Acorn User 1

home *** CD-ROM | disk | FTP | other *** search

/ Acorn User 1 / AU_CD1.iso / demos / s_to_z / symphony / PlayModule / !Help / Help < prev next >

Wrap

Text File | 1995-02-20 | 21KB | 308 lines

<title>Help : Digital Symphony Play Module</title> <h1>Digital Symphony Play Module</h1> The DSymPlay module provides all the code necessary for programmers of any level to play Symphonies from within their own code. The module allows control of the Symphony track using SWIs or from the command line, via the commands listed below. The module is provided so that including a soundtrack created by Digital Symphony in either a game, or demo, etc... is a trivial task, which will be performed well, using little processor time. <hr> <h2>More Details</h2> Any registered owner of Digital Symphony may apply (by sending a disc and SAE to Oregan) for further, more technically specific details about using the module. An additional new version of the module will be supplied, which is optimised for ARM 3 use. <hr> <h2>Copyright</h2> Copyright of the Digital Symphony play modules is owned by Oregan Software Developments, and BASS. However the modules may be used freely in Freeware productions, but a licence must be applied for when used in commercial, or Shareware products. Licences may be granted free of charge to registered Digital Symphony users, but in the case of commercial use, a one off licence fee of £100 may be imposed. Please direct all applications to: Oregan Software Developments 36 Grosvenor Avenue Streetly Sutton Coldfield B74 3PE Tel: 0121 353 6044 Fax: 0121 353 6472 <hr> <hr> <h2>SWI Details</h2> <r0> SWI Chunk name: DSym SWI Chunk base number: &45880 ----------------------------------------------------------------------------- SWI name Nr |Entry |Exit/Effect ----------------------------------------------------------------------------- Load 00 |R0=-1 to free RMA buffers |If an error occured, then |or R0= 0 to load from | R0 points to error | memory | and V is set, |or R0 points to file name |else |R1= source start address | R0= length of track | (if R0=0) | in memory. |R2= 0 to load to RMA | |or R2= destination start | | address | |R3= size of destination | | buffer (if R2[]0) | |R4= 0 to claim buffer | | in RMA | |or R4= start address of | | buffer (32K space) | |A buffer address is needed only if the Symphony file | contains some packed data. |Buffers are word aligned. |In the case of packed data, the source and destination | buffers can't share any part of memory. |In the case of entirely non packed data, the two buffers | can share a part of memory provided | destination address [= source address. After the call | the source data has been altered because the | module needs to build an internal structure different | to the source structure of the tune. |Although the code is quite optimized, loading from | memory may take some time because all the data has to | be moved in memory. So don't expect loading 50 songs | per second with an ARM2| ----------------------------------------------------------------------------- RestartSong 01 | - |Do a ResetParams, | |Tune position set to (0,0), | |Tune playing again. ----------------------------------------------------------------------------- Vol 02 |R0= new overall volume |R0= previous overall volume | or -1 to read | (0-64). |Initial value is 64 | ----------------------------------------------------------------------------- Stereo 03 |R0= voice number (0-7) |R1= previous stereo position |R1= new stereo position | (-127 to 127) for voice | or -128 to read | number R0. | | |Initial values are those of the Amiga. ----------------------------------------------------------------------------- CutNote 04 |R0= voice number (0-7) |R1= previous note state on |R1]=0 to read state | voice number R0 | [ 0 to stop note | [ 0 -] stopped | | ]=0 -] playing, = sample | | start address | |If R1]=0 then | | R2= offset in sample | | in 1/(2^12) units ----------------------------------------------------------------------------- PlayInstrPacked 05 |R0= voice number (0-7) |The new note is put into a |R1= full note data |1-entry-per-voice buffer to be |R5= minimum sustain time |played. | (in 1/50th sec) |Setting a sustain time means |R6[]0 to wait for buffer |that the new note has | empty |priority on the tune notes | else don't wait |during this time. ----------------------------------------------------------------------------- PlayInstr 06 |R0= voice number (0-7) |The new note is put into a |R1= note number (0-36) |1-entry-per-voice buffer to be |R2= sample number (0-63) |played. |R3= effect number (0-63) |Setting a sustain time means |R4= effect value (0-&FFF) |that the new note has |R5= minimum sustain time |priority on the tune notes | (in 1/50th sec) |during this time. |R6[]0 to wait for buffer | | empty | | else don't wait | ----------------------------------------------------------------------------- ResetParams 07 | - |All parameters are reset | |(stereo,counters,effects,...) | |and do a FlushOutput. ----------------------------------------------------------------------------- FlushOutput 08 | - |The current notes on all | |channels are cut. ----------------------------------------------------------------------------- FreezeOutput 09 |R0= -1 to read output |R0= previous output status | status |( 0= off ie. no sound output | []-1 to set | []0= on ) ----------------------------------------------------------------------------- UpCallVector 0A |R0= -1 to read upcall |R0= previous upcall address | address | | = -2 to set default | | else new address | ----------------------------------------------------------------------------- MaskVoice 0B |R0= voice number (0-7) |R0= previous voice status |R1= -1 to read voice stat | (0= off, []0=on) | []-1 to set voice status|The notes are still played | |but not heard for the voice. ----------------------------------------------------------------------------- SongPos 0C |R0= -1 to read sequence ps|R0= previous sequence pos | []-1 to set |R1= previous pattern pos |R1= -1 to read pattern pos| (0-63) | []-1 to set |If pattern pos is changed | |then the current counter is | |reset to play the tune line | |as soon as possible. ----------------------------------------------------------------------------- TuneControl 0D |R0= -1 to read status |R0= previous tune status | []-1 to set (lower byte)| (0= off, []0= on) | |Off means the tune decoder | |won't let play notes anymore, | |you can still play custom | |notes. | |Current notes still playing. ----------------------------------------------------------------------------- Pause 0E | - |The tune is stopped and | |current notes on tune | |channels cut. ----------------------------------------------------------------------------- Voices 0F |R0= -1 to read hardware |R0= previous hardware voices | voices number | number (1,2,4 or 8) | []-1 to set voices | |The change is taken into account during next configure. |Initial value is 4. ----------------------------------------------------------------------------- Wait 10 |R0= voice number (0-7) |C is set if custom note | |buffer is not empty, | |else clear. ----------------------------------------------------------------------------- IntState 11 | - |C is set if the call has | |interrupted the playing or | |filling routines. ----------------------------------------------------------------------------- NoteInfo 12 | - |R0= address of current notes | | table (1 word per voice) | | note is 0 to 1023 | |R1= address of current | | samples table (1 byte per | | voice) | | sample is 0 to 63 | |R2= address of effects table | | (1 word per voice) | | bits 30-31 meaningless | | bits 16-21 effect nr | | bits 0-11 effect value | |R3= address of volumes table | | (1 byte per voice) | | volume is 0 to 64 ----------------------------------------------------------------------------- VuBar 13 |R0= voice number (0-7) |R1= Vu bar height (0-64) ----------------------------------------------------------------------------- Loop 14 |R0= -1 to read loop contrl|R0= previous loop control | []-1 to set | ( 0= enabled, |R1= -1 to read loop flag | []0= disabled ) | []-1 to set |R1[]0 if the tune has looped | | else not looped | | |Loop control is initially enabled. |If a song has looped and the loop is disabled, you can |continue playing using TuneControl. ----------------------------------------------------------------------------- BufferAddress 15 | - |R0= current system hardware | | buffer address (with | | output data interleaved) | | 208 bytes per channel ----------------------------------------------------------------------------- VuGravity 16 |R0= -1 to read Vu gravity |R0= previous gravity of Vu | []-1 to set (lower byte)| bars (0-255) |Initial value is 2. | |The change is taken into account during next configure. ----------------------------------------------------------------------------- SampleRate 17 |R0= -1 to read sample rate|R0= previous sample rate | []-1 to set | (0-99) - determines | | sample output density. |Original value is 24. | |The change is taken into account during next configure. ----------------------------------------------------------------------------- Configure 18 |R0= -1 to reinstall previous | configuration | []-1 to configure the system | with new voices number, | sample rate, Vu gravity and hardware speed. ----------------------------------------------------------------------------- Params 19 | |R0= speed (1-&FFF) | |R1= tempo (1-&FFF) | |R2= counter (0-&FFE) |The counter varies from 1 to speed-1 at a speed |according to tempo (50 times a sec for default tempo) ----------------------------------------------------------------------------- TuneInfo 1A | - |R0= tune length | |R1= number of patterns ----------------------------------------------------------------------------- PlaySingle 1B | R0= -1 | Play pattern R1 | or | or | R0[]-1 | Play from pos R0 to R1 | | | and | | R2= -1 for no loop | | []-1 to loop | | | | or R0=-1 and R1=-1 | or Normal play. | | | |The pattern pos is set to 0. | |In the case of playing a | |part of the sequence, the | |current position is set to | |the first pos in that part. ----------------------------------------------------------------------------- DefaultStereo 1C |R0= voice number (0-7) |R1= previous default stereo |R1= new default stereo |position (1 to 7) for | position |voice number R0 | or 0 to read | | | |Initial values are those of the Amiga. ----------------------------------------------------------------------------- InstrData 1D |R0= sample number (1-63) |The specs for sample R0 |R1= sample data address |are changed to those on entry | or -1 to read |R1= previous address |R2= sample length |R2= previous length | or -1 to read |R3= previous repeat offset |R3= repeat offset |R4= previous repeat length | or -1 to read |R5= previous volume |R4= repeat length |R6= previous finetune | or -1 to read | (-8 to 7) |R5= volume (0-64) | | or -1 to read | |R6= finetune (0-&F) | | or -1 to read | |R1 to R4 must be 2-byte aligned. |Put a repeat length of 0 for no repeats. |Repeat length can't be 2. |Set bit 31 of R1 if the sample is signed linear. |The data is not moved i.e. it stays where you put it. |The data is also scaled to the current machine volume if |R1[]-1. ----------------------------------------------------------------------------- HardSpeed 1E |R0= samples output |R0= previous parameter | frequency (in kHz) |R1= current hardware speed | or 0 for 'auto speed' | (in kHz) | or -1 to read |The buffer filling routine | |output frequency is changed | |to the one on entry |Initial mode is 24000 | |The change is taken into account during next configure. | |In 'auto speed' mode, the filling routine will try to |guess the current VIDC frequency for outputting samples |by averaging the number of calls to it and adjust its |tables to always have the same real pitch whatever the |hardware speed is. The 'auto speed' selects one of the |three following speeds currently: | | 24000 kHz (normal modes) | 25175 kHz (VGA modes) | 36000 kHz (multi sync modes) | |Too bad to have the same clock for graphics and sound| ----------------------------------------------------------------------------- LoopType 1F |R0= loop type |R0= previous loop type | or -1 to read | (0 or 1) | | |Type 0: The loop flag is set if the tune reaches | position 0. |Type 1: The loop flag is set if the tune jumps to | a lower position. ----------------------------------------------------------------------------- FillAddress 20 | - |R0= address of buffer filling | | routine ----------------------------------------------------------------------------- </r0>