How to add sound?

epicdude312 · August 20, 2017, 11:35pm

Hey everyone –
I’ve been trying to figure out how I might add simple sound effects, and no matter how hard I try, I can’t seem to get even single notes to work. My game feels awfully quiet.
Can someone please explain the playTone and playNote functions to me? The API docs don’t really help much when it comes to these…

jonne · August 24, 2017, 10:51pm

Will make some examples for this

filmote · December 15, 2019, 3:36am

Sorry to dig up an old thread … did these examples get made?

Hanski · December 15, 2019, 5:29am

Play a sound effect:

Here: https://github.com/pokitto/PokittoLib/blob/master/Examples/PlaySFX

Play a melody using an in-build music player in PokittoLib:

Here: https://github.com/pokitto/PokittoLib/tree/master/Examples/PlayMusic

These are very simple examples. There are other, more complex, examples in there also.

filmote · December 15, 2019, 5:43am

Thanks @Hanski … I had already tried the PlayMusic example but it does not make any sound.

I have now tried the PlaySFX and it makes a noise - not sure what it is supposed to be but at least it makes one. How are the sound effects for PlaySFX encoded?

Hanski · December 15, 2019, 5:46am

Really? Then there has been some regression in PokittoLib then as they both have worked before.

PlaySfx can play RAW 8-bit or 4-bit audio data.

Edit: Also, PlaySfx is also used widely by MicroPython so it should work.
Edit2: Could the problems be related to the audio settings in mySettings.h?

Hanski · December 15, 2019, 5:58am

Does PlaySFX work if you play the background music at the same time? You can enable this:

//Sound::playMusicStream("abbaye/music/0_PrayerofHopeN.raw", 0);

You should have The Abbaye Des Morts game in SD to have the audio file, or use your own.
PokittoLib should mix the audio together.

filmote · December 15, 2019, 6:35am

PlaySFX is working but PlayMusic is not.

How are the sound effects for PlaySFX encoded? If it is in RAW format I assume I need to convert it in something like Audacity. What I am rellay trying to do is find the Pokitto equivalent of the Arduboy’s AruboyTones which allows you to create simply music / sound effects using a simple {note, duration} notation.

Hanski · December 15, 2019, 6:54am

How did you get it working? What was the problem?

Yes that is a pure RAW format.

I have used the tones as a car motor sound in Pokitto GP here: https://github.com/haviital/PokittoLib/tree/pzero2/Examples/PokittoGP

Edit: More precisely here: https://github.com/haviital/PokittoLib/blob/pzero2/Examples/PokittoGP/playerShip.cpp

            m_tonefreq = fix16_to_int(abs(m_fxVel*5));
            if(m_tonefreq>50) m_tonefreq = 50;
            //snd.playTone(1,m_tonefreq,amplitude,wavetype,arpmode);
            setOSC(&osc1,1,wavetype,1,0,0,m_tonefreq,amplitude,0,0,0,0,0,0,arpmode,1,0);

I think the snd.playTone() is a wrapper for setOSC() which is more versatile.
m_fxVel is the speed of the car

filmote · December 15, 2019, 6:59am

Sorry I think you misunderstood my first post. PlaySFX was always working but PlayMusic is not. PlayMusic seems to be closer to the ArduboyTones model of {note / duration} pairs.

I will download the game and have a look.

Hanski · December 15, 2019, 7:02am

Ok
I added detailed info in the previous post.

uXe · December 15, 2019, 8:42am

There is a playTone function:

github.com

pokitto/PokittoLib/blob/master/Pokitto/POKITTO_CORE/PokittoSound.cpp#L876




void Sound::playTone(uint8_t os, int frq, uint8_t amp, uint8_t wav,uint8_t arpmode)
{
if (wav>MAX_WAVETYPES) wav=0;
if (arpmode>MAX_ARPMODE) arpmode=MAX_ARPMODE;
if (os==1) setOSC(&osc1,1,wav,1,0,0,frq,amp,0,0,0,0,0,0,arpmode,0,0);
else if (os==2) setOSC(&osc2,1,wav,1,0,0,frq,amp,0,0,0,0,0,0,arpmode,0,0);
else if (os==3) setOSC(&osc3,1,wav,1,0,0,frq,amp,0,0,0,0,0,0,arpmode,0,0);
}


