Protracker playback library with sound effects

[E-Penguin]

Updated .obj and .asm here (maybe phx could check I'm not doing anything stupid!).

To use MTPlayFX you have to pass the address of an

SfxStructure

object and return a pointer to an

SfxChanStatus

object.

You probably want to create a few newtypes for it. Something like:

NewType SfxStructure
    sfx_ptr.l     ; Pointer to sample start in Chip RAM
    sfx_len.w     ; Sample length in words
    sfx_per.w     ; Hardware replay period for sample
    sfx_vol.w     ; Volume 0..64
    sfx_cha.b     ; 0..3 selected replay channel, -1 selects best channel
    sfx_pri.b     ; Priority range 1..127
End NewType

NewType SfxChanStatus
    n_note.w      ; UWORD translates to word (.w) in Blitz Basic
    n_cmd.w       ; Another word
    n_index.b     ; UBYTE translates to byte (.b) in Blitz Basic
    n_sfxpri.b    ; Another byte
End NewType

Unfortunately I'm not in a position to test anything at the moment, maybe later this evening, children permitting!

---
edited to remove attachment, updated one below

[phx]

Originally Posted by E-Penguin

Updated .obj and .asm here (maybe phx could check I'm not doing anything stupid!).

I noticed that you moved the SfxStructure pointer from d0 to a0 in

_mt_loopfx_stub

, but you didn't do that in

_mt_playfx_stub

. Does Blitz always pass a

long

argument in d0?

There might also be some room for optimization, as you only have to save/restore the registers which you modify in the stubs (mostly a6). All ptplayer functions follow the standard M68k-ABI, which means only d0-d1 and a0-a1 are scratch registers. The rest is preserved.

[E-Penguin]

Ah, I'd overlooked that. (another) updated library+src attached. I'll push it to github once someone's tested it.

Blitz passes in arguments in d0-d5 (pg 34 of the BlitzUM) and expects a4-a6 to be restored to initial values at the end of it all. I'm following idrougge's examples from his original blitz-wrapper.

The Statement or Function is defined as usual with a list of parameters enclosed in curly brackets. When using assembler, the parameters passed to the procedure are
loaded in data registers D0..D5.

Care must be taken to ensure that address registers A4-A6 are restored to their inital
state before the code exits from the procedure using the AsmExit command.
To set the return value in assembler for Functions simply load the register DO with the
value before the AsmExit command.

------------------------

Edited to remove old version of the library

[TheoTheoderich]

@E-Pinguin
Thank you very much for your help.

But sadly I don´t know what this sentence means:

To use MTPlayFX you have to pass the address of an SfxStructure object and return a pointer to an SfxChanStatus object.

The NewType SfxStructure already exists in the sample ptplayer_inc.ab3 and i added the NewType SfxChanStatus.
But I can not figure out, how to use it.
I am trying the example file for ptplayer which came with AmiBlitz3


DEFTYPE .sfx means your SfxStructure

WBSTARTUP

NEWTYPE .sound
  _data.l
  _period.w
  _length.w
  _loop.l
  _looplength.w
  _pad.b[2]
End NEWTYPE

NEWTYPE .sfx
  sfxPtr.l ; Pointer to sample start in chip ram, even address
  sfxLen.w ; Sample length
  sfxPer.w ; Hardware replay period for sample
  sfxVol.w ; Volume 0..64, is unaffected by the song's master volume
  sfxCha.b ; 0..3 selected replay channel, -1 selects best channel
  sfxPri.b ; unsigned priority, must be non-zero
  ;sfxSiz.b
End NEWTYPE

Statement SFXInit {*fx.sfx, snd.w, vol.w, cha.b, pri.b}
  *_snd.sound = Peek.l(Addr Sound(snd))  ; Get the pointer to the sound
  *fx\sfxPtr=*_snd\_data       ; Copy the data
  *fx\sfxLen=*_snd\_length     ; ...
  *fx\sfxPer=*_snd\_period
  *fx\sfxVol=vol
  *fx\sfxCha=cha
  *fx\sfxPri=pri
  ;*fx\sfxSiz=siz
End Statement

NEWTYPE .SfxChanStatus
    n_note.w      ; UWORD translates to word (.w) in Blitz Basic
    n_cmd.w       ; Another word
    n_index.b     ; UBYTE translates to byte (.b) in Blitz Basic
    n_sfxpri.b    ; Another byte
End NEWTYPE


MTInstall 1 ; Install the CIA MOD player routine (1=PAL,0=NTSC)

DEFTYPE .sfx clap
LoadSound 0,"909Clapp.iff"
; Initialize a sfx for ptplayer
SFXInit{&clap,0,64,-1,1} ; {*pointer.sfx, sound_index, volume, channel (-1=best), priority (>0) }

MTPlayFx &clap

MTEnd    ; Stop playing the current mod
MTRemove ; Remove the CIA MOD player routine

End

I get an error in the MTPlayFX line:
Return value needed for this function call

Sorry for all my questions...but I am still learning.

[E-Penguin]

chan_status.l = MTPlayFx &clap

if chan_status != 0 then it should have played properly.

It didn't previously return a value, now it does. In Blitz you must put the return value somewhere even if you don't do anything with it.

[TheoTheoderich]

Thanks, but there must still be something wrong.

With chan_status.l = MTPlayFx(&clap), only a buzz comes out of the speakers.

With MTSoundFX the sound is at least played once before an error message (Guru -. illigal instruction) comes, so at least I know that the sound file is OK.

[E-Penguin]

Debugging time... Can you print out the value of the sfx object fields?

I wonder whether it's being created properly.

[E-Penguin]

OK, the problem definitely isn't you, it's the library. I've tested it with some old code which I know works with the previous version (based on an older version of the ptplayer.asm). Either I made a mistake when I upgraded to the latest version on aminet (most likely) or we've somehow uncovered a bug in phx's code (least likely). I'll review my diffs.

---------------------------

OK, I found the problem. The solution is a bit nasty.

_mt_soundfx

internally calls

_mt_playfx

. The blitz library wraps these with "stubs" to save off registers a3-a6 and restore them at the end. Previously,

_mt_playfx

wasn't exposed to blitz so it didn't do any register saving. Now however, it is exposed so must also do a save/restore. This wasn't being done properly, it is now, so

_mt_playfx

should work.

The downside is that calling

_mt_soundfx

now saves/restores the registers twice, once itself and once again when calling through to

_mt_playfx

.

I don't know the best way of improving it.

exit_playfx

would need to know whether it had been called via

_mt_soundfx

or directly via

_mt_playfx

and only restore the registers in the latter case (else let the registers be restored at the end of

_mt_soundfx

). Maybe it doesn't matter for the sake of a few cycles every now and then, I guess you're not hammering sound effects at it every frame.

[E-Penguin]

So, this works.

Note the changes in SFXInit, and MTInit has to be called otherwise there's weird background sound. I guess it requires a mod to be at least loaded, if not actually playing.

WBStartup

NEWTYPE .sound
  _data.l
  _period.w
  _length.w
  _loop.l
  _looplength.w
  _pad.b[2]
End NEWTYPE

NEWTYPE .sfx
  sfxPtr.l ; Pointer to sample start in chip ram, even address
  sfxLen.w ; Sample length
  sfxPer.w ; Hardware replay period for sample
  sfxVol.w ; Volume 0..64, is unaffected by the song's master volume
  sfxCha.b ; 0..3 selected replay channel, -1 selects best channel
  sfxPri.b ; unsigned priority, must be non-zero
  ;sfxSiz.b
End NEWTYPE

Statement SFXInit {*fx.sfx, snd.w, vol.w, cha.b, pri.b}
  *_snd.sound = Addr Sound(snd)  ; Get the pointer to the sound
  *fx\sfxPtr=*_snd\_data       ; Copy the data
  *fx\sfxLen=*_snd\_length     ; ...
  *fx\sfxPer=*_snd\_period
  *fx\sfxVol=vol
  *fx\sfxCha=cha
  *fx\sfxPri=pri
  ;*fx\sfxSiz=siz
End Statement

NEWTYPE .SfxChanStatus
    n_note.w      ; UWORD translates to word (.w) in Blitz Basic
    n_cmd.w       ; Another word
    n_index.b     ; UBYTE translates to byte (.b) in Blitz Basic
    n_sfxpri.b    ; Another byte
End NEWTYPE


MTInstall 1 ; Install the CIA MOD player routine (1=PAL,0=NTSC)

LoadBank 0,"test_it_.mod",2

MTInit 0,0 ; Weirdness happens if this isn't called to point to some valid mod

DEFTYPE .sfx clap
LoadSound 0,"ow-sound.8svx"

; Initialize a sfx for ptplayer
SFXInit{&clap,0,64,-1,1} ; {*pointer.sfx, sound_index, volume, channel (-1=best), priority (>0) }

; Start the music play loop, if you want to
;MTPlay On

; Wait 10s
VWait 500

ad.l = 0

For i=0 To 10
  ad = MTPlayFx(&clap)
  VWait 50
Next i


MTEnd    ; Stop playing the current mod
MTRemove ; Remove the CIA MOD player routine


End

[TheoTheoderich]

Thank you very much.
This new code was also not working, due to the error:
"Can´t convert types"
in the Statement SFXInit line:
"*_snd.sound = Addr Sound(snd) ; Get the pointer to the sound"


But I found out, that changing the SFXInit snd parameter from "snd.w" to "snd.l" solves this problem.
Now the MTPlayFX command is working fine

Tomorrow I will try to implement it into my game Settle the World and will do some more testing

Thank you very much for your help @E-Pinguin.

[Zener]

Hi, I tried to update Blitz libs with this new version, and although it seems to be working, it changes the order of all the commands for older source codes. What was MasterSetVolume is now MTSoundFX, etc, etc.

Is it possible to keep the order of the commands? otherwise it is a mess. Thanks!

Originally Posted by E-Penguin

So, this works.

Note the changes in SFXInit, and MTInit has to be called otherwise there's weird background sound. I guess it requires a mod to be at least loaded, if not actually playing.

WBStartup

NEWTYPE .sound
  _data.l
  _period.w
  _length.w
  _loop.l
  _looplength.w
  _pad.b[2]
End NEWTYPE

NEWTYPE .sfx
  sfxPtr.l ; Pointer to sample start in chip ram, even address
  sfxLen.w ; Sample length
  sfxPer.w ; Hardware replay period for sample
  sfxVol.w ; Volume 0..64, is unaffected by the song's master volume
  sfxCha.b ; 0..3 selected replay channel, -1 selects best channel
  sfxPri.b ; unsigned priority, must be non-zero
  ;sfxSiz.b
End NEWTYPE

Statement SFXInit {*fx.sfx, snd.w, vol.w, cha.b, pri.b}
  *_snd.sound = Addr Sound(snd)  ; Get the pointer to the sound
  *fx\sfxPtr=*_snd\_data       ; Copy the data
  *fx\sfxLen=*_snd\_length     ; ...
  *fx\sfxPer=*_snd\_period
  *fx\sfxVol=vol
  *fx\sfxCha=cha
  *fx\sfxPri=pri
  ;*fx\sfxSiz=siz
End Statement

NEWTYPE .SfxChanStatus
    n_note.w      ; UWORD translates to word (.w) in Blitz Basic
    n_cmd.w       ; Another word
    n_index.b     ; UBYTE translates to byte (.b) in Blitz Basic
    n_sfxpri.b    ; Another byte
End NEWTYPE


MTInstall 1 ; Install the CIA MOD player routine (1=PAL,0=NTSC)

LoadBank 0,"test_it_.mod",2

MTInit 0,0 ; Weirdness happens if this isn't called to point to some valid mod

DEFTYPE .sfx clap
LoadSound 0,"ow-sound.8svx"

; Initialize a sfx for ptplayer
SFXInit{&clap,0,64,-1,1} ; {*pointer.sfx, sound_index, volume, channel (-1=best), priority (>0) }

; Start the music play loop, if you want to
;MTPlay On

; Wait 10s
VWait 500

ad.l = 0

For i=0 To 10
  ad = MTPlayFx(&clap)
  VWait 50
Next i


MTEnd    ; Stop playing the current mod
MTRemove ; Remove the CIA MOD player routine


End

[earok]

I've created another wrapper (but based on the existing one) for the purposes of the Scorpion Engine, but I've put it on github if anyone has any use for it or wants to submit pull requests.

It's mainly different in that it doesn't use the bank library, sound library etc, and that Blitz specific code is kept separate from ptplayer.asm so future updates can be dropped in without needing to merge. It uses the 6.4 beta (cheers Phx), which may be final if there's no further changes.

https://github.com/earok/ptplayer_blitzwrapper_scorpion

[Zener]

Thanks for sharing it! I have tried it and I have the same problem with function names not being the correct ones. I think it is related with latests versions of Amiblitz, it doesn't happen in Amiblitz 3.8, for example

Originally Posted by earok

I've created another wrapper (but based on the existing one) for the purposes of the Scorpion Engine, but I've put it on github if anyone has any use for it or wants to submit pull requests.

It's mainly different in that it doesn't use the bank library, sound library etc, and that Blitz specific code is kept separate from ptplayer.asm so future updates can be dropped in without needing to merge. It uses the 6.4 beta (cheers Phx), which may be final if there's no further changes.

https://github.com/earok/ptplayer_blitzwrapper_scorpion

[earok]

Originally Posted by Zener

Thanks for sharing it! I have tried it and I have the same problem with function names not being the correct ones. I think it is related with latests versions of Amiblitz, it doesn't happen in Amiblitz 3.8, for example

That is really strange. I'm unfortunately not very familiar with Amiblitz, does Amiblitz still use tokenisation?

Is there another copy of the library present that could be conflicting?

[E-Penguin]

Originally Posted by earok

I've created another wrapper (but based on the existing one) for the purposes of the Scorpion Engine, but I've put it on github if anyone has any use for it or wants to submit pull requests.

It's mainly different in that it doesn't use the bank library, sound library etc, and that Blitz specific code is kept separate from ptplayer.asm so future updates can be dropped in without needing to merge. It uses the 6.4 beta (cheers Phx), which may be final if there's no further changes.

https://github.com/earok/ptplayer_blitzwrapper_scorpion

I'll take a look and see if I can merge my changes with yours, better than maintaining two different-but-similar libraries.

Originally Posted by Zener

Thanks for sharing it! I have tried it and I have the same problem with function names not being the correct ones. I think it is related with latests versions of Amiblitz, it doesn't happen in Amiblitz 3.8, for example

Which order would you like?

[Zener]

Originally Posted by E-Penguin

I'll take a look and see if I can merge my changes with yours, better than maintaining two different-but-similar libraries.

Which order would you like?

Amiblitz has a tool to replace libraries that usually has worked just fine for me in the past. I am not sure what order it is expecting but this is the order it shows in the tool:

[Honitos]

Sorry, I missed this topic.

The Problem may be, that AmiBlitz3 uses a faster tokenization-routine - yes, the compiler stills needs tokenized sources.

As the commands are reordered in the blitzlib, the tokens have changed.
The tokenization routine that runs when loading a source does not know the new tokens.
But you can use the menu-option "help/update instruction index" once to update the token-hashmap.

Anyother problem with reordering of commands is, that AmiBlitz3 used the first command in each lib to identify the libname - as there is no other effective way to do it.
After replacing a lib with reordered commands, you have to update the file "system/token_mapping_libs.txt".


---

I'd like to update the distribution with the changed playerlib.
Can someone provide me please the lasted version ?

[Zener]

Thank you, I was able to update the library following the provided steps!!!
Now the first function is MTInstall instead of MTinit, changing it fixed it.

I noticed there isn't MTPlay anymore, it looks like MTEnable is the replacement.

Originally Posted by Honitos

Sorry, I missed this topic.

The Problem may be, that AmiBlitz3 uses a faster tokenization-routine - yes, the compiler stills needs tokenized sources.

As the commands are reordered in the blitzlib, the tokens have changed.
The tokenization routine that runs when loading a source does not know the new tokens.
But you can use the menu-option "help/update instruction index" once to update the token-hashmap.

Anyother problem with reordering of commands is, that AmiBlitz3 used the first command in each lib to identify the libname - as there is no other effective way to do it.
After replacing a lib with reordered commands, you have to update the file "system/token_mapping_libs.txt".


---

I'd like to update the distribution with the changed playerlib.
Can someone provide me please the lasted version ?

[jotd]

zoned tunes where tempo doesn't seem to register (sbagman.mod). Works with any tracker but not with ptplayer.

[carrion]

Im working on my game Robot Jet Action 2 https://eab.abime.net/showthread.php?t=116486
The game is developed in BB2.
And I was wondering if I can play sub tunes in module with ptplayer?
TIA