void Sound::playTone(uint8_t os, uint16_t frq, uint8_t volume, uint32_t duration)
{
if (os==1) setOSC(&osc1,1,WSQUARE,frq,volume,duration);
else if (os==2) setOSC(&osc2,1,WTRI,frq,volume,duration);
else if (os==3) setOSC(&osc3,1,WTRI,frq,volume,duration);
}


uint8_t Sound::ampIsOn()
{
#ifdef POK_SIM
return core.ampIsOn();

…which is sort of just a wrapper for the setOSC function:

github.com

pokitto/PokittoLib/blob/master/Pokitto/POKITTO_LIBS/Synth/Synth_oscfuncs.cpp#L102


      o->bendrate = (int32_t)bendrate*(o->cinc/10000); // test value
      o->maxbend = (int32_t)maxbend*(o->cinc/100);
      //o->samplebendcount = o->maxbend>>24;
      //o->samplebendtick = 0;
} else {
      o->bendrate = 0;
      o->maxbend = 0;
}
}


void setOSC(OSC* o,byte on, byte wave, uint16_t frq, uint8_t volume, uint32_t duration){
o->on = on;
o->overdrive = 0;
o->kick = 0;
o->wave = wave;
o->loop = 0;//1;
o->echo = 0;//1; //echo shifts left 8 steps to zero
o->echodiv = 0;
o->adsr = 0;//1;
o->attack = 0;//200;
o->decay = 0;//200;

…and I think takes note values in this format:

github.com

pokitto/PokittoLib/blob/master/Pokitto/POKITTO_LIBS/Synth/Synth_helpers.cpp#L642


457606852	,	  // 87 - NOTE_D8
484818051	,	  // 88 - NOTE_DS8
};






#endif


/** NOTE TO TEXT TABLES **/


const char note_0[]  = "B-0";  // 0 - NOTE_B0
const char note_1[]  = "C-1";  // 1 - NOTE_C1
const char note_2[]  = "C#1";  // 2 - NOTE_CS1
const char note_3[]  = "D-1";  // 3 - NOTE_D1
const char note_4[]  = "D#1";  // 4 - NOTE_DS1
const char note_5[]  = "E-1";  // 5 - NOTE_E1
const char note_6[]  = "F-1";  // 6 - NOTE_F1
const char note_7[]  = "F#1";  // 7 - NOTE_FS1
const char note_8[]  = "G-1";  // 8 - NOTE_G1
const char note_9[]  = "G#1";  // 9 - NOTE_GS1
const char note_10[]  = "A-1";  // 10 - NOTE_A1

filmote · December 15, 2019, 8:45am

Maybe I am misunderstanding it but that function lets you play one note, not a series of notes like ArduboyTones. To create a sound effect or music with that, you would have to continually poll the sound to see if it is finished before starting the next tone.

I was sort of hoping for a fuction that allows you to point it to an array of bytes.

jonne · December 15, 2019, 8:47am

i ported the arduboy tones lib once

Would you like to use it 1:1?

filmote · December 15, 2019, 8:49am

That could work!

However, if there is a ‘native’ approach I would like to know that too. Although the game I am writing is actually a port from the Arduboy, I hope to write new, unique games soon.

Hanski · December 15, 2019, 8:51am

That is exactly what the PlayMusic example, mentioned above, should do.

filmote · December 15, 2019, 8:54am

Yes it looks like what I want - but it doesn’t seem to work for me. If you have time, can you please try the example from the repo and see if it still works for you. Maybe I am doing something wrong - although other than the My_settings.h file and the code itself, I cannot see what I am doing wrong.

uXe · December 15, 2019, 8:57am

If @jonne has already done the work on ArduboyTones - that would be the best approach! Just looking at HWSound.cpp and PokittoSound.cpp is making my head start to hurt… this is what makes working with the Pokitto less appealing to me - the Arduboy2 library has one clear way of doing things, the Pokitto has sooo many ‘modes’ and layers, and swiss-army knives full of ways to approach video and audio! But no equivalent to play a simple sequence of tones?

jonne · December 15, 2019, 8:59am

Message received and understood. We will fix that

filmote · December 15, 2019, 8:59am

Obviously I am new to the environment … but I must agree, the Arduboy library is simple and well documented.

@jonne how do I get my hands on that ArduboyTones port?