https://wiki.ffrtt.ru/api.php?action=feedcontributions&feedformat=atom&user=Loveemu
Final Fantasy Inside - User contributions [en]
2026-08-04T01:30:56Z
User contributions
MediaWiki 1.32.1
https://wiki.ffrtt.ru/index.php?title=FF9/Sound/AKAO_sequence&diff=5775
FF9/Sound/AKAO sequence
2020-07-30T09:38:31Z
<p>Loveemu: Fix AkaoChannelInfo mask bits</p>
<hr />
<div>== Introduction ==<br />
AKAO sequence is similar to MIDI sequence - it's custom tracker format for playing sequence sound, well tuned specially for PSX.<br />
<br />
<br />
== File Structure ==<br />
=== Header (size: 64 bytes) ===<br />
<br />
struct AkaoSeqHeader<br />
{<br />
static const uint8_t magic[4]; // "AKAO" C-string<br />
uint16_t id; // song ID, used for playing sequence<br />
uint16_t length; // data length (including this header)<br />
uint16_t reverb_type; // reverb type (range from 0 to 9)<br />
uint8_t field_0A[6];<br />
uint32_t field_10;<br />
uint16_t sample_set_id; // associated sample set ID<br />
uint16_t field_12;<br />
uint32_t field_14;<br />
uint32_t field_18;<br />
uint32_t field_1C;<br />
uint32_t mask; // represents bitmask of used channels in this song<br />
uint32_t field_24;<br />
uint32_t field_28;<br />
uint32_t field_2C;<br />
uint32_t instrument_map_offset; // relative offset to custom instrument map (0 if unused)<br />
uint32_t drum_map_offset; // relative offset to custom drum map (0 if unused)<br />
uint32_t field_38;<br />
uint32_t field_3C;<br />
};<br />
<br />
=== Channel Offsets (size: 2 bytes * <channels count>) ===<br />
struct AkaoChannelInfo<br />
{<br />
uint32_t start_offsets[num_channels]; // offsets to channel opcode data<br />
};<br />
<br />
AkaoSeqHeader *header;<br />
int num_channels = 0;<br />
while (int bit = 0; bit < 32; bit++)<br />
if (info.mask & (1 << bit)) != 0)<br />
num_channels++;<br />
<br />
There is <channels count> offsets to channel opcode data counting from current offset. Each offsets is a relative offset based on the address the offset itself.<br />
<br />
<br />
=== Channel Commands [AKAO Opcodes] ===<br />
For every channels in an AKAO sequence, there is a set of commands to perform. This is similar to Field opcodes. Here I will call this sound commands "opcodes". Every opcode has its own number of arguments.<br />
<br />
=== Custom Instrument Map Table ===<br />
<br />
When a song uses custom instruments with [[FF9/Sound/Opcodes/0xfe14|opcode 0xFE 0x14]], a custom instrument map table will be placed after the end of AKAO opcode sequence.<br />
<br />
This table consists of a collection of zones representing performance settings for a particular key range. A zone is an 8-byte item, and an instrument can have one or more regions.<br />
<br />
struct AkaoInstrumentZoneAttr<br />
{<br />
uint8_t instrument; // corresponding to opcode 0xA1<br />
uint8_t low_key; // lowest key (in note number)<br />
uint8_t high_key; // highest key (in note number)<br />
uint8_t ar; // ADSR: attack rate (0-127)<br />
uint8_t sr; // ADSR: sustain rate (0-127)<br />
uint8_t s_mode; // ADSR: sustain mode (1: linear increase, 3: linear decrease, 5: exponential increase, 7: exponential decrease)<br />
uint8_t rr; // ADSR: release rate (0-31)<br />
uint8_t volume; // adjust the note volume to n/128 of the original volume (0 will keep the original volume)<br />
}<br />
<br />
- Zones must be ordered from low key to high key<br />
- The final zone of the instrument must be a terminator filled with 0s (more precisely, a zone with ADSR sustain mode of 0 is considered a terminator)<br />
<br />
=== Drum Instrument Map Table ===<br />
<br />
When a song uses a drum kit with [[FF9/Sound/Opcodes/0xfe04|opcode 0xFE 0x04]], a drum instrument map table will be placed at the end of the sequence. The table determines the instrument, channel volume and pan for each keys.<br />
<br />
The table consists of a repetition of 8-byte items.<br />
<br />
struct AkaoDrumKeyAttr<br />
{<br />
uint8_t instrument; // corresponding to opcode 0xA1<br />
uint8_t key; // note number when playing the drum note<br />
uint8_t ar; // ADSR: attack rate (0-127)<br />
uint8_t sr; // ADSR: sustain rate (0-127)<br />
uint8_t s_mode; // ADSR: sustain mode (1: linear increase, 3: linear decrease, 5: exponential increase, 7: exponential decrease)<br />
uint8_t rr; // ADSR: release rate (0-31)<br />
uint8_t volume; // adjust the percussion volume to n/128 of the original volume (0 will keep the original volume)<br />
uint8_t pan : 7; // corresponding to opcode 0xAA<br />
uint8_t reverb : 1; // reverb on/off (0: off, 1: on)<br />
}<br />
<br />
<br />
== Sound Opcode List ==<br />
<br />
{| class="wikitable"<br />
! Opcode<br />
! Summary<br />
! Length<br />
! Operands<br />
! Note<br />
|-<br />
|[[FF9/Sound/Opcodes/0x0099|0x00-0x99]]<br />
|Note, Tie, Rest<br />
|1<br />
|<br />
|The opcode indicates the note key and length.<br />
|-<br />
|0x9A-0x9F<br />
|Unimplemented<br />
|1<br />
|<br />
|Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xA0]]<br />
|Finish Channel<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa1|0xA1]]<br />
|Load Instrument<br />
|2<br />
|instrument: byte (0-127)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0x0099|0xA2]]<br />
|Overwrite Next Note Length<br />
|2<br />
|length: byte<br />
|Ignores the regular length (delta-time) of the next note and overwrites it with the specified length.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa8aa|0xA3]]<br />
|Channel Master Volume<br />
|2<br />
|volume: byte (0-127)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa4|0xA4]]<br />
|Pitch Bend Slide<br />
|3<br />
|length: byte, semitones: signed byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa5|0xA5]]<br />
|Set Octave<br />
|2<br />
|octave: byte (0-15)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa5|0xA6]]<br />
|Increase Octave<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa5|0xA7]]<br />
|Decrease Octave<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa8aa|0xA8]]<br />
|Channel Volume<br />
|2<br />
|volume: byte (0-127)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa9|0xA9]]<br />
|Channel Volume Slide<br />
|3<br />
|length: byte, volume: byte (0-127)<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa8aa|0xAA]]<br />
|Channel Pan<br />
|2<br />
|pan: byte (0-127)<br />
|64 is the center.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xab|0xAB]]<br />
|Channel Pan Slide<br />
|3<br />
|length: byte, pan: byte (0-127)<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xac|0xAC]]<br />
|Noise Clock Frequency<br />
|2<br />
|clock: byte (0x00-0x3f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xAD]]<br />
|ADSR: Attack Rate<br />
|2<br />
|attack_rate: byte (0x00-0x7f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xAE]]<br />
|ADSR: Decay Rate<br />
|2<br />
|decay_rate: byte (0x00-0x0f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xAF]]<br />
|ADSR: Sustain Level<br />
|2<br />
|sustain_level: byte (0x00-0x0f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xB0]]<br />
|ADSR: Decay Rate & Sustain Level<br />
|3<br />
|decay_rate: byte (0x00-0x0f), sustain_level: byte (0x00-0x0f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xB1]]<br />
|ADSR: Sustain Rate<br />
|2<br />
|sustain_rate: byte (0x00-0x7f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xB2]]<br />
|ADSR: Release Rate<br />
|2<br />
|release_rate: byte (0x00-0x1f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xB3]]<br />
|ADSR: Reset ADSR<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb4b5|0xB4]]<br />
|Vibrato (Channel Pitch LFO)<br />
|4<br />
|delay: byte, rate: byte, type: byte (0-15)<br />
|When <code>rate</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb4b5|0xB5]]<br />
|Vibrato Depth<br />
|2<br />
|depth: byte<br />
|The most significant bit of the <code>depth</code> determines the amplitude range.<br />
<br />
When it is 0, the range is up to about ± 50 cents (amplitude is 15/256 compared with range type 1).<br />
<br />
When it is 1, the range is up to about ± 700 cents.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb4b5|0xB6]]<br />
|Turn Off Vibrato<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xB7]]<br />
|ADSR: Attack Mode<br />
|2<br />
|attack_mode: byte (1 or 5)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb8b9|0xB8]]<br />
|Tremolo (Channel Volume LFO)<br />
|4<br />
|delay: byte, rate: byte, type: byte (0-15)<br />
|When <code>rate</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb8b9|0xB9]]<br />
|Tremolo Depth<br />
|2<br />
|depth: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb8b9|0xBA]]<br />
|Turn Off Tremolo<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xBB]]<br />
|ADSR: Sustain Mode<br />
|2<br />
|sustain_mode: byte (1, 3, 5 or 7)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xbcbd|0xBC]]<br />
|Channel Pan LFO<br />
|3<br />
|rate: byte, type: byte (0-15)<br />
|When <code>rate</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xbcbd|0xBD]]<br />
|Channel Pan LFO Depth<br />
|2<br />
|depth: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xbcbd|0xBE]]<br />
|Turn Off Channel Pan LFO<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xbf|0xBF]]<br />
|ADSR: Release Mode<br />
|2<br />
|release_mode: byte (3 or 7)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc0c1|0xC0]]<br />
|Channel Transpose (Absolute)<br />
|2<br />
|semitones: signed byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc0c1|0xC1]]<br />
|Channel Transpose (Relative)<br />
|2<br />
|semitones: signed byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc2c3|0xC2]]<br />
|Turn On Reverb<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc2c3|0xC3]]<br />
|Turn Off Reverb<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc4c5|0xC4]]<br />
|Turn On Noise<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc4c5|0xC5]]<br />
|Turn Off Noise<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc6c7|0xC6]]<br />
|Turn On Frequency Modulation<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc6c7|0xC7]]<br />
|Turn Off Frequency Modulation<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc8c9|0xC8]]<br />
|Loop Point<br />
|1<br />
|<br />
|Remember the current offset as a loop point and increase the nesting level of the loop.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc8c9|0xC9]]<br />
|Return to Loop Point Up to N Times<br />
|2<br />
|times: byte<br />
|On the Nth repeat, this instruction will end the current loop by decrementing the nesting level of the loop. Otherwise, it will increment the loop counter and return to the loop point.<br />
When <code>times</code> is 0, it will be translated to 256 times.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc8c9|0xCA]]<br />
|Return to Loop Point<br />
|1<br />
|<br />
|This instruction will increment the loop counter.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xcb|0xCB]]<br />
|Reset Sound Effects<br />
|1<br />
|<br />
|Reset sound effects such as noise, frequency modulation, reverb, overlay voice and alternate voice.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xcccd|0xCC]]<br />
|Turn On Legato<br />
|1<br />
|<br />
|This instruction will stop the regular key on and key off performance of the subsequent notes and update the pitch only.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xcccd|0xCD]]<br />
|Turn Off Legato<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xcecf|0xCE]]<br />
|Turn On Noise and Toggle Noise On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xcecf|0xCF]]<br />
|Toggle Noise On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd0d1|0xD0]]<br />
|Turn On Full-Length Note Mode<br />
|1<br />
|<br />
|This instruction will stop the regular key off performance of the subsequent notes.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd0d1|0xD1]]<br />
|Turn Off Full-Length Note Mode<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd2d3|0xD2]]<br />
|Turn On Frequency Modulation and Toggle Frequency Modulation On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd2d3|0xD3]]<br />
|Toggle Frequency Modulation On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd4d5|0xD4]]<br />
|Turn On Playback Rate Side Chain<br />
|1<br />
|<br />
|Duplicate and use the playback frequency of the previous voice channel.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd4d5|0xD5]]<br />
|Turn Off Playback Rate Side Chain<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd6d7|0xD6]]<br />
|Turn On Pitch-Volume Side Chain<br />
|1<br />
|<br />
|Multiply the playback frequency of the previous voice channel to the output volume. Lower pitch will make the volume smaller.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd6d7|0xD7]]<br />
|Turn Off Pitch-Volume Side Chain<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd8d9|0xD8]]<br />
|Channel Fine Tuning (Absolute)<br />
|2<br />
|amount: signed byte<br />
|The pitch can be changed in the range of one octave above and below.<br />
The <code>amount</code> is the multiplicand for the playback frequency, not a log-based parameter like cents. For example, when the <code>amount</code> is 127, the pitch will be multiplied by 127/128 (about +1 octave). Negative value will lower the pitch.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd8d9|0xD9]]<br />
|Channel Fine Tuning (Relative)<br />
|2<br />
|amount: signed byte<br />
|The <code>amount</code> will be added to the current tuning amount.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xdadb|0xDA]]<br />
|Turn On Portamento<br />
|2<br />
|speed: byte<br />
|When <code>speed</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xdadb|0xDB]]<br />
|Turn Off Portamento<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0x0099|0xDC]]<br />
|Fix Note Length<br />
|2<br />
|length_to_add: signed byte<br />
|Ignore the regular length (delta-time) of subsequent notes and set to the fixed length. The <code>length_to_add</code> parameter will be added to the current length value. (the initial value is 0)<br />
|-<br />
|[[FF9/Sound/Opcodes/0xdd|0xDD]]<br />
|Vibrato Depth Slide<br />
|3<br />
|length: byte, depth: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xde|0xDE]]<br />
|Tremolo Depth Slide<br />
|3<br />
|length: byte, depth: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xdf|0xDF]]<br />
|Channel Pan LFO Depth Slide<br />
|3<br />
|length: byte, depth: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe0|0xE0]]<br />
|Unknown<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe1|0xE1]]<br />
|Unknown<br />
|2<br />
|value: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe2|0xE2]]<br />
|Unknown<br />
|1<br />
|<br />
|Clears the effect of opcode 0xE1<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe3|0xE3]]<br />
|Unimplemented<br />
|1<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe4|0xE4]]<br />
|Vibrato Rate Slide<br />
|3<br />
|length: byte, rate: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe5|0xE5]]<br />
|Tremolo Rate Slide<br />
|3<br />
|length: byte, rate: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe6|0xE6]]<br />
|Channel Pan LFO Rate Slide<br />
|3<br />
|length: byte, rate: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xE7-0xEF]]<br />
|Unimplemented<br />
|1<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xf0fd|0xF0-0xFD]]<br />
|Note, Tie, Rest with Length<br />
|2<br />
|length: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe00|0xFE 0x00]]<br />
|Tempo<br />
|4<br />
|tempo: uint16<br />
|bpm = tempo / 218.453333 (approximate)<br />
More strictly, <code>bpm = 60.0 / (48 * (65536.0 / tempo) * (0x43D1 / (33868800.0 / 8)))</code><br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe00|0xFE 0x01]]<br />
|Tempo Slide<br />
|5<br />
|length: byte, tempo: uint16<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe02|0xFE 0x02]]<br />
|Reverb Depth<br />
|4<br />
|depth: uint16<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe02|0xFE 0x03]]<br />
|Reverb Depth Slide<br />
|5<br />
|length: byte, depth: uint16<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe04|0xFE 0x04]]<br />
|Turn On Drum Mode<br />
|2<br />
|<br />
|The drum map offset is recorded in the file header.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe04|0xFE 0x05]]<br />
|Turn Off Drum Mode<br />
|2<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe06|0xFE 0x06]]<br />
|Unconditional Jump<br />
|4<br />
|destination_offset: signed int16<br />
|This instruction can be used to make an infinite loop.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe07|0xFE 0x07]]<br />
|CPU-Conditional Jump<br />
|5<br />
|condition: byte, destination_offset: signed int16<br />
|Jump if the condition variable matches <code>condition</code>. The value of the condition variable can be set from the game program.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe08|0xFE 0x08]]<br />
|Jump on the Nth Repeat<br />
|5<br />
|times: byte, destination_offset: signed int16<br />
|When <code>times</code> is 0, it will be translated to 256 times.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe08|0xFE 0x09]]<br />
|Break the Loop on the Nth Repeat<br />
|5<br />
|times: byte, destination_offset: signed int16<br />
|Unlike 0xF0, this instruction will end the current loop by decrementing the nesting level of the loop.<br />
When <code>times</code> is 0, it will be translated to 256 times.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa1|0xFE 0x0A]]<br />
|Load Instrument (No Attack Sample)<br />
|3<br />
|instrument: byte<br />
|Unlike 0xA1, the sample before the loop point is replaced by a short, silence sample.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe0b|0xFE 0x0B]]<br />
|Unknown<br />
|6<br />
|offset: signed int16, offset2: signed int16<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xFE 0x0C-0x0D]]<br />
|Unimplemented<br />
|2<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe0e|0xFE 0x0E]]<br />
|Pattern<br />
|4<br />
|destination_offset: signed int16<br />
|Remember the return address and jump to the specified location. It cannot be nested.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe0f|0xFE 0x0F]]<br />
|End Pattern<br />
|2<br />
|<br />
|Return from opcode 0xFE 0x0E.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe10|0xFE 0x10]]<br />
|Allocate Reserved Voices<br />
|3<br />
|count: byte<br />
|Reserve the specified <code>count</code> of hardware voices. Reserved voices will not be used unless explicitly specified in opcode 0xFE 0x1D.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe10|0xFE 0x11]]<br />
|Free Reserved Voices<br />
|2<br />
|<br />
|Set the count of reserved voices to 0.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa3|0xFE 0x12]]<br />
|Channel Master Volume Slide<br />
|3<br />
|length: byte, volume: byte (0-127)<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xFE 0x13]]<br />
|Unimplemented<br />
|2<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe14|0xFE 0x14]]<br />
|Load Custom Instrument (Key-Split Instrument)<br />
|3<br />
|instrument: byte<br />
|The custom instrument number corresponds to the custom instrument map pointed from the file header. Note that the number is different from the regular sample number used in opcode 0xA1.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe15|0xFE 0x15]]<br />
|Time Signature<br />
|4<br />
|ticks_per_beat: byte, beats_per_measure: byte<br />
|Note that two parameters can be 0. This pattern is used for initialization.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe16|0xFE 0x16]]<br />
|Measure Number<br />
|3<br />
|measure: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xFE 0x17-0x18]]<br />
|Unimplemented<br />
|2<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa9|0xFE 0x19]]<br />
|Channel Volume Slide Per Note On<br />
|4<br />
|length: byte, volume: byte (0-127)<br />
|Applies volume slide (opcode 0xA9) for each notes. When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe1a|0xFE 0x1A]]<br />
|Unknown<br />
|2<br />
|<br />
|Turn something on.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe1b|0xFE 0x1B]]<br />
|Unknown<br />
|2<br />
|<br />
|Clears the effect of opcode 0xFE 0x1A.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe1c|0xFE 0x1C]]<br />
|Unknown<br />
|3<br />
|value: byte<br />
|Obsoleted opcode? As far as I learned from the assembly code, it probably does nothing.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe1d|0xFE 0x1D]]<br />
|Use Reserved Voices<br />
|2<br />
|<br />
|Allow using the reserved voices to play the sound of the current track. If they are all used, the remaining voices will instead be used normally.<br />
<br />
Use opcode [[FF9/Sound/Opcodes/0xfe10|0xFE 0x10]] to allocate reserved voices.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe1e|0xFE 0x1E]]<br />
|Use No Reserved Voices<br />
|2<br />
|<br />
|Disable the effect of opcode 0xFE 0x1D.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xFE 0x1F]]<br />
|Unimplemented<br />
|2<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|0xFE 0x20-0xFF<br />
|Unimplemented (Out of Range)<br />
|n/a<br />
|<br />
|Do not use.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xFF]]<br />
|Unimplemented<br />
|1<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|}</div>
Loveemu
https://wiki.ffrtt.ru/index.php?title=FF7/PSX/Sound/AKAO_sequence&diff=5774
FF7/PSX/Sound/AKAO sequence
2020-07-30T09:36:58Z
<p>Loveemu: Fix AkaoChannelInfo mask bits</p>
<hr />
<div>== Introduction ==<br />
AKAO sequence is the most complicated part of the FF7 sound system. ("AKAO" is the signature string, which implies that the sound format has developed by Square Enix sound programmer Minoru Akao.)<br />
<br />
AKAO sequence is similar to MIDI sequence - it's custom tracker format for playing sequence sound, well tuned specially for PSX.<br />
<br />
The sequence data can be found in all FF7 game modules: Field, Battle, Worldmap and in minigames.<br />
<br />
All files with exension *.SND are AKAO.<br />
<br />
* '''MINI/ASERI2.SND''' - Battle Arena theme<br />
* '''MINI/SENSUI.SND''' - used in Submarine minigame<br />
* '''ENEMY6/OVER2.SND''' - game over sequence<br />
* '''ENEMY6/FAN2.SND''' - battle win "fanfare" sequence<br />
* '''MOVIE/OVER2.SND''' - same game over sequence, don't know, why to duplicate data<br />
<br />
Other AKAO sequences are hard-wired in other files.<br />
<br />
<br />
== File Structure ==<br />
=== Header (size: 16 bytes) ===<br />
<br />
struct AkaoSeqHeader<br />
{<br />
static const uint8_t magic[4]; // "AKAO" C-string<br />
uint16_t id; // song ID, used for playing sequence<br />
uint16_t length; // data length - sizeof(header)<br />
uint16_t reverb_type; // reverb type (range from 0 to 9)<br />
struct AkaoTimeStamp timestamp; // creation time<br />
};<br />
<br />
struct AkaoTimeStamp<br />
{<br />
uint8_t year_bcd; // year (in binary coded decimal)<br />
uint8_t month_bcd; // month (in binary coded decimal, between 0x01 - 0x12)<br />
uint8_t day_bcd; // day (in binary coded decimal, between 0x01 - 0x31)<br />
uint8_t hours_bcd; // hours (in binary coded decimal, between 0x00 - 0x23)<br />
uint8_t minutes_bcd; // minutes (in binary coded decimal, between 0x00 - 0x59)<br />
uint8_t seconds_bcd; // seconds (in binary coded decimal, between 0x00 - 0x59)<br />
};<br />
<br />
=== Channel Info (size: 4 bytes + 2 bytes * <channels count>) ===<br />
struct AkaoChannelInfo<br />
{<br />
uint32_t mask; // represents bitmask of used channels in this song<br />
uint32_t start_offsets[num_channels]; // offsets to channel opcode data<br />
};<br />
<br />
int num_channels = 0;<br />
while (int bit = 0; bit < 24; bit++)<br />
if ((info.mask & 0xFFFFFF) & (1 << bit)) != 0)<br />
num_channels++;<br />
<br />
First there is 32-bit number (offset 0x10), which represents bitmask of used channels in this song.<br />
<br />
After this bitmask, there is <channels count> offsets to channel opcode data counting from current offset. Each offsets is a relative offset based on the address *next to* the offset itself. (This is a general rule for early versions of AKAO to interpret relative offsets.)<br />
<br />
<br />
=== Channel Commands [AKAO Opcodes] ===<br />
For every channels in an AKAO sequence, there is a set of commands to perform. This is similar to Field opcodes. Here I will call this sound commands "opcodes". Every opcode has its own number of arguments (from no-arguments, to 3 arguments).<br />
<br />
=== Drum Instrument Map Table ===<br />
<br />
When a song uses a drum kit with [[FF7/PSX/Sound/Opcodes/0xeced|opcode 0xEC]], a drum instrument map table will be placed at the end of the sequence. The table determines the instrument, channel volume and pan for each keys.<br />
<br />
The table consists of a repetition of 5-byte items.<br />
<br />
struct AkaoDrumKeyAttr<br />
{<br />
uint8_t instrument; // corresponding to opcode 0xA1<br />
uint8_t key; // note number when playing the drum note<br />
uint16_t volume; // corresponding to opcode 0xA8 (lower 8bit is a fractional part of the volume)<br />
uint8_t pan; // corresponding to opcode 0xAA<br />
}<br />
<br />
== Example (Home-Created AKAO Sequence): ==<br />
=== Header ===<br />
'''41 4b 41 4f''' - AKAO string<br />
<br />
'''34 12''' - song ID: 0x1234<br />
<br />
'''16 00''' - data length 0x16 in hex or 22 in decimal<br />
<br />
'''04 00''' - reverb type: 4 (large studio)<br />
<br />
'''96 12 18 22 46 28''' - created at 1996-12-18 22:46:28<br />
<br />
<br />
=== Channel Info ===<br />
'''01 00 00 00''' - this indicates, that used only one channel<br />
<br />
'''00 00''' - offset to first channel opcodes: in our example 0x00 means that next to this offset is opcodes for first channel<br />
<br />
<br />
=== Channel Commands ===<br />
'''e8 a8 66''' - sets tempo, parameter 0x66a8<br />
<br />
'''ea 00 50''' - sets reverb depth<br />
<br />
'''a8 55''' - load sample 0x55 from INSTR.ALL to channel<br />
<br />
'''aa 40''' - sets channel volume<br />
<br />
'''c2''' - turns on reverb effect<br />
<br />
'''a1 0c''' - sets volume pan<br />
<br />
'''c8''' - sets loop point<br />
<br />
'''66''' - 0x66 % 11 = 3 (3 means to take 3rd number from play length table), 0x66 / 11 = 9 (9 means to take pitch[9] from loaded instrument record index)<br />
<br />
'''ca''' - returns to saved loop point with opcode c8<br />
<br />
<br />
This example plays Chocobo "Whoo-Hoo" (instrument number 0x55) repeatedly.<br />
<br />
<br />
== Sound Opcode List ==<br />
<br />
{| class="wikitable"<br />
! Opcode<br />
! Summary<br />
! Length<br />
! Operands<br />
! Note<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0x0099|0x00-0x99]]<br />
|Note, Tie, Rest<br />
|1<br />
|<br />
|The opcode indicates the note key and length. The note will be keyed off 2 ticks before the next note.<br />
|-<br />
|0x9A-0x9F<br />
|Unimplemented<br />
|1<br />
|<br />
|Should not be used.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa0|0xA0]]<br />
|Finish Channel<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa1|0xA1]]<br />
|Load Instrument<br />
|2<br />
|instrument: byte (0-127)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0x0099|0xA2]]<br />
|Overwrite Next Note Length<br />
|2<br />
|length: byte<br />
|Ignores the regular length (delta-time) of the next note and overwrites it with the specified length.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa8aa|0xA3]]<br />
|Channel Master Volume<br />
|2<br />
|volume: byte (0-127)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa4|0xA4]]<br />
|Pitch Bend Slide<br />
|3<br />
|length: byte, semitones: signed byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa5|0xA5]]<br />
|Set Octave<br />
|2<br />
|octave: byte (0-15)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa5|0xA6]]<br />
|Increase Octave<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa5|0xA7]]<br />
|Decrease Octave<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa8aa|0xA8]]<br />
|Channel Volume<br />
|2<br />
|volume: byte (0-127)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa9|0xA9]]<br />
|Channel Volume Slide<br />
|3<br />
|length: byte, volume: byte (0-127)<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa8aa|0xAA]]<br />
|Channel Pan<br />
|2<br />
|pan: byte (0-127)<br />
|64 is the center.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xab|0xAB]]<br />
|Channel Pan Slide<br />
|3<br />
|length: byte, pan: byte (0-127)<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xac|0xAC]]<br />
|Noise Clock Frequency<br />
|2<br />
|clock: byte (0x00-0x3f)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/ADSR|0xAD]]<br />
|ADSR: Attack Rate<br />
|2<br />
|attack_rate: byte (0x00-0x7f)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/ADSR|0xAE]]<br />
|ADSR: Decay Rate<br />
|2<br />
|decay_rate: byte (0x00-0x0f)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/ADSR|0xAF]]<br />
|ADSR: Sustain Level<br />
|2<br />
|sustain_level: byte (0x00-0x0f)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/ADSR|0xB0]]<br />
|ADSR: Decay Rate & Sustain Level<br />
|3<br />
|decay_rate: byte (0x00-0x0f), sustain_level: byte (0x00-0x0f)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/ADSR|0xB1]]<br />
|ADSR: Sustain Rate<br />
|2<br />
|sustain_rate: byte (0x00-0x7f)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/ADSR|0xB2]]<br />
|ADSR: Release Rate<br />
|2<br />
|release_rate: byte (0x00-0x1f)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/ADSR|0xB3]]<br />
|ADSR: Reset ADSR<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xb4b5|0xB4]]<br />
|Vibrato (Channel Pitch LFO)<br />
|4<br />
|delay: byte, rate: byte, type: byte (0-15)<br />
|When <code>rate</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xb4b5|0xB5]]<br />
|Vibrato Depth<br />
|2<br />
|depth: byte<br />
|The most significant bit of the <code>depth</code> determines the amplitude range.<br />
<br />
When it is 0, the range is up to about ± 50 cents (amplitude is 15/256 compared with range type 1).<br />
<br />
When it is 1, the range is up to about ± 700 cents.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xb4b5|0xB6]]<br />
|Turn Off Vibrato<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/ADSR|0xB7]]<br />
|ADSR: Attack Mode<br />
|2<br />
|attack_mode: byte (1 or 5)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xb8b9|0xB8]]<br />
|Tremolo (Channel Volume LFO)<br />
|4<br />
|delay: byte, rate: byte, type: byte (0-15)<br />
|When <code>rate</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xb8b9|0xB9]]<br />
|Tremolo Depth<br />
|2<br />
|depth: byte<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xb8b9|0xBA]]<br />
|Turn Off Tremolo<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/ADSR|0xBB]]<br />
|ADSR: Sustain Mode<br />
|2<br />
|sustain_mode: byte (1, 3, 5 or 7)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xbcbd|0xBC]]<br />
|Channel Pan LFO<br />
|3<br />
|rate: byte, type: byte (0-15)<br />
|When <code>rate</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xbcbd|0xBD]]<br />
|Channel Pan LFO Depth<br />
|2<br />
|depth: byte<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xbcbd|0xBE]]<br />
|Turn Off Channel Pan LFO<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xbf|0xBF]]<br />
|ADSR: Release Mode<br />
|2<br />
|release_mode: byte (3 or 7)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc0c1|0xC0]]<br />
|Channel Transpose (Absolute)<br />
|2<br />
|semitones: signed byte<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc0c1|0xC1]]<br />
|Channel Transpose (Relative)<br />
|2<br />
|semitones: signed byte<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc2c3|0xC2]]<br />
|Turn On Reverb<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc2c3|0xC3]]<br />
|Turn Off Reverb<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc4c5|0xC4]]<br />
|Turn On Noise<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc4c5|0xC5]]<br />
|Turn Off Noise<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc6c7|0xC6]]<br />
|Turn On Frequency Modulation<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc6c7|0xC7]]<br />
|Turn Off Frequency Modulation<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc8c9|0xC8]]<br />
|Loop Point<br />
|1<br />
|<br />
|Remember the current offset as a loop point and increase the nesting level of the loop.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc8c9|0xC9]]<br />
|Return to Loop Point Up to N Times<br />
|2<br />
|times: byte<br />
|On the Nth repeat, this instruction will end the current loop by decrementing the nesting level of the loop. Otherwise, it will increment the loop counter and return to the loop point.<br />
When <code>times</code> is 0, it will be translated to 256 times.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc8c9|0xCA]]<br />
|Return to Loop Point<br />
|1<br />
|<br />
|This instruction will increment the loop counter.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xcb|0xCB]]<br />
|Reset Sound Effects<br />
|1<br />
|<br />
|Reset sound effects such as noise, frequency modulation, reverb, overlay voice and alternate voice.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xcccd|0xCC]]<br />
|Turn On Legato<br />
|1<br />
|<br />
|This instruction will stop the regular key on and key off performance of the subsequent notes and update the pitch only.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xcccd|0xCD]]<br />
|Turn Off Legato<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xcecf|0xCE]]<br />
|Turn On Noise and Toggle Noise On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xcecf|0xCF]]<br />
|Toggle Noise On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xd0d1|0xD0]]<br />
|Turn On Full-Length Note Mode<br />
|1<br />
|<br />
|This instruction will stop the regular key off performance of the subsequent notes.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xd0d1|0xD1]]<br />
|Turn Off Full-Length Note Mode<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xd2d3|0xD2]]<br />
|Turn On Frequency Modulation and Toggle Frequency Modulation On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xd2d3|0xD3]]<br />
|Toggle Frequency Modulation On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xd4d5|0xD4]]<br />
|Turn On Playback Rate Side Chain<br />
|1<br />
|<br />
|Duplicate and use the playback frequency of the previous voice channel.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xd4d5|0xD5]]<br />
|Turn Off Playback Rate Side Chain<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xd6d7|0xD6]]<br />
|Turn On Pitch-Volume Side Chain<br />
|1<br />
|<br />
|Multiply the playback frequency of the previous voice channel to the output volume. Lower pitch will make the volume smaller.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xd6d7|0xD7]]<br />
|Turn Off Pitch-Volume Side Chain<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xd8d9|0xD8]]<br />
|Channel Fine Tuning (Absolute)<br />
|2<br />
|amount: signed byte<br />
|The pitch can be changed in the range of one octave above and below.<br />
The <code>amount</code> is the multiplicand for the playback frequency, not a log-based parameter like cents. For example, when the <code>amount</code> is 127, the pitch will be multiplied by 127/128 (about +1 octave). Negative value will lower the pitch.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xd8d9|0xD9]]<br />
|Channel Fine Tuning (Relative)<br />
|2<br />
|amount: signed byte<br />
|The <code>amount</code> will be added to the current tuning amount.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xdadb|0xDA]]<br />
|Turn On Portamento<br />
|2<br />
|speed: byte<br />
|When <code>speed</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xdadb|0xDB]]<br />
|Turn Off Portamento<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0x0099|0xDC]]<br />
|Fix Note Length<br />
|2<br />
|length_to_add: signed byte<br />
|Ignore the regular length (delta-time) of subsequent notes and set to the fixed length. The <code>length_to_add</code> parameter will be added to the current length value. (the initial value is 0)<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xdd|0xDD]]<br />
|Vibrato Depth Slide<br />
|3<br />
|length: byte, depth: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xde|0xDE]]<br />
|Tremolo Depth Slide<br />
|3<br />
|length: byte, depth: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xdf|0xDF]]<br />
|Channel Pan LFO Depth Slide<br />
|3<br />
|length: byte, depth: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa0|0xE0-0xE7]]<br />
|Unimplemented<br />
|1<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xe8e9|0xE8]]<br />
|Tempo<br />
|3<br />
|tempo: uint16<br />
|bpm = tempo / 214.998204 (approximate)<br />
More strictly, <code>bpm = 60.0 / (48 * (65536.0 / tempo) * (0x44E8 / (33868800.0 / 8)))</code><br />
<br />
Note that this coefficient is different from other games with PlayStation AKAO.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xe8e9|0xE9]]<br />
|Tempo Slide<br />
|4<br />
|length: byte, tempo: uint16<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xeaeb|0xEA]]<br />
|Reverb Depth<br />
|3<br />
|depth: uint16<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xeaeb|0xEB]]<br />
|Reverb Depth Slide<br />
|4<br />
|length: byte, depth: uint16<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xeced|0xEC]]<br />
|Turn On Drum Mode<br />
|3<br />
|drum_map_offset: signed int16<br />
|The <code>drum_map_offset</code> is a relative offset pointing to the drum instrument map table, which determines the instrument for each keys.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xeced|0xED]]<br />
|Turn Off Drum Mode<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xee|0xEE]]<br />
|Unconditional Jump<br />
|3<br />
|destination_offset: signed int16<br />
|This instruction can be used to make an infinite loop.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xef|0xEF]]<br />
|CPU-Conditional Jump<br />
|4<br />
|condition: byte, destination_offset: signed int16<br />
|Jump if the condition variable matches <code>condition</code>. The value of the condition variable can be set from the game program.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xf0f1|0xF0]]<br />
|Jump on the Nth Repeat<br />
|4<br />
|times: byte, destination_offset: signed int16<br />
|When <code>times</code> is 0, it will be translated to 256 times.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xf0f1|0xF1]]<br />
|Break the Loop on the Nth Repeat<br />
|4<br />
|times: byte, destination_offset: signed int16<br />
|Unlike 0xF0, this instruction will end the current loop by decrementing the nesting level of the loop.<br />
When <code>times</code> is 0, it will be translated to 256 times.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa1|0xF2]]<br />
|Load Instrument (No Attack Sample)<br />
|2<br />
|instrument: byte<br />
|Unlike 0xA1, the sample before the loop point is replaced by a short, silence sample.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xf3|0xF3]]<br />
|Unknown<br />
|1<br />
|<br />
|There is no actual use in music.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xf4f5|0xF4]]<br />
|Turn On Overlay Voice<br />
|3<br />
|instrument: byte, instrument2: byte<br />
|Play the same melody by different instruments on two voice channels. A free voice channel is required to work. Note that the two channels share the playback rate, and the pitch is not calculated for each instruments.<br />
Used in the song "Anxious Heart".<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xf4f5|0xF5]]<br />
|Turn Off Overlay Voice<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xf4f5|0xF6]]<br />
|Overlay Volume Balance<br />
|2<br />
|balance: byte (0-127)<br />
|When the balance is 0, the volume of the primary voice will be 100% (127/128) of original and that of the secondary voice will be 0%. 127 is the opposite.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xf4f5|0xF7]]<br />
|Overlay Volume Balance Slide<br />
|3<br />
|length: byte, balance: byte (0-127)<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xf8f9|0xF8]]<br />
|Turn On Alternate Voice<br />
|2<br />
|release_rate: byte (0x00-0x1f)<br />
|This instruction allows subsequent notes to be played on two alternating channels. At the same time, the ADSR release rate will be set to the specified value. A free voice channel is required to work. <br />
Check "Opening - Bombing Mission", "Tifa's Theme" and "Fortress of the Condor" for actual usage.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xf8f9|0xF9]]<br />
|Turn Off Alternate Voice<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa0|0xFA-0xFC]]<br />
|Unimplemented<br />
|1<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xfd|0xFD]]<br />
|Time Signature<br />
|3<br />
|ticks_per_beat: byte, beats_per_measure: byte<br />
|Note that two parameters can be 0. This pattern is used for initialization.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xfe|0xFE]]<br />
|Measure Number<br />
|2<br />
|measure: byte<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa0|0xFF]]<br />
|Unimplemented<br />
|1<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|}</div>
Loveemu
https://wiki.ffrtt.ru/index.php?title=FF9/Sound/AKAO_sequence&diff=5773
FF9/Sound/AKAO sequence
2020-07-25T07:54:00Z
<p>Loveemu: "The note will be keyed off 2 ticks before the next note." Lied. This cannot be applied to the late version of AKAO.</p>
<hr />
<div>== Introduction ==<br />
AKAO sequence is similar to MIDI sequence - it's custom tracker format for playing sequence sound, well tuned specially for PSX.<br />
<br />
<br />
== File Structure ==<br />
=== Header (size: 64 bytes) ===<br />
<br />
struct AkaoSeqHeader<br />
{<br />
static const uint8_t magic[4]; // "AKAO" C-string<br />
uint16_t id; // song ID, used for playing sequence<br />
uint16_t length; // data length (including this header)<br />
uint16_t reverb_type; // reverb type (range from 0 to 9)<br />
uint8_t field_0A[6];<br />
uint32_t field_10;<br />
uint16_t sample_set_id; // associated sample set ID<br />
uint16_t field_12;<br />
uint32_t field_14;<br />
uint32_t field_18;<br />
uint32_t field_1C;<br />
uint32_t mask; // represents bitmask of used channels in this song<br />
uint32_t field_24;<br />
uint32_t field_28;<br />
uint32_t field_2C;<br />
uint32_t instrument_map_offset; // relative offset to custom instrument map (0 if unused)<br />
uint32_t drum_map_offset; // relative offset to custom drum map (0 if unused)<br />
uint32_t field_38;<br />
uint32_t field_3C;<br />
};<br />
<br />
=== Channel Offsets (size: 2 bytes * <channels count>) ===<br />
struct AkaoChannelInfo<br />
{<br />
uint32_t start_offsets[num_channels]; // offsets to channel opcode data<br />
};<br />
<br />
AkaoSeqHeader *header;<br />
int num_channels = 0;<br />
while (int bit = 0; header->mask & (1 << bit)) != 0; bit++)<br />
num_channels++;<br />
<br />
There is <channels count> offsets to channel opcode data counting from current offset. Each offsets is a relative offset based on the address the offset itself.<br />
<br />
<br />
=== Channel Commands [AKAO Opcodes] ===<br />
For every channels in an AKAO sequence, there is a set of commands to perform. This is similar to Field opcodes. Here I will call this sound commands "opcodes". Every opcode has its own number of arguments.<br />
<br />
=== Custom Instrument Map Table ===<br />
<br />
When a song uses custom instruments with [[FF9/Sound/Opcodes/0xfe14|opcode 0xFE 0x14]], a custom instrument map table will be placed after the end of AKAO opcode sequence.<br />
<br />
This table consists of a collection of zones representing performance settings for a particular key range. A zone is an 8-byte item, and an instrument can have one or more regions.<br />
<br />
struct AkaoInstrumentZoneAttr<br />
{<br />
uint8_t instrument; // corresponding to opcode 0xA1<br />
uint8_t low_key; // lowest key (in note number)<br />
uint8_t high_key; // highest key (in note number)<br />
uint8_t ar; // ADSR: attack rate (0-127)<br />
uint8_t sr; // ADSR: sustain rate (0-127)<br />
uint8_t s_mode; // ADSR: sustain mode (1: linear increase, 3: linear decrease, 5: exponential increase, 7: exponential decrease)<br />
uint8_t rr; // ADSR: release rate (0-31)<br />
uint8_t volume; // adjust the note volume to n/128 of the original volume (0 will keep the original volume)<br />
}<br />
<br />
- Zones must be ordered from low key to high key<br />
- The final zone of the instrument must be a terminator filled with 0s (more precisely, a zone with ADSR sustain mode of 0 is considered a terminator)<br />
<br />
=== Drum Instrument Map Table ===<br />
<br />
When a song uses a drum kit with [[FF9/Sound/Opcodes/0xfe04|opcode 0xFE 0x04]], a drum instrument map table will be placed at the end of the sequence. The table determines the instrument, channel volume and pan for each keys.<br />
<br />
The table consists of a repetition of 8-byte items.<br />
<br />
struct AkaoDrumKeyAttr<br />
{<br />
uint8_t instrument; // corresponding to opcode 0xA1<br />
uint8_t key; // note number when playing the drum note<br />
uint8_t ar; // ADSR: attack rate (0-127)<br />
uint8_t sr; // ADSR: sustain rate (0-127)<br />
uint8_t s_mode; // ADSR: sustain mode (1: linear increase, 3: linear decrease, 5: exponential increase, 7: exponential decrease)<br />
uint8_t rr; // ADSR: release rate (0-31)<br />
uint8_t volume; // adjust the percussion volume to n/128 of the original volume (0 will keep the original volume)<br />
uint8_t pan : 7; // corresponding to opcode 0xAA<br />
uint8_t reverb : 1; // reverb on/off (0: off, 1: on)<br />
}<br />
<br />
<br />
== Sound Opcode List ==<br />
<br />
{| class="wikitable"<br />
! Opcode<br />
! Summary<br />
! Length<br />
! Operands<br />
! Note<br />
|-<br />
|[[FF9/Sound/Opcodes/0x0099|0x00-0x99]]<br />
|Note, Tie, Rest<br />
|1<br />
|<br />
|The opcode indicates the note key and length.<br />
|-<br />
|0x9A-0x9F<br />
|Unimplemented<br />
|1<br />
|<br />
|Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xA0]]<br />
|Finish Channel<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa1|0xA1]]<br />
|Load Instrument<br />
|2<br />
|instrument: byte (0-127)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0x0099|0xA2]]<br />
|Overwrite Next Note Length<br />
|2<br />
|length: byte<br />
|Ignores the regular length (delta-time) of the next note and overwrites it with the specified length.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa8aa|0xA3]]<br />
|Channel Master Volume<br />
|2<br />
|volume: byte (0-127)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa4|0xA4]]<br />
|Pitch Bend Slide<br />
|3<br />
|length: byte, semitones: signed byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa5|0xA5]]<br />
|Set Octave<br />
|2<br />
|octave: byte (0-15)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa5|0xA6]]<br />
|Increase Octave<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa5|0xA7]]<br />
|Decrease Octave<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa8aa|0xA8]]<br />
|Channel Volume<br />
|2<br />
|volume: byte (0-127)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa9|0xA9]]<br />
|Channel Volume Slide<br />
|3<br />
|length: byte, volume: byte (0-127)<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa8aa|0xAA]]<br />
|Channel Pan<br />
|2<br />
|pan: byte (0-127)<br />
|64 is the center.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xab|0xAB]]<br />
|Channel Pan Slide<br />
|3<br />
|length: byte, pan: byte (0-127)<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xac|0xAC]]<br />
|Noise Clock Frequency<br />
|2<br />
|clock: byte (0x00-0x3f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xAD]]<br />
|ADSR: Attack Rate<br />
|2<br />
|attack_rate: byte (0x00-0x7f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xAE]]<br />
|ADSR: Decay Rate<br />
|2<br />
|decay_rate: byte (0x00-0x0f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xAF]]<br />
|ADSR: Sustain Level<br />
|2<br />
|sustain_level: byte (0x00-0x0f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xB0]]<br />
|ADSR: Decay Rate & Sustain Level<br />
|3<br />
|decay_rate: byte (0x00-0x0f), sustain_level: byte (0x00-0x0f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xB1]]<br />
|ADSR: Sustain Rate<br />
|2<br />
|sustain_rate: byte (0x00-0x7f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xB2]]<br />
|ADSR: Release Rate<br />
|2<br />
|release_rate: byte (0x00-0x1f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xB3]]<br />
|ADSR: Reset ADSR<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb4b5|0xB4]]<br />
|Vibrato (Channel Pitch LFO)<br />
|4<br />
|delay: byte, rate: byte, type: byte (0-15)<br />
|When <code>rate</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb4b5|0xB5]]<br />
|Vibrato Depth<br />
|2<br />
|depth: byte<br />
|The most significant bit of the <code>depth</code> determines the amplitude range.<br />
<br />
When it is 0, the range is up to about ± 50 cents (amplitude is 15/256 compared with range type 1).<br />
<br />
When it is 1, the range is up to about ± 700 cents.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb4b5|0xB6]]<br />
|Turn Off Vibrato<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xB7]]<br />
|ADSR: Attack Mode<br />
|2<br />
|attack_mode: byte (1 or 5)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb8b9|0xB8]]<br />
|Tremolo (Channel Volume LFO)<br />
|4<br />
|delay: byte, rate: byte, type: byte (0-15)<br />
|When <code>rate</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb8b9|0xB9]]<br />
|Tremolo Depth<br />
|2<br />
|depth: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb8b9|0xBA]]<br />
|Turn Off Tremolo<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xBB]]<br />
|ADSR: Sustain Mode<br />
|2<br />
|sustain_mode: byte (1, 3, 5 or 7)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xbcbd|0xBC]]<br />
|Channel Pan LFO<br />
|3<br />
|rate: byte, type: byte (0-15)<br />
|When <code>rate</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xbcbd|0xBD]]<br />
|Channel Pan LFO Depth<br />
|2<br />
|depth: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xbcbd|0xBE]]<br />
|Turn Off Channel Pan LFO<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xbf|0xBF]]<br />
|ADSR: Release Mode<br />
|2<br />
|release_mode: byte (3 or 7)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc0c1|0xC0]]<br />
|Channel Transpose (Absolute)<br />
|2<br />
|semitones: signed byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc0c1|0xC1]]<br />
|Channel Transpose (Relative)<br />
|2<br />
|semitones: signed byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc2c3|0xC2]]<br />
|Turn On Reverb<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc2c3|0xC3]]<br />
|Turn Off Reverb<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc4c5|0xC4]]<br />
|Turn On Noise<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc4c5|0xC5]]<br />
|Turn Off Noise<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc6c7|0xC6]]<br />
|Turn On Frequency Modulation<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc6c7|0xC7]]<br />
|Turn Off Frequency Modulation<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc8c9|0xC8]]<br />
|Loop Point<br />
|1<br />
|<br />
|Remember the current offset as a loop point and increase the nesting level of the loop.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc8c9|0xC9]]<br />
|Return to Loop Point Up to N Times<br />
|2<br />
|times: byte<br />
|On the Nth repeat, this instruction will end the current loop by decrementing the nesting level of the loop. Otherwise, it will increment the loop counter and return to the loop point.<br />
When <code>times</code> is 0, it will be translated to 256 times.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc8c9|0xCA]]<br />
|Return to Loop Point<br />
|1<br />
|<br />
|This instruction will increment the loop counter.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xcb|0xCB]]<br />
|Reset Sound Effects<br />
|1<br />
|<br />
|Reset sound effects such as noise, frequency modulation, reverb, overlay voice and alternate voice.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xcccd|0xCC]]<br />
|Turn On Legato<br />
|1<br />
|<br />
|This instruction will stop the regular key on and key off performance of the subsequent notes and update the pitch only.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xcccd|0xCD]]<br />
|Turn Off Legato<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xcecf|0xCE]]<br />
|Turn On Noise and Toggle Noise On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xcecf|0xCF]]<br />
|Toggle Noise On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd0d1|0xD0]]<br />
|Turn On Full-Length Note Mode<br />
|1<br />
|<br />
|This instruction will stop the regular key off performance of the subsequent notes.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd0d1|0xD1]]<br />
|Turn Off Full-Length Note Mode<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd2d3|0xD2]]<br />
|Turn On Frequency Modulation and Toggle Frequency Modulation On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd2d3|0xD3]]<br />
|Toggle Frequency Modulation On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd4d5|0xD4]]<br />
|Turn On Playback Rate Side Chain<br />
|1<br />
|<br />
|Duplicate and use the playback frequency of the previous voice channel.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd4d5|0xD5]]<br />
|Turn Off Playback Rate Side Chain<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd6d7|0xD6]]<br />
|Turn On Pitch-Volume Side Chain<br />
|1<br />
|<br />
|Multiply the playback frequency of the previous voice channel to the output volume. Lower pitch will make the volume smaller.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd6d7|0xD7]]<br />
|Turn Off Pitch-Volume Side Chain<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd8d9|0xD8]]<br />
|Channel Fine Tuning (Absolute)<br />
|2<br />
|amount: signed byte<br />
|The pitch can be changed in the range of one octave above and below.<br />
The <code>amount</code> is the multiplicand for the playback frequency, not a log-based parameter like cents. For example, when the <code>amount</code> is 127, the pitch will be multiplied by 127/128 (about +1 octave). Negative value will lower the pitch.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd8d9|0xD9]]<br />
|Channel Fine Tuning (Relative)<br />
|2<br />
|amount: signed byte<br />
|The <code>amount</code> will be added to the current tuning amount.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xdadb|0xDA]]<br />
|Turn On Portamento<br />
|2<br />
|speed: byte<br />
|When <code>speed</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xdadb|0xDB]]<br />
|Turn Off Portamento<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0x0099|0xDC]]<br />
|Fix Note Length<br />
|2<br />
|length_to_add: signed byte<br />
|Ignore the regular length (delta-time) of subsequent notes and set to the fixed length. The <code>length_to_add</code> parameter will be added to the current length value. (the initial value is 0)<br />
|-<br />
|[[FF9/Sound/Opcodes/0xdd|0xDD]]<br />
|Vibrato Depth Slide<br />
|3<br />
|length: byte, depth: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xde|0xDE]]<br />
|Tremolo Depth Slide<br />
|3<br />
|length: byte, depth: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xdf|0xDF]]<br />
|Channel Pan LFO Depth Slide<br />
|3<br />
|length: byte, depth: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe0|0xE0]]<br />
|Unknown<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe1|0xE1]]<br />
|Unknown<br />
|2<br />
|value: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe2|0xE2]]<br />
|Unknown<br />
|1<br />
|<br />
|Clears the effect of opcode 0xE1<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe3|0xE3]]<br />
|Unimplemented<br />
|1<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe4|0xE4]]<br />
|Vibrato Rate Slide<br />
|3<br />
|length: byte, rate: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe5|0xE5]]<br />
|Tremolo Rate Slide<br />
|3<br />
|length: byte, rate: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe6|0xE6]]<br />
|Channel Pan LFO Rate Slide<br />
|3<br />
|length: byte, rate: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xE7-0xEF]]<br />
|Unimplemented<br />
|1<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xf0fd|0xF0-0xFD]]<br />
|Note, Tie, Rest with Length<br />
|2<br />
|length: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe00|0xFE 0x00]]<br />
|Tempo<br />
|4<br />
|tempo: uint16<br />
|bpm = tempo / 218.453333 (approximate)<br />
More strictly, <code>bpm = 60.0 / (48 * (65536.0 / tempo) * (0x43D1 / (33868800.0 / 8)))</code><br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe00|0xFE 0x01]]<br />
|Tempo Slide<br />
|5<br />
|length: byte, tempo: uint16<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe02|0xFE 0x02]]<br />
|Reverb Depth<br />
|4<br />
|depth: uint16<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe02|0xFE 0x03]]<br />
|Reverb Depth Slide<br />
|5<br />
|length: byte, depth: uint16<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe04|0xFE 0x04]]<br />
|Turn On Drum Mode<br />
|2<br />
|<br />
|The drum map offset is recorded in the file header.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe04|0xFE 0x05]]<br />
|Turn Off Drum Mode<br />
|2<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe06|0xFE 0x06]]<br />
|Unconditional Jump<br />
|4<br />
|destination_offset: signed int16<br />
|This instruction can be used to make an infinite loop.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe07|0xFE 0x07]]<br />
|CPU-Conditional Jump<br />
|5<br />
|condition: byte, destination_offset: signed int16<br />
|Jump if the condition variable matches <code>condition</code>. The value of the condition variable can be set from the game program.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe08|0xFE 0x08]]<br />
|Jump on the Nth Repeat<br />
|5<br />
|times: byte, destination_offset: signed int16<br />
|When <code>times</code> is 0, it will be translated to 256 times.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe08|0xFE 0x09]]<br />
|Break the Loop on the Nth Repeat<br />
|5<br />
|times: byte, destination_offset: signed int16<br />
|Unlike 0xF0, this instruction will end the current loop by decrementing the nesting level of the loop.<br />
When <code>times</code> is 0, it will be translated to 256 times.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa1|0xFE 0x0A]]<br />
|Load Instrument (No Attack Sample)<br />
|3<br />
|instrument: byte<br />
|Unlike 0xA1, the sample before the loop point is replaced by a short, silence sample.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe0b|0xFE 0x0B]]<br />
|Unknown<br />
|6<br />
|offset: signed int16, offset2: signed int16<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xFE 0x0C-0x0D]]<br />
|Unimplemented<br />
|2<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe0e|0xFE 0x0E]]<br />
|Pattern<br />
|4<br />
|destination_offset: signed int16<br />
|Remember the return address and jump to the specified location. It cannot be nested.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe0f|0xFE 0x0F]]<br />
|End Pattern<br />
|2<br />
|<br />
|Return from opcode 0xFE 0x0E.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe10|0xFE 0x10]]<br />
|Allocate Reserved Voices<br />
|3<br />
|count: byte<br />
|Reserve the specified <code>count</code> of hardware voices. Reserved voices will not be used unless explicitly specified in opcode 0xFE 0x1D.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe10|0xFE 0x11]]<br />
|Free Reserved Voices<br />
|2<br />
|<br />
|Set the count of reserved voices to 0.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa3|0xFE 0x12]]<br />
|Channel Master Volume Slide<br />
|3<br />
|length: byte, volume: byte (0-127)<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xFE 0x13]]<br />
|Unimplemented<br />
|2<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe14|0xFE 0x14]]<br />
|Load Custom Instrument (Key-Split Instrument)<br />
|3<br />
|instrument: byte<br />
|The custom instrument number corresponds to the custom instrument map pointed from the file header. Note that the number is different from the regular sample number used in opcode 0xA1.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe15|0xFE 0x15]]<br />
|Time Signature<br />
|4<br />
|ticks_per_beat: byte, beats_per_measure: byte<br />
|Note that two parameters can be 0. This pattern is used for initialization.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe16|0xFE 0x16]]<br />
|Measure Number<br />
|3<br />
|measure: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xFE 0x17-0x18]]<br />
|Unimplemented<br />
|2<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa9|0xFE 0x19]]<br />
|Channel Volume Slide Per Note On<br />
|4<br />
|length: byte, volume: byte (0-127)<br />
|Applies volume slide (opcode 0xA9) for each notes. When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe1a|0xFE 0x1A]]<br />
|Unknown<br />
|2<br />
|<br />
|Turn something on.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe1b|0xFE 0x1B]]<br />
|Unknown<br />
|2<br />
|<br />
|Clears the effect of opcode 0xFE 0x1A.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe1c|0xFE 0x1C]]<br />
|Unknown<br />
|3<br />
|value: byte<br />
|Obsoleted opcode? As far as I learned from the assembly code, it probably does nothing.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe1d|0xFE 0x1D]]<br />
|Use Reserved Voices<br />
|2<br />
|<br />
|Allow using the reserved voices to play the sound of the current track. If they are all used, the remaining voices will instead be used normally.<br />
<br />
Use opcode [[FF9/Sound/Opcodes/0xfe10|0xFE 0x10]] to allocate reserved voices.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe1e|0xFE 0x1E]]<br />
|Use No Reserved Voices<br />
|2<br />
|<br />
|Disable the effect of opcode 0xFE 0x1D.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xFE 0x1F]]<br />
|Unimplemented<br />
|2<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|0xFE 0x20-0xFF<br />
|Unimplemented (Out of Range)<br />
|n/a<br />
|<br />
|Do not use.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xFF]]<br />
|Unimplemented<br />
|1<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|}</div>
Loveemu
https://wiki.ffrtt.ru/index.php?title=FF9/Sound/AKAO_sequence&diff=5772
FF9/Sound/AKAO sequence
2020-07-12T15:38:59Z
<p>Loveemu: </p>
<hr />
<div>== Introduction ==<br />
AKAO sequence is similar to MIDI sequence - it's custom tracker format for playing sequence sound, well tuned specially for PSX.<br />
<br />
<br />
== File Structure ==<br />
=== Header (size: 64 bytes) ===<br />
<br />
struct AkaoSeqHeader<br />
{<br />
static const uint8_t magic[4]; // "AKAO" C-string<br />
uint16_t id; // song ID, used for playing sequence<br />
uint16_t length; // data length (including this header)<br />
uint16_t reverb_type; // reverb type (range from 0 to 9)<br />
uint8_t field_0A[6];<br />
uint32_t field_10;<br />
uint16_t sample_set_id; // associated sample set ID<br />
uint16_t field_12;<br />
uint32_t field_14;<br />
uint32_t field_18;<br />
uint32_t field_1C;<br />
uint32_t mask; // represents bitmask of used channels in this song<br />
uint32_t field_24;<br />
uint32_t field_28;<br />
uint32_t field_2C;<br />
uint32_t instrument_map_offset; // relative offset to custom instrument map (0 if unused)<br />
uint32_t drum_map_offset; // relative offset to custom drum map (0 if unused)<br />
uint32_t field_38;<br />
uint32_t field_3C;<br />
};<br />
<br />
=== Channel Offsets (size: 2 bytes * <channels count>) ===<br />
struct AkaoChannelInfo<br />
{<br />
uint32_t start_offsets[num_channels]; // offsets to channel opcode data<br />
};<br />
<br />
AkaoSeqHeader *header;<br />
int num_channels = 0;<br />
while (int bit = 0; header->mask & (1 << bit)) != 0; bit++)<br />
num_channels++;<br />
<br />
There is <channels count> offsets to channel opcode data counting from current offset. Each offsets is a relative offset based on the address the offset itself.<br />
<br />
<br />
=== Channel Commands [AKAO Opcodes] ===<br />
For every channels in an AKAO sequence, there is a set of commands to perform. This is similar to Field opcodes. Here I will call this sound commands "opcodes". Every opcode has its own number of arguments.<br />
<br />
=== Custom Instrument Map Table ===<br />
<br />
When a song uses custom instruments with [[FF9/Sound/Opcodes/0xfe14|opcode 0xFE 0x14]], a custom instrument map table will be placed after the end of AKAO opcode sequence.<br />
<br />
This table consists of a collection of zones representing performance settings for a particular key range. A zone is an 8-byte item, and an instrument can have one or more regions.<br />
<br />
struct AkaoInstrumentZoneAttr<br />
{<br />
uint8_t instrument; // corresponding to opcode 0xA1<br />
uint8_t low_key; // lowest key (in note number)<br />
uint8_t high_key; // highest key (in note number)<br />
uint8_t ar; // ADSR: attack rate (0-127)<br />
uint8_t sr; // ADSR: sustain rate (0-127)<br />
uint8_t s_mode; // ADSR: sustain mode (1: linear increase, 3: linear decrease, 5: exponential increase, 7: exponential decrease)<br />
uint8_t rr; // ADSR: release rate (0-31)<br />
uint8_t volume; // adjust the note volume to n/128 of the original volume (0 will keep the original volume)<br />
}<br />
<br />
- Zones must be ordered from low key to high key<br />
- The final zone of the instrument must be a terminator filled with 0s (more precisely, a zone with ADSR sustain mode of 0 is considered a terminator)<br />
<br />
=== Drum Instrument Map Table ===<br />
<br />
When a song uses a drum kit with [[FF9/Sound/Opcodes/0xfe04|opcode 0xFE 0x04]], a drum instrument map table will be placed at the end of the sequence. The table determines the instrument, channel volume and pan for each keys.<br />
<br />
The table consists of a repetition of 8-byte items.<br />
<br />
struct AkaoDrumKeyAttr<br />
{<br />
uint8_t instrument; // corresponding to opcode 0xA1<br />
uint8_t key; // note number when playing the drum note<br />
uint8_t ar; // ADSR: attack rate (0-127)<br />
uint8_t sr; // ADSR: sustain rate (0-127)<br />
uint8_t s_mode; // ADSR: sustain mode (1: linear increase, 3: linear decrease, 5: exponential increase, 7: exponential decrease)<br />
uint8_t rr; // ADSR: release rate (0-31)<br />
uint8_t volume; // adjust the percussion volume to n/128 of the original volume (0 will keep the original volume)<br />
uint8_t pan : 7; // corresponding to opcode 0xAA<br />
uint8_t reverb : 1; // reverb on/off (0: off, 1: on)<br />
}<br />
<br />
<br />
== Sound Opcode List ==<br />
<br />
{| class="wikitable"<br />
! Opcode<br />
! Summary<br />
! Length<br />
! Operands<br />
! Note<br />
|-<br />
|[[FF9/Sound/Opcodes/0x0099|0x00-0x99]]<br />
|Note, Tie, Rest<br />
|1<br />
|<br />
|The opcode indicates the note key and length. The note will be keyed off 2 ticks before the next note.<br />
|-<br />
|0x9A-0x9F<br />
|Unimplemented<br />
|1<br />
|<br />
|Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xA0]]<br />
|Finish Channel<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa1|0xA1]]<br />
|Load Instrument<br />
|2<br />
|instrument: byte (0-127)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0x0099|0xA2]]<br />
|Overwrite Next Note Length<br />
|2<br />
|length: byte<br />
|Ignores the regular length (delta-time) of the next note and overwrites it with the specified length.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa8aa|0xA3]]<br />
|Channel Master Volume<br />
|2<br />
|volume: byte (0-127)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa4|0xA4]]<br />
|Pitch Bend Slide<br />
|3<br />
|length: byte, semitones: signed byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa5|0xA5]]<br />
|Set Octave<br />
|2<br />
|octave: byte (0-15)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa5|0xA6]]<br />
|Increase Octave<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa5|0xA7]]<br />
|Decrease Octave<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa8aa|0xA8]]<br />
|Channel Volume<br />
|2<br />
|volume: byte (0-127)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa9|0xA9]]<br />
|Channel Volume Slide<br />
|3<br />
|length: byte, volume: byte (0-127)<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa8aa|0xAA]]<br />
|Channel Pan<br />
|2<br />
|pan: byte (0-127)<br />
|64 is the center.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xab|0xAB]]<br />
|Channel Pan Slide<br />
|3<br />
|length: byte, pan: byte (0-127)<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xac|0xAC]]<br />
|Noise Clock Frequency<br />
|2<br />
|clock: byte (0x00-0x3f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xAD]]<br />
|ADSR: Attack Rate<br />
|2<br />
|attack_rate: byte (0x00-0x7f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xAE]]<br />
|ADSR: Decay Rate<br />
|2<br />
|decay_rate: byte (0x00-0x0f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xAF]]<br />
|ADSR: Sustain Level<br />
|2<br />
|sustain_level: byte (0x00-0x0f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xB0]]<br />
|ADSR: Decay Rate & Sustain Level<br />
|3<br />
|decay_rate: byte (0x00-0x0f), sustain_level: byte (0x00-0x0f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xB1]]<br />
|ADSR: Sustain Rate<br />
|2<br />
|sustain_rate: byte (0x00-0x7f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xB2]]<br />
|ADSR: Release Rate<br />
|2<br />
|release_rate: byte (0x00-0x1f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xB3]]<br />
|ADSR: Reset ADSR<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb4b5|0xB4]]<br />
|Vibrato (Channel Pitch LFO)<br />
|4<br />
|delay: byte, rate: byte, type: byte (0-15)<br />
|When <code>rate</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb4b5|0xB5]]<br />
|Vibrato Depth<br />
|2<br />
|depth: byte<br />
|The most significant bit of the <code>depth</code> determines the amplitude range.<br />
<br />
When it is 0, the range is up to about ± 50 cents (amplitude is 15/256 compared with range type 1).<br />
<br />
When it is 1, the range is up to about ± 700 cents.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb4b5|0xB6]]<br />
|Turn Off Vibrato<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xB7]]<br />
|ADSR: Attack Mode<br />
|2<br />
|attack_mode: byte (1 or 5)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb8b9|0xB8]]<br />
|Tremolo (Channel Volume LFO)<br />
|4<br />
|delay: byte, rate: byte, type: byte (0-15)<br />
|When <code>rate</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb8b9|0xB9]]<br />
|Tremolo Depth<br />
|2<br />
|depth: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb8b9|0xBA]]<br />
|Turn Off Tremolo<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xBB]]<br />
|ADSR: Sustain Mode<br />
|2<br />
|sustain_mode: byte (1, 3, 5 or 7)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xbcbd|0xBC]]<br />
|Channel Pan LFO<br />
|3<br />
|rate: byte, type: byte (0-15)<br />
|When <code>rate</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xbcbd|0xBD]]<br />
|Channel Pan LFO Depth<br />
|2<br />
|depth: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xbcbd|0xBE]]<br />
|Turn Off Channel Pan LFO<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xbf|0xBF]]<br />
|ADSR: Release Mode<br />
|2<br />
|release_mode: byte (3 or 7)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc0c1|0xC0]]<br />
|Channel Transpose (Absolute)<br />
|2<br />
|semitones: signed byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc0c1|0xC1]]<br />
|Channel Transpose (Relative)<br />
|2<br />
|semitones: signed byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc2c3|0xC2]]<br />
|Turn On Reverb<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc2c3|0xC3]]<br />
|Turn Off Reverb<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc4c5|0xC4]]<br />
|Turn On Noise<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc4c5|0xC5]]<br />
|Turn Off Noise<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc6c7|0xC6]]<br />
|Turn On Frequency Modulation<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc6c7|0xC7]]<br />
|Turn Off Frequency Modulation<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc8c9|0xC8]]<br />
|Loop Point<br />
|1<br />
|<br />
|Remember the current offset as a loop point and increase the nesting level of the loop.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc8c9|0xC9]]<br />
|Return to Loop Point Up to N Times<br />
|2<br />
|times: byte<br />
|On the Nth repeat, this instruction will end the current loop by decrementing the nesting level of the loop. Otherwise, it will increment the loop counter and return to the loop point.<br />
When <code>times</code> is 0, it will be translated to 256 times.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc8c9|0xCA]]<br />
|Return to Loop Point<br />
|1<br />
|<br />
|This instruction will increment the loop counter.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xcb|0xCB]]<br />
|Reset Sound Effects<br />
|1<br />
|<br />
|Reset sound effects such as noise, frequency modulation, reverb, overlay voice and alternate voice.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xcccd|0xCC]]<br />
|Turn On Legato<br />
|1<br />
|<br />
|This instruction will stop the regular key on and key off performance of the subsequent notes and update the pitch only.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xcccd|0xCD]]<br />
|Turn Off Legato<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xcecf|0xCE]]<br />
|Turn On Noise and Toggle Noise On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xcecf|0xCF]]<br />
|Toggle Noise On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd0d1|0xD0]]<br />
|Turn On Full-Length Note Mode<br />
|1<br />
|<br />
|This instruction will stop the regular key off performance of the subsequent notes.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd0d1|0xD1]]<br />
|Turn Off Full-Length Note Mode<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd2d3|0xD2]]<br />
|Turn On Frequency Modulation and Toggle Frequency Modulation On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd2d3|0xD3]]<br />
|Toggle Frequency Modulation On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd4d5|0xD4]]<br />
|Turn On Playback Rate Side Chain<br />
|1<br />
|<br />
|Duplicate and use the playback frequency of the previous voice channel.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd4d5|0xD5]]<br />
|Turn Off Playback Rate Side Chain<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd6d7|0xD6]]<br />
|Turn On Pitch-Volume Side Chain<br />
|1<br />
|<br />
|Multiply the playback frequency of the previous voice channel to the output volume. Lower pitch will make the volume smaller.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd6d7|0xD7]]<br />
|Turn Off Pitch-Volume Side Chain<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd8d9|0xD8]]<br />
|Channel Fine Tuning (Absolute)<br />
|2<br />
|amount: signed byte<br />
|The pitch can be changed in the range of one octave above and below.<br />
The <code>amount</code> is the multiplicand for the playback frequency, not a log-based parameter like cents. For example, when the <code>amount</code> is 127, the pitch will be multiplied by 127/128 (about +1 octave). Negative value will lower the pitch.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd8d9|0xD9]]<br />
|Channel Fine Tuning (Relative)<br />
|2<br />
|amount: signed byte<br />
|The <code>amount</code> will be added to the current tuning amount.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xdadb|0xDA]]<br />
|Turn On Portamento<br />
|2<br />
|speed: byte<br />
|When <code>speed</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xdadb|0xDB]]<br />
|Turn Off Portamento<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0x0099|0xDC]]<br />
|Fix Note Length<br />
|2<br />
|length_to_add: signed byte<br />
|Ignore the regular length (delta-time) of subsequent notes and set to the fixed length. The <code>length_to_add</code> parameter will be added to the current length value. (the initial value is 0)<br />
|-<br />
|[[FF9/Sound/Opcodes/0xdd|0xDD]]<br />
|Vibrato Depth Slide<br />
|3<br />
|length: byte, depth: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xde|0xDE]]<br />
|Tremolo Depth Slide<br />
|3<br />
|length: byte, depth: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xdf|0xDF]]<br />
|Channel Pan LFO Depth Slide<br />
|3<br />
|length: byte, depth: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe0|0xE0]]<br />
|Unknown<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe1|0xE1]]<br />
|Unknown<br />
|2<br />
|value: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe2|0xE2]]<br />
|Unknown<br />
|1<br />
|<br />
|Clears the effect of opcode 0xE1<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe3|0xE3]]<br />
|Unimplemented<br />
|1<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe4|0xE4]]<br />
|Vibrato Rate Slide<br />
|3<br />
|length: byte, rate: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe5|0xE5]]<br />
|Tremolo Rate Slide<br />
|3<br />
|length: byte, rate: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe6|0xE6]]<br />
|Channel Pan LFO Rate Slide<br />
|3<br />
|length: byte, rate: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xE7-0xEF]]<br />
|Unimplemented<br />
|1<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xf0fd|0xF0-0xFD]]<br />
|Note, Tie, Rest with Length<br />
|2<br />
|length: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe00|0xFE 0x00]]<br />
|Tempo<br />
|4<br />
|tempo: uint16<br />
|bpm = tempo / 218.453333 (approximate)<br />
More strictly, <code>bpm = 60.0 / (48 * (65536.0 / tempo) * (0x43D1 / (33868800.0 / 8)))</code><br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe00|0xFE 0x01]]<br />
|Tempo Slide<br />
|5<br />
|length: byte, tempo: uint16<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe02|0xFE 0x02]]<br />
|Reverb Depth<br />
|4<br />
|depth: uint16<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe02|0xFE 0x03]]<br />
|Reverb Depth Slide<br />
|5<br />
|length: byte, depth: uint16<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe04|0xFE 0x04]]<br />
|Turn On Drum Mode<br />
|2<br />
|<br />
|The drum map offset is recorded in the file header.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe04|0xFE 0x05]]<br />
|Turn Off Drum Mode<br />
|2<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe06|0xFE 0x06]]<br />
|Unconditional Jump<br />
|4<br />
|destination_offset: signed int16<br />
|This instruction can be used to make an infinite loop.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe07|0xFE 0x07]]<br />
|CPU-Conditional Jump<br />
|5<br />
|condition: byte, destination_offset: signed int16<br />
|Jump if the condition variable matches <code>condition</code>. The value of the condition variable can be set from the game program.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe08|0xFE 0x08]]<br />
|Jump on the Nth Repeat<br />
|5<br />
|times: byte, destination_offset: signed int16<br />
|When <code>times</code> is 0, it will be translated to 256 times.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe08|0xFE 0x09]]<br />
|Break the Loop on the Nth Repeat<br />
|5<br />
|times: byte, destination_offset: signed int16<br />
|Unlike 0xF0, this instruction will end the current loop by decrementing the nesting level of the loop.<br />
When <code>times</code> is 0, it will be translated to 256 times.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa1|0xFE 0x0A]]<br />
|Load Instrument (No Attack Sample)<br />
|3<br />
|instrument: byte<br />
|Unlike 0xA1, the sample before the loop point is replaced by a short, silence sample.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe0b|0xFE 0x0B]]<br />
|Unknown<br />
|6<br />
|offset: signed int16, offset2: signed int16<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xFE 0x0C-0x0D]]<br />
|Unimplemented<br />
|2<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe0e|0xFE 0x0E]]<br />
|Pattern<br />
|4<br />
|destination_offset: signed int16<br />
|Remember the return address and jump to the specified location. It cannot be nested.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe0f|0xFE 0x0F]]<br />
|End Pattern<br />
|2<br />
|<br />
|Return from opcode 0xFE 0x0E.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe10|0xFE 0x10]]<br />
|Allocate Reserved Voices<br />
|3<br />
|count: byte<br />
|Reserve the specified <code>count</code> of hardware voices. Reserved voices will not be used unless explicitly specified in opcode 0xFE 0x1D.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe10|0xFE 0x11]]<br />
|Free Reserved Voices<br />
|2<br />
|<br />
|Set the count of reserved voices to 0.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa3|0xFE 0x12]]<br />
|Channel Master Volume Slide<br />
|3<br />
|length: byte, volume: byte (0-127)<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xFE 0x13]]<br />
|Unimplemented<br />
|2<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe14|0xFE 0x14]]<br />
|Load Custom Instrument (Key-Split Instrument)<br />
|3<br />
|instrument: byte<br />
|The custom instrument number corresponds to the custom instrument map pointed from the file header. Note that the number is different from the regular sample number used in opcode 0xA1.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe15|0xFE 0x15]]<br />
|Time Signature<br />
|4<br />
|ticks_per_beat: byte, beats_per_measure: byte<br />
|Note that two parameters can be 0. This pattern is used for initialization.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe16|0xFE 0x16]]<br />
|Measure Number<br />
|3<br />
|measure: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xFE 0x17-0x18]]<br />
|Unimplemented<br />
|2<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa9|0xFE 0x19]]<br />
|Channel Volume Slide Per Note On<br />
|4<br />
|length: byte, volume: byte (0-127)<br />
|Applies volume slide (opcode 0xA9) for each notes. When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe1a|0xFE 0x1A]]<br />
|Unknown<br />
|2<br />
|<br />
|Turn something on.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe1b|0xFE 0x1B]]<br />
|Unknown<br />
|2<br />
|<br />
|Clears the effect of opcode 0xFE 0x1A.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe1c|0xFE 0x1C]]<br />
|Unknown<br />
|3<br />
|value: byte<br />
|Obsoleted opcode? As far as I learned from the assembly code, it probably does nothing.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe1d|0xFE 0x1D]]<br />
|Use Reserved Voices<br />
|2<br />
|<br />
|Allow using the reserved voices to play the sound of the current track. If they are all used, the remaining voices will instead be used normally.<br />
<br />
Use opcode [[FF9/Sound/Opcodes/0xfe10|0xFE 0x10]] to allocate reserved voices.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe1e|0xFE 0x1E]]<br />
|Use No Reserved Voices<br />
|2<br />
|<br />
|Disable the effect of opcode 0xFE 0x1D.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xFE 0x1F]]<br />
|Unimplemented<br />
|2<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|0xFE 0x20-0xFF<br />
|Unimplemented (Out of Range)<br />
|n/a<br />
|<br />
|Do not use.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xFF]]<br />
|Unimplemented<br />
|1<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|}</div>
Loveemu
https://wiki.ffrtt.ru/index.php?title=FF9/Sound/AKAO_sequence&diff=5771
FF9/Sound/AKAO sequence
2020-07-12T15:27:14Z
<p>Loveemu: Add description to 0xFE 0x10, 0x11, 0x1D and 0x1E</p>
<hr />
<div>== Introduction ==<br />
AKAO sequence is similar to MIDI sequence - it's custom tracker format for playing sequence sound, well tuned specially for PSX.<br />
<br />
<br />
== File Structure ==<br />
=== Header (size: 64 bytes) ===<br />
<br />
struct AkaoSeqHeader<br />
{<br />
static const uint8_t magic[4]; // "AKAO" C-string<br />
uint16_t id; // song ID, used for playing sequence<br />
uint16_t length; // data length (including this header)<br />
uint16_t reverb_type; // reverb type (range from 0 to 9)<br />
uint8_t field_0A[6];<br />
uint32_t field_10;<br />
uint16_t sample_set_id; // associated sample set ID<br />
uint16_t field_12;<br />
uint32_t field_14;<br />
uint32_t field_18;<br />
uint32_t field_1C;<br />
uint32_t mask; // represents bitmask of used channels in this song<br />
uint32_t field_24;<br />
uint32_t field_28;<br />
uint32_t field_2C;<br />
uint32_t instrument_map_offset; // relative offset to custom instrument map (0 if unused)<br />
uint32_t drum_map_offset; // relative offset to custom drum map (0 if unused)<br />
uint32_t field_38;<br />
uint32_t field_3C;<br />
};<br />
<br />
=== Channel Offsets (size: 2 bytes * <channels count>) ===<br />
struct AkaoChannelInfo<br />
{<br />
uint32_t start_offsets[num_channels]; // offsets to channel opcode data<br />
};<br />
<br />
AkaoSeqHeader *header;<br />
int num_channels = 0;<br />
while (int bit = 0; header->mask & (1 << bit)) != 0; bit++)<br />
num_channels++;<br />
<br />
There is <channels count> offsets to channel opcode data counting from current offset. Each offsets is a relative offset based on the address the offset itself.<br />
<br />
<br />
=== Channel Commands [AKAO Opcodes] ===<br />
For every channels in an AKAO sequence, there is a set of commands to perform. This is similar to Field opcodes. Here I will call this sound commands "opcodes". Every opcode has its own number of arguments.<br />
<br />
=== Custom Instrument Map Table ===<br />
<br />
When a song uses custom instruments with [[FF9/Sound/Opcodes/0xfe14|opcode 0xFE 0x14]], a custom instrument map table will be placed after the end of AKAO opcode sequence.<br />
<br />
This table consists of a collection of zones representing performance settings for a particular key range. A zone is an 8-byte item, and an instrument can have one or more regions.<br />
<br />
struct AkaoInstrumentZoneAttr<br />
{<br />
uint8_t instrument; // corresponding to opcode 0xA1<br />
uint8_t low_key; // lowest key (in note number)<br />
uint8_t high_key; // highest key (in note number)<br />
uint8_t ar; // ADSR: attack rate (0-127)<br />
uint8_t sr; // ADSR: sustain rate (0-127)<br />
uint8_t s_mode; // ADSR: sustain mode (1: linear increase, 3: linear decrease, 5: exponential increase, 7: exponential decrease)<br />
uint8_t rr; // ADSR: release rate (0-31)<br />
uint8_t volume; // adjust the note volume to n/128 of the original volume (0 will keep the original volume)<br />
}<br />
<br />
- Zones must be ordered from low key to high key<br />
- The final zone of the instrument must be a terminator filled with 0s (more precisely, a zone with ADSR sustain mode of 0 is considered a terminator)<br />
<br />
=== Drum Instrument Map Table ===<br />
<br />
When a song uses a drum kit with [[FF9/Sound/Opcodes/0xfe04|opcode 0xFE 0x04]], a drum instrument map table will be placed at the end of the sequence. The table determines the instrument, channel volume and pan for each keys.<br />
<br />
The table consists of a repetition of 8-byte items.<br />
<br />
struct AkaoDrumKeyAttr<br />
{<br />
uint8_t instrument; // corresponding to opcode 0xA1<br />
uint8_t key; // note number when playing the drum note<br />
uint8_t ar; // ADSR: attack rate (0-127)<br />
uint8_t sr; // ADSR: sustain rate (0-127)<br />
uint8_t s_mode; // ADSR: sustain mode (1: linear increase, 3: linear decrease, 5: exponential increase, 7: exponential decrease)<br />
uint8_t rr; // ADSR: release rate (0-31)<br />
uint8_t volume; // adjust the percussion volume to n/128 of the original volume (0 will keep the original volume)<br />
uint8_t pan : 7; // corresponding to opcode 0xAA<br />
uint8_t reverb : 1; // reverb on/off (0: off, 1: on)<br />
}<br />
<br />
<br />
== Sound Opcode List ==<br />
<br />
{| class="wikitable"<br />
! Opcode<br />
! Summary<br />
! Length<br />
! Operands<br />
! Note<br />
|-<br />
|[[FF9/Sound/Opcodes/0x0099|0x00-0x99]]<br />
|Note, Tie, Rest<br />
|1<br />
|<br />
|The opcode indicates the note key and length. The note will be keyed off 2 ticks before the next note.<br />
|-<br />
|0x9A-0x9F<br />
|Unimplemented<br />
|1<br />
|<br />
|Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xA0]]<br />
|Finish Channel<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa1|0xA1]]<br />
|Load Instrument<br />
|2<br />
|instrument: byte (0-127)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0x0099|0xA2]]<br />
|Overwrite Next Note Length<br />
|2<br />
|length: byte<br />
|Ignores the regular length (delta-time) of the next note and overwrites it with the specified length.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa8aa|0xA3]]<br />
|Channel Master Volume<br />
|2<br />
|volume: byte (0-127)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa4|0xA4]]<br />
|Pitch Bend Slide<br />
|3<br />
|length: byte, semitones: signed byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa5|0xA5]]<br />
|Set Octave<br />
|2<br />
|octave: byte (0-15)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa5|0xA6]]<br />
|Increase Octave<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa5|0xA7]]<br />
|Decrease Octave<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa8aa|0xA8]]<br />
|Channel Volume<br />
|2<br />
|volume: byte (0-127)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa9|0xA9]]<br />
|Channel Volume Slide<br />
|3<br />
|length: byte, volume: byte (0-127)<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa8aa|0xAA]]<br />
|Channel Pan<br />
|2<br />
|pan: byte (0-127)<br />
|64 is the center.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xab|0xAB]]<br />
|Channel Pan Slide<br />
|3<br />
|length: byte, pan: byte (0-127)<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xac|0xAC]]<br />
|Noise Clock Frequency<br />
|2<br />
|clock: byte (0x00-0x3f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xAD]]<br />
|ADSR: Attack Rate<br />
|2<br />
|attack_rate: byte (0x00-0x7f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xAE]]<br />
|ADSR: Decay Rate<br />
|2<br />
|decay_rate: byte (0x00-0x0f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xAF]]<br />
|ADSR: Sustain Level<br />
|2<br />
|sustain_level: byte (0x00-0x0f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xB0]]<br />
|ADSR: Decay Rate & Sustain Level<br />
|3<br />
|decay_rate: byte (0x00-0x0f), sustain_level: byte (0x00-0x0f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xB1]]<br />
|ADSR: Sustain Rate<br />
|2<br />
|sustain_rate: byte (0x00-0x7f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xB2]]<br />
|ADSR: Release Rate<br />
|2<br />
|release_rate: byte (0x00-0x1f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xB3]]<br />
|ADSR: Reset ADSR<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb4b5|0xB4]]<br />
|Vibrato (Channel Pitch LFO)<br />
|4<br />
|delay: byte, rate: byte, type: byte (0-15)<br />
|When <code>rate</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb4b5|0xB5]]<br />
|Vibrato Depth<br />
|2<br />
|depth: byte<br />
|The most significant bit of the <code>depth</code> determines the amplitude range.<br />
<br />
When it is 0, the range is up to about ± 50 cents (amplitude is 15/256 compared with range type 1).<br />
<br />
When it is 1, the range is up to about ± 700 cents.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb4b5|0xB6]]<br />
|Turn Off Vibrato<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xB7]]<br />
|ADSR: Attack Mode<br />
|2<br />
|attack_mode: byte (1 or 5)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb8b9|0xB8]]<br />
|Tremolo (Channel Volume LFO)<br />
|4<br />
|delay: byte, rate: byte, type: byte (0-15)<br />
|When <code>rate</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb8b9|0xB9]]<br />
|Tremolo Depth<br />
|2<br />
|depth: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb8b9|0xBA]]<br />
|Turn Off Tremolo<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xBB]]<br />
|ADSR: Sustain Mode<br />
|2<br />
|sustain_mode: byte (1, 3, 5 or 7)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xbcbd|0xBC]]<br />
|Channel Pan LFO<br />
|3<br />
|rate: byte, type: byte (0-15)<br />
|When <code>rate</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xbcbd|0xBD]]<br />
|Channel Pan LFO Depth<br />
|2<br />
|depth: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xbcbd|0xBE]]<br />
|Turn Off Channel Pan LFO<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xbf|0xBF]]<br />
|ADSR: Release Mode<br />
|2<br />
|release_mode: byte (3 or 7)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc0c1|0xC0]]<br />
|Channel Transpose (Absolute)<br />
|2<br />
|semitones: signed byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc0c1|0xC1]]<br />
|Channel Transpose (Relative)<br />
|2<br />
|semitones: signed byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc2c3|0xC2]]<br />
|Turn On Reverb<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc2c3|0xC3]]<br />
|Turn Off Reverb<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc4c5|0xC4]]<br />
|Turn On Noise<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc4c5|0xC5]]<br />
|Turn Off Noise<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc6c7|0xC6]]<br />
|Turn On Frequency Modulation<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc6c7|0xC7]]<br />
|Turn Off Frequency Modulation<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc8c9|0xC8]]<br />
|Loop Point<br />
|1<br />
|<br />
|Remember the current offset as a loop point and increase the nesting level of the loop.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc8c9|0xC9]]<br />
|Return to Loop Point Up to N Times<br />
|2<br />
|times: byte<br />
|On the Nth repeat, this instruction will end the current loop by decrementing the nesting level of the loop. Otherwise, it will increment the loop counter and return to the loop point.<br />
When <code>times</code> is 0, it will be translated to 256 times.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc8c9|0xCA]]<br />
|Return to Loop Point<br />
|1<br />
|<br />
|This instruction will increment the loop counter.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xcb|0xCB]]<br />
|Reset Sound Effects<br />
|1<br />
|<br />
|Reset sound effects such as noise, frequency modulation, reverb, overlay voice and alternate voice.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xcccd|0xCC]]<br />
|Turn On Legato<br />
|1<br />
|<br />
|This instruction will stop the regular key on and key off performance of the subsequent notes and update the pitch only.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xcccd|0xCD]]<br />
|Turn Off Legato<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xcecf|0xCE]]<br />
|Turn On Noise and Toggle Noise On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xcecf|0xCF]]<br />
|Toggle Noise On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd0d1|0xD0]]<br />
|Turn On Full-Length Note Mode<br />
|1<br />
|<br />
|This instruction will stop the regular key off performance of the subsequent notes.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd0d1|0xD1]]<br />
|Turn Off Full-Length Note Mode<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd2d3|0xD2]]<br />
|Turn On Frequency Modulation and Toggle Frequency Modulation On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd2d3|0xD3]]<br />
|Toggle Frequency Modulation On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd4d5|0xD4]]<br />
|Turn On Playback Rate Side Chain<br />
|1<br />
|<br />
|Duplicate and use the playback frequency of the previous voice channel.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd4d5|0xD5]]<br />
|Turn Off Playback Rate Side Chain<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd6d7|0xD6]]<br />
|Turn On Pitch-Volume Side Chain<br />
|1<br />
|<br />
|Multiply the playback frequency of the previous voice channel to the output volume. Lower pitch will make the volume smaller.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd6d7|0xD7]]<br />
|Turn Off Pitch-Volume Side Chain<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd8d9|0xD8]]<br />
|Channel Fine Tuning (Absolute)<br />
|2<br />
|amount: signed byte<br />
|The pitch can be changed in the range of one octave above and below.<br />
The <code>amount</code> is the multiplicand for the playback frequency, not a log-based parameter like cents. For example, when the <code>amount</code> is 127, the pitch will be multiplied by 127/128 (about +1 octave). Negative value will lower the pitch.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd8d9|0xD9]]<br />
|Channel Fine Tuning (Relative)<br />
|2<br />
|amount: signed byte<br />
|The <code>amount</code> will be added to the current tuning amount.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xdadb|0xDA]]<br />
|Turn On Portamento<br />
|2<br />
|speed: byte<br />
|When <code>speed</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xdadb|0xDB]]<br />
|Turn Off Portamento<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0x0099|0xDC]]<br />
|Fix Note Length<br />
|2<br />
|length_to_add: signed byte<br />
|Ignore the regular length (delta-time) of subsequent notes and set to the fixed length. The <code>length_to_add</code> parameter will be added to the current length value. (the initial value is 0)<br />
|-<br />
|[[FF9/Sound/Opcodes/0xdd|0xDD]]<br />
|Vibrato Depth Slide<br />
|3<br />
|length: byte, depth: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xde|0xDE]]<br />
|Tremolo Depth Slide<br />
|3<br />
|length: byte, depth: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xdf|0xDF]]<br />
|Channel Pan LFO Depth Slide<br />
|3<br />
|length: byte, depth: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe0|0xE0]]<br />
|Unknown<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe1|0xE1]]<br />
|Unknown<br />
|2<br />
|value: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe2|0xE2]]<br />
|Unknown<br />
|1<br />
|<br />
|Clears the effect of opcode 0xE1<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe3|0xE3]]<br />
|Unimplemented<br />
|1<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe4|0xE4]]<br />
|Vibrato Rate Slide<br />
|3<br />
|length: byte, rate: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe5|0xE5]]<br />
|Tremolo Rate Slide<br />
|3<br />
|length: byte, rate: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe6|0xE6]]<br />
|Channel Pan LFO Rate Slide<br />
|3<br />
|length: byte, rate: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xE7-0xEF]]<br />
|Unimplemented<br />
|1<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xf0fd|0xF0-0xFD]]<br />
|Note, Tie, Rest with Length<br />
|2<br />
|length: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe00|0xFE 0x00]]<br />
|Tempo<br />
|4<br />
|tempo: uint16<br />
|bpm = tempo / 218.453333 (approximate)<br />
More strictly, <code>bpm = 60.0 / (48 * (65536.0 / tempo) * (0x43D1 / (33868800.0 / 8)))</code><br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe00|0xFE 0x01]]<br />
|Tempo Slide<br />
|5<br />
|length: byte, tempo: uint16<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe02|0xFE 0x02]]<br />
|Reverb Depth<br />
|4<br />
|depth: uint16<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe02|0xFE 0x03]]<br />
|Reverb Depth Slide<br />
|5<br />
|length: byte, depth: uint16<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe04|0xFE 0x04]]<br />
|Turn On Drum Mode<br />
|2<br />
|<br />
|The drum map offset is recorded in the file header.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe04|0xFE 0x05]]<br />
|Turn Off Drum Mode<br />
|2<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe06|0xFE 0x06]]<br />
|Unconditional Jump<br />
|4<br />
|destination_offset: signed int16<br />
|This instruction can be used to make an infinite loop.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe07|0xFE 0x07]]<br />
|CPU-Conditional Jump<br />
|5<br />
|condition: byte, destination_offset: signed int16<br />
|Jump if the condition variable matches <code>condition</code>. The value of the condition variable can be set from the game program.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe08|0xFE 0x08]]<br />
|Jump on the Nth Repeat<br />
|5<br />
|times: byte, destination_offset: signed int16<br />
|When <code>times</code> is 0, it will be translated to 256 times.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe08|0xFE 0x09]]<br />
|Break the Loop on the Nth Repeat<br />
|5<br />
|times: byte, destination_offset: signed int16<br />
|Unlike 0xF0, this instruction will end the current loop by decrementing the nesting level of the loop.<br />
When <code>times</code> is 0, it will be translated to 256 times.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa1|0xFE 0x0A]]<br />
|Load Instrument (No Attack Sample)<br />
|3<br />
|instrument: byte<br />
|Unlike 0xA1, the sample before the loop point is replaced by a short, silence sample.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe0b|0xFE 0x0B]]<br />
|Unknown<br />
|6<br />
|offset: signed int16, offset2: signed int16<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xFE 0x0C-0x0D]]<br />
|Unimplemented<br />
|2<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe0e|0xFE 0x0E]]<br />
|Pattern<br />
|4<br />
|destination_offset: signed int16<br />
|Remember the return address and jump to the specified location. It cannot be nested.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe0f|0xFE 0x0F]]<br />
|End Pattern<br />
|2<br />
|<br />
|Return from opcode 0xFE 0x0E.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe10|0xFE 0x10]]<br />
|Allocate Reserved Voices<br />
|3<br />
|count: byte<br />
|Reserve the specified <code>count</code> of hardware voices. Reserved voices will not be used unless explicitly specified in opcode 0xFE 0x1D.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe10|0xFE 0x11]]<br />
|Free Reserved Voices<br />
|2<br />
|<br />
|Set the count of reserved voices to 0.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa3|0xFE 0x12]]<br />
|Channel Master Volume Slide<br />
|3<br />
|length: byte, volume: byte (0-127)<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xFE 0x13]]<br />
|Unimplemented<br />
|2<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe14|0xFE 0x14]]<br />
|Load Custom Instrument (Key-Split Instrument)<br />
|3<br />
|instrument: byte<br />
|The custom instrument number corresponds to the custom instrument map pointed from the file header. Note that the number is different from the regular sample number used in opcode 0xA1.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe15|0xFE 0x15]]<br />
|Time Signature<br />
|4<br />
|ticks_per_beat: byte, beats_per_measure: byte<br />
|Note that two parameters can be 0. This pattern is used for initialization.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe16|0xFE 0x16]]<br />
|Measure Number<br />
|3<br />
|measure: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xFE 0x17-0x18]]<br />
|Unimplemented<br />
|2<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa9|0xFE 0x19]]<br />
|Channel Volume Slide Per Note On<br />
|4<br />
|length: byte, volume: byte (0-127)<br />
|Applies volume slide (opcode 0xA9) for each notes. When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe1a|0xFE 0x1A]]<br />
|Unknown<br />
|2<br />
|<br />
|Turn something on.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe1b|0xFE 0x1B]]<br />
|Unknown<br />
|2<br />
|<br />
|Clears the effect of opcode 0xFE 0x1A.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe1c|0xFE 0x1C]]<br />
|Unknown<br />
|3<br />
|value: byte<br />
|Obsoleted opcode? It probably does nothing.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe1d|0xFE 0x1D]]<br />
|Use Reserved Voices<br />
|2<br />
|<br />
|Allow using the reserved voices to play the sound of the current track. If they are all used, the remaining voices will instead be used normally.<br />
<br />
Use opcode [[FF9/Sound/Opcodes/0xfe10|0xFE 0x10]] to allocate reserved voices.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe1e|0xFE 0x1E]]<br />
|Use No Reserved Voices<br />
|2<br />
|<br />
|Disable the effect of opcode 0xFE 0x1D.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xFE 0x1F]]<br />
|Unimplemented<br />
|2<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|0xFE 0x20-0xFF<br />
|Unimplemented (Out of Range)<br />
|n/a<br />
|<br />
|Do not use.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xFF]]<br />
|Unimplemented<br />
|1<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|}</div>
Loveemu
https://wiki.ffrtt.ru/index.php?title=FF9/Sound/AKAO_sequence&diff=5770
FF9/Sound/AKAO sequence
2020-07-11T22:27:49Z
<p>Loveemu: Rename: Subroutine Jump -> Pattern</p>
<hr />
<div>== Introduction ==<br />
AKAO sequence is similar to MIDI sequence - it's custom tracker format for playing sequence sound, well tuned specially for PSX.<br />
<br />
<br />
== File Structure ==<br />
=== Header (size: 64 bytes) ===<br />
<br />
struct AkaoSeqHeader<br />
{<br />
static const uint8_t magic[4]; // "AKAO" C-string<br />
uint16_t id; // song ID, used for playing sequence<br />
uint16_t length; // data length (including this header)<br />
uint16_t reverb_type; // reverb type (range from 0 to 9)<br />
uint8_t field_0A[6];<br />
uint32_t field_10;<br />
uint16_t sample_set_id; // associated sample set ID<br />
uint16_t field_12;<br />
uint32_t field_14;<br />
uint32_t field_18;<br />
uint32_t field_1C;<br />
uint32_t mask; // represents bitmask of used channels in this song<br />
uint32_t field_24;<br />
uint32_t field_28;<br />
uint32_t field_2C;<br />
uint32_t instrument_map_offset; // relative offset to custom instrument map (0 if unused)<br />
uint32_t drum_map_offset; // relative offset to custom drum map (0 if unused)<br />
uint32_t field_38;<br />
uint32_t field_3C;<br />
};<br />
<br />
=== Channel Offsets (size: 2 bytes * <channels count>) ===<br />
struct AkaoChannelInfo<br />
{<br />
uint32_t start_offsets[num_channels]; // offsets to channel opcode data<br />
};<br />
<br />
AkaoSeqHeader *header;<br />
int num_channels = 0;<br />
while (int bit = 0; header->mask & (1 << bit)) != 0; bit++)<br />
num_channels++;<br />
<br />
There is <channels count> offsets to channel opcode data counting from current offset. Each offsets is a relative offset based on the address the offset itself.<br />
<br />
<br />
=== Channel Commands [AKAO Opcodes] ===<br />
For every channels in an AKAO sequence, there is a set of commands to perform. This is similar to Field opcodes. Here I will call this sound commands "opcodes". Every opcode has its own number of arguments.<br />
<br />
=== Custom Instrument Map Table ===<br />
<br />
When a song uses custom instruments with [[FF9/Sound/Opcodes/0xfe14|opcode 0xFE 0x14]], a custom instrument map table will be placed after the end of AKAO opcode sequence.<br />
<br />
This table consists of a collection of zones representing performance settings for a particular key range. A zone is an 8-byte item, and an instrument can have one or more regions.<br />
<br />
struct AkaoInstrumentZoneAttr<br />
{<br />
uint8_t instrument; // corresponding to opcode 0xA1<br />
uint8_t low_key; // lowest key (in note number)<br />
uint8_t high_key; // highest key (in note number)<br />
uint8_t ar; // ADSR: attack rate (0-127)<br />
uint8_t sr; // ADSR: sustain rate (0-127)<br />
uint8_t s_mode; // ADSR: sustain mode (1: linear increase, 3: linear decrease, 5: exponential increase, 7: exponential decrease)<br />
uint8_t rr; // ADSR: release rate (0-31)<br />
uint8_t volume; // adjust the note volume to n/128 of the original volume (0 will keep the original volume)<br />
}<br />
<br />
- Zones must be ordered from low key to high key<br />
- The final zone of the instrument must be a terminator filled with 0s (more precisely, a zone with ADSR sustain mode of 0 is considered a terminator)<br />
<br />
=== Drum Instrument Map Table ===<br />
<br />
When a song uses a drum kit with [[FF9/Sound/Opcodes/0xfe04|opcode 0xFE 0x04]], a drum instrument map table will be placed at the end of the sequence. The table determines the instrument, channel volume and pan for each keys.<br />
<br />
The table consists of a repetition of 8-byte items.<br />
<br />
struct AkaoDrumKeyAttr<br />
{<br />
uint8_t instrument; // corresponding to opcode 0xA1<br />
uint8_t key; // note number when playing the drum note<br />
uint8_t ar; // ADSR: attack rate (0-127)<br />
uint8_t sr; // ADSR: sustain rate (0-127)<br />
uint8_t s_mode; // ADSR: sustain mode (1: linear increase, 3: linear decrease, 5: exponential increase, 7: exponential decrease)<br />
uint8_t rr; // ADSR: release rate (0-31)<br />
uint8_t volume; // adjust the percussion volume to n/128 of the original volume (0 will keep the original volume)<br />
uint8_t pan : 7; // corresponding to opcode 0xAA<br />
uint8_t reverb : 1; // reverb on/off (0: off, 1: on)<br />
}<br />
<br />
<br />
== Sound Opcode List ==<br />
<br />
{| class="wikitable"<br />
! Opcode<br />
! Summary<br />
! Length<br />
! Operands<br />
! Note<br />
|-<br />
|[[FF9/Sound/Opcodes/0x0099|0x00-0x99]]<br />
|Note, Tie, Rest<br />
|1<br />
|<br />
|The opcode indicates the note key and length. The note will be keyed off 2 ticks before the next note.<br />
|-<br />
|0x9A-0x9F<br />
|Unimplemented<br />
|1<br />
|<br />
|Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xA0]]<br />
|Finish Channel<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa1|0xA1]]<br />
|Load Instrument<br />
|2<br />
|instrument: byte (0-127)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0x0099|0xA2]]<br />
|Overwrite Next Note Length<br />
|2<br />
|length: byte<br />
|Ignores the regular length (delta-time) of the next note and overwrites it with the specified length.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa8aa|0xA3]]<br />
|Channel Master Volume<br />
|2<br />
|volume: byte (0-127)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa4|0xA4]]<br />
|Pitch Bend Slide<br />
|3<br />
|length: byte, semitones: signed byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa5|0xA5]]<br />
|Set Octave<br />
|2<br />
|octave: byte (0-15)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa5|0xA6]]<br />
|Increase Octave<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa5|0xA7]]<br />
|Decrease Octave<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa8aa|0xA8]]<br />
|Channel Volume<br />
|2<br />
|volume: byte (0-127)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa9|0xA9]]<br />
|Channel Volume Slide<br />
|3<br />
|length: byte, volume: byte (0-127)<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa8aa|0xAA]]<br />
|Channel Pan<br />
|2<br />
|pan: byte (0-127)<br />
|64 is the center.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xab|0xAB]]<br />
|Channel Pan Slide<br />
|3<br />
|length: byte, pan: byte (0-127)<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xac|0xAC]]<br />
|Noise Clock Frequency<br />
|2<br />
|clock: byte (0x00-0x3f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xAD]]<br />
|ADSR: Attack Rate<br />
|2<br />
|attack_rate: byte (0x00-0x7f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xAE]]<br />
|ADSR: Decay Rate<br />
|2<br />
|decay_rate: byte (0x00-0x0f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xAF]]<br />
|ADSR: Sustain Level<br />
|2<br />
|sustain_level: byte (0x00-0x0f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xB0]]<br />
|ADSR: Decay Rate & Sustain Level<br />
|3<br />
|decay_rate: byte (0x00-0x0f), sustain_level: byte (0x00-0x0f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xB1]]<br />
|ADSR: Sustain Rate<br />
|2<br />
|sustain_rate: byte (0x00-0x7f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xB2]]<br />
|ADSR: Release Rate<br />
|2<br />
|release_rate: byte (0x00-0x1f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xB3]]<br />
|ADSR: Reset ADSR<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb4b5|0xB4]]<br />
|Vibrato (Channel Pitch LFO)<br />
|4<br />
|delay: byte, rate: byte, type: byte (0-15)<br />
|When <code>rate</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb4b5|0xB5]]<br />
|Vibrato Depth<br />
|2<br />
|depth: byte<br />
|The most significant bit of the <code>depth</code> determines the amplitude range.<br />
<br />
When it is 0, the range is up to about ± 50 cents (amplitude is 15/256 compared with range type 1).<br />
<br />
When it is 1, the range is up to about ± 700 cents.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb4b5|0xB6]]<br />
|Turn Off Vibrato<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xB7]]<br />
|ADSR: Attack Mode<br />
|2<br />
|attack_mode: byte (1 or 5)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb8b9|0xB8]]<br />
|Tremolo (Channel Volume LFO)<br />
|4<br />
|delay: byte, rate: byte, type: byte (0-15)<br />
|When <code>rate</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb8b9|0xB9]]<br />
|Tremolo Depth<br />
|2<br />
|depth: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb8b9|0xBA]]<br />
|Turn Off Tremolo<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xBB]]<br />
|ADSR: Sustain Mode<br />
|2<br />
|sustain_mode: byte (1, 3, 5 or 7)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xbcbd|0xBC]]<br />
|Channel Pan LFO<br />
|3<br />
|rate: byte, type: byte (0-15)<br />
|When <code>rate</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xbcbd|0xBD]]<br />
|Channel Pan LFO Depth<br />
|2<br />
|depth: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xbcbd|0xBE]]<br />
|Turn Off Channel Pan LFO<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xbf|0xBF]]<br />
|ADSR: Release Mode<br />
|2<br />
|release_mode: byte (3 or 7)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc0c1|0xC0]]<br />
|Channel Transpose (Absolute)<br />
|2<br />
|semitones: signed byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc0c1|0xC1]]<br />
|Channel Transpose (Relative)<br />
|2<br />
|semitones: signed byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc2c3|0xC2]]<br />
|Turn On Reverb<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc2c3|0xC3]]<br />
|Turn Off Reverb<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc4c5|0xC4]]<br />
|Turn On Noise<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc4c5|0xC5]]<br />
|Turn Off Noise<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc6c7|0xC6]]<br />
|Turn On Frequency Modulation<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc6c7|0xC7]]<br />
|Turn Off Frequency Modulation<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc8c9|0xC8]]<br />
|Loop Point<br />
|1<br />
|<br />
|Remember the current offset as a loop point and increase the nesting level of the loop.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc8c9|0xC9]]<br />
|Return to Loop Point Up to N Times<br />
|2<br />
|times: byte<br />
|On the Nth repeat, this instruction will end the current loop by decrementing the nesting level of the loop. Otherwise, it will increment the loop counter and return to the loop point.<br />
When <code>times</code> is 0, it will be translated to 256 times.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc8c9|0xCA]]<br />
|Return to Loop Point<br />
|1<br />
|<br />
|This instruction will increment the loop counter.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xcb|0xCB]]<br />
|Reset Sound Effects<br />
|1<br />
|<br />
|Reset sound effects such as noise, frequency modulation, reverb, overlay voice and alternate voice.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xcccd|0xCC]]<br />
|Turn On Legato<br />
|1<br />
|<br />
|This instruction will stop the regular key on and key off performance of the subsequent notes and update the pitch only.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xcccd|0xCD]]<br />
|Turn Off Legato<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xcecf|0xCE]]<br />
|Turn On Noise and Toggle Noise On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xcecf|0xCF]]<br />
|Toggle Noise On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd0d1|0xD0]]<br />
|Turn On Full-Length Note Mode<br />
|1<br />
|<br />
|This instruction will stop the regular key off performance of the subsequent notes.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd0d1|0xD1]]<br />
|Turn Off Full-Length Note Mode<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd2d3|0xD2]]<br />
|Turn On Frequency Modulation and Toggle Frequency Modulation On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd2d3|0xD3]]<br />
|Toggle Frequency Modulation On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd4d5|0xD4]]<br />
|Turn On Playback Rate Side Chain<br />
|1<br />
|<br />
|Duplicate and use the playback frequency of the previous voice channel.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd4d5|0xD5]]<br />
|Turn Off Playback Rate Side Chain<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd6d7|0xD6]]<br />
|Turn On Pitch-Volume Side Chain<br />
|1<br />
|<br />
|Multiply the playback frequency of the previous voice channel to the output volume. Lower pitch will make the volume smaller.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd6d7|0xD7]]<br />
|Turn Off Pitch-Volume Side Chain<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd8d9|0xD8]]<br />
|Channel Fine Tuning (Absolute)<br />
|2<br />
|amount: signed byte<br />
|The pitch can be changed in the range of one octave above and below.<br />
The <code>amount</code> is the multiplicand for the playback frequency, not a log-based parameter like cents. For example, when the <code>amount</code> is 127, the pitch will be multiplied by 127/128 (about +1 octave). Negative value will lower the pitch.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd8d9|0xD9]]<br />
|Channel Fine Tuning (Relative)<br />
|2<br />
|amount: signed byte<br />
|The <code>amount</code> will be added to the current tuning amount.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xdadb|0xDA]]<br />
|Turn On Portamento<br />
|2<br />
|speed: byte<br />
|When <code>speed</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xdadb|0xDB]]<br />
|Turn Off Portamento<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0x0099|0xDC]]<br />
|Fix Note Length<br />
|2<br />
|length_to_add: signed byte<br />
|Ignore the regular length (delta-time) of subsequent notes and set to the fixed length. The <code>length_to_add</code> parameter will be added to the current length value. (the initial value is 0)<br />
|-<br />
|[[FF9/Sound/Opcodes/0xdd|0xDD]]<br />
|Vibrato Depth Slide<br />
|3<br />
|length: byte, depth: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xde|0xDE]]<br />
|Tremolo Depth Slide<br />
|3<br />
|length: byte, depth: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xdf|0xDF]]<br />
|Channel Pan LFO Depth Slide<br />
|3<br />
|length: byte, depth: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe0|0xE0]]<br />
|Unknown<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe1|0xE1]]<br />
|Unknown<br />
|2<br />
|value: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe2|0xE2]]<br />
|Unknown<br />
|1<br />
|<br />
|Clears the effect of opcode 0xE1<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe3|0xE3]]<br />
|Unimplemented<br />
|1<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe4|0xE4]]<br />
|Vibrato Rate Slide<br />
|3<br />
|length: byte, rate: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe5|0xE5]]<br />
|Tremolo Rate Slide<br />
|3<br />
|length: byte, rate: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe6|0xE6]]<br />
|Channel Pan LFO Rate Slide<br />
|3<br />
|length: byte, rate: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xE7-0xEF]]<br />
|Unimplemented<br />
|1<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xf0fd|0xF0-0xFD]]<br />
|Note, Tie, Rest with Length<br />
|2<br />
|length: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe00|0xFE 0x00]]<br />
|Tempo<br />
|4<br />
|tempo: uint16<br />
|bpm = tempo / 218.453333 (approximate)<br />
More strictly, <code>bpm = 60.0 / (48 * (65536.0 / tempo) * (0x43D1 / (33868800.0 / 8)))</code><br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe00|0xFE 0x01]]<br />
|Tempo Slide<br />
|5<br />
|length: byte, tempo: uint16<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe02|0xFE 0x02]]<br />
|Reverb Depth<br />
|4<br />
|depth: uint16<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe02|0xFE 0x03]]<br />
|Reverb Depth Slide<br />
|5<br />
|length: byte, depth: uint16<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe04|0xFE 0x04]]<br />
|Turn On Drum Mode<br />
|2<br />
|<br />
|The drum map offset is recorded in the file header.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe04|0xFE 0x05]]<br />
|Turn Off Drum Mode<br />
|2<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe06|0xFE 0x06]]<br />
|Unconditional Jump<br />
|4<br />
|destination_offset: signed int16<br />
|This instruction can be used to make an infinite loop.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe07|0xFE 0x07]]<br />
|CPU-Conditional Jump<br />
|5<br />
|condition: byte, destination_offset: signed int16<br />
|Jump if the condition variable matches <code>condition</code>. The value of the condition variable can be set from the game program.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe08|0xFE 0x08]]<br />
|Jump on the Nth Repeat<br />
|5<br />
|times: byte, destination_offset: signed int16<br />
|When <code>times</code> is 0, it will be translated to 256 times.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe08|0xFE 0x09]]<br />
|Break the Loop on the Nth Repeat<br />
|5<br />
|times: byte, destination_offset: signed int16<br />
|Unlike 0xF0, this instruction will end the current loop by decrementing the nesting level of the loop.<br />
When <code>times</code> is 0, it will be translated to 256 times.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa1|0xFE 0x0A]]<br />
|Load Instrument (No Attack Sample)<br />
|3<br />
|instrument: byte<br />
|Unlike 0xA1, the sample before the loop point is replaced by a short, silence sample.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe0b|0xFE 0x0B]]<br />
|Unknown<br />
|6<br />
|offset: signed int16, offset2: signed int16<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xFE 0x0C-0x0D]]<br />
|Unimplemented<br />
|2<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe0e|0xFE 0x0E]]<br />
|Pattern<br />
|4<br />
|destination_offset: signed int16<br />
|Remember the return address and jump to the specified location. It cannot be nested.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe0f|0xFE 0x0F]]<br />
|End Pattern<br />
|2<br />
|<br />
|Return from opcode 0xFE 0x0E.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe10|0xFE 0x10]]<br />
|Unknown<br />
|3<br />
|value: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe10|0xFE 0x11]]<br />
|Unknown<br />
|2<br />
|<br />
|Same as 0xFE 0x10 0x00<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa3|0xFE 0x12]]<br />
|Channel Master Volume Slide<br />
|3<br />
|length: byte, volume: byte (0-127)<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xFE 0x13]]<br />
|Unimplemented<br />
|2<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe14|0xFE 0x14]]<br />
|Load Custom Instrument (Key-Split Instrument)<br />
|3<br />
|instrument: byte<br />
|The custom instrument number corresponds to the custom instrument map pointed from the file header. Note that the number is different from the regular sample number used in opcode 0xA1.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe15|0xFE 0x15]]<br />
|Time Signature<br />
|4<br />
|ticks_per_beat: byte, beats_per_measure: byte<br />
|Note that two parameters can be 0. This pattern is used for initialization.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe16|0xFE 0x16]]<br />
|Measure Number<br />
|3<br />
|measure: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xFE 0x17-0x18]]<br />
|Unimplemented<br />
|2<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa9|0xFE 0x19]]<br />
|Channel Volume Slide Per Note On<br />
|4<br />
|length: byte, volume: byte (0-127)<br />
|Applies volume slide (opcode 0xA9) for each notes. When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe1a|0xFE 0x1A]]<br />
|Unknown<br />
|2<br />
|<br />
|Turn something on.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe1b|0xFE 0x1B]]<br />
|Unknown<br />
|2<br />
|<br />
|Clears the effect of opcode 0xFE 0x1A.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe1c|0xFE 0x1C]]<br />
|Unknown<br />
|3<br />
|value: byte<br />
|Obsoleted opcode? It probably does nothing.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe1d|0xFE 0x1D]]<br />
|Unknown<br />
|2<br />
|<br />
|Turn something on.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe1e|0xFE 0x1E]]<br />
|Unknown<br />
|2<br />
|<br />
|Clears the effect of opcode 0xFE 0x1D.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xFE 0x1F]]<br />
|Unimplemented<br />
|2<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|0xFE 0x20-0xFF<br />
|Unimplemented (Out of Range)<br />
|n/a<br />
|<br />
|Do not use.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xFF]]<br />
|Unimplemented<br />
|1<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|}</div>
Loveemu
https://wiki.ffrtt.ru/index.php?title=FF9/Sound/AKAO_sequence&diff=5769
FF9/Sound/AKAO sequence
2020-07-11T22:21:42Z
<p>Loveemu: </p>
<hr />
<div>== Introduction ==<br />
AKAO sequence is similar to MIDI sequence - it's custom tracker format for playing sequence sound, well tuned specially for PSX.<br />
<br />
<br />
== File Structure ==<br />
=== Header (size: 64 bytes) ===<br />
<br />
struct AkaoSeqHeader<br />
{<br />
static const uint8_t magic[4]; // "AKAO" C-string<br />
uint16_t id; // song ID, used for playing sequence<br />
uint16_t length; // data length (including this header)<br />
uint16_t reverb_type; // reverb type (range from 0 to 9)<br />
uint8_t field_0A[6];<br />
uint32_t field_10;<br />
uint16_t sample_set_id; // associated sample set ID<br />
uint16_t field_12;<br />
uint32_t field_14;<br />
uint32_t field_18;<br />
uint32_t field_1C;<br />
uint32_t mask; // represents bitmask of used channels in this song<br />
uint32_t field_24;<br />
uint32_t field_28;<br />
uint32_t field_2C;<br />
uint32_t instrument_map_offset; // relative offset to custom instrument map (0 if unused)<br />
uint32_t drum_map_offset; // relative offset to custom drum map (0 if unused)<br />
uint32_t field_38;<br />
uint32_t field_3C;<br />
};<br />
<br />
=== Channel Offsets (size: 2 bytes * <channels count>) ===<br />
struct AkaoChannelInfo<br />
{<br />
uint32_t start_offsets[num_channels]; // offsets to channel opcode data<br />
};<br />
<br />
AkaoSeqHeader *header;<br />
int num_channels = 0;<br />
while (int bit = 0; header->mask & (1 << bit)) != 0; bit++)<br />
num_channels++;<br />
<br />
There is <channels count> offsets to channel opcode data counting from current offset. Each offsets is a relative offset based on the address the offset itself.<br />
<br />
<br />
=== Channel Commands [AKAO Opcodes] ===<br />
For every channels in an AKAO sequence, there is a set of commands to perform. This is similar to Field opcodes. Here I will call this sound commands "opcodes". Every opcode has its own number of arguments.<br />
<br />
=== Custom Instrument Map Table ===<br />
<br />
When a song uses custom instruments with [[FF9/Sound/Opcodes/0xfe14|opcode 0xFE 0x14]], a custom instrument map table will be placed after the end of AKAO opcode sequence.<br />
<br />
This table consists of a collection of zones representing performance settings for a particular key range. A zone is an 8-byte item, and an instrument can have one or more regions.<br />
<br />
struct AkaoInstrumentZoneAttr<br />
{<br />
uint8_t instrument; // corresponding to opcode 0xA1<br />
uint8_t low_key; // lowest key (in note number)<br />
uint8_t high_key; // highest key (in note number)<br />
uint8_t ar; // ADSR: attack rate (0-127)<br />
uint8_t sr; // ADSR: sustain rate (0-127)<br />
uint8_t s_mode; // ADSR: sustain mode (1: linear increase, 3: linear decrease, 5: exponential increase, 7: exponential decrease)<br />
uint8_t rr; // ADSR: release rate (0-31)<br />
uint8_t volume; // adjust the note volume to n/128 of the original volume (0 will keep the original volume)<br />
}<br />
<br />
- Zones must be ordered from low key to high key<br />
- The final zone of the instrument must be a terminator filled with 0s (more precisely, a zone with ADSR sustain mode of 0 is considered a terminator)<br />
<br />
=== Drum Instrument Map Table ===<br />
<br />
When a song uses a drum kit with [[FF9/Sound/Opcodes/0xfe04|opcode 0xFE 0x04]], a drum instrument map table will be placed at the end of the sequence. The table determines the instrument, channel volume and pan for each keys.<br />
<br />
The table consists of a repetition of 8-byte items.<br />
<br />
struct AkaoDrumKeyAttr<br />
{<br />
uint8_t instrument; // corresponding to opcode 0xA1<br />
uint8_t key; // note number when playing the drum note<br />
uint8_t ar; // ADSR: attack rate (0-127)<br />
uint8_t sr; // ADSR: sustain rate (0-127)<br />
uint8_t s_mode; // ADSR: sustain mode (1: linear increase, 3: linear decrease, 5: exponential increase, 7: exponential decrease)<br />
uint8_t rr; // ADSR: release rate (0-31)<br />
uint8_t volume; // adjust the percussion volume to n/128 of the original volume (0 will keep the original volume)<br />
uint8_t pan : 7; // corresponding to opcode 0xAA<br />
uint8_t reverb : 1; // reverb on/off (0: off, 1: on)<br />
}<br />
<br />
<br />
== Sound Opcode List ==<br />
<br />
{| class="wikitable"<br />
! Opcode<br />
! Summary<br />
! Length<br />
! Operands<br />
! Note<br />
|-<br />
|[[FF9/Sound/Opcodes/0x0099|0x00-0x99]]<br />
|Note, Tie, Rest<br />
|1<br />
|<br />
|The opcode indicates the note key and length. The note will be keyed off 2 ticks before the next note.<br />
|-<br />
|0x9A-0x9F<br />
|Unimplemented<br />
|1<br />
|<br />
|Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xA0]]<br />
|Finish Channel<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa1|0xA1]]<br />
|Load Instrument<br />
|2<br />
|instrument: byte (0-127)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0x0099|0xA2]]<br />
|Overwrite Next Note Length<br />
|2<br />
|length: byte<br />
|Ignores the regular length (delta-time) of the next note and overwrites it with the specified length.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa8aa|0xA3]]<br />
|Channel Master Volume<br />
|2<br />
|volume: byte (0-127)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa4|0xA4]]<br />
|Pitch Bend Slide<br />
|3<br />
|length: byte, semitones: signed byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa5|0xA5]]<br />
|Set Octave<br />
|2<br />
|octave: byte (0-15)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa5|0xA6]]<br />
|Increase Octave<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa5|0xA7]]<br />
|Decrease Octave<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa8aa|0xA8]]<br />
|Channel Volume<br />
|2<br />
|volume: byte (0-127)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa9|0xA9]]<br />
|Channel Volume Slide<br />
|3<br />
|length: byte, volume: byte (0-127)<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa8aa|0xAA]]<br />
|Channel Pan<br />
|2<br />
|pan: byte (0-127)<br />
|64 is the center.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xab|0xAB]]<br />
|Channel Pan Slide<br />
|3<br />
|length: byte, pan: byte (0-127)<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xac|0xAC]]<br />
|Noise Clock Frequency<br />
|2<br />
|clock: byte (0x00-0x3f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xAD]]<br />
|ADSR: Attack Rate<br />
|2<br />
|attack_rate: byte (0x00-0x7f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xAE]]<br />
|ADSR: Decay Rate<br />
|2<br />
|decay_rate: byte (0x00-0x0f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xAF]]<br />
|ADSR: Sustain Level<br />
|2<br />
|sustain_level: byte (0x00-0x0f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xB0]]<br />
|ADSR: Decay Rate & Sustain Level<br />
|3<br />
|decay_rate: byte (0x00-0x0f), sustain_level: byte (0x00-0x0f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xB1]]<br />
|ADSR: Sustain Rate<br />
|2<br />
|sustain_rate: byte (0x00-0x7f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xB2]]<br />
|ADSR: Release Rate<br />
|2<br />
|release_rate: byte (0x00-0x1f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xB3]]<br />
|ADSR: Reset ADSR<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb4b5|0xB4]]<br />
|Vibrato (Channel Pitch LFO)<br />
|4<br />
|delay: byte, rate: byte, type: byte (0-15)<br />
|When <code>rate</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb4b5|0xB5]]<br />
|Vibrato Depth<br />
|2<br />
|depth: byte<br />
|The most significant bit of the <code>depth</code> determines the amplitude range.<br />
<br />
When it is 0, the range is up to about ± 50 cents (amplitude is 15/256 compared with range type 1).<br />
<br />
When it is 1, the range is up to about ± 700 cents.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb4b5|0xB6]]<br />
|Turn Off Vibrato<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xB7]]<br />
|ADSR: Attack Mode<br />
|2<br />
|attack_mode: byte (1 or 5)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb8b9|0xB8]]<br />
|Tremolo (Channel Volume LFO)<br />
|4<br />
|delay: byte, rate: byte, type: byte (0-15)<br />
|When <code>rate</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb8b9|0xB9]]<br />
|Tremolo Depth<br />
|2<br />
|depth: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb8b9|0xBA]]<br />
|Turn Off Tremolo<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xBB]]<br />
|ADSR: Sustain Mode<br />
|2<br />
|sustain_mode: byte (1, 3, 5 or 7)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xbcbd|0xBC]]<br />
|Channel Pan LFO<br />
|3<br />
|rate: byte, type: byte (0-15)<br />
|When <code>rate</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xbcbd|0xBD]]<br />
|Channel Pan LFO Depth<br />
|2<br />
|depth: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xbcbd|0xBE]]<br />
|Turn Off Channel Pan LFO<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xbf|0xBF]]<br />
|ADSR: Release Mode<br />
|2<br />
|release_mode: byte (3 or 7)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc0c1|0xC0]]<br />
|Channel Transpose (Absolute)<br />
|2<br />
|semitones: signed byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc0c1|0xC1]]<br />
|Channel Transpose (Relative)<br />
|2<br />
|semitones: signed byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc2c3|0xC2]]<br />
|Turn On Reverb<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc2c3|0xC3]]<br />
|Turn Off Reverb<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc4c5|0xC4]]<br />
|Turn On Noise<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc4c5|0xC5]]<br />
|Turn Off Noise<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc6c7|0xC6]]<br />
|Turn On Frequency Modulation<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc6c7|0xC7]]<br />
|Turn Off Frequency Modulation<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc8c9|0xC8]]<br />
|Loop Point<br />
|1<br />
|<br />
|Remember the current offset as a loop point and increase the nesting level of the loop.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc8c9|0xC9]]<br />
|Return to Loop Point Up to N Times<br />
|2<br />
|times: byte<br />
|On the Nth repeat, this instruction will end the current loop by decrementing the nesting level of the loop. Otherwise, it will increment the loop counter and return to the loop point.<br />
When <code>times</code> is 0, it will be translated to 256 times.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc8c9|0xCA]]<br />
|Return to Loop Point<br />
|1<br />
|<br />
|This instruction will increment the loop counter.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xcb|0xCB]]<br />
|Reset Sound Effects<br />
|1<br />
|<br />
|Reset sound effects such as noise, frequency modulation, reverb, overlay voice and alternate voice.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xcccd|0xCC]]<br />
|Turn On Legato<br />
|1<br />
|<br />
|This instruction will stop the regular key on and key off performance of the subsequent notes and update the pitch only.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xcccd|0xCD]]<br />
|Turn Off Legato<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xcecf|0xCE]]<br />
|Turn On Noise and Toggle Noise On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xcecf|0xCF]]<br />
|Toggle Noise On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd0d1|0xD0]]<br />
|Turn On Full-Length Note Mode<br />
|1<br />
|<br />
|This instruction will stop the regular key off performance of the subsequent notes.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd0d1|0xD1]]<br />
|Turn Off Full-Length Note Mode<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd2d3|0xD2]]<br />
|Turn On Frequency Modulation and Toggle Frequency Modulation On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd2d3|0xD3]]<br />
|Toggle Frequency Modulation On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd4d5|0xD4]]<br />
|Turn On Playback Rate Side Chain<br />
|1<br />
|<br />
|Duplicate and use the playback frequency of the previous voice channel.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd4d5|0xD5]]<br />
|Turn Off Playback Rate Side Chain<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd6d7|0xD6]]<br />
|Turn On Pitch-Volume Side Chain<br />
|1<br />
|<br />
|Multiply the playback frequency of the previous voice channel to the output volume. Lower pitch will make the volume smaller.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd6d7|0xD7]]<br />
|Turn Off Pitch-Volume Side Chain<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd8d9|0xD8]]<br />
|Channel Fine Tuning (Absolute)<br />
|2<br />
|amount: signed byte<br />
|The pitch can be changed in the range of one octave above and below.<br />
The <code>amount</code> is the multiplicand for the playback frequency, not a log-based parameter like cents. For example, when the <code>amount</code> is 127, the pitch will be multiplied by 127/128 (about +1 octave). Negative value will lower the pitch.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd8d9|0xD9]]<br />
|Channel Fine Tuning (Relative)<br />
|2<br />
|amount: signed byte<br />
|The <code>amount</code> will be added to the current tuning amount.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xdadb|0xDA]]<br />
|Turn On Portamento<br />
|2<br />
|speed: byte<br />
|When <code>speed</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xdadb|0xDB]]<br />
|Turn Off Portamento<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0x0099|0xDC]]<br />
|Fix Note Length<br />
|2<br />
|length_to_add: signed byte<br />
|Ignore the regular length (delta-time) of subsequent notes and set to the fixed length. The <code>length_to_add</code> parameter will be added to the current length value. (the initial value is 0)<br />
|-<br />
|[[FF9/Sound/Opcodes/0xdd|0xDD]]<br />
|Vibrato Depth Slide<br />
|3<br />
|length: byte, depth: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xde|0xDE]]<br />
|Tremolo Depth Slide<br />
|3<br />
|length: byte, depth: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xdf|0xDF]]<br />
|Channel Pan LFO Depth Slide<br />
|3<br />
|length: byte, depth: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe0|0xE0]]<br />
|Unknown<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe1|0xE1]]<br />
|Unknown<br />
|2<br />
|value: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe2|0xE2]]<br />
|Unknown<br />
|1<br />
|<br />
|Clears the effect of opcode 0xE1<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe3|0xE3]]<br />
|Unimplemented<br />
|1<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe4|0xE4]]<br />
|Vibrato Rate Slide<br />
|3<br />
|length: byte, rate: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe5|0xE5]]<br />
|Tremolo Rate Slide<br />
|3<br />
|length: byte, rate: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe6|0xE6]]<br />
|Channel Pan LFO Rate Slide<br />
|3<br />
|length: byte, rate: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xE7-0xEF]]<br />
|Unimplemented<br />
|1<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xf0fd|0xF0-0xFD]]<br />
|Note, Tie, Rest with Length<br />
|2<br />
|length: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe00|0xFE 0x00]]<br />
|Tempo<br />
|4<br />
|tempo: uint16<br />
|bpm = tempo / 218.453333 (approximate)<br />
More strictly, <code>bpm = 60.0 / (48 * (65536.0 / tempo) * (0x43D1 / (33868800.0 / 8)))</code><br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe00|0xFE 0x01]]<br />
|Tempo Slide<br />
|5<br />
|length: byte, tempo: uint16<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe02|0xFE 0x02]]<br />
|Reverb Depth<br />
|4<br />
|depth: uint16<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe02|0xFE 0x03]]<br />
|Reverb Depth Slide<br />
|5<br />
|length: byte, depth: uint16<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe04|0xFE 0x04]]<br />
|Turn On Drum Mode<br />
|2<br />
|<br />
|The drum map offset is recorded in the file header.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe04|0xFE 0x05]]<br />
|Turn Off Drum Mode<br />
|2<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe06|0xFE 0x06]]<br />
|Unconditional Jump<br />
|4<br />
|destination_offset: signed int16<br />
|This instruction can be used to make an infinite loop.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe07|0xFE 0x07]]<br />
|CPU-Conditional Jump<br />
|5<br />
|condition: byte, destination_offset: signed int16<br />
|Jump if the condition variable matches <code>condition</code>. The value of the condition variable can be set from the game program.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe08|0xFE 0x08]]<br />
|Jump on the Nth Repeat<br />
|5<br />
|times: byte, destination_offset: signed int16<br />
|When <code>times</code> is 0, it will be translated to 256 times.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe08|0xFE 0x09]]<br />
|Break the Loop on the Nth Repeat<br />
|5<br />
|times: byte, destination_offset: signed int16<br />
|Unlike 0xF0, this instruction will end the current loop by decrementing the nesting level of the loop.<br />
When <code>times</code> is 0, it will be translated to 256 times.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa1|0xFE 0x0A]]<br />
|Load Instrument (No Attack Sample)<br />
|3<br />
|instrument: byte<br />
|Unlike 0xA1, the sample before the loop point is replaced by a short, silence sample.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe0b|0xFE 0x0B]]<br />
|Unknown<br />
|6<br />
|offset: signed int16, offset2: signed int16<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xFE 0x0C-0x0D]]<br />
|Unimplemented<br />
|2<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe0e|0xFE 0x0E]]<br />
|Subroutine Jump<br />
|4<br />
|destination_offset: signed int16<br />
|The subroutine jump cannot be nested. It will overwrite the return address.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe0f|0xFE 0x0F]]<br />
|Return from Subroutine<br />
|2<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe10|0xFE 0x10]]<br />
|Unknown<br />
|3<br />
|value: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe10|0xFE 0x11]]<br />
|Unknown<br />
|2<br />
|<br />
|Same as 0xFE 0x10 0x00<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa3|0xFE 0x12]]<br />
|Channel Master Volume Slide<br />
|3<br />
|length: byte, volume: byte (0-127)<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xFE 0x13]]<br />
|Unimplemented<br />
|2<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe14|0xFE 0x14]]<br />
|Load Custom Instrument (Key-Split Instrument)<br />
|3<br />
|instrument: byte<br />
|The custom instrument number corresponds to the custom instrument map pointed from the file header. Note that the number is different from the regular sample number used in opcode 0xA1.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe15|0xFE 0x15]]<br />
|Time Signature<br />
|4<br />
|ticks_per_beat: byte, beats_per_measure: byte<br />
|Note that two parameters can be 0. This pattern is used for initialization.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe16|0xFE 0x16]]<br />
|Measure Number<br />
|3<br />
|measure: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xFE 0x17-0x18]]<br />
|Unimplemented<br />
|2<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa9|0xFE 0x19]]<br />
|Channel Volume Slide Per Note On<br />
|4<br />
|length: byte, volume: byte (0-127)<br />
|Applies volume slide (opcode 0xA9) for each notes. When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe1a|0xFE 0x1A]]<br />
|Unknown<br />
|2<br />
|<br />
|Turn something on.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe1b|0xFE 0x1B]]<br />
|Unknown<br />
|2<br />
|<br />
|Clears the effect of opcode 0xFE 0x1A.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe1c|0xFE 0x1C]]<br />
|Unknown<br />
|3<br />
|value: byte<br />
|Obsoleted opcode? It probably does nothing.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe1d|0xFE 0x1D]]<br />
|Unknown<br />
|2<br />
|<br />
|Turn something on.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe1e|0xFE 0x1E]]<br />
|Unknown<br />
|2<br />
|<br />
|Clears the effect of opcode 0xFE 0x1D.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xFE 0x1F]]<br />
|Unimplemented<br />
|2<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|0xFE 0x20-0xFF<br />
|Unimplemented (Out of Range)<br />
|n/a<br />
|<br />
|Do not use.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xFF]]<br />
|Unimplemented<br />
|1<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|}</div>
Loveemu
https://wiki.ffrtt.ru/index.php?title=FF7/PSX/Sound/AKAO_sequence&diff=5768
FF7/PSX/Sound/AKAO sequence
2020-07-11T22:11:32Z
<p>Loveemu: Channel Pitch LFO -> Vibrato, Channel Volume LFO -> Tremolo</p>
<hr />
<div>== Introduction ==<br />
AKAO sequence is the most complicated part of the FF7 sound system. ("AKAO" is the signature string, which implies that the sound format has developed by Square Enix sound programmer Minoru Akao.)<br />
<br />
AKAO sequence is similar to MIDI sequence - it's custom tracker format for playing sequence sound, well tuned specially for PSX.<br />
<br />
The sequence data can be found in all FF7 game modules: Field, Battle, Worldmap and in minigames.<br />
<br />
All files with exension *.SND are AKAO.<br />
<br />
* '''MINI/ASERI2.SND''' - Battle Arena theme<br />
* '''MINI/SENSUI.SND''' - used in Submarine minigame<br />
* '''ENEMY6/OVER2.SND''' - game over sequence<br />
* '''ENEMY6/FAN2.SND''' - battle win "fanfare" sequence<br />
* '''MOVIE/OVER2.SND''' - same game over sequence, don't know, why to duplicate data<br />
<br />
Other AKAO sequences are hard-wired in other files.<br />
<br />
<br />
== File Structure ==<br />
=== Header (size: 16 bytes) ===<br />
<br />
struct AkaoSeqHeader<br />
{<br />
static const uint8_t magic[4]; // "AKAO" C-string<br />
uint16_t id; // song ID, used for playing sequence<br />
uint16_t length; // data length - sizeof(header)<br />
uint16_t reverb_type; // reverb type (range from 0 to 9)<br />
struct AkaoTimeStamp timestamp; // creation time<br />
};<br />
<br />
struct AkaoTimeStamp<br />
{<br />
uint8_t year_bcd; // year (in binary coded decimal)<br />
uint8_t month_bcd; // month (in binary coded decimal, between 0x01 - 0x12)<br />
uint8_t day_bcd; // day (in binary coded decimal, between 0x01 - 0x31)<br />
uint8_t hours_bcd; // hours (in binary coded decimal, between 0x00 - 0x23)<br />
uint8_t minutes_bcd; // minutes (in binary coded decimal, between 0x00 - 0x59)<br />
uint8_t seconds_bcd; // seconds (in binary coded decimal, between 0x00 - 0x59)<br />
};<br />
<br />
=== Channel Info (size: 4 bytes + 2 bytes * <channels count>) ===<br />
struct AkaoChannelInfo<br />
{<br />
uint32_t mask; // represents bitmask of used channels in this song<br />
uint32_t start_offsets[num_channels]; // offsets to channel opcode data<br />
};<br />
<br />
int num_channels = 0;<br />
while (int bit = 0; ((info.mask & 0xFFFFFF) & (1 << bit)) != 0; bit++)<br />
num_channels++;<br />
<br />
First there is 32-bit number (offset 0x10), which represents bitmask of used channels in this song.<br />
<br />
After this bitmask, there is <channels count> offsets to channel opcode data counting from current offset. Each offsets is a relative offset based on the address *next to* the offset itself. (This is a general rule for early versions of AKAO to interpret relative offsets.)<br />
<br />
<br />
=== Channel Commands [AKAO Opcodes] ===<br />
For every channels in an AKAO sequence, there is a set of commands to perform. This is similar to Field opcodes. Here I will call this sound commands "opcodes". Every opcode has its own number of arguments (from no-arguments, to 3 arguments).<br />
<br />
=== Drum Instrument Map Table ===<br />
<br />
When a song uses a drum kit with [[FF7/PSX/Sound/Opcodes/0xeced|opcode 0xEC]], a drum instrument map table will be placed at the end of the sequence. The table determines the instrument, channel volume and pan for each keys.<br />
<br />
The table consists of a repetition of 5-byte items.<br />
<br />
struct AkaoDrumKeyAttr<br />
{<br />
uint8_t instrument; // corresponding to opcode 0xA1<br />
uint8_t key; // note number when playing the drum note<br />
uint16_t volume; // corresponding to opcode 0xA8 (lower 8bit is a fractional part of the volume)<br />
uint8_t pan; // corresponding to opcode 0xAA<br />
}<br />
<br />
== Example (Home-Created AKAO Sequence): ==<br />
=== Header ===<br />
'''41 4b 41 4f''' - AKAO string<br />
<br />
'''34 12''' - song ID: 0x1234<br />
<br />
'''16 00''' - data length 0x16 in hex or 22 in decimal<br />
<br />
'''04 00''' - reverb type: 4 (large studio)<br />
<br />
'''96 12 18 22 46 28''' - created at 1996-12-18 22:46:28<br />
<br />
<br />
=== Channel Info ===<br />
'''01 00 00 00''' - this indicates, that used only one channel<br />
<br />
'''00 00''' - offset to first channel opcodes: in our example 0x00 means that next to this offset is opcodes for first channel<br />
<br />
<br />
=== Channel Commands ===<br />
'''e8 a8 66''' - sets tempo, parameter 0x66a8<br />
<br />
'''ea 00 50''' - sets reverb depth<br />
<br />
'''a8 55''' - load sample 0x55 from INSTR.ALL to channel<br />
<br />
'''aa 40''' - sets channel volume<br />
<br />
'''c2''' - turns on reverb effect<br />
<br />
'''a1 0c''' - sets volume pan<br />
<br />
'''c8''' - sets loop point<br />
<br />
'''66''' - 0x66 % 11 = 3 (3 means to take 3rd number from play length table), 0x66 / 11 = 9 (9 means to take pitch[9] from loaded instrument record index)<br />
<br />
'''ca''' - returns to saved loop point with opcode c8<br />
<br />
<br />
This example plays Chocobo "Whoo-Hoo" (instrument number 0x55) repeatedly.<br />
<br />
<br />
== Sound Opcode List ==<br />
<br />
{| class="wikitable"<br />
! Opcode<br />
! Summary<br />
! Length<br />
! Operands<br />
! Note<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0x0099|0x00-0x99]]<br />
|Note, Tie, Rest<br />
|1<br />
|<br />
|The opcode indicates the note key and length. The note will be keyed off 2 ticks before the next note.<br />
|-<br />
|0x9A-0x9F<br />
|Unimplemented<br />
|1<br />
|<br />
|Should not be used.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa0|0xA0]]<br />
|Finish Channel<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa1|0xA1]]<br />
|Load Instrument<br />
|2<br />
|instrument: byte (0-127)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0x0099|0xA2]]<br />
|Overwrite Next Note Length<br />
|2<br />
|length: byte<br />
|Ignores the regular length (delta-time) of the next note and overwrites it with the specified length.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa8aa|0xA3]]<br />
|Channel Master Volume<br />
|2<br />
|volume: byte (0-127)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa4|0xA4]]<br />
|Pitch Bend Slide<br />
|3<br />
|length: byte, semitones: signed byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa5|0xA5]]<br />
|Set Octave<br />
|2<br />
|octave: byte (0-15)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa5|0xA6]]<br />
|Increase Octave<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa5|0xA7]]<br />
|Decrease Octave<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa8aa|0xA8]]<br />
|Channel Volume<br />
|2<br />
|volume: byte (0-127)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa9|0xA9]]<br />
|Channel Volume Slide<br />
|3<br />
|length: byte, volume: byte (0-127)<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa8aa|0xAA]]<br />
|Channel Pan<br />
|2<br />
|pan: byte (0-127)<br />
|64 is the center.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xab|0xAB]]<br />
|Channel Pan Slide<br />
|3<br />
|length: byte, pan: byte (0-127)<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xac|0xAC]]<br />
|Noise Clock Frequency<br />
|2<br />
|clock: byte (0x00-0x3f)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/ADSR|0xAD]]<br />
|ADSR: Attack Rate<br />
|2<br />
|attack_rate: byte (0x00-0x7f)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/ADSR|0xAE]]<br />
|ADSR: Decay Rate<br />
|2<br />
|decay_rate: byte (0x00-0x0f)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/ADSR|0xAF]]<br />
|ADSR: Sustain Level<br />
|2<br />
|sustain_level: byte (0x00-0x0f)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/ADSR|0xB0]]<br />
|ADSR: Decay Rate & Sustain Level<br />
|3<br />
|decay_rate: byte (0x00-0x0f), sustain_level: byte (0x00-0x0f)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/ADSR|0xB1]]<br />
|ADSR: Sustain Rate<br />
|2<br />
|sustain_rate: byte (0x00-0x7f)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/ADSR|0xB2]]<br />
|ADSR: Release Rate<br />
|2<br />
|release_rate: byte (0x00-0x1f)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/ADSR|0xB3]]<br />
|ADSR: Reset ADSR<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xb4b5|0xB4]]<br />
|Vibrato (Channel Pitch LFO)<br />
|4<br />
|delay: byte, rate: byte, type: byte (0-15)<br />
|When <code>rate</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xb4b5|0xB5]]<br />
|Vibrato Depth<br />
|2<br />
|depth: byte<br />
|The most significant bit of the <code>depth</code> determines the amplitude range.<br />
<br />
When it is 0, the range is up to about ± 50 cents (amplitude is 15/256 compared with range type 1).<br />
<br />
When it is 1, the range is up to about ± 700 cents.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xb4b5|0xB6]]<br />
|Turn Off Vibrato<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/ADSR|0xB7]]<br />
|ADSR: Attack Mode<br />
|2<br />
|attack_mode: byte (1 or 5)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xb8b9|0xB8]]<br />
|Tremolo (Channel Volume LFO)<br />
|4<br />
|delay: byte, rate: byte, type: byte (0-15)<br />
|When <code>rate</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xb8b9|0xB9]]<br />
|Tremolo Depth<br />
|2<br />
|depth: byte<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xb8b9|0xBA]]<br />
|Turn Off Tremolo<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/ADSR|0xBB]]<br />
|ADSR: Sustain Mode<br />
|2<br />
|sustain_mode: byte (1, 3, 5 or 7)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xbcbd|0xBC]]<br />
|Channel Pan LFO<br />
|3<br />
|rate: byte, type: byte (0-15)<br />
|When <code>rate</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xbcbd|0xBD]]<br />
|Channel Pan LFO Depth<br />
|2<br />
|depth: byte<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xbcbd|0xBE]]<br />
|Turn Off Channel Pan LFO<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xbf|0xBF]]<br />
|ADSR: Release Mode<br />
|2<br />
|release_mode: byte (3 or 7)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc0c1|0xC0]]<br />
|Channel Transpose (Absolute)<br />
|2<br />
|semitones: signed byte<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc0c1|0xC1]]<br />
|Channel Transpose (Relative)<br />
|2<br />
|semitones: signed byte<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc2c3|0xC2]]<br />
|Turn On Reverb<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc2c3|0xC3]]<br />
|Turn Off Reverb<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc4c5|0xC4]]<br />
|Turn On Noise<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc4c5|0xC5]]<br />
|Turn Off Noise<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc6c7|0xC6]]<br />
|Turn On Frequency Modulation<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc6c7|0xC7]]<br />
|Turn Off Frequency Modulation<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc8c9|0xC8]]<br />
|Loop Point<br />
|1<br />
|<br />
|Remember the current offset as a loop point and increase the nesting level of the loop.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc8c9|0xC9]]<br />
|Return to Loop Point Up to N Times<br />
|2<br />
|times: byte<br />
|On the Nth repeat, this instruction will end the current loop by decrementing the nesting level of the loop. Otherwise, it will increment the loop counter and return to the loop point.<br />
When <code>times</code> is 0, it will be translated to 256 times.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc8c9|0xCA]]<br />
|Return to Loop Point<br />
|1<br />
|<br />
|This instruction will increment the loop counter.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xcb|0xCB]]<br />
|Reset Sound Effects<br />
|1<br />
|<br />
|Reset sound effects such as noise, frequency modulation, reverb, overlay voice and alternate voice.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xcccd|0xCC]]<br />
|Turn On Legato<br />
|1<br />
|<br />
|This instruction will stop the regular key on and key off performance of the subsequent notes and update the pitch only.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xcccd|0xCD]]<br />
|Turn Off Legato<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xcecf|0xCE]]<br />
|Turn On Noise and Toggle Noise On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xcecf|0xCF]]<br />
|Toggle Noise On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xd0d1|0xD0]]<br />
|Turn On Full-Length Note Mode<br />
|1<br />
|<br />
|This instruction will stop the regular key off performance of the subsequent notes.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xd0d1|0xD1]]<br />
|Turn Off Full-Length Note Mode<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xd2d3|0xD2]]<br />
|Turn On Frequency Modulation and Toggle Frequency Modulation On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xd2d3|0xD3]]<br />
|Toggle Frequency Modulation On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xd4d5|0xD4]]<br />
|Turn On Playback Rate Side Chain<br />
|1<br />
|<br />
|Duplicate and use the playback frequency of the previous voice channel.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xd4d5|0xD5]]<br />
|Turn Off Playback Rate Side Chain<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xd6d7|0xD6]]<br />
|Turn On Pitch-Volume Side Chain<br />
|1<br />
|<br />
|Multiply the playback frequency of the previous voice channel to the output volume. Lower pitch will make the volume smaller.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xd6d7|0xD7]]<br />
|Turn Off Pitch-Volume Side Chain<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xd8d9|0xD8]]<br />
|Channel Fine Tuning (Absolute)<br />
|2<br />
|amount: signed byte<br />
|The pitch can be changed in the range of one octave above and below.<br />
The <code>amount</code> is the multiplicand for the playback frequency, not a log-based parameter like cents. For example, when the <code>amount</code> is 127, the pitch will be multiplied by 127/128 (about +1 octave). Negative value will lower the pitch.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xd8d9|0xD9]]<br />
|Channel Fine Tuning (Relative)<br />
|2<br />
|amount: signed byte<br />
|The <code>amount</code> will be added to the current tuning amount.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xdadb|0xDA]]<br />
|Turn On Portamento<br />
|2<br />
|speed: byte<br />
|When <code>speed</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xdadb|0xDB]]<br />
|Turn Off Portamento<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0x0099|0xDC]]<br />
|Fix Note Length<br />
|2<br />
|length_to_add: signed byte<br />
|Ignore the regular length (delta-time) of subsequent notes and set to the fixed length. The <code>length_to_add</code> parameter will be added to the current length value. (the initial value is 0)<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xdd|0xDD]]<br />
|Vibrato Depth Slide<br />
|3<br />
|length: byte, depth: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xde|0xDE]]<br />
|Tremolo Depth Slide<br />
|3<br />
|length: byte, depth: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xdf|0xDF]]<br />
|Channel Pan LFO Depth Slide<br />
|3<br />
|length: byte, depth: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa0|0xE0-0xE7]]<br />
|Unimplemented<br />
|1<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xe8e9|0xE8]]<br />
|Tempo<br />
|3<br />
|tempo: uint16<br />
|bpm = tempo / 214.998204 (approximate)<br />
More strictly, <code>bpm = 60.0 / (48 * (65536.0 / tempo) * (0x44E8 / (33868800.0 / 8)))</code><br />
<br />
Note that this coefficient is different from other games with PlayStation AKAO.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xe8e9|0xE9]]<br />
|Tempo Slide<br />
|4<br />
|length: byte, tempo: uint16<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xeaeb|0xEA]]<br />
|Reverb Depth<br />
|3<br />
|depth: uint16<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xeaeb|0xEB]]<br />
|Reverb Depth Slide<br />
|4<br />
|length: byte, depth: uint16<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xeced|0xEC]]<br />
|Turn On Drum Mode<br />
|3<br />
|drum_map_offset: signed int16<br />
|The <code>drum_map_offset</code> is a relative offset pointing to the drum instrument map table, which determines the instrument for each keys.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xeced|0xED]]<br />
|Turn Off Drum Mode<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xee|0xEE]]<br />
|Unconditional Jump<br />
|3<br />
|destination_offset: signed int16<br />
|This instruction can be used to make an infinite loop.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xef|0xEF]]<br />
|CPU-Conditional Jump<br />
|4<br />
|condition: byte, destination_offset: signed int16<br />
|Jump if the condition variable matches <code>condition</code>. The value of the condition variable can be set from the game program.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xf0f1|0xF0]]<br />
|Jump on the Nth Repeat<br />
|4<br />
|times: byte, destination_offset: signed int16<br />
|When <code>times</code> is 0, it will be translated to 256 times.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xf0f1|0xF1]]<br />
|Break the Loop on the Nth Repeat<br />
|4<br />
|times: byte, destination_offset: signed int16<br />
|Unlike 0xF0, this instruction will end the current loop by decrementing the nesting level of the loop.<br />
When <code>times</code> is 0, it will be translated to 256 times.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa1|0xF2]]<br />
|Load Instrument (No Attack Sample)<br />
|2<br />
|instrument: byte<br />
|Unlike 0xA1, the sample before the loop point is replaced by a short, silence sample.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xf3|0xF3]]<br />
|Unknown<br />
|1<br />
|<br />
|There is no actual use in music.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xf4f5|0xF4]]<br />
|Turn On Overlay Voice<br />
|3<br />
|instrument: byte, instrument2: byte<br />
|Play the same melody by different instruments on two voice channels. A free voice channel is required to work. Note that the two channels share the playback rate, and the pitch is not calculated for each instruments.<br />
Used in the song "Anxious Heart".<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xf4f5|0xF5]]<br />
|Turn Off Overlay Voice<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xf4f5|0xF6]]<br />
|Overlay Volume Balance<br />
|2<br />
|balance: byte (0-127)<br />
|When the balance is 0, the volume of the primary voice will be 100% (127/128) of original and that of the secondary voice will be 0%. 127 is the opposite.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xf4f5|0xF7]]<br />
|Overlay Volume Balance Slide<br />
|3<br />
|length: byte, balance: byte (0-127)<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xf8f9|0xF8]]<br />
|Turn On Alternate Voice<br />
|2<br />
|release_rate: byte (0x00-0x1f)<br />
|This instruction allows subsequent notes to be played on two alternating channels. At the same time, the ADSR release rate will be set to the specified value. A free voice channel is required to work. <br />
Check "Opening - Bombing Mission", "Tifa's Theme" and "Fortress of the Condor" for actual usage.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xf8f9|0xF9]]<br />
|Turn Off Alternate Voice<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa0|0xFA-0xFC]]<br />
|Unimplemented<br />
|1<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xfd|0xFD]]<br />
|Time Signature<br />
|3<br />
|ticks_per_beat: byte, beats_per_measure: byte<br />
|Note that two parameters can be 0. This pattern is used for initialization.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xfe|0xFE]]<br />
|Measure Number<br />
|2<br />
|measure: byte<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa0|0xFF]]<br />
|Unimplemented<br />
|1<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|}</div>
Loveemu
https://wiki.ffrtt.ru/index.php?title=FF9/Sound/AKAO_sequence&diff=5767
FF9/Sound/AKAO sequence
2020-07-11T22:10:02Z
<p>Loveemu: Channel Pitch LFO -> Vibrato, Channel Volume LFO -> Tremolo</p>
<hr />
<div>== Introduction ==<br />
AKAO sequence is similar to MIDI sequence - it's custom tracker format for playing sequence sound, well tuned specially for PSX.<br />
<br />
<br />
== File Structure ==<br />
=== Header (size: 64 bytes) ===<br />
<br />
struct AkaoSeqHeader<br />
{<br />
static const uint8_t magic[4]; // "AKAO" C-string<br />
uint16_t id; // song ID, used for playing sequence<br />
uint16_t length; // data length (including this header)<br />
uint16_t reverb_type; // reverb type (range from 0 to 9)<br />
uint8_t field_0A[6];<br />
uint32_t field_10;<br />
uint16_t sample_set_id; // associated sample set ID<br />
uint16_t field_12;<br />
uint32_t field_14;<br />
uint32_t field_18;<br />
uint32_t field_1C;<br />
uint32_t mask; // represents bitmask of used channels in this song<br />
uint32_t field_24;<br />
uint32_t field_28;<br />
uint32_t field_2C;<br />
uint32_t instrument_map_offset; // relative offset to custom instrument map (0 if unused)<br />
uint32_t drum_map_offset; // relative offset to custom drum map (0 if unused)<br />
uint32_t field_38;<br />
uint32_t field_3C;<br />
};<br />
<br />
=== Channel Offsets (size: 2 bytes * <channels count>) ===<br />
struct AkaoChannelInfo<br />
{<br />
uint32_t start_offsets[num_channels]; // offsets to channel opcode data<br />
};<br />
<br />
AkaoSeqHeader *header;<br />
int num_channels = 0;<br />
while (int bit = 0; header->mask & (1 << bit)) != 0; bit++)<br />
num_channels++;<br />
<br />
There is <channels count> offsets to channel opcode data counting from current offset. Each offsets is a relative offset based on the address the offset itself.<br />
<br />
<br />
=== Channel Commands [AKAO Opcodes] ===<br />
For every channels in an AKAO sequence, there is a set of commands to perform. This is similar to Field opcodes. Here I will call this sound commands "opcodes". Every opcode has its own number of arguments.<br />
<br />
=== Custom Instrument Map Table ===<br />
<br />
When a song uses custom instruments with [[FF9/Sound/Opcodes/0xfe14|opcode 0xFE 0x14]], a custom instrument map table will be placed after the end of AKAO opcode sequence.<br />
<br />
This table consists of a collection of zones representing performance settings for a particular key range. A zone is an 8-byte item, and an instrument can have one or more regions.<br />
<br />
struct AkaoInstrumentZoneAttr<br />
{<br />
uint8_t instrument; // corresponding to opcode 0xA1<br />
uint8_t low_key; // lowest key (in note number)<br />
uint8_t high_key; // highest key (in note number)<br />
uint8_t ar; // ADSR: attack rate (0-127)<br />
uint8_t sr; // ADSR: sustain rate (0-127)<br />
uint8_t s_mode; // ADSR: sustain mode (1: linear increase, 3: linear decrease, 5: exponential increase, 7: exponential decrease)<br />
uint8_t rr; // ADSR: release rate (0-31)<br />
uint8_t volume; // adjust the note volume to n/128 of the original volume (0 will keep the original volume)<br />
}<br />
<br />
- Zones must be ordered from low key to high key<br />
- The final zone of the instrument must be a terminator filled with 0s (more precisely, a zone with ADSR sustain mode of 0 is considered a terminator)<br />
<br />
=== Drum Instrument Map Table ===<br />
<br />
When a song uses a drum kit with [[FF9/Sound/Opcodes/0xfe04|opcode 0xFE 0x04]], a drum instrument map table will be placed at the end of the sequence. The table determines the instrument, channel volume and pan for each keys.<br />
<br />
The table consists of a repetition of 8-byte items.<br />
<br />
struct AkaoDrumKeyAttr<br />
{<br />
uint8_t instrument; // corresponding to opcode 0xA1<br />
uint8_t key; // note number when playing the drum note<br />
uint8_t ar; // ADSR: attack rate (0-127)<br />
uint8_t sr; // ADSR: sustain rate (0-127)<br />
uint8_t s_mode; // ADSR: sustain mode (1: linear increase, 3: linear decrease, 5: exponential increase, 7: exponential decrease)<br />
uint8_t rr; // ADSR: release rate (0-31)<br />
uint8_t volume; // adjust the percussion volume to n/128 of the original volume (0 will keep the original volume)<br />
uint8_t pan : 7; // corresponding to opcode 0xAA<br />
uint8_t reverb : 1; // reverb on/off (0: off, 1: on)<br />
}<br />
<br />
<br />
== Sound Opcode List ==<br />
<br />
{| class="wikitable"<br />
! Opcode<br />
! Summary<br />
! Length<br />
! Operands<br />
! Note<br />
|-<br />
|[[FF9/Sound/Opcodes/0x0099|0x00-0x99]]<br />
|Note, Tie, Rest<br />
|1<br />
|<br />
|The opcode indicates the note key and length. The note will be keyed off 2 ticks before the next note.<br />
|-<br />
|0x9A-0x9F<br />
|Unimplemented<br />
|1<br />
|<br />
|Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xA0]]<br />
|Finish Channel<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa1|0xA1]]<br />
|Load Instrument<br />
|2<br />
|instrument: byte (0-127)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0x0099|0xA2]]<br />
|Overwrite Next Note Length<br />
|2<br />
|length: byte<br />
|Ignores the regular length (delta-time) of the next note and overwrites it with the specified length.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa8aa|0xA3]]<br />
|Channel Master Volume<br />
|2<br />
|volume: byte (0-127)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa4|0xA4]]<br />
|Pitch Bend Slide<br />
|3<br />
|length: byte, semitones: signed byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa5|0xA5]]<br />
|Set Octave<br />
|2<br />
|octave: byte (0-15)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa5|0xA6]]<br />
|Increase Octave<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa5|0xA7]]<br />
|Decrease Octave<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa8aa|0xA8]]<br />
|Channel Volume<br />
|2<br />
|volume: byte (0-127)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa9|0xA9]]<br />
|Channel Volume Slide<br />
|3<br />
|length: byte, volume: byte (0-127)<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa8aa|0xAA]]<br />
|Channel Pan<br />
|2<br />
|pan: byte (0-127)<br />
|64 is the center.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xab|0xAB]]<br />
|Channel Pan Slide<br />
|3<br />
|length: byte, pan: byte (0-127)<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xac|0xAC]]<br />
|Noise Clock Frequency<br />
|2<br />
|clock: byte (0x00-0x3f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xAD]]<br />
|ADSR: Attack Rate<br />
|2<br />
|attack_rate: byte (0x00-0x7f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xAE]]<br />
|ADSR: Decay Rate<br />
|2<br />
|decay_rate: byte (0x00-0x0f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xAF]]<br />
|ADSR: Sustain Level<br />
|2<br />
|sustain_level: byte (0x00-0x0f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xB0]]<br />
|ADSR: Decay Rate & Sustain Level<br />
|3<br />
|decay_rate: byte (0x00-0x0f), sustain_level: byte (0x00-0x0f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xB1]]<br />
|ADSR: Sustain Rate<br />
|2<br />
|sustain_rate: byte (0x00-0x7f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xB2]]<br />
|ADSR: Release Rate<br />
|2<br />
|release_rate: byte (0x00-0x1f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xB3]]<br />
|ADSR: Reset ADSR<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb4b5|0xB4]]<br />
|Vibrato (Channel Pitch LFO)<br />
|4<br />
|delay: byte, rate: byte, type: byte (0-15)<br />
|When <code>rate</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb4b5|0xB5]]<br />
|Vibrato Depth<br />
|2<br />
|depth: byte<br />
|The most significant bit of the <code>depth</code> determines the amplitude range.<br />
<br />
When it is 0, the range is up to about ± 50 cents (amplitude is 15/256 compared with range type 1).<br />
<br />
When it is 1, the range is up to about ± 700 cents.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb4b5|0xB6]]<br />
|Turn Off Vibrato<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xB7]]<br />
|ADSR: Attack Mode<br />
|2<br />
|attack_mode: byte (1 or 5)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb8b9|0xB8]]<br />
|Tremolo (Channel Volume LFO)<br />
|4<br />
|delay: byte, rate: byte, type: byte (0-15)<br />
|When <code>rate</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb8b9|0xB9]]<br />
|Tremolo Depth<br />
|2<br />
|depth: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb8b9|0xBA]]<br />
|Turn Off Tremolo<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xBB]]<br />
|ADSR: Sustain Mode<br />
|2<br />
|sustain_mode: byte (1, 3, 5 or 7)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xbcbd|0xBC]]<br />
|Channel Pan LFO<br />
|3<br />
|rate: byte, type: byte (0-15)<br />
|When <code>rate</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xbcbd|0xBD]]<br />
|Channel Pan LFO Depth<br />
|2<br />
|depth: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xbcbd|0xBE]]<br />
|Turn Off Channel Pan LFO<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xbf|0xBF]]<br />
|ADSR: Release Mode<br />
|2<br />
|release_mode: byte (3 or 7)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc0c1|0xC0]]<br />
|Channel Transpose (Absolute)<br />
|2<br />
|semitones: signed byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc0c1|0xC1]]<br />
|Channel Transpose (Relative)<br />
|2<br />
|semitones: signed byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc2c3|0xC2]]<br />
|Turn On Reverb<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc2c3|0xC3]]<br />
|Turn Off Reverb<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc4c5|0xC4]]<br />
|Turn On Noise<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc4c5|0xC5]]<br />
|Turn Off Noise<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc6c7|0xC6]]<br />
|Turn On Frequency Modulation<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc6c7|0xC7]]<br />
|Turn Off Frequency Modulation<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc8c9|0xC8]]<br />
|Loop Point<br />
|1<br />
|<br />
|Remember the current offset as a loop point and increase the nesting level of the loop.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc8c9|0xC9]]<br />
|Return to Loop Point Up to N Times<br />
|2<br />
|times: byte<br />
|On the Nth repeat, this instruction will end the current loop by decrementing the nesting level of the loop. Otherwise, it will increment the loop counter and return to the loop point.<br />
When <code>times</code> is 0, it will be translated to 256 times.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc8c9|0xCA]]<br />
|Return to Loop Point<br />
|1<br />
|<br />
|This instruction will increment the loop counter.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xcb|0xCB]]<br />
|Reset Sound Effects<br />
|1<br />
|<br />
|Reset sound effects such as noise, frequency modulation, reverb, overlay voice and alternate voice.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xcccd|0xCC]]<br />
|Turn On Legato<br />
|1<br />
|<br />
|This instruction will stop the regular key on and key off performance of the subsequent notes and update the pitch only.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xcccd|0xCD]]<br />
|Turn Off Legato<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xcecf|0xCE]]<br />
|Turn On Noise and Toggle Noise On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xcecf|0xCF]]<br />
|Toggle Noise On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd0d1|0xD0]]<br />
|Turn On Full-Length Note Mode<br />
|1<br />
|<br />
|This instruction will stop the regular key off performance of the subsequent notes.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd0d1|0xD1]]<br />
|Turn Off Full-Length Note Mode<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd2d3|0xD2]]<br />
|Turn On Frequency Modulation and Toggle Frequency Modulation On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd2d3|0xD3]]<br />
|Toggle Frequency Modulation On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd4d5|0xD4]]<br />
|Turn On Playback Rate Side Chain<br />
|1<br />
|<br />
|Duplicate and use the playback frequency of the previous voice channel.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd4d5|0xD5]]<br />
|Turn Off Playback Rate Side Chain<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd6d7|0xD6]]<br />
|Turn On Pitch-Volume Side Chain<br />
|1<br />
|<br />
|Multiply the playback frequency of the previous voice channel to the output volume. Lower pitch will make the volume smaller.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd6d7|0xD7]]<br />
|Turn Off Pitch-Volume Side Chain<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd8d9|0xD8]]<br />
|Channel Fine Tuning (Absolute)<br />
|2<br />
|amount: signed byte<br />
|The pitch can be changed in the range of one octave above and below.<br />
The <code>amount</code> is the multiplicand for the playback frequency, not a log-based parameter like cents. For example, when the <code>amount</code> is 127, the pitch will be multiplied by 127/128 (about +1 octave). Negative value will lower the pitch.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd8d9|0xD9]]<br />
|Channel Fine Tuning (Relative)<br />
|2<br />
|amount: signed byte<br />
|The <code>amount</code> will be added to the current tuning amount.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xdadb|0xDA]]<br />
|Turn On Portamento<br />
|2<br />
|speed: byte<br />
|When <code>speed</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xdadb|0xDB]]<br />
|Turn Off Portamento<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0x0099|0xDC]]<br />
|Fix Note Length<br />
|2<br />
|length_to_add: signed byte<br />
|Ignore the regular length (delta-time) of subsequent notes and set to the fixed length. The <code>length_to_add</code> parameter will be added to the current length value. (the initial value is 0)<br />
|-<br />
|[[FF9/Sound/Opcodes/0xdd|0xDD]]<br />
|Vibrato Depth Slide<br />
|3<br />
|length: byte, depth: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xde|0xDE]]<br />
|Tremolo Depth Slide<br />
|3<br />
|length: byte, depth: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xdf|0xDF]]<br />
|Channel Pan LFO Depth Slide<br />
|3<br />
|length: byte, depth: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe0|0xE0]]<br />
|Unknown<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe1|0xE1]]<br />
|Unknown<br />
|2<br />
|value: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe2|0xE2]]<br />
|Unknown<br />
|1<br />
|<br />
|Clears the effect of opcode 0xE1<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe3|0xE3]]<br />
|Unimplemented<br />
|1<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe4|0xE4]]<br />
|Vibrato Rate Slide<br />
|3<br />
|length: byte, rate: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe5|0xE5]]<br />
|Tremolo Rate Slide<br />
|3<br />
|length: byte, rate: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe6|0xE6]]<br />
|Channel Pan LFO Rate Slide<br />
|3<br />
|length: byte, rate: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xE7-0xEF]]<br />
|Unimplemented<br />
|1<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xf0fd|0xF0-0xFD]]<br />
|Note, Tie, Rest with Length<br />
|2<br />
|length: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe00|0xFE 0x00]]<br />
|Tempo<br />
|4<br />
|tempo: uint16<br />
|bpm = tempo / 218.453333 (approximate)<br />
More strictly, <code>bpm = 60.0 / (48 * (65536.0 / tempo) * (0x43D1 / (33868800.0 / 8)))</code><br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe00|0xFE 0x01]]<br />
|Tempo Slide<br />
|5<br />
|length: byte, tempo: uint16<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe02|0xFE 0x02]]<br />
|Reverb Depth<br />
|4<br />
|depth: uint16<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe02|0xFE 0x03]]<br />
|Reverb Depth Slide<br />
|5<br />
|length: byte, depth: uint16<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe04|0xFE 0x04]]<br />
|Turn On Drum Mode<br />
|2<br />
|<br />
|The drum map offset is recorded in the file header.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe04|0xFE 0x05]]<br />
|Turn Off Drum Mode<br />
|2<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe06|0xFE 0x06]]<br />
|Unconditional Jump<br />
|4<br />
|destination_offset: signed int16<br />
|This instruction can be used to make an infinite loop.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe07|0xFE 0x07]]<br />
|CPU-Conditional Jump<br />
|5<br />
|condition: byte, destination_offset: signed int16<br />
|Jump if the condition variable matches <code>condition</code>. The value of the condition variable can be set from the game program.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe08|0xFE 0x08]]<br />
|Jump on the Nth Repeat<br />
|5<br />
|times: byte, destination_offset: signed int16<br />
|When <code>times</code> is 0, it will be translated to 256 times.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe08|0xFE 0x09]]<br />
|Break the Loop on the Nth Repeat<br />
|5<br />
|times: byte, destination_offset: signed int16<br />
|Unlike 0xF0, this instruction will end the current loop by decrementing the nesting level of the loop.<br />
When <code>times</code> is 0, it will be translated to 256 times.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa1|0xFE 0x0A]]<br />
|Load Instrument (No Attack Sample)<br />
|3<br />
|instrument: byte<br />
|Unlike 0xA1, the sample before the loop point is replaced by a short, silence sample.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe0b|0xFE 0x0B]]<br />
|Unknown<br />
|6<br />
|offset: signed int16, offset2: signed int16<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xFE 0x0C-0x0D]]<br />
|Unimplemented<br />
|2<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe0e|0xFE 0x0E]]<br />
|Subroutine Jump<br />
|4<br />
|destination_offset: signed int16<br />
|The subroutine jump cannot be nested. It will overwrite the return address.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe0f|0xFE 0x0F]]<br />
|Return from Subroutine<br />
|2<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe10|0xFE 0x10]]<br />
|Unknown<br />
|3<br />
|value: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe10|0xFE 0x11]]<br />
|Unknown<br />
|2<br />
|<br />
|Clears the effect of opcode 0xFE 0x10<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa3|0xFE 0x12]]<br />
|Channel Master Volume Slide<br />
|3<br />
|length: byte, volume: byte (0-127)<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xFE 0x13]]<br />
|Unimplemented<br />
|2<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe14|0xFE 0x14]]<br />
|Load Custom Instrument (Key-Split Instrument)<br />
|3<br />
|instrument: byte<br />
|The custom instrument number corresponds to the custom instrument map pointed from the file header. Note that the number is different from the regular sample number used in opcode 0xA1.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe15|0xFE 0x15]]<br />
|Time Signature<br />
|4<br />
|ticks_per_beat: byte, beats_per_measure: byte<br />
|Note that two parameters can be 0. This pattern is used for initialization.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe16|0xFE 0x16]]<br />
|Measure Number<br />
|3<br />
|measure: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xFE 0x17-0x18]]<br />
|Unimplemented<br />
|2<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa9|0xFE 0x19]]<br />
|Channel Volume Slide Per Note On<br />
|4<br />
|length: byte, volume: byte (0-127)<br />
|Applies volume slide (opcode 0xA9) for each notes. When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe1a|0xFE 0x1A]]<br />
|Unknown<br />
|2<br />
|<br />
|Turn something on.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe1b|0xFE 0x1B]]<br />
|Unknown<br />
|2<br />
|<br />
|Clears the effect of opcode 0xFE 0x1A.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe1c|0xFE 0x1C]]<br />
|Unknown<br />
|3<br />
|value: byte<br />
|Obsoleted opcode? It probably does nothing.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe1d|0xFE 0x1D]]<br />
|Unknown<br />
|2<br />
|<br />
|Turn something on.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe1e|0xFE 0x1E]]<br />
|Unknown<br />
|2<br />
|<br />
|Clears the effect of opcode 0xFE 0x1D.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xFE 0x1F]]<br />
|Unimplemented<br />
|2<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|0xFE 0x20-0xFF<br />
|Unimplemented (Out of Range)<br />
|n/a<br />
|<br />
|Do not use.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xFF]]<br />
|Unimplemented<br />
|1<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|}</div>
Loveemu
https://wiki.ffrtt.ru/index.php?title=FF9/Sound/AKAO_sequence&diff=5766
FF9/Sound/AKAO sequence
2020-07-11T22:06:51Z
<p>Loveemu: Identify opcode 0xFE 0x0A</p>
<hr />
<div>== Introduction ==<br />
AKAO sequence is similar to MIDI sequence - it's custom tracker format for playing sequence sound, well tuned specially for PSX.<br />
<br />
<br />
== File Structure ==<br />
=== Header (size: 64 bytes) ===<br />
<br />
struct AkaoSeqHeader<br />
{<br />
static const uint8_t magic[4]; // "AKAO" C-string<br />
uint16_t id; // song ID, used for playing sequence<br />
uint16_t length; // data length (including this header)<br />
uint16_t reverb_type; // reverb type (range from 0 to 9)<br />
uint8_t field_0A[6];<br />
uint32_t field_10;<br />
uint16_t sample_set_id; // associated sample set ID<br />
uint16_t field_12;<br />
uint32_t field_14;<br />
uint32_t field_18;<br />
uint32_t field_1C;<br />
uint32_t mask; // represents bitmask of used channels in this song<br />
uint32_t field_24;<br />
uint32_t field_28;<br />
uint32_t field_2C;<br />
uint32_t instrument_map_offset; // relative offset to custom instrument map (0 if unused)<br />
uint32_t drum_map_offset; // relative offset to custom drum map (0 if unused)<br />
uint32_t field_38;<br />
uint32_t field_3C;<br />
};<br />
<br />
=== Channel Offsets (size: 2 bytes * <channels count>) ===<br />
struct AkaoChannelInfo<br />
{<br />
uint32_t start_offsets[num_channels]; // offsets to channel opcode data<br />
};<br />
<br />
AkaoSeqHeader *header;<br />
int num_channels = 0;<br />
while (int bit = 0; header->mask & (1 << bit)) != 0; bit++)<br />
num_channels++;<br />
<br />
There is <channels count> offsets to channel opcode data counting from current offset. Each offsets is a relative offset based on the address the offset itself.<br />
<br />
<br />
=== Channel Commands [AKAO Opcodes] ===<br />
For every channels in an AKAO sequence, there is a set of commands to perform. This is similar to Field opcodes. Here I will call this sound commands "opcodes". Every opcode has its own number of arguments.<br />
<br />
=== Custom Instrument Map Table ===<br />
<br />
When a song uses custom instruments with [[FF9/Sound/Opcodes/0xfe14|opcode 0xFE 0x14]], a custom instrument map table will be placed after the end of AKAO opcode sequence.<br />
<br />
This table consists of a collection of zones representing performance settings for a particular key range. A zone is an 8-byte item, and an instrument can have one or more regions.<br />
<br />
struct AkaoInstrumentZoneAttr<br />
{<br />
uint8_t instrument; // corresponding to opcode 0xA1<br />
uint8_t low_key; // lowest key (in note number)<br />
uint8_t high_key; // highest key (in note number)<br />
uint8_t ar; // ADSR: attack rate (0-127)<br />
uint8_t sr; // ADSR: sustain rate (0-127)<br />
uint8_t s_mode; // ADSR: sustain mode (1: linear increase, 3: linear decrease, 5: exponential increase, 7: exponential decrease)<br />
uint8_t rr; // ADSR: release rate (0-31)<br />
uint8_t volume; // adjust the note volume to n/128 of the original volume (0 will keep the original volume)<br />
}<br />
<br />
- Zones must be ordered from low key to high key<br />
- The final zone of the instrument must be a terminator filled with 0s (more precisely, a zone with ADSR sustain mode of 0 is considered a terminator)<br />
<br />
=== Drum Instrument Map Table ===<br />
<br />
When a song uses a drum kit with [[FF9/Sound/Opcodes/0xfe04|opcode 0xFE 0x04]], a drum instrument map table will be placed at the end of the sequence. The table determines the instrument, channel volume and pan for each keys.<br />
<br />
The table consists of a repetition of 8-byte items.<br />
<br />
struct AkaoDrumKeyAttr<br />
{<br />
uint8_t instrument; // corresponding to opcode 0xA1<br />
uint8_t key; // note number when playing the drum note<br />
uint8_t ar; // ADSR: attack rate (0-127)<br />
uint8_t sr; // ADSR: sustain rate (0-127)<br />
uint8_t s_mode; // ADSR: sustain mode (1: linear increase, 3: linear decrease, 5: exponential increase, 7: exponential decrease)<br />
uint8_t rr; // ADSR: release rate (0-31)<br />
uint8_t volume; // adjust the percussion volume to n/128 of the original volume (0 will keep the original volume)<br />
uint8_t pan : 7; // corresponding to opcode 0xAA<br />
uint8_t reverb : 1; // reverb on/off (0: off, 1: on)<br />
}<br />
<br />
<br />
== Sound Opcode List ==<br />
<br />
{| class="wikitable"<br />
! Opcode<br />
! Summary<br />
! Length<br />
! Operands<br />
! Note<br />
|-<br />
|[[FF9/Sound/Opcodes/0x0099|0x00-0x99]]<br />
|Note, Tie, Rest<br />
|1<br />
|<br />
|The opcode indicates the note key and length. The note will be keyed off 2 ticks before the next note.<br />
|-<br />
|0x9A-0x9F<br />
|Unimplemented<br />
|1<br />
|<br />
|Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xA0]]<br />
|Finish Channel<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa1|0xA1]]<br />
|Load Instrument<br />
|2<br />
|instrument: byte (0-127)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0x0099|0xA2]]<br />
|Overwrite Next Note Length<br />
|2<br />
|length: byte<br />
|Ignores the regular length (delta-time) of the next note and overwrites it with the specified length.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa8aa|0xA3]]<br />
|Channel Master Volume<br />
|2<br />
|volume: byte (0-127)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa4|0xA4]]<br />
|Pitch Bend Slide<br />
|3<br />
|length: byte, semitones: signed byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa5|0xA5]]<br />
|Set Octave<br />
|2<br />
|octave: byte (0-15)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa5|0xA6]]<br />
|Increase Octave<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa5|0xA7]]<br />
|Decrease Octave<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa8aa|0xA8]]<br />
|Channel Volume<br />
|2<br />
|volume: byte (0-127)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa9|0xA9]]<br />
|Channel Volume Slide<br />
|3<br />
|length: byte, volume: byte (0-127)<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa8aa|0xAA]]<br />
|Channel Pan<br />
|2<br />
|pan: byte (0-127)<br />
|64 is the center.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xab|0xAB]]<br />
|Channel Pan Slide<br />
|3<br />
|length: byte, pan: byte (0-127)<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xac|0xAC]]<br />
|Noise Clock Frequency<br />
|2<br />
|clock: byte (0x00-0x3f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xAD]]<br />
|ADSR: Attack Rate<br />
|2<br />
|attack_rate: byte (0x00-0x7f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xAE]]<br />
|ADSR: Decay Rate<br />
|2<br />
|decay_rate: byte (0x00-0x0f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xAF]]<br />
|ADSR: Sustain Level<br />
|2<br />
|sustain_level: byte (0x00-0x0f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xB0]]<br />
|ADSR: Decay Rate & Sustain Level<br />
|3<br />
|decay_rate: byte (0x00-0x0f), sustain_level: byte (0x00-0x0f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xB1]]<br />
|ADSR: Sustain Rate<br />
|2<br />
|sustain_rate: byte (0x00-0x7f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xB2]]<br />
|ADSR: Release Rate<br />
|2<br />
|release_rate: byte (0x00-0x1f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xB3]]<br />
|ADSR: Reset ADSR<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb4b5|0xB4]]<br />
|Channel Pitch LFO (Vibrato)<br />
|4<br />
|delay: byte, rate: byte, type: byte (0-15)<br />
|When <code>rate</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb4b5|0xB5]]<br />
|Channel Pitch LFO Depth<br />
|2<br />
|depth: byte<br />
|The most significant bit of the <code>depth</code> determines the amplitude range.<br />
<br />
When it is 0, the range is up to about ± 50 cents (amplitude is 15/256 compared with range type 1).<br />
<br />
When it is 1, the range is up to about ± 700 cents.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb4b5|0xB6]]<br />
|Turn Off Channel Pitch LFO<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xB7]]<br />
|ADSR: Attack Mode<br />
|2<br />
|attack_mode: byte (1 or 5)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb8b9|0xB8]]<br />
|Channel Volume LFO (Tremolo)<br />
|4<br />
|delay: byte, rate: byte, type: byte (0-15)<br />
|When <code>rate</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb8b9|0xB9]]<br />
|Channel Volume LFO Depth<br />
|2<br />
|depth: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb8b9|0xBA]]<br />
|Turn Off Channel Volume LFO<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xBB]]<br />
|ADSR: Sustain Mode<br />
|2<br />
|sustain_mode: byte (1, 3, 5 or 7)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xbcbd|0xBC]]<br />
|Channel Pan LFO<br />
|3<br />
|rate: byte, type: byte (0-15)<br />
|When <code>rate</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xbcbd|0xBD]]<br />
|Channel Pan LFO Depth<br />
|2<br />
|depth: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xbcbd|0xBE]]<br />
|Turn Off Channel Pan LFO<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xbf|0xBF]]<br />
|ADSR: Release Mode<br />
|2<br />
|release_mode: byte (3 or 7)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc0c1|0xC0]]<br />
|Channel Transpose (Absolute)<br />
|2<br />
|semitones: signed byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc0c1|0xC1]]<br />
|Channel Transpose (Relative)<br />
|2<br />
|semitones: signed byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc2c3|0xC2]]<br />
|Turn On Reverb<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc2c3|0xC3]]<br />
|Turn Off Reverb<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc4c5|0xC4]]<br />
|Turn On Noise<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc4c5|0xC5]]<br />
|Turn Off Noise<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc6c7|0xC6]]<br />
|Turn On Frequency Modulation<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc6c7|0xC7]]<br />
|Turn Off Frequency Modulation<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc8c9|0xC8]]<br />
|Loop Point<br />
|1<br />
|<br />
|Remember the current offset as a loop point and increase the nesting level of the loop.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc8c9|0xC9]]<br />
|Return to Loop Point Up to N Times<br />
|2<br />
|times: byte<br />
|On the Nth repeat, this instruction will end the current loop by decrementing the nesting level of the loop. Otherwise, it will increment the loop counter and return to the loop point.<br />
When <code>times</code> is 0, it will be translated to 256 times.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc8c9|0xCA]]<br />
|Return to Loop Point<br />
|1<br />
|<br />
|This instruction will increment the loop counter.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xcb|0xCB]]<br />
|Reset Sound Effects<br />
|1<br />
|<br />
|Reset sound effects such as noise, frequency modulation, reverb, overlay voice and alternate voice.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xcccd|0xCC]]<br />
|Turn On Legato<br />
|1<br />
|<br />
|This instruction will stop the regular key on and key off performance of the subsequent notes and update the pitch only.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xcccd|0xCD]]<br />
|Turn Off Legato<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xcecf|0xCE]]<br />
|Turn On Noise and Toggle Noise On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xcecf|0xCF]]<br />
|Toggle Noise On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd0d1|0xD0]]<br />
|Turn On Full-Length Note Mode<br />
|1<br />
|<br />
|This instruction will stop the regular key off performance of the subsequent notes.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd0d1|0xD1]]<br />
|Turn Off Full-Length Note Mode<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd2d3|0xD2]]<br />
|Turn On Frequency Modulation and Toggle Frequency Modulation On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd2d3|0xD3]]<br />
|Toggle Frequency Modulation On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd4d5|0xD4]]<br />
|Turn On Playback Rate Side Chain<br />
|1<br />
|<br />
|Duplicate and use the playback frequency of the previous voice channel.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd4d5|0xD5]]<br />
|Turn Off Playback Rate Side Chain<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd6d7|0xD6]]<br />
|Turn On Pitch-Volume Side Chain<br />
|1<br />
|<br />
|Multiply the playback frequency of the previous voice channel to the output volume. Lower pitch will make the volume smaller.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd6d7|0xD7]]<br />
|Turn Off Pitch-Volume Side Chain<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd8d9|0xD8]]<br />
|Channel Fine Tuning (Absolute)<br />
|2<br />
|amount: signed byte<br />
|The pitch can be changed in the range of one octave above and below.<br />
The <code>amount</code> is the multiplicand for the playback frequency, not a log-based parameter like cents. For example, when the <code>amount</code> is 127, the pitch will be multiplied by 127/128 (about +1 octave). Negative value will lower the pitch.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd8d9|0xD9]]<br />
|Channel Fine Tuning (Relative)<br />
|2<br />
|amount: signed byte<br />
|The <code>amount</code> will be added to the current tuning amount.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xdadb|0xDA]]<br />
|Turn On Portamento<br />
|2<br />
|speed: byte<br />
|When <code>speed</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xdadb|0xDB]]<br />
|Turn Off Portamento<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0x0099|0xDC]]<br />
|Fix Note Length<br />
|2<br />
|length_to_add: signed byte<br />
|Ignore the regular length (delta-time) of subsequent notes and set to the fixed length. The <code>length_to_add</code> parameter will be added to the current length value. (the initial value is 0)<br />
|-<br />
|[[FF9/Sound/Opcodes/0xdd|0xDD]]<br />
|Channel Pitch LFO Depth Slide<br />
|3<br />
|length: byte, depth: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xde|0xDE]]<br />
|Channel Volume LFO Depth Slide<br />
|3<br />
|length: byte, depth: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xdf|0xDF]]<br />
|Channel Pan LFO Depth Slide<br />
|3<br />
|length: byte, depth: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe0|0xE0]]<br />
|Unknown<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe1|0xE1]]<br />
|Unknown<br />
|2<br />
|value: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe2|0xE2]]<br />
|Unknown<br />
|1<br />
|<br />
|Clears the effect of opcode 0xE1<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe3|0xE3]]<br />
|Unimplemented<br />
|1<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe4|0xE4]]<br />
|Channel Pitch LFO Rate Slide<br />
|3<br />
|length: byte, rate: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe5|0xE5]]<br />
|Channel Volume LFO Rate Slide<br />
|3<br />
|length: byte, rate: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe6|0xE6]]<br />
|Channel Pan LFO Rate Slide<br />
|3<br />
|length: byte, rate: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xE7-0xEF]]<br />
|Unimplemented<br />
|1<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xf0fd|0xF0-0xFD]]<br />
|Note, Tie, Rest with Length<br />
|2<br />
|length: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe00|0xFE 0x00]]<br />
|Tempo<br />
|4<br />
|tempo: uint16<br />
|bpm = tempo / 218.453333 (approximate)<br />
More strictly, <code>bpm = 60.0 / (48 * (65536.0 / tempo) * (0x43D1 / (33868800.0 / 8)))</code><br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe00|0xFE 0x01]]<br />
|Tempo Slide<br />
|5<br />
|length: byte, tempo: uint16<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe02|0xFE 0x02]]<br />
|Reverb Depth<br />
|4<br />
|depth: uint16<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe02|0xFE 0x03]]<br />
|Reverb Depth Slide<br />
|5<br />
|length: byte, depth: uint16<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe04|0xFE 0x04]]<br />
|Turn On Drum Mode<br />
|2<br />
|<br />
|The drum map offset is recorded in the file header.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe04|0xFE 0x05]]<br />
|Turn Off Drum Mode<br />
|2<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe06|0xFE 0x06]]<br />
|Unconditional Jump<br />
|4<br />
|destination_offset: signed int16<br />
|This instruction can be used to make an infinite loop.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe07|0xFE 0x07]]<br />
|CPU-Conditional Jump<br />
|5<br />
|condition: byte, destination_offset: signed int16<br />
|Jump if the condition variable matches <code>condition</code>. The value of the condition variable can be set from the game program.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe08|0xFE 0x08]]<br />
|Jump on the Nth Repeat<br />
|5<br />
|times: byte, destination_offset: signed int16<br />
|When <code>times</code> is 0, it will be translated to 256 times.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe08|0xFE 0x09]]<br />
|Break the Loop on the Nth Repeat<br />
|5<br />
|times: byte, destination_offset: signed int16<br />
|Unlike 0xF0, this instruction will end the current loop by decrementing the nesting level of the loop.<br />
When <code>times</code> is 0, it will be translated to 256 times.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa1|0xFE 0x0A]]<br />
|Load Instrument (No Attack Sample)<br />
|3<br />
|instrument: byte<br />
|Unlike 0xA1, the sample before the loop point is replaced by a short, silence sample.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe0b|0xFE 0x0B]]<br />
|Unknown<br />
|6<br />
|offset: signed int16, offset2: signed int16<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xFE 0x0C-0x0D]]<br />
|Unimplemented<br />
|2<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe0e|0xFE 0x0E]]<br />
|Subroutine Jump<br />
|4<br />
|destination_offset: signed int16<br />
|The subroutine jump cannot be nested. It will overwrite the return address.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe0f|0xFE 0x0F]]<br />
|Return from Subroutine<br />
|2<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe10|0xFE 0x10]]<br />
|Unknown<br />
|3<br />
|value: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe10|0xFE 0x11]]<br />
|Unknown<br />
|2<br />
|<br />
|Clears the effect of opcode 0xFE 0x10<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa3|0xFE 0x12]]<br />
|Channel Master Volume Slide<br />
|3<br />
|length: byte, volume: byte (0-127)<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xFE 0x13]]<br />
|Unimplemented<br />
|2<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe14|0xFE 0x14]]<br />
|Load Custom Instrument (Key-Split Instrument)<br />
|3<br />
|instrument: byte<br />
|The custom instrument number corresponds to the custom instrument map pointed from the file header. Note that the number is different from the regular sample number used in opcode 0xA1.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe15|0xFE 0x15]]<br />
|Time Signature<br />
|4<br />
|ticks_per_beat: byte, beats_per_measure: byte<br />
|Note that two parameters can be 0. This pattern is used for initialization.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe16|0xFE 0x16]]<br />
|Measure Number<br />
|3<br />
|measure: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xFE 0x17-0x18]]<br />
|Unimplemented<br />
|2<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa9|0xFE 0x19]]<br />
|Channel Volume Slide Per Note On<br />
|4<br />
|length: byte, volume: byte (0-127)<br />
|Applies volume slide (opcode 0xA9) for each notes. When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe1a|0xFE 0x1A]]<br />
|Unknown<br />
|2<br />
|<br />
|Turn something on.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe1b|0xFE 0x1B]]<br />
|Unknown<br />
|2<br />
|<br />
|Clears the effect of opcode 0xFE 0x1A.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe1c|0xFE 0x1C]]<br />
|Unknown<br />
|3<br />
|value: byte<br />
|Obsoleted opcode? It probably does nothing.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe1d|0xFE 0x1D]]<br />
|Unknown<br />
|2<br />
|<br />
|Turn something on.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe1e|0xFE 0x1E]]<br />
|Unknown<br />
|2<br />
|<br />
|Clears the effect of opcode 0xFE 0x1D.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xFE 0x1F]]<br />
|Unimplemented<br />
|2<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|0xFE 0x20-0xFF<br />
|Unimplemented (Out of Range)<br />
|n/a<br />
|<br />
|Do not use.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xFF]]<br />
|Unimplemented<br />
|1<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|}</div>
Loveemu
https://wiki.ffrtt.ru/index.php?title=FF9/Sound/AKAO_sequence&diff=5765
FF9/Sound/AKAO sequence
2020-07-11T21:54:47Z
<p>Loveemu: Size of all opcodes identified</p>
<hr />
<div>== Introduction ==<br />
AKAO sequence is similar to MIDI sequence - it's custom tracker format for playing sequence sound, well tuned specially for PSX.<br />
<br />
<br />
== File Structure ==<br />
=== Header (size: 64 bytes) ===<br />
<br />
struct AkaoSeqHeader<br />
{<br />
static const uint8_t magic[4]; // "AKAO" C-string<br />
uint16_t id; // song ID, used for playing sequence<br />
uint16_t length; // data length (including this header)<br />
uint16_t reverb_type; // reverb type (range from 0 to 9)<br />
uint8_t field_0A[6];<br />
uint32_t field_10;<br />
uint16_t sample_set_id; // associated sample set ID<br />
uint16_t field_12;<br />
uint32_t field_14;<br />
uint32_t field_18;<br />
uint32_t field_1C;<br />
uint32_t mask; // represents bitmask of used channels in this song<br />
uint32_t field_24;<br />
uint32_t field_28;<br />
uint32_t field_2C;<br />
uint32_t instrument_map_offset; // relative offset to custom instrument map (0 if unused)<br />
uint32_t drum_map_offset; // relative offset to custom drum map (0 if unused)<br />
uint32_t field_38;<br />
uint32_t field_3C;<br />
};<br />
<br />
=== Channel Offsets (size: 2 bytes * <channels count>) ===<br />
struct AkaoChannelInfo<br />
{<br />
uint32_t start_offsets[num_channels]; // offsets to channel opcode data<br />
};<br />
<br />
AkaoSeqHeader *header;<br />
int num_channels = 0;<br />
while (int bit = 0; header->mask & (1 << bit)) != 0; bit++)<br />
num_channels++;<br />
<br />
There is <channels count> offsets to channel opcode data counting from current offset. Each offsets is a relative offset based on the address the offset itself.<br />
<br />
<br />
=== Channel Commands [AKAO Opcodes] ===<br />
For every channels in an AKAO sequence, there is a set of commands to perform. This is similar to Field opcodes. Here I will call this sound commands "opcodes". Every opcode has its own number of arguments.<br />
<br />
=== Custom Instrument Map Table ===<br />
<br />
When a song uses custom instruments with [[FF9/Sound/Opcodes/0xfe14|opcode 0xFE 0x14]], a custom instrument map table will be placed after the end of AKAO opcode sequence.<br />
<br />
This table consists of a collection of zones representing performance settings for a particular key range. A zone is an 8-byte item, and an instrument can have one or more regions.<br />
<br />
struct AkaoInstrumentZoneAttr<br />
{<br />
uint8_t instrument; // corresponding to opcode 0xA1<br />
uint8_t low_key; // lowest key (in note number)<br />
uint8_t high_key; // highest key (in note number)<br />
uint8_t ar; // ADSR: attack rate (0-127)<br />
uint8_t sr; // ADSR: sustain rate (0-127)<br />
uint8_t s_mode; // ADSR: sustain mode (1: linear increase, 3: linear decrease, 5: exponential increase, 7: exponential decrease)<br />
uint8_t rr; // ADSR: release rate (0-31)<br />
uint8_t volume; // adjust the note volume to n/128 of the original volume (0 will keep the original volume)<br />
}<br />
<br />
- Zones must be ordered from low key to high key<br />
- The final zone of the instrument must be a terminator filled with 0s (more precisely, a zone with ADSR sustain mode of 0 is considered a terminator)<br />
<br />
=== Drum Instrument Map Table ===<br />
<br />
When a song uses a drum kit with [[FF9/Sound/Opcodes/0xfe04|opcode 0xFE 0x04]], a drum instrument map table will be placed at the end of the sequence. The table determines the instrument, channel volume and pan for each keys.<br />
<br />
The table consists of a repetition of 8-byte items.<br />
<br />
struct AkaoDrumKeyAttr<br />
{<br />
uint8_t instrument; // corresponding to opcode 0xA1<br />
uint8_t key; // note number when playing the drum note<br />
uint8_t ar; // ADSR: attack rate (0-127)<br />
uint8_t sr; // ADSR: sustain rate (0-127)<br />
uint8_t s_mode; // ADSR: sustain mode (1: linear increase, 3: linear decrease, 5: exponential increase, 7: exponential decrease)<br />
uint8_t rr; // ADSR: release rate (0-31)<br />
uint8_t volume; // adjust the percussion volume to n/128 of the original volume (0 will keep the original volume)<br />
uint8_t pan : 7; // corresponding to opcode 0xAA<br />
uint8_t reverb : 1; // reverb on/off (0: off, 1: on)<br />
}<br />
<br />
<br />
== Sound Opcode List ==<br />
<br />
{| class="wikitable"<br />
! Opcode<br />
! Summary<br />
! Length<br />
! Operands<br />
! Note<br />
|-<br />
|[[FF9/Sound/Opcodes/0x0099|0x00-0x99]]<br />
|Note, Tie, Rest<br />
|1<br />
|<br />
|The opcode indicates the note key and length. The note will be keyed off 2 ticks before the next note.<br />
|-<br />
|0x9A-0x9F<br />
|Unimplemented<br />
|1<br />
|<br />
|Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xA0]]<br />
|Finish Channel<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa1|0xA1]]<br />
|Load Instrument<br />
|2<br />
|instrument: byte (0-127)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0x0099|0xA2]]<br />
|Overwrite Next Note Length<br />
|2<br />
|length: byte<br />
|Ignores the regular length (delta-time) of the next note and overwrites it with the specified length.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa8aa|0xA3]]<br />
|Channel Master Volume<br />
|2<br />
|volume: byte (0-127)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa4|0xA4]]<br />
|Pitch Bend Slide<br />
|3<br />
|length: byte, semitones: signed byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa5|0xA5]]<br />
|Set Octave<br />
|2<br />
|octave: byte (0-15)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa5|0xA6]]<br />
|Increase Octave<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa5|0xA7]]<br />
|Decrease Octave<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa8aa|0xA8]]<br />
|Channel Volume<br />
|2<br />
|volume: byte (0-127)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa9|0xA9]]<br />
|Channel Volume Slide<br />
|3<br />
|length: byte, volume: byte (0-127)<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa8aa|0xAA]]<br />
|Channel Pan<br />
|2<br />
|pan: byte (0-127)<br />
|64 is the center.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xab|0xAB]]<br />
|Channel Pan Slide<br />
|3<br />
|length: byte, pan: byte (0-127)<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xac|0xAC]]<br />
|Noise Clock Frequency<br />
|2<br />
|clock: byte (0x00-0x3f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xAD]]<br />
|ADSR: Attack Rate<br />
|2<br />
|attack_rate: byte (0x00-0x7f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xAE]]<br />
|ADSR: Decay Rate<br />
|2<br />
|decay_rate: byte (0x00-0x0f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xAF]]<br />
|ADSR: Sustain Level<br />
|2<br />
|sustain_level: byte (0x00-0x0f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xB0]]<br />
|ADSR: Decay Rate & Sustain Level<br />
|3<br />
|decay_rate: byte (0x00-0x0f), sustain_level: byte (0x00-0x0f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xB1]]<br />
|ADSR: Sustain Rate<br />
|2<br />
|sustain_rate: byte (0x00-0x7f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xB2]]<br />
|ADSR: Release Rate<br />
|2<br />
|release_rate: byte (0x00-0x1f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xB3]]<br />
|ADSR: Reset ADSR<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb4b5|0xB4]]<br />
|Channel Pitch LFO (Vibrato)<br />
|4<br />
|delay: byte, rate: byte, type: byte (0-15)<br />
|When <code>rate</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb4b5|0xB5]]<br />
|Channel Pitch LFO Depth<br />
|2<br />
|depth: byte<br />
|The most significant bit of the <code>depth</code> determines the amplitude range.<br />
<br />
When it is 0, the range is up to about ± 50 cents (amplitude is 15/256 compared with range type 1).<br />
<br />
When it is 1, the range is up to about ± 700 cents.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb4b5|0xB6]]<br />
|Turn Off Channel Pitch LFO<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xB7]]<br />
|ADSR: Attack Mode<br />
|2<br />
|attack_mode: byte (1 or 5)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb8b9|0xB8]]<br />
|Channel Volume LFO (Tremolo)<br />
|4<br />
|delay: byte, rate: byte, type: byte (0-15)<br />
|When <code>rate</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb8b9|0xB9]]<br />
|Channel Volume LFO Depth<br />
|2<br />
|depth: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb8b9|0xBA]]<br />
|Turn Off Channel Volume LFO<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xBB]]<br />
|ADSR: Sustain Mode<br />
|2<br />
|sustain_mode: byte (1, 3, 5 or 7)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xbcbd|0xBC]]<br />
|Channel Pan LFO<br />
|3<br />
|rate: byte, type: byte (0-15)<br />
|When <code>rate</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xbcbd|0xBD]]<br />
|Channel Pan LFO Depth<br />
|2<br />
|depth: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xbcbd|0xBE]]<br />
|Turn Off Channel Pan LFO<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xbf|0xBF]]<br />
|ADSR: Release Mode<br />
|2<br />
|release_mode: byte (3 or 7)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc0c1|0xC0]]<br />
|Channel Transpose (Absolute)<br />
|2<br />
|semitones: signed byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc0c1|0xC1]]<br />
|Channel Transpose (Relative)<br />
|2<br />
|semitones: signed byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc2c3|0xC2]]<br />
|Turn On Reverb<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc2c3|0xC3]]<br />
|Turn Off Reverb<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc4c5|0xC4]]<br />
|Turn On Noise<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc4c5|0xC5]]<br />
|Turn Off Noise<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc6c7|0xC6]]<br />
|Turn On Frequency Modulation<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc6c7|0xC7]]<br />
|Turn Off Frequency Modulation<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc8c9|0xC8]]<br />
|Loop Point<br />
|1<br />
|<br />
|Remember the current offset as a loop point and increase the nesting level of the loop.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc8c9|0xC9]]<br />
|Return to Loop Point Up to N Times<br />
|2<br />
|times: byte<br />
|On the Nth repeat, this instruction will end the current loop by decrementing the nesting level of the loop. Otherwise, it will increment the loop counter and return to the loop point.<br />
When <code>times</code> is 0, it will be translated to 256 times.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc8c9|0xCA]]<br />
|Return to Loop Point<br />
|1<br />
|<br />
|This instruction will increment the loop counter.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xcb|0xCB]]<br />
|Reset Sound Effects<br />
|1<br />
|<br />
|Reset sound effects such as noise, frequency modulation, reverb, overlay voice and alternate voice.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xcccd|0xCC]]<br />
|Turn On Legato<br />
|1<br />
|<br />
|This instruction will stop the regular key on and key off performance of the subsequent notes and update the pitch only.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xcccd|0xCD]]<br />
|Turn Off Legato<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xcecf|0xCE]]<br />
|Turn On Noise and Toggle Noise On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xcecf|0xCF]]<br />
|Toggle Noise On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd0d1|0xD0]]<br />
|Turn On Full-Length Note Mode<br />
|1<br />
|<br />
|This instruction will stop the regular key off performance of the subsequent notes.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd0d1|0xD1]]<br />
|Turn Off Full-Length Note Mode<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd2d3|0xD2]]<br />
|Turn On Frequency Modulation and Toggle Frequency Modulation On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd2d3|0xD3]]<br />
|Toggle Frequency Modulation On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd4d5|0xD4]]<br />
|Turn On Playback Rate Side Chain<br />
|1<br />
|<br />
|Duplicate and use the playback frequency of the previous voice channel.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd4d5|0xD5]]<br />
|Turn Off Playback Rate Side Chain<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd6d7|0xD6]]<br />
|Turn On Pitch-Volume Side Chain<br />
|1<br />
|<br />
|Multiply the playback frequency of the previous voice channel to the output volume. Lower pitch will make the volume smaller.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd6d7|0xD7]]<br />
|Turn Off Pitch-Volume Side Chain<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd8d9|0xD8]]<br />
|Channel Fine Tuning (Absolute)<br />
|2<br />
|amount: signed byte<br />
|The pitch can be changed in the range of one octave above and below.<br />
The <code>amount</code> is the multiplicand for the playback frequency, not a log-based parameter like cents. For example, when the <code>amount</code> is 127, the pitch will be multiplied by 127/128 (about +1 octave). Negative value will lower the pitch.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd8d9|0xD9]]<br />
|Channel Fine Tuning (Relative)<br />
|2<br />
|amount: signed byte<br />
|The <code>amount</code> will be added to the current tuning amount.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xdadb|0xDA]]<br />
|Turn On Portamento<br />
|2<br />
|speed: byte<br />
|When <code>speed</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xdadb|0xDB]]<br />
|Turn Off Portamento<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0x0099|0xDC]]<br />
|Fix Note Length<br />
|2<br />
|length_to_add: signed byte<br />
|Ignore the regular length (delta-time) of subsequent notes and set to the fixed length. The <code>length_to_add</code> parameter will be added to the current length value. (the initial value is 0)<br />
|-<br />
|[[FF9/Sound/Opcodes/0xdd|0xDD]]<br />
|Channel Pitch LFO Depth Slide<br />
|3<br />
|length: byte, depth: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xde|0xDE]]<br />
|Channel Volume LFO Depth Slide<br />
|3<br />
|length: byte, depth: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xdf|0xDF]]<br />
|Channel Pan LFO Depth Slide<br />
|3<br />
|length: byte, depth: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe0|0xE0]]<br />
|Unknown<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe1|0xE1]]<br />
|Unknown<br />
|2<br />
|value: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe2|0xE2]]<br />
|Unknown<br />
|1<br />
|<br />
|Clears the effect of opcode 0xE1<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe3|0xE3]]<br />
|Unimplemented<br />
|1<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe4|0xE4]]<br />
|Channel Pitch LFO Rate Slide<br />
|3<br />
|length: byte, rate: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe5|0xE5]]<br />
|Channel Volume LFO Rate Slide<br />
|3<br />
|length: byte, rate: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe6|0xE6]]<br />
|Channel Pan LFO Rate Slide<br />
|3<br />
|length: byte, rate: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xE7-0xEF]]<br />
|Unimplemented<br />
|1<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xf0fd|0xF0-0xFD]]<br />
|Note, Tie, Rest with Length<br />
|2<br />
|length: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe00|0xFE 0x00]]<br />
|Tempo<br />
|4<br />
|tempo: uint16<br />
|bpm = tempo / 218.453333 (approximate)<br />
More strictly, <code>bpm = 60.0 / (48 * (65536.0 / tempo) * (0x43D1 / (33868800.0 / 8)))</code><br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe00|0xFE 0x01]]<br />
|Tempo Slide<br />
|5<br />
|length: byte, tempo: uint16<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe02|0xFE 0x02]]<br />
|Reverb Depth<br />
|4<br />
|depth: uint16<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe02|0xFE 0x03]]<br />
|Reverb Depth Slide<br />
|5<br />
|length: byte, depth: uint16<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe04|0xFE 0x04]]<br />
|Turn On Drum Mode<br />
|2<br />
|<br />
|The drum map offset is recorded in the file header.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe04|0xFE 0x05]]<br />
|Turn Off Drum Mode<br />
|2<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe06|0xFE 0x06]]<br />
|Unconditional Jump<br />
|4<br />
|destination_offset: signed int16<br />
|This instruction can be used to make an infinite loop.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe07|0xFE 0x07]]<br />
|CPU-Conditional Jump<br />
|5<br />
|condition: byte, destination_offset: signed int16<br />
|Jump if the condition variable matches <code>condition</code>. The value of the condition variable can be set from the game program.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe08|0xFE 0x08]]<br />
|Jump on the Nth Repeat<br />
|5<br />
|times: byte, destination_offset: signed int16<br />
|When <code>times</code> is 0, it will be translated to 256 times.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe08|0xFE 0x09]]<br />
|Break the Loop on the Nth Repeat<br />
|5<br />
|times: byte, destination_offset: signed int16<br />
|Unlike 0xF0, this instruction will end the current loop by decrementing the nesting level of the loop.<br />
When <code>times</code> is 0, it will be translated to 256 times.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa1|0xFE 0x0A]]<br />
|Load Instrument (With Some Unknown Effect)<br />
|3<br />
|instrument: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe0b|0xFE 0x0B]]<br />
|Unknown<br />
|6<br />
|offset: signed int16, offset2: signed int16<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xFE 0x0C-0x0D]]<br />
|Unimplemented<br />
|2<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe0e|0xFE 0x0E]]<br />
|Subroutine Jump<br />
|4<br />
|destination_offset: signed int16<br />
|The subroutine jump cannot be nested. It will overwrite the return address.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe0f|0xFE 0x0F]]<br />
|Return from Subroutine<br />
|2<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe10|0xFE 0x10]]<br />
|Unknown<br />
|3<br />
|value: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe10|0xFE 0x11]]<br />
|Unknown<br />
|2<br />
|<br />
|Clears the effect of opcode 0xFE 0x10<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa3|0xFE 0x12]]<br />
|Channel Master Volume Slide<br />
|3<br />
|length: byte, volume: byte (0-127)<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xFE 0x13]]<br />
|Unimplemented<br />
|2<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe14|0xFE 0x14]]<br />
|Load Custom Instrument (Key-Split Instrument)<br />
|3<br />
|instrument: byte<br />
|The custom instrument number corresponds to the custom instrument map pointed from the file header. Note that the number is different from the regular sample number used in opcode 0xA1.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe15|0xFE 0x15]]<br />
|Time Signature<br />
|4<br />
|ticks_per_beat: byte, beats_per_measure: byte<br />
|Note that two parameters can be 0. This pattern is used for initialization.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe16|0xFE 0x16]]<br />
|Measure Number<br />
|3<br />
|measure: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xFE 0x17-0x18]]<br />
|Unimplemented<br />
|2<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa9|0xFE 0x19]]<br />
|Channel Volume Slide Per Note On<br />
|4<br />
|length: byte, volume: byte (0-127)<br />
|Applies volume slide (opcode 0xA9) for each notes. When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe1a|0xFE 0x1A]]<br />
|Unknown<br />
|2<br />
|<br />
|Turn something on.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe1b|0xFE 0x1B]]<br />
|Unknown<br />
|2<br />
|<br />
|Clears the effect of opcode 0xFE 0x1A.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe1c|0xFE 0x1C]]<br />
|Unknown<br />
|3<br />
|value: byte<br />
|Obsoleted opcode? It probably does nothing.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe1d|0xFE 0x1D]]<br />
|Unknown<br />
|2<br />
|<br />
|Turn something on.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe1e|0xFE 0x1E]]<br />
|Unknown<br />
|2<br />
|<br />
|Clears the effect of opcode 0xFE 0x1D.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xFE 0x1F]]<br />
|Unimplemented<br />
|2<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|0xFE 0x20-0xFF<br />
|Unimplemented (Out of Range)<br />
|n/a<br />
|<br />
|Do not use.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xFF]]<br />
|Unimplemented<br />
|1<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|}</div>
Loveemu
https://wiki.ffrtt.ru/index.php?title=FF9/Sound/AKAO_sequence&diff=5764
FF9/Sound/AKAO sequence
2020-07-11T21:36:13Z
<p>Loveemu: </p>
<hr />
<div>== Introduction ==<br />
AKAO sequence is similar to MIDI sequence - it's custom tracker format for playing sequence sound, well tuned specially for PSX.<br />
<br />
<br />
== File Structure ==<br />
=== Header (size: 64 bytes) ===<br />
<br />
struct AkaoSeqHeader<br />
{<br />
static const uint8_t magic[4]; // "AKAO" C-string<br />
uint16_t id; // song ID, used for playing sequence<br />
uint16_t length; // data length (including this header)<br />
uint16_t reverb_type; // reverb type (range from 0 to 9)<br />
uint8_t field_0A[6];<br />
uint32_t field_10;<br />
uint16_t sample_set_id; // associated sample set ID<br />
uint16_t field_12;<br />
uint32_t field_14;<br />
uint32_t field_18;<br />
uint32_t field_1C;<br />
uint32_t mask; // represents bitmask of used channels in this song<br />
uint32_t field_24;<br />
uint32_t field_28;<br />
uint32_t field_2C;<br />
uint32_t instrument_map_offset; // relative offset to custom instrument map (0 if unused)<br />
uint32_t drum_map_offset; // relative offset to custom drum map (0 if unused)<br />
uint32_t field_38;<br />
uint32_t field_3C;<br />
};<br />
<br />
=== Channel Offsets (size: 2 bytes * <channels count>) ===<br />
struct AkaoChannelInfo<br />
{<br />
uint32_t start_offsets[num_channels]; // offsets to channel opcode data<br />
};<br />
<br />
AkaoSeqHeader *header;<br />
int num_channels = 0;<br />
while (int bit = 0; header->mask & (1 << bit)) != 0; bit++)<br />
num_channels++;<br />
<br />
There is <channels count> offsets to channel opcode data counting from current offset. Each offsets is a relative offset based on the address the offset itself.<br />
<br />
<br />
=== Channel Commands [AKAO Opcodes] ===<br />
For every channels in an AKAO sequence, there is a set of commands to perform. This is similar to Field opcodes. Here I will call this sound commands "opcodes". Every opcode has its own number of arguments.<br />
<br />
=== Custom Instrument Map Table ===<br />
<br />
When a song uses custom instruments with [[FF9/Sound/Opcodes/0xfe14|opcode 0xFE 0x14]], a custom instrument map table will be placed after the end of AKAO opcode sequence.<br />
<br />
This table consists of a collection of zones representing performance settings for a particular key range. A zone is an 8-byte item, and an instrument can have one or more regions.<br />
<br />
struct AkaoInstrumentZoneAttr<br />
{<br />
uint8_t instrument; // corresponding to opcode 0xA1<br />
uint8_t low_key; // lowest key (in note number)<br />
uint8_t high_key; // highest key (in note number)<br />
uint8_t ar; // ADSR: attack rate (0-127)<br />
uint8_t sr; // ADSR: sustain rate (0-127)<br />
uint8_t s_mode; // ADSR: sustain mode (1: linear increase, 3: linear decrease, 5: exponential increase, 7: exponential decrease)<br />
uint8_t rr; // ADSR: release rate (0-31)<br />
uint8_t volume; // adjust the note volume to n/128 of the original volume (0 will keep the original volume)<br />
}<br />
<br />
- Zones must be ordered from low key to high key<br />
- The final zone of the instrument must be a terminator filled with 0s (more precisely, a zone with ADSR sustain mode of 0 is considered a terminator)<br />
<br />
=== Drum Instrument Map Table ===<br />
<br />
When a song uses a drum kit with [[FF9/Sound/Opcodes/0xfe04|opcode 0xFE 0x04]], a drum instrument map table will be placed at the end of the sequence. The table determines the instrument, channel volume and pan for each keys.<br />
<br />
The table consists of a repetition of 8-byte items.<br />
<br />
struct AkaoDrumKeyAttr<br />
{<br />
uint8_t instrument; // corresponding to opcode 0xA1<br />
uint8_t key; // note number when playing the drum note<br />
uint8_t ar; // ADSR: attack rate (0-127)<br />
uint8_t sr; // ADSR: sustain rate (0-127)<br />
uint8_t s_mode; // ADSR: sustain mode (1: linear increase, 3: linear decrease, 5: exponential increase, 7: exponential decrease)<br />
uint8_t rr; // ADSR: release rate (0-31)<br />
uint8_t volume; // adjust the percussion volume to n/128 of the original volume (0 will keep the original volume)<br />
uint8_t pan : 7; // corresponding to opcode 0xAA<br />
uint8_t reverb : 1; // reverb on/off (0: off, 1: on)<br />
}<br />
<br />
<br />
== Sound Opcode List ==<br />
<br />
{| class="wikitable"<br />
! Opcode<br />
! Summary<br />
! Length<br />
! Operands<br />
! Note<br />
|-<br />
|[[FF9/Sound/Opcodes/0x0099|0x00-0x99]]<br />
|Note, Tie, Rest<br />
|1<br />
|<br />
|The opcode indicates the note key and length. The note will be keyed off 2 ticks before the next note.<br />
|-<br />
|0x9A-0x9F<br />
|Unimplemented<br />
|1<br />
|<br />
|Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xA0]]<br />
|Finish Channel<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa1|0xA1]]<br />
|Load Instrument<br />
|2<br />
|instrument: byte (0-127)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0x0099|0xA2]]<br />
|Overwrite Next Note Length<br />
|2<br />
|length: byte<br />
|Ignores the regular length (delta-time) of the next note and overwrites it with the specified length.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa8aa|0xA3]]<br />
|Channel Master Volume<br />
|2<br />
|volume: byte (0-127)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa4|0xA4]]<br />
|Pitch Bend Slide<br />
|3<br />
|length: byte, semitones: signed byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa5|0xA5]]<br />
|Set Octave<br />
|2<br />
|octave: byte (0-15)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa5|0xA6]]<br />
|Increase Octave<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa5|0xA7]]<br />
|Decrease Octave<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa8aa|0xA8]]<br />
|Channel Volume<br />
|2<br />
|volume: byte (0-127)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa9|0xA9]]<br />
|Channel Volume Slide<br />
|3<br />
|length: byte, volume: byte (0-127)<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa8aa|0xAA]]<br />
|Channel Pan<br />
|2<br />
|pan: byte (0-127)<br />
|64 is the center.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xab|0xAB]]<br />
|Channel Pan Slide<br />
|3<br />
|length: byte, pan: byte (0-127)<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xac|0xAC]]<br />
|Noise Clock Frequency<br />
|2<br />
|clock: byte (0x00-0x3f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xAD]]<br />
|ADSR: Attack Rate<br />
|2<br />
|attack_rate: byte (0x00-0x7f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xAE]]<br />
|ADSR: Decay Rate<br />
|2<br />
|decay_rate: byte (0x00-0x0f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xAF]]<br />
|ADSR: Sustain Level<br />
|2<br />
|sustain_level: byte (0x00-0x0f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xB0]]<br />
|ADSR: Decay Rate & Sustain Level<br />
|3<br />
|decay_rate: byte (0x00-0x0f), sustain_level: byte (0x00-0x0f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xB1]]<br />
|ADSR: Sustain Rate<br />
|2<br />
|sustain_rate: byte (0x00-0x7f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xB2]]<br />
|ADSR: Release Rate<br />
|2<br />
|release_rate: byte (0x00-0x1f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xB3]]<br />
|ADSR: Reset ADSR<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb4b5|0xB4]]<br />
|Channel Pitch LFO (Vibrato)<br />
|4<br />
|delay: byte, rate: byte, type: byte (0-15)<br />
|When <code>rate</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb4b5|0xB5]]<br />
|Channel Pitch LFO Depth<br />
|2<br />
|depth: byte<br />
|The most significant bit of the <code>depth</code> determines the amplitude range.<br />
<br />
When it is 0, the range is up to about ± 50 cents (amplitude is 15/256 compared with range type 1).<br />
<br />
When it is 1, the range is up to about ± 700 cents.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb4b5|0xB6]]<br />
|Turn Off Channel Pitch LFO<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xB7]]<br />
|ADSR: Attack Mode<br />
|2<br />
|attack_mode: byte (1 or 5)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb8b9|0xB8]]<br />
|Channel Volume LFO (Tremolo)<br />
|4<br />
|delay: byte, rate: byte, type: byte (0-15)<br />
|When <code>rate</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb8b9|0xB9]]<br />
|Channel Volume LFO Depth<br />
|2<br />
|depth: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb8b9|0xBA]]<br />
|Turn Off Channel Volume LFO<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xBB]]<br />
|ADSR: Sustain Mode<br />
|2<br />
|sustain_mode: byte (1, 3, 5 or 7)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xbcbd|0xBC]]<br />
|Channel Pan LFO<br />
|3<br />
|rate: byte, type: byte (0-15)<br />
|When <code>rate</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xbcbd|0xBD]]<br />
|Channel Pan LFO Depth<br />
|2<br />
|depth: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xbcbd|0xBE]]<br />
|Turn Off Channel Pan LFO<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xbf|0xBF]]<br />
|ADSR: Release Mode<br />
|2<br />
|release_mode: byte (3 or 7)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc0c1|0xC0]]<br />
|Channel Transpose (Absolute)<br />
|2<br />
|semitones: signed byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc0c1|0xC1]]<br />
|Channel Transpose (Relative)<br />
|2<br />
|semitones: signed byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc2c3|0xC2]]<br />
|Turn On Reverb<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc2c3|0xC3]]<br />
|Turn Off Reverb<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc4c5|0xC4]]<br />
|Turn On Noise<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc4c5|0xC5]]<br />
|Turn Off Noise<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc6c7|0xC6]]<br />
|Turn On Frequency Modulation<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc6c7|0xC7]]<br />
|Turn Off Frequency Modulation<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc8c9|0xC8]]<br />
|Loop Point<br />
|1<br />
|<br />
|Remember the current offset as a loop point and increase the nesting level of the loop.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc8c9|0xC9]]<br />
|Return to Loop Point Up to N Times<br />
|2<br />
|times: byte<br />
|On the Nth repeat, this instruction will end the current loop by decrementing the nesting level of the loop. Otherwise, it will increment the loop counter and return to the loop point.<br />
When <code>times</code> is 0, it will be translated to 256 times.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc8c9|0xCA]]<br />
|Return to Loop Point<br />
|1<br />
|<br />
|This instruction will increment the loop counter.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xcb|0xCB]]<br />
|Reset Sound Effects<br />
|1<br />
|<br />
|Reset sound effects such as noise, frequency modulation, reverb, overlay voice and alternate voice.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xcccd|0xCC]]<br />
|Turn On Legato<br />
|1<br />
|<br />
|This instruction will stop the regular key on and key off performance of the subsequent notes and update the pitch only.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xcccd|0xCD]]<br />
|Turn Off Legato<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xcecf|0xCE]]<br />
|Turn On Noise and Toggle Noise On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xcecf|0xCF]]<br />
|Toggle Noise On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd0d1|0xD0]]<br />
|Turn On Full-Length Note Mode<br />
|1<br />
|<br />
|This instruction will stop the regular key off performance of the subsequent notes.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd0d1|0xD1]]<br />
|Turn Off Full-Length Note Mode<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd2d3|0xD2]]<br />
|Turn On Frequency Modulation and Toggle Frequency Modulation On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd2d3|0xD3]]<br />
|Toggle Frequency Modulation On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd4d5|0xD4]]<br />
|Turn On Playback Rate Side Chain<br />
|1<br />
|<br />
|Duplicate and use the playback frequency of the previous voice channel.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd4d5|0xD5]]<br />
|Turn Off Playback Rate Side Chain<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd6d7|0xD6]]<br />
|Turn On Pitch-Volume Side Chain<br />
|1<br />
|<br />
|Multiply the playback frequency of the previous voice channel to the output volume. Lower pitch will make the volume smaller.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd6d7|0xD7]]<br />
|Turn Off Pitch-Volume Side Chain<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd8d9|0xD8]]<br />
|Channel Fine Tuning (Absolute)<br />
|2<br />
|amount: signed byte<br />
|The pitch can be changed in the range of one octave above and below.<br />
The <code>amount</code> is the multiplicand for the playback frequency, not a log-based parameter like cents. For example, when the <code>amount</code> is 127, the pitch will be multiplied by 127/128 (about +1 octave). Negative value will lower the pitch.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd8d9|0xD9]]<br />
|Channel Fine Tuning (Relative)<br />
|2<br />
|amount: signed byte<br />
|The <code>amount</code> will be added to the current tuning amount.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xdadb|0xDA]]<br />
|Turn On Portamento<br />
|2<br />
|speed: byte<br />
|When <code>speed</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xdadb|0xDB]]<br />
|Turn Off Portamento<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0x0099|0xDC]]<br />
|Fix Note Length<br />
|2<br />
|length_to_add: signed byte<br />
|Ignore the regular length (delta-time) of subsequent notes and set to the fixed length. The <code>length_to_add</code> parameter will be added to the current length value. (the initial value is 0)<br />
|-<br />
|[[FF9/Sound/Opcodes/0xdd|0xDD]]<br />
|Channel Pitch LFO Depth Slide<br />
|3<br />
|length: byte, depth: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xde|0xDE]]<br />
|Channel Volume LFO Depth Slide<br />
|3<br />
|length: byte, depth: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xdf|0xDF]]<br />
|Channel Pan LFO Depth Slide<br />
|3<br />
|length: byte, depth: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe0|0xE0]]<br />
|Unknown<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe1|0xE1]]<br />
|Unknown<br />
|2<br />
|value: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe2|0xE2]]<br />
|Unknown<br />
|1<br />
|<br />
|Clears the effect of opcode 0xE1<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe3|0xE3]]<br />
|Unimplemented<br />
|1<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe4|0xE4]]<br />
|Channel Pitch LFO Rate Slide<br />
|3<br />
|length: byte, rate: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe5|0xE5]]<br />
|Channel Volume LFO Rate Slide<br />
|3<br />
|length: byte, rate: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe6|0xE6]]<br />
|Channel Pan LFO Rate Slide<br />
|3<br />
|length: byte, rate: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xE7-0xEF]]<br />
|Unimplemented<br />
|1<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xf0fd|0xF0-0xFD]]<br />
|Note, Tie, Rest with Length<br />
|2<br />
|length: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe00|0xFE 0x00]]<br />
|Tempo<br />
|4<br />
|tempo: uint16<br />
|bpm = tempo / 218.453333 (approximate)<br />
More strictly, <code>bpm = 60.0 / (48 * (65536.0 / tempo) * (0x43D1 / (33868800.0 / 8)))</code><br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe00|0xFE 0x01]]<br />
|Tempo Slide<br />
|5<br />
|length: byte, tempo: uint16<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe02|0xFE 0x02]]<br />
|Reverb Depth<br />
|4<br />
|depth: uint16<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe02|0xFE 0x03]]<br />
|Reverb Depth Slide<br />
|5<br />
|length: byte, depth: uint16<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe04|0xFE 0x04]]<br />
|Turn On Drum Mode<br />
|2<br />
|<br />
|The drum map offset is recorded in the file header.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe04|0xFE 0x05]]<br />
|Turn Off Drum Mode<br />
|2<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe06|0xFE 0x06]]<br />
|Unconditional Jump<br />
|4<br />
|destination_offset: signed int16<br />
|This instruction can be used to make an infinite loop.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe07|0xFE 0x07]]<br />
|CPU-Conditional Jump<br />
|5<br />
|condition: byte, destination_offset: signed int16<br />
|Jump if the condition variable matches <code>condition</code>. The value of the condition variable can be set from the game program.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe08|0xFE 0x08]]<br />
|Jump on the Nth Repeat<br />
|5<br />
|times: byte, destination_offset: signed int16<br />
|When <code>times</code> is 0, it will be translated to 256 times.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe08|0xFE 0x09]]<br />
|Break the Loop on the Nth Repeat<br />
|5<br />
|times: byte, destination_offset: signed int16<br />
|Unlike 0xF0, this instruction will end the current loop by decrementing the nesting level of the loop.<br />
When <code>times</code> is 0, it will be translated to 256 times.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa1|0xFE 0x0A]]<br />
|Load Instrument (With Some Unknown Effect)<br />
|3<br />
|instrument: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe0b|0xFE 0x0B]]<br />
|Unknown<br />
|6<br />
|offset: signed int16, offset2: signed int16<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xFE 0x0C-0x0D]]<br />
|Unimplemented<br />
|2<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe0e|0xFE 0x0E]]<br />
|Subroutine Jump<br />
|4<br />
|destination_offset: signed int16<br />
|The subroutine jump cannot be nested. It will overwrite the return address.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe0f|0xFE 0x0F]]<br />
|Return from Subroutine<br />
|2<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe10|0xFE 0x10]]<br />
|Unknown<br />
|3<br />
|value: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe10|0xFE 0x11]]<br />
|Unknown<br />
|2<br />
|<br />
|Clears the effect of opcode 0xFE 0x10<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa3|0xFE 0x12]]<br />
|Channel Master Volume Slide<br />
|3<br />
|length: byte, volume: byte (0-127)<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xFE 0x13]]<br />
|Unimplemented<br />
|2<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe14|0xFE 0x14]]<br />
|Load Custom Instrument (Key-Split Instrument)<br />
|3<br />
|instrument: byte<br />
|The custom instrument number corresponds to the custom instrument map pointed from the file header. Note that the number is different from the regular sample number used in opcode 0xA1.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe15|0xFE 0x15]]<br />
|Time Signature<br />
|4<br />
|ticks_per_beat: byte, beats_per_measure: byte<br />
|Note that two parameters can be 0. This pattern is used for initialization.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe16|0xFE 0x16]]<br />
|Measure Number<br />
|3<br />
|measure: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xFE 0x17-0x18]]<br />
|Unimplemented<br />
|2<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe19|0xFE 0x19]]<br />
|Unknown<br />
|?<br />
|?<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe1a|0xFE 0x1A]]<br />
|Unknown<br />
|?<br />
|?<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe1b|0xFE 0x1B]]<br />
|Unknown<br />
|?<br />
|?<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe1c|0xFE 0x1C]]<br />
|Unknown<br />
|?<br />
|?<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe1d|0xFE 0x1D]]<br />
|Unknown<br />
|?<br />
|?<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe1e|0xFE 0x1E]]<br />
|Unknown<br />
|?<br />
|?<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xFE 0x1F]]<br />
|Unimplemented<br />
|2<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|0xFE 0x20-0xFF<br />
|Unimplemented (Out of Range)<br />
|n/a<br />
|<br />
|Do not use.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xFF]]<br />
|Unimplemented<br />
|1<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|}</div>
Loveemu
https://wiki.ffrtt.ru/index.php?title=FF9/Sound/AKAO_sequence&diff=5763
FF9/Sound/AKAO sequence
2020-07-11T15:47:19Z
<p>Loveemu: Add description of custom instrument map</p>
<hr />
<div>== Introduction ==<br />
AKAO sequence is similar to MIDI sequence - it's custom tracker format for playing sequence sound, well tuned specially for PSX.<br />
<br />
<br />
== File Structure ==<br />
=== Header (size: 64 bytes) ===<br />
<br />
struct AkaoSeqHeader<br />
{<br />
static const uint8_t magic[4]; // "AKAO" C-string<br />
uint16_t id; // song ID, used for playing sequence<br />
uint16_t length; // data length (including this header)<br />
uint16_t reverb_type; // reverb type (range from 0 to 9)<br />
uint8_t field_0A[6];<br />
uint32_t field_10;<br />
uint16_t sample_set_id; // associated sample set ID<br />
uint16_t field_12;<br />
uint32_t field_14;<br />
uint32_t field_18;<br />
uint32_t field_1C;<br />
uint32_t mask; // represents bitmask of used channels in this song<br />
uint32_t field_24;<br />
uint32_t field_28;<br />
uint32_t field_2C;<br />
uint32_t instrument_map_offset; // relative offset to custom instrument map (0 if unused)<br />
uint32_t drum_map_offset; // relative offset to custom drum map (0 if unused)<br />
uint32_t field_38;<br />
uint32_t field_3C;<br />
};<br />
<br />
=== Channel Offsets (size: 2 bytes * <channels count>) ===<br />
struct AkaoChannelInfo<br />
{<br />
uint32_t start_offsets[num_channels]; // offsets to channel opcode data<br />
};<br />
<br />
AkaoSeqHeader *header;<br />
int num_channels = 0;<br />
while (int bit = 0; header->mask & (1 << bit)) != 0; bit++)<br />
num_channels++;<br />
<br />
There is <channels count> offsets to channel opcode data counting from current offset. Each offsets is a relative offset based on the address the offset itself.<br />
<br />
<br />
=== Channel Commands [AKAO Opcodes] ===<br />
For every channels in an AKAO sequence, there is a set of commands to perform. This is similar to Field opcodes. Here I will call this sound commands "opcodes". Every opcode has its own number of arguments.<br />
<br />
=== Custom Instrument Map Table ===<br />
<br />
When a song uses custom instruments with [[FF9/Sound/Opcodes/0xfe14|opcode 0xFE 0x14]], a custom instrument map table will be placed after the end of AKAO opcode sequence.<br />
<br />
This table consists of a collection of zones representing performance settings for a particular key range. A zone is an 8-byte item, and an instrument can have one or more regions.<br />
<br />
struct AkaoInstrumentZoneAttr<br />
{<br />
uint8_t instrument; // corresponding to opcode 0xA1<br />
uint8_t low_key; // lowest key (in note number)<br />
uint8_t high_key; // highest key (in note number)<br />
uint8_t ar; // ADSR: attack rate (0-127)<br />
uint8_t sr; // ADSR: sustain rate (0-127)<br />
uint8_t s_mode; // ADSR: sustain mode (1: linear increase, 3: linear decrease, 5: exponential increase, 7: exponential decrease)<br />
uint8_t rr; // ADSR: release rate (0-31)<br />
uint8_t volume; // adjust the note volume to n/128 of the original volume (0 will keep the original volume)<br />
}<br />
<br />
- Zones must be ordered from low key to high key<br />
- The final zone of the instrument must be a terminator filled with 0s (more precisely, a zone with ADSR sustain mode of 0 is considered a terminator)<br />
<br />
=== Drum Instrument Map Table ===<br />
<br />
When a song uses a drum kit with [[FF9/Sound/Opcodes/0xfe04|opcode 0xFE 0x04]], a drum instrument map table will be placed at the end of the sequence. The table determines the instrument, channel volume and pan for each keys.<br />
<br />
The table consists of a repetition of 8-byte items.<br />
<br />
struct AkaoDrumKeyAttr<br />
{<br />
uint8_t instrument; // corresponding to opcode 0xA1<br />
uint8_t key; // note number when playing the drum note<br />
uint8_t ar; // ADSR: attack rate (0-127)<br />
uint8_t sr; // ADSR: sustain rate (0-127)<br />
uint8_t s_mode; // ADSR: sustain mode (1: linear increase, 3: linear decrease, 5: exponential increase, 7: exponential decrease)<br />
uint8_t rr; // ADSR: release rate (0-31)<br />
uint8_t volume; // adjust the percussion volume to n/128 of the original volume (0 will keep the original volume)<br />
uint8_t pan : 7; // corresponding to opcode 0xAA<br />
uint8_t reverb : 1; // reverb on/off (0: off, 1: on)<br />
}<br />
<br />
<br />
== Sound Opcode List ==<br />
<br />
{| class="wikitable"<br />
! Opcode<br />
! Summary<br />
! Length<br />
! Operands<br />
! Note<br />
|-<br />
|[[FF9/Sound/Opcodes/0x0099|0x00-0x99]]<br />
|Note, Tie, Rest<br />
|1<br />
|<br />
|The opcode indicates the note key and length. The note will be keyed off 2 ticks before the next note.<br />
|-<br />
|0x9A-0x9F<br />
|Unimplemented<br />
|1<br />
|<br />
|Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xA0]]<br />
|Finish Channel<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa1|0xA1]]<br />
|Load Instrument<br />
|2<br />
|instrument: byte (0-127)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0x0099|0xA2]]<br />
|Overwrite Next Note Length<br />
|2<br />
|length: byte<br />
|Ignores the regular length (delta-time) of the next note and overwrites it with the specified length.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa8aa|0xA3]]<br />
|Channel Master Volume<br />
|2<br />
|volume: byte (0-127)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa4|0xA4]]<br />
|Pitch Bend Slide<br />
|3<br />
|length: byte, semitones: signed byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa5|0xA5]]<br />
|Set Octave<br />
|2<br />
|octave: byte (0-15)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa5|0xA6]]<br />
|Increase Octave<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa5|0xA7]]<br />
|Decrease Octave<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa8aa|0xA8]]<br />
|Channel Volume<br />
|2<br />
|volume: byte (0-127)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa9|0xA9]]<br />
|Channel Volume Slide<br />
|3<br />
|length: byte, volume: byte (0-127)<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa8aa|0xAA]]<br />
|Channel Pan<br />
|2<br />
|pan: byte (0-127)<br />
|64 is the center.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xab|0xAB]]<br />
|Channel Pan Slide<br />
|3<br />
|length: byte, pan: byte (0-127)<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xac|0xAC]]<br />
|Noise Clock Frequency<br />
|2<br />
|clock: byte (0x00-0x3f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xAD]]<br />
|ADSR: Attack Rate<br />
|2<br />
|attack_rate: byte (0x00-0x7f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xAE]]<br />
|ADSR: Decay Rate<br />
|2<br />
|decay_rate: byte (0x00-0x0f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xAF]]<br />
|ADSR: Sustain Level<br />
|2<br />
|sustain_level: byte (0x00-0x0f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xB0]]<br />
|ADSR: Decay Rate & Sustain Level<br />
|3<br />
|decay_rate: byte (0x00-0x0f), sustain_level: byte (0x00-0x0f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xB1]]<br />
|ADSR: Sustain Rate<br />
|2<br />
|sustain_rate: byte (0x00-0x7f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xB2]]<br />
|ADSR: Release Rate<br />
|2<br />
|release_rate: byte (0x00-0x1f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xB3]]<br />
|ADSR: Reset ADSR<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb4b5|0xB4]]<br />
|Channel Pitch LFO (Vibrato)<br />
|4<br />
|delay: byte, rate: byte, type: byte (0-15)<br />
|When <code>rate</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb4b5|0xB5]]<br />
|Channel Pitch LFO Depth<br />
|2<br />
|depth: byte<br />
|The most significant bit of the <code>depth</code> determines the amplitude range.<br />
<br />
When it is 0, the range is up to about ± 50 cents (amplitude is 15/256 compared with range type 1).<br />
<br />
When it is 1, the range is up to about ± 700 cents.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb4b5|0xB6]]<br />
|Turn Off Channel Pitch LFO<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xB7]]<br />
|ADSR: Attack Mode<br />
|2<br />
|attack_mode: byte (1 or 5)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb8b9|0xB8]]<br />
|Channel Volume LFO (Tremolo)<br />
|4<br />
|delay: byte, rate: byte, type: byte (0-15)<br />
|When <code>rate</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb8b9|0xB9]]<br />
|Channel Volume LFO Depth<br />
|2<br />
|depth: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb8b9|0xBA]]<br />
|Turn Off Channel Volume LFO<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xBB]]<br />
|ADSR: Sustain Mode<br />
|2<br />
|sustain_mode: byte (1, 3, 5 or 7)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xbcbd|0xBC]]<br />
|Channel Pan LFO<br />
|3<br />
|rate: byte, type: byte (0-15)<br />
|When <code>rate</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xbcbd|0xBD]]<br />
|Channel Pan LFO Depth<br />
|2<br />
|depth: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xbcbd|0xBE]]<br />
|Turn Off Channel Pan LFO<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xbf|0xBF]]<br />
|ADSR: Release Mode<br />
|2<br />
|release_mode: byte (3 or 7)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc0c1|0xC0]]<br />
|Channel Transpose (Absolute)<br />
|2<br />
|semitones: signed byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc0c1|0xC1]]<br />
|Channel Transpose (Relative)<br />
|2<br />
|semitones: signed byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc2c3|0xC2]]<br />
|Turn On Reverb<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc2c3|0xC3]]<br />
|Turn Off Reverb<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc4c5|0xC4]]<br />
|Turn On Noise<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc4c5|0xC5]]<br />
|Turn Off Noise<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc6c7|0xC6]]<br />
|Turn On Frequency Modulation<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc6c7|0xC7]]<br />
|Turn Off Frequency Modulation<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc8c9|0xC8]]<br />
|Loop Point<br />
|1<br />
|<br />
|Remember the current offset as a loop point and increase the nesting level of the loop.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc8c9|0xC9]]<br />
|Return to Loop Point Up to N Times<br />
|2<br />
|times: byte<br />
|On the Nth repeat, this instruction will end the current loop by decrementing the nesting level of the loop. Otherwise, it will increment the loop counter and return to the loop point.<br />
When <code>times</code> is 0, it will be translated to 256 times.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc8c9|0xCA]]<br />
|Return to Loop Point<br />
|1<br />
|<br />
|This instruction will increment the loop counter.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xcb|0xCB]]<br />
|Reset Sound Effects<br />
|1<br />
|<br />
|Reset sound effects such as noise, frequency modulation, reverb, overlay voice and alternate voice.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xcccd|0xCC]]<br />
|Turn On Legato<br />
|1<br />
|<br />
|This instruction will stop the regular key on and key off performance of the subsequent notes and update the pitch only.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xcccd|0xCD]]<br />
|Turn Off Legato<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xcecf|0xCE]]<br />
|Turn On Noise and Toggle Noise On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xcecf|0xCF]]<br />
|Toggle Noise On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd0d1|0xD0]]<br />
|Turn On Full-Length Note Mode<br />
|1<br />
|<br />
|This instruction will stop the regular key off performance of the subsequent notes.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd0d1|0xD1]]<br />
|Turn Off Full-Length Note Mode<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd2d3|0xD2]]<br />
|Turn On Frequency Modulation and Toggle Frequency Modulation On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd2d3|0xD3]]<br />
|Toggle Frequency Modulation On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd4d5|0xD4]]<br />
|Turn On Playback Rate Side Chain<br />
|1<br />
|<br />
|Duplicate and use the playback frequency of the previous voice channel.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd4d5|0xD5]]<br />
|Turn Off Playback Rate Side Chain<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd6d7|0xD6]]<br />
|Turn On Pitch-Volume Side Chain<br />
|1<br />
|<br />
|Multiply the playback frequency of the previous voice channel to the output volume. Lower pitch will make the volume smaller.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd6d7|0xD7]]<br />
|Turn Off Pitch-Volume Side Chain<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd8d9|0xD8]]<br />
|Channel Fine Tuning (Absolute)<br />
|2<br />
|amount: signed byte<br />
|The pitch can be changed in the range of one octave above and below.<br />
The <code>amount</code> is the multiplicand for the playback frequency, not a log-based parameter like cents. For example, when the <code>amount</code> is 127, the pitch will be multiplied by 127/128 (about +1 octave). Negative value will lower the pitch.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd8d9|0xD9]]<br />
|Channel Fine Tuning (Relative)<br />
|2<br />
|amount: signed byte<br />
|The <code>amount</code> will be added to the current tuning amount.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xdadb|0xDA]]<br />
|Turn On Portamento<br />
|2<br />
|speed: byte<br />
|When <code>speed</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xdadb|0xDB]]<br />
|Turn Off Portamento<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0x0099|0xDC]]<br />
|Fix Note Length<br />
|2<br />
|length_to_add: signed byte<br />
|Ignore the regular length (delta-time) of subsequent notes and set to the fixed length. The <code>length_to_add</code> parameter will be added to the current length value. (the initial value is 0)<br />
|-<br />
|[[FF9/Sound/Opcodes/0xdd|0xDD]]<br />
|Channel Pitch LFO Depth Slide<br />
|3<br />
|length: byte, depth: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xde|0xDE]]<br />
|Channel Volume LFO Depth Slide<br />
|3<br />
|length: byte, depth: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xdf|0xDF]]<br />
|Channel Pan LFO Depth Slide<br />
|3<br />
|length: byte, depth: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe0|0xE0]]<br />
|Unknown<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe1|0xE1]]<br />
|Unknown<br />
|2<br />
|value: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe2|0xE2]]<br />
|Unknown<br />
|1<br />
|<br />
|Clears the effect of opcode 0xE1<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe3|0xE3]]<br />
|Unimplemented<br />
|1<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe4|0xE4]]<br />
|Channel Pitch LFO Rate Slide<br />
|3<br />
|length: byte, rate: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe5|0xE5]]<br />
|Channel Volume LFO Rate Slide<br />
|3<br />
|length: byte, rate: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe6|0xE6]]<br />
|Channel Pan LFO Rate Slide<br />
|3<br />
|length: byte, rate: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xE7-0xEF]]<br />
|Unimplemented<br />
|1<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xf0fd|0xF0-0xFD]]<br />
|Note, Tie, Rest with Length<br />
|2<br />
|length: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe00|0xFE 0x00]]<br />
|Tempo<br />
|4<br />
|tempo: uint16<br />
|bpm = tempo / 218.453333 (approximate)<br />
More strictly, <code>bpm = 60.0 / (48 * (65536.0 / tempo) * (0x43D1 / (33868800.0 / 8)))</code><br />
<br />
Note that this coefficient is different from other games with PlayStation AKAO.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe00|0xFE 0x01]]<br />
|Tempo Slide<br />
|5<br />
|length: byte, tempo: uint16<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe02|0xFE 0x02]]<br />
|Reverb Depth<br />
|4<br />
|depth: uint16<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe02|0xFE 0x03]]<br />
|Reverb Depth Slide<br />
|5<br />
|length: byte, depth: uint16<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe04|0xFE 0x04]]<br />
|Turn On Drum Mode<br />
|2<br />
|<br />
|The drum map offset is recorded in the file header.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe04|0xFE 0x05]]<br />
|Turn Off Drum Mode<br />
|2<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe06|0xFE 0x06]]<br />
|Unconditional Jump<br />
|4<br />
|destination_offset: signed int16<br />
|This instruction can be used to make an infinite loop.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe07|0xFE 0x07]]<br />
|CPU-Conditional Jump<br />
|5<br />
|condition: byte, destination_offset: signed int16<br />
|Jump if the condition variable matches <code>condition</code>. The value of the condition variable can be set from the game program.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe08|0xFE 0x08]]<br />
|Jump on the Nth Repeat<br />
|5<br />
|times: byte, destination_offset: signed int16<br />
|When <code>times</code> is 0, it will be translated to 256 times.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe08|0xFE 0x09]]<br />
|Break the Loop on the Nth Repeat<br />
|5<br />
|times: byte, destination_offset: signed int16<br />
|Unlike 0xF0, this instruction will end the current loop by decrementing the nesting level of the loop.<br />
When <code>times</code> is 0, it will be translated to 256 times.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa1|0xFE 0x0A]]<br />
|Load Instrument (With Some Unknown Effect)<br />
|3<br />
|instrument: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe0b|0xFE 0x0B]]<br />
|Unknown<br />
|6<br />
|offset: signed int16, offset2: signed int16<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xFE 0x0C-0x0D]]<br />
|Unimplemented<br />
|2<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe0e|0xFE 0x0E]]<br />
|Subroutine Jump<br />
|4<br />
|destination_offset: signed int16<br />
|The subroutine jump cannot be nested. It will overwrite the return address.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe0f|0xFE 0x0F]]<br />
|Return from Subroutine<br />
|2<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe10|0xFE 0x10]]<br />
|Unknown<br />
|3<br />
|value: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe10|0xFE 0x11]]<br />
|Unknown<br />
|2<br />
|<br />
|Clears the effect of opcode 0xFE 0x10<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa3|0xFE 0x12]]<br />
|Channel Master Volume Slide<br />
|3<br />
|length: byte, volume: byte (0-127)<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xFE 0x13]]<br />
|Unimplemented<br />
|2<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe14|0xFE 0x14]]<br />
|Load Custom Instrument (Key-Split Instrument)<br />
|3<br />
|instrument: byte<br />
|The custom instrument number corresponds to the custom instrument map pointed from the file header. Note that the number is different from the regular sample number used in opcode 0xA1.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe15|0xFE 0x15]]<br />
|Time Signature<br />
|4<br />
|ticks_per_beat: byte, beats_per_measure: byte<br />
|Note that two parameters can be 0. This pattern is used for initialization.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe16|0xFE 0x16]]<br />
|Measure Number<br />
|3<br />
|measure: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xFE 0x17-0x18]]<br />
|Unimplemented<br />
|2<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe19|0xFE 0x19]]<br />
|Unknown<br />
|?<br />
|?<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe1a|0xFE 0x1A]]<br />
|Unknown<br />
|?<br />
|?<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe1b|0xFE 0x1B]]<br />
|Unknown<br />
|?<br />
|?<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe1c|0xFE 0x1C]]<br />
|Unknown<br />
|?<br />
|?<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe1d|0xFE 0x1D]]<br />
|Unknown<br />
|?<br />
|?<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe1e|0xFE 0x1E]]<br />
|Unknown<br />
|?<br />
|?<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xFE 0x1F]]<br />
|Unimplemented<br />
|2<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|0xFE 0x20-0xFF<br />
|Unimplemented (Out of Range)<br />
|n/a<br />
|<br />
|Do not use.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xFF]]<br />
|Unimplemented<br />
|1<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|}</div>
Loveemu
https://wiki.ffrtt.ru/index.php?title=FF9/Sound/AKAO_sequence&diff=5762
FF9/Sound/AKAO sequence
2020-07-11T07:15:08Z
<p>Loveemu: </p>
<hr />
<div>== Introduction ==<br />
AKAO sequence is similar to MIDI sequence - it's custom tracker format for playing sequence sound, well tuned specially for PSX.<br />
<br />
<br />
== File Structure ==<br />
=== Header (size: 64 bytes) ===<br />
<br />
struct AkaoSeqHeader<br />
{<br />
static const uint8_t magic[4]; // "AKAO" C-string<br />
uint16_t id; // song ID, used for playing sequence<br />
uint16_t length; // data length (including this header)<br />
uint16_t reverb_type; // reverb type (range from 0 to 9)<br />
uint8_t field_0A[6];<br />
uint32_t field_10;<br />
uint16_t sample_set_id; // associated sample set ID<br />
uint16_t field_12;<br />
uint32_t field_14;<br />
uint32_t field_18;<br />
uint32_t field_1C;<br />
uint32_t mask; // represents bitmask of used channels in this song<br />
uint32_t field_24;<br />
uint32_t field_28;<br />
uint32_t field_2C;<br />
uint32_t instrument_map_offset; // relative offset to custom instrument map (0 if unused)<br />
uint32_t drum_map_offset; // relative offset to custom drum map (0 if unused)<br />
uint32_t field_38;<br />
uint32_t field_3C;<br />
};<br />
<br />
=== Channel Offsets (size: 2 bytes * <channels count>) ===<br />
struct AkaoChannelInfo<br />
{<br />
uint32_t start_offsets[num_channels]; // offsets to channel opcode data<br />
};<br />
<br />
AkaoSeqHeader *header;<br />
int num_channels = 0;<br />
while (int bit = 0; header->mask & (1 << bit)) != 0; bit++)<br />
num_channels++;<br />
<br />
There is <channels count> offsets to channel opcode data counting from current offset. Each offsets is a relative offset based on the address the offset itself.<br />
<br />
<br />
=== Channel Commands [AKAO Opcodes] ===<br />
For every channels in an AKAO sequence, there is a set of commands to perform. This is similar to Field opcodes. Here I will call this sound commands "opcodes". Every opcode has its own number of arguments.<br />
<br />
=== Drum Instrument Map Table ===<br />
<br />
When a song uses a drum kit with [[FF9/Sound/Opcodes/0xfe04|opcode 0xFE 0x04]], a drum instrument map table will be placed at the end of the sequence. The table determines the instrument, channel volume and pan for each keys.<br />
<br />
The table consists of a repetition of 8-byte items.<br />
<br />
struct AkaoDrumKeyAttr<br />
{<br />
uint8_t instrument; // corresponding to opcode 0xA1<br />
uint8_t key; // note number when playing the drum note<br />
uint8_t ar; // ADSR: attack rate (0-127)<br />
uint8_t sr; // ADSR: sustain rate (0-127)<br />
uint8_t s_mode; // ADSR: sustain mode (1: linear increase, 3: linear decrease, 5: exponential increase, 7: exponential decrease)<br />
uint8_t rr; // ADSR: release rate (0-127)<br />
uint8_t volume; // adjust the percussion volume to n/128 of the original volume (0 will keep the original volume)<br />
uint8_t pan : 7; // corresponding to opcode 0xAA<br />
uint8_t reverb : 1; // reverb on/off (0: off, 1: on)<br />
}<br />
<br />
<br />
== Sound Opcode List ==<br />
<br />
{| class="wikitable"<br />
! Opcode<br />
! Summary<br />
! Length<br />
! Operands<br />
! Note<br />
|-<br />
|[[FF9/Sound/Opcodes/0x0099|0x00-0x99]]<br />
|Note, Tie, Rest<br />
|1<br />
|<br />
|The opcode indicates the note key and length. The note will be keyed off 2 ticks before the next note.<br />
|-<br />
|0x9A-0x9F<br />
|Unimplemented<br />
|1<br />
|<br />
|Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xA0]]<br />
|Finish Channel<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa1|0xA1]]<br />
|Load Instrument<br />
|2<br />
|instrument: byte (0-127)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0x0099|0xA2]]<br />
|Overwrite Next Note Length<br />
|2<br />
|length: byte<br />
|Ignores the regular length (delta-time) of the next note and overwrites it with the specified length.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa8aa|0xA3]]<br />
|Channel Master Volume<br />
|2<br />
|volume: byte (0-127)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa4|0xA4]]<br />
|Pitch Bend Slide<br />
|3<br />
|length: byte, semitones: signed byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa5|0xA5]]<br />
|Set Octave<br />
|2<br />
|octave: byte (0-15)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa5|0xA6]]<br />
|Increase Octave<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa5|0xA7]]<br />
|Decrease Octave<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa8aa|0xA8]]<br />
|Channel Volume<br />
|2<br />
|volume: byte (0-127)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa9|0xA9]]<br />
|Channel Volume Slide<br />
|3<br />
|length: byte, volume: byte (0-127)<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa8aa|0xAA]]<br />
|Channel Pan<br />
|2<br />
|pan: byte (0-127)<br />
|64 is the center.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xab|0xAB]]<br />
|Channel Pan Slide<br />
|3<br />
|length: byte, pan: byte (0-127)<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xac|0xAC]]<br />
|Noise Clock Frequency<br />
|2<br />
|clock: byte (0x00-0x3f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xAD]]<br />
|ADSR: Attack Rate<br />
|2<br />
|attack_rate: byte (0x00-0x7f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xAE]]<br />
|ADSR: Decay Rate<br />
|2<br />
|decay_rate: byte (0x00-0x0f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xAF]]<br />
|ADSR: Sustain Level<br />
|2<br />
|sustain_level: byte (0x00-0x0f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xB0]]<br />
|ADSR: Decay Rate & Sustain Level<br />
|3<br />
|decay_rate: byte (0x00-0x0f), sustain_level: byte (0x00-0x0f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xB1]]<br />
|ADSR: Sustain Rate<br />
|2<br />
|sustain_rate: byte (0x00-0x7f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xB2]]<br />
|ADSR: Release Rate<br />
|2<br />
|release_rate: byte (0x00-0x1f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xB3]]<br />
|ADSR: Reset ADSR<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb4b5|0xB4]]<br />
|Channel Pitch LFO (Vibrato)<br />
|4<br />
|delay: byte, rate: byte, type: byte (0-15)<br />
|When <code>rate</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb4b5|0xB5]]<br />
|Channel Pitch LFO Depth<br />
|2<br />
|depth: byte<br />
|The most significant bit of the <code>depth</code> determines the amplitude range.<br />
<br />
When it is 0, the range is up to about ± 50 cents (amplitude is 15/256 compared with range type 1).<br />
<br />
When it is 1, the range is up to about ± 700 cents.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb4b5|0xB6]]<br />
|Turn Off Channel Pitch LFO<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xB7]]<br />
|ADSR: Attack Mode<br />
|2<br />
|attack_mode: byte (1 or 5)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb8b9|0xB8]]<br />
|Channel Volume LFO (Tremolo)<br />
|4<br />
|delay: byte, rate: byte, type: byte (0-15)<br />
|When <code>rate</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb8b9|0xB9]]<br />
|Channel Volume LFO Depth<br />
|2<br />
|depth: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb8b9|0xBA]]<br />
|Turn Off Channel Volume LFO<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xBB]]<br />
|ADSR: Sustain Mode<br />
|2<br />
|sustain_mode: byte (1, 3, 5 or 7)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xbcbd|0xBC]]<br />
|Channel Pan LFO<br />
|3<br />
|rate: byte, type: byte (0-15)<br />
|When <code>rate</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xbcbd|0xBD]]<br />
|Channel Pan LFO Depth<br />
|2<br />
|depth: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xbcbd|0xBE]]<br />
|Turn Off Channel Pan LFO<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xbf|0xBF]]<br />
|ADSR: Release Mode<br />
|2<br />
|release_mode: byte (3 or 7)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc0c1|0xC0]]<br />
|Channel Transpose (Absolute)<br />
|2<br />
|semitones: signed byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc0c1|0xC1]]<br />
|Channel Transpose (Relative)<br />
|2<br />
|semitones: signed byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc2c3|0xC2]]<br />
|Turn On Reverb<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc2c3|0xC3]]<br />
|Turn Off Reverb<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc4c5|0xC4]]<br />
|Turn On Noise<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc4c5|0xC5]]<br />
|Turn Off Noise<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc6c7|0xC6]]<br />
|Turn On Frequency Modulation<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc6c7|0xC7]]<br />
|Turn Off Frequency Modulation<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc8c9|0xC8]]<br />
|Loop Point<br />
|1<br />
|<br />
|Remember the current offset as a loop point and increase the nesting level of the loop.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc8c9|0xC9]]<br />
|Return to Loop Point Up to N Times<br />
|2<br />
|times: byte<br />
|On the Nth repeat, this instruction will end the current loop by decrementing the nesting level of the loop. Otherwise, it will increment the loop counter and return to the loop point.<br />
When <code>times</code> is 0, it will be translated to 256 times.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc8c9|0xCA]]<br />
|Return to Loop Point<br />
|1<br />
|<br />
|This instruction will increment the loop counter.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xcb|0xCB]]<br />
|Reset Sound Effects<br />
|1<br />
|<br />
|Reset sound effects such as noise, frequency modulation, reverb, overlay voice and alternate voice.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xcccd|0xCC]]<br />
|Turn On Legato<br />
|1<br />
|<br />
|This instruction will stop the regular key on and key off performance of the subsequent notes and update the pitch only.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xcccd|0xCD]]<br />
|Turn Off Legato<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xcecf|0xCE]]<br />
|Turn On Noise and Toggle Noise On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xcecf|0xCF]]<br />
|Toggle Noise On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd0d1|0xD0]]<br />
|Turn On Full-Length Note Mode<br />
|1<br />
|<br />
|This instruction will stop the regular key off performance of the subsequent notes.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd0d1|0xD1]]<br />
|Turn Off Full-Length Note Mode<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd2d3|0xD2]]<br />
|Turn On Frequency Modulation and Toggle Frequency Modulation On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd2d3|0xD3]]<br />
|Toggle Frequency Modulation On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd4d5|0xD4]]<br />
|Turn On Playback Rate Side Chain<br />
|1<br />
|<br />
|Duplicate and use the playback frequency of the previous voice channel.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd4d5|0xD5]]<br />
|Turn Off Playback Rate Side Chain<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd6d7|0xD6]]<br />
|Turn On Pitch-Volume Side Chain<br />
|1<br />
|<br />
|Multiply the playback frequency of the previous voice channel to the output volume. Lower pitch will make the volume smaller.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd6d7|0xD7]]<br />
|Turn Off Pitch-Volume Side Chain<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd8d9|0xD8]]<br />
|Channel Fine Tuning (Absolute)<br />
|2<br />
|amount: signed byte<br />
|The pitch can be changed in the range of one octave above and below.<br />
The <code>amount</code> is the multiplicand for the playback frequency, not a log-based parameter like cents. For example, when the <code>amount</code> is 127, the pitch will be multiplied by 127/128 (about +1 octave). Negative value will lower the pitch.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd8d9|0xD9]]<br />
|Channel Fine Tuning (Relative)<br />
|2<br />
|amount: signed byte<br />
|The <code>amount</code> will be added to the current tuning amount.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xdadb|0xDA]]<br />
|Turn On Portamento<br />
|2<br />
|speed: byte<br />
|When <code>speed</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xdadb|0xDB]]<br />
|Turn Off Portamento<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0x0099|0xDC]]<br />
|Fix Note Length<br />
|2<br />
|length_to_add: signed byte<br />
|Ignore the regular length (delta-time) of subsequent notes and set to the fixed length. The <code>length_to_add</code> parameter will be added to the current length value. (the initial value is 0)<br />
|-<br />
|[[FF9/Sound/Opcodes/0xdd|0xDD]]<br />
|Channel Pitch LFO Depth Slide<br />
|3<br />
|length: byte, depth: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xde|0xDE]]<br />
|Channel Volume LFO Depth Slide<br />
|3<br />
|length: byte, depth: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xdf|0xDF]]<br />
|Channel Pan LFO Depth Slide<br />
|3<br />
|length: byte, depth: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe0|0xE0]]<br />
|Unknown<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe1|0xE1]]<br />
|Unknown<br />
|2<br />
|value: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe2|0xE2]]<br />
|Unknown<br />
|1<br />
|<br />
|Clears the effect of opcode 0xE1<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe3|0xE3]]<br />
|Unimplemented<br />
|1<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe4|0xE4]]<br />
|Channel Pitch LFO Rate Slide<br />
|3<br />
|length: byte, rate: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe5|0xE5]]<br />
|Channel Volume LFO Rate Slide<br />
|3<br />
|length: byte, rate: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe6|0xE6]]<br />
|Channel Pan LFO Rate Slide<br />
|3<br />
|length: byte, rate: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xE7-0xEF]]<br />
|Unimplemented<br />
|1<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xf0fd|0xF0-0xFD]]<br />
|Note, Tie, Rest with Length<br />
|2<br />
|length: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe00|0xFE 0x00]]<br />
|Tempo<br />
|4<br />
|tempo: uint16<br />
|bpm = tempo / 218.453333 (approximate)<br />
More strictly, <code>bpm = 60.0 / (48 * (65536.0 / tempo) * (0x43D1 / (33868800.0 / 8)))</code><br />
<br />
Note that this coefficient is different from other games with PlayStation AKAO.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe00|0xFE 0x01]]<br />
|Tempo Slide<br />
|5<br />
|length: byte, tempo: uint16<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe02|0xFE 0x02]]<br />
|Reverb Depth<br />
|4<br />
|depth: uint16<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe02|0xFE 0x03]]<br />
|Reverb Depth Slide<br />
|5<br />
|length: byte, depth: uint16<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe04|0xFE 0x04]]<br />
|Turn On Drum Mode<br />
|2<br />
|<br />
|The drum map offset is recorded in the file header.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe04|0xFE 0x05]]<br />
|Turn Off Drum Mode<br />
|2<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe06|0xFE 0x06]]<br />
|Unconditional Jump<br />
|4<br />
|destination_offset: signed int16<br />
|This instruction can be used to make an infinite loop.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe07|0xFE 0x07]]<br />
|CPU-Conditional Jump<br />
|5<br />
|condition: byte, destination_offset: signed int16<br />
|Jump if the condition variable matches <code>condition</code>. The value of the condition variable can be set from the game program.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe08|0xFE 0x08]]<br />
|Jump on the Nth Repeat<br />
|5<br />
|times: byte, destination_offset: signed int16<br />
|When <code>times</code> is 0, it will be translated to 256 times.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe08|0xFE 0x09]]<br />
|Break the Loop on the Nth Repeat<br />
|5<br />
|times: byte, destination_offset: signed int16<br />
|Unlike 0xF0, this instruction will end the current loop by decrementing the nesting level of the loop.<br />
When <code>times</code> is 0, it will be translated to 256 times.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa1|0xFE 0x0A]]<br />
|Load Instrument (With Some Unknown Effect)<br />
|3<br />
|instrument: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe0b|0xFE 0x0B]]<br />
|Unknown<br />
|6<br />
|offset: signed int16, offset2: signed int16<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xFE 0x0C-0x0D]]<br />
|Unimplemented<br />
|2<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe0e|0xFE 0x0E]]<br />
|Subroutine Jump<br />
|4<br />
|destination_offset: signed int16<br />
|The subroutine jump cannot be nested. It will overwrite the return address.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe0f|0xFE 0x0F]]<br />
|Return from Subroutine<br />
|2<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe10|0xFE 0x10]]<br />
|Unknown<br />
|3<br />
|value: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe10|0xFE 0x11]]<br />
|Unknown<br />
|2<br />
|<br />
|Clears the effect of opcode 0xFE 0x10<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa3|0xFE 0x12]]<br />
|Channel Master Volume Slide<br />
|3<br />
|length: byte, volume: byte (0-127)<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xFE 0x13]]<br />
|Unimplemented<br />
|2<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe14|0xFE 0x14]]<br />
|Load Custom Instrument (Key-Split Instrument)<br />
|3<br />
|instrument: byte<br />
|The custom instrument number corresponds to the custom instrument map pointed from the file header. Note that the number is different from the regular sample number used in opcode 0xA1.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe15|0xFE 0x15]]<br />
|Time Signature<br />
|4<br />
|ticks_per_beat: byte, beats_per_measure: byte<br />
|Note that two parameters can be 0. This pattern is used for initialization.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe16|0xFE 0x16]]<br />
|Measure Number<br />
|3<br />
|measure: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xFE 0x17-0x18]]<br />
|Unimplemented<br />
|2<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe19|0xFE 0x19]]<br />
|Unknown<br />
|?<br />
|?<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe1a|0xFE 0x1A]]<br />
|Unknown<br />
|?<br />
|?<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe1b|0xFE 0x1B]]<br />
|Unknown<br />
|?<br />
|?<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe1c|0xFE 0x1C]]<br />
|Unknown<br />
|?<br />
|?<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe1d|0xFE 0x1D]]<br />
|Unknown<br />
|?<br />
|?<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe1e|0xFE 0x1E]]<br />
|Unknown<br />
|?<br />
|?<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xFE 0x1F]]<br />
|Unimplemented<br />
|2<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|0xFE 0x20-0xFF<br />
|Unimplemented (Out of Range)<br />
|n/a<br />
|<br />
|Do not use.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xFF]]<br />
|Unimplemented<br />
|1<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|}</div>
Loveemu
https://wiki.ffrtt.ru/index.php?title=FF9/Sound/AKAO_sequence&diff=5761
FF9/Sound/AKAO sequence
2020-07-11T04:03:31Z
<p>Loveemu: Created page with "== Introduction == AKAO sequence is similar to MIDI sequence - it's custom tracker format for playing sequence sound, well tuned specially for PSX. == File Structure == ===..."</p>
<hr />
<div>== Introduction ==<br />
AKAO sequence is similar to MIDI sequence - it's custom tracker format for playing sequence sound, well tuned specially for PSX.<br />
<br />
<br />
== File Structure ==<br />
=== Header (size: 64 bytes) ===<br />
<br />
struct AkaoSeqHeader<br />
{<br />
static const uint8_t magic[4]; // "AKAO" C-string<br />
uint16_t id; // song ID, used for playing sequence<br />
uint16_t length; // data length (including this header)<br />
uint16_t reverb_type; // reverb type (range from 0 to 9)<br />
uint8_t field_0A[6];<br />
uint32_t field_10;<br />
uint16_t sample_set_id; // associated sample set ID<br />
uint16_t field_12;<br />
uint32_t field_14;<br />
uint32_t field_18;<br />
uint32_t field_1C;<br />
uint32_t mask; // represents bitmask of used channels in this song<br />
uint32_t field_24;<br />
uint32_t field_28;<br />
uint32_t field_2C;<br />
uint32_t instrument_map_offset; // relative offset to custom instrument map (0 if unused)<br />
uint32_t drum_map_offset; // relative offset to custom drum map (0 if unused)<br />
uint32_t field_38;<br />
uint32_t field_3C;<br />
};<br />
<br />
=== Channel Offsets (size: 2 bytes * <channels count>) ===<br />
struct AkaoChannelInfo<br />
{<br />
uint32_t start_offsets[num_channels]; // offsets to channel opcode data<br />
};<br />
<br />
AkaoSeqHeader *header;<br />
int num_channels = 0;<br />
while (int bit = 0; header->mask & (1 << bit)) != 0; bit++)<br />
num_channels++;<br />
<br />
There is <channels count> offsets to channel opcode data counting from current offset. Each offsets is a relative offset based on the address the offset itself.<br />
<br />
<br />
=== Channel Commands [AKAO Opcodes] ===<br />
For every channels in an AKAO sequence, there is a set of commands to perform. This is similar to Field opcodes. Here I will call this sound commands "opcodes". Every opcode has its own number of arguments (from no-arguments, to 3 arguments).<br />
<br />
=== Drum Instrument Map Table ===<br />
<br />
When a song uses a drum kit with [[FF9/Sound/Opcodes/0xfe04|opcode 0xFE 0x04]], a drum instrument map table will be placed at the end of the sequence. The table determines the instrument, channel volume and pan for each keys.<br />
<br />
The table consists of a repetition of 8-byte items.<br />
<br />
struct AkaoDrumKeyAttr<br />
{<br />
uint8_t instrument; // corresponding to opcode 0xA1<br />
uint8_t key; // note number when playing the drum note<br />
uint8_t ar; // ADSR: attack rate (0-127)<br />
uint8_t sr; // ADSR: sustain rate (0-127)<br />
uint8_t s_mode; // ADSR: sustain mode (1: linear increase, 3: linear decrease, 5: exponential increase, 7: exponential decrease)<br />
uint8_t rr; // ADSR: release rate (0-127)<br />
uint8_t volume; // adjust the percussion volume to n/128 of the original volume (0 will keep the original volume)<br />
uint8_t pan : 7; // corresponding to opcode 0xAA<br />
uint8_t reverb : 1; // reverb on/off (0: off, 1: on)<br />
}<br />
<br />
<br />
== Sound Opcode List ==<br />
<br />
{| class="wikitable"<br />
! Opcode<br />
! Summary<br />
! Length<br />
! Operands<br />
! Note<br />
|-<br />
|[[FF9/Sound/Opcodes/0x0099|0x00-0x99]]<br />
|Note, Tie, Rest<br />
|1<br />
|<br />
|The opcode indicates the note key and length. The note will be keyed off 2 ticks before the next note.<br />
|-<br />
|0x9A-0x9F<br />
|Unimplemented<br />
|1<br />
|<br />
|Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xA0]]<br />
|Finish Channel<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa1|0xA1]]<br />
|Load Instrument<br />
|2<br />
|instrument: byte (0-127)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0x0099|0xA2]]<br />
|Overwrite Next Note Length<br />
|2<br />
|length: byte<br />
|Ignores the regular length (delta-time) of the next note and overwrites it with the specified length.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa8aa|0xA3]]<br />
|Channel Master Volume<br />
|2<br />
|volume: byte (0-127)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa4|0xA4]]<br />
|Pitch Bend Slide<br />
|3<br />
|length: byte, semitones: signed byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa5|0xA5]]<br />
|Set Octave<br />
|2<br />
|octave: byte (0-15)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa5|0xA6]]<br />
|Increase Octave<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa5|0xA7]]<br />
|Decrease Octave<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa8aa|0xA8]]<br />
|Channel Volume<br />
|2<br />
|volume: byte (0-127)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa9|0xA9]]<br />
|Channel Volume Slide<br />
|3<br />
|length: byte, volume: byte (0-127)<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa8aa|0xAA]]<br />
|Channel Pan<br />
|2<br />
|pan: byte (0-127)<br />
|64 is the center.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xab|0xAB]]<br />
|Channel Pan Slide<br />
|3<br />
|length: byte, pan: byte (0-127)<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xac|0xAC]]<br />
|Noise Clock Frequency<br />
|2<br />
|clock: byte (0x00-0x3f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xAD]]<br />
|ADSR: Attack Rate<br />
|2<br />
|attack_rate: byte (0x00-0x7f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xAE]]<br />
|ADSR: Decay Rate<br />
|2<br />
|decay_rate: byte (0x00-0x0f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xAF]]<br />
|ADSR: Sustain Level<br />
|2<br />
|sustain_level: byte (0x00-0x0f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xB0]]<br />
|ADSR: Decay Rate & Sustain Level<br />
|3<br />
|decay_rate: byte (0x00-0x0f), sustain_level: byte (0x00-0x0f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xB1]]<br />
|ADSR: Sustain Rate<br />
|2<br />
|sustain_rate: byte (0x00-0x7f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xB2]]<br />
|ADSR: Release Rate<br />
|2<br />
|release_rate: byte (0x00-0x1f)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xB3]]<br />
|ADSR: Reset ADSR<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb4b5|0xB4]]<br />
|Channel Pitch LFO (Vibrato)<br />
|4<br />
|delay: byte, rate: byte, type: byte (0-15)<br />
|When <code>rate</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb4b5|0xB5]]<br />
|Channel Pitch LFO Depth<br />
|2<br />
|depth: byte<br />
|The most significant bit of the <code>depth</code> determines the amplitude range.<br />
<br />
When it is 0, the range is up to about ± 50 cents (amplitude is 15/256 compared with range type 1).<br />
<br />
When it is 1, the range is up to about ± 700 cents.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb4b5|0xB6]]<br />
|Turn Off Channel Pitch LFO<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xB7]]<br />
|ADSR: Attack Mode<br />
|2<br />
|attack_mode: byte (1 or 5)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb8b9|0xB8]]<br />
|Channel Volume LFO (Tremolo)<br />
|4<br />
|delay: byte, rate: byte, type: byte (0-15)<br />
|When <code>rate</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb8b9|0xB9]]<br />
|Channel Volume LFO Depth<br />
|2<br />
|depth: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xb8b9|0xBA]]<br />
|Turn Off Channel Volume LFO<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/ADSR|0xBB]]<br />
|ADSR: Sustain Mode<br />
|2<br />
|sustain_mode: byte (1, 3, 5 or 7)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xbcbd|0xBC]]<br />
|Channel Pan LFO<br />
|3<br />
|rate: byte, type: byte (0-15)<br />
|When <code>rate</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xbcbd|0xBD]]<br />
|Channel Pan LFO Depth<br />
|2<br />
|depth: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xbcbd|0xBE]]<br />
|Turn Off Channel Pan LFO<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xbf|0xBF]]<br />
|ADSR: Release Mode<br />
|2<br />
|release_mode: byte (3 or 7)<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc0c1|0xC0]]<br />
|Channel Transpose (Absolute)<br />
|2<br />
|semitones: signed byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc0c1|0xC1]]<br />
|Channel Transpose (Relative)<br />
|2<br />
|semitones: signed byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc2c3|0xC2]]<br />
|Turn On Reverb<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc2c3|0xC3]]<br />
|Turn Off Reverb<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc4c5|0xC4]]<br />
|Turn On Noise<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc4c5|0xC5]]<br />
|Turn Off Noise<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc6c7|0xC6]]<br />
|Turn On Frequency Modulation<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc6c7|0xC7]]<br />
|Turn Off Frequency Modulation<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc8c9|0xC8]]<br />
|Loop Point<br />
|1<br />
|<br />
|Remember the current offset as a loop point and increase the nesting level of the loop.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc8c9|0xC9]]<br />
|Return to Loop Point Up to N Times<br />
|2<br />
|times: byte<br />
|On the Nth repeat, this instruction will end the current loop by decrementing the nesting level of the loop. Otherwise, it will increment the loop counter and return to the loop point.<br />
When <code>times</code> is 0, it will be translated to 256 times.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xc8c9|0xCA]]<br />
|Return to Loop Point<br />
|1<br />
|<br />
|This instruction will increment the loop counter.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xcb|0xCB]]<br />
|Reset Sound Effects<br />
|1<br />
|<br />
|Reset sound effects such as noise, frequency modulation, reverb, overlay voice and alternate voice.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xcccd|0xCC]]<br />
|Turn On Legato<br />
|1<br />
|<br />
|This instruction will stop the regular key on and key off performance of the subsequent notes and update the pitch only.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xcccd|0xCD]]<br />
|Turn Off Legato<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xcecf|0xCE]]<br />
|Turn On Noise and Toggle Noise On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xcecf|0xCF]]<br />
|Toggle Noise On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd0d1|0xD0]]<br />
|Turn On Full-Length Note Mode<br />
|1<br />
|<br />
|This instruction will stop the regular key off performance of the subsequent notes.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd0d1|0xD1]]<br />
|Turn Off Full-Length Note Mode<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd2d3|0xD2]]<br />
|Turn On Frequency Modulation and Toggle Frequency Modulation On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd2d3|0xD3]]<br />
|Toggle Frequency Modulation On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd4d5|0xD4]]<br />
|Turn On Playback Rate Side Chain<br />
|1<br />
|<br />
|Duplicate and use the playback frequency of the previous voice channel.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd4d5|0xD5]]<br />
|Turn Off Playback Rate Side Chain<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd6d7|0xD6]]<br />
|Turn On Pitch-Volume Side Chain<br />
|1<br />
|<br />
|Multiply the playback frequency of the previous voice channel to the output volume. Lower pitch will make the volume smaller.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd6d7|0xD7]]<br />
|Turn Off Pitch-Volume Side Chain<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd8d9|0xD8]]<br />
|Channel Fine Tuning (Absolute)<br />
|2<br />
|amount: signed byte<br />
|The pitch can be changed in the range of one octave above and below.<br />
The <code>amount</code> is the multiplicand for the playback frequency, not a log-based parameter like cents. For example, when the <code>amount</code> is 127, the pitch will be multiplied by 127/128 (about +1 octave). Negative value will lower the pitch.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xd8d9|0xD9]]<br />
|Channel Fine Tuning (Relative)<br />
|2<br />
|amount: signed byte<br />
|The <code>amount</code> will be added to the current tuning amount.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xdadb|0xDA]]<br />
|Turn On Portamento<br />
|2<br />
|speed: byte<br />
|When <code>speed</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xdadb|0xDB]]<br />
|Turn Off Portamento<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0x0099|0xDC]]<br />
|Fix Note Length<br />
|2<br />
|length_to_add: signed byte<br />
|Ignore the regular length (delta-time) of subsequent notes and set to the fixed length. The <code>length_to_add</code> parameter will be added to the current length value. (the initial value is 0)<br />
|-<br />
|[[FF9/Sound/Opcodes/0xdd|0xDD]]<br />
|Channel Pitch LFO Depth Slide<br />
|3<br />
|length: byte, depth: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xde|0xDE]]<br />
|Channel Volume LFO Depth Slide<br />
|3<br />
|length: byte, depth: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xdf|0xDF]]<br />
|Channel Pan LFO Depth Slide<br />
|3<br />
|length: byte, depth: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe0|0xE0]]<br />
|Unknown<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe1|0xE1]]<br />
|Unknown<br />
|2<br />
|value: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe2|0xE2]]<br />
|Unknown<br />
|1<br />
|<br />
|Clears the effect of opcode 0xE1<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe3|0xE3]]<br />
|Unimplemented<br />
|1<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe4|0xE4]]<br />
|Channel Pitch LFO Rate Slide<br />
|3<br />
|length: byte, rate: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe5|0xE5]]<br />
|Channel Volume LFO Rate Slide<br />
|3<br />
|length: byte, rate: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xe6|0xE6]]<br />
|Channel Pan LFO Rate Slide<br />
|3<br />
|length: byte, rate: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xE7-0xEF]]<br />
|Unimplemented<br />
|1<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xf0fd|0xF0-0xFD]]<br />
|Note, Tie, Rest with Length<br />
|2<br />
|length: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe00|0xFE 0x00]]<br />
|Tempo<br />
|4<br />
|tempo: uint16<br />
|bpm = tempo / 218.453333 (approximate)<br />
More strictly, <code>bpm = 60.0 / (48 * (65536.0 / tempo) * (0x43D1 / (33868800.0 / 8)))</code><br />
<br />
Note that this coefficient is different from other games with PlayStation AKAO.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe00|0xFE 0x01]]<br />
|Tempo Slide<br />
|5<br />
|length: byte, tempo: uint16<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe02|0xFE 0x02]]<br />
|Reverb Depth<br />
|4<br />
|depth: uint16<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe02|0xFE 0x03]]<br />
|Reverb Depth Slide<br />
|5<br />
|length: byte, depth: uint16<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe04|0xFE 0x04]]<br />
|Turn On Drum Mode<br />
|2<br />
|<br />
|The drum map offset is recorded in the file header.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe04|0xFE 0x05]]<br />
|Turn Off Drum Mode<br />
|2<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe06|0xFE 0x06]]<br />
|Unconditional Jump<br />
|4<br />
|destination_offset: signed int16<br />
|This instruction can be used to make an infinite loop.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe07|0xFE 0x07]]<br />
|CPU-Conditional Jump<br />
|5<br />
|condition: byte, destination_offset: signed int16<br />
|Jump if the condition variable matches <code>condition</code>. The value of the condition variable can be set from the game program.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe08|0xFE 0x08]]<br />
|Jump on the Nth Repeat<br />
|5<br />
|times: byte, destination_offset: signed int16<br />
|When <code>times</code> is 0, it will be translated to 256 times.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe08|0xFE 0x09]]<br />
|Break the Loop on the Nth Repeat<br />
|5<br />
|times: byte, destination_offset: signed int16<br />
|Unlike 0xF0, this instruction will end the current loop by decrementing the nesting level of the loop.<br />
When <code>times</code> is 0, it will be translated to 256 times.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa1|0xFE 0x0A]]<br />
|Load Instrument (With Some Unknown Effect)<br />
|3<br />
|instrument: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe0b|0xFE 0x0B]]<br />
|Unknown<br />
|6<br />
|offset: signed int16, offset2: signed int16<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xFE 0x0C-0x0D]]<br />
|Unimplemented<br />
|2<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe0e|0xFE 0x0E]]<br />
|Subroutine Jump<br />
|4<br />
|destination_offset: signed int16<br />
|The subroutine jump cannot be nested. It will overwrite the return address.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe0f|0xFE 0x0F]]<br />
|Return from Subroutine<br />
|2<br />
|<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe10|0xFE 0x10]]<br />
|Unknown<br />
|3<br />
|value: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe10|0xFE 0x11]]<br />
|Unknown<br />
|2<br />
|<br />
|Clears the effect of opcode 0xFE 0x10<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa3|0xFE 0x12]]<br />
|Channel Master Volume Slide<br />
|3<br />
|length: byte, volume: byte (0-127)<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xFE 0x13]]<br />
|Unimplemented<br />
|2<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe14|0xFE 0x14]]<br />
|Load Custom Instrument (Key-Split Instrument)<br />
|3<br />
|instrument: byte<br />
|The custom instrument number corresponds to the custom instrument map pointed from the file header. Note that the number is different from the regular sample number used in opcode 0xA1.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe15|0xFE 0x15]]<br />
|Time Signature<br />
|4<br />
|ticks_per_beat: byte, beats_per_measure: byte<br />
|Note that two parameters can be 0. This pattern is used for initialization.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe16|0xFE 0x16]]<br />
|Measure Number<br />
|3<br />
|measure: byte<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xFE 0x17-0x18]]<br />
|Unimplemented<br />
|2<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe19|0xFE 0x19]]<br />
|Unknown<br />
|?<br />
|?<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe1a|0xFE 0x1A]]<br />
|Unknown<br />
|?<br />
|?<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe1b|0xFE 0x1B]]<br />
|Unknown<br />
|?<br />
|?<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe1c|0xFE 0x1C]]<br />
|Unknown<br />
|?<br />
|?<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe1d|0xFE 0x1D]]<br />
|Unknown<br />
|?<br />
|?<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xfe1e|0xFE 0x1E]]<br />
|Unknown<br />
|?<br />
|?<br />
|<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xFE 0x1F]]<br />
|Unimplemented<br />
|2<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|0xFE 0x20-0xFF<br />
|Unimplemented (Out of Range)<br />
|n/a<br />
|<br />
|Do not use.<br />
|-<br />
|[[FF9/Sound/Opcodes/0xa0|0xFF]]<br />
|Unimplemented<br />
|1<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|}</div>
Loveemu
https://wiki.ffrtt.ru/index.php?title=FF9/Sound&diff=5760
FF9/Sound
2020-07-11T02:11:56Z
<p>Loveemu: Add subpage links as like as FF7</p>
<hr />
<div>* [[FF9/Sound/Overview|Overview]]<br />
* [[FF9/Sound/AKAO sequence|AKAO sequence]]<br />
* [[FF9/Sound/AKAO instruments|AKAO instruments]]<br />
* [[FF9/Sound/Code Map|Code Map]]</div>
Loveemu
https://wiki.ffrtt.ru/index.php?title=FF9&diff=5759
FF9
2020-07-11T02:08:11Z
<p>Loveemu: Add a link to sound page</p>
<hr />
<div>=Final Fantasy 9 Information=<br />
Since there isn't a PC version of this game all information relates to the PS1.<br />
<br />
=Disk IMG Format=<br />
The game information is contained in a single file on the CD-ROM named FF9.IMG with each disk containing a file named this.<br />
FMV movies are stored in sub directories on the disk.<br />
<br />
==[[FF9/IMGRootDir|Image Root Directory]]==<br />
The IMG file begins with a '''root directory''' that has a list of file counts and sectors.<br />
<br />
==[[FF9/IMGSubDir|Image Sub Directory]]==<br />
Some directory entries contain '''subdirectories'''.<br />
<br />
==[[FF9/Dirs|Directories and data]]==<br />
What contains directories and for what contain files<br />
<br />
===[[FF9/Dirs/00|Directory '0']]===<br />
<br />
===[[FF9/Dirs/01|Directory '1']]===<br />
<br />
==[[FF9/File/Data|File Cluster Information]]==<br />
Some of the files are actually '''data clusters''' that contain multiple information these files begin with the hexadecimal number 0xDB.<br />
<br />
===[[FF9/File/0x02|Chunk 0x02: 3D Model data]]===<br />
This chunk contains 3D model information: vertices, quads, triangles, texture mapping coordinates...<br />
<br />
===[[FF9/File/0x03|Chunk 0x03: 3D Animation]]===<br />
This chunk contains animation sequences for 3d models...<br />
<br />
===[[FF9/File/0x04|Chunk 0x04: Image data(TIM`s)]]===<br />
This chunk contains tim-images...<br />
<br />
===[[FF9/File/0x05|Chunk 0x05: Scripts]]===<br />
This chunk contains scripts files...<br />
<br />
===[[FF9/File/0x0A|Chunk 0x0A: Field tiles]]===<br />
This chunk contains information about field tiles and field camera parameters...<br />
<br />
===[[FF9/File/0x0B|Chunk 0x0B: Field walkmesh]]===<br />
This chunk contain field walkmesh data...<br />
<br />
===[[FF9/File/0x0C|Chunk 0x0C: Battle scenes]]===<br />
This chunk contain battle scenes geometry...<br />
<br />
===[[FF9/File/0x12|Chunk 0x12: Contain CLUT and TPage for models]]===<br />
This chunk contains CLUT and TPage info for models.<br />
<br />
===[[FF9/File/0x1B|Chunk 0x1B: Pointers to other 'DB']]===<br />
This chunk contains pointers to other DB structures.<br />
<br />
=[[FF9/WorldMap|WorldMap]]=<br />
<br />
=[[FF9/CharTables|Character Tables]]=<br />
==[[FF9/CharTables#Character_Table_for_EU_.26_US_version|European & US Tables]]==<br />
==[[FF9/CharTables#Character_Table_for_JP_version|Japanese Table]]==<br />
==[[FF9/CharTables#Kanji_Table_A|Kanji Table A]]==<br />
==[[FF9/CharTables#Kanji_Table_B|Kanji Table B]]==<br />
<br />
=Sound=<br />
* [[FF9/Sound|Sound]]<br />
<br />
=Tools and Patches=<br />
* [[FF9/Tools|Tools and Patches]]</div>
Loveemu
https://wiki.ffrtt.ru/index.php?title=FF9&diff=5758
FF9
2020-07-11T01:58:43Z
<p>Loveemu: Fix heading levels?</p>
<hr />
<div>=Final Fantasy 9 Information=<br />
Since there isn't a PC version of this game all information relates to the PS1.<br />
<br />
=Disk IMG Format=<br />
The game information is contained in a single file on the CD-ROM named FF9.IMG with each disk containing a file named this.<br />
FMV movies are stored in sub directories on the disk.<br />
<br />
==[[FF9/IMGRootDir|Image Root Directory]]==<br />
The IMG file begins with a '''root directory''' that has a list of file counts and sectors.<br />
<br />
==[[FF9/IMGSubDir|Image Sub Directory]]==<br />
Some directory entries contain '''subdirectories'''.<br />
<br />
==[[FF9/Dirs|Directories and data]]==<br />
What contains directories and for what contain files<br />
<br />
===[[FF9/Dirs/00|Directory '0']]===<br />
<br />
===[[FF9/Dirs/01|Directory '1']]===<br />
<br />
==[[FF9/File/Data|File Cluster Information]]==<br />
Some of the files are actually '''data clusters''' that contain multiple information these files begin with the hexadecimal number 0xDB.<br />
<br />
===[[FF9/File/0x02|Chunk 0x02: 3D Model data]]===<br />
This chunk contains 3D model information: vertices, quads, triangles, texture mapping coordinates...<br />
<br />
===[[FF9/File/0x03|Chunk 0x03: 3D Animation]]===<br />
This chunk contains animation sequences for 3d models...<br />
<br />
===[[FF9/File/0x04|Chunk 0x04: Image data(TIM`s)]]===<br />
This chunk contains tim-images...<br />
<br />
===[[FF9/File/0x05|Chunk 0x05: Scripts]]===<br />
This chunk contains scripts files...<br />
<br />
===[[FF9/File/0x0A|Chunk 0x0A: Field tiles]]===<br />
This chunk contains information about field tiles and field camera parameters...<br />
<br />
===[[FF9/File/0x0B|Chunk 0x0B: Field walkmesh]]===<br />
This chunk contain field walkmesh data...<br />
<br />
===[[FF9/File/0x0C|Chunk 0x0C: Battle scenes]]===<br />
This chunk contain battle scenes geometry...<br />
<br />
===[[FF9/File/0x12|Chunk 0x12: Contain CLUT and TPage for models]]===<br />
This chunk contains CLUT and TPage info for models.<br />
<br />
===[[FF9/File/0x1B|Chunk 0x1B: Pointers to other 'DB']]===<br />
This chunk contains pointers to other DB structures.<br />
<br />
=[[FF9/WorldMap|WorldMap]]=<br />
<br />
=[[FF9/CharTables|Character Tables]]=<br />
==[[FF9/CharTables#Character_Table_for_EU_.26_US_version|European & US Tables]]==<br />
==[[FF9/CharTables#Character_Table_for_JP_version|Japanese Table]]==<br />
==[[FF9/CharTables#Kanji_Table_A|Kanji Table A]]==<br />
==[[FF9/CharTables#Kanji_Table_B|Kanji Table B]]==<br />
<br />
=Tools and Patches=<br />
* [[FF9/Tools|Tools and Patches]]</div>
Loveemu
https://wiki.ffrtt.ru/index.php?title=FF7/PSX/Sound/Code_Map&diff=5757
FF7/PSX/Sound/Code Map
2020-06-28T06:57:19Z
<p>Loveemu: </p>
<hr />
<div>= Code Map =<br />
<br />
Introduces functions, variables and data related to sound, contained in SCUS_941.63 (game program of US version). Note that all symbol names below are for convenience only.<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x800293D0<br />
|void _AkaoSpuTransferCallback(void)<br />
|<br />
|-<br />
|0x800293F4<br />
|void _AkaoSpuSetTransferCallback(void)<br />
|<br />
|-<br />
|0x80029424<br />
|unsigned int _AkaoTransferSamples(const unsigned char *addr, unsigned int size)<br />
|<br />
|-<br />
|0x800294A4<br />
|void _AkaoWaitForSpuTransfer(void)<br />
|<br />
|-<br />
|0x800294BC<br />
|void _AkaoReset(void)<br />
|<br />
|-<br />
|0x800297A4<br />
|void AkaoLoadInstrumentSet(const sturct AkaoSampleSet *sampleSet, const struct AkaoInstrumentAttr *instrumentSet)<br />
|Load standard instrument set<br />
<br />
''sampleSet'': corresponding to SOUND/INSTR.ALL<br />
<br />
''instrumentSet'': corresponding to SOUND/INSTR.DAT<br />
<br />
This function is called transparently from 0x8002988C.<br />
|-<br />
|0x80029818<br />
|void AkaoLoadInstrumentSet2(const sturct AkaoSampleSet *sampleSet, const struct AkaoInstrumentAttr *instrumentSet)<br />
|Load additional instrument set<br />
<br />
''sampleSet'': corresponding to SOUND/INSTR2.ALL<br />
<br />
''instrumentSet'': corresponding to SOUND/INSTR2.DAT<br />
|-<br />
|0x8002988C<br />
|void AkaoInitialize(const sturct AkaoSampleSet *sampleSet, const struct AkaoInstrumentAttr *instrumentSet)<br />
|Initialize sound driver and load initial instruments<br />
<br />
''sampleSet'': corresponding to SOUND/INSTR.ALL<br />
<br />
''instrumentSet'': corresponding to SOUND/INSTR.DAT<br />
|-<br />
|0x800299C8<br />
|void AkaoDeinitialize(void)<br />
|Deinitialize sound driver<br />
|-<br />
|0x80029AF0<br />
|void AkaoSetReverbMode(int mode)<br />
|<br />
|-<br />
|0x80029B78<br />
|void _AkaoTransferSeqBody(const unsigned char *data, int size)<br />
|<br />
|-<br />
|0x80029C48<br />
|void _AkaoLoadTracks(void)<br />
|<br />
|-<br />
|0x8002DA30<br />
|void AkaoNewMessage(struct AkaoMessage **ppMessage)<br />
|<br />
|-<br />
|0x8002DA7C<br />
|int AkaoPostMessage(void)<br />
|Post a new command message to the queue (with some wrapped processing)<br />
<br />
The message data comes from a global variable at 0x8009A000.<br />
<br />
Return value depends on the content of the message data.<br />
<br />
<br />
'''Opcode 0x10'''<br />
<br />
Load and start playing new [[FF7/PSX/Sound/AKAO sequence|AKAO sequence]]<br />
<br />
Returns: 0 for success, 1 for already loaded, and -1 for invalid signature<br />
<br />
<br />
'''Opcode 0x92'''<br />
<br />
Set value to the condition variable used by Opcode 0xEF.<br />
|-<br />
|0x8002E1A8<br />
|void _AkaoDispatchMessages(void)<br />
|<br />
|-<br />
|0x8002E23C<br />
|void _AkaoWriteSpuRegisters(int voiceNum, struct AkaoSpuVoiceAttr *attr)<br />
|<br />
|-<br />
|0x8002E478<br />
|void _AkaoDspOnTick(struct AkaoPlayerTrack *track, struct AkaoPlayer *player, int voiceMask)<br />
|<br />
|-<br />
|0x8002ED34<br />
|void _AkaoCalculateVolumeAndPitch(struct AkaoPlayerTrack *track, int voiceMask, int voiceNum)<br />
|<br />
|-<br />
|0x8002F24C<br />
|void _AkaoCalculateVolumeAndPitch2(struct AkaoPlayerTrack *track, int voiceMask)<br />
|<br />
|-<br />
|0x8002F738<br />
|void _AkaoDspOverlayVoice(struct AkaoPlayerTrack *track, int unknownVoiceMask, int voiceNum)<br />
|<br />
|-<br />
|0x8002F848<br />
|void _AkaoDspMain(void)<br />
|<br />
|-<br />
|0x8002FF4C<br />
|void _AkaoSpuNoiseVoice(void)<br />
|<br />
|-<br />
|0x80030038<br />
|void _AkaoSpuReverbVoice(void)<br />
|<br />
|-<br />
|0x80030148<br />
|void _AkaoSpuPitchLFOVoice(void)<br />
|<br />
|-<br />
|0x80030234<br />
|int _AkaoTimerCallback(void)<br />
|Sound callback event that is periodically triggered by root counter 2<br />
|-<br />
|0x800308D4<br />
|void _AkaoMain(void)<br />
|<br />
|-<br />
|0x80030E7C<br />
|void _AkaoDispatchVoice(struct AkaoPlayerTrack *track, struct AkaoPlayer *player, int voiceMask)<br />
|Dispatch voice opcodes until the next note or end of track<br />
|-<br />
|0x80031820<br />
|void AkaoSetInstrument(struct AkaoPlayerTrack *track, unsigned short progNumber)<br />
|<br />
|-<br />
|0x800318BC<br />
|int _AkaoReadNextNote(struct AkaoPlayerTrack *track)<br />
|<br />
|-<br />
|0x80031A70<br />
|int _AkaoFindNextEndPoint(struct AkaoPlayerTrack *track)<br />
|<br />
|-<br />
|0x80049548<br />
|void (* const MESSAGE_HANDLERS[256])(struct AkaoMessage *)<br />
|<br />
|-<br />
|0x80049948<br />
|const unsigned char VOICE_OPCODE_LENGTHS[0x60]<br />
|Length table for voice opcodes 0xa0-0xff<br />
<br />
0 for end of track and branches<br />
|-<br />
|0x80049AA8<br />
|void (* const VOICE_OPCODES[0x60])(struct AkaoPlayerTrack *, struct AkaoPlayer *, int)<br />
|Address table for voice opcodes 0xa0-0xff<br />
|-<br />
|0x80049C28<br />
|const unsigned short DELTA_TIME_TABLE[11];<br />
|<br />
|-<br />
|0x80049C44<br />
|const unsigned short VOLUME_TABLE_L[128]<br />
|See [[FF7/PSX/Sound/Opcodes/0xa8aa|Opcode 0xAA]] for volume balance calculation<br />
|-<br />
|0x80049E44<br />
|const unsigned short VOLUME_TABLE_R[128]<br />
|See [[FF7/PSX/Sound/Opcodes/0xa8aa|Opcode 0xAA]] for volume balance calculation<br />
|-<br />
|0x8004A5CC<br />
|const short *LFO_FORMS[16]<br />
|<br />
|-<br />
|0x8004A60C<br />
|const unsigned char EMPTY_ADPCM[32]<br />
|<br />
|-<br />
|0x80063010<br />
|int g_AkaoNumQueuedMessages<br />
|<br />
|-<br />
|0x80081DC8<br />
|AkaoMessage g_AkaoMessageQueue[]<br />
|<br />
|-<br />
|0x80083580<br />
|unsigned char g_AkaoSeqData[]<br />
|RAM area to load AKAO sequence data<br />
|-<br />
|0x8009A000<br />
|AkaoMessage g_AkaoMessage<br />
|Message data to be posted. Processed by the function 0x8002DA7C<br />
|}<br />
<br />
== Runtime Library Functions ==<br />
<br />
=== LIBSPU ===<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x80036298<br />
|void SpuInit(void)<br />
|<br />
|-<br />
|0x80036FFC<br />
|long SpuInitMalloc(long num, char *top)<br />
|<br />
|-<br />
|0x800373AC<br />
|long SpuMallocWithStartAddr(unsigned long addr, long size)<br />
|<br />
|-<br />
|0x80037964<br />
|unsigned long SpuSetNoiseVoice(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x80037B90<br />
|long SpuSetNoiseClock(long n_clock)<br />
|<br />
|-<br />
|0x80037BE0<br />
|unsigned long SpuRead(unsigned char *addr, unsigned long size)<br />
|<br />
|-<br />
|0x80037C40<br />
|long SpuSetReverb(long on_off)<br />
|<br />
|-<br />
|0x80037D90<br />
|long SpuGetReverb(void)<br />
|<br />
|-<br />
|0x80037E1C<br />
|long SpuSetReverbModeParam(SpuReverbAttr *attr)<br />
|<br />
|-<br />
|0x800387FC<br />
|void SpuGetReverbModeParam (SpuReverbAttr *attr)<br />
|<br />
|-<br />
|0x8003884C<br />
|long SpuSetReverbDepth(SpuReverbAttr *attr)<br />
|<br />
|-<br />
|0x800388C4<br />
|unsigned long SpuSetReverbVoice(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x800388E8<br />
|long SpuClearReverbWorkArea(long mode)<br />
|<br />
|-<br />
|0x80038A84<br />
|long SpuSetIRQ(long on_off)<br />
|<br />
|-<br />
|0x80038BC4<br />
|unsigned long SpuSetIRQAddr(unsigned long addr)<br />
|<br />
|-<br />
|0x80038C04<br />
|SpuIRQCallbackProc SpuSetIRQCallback(SpuIRQCallbackProc func)<br />
|<br />
|-<br />
|0x80038C6C<br />
|void SpuSetKey(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x80038F04<br />
|unsigned long SpuWrite(unsigned char *addr, unsigned long size)<br />
|<br />
|-<br />
|0x80038F64<br />
|unsigned long SpuSetTransferStartAddr(unsigned long addr)<br />
|<br />
|-<br />
|0x80038FB8<br />
|long SpuSetTransferMode(long mode)<br />
|<br />
|-<br />
|0x80038FEC<br />
|SpuTransferCallbackProc SpuSetTransferCallback(SpuTransferCallbackProc func)<br />
|<br />
|-<br />
|0x80039010<br />
|unsigned long SpuSetPitchLFOVoice(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x80039034<br />
|void SpuSetCommonAttr(SpuCommonAttr *attr)<br />
|<br />
|-<br />
|0x800393C8<br />
|void SpuSetVoiceVolume(int voiceNum, short volL, short volR)<br />
|<br />
|-<br />
|0x80039450<br />
|void SpuSetVoiceVolumeAttr(int voiceNum, short volL, short volR, short volModeL, short volModeR)<br />
|<br />
|-<br />
|0x800395C8<br />
|void SpuSetVoicePitch(int voiceNum, unsigned short pitch)<br />
|<br />
|-<br />
|0x80039644<br />
|void SpuSetVoiceStartAddr(int voiceNum, unsigned long startAddr)<br />
|<br />
|-<br />
|0x800396C0<br />
|void SpuSetVoiceLoopStartAddr(int voiceNum, unsigned long lsa)<br />
|<br />
|-<br />
|0x8003973C<br />
|void SpuSetVoiceDR(int voiceNum, unsigned short DR)<br />
|<br />
|-<br />
|0x800397C8<br />
|void SpuSetVoiceSL(int voiceNum, unsigned short SL)<br />
|<br />
|-<br />
|0x80039850<br />
|void SpuSetVoiceARAttr(int voiceNum, unsigned short AR, long ARmode)<br />
|<br />
|-<br />
|0x800398EC<br />
|void SpuSetVoiceSRAttr(int voiceNum, unsigned short SR, long SRmode)<br />
|<br />
|-<br />
|0x800399D0<br />
|void SpuSetVoiceRRAttr(int voiceNum, unsigned short RR, long RRmode)<br />
|<br />
|}<br />
<br />
=== LIBETC ===<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x8003D0C0<br />
|int ResetCallback(void)<br />
|<br />
|-<br />
|0x8003D150<br />
|int VSyncCallback(void (*func)(void))<br />
|<br />
|-<br />
|0x8003D1B4<br />
|int StopCallback(void)<br />
|<br />
|-<br />
|0x8003D214<br />
|int CheckCallback(void)<br />
|<br />
|}<br />
<br />
=== LIBAPI ===<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x800429F0<br />
|void DeliverEvent(unsigned long ev1, unsigned long ev2)<br />
|<br />
|-<br />
|0x80042A00<br />
|long OpenEvent(unsigned long desc, long spec, long mode, long (*func)())<br />
|<br />
|-<br />
|0x80042A10<br />
|long CloseEvent(long event)<br />
|<br />
|-<br />
|0x80042A20<br />
|long WaitEvent(long event)<br />
|<br />
|-<br />
|0x80042A40<br />
|long EnableEvent(long event)<br />
|<br />
|-<br />
|0x80042A50<br />
|long DisableEvent(long event)<br />
|<br />
|-<br />
|0x80042BC0<br />
|long SetRCnt(unsigned long spec, unsigned short target, long mode)<br />
|<br />
|-<br />
|0x80042C60<br />
|long GetRCnt(unsigned long spec)<br />
|<br />
|-<br />
|0x80042C98<br />
|long StartRCnt(unsigned long spec)<br />
|<br />
|-<br />
|0x80042CCC<br />
|long StopRCnt(unsigned long spec)<br />
|<br />
|}<br />
<br />
= Structures =<br />
<br />
[[FF7/PSX/Sound/INSTRx.DAT|struct AkaoInstrumentAttr]]<br />
<br />
[[FF7/PSX/Sound/INSTRx.ALL|struct AkaoSampleSet]]<br />
<br />
[[FF7/PSX/Sound/AKAO sequence|struct AkaoSeqHeader, struct AkaoDrumKeyAttr]]<br />
<br />
struct AkaoMessage // 36 bytes long<br />
{<br />
uint16_t opcode;<br />
uint16_t reserved;<br />
uint32_t data[8];<br />
};<br />
<br />
struct AkaoSpuVoiceAttr<br />
{<br />
uint32_t voice; // 0x00: voice number<br />
uint32_t update_flags; // 0x04: bitset that indicates what SPU registers need to be updated<br />
uint32_t addr; // 0x08: waveform data start address (SPU address)<br />
uint32_t loop_addr; // 0x0c: loop start address (SPU address)<br />
uint32_t a_mode; // 0x10: ADSR: attack mode<br />
uint32_t s_mode; // 0x14: ADSR: sustain mode<br />
uint32_t r_mode // 0x18: ADSR: release mode<br />
uint16_t pitch; // 0x1c: pitch<br />
uint16_t ar; // 0x1e: ADSR: attack rate<br />
uint16_t dr; // 0x20: ADSR: decay rate<br />
uint16_t sl; // 0x22: ADSR: sustain level<br />
uint16_t sr; // 0x24: ADSR: sustain rate<br />
uint16_t rr; // 0x26: ADSR: release rate<br />
SpuVolume volume; // 0x28: volume (left and right)<br />
};<br />
<br />
struct AkaoPlayer // the music player instance exists at 0x8009A104<br />
{<br />
uint32_t stereo_mode; // 0x00: stereo mode (1: stereo, 4: surround, otherwise: mono)<br />
uint32_t active_voices; // 0x04: bitset that indicates the voices currently in use<br />
uint32_t key_on_voices; // 0x08: bitset that indicates the voices to key on<br />
uint32_t keyed_voices; // 0x0c: bitset that indicates the voices currently keyed on<br />
uint32_t key_off_voices; // 0x10: bitset that indicates the voices to key off<br />
uint32_t saved_active_voices; // 0x14: unknown voice bitset<br />
uint32_t tempo; // 0x18: tempo (Q16 fixed-point number)<br />
int32_t tempo_slope; // 0x1c: slope of tempo slider (Q16 fixed-point number)<br />
uint32_t time_counter; // 0x20: time counter (0x10000 = 1 tick)<br />
uint32_t overlay_voices; // 0x24: bitset that indicates the sub-voices used for overlay (opcode 0xF4)<br />
uint32_t alternate_voices; // 0x28: bitset that indicates the sub-voices used for alternate voice (opcode 0xF8)<br />
uint32_t noise_voices; // 0x2c: bitset that indicates the voices with noise mode enabled<br />
uint32_t reverb_voices; // 0x30: bitset that indicates the voices with reverb enabled<br />
uint32_t pitch_lfo_voices; // 0x34: bitset that indicates the voices with pitch LFO (frequency modulation) mode enabled<br />
uint32_t spucnt; // 0x38: SPUCNT shadow<br />
uint32_t reverb_type; // 0x3c: reverb type<br />
uint32_t reverb_depth; // 0x40: reverb depth (Q16 fixed-point number)<br />
int32_t reverb_depth_slope; // 0x44: slope of reverb depth slider (Q16 fixed-point number)<br />
uint16_t tempo_slide_length; // 0x48: tempo slide length<br />
uint16_t song_id; // 0x4a: current song id<br />
uint16_t condition_ack; // 0x4c: the last matched condition value (opcode 0xEF)<br />
uint16_t condition; // 0x4e: condition variable for dynamic branching according to game status (opcode 0xEF)<br />
uint16_t reverb_depth_slide_length; // 0x50: length of reverb depth slide<br />
uint16_t noise_clock; // 0x52: noise clock frequency<br />
uint16_t field_54; // 0x54: unknown (can be altered by opcode 0xF3)<br />
uint16_t beats_per_measure; // 0x56: beats per measure<br />
uint16_t beat; // 0x58: current beat<br />
uint16_t ticks_per_beat; // 0x5a: ticks per beat<br />
uint16_t tick; // 0x5c: current ticks per beat<br />
uint16_t measure; // 0x5e: current measure<br />
};<br />
<br />
struct AkaoPlayerTrack // the music player track instances exist at 0x80096608 + (N * 0x108)<br />
{<br />
uint8_t *addr; // 0x00<br />
uint8_t *loop_addrs[4]; // 0x04<br />
AkaoDrumKeyAttr *drum_addr; // 0x14<br />
int16_t *vibrato_lfo_addr; // 0x18<br />
int16_t *tremolo_lfo_addr; // 0x1c<br />
int16_t *pan_lfo_addr; // 0x20<br />
uint32_t overlay_voice_num; // 0x24<br />
uint32_t alternate_voice_num; // 0x28<br />
uint32_t master_volume; // 0x2c<br />
uint32_t pitch_of_note; // 0x30<br />
int32_t pitch_bend_slide_amplitude; // 0x34<br />
uint16_t voice_effect_flags; // 0x38<br />
uint16_t field_3A; // 0x3a<br />
uint16_t field_3C; // 0x3c<br />
uint16_t field_3E; // 0x3e<br />
uint32_t field_40; // 0x40<br />
uint32_t volume; // 0x44<br />
int32_t volume_slope; // 0x48<br />
int32_t pitch_bend_slope; // 0x4c<br />
uint16_t field_50; // 0x50<br />
uint16_t field_52; // 0x52<br />
uint16_t field_54; // 0x54<br />
uint8_t delta_time_counter; // 0x56<br />
uint8_t gate_time_counter; // 0x57<br />
uint16_t instrument; // 0x58<br />
uint16_t field_5A; // 0x5a<br />
uint16_t volume_slide_length_counter; // 0x5c<br />
uint16_t overlay_balance_slide_length_counter; // 0x5e<br />
uint16_t pan; // 0x60<br />
uint16_t pan_slide_length; // 0x62<br />
int16_t pitch_slide_length_counter; // 0x64<br />
uint16_t octave; // 0x66<br />
uint16_t pitch_slide_length; // 0x68<br />
uint16_t previous_note_number; // 0x6a<br />
uint16_t portamento_speed; // 0x6c<br />
uint16_t legato_flags; // 0x6e<br />
uint16_t field_70; // 0x70<br />
uint16_t vibrato_delay; // 0x72<br />
uint16_t vibrato_delay_counter; // 0x74<br />
uint16_t vibrato_rate; // 0x76<br />
uint16_t vibrato_rate_counter; // 0x78<br />
uint16_t vibrato_form; // 0x7a<br />
uint16_t vibrato_max_amplitude; // 0x7c<br />
uint16_t vibrato_depth; // 0x7e<br />
uint16_t vibrato_depth_slide_length_counter; // 0x80<br />
int16_t vibrato_depth_slope; // 0x82<br />
uint16_t field_84; // 0x84<br />
uint16_t tremolo_delay; // 0x86<br />
uint16_t tremolo_delay_counter; // 0x88<br />
uint16_t tremolo_rate; // 0x8a<br />
uint16_t tremolo_rate_counter; // 0x8c<br />
uint16_t tremolo_form; // 0x8e<br />
uint16_t tremolo_depth; // 0x90<br />
uint16_t tremolo_depth_slide_length_counter; // 0x92<br />
int16_t tremolo_depth_slope; // 0x94<br />
uint16_t field_96; // 0x96<br />
uint16_t pan_lfo_rate; // 0x98<br />
uint16_t pan_lfo_rate_counter; // 0x9a<br />
uint16_t pan_lfo_form; // 0x9c<br />
uint16_t pan_lfo_depth; // 0x9e<br />
uint16_t pan_lfo_depth_slide_length_counter; // 0xa0<br />
int16_t pan_lfo_slope; // 0xa2<br />
uint16_t noise_on_off_delay_counter; // 0xa4<br />
uint16_t pitchmod_on_off_delay_counter; // 0xa6<br />
uint8_t field_A8[16]; // 0xa8<br />
uint16_t loop_layer; // 0xb8<br />
uint16_t loop_counts[4]; // 0xba<br />
uint16_t previous_delta_time; // 0xc2<br />
uint16_t forced_delta_time; // 0xc4<br />
uint16_t overlay_balance; // 0xc6<br />
int16_t overlay_balance_slope; // 0xc8<br />
int16_t pan_slope; // 0xca<br />
int16_t transpose; // 0xcc<br />
int16_t tuning; // 0xce<br />
uint16_t note; // 0xd0<br />
int16_t pitch_slide_amount; // 0xd2<br />
int16_t previous_transpose; // 0xd4<br />
int16_t vibrato_lfo_amplitude; // 0xd6<br />
int16_t tremolo_lfo_amplitude; // 0xd8<br />
int16_t pan_lfo_amplitude; // 0xda<br />
AkaoSpuVoiceAttr spu_attr; // 0xdc<br />
};</div>
Loveemu
https://wiki.ffrtt.ru/index.php?title=FF7/PSX/Sound/INSTRx.DAT&diff=5756
FF7/PSX/Sound/INSTRx.DAT
2020-06-20T15:25:40Z
<p>Loveemu: Add hard-coded load offset information for each files.</p>
<hr />
<div>There are two files of such type:<br />
<br />
<br />
{| class="wikitable"<br />
! File<br />
! Number of Instruments<br />
! Load Offset<br />
! Load Size<br />
! Description<br />
|-<br />
|SOUND/INSTR.DAT<br />
|style="text-align:right"| 93<br />
|0<br />
|0x2000 (128 * 0x40)<br />
|Main game sounds<br />
|-<br />
|SOUND/INSTR2.DAT<br />
|style="text-align:right"| 4<br />
|0xD40 (53 * 0x40)<br />
|0x12C0 (75 * 0x40)<br />
|Voices from ending theme "One Winged Angel"<br />
|}<br />
<br />
These files contain index data for all instruments from INSTRx.ALL.<br />
<br />
<br />
== Record format ==<br />
<br />
struct AkaoInstrumentAttr<br />
{<br />
/* offsets */<br />
uint32_t addr; // offset to attack part of instrument (SPU hardware address)<br />
uint32_t loop_addr; // offset to loop part of instrument (SPU hardware address)<br />
/* ADSR Envelope settings */<br />
uint8_t ar; // ADSR: attack rate (0x00-0x7f)<br />
uint8_t dr; // ADSR: decay rate (0x00-0x0f)<br />
uint8_t sl; // ADSR: sustain level (0x00-0x0f)<br />
uint8_t sr; // ADSR: sustain rate (0x00-0x7f)<br />
uint8_t rr; // ADSR: release rate (0x00-0x1f)<br />
uint8_t a_mode; // ADSR: attack mode<br />
// 0x05 - (exponential)<br />
// 0x01 (default) - (linear)<br />
uint8_t s_mode; // ADSR: sustain mode<br />
// 0x01 - (linear, increase)<br />
// 0x05 - (exponential, increase)<br />
// 0x07 - (exponential, decrease)<br />
// 0x03 (default) - (linear, decrease)<br />
uint8_t r_mode; // ADSR: release mode<br />
// 0x07 - (exponential decrease)<br />
// 0x03 (default) - (linear decrease)<br />
uint32_t pitch[12]; // predefined pitch set for instrument<br />
};<br />
<br />
Each index file takes 4 CDROM sectors, so rest unused data filled with zeroes. Attack and loop offsets isn't real file offsets, it's offsets to instruments in SPU internal memory (all instrument data from INSTRx.ALL files are copied by DMA to SPU memory in one chunk), so to translate INSTR.ALL you need to subtract 0x0ff0 (or you need to subtract 0x38540 for INSTR2.DAT). INSTR.DAT file resides in PSX RAM at address 0x80075f30 and when it's needed to load any instrument or to reset pitch for this instrument this table is used.</div>
Loveemu
https://wiki.ffrtt.ru/index.php?title=FF7/PSX/Sound/AKAO_sequence&diff=5755
FF7/PSX/Sound/AKAO sequence
2020-06-20T14:41:36Z
<p>Loveemu: </p>
<hr />
<div>== Introduction ==<br />
AKAO sequence is the most complicated part of the FF7 sound system. ("AKAO" is the signature string, which implies that the sound format has developed by Square Enix sound programmer Minoru Akao.)<br />
<br />
AKAO sequence is similar to MIDI sequence - it's custom tracker format for playing sequence sound, well tuned specially for PSX.<br />
<br />
The sequence data can be found in all FF7 game modules: Field, Battle, Worldmap and in minigames.<br />
<br />
All files with exension *.SND are AKAO.<br />
<br />
* '''MINI/ASERI2.SND''' - Battle Arena theme<br />
* '''MINI/SENSUI.SND''' - used in Submarine minigame<br />
* '''ENEMY6/OVER2.SND''' - game over sequence<br />
* '''ENEMY6/FAN2.SND''' - battle win "fanfare" sequence<br />
* '''MOVIE/OVER2.SND''' - same game over sequence, don't know, why to duplicate data<br />
<br />
Other AKAO sequences are hard-wired in other files.<br />
<br />
<br />
== File Structure ==<br />
=== Header (size: 16 bytes) ===<br />
<br />
struct AkaoSeqHeader<br />
{<br />
static const uint8_t magic[4]; // "AKAO" C-string<br />
uint16_t id; // song ID, used for playing sequence<br />
uint16_t length; // data length - sizeof(header)<br />
uint16_t reverb_type; // reverb type (range from 0 to 9)<br />
struct AkaoTimeStamp timestamp; // creation time<br />
};<br />
<br />
struct AkaoTimeStamp<br />
{<br />
uint8_t year_bcd; // year (in binary coded decimal)<br />
uint8_t month_bcd; // month (in binary coded decimal, between 0x01 - 0x12)<br />
uint8_t day_bcd; // day (in binary coded decimal, between 0x01 - 0x31)<br />
uint8_t hours_bcd; // hours (in binary coded decimal, between 0x00 - 0x23)<br />
uint8_t minutes_bcd; // minutes (in binary coded decimal, between 0x00 - 0x59)<br />
uint8_t seconds_bcd; // seconds (in binary coded decimal, between 0x00 - 0x59)<br />
};<br />
<br />
=== Channel Info (size: 4 bytes + 2 bytes * <channels count>) ===<br />
struct AkaoChannelInfo<br />
{<br />
uint32_t mask; // represents bitmask of used channels in this song<br />
uint32_t start_offsets[num_channels]; // offsets to channel opcode data<br />
};<br />
<br />
int num_channels = 0;<br />
while (int bit = 0; ((info.mask & 0xFFFFFF) & (1 << bit)) != 0; bit++)<br />
num_channels++;<br />
<br />
First there is 32-bit number (offset 0x10), which represents bitmask of used channels in this song.<br />
<br />
After this bitmask, there is <channels count> offsets to channel opcode data counting from current offset. Each offsets is a relative offset based on the address *next to* the offset itself. (This is a general rule for early versions of AKAO to interpret relative offsets.)<br />
<br />
<br />
=== Channel Commands [AKAO Opcodes] ===<br />
For every channels in an AKAO sequence, there is a set of commands to perform. This is similar to Field opcodes. Here I will call this sound commands "opcodes". Every opcode has its own number of arguments (from no-arguments, to 3 arguments).<br />
<br />
=== Drum Instrument Map Table ===<br />
<br />
When a song uses a drum kit with [[FF7/PSX/Sound/Opcodes/0xeced|opcode 0xEC]], a drum instrument map table will be placed at the end of the sequence. The table determines the instrument, channel volume and pan for each keys.<br />
<br />
The table consists of a repetition of 5-byte items.<br />
<br />
struct AkaoDrumKeyAttr<br />
{<br />
uint8_t instrument; // corresponding to opcode 0xA1<br />
uint8_t key; // note number when playing the drum note<br />
uint16_t volume; // corresponding to opcode 0xA8 (lower 8bit is a fractional part of the volume)<br />
uint8_t pan; // corresponding to opcode 0xAA<br />
}<br />
<br />
== Example (Home-Created AKAO Sequence): ==<br />
=== Header ===<br />
'''41 4b 41 4f''' - AKAO string<br />
<br />
'''34 12''' - song ID: 0x1234<br />
<br />
'''16 00''' - data length 0x16 in hex or 22 in decimal<br />
<br />
'''04 00''' - reverb type: 4 (large studio)<br />
<br />
'''96 12 18 22 46 28''' - created at 1996-12-18 22:46:28<br />
<br />
<br />
=== Channel Info ===<br />
'''01 00 00 00''' - this indicates, that used only one channel<br />
<br />
'''00 00''' - offset to first channel opcodes: in our example 0x00 means that next to this offset is opcodes for first channel<br />
<br />
<br />
=== Channel Commands ===<br />
'''e8 a8 66''' - sets tempo, parameter 0x66a8<br />
<br />
'''ea 00 50''' - sets reverb depth<br />
<br />
'''a8 55''' - load sample 0x55 from INSTR.ALL to channel<br />
<br />
'''aa 40''' - sets channel volume<br />
<br />
'''c2''' - turns on reverb effect<br />
<br />
'''a1 0c''' - sets volume pan<br />
<br />
'''c8''' - sets loop point<br />
<br />
'''66''' - 0x66 % 11 = 3 (3 means to take 3rd number from play length table), 0x66 / 11 = 9 (9 means to take pitch[9] from loaded instrument record index)<br />
<br />
'''ca''' - returns to saved loop point with opcode c8<br />
<br />
<br />
This example plays Chocobo "Whoo-Hoo" (instrument number 0x55) repeatedly.<br />
<br />
<br />
== Sound Opcode List ==<br />
<br />
{| class="wikitable"<br />
! Opcode<br />
! Summary<br />
! Length<br />
! Operands<br />
! Note<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0x0099|0x00-0x99]]<br />
|Note, Tie, Rest<br />
|1<br />
|<br />
|The opcode indicates the note key and length. The note will be keyed off 2 ticks before the next note.<br />
|-<br />
|0x9A-0x9F<br />
|Unimplemented<br />
|1<br />
|<br />
|Should not be used.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa0|0xA0]]<br />
|Finish Channel<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa1|0xA1]]<br />
|Load Instrument<br />
|2<br />
|instrument: byte (0-127)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0x0099|0xA2]]<br />
|Overwrite Next Note Length<br />
|2<br />
|length: byte<br />
|Ignores the regular length (delta-time) of the next note and overwrites it with the specified length.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa8aa|0xA3]]<br />
|Channel Master Volume<br />
|2<br />
|volume: byte (0-127)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa4|0xA4]]<br />
|Pitch Bend Slide<br />
|3<br />
|length: byte, semitones: signed byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa5|0xA5]]<br />
|Set Octave<br />
|2<br />
|octave: byte (0-15)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa5|0xA6]]<br />
|Increase Octave<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa5|0xA7]]<br />
|Decrease Octave<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa8aa|0xA8]]<br />
|Channel Volume<br />
|2<br />
|volume: byte (0-127)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa9|0xA9]]<br />
|Channel Volume Slide<br />
|3<br />
|length: byte, volume: byte (0-127)<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa8aa|0xAA]]<br />
|Channel Pan<br />
|2<br />
|pan: byte (0-127)<br />
|64 is the center.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xab|0xAB]]<br />
|Channel Pan Slide<br />
|3<br />
|length: byte, pan: byte (0-127)<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xac|0xAC]]<br />
|Noise Clock Frequency<br />
|2<br />
|clock: byte (0x00-0x3f)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/ADSR|0xAD]]<br />
|ADSR: Attack Rate<br />
|2<br />
|attack_rate: byte (0x00-0x7f)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/ADSR|0xAE]]<br />
|ADSR: Decay Rate<br />
|2<br />
|decay_rate: byte (0x00-0x0f)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/ADSR|0xAF]]<br />
|ADSR: Sustain Level<br />
|2<br />
|sustain_level: byte (0x00-0x0f)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/ADSR|0xB0]]<br />
|ADSR: Decay Rate & Sustain Level<br />
|3<br />
|decay_rate: byte (0x00-0x0f), sustain_level: byte (0x00-0x0f)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/ADSR|0xB1]]<br />
|ADSR: Sustain Rate<br />
|2<br />
|sustain_rate: byte (0x00-0x7f)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/ADSR|0xB2]]<br />
|ADSR: Release Rate<br />
|2<br />
|release_rate: byte (0x00-0x1f)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/ADSR|0xB3]]<br />
|ADSR: Reset ADSR<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xb4b5|0xB4]]<br />
|Channel Pitch LFO (Vibrato)<br />
|4<br />
|delay: byte, rate: byte, type: byte (0-15)<br />
|When <code>rate</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xb4b5|0xB5]]<br />
|Channel Pitch LFO Depth<br />
|2<br />
|depth: byte<br />
|The most significant bit of the <code>depth</code> determines the amplitude range.<br />
<br />
When it is 0, the range is up to about ± 50 cents (amplitude is 15/256 compared with range type 1).<br />
<br />
When it is 1, the range is up to about ± 700 cents.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xb4b5|0xB6]]<br />
|Turn Off Channel Pitch LFO<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/ADSR|0xB7]]<br />
|ADSR: Attack Mode<br />
|2<br />
|attack_mode: byte (1 or 5)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xb8b9|0xB8]]<br />
|Channel Volume LFO (Tremolo)<br />
|4<br />
|delay: byte, rate: byte, type: byte (0-15)<br />
|When <code>rate</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xb8b9|0xB9]]<br />
|Channel Volume LFO Depth<br />
|2<br />
|depth: byte<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xb8b9|0xBA]]<br />
|Turn Off Channel Volume LFO<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/ADSR|0xBB]]<br />
|ADSR: Sustain Mode<br />
|2<br />
|sustain_mode: byte (1, 3, 5 or 7)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xbcbd|0xBC]]<br />
|Channel Pan LFO<br />
|3<br />
|rate: byte, type: byte (0-15)<br />
|When <code>rate</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xbcbd|0xBD]]<br />
|Channel Pan LFO Depth<br />
|2<br />
|depth: byte<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xbcbd|0xBE]]<br />
|Turn Off Channel Pan LFO<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xbf|0xBF]]<br />
|ADSR: Release Mode<br />
|2<br />
|release_mode: byte (3 or 7)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc0c1|0xC0]]<br />
|Channel Transpose (Absolute)<br />
|2<br />
|semitones: signed byte<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc0c1|0xC1]]<br />
|Channel Transpose (Relative)<br />
|2<br />
|semitones: signed byte<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc2c3|0xC2]]<br />
|Turn On Reverb<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc2c3|0xC3]]<br />
|Turn Off Reverb<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc4c5|0xC4]]<br />
|Turn On Noise<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc4c5|0xC5]]<br />
|Turn Off Noise<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc6c7|0xC6]]<br />
|Turn On Frequency Modulation<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc6c7|0xC7]]<br />
|Turn Off Frequency Modulation<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc8c9|0xC8]]<br />
|Loop Point<br />
|1<br />
|<br />
|Remember the current offset as a loop point and increase the nesting level of the loop.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc8c9|0xC9]]<br />
|Return to Loop Point Up to N Times<br />
|2<br />
|times: byte<br />
|On the Nth repeat, this instruction will end the current loop by decrementing the nesting level of the loop. Otherwise, it will increment the loop counter and return to the loop point.<br />
When <code>times</code> is 0, it will be translated to 256 times.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc8c9|0xCA]]<br />
|Return to Loop Point<br />
|1<br />
|<br />
|This instruction will increment the loop counter.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xcb|0xCB]]<br />
|Reset Sound Effects<br />
|1<br />
|<br />
|Reset sound effects such as noise, frequency modulation, reverb, overlay voice and alternate voice.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xcccd|0xCC]]<br />
|Turn On Legato<br />
|1<br />
|<br />
|This instruction will stop the regular key on and key off performance of the subsequent notes and update the pitch only.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xcccd|0xCD]]<br />
|Turn Off Legato<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xcecf|0xCE]]<br />
|Turn On Noise and Toggle Noise On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xcecf|0xCF]]<br />
|Toggle Noise On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xd0d1|0xD0]]<br />
|Turn On Full-Length Note Mode<br />
|1<br />
|<br />
|This instruction will stop the regular key off performance of the subsequent notes.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xd0d1|0xD1]]<br />
|Turn Off Full-Length Note Mode<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xd2d3|0xD2]]<br />
|Turn On Frequency Modulation and Toggle Frequency Modulation On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xd2d3|0xD3]]<br />
|Toggle Frequency Modulation On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xd4d5|0xD4]]<br />
|Turn On Playback Rate Side Chain<br />
|1<br />
|<br />
|Duplicate and use the playback frequency of the previous voice channel.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xd4d5|0xD5]]<br />
|Turn Off Playback Rate Side Chain<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xd6d7|0xD6]]<br />
|Turn On Pitch-Volume Side Chain<br />
|1<br />
|<br />
|Multiply the playback frequency of the previous voice channel to the output volume. Lower pitch will make the volume smaller.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xd6d7|0xD7]]<br />
|Turn Off Pitch-Volume Side Chain<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xd8d9|0xD8]]<br />
|Channel Fine Tuning (Absolute)<br />
|2<br />
|amount: signed byte<br />
|The pitch can be changed in the range of one octave above and below.<br />
The <code>amount</code> is the multiplicand for the playback frequency, not a log-based parameter like cents. For example, when the <code>amount</code> is 127, the pitch will be multiplied by 127/128 (about +1 octave). Negative value will lower the pitch.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xd8d9|0xD9]]<br />
|Channel Fine Tuning (Relative)<br />
|2<br />
|amount: signed byte<br />
|The <code>amount</code> will be added to the current tuning amount.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xdadb|0xDA]]<br />
|Turn On Portamento<br />
|2<br />
|speed: byte<br />
|When <code>speed</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xdadb|0xDB]]<br />
|Turn Off Portamento<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0x0099|0xDC]]<br />
|Fix Note Length<br />
|2<br />
|length_to_add: signed byte<br />
|Ignore the regular length (delta-time) of subsequent notes and set to the fixed length. The <code>length_to_add</code> parameter will be added to the current length value. (the initial value is 0)<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xdd|0xDD]]<br />
|Channel Pitch LFO Depth Slide<br />
|3<br />
|length: byte, depth: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xde|0xDE]]<br />
|Channel Volume LFO Depth Slide<br />
|3<br />
|length: byte, depth: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xdf|0xDF]]<br />
|Channel Pan LFO Depth Slide<br />
|3<br />
|length: byte, depth: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa0|0xE0-0xE7]]<br />
|Unimplemented<br />
|1<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xe8e9|0xE8]]<br />
|Tempo<br />
|3<br />
|tempo: uint16<br />
|bpm = tempo / 214.998204 (approximate)<br />
More strictly, <code>bpm = 60.0 / (48 * (65536.0 / tempo) * (0x44E8 / (33868800.0 / 8)))</code><br />
<br />
Note that this coefficient is different from other games with PlayStation AKAO.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xe8e9|0xE9]]<br />
|Tempo Slide<br />
|4<br />
|length: byte, tempo: uint16<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xeaeb|0xEA]]<br />
|Reverb Depth<br />
|3<br />
|depth: uint16<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xeaeb|0xEB]]<br />
|Reverb Depth Slide<br />
|4<br />
|length: byte, depth: uint16<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xeced|0xEC]]<br />
|Turn On Drum Mode<br />
|3<br />
|drum_map_offset: signed int16<br />
|The <code>drum_map_offset</code> is a relative offset pointing to the drum instrument map table, which determines the instrument for each keys.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xeced|0xED]]<br />
|Turn Off Drum Mode<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xee|0xEE]]<br />
|Unconditional Jump<br />
|3<br />
|destination_offset: signed int16<br />
|This instruction can be used to make an infinite loop.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xef|0xEF]]<br />
|CPU-Conditional Jump<br />
|4<br />
|condition: byte, destination_offset: signed int16<br />
|Jump if the condition variable matches <code>condition</code>. The value of the condition variable can be set from the game program.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xf0f1|0xF0]]<br />
|Jump on the Nth Repeat<br />
|4<br />
|times: byte, destination_offset: signed int16<br />
|When <code>times</code> is 0, it will be translated to 256 times.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xf0f1|0xF1]]<br />
|Break the Loop on the Nth Repeat<br />
|4<br />
|times: byte, destination_offset: signed int16<br />
|Unlike 0xF0, this instruction will end the current loop by decrementing the nesting level of the loop.<br />
When <code>times</code> is 0, it will be translated to 256 times.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa1|0xF2]]<br />
|Load Instrument (No Attack Sample)<br />
|2<br />
|instrument: byte<br />
|Unlike 0xA1, the sample before the loop point is replaced by a short, silence sample.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xf3|0xF3]]<br />
|Unknown<br />
|1<br />
|<br />
|There is no actual use in music.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xf4f5|0xF4]]<br />
|Turn On Overlay Voice<br />
|3<br />
|instrument: byte, instrument2: byte<br />
|Play the same melody by different instruments on two voice channels. A free voice channel is required to work. Note that the two channels share the playback rate, and the pitch is not calculated for each instruments.<br />
Used in the song "Anxious Heart".<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xf4f5|0xF5]]<br />
|Turn Off Overlay Voice<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xf4f5|0xF6]]<br />
|Overlay Volume Balance<br />
|2<br />
|balance: byte (0-127)<br />
|When the balance is 0, the volume of the primary voice will be 100% (127/128) of original and that of the secondary voice will be 0%. 127 is the opposite.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xf4f5|0xF7]]<br />
|Overlay Volume Balance Slide<br />
|3<br />
|length: byte, balance: byte (0-127)<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xf8f9|0xF8]]<br />
|Turn On Alternate Voice<br />
|2<br />
|release_rate: byte (0x00-0x1f)<br />
|This instruction allows subsequent notes to be played on two alternating channels. At the same time, the ADSR release rate will be set to the specified value. A free voice channel is required to work. <br />
Check "Opening - Bombing Mission", "Tifa's Theme" and "Fortress of the Condor" for actual usage.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xf8f9|0xF9]]<br />
|Turn Off Alternate Voice<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa0|0xFA-0xFC]]<br />
|Unimplemented<br />
|1<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xfd|0xFD]]<br />
|Time Signature<br />
|3<br />
|ticks_per_beat: byte, beats_per_measure: byte<br />
|Note that two parameters can be 0. This pattern is used for initialization.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xfe|0xFE]]<br />
|Measure Number<br />
|2<br />
|measure: byte<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa0|0xFF]]<br />
|Unimplemented<br />
|1<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|}</div>
Loveemu
https://wiki.ffrtt.ru/index.php?title=FF7/PSX/Sound/Code_Map&diff=5754
FF7/PSX/Sound/Code Map
2020-06-20T14:40:17Z
<p>Loveemu: </p>
<hr />
<div>= Code Map =<br />
<br />
Introduces functions, variables and data related to sound, contained in SCUS_941.63 (game program of US version). Note that all symbol names below are for convenience only.<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x800293D0<br />
|void _AkaoSpuTransferCallback(void)<br />
|<br />
|-<br />
|0x800293F4<br />
|void _AkaoSpuSetTransferCallback(void)<br />
|<br />
|-<br />
|0x80029424<br />
|unsigned int _AkaoTransferSamples(const unsigned char *addr, unsigned int size)<br />
|<br />
|-<br />
|0x800294A4<br />
|void _AkaoWaitForSpuTransfer(void)<br />
|<br />
|-<br />
|0x800294BC<br />
|void _AkaoReset(void)<br />
|<br />
|-<br />
|0x800297A4<br />
|void AkaoLoadInstrumentSet(const sturct AkaoSampleSet *sampleSet, const struct AkaoInstrumentAttr *instrumentSet)<br />
|Load standard instrument set<br />
<br />
''sampleSet'': corresponding to SOUND/INSTR.ALL<br />
<br />
''instrumentSet'': corresponding to SOUND/INSTR.DAT<br />
<br />
This function is called transparently from 0x8002988C.<br />
|-<br />
|0x80029818<br />
|void AkaoLoadInstrumentSet2(const sturct AkaoSampleSet *sampleSet, const struct AkaoInstrumentAttr *instrumentSet)<br />
|Load additional instrument set<br />
<br />
''sampleSet'': corresponding to SOUND/INSTR2.ALL<br />
<br />
''instrumentSet'': corresponding to SOUND/INSTR2.DAT<br />
|-<br />
|0x8002988C<br />
|void AkaoInitialize(const sturct AkaoSampleSet *sampleSet, const struct AkaoInstrumentAttr *instrumentSet)<br />
|Initialize sound driver and load initial instruments<br />
<br />
''sampleSet'': corresponding to SOUND/INSTR.ALL<br />
<br />
''instrumentSet'': corresponding to SOUND/INSTR.DAT<br />
|-<br />
|0x800299C8<br />
|void AkaoDeinitialize(void)<br />
|Deinitialize sound driver<br />
|-<br />
|0x80029AF0<br />
|void AkaoSetReverbMode(int mode)<br />
|<br />
|-<br />
|0x80029B78<br />
|void _AkaoTransferSeqBody(const unsigned char *data, int size)<br />
|<br />
|-<br />
|0x80029C48<br />
|void _AkaoLoadTracks(void)<br />
|<br />
|-<br />
|0x8002DA30<br />
|void AkaoNewMessage(struct AkaoMessage **ppMessage)<br />
|<br />
|-<br />
|0x8002DA7C<br />
|int AkaoPostMessage(void)<br />
|Post a new command message to the queue (with some wrapped processing)<br />
<br />
The message data comes from a global variable at 0x8009A000.<br />
<br />
Return value depends on the content of the message data.<br />
<br />
<br />
'''Opcode 0x10'''<br />
<br />
Load and start playing new [[FF7/PSX/Sound/AKAO sequence|AKAO sequence]]<br />
<br />
Returns: 0 for success, 1 for already loaded, and -1 for invalid signature<br />
<br />
<br />
'''Opcode 0x92'''<br />
<br />
Set value to the condition variable used by Opcode 0xEF.<br />
|-<br />
|0x8002E1A8<br />
|void _AkaoDispatchMessages(void)<br />
|<br />
|-<br />
|0x8002E23C<br />
|void _AkaoWriteSpuRegisters(int voiceNum, struct AkaoSpuVoiceAttr *attr)<br />
|<br />
|-<br />
|0x8002E478<br />
|void _AkaoDspOnTick(struct AkaoPlayerTrack *track, struct AkaoPlayer *player, int voiceMask)<br />
|<br />
|-<br />
|0x8002ED34<br />
|void _AkaoCalculateVolumeAndPitch(struct AkaoPlayerTrack *track, int voiceMask, int voiceNum)<br />
|<br />
|-<br />
|0x8002F24C<br />
|void _AkaoCalculateVolumeAndPitch2(struct AkaoPlayerTrack *track, int voiceMask)<br />
|<br />
|-<br />
|0x8002F738<br />
|void _AkaoDspOverlayVoice(struct AkaoPlayerTrack *track, int unknownVoiceMask, int voiceNum)<br />
|<br />
|-<br />
|0x8002F848<br />
|void _AkaoDspMain(void)<br />
|<br />
|-<br />
|0x8002FF4C<br />
|void _AkaoSpuNoiseVoice(void)<br />
|<br />
|-<br />
|0x80030038<br />
|void _AkaoSpuReverbVoice(void)<br />
|<br />
|-<br />
|0x80030148<br />
|void _AkaoSpuPitchLFOVoice(void)<br />
|<br />
|-<br />
|0x80030234<br />
|int _AkaoTimerCallback(void)<br />
|Sound callback event that is periodically triggered by root counter 2<br />
|-<br />
|0x800308D4<br />
|void _AkaoMain(void)<br />
|<br />
|-<br />
|0x80030E7C<br />
|void _AkaoDispatchVoice(struct AkaoPlayerTrack *track, struct AkaoPlayer *player, int voiceMask)<br />
|Dispatch voice opcodes until the next note or end of track<br />
|-<br />
|0x80031820<br />
|void AkaoSetInstrument(struct AkaoPlayerTrack *track, unsigned short progNumber)<br />
|<br />
|-<br />
|0x800318BC<br />
|int _AkaoReadNextNote(struct AkaoPlayerTrack *track)<br />
|<br />
|-<br />
|0x80031A70<br />
|int _AkaoFindNextEndPoint(struct AkaoPlayerTrack *track)<br />
|<br />
|-<br />
|0x80049548<br />
|void (* const MESSAGE_HANDLERS[256])(struct AkaoMessage *)<br />
|<br />
|-<br />
|0x80049948<br />
|const unsigned char VOICE_OPCODE_LENGTHS[0x60]<br />
|Length table for voice opcodes 0xa0-0xff<br />
<br />
0 for end of track and branches<br />
|-<br />
|0x80049AA8<br />
|void (* const VOICE_OPCODES[0x60])(struct AkaoPlayerTrack *, struct AkaoPlayer *, int)<br />
|Address table for voice opcodes 0xa0-0xff<br />
|-<br />
|0x80049C28<br />
|const unsigned short DELTA_TIME_TABLE[11];<br />
|<br />
|-<br />
|0x80049C44<br />
|const unsigned short VOLUME_TABLE_L[128]<br />
|See [[FF7/PSX/Sound/Opcodes/0xa8aa|Opcode 0xAA]] for volume balance calculation<br />
|-<br />
|0x80049E44<br />
|const unsigned short VOLUME_TABLE_R[128]<br />
|See [[FF7/PSX/Sound/Opcodes/0xa8aa|Opcode 0xAA]] for volume balance calculation<br />
|-<br />
|0x8004A5CC<br />
|const short *LFO_FORMS[16]<br />
|<br />
|-<br />
|0x8004A60C<br />
|const unsigned char EMPTY_ADPCM[32]<br />
|<br />
|-<br />
|0x80063010<br />
|int g_AkaoNumQueuedMessages<br />
|<br />
|-<br />
|0x80081DC8<br />
|AkaoMessage g_AkaoMessageQueue[]<br />
|<br />
|-<br />
|0x80083580<br />
|unsigned char g_AkaoSeqData[]<br />
|RAM area to load AKAO sequence data<br />
|-<br />
|0x8009A000<br />
|AkaoMessage g_AkaoMessage<br />
|Message data to be posted. Processed by the function 0x8002DA7C<br />
|}<br />
<br />
== Runtime Library Functions ==<br />
<br />
=== LIBSPU ===<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x80036298<br />
|void SpuInit(void)<br />
|<br />
|-<br />
|0x80036FFC<br />
|long SpuInitMalloc(long num, char *top)<br />
|<br />
|-<br />
|0x800373AC<br />
|long SpuMallocWithStartAddr(unsigned long addr, long size)<br />
|<br />
|-<br />
|0x80037964<br />
|unsigned long SpuSetNoiseVoice(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x80037B90<br />
|long SpuSetNoiseClock(long n_clock)<br />
|<br />
|-<br />
|0x80037BE0<br />
|unsigned long SpuRead(unsigned char *addr, unsigned long size)<br />
|<br />
|-<br />
|0x80037C40<br />
|long SpuSetReverb(long on_off)<br />
|<br />
|-<br />
|0x80037D90<br />
|long SpuGetReverb(void)<br />
|<br />
|-<br />
|0x80037E1C<br />
|long SpuSetReverbModeParam(SpuReverbAttr *attr)<br />
|<br />
|-<br />
|0x800387FC<br />
|void SpuGetReverbModeParam (SpuReverbAttr *attr)<br />
|<br />
|-<br />
|0x8003884C<br />
|long SpuSetReverbDepth(SpuReverbAttr *attr)<br />
|<br />
|-<br />
|0x800388C4<br />
|unsigned long SpuSetReverbVoice(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x800388E8<br />
|long SpuClearReverbWorkArea(long mode)<br />
|<br />
|-<br />
|0x80038A84<br />
|long SpuSetIRQ(long on_off)<br />
|<br />
|-<br />
|0x80038BC4<br />
|unsigned long SpuSetIRQAddr(unsigned long addr)<br />
|<br />
|-<br />
|0x80038C04<br />
|SpuIRQCallbackProc SpuSetIRQCallback(SpuIRQCallbackProc func)<br />
|<br />
|-<br />
|0x80038C6C<br />
|void SpuSetKey(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x80038F04<br />
|unsigned long SpuWrite(unsigned char *addr, unsigned long size)<br />
|<br />
|-<br />
|0x80038F64<br />
|unsigned long SpuSetTransferStartAddr(unsigned long addr)<br />
|<br />
|-<br />
|0x80038FB8<br />
|long SpuSetTransferMode(long mode)<br />
|<br />
|-<br />
|0x80038FEC<br />
|SpuTransferCallbackProc SpuSetTransferCallback(SpuTransferCallbackProc func)<br />
|<br />
|-<br />
|0x80039010<br />
|unsigned long SpuSetPitchLFOVoice(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x80039034<br />
|void SpuSetCommonAttr(SpuCommonAttr *attr)<br />
|<br />
|-<br />
|0x800393C8<br />
|void SpuSetVoiceVolume(int voiceNum, short volL, short volR)<br />
|<br />
|-<br />
|0x80039450<br />
|void SpuSetVoiceVolumeAttr(int voiceNum, short volL, short volR, short volModeL, short volModeR)<br />
|<br />
|-<br />
|0x800395C8<br />
|void SpuSetVoicePitch(int voiceNum, unsigned short pitch)<br />
|<br />
|-<br />
|0x80039644<br />
|void SpuSetVoiceStartAddr(int voiceNum, unsigned long startAddr)<br />
|<br />
|-<br />
|0x800396C0<br />
|void SpuSetVoiceLoopStartAddr(int voiceNum, unsigned long lsa)<br />
|<br />
|-<br />
|0x8003973C<br />
|void SpuSetVoiceDR(int voiceNum, unsigned short DR)<br />
|<br />
|-<br />
|0x800397C8<br />
|void SpuSetVoiceSL(int voiceNum, unsigned short SL)<br />
|<br />
|-<br />
|0x80039850<br />
|void SpuSetVoiceARAttr(int voiceNum, unsigned short AR, long ARmode)<br />
|<br />
|-<br />
|0x800398EC<br />
|void SpuSetVoiceSRAttr(int voiceNum, unsigned short SR, long SRmode)<br />
|<br />
|-<br />
|0x800399D0<br />
|void SpuSetVoiceRRAttr(int voiceNum, unsigned short RR, long RRmode)<br />
|<br />
|}<br />
<br />
=== LIBETC ===<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x8003D0C0<br />
|int ResetCallback(void)<br />
|<br />
|-<br />
|0x8003D150<br />
|int VSyncCallback(void (*func)(void))<br />
|<br />
|-<br />
|0x8003D1B4<br />
|int StopCallback(void)<br />
|<br />
|-<br />
|0x8003D214<br />
|int CheckCallback(void)<br />
|<br />
|}<br />
<br />
=== LIBAPI ===<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x800429F0<br />
|void DeliverEvent(unsigned long ev1, unsigned long ev2)<br />
|<br />
|-<br />
|0x80042A00<br />
|long OpenEvent(unsigned long desc, long spec, long mode, long (*func)())<br />
|<br />
|-<br />
|0x80042A10<br />
|long CloseEvent(long event)<br />
|<br />
|-<br />
|0x80042A20<br />
|long WaitEvent(long event)<br />
|<br />
|-<br />
|0x80042A40<br />
|long EnableEvent(long event)<br />
|<br />
|-<br />
|0x80042A50<br />
|long DisableEvent(long event)<br />
|<br />
|-<br />
|0x80042BC0<br />
|long SetRCnt(unsigned long spec, unsigned short target, long mode)<br />
|<br />
|-<br />
|0x80042C60<br />
|long GetRCnt(unsigned long spec)<br />
|<br />
|-<br />
|0x80042C98<br />
|long StartRCnt(unsigned long spec)<br />
|<br />
|-<br />
|0x80042CCC<br />
|long StopRCnt(unsigned long spec)<br />
|<br />
|}<br />
<br />
= Structures =<br />
<br />
[[FF7/PSX/Sound/INSTRx.DAT|struct AkaoInstrumentAttr]]<br />
<br />
[[FF7/PSX/Sound/INSTRx.ALL|struct AkaoSampleSet]]<br />
<br />
[[FF7/PSX/Sound/AKAO sequence|struct AkaoSeqHeader, struct AkaoDrumKeyAttr]]<br />
<br />
struct AkaoMessage // 36 bytes long<br />
{<br />
uint16_t opcode;<br />
uint16_t reserved;<br />
uint32_t data[8];<br />
};<br />
<br />
struct AkaoSpuVoiceAttr<br />
{<br />
uint32_t voice; // 0x00: voice number<br />
uint32_t update_flags; // 0x04: bitset that indicates what SPU registers need to be updated<br />
uint32_t addr; // 0x08: waveform data start address (SPU address)<br />
uint32_t loop_addr; // 0x0c: loop start address (SPU address)<br />
uint32_t a_mode; // 0x10: ADSR: attack mode<br />
uint32_t s_mode; // 0x14: ADSR: sustain mode<br />
uint32_t r_mode // 0x18: ADSR: release mode<br />
uint16_t pitch; // 0x1c: pitch<br />
uint16_t ar; // 0x1e: ADSR: attack rate<br />
uint16_t dr; // 0x20: ADSR: decay rate<br />
uint16_t sl; // 0x22: ADSR: sustain level<br />
uint16_t sr; // 0x24: ADSR: sustain rate<br />
uint16_t rr; // 0x26: ADSR: release rate<br />
SpuVolume volume; // 0x28: volume (left and right)<br />
};<br />
<br />
struct AkaoPlayer // the music player instance exists at 0x8009A104<br />
{<br />
uint32_t stereo_mode; // 0x00: stereo mode (1: stereo, 4: surround, otherwise: mono)<br />
uint32_t active_voices; // 0x04: bitset that indicates the voices currently in use<br />
uint32_t key_on_voices; // 0x08: bitset that indicates the voices to key on<br />
uint32_t keyed_voices; // 0x0c: bitset that indicates the voices currently keyed on<br />
uint32_t key_off_voices; // 0x10: bitset that indicates the voices to key off<br />
uint32_t saved_active_voices; // 0x14: unknown voice bitset<br />
uint32_t tempo; // 0x18: tempo (Q16 fixed-point number)<br />
int32_t tempo_slope; // 0x1c: slope of tempo slider (Q16 fixed-point number)<br />
uint32_t time_counter; // 0x20: time counter (0x10000 = 1 tick)<br />
uint32_t overlay_voices; // 0x24: bitset that indicates the sub-voices used for overlay (opcode 0xF4)<br />
uint32_t alternate_voices; // 0x28: bitset that indicates the sub-voices used for alternate voice (opcode 0xF8)<br />
uint32_t noise_voices; // 0x2c: bitset that indicates the voices with noise mode enabled<br />
uint32_t reverb_voices; // 0x30: bitset that indicates the voices with reverb enabled<br />
uint32_t pitch_lfo_voices; // 0x34: bitset that indicates the voices with pitch LFO (frequency modulation) mode enabled<br />
uint32_t spucnt; // 0x38: SPUCNT shadow<br />
uint32_t reverb_type; // 0x3c: reverb type<br />
uint32_t reverb_depth; // 0x40: reverb depth (Q16 fixed-point number)<br />
int32_t reverb_depth_slope; // 0x44: slope of reverb depth slider (Q16 fixed-point number)<br />
uint16_t tempo_slide_length; // 0x48: tempo slide length<br />
uint16_t song_id; // 0x4a: current song id<br />
uint16_t condition_ack; // 0x4c: the last matched condition value (opcode 0xEF)<br />
uint16_t condition; // 0x4e: condition variable for dynamic branching according to game status (opcode 0xEF)<br />
uint16_t reverb_depth_slide_length; // 0x50: length of reverb depth slide<br />
uint16_t noise_clock; // 0x52: noise clock frequency<br />
uint16_t field_54; // 0x54: unknown (can be altered by opcode 0xF3)<br />
uint16_t beats_per_measure; // 0x56: beats per measure<br />
uint16_t beat; // 0x58: current beat<br />
uint16_t ticks_per_beat; // 0x5a: ticks per beat<br />
uint16_t tick; // 0x5c: current ticks per beat<br />
uint16_t measure; // 0x5e: current measure<br />
};<br />
<br />
struct AkaoPlayerTrack // the music player track instances exist at 0x80096608 + (N * 0x108)<br />
{<br />
uint8_t *addr; // 0x00<br />
uint8_t *loop_addrs[4]; // 0x04<br />
AkaoDrumKeyAttr *drum_addr; // 0x14<br />
int16_t *vibrato_lfo_addr; // 0x18<br />
int16_t *tremolo_lfo_addr; // 0x1c<br />
int16_t *pan_lfo_addr; // 0x20<br />
uint32_t overlay_voice_num; // 0x24<br />
uint32_t alternate_voice_num; // 0x28<br />
uint32_t master_volume; // 0x2c<br />
uint32_t pitch_of_note; // 0x30<br />
int32_t pitch_bend_slide_amplitude; // 0x34<br />
uint16_t voice_effect_flags; // 0x38<br />
uint16_t field_3A; // 0x3a<br />
uint16_t field_3C; // 0x3c<br />
uint16_t field_3E; // 0x3e<br />
uint32_t field_40; // 0x40<br />
uint32_t volume; // 0x44<br />
int32_t volume_slope; // 0x48<br />
int32_t pitch_bend_slope; // 0x4c<br />
uint16_t field_50; // 0x50<br />
uint16_t field_52; // 0x52<br />
uint16_t field_54; // 0x54<br />
uint8_t delta_time_counter; // 0x56<br />
uint8_t gate_time_counter; // 0x57<br />
uint16_t instrument; // 0x58<br />
uint16_t field_5A; // 0x5a<br />
uint16_t volume_slide_length_counter; // 0x5c<br />
uint16_t overlay_balance_slide_length_counter; // 0x5e<br />
uint16_t pan; // 0x60<br />
uint16_t pan_slide_length; // 0x62<br />
int16_t pitch_slide_length_counter; // 0x64<br />
uint16_t octave; // 0x66<br />
uint16_t pitch_slide_length; // 0x68<br />
uint16_t previous_note_number; // 0x6a<br />
uint16_t portamento_speed; // 0x6c<br />
uint16_t legato_flags; // 0x6e<br />
uint16_t field_70; // 0x70<br />
uint16_t vibrato_lfo_delay; // 0x72<br />
uint16_t vibrato_delay_counter; // 0x74<br />
uint16_t vibrato_rate; // 0x76<br />
uint16_t vibrato_rate_counter; // 0x78<br />
uint16_t vibrato_form; // 0x7a<br />
uint16_t vibrato_max_amplitude; // 0x7c<br />
uint16_t vibrato_depth; // 0x7e<br />
uint16_t vibrato_depth_slide_length_counter; // 0x80<br />
int16_t vibrato_depth_slope; // 0x82<br />
uint16_t field_84; // 0x84<br />
uint16_t tremolo_delay; // 0x86<br />
uint16_t tremolo_delay_counter; // 0x88<br />
uint16_t tremolo_rate; // 0x8a<br />
uint16_t tremolo_rate_counter; // 0x8c<br />
uint16_t tremolo_form; // 0x8e<br />
uint16_t tremolo_depth; // 0x90<br />
uint16_t tremolo_depth_slide_length_counter; // 0x92<br />
int16_t tremolo_depth_slope; // 0x94<br />
uint16_t field_96; // 0x96<br />
uint16_t pan_lfo_rate; // 0x98<br />
uint16_t pan_lfo_rate_counter; // 0x9a<br />
uint16_t pan_lfo_form; // 0x9c<br />
uint16_t pan_lfo_depth; // 0x9e<br />
uint16_t pan_lfo_depth_slide_length_counter; // 0xa0<br />
int16_t pan_lfo_slope; // 0xa2<br />
uint16_t noise_on_off_delay_counter; // 0xa4<br />
uint16_t pitchmod_on_off_delay_counter; // 0xa6<br />
uint8_t field_A8[16]; // 0xa8<br />
uint16_t loop_layer; // 0xb8<br />
uint16_t loop_counts[4]; // 0xba<br />
uint16_t previous_delta_time; // 0xc2<br />
uint16_t forced_delta_time; // 0xc4<br />
uint16_t overlay_balance; // 0xc6<br />
int16_t overlay_balance_slope; // 0xc8<br />
int16_t pan_slope; // 0xca<br />
int16_t transpose; // 0xcc<br />
int16_t tuning; // 0xce<br />
uint16_t note; // 0xd0<br />
int16_t pitch_slide_amount; // 0xd2<br />
int16_t previous_transpose; // 0xd4<br />
int16_t vibrato_lfo_amplitude; // 0xd6<br />
int16_t tremolo_lfo_amplitude; // 0xd8<br />
int16_t pan_lfo_amplitude; // 0xda<br />
AkaoSpuVoiceAttr spu_attr; // 0xdc<br />
};</div>
Loveemu
https://wiki.ffrtt.ru/index.php?title=FF7/PSX/Sound/Code_Map&diff=5753
FF7/PSX/Sound/Code Map
2020-06-20T14:39:18Z
<p>Loveemu: Add comment to AkaoPlayer.field_54</p>
<hr />
<div>= Code Map =<br />
<br />
Introduces functions, variables and data related to sound, contained in SCUS_941.63 (game program of US version). Note that all symbol names below are for convenience only.<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x800293D0<br />
|void _AkaoSpuTransferCallback(void)<br />
|<br />
|-<br />
|0x800293F4<br />
|void _AkaoSpuSetTransferCallback(void)<br />
|<br />
|-<br />
|0x80029424<br />
|unsigned int _AkaoTransferSamples(const unsigned char *addr, unsigned int size)<br />
|<br />
|-<br />
|0x800294A4<br />
|void _AkaoWaitForSpuTransfer(void)<br />
|<br />
|-<br />
|0x800294BC<br />
|void _AkaoReset(void)<br />
|<br />
|-<br />
|0x800297A4<br />
|void AkaoLoadInstrumentSet(const sturct AkaoSampleSet *sampleSet, const struct AkaoInstrumentAttr *instrumentSet)<br />
|Load standard instrument set<br />
<br />
''sampleSet'': corresponding to SOUND/INSTR.ALL<br />
<br />
''instrumentSet'': corresponding to SOUND/INSTR.DAT<br />
<br />
This function is called transparently from 0x8002988C.<br />
|-<br />
|0x80029818<br />
|void AkaoLoadInstrumentSet2(const sturct AkaoSampleSet *sampleSet, const struct AkaoInstrumentAttr *instrumentSet)<br />
|Load additional instrument set<br />
<br />
''sampleSet'': corresponding to SOUND/INSTR2.ALL<br />
<br />
''instrumentSet'': corresponding to SOUND/INSTR2.DAT<br />
|-<br />
|0x8002988C<br />
|void AkaoInitialize(const sturct AkaoSampleSet *sampleSet, const struct AkaoInstrumentAttr *instrumentSet)<br />
|Initialize sound driver and load initial instruments<br />
<br />
''sampleSet'': corresponding to SOUND/INSTR.ALL<br />
<br />
''instrumentSet'': corresponding to SOUND/INSTR.DAT<br />
|-<br />
|0x800299C8<br />
|void AkaoDeinitialize(void)<br />
|Deinitialize sound driver<br />
|-<br />
|0x80029AF0<br />
|void AkaoSetReverbMode(int mode)<br />
|<br />
|-<br />
|0x80029B78<br />
|void _AkaoTransferSeqBody(const unsigned char *data, int size)<br />
|<br />
|-<br />
|0x80029C48<br />
|void _AkaoLoadTracks(void)<br />
|<br />
|-<br />
|0x8002DA30<br />
|void AkaoNewMessage(struct AkaoMessage **ppMessage)<br />
|<br />
|-<br />
|0x8002DA7C<br />
|int AkaoPostMessage(void)<br />
|Post a new command message to the queue (with some wrapped processing)<br />
<br />
The message data comes from a global variable at 0x8009A000.<br />
<br />
Return value depends on the content of the message data.<br />
<br />
<br />
'''Opcode 0x10'''<br />
<br />
Load and start playing new [[FF7/PSX/Sound/AKAO sequence|AKAO sequence]]<br />
<br />
Returns: 0 for success, 1 for already loaded, and -1 for invalid signature<br />
<br />
<br />
'''Opcode 0x92'''<br />
<br />
Set value to the condition variable used by Opcode 0xEF.<br />
|-<br />
|0x8002E1A8<br />
|void _AkaoDispatchMessages(void)<br />
|<br />
|-<br />
|0x8002E23C<br />
|void _AkaoWriteSpuRegisters(int voiceNum, struct AkaoSpuVoiceAttr *attr)<br />
|<br />
|-<br />
|0x8002E478<br />
|void _AkaoDspOnTick(struct AkaoPlayerTrack *track, struct AkaoPlayer *player, int voiceMask)<br />
|<br />
|-<br />
|0x8002ED34<br />
|void _AkaoCalculateVolumeAndPitch(struct AkaoPlayerTrack *track, int voiceMask, int voiceNum)<br />
|<br />
|-<br />
|0x8002F24C<br />
|void _AkaoCalculateVolumeAndPitch2(struct AkaoPlayerTrack *track, int voiceMask)<br />
|<br />
|-<br />
|0x8002F738<br />
|void _AkaoDspOverlayVoice(struct AkaoPlayerTrack *track, int unknownVoiceMask, int voiceNum)<br />
|<br />
|-<br />
|0x8002F848<br />
|void _AkaoDspMain(void)<br />
|<br />
|-<br />
|0x8002FF4C<br />
|void _AkaoSpuNoiseVoice(void)<br />
|<br />
|-<br />
|0x80030038<br />
|void _AkaoSpuReverbVoice(void)<br />
|<br />
|-<br />
|0x80030148<br />
|void _AkaoSpuPitchLFOVoice(void)<br />
|<br />
|-<br />
|0x80030234<br />
|int _AkaoTimerCallback(void)<br />
|Sound callback event that is periodically triggered by root counter 2<br />
|-<br />
|0x800308D4<br />
|void _AkaoMain(void)<br />
|<br />
|-<br />
|0x80030E7C<br />
|void _AkaoDispatchVoice(struct AkaoPlayerTrack *track, struct AkaoPlayer *player, int voiceMask)<br />
|Dispatch voice opcodes until the next note or end of track<br />
|-<br />
|0x80031820<br />
|void AkaoSetInstrument(struct AkaoPlayerTrack *track, unsigned short progNumber)<br />
|<br />
|-<br />
|0x800318BC<br />
|int _AkaoReadNextNote(struct AkaoPlayerTrack *track)<br />
|<br />
|-<br />
|0x80031A70<br />
|int _AkaoFindNextEndPoint(struct AkaoPlayerTrack *track)<br />
|<br />
|-<br />
|0x80049548<br />
|void (* const MESSAGE_HANDLERS[256])(struct AkaoMessage *)<br />
|<br />
|-<br />
|0x80049948<br />
|const unsigned char VOICE_OPCODE_LENGTHS[0x60]<br />
|Length table for voice opcodes 0xa0-0xff<br />
<br />
0 for end of track and branches<br />
|-<br />
|0x80049AA8<br />
|void (* const VOICE_OPCODES[0x60])(struct AkaoPlayerTrack *, struct AkaoPlayer *, int)<br />
|Address table for voice opcodes 0xa0-0xff<br />
|-<br />
|0x80049C28<br />
|const unsigned short DELTA_TIME_TABLE[11];<br />
|<br />
|-<br />
|0x80049C44<br />
|const unsigned short VOLUME_TABLE_L[128]<br />
|See [[FF7/PSX/Sound/Opcodes/0xa8aa|Opcode 0xAA]] for volume balance calculation<br />
|-<br />
|0x80049E44<br />
|const unsigned short VOLUME_TABLE_R[128]<br />
|See [[FF7/PSX/Sound/Opcodes/0xa8aa|Opcode 0xAA]] for volume balance calculation<br />
|-<br />
|0x8004A5CC<br />
|const short *LFO_FORMS[16]<br />
|<br />
|-<br />
|0x8004A60C<br />
|const unsigned char EMPTY_ADPCM[32]<br />
|<br />
|-<br />
|0x80063010<br />
|int g_AkaoNumQueuedMessages<br />
|<br />
|-<br />
|0x80081DC8<br />
|AkaoMessage g_AkaoMessageQueue[]<br />
|<br />
|-<br />
|0x80083580<br />
|unsigned char g_AkaoSeqData[]<br />
|RAM area to load AKAO sequence data<br />
|-<br />
|0x8009A000<br />
|AkaoMessage g_AkaoMessage<br />
|Message data to be posted. Processed by the function 0x8002DA7C<br />
|}<br />
<br />
== Runtime Library Functions ==<br />
<br />
=== LIBSPU ===<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x80036298<br />
|void SpuInit(void)<br />
|<br />
|-<br />
|0x80036FFC<br />
|long SpuInitMalloc(long num, char *top)<br />
|<br />
|-<br />
|0x800373AC<br />
|long SpuMallocWithStartAddr(unsigned long addr, long size)<br />
|<br />
|-<br />
|0x80037964<br />
|unsigned long SpuSetNoiseVoice(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x80037B90<br />
|long SpuSetNoiseClock(long n_clock)<br />
|<br />
|-<br />
|0x80037BE0<br />
|unsigned long SpuRead(unsigned char *addr, unsigned long size)<br />
|<br />
|-<br />
|0x80037C40<br />
|long SpuSetReverb(long on_off)<br />
|<br />
|-<br />
|0x80037D90<br />
|long SpuGetReverb(void)<br />
|<br />
|-<br />
|0x80037E1C<br />
|long SpuSetReverbModeParam(SpuReverbAttr *attr)<br />
|<br />
|-<br />
|0x800387FC<br />
|void SpuGetReverbModeParam (SpuReverbAttr *attr)<br />
|<br />
|-<br />
|0x8003884C<br />
|long SpuSetReverbDepth(SpuReverbAttr *attr)<br />
|<br />
|-<br />
|0x800388C4<br />
|unsigned long SpuSetReverbVoice(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x800388E8<br />
|long SpuClearReverbWorkArea(long mode)<br />
|<br />
|-<br />
|0x80038A84<br />
|long SpuSetIRQ(long on_off)<br />
|<br />
|-<br />
|0x80038BC4<br />
|unsigned long SpuSetIRQAddr(unsigned long addr)<br />
|<br />
|-<br />
|0x80038C04<br />
|SpuIRQCallbackProc SpuSetIRQCallback(SpuIRQCallbackProc func)<br />
|<br />
|-<br />
|0x80038C6C<br />
|void SpuSetKey(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x80038F04<br />
|unsigned long SpuWrite(unsigned char *addr, unsigned long size)<br />
|<br />
|-<br />
|0x80038F64<br />
|unsigned long SpuSetTransferStartAddr(unsigned long addr)<br />
|<br />
|-<br />
|0x80038FB8<br />
|long SpuSetTransferMode(long mode)<br />
|<br />
|-<br />
|0x80038FEC<br />
|SpuTransferCallbackProc SpuSetTransferCallback(SpuTransferCallbackProc func)<br />
|<br />
|-<br />
|0x80039010<br />
|unsigned long SpuSetPitchLFOVoice(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x80039034<br />
|void SpuSetCommonAttr(SpuCommonAttr *attr)<br />
|<br />
|-<br />
|0x800393C8<br />
|void SpuSetVoiceVolume(int voiceNum, short volL, short volR)<br />
|<br />
|-<br />
|0x80039450<br />
|void SpuSetVoiceVolumeAttr(int voiceNum, short volL, short volR, short volModeL, short volModeR)<br />
|<br />
|-<br />
|0x800395C8<br />
|void SpuSetVoicePitch(int voiceNum, unsigned short pitch)<br />
|<br />
|-<br />
|0x80039644<br />
|void SpuSetVoiceStartAddr(int voiceNum, unsigned long startAddr)<br />
|<br />
|-<br />
|0x800396C0<br />
|void SpuSetVoiceLoopStartAddr(int voiceNum, unsigned long lsa)<br />
|<br />
|-<br />
|0x8003973C<br />
|void SpuSetVoiceDR(int voiceNum, unsigned short DR)<br />
|<br />
|-<br />
|0x800397C8<br />
|void SpuSetVoiceSL(int voiceNum, unsigned short SL)<br />
|<br />
|-<br />
|0x80039850<br />
|void SpuSetVoiceARAttr(int voiceNum, unsigned short AR, long ARmode)<br />
|<br />
|-<br />
|0x800398EC<br />
|void SpuSetVoiceSRAttr(int voiceNum, unsigned short SR, long SRmode)<br />
|<br />
|-<br />
|0x800399D0<br />
|void SpuSetVoiceRRAttr(int voiceNum, unsigned short RR, long RRmode)<br />
|<br />
|}<br />
<br />
=== LIBETC ===<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x8003D0C0<br />
|int ResetCallback(void)<br />
|<br />
|-<br />
|0x8003D150<br />
|int VSyncCallback(void (*func)(void))<br />
|<br />
|-<br />
|0x8003D1B4<br />
|int StopCallback(void)<br />
|<br />
|-<br />
|0x8003D214<br />
|int CheckCallback(void)<br />
|<br />
|}<br />
<br />
=== LIBAPI ===<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x800429F0<br />
|void DeliverEvent(unsigned long ev1, unsigned long ev2)<br />
|<br />
|-<br />
|0x80042A00<br />
|long OpenEvent(unsigned long desc, long spec, long mode, long (*func)())<br />
|<br />
|-<br />
|0x80042A10<br />
|long CloseEvent(long event)<br />
|<br />
|-<br />
|0x80042A20<br />
|long WaitEvent(long event)<br />
|<br />
|-<br />
|0x80042A40<br />
|long EnableEvent(long event)<br />
|<br />
|-<br />
|0x80042A50<br />
|long DisableEvent(long event)<br />
|<br />
|-<br />
|0x80042BC0<br />
|long SetRCnt(unsigned long spec, unsigned short target, long mode)<br />
|<br />
|-<br />
|0x80042C60<br />
|long GetRCnt(unsigned long spec)<br />
|<br />
|-<br />
|0x80042C98<br />
|long StartRCnt(unsigned long spec)<br />
|<br />
|-<br />
|0x80042CCC<br />
|long StopRCnt(unsigned long spec)<br />
|<br />
|}<br />
<br />
= Structures =<br />
<br />
[[FF7/PSX/Sound/INSTRx.DAT|struct AkaoInstrumentAttr]]<br />
<br />
[[FF7/PSX/Sound/INSTRx.ALL|struct AkaoSampleSet]]<br />
<br />
[[FF7/PSX/Sound/AKAO sequence|struct AkaoSeqHeader, struct AkaoDrumKeyAttr]]<br />
<br />
struct AkaoMessage // 36 bytes long<br />
{<br />
uint16_t opcode;<br />
uint16_t reserved;<br />
uint32_t data[8];<br />
};<br />
<br />
struct AkaoSpuVoiceAttr<br />
{<br />
uint32_t voice; // 0x00: voice number<br />
uint32_t update_flags; // 0x04: bitset that indicates what SPU registers need to be updated<br />
uint32_t addr; // 0x08: waveform data start address (SPU address)<br />
uint32_t loop_addr; // 0x0c: loop start address (SPU address)<br />
uint32_t a_mode; // 0x10: ADSR: attack rate mode<br />
uint32_t s_mode; // 0x14: ADSR: sustain rate mode<br />
uint32_t r_mode // 0x18: ADSR: release rate mode<br />
uint16_t pitch; // 0x1c: pitch<br />
uint16_t ar; // 0x1e: ADSR: attack rate<br />
uint16_t dr; // 0x20: ADSR: decay rate<br />
uint16_t sl; // 0x22: ADSR: sustain level<br />
uint16_t sr; // 0x24: ADSR: sustain rate<br />
uint16_t rr; // 0x26: ADSR: release rate<br />
SpuVolume volume; // 0x28: volume (left and right)<br />
};<br />
<br />
struct AkaoPlayer // the music player instance exists at 0x8009A104<br />
{<br />
uint32_t stereo_mode; // 0x00: stereo mode (1: stereo, 4: surround, otherwise: mono)<br />
uint32_t active_voices; // 0x04: bitset that indicates the voices currently in use<br />
uint32_t key_on_voices; // 0x08: bitset that indicates the voices to key on<br />
uint32_t keyed_voices; // 0x0c: bitset that indicates the voices currently keyed on<br />
uint32_t key_off_voices; // 0x10: bitset that indicates the voices to key off<br />
uint32_t saved_active_voices; // 0x14: unknown voice bitset<br />
uint32_t tempo; // 0x18: tempo (Q16 fixed-point number)<br />
int32_t tempo_slope; // 0x1c: slope of tempo slider (Q16 fixed-point number)<br />
uint32_t time_counter; // 0x20: time counter (0x10000 = 1 tick)<br />
uint32_t overlay_voices; // 0x24: bitset that indicates the sub-voices used for overlay (opcode 0xF4)<br />
uint32_t alternate_voices; // 0x28: bitset that indicates the sub-voices used for alternate voice (opcode 0xF8)<br />
uint32_t noise_voices; // 0x2c: bitset that indicates the voices with noise mode enabled<br />
uint32_t reverb_voices; // 0x30: bitset that indicates the voices with reverb enabled<br />
uint32_t pitch_lfo_voices; // 0x34: bitset that indicates the voices with pitch LFO (frequency modulation) mode enabled<br />
uint32_t spucnt; // 0x38: SPUCNT shadow<br />
uint32_t reverb_type; // 0x3c: reverb type<br />
uint32_t reverb_depth; // 0x40: reverb depth (Q16 fixed-point number)<br />
int32_t reverb_depth_slope; // 0x44: slope of reverb depth slider (Q16 fixed-point number)<br />
uint16_t tempo_slide_length; // 0x48: tempo slide length<br />
uint16_t song_id; // 0x4a: current song id<br />
uint16_t condition_ack; // 0x4c: the last matched condition value (opcode 0xEF)<br />
uint16_t condition; // 0x4e: condition variable for dynamic branching according to game status (opcode 0xEF)<br />
uint16_t reverb_depth_slide_length; // 0x50: length of reverb depth slide<br />
uint16_t noise_clock; // 0x52: noise clock frequency<br />
uint16_t field_54; // 0x54: unknown (can be altered by opcode 0xF3)<br />
uint16_t beats_per_measure; // 0x56: beats per measure<br />
uint16_t beat; // 0x58: current beat<br />
uint16_t ticks_per_beat; // 0x5a: ticks per beat<br />
uint16_t tick; // 0x5c: current ticks per beat<br />
uint16_t measure; // 0x5e: current measure<br />
};<br />
<br />
struct AkaoPlayerTrack // the music player track instances exist at 0x80096608 + (N * 0x108)<br />
{<br />
uint8_t *addr; // 0x00<br />
uint8_t *loop_addrs[4]; // 0x04<br />
AkaoDrumKeyAttr *drum_addr; // 0x14<br />
int16_t *vibrato_lfo_addr; // 0x18<br />
int16_t *tremolo_lfo_addr; // 0x1c<br />
int16_t *pan_lfo_addr; // 0x20<br />
uint32_t overlay_voice_num; // 0x24<br />
uint32_t alternate_voice_num; // 0x28<br />
uint32_t master_volume; // 0x2c<br />
uint32_t pitch_of_note; // 0x30<br />
int32_t pitch_bend_slide_amplitude; // 0x34<br />
uint16_t voice_effect_flags; // 0x38<br />
uint16_t field_3A; // 0x3a<br />
uint16_t field_3C; // 0x3c<br />
uint16_t field_3E; // 0x3e<br />
uint32_t field_40; // 0x40<br />
uint32_t volume; // 0x44<br />
int32_t volume_slope; // 0x48<br />
int32_t pitch_bend_slope; // 0x4c<br />
uint16_t field_50; // 0x50<br />
uint16_t field_52; // 0x52<br />
uint16_t field_54; // 0x54<br />
uint8_t delta_time_counter; // 0x56<br />
uint8_t gate_time_counter; // 0x57<br />
uint16_t instrument; // 0x58<br />
uint16_t field_5A; // 0x5a<br />
uint16_t volume_slide_length_counter; // 0x5c<br />
uint16_t overlay_balance_slide_length_counter; // 0x5e<br />
uint16_t pan; // 0x60<br />
uint16_t pan_slide_length; // 0x62<br />
int16_t pitch_slide_length_counter; // 0x64<br />
uint16_t octave; // 0x66<br />
uint16_t pitch_slide_length; // 0x68<br />
uint16_t previous_note_number; // 0x6a<br />
uint16_t portamento_speed; // 0x6c<br />
uint16_t legato_flags; // 0x6e<br />
uint16_t field_70; // 0x70<br />
uint16_t vibrato_lfo_delay; // 0x72<br />
uint16_t vibrato_delay_counter; // 0x74<br />
uint16_t vibrato_rate; // 0x76<br />
uint16_t vibrato_rate_counter; // 0x78<br />
uint16_t vibrato_form; // 0x7a<br />
uint16_t vibrato_max_amplitude; // 0x7c<br />
uint16_t vibrato_depth; // 0x7e<br />
uint16_t vibrato_depth_slide_length_counter; // 0x80<br />
int16_t vibrato_depth_slope; // 0x82<br />
uint16_t field_84; // 0x84<br />
uint16_t tremolo_delay; // 0x86<br />
uint16_t tremolo_delay_counter; // 0x88<br />
uint16_t tremolo_rate; // 0x8a<br />
uint16_t tremolo_rate_counter; // 0x8c<br />
uint16_t tremolo_form; // 0x8e<br />
uint16_t tremolo_depth; // 0x90<br />
uint16_t tremolo_depth_slide_length_counter; // 0x92<br />
int16_t tremolo_depth_slope; // 0x94<br />
uint16_t field_96; // 0x96<br />
uint16_t pan_lfo_rate; // 0x98<br />
uint16_t pan_lfo_rate_counter; // 0x9a<br />
uint16_t pan_lfo_form; // 0x9c<br />
uint16_t pan_lfo_depth; // 0x9e<br />
uint16_t pan_lfo_depth_slide_length_counter; // 0xa0<br />
int16_t pan_lfo_slope; // 0xa2<br />
uint16_t noise_on_off_delay_counter; // 0xa4<br />
uint16_t pitchmod_on_off_delay_counter; // 0xa6<br />
uint8_t field_A8[16]; // 0xa8<br />
uint16_t loop_layer; // 0xb8<br />
uint16_t loop_counts[4]; // 0xba<br />
uint16_t previous_delta_time; // 0xc2<br />
uint16_t forced_delta_time; // 0xc4<br />
uint16_t overlay_balance; // 0xc6<br />
int16_t overlay_balance_slope; // 0xc8<br />
int16_t pan_slope; // 0xca<br />
int16_t transpose; // 0xcc<br />
int16_t tuning; // 0xce<br />
uint16_t note; // 0xd0<br />
int16_t pitch_slide_amount; // 0xd2<br />
int16_t previous_transpose; // 0xd4<br />
int16_t vibrato_lfo_amplitude; // 0xd6<br />
int16_t tremolo_lfo_amplitude; // 0xd8<br />
int16_t pan_lfo_amplitude; // 0xda<br />
AkaoSpuVoiceAttr spu_attr; // 0xdc<br />
};</div>
Loveemu
https://wiki.ffrtt.ru/index.php?title=FF7/PSX/Sound/Opcodes/0xa8aa&diff=5752
FF7/PSX/Sound/Opcodes/0xa8aa
2020-06-13T02:43:28Z
<p>Loveemu: </p>
<hr />
<div>== 0xA8, 0xAA, 0xA3 (Channel Volume, Pan, Volume Modifier) ==<br />
0xA8 has one 8-bit parameter, which used in calculation of base channel volume.<br />
<br />
0xAA has one 8-bit parameter, which used in calculation of channel pan (difference between left and right channel volume).<br />
<br />
0xA3 has one 8-bit parameter, which used in calculation of base channel volume.<br />
<br />
=== Volume Calculation ===<br />
<br />
// m_AKAO_VOLUME_TABLE_L[i] = 32768 - m_AKAO_VOLUME_TABLE_R[i];<br />
const uint16_t m_AKAO_VOLUME_TABLE_L[128] = {<br />
0x7f80, 0x7e80, 0x7d80, 0x7c80, 0x7b80, 0x7a80, 0x7980, 0x7880,<br />
0x7780, 0x7680, 0x7580, 0x7480, 0x7380, 0x7280, 0x7180, 0x7080,<br />
0x6f80, 0x6e80, 0x6d80, 0x6c80, 0x6b80, 0x6a80, 0x6980, 0x6880,<br />
0x6780, 0x6680, 0x6580, 0x6480, 0x6380, 0x6280, 0x6180, 0x6080,<br />
0x5f80, 0x5e80, 0x5d80, 0x5c80, 0x5b80, 0x5a80, 0x5980, 0x5880,<br />
0x5780, 0x5680, 0x5580, 0x5480, 0x5380, 0x5280, 0x5180, 0x5080,<br />
0x4f80, 0x4e80, 0x4d80, 0x4c80, 0x4b80, 0x4a80, 0x4980, 0x4880,<br />
0x4780, 0x4680, 0x4580, 0x4480, 0x4380, 0x4280, 0x4180, 0x4080,<br />
0x3f80, 0x3e80, 0x3d80, 0x3c80, 0x3b80, 0x3a80, 0x3980, 0x3880,<br />
0x3780, 0x3680, 0x3580, 0x3480, 0x3380, 0x3280, 0x3180, 0x3080,<br />
0x2f80, 0x2e80, 0x2d80, 0x2c80, 0x2b80, 0x2a80, 0x2980, 0x2880,<br />
0x2780, 0x2680, 0x2580, 0x2480, 0x2380, 0x2280, 0x2180, 0x2080,<br />
0x1f80, 0x1e80, 0x1d80, 0x1c80, 0x1b80, 0x1a80, 0x1980, 0x1880,<br />
0x1780, 0x1680, 0x1580, 0x1480, 0x1380, 0x1280, 0x1180, 0x1080,<br />
0x0f80, 0x0e80, 0x0d80, 0x0c80, 0x0b80, 0x0a80, 0x0980, 0x0880,<br />
0x0780, 0x0680, 0x0580, 0x0480, 0x0380, 0x0280, 0x0180, 0x0080<br />
};<br />
<br />
// m_AKAO_VOLUME_TABLE_R[i] = i * 256 + 128;<br />
const uint16_t m_AKAO_VOLUME_TABLE_R[128] = {<br />
0x0080, 0x0180, 0x0280, 0x0380, 0x0480, 0x0580, 0x0680, 0x0780,<br />
0x0880, 0x0980, 0x0a80, 0x0b80, 0x0c80, 0x0d80, 0x0e80, 0x0f80,<br />
0x1080, 0x1180, 0x1280, 0x1380, 0x1480, 0x1580, 0x1680, 0x1780,<br />
0x1880, 0x1980, 0x1a80, 0x1b80, 0x1c80, 0x1d80, 0x1e80, 0x1f80,<br />
0x2080, 0x2180, 0x2280, 0x2380, 0x2480, 0x2580, 0x2680, 0x2780,<br />
0x2880, 0x2980, 0x2a80, 0x2b80, 0x2c80, 0x2d80, 0x2e80, 0x2f80,<br />
0x3080, 0x3180, 0x3280, 0x3380, 0x3480, 0x3580, 0x3680, 0x3780,<br />
0x3880, 0x3980, 0x3a80, 0x3b80, 0x3c80, 0x3d80, 0x3e80, 0x3f80,<br />
0x4080, 0x4180, 0x4280, 0x4380, 0x4480, 0x4580, 0x4680, 0x4780,<br />
0x4880, 0x4980, 0x4a80, 0x4b80, 0x4c80, 0x4d80, 0x4e80, 0x4f80,<br />
0x5080, 0x5180, 0x5280, 0x5380, 0x5480, 0x5580, 0x5680, 0x5780,<br />
0x5880, 0x5980, 0x5a80, 0x5b80, 0x5c80, 0x5d80, 0x5e80, 0x5f80,<br />
0x6080, 0x6180, 0x6280, 0x6380, 0x6480, 0x6580, 0x6680, 0x6780,<br />
0x6880, 0x6980, 0x6a80, 0x6b80, 0x6c80, 0x6d80, 0x6e80, 0x6f80,<br />
0x7080, 0x7180, 0x7280, 0x7380, 0x7480, 0x7580, 0x7680, 0x7780,<br />
0x7880, 0x7980, 0x7a80, 0x7b80, 0x7c80, 0x7d80, 0x7e80, 0x7f80<br />
};<br />
<br />
left_volume = m_AKAO_VOLUME_TABLE_L[aa_parameter] * ((a8_parameter * a3_parameter * 0x7f) / 128) / 256 / 128;<br />
<br />
right_volume = m_AKAO_VOLUME_TABLE_R[aa_parameter] * ((a8_parameter * a3_paramater * 0x7f) / 128) / 256 / 128;<br />
<br />
If there is no A3 opcode in sequence (as in SENSUI.SND for example), default value 0x7f is used.<br />
<br />
If there is no A8 opcode in sequence, default value 0x7f.fe is used. (More precisely, 0x3fff is stored in memory.)</div>
Loveemu
https://wiki.ffrtt.ru/index.php?title=FF7/PSX/Sound/Opcodes/0xa8aa&diff=5751
FF7/PSX/Sound/Opcodes/0xa8aa
2020-06-13T02:42:59Z
<p>Loveemu: Add default value information of opcode A8.</p>
<hr />
<div>== 0xA8, 0xAA, 0xA3 (Channel Volume, Pan, Volume Modifier) ==<br />
0xA8 has one 8-bit parameter, which used in calculation of base channel volume.<br />
<br />
0xAA has one 8-bit parameter, which used in calculation of channel pan (difference between left and right channel volume).<br />
<br />
0xA3 has one 8-bit parameter, which used in calculation of base channel volume.<br />
<br />
=== Volume Calculation ===<br />
<br />
// m_AKAO_VOLUME_TABLE_L[i] = 32768 - m_AKAO_VOLUME_TABLE_R[i];<br />
const uint16_t m_AKAO_VOLUME_TABLE_L[128] = {<br />
0x7f80, 0x7e80, 0x7d80, 0x7c80, 0x7b80, 0x7a80, 0x7980, 0x7880,<br />
0x7780, 0x7680, 0x7580, 0x7480, 0x7380, 0x7280, 0x7180, 0x7080,<br />
0x6f80, 0x6e80, 0x6d80, 0x6c80, 0x6b80, 0x6a80, 0x6980, 0x6880,<br />
0x6780, 0x6680, 0x6580, 0x6480, 0x6380, 0x6280, 0x6180, 0x6080,<br />
0x5f80, 0x5e80, 0x5d80, 0x5c80, 0x5b80, 0x5a80, 0x5980, 0x5880,<br />
0x5780, 0x5680, 0x5580, 0x5480, 0x5380, 0x5280, 0x5180, 0x5080,<br />
0x4f80, 0x4e80, 0x4d80, 0x4c80, 0x4b80, 0x4a80, 0x4980, 0x4880,<br />
0x4780, 0x4680, 0x4580, 0x4480, 0x4380, 0x4280, 0x4180, 0x4080,<br />
0x3f80, 0x3e80, 0x3d80, 0x3c80, 0x3b80, 0x3a80, 0x3980, 0x3880,<br />
0x3780, 0x3680, 0x3580, 0x3480, 0x3380, 0x3280, 0x3180, 0x3080,<br />
0x2f80, 0x2e80, 0x2d80, 0x2c80, 0x2b80, 0x2a80, 0x2980, 0x2880,<br />
0x2780, 0x2680, 0x2580, 0x2480, 0x2380, 0x2280, 0x2180, 0x2080,<br />
0x1f80, 0x1e80, 0x1d80, 0x1c80, 0x1b80, 0x1a80, 0x1980, 0x1880,<br />
0x1780, 0x1680, 0x1580, 0x1480, 0x1380, 0x1280, 0x1180, 0x1080,<br />
0x0f80, 0x0e80, 0x0d80, 0x0c80, 0x0b80, 0x0a80, 0x0980, 0x0880,<br />
0x0780, 0x0680, 0x0580, 0x0480, 0x0380, 0x0280, 0x0180, 0x0080<br />
};<br />
<br />
// m_AKAO_VOLUME_TABLE_R[i] = i * 256 + 128;<br />
const uint16_t m_AKAO_VOLUME_TABLE_R[128] = {<br />
0x0080, 0x0180, 0x0280, 0x0380, 0x0480, 0x0580, 0x0680, 0x0780,<br />
0x0880, 0x0980, 0x0a80, 0x0b80, 0x0c80, 0x0d80, 0x0e80, 0x0f80,<br />
0x1080, 0x1180, 0x1280, 0x1380, 0x1480, 0x1580, 0x1680, 0x1780,<br />
0x1880, 0x1980, 0x1a80, 0x1b80, 0x1c80, 0x1d80, 0x1e80, 0x1f80,<br />
0x2080, 0x2180, 0x2280, 0x2380, 0x2480, 0x2580, 0x2680, 0x2780,<br />
0x2880, 0x2980, 0x2a80, 0x2b80, 0x2c80, 0x2d80, 0x2e80, 0x2f80,<br />
0x3080, 0x3180, 0x3280, 0x3380, 0x3480, 0x3580, 0x3680, 0x3780,<br />
0x3880, 0x3980, 0x3a80, 0x3b80, 0x3c80, 0x3d80, 0x3e80, 0x3f80,<br />
0x4080, 0x4180, 0x4280, 0x4380, 0x4480, 0x4580, 0x4680, 0x4780,<br />
0x4880, 0x4980, 0x4a80, 0x4b80, 0x4c80, 0x4d80, 0x4e80, 0x4f80,<br />
0x5080, 0x5180, 0x5280, 0x5380, 0x5480, 0x5580, 0x5680, 0x5780,<br />
0x5880, 0x5980, 0x5a80, 0x5b80, 0x5c80, 0x5d80, 0x5e80, 0x5f80,<br />
0x6080, 0x6180, 0x6280, 0x6380, 0x6480, 0x6580, 0x6680, 0x6780,<br />
0x6880, 0x6980, 0x6a80, 0x6b80, 0x6c80, 0x6d80, 0x6e80, 0x6f80,<br />
0x7080, 0x7180, 0x7280, 0x7380, 0x7480, 0x7580, 0x7680, 0x7780,<br />
0x7880, 0x7980, 0x7a80, 0x7b80, 0x7c80, 0x7d80, 0x7e80, 0x7f80<br />
};<br />
<br />
left_volume = m_AKAO_VOLUME_TABLE_L[aa_parameter] * ((a8_parameter * a3_parameter * 0x7f) / 128) / 256 / 128;<br />
<br />
right_volume = m_AKAO_VOLUME_TABLE_R[aa_parameter] * ((a8_parameter * a3_paramater * 0x7f) / 128) / 256 / 128;<br />
<br />
If there is no A3 opcode in sequence (as in SENSUI.SND for example), default value 0x7f is used.<br />
<br />
If there is no A8 opcode in sequence, default value 0x7f.fe is used. (More precisely, 0x3FFF is stored in memory.)</div>
Loveemu
https://wiki.ffrtt.ru/index.php?title=FF7/PSX/Sound/Opcodes/0xa8aa&diff=5750
FF7/PSX/Sound/Opcodes/0xa8aa
2020-06-10T15:07:00Z
<p>Loveemu: </p>
<hr />
<div>== 0xA8, 0xAA, 0xA3 (Channel Volume, Pan, Volume Modifier) ==<br />
0xA8 has one 8-bit parameter, which used in calculation of base channel volume.<br />
<br />
0xAA has one 8-bit parameter, which used in calculation of channel pan (difference between left and right channel volume).<br />
<br />
0xA3 has one 8-bit parameter, which used in calculation of base channel volume.<br />
<br />
=== Volume Calculation ===<br />
<br />
// m_AKAO_VOLUME_TABLE_L[i] = 32768 - m_AKAO_VOLUME_TABLE_R[i];<br />
const uint16_t m_AKAO_VOLUME_TABLE_L[128] = {<br />
0x7f80, 0x7e80, 0x7d80, 0x7c80, 0x7b80, 0x7a80, 0x7980, 0x7880,<br />
0x7780, 0x7680, 0x7580, 0x7480, 0x7380, 0x7280, 0x7180, 0x7080,<br />
0x6f80, 0x6e80, 0x6d80, 0x6c80, 0x6b80, 0x6a80, 0x6980, 0x6880,<br />
0x6780, 0x6680, 0x6580, 0x6480, 0x6380, 0x6280, 0x6180, 0x6080,<br />
0x5f80, 0x5e80, 0x5d80, 0x5c80, 0x5b80, 0x5a80, 0x5980, 0x5880,<br />
0x5780, 0x5680, 0x5580, 0x5480, 0x5380, 0x5280, 0x5180, 0x5080,<br />
0x4f80, 0x4e80, 0x4d80, 0x4c80, 0x4b80, 0x4a80, 0x4980, 0x4880,<br />
0x4780, 0x4680, 0x4580, 0x4480, 0x4380, 0x4280, 0x4180, 0x4080,<br />
0x3f80, 0x3e80, 0x3d80, 0x3c80, 0x3b80, 0x3a80, 0x3980, 0x3880,<br />
0x3780, 0x3680, 0x3580, 0x3480, 0x3380, 0x3280, 0x3180, 0x3080,<br />
0x2f80, 0x2e80, 0x2d80, 0x2c80, 0x2b80, 0x2a80, 0x2980, 0x2880,<br />
0x2780, 0x2680, 0x2580, 0x2480, 0x2380, 0x2280, 0x2180, 0x2080,<br />
0x1f80, 0x1e80, 0x1d80, 0x1c80, 0x1b80, 0x1a80, 0x1980, 0x1880,<br />
0x1780, 0x1680, 0x1580, 0x1480, 0x1380, 0x1280, 0x1180, 0x1080,<br />
0x0f80, 0x0e80, 0x0d80, 0x0c80, 0x0b80, 0x0a80, 0x0980, 0x0880,<br />
0x0780, 0x0680, 0x0580, 0x0480, 0x0380, 0x0280, 0x0180, 0x0080<br />
};<br />
<br />
// m_AKAO_VOLUME_TABLE_R[i] = i * 256 + 128;<br />
const uint16_t m_AKAO_VOLUME_TABLE_R[128] = {<br />
0x0080, 0x0180, 0x0280, 0x0380, 0x0480, 0x0580, 0x0680, 0x0780,<br />
0x0880, 0x0980, 0x0a80, 0x0b80, 0x0c80, 0x0d80, 0x0e80, 0x0f80,<br />
0x1080, 0x1180, 0x1280, 0x1380, 0x1480, 0x1580, 0x1680, 0x1780,<br />
0x1880, 0x1980, 0x1a80, 0x1b80, 0x1c80, 0x1d80, 0x1e80, 0x1f80,<br />
0x2080, 0x2180, 0x2280, 0x2380, 0x2480, 0x2580, 0x2680, 0x2780,<br />
0x2880, 0x2980, 0x2a80, 0x2b80, 0x2c80, 0x2d80, 0x2e80, 0x2f80,<br />
0x3080, 0x3180, 0x3280, 0x3380, 0x3480, 0x3580, 0x3680, 0x3780,<br />
0x3880, 0x3980, 0x3a80, 0x3b80, 0x3c80, 0x3d80, 0x3e80, 0x3f80,<br />
0x4080, 0x4180, 0x4280, 0x4380, 0x4480, 0x4580, 0x4680, 0x4780,<br />
0x4880, 0x4980, 0x4a80, 0x4b80, 0x4c80, 0x4d80, 0x4e80, 0x4f80,<br />
0x5080, 0x5180, 0x5280, 0x5380, 0x5480, 0x5580, 0x5680, 0x5780,<br />
0x5880, 0x5980, 0x5a80, 0x5b80, 0x5c80, 0x5d80, 0x5e80, 0x5f80,<br />
0x6080, 0x6180, 0x6280, 0x6380, 0x6480, 0x6580, 0x6680, 0x6780,<br />
0x6880, 0x6980, 0x6a80, 0x6b80, 0x6c80, 0x6d80, 0x6e80, 0x6f80,<br />
0x7080, 0x7180, 0x7280, 0x7380, 0x7480, 0x7580, 0x7680, 0x7780,<br />
0x7880, 0x7980, 0x7a80, 0x7b80, 0x7c80, 0x7d80, 0x7e80, 0x7f80<br />
};<br />
<br />
left_volume = m_AKAO_VOLUME_TABLE_L[aa_parameter] * ((a8_parameter * a3_parameter * 0x7f) / 128) / 256 / 128;<br />
<br />
right_volume = m_AKAO_VOLUME_TABLE_R[aa_parameter] * ((a8_parameter * a3_paramater * 0x7f) / 128) / 256 / 128;<br />
<br />
If there is no A3 opcode in sequence (as in SENSUI.SND for example), default value 0x7f is used.</div>
Loveemu
https://wiki.ffrtt.ru/index.php?title=FF7/PSX/Sound/Opcodes/0xa8aa&diff=5749
FF7/PSX/Sound/Opcodes/0xa8aa
2020-06-10T15:06:41Z
<p>Loveemu: Add formula for generating the volume table. (linear curve)</p>
<hr />
<div>== 0xA8, 0xAA, 0xA3 (Channel Volume, Pan, Volume Modifier) ==<br />
0xA8 has one 8-bit parameter, which used in calculation of base channel volume.<br />
<br />
0xAA has one 8-bit parameter, which used in calculation of channel pan (difference between left and right channel volume).<br />
<br />
0xA3 has one 8-bit parameter, which used in calculation of base channel volume.<br />
<br />
Understanding of this opcodes isn't that easy, but here is what I have got:<br />
<br />
=== Volume Calculation ===<br />
<br />
// m_AKAO_VOLUME_TABLE_L[i] = 32768 - m_AKAO_VOLUME_TABLE_R[i];<br />
const uint16_t m_AKAO_VOLUME_TABLE_L[128] = {<br />
0x7f80, 0x7e80, 0x7d80, 0x7c80, 0x7b80, 0x7a80, 0x7980, 0x7880,<br />
0x7780, 0x7680, 0x7580, 0x7480, 0x7380, 0x7280, 0x7180, 0x7080,<br />
0x6f80, 0x6e80, 0x6d80, 0x6c80, 0x6b80, 0x6a80, 0x6980, 0x6880,<br />
0x6780, 0x6680, 0x6580, 0x6480, 0x6380, 0x6280, 0x6180, 0x6080,<br />
0x5f80, 0x5e80, 0x5d80, 0x5c80, 0x5b80, 0x5a80, 0x5980, 0x5880,<br />
0x5780, 0x5680, 0x5580, 0x5480, 0x5380, 0x5280, 0x5180, 0x5080,<br />
0x4f80, 0x4e80, 0x4d80, 0x4c80, 0x4b80, 0x4a80, 0x4980, 0x4880,<br />
0x4780, 0x4680, 0x4580, 0x4480, 0x4380, 0x4280, 0x4180, 0x4080,<br />
0x3f80, 0x3e80, 0x3d80, 0x3c80, 0x3b80, 0x3a80, 0x3980, 0x3880,<br />
0x3780, 0x3680, 0x3580, 0x3480, 0x3380, 0x3280, 0x3180, 0x3080,<br />
0x2f80, 0x2e80, 0x2d80, 0x2c80, 0x2b80, 0x2a80, 0x2980, 0x2880,<br />
0x2780, 0x2680, 0x2580, 0x2480, 0x2380, 0x2280, 0x2180, 0x2080,<br />
0x1f80, 0x1e80, 0x1d80, 0x1c80, 0x1b80, 0x1a80, 0x1980, 0x1880,<br />
0x1780, 0x1680, 0x1580, 0x1480, 0x1380, 0x1280, 0x1180, 0x1080,<br />
0x0f80, 0x0e80, 0x0d80, 0x0c80, 0x0b80, 0x0a80, 0x0980, 0x0880,<br />
0x0780, 0x0680, 0x0580, 0x0480, 0x0380, 0x0280, 0x0180, 0x0080<br />
};<br />
<br />
// m_AKAO_VOLUME_TABLE_R[i] = i * 256 + 128;<br />
const uint16_t m_AKAO_VOLUME_TABLE_R[128] = {<br />
0x0080, 0x0180, 0x0280, 0x0380, 0x0480, 0x0580, 0x0680, 0x0780,<br />
0x0880, 0x0980, 0x0a80, 0x0b80, 0x0c80, 0x0d80, 0x0e80, 0x0f80,<br />
0x1080, 0x1180, 0x1280, 0x1380, 0x1480, 0x1580, 0x1680, 0x1780,<br />
0x1880, 0x1980, 0x1a80, 0x1b80, 0x1c80, 0x1d80, 0x1e80, 0x1f80,<br />
0x2080, 0x2180, 0x2280, 0x2380, 0x2480, 0x2580, 0x2680, 0x2780,<br />
0x2880, 0x2980, 0x2a80, 0x2b80, 0x2c80, 0x2d80, 0x2e80, 0x2f80,<br />
0x3080, 0x3180, 0x3280, 0x3380, 0x3480, 0x3580, 0x3680, 0x3780,<br />
0x3880, 0x3980, 0x3a80, 0x3b80, 0x3c80, 0x3d80, 0x3e80, 0x3f80,<br />
0x4080, 0x4180, 0x4280, 0x4380, 0x4480, 0x4580, 0x4680, 0x4780,<br />
0x4880, 0x4980, 0x4a80, 0x4b80, 0x4c80, 0x4d80, 0x4e80, 0x4f80,<br />
0x5080, 0x5180, 0x5280, 0x5380, 0x5480, 0x5580, 0x5680, 0x5780,<br />
0x5880, 0x5980, 0x5a80, 0x5b80, 0x5c80, 0x5d80, 0x5e80, 0x5f80,<br />
0x6080, 0x6180, 0x6280, 0x6380, 0x6480, 0x6580, 0x6680, 0x6780,<br />
0x6880, 0x6980, 0x6a80, 0x6b80, 0x6c80, 0x6d80, 0x6e80, 0x6f80,<br />
0x7080, 0x7180, 0x7280, 0x7380, 0x7480, 0x7580, 0x7680, 0x7780,<br />
0x7880, 0x7980, 0x7a80, 0x7b80, 0x7c80, 0x7d80, 0x7e80, 0x7f80<br />
};<br />
<br />
left_volume = m_AKAO_VOLUME_TABLE_L[aa_parameter] * ((a8_parameter * a3_parameter * 0x7f) / 128) / 256 / 128;<br />
<br />
right_volume = m_AKAO_VOLUME_TABLE_R[aa_parameter] * ((a8_parameter * a3_paramater * 0x7f) / 128) / 256 / 128;<br />
<br />
If there is no A3 opcode in sequence (as in SENSUI.SND for example), default value 0x7f is used.</div>
Loveemu
https://wiki.ffrtt.ru/index.php?title=FF7/PSX/Sound/Opcodes/0xfd&diff=5748
FF7/PSX/Sound/Opcodes/0xfd
2020-06-10T14:08:10Z
<p>Loveemu: Undo revision 5747 by Loveemu (talk)</p>
<hr />
<div>== 0xFD (Unknown Yet) ==<br />
Has two 8-bit parameters.<br />
<br />
Unknown Opcode.<br />
<br />
Parameters writes to Global Configuration structure (I think :)) at 0x8009A104.<br />
<br />
1st parameter offset: 0x5a<br />
<br />
2nd parameter offset: 0x56<br />
<br />
In structure this two parameters are 16-bit.<br />
<br />
Opcode also clears two another 16-bit numbers at offsets 0x58 and 0x5c.<br />
<br />
All 4 parameters mentioned are checked in every iteration of opcode processing (this needs more investigation).</div>
Loveemu
https://wiki.ffrtt.ru/index.php?title=FF7/PSX/Sound/Opcodes/0xfd&diff=5747
FF7/PSX/Sound/Opcodes/0xfd
2020-06-10T14:06:05Z
<p>Loveemu: Blanked the page</p>
<hr />
<div></div>
Loveemu
https://wiki.ffrtt.ru/index.php?title=FF7/PSX/Sound/Opcodes/0xb4b5&diff=5746
FF7/PSX/Sound/Opcodes/0xb4b5
2020-06-09T14:57:24Z
<p>Loveemu: </p>
<hr />
<div>== LFO ==<br />
<br />
=== LFO Forms ===<br />
<br />
The two zeros are a special prefix for moving the LFO pointer, and the following value indicates the relative offset to move to.<br />
<br />
const int16_t LFO_FORM_00[] = {<br />
-0x1FFF, 0x3FFF, -0x3FFF, 0x5FFF, -0x5FFF,<br />
0x7FFF, -0x7FFF,<br />
0, 0, -2<br />
};<br />
<br />
const int16_t LFO_FORM_01[] = {<br />
0x7FFF, -0x7FFF,<br />
0, 0, -2<br />
};<br />
<br />
const int16_t LFO_FORM_02[] = {<br />
0x1FFF, 0x0000, 0x3FFF, 0x0000, 0x5FFF,<br />
0x0000, 0x7FFF,<br />
0, 0, -2<br />
};<br />
<br />
const int16_t LFO_FORM_03[] = {<br />
0x7FFF,<br />
0x0000, 0x7FFF,<br />
0, 0, -2<br />
};<br />
<br />
const int16_t LFO_FORM_04[] = {<br />
-0x1FFF, 0x0000, -0x3FFF, 0x0000, -0x5FFF,<br />
0x0000, -0x7FFF,<br />
0, 0, -2<br />
};<br />
<br />
const int16_t LFO_FORM_05[] = {<br />
-0x7FFF,<br />
0x0000, -0x7FFF,<br />
0, 0, -2<br />
};<br />
<br />
const int16_t LFO_FORM_06[] = {<br />
0x0000, 0x0500, 0x09E2, 0x12CD, 0x169E, 0x19E1, 0x1C81, 0x1E6D,<br />
0x1F9A, 0x1FFF, 0x1F9C, 0x1E71, 0x1C86, 0x19E8, 0x16A7, 0x12D7,<br />
0x0E90, 0x09EE, 0x050D, 0x0000, -0x04F4, -0x09D6, -0x0E7A, -0x12C3,<br />
-0x1696, -0x19DA, -0x1C7C, -0x1E6A, -0x1F99, -0x2000, -0x1F9F, -0x1E76,<br />
-0x1C8D, -0x19F1, -0x16B1, -0x12E3, -0x0E9D, -0x09FC, -0x051B, 0x0000,<br />
0x0A01, 0x13C4, 0x259A, 0x2D3C, 0x33C2, 0x3902, 0x3CDA, 0x3F34,<br />
0x3FFF, 0x3F38, 0x3CE2, 0x390D, 0x33D1, 0x2D4F, 0x25AF, 0x1D21,<br />
0x13DD, 0x0A1B, 0x0000, -0x09E8, -0x13AC, -0x1CF4, -0x2585, -0x2D2B,<br />
-0x33B3, -0x38F7, -0x3CD3, -0x3F31, -0x4000, -0x3F3D, -0x3CEB, -0x391A,<br />
-0x33E1, -0x2D62, -0x25C5, -0x1D3A, -0x13F7, -0x0A36, 0x0000, 0x0F02,<br />
0x1DA6, 0x3867, 0x43DA, 0x4DA3, 0x5583, 0x5B47, 0x5ECE, 0x5FFF,<br />
0x5ED4, 0x5B53, 0x5594, 0x4DBA, 0x43F6, 0x3886, 0x2BB2, 0x1DCB,<br />
0x0F29, 0x0000, -0x0EDC, -0x1D82, -0x2B6E, -0x3848, -0x43C0, -0x4D8D,<br />
-0x5572, -0x5B3D, -0x5EC9, -0x6000, -0x5EDC, -0x5B61, -0x55A7, -0x4DD2,<br />
-0x4413, -0x38A7, -0x2BD7, -0x1DF2, -0x0F51,<br />
0x0000, 0x1403, 0x2788, 0x4B34, 0x5A79, 0x6784, 0x7204, 0x79B5,<br />
0x7E68, 0x7FFF, 0x7E71, 0x79C5, 0x721B, 0x67A3, 0x5A9E, 0x4B5E,<br />
0x3A43, 0x27BA, 0x1437, 0x0000, -0x13D0, -0x2758, -0x39E7, -0x4B0A,<br />
-0x5A55, -0x6766, -0x71ED, -0x79A6, -0x7E61, -0x8000, -0x7E7A, -0x79D6,<br />
-0x7234, -0x67C2, -0x5AC3, -0x4B89, -0x3A73, -0x27ED, -0x146B,<br />
0, 0, -39<br />
};<br />
<br />
const int16_t LFO_FORM_07[] = {<br />
0x0000, 0x1403, 0x2788, 0x4B34, 0x5A79, 0x6784, 0x7204, 0x79B5,<br />
0x7E68, 0x7FFF, 0x7E71, 0x79C5, 0x721B, 0x67A3, 0x5A9E, 0x4B5E,<br />
0x3A43, 0x27BA, 0x1437, 0x0000, -0x13D0, -0x2758, -0x39E7, -0x4B0A,<br />
-0x5A55, -0x6766, -0x71ED, -0x79A6, -0x7E61, -0x8000, -0x7E7A, -0x79D6,<br />
-0x7234, -0x67C2, -0x5AC3, -0x4B89, -0x3A73, -0x27ED, -0x146B,<br />
0, 0, -39<br />
};<br />
<br />
const int16_t LFO_FORM_0A[] = {<br />
0x0000, 0x09E2, 0x12CD, 0x19E1, 0x1E6D, 0x1FFF, 0x1E71, 0x19E8,<br />
0x12D7, 0x09EE, 0x000D, -0x09D6, -0x12C3, -0x19DA, -0x1E6A, -0x2000,<br />
-0x1E76, -0x19F1, -0x12E3, -0x09FC, 0x0000, 0x13C4, 0x259A, 0x33C2,<br />
0x3CDA, 0x3FFF, 0x3CE2, 0x33D1, 0x25AF, 0x13DD, 0x001A, -0x13AC,<br />
-0x2585, -0x33B3, -0x3CD3, -0x4000, -0x3CEB, -0x33E1, -0x25C5, -0x13F7,<br />
0x0000, 0x1DA6, 0x3867, 0x4DA3, 0x5B47, 0x5FFF, 0x5B53, 0x4DBA,<br />
0x3886, 0x1DCB, 0x0027, -0x1D82, -0x3848, -0x4D8D, -0x5B3D, -0x6000,<br />
-0x5B61, -0x4DD2, -0x38A7, -0x1DF2,<br />
0x0000, 0x2788, 0x4B34, 0x6784, 0x79B5, 0x7FFF, 0x79C5, 0x67A3,<br />
0x4B5E, 0x27BA, 0x0034, -0x2758, -0x4B0A, -0x6766, -0x79A6, -0x8000,<br />
-0x79D6, -0x67C2, -0x4B89, -0x27ED,<br />
0, 0, -20<br />
};<br />
<br />
const int16_t LFO_FORM_0B[] = {<br />
0x0000, 0x2788, 0x4B34, 0x6784, 0x79B5, 0x7FFF, 0x79C5, 0x67A3,<br />
0x4B5E, 0x27BA, 0x0034, -0x2758, -0x4B0A, -0x6766, -0x79A6, -0x8000,<br />
-0x79D6, -0x67C2, -0x4B89, -0x27ED,<br />
0, 0, -20<br />
};<br />
<br />
const int16_t LFO_FORM_08[] = {<br />
0x0000, 0x07FF, 0x0FFF, 0x17FF, 0x1FFF, 0x17FF, 0x0FFF, 0x07FF,<br />
0x0000, -0x07FF, -0x0FFF, -0x17FF, -0x1FFF, -0x17FF, -0x0FFF, -0x07FF,<br />
0x0000, 0x0FFF, 0x1FFF, 0x2FFF, 0x3FFF, 0x2FFF, 0x1FFF, 0x0FFF,<br />
0x0000, -0x0FFF, -0x1FFF, -0x2FFF, -0x3FFF, -0x2FFF, -0x1FFF, -0x0FFF,<br />
0x0000, 0x17FF, 0x2FFF, 0x47FF, 0x5FFF, 0x47FF, 0x2FFF, 0x17FF,<br />
0x0000, -0x17FF, -0x2FFF, -0x47FF, -0x5FFF, -0x47FF, -0x2FFF, -0x17FF,<br />
0x0000, 0x1FFF, 0x3FFF, 0x5FFF, 0x7FFF, 0x5FFF, 0x3FFF, 0x1FFF,<br />
0x0000, -0x1FFF, -0x3FFF, -0x5FFF, -0x7FFF, -0x5FFF, -0x3FFF, -0x1FFF,<br />
0, 0, -16<br />
};<br />
<br />
const int16_t LFO_FORM_09[] = {<br />
0x0000, 0x1FFF, 0x3FFF, 0x5FFF, 0x7FFF, 0x5FFF, 0x3FFF, 0x1FFF,<br />
0x0000, -0x1FFF, -0x3FFF, -0x5FFF, -0x7FFF, -0x5FFF, -0x3FFF, -0x1FFF,<br />
0, 0, -16<br />
};<br />
<br />
const int16_t LFO_FORM_0C[] = {<br />
0x0000, 0x31FD, 0x7D05, -0x0A03, -0x1312, 0x793C, 0x75D0, 0x07FC,<br />
-0x0BEF, -0x3D0B, 0x660F, 0x330E, 0x3FEA, -0x411F, -0x73EE, 0x1821,<br />
-0x5005, 0x4A00, -0x2C19, -0x0B0B, -0x1EC9, -0x182D, 0x520D, 0x1103,<br />
-0x5121, 0x4AF8, 0x0746, 0x70F4, -0x713F, -0x68E7, 0x3512, -0x0A00,<br />
0x1B00, -0x4B17, 0x3B1E, -0x51EB, -0x6338, 0x65F9, -0x3CDD, 0x71F8,<br />
0x2CF1, -0x59FC, -0x6D04, -0x36F2, -0x4FF7, 0x10E5, 0x0804, -0x7FFF,<br />
0x12FA, 0x1118, -0x18F7, 0x47F8, -0x6A27, -0x22E4, 0x1B09, 0x0BF4,<br />
0x7BFC, 0x20FF, -0x6BFC, 0x7DFC, -0x750B, -0x48E9, 0x74F9, 0x2AFC,<br />
-0x22FA, -0x280D, -0x0B03, 0x0608, -0x0DE8, 0x69DF, -0x43F9, 0x4AF7,<br />
-0x7615, -0x44D9, 0x1109, 0x7FEF, 0x3615, -0x1333, 0x7621, -0x67EB,<br />
0x56CF, -0x2BFA, 0x3322, -0x201A, -0x50F6, -0x460B, -0x31F8, 0x5D05,<br />
-0x4012, -0x0FE6, 0x20E8, -0x60EA, -0x730E, -0x3D19, -0x2DD2, -0x39FF,<br />
-0x4630, -0x7EF4, 0x4323, 0x28DD, -0x6909, 0x5C3C, -0x6022, -0x5118,<br />
-0x49E5, 0x3EF3, 0x1408, -0x2517, 0x2C0B, -0x4ECD, -0x571F, 0x05DA,<br />
0x0914, 0x4E22, -0x0018, -0x780F, 0x21F0, -0x72DB, 0x7DFC, 0x1CF0,<br />
0x5E11, 0x3DE8, -0x38F6, -0x70E9, -0x0010, 0x6A0D, -0x001D, 0x12F3,<br />
0x041F, 0x780C, -0x3B11, 0x5B02, 0x3D02, 0x02F2, 0x1519, -0x252B,<br />
-0x42F7, -0x6DE7, -0x0AFD, 0x62DD, 0x3806, 0x0F26, -0x5705, -0x1F02,<br />
-0x091D, 0x0E02, 0x0210, 0x4406, -0x6B2C, -0x2EF6, -0x57BA, 0x10F1,<br />
0x1ACC, -0x4203, 0x1A30, -0x5F15, 0x5FEA, -0x40F0, -0x4411, -0x20E5,<br />
-0x3DF4, 0x2AE0, 0x3EF2, -0x51D9, 0x5001, -0x0623, 0x3611, -0x52E6,<br />
0x07DF, 0x6D05, 0x1A0D, -0x4925, 0x6D2B, 0x3607, -0x0434, 0x4208,<br />
0x0F21, 0x36F6, -0x37FA, 0x0603, -0x0229, 0x7817, 0x0605, -0x50F5,<br />
-0x6A04, 0x10EC, -0x58F2, -0x520D, 0x660F, -0x420E, -0x2108, -0x1BDF,<br />
-0x4E19, -0x0313, 0x5B1C, -0x5EF7, -0x330E, -0x0A0D, -0x6505, -0x4BE9,<br />
-0x6D18, 0x7F08, 0x4BFA, -0x7603, 0x3C1C, -0x0311, -0x0D25, 0x4A1D,<br />
0x671D, -0x2901, 0x65DA, -0x0E04, 0x6E0A, 0x0A0C, 0x11F8, 0x4A02,<br />
0x5BFC, -0x14FA, -0x5A13, 0x30E6, -0x7FEF, -0x2DCC, 0x08F8, 0x43DC,<br />
-0x09F7, -0x590E, -0x65F3, 0x7006, -0x0A16, -0x6304, -0x7EE2, -0x521A,<br />
-0x19F2, -0x6A09, -0x4CFC, -0x6301, -0x1016, -0x0AE7, -0x0600, 0x3AF6,<br />
-0x382B, 0x2722, -0x44C8, 0x43D1, 0x77ED, 0x4908, -0x31FE, -0x54F1,<br />
0x3DEB, -0x24F6, 0x6401, 0x3FF9, 0x76F2, -0x6CF7, -0x2DF1, 0x74E5,<br />
0, 0, -256<br />
};<br />
<br />
const int16_t *LFO_FORMS[] = {<br />
LFO_FORM_00, // 0x00<br />
LFO_FORM_01, // 0x01<br />
LFO_FORM_02, // 0x02<br />
LFO_FORM_03, // 0x03<br />
LFO_FORM_04, // 0x04<br />
LFO_FORM_05, // 0x05<br />
LFO_FORM_06, // 0x06<br />
LFO_FORM_07, // 0x07<br />
LFO_FORM_08, // 0x08<br />
LFO_FORM_09, // 0x09<br />
LFO_FORM_0A, // 0x0a<br />
LFO_FORM_0B, // 0x0b<br />
LFO_FORM_0C, // 0x0c<br />
LFO_FORM_09, // 0x0d<br />
LFO_FORM_08, // 0x0e<br />
LFO_FORM_09 // 0x0f<br />
};</div>
Loveemu
https://wiki.ffrtt.ru/index.php?title=FF7/PSX/Sound/Opcodes/0xb4b5&diff=5745
FF7/PSX/Sound/Opcodes/0xb4b5
2020-06-09T14:53:11Z
<p>Loveemu: Add raw LFO data. In the future it will be desirable to add waveform visualizations and detailed explanations.</p>
<hr />
<div>== LFO ==<br />
<br />
=== LFO Forms ===<br />
<br />
The two zeros are a special prefix for moving the LFO pointer, and the following value indicates the relative offset to move to.<br />
<br />
const int16_t LFO_FORM_00[] = {<br />
-0x1FFF, 0x3FFF, -0x3FFF, 0x5FFF, -0x5FFF,<br />
0x7FFF, -0x7FFF,<br />
0, 0, -2<br />
};<br />
<br />
const int16_t LFO_FORM_01[] = {<br />
0x7FFF, -0x7FFF,<br />
0, 0, -2<br />
};<br />
<br />
const int16_t LFO_FORM_02[] = {<br />
0x1FFF, 0x0000, 0x3FFF, 0x0000, 0x5FFF,<br />
0x0000, 0x7FFF,<br />
0, 0, -2<br />
};<br />
<br />
const int16_t LFO_FORM_03[] = {<br />
0x7FFF,<br />
0x0000, 0x7FFF,<br />
0, 0, -2<br />
};<br />
<br />
const int16_t LFO_FORM_04[] = {<br />
-0x1FFF, 0x0000, -0x3FFF, 0x0000, -0x5FFF,<br />
0x0000, -0x7FFF,<br />
0, 0, -2<br />
};<br />
<br />
const int16_t LFO_FORM_05[] = {<br />
-0x7FFF,<br />
0x0000, -0x7FFF,<br />
0, 0, -2<br />
};<br />
<br />
const int16_t LFO_FORM_06[] = {<br />
0x0000, 0x0500, 0x09E2, 0x12CD, 0x169E, 0x19E1, 0x1C81, 0x1E6D,<br />
0x1F9A, 0x1FFF, 0x1F9C, 0x1E71, 0x1C86, 0x19E8, 0x16A7, 0x12D7,<br />
0x0E90, 0x09EE, 0x050D, 0x0000, -0x04F4, -0x09D6, -0x0E7A, -0x12C3,<br />
-0x1696, -0x19DA, -0x1C7C, -0x1E6A, -0x1F99, -0x2000, -0x1F9F, -0x1E76,<br />
-0x1C8D, -0x19F1, -0x16B1, -0x12E3, -0x0E9D, -0x09FC, -0x051B, 0x0000,<br />
0x0A01, 0x13C4, 0x259A, 0x2D3C, 0x33C2, 0x3902, 0x3CDA, 0x3F34,<br />
0x3FFF, 0x3F38, 0x3CE2, 0x390D, 0x33D1, 0x2D4F, 0x25AF, 0x1D21,<br />
0x13DD, 0x0A1B, 0x0000, -0x09E8, -0x13AC, -0x1CF4, -0x2585, -0x2D2B,<br />
-0x33B3, -0x38F7, -0x3CD3, -0x3F31, -0x4000, -0x3F3D, -0x3CEB, -0x391A,<br />
-0x33E1, -0x2D62, -0x25C5, -0x1D3A, -0x13F7, -0x0A36, 0x0000, 0x0F02,<br />
0x1DA6, 0x3867, 0x43DA, 0x4DA3, 0x5583, 0x5B47, 0x5ECE, 0x5FFF,<br />
0x5ED4, 0x5B53, 0x5594, 0x4DBA, 0x43F6, 0x3886, 0x2BB2, 0x1DCB,<br />
0x0F29, 0x0000, -0x0EDC, -0x1D82, -0x2B6E, -0x3848, -0x43C0, -0x4D8D,<br />
-0x5572, -0x5B3D, -0x5EC9, -0x6000, -0x5EDC, -0x5B61, -0x55A7, -0x4DD2,<br />
-0x4413, -0x38A7, -0x2BD7, -0x1DF2, -0x0F51,<br />
0x0000, 0x1403, 0x2788, 0x4B34, 0x5A79, 0x6784, 0x7204, 0x79B5,<br />
0x7E68, 0x7FFF, 0x7E71, 0x79C5, 0x721B, 0x67A3, 0x5A9E, 0x4B5E,<br />
0x3A43, 0x27BA, 0x1437, 0x0000, -0x13D0, -0x2758, -0x39E7, -0x4B0A,<br />
-0x5A55, -0x6766, -0x71ED, -0x79A6, -0x7E61, -0x8000, -0x7E7A, -0x79D6,<br />
-0x7234, -0x67C2, -0x5AC3, -0x4B89, -0x3A73, -0x27ED, -0x146B,<br />
0, 0, -39<br />
};<br />
<br />
const int16_t LFO_FORM_07[] = {<br />
0x0000, 0x1403, 0x2788, 0x4B34, 0x5A79, 0x6784, 0x7204, 0x79B5,<br />
0x7E68, 0x7FFF, 0x7E71, 0x79C5, 0x721B, 0x67A3, 0x5A9E, 0x4B5E,<br />
0x3A43, 0x27BA, 0x1437, 0x0000, -0x13D0, -0x2758, -0x39E7, -0x4B0A,<br />
-0x5A55, -0x6766, -0x71ED, -0x79A6, -0x7E61, -0x8000, -0x7E7A, -0x79D6,<br />
-0x7234, -0x67C2, -0x5AC3, -0x4B89, -0x3A73, -0x27ED, -0x146B,<br />
0, 0, -39<br />
};<br />
<br />
const int16_t LFO_FORM_0A[] = {<br />
0x0000, 0x09E2, 0x12CD, 0x19E1, 0x1E6D, 0x1FFF, 0x1E71, 0x19E8,<br />
0x12D7, 0x09EE, 0x000D, -0x09D6, -0x12C3, -0x19DA, -0x1E6A, -0x2000,<br />
-0x1E76, -0x19F1, -0x12E3, -0x09FC, 0x0000, 0x13C4, 0x259A, 0x33C2,<br />
0x3CDA, 0x3FFF, 0x3CE2, 0x33D1, 0x25AF, 0x13DD, 0x001A, -0x13AC,<br />
-0x2585, -0x33B3, -0x3CD3, -0x4000, -0x3CEB, -0x33E1, -0x25C5, -0x13F7,<br />
0x0000, 0x1DA6, 0x3867, 0x4DA3, 0x5B47, 0x5FFF, 0x5B53, 0x4DBA,<br />
0x3886, 0x1DCB, 0x0027, -0x1D82, -0x3848, -0x4D8D, -0x5B3D, -0x6000,<br />
-0x5B61, -0x4DD2, -0x38A7, -0x1DF2,<br />
0x0000, 0x2788, 0x4B34, 0x6784, 0x79B5, 0x7FFF, 0x79C5, 0x67A3,<br />
0x4B5E, 0x27BA, 0x0034, -0x2758, -0x4B0A, -0x6766, -0x79A6, -0x8000,<br />
-0x79D6, -0x67C2, -0x4B89, -0x27ED,<br />
0, 0, -20<br />
};<br />
<br />
const int16_t LFO_FORM_0B[] = {<br />
0x0000, 0x2788, 0x4B34, 0x6784, 0x79B5, 0x7FFF, 0x79C5, 0x67A3,<br />
0x4B5E, 0x27BA, 0x0034, -0x2758, -0x4B0A, -0x6766, -0x79A6, -0x8000,<br />
-0x79D6, -0x67C2, -0x4B89, -0x27ED,<br />
0, 0, -20<br />
};<br />
<br />
const int16_t LFO_FORM_08[] = {<br />
0x0000, 0x07FF, 0x0FFF, 0x17FF, 0x1FFF, 0x17FF, 0x0FFF, 0x07FF,<br />
0x0000, -0x07FF, -0x0FFF, -0x17FF, -0x1FFF, -0x17FF, -0x0FFF, -0x07FF,<br />
0x0000, 0x0FFF, 0x1FFF, 0x2FFF, 0x3FFF, 0x2FFF, 0x1FFF, 0x0FFF,<br />
0x0000, -0x0FFF, -0x1FFF, -0x2FFF, -0x3FFF, -0x2FFF, -0x1FFF, -0x0FFF,<br />
0x0000, 0x17FF, 0x2FFF, 0x47FF, 0x5FFF, 0x47FF, 0x2FFF, 0x17FF,<br />
0x0000, -0x17FF, -0x2FFF, -0x47FF, -0x5FFF, -0x47FF, -0x2FFF, -0x17FF,<br />
0x0000, 0x1FFF, 0x3FFF, 0x5FFF, 0x7FFF, 0x5FFF, 0x3FFF, 0x1FFF,<br />
0x0000, -0x1FFF, -0x3FFF, -0x5FFF, -0x7FFF, -0x5FFF, -0x3FFF, -0x1FFF,<br />
0, 0, -16<br />
};<br />
<br />
const int16_t LFO_FORM_09[] = {<br />
0x0000, 0x1FFF, 0x3FFF, 0x5FFF, 0x7FFF, 0x5FFF, 0x3FFF, 0x1FFF,<br />
0x0000, -0x1FFF, -0x3FFF, -0x5FFF, -0x7FFF, -0x5FFF, -0x3FFF, -0x1FFF,<br />
0, 0, -16<br />
};<br />
<br />
const int16_t LFO_FORM_0C[] = {<br />
0x0000, 0x31FD, 0x7D05, -0x0A03, -0x1312, 0x793C, 0x75D0, 0x07FC,<br />
-0x0BEF, -0x3D0B, 0x660F, 0x330E, 0x3FEA, -0x411F, -0x73EE, 0x1821,<br />
-0x5005, 0x4A00, -0x2C19, -0x0B0B, -0x1EC9, -0x182D, 0x520D, 0x1103,<br />
-0x5121, 0x4AF8, 0x0746, 0x70F4, -0x713F, -0x68E7, 0x3512, -0x0A00,<br />
0x1B00, -0x4B17, 0x3B1E, -0x51EB, -0x6338, 0x65F9, -0x3CDD, 0x71F8,<br />
0x2CF1, -0x59FC, -0x6D04, -0x36F2, -0x4FF7, 0x10E5, 0x0804, -0x7FFF,<br />
0x12FA, 0x1118, -0x18F7, 0x47F8, -0x6A27, -0x22E4, 0x1B09, 0x0BF4,<br />
0x7BFC, 0x20FF, -0x6BFC, 0x7DFC, -0x750B, -0x48E9, 0x74F9, 0x2AFC,<br />
-0x22FA, -0x280D, -0x0B03, 0x0608, -0x0DE8, 0x69DF, -0x43F9, 0x4AF7,<br />
-0x7615, -0x44D9, 0x1109, 0x7FEF, 0x3615, -0x1333, 0x7621, -0x67EB,<br />
0x56CF, -0x2BFA, 0x3322, -0x201A, -0x50F6, -0x460B, -0x31F8, 0x5D05,<br />
-0x4012, -0x0FE6, 0x20E8, -0x60EA, -0x730E, -0x3D19, -0x2DD2, -0x39FF,<br />
-0x4630, -0x7EF4, 0x4323, 0x28DD, -0x6909, 0x5C3C, -0x6022, -0x5118,<br />
-0x49E5, 0x3EF3, 0x1408, -0x2517, 0x2C0B, -0x4ECD, -0x571F, 0x05DA,<br />
0x0914, 0x4E22, -0x0018, -0x780F, 0x21F0, -0x72DB, 0x7DFC, 0x1CF0,<br />
0x5E11, 0x3DE8, -0x38F6, -0x70E9, -0x0010, 0x6A0D, -0x001D, 0x12F3,<br />
0x041F, 0x780C, -0x3B11, 0x5B02, 0x3D02, 0x02F2, 0x1519, -0x252B,<br />
-0x42F7, -0x6DE7, -0x0AFD, 0x62DD, 0x3806, 0x0F26, -0x5705, -0x1F02,<br />
-0x091D, 0x0E02, 0x0210, 0x4406, -0x6B2C, -0x2EF6, -0x57BA, 0x10F1,<br />
0x1ACC, -0x4203, 0x1A30, -0x5F15, 0x5FEA, -0x40F0, -0x4411, -0x20E5,<br />
-0x3DF4, 0x2AE0, 0x3EF2, -0x51D9, 0x5001, -0x0623, 0x3611, -0x52E6,<br />
0x07DF, 0x6D05, 0x1A0D, -0x4925, 0x6D2B, 0x3607, -0x0434, 0x4208,<br />
0x0F21, 0x36F6, -0x37FA, 0x0603, -0x0229, 0x7817, 0x0605, -0x50F5,<br />
-0x6A04, 0x10EC, -0x58F2, -0x520D, 0x660F, -0x420E, -0x2108, -0x1BDF,<br />
-0x4E19, -0x0313, 0x5B1C, -0x5EF7, -0x330E, -0x0A0D, -0x6505, -0x4BE9,<br />
-0x6D18, 0x7F08, 0x4BFA, -0x7603, 0x3C1C, -0x0311, -0x0D25, 0x4A1D,<br />
0x671D, -0x2901, 0x65DA, -0x0E04, 0x6E0A, 0x0A0C, 0x11F8, 0x4A02,<br />
0x5BFC, -0x14FA, -0x5A13, 0x30E6, -0x7FEF, -0x2DCC, 0x08F8, 0x43DC,<br />
-0x09F7, -0x590E, -0x65F3, 0x7006, -0x0A16, -0x6304, -0x7EE2, -0x521A,<br />
-0x19F2, -0x6A09, -0x4CFC, -0x6301, -0x1016, -0x0AE7, -0x0600, 0x3AF6,<br />
-0x382B, 0x2722, -0x44C8, 0x43D1, 0x77ED, 0x4908, -0x31FE, -0x54F1,<br />
0x3DEB, -0x24F6, 0x6401, 0x3FF9, 0x76F2, -0x6CF7, -0x2DF1, 0x74E5,<br />
0, 0, -256<br />
};<br />
<br />
const int16_t *LFO_FORMS[] = {<br />
LFO_FORM_00, // 0x00<br />
LFO_FORM_01, // 0x01<br />
LFO_FORM_02, // 0x02<br />
LFO_FORM_03, // 0x03<br />
LFO_FORM_04, // 0x04<br />
LFO_FORM_05, // 0x05<br />
LFO_FORM_06, // 0x06<br />
LFO_FORM_07, // 0x07<br />
LFO_FORM_08, // 0x08<br />
LFO_FORM_09, // 0x09<br />
LFO_FORM_0a, // 0x0a<br />
LFO_FORM_0b, // 0x0b<br />
LFO_FORM_0c, // 0x0c<br />
LFO_FORM_09, // 0x0d<br />
LFO_FORM_08, // 0x0e<br />
LFO_FORM_09 // 0x0f<br />
};</div>
Loveemu
https://wiki.ffrtt.ru/index.php?title=FF7/PSX/Sound/Code_Map&diff=5743
FF7/PSX/Sound/Code Map
2020-06-07T15:31:24Z
<p>Loveemu: </p>
<hr />
<div>= Code Map =<br />
<br />
Introduces functions, variables and data related to sound, contained in SCUS_941.63 (game program of US version). Note that all symbol names below are for convenience only.<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x800293D0<br />
|void _AkaoSpuTransferCallback(void)<br />
|<br />
|-<br />
|0x800293F4<br />
|void _AkaoSpuSetTransferCallback(void)<br />
|<br />
|-<br />
|0x80029424<br />
|unsigned int _AkaoTransferSamples(const unsigned char *addr, unsigned int size)<br />
|<br />
|-<br />
|0x800294A4<br />
|void _AkaoWaitForSpuTransfer(void)<br />
|<br />
|-<br />
|0x800294BC<br />
|void _AkaoReset(void)<br />
|<br />
|-<br />
|0x800297A4<br />
|void AkaoLoadInstrumentSet(const sturct AkaoSampleSet *sampleSet, const struct AkaoInstrumentAttr *instrumentSet)<br />
|Load standard instrument set<br />
<br />
''sampleSet'': corresponding to SOUND/INSTR.ALL<br />
<br />
''instrumentSet'': corresponding to SOUND/INSTR.DAT<br />
<br />
This function is called transparently from 0x8002988C.<br />
|-<br />
|0x80029818<br />
|void AkaoLoadInstrumentSet2(const sturct AkaoSampleSet *sampleSet, const struct AkaoInstrumentAttr *instrumentSet)<br />
|Load additional instrument set<br />
<br />
''sampleSet'': corresponding to SOUND/INSTR2.ALL<br />
<br />
''instrumentSet'': corresponding to SOUND/INSTR2.DAT<br />
|-<br />
|0x8002988C<br />
|void AkaoInitialize(const sturct AkaoSampleSet *sampleSet, const struct AkaoInstrumentAttr *instrumentSet)<br />
|Initialize sound driver and load initial instruments<br />
<br />
''sampleSet'': corresponding to SOUND/INSTR.ALL<br />
<br />
''instrumentSet'': corresponding to SOUND/INSTR.DAT<br />
|-<br />
|0x800299C8<br />
|void AkaoDeinitialize(void)<br />
|Deinitialize sound driver<br />
|-<br />
|0x80029AF0<br />
|void AkaoSetReverbMode(int mode)<br />
|<br />
|-<br />
|0x80029B78<br />
|void _AkaoTransferSeqBody(const unsigned char *data, int size)<br />
|<br />
|-<br />
|0x80029C48<br />
|void _AkaoLoadTracks(void)<br />
|<br />
|-<br />
|0x8002DA30<br />
|void AkaoNewMessage(struct AkaoMessage **ppMessage)<br />
|<br />
|-<br />
|0x8002DA7C<br />
|int AkaoPostMessage(void)<br />
|Post a new command message to the queue (with some wrapped processing)<br />
<br />
The message data comes from a global variable at 0x8009A000.<br />
<br />
Return value depends on the content of the message data.<br />
<br />
<br />
'''Opcode 0x10'''<br />
<br />
Load and start playing new [[FF7/PSX/Sound/AKAO sequence|AKAO sequence]]<br />
<br />
Returns: 0 for success, 1 for already loaded, and -1 for invalid signature<br />
<br />
<br />
'''Opcode 0x92'''<br />
<br />
Set value to the condition variable used by Opcode 0xEF.<br />
|-<br />
|0x8002E1A8<br />
|void _AkaoDispatchMessages(void)<br />
|<br />
|-<br />
|0x8002E23C<br />
|void _AkaoWriteSpuRegisters(int voiceNum, struct AkaoSpuVoiceAttr *attr)<br />
|<br />
|-<br />
|0x8002E478<br />
|void _AkaoDspOnTick(struct AkaoPlayerTrack *track, struct AkaoPlayer *player, int voiceMask)<br />
|<br />
|-<br />
|0x8002ED34<br />
|void _AkaoCalculateVolumeAndPitch(struct AkaoPlayerTrack *track, int voiceMask, int voiceNum)<br />
|<br />
|-<br />
|0x8002F24C<br />
|void _AkaoCalculateVolumeAndPitch2(struct AkaoPlayerTrack *track, int voiceMask)<br />
|<br />
|-<br />
|0x8002F738<br />
|void _AkaoDspOverlayVoice(struct AkaoPlayerTrack *track, int unknownVoiceMask, int voiceNum)<br />
|<br />
|-<br />
|0x8002F848<br />
|void _AkaoDspMain(void)<br />
|<br />
|-<br />
|0x8002FF4C<br />
|void _AkaoSpuNoiseVoice(void)<br />
|<br />
|-<br />
|0x80030038<br />
|void _AkaoSpuReverbVoice(void)<br />
|<br />
|-<br />
|0x80030148<br />
|void _AkaoSpuPitchLFOVoice(void)<br />
|<br />
|-<br />
|0x80030234<br />
|int _AkaoTimerCallback(void)<br />
|Sound callback event that is periodically triggered by root counter 2<br />
|-<br />
|0x800308D4<br />
|void _AkaoMain(void)<br />
|<br />
|-<br />
|0x80030E7C<br />
|void _AkaoDispatchVoice(struct AkaoPlayerTrack *track, struct AkaoPlayer *player, int voiceMask)<br />
|Dispatch voice opcodes until the next note or end of track<br />
|-<br />
|0x80031820<br />
|void AkaoSetInstrument(struct AkaoPlayerTrack *track, unsigned short progNumber)<br />
|<br />
|-<br />
|0x800318BC<br />
|int _AkaoReadNextNote(struct AkaoPlayerTrack *track)<br />
|<br />
|-<br />
|0x80031A70<br />
|int _AkaoFindNextEndPoint(struct AkaoPlayerTrack *track)<br />
|<br />
|-<br />
|0x80049548<br />
|void (* const MESSAGE_HANDLERS[256])(struct AkaoMessage *)<br />
|<br />
|-<br />
|0x80049948<br />
|const unsigned char VOICE_OPCODE_LENGTHS[0x60]<br />
|Length table for voice opcodes 0xa0-0xff<br />
<br />
0 for end of track and branches<br />
|-<br />
|0x80049AA8<br />
|void (* const VOICE_OPCODES[0x60])(struct AkaoPlayerTrack *, struct AkaoPlayer *, int)<br />
|Address table for voice opcodes 0xa0-0xff<br />
|-<br />
|0x80049C28<br />
|const unsigned short DELTA_TIME_TABLE[11];<br />
|<br />
|-<br />
|0x80049C44<br />
|const unsigned short VOLUME_TABLE_L[128]<br />
|See [[FF7/PSX/Sound/Opcodes/0xa8aa|Opcode 0xAA]] for volume balance calculation<br />
|-<br />
|0x80049E44<br />
|const unsigned short VOLUME_TABLE_R[128]<br />
|See [[FF7/PSX/Sound/Opcodes/0xa8aa|Opcode 0xAA]] for volume balance calculation<br />
|-<br />
|0x8004A5CC<br />
|const short *LFO_FORMS[16]<br />
|<br />
|-<br />
|0x8004A60C<br />
|const unsigned char EMPTY_ADPCM[32]<br />
|<br />
|-<br />
|0x80063010<br />
|int g_AkaoNumQueuedMessages<br />
|<br />
|-<br />
|0x80081DC8<br />
|AkaoMessage g_AkaoMessageQueue[]<br />
|<br />
|-<br />
|0x80083580<br />
|unsigned char g_AkaoSeqData[]<br />
|RAM area to load AKAO sequence data<br />
|-<br />
|0x8009A000<br />
|AkaoMessage g_AkaoMessage<br />
|Message data to be posted. Processed by the function 0x8002DA7C<br />
|}<br />
<br />
== Runtime Library Functions ==<br />
<br />
=== LIBSPU ===<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x80036298<br />
|void SpuInit(void)<br />
|<br />
|-<br />
|0x80036FFC<br />
|long SpuInitMalloc(long num, char *top)<br />
|<br />
|-<br />
|0x800373AC<br />
|long SpuMallocWithStartAddr(unsigned long addr, long size)<br />
|<br />
|-<br />
|0x80037964<br />
|unsigned long SpuSetNoiseVoice(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x80037B90<br />
|long SpuSetNoiseClock(long n_clock)<br />
|<br />
|-<br />
|0x80037BE0<br />
|unsigned long SpuRead(unsigned char *addr, unsigned long size)<br />
|<br />
|-<br />
|0x80037C40<br />
|long SpuSetReverb(long on_off)<br />
|<br />
|-<br />
|0x80037D90<br />
|long SpuGetReverb(void)<br />
|<br />
|-<br />
|0x80037E1C<br />
|long SpuSetReverbModeParam(SpuReverbAttr *attr)<br />
|<br />
|-<br />
|0x800387FC<br />
|void SpuGetReverbModeParam (SpuReverbAttr *attr)<br />
|<br />
|-<br />
|0x8003884C<br />
|long SpuSetReverbDepth(SpuReverbAttr *attr)<br />
|<br />
|-<br />
|0x800388C4<br />
|unsigned long SpuSetReverbVoice(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x800388E8<br />
|long SpuClearReverbWorkArea(long mode)<br />
|<br />
|-<br />
|0x80038A84<br />
|long SpuSetIRQ(long on_off)<br />
|<br />
|-<br />
|0x80038BC4<br />
|unsigned long SpuSetIRQAddr(unsigned long addr)<br />
|<br />
|-<br />
|0x80038C04<br />
|SpuIRQCallbackProc SpuSetIRQCallback(SpuIRQCallbackProc func)<br />
|<br />
|-<br />
|0x80038C6C<br />
|void SpuSetKey(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x80038F04<br />
|unsigned long SpuWrite(unsigned char *addr, unsigned long size)<br />
|<br />
|-<br />
|0x80038F64<br />
|unsigned long SpuSetTransferStartAddr(unsigned long addr)<br />
|<br />
|-<br />
|0x80038FB8<br />
|long SpuSetTransferMode(long mode)<br />
|<br />
|-<br />
|0x80038FEC<br />
|SpuTransferCallbackProc SpuSetTransferCallback(SpuTransferCallbackProc func)<br />
|<br />
|-<br />
|0x80039010<br />
|unsigned long SpuSetPitchLFOVoice(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x80039034<br />
|void SpuSetCommonAttr(SpuCommonAttr *attr)<br />
|<br />
|-<br />
|0x800393C8<br />
|void SpuSetVoiceVolume(int voiceNum, short volL, short volR)<br />
|<br />
|-<br />
|0x80039450<br />
|void SpuSetVoiceVolumeAttr(int voiceNum, short volL, short volR, short volModeL, short volModeR)<br />
|<br />
|-<br />
|0x800395C8<br />
|void SpuSetVoicePitch(int voiceNum, unsigned short pitch)<br />
|<br />
|-<br />
|0x80039644<br />
|void SpuSetVoiceStartAddr(int voiceNum, unsigned long startAddr)<br />
|<br />
|-<br />
|0x800396C0<br />
|void SpuSetVoiceLoopStartAddr(int voiceNum, unsigned long lsa)<br />
|<br />
|-<br />
|0x8003973C<br />
|void SpuSetVoiceDR(int voiceNum, unsigned short DR)<br />
|<br />
|-<br />
|0x800397C8<br />
|void SpuSetVoiceSL(int voiceNum, unsigned short SL)<br />
|<br />
|-<br />
|0x80039850<br />
|void SpuSetVoiceARAttr(int voiceNum, unsigned short AR, long ARmode)<br />
|<br />
|-<br />
|0x800398EC<br />
|void SpuSetVoiceSRAttr(int voiceNum, unsigned short SR, long SRmode)<br />
|<br />
|-<br />
|0x800399D0<br />
|void SpuSetVoiceRRAttr(int voiceNum, unsigned short RR, long RRmode)<br />
|<br />
|}<br />
<br />
=== LIBETC ===<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x8003D0C0<br />
|int ResetCallback(void)<br />
|<br />
|-<br />
|0x8003D150<br />
|int VSyncCallback(void (*func)(void))<br />
|<br />
|-<br />
|0x8003D1B4<br />
|int StopCallback(void)<br />
|<br />
|-<br />
|0x8003D214<br />
|int CheckCallback(void)<br />
|<br />
|}<br />
<br />
=== LIBAPI ===<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x800429F0<br />
|void DeliverEvent(unsigned long ev1, unsigned long ev2)<br />
|<br />
|-<br />
|0x80042A00<br />
|long OpenEvent(unsigned long desc, long spec, long mode, long (*func)())<br />
|<br />
|-<br />
|0x80042A10<br />
|long CloseEvent(long event)<br />
|<br />
|-<br />
|0x80042A20<br />
|long WaitEvent(long event)<br />
|<br />
|-<br />
|0x80042A40<br />
|long EnableEvent(long event)<br />
|<br />
|-<br />
|0x80042A50<br />
|long DisableEvent(long event)<br />
|<br />
|-<br />
|0x80042BC0<br />
|long SetRCnt(unsigned long spec, unsigned short target, long mode)<br />
|<br />
|-<br />
|0x80042C60<br />
|long GetRCnt(unsigned long spec)<br />
|<br />
|-<br />
|0x80042C98<br />
|long StartRCnt(unsigned long spec)<br />
|<br />
|-<br />
|0x80042CCC<br />
|long StopRCnt(unsigned long spec)<br />
|<br />
|}<br />
<br />
= Structures =<br />
<br />
[[FF7/PSX/Sound/INSTRx.DAT|struct AkaoInstrumentAttr]]<br />
<br />
[[FF7/PSX/Sound/INSTRx.ALL|struct AkaoSampleSet]]<br />
<br />
[[FF7/PSX/Sound/AKAO sequence|struct AkaoSeqHeader, struct AkaoDrumKeyAttr]]<br />
<br />
struct AkaoMessage // 36 bytes long<br />
{<br />
uint16_t opcode;<br />
uint16_t reserved;<br />
uint32_t data[8];<br />
};<br />
<br />
struct AkaoSpuVoiceAttr<br />
{<br />
uint32_t voice; // 0x00: voice number<br />
uint32_t update_flags; // 0x04: bitset that indicates what SPU registers need to be updated<br />
uint32_t addr; // 0x08: waveform data start address (SPU address)<br />
uint32_t loop_addr; // 0x0c: loop start address (SPU address)<br />
uint32_t a_mode; // 0x10: ADSR: attack rate mode<br />
uint32_t s_mode; // 0x14: ADSR: sustain rate mode<br />
uint32_t r_mode // 0x18: ADSR: release rate mode<br />
uint16_t pitch; // 0x1c: pitch<br />
uint16_t ar; // 0x1e: ADSR: attack rate<br />
uint16_t dr; // 0x20: ADSR: decay rate<br />
uint16_t sl; // 0x22: ADSR: sustain level<br />
uint16_t sr; // 0x24: ADSR: sustain rate<br />
uint16_t rr; // 0x26: ADSR: release rate<br />
SpuVolume volume; // 0x28: volume (left and right)<br />
};<br />
<br />
struct AkaoPlayer // the music player instance exists at 0x8009A104<br />
{<br />
uint32_t stereo_mode; // 0x00: stereo mode (1: stereo, 4: surround, otherwise: mono)<br />
uint32_t active_voices; // 0x04: bitset that indicates the voices currently in use<br />
uint32_t key_on_voices; // 0x08: bitset that indicates the voices to key on<br />
uint32_t keyed_voices; // 0x0c: bitset that indicates the voices currently keyed on<br />
uint32_t key_off_voices; // 0x10: bitset that indicates the voices to key off<br />
uint32_t saved_active_voices; // 0x14: unknown voice bitset<br />
uint32_t tempo; // 0x18: tempo (Q16 fixed-point number)<br />
int32_t tempo_slope; // 0x1c: slope of tempo slider (Q16 fixed-point number)<br />
uint32_t time_counter; // 0x20: time counter (0x10000 = 1 tick)<br />
uint32_t overlay_voices; // 0x24: bitset that indicates the sub-voices used for overlay (opcode 0xF4)<br />
uint32_t alternate_voices; // 0x28: bitset that indicates the sub-voices used for alternate voice (opcode 0xF8)<br />
uint32_t noise_voices; // 0x2c: bitset that indicates the voices with noise mode enabled<br />
uint32_t reverb_voices; // 0x30: bitset that indicates the voices with reverb enabled<br />
uint32_t pitch_lfo_voices; // 0x34: bitset that indicates the voices with pitch LFO (frequency modulation) mode enabled<br />
uint32_t spucnt; // 0x38: SPUCNT shadow<br />
uint32_t reverb_type; // 0x3c: reverb type<br />
uint32_t reverb_depth; // 0x40: reverb depth (Q16 fixed-point number)<br />
int32_t reverb_depth_slope; // 0x44: slope of reverb depth slider (Q16 fixed-point number)<br />
uint16_t tempo_slide_length; // 0x48: tempo slide length<br />
uint16_t song_id; // 0x4a: current song id<br />
uint16_t condition_ack; // 0x4c: the last matched condition value (opcode 0xEF)<br />
uint16_t condition; // 0x4e: condition variable for dynamic branching according to game status (opcode 0xEF)<br />
uint16_t reverb_depth_slide_length; // 0x50: length of reverb depth slide<br />
uint16_t noise_clock; // 0x52: noise clock frequency<br />
uint16_t field_54; // 0x54: unknown<br />
uint16_t beats_per_measure; // 0x56: beats per measure<br />
uint16_t beat; // 0x58: current beat<br />
uint16_t ticks_per_beat; // 0x5a: ticks per beat<br />
uint16_t tick; // 0x5c: current ticks per beat<br />
uint16_t measure; // 0x5e: current measure<br />
};<br />
<br />
struct AkaoPlayerTrack // the music player track instances exist at 0x80096608 + (N * 0x108)<br />
{<br />
uint8_t *addr; // 0x00<br />
uint8_t *loop_addrs[4]; // 0x04<br />
AkaoDrumKeyAttr *drum_addr; // 0x14<br />
int16_t *vibrato_lfo_addr; // 0x18<br />
int16_t *tremolo_lfo_addr; // 0x1c<br />
int16_t *pan_lfo_addr; // 0x20<br />
uint32_t overlay_voice_num; // 0x24<br />
uint32_t alternate_voice_num; // 0x28<br />
uint32_t master_volume; // 0x2c<br />
uint32_t pitch_of_note; // 0x30<br />
int32_t pitch_bend_slide_amplitude; // 0x34<br />
uint16_t voice_effect_flags; // 0x38<br />
uint16_t field_3A; // 0x3a<br />
uint16_t field_3C; // 0x3c<br />
uint16_t field_3E; // 0x3e<br />
uint32_t field_40; // 0x40<br />
uint32_t volume; // 0x44<br />
int32_t volume_slope; // 0x48<br />
int32_t pitch_bend_slope; // 0x4c<br />
uint16_t field_50; // 0x50<br />
uint16_t field_52; // 0x52<br />
uint16_t field_54; // 0x54<br />
uint8_t delta_time_counter; // 0x56<br />
uint8_t gate_time_counter; // 0x57<br />
uint16_t instrument; // 0x58<br />
uint16_t field_5A; // 0x5a<br />
uint16_t volume_slide_length_counter; // 0x5c<br />
uint16_t overlay_balance_slide_length_counter; // 0x5e<br />
uint16_t pan; // 0x60<br />
uint16_t pan_slide_length; // 0x62<br />
int16_t pitch_slide_length_counter; // 0x64<br />
uint16_t octave; // 0x66<br />
uint16_t pitch_slide_length; // 0x68<br />
uint16_t previous_note_number; // 0x6a<br />
uint16_t portamento_speed; // 0x6c<br />
uint16_t legato_flags; // 0x6e<br />
uint16_t field_70; // 0x70<br />
uint16_t vibrato_lfo_delay; // 0x72<br />
uint16_t vibrato_delay_counter; // 0x74<br />
uint16_t vibrato_rate; // 0x76<br />
uint16_t vibrato_rate_counter; // 0x78<br />
uint16_t vibrato_form; // 0x7a<br />
uint16_t vibrato_max_amplitude; // 0x7c<br />
uint16_t vibrato_depth; // 0x7e<br />
uint16_t vibrato_depth_slide_length_counter; // 0x80<br />
int16_t vibrato_depth_slope; // 0x82<br />
uint16_t field_84; // 0x84<br />
uint16_t tremolo_delay; // 0x86<br />
uint16_t tremolo_delay_counter; // 0x88<br />
uint16_t tremolo_rate; // 0x8a<br />
uint16_t tremolo_rate_counter; // 0x8c<br />
uint16_t tremolo_form; // 0x8e<br />
uint16_t tremolo_depth; // 0x90<br />
uint16_t tremolo_depth_slide_length_counter; // 0x92<br />
int16_t tremolo_depth_slope; // 0x94<br />
uint16_t field_96; // 0x96<br />
uint16_t pan_lfo_rate; // 0x98<br />
uint16_t pan_lfo_rate_counter; // 0x9a<br />
uint16_t pan_lfo_form; // 0x9c<br />
uint16_t pan_lfo_depth; // 0x9e<br />
uint16_t pan_lfo_depth_slide_length_counter; // 0xa0<br />
int16_t pan_lfo_slope; // 0xa2<br />
uint16_t noise_on_off_delay_counter; // 0xa4<br />
uint16_t pitchmod_on_off_delay_counter; // 0xa6<br />
uint8_t field_A8[16]; // 0xa8<br />
uint16_t loop_layer; // 0xb8<br />
uint16_t loop_counts[4]; // 0xba<br />
uint16_t previous_delta_time; // 0xc2<br />
uint16_t forced_delta_time; // 0xc4<br />
uint16_t overlay_balance; // 0xc6<br />
int16_t overlay_balance_slope; // 0xc8<br />
int16_t pan_slope; // 0xca<br />
int16_t transpose; // 0xcc<br />
int16_t tuning; // 0xce<br />
uint16_t note; // 0xd0<br />
int16_t pitch_slide_amount; // 0xd2<br />
int16_t previous_transpose; // 0xd4<br />
int16_t vibrato_lfo_amplitude; // 0xd6<br />
int16_t tremolo_lfo_amplitude; // 0xd8<br />
int16_t pan_lfo_amplitude; // 0xda<br />
AkaoSpuVoiceAttr spu_attr; // 0xdc<br />
};</div>
Loveemu
https://wiki.ffrtt.ru/index.php?title=FF7/PSX/Sound/Code_Map&diff=5742
FF7/PSX/Sound/Code Map
2020-06-07T15:28:26Z
<p>Loveemu: </p>
<hr />
<div>= Code Map =<br />
<br />
Introduces functions, variables and data related to sound, contained in SCUS_941.63 (game program of US version). Note that all symbol names below are for convenience only.<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x800293D0<br />
|void _AkaoSpuTransferCallback(void)<br />
|<br />
|-<br />
|0x800293F4<br />
|void _AkaoSpuSetTransferCallback(void)<br />
|<br />
|-<br />
|0x80029424<br />
|unsigned int _AkaoTransferSamples(const unsigned char *addr, unsigned int size)<br />
|<br />
|-<br />
|0x800294A4<br />
|void _AkaoWaitForSpuTransfer(void)<br />
|<br />
|-<br />
|0x800294BC<br />
|void _AkaoReset(void)<br />
|<br />
|-<br />
|0x800297A4<br />
|void AkaoLoadInstrumentSet(const sturct AkaoSampleSet *sampleSet, const struct AkaoInstrumentAttr *instrumentSet)<br />
|Load standard instrument set<br />
<br />
''sampleSet'': corresponding to SOUND/INSTR.ALL<br />
<br />
''instrumentSet'': corresponding to SOUND/INSTR.DAT<br />
<br />
This function is called transparently from 0x8002988C.<br />
|-<br />
|0x80029818<br />
|void AkaoLoadInstrumentSet2(const sturct AkaoSampleSet *sampleSet, const struct AkaoInstrumentAttr *instrumentSet)<br />
|Load additional instrument set<br />
<br />
''sampleSet'': corresponding to SOUND/INSTR2.ALL<br />
<br />
''instrumentSet'': corresponding to SOUND/INSTR2.DAT<br />
|-<br />
|0x8002988C<br />
|void AkaoInitialize(const sturct AkaoSampleSet *sampleSet, const struct AkaoInstrumentAttr *instrumentSet)<br />
|Initialize sound driver and load initial instruments<br />
<br />
''sampleSet'': corresponding to SOUND/INSTR.ALL<br />
<br />
''instrumentSet'': corresponding to SOUND/INSTR.DAT<br />
|-<br />
|0x800299C8<br />
|void AkaoDeinitialize(void)<br />
|Deinitialize sound driver<br />
|-<br />
|0x80029AF0<br />
|void AkaoSetReverbMode(int mode)<br />
|<br />
|-<br />
|0x80029B78<br />
|void _AkaoTransferSeqBody(const unsigned char *data, int size)<br />
|<br />
|-<br />
|0x80029C48<br />
|void _AkaoLoadTracks(void)<br />
|<br />
|-<br />
|0x8002DA30<br />
|void AkaoNewMessage(AkaoMessage **ppMessage)<br />
|<br />
|-<br />
|0x8002DA7C<br />
|int AkaoPostMessage(void)<br />
|Post a new command message to the queue (with some wrapped processing)<br />
<br />
The message data comes from a global variable at 0x8009A000.<br />
<br />
Return value depends on the content of the message data.<br />
<br />
<br />
'''Opcode 0x10'''<br />
<br />
Load and start playing new [[FF7/PSX/Sound/AKAO sequence|AKAO sequence]]<br />
<br />
Returns: 0 for success, 1 for already loaded, and -1 for invalid signature<br />
<br />
<br />
'''Opcode 0x92'''<br />
<br />
Set value to the condition variable used by Opcode 0xEF.<br />
|-<br />
|0x8002E1A8<br />
|void _AkaoDispatchMessages(void)<br />
|<br />
|-<br />
|0x8002E23C<br />
|void _AkaoWriteSpuRegisters(int voiceNum, struct AkaoSpuVoiceAttr *attr)<br />
|<br />
|-<br />
|0x8002E478<br />
|void _AkaoDspOnTick(struct AkaoPlayerTrack *track, AkaoPlayer *player, int voiceMask)<br />
|<br />
|-<br />
|0x8002ED34<br />
|void _AkaoCalculateVolumeAndPitch(struct AkaoPlayerTrack *track, int voiceMask, int voiceNum)<br />
|<br />
|-<br />
|0x8002F24C<br />
|void _AkaoCalculateVolumeAndPitch2(struct AkaoPlayerTrack *track, int voiceMask)<br />
|<br />
|-<br />
|0x8002F738<br />
|void _AkaoDspOverlayVoice(struct AkaoPlayerTrack *track, int unknownVoiceMask, int voiceNum)<br />
|<br />
|-<br />
|0x8002F848<br />
|void _AkaoDspMain(void)<br />
|<br />
|-<br />
|0x8002FF4C<br />
|void _AkaoSpuNoiseVoice(void)<br />
|<br />
|-<br />
|0x80030038<br />
|void _AkaoSpuReverbVoice(void)<br />
|<br />
|-<br />
|0x80030148<br />
|void _AkaoSpuPitchLFOVoice(void)<br />
|<br />
|-<br />
|0x80030234<br />
|int _AkaoTimerCallback(void)<br />
|Sound callback event that is periodically triggered by root counter 2<br />
|-<br />
|0x800308D4<br />
|void _AkaoMain(void)<br />
|<br />
|-<br />
|0x80030E7C<br />
|void _AkaoDispatchVoice(struct AkaoPlayerTrack *track, struct AkaoPlayer *player, int voiceMask)<br />
|Dispatch voice opcodes until the next note or end of track<br />
|-<br />
|0x80031820<br />
|void AkaoSetInstrument(struct AkaoPlayerTrack *track, unsigned short progNumber)<br />
|<br />
|-<br />
|0x800318BC<br />
|int _AkaoReadNextNote(struct AkaoPlayerTrack *track)<br />
|<br />
|-<br />
|0x80031A70<br />
|int _AkaoFindNextEndPoint(struct AkaoPlayerTrack *track)<br />
|<br />
|-<br />
|0x80049548<br />
|void (* const MESSAGE_HANDLERS[256])(struct AkaoMessage *)<br />
|<br />
|-<br />
|0x80049948<br />
|const unsigned char VOICE_OPCODE_LENGTHS[0x60]<br />
|Length table for voice opcodes 0xa0-0xff<br />
<br />
0 for end of track and branches<br />
|-<br />
|0x80049AA8<br />
|void (* const VOICE_OPCODES[0x60])(struct AkaoPlayerTrack *, struct AkaoPlayer *, int)<br />
|Address table for voice opcodes 0xa0-0xff<br />
|-<br />
|0x80049C28<br />
|const unsigned short DELTA_TIME_TABLE[11];<br />
|<br />
|-<br />
|0x80049C44<br />
|const unsigned short VOLUME_TABLE_L[128]<br />
|See [[FF7/PSX/Sound/Opcodes/0xa8aa|Opcode 0xAA]] for volume balance calculation<br />
|-<br />
|0x80049E44<br />
|const unsigned short VOLUME_TABLE_R[128]<br />
|See [[FF7/PSX/Sound/Opcodes/0xa8aa|Opcode 0xAA]] for volume balance calculation<br />
|-<br />
|0x8004A5CC<br />
|const short *LFO_FORMS[16]<br />
|<br />
|-<br />
|0x8004A60C<br />
|const unsigned char EMPTY_ADPCM[32]<br />
|<br />
|-<br />
|0x80083580<br />
|unsigned char g_AkaoSeqData[]<br />
|RAM area to load AKAO sequence data<br />
|-<br />
|0x8009A000<br />
|AkaoMessage g_AkaoMessage<br />
|Message data to be posted. Processed by the function 0x8002DA7C<br />
|}<br />
<br />
== Runtime Library Functions ==<br />
<br />
=== LIBSPU ===<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x80036298<br />
|void SpuInit(void)<br />
|<br />
|-<br />
|0x80036FFC<br />
|long SpuInitMalloc(long num, char *top)<br />
|<br />
|-<br />
|0x800373AC<br />
|long SpuMallocWithStartAddr(unsigned long addr, long size)<br />
|<br />
|-<br />
|0x80037964<br />
|unsigned long SpuSetNoiseVoice(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x80037B90<br />
|long SpuSetNoiseClock(long n_clock)<br />
|<br />
|-<br />
|0x80037BE0<br />
|unsigned long SpuRead(unsigned char *addr, unsigned long size)<br />
|<br />
|-<br />
|0x80037C40<br />
|long SpuSetReverb(long on_off)<br />
|<br />
|-<br />
|0x80037D90<br />
|long SpuGetReverb(void)<br />
|<br />
|-<br />
|0x80037E1C<br />
|long SpuSetReverbModeParam(SpuReverbAttr *attr)<br />
|<br />
|-<br />
|0x800387FC<br />
|void SpuGetReverbModeParam (SpuReverbAttr *attr)<br />
|<br />
|-<br />
|0x8003884C<br />
|long SpuSetReverbDepth(SpuReverbAttr *attr)<br />
|<br />
|-<br />
|0x800388C4<br />
|unsigned long SpuSetReverbVoice(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x800388E8<br />
|long SpuClearReverbWorkArea(long mode)<br />
|<br />
|-<br />
|0x80038A84<br />
|long SpuSetIRQ(long on_off)<br />
|<br />
|-<br />
|0x80038BC4<br />
|unsigned long SpuSetIRQAddr(unsigned long addr)<br />
|<br />
|-<br />
|0x80038C04<br />
|SpuIRQCallbackProc SpuSetIRQCallback(SpuIRQCallbackProc func)<br />
|<br />
|-<br />
|0x80038C6C<br />
|void SpuSetKey(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x80038F04<br />
|unsigned long SpuWrite(unsigned char *addr, unsigned long size)<br />
|<br />
|-<br />
|0x80038F64<br />
|unsigned long SpuSetTransferStartAddr(unsigned long addr)<br />
|<br />
|-<br />
|0x80038FB8<br />
|long SpuSetTransferMode(long mode)<br />
|<br />
|-<br />
|0x80038FEC<br />
|SpuTransferCallbackProc SpuSetTransferCallback(SpuTransferCallbackProc func)<br />
|<br />
|-<br />
|0x80039010<br />
|unsigned long SpuSetPitchLFOVoice(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x80039034<br />
|void SpuSetCommonAttr(SpuCommonAttr *attr)<br />
|<br />
|-<br />
|0x800393C8<br />
|void SpuSetVoiceVolume(int voiceNum, short volL, short volR)<br />
|<br />
|-<br />
|0x80039450<br />
|void SpuSetVoiceVolumeAttr(int voiceNum, short volL, short volR, short volModeL, short volModeR)<br />
|<br />
|-<br />
|0x800395C8<br />
|void SpuSetVoicePitch(int voiceNum, unsigned short pitch)<br />
|<br />
|-<br />
|0x80039644<br />
|void SpuSetVoiceStartAddr(int voiceNum, unsigned long startAddr)<br />
|<br />
|-<br />
|0x800396C0<br />
|void SpuSetVoiceLoopStartAddr(int voiceNum, unsigned long lsa)<br />
|<br />
|-<br />
|0x8003973C<br />
|void SpuSetVoiceDR(int voiceNum, unsigned short DR)<br />
|<br />
|-<br />
|0x800397C8<br />
|void SpuSetVoiceSL(int voiceNum, unsigned short SL)<br />
|<br />
|-<br />
|0x80039850<br />
|void SpuSetVoiceARAttr(int voiceNum, unsigned short AR, long ARmode)<br />
|<br />
|-<br />
|0x800398EC<br />
|void SpuSetVoiceSRAttr(int voiceNum, unsigned short SR, long SRmode)<br />
|<br />
|-<br />
|0x800399D0<br />
|void SpuSetVoiceRRAttr(int voiceNum, unsigned short RR, long RRmode)<br />
|<br />
|}<br />
<br />
=== LIBETC ===<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x8003D0C0<br />
|int ResetCallback(void)<br />
|<br />
|-<br />
|0x8003D150<br />
|int VSyncCallback(void (*func)(void))<br />
|<br />
|-<br />
|0x8003D1B4<br />
|int StopCallback(void)<br />
|<br />
|-<br />
|0x8003D214<br />
|int CheckCallback(void)<br />
|<br />
|}<br />
<br />
=== LIBAPI ===<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x800429F0<br />
|void DeliverEvent(unsigned long ev1, unsigned long ev2)<br />
|<br />
|-<br />
|0x80042A00<br />
|long OpenEvent(unsigned long desc, long spec, long mode, long (*func)())<br />
|<br />
|-<br />
|0x80042A10<br />
|long CloseEvent(long event)<br />
|<br />
|-<br />
|0x80042A20<br />
|long WaitEvent(long event)<br />
|<br />
|-<br />
|0x80042A40<br />
|long EnableEvent(long event)<br />
|<br />
|-<br />
|0x80042A50<br />
|long DisableEvent(long event)<br />
|<br />
|-<br />
|0x80042BC0<br />
|long SetRCnt(unsigned long spec, unsigned short target, long mode)<br />
|<br />
|-<br />
|0x80042C60<br />
|long GetRCnt(unsigned long spec)<br />
|<br />
|-<br />
|0x80042C98<br />
|long StartRCnt(unsigned long spec)<br />
|<br />
|-<br />
|0x80042CCC<br />
|long StopRCnt(unsigned long spec)<br />
|<br />
|}<br />
<br />
= Structures =<br />
<br />
[[FF7/PSX/Sound/INSTRx.DAT|struct AkaoInstrumentAttr]]<br />
<br />
[[FF7/PSX/Sound/INSTRx.ALL|struct AkaoSampleSet]]<br />
<br />
[[FF7/PSX/Sound/AKAO sequence|struct AkaoSeqHeader, struct AkaoDrumKeyAttr]]<br />
<br />
struct AkaoMessage // 36 bytes long<br />
{<br />
uint16_t opcode;<br />
uint16_t reserved;<br />
uint32_t data[8];<br />
};<br />
<br />
struct AkaoSpuVoiceAttr<br />
{<br />
uint32_t voice; // 0x00: voice number<br />
uint32_t update_flags; // 0x04: bitset that indicates what SPU registers need to be updated<br />
uint32_t addr; // 0x08: waveform data start address (SPU address)<br />
uint32_t loop_addr; // 0x0c: loop start address (SPU address)<br />
uint32_t a_mode; // 0x10: ADSR: attack rate mode<br />
uint32_t s_mode; // 0x14: ADSR: sustain rate mode<br />
uint32_t r_mode // 0x18: ADSR: release rate mode<br />
uint16_t pitch; // 0x1c: pitch<br />
uint16_t ar; // 0x1e: ADSR: attack rate<br />
uint16_t dr; // 0x20: ADSR: decay rate<br />
uint16_t sl; // 0x22: ADSR: sustain level<br />
uint16_t sr; // 0x24: ADSR: sustain rate<br />
uint16_t rr; // 0x26: ADSR: release rate<br />
SpuVolume volume; // 0x28: volume (left and right)<br />
};<br />
<br />
struct AkaoPlayer // the music player instance exists at 0x8009A104<br />
{<br />
uint32_t stereo_mode; // 0x00: stereo mode (1: stereo, 4: surround, otherwise: mono)<br />
uint32_t active_voices; // 0x04: bitset that indicates the voices currently in use<br />
uint32_t key_on_voices; // 0x08: bitset that indicates the voices to key on<br />
uint32_t keyed_voices; // 0x0c: bitset that indicates the voices currently keyed on<br />
uint32_t key_off_voices; // 0x10: bitset that indicates the voices to key off<br />
uint32_t saved_active_voices; // 0x14: unknown voice bitset<br />
uint32_t tempo; // 0x18: tempo (Q16 fixed-point number)<br />
int32_t tempo_slope; // 0x1c: slope of tempo slider (Q16 fixed-point number)<br />
uint32_t time_counter; // 0x20: time counter (0x10000 = 1 tick)<br />
uint32_t overlay_voices; // 0x24: bitset that indicates the sub-voices used for overlay (opcode 0xF4)<br />
uint32_t alternate_voices; // 0x28: bitset that indicates the sub-voices used for alternate voice (opcode 0xF8)<br />
uint32_t noise_voices; // 0x2c: bitset that indicates the voices with noise mode enabled<br />
uint32_t reverb_voices; // 0x30: bitset that indicates the voices with reverb enabled<br />
uint32_t pitch_lfo_voices; // 0x34: bitset that indicates the voices with pitch LFO (frequency modulation) mode enabled<br />
uint32_t spucnt; // 0x38: SPUCNT shadow<br />
uint32_t reverb_type; // 0x3c: reverb type<br />
uint32_t reverb_depth; // 0x40: reverb depth (Q16 fixed-point number)<br />
int32_t reverb_depth_slope; // 0x44: slope of reverb depth slider (Q16 fixed-point number)<br />
uint16_t tempo_slide_length; // 0x48: tempo slide length<br />
uint16_t song_id; // 0x4a: current song id<br />
uint16_t condition_ack; // 0x4c: the last matched condition value (opcode 0xEF)<br />
uint16_t condition; // 0x4e: condition variable for dynamic branching according to game status (opcode 0xEF)<br />
uint16_t reverb_depth_slide_length; // 0x50: length of reverb depth slide<br />
uint16_t noise_clock; // 0x52: noise clock frequency<br />
uint16_t field_54; // 0x54: unknown<br />
uint16_t beats_per_measure; // 0x56: beats per measure<br />
uint16_t beat; // 0x58: current beat<br />
uint16_t ticks_per_beat; // 0x5a: ticks per beat<br />
uint16_t tick; // 0x5c: current ticks per beat<br />
uint16_t measure; // 0x5e: current measure<br />
};<br />
<br />
struct AkaoPlayerTrack // the music player track instances exist at 0x80096608 + (N * 0x108)<br />
{<br />
uint8_t *addr; // 0x00<br />
uint8_t *loop_addrs[4]; // 0x04<br />
AkaoDrumKeyAttr *drum_addr; // 0x14<br />
int16_t *vibrato_lfo_addr; // 0x18<br />
int16_t *tremolo_lfo_addr; // 0x1c<br />
int16_t *pan_lfo_addr; // 0x20<br />
uint32_t overlay_voice_num; // 0x24<br />
uint32_t alternate_voice_num; // 0x28<br />
uint32_t master_volume; // 0x2c<br />
uint32_t pitch_of_note; // 0x30<br />
int32_t pitch_bend_slide_amplitude; // 0x34<br />
uint16_t voice_effect_flags; // 0x38<br />
uint16_t field_3A; // 0x3a<br />
uint16_t field_3C; // 0x3c<br />
uint16_t field_3E; // 0x3e<br />
uint32_t field_40; // 0x40<br />
uint32_t volume; // 0x44<br />
int32_t volume_slope; // 0x48<br />
int32_t pitch_bend_slope; // 0x4c<br />
uint16_t field_50; // 0x50<br />
uint16_t field_52; // 0x52<br />
uint16_t field_54; // 0x54<br />
uint8_t delta_time_counter; // 0x56<br />
uint8_t gate_time_counter; // 0x57<br />
uint16_t instrument; // 0x58<br />
uint16_t field_5A; // 0x5a<br />
uint16_t volume_slide_length_counter; // 0x5c<br />
uint16_t overlay_balance_slide_length_counter; // 0x5e<br />
uint16_t pan; // 0x60<br />
uint16_t pan_slide_length; // 0x62<br />
int16_t pitch_slide_length_counter; // 0x64<br />
uint16_t octave; // 0x66<br />
uint16_t pitch_slide_length; // 0x68<br />
uint16_t previous_note_number; // 0x6a<br />
uint16_t portamento_speed; // 0x6c<br />
uint16_t legato_flags; // 0x6e<br />
uint16_t field_70; // 0x70<br />
uint16_t vibrato_lfo_delay; // 0x72<br />
uint16_t vibrato_delay_counter; // 0x74<br />
uint16_t vibrato_rate; // 0x76<br />
uint16_t vibrato_rate_counter; // 0x78<br />
uint16_t vibrato_form; // 0x7a<br />
uint16_t vibrato_max_amplitude; // 0x7c<br />
uint16_t vibrato_depth; // 0x7e<br />
uint16_t vibrato_depth_slide_length_counter; // 0x80<br />
int16_t vibrato_depth_slope; // 0x82<br />
uint16_t field_84; // 0x84<br />
uint16_t tremolo_delay; // 0x86<br />
uint16_t tremolo_delay_counter; // 0x88<br />
uint16_t tremolo_rate; // 0x8a<br />
uint16_t tremolo_rate_counter; // 0x8c<br />
uint16_t tremolo_form; // 0x8e<br />
uint16_t tremolo_depth; // 0x90<br />
uint16_t tremolo_depth_slide_length_counter; // 0x92<br />
int16_t tremolo_depth_slope; // 0x94<br />
uint16_t field_96; // 0x96<br />
uint16_t pan_lfo_rate; // 0x98<br />
uint16_t pan_lfo_rate_counter; // 0x9a<br />
uint16_t pan_lfo_form; // 0x9c<br />
uint16_t pan_lfo_depth; // 0x9e<br />
uint16_t pan_lfo_depth_slide_length_counter; // 0xa0<br />
int16_t pan_lfo_slope; // 0xa2<br />
uint16_t noise_on_off_delay_counter; // 0xa4<br />
uint16_t pitchmod_on_off_delay_counter; // 0xa6<br />
uint8_t field_A8[16]; // 0xa8<br />
uint16_t loop_layer; // 0xb8<br />
uint16_t loop_counts[4]; // 0xba<br />
uint16_t previous_delta_time; // 0xc2<br />
uint16_t forced_delta_time; // 0xc4<br />
uint16_t overlay_balance; // 0xc6<br />
int16_t overlay_balance_slope; // 0xc8<br />
int16_t pan_slope; // 0xca<br />
int16_t transpose; // 0xcc<br />
int16_t tuning; // 0xce<br />
uint16_t note; // 0xd0<br />
int16_t pitch_slide_amount; // 0xd2<br />
int16_t previous_transpose; // 0xd4<br />
int16_t vibrato_lfo_amplitude; // 0xd6<br />
int16_t tremolo_lfo_amplitude; // 0xd8<br />
int16_t pan_lfo_amplitude; // 0xda<br />
AkaoSpuVoiceAttr spu_attr; // 0xdc<br />
};</div>
Loveemu
https://wiki.ffrtt.ru/index.php?title=FF7/PSX/Sound/Code_Map&diff=5741
FF7/PSX/Sound/Code Map
2020-06-07T15:13:03Z
<p>Loveemu: </p>
<hr />
<div>= Code Map =<br />
<br />
Introduces functions, variables and data related to sound, contained in SCUS_941.63 (game program of US version). Note that all symbol names below are for convenience only.<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x800293D0<br />
|void _AkaoSpuTransferCallback(void)<br />
|<br />
|-<br />
|0x800293F4<br />
|void _AkaoSpuSetTransferCallback(void)<br />
|<br />
|-<br />
|0x80029424<br />
|unsigned int _AkaoTransferSamples(const unsigned char *addr, unsigned int size)<br />
|<br />
|-<br />
|0x800294A4<br />
|void _AkaoWaitForSpuTransfer(void)<br />
|<br />
|-<br />
|0x800294BC<br />
|void _AkaoReset(void)<br />
|<br />
|-<br />
|0x800297A4<br />
|void AkaoLoadInstrumentSet(const sturct AkaoSampleSet *sampleSet, const struct AkaoInstrumentAttr *instrumentSet)<br />
|Load standard instrument set<br />
<br />
''sampleSet'': corresponding to SOUND/INSTR.ALL<br />
<br />
''instrumentSet'': corresponding to SOUND/INSTR.DAT<br />
<br />
This function is called transparently from 0x8002988C.<br />
|-<br />
|0x80029818<br />
|void AkaoLoadInstrumentSet2(const sturct AkaoSampleSet *sampleSet, const struct AkaoInstrumentAttr *instrumentSet)<br />
|Load additional instrument set<br />
<br />
''sampleSet'': corresponding to SOUND/INSTR2.ALL<br />
<br />
''instrumentSet'': corresponding to SOUND/INSTR2.DAT<br />
|-<br />
|0x8002988C<br />
|void AkaoInitialize(const sturct AkaoSampleSet *sampleSet, const struct AkaoInstrumentAttr *instrumentSet)<br />
|Initialize sound driver and load initial instruments<br />
<br />
''sampleSet'': corresponding to SOUND/INSTR.ALL<br />
<br />
''instrumentSet'': corresponding to SOUND/INSTR.DAT<br />
|-<br />
|0x800299C8<br />
|void AkaoDeinitialize(void)<br />
|Deinitialize sound driver<br />
|-<br />
|0x80029AF0<br />
|void AkaoSetReverbMode(int mode)<br />
|<br />
|-<br />
|0x80029B78<br />
|void _AkaoTransferSeqBody(const unsigned char *data, int size)<br />
|<br />
|-<br />
|0x80029C48<br />
|void _AkaoLoadTracks(void)<br />
|<br />
|-<br />
|0x8002DA30<br />
|void AkaoNewMessage(AkaoMessage **ppMessage)<br />
|<br />
|-<br />
|0x8002DA7C<br />
|int AkaoPostMessage(void)<br />
|Post a new command message to the queue (with some wrapped processing)<br />
<br />
The message data comes from a global variable at 0x8009A000.<br />
<br />
Return value depends on the content of the message data.<br />
<br />
<br />
'''Opcode 0x10'''<br />
<br />
Load and start playing new [[FF7/PSX/Sound/AKAO sequence|AKAO sequence]]<br />
<br />
Returns: 0 for success, 1 for already loaded, and -1 for invalid signature<br />
<br />
<br />
'''Opcode 0x92'''<br />
<br />
Set value to the condition variable used by Opcode 0xEF.<br />
|-<br />
|0x8002E1A8<br />
|void _AkaoDispatchMessages(void)<br />
|<br />
|-<br />
|0x8002E23C<br />
|void _AkaoWriteSpuRegisters(int voiceNum, AkaoSpuVoiceAttr *attr)<br />
|<br />
|-<br />
|0x8002E478<br />
|void _AkaoDspOnTick(AkaoPlayerTrack *track, AkaoPlayer *player, int voiceMask)<br />
|<br />
|-<br />
|0x8002ED34<br />
|void _AkaoCalculateVolumeAndPitch(AkaoPlayerTrack *track, int voiceMask, int voiceNum)<br />
|<br />
|-<br />
|0x8002F24C<br />
|void _AkaoCalculateVolumeAndPitch2(AkaoPlayerTrack *track, int voiceMask)<br />
|<br />
|-<br />
|0x8002F738<br />
|void _AkaoDspOverlayVoice(AkaoPlayerTrack *track, int unknownVoiceMask, int voiceNum)<br />
|<br />
|-<br />
|0x8002F848<br />
|void _AkaoDspMain(void)<br />
|<br />
|-<br />
|0x8002FF4C<br />
|void _AkaoSpuNoiseVoice(void)<br />
|<br />
|-<br />
|0x80030038<br />
|void _AkaoSpuReverbVoice(void)<br />
|<br />
|-<br />
|0x80030148<br />
|void _AkaoSpuPitchLFOVoice(void)<br />
|<br />
|-<br />
|0x80030234<br />
|int _AkaoTimerCallback(void)<br />
|Sound callback event that is periodically triggered by root counter 2<br />
|-<br />
|0x800308D4<br />
|void _AkaoMain(void)<br />
|<br />
|-<br />
|0x80030E7C<br />
|void _AkaoDispatchVoice(AkaoPlayerTrack *track, AkaoPlayer *player, int voiceMask)<br />
|Dispatch voice opcodes until the next note or end of track<br />
|-<br />
|0x80031820<br />
|void AkaoSetInstrument(AkaoPlayerTrack *track, unsigned short progNumber)<br />
|<br />
|-<br />
|0x800318BC<br />
|int _AkaoReadNextNote(AkaoPlayerTrack *track)<br />
|<br />
|-<br />
|0x80031A70<br />
|int _AkaoFindNextEndPoint(AkaoPlayerTrack *track)<br />
|<br />
|-<br />
|0x80049548<br />
|void (* const MESSAGE_HANDLERS[256])(struct AkaoMessage *)<br />
|<br />
|-<br />
|0x80049948<br />
|const unsigned char VOICE_OPCODE_LENGTHS[0x60]<br />
|Length table for voice opcodes 0xa0-0xff<br />
<br />
0 for end of track and branches<br />
|-<br />
|0x80049AA8<br />
|void (* const VOICE_OPCODES[0x60])(struct MusicPlayerTrack *, void *, int)<br />
|Address table for voice opcodes 0xa0-0xff<br />
|-<br />
|0x80049C28<br />
|const unsigned short DELTA_TIME_TABLE[11];<br />
|<br />
|-<br />
|0x80049C44<br />
|const unsigned short VOLUME_TABLE_L[128]<br />
|See [[FF7/PSX/Sound/Opcodes/0xa8aa|Opcode 0xAA]] for volume balance calculation<br />
|-<br />
|0x80049E44<br />
|const unsigned short VOLUME_TABLE_R[128]<br />
|See [[FF7/PSX/Sound/Opcodes/0xa8aa|Opcode 0xAA]] for volume balance calculation<br />
|-<br />
|0x8004A5CC<br />
|const short *LFO_FORMS[16]<br />
|<br />
|-<br />
|0x8004A60C<br />
|const unsigned char EMPTY_ADPCM[32]<br />
|<br />
|-<br />
|0x80083580<br />
|unsigned char g_AkaoSeqData[]<br />
|RAM area to load AKAO sequence data<br />
|-<br />
|0x8009A000<br />
|AkaoMessage g_AkaoMessage<br />
|Message data to be posted. Processed by the function 0x8002DA7C<br />
|}<br />
<br />
== Runtime Library Functions ==<br />
<br />
=== LIBSPU ===<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x80036298<br />
|void SpuInit(void)<br />
|<br />
|-<br />
|0x80036FFC<br />
|long SpuInitMalloc(long num, char *top)<br />
|<br />
|-<br />
|0x800373AC<br />
|long SpuMallocWithStartAddr(unsigned long addr, long size)<br />
|<br />
|-<br />
|0x80037964<br />
|unsigned long SpuSetNoiseVoice(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x80037B90<br />
|long SpuSetNoiseClock(long n_clock)<br />
|<br />
|-<br />
|0x80037BE0<br />
|unsigned long SpuRead(unsigned char *addr, unsigned long size)<br />
|<br />
|-<br />
|0x80037C40<br />
|long SpuSetReverb(long on_off)<br />
|<br />
|-<br />
|0x80037D90<br />
|long SpuGetReverb(void)<br />
|<br />
|-<br />
|0x80037E1C<br />
|long SpuSetReverbModeParam(SpuReverbAttr *attr)<br />
|<br />
|-<br />
|0x800387FC<br />
|void SpuGetReverbModeParam (SpuReverbAttr *attr)<br />
|<br />
|-<br />
|0x8003884C<br />
|long SpuSetReverbDepth(SpuReverbAttr *attr)<br />
|<br />
|-<br />
|0x800388C4<br />
|unsigned long SpuSetReverbVoice(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x800388E8<br />
|long SpuClearReverbWorkArea(long mode)<br />
|<br />
|-<br />
|0x80038A84<br />
|long SpuSetIRQ(long on_off)<br />
|<br />
|-<br />
|0x80038BC4<br />
|unsigned long SpuSetIRQAddr(unsigned long addr)<br />
|<br />
|-<br />
|0x80038C04<br />
|SpuIRQCallbackProc SpuSetIRQCallback(SpuIRQCallbackProc func)<br />
|<br />
|-<br />
|0x80038C6C<br />
|void SpuSetKey(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x80038F04<br />
|unsigned long SpuWrite(unsigned char *addr, unsigned long size)<br />
|<br />
|-<br />
|0x80038F64<br />
|unsigned long SpuSetTransferStartAddr(unsigned long addr)<br />
|<br />
|-<br />
|0x80038FB8<br />
|long SpuSetTransferMode(long mode)<br />
|<br />
|-<br />
|0x80038FEC<br />
|SpuTransferCallbackProc SpuSetTransferCallback(SpuTransferCallbackProc func)<br />
|<br />
|-<br />
|0x80039010<br />
|unsigned long SpuSetPitchLFOVoice(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x80039034<br />
|void SpuSetCommonAttr(SpuCommonAttr *attr)<br />
|<br />
|-<br />
|0x800393C8<br />
|void SpuSetVoiceVolume(int voiceNum, short volL, short volR)<br />
|<br />
|-<br />
|0x80039450<br />
|void SpuSetVoiceVolumeAttr(int voiceNum, short volL, short volR, short volModeL, short volModeR)<br />
|<br />
|-<br />
|0x800395C8<br />
|void SpuSetVoicePitch(int voiceNum, unsigned short pitch)<br />
|<br />
|-<br />
|0x80039644<br />
|void SpuSetVoiceStartAddr(int voiceNum, unsigned long startAddr)<br />
|<br />
|-<br />
|0x800396C0<br />
|void SpuSetVoiceLoopStartAddr(int voiceNum, unsigned long lsa)<br />
|<br />
|-<br />
|0x8003973C<br />
|void SpuSetVoiceDR(int voiceNum, unsigned short DR)<br />
|<br />
|-<br />
|0x800397C8<br />
|void SpuSetVoiceSL(int voiceNum, unsigned short SL)<br />
|<br />
|-<br />
|0x80039850<br />
|void SpuSetVoiceARAttr(int voiceNum, unsigned short AR, long ARmode)<br />
|<br />
|-<br />
|0x800398EC<br />
|void SpuSetVoiceSRAttr(int voiceNum, unsigned short SR, long SRmode)<br />
|<br />
|-<br />
|0x800399D0<br />
|void SpuSetVoiceRRAttr(int voiceNum, unsigned short RR, long RRmode)<br />
|<br />
|}<br />
<br />
=== LIBETC ===<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x8003D0C0<br />
|int ResetCallback(void)<br />
|<br />
|-<br />
|0x8003D150<br />
|int VSyncCallback(void (*func)(void))<br />
|<br />
|-<br />
|0x8003D1B4<br />
|int StopCallback(void)<br />
|<br />
|-<br />
|0x8003D214<br />
|int CheckCallback(void)<br />
|<br />
|}<br />
<br />
=== LIBAPI ===<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x800429F0<br />
|void DeliverEvent(unsigned long ev1, unsigned long ev2)<br />
|<br />
|-<br />
|0x80042A00<br />
|long OpenEvent(unsigned long desc, long spec, long mode, long (*func)())<br />
|<br />
|-<br />
|0x80042A10<br />
|long CloseEvent(long event)<br />
|<br />
|-<br />
|0x80042A20<br />
|long WaitEvent(long event)<br />
|<br />
|-<br />
|0x80042A40<br />
|long EnableEvent(long event)<br />
|<br />
|-<br />
|0x80042A50<br />
|long DisableEvent(long event)<br />
|<br />
|-<br />
|0x80042BC0<br />
|long SetRCnt(unsigned long spec, unsigned short target, long mode)<br />
|<br />
|-<br />
|0x80042C60<br />
|long GetRCnt(unsigned long spec)<br />
|<br />
|-<br />
|0x80042C98<br />
|long StartRCnt(unsigned long spec)<br />
|<br />
|-<br />
|0x80042CCC<br />
|long StopRCnt(unsigned long spec)<br />
|<br />
|}<br />
<br />
= Structures =<br />
<br />
[[FF7/PSX/Sound/INSTRx.DAT|struct AkaoInstrumentAttr]]<br />
<br />
[[FF7/PSX/Sound/INSTRx.ALL|struct AkaoSampleSet]]<br />
<br />
[[FF7/PSX/Sound/AKAO sequence|struct AkaoSeqHeader, struct AkaoDrumKeyAttr]]<br />
<br />
struct AkaoMessage // 36 bytes long<br />
{<br />
uint16_t opcode;<br />
uint16_t reserved;<br />
uint32_t data[8];<br />
};<br />
<br />
struct AkaoSpuVoiceAttr<br />
{<br />
uint32_t voice; // 0x00: voice number<br />
uint32_t update_flags; // 0x04: bitset that indicates what SPU registers need to be updated<br />
uint32_t addr; // 0x08: waveform data start address (SPU address)<br />
uint32_t loop_addr; // 0x0c: loop start address (SPU address)<br />
uint32_t a_mode; // 0x10: ADSR: attack rate mode<br />
uint32_t s_mode; // 0x14: ADSR: sustain rate mode<br />
uint32_t r_mode // 0x18: ADSR: release rate mode<br />
uint16_t pitch; // 0x1c: pitch<br />
uint16_t ar; // 0x1e: ADSR: attack rate<br />
uint16_t dr; // 0x20: ADSR: decay rate<br />
uint16_t sl; // 0x22: ADSR: sustain level<br />
uint16_t sr; // 0x24: ADSR: sustain rate<br />
uint16_t rr; // 0x26: ADSR: release rate<br />
SpuVolume volume; // 0x28: volume (left and right)<br />
};<br />
<br />
struct AkaoPlayer // the music player instance exists at 0x8009A104<br />
{<br />
uint32_t stereo_mode; // 0x00: stereo mode (1: stereo, 4: surround, otherwise: mono)<br />
uint32_t active_voices; // 0x04: bitset that indicates the voices currently in use<br />
uint32_t key_on_voices; // 0x08: bitset that indicates the voices to key on<br />
uint32_t keyed_voices; // 0x0c: bitset that indicates the voices currently keyed on<br />
uint32_t key_off_voices; // 0x10: bitset that indicates the voices to key off<br />
uint32_t saved_active_voices; // 0x14: unknown voice bitset<br />
uint32_t tempo; // 0x18: tempo (Q16 fixed-point number)<br />
int32_t tempo_slope; // 0x1c: slope of tempo slider (Q16 fixed-point number)<br />
uint32_t time_counter; // 0x20: time counter (0x10000 = 1 tick)<br />
uint32_t overlay_voices; // 0x24: bitset that indicates the sub-voices used for overlay (opcode 0xF4)<br />
uint32_t alternate_voices; // 0x28: bitset that indicates the sub-voices used for alternate voice (opcode 0xF8)<br />
uint32_t noise_voices; // 0x2c: bitset that indicates the voices with noise mode enabled<br />
uint32_t reverb_voices; // 0x30: bitset that indicates the voices with reverb enabled<br />
uint32_t pitch_lfo_voices; // 0x34: bitset that indicates the voices with pitch LFO (frequency modulation) mode enabled<br />
uint32_t spucnt; // 0x38: SPUCNT shadow<br />
uint32_t reverb_type; // 0x3c: reverb type<br />
uint32_t reverb_depth; // 0x40: reverb depth (Q16 fixed-point number)<br />
int32_t reverb_depth_slope; // 0x44: slope of reverb depth slider (Q16 fixed-point number)<br />
uint16_t tempo_slide_length; // 0x48: tempo slide length<br />
uint16_t song_id; // 0x4a: current song id<br />
uint16_t condition_ack; // 0x4c: the last matched condition value (opcode 0xEF)<br />
uint16_t condition; // 0x4e: condition variable for dynamic branching according to game status (opcode 0xEF)<br />
uint16_t reverb_depth_slide_length; // 0x50: length of reverb depth slide<br />
uint16_t noise_clock; // 0x52: noise clock frequency<br />
uint16_t field_54; // 0x54: unknown<br />
uint16_t beats_per_measure; // 0x56: beats per measure<br />
uint16_t beat; // 0x58: current beat<br />
uint16_t ticks_per_beat; // 0x5a: ticks per beat<br />
uint16_t tick; // 0x5c: current ticks per beat<br />
uint16_t measure; // 0x5e: current measure<br />
};<br />
<br />
struct AkaoPlayerTrack // the music player track instances exist at 0x80096608 + (N * 0x108)<br />
{<br />
uint8_t *addr; // 0x00<br />
uint8_t *loop_addrs[4]; // 0x04<br />
AkaoDrumKeyAttr *drum_addr; // 0x14<br />
int16_t *vibrato_lfo_addr; // 0x18<br />
int16_t *tremolo_lfo_addr; // 0x1c<br />
int16_t *pan_lfo_addr; // 0x20<br />
uint32_t overlay_voice_num; // 0x24<br />
uint32_t alternate_voice_num; // 0x28<br />
uint32_t master_volume; // 0x2c<br />
uint32_t pitch_of_note; // 0x30<br />
int32_t pitch_bend_slide_amplitude; // 0x34<br />
uint16_t voice_effect_flags; // 0x38<br />
uint16_t field_3A; // 0x3a<br />
uint16_t field_3C; // 0x3c<br />
uint16_t field_3E; // 0x3e<br />
uint32_t field_40; // 0x40<br />
uint32_t volume; // 0x44<br />
int32_t volume_slope; // 0x48<br />
int32_t pitch_bend_slope; // 0x4c<br />
uint16_t field_50; // 0x50<br />
uint16_t field_52; // 0x52<br />
uint16_t field_54; // 0x54<br />
uint8_t delta_time_counter; // 0x56<br />
uint8_t gate_time_counter; // 0x57<br />
uint16_t instrument; // 0x58<br />
uint16_t field_5A; // 0x5a<br />
uint16_t volume_slide_length_counter; // 0x5c<br />
uint16_t overlay_balance_slide_length_counter; // 0x5e<br />
uint16_t pan; // 0x60<br />
uint16_t pan_slide_length; // 0x62<br />
int16_t pitch_slide_length_counter; // 0x64<br />
uint16_t octave; // 0x66<br />
uint16_t pitch_slide_length; // 0x68<br />
uint16_t previous_note_number; // 0x6a<br />
uint16_t portamento_speed; // 0x6c<br />
uint16_t legato_flags; // 0x6e<br />
uint16_t field_70; // 0x70<br />
uint16_t vibrato_lfo_delay; // 0x72<br />
uint16_t vibrato_delay_counter; // 0x74<br />
uint16_t vibrato_rate; // 0x76<br />
uint16_t vibrato_rate_counter; // 0x78<br />
uint16_t vibrato_form; // 0x7a<br />
uint16_t vibrato_max_amplitude; // 0x7c<br />
uint16_t vibrato_depth; // 0x7e<br />
uint16_t vibrato_depth_slide_length_counter; // 0x80<br />
int16_t vibrato_depth_slope; // 0x82<br />
uint16_t field_84; // 0x84<br />
uint16_t tremolo_delay; // 0x86<br />
uint16_t tremolo_delay_counter; // 0x88<br />
uint16_t tremolo_rate; // 0x8a<br />
uint16_t tremolo_rate_counter; // 0x8c<br />
uint16_t tremolo_form; // 0x8e<br />
uint16_t tremolo_depth; // 0x90<br />
uint16_t tremolo_depth_slide_length_counter; // 0x92<br />
int16_t tremolo_depth_slope; // 0x94<br />
uint16_t field_96; // 0x96<br />
uint16_t pan_lfo_rate; // 0x98<br />
uint16_t pan_lfo_rate_counter; // 0x9a<br />
uint16_t pan_lfo_form; // 0x9c<br />
uint16_t pan_lfo_depth; // 0x9e<br />
uint16_t pan_lfo_depth_slide_length_counter; // 0xa0<br />
int16_t pan_lfo_slope; // 0xa2<br />
uint16_t noise_on_off_delay_counter; // 0xa4<br />
uint16_t pitchmod_on_off_delay_counter; // 0xa6<br />
uint8_t field_A8[16]; // 0xa8<br />
uint16_t loop_layer; // 0xb8<br />
uint16_t loop_counts[4]; // 0xba<br />
uint16_t previous_delta_time; // 0xc2<br />
uint16_t forced_delta_time; // 0xc4<br />
uint16_t overlay_balance; // 0xc6<br />
int16_t overlay_balance_slope; // 0xc8<br />
int16_t pan_slope; // 0xca<br />
int16_t transpose; // 0xcc<br />
int16_t tuning; // 0xce<br />
uint16_t note; // 0xd0<br />
int16_t pitch_slide_amount; // 0xd2<br />
int16_t previous_transpose; // 0xd4<br />
int16_t vibrato_lfo_amplitude; // 0xd6<br />
int16_t tremolo_lfo_amplitude; // 0xd8<br />
int16_t pan_lfo_amplitude; // 0xda<br />
AkaoSpuVoiceAttr spu_attr; // 0xdc<br />
};</div>
Loveemu
https://wiki.ffrtt.ru/index.php?title=FF7/PSX/Sound/Code_Map&diff=5740
FF7/PSX/Sound/Code Map
2020-06-07T15:03:50Z
<p>Loveemu: </p>
<hr />
<div>= Code Map =<br />
<br />
Introduces functions, variables and data related to sound, contained in SCUS_941.63 (game program of US version). Note that all symbol names below are for convenience only.<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x800293D0<br />
|void _AkaoSpuTransferCallback(void)<br />
|<br />
|-<br />
|0x800293F4<br />
|void _AkaoSpuSetTransferCallback(void)<br />
|<br />
|-<br />
|0x80029424<br />
|unsigned int _AkaoTransferSamples(const unsigned char *addr, unsigned int size)<br />
|<br />
|-<br />
|0x800294A4<br />
|void _AkaoWaitForSpuTransfer(void)<br />
|<br />
|-<br />
|0x800294BC<br />
|void _AkaoReset(void)<br />
|<br />
|-<br />
|0x800297A4<br />
|void AkaoLoadInstrumentSet(const sturct AkaoSampleSet *sampleSet, const struct AkaoInstrumentAttr *instrumentSet)<br />
|Load standard instrument set<br />
<br />
''sampleSet'': corresponding to SOUND/INSTR.ALL<br />
<br />
''instrumentSet'': corresponding to SOUND/INSTR.DAT<br />
<br />
This function is called transparently from 0x8002988C.<br />
|-<br />
|0x80029818<br />
|void AkaoLoadInstrumentSet2(const sturct AkaoSampleSet *sampleSet, const struct AkaoInstrumentAttr *instrumentSet)<br />
|Load additional instrument set<br />
<br />
''sampleSet'': corresponding to SOUND/INSTR2.ALL<br />
<br />
''instrumentSet'': corresponding to SOUND/INSTR2.DAT<br />
|-<br />
|0x8002988C<br />
|void AkaoInitialize(const sturct AkaoSampleSet *sampleSet, const struct AkaoInstrumentAttr *instrumentSet)<br />
|Initialize sound driver and load initial instruments<br />
<br />
''sampleSet'': corresponding to SOUND/INSTR.ALL<br />
<br />
''instrumentSet'': corresponding to SOUND/INSTR.DAT<br />
|-<br />
|0x800299C8<br />
|void AkaoDeinitialize(void)<br />
|Deinitialize sound driver<br />
|-<br />
|0x80029AF0<br />
|void AkaoSetReverbMode(int mode)<br />
|<br />
|-<br />
|0x80029B78<br />
|void _AkaoTransferSeqBody(const unsigned char *data, int size)<br />
|<br />
|-<br />
|0x80029C48<br />
|void _AkaoLoadTracks(void)<br />
|<br />
|-<br />
|0x8002DA30<br />
|void AkaoNewMessage(AkaoMessage **ppMessage)<br />
|<br />
|-<br />
|0x8002DA7C<br />
|int AkaoPostMessage(void)<br />
|Post a new command message to the queue (with some wrapped processing)<br />
<br />
The message data comes from a global variable at 0x8009A000.<br />
<br />
Return value depends on the content of the message data.<br />
<br />
<br />
'''Opcode 0x10'''<br />
<br />
Load and start playing new [[FF7/PSX/Sound/AKAO sequence|AKAO sequence]]<br />
<br />
Returns: 0 for success, 1 for already loaded, and -1 for invalid signature<br />
<br />
<br />
'''Opcode 0x92'''<br />
<br />
Set value to the condition variable used by Opcode 0xEF.<br />
|-<br />
|0x8002E1A8<br />
|void _AkaoDispatchMessages(void)<br />
|<br />
|-<br />
|0x8002E23C<br />
|void _AkaoWriteSpuRegisters(int voiceNum, AkaoSpuVoiceAttr *attr)<br />
|<br />
|-<br />
|0x8002E478<br />
|void _AkaoDspOnTick(AkaoPlayerTrack *track, AkaoPlayer *player, int voiceMask)<br />
|<br />
|-<br />
|0x8002ED34<br />
|void _AkaoCalculateVolumeAndPitch(AkaoPlayerTrack *track, int voiceMask, int voiceNum)<br />
|<br />
|-<br />
|0x8002F24C<br />
|void _AkaoCalculateVolumeAndPitch2(AkaoPlayerTrack *track, int voiceMask)<br />
|<br />
|-<br />
|0x8002F738<br />
|void _AkaoDspOverlayVoice(AkaoPlayerTrack *track, int unknownVoiceMask, int voiceNum)<br />
|<br />
|-<br />
|0x8002F848<br />
|void _AkaoDspMain(void)<br />
|<br />
|-<br />
|0x8002FF4C<br />
|void _AkaoSpuNoiseVoice(void)<br />
|<br />
|-<br />
|0x80030038<br />
|void _AkaoSpuReverbVoice(void)<br />
|<br />
|-<br />
|0x80030148<br />
|void _AkaoSpuPitchLFOVoice(void)<br />
|<br />
|-<br />
|0x80030234<br />
|int _AkaoTimerCallback(void)<br />
|Sound callback event that is periodically triggered by root counter 2<br />
|-<br />
|0x800308D4<br />
|void _AkaoMain(void)<br />
|<br />
|-<br />
|0x80030E7C<br />
|void _AkaoDispatchVoice(AkaoPlayerTrack *track, AkaoPlayer *player, int voiceMask)<br />
|Dispatch voice opcodes until the next note or end of track<br />
|-<br />
|0x80031820<br />
|void AkaoSetInstrument(AkaoPlayerTrack *track, unsigned short progNumber)<br />
|<br />
|-<br />
|0x800318BC<br />
|int _AkaoReadNextNote(AkaoPlayerTrack *track)<br />
|<br />
|-<br />
|0x80031A70<br />
|int _AkaoFindNextEndPoint(AkaoPlayerTrack *track)<br />
|<br />
|-<br />
|0x80049548<br />
|void (* const MESSAGE_HANDLERS[256])(struct AkaoMessage *)<br />
|<br />
|-<br />
|0x80049948<br />
|const unsigned char VOICE_OPCODE_LENGTHS[0x60]<br />
|Length table for voice opcodes 0xa0-0xff<br />
<br />
0 for end of track and branches<br />
|-<br />
|0x80049AA8<br />
|void (* const VOICE_OPCODES[0x60])(struct MusicPlayerTrack *, void *, int)<br />
|Address table for voice opcodes 0xa0-0xff<br />
|-<br />
|0x80049C28<br />
|const unsigned short DELTA_TIME_TABLE[11];<br />
|<br />
|-<br />
|0x80049C44<br />
|const unsigned short VOLUME_TABLE_L[128]<br />
|See [[FF7/PSX/Sound/Opcodes/0xa8aa|Opcode 0xAA]] for volume balance calculation<br />
|-<br />
|0x80049E44<br />
|const unsigned short VOLUME_TABLE_R[128]<br />
|See [[FF7/PSX/Sound/Opcodes/0xa8aa|Opcode 0xAA]] for volume balance calculation<br />
|-<br />
|0x8004A5CC<br />
|const short *LFO_FORMS[16]<br />
|<br />
|-<br />
|0x8004A60C<br />
|const unsigned char EMPTY_ADPCM[32]<br />
|<br />
|-<br />
|0x80083580<br />
|unsigned char g_AkaoSeqData[]<br />
|RAM area to load AKAO sequence data<br />
|-<br />
|0x8009A000<br />
|AkaoMessage g_AkaoMessage<br />
|Message data to be posted. Processed by the function 0x8002DA7C<br />
|}<br />
<br />
== Runtime Library Functions ==<br />
<br />
=== LIBSPU ===<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x80036298<br />
|void SpuInit(void)<br />
|<br />
|-<br />
|0x80036FFC<br />
|long SpuInitMalloc(long num, char *top)<br />
|<br />
|-<br />
|0x800373AC<br />
|long SpuMallocWithStartAddr(unsigned long addr, long size)<br />
|<br />
|-<br />
|0x80037964<br />
|unsigned long SpuSetNoiseVoice(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x80037B90<br />
|long SpuSetNoiseClock(long n_clock)<br />
|<br />
|-<br />
|0x80037BE0<br />
|unsigned long SpuRead(unsigned char *addr, unsigned long size)<br />
|<br />
|-<br />
|0x80037C40<br />
|long SpuSetReverb(long on_off)<br />
|<br />
|-<br />
|0x80037D90<br />
|long SpuGetReverb(void)<br />
|<br />
|-<br />
|0x80037E1C<br />
|long SpuSetReverbModeParam(SpuReverbAttr *attr)<br />
|<br />
|-<br />
|0x800387FC<br />
|void SpuGetReverbModeParam (SpuReverbAttr *attr)<br />
|<br />
|-<br />
|0x8003884C<br />
|long SpuSetReverbDepth(SpuReverbAttr *attr)<br />
|<br />
|-<br />
|0x800388C4<br />
|unsigned long SpuSetReverbVoice(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x800388E8<br />
|long SpuClearReverbWorkArea(long mode)<br />
|<br />
|-<br />
|0x80038A84<br />
|long SpuSetIRQ(long on_off)<br />
|<br />
|-<br />
|0x80038BC4<br />
|unsigned long SpuSetIRQAddr(unsigned long addr)<br />
|<br />
|-<br />
|0x80038C04<br />
|SpuIRQCallbackProc SpuSetIRQCallback(SpuIRQCallbackProc func)<br />
|<br />
|-<br />
|0x80038C6C<br />
|void SpuSetKey(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x80038F04<br />
|unsigned long SpuWrite(unsigned char *addr, unsigned long size)<br />
|<br />
|-<br />
|0x80038F64<br />
|unsigned long SpuSetTransferStartAddr(unsigned long addr)<br />
|<br />
|-<br />
|0x80038FB8<br />
|long SpuSetTransferMode(long mode)<br />
|<br />
|-<br />
|0x80038FEC<br />
|SpuTransferCallbackProc SpuSetTransferCallback(SpuTransferCallbackProc func)<br />
|<br />
|-<br />
|0x80039010<br />
|unsigned long SpuSetPitchLFOVoice(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x80039034<br />
|void SpuSetCommonAttr(SpuCommonAttr *attr)<br />
|<br />
|-<br />
|0x800393C8<br />
|void SpuSetVoiceVolume(int voiceNum, short volL, short volR)<br />
|<br />
|-<br />
|0x80039450<br />
|void SpuSetVoiceVolumeAttr(int voiceNum, short volL, short volR, short volModeL, short volModeR)<br />
|<br />
|-<br />
|0x800395C8<br />
|void SpuSetVoicePitch(int voiceNum, unsigned short pitch)<br />
|<br />
|-<br />
|0x80039644<br />
|void SpuSetVoiceStartAddr(int voiceNum, unsigned long startAddr)<br />
|<br />
|-<br />
|0x800396C0<br />
|void SpuSetVoiceLoopStartAddr(int voiceNum, unsigned long lsa)<br />
|<br />
|-<br />
|0x8003973C<br />
|void SpuSetVoiceDR(int voiceNum, unsigned short DR)<br />
|<br />
|-<br />
|0x800397C8<br />
|void SpuSetVoiceSL(int voiceNum, unsigned short SL)<br />
|<br />
|-<br />
|0x80039850<br />
|void SpuSetVoiceARAttr(int voiceNum, unsigned short AR, long ARmode)<br />
|<br />
|-<br />
|0x800398EC<br />
|void SpuSetVoiceSRAttr(int voiceNum, unsigned short SR, long SRmode)<br />
|<br />
|-<br />
|0x800399D0<br />
|void SpuSetVoiceRRAttr(int voiceNum, unsigned short RR, long RRmode)<br />
|<br />
|}<br />
<br />
=== LIBETC ===<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x8003D0C0<br />
|int ResetCallback(void)<br />
|<br />
|-<br />
|0x8003D150<br />
|int VSyncCallback(void (*func)(void))<br />
|<br />
|-<br />
|0x8003D1B4<br />
|int StopCallback(void)<br />
|<br />
|-<br />
|0x8003D214<br />
|int CheckCallback(void)<br />
|<br />
|}<br />
<br />
=== LIBAPI ===<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x800429F0<br />
|void DeliverEvent(unsigned long ev1, unsigned long ev2)<br />
|<br />
|-<br />
|0x80042A00<br />
|long OpenEvent(unsigned long desc, long spec, long mode, long (*func)())<br />
|<br />
|-<br />
|0x80042A10<br />
|long CloseEvent(long event)<br />
|<br />
|-<br />
|0x80042A20<br />
|long WaitEvent(long event)<br />
|<br />
|-<br />
|0x80042A40<br />
|long EnableEvent(long event)<br />
|<br />
|-<br />
|0x80042A50<br />
|long DisableEvent(long event)<br />
|<br />
|-<br />
|0x80042BC0<br />
|long SetRCnt(unsigned long spec, unsigned short target, long mode)<br />
|<br />
|-<br />
|0x80042C60<br />
|long GetRCnt(unsigned long spec)<br />
|<br />
|-<br />
|0x80042C98<br />
|long StartRCnt(unsigned long spec)<br />
|<br />
|-<br />
|0x80042CCC<br />
|long StopRCnt(unsigned long spec)<br />
|<br />
|}<br />
<br />
= Structures =<br />
<br />
[[FF7/PSX/Sound/INSTRx.DAT|struct AkaoInstrumentAttr]]<br />
<br />
[[FF7/PSX/Sound/INSTRx.ALL|struct AkaoSampleSet]]<br />
<br />
[[FF7/PSX/Sound/AKAO sequence|struct AkaoSeqHeader]]<br />
<br />
struct AkaoMessage // 36 bytes long<br />
{<br />
uint16_t opcode;<br />
uint16_t reserved;<br />
uint32_t data[8];<br />
};<br />
<br />
struct AkaoSpuVoiceAttr<br />
{<br />
uint32_t voice; // 0x00: voice number<br />
uint32_t update_flags; // 0x04: bitset that indicates what SPU registers need to be updated<br />
uint32_t addr; // 0x08: waveform data start address (SPU address)<br />
uint32_t loop_addr; // 0x0c: loop start address (SPU address)<br />
uint32_t a_mode; // 0x10: ADSR: attack rate mode<br />
uint32_t s_mode; // 0x14: ADSR: sustain rate mode<br />
uint32_t r_mode // 0x18: ADSR: release rate mode<br />
uint16_t pitch; // 0x1c: pitch<br />
uint16_t ar; // 0x1e: ADSR: attack rate<br />
uint16_t dr; // 0x20: ADSR: decay rate<br />
uint16_t sl; // 0x22: ADSR: sustain level<br />
uint16_t sr; // 0x24: ADSR: sustain rate<br />
uint16_t rr; // 0x26: ADSR: release rate<br />
SpuVolume volume; // 0x28: volume (left and right)<br />
};<br />
<br />
struct AkaoPlayer // the music player instance exists at 0x8009A104<br />
{<br />
uint32_t stereo_mode; // 0x00: stereo mode (1: stereo, 4: surround, otherwise: mono)<br />
uint32_t active_voices; // 0x04: bitset that indicates the voices currently in use<br />
uint32_t key_on_voices; // 0x08: bitset that indicates the voices to key on<br />
uint32_t keyed_voices; // 0x0c: bitset that indicates the voices currently keyed on<br />
uint32_t key_off_voices; // 0x10: bitset that indicates the voices to key off<br />
uint32_t saved_active_voices; // 0x14: unknown voice bitset<br />
uint32_t tempo; // 0x18: tempo (Q16 fixed-point number)<br />
int32_t tempo_slope; // 0x1c: slope of tempo slider (Q16 fixed-point number)<br />
uint32_t time_counter; // 0x20: time counter (0x10000 = 1 tick)<br />
uint32_t overlay_voices; // 0x24: bitset that indicates the sub-voices used for overlay (opcode 0xF4)<br />
uint32_t alternate_voices; // 0x28: bitset that indicates the sub-voices used for alternate voice (opcode 0xF8)<br />
uint32_t noise_voices; // 0x2c: bitset that indicates the voices with noise mode enabled<br />
uint32_t reverb_voices; // 0x30: bitset that indicates the voices with reverb enabled<br />
uint32_t pitch_lfo_voices; // 0x34: bitset that indicates the voices with pitch LFO (frequency modulation) mode enabled<br />
uint32_t spucnt; // 0x38: SPUCNT shadow<br />
uint32_t reverb_type; // 0x3c: reverb type<br />
uint32_t reverb_depth; // 0x40: reverb depth (Q16 fixed-point number)<br />
int32_t reverb_depth_slope; // 0x44: slope of reverb depth slider (Q16 fixed-point number)<br />
uint16_t tempo_slide_length; // 0x48: tempo slide length<br />
uint16_t song_id; // 0x4a: current song id<br />
uint16_t condition_ack; // 0x4c: the last matched condition value (opcode 0xEF)<br />
uint16_t condition; // 0x4e: condition variable for dynamic branching according to game status (opcode 0xEF)<br />
uint16_t reverb_depth_slide_length; // 0x50: length of reverb depth slide<br />
uint16_t noise_clock; // 0x52: noise clock frequency<br />
uint16_t field_54; // 0x54: unknown<br />
uint16_t beats_per_measure; // 0x56: beats per measure<br />
uint16_t beat; // 0x58: current beat<br />
uint16_t ticks_per_beat; // 0x5a: ticks per beat<br />
uint16_t tick; // 0x5c: current ticks per beat<br />
uint16_t measure; // 0x5e: current measure<br />
};<br />
<br />
struct AkaoPlayerTrack // the music player track instances exist at 0x80096608 + (N * 0x108)<br />
{<br />
uint8_t *addr; // 0x00<br />
uint8_t *loop_addrs[4]; // 0x04<br />
AkaoDrumKeyAttr *drum_addr; // 0x14<br />
int16_t *vibrato_lfo_addr; // 0x18<br />
int16_t *tremolo_lfo_addr; // 0x1c<br />
int16_t *pan_lfo_addr; // 0x20<br />
uint32_t overlay_voice_num; // 0x24<br />
uint32_t alternate_voice_num; // 0x28<br />
uint32_t master_volume; // 0x2c<br />
uint32_t pitch_of_note; // 0x30<br />
int32_t pitch_bend_slide_amplitude; // 0x34<br />
uint16_t voice_effect_flags; // 0x38<br />
uint16_t field_3A; // 0x3a<br />
uint16_t field_3C; // 0x3c<br />
uint16_t field_3E; // 0x3e<br />
uint32_t field_40; // 0x40<br />
uint32_t volume; // 0x44<br />
int32_t volume_slope; // 0x48<br />
int32_t pitch_bend_slope; // 0x4c<br />
uint16_t field_50; // 0x50<br />
uint16_t field_52; // 0x52<br />
uint16_t field_54; // 0x54<br />
uint8_t delta_time_counter; // 0x56<br />
uint8_t gate_time_counter; // 0x57<br />
uint16_t instrument; // 0x58<br />
uint16_t field_5A; // 0x5a<br />
uint16_t volume_slide_length_counter; // 0x5c<br />
uint16_t overlay_balance_slide_length_counter; // 0x5e<br />
uint16_t pan; // 0x60<br />
uint16_t pan_slide_length; // 0x62<br />
int16_t pitch_slide_length_counter; // 0x64<br />
uint16_t octave; // 0x66<br />
uint16_t pitch_slide_length; // 0x68<br />
uint16_t previous_note_number; // 0x6a<br />
uint16_t portamento_speed; // 0x6c<br />
uint16_t legato_flags; // 0x6e<br />
uint16_t field_70; // 0x70<br />
uint16_t vibrato_lfo_delay; // 0x72<br />
uint16_t vibrato_delay_counter; // 0x74<br />
uint16_t vibrato_rate; // 0x76<br />
uint16_t vibrato_rate_counter; // 0x78<br />
uint16_t vibrato_form; // 0x7a<br />
uint16_t vibrato_max_amplitude; // 0x7c<br />
uint16_t vibrato_depth; // 0x7e<br />
uint16_t vibrato_depth_slide_length_counter; // 0x80<br />
int16_t vibrato_depth_slope; // 0x82<br />
uint16_t field_84; // 0x84<br />
uint16_t tremolo_delay; // 0x86<br />
uint16_t tremolo_delay_counter; // 0x88<br />
uint16_t tremolo_rate; // 0x8a<br />
uint16_t tremolo_rate_counter; // 0x8c<br />
uint16_t tremolo_form; // 0x8e<br />
uint16_t tremolo_depth; // 0x90<br />
uint16_t tremolo_depth_slide_length_counter; // 0x92<br />
int16_t tremolo_depth_slope; // 0x94<br />
uint16_t field_96; // 0x96<br />
uint16_t pan_lfo_rate; // 0x98<br />
uint16_t pan_lfo_rate_counter; // 0x9a<br />
uint16_t pan_lfo_form; // 0x9c<br />
uint16_t pan_lfo_depth; // 0x9e<br />
uint16_t pan_lfo_depth_slide_length_counter; // 0xa0<br />
int16_t pan_lfo_slope; // 0xa2<br />
uint16_t noise_on_off_delay_counter; // 0xa4<br />
uint16_t pitchmod_on_off_delay_counter; // 0xa6<br />
uint8_t field_A8[16]; // 0xa8<br />
uint16_t loop_layer; // 0xb8<br />
uint16_t loop_counts[4]; // 0xba<br />
uint16_t previous_delta_time; // 0xc2<br />
uint16_t forced_delta_time; // 0xc4<br />
uint16_t overlay_balance; // 0xc6<br />
int16_t overlay_balance_slope; // 0xc8<br />
int16_t pan_slope; // 0xca<br />
int16_t transpose; // 0xcc<br />
int16_t tuning; // 0xce<br />
uint16_t note; // 0xd0<br />
int16_t pitch_slide_amount; // 0xd2<br />
int16_t previous_transpose; // 0xd4<br />
int16_t vibrato_lfo_amplitude; // 0xd6<br />
int16_t tremolo_lfo_amplitude; // 0xd8<br />
int16_t pan_lfo_amplitude; // 0xda<br />
AkaoSpuVoiceAttr spu_attr; // 0xdc<br />
};</div>
Loveemu
https://wiki.ffrtt.ru/index.php?title=FF7/PSX/Sound/Code_Map&diff=5739
FF7/PSX/Sound/Code Map
2020-06-07T15:03:11Z
<p>Loveemu: </p>
<hr />
<div>= Code Map =<br />
<br />
Introduces functions, variables and data related to sound, contained in SCUS_941.63 (game program of US version). Note that all symbol names below are for convenience only.<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x800293D0<br />
|void _AkaoSpuTransferCallback(void)<br />
|<br />
|-<br />
|0x800293F4<br />
|void _AkaoSpuSetTransferCallback(void)<br />
|<br />
|-<br />
|0x80029424<br />
|unsigned int _AkaoTransferSamples(const unsigned char *addr, unsigned int size)<br />
|<br />
|-<br />
|0x800294A4<br />
|void _AkaoWaitForSpuTransfer(void)<br />
|<br />
|-<br />
|0x800294BC<br />
|void _AkaoReset(void)<br />
|<br />
|-<br />
|0x800297A4<br />
|void AkaoLoadInstrumentSet(const sturct AkaoSampleSet *sampleSet, const struct AkaoInstrumentAttr *instrumentSet)<br />
|Load standard instrument set<br />
<br />
''sampleSet'': corresponding to SOUND/INSTR.ALL<br />
<br />
''instrumentSet'': corresponding to SOUND/INSTR.DAT<br />
<br />
This function is called transparently from 0x8002988C.<br />
|-<br />
|0x80029818<br />
|void AkaoLoadInstrumentSet2(const sturct AkaoSampleSet *sampleSet, const struct AkaoInstrumentAttr *instrumentSet)<br />
|Load additional instrument set<br />
<br />
''sampleSet'': corresponding to SOUND/INSTR2.ALL<br />
<br />
''instrumentSet'': corresponding to SOUND/INSTR2.DAT<br />
|-<br />
|0x8002988C<br />
|void AkaoInitialize(const sturct AkaoSampleSet *sampleSet, const struct AkaoInstrumentAttr *instrumentSet)<br />
|Initialize sound driver and load initial instruments<br />
<br />
''sampleSet'': corresponding to SOUND/INSTR.ALL<br />
<br />
''instrumentSet'': corresponding to SOUND/INSTR.DAT<br />
|-<br />
|0x800299C8<br />
|void AkaoDeinitialize(void)<br />
|Deinitialize sound driver<br />
|-<br />
|0x80029AF0<br />
|void AkaoSetReverbMode(int mode)<br />
|<br />
|-<br />
|0x80029B78<br />
|void _AkaoTransferSeqBody(const unsigned char *data, int size)<br />
|<br />
|-<br />
|0x80029C48<br />
|void _AkaoLoadTracks(void)<br />
|<br />
|-<br />
|0x8002DA30<br />
|void AkaoNewMessage(AkaoMessage **ppMessage)<br />
|<br />
|-<br />
|0x8002DA7C<br />
|int AkaoPostMessage(void)<br />
|Post a new command message to the queue (with some wrapped processing)<br />
<br />
The message data comes from a global variable at 0x8009A000.<br />
<br />
Return value depends on the content of the message data.<br />
<br />
<br />
'''Opcode 0x10'''<br />
<br />
Load and start playing new [[FF7/PSX/Sound/AKAO sequence|AKAO sequence]]<br />
<br />
Returns: 0 for success, 1 for already loaded, and -1 for invalid signature<br />
<br />
<br />
'''Opcode 0x92'''<br />
<br />
Set value to the condition variable used by Opcode 0xEF.<br />
|-<br />
|0x8002E1A8<br />
|void _AkaoDispatchMessages(void)<br />
|<br />
|-<br />
|0x8002E23C<br />
|void _AkaoWriteSpuRegisters(int voiceNum, AkaoSpuVoiceAttr *attr)<br />
|<br />
|-<br />
|0x8002E478<br />
|void _AkaoDspOnTick(AkaoPlayerTrack *track, AkaoPlayer *player, int voiceMask)<br />
|<br />
|-<br />
|0x8002ED34<br />
|void _AkaoCalculateVolumeAndPitch(AkaoPlayerTrack *track, int voiceMask, int voiceNum)<br />
|<br />
|-<br />
|0x8002F24C<br />
|void _AkaoCalculateVolumeAndPitch2(AkaoPlayerTrack *track, int voiceMask)<br />
|<br />
|-<br />
|0x8002F738<br />
|void _AkaoDspOverlayVoice(AkaoPlayerTrack *track, int unknownVoiceMask, int voiceNum)<br />
|<br />
|-<br />
|0x8002F848<br />
|void _AkaoDspMain(void)<br />
|<br />
|-<br />
|0x8002FF4C<br />
|void _AkaoSpuNoiseVoice(void)<br />
|<br />
|-<br />
|0x80030038<br />
|void _AkaoSpuReverbVoice(void)<br />
|<br />
|-<br />
|0x80030148<br />
|void _AkaoSpuPitchLFOVoice(void)<br />
|<br />
|-<br />
|0x80030234<br />
|int _AkaoTimerCallback(void)<br />
|Sound callback event that is periodically triggered by root counter 2<br />
|-<br />
|0x800308D4<br />
|void _AkaoMain(void)<br />
|<br />
|-<br />
|0x80030E7C<br />
|void _AkaoDispatchVoice(AkaoPlayerTrack *track, AkaoPlayer *player, int voiceMask)<br />
|Dispatch voice opcodes until the next note or end of track<br />
|-<br />
|0x80031820<br />
|void AkaoSetInstrument(AkaoPlayerTrack *track, unsigned short progNumber)<br />
|<br />
|-<br />
|0x800318BC<br />
|int _AkaoReadNextNote(AkaoPlayerTrack *track)<br />
|<br />
|-<br />
|0x80031A70<br />
|int _AkaoFindNextEndPoint(AkaoPlayerTrack *track)<br />
|<br />
|-<br />
|0x80049548<br />
|void (* const MESSAGE_HANDLERS[256])(struct AkaoMessage *)<br />
|<br />
|-<br />
|0x80049948<br />
|const unsigned char VOICE_OPCODE_LENGTHS[0x60]<br />
|Length table for voice opcodes 0xa0-0xff<br />
<br />
0 for end of track and branches<br />
|-<br />
|0x80049AA8<br />
|void (* const VOICE_OPCODES[0x60])(struct MusicPlayerTrack *, void *, int)<br />
|Address table for voice opcodes 0xa0-0xff<br />
|-<br />
|0x80049C28<br />
|const unsigned short DELTA_TIME_TABLE[11];<br />
|<br />
|-<br />
|0x80049C44<br />
|const unsigned short VOLUME_TABLE_L[128]<br />
|See [[FF7/PSX/Sound/Opcodes/0xa8aa|Opcode 0xAA]] for volume balance calculation<br />
|-<br />
|0x80049E44<br />
|const unsigned short VOLUME_TABLE_R[128]<br />
|See [[FF7/PSX/Sound/Opcodes/0xa8aa|Opcode 0xAA]] for volume balance calculation<br />
|-<br />
|0x8004A5CC<br />
|const short *LFO_FORMS[16]<br />
|<br />
|-<br />
|0x8004A60C<br />
|const unsigned char EMPTY_ADPCM[32]<br />
|<br />
|-<br />
|0x80083580<br />
|unsigned char g_AkaoSeqData[]<br />
|RAM area to load AKAO sequence data<br />
|-<br />
|0x8009A000<br />
|AkaoMessage g_AkaoMessage<br />
|Message data to be posted. Processed by the function 0x8002DA7C<br />
|}<br />
<br />
== Runtime Library Functions ==<br />
<br />
=== LIBSPU ===<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x80036298<br />
|void SpuInit(void)<br />
|<br />
|-<br />
|0x80036FFC<br />
|long SpuInitMalloc(long num, char *top)<br />
|<br />
|-<br />
|0x800373AC<br />
|long SpuMallocWithStartAddr(unsigned long addr, long size)<br />
|<br />
|-<br />
|0x80037964<br />
|unsigned long SpuSetNoiseVoice(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x80037B90<br />
|long SpuSetNoiseClock(long n_clock)<br />
|<br />
|-<br />
|0x80037BE0<br />
|unsigned long SpuRead(unsigned char *addr, unsigned long size)<br />
|<br />
|-<br />
|0x80037C40<br />
|long SpuSetReverb(long on_off)<br />
|<br />
|-<br />
|0x80037D90<br />
|long SpuGetReverb(void)<br />
|<br />
|-<br />
|0x80037E1C<br />
|long SpuSetReverbModeParam(SpuReverbAttr *attr)<br />
|<br />
|-<br />
|0x800387FC<br />
|void SpuGetReverbModeParam (SpuReverbAttr *attr)<br />
|<br />
|-<br />
|0x8003884C<br />
|long SpuSetReverbDepth(SpuReverbAttr *attr)<br />
|<br />
|-<br />
|0x800388C4<br />
|unsigned long SpuSetReverbVoice(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x800388E8<br />
|long SpuClearReverbWorkArea(long mode)<br />
|<br />
|-<br />
|0x80038A84<br />
|long SpuSetIRQ(long on_off)<br />
|<br />
|-<br />
|0x80038BC4<br />
|unsigned long SpuSetIRQAddr(unsigned long addr)<br />
|<br />
|-<br />
|0x80038C04<br />
|SpuIRQCallbackProc SpuSetIRQCallback(SpuIRQCallbackProc func)<br />
|<br />
|-<br />
|0x80038C6C<br />
|void SpuSetKey(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x80038F04<br />
|unsigned long SpuWrite(unsigned char *addr, unsigned long size)<br />
|<br />
|-<br />
|0x80038F64<br />
|unsigned long SpuSetTransferStartAddr(unsigned long addr)<br />
|<br />
|-<br />
|0x80038FB8<br />
|long SpuSetTransferMode(long mode)<br />
|<br />
|-<br />
|0x80038FEC<br />
|SpuTransferCallbackProc SpuSetTransferCallback(SpuTransferCallbackProc func)<br />
|<br />
|-<br />
|0x80039010<br />
|unsigned long SpuSetPitchLFOVoice(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x80039034<br />
|void SpuSetCommonAttr(SpuCommonAttr *attr)<br />
|<br />
|-<br />
|0x800393C8<br />
|void SpuSetVoiceVolume(int voiceNum, short volL, short volR)<br />
|<br />
|-<br />
|0x80039450<br />
|void SpuSetVoiceVolumeAttr(int voiceNum, short volL, short volR, short volModeL, short volModeR)<br />
|<br />
|-<br />
|0x800395C8<br />
|void SpuSetVoicePitch(int voiceNum, unsigned short pitch)<br />
|<br />
|-<br />
|0x80039644<br />
|void SpuSetVoiceStartAddr(int voiceNum, unsigned long startAddr)<br />
|<br />
|-<br />
|0x800396C0<br />
|void SpuSetVoiceLoopStartAddr(int voiceNum, unsigned long lsa)<br />
|<br />
|-<br />
|0x8003973C<br />
|void SpuSetVoiceDR(int voiceNum, unsigned short DR)<br />
|<br />
|-<br />
|0x800397C8<br />
|void SpuSetVoiceSL(int voiceNum, unsigned short SL)<br />
|<br />
|-<br />
|0x80039850<br />
|void SpuSetVoiceARAttr(int voiceNum, unsigned short AR, long ARmode)<br />
|<br />
|-<br />
|0x800398EC<br />
|void SpuSetVoiceSRAttr(int voiceNum, unsigned short SR, long SRmode)<br />
|<br />
|-<br />
|0x800399D0<br />
|void SpuSetVoiceRRAttr(int voiceNum, unsigned short RR, long RRmode)<br />
|<br />
|}<br />
<br />
=== LIBETC ===<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x8003D0C0<br />
|int ResetCallback(void)<br />
|<br />
|-<br />
|0x8003D150<br />
|int VSyncCallback(void (*func)(void))<br />
|<br />
|-<br />
|0x8003D1B4<br />
|int StopCallback(void)<br />
|<br />
|-<br />
|0x8003D214<br />
|int CheckCallback(void)<br />
|<br />
|}<br />
<br />
=== LIBAPI ===<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x800429F0<br />
|void DeliverEvent(unsigned long ev1, unsigned long ev2)<br />
|<br />
|-<br />
|0x80042A00<br />
|long OpenEvent(unsigned long desc, long spec, long mode, long (*func)())<br />
|<br />
|-<br />
|0x80042A10<br />
|long CloseEvent(long event)<br />
|<br />
|-<br />
|0x80042A20<br />
|long WaitEvent(long event)<br />
|<br />
|-<br />
|0x80042A40<br />
|long EnableEvent(long event)<br />
|<br />
|-<br />
|0x80042A50<br />
|long DisableEvent(long event)<br />
|<br />
|-<br />
|0x80042BC0<br />
|long SetRCnt(unsigned long spec, unsigned short target, long mode)<br />
|<br />
|-<br />
|0x80042C60<br />
|long GetRCnt(unsigned long spec)<br />
|<br />
|-<br />
|0x80042C98<br />
|long StartRCnt(unsigned long spec)<br />
|<br />
|-<br />
|0x80042CCC<br />
|long StopRCnt(unsigned long spec)<br />
|<br />
|}<br />
<br />
= Structures =<br />
<br />
[[FF7/PSX/Sound/INSTRx.DAT|struct AkaoInstrumentAttr]]<br />
<br />
[[FF7/PSX/Sound/INSTRx.ALL|struct AkaoSampleSet]]<br />
<br />
[[FF7/PSX/Sound/AKAO sequence|struct AkaoSeqHeader]]<br />
<br />
struct AkaoMessage // 36 bytes long<br />
{<br />
uint16_t opcode;<br />
uint16_t reserved;<br />
uint32_t data[8];<br />
};<br />
<br />
struct AkaoSpuVoiceAttr<br />
{<br />
uint32_t voice; // 0x00: voice number<br />
uint32_t update_flags; // 0x04: bitset that indicates what SPU registers need to be updated<br />
uint32_t addr; // 0x08: waveform data start address (SPU address)<br />
uint32_t loop_addr; // 0x0c: loop start address (SPU address)<br />
uint32_t a_mode; // 0x10: ADSR: attack rate mode<br />
uint32_t s_mode; // 0x14: ADSR: sustain rate mode<br />
uint32_t r_mode // 0x18: ADSR: release rate mode<br />
uint16_t pitch; // 0x1c: pitch<br />
uint16_t ar; // 0x1e: ADSR: attack rate<br />
uint16_t dr; // 0x20: ADSR: decay rate<br />
uint16_t sl; // 0x22: ADSR: sustain level<br />
uint16_t sr; // 0x24: ADSR: sustain rate<br />
uint16_t rr; // 0x26: ADSR: release rate<br />
SpuVolume volume; // 0x28: volume (left and right)<br />
};<br />
<br />
struct AkaoPlayer // the music player instance exists at 0x8009A104<br />
{<br />
uint32_t stereo_mode; // 0x00: stereo mode (1: stereo, 4: surround, otherwise: mono)<br />
uint32_t active_voices; // 0x04: bitset that indicates the voices currently in use<br />
uint32_t key_on_voices; // 0x08: bitset that indicates the voices to key on<br />
uint32_t keyed_voices; // 0x0c: bitset that indicates the voices currently keyed on<br />
uint32_t key_off_voices; // 0x10: bitset that indicates the voices to key off<br />
uint32_t saved_active_voices; // 0x14: unknown voice bitset<br />
uint32_t tempo; // 0x18: tempo (Q16 fixed-point number)<br />
int32_t tempo_slope; // 0x1c: slope of tempo slider (Q16 fixed-point number)<br />
uint32_t time_counter; // 0x20: time counter (0x10000 = 1 tick)<br />
uint32_t overlay_voices; // 0x24: bitset that indicates the sub-voices used for overlay (opcode 0xF4)<br />
uint32_t alternate_voices; // 0x28: bitset that indicates the sub-voices used for alternate voice (opcode 0xF8)<br />
uint32_t noise_voices; // 0x2c: bitset that indicates the voices with noise mode enabled<br />
uint32_t reverb_voices; // 0x30: bitset that indicates the voices with reverb enabled<br />
uint32_t pitch_lfo_voices; // 0x34: bitset that indicates the voices with pitch LFO (frequency modulation) mode enabled<br />
uint32_t spucnt; // 0x38: SPUCNT shadow<br />
uint32_t reverb_type; // 0x3c: reverb type<br />
uint32_t reverb_depth; // 0x40: reverb depth (Q16 fixed-point number)<br />
int32_t reverb_depth_slope; // 0x44: slope of reverb depth slider (Q16 fixed-point number)<br />
uint16_t tempo_slide_length; // 0x48: tempo slide length<br />
uint16_t song_id; // 0x4a: current song id<br />
uint16_t condition_ack; // 0x4c: the last matched condition value (opcode 0xEF)<br />
uint16_t condition; // 0x4e: condition variable for dynamic branching according to game status (opcode 0xEF)<br />
uint16_t reverb_depth_slide_length; // 0x50: length of reverb depth slide<br />
uint16_t noise_clock; // 0x52: noise clock frequency<br />
uint16_t field_54; // 0x54: unknown<br />
uint16_t beats_per_measure; // 0x56: beats per measure<br />
uint16_t beat; // 0x58: current beat<br />
uint16_t ticks_per_beat; // 0x5a: ticks per beat<br />
uint16_t tick; // 0x5c: current ticks per beat<br />
uint16_t measure; // 0x5e: current measure<br />
};<br />
<br />
struct AkaoPlayerTrack // the music player track instances exist at 0x80096608 + (N * 0x108)<br />
{<br />
uint8_t *addr; // 0x00<br />
uint8_t *loop_addrs[4]; // 0x04<br />
AkaoDrumKeyAttr *drum_addr; // 0x14<br />
int16_t *vibrato_lfo_addr; // 0x18<br />
int16_t *tremolo_lfo_addr; // 0x1C<br />
int16_t *pan_lfo_addr; // 0x20<br />
uint32_t overlay_voice_num; // 0x24<br />
uint32_t alternate_voice_num; // 0x28<br />
uint32_t master_volume; // 0x2C<br />
uint32_t pitch_of_note; // 0x30<br />
int32_t pitch_bend_slide_amplitude; // 0x34<br />
uint16_t voice_effect_flags; // 0x38<br />
uint16_t field_3A; // 0x3A<br />
uint16_t field_3C; // 0x3C<br />
uint16_t field_3E; // 0x3E<br />
uint32_t field_40; // 0x40<br />
uint32_t volume; // 0x44<br />
int32_t volume_slope; // 0x48<br />
int32_t pitch_bend_slope; // 0x4C<br />
uint16_t field_50; // 0x50<br />
uint16_t field_52; // 0x52<br />
uint16_t field_54; // 0x54<br />
uint8_t delta_time_counter; // 0x56<br />
uint8_t gate_time_counter; // 0x57<br />
uint16_t instrument; // 0x58<br />
uint16_t field_5A; // 0x5A<br />
uint16_t volume_slide_length_counter; // 0x5C<br />
uint16_t overlay_balance_slide_length_counter; // 0x5E<br />
uint16_t pan; // 0x60<br />
uint16_t pan_slide_length; // 0x62<br />
int16_t pitch_slide_length_counter; // 0x64<br />
uint16_t octave; // 0x66<br />
uint16_t pitch_slide_length; // 0x68<br />
uint16_t previous_note_number; // 0x6A<br />
uint16_t portamento_speed; // 0x6C<br />
uint16_t legato_flags; // 0x6E<br />
uint16_t field_70; // 0x70<br />
uint16_t vibrato_lfo_delay; // 0x72<br />
uint16_t vibrato_delay_counter; // 0x74<br />
uint16_t vibrato_rate; // 0x76<br />
uint16_t vibrato_rate_counter; // 0x78<br />
uint16_t vibrato_form; // 0x7A<br />
uint16_t vibrato_max_amplitude; // 0x7C<br />
uint16_t vibrato_depth; // 0x7E<br />
uint16_t vibrato_depth_slide_length_counter; // 0x80<br />
int16_t vibrato_depth_slope; // 0x82<br />
uint16_t field_84; // 0x84<br />
uint16_t tremolo_delay; // 0x86<br />
uint16_t tremolo_delay_counter; // 0x88<br />
uint16_t tremolo_rate; // 0x8A<br />
uint16_t tremolo_rate_counter; // 0x8C<br />
uint16_t tremolo_form; // 0x8E<br />
uint16_t tremolo_depth; // 0x90<br />
uint16_t tremolo_depth_slide_length_counter; // 0x92<br />
int16_t tremolo_depth_slope; // 0x94<br />
uint16_t field_96; // 0x96<br />
uint16_t pan_lfo_rate; // 0x98<br />
uint16_t pan_lfo_rate_counter; // 0x9A<br />
uint16_t pan_lfo_form; // 0x9C<br />
uint16_t pan_lfo_depth; // 0x9E<br />
uint16_t pan_lfo_depth_slide_length_counter; // 0xA0<br />
int16_t pan_lfo_slope; // 0xA2<br />
uint16_t noise_on_off_delay_counter; // 0xA4<br />
uint16_t pitchmod_on_off_delay_counter; // 0xA6<br />
uint8_t field_A8[16]; // 0xA8<br />
uint16_t loop_layer; // 0xB8<br />
uint16_t loop_counts[4]; // 0xBA<br />
uint16_t previous_delta_time; // 0xC2<br />
uint16_t forced_delta_time; // 0xC4<br />
uint16_t overlay_balance; // 0xC6<br />
int16_t overlay_balance_slope; // 0xC8<br />
int16_t pan_slope; // 0xCA<br />
int16_t transpose; // 0xCC<br />
int16_t tuning; // 0xCE<br />
uint16_t note; // 0xD0<br />
int16_t pitch_slide_amount; // 0xD2<br />
int16_t previous_transpose; // 0xD4<br />
int16_t vibrato_lfo_amplitude; // 0xD6<br />
int16_t tremolo_lfo_amplitude; // 0xD8<br />
int16_t pan_lfo_amplitude; // 0xDA<br />
AkaoSpuVoiceAttr spu_attr; // 0xDC<br />
};</div>
Loveemu
https://wiki.ffrtt.ru/index.php?title=FF7/PSX/Sound/Code_Map&diff=5738
FF7/PSX/Sound/Code Map
2020-06-07T14:39:20Z
<p>Loveemu: </p>
<hr />
<div>= Code Map =<br />
<br />
Introduces functions, variables and data related to sound, contained in SCUS_941.63 (game program of US version). Note that all symbol names below are for convenience only.<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x800293D0<br />
|void _AkaoSpuTransferCallback(void)<br />
|<br />
|-<br />
|0x800293F4<br />
|void _AkaoSpuSetTransferCallback(void)<br />
|<br />
|-<br />
|0x80029424<br />
|unsigned int _AkaoTransferSamples(const unsigned char *addr, unsigned int size)<br />
|<br />
|-<br />
|0x800294A4<br />
|void _AkaoWaitForSpuTransfer(void)<br />
|<br />
|-<br />
|0x800294BC<br />
|void _AkaoReset(void)<br />
|<br />
|-<br />
|0x800297A4<br />
|void AkaoLoadInstrumentSet(const sturct AkaoSampleSet *sampleSet, const struct AkaoInstrumentAttr *instrumentSet)<br />
|Load standard instrument set<br />
<br />
''sampleSet'': corresponding to SOUND/INSTR.ALL<br />
<br />
''instrumentSet'': corresponding to SOUND/INSTR.DAT<br />
<br />
This function is called transparently from 0x8002988C.<br />
|-<br />
|0x80029818<br />
|void AkaoLoadInstrumentSet2(const sturct AkaoSampleSet *sampleSet, const struct AkaoInstrumentAttr *instrumentSet)<br />
|Load additional instrument set<br />
<br />
''sampleSet'': corresponding to SOUND/INSTR2.ALL<br />
<br />
''instrumentSet'': corresponding to SOUND/INSTR2.DAT<br />
|-<br />
|0x8002988C<br />
|void AkaoInitialize(const sturct AkaoSampleSet *sampleSet, const struct AkaoInstrumentAttr *instrumentSet)<br />
|Initialize sound driver and load initial instruments<br />
<br />
''sampleSet'': corresponding to SOUND/INSTR.ALL<br />
<br />
''instrumentSet'': corresponding to SOUND/INSTR.DAT<br />
|-<br />
|0x800299C8<br />
|void AkaoDeinitialize(void)<br />
|Deinitialize sound driver<br />
|-<br />
|0x80029AF0<br />
|void AkaoSetReverbMode(int mode)<br />
|<br />
|-<br />
|0x80029B78<br />
|void _AkaoTransferSeqBody(const unsigned char *data, int size)<br />
|<br />
|-<br />
|0x80029C48<br />
|void _AkaoLoadTracks(void)<br />
|<br />
|-<br />
|0x8002DA30<br />
|void AkaoNewMessage(AkaoMessage **ppMessage)<br />
|<br />
|-<br />
|0x8002DA7C<br />
|int AkaoPostMessage(void)<br />
|Post a new command message to the queue (with some wrapped processing)<br />
<br />
The message data comes from a global variable at 0x8009A000.<br />
<br />
Return value depends on the content of the message data.<br />
<br />
<br />
'''Opcode 0x10'''<br />
<br />
Load and start playing new [[FF7/PSX/Sound/AKAO sequence|AKAO sequence]]<br />
<br />
Returns: 0 for success, 1 for already loaded, and -1 for invalid signature<br />
<br />
<br />
'''Opcode 0x92'''<br />
<br />
Set value to the condition variable used by Opcode 0xEF.<br />
|-<br />
|0x8002E1A8<br />
|void _AkaoDispatchMessages(void)<br />
|<br />
|-<br />
|0x8002E23C<br />
|void _AkaoWriteSpuRegisters(int voiceNum, AkaoSpuVoiceAttr *attr)<br />
|<br />
|-<br />
|0x8002E478<br />
|void _AkaoDspOnTick(AkaoPlayerTrack *track, AkaoPlayer *player, int voiceMask)<br />
|<br />
|-<br />
|0x8002ED34<br />
|void _AkaoCalculateVolumeAndPitch(AkaoPlayerTrack *track, int voiceMask, int voiceNum)<br />
|<br />
|-<br />
|0x8002F24C<br />
|void _AkaoCalculateVolumeAndPitch2(AkaoPlayerTrack *track, int voiceMask)<br />
|<br />
|-<br />
|0x8002F738<br />
|void _AkaoDspOverlayVoice(AkaoPlayerTrack *track, int unknownVoiceMask, int voiceNum)<br />
|<br />
|-<br />
|0x8002F848<br />
|void _AkaoDspMain(void)<br />
|<br />
|-<br />
|0x8002FF4C<br />
|void _AkaoSpuNoiseVoice(void)<br />
|<br />
|-<br />
|0x80030038<br />
|void _AkaoSpuReverbVoice(void)<br />
|<br />
|-<br />
|0x80030148<br />
|void _AkaoSpuPitchLFOVoice(void)<br />
|<br />
|-<br />
|0x80030234<br />
|int _AkaoCallback(void)<br />
|Callback event for sound, registered by OpenEvent BIOS function<br />
|-<br />
|0x80030E7C<br />
|void _AkaoDispatchVoice(struct MusicPlayerTrack *track, void *a1, int a2)<br />
|Dispatch voice opcodes until the next note or end of track<br />
|-<br />
|0x80049548<br />
|void (* const MESSAGE_HANDLERS[256])(struct AkaoMessage *)<br />
|<br />
|-<br />
|0x80049948<br />
|const unsigned char VOICE_OPCODE_LENGTHS[0x60]<br />
|Length table for voice opcodes 0xa0-0xff<br />
<br />
0 for end of track and branches<br />
|-<br />
|0x80049AA8<br />
|void (* const VOICE_OPCODES[0x60])(struct MusicPlayerTrack *, void *, int)<br />
|Address table for voice opcodes 0xa0-0xff<br />
|-<br />
|0x80049C44<br />
|const unsigned short VOLUME_TABLE_L[256]<br />
|See [[FF7/PSX/Sound/Opcodes/0xa8aa|Opcode 0xAA]] for volume balance calculation<br />
|-<br />
|0x80049E44<br />
|const unsigned short VOLUME_TABLE_R[256]<br />
|See [[FF7/PSX/Sound/Opcodes/0xa8aa|Opcode 0xAA]] for volume balance calculation<br />
|-<br />
|0x80083580<br />
|unsigned char g_AkaoSeqData[]<br />
|RAM area to load AKAO sequence data<br />
|}<br />
<br />
== Runtime Library Functions ==<br />
<br />
=== LIBSPU ===<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x80036298<br />
|void SpuInit(void)<br />
|<br />
|-<br />
|0x80036FFC<br />
|long SpuInitMalloc(long num, char *top)<br />
|<br />
|-<br />
|0x800373AC<br />
|long SpuMallocWithStartAddr(unsigned long addr, long size)<br />
|<br />
|-<br />
|0x80037964<br />
|unsigned long SpuSetNoiseVoice(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x80037B90<br />
|long SpuSetNoiseClock(long n_clock)<br />
|<br />
|-<br />
|0x80037BE0<br />
|unsigned long SpuRead(unsigned char *addr, unsigned long size)<br />
|<br />
|-<br />
|0x80037C40<br />
|long SpuSetReverb(long on_off)<br />
|<br />
|-<br />
|0x80037D90<br />
|long SpuGetReverb(void)<br />
|<br />
|-<br />
|0x80037E1C<br />
|long SpuSetReverbModeParam(SpuReverbAttr *attr)<br />
|<br />
|-<br />
|0x800387FC<br />
|void SpuGetReverbModeParam (SpuReverbAttr *attr)<br />
|<br />
|-<br />
|0x8003884C<br />
|long SpuSetReverbDepth(SpuReverbAttr *attr)<br />
|<br />
|-<br />
|0x800388C4<br />
|unsigned long SpuSetReverbVoice(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x800388E8<br />
|long SpuClearReverbWorkArea(long mode)<br />
|<br />
|-<br />
|0x80038A84<br />
|long SpuSetIRQ(long on_off)<br />
|<br />
|-<br />
|0x80038BC4<br />
|unsigned long SpuSetIRQAddr(unsigned long addr)<br />
|<br />
|-<br />
|0x80038C04<br />
|SpuIRQCallbackProc SpuSetIRQCallback(SpuIRQCallbackProc func)<br />
|<br />
|-<br />
|0x80038C6C<br />
|void SpuSetKey(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x80038F04<br />
|unsigned long SpuWrite(unsigned char *addr, unsigned long size)<br />
|<br />
|-<br />
|0x80038F64<br />
|unsigned long SpuSetTransferStartAddr(unsigned long addr)<br />
|<br />
|-<br />
|0x80038FB8<br />
|long SpuSetTransferMode(long mode)<br />
|<br />
|-<br />
|0x80038FEC<br />
|SpuTransferCallbackProc SpuSetTransferCallback(SpuTransferCallbackProc func)<br />
|<br />
|-<br />
|0x80039010<br />
|unsigned long SpuSetPitchLFOVoice(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x80039034<br />
|void SpuSetCommonAttr(SpuCommonAttr *attr)<br />
|<br />
|-<br />
|0x800393C8<br />
|void SpuSetVoiceVolume(int voiceNum, short volL, short volR)<br />
|<br />
|-<br />
|0x80039450<br />
|void SpuSetVoiceVolumeAttr(int voiceNum, short volL, short volR, short volModeL, short volModeR)<br />
|<br />
|-<br />
|0x800395C8<br />
|void SpuSetVoicePitch(int voiceNum, unsigned short pitch)<br />
|<br />
|-<br />
|0x80039644<br />
|void SpuSetVoiceStartAddr(int voiceNum, unsigned long startAddr)<br />
|<br />
|-<br />
|0x800396C0<br />
|void SpuSetVoiceLoopStartAddr(int voiceNum, unsigned long lsa)<br />
|<br />
|-<br />
|0x8003973C<br />
|void SpuSetVoiceDR(int voiceNum, unsigned short DR)<br />
|<br />
|-<br />
|0x800397C8<br />
|void SpuSetVoiceSL(int voiceNum, unsigned short SL)<br />
|<br />
|-<br />
|0x80039850<br />
|void SpuSetVoiceARAttr(int voiceNum, unsigned short AR, long ARmode)<br />
|<br />
|-<br />
|0x800398EC<br />
|void SpuSetVoiceSRAttr(int voiceNum, unsigned short SR, long SRmode)<br />
|<br />
|-<br />
|0x800399D0<br />
|void SpuSetVoiceRRAttr(int voiceNum, unsigned short RR, long RRmode)<br />
|<br />
|}<br />
<br />
=== LIBETC ===<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x8003D0C0<br />
|int ResetCallback(void)<br />
|<br />
|-<br />
|0x8003D150<br />
|int VSyncCallback(void (*func)(void))<br />
|<br />
|-<br />
|0x8003D1B4<br />
|int StopCallback(void)<br />
|<br />
|-<br />
|0x8003D214<br />
|int CheckCallback(void)<br />
|<br />
|}<br />
<br />
=== LIBAPI ===<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x800429F0<br />
|void DeliverEvent(unsigned long ev1, unsigned long ev2)<br />
|<br />
|-<br />
|0x80042A00<br />
|long OpenEvent(unsigned long desc, long spec, long mode, long (*func)())<br />
|<br />
|-<br />
|0x80042A10<br />
|long CloseEvent(long event)<br />
|<br />
|-<br />
|0x80042A20<br />
|long WaitEvent(long event)<br />
|<br />
|-<br />
|0x80042A40<br />
|long EnableEvent(long event)<br />
|<br />
|-<br />
|0x80042A50<br />
|long DisableEvent(long event)<br />
|<br />
|-<br />
|0x80042BC0<br />
|long SetRCnt(unsigned long spec, unsigned short target, long mode)<br />
|<br />
|-<br />
|0x80042C60<br />
|long GetRCnt(unsigned long spec)<br />
|<br />
|-<br />
|0x80042C98<br />
|long StartRCnt(unsigned long spec)<br />
|<br />
|-<br />
|0x80042CCC<br />
|long StopRCnt(unsigned long spec)<br />
|<br />
|}<br />
<br />
= Structures =<br />
<br />
[[FF7/PSX/Sound/INSTRx.DAT|struct AkaoInstrumentAttr]]<br />
<br />
[[FF7/PSX/Sound/INSTRx.ALL|struct AkaoSampleSet]]<br />
<br />
[[FF7/PSX/Sound/AKAO sequence|struct AkaoSeqHeader]]<br />
<br />
struct AkaoMessage // 36 bytes long<br />
{<br />
uint16_t opcode;<br />
uint16_t reserved;<br />
uint32_t data[8];<br />
};<br />
<br />
struct AkaoSpuVoiceAttr<br />
{<br />
uint32_t voice; // 0x00: voice number<br />
uint32_t update_flags; // 0x04: bitset that indicates what SPU registers need to be updated<br />
uint32_t addr; // 0x08: waveform data start address (SPU address)<br />
uint32_t loop_addr; // 0x0c: loop start address (SPU address)<br />
uint32_t a_mode; // 0x10: ADSR: attack rate mode<br />
uint32_t s_mode; // 0x14: ADSR: sustain rate mode<br />
uint32_t r_mode // 0x18: ADSR: release rate mode<br />
uint16_t pitch; // 0x1c: pitch<br />
uint16_t ar; // 0x1e: ADSR: attack rate<br />
uint16_t dr; // 0x20: ADSR: decay rate<br />
uint16_t sl; // 0x22: ADSR: sustain level<br />
uint16_t sr; // 0x24: ADSR: sustain rate<br />
uint16_t rr; // 0x26: ADSR: release rate<br />
SpuVolume volume; // 0x28: volume (left and right)<br />
};<br />
<br />
struct AkaoPlayer // the music player instance exists at 0x8009A104<br />
{<br />
uint32_t stereo_mode; // 0x00: stereo mode (1: stereo, 4: surround, otherwise: mono)<br />
uint32_t active_voices; // 0x04: bitset that indicates the voices currently in use<br />
uint32_t key_on_voices; // 0x08: bitset that indicates the voices to key on<br />
uint32_t keyed_voices; // 0x0c: bitset that indicates the voices currently keyed on<br />
uint32_t key_off_voices; // 0x10: bitset that indicates the voices to key off<br />
uint32_t saved_active_voices; // 0x14: unknown voice bitset<br />
uint32_t tempo; // 0x18: tempo (Q16 fixed-point number)<br />
int32_t tempo_slope; // 0x1c: slope of tempo slider (Q16 fixed-point number)<br />
uint32_t time_counter; // 0x20: time counter (0x10000 = 1 tick)<br />
uint32_t overlay_voices; // 0x24: bitset that indicates the sub-voices used for overlay (opcode 0xF4)<br />
uint32_t alternate_voices; // 0x28: bitset that indicates the sub-voices used for alternate voice (opcode 0xF8)<br />
uint32_t noise_voices; // 0x2c: bitset that indicates the voices with noise mode enabled<br />
uint32_t reverb_voices; // 0x30: bitset that indicates the voices with reverb enabled<br />
uint32_t pitch_lfo_voices; // 0x34: bitset that indicates the voices with pitch LFO (frequency modulation) mode enabled<br />
uint32_t spucnt; // 0x38: SPUCNT shadow<br />
uint32_t reverb_type; // 0x3c: reverb type<br />
uint32_t reverb_depth; // 0x40: reverb depth (Q16 fixed-point number)<br />
int32_t reverb_depth_slope; // 0x44: slope of reverb depth slider (Q16 fixed-point number)<br />
uint16_t tempo_slide_length; // 0x48: tempo slide length<br />
uint16_t song_id; // 0x4a: current song id<br />
uint16_t condition_ack; // 0x4c: the last matched condition value (opcode 0xEF)<br />
uint16_t condition; // 0x4e: condition variable for dynamic branching according to game status (opcode 0xEF)<br />
uint16_t reverb_depth_slide_length; // 0x50: length of reverb depth slide<br />
uint16_t noise_clock; // 0x52: noise clock frequency<br />
uint16_t field_54; // 0x54: unknown<br />
uint16_t beats_per_measure; // 0x56: beats per measure<br />
uint16_t beat; // 0x58: current beat<br />
uint16_t ticks_per_beat; // 0x5a: ticks per beat<br />
uint16_t tick; // 0x5c: current ticks per beat<br />
uint16_t measure; // 0x5e: current measure<br />
};<br />
<br />
struct AkaoPlayerTrack // the music player track instances exist at 0x80096608 + (N * 0x108)<br />
{<br />
uint8_t *addr; // 0x00<br />
uint8_t *loop_addrs[4]; // 0x04<br />
AkaoDrumKeyAttr *drum_addr; // 0x14<br />
int16_t *vibrato_lfo_addr; // 0x18<br />
int16_t *tremolo_lfo_addr; // 0x1C<br />
int16_t *pan_lfo_addr; // 0x20<br />
uint32_t overlay_voice_num; // 0x24<br />
uint32_t alternate_voice_num; // 0x28<br />
uint32_t master_volume; // 0x2C<br />
uint32_t pitch_of_note; // 0x30<br />
int32_t pitch_bend_slide_amplitude; // 0x34<br />
uint16_t voice_effect_flags; // 0x38<br />
uint16_t field_3A; // 0x3A<br />
uint16_t field_3C; // 0x3C<br />
uint16_t field_3E; // 0x3E<br />
uint32_t field_40; // 0x40<br />
uint32_t volume; // 0x44<br />
int32_t volume_slope; // 0x48<br />
int32_t pitch_bend_slope; // 0x4C<br />
uint16_t field_50; // 0x50<br />
uint16_t field_52; // 0x52<br />
uint16_t field_54; // 0x54<br />
uint8_t delta_time_counter; // 0x56<br />
uint8_t gate_time_counter; // 0x57<br />
uint16_t instrument; // 0x58<br />
uint16_t field_5A; // 0x5A<br />
uint16_t volume_slide_length_counter; // 0x5C<br />
uint16_t overlay_balance_slide_length_counter; // 0x5E<br />
uint16_t pan; // 0x60<br />
uint16_t pan_slide_length; // 0x62<br />
int16_t pitch_slide_length_counter; // 0x64<br />
uint16_t octave; // 0x66<br />
uint16_t pitch_slide_length; // 0x68<br />
uint16_t previous_note_number; // 0x6A<br />
uint16_t portamento_speed; // 0x6C<br />
uint16_t legato_flags; // 0x6E<br />
uint16_t field_70; // 0x70<br />
uint16_t vibrato_lfo_delay; // 0x72<br />
uint16_t vibrato_delay_counter; // 0x74<br />
uint16_t vibrato_rate; // 0x76<br />
uint16_t vibrato_rate_counter; // 0x78<br />
uint16_t vibrato_form; // 0x7A<br />
uint16_t vibrato_max_amplitude; // 0x7C<br />
uint16_t vibrato_depth; // 0x7E<br />
uint16_t vibrato_depth_slide_length_counter; // 0x80<br />
int16_t vibrato_depth_slope; // 0x82<br />
uint16_t field_84; // 0x84<br />
uint16_t tremolo_delay; // 0x86<br />
uint16_t tremolo_delay_counter; // 0x88<br />
uint16_t tremolo_rate; // 0x8A<br />
uint16_t tremolo_rate_counter; // 0x8C<br />
uint16_t tremolo_form; // 0x8E<br />
uint16_t tremolo_depth; // 0x90<br />
uint16_t tremolo_depth_slide_length_counter; // 0x92<br />
int16_t tremolo_depth_slope; // 0x94<br />
uint16_t field_96; // 0x96<br />
uint16_t pan_lfo_rate; // 0x98<br />
uint16_t pan_lfo_rate_counter; // 0x9A<br />
uint16_t pan_lfo_form; // 0x9C<br />
uint16_t pan_lfo_depth; // 0x9E<br />
uint16_t pan_lfo_depth_slide_length_counter; // 0xA0<br />
int16_t pan_lfo_slope; // 0xA2<br />
uint16_t noise_on_off_delay_counter; // 0xA4<br />
uint16_t pitchmod_on_off_delay_counter; // 0xA6<br />
uint8_t field_A8[16]; // 0xA8<br />
uint16_t loop_layer; // 0xB8<br />
uint16_t loop_counts[4]; // 0xBA<br />
uint16_t previous_delta_time; // 0xC2<br />
uint16_t forced_delta_time; // 0xC4<br />
uint16_t overlay_balance; // 0xC6<br />
int16_t overlay_balance_slope; // 0xC8<br />
int16_t pan_slope; // 0xCA<br />
int16_t transpose; // 0xCC<br />
int16_t tuning; // 0xCE<br />
uint16_t note; // 0xD0<br />
int16_t pitch_slide_amount; // 0xD2<br />
int16_t previous_transpose; // 0xD4<br />
int16_t vibrato_lfo_amplitude; // 0xD6<br />
int16_t tremolo_lfo_amplitude; // 0xD8<br />
int16_t pan_lfo_amplitude; // 0xDA<br />
AkaoSpuVoiceAttr spu_attr; // 0xDC<br />
};</div>
Loveemu
https://wiki.ffrtt.ru/index.php?title=FF7/PSX/Sound/Code_Map&diff=5737
FF7/PSX/Sound/Code Map
2020-06-07T14:09:45Z
<p>Loveemu: </p>
<hr />
<div>= Code Map =<br />
<br />
Introduces functions, variables and data related to sound, contained in SCUS_941.63 (game program of US version). Note that all symbol names below are for convenience only.<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x800293D0<br />
|void _AkaoSpuTransferCallback(void)<br />
|<br />
|-<br />
|0x800293F4<br />
|void _AkaoSpuSetTransferCallback(void)<br />
|<br />
|-<br />
|0x80029424<br />
|unsigned int _AkaoTransferSamples(const unsigned char *addr, unsigned int size)<br />
|<br />
|-<br />
|0x800294A4<br />
|void _AkaoWaitForSpuTransfer(void)<br />
|<br />
|-<br />
|0x800294BC<br />
|void _AkaoReset(void)<br />
|<br />
|-<br />
|0x800297A4<br />
|void AkaoLoadInstrumentSet(const sturct AkaoSampleSet *sampleSet, const struct AkaoInstrumentAttr *instrumentSet)<br />
|Load standard instrument set<br />
<br />
''sampleSet'': corresponding to SOUND/INSTR.ALL<br />
<br />
''instrumentSet'': corresponding to SOUND/INSTR.DAT<br />
<br />
This function is called transparently from 0x8002988C.<br />
|-<br />
|0x80029818<br />
|void AkaoLoadInstrumentSet2(const sturct AkaoSampleSet *sampleSet, const struct AkaoInstrumentAttr *instrumentSet)<br />
|Load additional instrument set<br />
<br />
''sampleSet'': corresponding to SOUND/INSTR2.ALL<br />
<br />
''instrumentSet'': corresponding to SOUND/INSTR2.DAT<br />
|-<br />
|0x8002988C<br />
|void AkaoInitialize(const sturct AkaoSampleSet *sampleSet, const struct AkaoInstrumentAttr *instrumentSet)<br />
|Initialize sound driver and load initial instruments<br />
<br />
''sampleSet'': corresponding to SOUND/INSTR.ALL<br />
<br />
''instrumentSet'': corresponding to SOUND/INSTR.DAT<br />
|-<br />
|0x800299C8<br />
|void AkaoDeinitialize(void)<br />
|Deinitialize sound driver<br />
|-<br />
|0x80029AF0<br />
|void AkaoSetReverbMode(int mode)<br />
|<br />
|-<br />
|0x80029B78<br />
|void _AkaoTransferSeqBody(const unsigned char *data, int size)<br />
|<br />
|-<br />
|0x80029C48<br />
|void _AkaoLoadTracks(void)<br />
|<br />
|-<br />
|0x8002DA30<br />
|void AkaoNewMessage(AkaoMessage **ppMessage)<br />
|<br />
|-<br />
|0x8002DA7C<br />
|int AkaoPostMessage(void)<br />
|Post a new command message to the queue (with some wrapped processing)<br />
<br />
The message data comes from a global variable at 0x8009A000.<br />
<br />
Return value depends on the content of the message data.<br />
<br />
<br />
'''Opcode 0x10'''<br />
<br />
Load and start playing new [[FF7/PSX/Sound/AKAO sequence|AKAO sequence]]<br />
<br />
Returns: 0 for success, 1 for already loaded, and -1 for invalid signature<br />
<br />
<br />
'''Opcode 0x92'''<br />
<br />
Set value to the condition variable used by Opcode 0xEF.<br />
|-<br />
|0x8002E1A8<br />
|void _AkaoDispatchMessages(void)<br />
|<br />
|-<br />
|0x80030234<br />
|int _AkaoCallback(void)<br />
|Callback event for sound, registered by OpenEvent BIOS function<br />
|-<br />
|0x80030E7C<br />
|void _AkaoDispatchVoice(struct MusicPlayerTrack *track, void *a1, int a2)<br />
|Dispatch voice opcodes until the next note or end of track<br />
|-<br />
|0x80049548<br />
|void (* const MESSAGE_HANDLERS[256])(struct AkaoMessage *)<br />
|<br />
|-<br />
|0x80049948<br />
|const unsigned char VOICE_OPCODE_LENGTHS[0x60]<br />
|Length table for voice opcodes 0xa0-0xff<br />
<br />
0 for end of track and branches<br />
|-<br />
|0x80049AA8<br />
|void (* const VOICE_OPCODES[0x60])(struct MusicPlayerTrack *, void *, int)<br />
|Address table for voice opcodes 0xa0-0xff<br />
|-<br />
|0x80049C44<br />
|const unsigned short VOLUME_TABLE_L[256]<br />
|See [[FF7/PSX/Sound/Opcodes/0xa8aa|Opcode 0xAA]] for volume balance calculation<br />
|-<br />
|0x80049E44<br />
|const unsigned short VOLUME_TABLE_R[256]<br />
|See [[FF7/PSX/Sound/Opcodes/0xa8aa|Opcode 0xAA]] for volume balance calculation<br />
|-<br />
|0x80083580<br />
|unsigned char g_AkaoSeqData[]<br />
|RAM area to load AKAO sequence data<br />
|}<br />
<br />
== Runtime Library Functions ==<br />
<br />
=== LIBSPU ===<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x80036298<br />
|void SpuInit(void)<br />
|<br />
|-<br />
|0x80036FFC<br />
|long SpuInitMalloc(long num, char *top)<br />
|<br />
|-<br />
|0x800373AC<br />
|long SpuMallocWithStartAddr(unsigned long addr, long size)<br />
|<br />
|-<br />
|0x80037964<br />
|unsigned long SpuSetNoiseVoice(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x80037B90<br />
|long SpuSetNoiseClock(long n_clock)<br />
|<br />
|-<br />
|0x80037BE0<br />
|unsigned long SpuRead(unsigned char *addr, unsigned long size)<br />
|<br />
|-<br />
|0x80037C40<br />
|long SpuSetReverb(long on_off)<br />
|<br />
|-<br />
|0x80037D90<br />
|long SpuGetReverb(void)<br />
|<br />
|-<br />
|0x80037E1C<br />
|long SpuSetReverbModeParam(SpuReverbAttr *attr)<br />
|<br />
|-<br />
|0x800387FC<br />
|void SpuGetReverbModeParam (SpuReverbAttr *attr)<br />
|<br />
|-<br />
|0x8003884C<br />
|long SpuSetReverbDepth(SpuReverbAttr *attr)<br />
|<br />
|-<br />
|0x800388C4<br />
|unsigned long SpuSetReverbVoice(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x800388E8<br />
|long SpuClearReverbWorkArea(long mode)<br />
|<br />
|-<br />
|0x80038A84<br />
|long SpuSetIRQ(long on_off)<br />
|<br />
|-<br />
|0x80038BC4<br />
|unsigned long SpuSetIRQAddr(unsigned long addr)<br />
|<br />
|-<br />
|0x80038C04<br />
|SpuIRQCallbackProc SpuSetIRQCallback(SpuIRQCallbackProc func)<br />
|<br />
|-<br />
|0x80038C6C<br />
|void SpuSetKey(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x80038F04<br />
|unsigned long SpuWrite(unsigned char *addr, unsigned long size)<br />
|<br />
|-<br />
|0x80038F64<br />
|unsigned long SpuSetTransferStartAddr(unsigned long addr)<br />
|<br />
|-<br />
|0x80038FB8<br />
|long SpuSetTransferMode(long mode)<br />
|<br />
|-<br />
|0x80038FEC<br />
|SpuTransferCallbackProc SpuSetTransferCallback(SpuTransferCallbackProc func)<br />
|<br />
|-<br />
|0x80039010<br />
|unsigned long SpuSetPitchLFOVoice(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x80039034<br />
|void SpuSetCommonAttr(SpuCommonAttr *attr)<br />
|<br />
|-<br />
|0x800393C8<br />
|void SpuSetVoiceVolume(int voiceNum, short volL, short volR)<br />
|<br />
|-<br />
|0x80039450<br />
|void SpuSetVoiceVolumeAttr(int voiceNum, short volL, short volR, short volModeL, short volModeR)<br />
|<br />
|-<br />
|0x800395C8<br />
|void SpuSetVoicePitch(int voiceNum, unsigned short pitch)<br />
|<br />
|-<br />
|0x80039644<br />
|void SpuSetVoiceStartAddr(int voiceNum, unsigned long startAddr)<br />
|<br />
|-<br />
|0x800396C0<br />
|void SpuSetVoiceLoopStartAddr(int voiceNum, unsigned long lsa)<br />
|<br />
|-<br />
|0x8003973C<br />
|void SpuSetVoiceDR(int voiceNum, unsigned short DR)<br />
|<br />
|-<br />
|0x800397C8<br />
|void SpuSetVoiceSL(int voiceNum, unsigned short SL)<br />
|<br />
|-<br />
|0x80039850<br />
|void SpuSetVoiceARAttr(int voiceNum, unsigned short AR, long ARmode)<br />
|<br />
|-<br />
|0x800398EC<br />
|void SpuSetVoiceSRAttr(int voiceNum, unsigned short SR, long SRmode)<br />
|<br />
|-<br />
|0x800399D0<br />
|void SpuSetVoiceRRAttr(int voiceNum, unsigned short RR, long RRmode)<br />
|<br />
|}<br />
<br />
=== LIBETC ===<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x8003D0C0<br />
|int ResetCallback(void)<br />
|<br />
|-<br />
|0x8003D150<br />
|int VSyncCallback(void (*func)(void))<br />
|<br />
|-<br />
|0x8003D1B4<br />
|int StopCallback(void)<br />
|<br />
|-<br />
|0x8003D214<br />
|int CheckCallback(void)<br />
|<br />
|}<br />
<br />
=== LIBAPI ===<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x800429F0<br />
|void DeliverEvent(unsigned long ev1, unsigned long ev2)<br />
|<br />
|-<br />
|0x80042A00<br />
|long OpenEvent(unsigned long desc, long spec, long mode, long (*func)())<br />
|<br />
|-<br />
|0x80042A10<br />
|long CloseEvent(long event)<br />
|<br />
|-<br />
|0x80042A20<br />
|long WaitEvent(long event)<br />
|<br />
|-<br />
|0x80042A40<br />
|long EnableEvent(long event)<br />
|<br />
|-<br />
|0x80042A50<br />
|long DisableEvent(long event)<br />
|<br />
|-<br />
|0x80042BC0<br />
|long SetRCnt(unsigned long spec, unsigned short target, long mode)<br />
|<br />
|-<br />
|0x80042C60<br />
|long GetRCnt(unsigned long spec)<br />
|<br />
|-<br />
|0x80042C98<br />
|long StartRCnt(unsigned long spec)<br />
|<br />
|-<br />
|0x80042CCC<br />
|long StopRCnt(unsigned long spec)<br />
|<br />
|}<br />
<br />
= Structures =<br />
<br />
[[FF7/PSX/Sound/INSTRx.DAT|struct AkaoInstrumentAttr]]<br />
<br />
[[FF7/PSX/Sound/INSTRx.ALL|struct AkaoSampleSet]]<br />
<br />
[[FF7/PSX/Sound/AKAO sequence|struct AkaoSeqHeader]]<br />
<br />
struct AkaoMessage // 36 bytes long<br />
{<br />
uint16_t opcode;<br />
uint16_t reserved;<br />
uint32_t data[8];<br />
};<br />
<br />
struct AkaoSpuVoiceAttr<br />
{<br />
uint32_t voice; // 0x00: voice number<br />
uint32_t update_flags; // 0x04: bitset that indicates what SPU registers need to be updated<br />
uint32_t addr; // 0x08: waveform data start address (SPU address)<br />
uint32_t loop_addr; // 0x0c: loop start address (SPU address)<br />
uint32_t a_mode; // 0x10: ADSR: attack rate mode<br />
uint32_t s_mode; // 0x14: ADSR: sustain rate mode<br />
uint32_t r_mode // 0x18: ADSR: release rate mode<br />
uint16_t pitch; // 0x1c: pitch<br />
uint16_t ar; // 0x1e: ADSR: attack rate<br />
uint16_t dr; // 0x20: ADSR: decay rate<br />
uint16_t sl; // 0x22: ADSR: sustain level<br />
uint16_t sr; // 0x24: ADSR: sustain rate<br />
uint16_t rr; // 0x26: ADSR: release rate<br />
SpuVolume volume; // 0x28: volume (left and right)<br />
};<br />
<br />
struct AkaoPlayer // the music player instance exists at 0x8009A104<br />
{<br />
uint32_t stereo_mode; // 0x00: stereo mode (1: stereo, 4: surround, otherwise: mono)<br />
uint32_t active_voices; // 0x04: bitset that indicates the voices currently in use<br />
uint32_t key_on_voices; // 0x08: bitset that indicates the voices to key on<br />
uint32_t keyed_voices; // 0x0c: bitset that indicates the voices currently keyed on<br />
uint32_t key_off_voices; // 0x10: bitset that indicates the voices to key off<br />
uint32_t saved_active_voices; // 0x14: unknown voice bitset<br />
uint32_t tempo; // 0x18: tempo (Q16 fixed-point number)<br />
int32_t tempo_slope; // 0x1c: slope of tempo slider (Q16 fixed-point number)<br />
uint32_t time_counter; // 0x20: time counter (0x10000 = 1 tick)<br />
uint32_t overlay_voices; // 0x24: bitset that indicates the sub-voices used for overlay (opcode 0xF4)<br />
uint32_t alternate_voices; // 0x28: bitset that indicates the sub-voices used for alternate voice (opcode 0xF8)<br />
uint32_t noise_voices; // 0x2c: bitset that indicates the voices with noise mode enabled<br />
uint32_t reverb_voices; // 0x30: bitset that indicates the voices with reverb enabled<br />
uint32_t pitch_lfo_voices; // 0x34: bitset that indicates the voices with pitch LFO (frequency modulation) mode enabled<br />
uint32_t spucnt; // 0x38: SPUCNT shadow<br />
uint32_t reverb_type; // 0x3c: reverb type<br />
uint32_t reverb_depth; // 0x40: reverb depth (Q16 fixed-point number)<br />
int32_t reverb_depth_slope; // 0x44: slope of reverb depth slider (Q16 fixed-point number)<br />
uint16_t tempo_slide_length; // 0x48: tempo slide length<br />
uint16_t song_id; // 0x4a: current song id<br />
uint16_t condition_ack; // 0x4c: the last matched condition value (opcode 0xEF)<br />
uint16_t condition; // 0x4e: condition variable for dynamic branching according to game status (opcode 0xEF)<br />
uint16_t reverb_depth_slide_length; // 0x50: length of reverb depth slide<br />
uint16_t noise_clock; // 0x52: noise clock frequency<br />
uint16_t field_54; // 0x54: unknown<br />
uint16_t beats_per_measure; // 0x56: beats per measure<br />
uint16_t beat; // 0x58: current beat<br />
uint16_t ticks_per_beat; // 0x5a: ticks per beat<br />
uint16_t tick; // 0x5c: current ticks per beat<br />
uint16_t measure; // 0x5e: current measure<br />
};<br />
<br />
struct AkaoPlayerTrack // the music player track instances exist at 0x80096608 + (N * 0x108)<br />
{<br />
uint8_t *addr; // 0x00<br />
uint8_t *loop_addrs[4]; // 0x04<br />
AkaoDrumKeyAttr *drum_addr; // 0x14<br />
int16_t *vibrato_lfo_addr; // 0x18<br />
int16_t *tremolo_lfo_addr; // 0x1C<br />
int16_t *pan_lfo_addr; // 0x20<br />
uint32_t overlay_voice_num; // 0x24<br />
uint32_t alternate_voice_num; // 0x28<br />
uint32_t master_volume; // 0x2C<br />
uint32_t pitch_of_note; // 0x30<br />
int32_t pitch_bend_slide_amplitude; // 0x34<br />
uint16_t voice_effect_flags; // 0x38<br />
uint16_t field_3A; // 0x3A<br />
uint16_t field_3C; // 0x3C<br />
uint16_t field_3E; // 0x3E<br />
uint32_t field_40; // 0x40<br />
uint32_t volume; // 0x44<br />
int32_t volume_slope; // 0x48<br />
int32_t pitch_bend_slope; // 0x4C<br />
uint16_t field_50; // 0x50<br />
uint16_t field_52; // 0x52<br />
uint16_t field_54; // 0x54<br />
uint8_t delta_time_counter; // 0x56<br />
uint8_t gate_time_counter; // 0x57<br />
uint16_t instrument; // 0x58<br />
uint16_t field_5A; // 0x5A<br />
uint16_t volume_slide_length_counter; // 0x5C<br />
uint16_t overlay_balance_slide_length_counter; // 0x5E<br />
uint16_t pan; // 0x60<br />
uint16_t pan_slide_length; // 0x62<br />
int16_t pitch_slide_length_counter; // 0x64<br />
uint16_t octave; // 0x66<br />
uint16_t pitch_slide_length; // 0x68<br />
uint16_t previous_note_number; // 0x6A<br />
uint16_t portamento_speed; // 0x6C<br />
uint16_t legato_flags; // 0x6E<br />
uint16_t field_70; // 0x70<br />
uint16_t vibrato_lfo_delay; // 0x72<br />
uint16_t vibrato_delay_counter; // 0x74<br />
uint16_t vibrato_rate; // 0x76<br />
uint16_t vibrato_rate_counter; // 0x78<br />
uint16_t vibrato_form; // 0x7A<br />
uint16_t vibrato_max_amplitude; // 0x7C<br />
uint16_t vibrato_depth; // 0x7E<br />
uint16_t vibrato_depth_slide_length_counter; // 0x80<br />
int16_t vibrato_depth_slope; // 0x82<br />
uint16_t field_84; // 0x84<br />
uint16_t tremolo_delay; // 0x86<br />
uint16_t tremolo_delay_counter; // 0x88<br />
uint16_t tremolo_rate; // 0x8A<br />
uint16_t tremolo_rate_counter; // 0x8C<br />
uint16_t tremolo_form; // 0x8E<br />
uint16_t tremolo_depth; // 0x90<br />
uint16_t tremolo_depth_slide_length_counter; // 0x92<br />
int16_t tremolo_depth_slope; // 0x94<br />
uint16_t field_96; // 0x96<br />
uint16_t pan_lfo_rate; // 0x98<br />
uint16_t pan_lfo_rate_counter; // 0x9A<br />
uint16_t pan_lfo_form; // 0x9C<br />
uint16_t pan_lfo_depth; // 0x9E<br />
uint16_t pan_lfo_depth_slide_length_counter; // 0xA0<br />
int16_t pan_lfo_slope; // 0xA2<br />
uint16_t noise_on_off_delay_counter; // 0xA4<br />
uint16_t pitchmod_on_off_delay_counter; // 0xA6<br />
uint8_t field_A8[16]; // 0xA8<br />
uint16_t loop_layer; // 0xB8<br />
uint16_t loop_counts[4]; // 0xBA<br />
uint16_t previous_delta_time; // 0xC2<br />
uint16_t forced_delta_time; // 0xC4<br />
uint16_t overlay_balance; // 0xC6<br />
int16_t overlay_balance_slope; // 0xC8<br />
int16_t pan_slope; // 0xCA<br />
int16_t transpose; // 0xCC<br />
int16_t tuning; // 0xCE<br />
uint16_t note; // 0xD0<br />
int16_t pitch_slide_amount; // 0xD2<br />
int16_t previous_transpose; // 0xD4<br />
int16_t vibrato_lfo_amplitude; // 0xD6<br />
int16_t tremolo_lfo_amplitude; // 0xD8<br />
int16_t pan_lfo_amplitude; // 0xDA<br />
AkaoSpuVoiceAttr spu_attr; // 0xDC<br />
};</div>
Loveemu
https://wiki.ffrtt.ru/index.php?title=FF7/PSX/Sound/AKAO_sequence&diff=5736
FF7/PSX/Sound/AKAO sequence
2020-06-07T14:06:15Z
<p>Loveemu: </p>
<hr />
<div>== Introduction ==<br />
AKAO sequence is the most complicated part of the FF7 sound system. ("AKAO" is the signature string, which implies that the sound format has developed by Square Enix sound programmer Minoru Akao.)<br />
<br />
AKAO sequence is similar to MIDI sequence - it's custom tracker format for playing sequence sound, well tuned specially for PSX.<br />
<br />
The sequence data can be found in all FF7 game modules: Field, Battle, Worldmap and in minigames.<br />
<br />
All files with exension *.SND are AKAO.<br />
<br />
* '''MINI/ASERI2.SND''' - Battle Arena theme<br />
* '''MINI/SENSUI.SND''' - used in Submarine minigame<br />
* '''ENEMY6/OVER2.SND''' - game over sequence<br />
* '''ENEMY6/FAN2.SND''' - battle win "fanfare" sequence<br />
* '''MOVIE/OVER2.SND''' - same game over sequence, don't know, why to duplicate data<br />
<br />
Other AKAO sequences are hard-wired in other files.<br />
<br />
<br />
== File Structure ==<br />
=== Header (size: 16 bytes) ===<br />
<br />
struct AkaoSeqHeader<br />
{<br />
static const uint8_t magic[4]; // "AKAO" C-string<br />
uint16_t id; // song ID, used for playing sequence<br />
uint16_t length; // data length - sizeof(header)<br />
uint16_t reverb_type; // reverb type (range from 0 to 9)<br />
struct AkaoTimeStamp timestamp; // creation time<br />
};<br />
<br />
struct AkaoTimeStamp<br />
{<br />
uint8_t year_bcd; // year (in binary coded decimal)<br />
uint8_t month_bcd; // month (in binary coded decimal, between 0x01 - 0x12)<br />
uint8_t day_bcd; // day (in binary coded decimal, between 0x01 - 0x31)<br />
uint8_t hours_bcd; // hours (in binary coded decimal, between 0x00 - 0x23)<br />
uint8_t minutes_bcd; // minutes (in binary coded decimal, between 0x00 - 0x59)<br />
uint8_t seconds_bcd; // seconds (in binary coded decimal, between 0x00 - 0x59)<br />
};<br />
<br />
=== Channel Info (size: 4 bytes + 2 bytes * <channels count>) ===<br />
struct AkaoChannelInfo<br />
{<br />
uint32_t mask; // represents bitmask of used channels in this song<br />
uint32_t start_offsets[num_channels]; // offsets to channel opcode data<br />
};<br />
<br />
int num_channels = 0;<br />
while (int bit = 0; ((info.mask & 0xFFFFFF) & (1 << bit)) != 0; bit++)<br />
num_channels++;<br />
<br />
First there is 32-bit number (offset 0x10), which represents bitmask of used channels in this song.<br />
<br />
After this bitmask, there is <channels count> offsets to channel opcode data counting from current offset. Each offsets is a relative offset based on the address *next to* the offset itself. (This is a general rule for early versions of AKAO to interpret relative offsets.)<br />
<br />
<br />
=== Channel Commands [AKAO Opcodes] ===<br />
For every channels in an AKAO sequence, there is a set of commands to perform. This is similar to Field opcodes. Here I will call this sound commands "opcodes". Every opcode has its own number of arguments (from no-arguments, to 3 arguments).<br />
<br />
=== Drum Instrument Map Table ===<br />
<br />
When a song uses a drum kit with [[FF7/PSX/Sound/Opcodes/0xeced|opcode 0xEC]], a drum instrument map table will be placed at the end of the sequence. The table determines the instrument, channel volume and pan for each keys.<br />
<br />
The table consists of a repetition of 5-byte items.<br />
<br />
struct AkaoDrumKeyAttr<br />
{<br />
uint8_t instrument; // corresponding to opcode 0xA1<br />
uint8_t key; // note number when playing the drum note<br />
uint16_t volume; // corresponding to opcode 0xA8 (lower 8bit is a fractional part of the volume)<br />
uint8_t pan; // corresponding to opcode 0xAA<br />
}<br />
<br />
== Example (Home-Created AKAO Sequence): ==<br />
=== Header ===<br />
'''41 4b 41 4f''' - AKAO string<br />
<br />
'''34 12''' - song ID: 0x1234<br />
<br />
'''16 00''' - data length 0x16 in hex or 22 in decimal<br />
<br />
'''04 00''' - reverb type: 4 (large studio)<br />
<br />
'''96 12 18 22 46 28''' - created at 1996-12-18 22:46:28<br />
<br />
<br />
=== Channel Info ===<br />
'''01 00 00 00''' - this indicates, that used only one channel<br />
<br />
'''00 00''' - offset to first channel opcodes: in our example 0x00 means that next to this offset is opcodes for first channel<br />
<br />
<br />
=== Channel Commands ===<br />
'''e8 a8 66''' - sets tempo, parameter 0x66a8<br />
<br />
'''ea 00 50''' - sets reverb depth<br />
<br />
'''a8 55''' - load sample 0x55 from INSTR.ALL to channel<br />
<br />
'''aa 40''' - sets channel volume<br />
<br />
'''c2''' - turns on reverb effect<br />
<br />
'''a1 0c''' - sets volume pan<br />
<br />
'''c8''' - sets loop point<br />
<br />
'''66''' - 0x66 % 11 = 3 (3 means to take 3rd number from play length table), 0x66 / 11 = 9 (9 means to take pitch[9] from loaded instrument record index)<br />
<br />
'''ca''' - returns to saved loop point with opcode c8<br />
<br />
<br />
This example plays Chocobo "Whoo-Hoo" (instrument number 0x55) repeatedly.<br />
<br />
<br />
== Sound Opcode List ==<br />
<br />
{| class="wikitable"<br />
! Opcode<br />
! Summary<br />
! Length<br />
! Operands<br />
! Note<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0x0099|0x00-0x99]]<br />
|Note, Tie, Rest<br />
|1<br />
|<br />
|The opcode indicates the note key and length. The note will be keyed off 2 ticks before the next note.<br />
|-<br />
|0x9A-0x9F<br />
|Unimplemented<br />
|1<br />
|<br />
|Should not be used.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa0|0xA0]]<br />
|Finish Channel<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa1|0xA1]]<br />
|Load Instrument<br />
|2<br />
|instrument: byte<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0x0099|0xA2]]<br />
|Overwrite Next Note Length<br />
|2<br />
|length: byte<br />
|Ignores the regular length (delta-time) of the next note and overwrites it with the specified length.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa8aa|0xA3]]<br />
|Channel Master Volume<br />
|2<br />
|volume: byte (0-127)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa4|0xA4]]<br />
|Pitch Bend Slide<br />
|3<br />
|length: byte, semitones: signed byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa5|0xA5]]<br />
|Set Octave<br />
|2<br />
|octave: byte (0-15)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa5|0xA6]]<br />
|Increase Octave<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa5|0xA7]]<br />
|Decrease Octave<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa8aa|0xA8]]<br />
|Channel Volume<br />
|2<br />
|volume: byte (0-127)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa9|0xA9]]<br />
|Channel Volume Slide<br />
|3<br />
|length: byte, volume: byte (0-127)<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa8aa|0xAA]]<br />
|Channel Pan<br />
|2<br />
|pan: byte (0-127)<br />
|64 is the center.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xab|0xAB]]<br />
|Channel Pan Slide<br />
|3<br />
|length: byte, pan: byte (0-127)<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xac|0xAC]]<br />
|Noise Clock Frequency<br />
|2<br />
|clock: byte (0x00-0x3f)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/ADSR|0xAD]]<br />
|ADSR: Attack Rate<br />
|2<br />
|attack_rate: byte (0x00-0x7f)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/ADSR|0xAE]]<br />
|ADSR: Decay Rate<br />
|2<br />
|decay_rate: byte (0x00-0x0f)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/ADSR|0xAF]]<br />
|ADSR: Sustain Level<br />
|2<br />
|sustain_level: byte (0x00-0x0f)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/ADSR|0xB0]]<br />
|ADSR: Decay Rate & Sustain Level<br />
|3<br />
|decay_rate: byte (0x00-0x0f), sustain_level: byte (0x00-0x0f)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/ADSR|0xB1]]<br />
|ADSR: Sustain Rate<br />
|2<br />
|sustain_rate: byte (0x00-0x7f)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/ADSR|0xB2]]<br />
|ADSR: Release Rate<br />
|2<br />
|release_rate: byte (0x00-0x1f)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/ADSR|0xB3]]<br />
|ADSR: Reset ADSR<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xb4b5|0xB4]]<br />
|Channel Pitch LFO (Vibrato)<br />
|4<br />
|delay: byte, rate: byte, type: byte (0-15)<br />
|When <code>rate</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xb4b5|0xB5]]<br />
|Channel Pitch LFO Depth<br />
|2<br />
|depth: byte<br />
|The most significant bit of the <code>depth</code> determines the amplitude range.<br />
<br />
When it is 0, the range is up to about ± 50 cents (amplitude is 15/256 compared with range type 1).<br />
<br />
When it is 1, the range is up to about ± 700 cents.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xb4b5|0xB6]]<br />
|Turn Off Channel Pitch LFO<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/ADSR|0xB7]]<br />
|ADSR: Attack Mode<br />
|2<br />
|attack_mode: byte (1 or 5)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xb8b9|0xB8]]<br />
|Channel Volume LFO (Tremolo)<br />
|4<br />
|delay: byte, rate: byte, type: byte (0-15)<br />
|When <code>rate</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xb8b9|0xB9]]<br />
|Channel Volume LFO Depth<br />
|2<br />
|depth: byte<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xb8b9|0xBA]]<br />
|Turn Off Channel Volume LFO<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/ADSR|0xBB]]<br />
|ADSR: Sustain Mode<br />
|2<br />
|sustain_mode: byte (1, 3, 5 or 7)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xbcbd|0xBC]]<br />
|Channel Pan LFO<br />
|3<br />
|rate: byte, type: byte (0-15)<br />
|When <code>rate</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xbcbd|0xBD]]<br />
|Channel Pan LFO Depth<br />
|2<br />
|depth: byte<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xbcbd|0xBE]]<br />
|Turn Off Channel Pan LFO<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xbf|0xBF]]<br />
|ADSR: Release Mode<br />
|2<br />
|release_mode: byte (3 or 7)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc0c1|0xC0]]<br />
|Channel Transpose (Absolute)<br />
|2<br />
|semitones: signed byte<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc0c1|0xC1]]<br />
|Channel Transpose (Relative)<br />
|2<br />
|semitones: signed byte<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc2c3|0xC2]]<br />
|Turn On Reverb<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc2c3|0xC3]]<br />
|Turn Off Reverb<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc4c5|0xC4]]<br />
|Turn On Noise<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc4c5|0xC5]]<br />
|Turn Off Noise<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc6c7|0xC6]]<br />
|Turn On Frequency Modulation<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc6c7|0xC7]]<br />
|Turn Off Frequency Modulation<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc8c9|0xC8]]<br />
|Loop Point<br />
|1<br />
|<br />
|Remember the current offset as a loop point and increase the nesting level of the loop.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc8c9|0xC9]]<br />
|Return to Loop Point Up to N Times<br />
|2<br />
|times: byte<br />
|On the Nth repeat, this instruction will end the current loop by decrementing the nesting level of the loop. Otherwise, it will increment the loop counter and return to the loop point.<br />
When <code>times</code> is 0, it will be translated to 256 times.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc8c9|0xCA]]<br />
|Return to Loop Point<br />
|1<br />
|<br />
|This instruction will increment the loop counter.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xcb|0xCB]]<br />
|Reset Sound Effects<br />
|1<br />
|<br />
|Reset sound effects such as noise, frequency modulation, reverb, overlay voice and alternate voice.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xcccd|0xCC]]<br />
|Turn On Legato<br />
|1<br />
|<br />
|This instruction will stop the regular key on and key off performance of the subsequent notes and update the pitch only.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xcccd|0xCD]]<br />
|Turn Off Legato<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xcecf|0xCE]]<br />
|Turn On Noise and Toggle Noise On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xcecf|0xCF]]<br />
|Toggle Noise On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xd0d1|0xD0]]<br />
|Turn On Full-Length Note Mode<br />
|1<br />
|<br />
|This instruction will stop the regular key off performance of the subsequent notes.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xd0d1|0xD1]]<br />
|Turn Off Full-Length Note Mode<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xd2d3|0xD2]]<br />
|Turn On Frequency Modulation and Toggle Frequency Modulation On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xd2d3|0xD3]]<br />
|Toggle Frequency Modulation On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xd4d5|0xD4]]<br />
|Turn On Playback Rate Side Chain<br />
|1<br />
|<br />
|Duplicate and use the playback frequency of the previous voice channel.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xd4d5|0xD5]]<br />
|Turn Off Playback Rate Side Chain<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xd6d7|0xD6]]<br />
|Turn On Pitch-Volume Side Chain<br />
|1<br />
|<br />
|Multiply the playback frequency of the previous voice channel to the output volume. Lower pitch will make the volume smaller.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xd6d7|0xD7]]<br />
|Turn Off Pitch-Volume Side Chain<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xd8d9|0xD8]]<br />
|Channel Fine Tuning (Absolute)<br />
|2<br />
|amount: signed byte<br />
|The pitch can be changed in the range of one octave above and below.<br />
The <code>amount</code> is the multiplicand for the playback frequency, not a log-based parameter like cents. For example, when the <code>amount</code> is 127, the pitch will be multiplied by 127/128 (about +1 octave). Negative value will lower the pitch.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xd8d9|0xD9]]<br />
|Channel Fine Tuning (Relative)<br />
|2<br />
|amount: signed byte<br />
|The <code>amount</code> will be added to the current tuning amount.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xdadb|0xDA]]<br />
|Turn On Portamento<br />
|2<br />
|speed: byte<br />
|When <code>speed</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xdadb|0xDB]]<br />
|Turn Off Portamento<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0x0099|0xDC]]<br />
|Fix Note Length<br />
|2<br />
|length_to_add: signed byte<br />
|Ignore the regular length (delta-time) of subsequent notes and set to the fixed length. The <code>length_to_add</code> parameter will be added to the current length value. (the initial value is 0)<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xdd|0xDD]]<br />
|Channel Pitch LFO Depth Slide<br />
|3<br />
|length: byte, depth: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xde|0xDE]]<br />
|Channel Volume LFO Depth Slide<br />
|3<br />
|length: byte, depth: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xdf|0xDF]]<br />
|Channel Pan LFO Depth Slide<br />
|3<br />
|length: byte, depth: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa0|0xE0-0xE7]]<br />
|Unimplemented<br />
|1<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xe8e9|0xE8]]<br />
|Tempo<br />
|3<br />
|tempo: uint16<br />
|bpm = tempo / 214.998204 (approximate)<br />
More strictly, <code>bpm = 60.0 / (48 * (65536.0 / tempo) * (0x44E8 / (33868800.0 / 8)))</code><br />
<br />
Note that this coefficient is different from other games with PlayStation AKAO.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xe8e9|0xE9]]<br />
|Tempo Slide<br />
|4<br />
|length: byte, tempo: uint16<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xeaeb|0xEA]]<br />
|Reverb Depth<br />
|3<br />
|depth: uint16<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xeaeb|0xEB]]<br />
|Reverb Depth Slide<br />
|4<br />
|length: byte, depth: uint16<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xeced|0xEC]]<br />
|Turn On Drum Mode<br />
|3<br />
|drum_map_offset: signed int16<br />
|The <code>drum_map_offset</code> is a relative offset pointing to the drum instrument map table, which determines the instrument for each keys.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xeced|0xED]]<br />
|Turn Off Drum Mode<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xee|0xEE]]<br />
|Unconditional Jump<br />
|3<br />
|destination_offset: signed int16<br />
|This instruction can be used to make an infinite loop.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xef|0xEF]]<br />
|CPU-Conditional Jump<br />
|4<br />
|condition: byte, destination_offset: signed int16<br />
|Jump if the condition variable matches <code>condition</code>. The value of the condition variable can be set from the game program.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xf0f1|0xF0]]<br />
|Jump on the Nth Repeat<br />
|4<br />
|times: byte, destination_offset: signed int16<br />
|When <code>times</code> is 0, it will be translated to 256 times.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xf0f1|0xF1]]<br />
|Break the Loop on the Nth Repeat<br />
|4<br />
|times: byte, destination_offset: signed int16<br />
|Unlike 0xF0, this instruction will end the current loop by decrementing the nesting level of the loop.<br />
When <code>times</code> is 0, it will be translated to 256 times.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa1|0xF2]]<br />
|Load Instrument (No Attack Sample)<br />
|2<br />
|instrument: byte<br />
|Unlike 0xA1, the sample before the loop point is replaced by a short, silence sample.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xf3|0xF3]]<br />
|Unknown<br />
|1<br />
|<br />
|There is no actual use in music.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xf4f5|0xF4]]<br />
|Turn On Overlay Voice<br />
|3<br />
|instrument: byte, instrument2: byte<br />
|Play the same melody by different instruments on two voice channels. A free voice channel is required to work. Note that the two channels share the playback rate, and the pitch is not calculated for each instruments.<br />
Used in the song "Anxious Heart".<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xf4f5|0xF5]]<br />
|Turn Off Overlay Voice<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xf4f5|0xF6]]<br />
|Overlay Volume Balance<br />
|2<br />
|balance: byte (0-127)<br />
|When the balance is 0, the volume of the primary voice will be 100% (127/128) of original and that of the secondary voice will be 0%. 127 is the opposite.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xf4f5|0xF7]]<br />
|Overlay Volume Balance Slide<br />
|3<br />
|length: byte, balance: byte (0-127)<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xf8f9|0xF8]]<br />
|Turn On Alternate Voice<br />
|2<br />
|release_rate: byte (0x00-0x1f)<br />
|This instruction allows subsequent notes to be played on two alternating channels. At the same time, the ADSR release rate will be set to the specified value. A free voice channel is required to work. <br />
Check "Opening - Bombing Mission", "Tifa's Theme" and "Fortress of the Condor" for actual usage.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xf8f9|0xF9]]<br />
|Turn Off Alternate Voice<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa0|0xFA-0xFC]]<br />
|Unimplemented<br />
|1<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xfd|0xFD]]<br />
|Time Signature<br />
|3<br />
|ticks_per_beat: byte, beats_per_measure: byte<br />
|Note that two parameters can be 0. This pattern is used for initialization.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xfe|0xFE]]<br />
|Measure Number<br />
|2<br />
|measure: byte<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa0|0xFF]]<br />
|Unimplemented<br />
|1<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|}</div>
Loveemu
https://wiki.ffrtt.ru/index.php?title=FF7/PSX/Sound/INSTRx.DAT&diff=5735
FF7/PSX/Sound/INSTRx.DAT
2020-06-07T13:54:08Z
<p>Loveemu: </p>
<hr />
<div>There are two files of such type:<br />
* SOUND/INSTR.DAT - Main game sounds (93 instruments)<br />
* SOUND/INSTR2.DAT - Voices from ending theme "One Winged Angel" (4 instruments)<br />
<br />
These files contain index data for all instruments from INSTRx.ALL.<br />
<br />
<br />
== Record format ==<br />
<br />
struct AkaoInstrumentAttr<br />
{<br />
/* offsets */<br />
uint32_t addr; // offset to attack part of instrument (SPU hardware address)<br />
uint32_t loop_addr; // offset to loop part of instrument (SPU hardware address)<br />
/* ADSR Envelope settings */<br />
uint8_t ar; // ADSR: attack rate (0x00-0x7f)<br />
uint8_t dr; // ADSR: decay rate (0x00-0x0f)<br />
uint8_t sl; // ADSR: sustain level (0x00-0x0f)<br />
uint8_t sr; // ADSR: sustain rate (0x00-0x7f)<br />
uint8_t rr; // ADSR: release rate (0x00-0x1f)<br />
uint8_t a_mode; // ADSR: attack mode<br />
// 0x05 - (exponential)<br />
// 0x01 (default) - (linear)<br />
uint8_t s_mode; // ADSR: sustain mode<br />
// 0x01 - (linear, increase)<br />
// 0x05 - (exponential, increase)<br />
// 0x07 - (exponential, decrease)<br />
// 0x03 (default) - (linear, decrease)<br />
uint8_t r_mode; // ADSR: release mode<br />
// 0x07 - (exponential decrease)<br />
// 0x03 (default) - (linear decrease)<br />
uint32_t pitch[12]; // predefined pitch set for instrument<br />
};<br />
<br />
Each index file takes 4 CDROM sectors, so rest unused data filled with zeroes. Attack and loop offsets isn't real file offsets, it's offsets to instruments in SPU internal memory (all instrument data from INSTRx.ALL files are copied by DMA to SPU memory in one chunk), so to translate INSTR.ALL you need to subtract 0x0ff0 (or you need to subtract 0x38540 for INSTR2.DAT). INSTR.DAT file resides in PSX RAM at address 0x80075f30 and when it's needed to load any instrument or to reset pitch for this instrument this table is used.</div>
Loveemu
https://wiki.ffrtt.ru/index.php?title=FF7/PSX/Sound/INSTRx.ALL&diff=5734
FF7/PSX/Sound/INSTRx.ALL
2020-06-07T13:49:46Z
<p>Loveemu: </p>
<hr />
<div>There is two files of this structure on FF7 game discs:<br />
* SOUND/INSTR.ALL - Main game sounds (93 instruments)<br />
* SOUND/INSTR2.ALL - Voices from ending theme "One Winged Angel" (4 instruments)<br />
These files contain all sample data for every instrument in game. Every instrument consists of 16-byte PSX ADPCM frames. Frame format is known and there is numerous decompressors for it whether on the net, or in Q-Gears source.<br />
<br />
== File Structure ==<br />
At file beginning there is two 32-bit numbers. Counting from 0x10 file offset there is sample data for all instruments. (using term "Instrument" I actually mean serie of ADPCM samples, although in some context I can use term "Sample", "Sound" or "Voice" to describe instrument). All data from INSTR.ALL are loaded by DMA to SPU RAM in one chunk, offset 0x0202.<br />
<br />
struct AkaoSampleSet<br />
{<br />
uint32_t addr; // transfer destination address (SPU hardware address, between 0x1010 - 0x7ffff)<br />
uint32_t size; // transfer size<br />
uint8_t unknown[8]; // unused? padded with 0s<br />
<br />
uint8_t data[size]; // PSX ADPCM frames<br />
};</div>
Loveemu
https://wiki.ffrtt.ru/index.php?title=FF7/PSX/Sound/Code_Map&diff=5733
FF7/PSX/Sound/Code Map
2020-06-07T10:27:18Z
<p>Loveemu: </p>
<hr />
<div>= Code Map =<br />
<br />
Introduces functions, variables and data related to sound, contained in SCUS_941.63 (game program of US version). Note that all symbol names below are for convenience only.<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x800293D0<br />
|void _AkaoSpuTransferCallback(void)<br />
|<br />
|-<br />
|0x800293F4<br />
|void _AkaoSpuSetTransferCallback(void)<br />
|<br />
|-<br />
|0x80029424<br />
|unsigned int _AkaoTransferSamples(const unsigned char *addr, unsigned int size)<br />
|<br />
|-<br />
|0x800294A4<br />
|void _AkaoWaitForSpuTransfer(void)<br />
|<br />
|-<br />
|0x800294BC<br />
|void _AkaoReset(void)<br />
|<br />
|-<br />
|0x800297A4<br />
|void AkaoLoadInstrumentSet(const void *sampleSet, const void *instrumentSet)<br />
|Load standard instrument set<br />
<br />
''sampleSet'': corresponding to SOUND/INSTR.ALL<br />
<br />
''instrumentSet'': corresponding to SOUND/INSTR.DAT<br />
<br />
This function is called transparently from 0x8002988C.<br />
|-<br />
|0x80029818<br />
|void AkaoLoadInstrumentSet2(const void *sampleSet, const void *instrumentSet)<br />
|Load additional instrument set<br />
<br />
''sampleSet'': corresponding to SOUND/INSTR2.ALL<br />
<br />
''instrumentSet'': corresponding to SOUND/INSTR2.DAT<br />
|-<br />
|0x8002988C<br />
|void AkaoInitialize(const void *sampleSet, const void *instrumentSet)<br />
|Initialize sound driver and load initial instruments<br />
<br />
''sampleSet'': corresponding to SOUND/INSTR.ALL<br />
<br />
''instrumentSet'': corresponding to SOUND/INSTR.DAT<br />
|-<br />
|0x800299C8<br />
|void AkaoDeinitialize(void)<br />
|Deinitialize sound driver<br />
|-<br />
|0x80029AF0<br />
|void AkaoSetReverbMode(int mode)<br />
|<br />
|-<br />
|0x80029B78<br />
|void _AkaoTransferSeqBody(const void *data, int size)<br />
|<br />
|-<br />
|0x80029C48<br />
|void _AkaoLoadTracks(void)<br />
|<br />
|-<br />
|0x8002DA30<br />
|void AkaoNewMessage(AkaoMessage **ppMessage)<br />
|<br />
|-<br />
|0x8002DA7C<br />
|int AkaoPostMessage(void)<br />
|Post a new command message to the queue (with some wrapped processing)<br />
<br />
The message data comes from a global variable at 0x8009A000.<br />
<br />
Return value depends on the content of the message data.<br />
<br />
<br />
'''Opcode 0x10'''<br />
<br />
Load and start playing new [[FF7/PSX/Sound/AKAO sequence|AKAO sequence]]<br />
<br />
Returns: 0 for success, 1 for already loaded, and -1 for invalid signature<br />
<br />
<br />
'''Opcode 0x92'''<br />
<br />
Set value to the condition variable used by Opcode 0xEF.<br />
|-<br />
|0x8002E1A8<br />
|void _AkaoDispatchMessages(void)<br />
|<br />
|-<br />
|0x80030234<br />
|int _AkaoCallback(void)<br />
|Callback event for sound, registered by OpenEvent BIOS function<br />
|-<br />
|0x80030E7C<br />
|void _AkaoDispatchVoice(struct MusicPlayerTrack *track, void *a1, int a2)<br />
|Dispatch voice opcodes until the next note or end of track<br />
|-<br />
|0x80049548<br />
|void (* const MESSAGE_HANDLERS[256])(struct AkaoMessage *)<br />
|<br />
|-<br />
|0x80049948<br />
|const unsigned char VOICE_OPCODE_LENGTHS[0x60]<br />
|Length table for voice opcodes 0xa0-0xff<br />
<br />
0 for end of track and branches<br />
|-<br />
|0x80049AA8<br />
|void (* const VOICE_OPCODES[0x60])(struct MusicPlayerTrack *, void *, int)<br />
|Address table for voice opcodes 0xa0-0xff<br />
|-<br />
|0x80049C44<br />
|const unsigned short VOLUME_TABLE_L[256]<br />
|See [[FF7/PSX/Sound/Opcodes/0xa8aa|Opcode 0xAA]] for volume balance calculation<br />
|-<br />
|0x80049E44<br />
|const unsigned short VOLUME_TABLE_R[256]<br />
|See [[FF7/PSX/Sound/Opcodes/0xa8aa|Opcode 0xAA]] for volume balance calculation<br />
|-<br />
|0x80083580<br />
|unsigned char g_AkaoSeqData[]<br />
|RAM area to load AKAO sequence data<br />
|}<br />
<br />
== Runtime Library Functions ==<br />
<br />
=== LIBSPU ===<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x80036298<br />
|void SpuInit(void)<br />
|<br />
|-<br />
|0x80036FFC<br />
|long SpuInitMalloc(long num, char *top)<br />
|<br />
|-<br />
|0x800373AC<br />
|long SpuMallocWithStartAddr(unsigned long addr, long size)<br />
|<br />
|-<br />
|0x80037964<br />
|unsigned long SpuSetNoiseVoice(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x80037B90<br />
|long SpuSetNoiseClock(long n_clock)<br />
|<br />
|-<br />
|0x80037BE0<br />
|unsigned long SpuRead(unsigned char *addr, unsigned long size)<br />
|<br />
|-<br />
|0x80037C40<br />
|long SpuSetReverb(long on_off)<br />
|<br />
|-<br />
|0x80037D90<br />
|long SpuGetReverb(void)<br />
|<br />
|-<br />
|0x80037E1C<br />
|long SpuSetReverbModeParam(SpuReverbAttr *attr)<br />
|<br />
|-<br />
|0x800387FC<br />
|void SpuGetReverbModeParam (SpuReverbAttr *attr)<br />
|<br />
|-<br />
|0x8003884C<br />
|long SpuSetReverbDepth(SpuReverbAttr *attr)<br />
|<br />
|-<br />
|0x800388C4<br />
|unsigned long SpuSetReverbVoice(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x800388E8<br />
|long SpuClearReverbWorkArea(long mode)<br />
|<br />
|-<br />
|0x80038A84<br />
|long SpuSetIRQ(long on_off)<br />
|<br />
|-<br />
|0x80038BC4<br />
|unsigned long SpuSetIRQAddr(unsigned long addr)<br />
|<br />
|-<br />
|0x80038C04<br />
|SpuIRQCallbackProc SpuSetIRQCallback(SpuIRQCallbackProc func)<br />
|<br />
|-<br />
|0x80038C6C<br />
|void SpuSetKey(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x80038F04<br />
|unsigned long SpuWrite(unsigned char *addr, unsigned long size)<br />
|<br />
|-<br />
|0x80038F64<br />
|unsigned long SpuSetTransferStartAddr(unsigned long addr)<br />
|<br />
|-<br />
|0x80038FB8<br />
|long SpuSetTransferMode(long mode)<br />
|<br />
|-<br />
|0x80038FEC<br />
|SpuTransferCallbackProc SpuSetTransferCallback(SpuTransferCallbackProc func)<br />
|<br />
|-<br />
|0x80039010<br />
|unsigned long SpuSetPitchLFOVoice(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x80039034<br />
|void SpuSetCommonAttr(SpuCommonAttr *attr)<br />
|<br />
|-<br />
|0x800393C8<br />
|void SpuSetVoiceVolume(int voiceNum, short volL, short volR)<br />
|<br />
|-<br />
|0x80039450<br />
|void SpuSetVoiceVolumeAttr(int voiceNum, short volL, short volR, short volModeL, short volModeR)<br />
|<br />
|-<br />
|0x800395C8<br />
|void SpuSetVoicePitch(int voiceNum, unsigned short pitch)<br />
|<br />
|-<br />
|0x80039644<br />
|void SpuSetVoiceStartAddr(int voiceNum, unsigned long startAddr)<br />
|<br />
|-<br />
|0x800396C0<br />
|void SpuSetVoiceLoopStartAddr(int voiceNum, unsigned long lsa)<br />
|<br />
|-<br />
|0x8003973C<br />
|void SpuSetVoiceDR(int voiceNum, unsigned short DR)<br />
|<br />
|-<br />
|0x800397C8<br />
|void SpuSetVoiceSL(int voiceNum, unsigned short SL)<br />
|<br />
|-<br />
|0x80039850<br />
|void SpuSetVoiceARAttr(int voiceNum, unsigned short AR, long ARmode)<br />
|<br />
|-<br />
|0x800398EC<br />
|void SpuSetVoiceSRAttr(int voiceNum, unsigned short SR, long SRmode)<br />
|<br />
|-<br />
|0x800399D0<br />
|void SpuSetVoiceRRAttr(int voiceNum, unsigned short RR, long RRmode)<br />
|<br />
|}<br />
<br />
=== LIBETC ===<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x8003D0C0<br />
|int ResetCallback(void)<br />
|<br />
|-<br />
|0x8003D150<br />
|int VSyncCallback(void (*func)(void))<br />
|<br />
|-<br />
|0x8003D1B4<br />
|int StopCallback(void)<br />
|<br />
|-<br />
|0x8003D214<br />
|int CheckCallback(void)<br />
|<br />
|}<br />
<br />
=== LIBAPI ===<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x800429F0<br />
|void DeliverEvent(unsigned long ev1, unsigned long ev2)<br />
|<br />
|-<br />
|0x80042A00<br />
|long OpenEvent(unsigned long desc, long spec, long mode, long (*func)())<br />
|<br />
|-<br />
|0x80042A10<br />
|long CloseEvent(long event)<br />
|<br />
|-<br />
|0x80042A20<br />
|long WaitEvent(long event)<br />
|<br />
|-<br />
|0x80042A40<br />
|long EnableEvent(long event)<br />
|<br />
|-<br />
|0x80042A50<br />
|long DisableEvent(long event)<br />
|<br />
|-<br />
|0x80042BC0<br />
|long SetRCnt(unsigned long spec, unsigned short target, long mode)<br />
|<br />
|-<br />
|0x80042C60<br />
|long GetRCnt(unsigned long spec)<br />
|<br />
|-<br />
|0x80042C98<br />
|long StartRCnt(unsigned long spec)<br />
|<br />
|-<br />
|0x80042CCC<br />
|long StopRCnt(unsigned long spec)<br />
|<br />
|}<br />
<br />
= Structures =<br />
<br />
struct AkaoMessage // 36 bytes long<br />
{<br />
uint16_t opcode;<br />
uint16_t reserved;<br />
uint32_t data[8];<br />
};<br />
<br />
struct AkaoSpuVoiceAttr<br />
{<br />
uint32_t voice; // 0x00: voice number<br />
uint32_t update_flags; // 0x04: bitset that indicates what SPU registers need to be updated<br />
uint32_t addr; // 0x08: waveform data start address (SPU address)<br />
uint32_t loop_addr; // 0x0c: loop start address (SPU address)<br />
uint32_t a_mode; // 0x10: ADSR: attack rate mode<br />
uint32_t s_mode; // 0x14: ADSR: sustain rate mode<br />
uint32_t r_mode // 0x18: ADSR: release rate mode<br />
uint16_t pitch; // 0x1c: pitch<br />
uint16_t ar; // 0x1e: ADSR: attack rate<br />
uint16_t dr; // 0x20: ADSR: decay rate<br />
uint16_t sl; // 0x22: ADSR: sustain level<br />
uint16_t sr; // 0x24: ADSR: sustain rate<br />
uint16_t rr; // 0x26: ADSR: release rate<br />
SpuVolume volume; // 0x28: volume (left and right)<br />
};<br />
<br />
struct AkaoPlayer // the music player instance exists at 0x8009A104<br />
{<br />
uint32_t stereo_mode; // 0x00: stereo mode (1: stereo, 4: surround, otherwise: mono)<br />
uint32_t active_voices; // 0x04: bitset that indicates the voices currently in use<br />
uint32_t key_on_voices; // 0x08: bitset that indicates the voices to key on<br />
uint32_t keyed_voices; // 0x0c: bitset that indicates the voices currently keyed on<br />
uint32_t key_off_voices; // 0x10: bitset that indicates the voices to key off<br />
uint32_t saved_active_voices; // 0x14: unknown voice bitset<br />
uint32_t tempo; // 0x18: tempo (Q16 fixed-point number)<br />
int32_t tempo_slope; // 0x1c: slope of tempo slider (Q16 fixed-point number)<br />
uint32_t time_counter; // 0x20: time counter (0x10000 = 1 tick)<br />
uint32_t overlay_voices; // 0x24: bitset that indicates the sub-voices used for overlay (opcode 0xF4)<br />
uint32_t alternate_voices; // 0x28: bitset that indicates the sub-voices used for alternate voice (opcode 0xF8)<br />
uint32_t noise_voices; // 0x2c: bitset that indicates the voices with noise mode enabled<br />
uint32_t reverb_voices; // 0x30: bitset that indicates the voices with reverb enabled<br />
uint32_t pitch_lfo_voices; // 0x34: bitset that indicates the voices with pitch LFO (frequency modulation) mode enabled<br />
uint32_t spucnt; // 0x38: SPUCNT shadow<br />
uint32_t reverb_type; // 0x3c: reverb type<br />
uint32_t reverb_depth; // 0x40: reverb depth (Q16 fixed-point number)<br />
int32_t reverb_depth_slope; // 0x44: slope of reverb depth slider (Q16 fixed-point number)<br />
uint16_t tempo_slide_length; // 0x48: tempo slide length<br />
uint16_t song_id; // 0x4a: current song id<br />
uint16_t condition_ack; // 0x4c: the last matched condition value (opcode 0xEF)<br />
uint16_t condition; // 0x4e: condition variable for dynamic branching according to game status (opcode 0xEF)<br />
uint16_t reverb_depth_slide_length; // 0x50: length of reverb depth slide<br />
uint16_t noise_clock; // 0x52: noise clock frequency<br />
uint16_t field_54; // 0x54: unknown<br />
uint16_t beats_per_measure; // 0x56: beats per measure<br />
uint16_t beat; // 0x58: current beat<br />
uint16_t ticks_per_beat; // 0x5a: ticks per beat<br />
uint16_t tick; // 0x5c: current ticks per beat<br />
uint16_t measure; // 0x5e: current measure<br />
};<br />
<br />
struct AkaoPlayerTrack // the music player track instances exist at 0x80096608 + (N * 0x108)<br />
{<br />
uint8_t *addr; // 0x00<br />
uint8_t *loop_addrs[4]; // 0x04<br />
AkaoDrumKeyAttr *drum_addr; // 0x14<br />
int16_t *vibrato_lfo_addr; // 0x18<br />
int16_t *tremolo_lfo_addr; // 0x1C<br />
int16_t *pan_lfo_addr; // 0x20<br />
uint32_t overlay_voice_num; // 0x24<br />
uint32_t alternate_voice_num; // 0x28<br />
uint32_t master_volume; // 0x2C<br />
uint32_t pitch_of_note; // 0x30<br />
int32_t pitch_bend_slide_amplitude; // 0x34<br />
uint16_t voice_effect_flags; // 0x38<br />
uint16_t field_3A; // 0x3A<br />
uint16_t field_3C; // 0x3C<br />
uint16_t field_3E; // 0x3E<br />
uint32_t field_40; // 0x40<br />
uint32_t volume; // 0x44<br />
int32_t volume_slope; // 0x48<br />
int32_t pitch_bend_slope; // 0x4C<br />
uint16_t field_50; // 0x50<br />
uint16_t field_52; // 0x52<br />
uint16_t field_54; // 0x54<br />
uint8_t delta_time_counter; // 0x56<br />
uint8_t gate_time_counter; // 0x57<br />
uint16_t instrument; // 0x58<br />
uint16_t field_5A; // 0x5A<br />
uint16_t volume_slide_length_counter; // 0x5C<br />
uint16_t overlay_balance_slide_length_counter; // 0x5E<br />
uint16_t pan; // 0x60<br />
uint16_t pan_slide_length; // 0x62<br />
int16_t pitch_slide_length_counter; // 0x64<br />
uint16_t octave; // 0x66<br />
uint16_t pitch_slide_length; // 0x68<br />
uint16_t previous_note_number; // 0x6A<br />
uint16_t portamento_speed; // 0x6C<br />
uint16_t legato_flags; // 0x6E<br />
uint16_t field_70; // 0x70<br />
uint16_t vibrato_lfo_delay; // 0x72<br />
uint16_t vibrato_delay_counter; // 0x74<br />
uint16_t vibrato_rate; // 0x76<br />
uint16_t vibrato_rate_counter; // 0x78<br />
uint16_t vibrato_form; // 0x7A<br />
uint16_t vibrato_max_amplitude; // 0x7C<br />
uint16_t vibrato_depth; // 0x7E<br />
uint16_t vibrato_depth_slide_length_counter; // 0x80<br />
int16_t vibrato_depth_slope; // 0x82<br />
uint16_t field_84; // 0x84<br />
uint16_t tremolo_delay; // 0x86<br />
uint16_t tremolo_delay_counter; // 0x88<br />
uint16_t tremolo_rate; // 0x8A<br />
uint16_t tremolo_rate_counter; // 0x8C<br />
uint16_t tremolo_form; // 0x8E<br />
uint16_t tremolo_depth; // 0x90<br />
uint16_t tremolo_depth_slide_length_counter; // 0x92<br />
int16_t tremolo_depth_slope; // 0x94<br />
uint16_t field_96; // 0x96<br />
uint16_t pan_lfo_rate; // 0x98<br />
uint16_t pan_lfo_rate_counter; // 0x9A<br />
uint16_t pan_lfo_form; // 0x9C<br />
uint16_t pan_lfo_depth; // 0x9E<br />
uint16_t pan_lfo_depth_slide_length_counter; // 0xA0<br />
int16_t pan_lfo_slope; // 0xA2<br />
uint16_t noise_on_off_delay_counter; // 0xA4<br />
uint16_t pitchmod_on_off_delay_counter; // 0xA6<br />
uint8_t field_A8[16]; // 0xA8<br />
uint16_t loop_layer; // 0xB8<br />
uint16_t loop_counts[4]; // 0xBA<br />
uint16_t previous_delta_time; // 0xC2<br />
uint16_t forced_delta_time; // 0xC4<br />
uint16_t overlay_balance; // 0xC6<br />
int16_t overlay_balance_slope; // 0xC8<br />
int16_t pan_slope; // 0xCA<br />
int16_t transpose; // 0xCC<br />
int16_t tuning; // 0xCE<br />
uint16_t note; // 0xD0<br />
int16_t pitch_slide_amount; // 0xD2<br />
int16_t previous_transpose; // 0xD4<br />
int16_t vibrato_lfo_amplitude; // 0xD6<br />
int16_t tremolo_lfo_amplitude; // 0xD8<br />
int16_t pan_lfo_amplitude; // 0xDA<br />
AkaoSpuVoiceAttr spu_attr; // 0xDC<br />
};</div>
Loveemu
https://wiki.ffrtt.ru/index.php?title=FF7/PSX/Sound/Code_Map&diff=5732
FF7/PSX/Sound/Code Map
2020-06-07T07:46:03Z
<p>Loveemu: Add AkaoMessage structure.</p>
<hr />
<div>= Code Map =<br />
<br />
Introduces functions, variables and data related to sound, contained in SCUS_941.63 (game program of US version). Note that all symbol names below are for convenience only.<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x800293D0<br />
|void _AkaoSpuTransferCallback(void)<br />
|<br />
|-<br />
|0x800293F4<br />
|void _AkaoSpuSetTransferCallback(void)<br />
|<br />
|-<br />
|0x80029424<br />
|unsigned int _AkaoTransferSamples(const unsigned char *addr, unsigned int size)<br />
|<br />
|-<br />
|0x800294A4<br />
|void _AkaoWaitForSpuTransfer(void)<br />
|<br />
|-<br />
|0x800294BC<br />
|void _AkaoReset(void)<br />
|<br />
|-<br />
|0x800297A4<br />
|void AkaoLoadInstrumentSet(const void *sampleSet, const void *instrumentSet)<br />
|Load standard instrument set<br />
<br />
''sampleSet'': corresponding to SOUND/INSTR.ALL<br />
<br />
''instrumentSet'': corresponding to SOUND/INSTR.DAT<br />
<br />
This function is called transparently from 0x8002988C.<br />
|-<br />
|0x80029818<br />
|void AkaoLoadInstrumentSet2(const void *sampleSet, const void *instrumentSet)<br />
|Load additional instrument set<br />
<br />
''sampleSet'': corresponding to SOUND/INSTR2.ALL<br />
<br />
''instrumentSet'': corresponding to SOUND/INSTR2.DAT<br />
|-<br />
|0x8002988C<br />
|void AkaoInitialize(const void *sampleSet, const void *instrumentSet)<br />
|Initialize sound driver and load initial instruments<br />
<br />
''sampleSet'': corresponding to SOUND/INSTR.ALL<br />
<br />
''instrumentSet'': corresponding to SOUND/INSTR.DAT<br />
|-<br />
|0x800299C8<br />
|void AkaoDeinitialize(void)<br />
|Deinitialize sound driver<br />
|-<br />
|0x80029AF0<br />
|void AkaoSetReverbMode(int mode)<br />
|<br />
|-<br />
|0x80029B78<br />
|void _AkaoTransferSeqBody(const void *data, int size)<br />
|<br />
|-<br />
|0x80029C48<br />
|void _AkaoLoadTracks(void)<br />
|<br />
|-<br />
|0x8002DA7C<br />
|int AkaoLoadSeq(void)<br />
|Load and start playing new [[FF7/PSX/Sound/AKAO sequence|AKAO sequence]]<br />
<br />
Parameters are given from a global structure<br />
<br />
Returns: 0 for success, 1 for already loaded, and -1 for invalid signature<br />
|-<br />
|0x80030234<br />
|int _AkaoCallback(void)<br />
|Callback event for sound, registered by OpenEvent BIOS function<br />
|-<br />
|0x80030E7C<br />
|void _AkaoDispatchVoice(struct MusicPlayerTrack *track, void *a1, int a2)<br />
|Dispatch voice opcodes until the next note or end of track<br />
|-<br />
|0x80049948<br />
|const unsigned char VOICE_OPCODE_LENGTHS[0x60]<br />
|Length table for voice opcodes 0xa0-0xff<br />
<br />
0 for end of track and branches<br />
|-<br />
|0x80049AA8<br />
|void (* const VOICE_OPCODES[0x60])(struct MusicPlayerTrack *, void *, int)<br />
|Address table for voice opcodes 0xa0-0xff<br />
|-<br />
|0x80049C44<br />
|const unsigned short VOLUME_TABLE_L[256]<br />
|See [[FF7/PSX/Sound/Opcodes/0xa8aa|Opcode 0xAA]] for volume balance calculation<br />
|-<br />
|0x80049E44<br />
|const unsigned short VOLUME_TABLE_R[256]<br />
|See [[FF7/PSX/Sound/Opcodes/0xa8aa|Opcode 0xAA]] for volume balance calculation<br />
|-<br />
|0x80083580<br />
|unsigned char g_AkaoSeqData[]<br />
|RAM area to load AKAO sequence data<br />
|}<br />
<br />
== Runtime Library Functions ==<br />
<br />
=== LIBSPU ===<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x80036298<br />
|void SpuInit(void)<br />
|<br />
|-<br />
|0x80036FFC<br />
|long SpuInitMalloc(long num, char *top)<br />
|<br />
|-<br />
|0x800373AC<br />
|long SpuMallocWithStartAddr(unsigned long addr, long size)<br />
|<br />
|-<br />
|0x80037964<br />
|unsigned long SpuSetNoiseVoice(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x80037B90<br />
|long SpuSetNoiseClock(long n_clock)<br />
|<br />
|-<br />
|0x80037BE0<br />
|unsigned long SpuRead(unsigned char *addr, unsigned long size)<br />
|<br />
|-<br />
|0x80037C40<br />
|long SpuSetReverb(long on_off)<br />
|<br />
|-<br />
|0x80037D90<br />
|long SpuGetReverb(void)<br />
|<br />
|-<br />
|0x80037E1C<br />
|long SpuSetReverbModeParam(SpuReverbAttr *attr)<br />
|<br />
|-<br />
|0x800387FC<br />
|void SpuGetReverbModeParam (SpuReverbAttr *attr)<br />
|<br />
|-<br />
|0x8003884C<br />
|long SpuSetReverbDepth(SpuReverbAttr *attr)<br />
|<br />
|-<br />
|0x800388C4<br />
|unsigned long SpuSetReverbVoice(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x800388E8<br />
|long SpuClearReverbWorkArea(long mode)<br />
|<br />
|-<br />
|0x80038A84<br />
|long SpuSetIRQ(long on_off)<br />
|<br />
|-<br />
|0x80038BC4<br />
|unsigned long SpuSetIRQAddr(unsigned long addr)<br />
|<br />
|-<br />
|0x80038C04<br />
|SpuIRQCallbackProc SpuSetIRQCallback(SpuIRQCallbackProc func)<br />
|<br />
|-<br />
|0x80038C6C<br />
|void SpuSetKey(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x80038F04<br />
|unsigned long SpuWrite(unsigned char *addr, unsigned long size)<br />
|<br />
|-<br />
|0x80038F64<br />
|unsigned long SpuSetTransferStartAddr(unsigned long addr)<br />
|<br />
|-<br />
|0x80038FB8<br />
|long SpuSetTransferMode(long mode)<br />
|<br />
|-<br />
|0x80038FEC<br />
|SpuTransferCallbackProc SpuSetTransferCallback(SpuTransferCallbackProc func)<br />
|<br />
|-<br />
|0x80039010<br />
|unsigned long SpuSetPitchLFOVoice(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x80039034<br />
|void SpuSetCommonAttr(SpuCommonAttr *attr)<br />
|<br />
|-<br />
|0x800393C8<br />
|void SpuSetVoiceVolume(int voiceNum, short volL, short volR)<br />
|<br />
|-<br />
|0x80039450<br />
|void SpuSetVoiceVolumeAttr(int voiceNum, short volL, short volR, short volModeL, short volModeR)<br />
|<br />
|-<br />
|0x800395C8<br />
|void SpuSetVoicePitch(int voiceNum, unsigned short pitch)<br />
|<br />
|-<br />
|0x80039644<br />
|void SpuSetVoiceStartAddr(int voiceNum, unsigned long startAddr)<br />
|<br />
|-<br />
|0x800396C0<br />
|void SpuSetVoiceLoopStartAddr(int voiceNum, unsigned long lsa)<br />
|<br />
|-<br />
|0x8003973C<br />
|void SpuSetVoiceDR(int voiceNum, unsigned short DR)<br />
|<br />
|-<br />
|0x800397C8<br />
|void SpuSetVoiceSL(int voiceNum, unsigned short SL)<br />
|<br />
|-<br />
|0x80039850<br />
|void SpuSetVoiceARAttr(int voiceNum, unsigned short AR, long ARmode)<br />
|<br />
|-<br />
|0x800398EC<br />
|void SpuSetVoiceSRAttr(int voiceNum, unsigned short SR, long SRmode)<br />
|<br />
|-<br />
|0x800399D0<br />
|void SpuSetVoiceRRAttr(int voiceNum, unsigned short RR, long RRmode)<br />
|<br />
|}<br />
<br />
=== LIBETC ===<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x8003D0C0<br />
|int ResetCallback(void)<br />
|<br />
|-<br />
|0x8003D150<br />
|int VSyncCallback(void (*func)(void))<br />
|<br />
|-<br />
|0x8003D1B4<br />
|int StopCallback(void)<br />
|<br />
|-<br />
|0x8003D214<br />
|int CheckCallback(void)<br />
|<br />
|}<br />
<br />
=== LIBAPI ===<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x800429F0<br />
|void DeliverEvent(unsigned long ev1, unsigned long ev2)<br />
|<br />
|-<br />
|0x80042A00<br />
|long OpenEvent(unsigned long desc, long spec, long mode, long (*func)())<br />
|<br />
|-<br />
|0x80042A10<br />
|long CloseEvent(long event)<br />
|<br />
|-<br />
|0x80042A20<br />
|long WaitEvent(long event)<br />
|<br />
|-<br />
|0x80042A40<br />
|long EnableEvent(long event)<br />
|<br />
|-<br />
|0x80042A50<br />
|long DisableEvent(long event)<br />
|<br />
|-<br />
|0x80042BC0<br />
|long SetRCnt(unsigned long spec, unsigned short target, long mode)<br />
|<br />
|-<br />
|0x80042C60<br />
|long GetRCnt(unsigned long spec)<br />
|<br />
|-<br />
|0x80042C98<br />
|long StartRCnt(unsigned long spec)<br />
|<br />
|-<br />
|0x80042CCC<br />
|long StopRCnt(unsigned long spec)<br />
|<br />
|}<br />
<br />
= Structures =<br />
<br />
struct AkaoMessage // 36 bytes long<br />
{<br />
uint16_t opcode;<br />
uint16_t reserved;<br />
uint32_t data[8];<br />
};<br />
<br />
struct AkaoSpuVoiceAttr<br />
{<br />
uint32_t voice; // 0x00: voice number<br />
uint32_t update_flags; // 0x04: bitset that indicates what SPU registers need to be updated<br />
uint32_t addr; // 0x08: waveform data start address (SPU address)<br />
uint32_t loop_addr; // 0x0c: loop start address (SPU address)<br />
uint32_t a_mode; // 0x10: ADSR: attack rate mode<br />
uint32_t s_mode; // 0x14: ADSR: sustain rate mode<br />
uint32_t r_mode // 0x18: ADSR: release rate mode<br />
uint16_t pitch; // 0x1c: pitch<br />
uint16_t ar; // 0x1e: ADSR: attack rate<br />
uint16_t dr; // 0x20: ADSR: decay rate<br />
uint16_t sl; // 0x22: ADSR: sustain level<br />
uint16_t sr; // 0x24: ADSR: sustain rate<br />
uint16_t rr; // 0x26: ADSR: release rate<br />
SpuVolume volume; // 0x28: volume (left and right)<br />
};<br />
<br />
struct AkaoPlayer // the music player instance exists at 0x8009A104<br />
{<br />
uint32_t stereo_mode; // 0x00: stereo mode (1: stereo, 4: surround, otherwise: mono)<br />
uint32_t active_voices; // 0x04: bitset that indicates the voices currently in use<br />
uint32_t key_on_voices; // 0x08: bitset that indicates the voices to key on<br />
uint32_t keyed_voices; // 0x0c: bitset that indicates the voices currently keyed on<br />
uint32_t key_off_voices; // 0x10: bitset that indicates the voices to key off<br />
uint32_t saved_active_voices; // 0x14: unknown voice bitset<br />
uint32_t tempo; // 0x18: tempo (Q16 fixed-point number)<br />
int32_t tempo_slope; // 0x1c: slope of tempo slider (Q16 fixed-point number)<br />
uint32_t time_counter; // 0x20: time counter (0x10000 = 1 tick)<br />
uint32_t overlay_voices; // 0x24: bitset that indicates the sub-voices used for overlay (opcode 0xF4)<br />
uint32_t alternate_voices; // 0x28: bitset that indicates the sub-voices used for alternate voice (opcode 0xF8)<br />
uint32_t noise_voices; // 0x2c: bitset that indicates the voices with noise mode enabled<br />
uint32_t reverb_voices; // 0x30: bitset that indicates the voices with reverb enabled<br />
uint32_t pitch_lfo_voices; // 0x34: bitset that indicates the voices with pitch LFO (frequency modulation) mode enabled<br />
uint32_t spucnt; // 0x38: SPUCNT shadow<br />
uint32_t reverb_type; // 0x3c: reverb type<br />
uint32_t reverb_depth; // 0x40: reverb depth (Q16 fixed-point number)<br />
int32_t reverb_depth_slope; // 0x44: slope of reverb depth slider (Q16 fixed-point number)<br />
uint16_t tempo_slide_length; // 0x48: tempo slide length<br />
uint16_t song_id; // 0x4a: current song id<br />
uint16_t condition_ack; // 0x4c: the last matched condition value (opcode 0xEF)<br />
uint16_t condition; // 0x4e: condition variable for dynamic branching according to game status (opcode 0xEF)<br />
uint16_t reverb_depth_slide_length; // 0x50: length of reverb depth slide<br />
uint16_t noise_clock; // 0x52: noise clock frequency<br />
uint16_t field_54; // 0x54: unknown<br />
uint16_t beats_per_measure; // 0x56: beats per measure<br />
uint16_t beat; // 0x58: current beat<br />
uint16_t ticks_per_beat; // 0x5a: ticks per beat<br />
uint16_t tick; // 0x5c: current ticks per beat<br />
uint16_t measure; // 0x5e: current measure<br />
};<br />
<br />
struct AkaoPlayerTrack // the music player track instances exist at 0x80096608 + (N * 0x108)<br />
{<br />
uint8_t *addr; // 0x00<br />
uint8_t *loop_addrs[4]; // 0x04<br />
AkaoDrumKeyAttr *drum_addr; // 0x14<br />
int16_t *vibrato_lfo_addr; // 0x18<br />
int16_t *tremolo_lfo_addr; // 0x1C<br />
int16_t *pan_lfo_addr; // 0x20<br />
uint32_t overlay_voice_num; // 0x24<br />
uint32_t alternate_voice_num; // 0x28<br />
uint32_t master_volume; // 0x2C<br />
uint32_t pitch_of_note; // 0x30<br />
int32_t pitch_bend_slide_amplitude; // 0x34<br />
uint16_t voice_effect_flags; // 0x38<br />
uint16_t field_3A; // 0x3A<br />
uint16_t field_3C; // 0x3C<br />
uint16_t field_3E; // 0x3E<br />
uint32_t field_40; // 0x40<br />
uint32_t volume; // 0x44<br />
int32_t volume_slope; // 0x48<br />
int32_t pitch_bend_slope; // 0x4C<br />
uint16_t field_50; // 0x50<br />
uint16_t field_52; // 0x52<br />
uint16_t field_54; // 0x54<br />
uint8_t delta_time_counter; // 0x56<br />
uint8_t gate_time_counter; // 0x57<br />
uint16_t instrument; // 0x58<br />
uint16_t field_5A; // 0x5A<br />
uint16_t volume_slide_length_counter; // 0x5C<br />
uint16_t overlay_balance_slide_length_counter; // 0x5E<br />
uint16_t pan; // 0x60<br />
uint16_t pan_slide_length; // 0x62<br />
int16_t pitch_slide_length_counter; // 0x64<br />
uint16_t octave; // 0x66<br />
uint16_t pitch_slide_length; // 0x68<br />
uint16_t previous_note_number; // 0x6A<br />
uint16_t portamento_speed; // 0x6C<br />
uint16_t legato_flags; // 0x6E<br />
uint16_t field_70; // 0x70<br />
uint16_t vibrato_lfo_delay; // 0x72<br />
uint16_t vibrato_delay_counter; // 0x74<br />
uint16_t vibrato_rate; // 0x76<br />
uint16_t vibrato_rate_counter; // 0x78<br />
uint16_t vibrato_form; // 0x7A<br />
uint16_t vibrato_max_amplitude; // 0x7C<br />
uint16_t vibrato_depth; // 0x7E<br />
uint16_t vibrato_depth_slide_length_counter; // 0x80<br />
int16_t vibrato_depth_slope; // 0x82<br />
uint16_t field_84; // 0x84<br />
uint16_t tremolo_delay; // 0x86<br />
uint16_t tremolo_delay_counter; // 0x88<br />
uint16_t tremolo_rate; // 0x8A<br />
uint16_t tremolo_rate_counter; // 0x8C<br />
uint16_t tremolo_form; // 0x8E<br />
uint16_t tremolo_depth; // 0x90<br />
uint16_t tremolo_depth_slide_length_counter; // 0x92<br />
int16_t tremolo_depth_slope; // 0x94<br />
uint16_t field_96; // 0x96<br />
uint16_t pan_lfo_rate; // 0x98<br />
uint16_t pan_lfo_rate_counter; // 0x9A<br />
uint16_t pan_lfo_form; // 0x9C<br />
uint16_t pan_lfo_depth; // 0x9E<br />
uint16_t pan_lfo_depth_slide_length_counter; // 0xA0<br />
int16_t pan_lfo_slope; // 0xA2<br />
uint16_t noise_on_off_delay_counter; // 0xA4<br />
uint16_t pitchmod_on_off_delay_counter; // 0xA6<br />
uint8_t field_A8[16]; // 0xA8<br />
uint16_t loop_layer; // 0xB8<br />
uint16_t loop_counts[4]; // 0xBA<br />
uint16_t previous_delta_time; // 0xC2<br />
uint16_t forced_delta_time; // 0xC4<br />
uint16_t overlay_balance; // 0xC6<br />
int16_t overlay_balance_slope; // 0xC8<br />
int16_t pan_slope; // 0xCA<br />
int16_t transpose; // 0xCC<br />
int16_t tuning; // 0xCE<br />
uint16_t note; // 0xD0<br />
int16_t pitch_slide_amount; // 0xD2<br />
int16_t previous_transpose; // 0xD4<br />
int16_t vibrato_lfo_amplitude; // 0xD6<br />
int16_t tremolo_lfo_amplitude; // 0xD8<br />
int16_t pan_lfo_amplitude; // 0xDA<br />
AkaoSpuVoiceAttr spu_attr; // 0xDC<br />
};</div>
Loveemu
https://wiki.ffrtt.ru/index.php?title=FF7/PSX/Sound/Code_Map&diff=5731
FF7/PSX/Sound/Code Map
2020-06-07T05:37:19Z
<p>Loveemu: </p>
<hr />
<div>= Code Map =<br />
<br />
Introduces functions, variables and data related to sound, contained in SCUS_941.63 (game program of US version). Note that all symbol names below are for convenience only.<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x800293D0<br />
|void _AkaoSpuTransferCallback(void)<br />
|<br />
|-<br />
|0x800293F4<br />
|void _AkaoSpuSetTransferCallback(void)<br />
|<br />
|-<br />
|0x80029424<br />
|unsigned int _AkaoTransferSamples(const unsigned char *addr, unsigned int size)<br />
|<br />
|-<br />
|0x800294A4<br />
|void _AkaoWaitForSpuTransfer(void)<br />
|<br />
|-<br />
|0x800294BC<br />
|void _AkaoReset(void)<br />
|<br />
|-<br />
|0x800297A4<br />
|void AkaoLoadInstrumentSet(const void *sampleSet, const void *instrumentSet)<br />
|Load standard instrument set<br />
<br />
''sampleSet'': corresponding to SOUND/INSTR.ALL<br />
<br />
''instrumentSet'': corresponding to SOUND/INSTR.DAT<br />
<br />
This function is called transparently from 0x8002988C.<br />
|-<br />
|0x80029818<br />
|void AkaoLoadInstrumentSet2(const void *sampleSet, const void *instrumentSet)<br />
|Load additional instrument set<br />
<br />
''sampleSet'': corresponding to SOUND/INSTR2.ALL<br />
<br />
''instrumentSet'': corresponding to SOUND/INSTR2.DAT<br />
|-<br />
|0x8002988C<br />
|void AkaoInitialize(const void *sampleSet, const void *instrumentSet)<br />
|Initialize sound driver and load initial instruments<br />
<br />
''sampleSet'': corresponding to SOUND/INSTR.ALL<br />
<br />
''instrumentSet'': corresponding to SOUND/INSTR.DAT<br />
|-<br />
|0x800299C8<br />
|void AkaoDeinitialize(void)<br />
|Deinitialize sound driver<br />
|-<br />
|0x80029AF0<br />
|void AkaoSetReverbMode(int mode)<br />
|<br />
|-<br />
|0x80029B78<br />
|void _AkaoTransferSeqBody(const void *data, int size)<br />
|<br />
|-<br />
|0x80029C48<br />
|void _AkaoLoadTracks(void)<br />
|<br />
|-<br />
|0x8002DA7C<br />
|int AkaoLoadSeq(void)<br />
|Load and start playing new [[FF7/PSX/Sound/AKAO sequence|AKAO sequence]]<br />
<br />
Parameters are given from a global structure<br />
<br />
Returns: 0 for success, 1 for already loaded, and -1 for invalid signature<br />
|-<br />
|0x80030234<br />
|int _AkaoCallback(void)<br />
|Callback event for sound, registered by OpenEvent BIOS function<br />
|-<br />
|0x80030E7C<br />
|void _AkaoDispatchVoice(struct MusicPlayerTrack *track, void *a1, int a2)<br />
|Dispatch voice opcodes until the next note or end of track<br />
|-<br />
|0x80049948<br />
|const unsigned char VOICE_OPCODE_LENGTHS[0x60]<br />
|Length table for voice opcodes 0xa0-0xff<br />
<br />
0 for end of track and branches<br />
|-<br />
|0x80049AA8<br />
|void (* const VOICE_OPCODES[0x60])(struct MusicPlayerTrack *, void *, int)<br />
|Address table for voice opcodes 0xa0-0xff<br />
|-<br />
|0x80049C44<br />
|const unsigned short VOLUME_TABLE_L[256]<br />
|See [[FF7/PSX/Sound/Opcodes/0xa8aa|Opcode 0xAA]] for volume balance calculation<br />
|-<br />
|0x80049E44<br />
|const unsigned short VOLUME_TABLE_R[256]<br />
|See [[FF7/PSX/Sound/Opcodes/0xa8aa|Opcode 0xAA]] for volume balance calculation<br />
|-<br />
|0x80083580<br />
|unsigned char g_AkaoSeqData[]<br />
|RAM area to load AKAO sequence data<br />
|}<br />
<br />
== Runtime Library Functions ==<br />
<br />
=== LIBSPU ===<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x80036298<br />
|void SpuInit(void)<br />
|<br />
|-<br />
|0x80036FFC<br />
|long SpuInitMalloc(long num, char *top)<br />
|<br />
|-<br />
|0x800373AC<br />
|long SpuMallocWithStartAddr(unsigned long addr, long size)<br />
|<br />
|-<br />
|0x80037964<br />
|unsigned long SpuSetNoiseVoice(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x80037B90<br />
|long SpuSetNoiseClock(long n_clock)<br />
|<br />
|-<br />
|0x80037BE0<br />
|unsigned long SpuRead(unsigned char *addr, unsigned long size)<br />
|<br />
|-<br />
|0x80037C40<br />
|long SpuSetReverb(long on_off)<br />
|<br />
|-<br />
|0x80037D90<br />
|long SpuGetReverb(void)<br />
|<br />
|-<br />
|0x80037E1C<br />
|long SpuSetReverbModeParam(SpuReverbAttr *attr)<br />
|<br />
|-<br />
|0x800387FC<br />
|void SpuGetReverbModeParam (SpuReverbAttr *attr)<br />
|<br />
|-<br />
|0x8003884C<br />
|long SpuSetReverbDepth(SpuReverbAttr *attr)<br />
|<br />
|-<br />
|0x800388C4<br />
|unsigned long SpuSetReverbVoice(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x800388E8<br />
|long SpuClearReverbWorkArea(long mode)<br />
|<br />
|-<br />
|0x80038A84<br />
|long SpuSetIRQ(long on_off)<br />
|<br />
|-<br />
|0x80038BC4<br />
|unsigned long SpuSetIRQAddr(unsigned long addr)<br />
|<br />
|-<br />
|0x80038C04<br />
|SpuIRQCallbackProc SpuSetIRQCallback(SpuIRQCallbackProc func)<br />
|<br />
|-<br />
|0x80038C6C<br />
|void SpuSetKey(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x80038F04<br />
|unsigned long SpuWrite(unsigned char *addr, unsigned long size)<br />
|<br />
|-<br />
|0x80038F64<br />
|unsigned long SpuSetTransferStartAddr(unsigned long addr)<br />
|<br />
|-<br />
|0x80038FB8<br />
|long SpuSetTransferMode(long mode)<br />
|<br />
|-<br />
|0x80038FEC<br />
|SpuTransferCallbackProc SpuSetTransferCallback(SpuTransferCallbackProc func)<br />
|<br />
|-<br />
|0x80039010<br />
|unsigned long SpuSetPitchLFOVoice(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x80039034<br />
|void SpuSetCommonAttr(SpuCommonAttr *attr)<br />
|<br />
|-<br />
|0x800393C8<br />
|void SpuSetVoiceVolume(int voiceNum, short volL, short volR)<br />
|<br />
|-<br />
|0x80039450<br />
|void SpuSetVoiceVolumeAttr(int voiceNum, short volL, short volR, short volModeL, short volModeR)<br />
|<br />
|-<br />
|0x800395C8<br />
|void SpuSetVoicePitch(int voiceNum, unsigned short pitch)<br />
|<br />
|-<br />
|0x80039644<br />
|void SpuSetVoiceStartAddr(int voiceNum, unsigned long startAddr)<br />
|<br />
|-<br />
|0x800396C0<br />
|void SpuSetVoiceLoopStartAddr(int voiceNum, unsigned long lsa)<br />
|<br />
|-<br />
|0x8003973C<br />
|void SpuSetVoiceDR(int voiceNum, unsigned short DR)<br />
|<br />
|-<br />
|0x800397C8<br />
|void SpuSetVoiceSL(int voiceNum, unsigned short SL)<br />
|<br />
|-<br />
|0x80039850<br />
|void SpuSetVoiceARAttr(int voiceNum, unsigned short AR, long ARmode)<br />
|<br />
|-<br />
|0x800398EC<br />
|void SpuSetVoiceSRAttr(int voiceNum, unsigned short SR, long SRmode)<br />
|<br />
|-<br />
|0x800399D0<br />
|void SpuSetVoiceRRAttr(int voiceNum, unsigned short RR, long RRmode)<br />
|<br />
|}<br />
<br />
=== LIBETC ===<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x8003D0C0<br />
|int ResetCallback(void)<br />
|<br />
|-<br />
|0x8003D150<br />
|int VSyncCallback(void (*func)(void))<br />
|<br />
|-<br />
|0x8003D1B4<br />
|int StopCallback(void)<br />
|<br />
|-<br />
|0x8003D214<br />
|int CheckCallback(void)<br />
|<br />
|}<br />
<br />
=== LIBAPI ===<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x800429F0<br />
|void DeliverEvent(unsigned long ev1, unsigned long ev2)<br />
|<br />
|-<br />
|0x80042A00<br />
|long OpenEvent(unsigned long desc, long spec, long mode, long (*func)())<br />
|<br />
|-<br />
|0x80042A10<br />
|long CloseEvent(long event)<br />
|<br />
|-<br />
|0x80042A20<br />
|long WaitEvent(long event)<br />
|<br />
|-<br />
|0x80042A40<br />
|long EnableEvent(long event)<br />
|<br />
|-<br />
|0x80042A50<br />
|long DisableEvent(long event)<br />
|<br />
|-<br />
|0x80042BC0<br />
|long SetRCnt(unsigned long spec, unsigned short target, long mode)<br />
|<br />
|-<br />
|0x80042C60<br />
|long GetRCnt(unsigned long spec)<br />
|<br />
|-<br />
|0x80042C98<br />
|long StartRCnt(unsigned long spec)<br />
|<br />
|-<br />
|0x80042CCC<br />
|long StopRCnt(unsigned long spec)<br />
|<br />
|}<br />
<br />
= Structures =<br />
<br />
struct AkaoSpuVoiceAttr<br />
{<br />
uint32_t voice; // 0x00: voice number<br />
uint32_t update_flags; // 0x04: bitset that indicates what SPU registers need to be updated<br />
uint32_t addr; // 0x08: waveform data start address (SPU address)<br />
uint32_t loop_addr; // 0x0c: loop start address (SPU address)<br />
uint32_t a_mode; // 0x10: ADSR: attack rate mode<br />
uint32_t s_mode; // 0x14: ADSR: sustain rate mode<br />
uint32_t r_mode // 0x18: ADSR: release rate mode<br />
uint16_t pitch; // 0x1c: pitch<br />
uint16_t ar; // 0x1e: ADSR: attack rate<br />
uint16_t dr; // 0x20: ADSR: decay rate<br />
uint16_t sl; // 0x22: ADSR: sustain level<br />
uint16_t sr; // 0x24: ADSR: sustain rate<br />
uint16_t rr; // 0x26: ADSR: release rate<br />
SpuVolume volume; // 0x28: volume (left and right)<br />
};<br />
<br />
struct AkaoPlayer // the music player instance exists at 0x8009A104<br />
{<br />
uint32_t stereo_mode; // 0x00: stereo mode (1: stereo, 4: surround, otherwise: mono)<br />
uint32_t active_voices; // 0x04: bitset that indicates the voices currently in use<br />
uint32_t key_on_voices; // 0x08: bitset that indicates the voices to key on<br />
uint32_t keyed_voices; // 0x0c: bitset that indicates the voices currently keyed on<br />
uint32_t key_off_voices; // 0x10: bitset that indicates the voices to key off<br />
uint32_t saved_active_voices; // 0x14: unknown voice bitset<br />
uint32_t tempo; // 0x18: tempo (Q16 fixed-point number)<br />
int32_t tempo_slope; // 0x1c: slope of tempo slider (Q16 fixed-point number)<br />
uint32_t time_counter; // 0x20: time counter (0x10000 = 1 tick)<br />
uint32_t overlay_voices; // 0x24: bitset that indicates the sub-voices used for overlay (opcode 0xF4)<br />
uint32_t alternate_voices; // 0x28: bitset that indicates the sub-voices used for alternate voice (opcode 0xF8)<br />
uint32_t noise_voices; // 0x2c: bitset that indicates the voices with noise mode enabled<br />
uint32_t reverb_voices; // 0x30: bitset that indicates the voices with reverb enabled<br />
uint32_t pitch_lfo_voices; // 0x34: bitset that indicates the voices with pitch LFO (frequency modulation) mode enabled<br />
uint32_t spucnt; // 0x38: SPUCNT shadow<br />
uint32_t reverb_type; // 0x3c: reverb type<br />
uint32_t reverb_depth; // 0x40: reverb depth (Q16 fixed-point number)<br />
int32_t reverb_depth_slope; // 0x44: slope of reverb depth slider (Q16 fixed-point number)<br />
uint16_t tempo_slide_length; // 0x48: tempo slide length<br />
uint16_t song_id; // 0x4a: current song id<br />
uint16_t condition_ack; // 0x4c: the last matched condition value (opcode 0xEF)<br />
uint16_t condition; // 0x4e: condition variable for dynamic branching according to game status (opcode 0xEF)<br />
uint16_t reverb_depth_slide_length; // 0x50: length of reverb depth slide<br />
uint16_t noise_clock; // 0x52: noise clock frequency<br />
uint16_t field_54; // 0x54: unknown<br />
uint16_t beats_per_measure; // 0x56: beats per measure<br />
uint16_t beat; // 0x58: current beat<br />
uint16_t ticks_per_beat; // 0x5a: ticks per beat<br />
uint16_t tick; // 0x5c: current ticks per beat<br />
uint16_t measure; // 0x5e: current measure<br />
};<br />
<br />
struct AkaoPlayerTrack // the music player track instances exist at 0x80096608 + (N * 0x108)<br />
{<br />
uint8_t *addr; // 0x00<br />
uint8_t *loop_addrs[4]; // 0x04<br />
AkaoDrumKeyAttr *drum_addr; // 0x14<br />
int16_t *vibrato_lfo_addr; // 0x18<br />
int16_t *tremolo_lfo_addr; // 0x1C<br />
int16_t *pan_lfo_addr; // 0x20<br />
uint32_t overlay_voice_num; // 0x24<br />
uint32_t alternate_voice_num; // 0x28<br />
uint32_t master_volume; // 0x2C<br />
uint32_t pitch_of_note; // 0x30<br />
int32_t pitch_bend_slide_amplitude; // 0x34<br />
uint16_t voice_effect_flags; // 0x38<br />
uint16_t field_3A; // 0x3A<br />
uint16_t field_3C; // 0x3C<br />
uint16_t field_3E; // 0x3E<br />
uint32_t field_40; // 0x40<br />
uint32_t volume; // 0x44<br />
int32_t volume_slope; // 0x48<br />
int32_t pitch_bend_slope; // 0x4C<br />
uint16_t field_50; // 0x50<br />
uint16_t field_52; // 0x52<br />
uint16_t field_54; // 0x54<br />
uint8_t delta_time_counter; // 0x56<br />
uint8_t gate_time_counter; // 0x57<br />
uint16_t instrument; // 0x58<br />
uint16_t field_5A; // 0x5A<br />
uint16_t volume_slide_length_counter; // 0x5C<br />
uint16_t overlay_balance_slide_length_counter; // 0x5E<br />
uint16_t pan; // 0x60<br />
uint16_t pan_slide_length; // 0x62<br />
int16_t pitch_slide_length_counter; // 0x64<br />
uint16_t octave; // 0x66<br />
uint16_t pitch_slide_length; // 0x68<br />
uint16_t previous_note_number; // 0x6A<br />
uint16_t portamento_speed; // 0x6C<br />
uint16_t legato_flags; // 0x6E<br />
uint16_t field_70; // 0x70<br />
uint16_t vibrato_lfo_delay; // 0x72<br />
uint16_t vibrato_delay_counter; // 0x74<br />
uint16_t vibrato_rate; // 0x76<br />
uint16_t vibrato_rate_counter; // 0x78<br />
uint16_t vibrato_form; // 0x7A<br />
uint16_t vibrato_max_amplitude; // 0x7C<br />
uint16_t vibrato_depth; // 0x7E<br />
uint16_t vibrato_depth_slide_length_counter; // 0x80<br />
int16_t vibrato_depth_slope; // 0x82<br />
uint16_t field_84; // 0x84<br />
uint16_t tremolo_delay; // 0x86<br />
uint16_t tremolo_delay_counter; // 0x88<br />
uint16_t tremolo_rate; // 0x8A<br />
uint16_t tremolo_rate_counter; // 0x8C<br />
uint16_t tremolo_form; // 0x8E<br />
uint16_t tremolo_depth; // 0x90<br />
uint16_t tremolo_depth_slide_length_counter; // 0x92<br />
int16_t tremolo_depth_slope; // 0x94<br />
uint16_t field_96; // 0x96<br />
uint16_t pan_lfo_rate; // 0x98<br />
uint16_t pan_lfo_rate_counter; // 0x9A<br />
uint16_t pan_lfo_form; // 0x9C<br />
uint16_t pan_lfo_depth; // 0x9E<br />
uint16_t pan_lfo_depth_slide_length_counter; // 0xA0<br />
int16_t pan_lfo_slope; // 0xA2<br />
uint16_t noise_on_off_delay_counter; // 0xA4<br />
uint16_t pitchmod_on_off_delay_counter; // 0xA6<br />
uint8_t field_A8[16]; // 0xA8<br />
uint16_t loop_layer; // 0xB8<br />
uint16_t loop_counts[4]; // 0xBA<br />
uint16_t previous_delta_time; // 0xC2<br />
uint16_t forced_delta_time; // 0xC4<br />
uint16_t overlay_balance; // 0xC6<br />
int16_t overlay_balance_slope; // 0xC8<br />
int16_t pan_slope; // 0xCA<br />
int16_t transpose; // 0xCC<br />
int16_t tuning; // 0xCE<br />
uint16_t note; // 0xD0<br />
int16_t pitch_slide_amount; // 0xD2<br />
int16_t previous_transpose; // 0xD4<br />
int16_t vibrato_lfo_amplitude; // 0xD6<br />
int16_t tremolo_lfo_amplitude; // 0xD8<br />
int16_t pan_lfo_amplitude; // 0xDA<br />
AkaoSpuVoiceAttr spu_attr; // 0xDC<br />
};</div>
Loveemu
https://wiki.ffrtt.ru/index.php?title=FF7/PSX/Sound/Code_Map&diff=5730
FF7/PSX/Sound/Code Map
2020-06-07T05:29:50Z
<p>Loveemu: </p>
<hr />
<div>= Code Map =<br />
<br />
Introduces functions, variables and data related to sound, contained in SCUS_941.63 (game program of US version). Note that all symbol names below are for convenience only.<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x800293D0<br />
|void _AkaoSpuTransferCallback(void)<br />
|<br />
|-<br />
|0x800293F4<br />
|void _AkaoSpuSetTransferCallback(void)<br />
|<br />
|-<br />
|0x80029424<br />
|unsigned int _AkaoTransferSamples(const unsigned char *addr, unsigned int size)<br />
|<br />
|-<br />
|0x800294A4<br />
|void _AkaoWaitForSpuTransfer(void)<br />
|<br />
|-<br />
|0x800294BC<br />
|void _AkaoReset(void)<br />
|<br />
|-<br />
|0x800297A4<br />
|void AkaoLoadInstrumentSet(const void *sampleSet, const void *instrumentSet)<br />
|Load standard instrument set (called transparently from 0x8002988C)<br />
<br />
''sampleSet'': corresponding to SOUND/INSTR.ALL<br />
<br />
''instrumentSet'': corresponding to SOUND/INSTR.DAT<br />
|-<br />
|0x80029818<br />
|void AkaoLoadInstrumentSet2(const void *sampleSet, const void *instrumentSet)<br />
|Load additional instrument set<br />
<br />
''sampleSet'': corresponding to SOUND/INSTR2.ALL<br />
<br />
''instrumentSet'': corresponding to SOUND/INSTR2.DAT<br />
|-<br />
|0x8002988C<br />
|void AkaoInitialize(const void *sampleSet, const void *instrSet)<br />
|Initialize sound driver and load initial instruments<br />
<br />
''sampleSet'': corresponding to SOUND/INSTR.ALL<br />
<br />
''instrSet'': corresponding to SOUND/INSTR.DAT<br />
|-<br />
|0x8002DA7C<br />
|int AkaoLoadSeq(void)<br />
|Load and start playing new [[FF7/PSX/Sound/AKAO sequence|AKAO sequence]]<br />
<br />
Parameters are given from a global structure<br />
<br />
Returns: 0 for success, 1 for already loaded, and -1 for invalid signature<br />
|-<br />
|0x80030234<br />
|int _AkaoCallback(void)<br />
|Callback event for sound, registered by OpenEvent BIOS function<br />
|-<br />
|0x80030E7C<br />
|void _AkaoDispatchVoice(struct MusicPlayerTrack *track, void *a1, int a2)<br />
|Dispatch voice opcodes until the next note or end of track<br />
|-<br />
|0x80049948<br />
|const unsigned char VOICE_OPCODE_LENGTHS[0x60]<br />
|Length table for voice opcodes 0xa0-0xff<br />
<br />
0 for end of track and branches<br />
|-<br />
|0x80049AA8<br />
|void (* const VOICE_OPCODES[0x60])(struct MusicPlayerTrack *, void *, int)<br />
|Address table for voice opcodes 0xa0-0xff<br />
|-<br />
|0x80049C44<br />
|const unsigned short VOLUME_TABLE_L[256]<br />
|See [[FF7/PSX/Sound/Opcodes/0xa8aa|Opcode 0xAA]] for volume balance calculation<br />
|-<br />
|0x80049E44<br />
|const unsigned short VOLUME_TABLE_R[256]<br />
|See [[FF7/PSX/Sound/Opcodes/0xa8aa|Opcode 0xAA]] for volume balance calculation<br />
|-<br />
|0x80083580<br />
|unsigned char g_AkaoSeqData[]<br />
|RAM area to load AKAO sequence data<br />
|}<br />
<br />
== Runtime Library Functions ==<br />
<br />
=== LIBSPU ===<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x80036298<br />
|void SpuInit(void)<br />
|<br />
|-<br />
|0x80036FFC<br />
|long SpuInitMalloc(long num, char *top)<br />
|<br />
|-<br />
|0x800373AC<br />
|long SpuMallocWithStartAddr(unsigned long addr, long size)<br />
|<br />
|-<br />
|0x80037964<br />
|unsigned long SpuSetNoiseVoice(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x80037B90<br />
|long SpuSetNoiseClock(long n_clock)<br />
|<br />
|-<br />
|0x80037BE0<br />
|unsigned long SpuRead(unsigned char *addr, unsigned long size)<br />
|<br />
|-<br />
|0x80037C40<br />
|long SpuSetReverb(long on_off)<br />
|<br />
|-<br />
|0x80037D90<br />
|long SpuGetReverb(void)<br />
|<br />
|-<br />
|0x80037E1C<br />
|long SpuSetReverbModeParam(SpuReverbAttr *attr)<br />
|<br />
|-<br />
|0x800387FC<br />
|void SpuGetReverbModeParam (SpuReverbAttr *attr)<br />
|<br />
|-<br />
|0x8003884C<br />
|long SpuSetReverbDepth(SpuReverbAttr *attr)<br />
|<br />
|-<br />
|0x800388C4<br />
|unsigned long SpuSetReverbVoice(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x800388E8<br />
|long SpuClearReverbWorkArea(long mode)<br />
|<br />
|-<br />
|0x80038A84<br />
|long SpuSetIRQ(long on_off)<br />
|<br />
|-<br />
|0x80038BC4<br />
|unsigned long SpuSetIRQAddr(unsigned long addr)<br />
|<br />
|-<br />
|0x80038C04<br />
|SpuIRQCallbackProc SpuSetIRQCallback(SpuIRQCallbackProc func)<br />
|<br />
|-<br />
|0x80038C6C<br />
|void SpuSetKey(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x80038F04<br />
|unsigned long SpuWrite(unsigned char *addr, unsigned long size)<br />
|<br />
|-<br />
|0x80038F64<br />
|unsigned long SpuSetTransferStartAddr(unsigned long addr)<br />
|<br />
|-<br />
|0x80038FB8<br />
|long SpuSetTransferMode(long mode)<br />
|<br />
|-<br />
|0x80038FEC<br />
|SpuTransferCallbackProc SpuSetTransferCallback(SpuTransferCallbackProc func)<br />
|<br />
|-<br />
|0x80039010<br />
|unsigned long SpuSetPitchLFOVoice(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x80039034<br />
|void SpuSetCommonAttr(SpuCommonAttr *attr)<br />
|<br />
|-<br />
|0x800393C8<br />
|void SpuSetVoiceVolume(int voiceNum, short volL, short volR)<br />
|<br />
|-<br />
|0x80039450<br />
|void SpuSetVoiceVolumeAttr(int voiceNum, short volL, short volR, short volModeL, short volModeR)<br />
|<br />
|-<br />
|0x800395C8<br />
|void SpuSetVoicePitch(int voiceNum, unsigned short pitch)<br />
|<br />
|-<br />
|0x80039644<br />
|void SpuSetVoiceStartAddr(int voiceNum, unsigned long startAddr)<br />
|<br />
|-<br />
|0x800396C0<br />
|void SpuSetVoiceLoopStartAddr(int voiceNum, unsigned long lsa)<br />
|<br />
|-<br />
|0x8003973C<br />
|void SpuSetVoiceDR(int voiceNum, unsigned short DR)<br />
|<br />
|-<br />
|0x800397C8<br />
|void SpuSetVoiceSL(int voiceNum, unsigned short SL)<br />
|<br />
|-<br />
|0x80039850<br />
|void SpuSetVoiceARAttr(int voiceNum, unsigned short AR, long ARmode)<br />
|<br />
|-<br />
|0x800398EC<br />
|void SpuSetVoiceSRAttr(int voiceNum, unsigned short SR, long SRmode)<br />
|<br />
|-<br />
|0x800399D0<br />
|void SpuSetVoiceRRAttr(int voiceNum, unsigned short RR, long RRmode)<br />
|<br />
|}<br />
<br />
=== LIBETC ===<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x8003D0C0<br />
|int ResetCallback(void)<br />
|<br />
|-<br />
|0x8003D150<br />
|int VSyncCallback(void (*func)(void))<br />
|<br />
|-<br />
|0x8003D1B4<br />
|int StopCallback(void)<br />
|<br />
|-<br />
|0x8003D214<br />
|int CheckCallback(void)<br />
|<br />
|}<br />
<br />
=== LIBAPI ===<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x800429F0<br />
|void DeliverEvent(unsigned long ev1, unsigned long ev2)<br />
|<br />
|-<br />
|0x80042A00<br />
|long OpenEvent(unsigned long desc, long spec, long mode, long (*func)())<br />
|<br />
|-<br />
|0x80042A10<br />
|long CloseEvent(long event)<br />
|<br />
|-<br />
|0x80042A20<br />
|long WaitEvent(long event)<br />
|<br />
|-<br />
|0x80042A40<br />
|long EnableEvent(long event)<br />
|<br />
|-<br />
|0x80042A50<br />
|long DisableEvent(long event)<br />
|<br />
|-<br />
|0x80042BC0<br />
|long SetRCnt(unsigned long spec, unsigned short target, long mode)<br />
|<br />
|-<br />
|0x80042C60<br />
|long GetRCnt(unsigned long spec)<br />
|<br />
|-<br />
|0x80042C98<br />
|long StartRCnt(unsigned long spec)<br />
|<br />
|-<br />
|0x80042CCC<br />
|long StopRCnt(unsigned long spec)<br />
|<br />
|}<br />
<br />
= Structures =<br />
<br />
struct AkaoSpuVoiceAttr<br />
{<br />
uint32_t voice; // 0x00: voice number<br />
uint32_t update_flags; // 0x04: bitset that indicates what SPU registers need to be updated<br />
uint32_t addr; // 0x08: waveform data start address (SPU address)<br />
uint32_t loop_addr; // 0x0c: loop start address (SPU address)<br />
uint32_t a_mode; // 0x10: ADSR: attack rate mode<br />
uint32_t s_mode; // 0x14: ADSR: sustain rate mode<br />
uint32_t r_mode // 0x18: ADSR: release rate mode<br />
uint16_t pitch; // 0x1c: pitch<br />
uint16_t ar; // 0x1e: ADSR: attack rate<br />
uint16_t dr; // 0x20: ADSR: decay rate<br />
uint16_t sl; // 0x22: ADSR: sustain level<br />
uint16_t sr; // 0x24: ADSR: sustain rate<br />
uint16_t rr; // 0x26: ADSR: release rate<br />
SpuVolume volume; // 0x28: volume (left and right)<br />
};<br />
<br />
struct AkaoPlayer // the music player instance exists at 0x8009A104<br />
{<br />
uint32_t stereo_mode; // 0x00: stereo mode (1: stereo, 4: surround, otherwise: mono)<br />
uint32_t active_voices; // 0x04: bitset that indicates the voices currently in use<br />
uint32_t key_on_voices; // 0x08: bitset that indicates the voices to key on<br />
uint32_t keyed_voices; // 0x0c: bitset that indicates the voices currently keyed on<br />
uint32_t key_off_voices; // 0x10: bitset that indicates the voices to key off<br />
uint32_t saved_active_voices; // 0x14: unknown voice bitset<br />
uint32_t tempo; // 0x18: tempo (Q16 fixed-point number)<br />
int32_t tempo_slope; // 0x1c: slope of tempo slider (Q16 fixed-point number)<br />
uint32_t time_counter; // 0x20: time counter (0x10000 = 1 tick)<br />
uint32_t overlay_voices; // 0x24: bitset that indicates the sub-voices used for overlay (opcode 0xF4)<br />
uint32_t alternate_voices; // 0x28: bitset that indicates the sub-voices used for alternate voice (opcode 0xF8)<br />
uint32_t noise_voices; // 0x2c: bitset that indicates the voices with noise mode enabled<br />
uint32_t reverb_voices; // 0x30: bitset that indicates the voices with reverb enabled<br />
uint32_t pitch_lfo_voices; // 0x34: bitset that indicates the voices with pitch LFO (frequency modulation) mode enabled<br />
uint32_t spucnt; // 0x38: SPUCNT shadow<br />
uint32_t reverb_type; // 0x3c: reverb type<br />
uint32_t reverb_depth; // 0x40: reverb depth (Q16 fixed-point number)<br />
int32_t reverb_depth_slope; // 0x44: slope of reverb depth slider (Q16 fixed-point number)<br />
uint16_t tempo_slide_length; // 0x48: tempo slide length<br />
uint16_t song_id; // 0x4a: current song id<br />
uint16_t condition_ack; // 0x4c: the last matched condition value (opcode 0xEF)<br />
uint16_t condition; // 0x4e: condition variable for dynamic branching according to game status (opcode 0xEF)<br />
uint16_t reverb_depth_slide_length; // 0x50: length of reverb depth slide<br />
uint16_t noise_clock; // 0x52: noise clock frequency<br />
uint16_t field_54; // 0x54: unknown<br />
uint16_t beats_per_measure; // 0x56: beats per measure<br />
uint16_t beat; // 0x58: current beat<br />
uint16_t ticks_per_beat; // 0x5a: ticks per beat<br />
uint16_t tick; // 0x5c: current ticks per beat<br />
uint16_t measure; // 0x5e: current measure<br />
};<br />
<br />
struct AkaoPlayerTrack // the music player track instances exist at 0x80096608 + (N * 0x108)<br />
{<br />
uint8_t *addr; // 0x00<br />
uint8_t *loop_addrs[4]; // 0x04<br />
AkaoDrumKeyAttr *drum_addr; // 0x14<br />
int16_t *vibrato_lfo_addr; // 0x18<br />
int16_t *tremolo_lfo_addr; // 0x1C<br />
int16_t *pan_lfo_addr; // 0x20<br />
uint32_t overlay_voice_num; // 0x24<br />
uint32_t alternate_voice_num; // 0x28<br />
uint32_t master_volume; // 0x2C<br />
uint32_t pitch_of_note; // 0x30<br />
int32_t pitch_bend_slide_amplitude; // 0x34<br />
uint16_t voice_effect_flags; // 0x38<br />
uint16_t field_3A; // 0x3A<br />
uint16_t field_3C; // 0x3C<br />
uint16_t field_3E; // 0x3E<br />
uint32_t field_40; // 0x40<br />
uint32_t volume; // 0x44<br />
int32_t volume_slope; // 0x48<br />
int32_t pitch_bend_slope; // 0x4C<br />
uint16_t field_50; // 0x50<br />
uint16_t field_52; // 0x52<br />
uint16_t field_54; // 0x54<br />
uint8_t delta_time_counter; // 0x56<br />
uint8_t gate_time_counter; // 0x57<br />
uint16_t instrument; // 0x58<br />
uint16_t field_5A; // 0x5A<br />
uint16_t volume_slide_length_counter; // 0x5C<br />
uint16_t overlay_balance_slide_length_counter; // 0x5E<br />
uint16_t pan; // 0x60<br />
uint16_t pan_slide_length; // 0x62<br />
int16_t pitch_slide_length_counter; // 0x64<br />
uint16_t octave; // 0x66<br />
uint16_t pitch_slide_length; // 0x68<br />
uint16_t previous_note_number; // 0x6A<br />
uint16_t portamento_speed; // 0x6C<br />
uint16_t legato_flags; // 0x6E<br />
uint16_t field_70; // 0x70<br />
uint16_t vibrato_lfo_delay; // 0x72<br />
uint16_t vibrato_delay_counter; // 0x74<br />
uint16_t vibrato_rate; // 0x76<br />
uint16_t vibrato_rate_counter; // 0x78<br />
uint16_t vibrato_form; // 0x7A<br />
uint16_t vibrato_max_amplitude; // 0x7C<br />
uint16_t vibrato_depth; // 0x7E<br />
uint16_t vibrato_depth_slide_length_counter; // 0x80<br />
int16_t vibrato_depth_slope; // 0x82<br />
uint16_t field_84; // 0x84<br />
uint16_t tremolo_delay; // 0x86<br />
uint16_t tremolo_delay_counter; // 0x88<br />
uint16_t tremolo_rate; // 0x8A<br />
uint16_t tremolo_rate_counter; // 0x8C<br />
uint16_t tremolo_form; // 0x8E<br />
uint16_t tremolo_depth; // 0x90<br />
uint16_t tremolo_depth_slide_length_counter; // 0x92<br />
int16_t tremolo_depth_slope; // 0x94<br />
uint16_t field_96; // 0x96<br />
uint16_t pan_lfo_rate; // 0x98<br />
uint16_t pan_lfo_rate_counter; // 0x9A<br />
uint16_t pan_lfo_form; // 0x9C<br />
uint16_t pan_lfo_depth; // 0x9E<br />
uint16_t pan_lfo_depth_slide_length_counter; // 0xA0<br />
int16_t pan_lfo_slope; // 0xA2<br />
uint16_t noise_on_off_delay_counter; // 0xA4<br />
uint16_t pitchmod_on_off_delay_counter; // 0xA6<br />
uint8_t field_A8[16]; // 0xA8<br />
uint16_t loop_layer; // 0xB8<br />
uint16_t loop_counts[4]; // 0xBA<br />
uint16_t previous_delta_time; // 0xC2<br />
uint16_t forced_delta_time; // 0xC4<br />
uint16_t overlay_balance; // 0xC6<br />
int16_t overlay_balance_slope; // 0xC8<br />
int16_t pan_slope; // 0xCA<br />
int16_t transpose; // 0xCC<br />
int16_t tuning; // 0xCE<br />
uint16_t note; // 0xD0<br />
int16_t pitch_slide_amount; // 0xD2<br />
int16_t previous_transpose; // 0xD4<br />
int16_t vibrato_lfo_amplitude; // 0xD6<br />
int16_t tremolo_lfo_amplitude; // 0xD8<br />
int16_t pan_lfo_amplitude; // 0xDA<br />
AkaoSpuVoiceAttr spu_attr; // 0xDC<br />
};</div>
Loveemu
https://wiki.ffrtt.ru/index.php?title=FF7/PSX/Sound/Code_Map&diff=5729
FF7/PSX/Sound/Code Map
2020-06-07T05:18:14Z
<p>Loveemu: </p>
<hr />
<div>= Code Map =<br />
<br />
Introduces functions, variables and data related to sound, contained in SCUS_941.63 (game program of US version). Note that all symbol names below are for convenience only.<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x800293D0<br />
|void _AkaoSpuTransferCallback(void)<br />
|<br />
|-<br />
|0x800293F4<br />
|void _AkaoSpuSetTransferCallback(void)<br />
|<br />
|-<br />
|0x80029424<br />
|unsigned int _AkaoTransferSamples(uint8_t *addr, unsigned int size)<br />
|<br />
|-<br />
|0x800294A4<br />
|void _AkaoWaitForSpuTransfer(void)<br />
|<br />
|-<br />
|0x800294BC<br />
|void _AkaoReset(void)<br />
|<br />
|-<br />
|0x800297A4<br />
|void AkaoLoadInstrumentSet(const void *sampleSet, const void *instrumentSet)<br />
|Load standard instrument set (called transparently from 0x8002988C)<br />
<br />
''sampleSet'': corresponding to SOUND/INSTR.ALL<br />
<br />
''instrumentSet'': corresponding to SOUND/INSTR.DAT<br />
|-<br />
|0x80029818<br />
|void AkaoLoadInstrumentSet2(const void *sampleSet, const void *instrumentSet)<br />
|Load additional instrument set<br />
<br />
''sampleSet'': corresponding to SOUND/INSTR2.ALL<br />
<br />
''instrumentSet'': corresponding to SOUND/INSTR2.DAT<br />
|-<br />
|0x8002988C<br />
|void AkaoInitialize(const void *sampleSet, const void *instrSet)<br />
|Initialize sound driver and load initial instruments<br />
<br />
''sampleSet'': corresponding to SOUND/INSTR.ALL<br />
<br />
''instrSet'': corresponding to SOUND/INSTR.DAT<br />
|-<br />
|0x8002DA7C<br />
|int AkaoLoadSeq(void)<br />
|Load and start playing new [[FF7/PSX/Sound/AKAO sequence|AKAO sequence]]<br />
<br />
Parameters are given from a global structure<br />
<br />
Returns: 0 for success, 1 for already loaded, and -1 for invalid signature<br />
|-<br />
|0x80030234<br />
|int _AkaoCallback(void)<br />
|Callback event for sound, registered by OpenEvent BIOS function<br />
|-<br />
|0x80030E7C<br />
|void _AkaoDispatchVoice(struct MusicPlayerTrack *track, void *a1, int a2)<br />
|Dispatch voice opcodes until the next note or end of track<br />
|-<br />
|0x80049948<br />
|const unsigned char VOICE_OPCODE_LENGTHS[0x60]<br />
|Length table for voice opcodes 0xa0-0xff<br />
<br />
0 for end of track and branches<br />
|-<br />
|0x80049AA8<br />
|void (* const VOICE_OPCODES[0x60])(struct MusicPlayerTrack *, void *, int)<br />
|Address table for voice opcodes 0xa0-0xff<br />
|-<br />
|0x80049C44<br />
|const unsigned short VOLUME_TABLE_L[256]<br />
|See [[FF7/PSX/Sound/Opcodes/0xa8aa|Opcode 0xAA]] for volume balance calculation<br />
|-<br />
|0x80049E44<br />
|const unsigned short VOLUME_TABLE_R[256]<br />
|See [[FF7/PSX/Sound/Opcodes/0xa8aa|Opcode 0xAA]] for volume balance calculation<br />
|-<br />
|0x80083580<br />
|unsigned char g_AkaoSeqData[]<br />
|RAM area to load AKAO sequence data<br />
|}<br />
<br />
== Runtime Library Functions ==<br />
<br />
=== LIBSPU ===<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x80036298<br />
|void SpuInit(void)<br />
|<br />
|-<br />
|0x80036FFC<br />
|long SpuInitMalloc(long num, char *top)<br />
|<br />
|-<br />
|0x800373AC<br />
|long SpuMallocWithStartAddr(unsigned long addr, long size)<br />
|<br />
|-<br />
|0x80037964<br />
|unsigned long SpuSetNoiseVoice(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x80037B90<br />
|long SpuSetNoiseClock(long n_clock)<br />
|<br />
|-<br />
|0x80037BE0<br />
|unsigned long SpuRead(unsigned char *addr, unsigned long size)<br />
|<br />
|-<br />
|0x80037C40<br />
|long SpuSetReverb(long on_off)<br />
|<br />
|-<br />
|0x80037D90<br />
|long SpuGetReverb(void)<br />
|<br />
|-<br />
|0x80037E1C<br />
|long SpuSetReverbModeParam(SpuReverbAttr *attr)<br />
|<br />
|-<br />
|0x800387FC<br />
|void SpuGetReverbModeParam (SpuReverbAttr *attr)<br />
|<br />
|-<br />
|0x8003884C<br />
|long SpuSetReverbDepth(SpuReverbAttr *attr)<br />
|<br />
|-<br />
|0x800388C4<br />
|unsigned long SpuSetReverbVoice(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x800388E8<br />
|long SpuClearReverbWorkArea(long mode)<br />
|<br />
|-<br />
|0x80038A84<br />
|long SpuSetIRQ(long on_off)<br />
|<br />
|-<br />
|0x80038BC4<br />
|unsigned long SpuSetIRQAddr(unsigned long addr)<br />
|<br />
|-<br />
|0x80038C04<br />
|SpuIRQCallbackProc SpuSetIRQCallback(SpuIRQCallbackProc func)<br />
|<br />
|-<br />
|0x80038C6C<br />
|void SpuSetKey(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x80038F04<br />
|unsigned long SpuWrite(unsigned char *addr, unsigned long size)<br />
|<br />
|-<br />
|0x80038F64<br />
|unsigned long SpuSetTransferStartAddr(unsigned long addr)<br />
|<br />
|-<br />
|0x80038FB8<br />
|long SpuSetTransferMode(long mode)<br />
|<br />
|-<br />
|0x80038FEC<br />
|SpuTransferCallbackProc SpuSetTransferCallback(SpuTransferCallbackProc func)<br />
|<br />
|-<br />
|0x80039010<br />
|unsigned long SpuSetPitchLFOVoice(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x80039034<br />
|void SpuSetCommonAttr(SpuCommonAttr *attr)<br />
|<br />
|-<br />
|0x800393C8<br />
|void SpuSetVoiceVolume(int voiceNum, short volL, short volR)<br />
|<br />
|-<br />
|0x80039450<br />
|void SpuSetVoiceVolumeAttr(int voiceNum, short volL, short volR, short volModeL, short volModeR)<br />
|<br />
|-<br />
|0x800395C8<br />
|void SpuSetVoicePitch(int voiceNum, unsigned short pitch)<br />
|<br />
|-<br />
|0x80039644<br />
|void SpuSetVoiceStartAddr(int voiceNum, unsigned long startAddr)<br />
|<br />
|-<br />
|0x800396C0<br />
|void SpuSetVoiceLoopStartAddr(int voiceNum, unsigned long lsa)<br />
|<br />
|-<br />
|0x8003973C<br />
|void SpuSetVoiceDR(int voiceNum, unsigned short DR)<br />
|<br />
|-<br />
|0x800397C8<br />
|void SpuSetVoiceSL(int voiceNum, unsigned short SL)<br />
|<br />
|-<br />
|0x80039850<br />
|void SpuSetVoiceARAttr(int voiceNum, unsigned short AR, long ARmode)<br />
|<br />
|-<br />
|0x800398EC<br />
|void SpuSetVoiceSRAttr(int voiceNum, unsigned short SR, long SRmode)<br />
|<br />
|-<br />
|0x800399D0<br />
|void SpuSetVoiceRRAttr(int voiceNum, unsigned short RR, long RRmode)<br />
|<br />
|}<br />
<br />
=== LIBETC ===<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x8003D0C0<br />
|int ResetCallback(void)<br />
|<br />
|-<br />
|0x8003D150<br />
|int VSyncCallback(void (*func)(void))<br />
|<br />
|-<br />
|0x8003D1B4<br />
|int StopCallback(void)<br />
|<br />
|-<br />
|0x8003D214<br />
|int CheckCallback(void)<br />
|<br />
|}<br />
<br />
=== LIBAPI ===<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x800429F0<br />
|void DeliverEvent(unsigned long ev1, unsigned long ev2)<br />
|<br />
|-<br />
|0x80042A00<br />
|long OpenEvent(unsigned long desc, long spec, long mode, long (*func)())<br />
|<br />
|-<br />
|0x80042A10<br />
|long CloseEvent(long event)<br />
|<br />
|-<br />
|0x80042A20<br />
|long WaitEvent(long event)<br />
|<br />
|-<br />
|0x80042A40<br />
|long EnableEvent(long event)<br />
|<br />
|-<br />
|0x80042A50<br />
|long DisableEvent(long event)<br />
|<br />
|-<br />
|0x80042BC0<br />
|long SetRCnt(unsigned long spec, unsigned short target, long mode)<br />
|<br />
|-<br />
|0x80042C60<br />
|long GetRCnt(unsigned long spec)<br />
|<br />
|-<br />
|0x80042C98<br />
|long StartRCnt(unsigned long spec)<br />
|<br />
|-<br />
|0x80042CCC<br />
|long StopRCnt(unsigned long spec)<br />
|<br />
|}<br />
<br />
= Structures =<br />
<br />
struct AkaoSpuVoiceAttr<br />
{<br />
uint32_t voice; // 0x00: voice number<br />
uint32_t update_flags; // 0x04: bitset that indicates what SPU registers need to be updated<br />
uint32_t addr; // 0x08: waveform data start address (SPU address)<br />
uint32_t loop_addr; // 0x0c: loop start address (SPU address)<br />
uint32_t a_mode; // 0x10: ADSR: attack rate mode<br />
uint32_t s_mode; // 0x14: ADSR: sustain rate mode<br />
uint32_t r_mode // 0x18: ADSR: release rate mode<br />
uint16_t pitch; // 0x1c: pitch<br />
uint16_t ar; // 0x1e: ADSR: attack rate<br />
uint16_t dr; // 0x20: ADSR: decay rate<br />
uint16_t sl; // 0x22: ADSR: sustain level<br />
uint16_t sr; // 0x24: ADSR: sustain rate<br />
uint16_t rr; // 0x26: ADSR: release rate<br />
SpuVolume volume; // 0x28: volume (left and right)<br />
};<br />
<br />
struct AkaoPlayer // the music player instance exists at 0x8009A104<br />
{<br />
uint32_t stereo_mode; // 0x00: stereo mode (1: stereo, 4: surround, otherwise: mono)<br />
uint32_t active_voices; // 0x04: bitset that indicates the voices currently in use<br />
uint32_t key_on_voices; // 0x08: bitset that indicates the voices to key on<br />
uint32_t keyed_voices; // 0x0c: bitset that indicates the voices currently keyed on<br />
uint32_t key_off_voices; // 0x10: bitset that indicates the voices to key off<br />
uint32_t saved_active_voices; // 0x14: unknown voice bitset<br />
uint32_t tempo; // 0x18: tempo (Q16 fixed-point number)<br />
int32_t tempo_slope; // 0x1c: slope of tempo slider (Q16 fixed-point number)<br />
uint32_t time_counter; // 0x20: time counter (0x10000 = 1 tick)<br />
uint32_t overlay_voices; // 0x24: bitset that indicates the sub-voices used for overlay (opcode 0xF4)<br />
uint32_t alternate_voices; // 0x28: bitset that indicates the sub-voices used for alternate voice (opcode 0xF8)<br />
uint32_t noise_voices; // 0x2c: bitset that indicates the voices with noise mode enabled<br />
uint32_t reverb_voices; // 0x30: bitset that indicates the voices with reverb enabled<br />
uint32_t pitch_lfo_voices; // 0x34: bitset that indicates the voices with pitch LFO (frequency modulation) mode enabled<br />
uint32_t spucnt; // 0x38: SPUCNT shadow<br />
uint32_t reverb_type; // 0x3c: reverb type<br />
uint32_t reverb_depth; // 0x40: reverb depth (Q16 fixed-point number)<br />
int32_t reverb_depth_slope; // 0x44: slope of reverb depth slider (Q16 fixed-point number)<br />
uint16_t tempo_slide_length; // 0x48: tempo slide length<br />
uint16_t song_id; // 0x4a: current song id<br />
uint16_t condition_ack; // 0x4c: the last matched condition value (opcode 0xEF)<br />
uint16_t condition; // 0x4e: condition variable for dynamic branching according to game status (opcode 0xEF)<br />
uint16_t reverb_depth_slide_length; // 0x50: length of reverb depth slide<br />
uint16_t noise_clock; // 0x52: noise clock frequency<br />
uint16_t field_54; // 0x54: unknown<br />
uint16_t beats_per_measure; // 0x56: beats per measure<br />
uint16_t beat; // 0x58: current beat<br />
uint16_t ticks_per_beat; // 0x5a: ticks per beat<br />
uint16_t tick; // 0x5c: current ticks per beat<br />
uint16_t measure; // 0x5e: current measure<br />
};<br />
<br />
struct AkaoPlayerTrack // the music player track instances exist at 0x80096608 + (N * 0x108)<br />
{<br />
uint8_t *addr; // 0x00<br />
uint8_t *loop_addrs[4]; // 0x04<br />
AkaoDrumKeyAttr *drum_addr; // 0x14<br />
int16_t *vibrato_lfo_addr; // 0x18<br />
int16_t *tremolo_lfo_addr; // 0x1C<br />
int16_t *pan_lfo_addr; // 0x20<br />
uint32_t overlay_voice_num; // 0x24<br />
uint32_t alternate_voice_num; // 0x28<br />
uint32_t master_volume; // 0x2C<br />
uint32_t pitch_of_note; // 0x30<br />
int32_t pitch_bend_slide_amplitude; // 0x34<br />
uint16_t voice_effect_flags; // 0x38<br />
uint16_t field_3A; // 0x3A<br />
uint16_t field_3C; // 0x3C<br />
uint16_t field_3E; // 0x3E<br />
uint32_t field_40; // 0x40<br />
uint32_t volume; // 0x44<br />
int32_t volume_slope; // 0x48<br />
int32_t pitch_bend_slope; // 0x4C<br />
uint16_t field_50; // 0x50<br />
uint16_t field_52; // 0x52<br />
uint16_t field_54; // 0x54<br />
uint8_t delta_time_counter; // 0x56<br />
uint8_t gate_time_counter; // 0x57<br />
uint16_t instrument; // 0x58<br />
uint16_t field_5A; // 0x5A<br />
uint16_t volume_slide_length_counter; // 0x5C<br />
uint16_t overlay_balance_slide_length_counter; // 0x5E<br />
uint16_t pan; // 0x60<br />
uint16_t pan_slide_length; // 0x62<br />
int16_t pitch_slide_length_counter; // 0x64<br />
uint16_t octave; // 0x66<br />
uint16_t pitch_slide_length; // 0x68<br />
uint16_t previous_note_number; // 0x6A<br />
uint16_t portamento_speed; // 0x6C<br />
uint16_t legato_flags; // 0x6E<br />
uint16_t field_70; // 0x70<br />
uint16_t vibrato_lfo_delay; // 0x72<br />
uint16_t vibrato_delay_counter; // 0x74<br />
uint16_t vibrato_rate; // 0x76<br />
uint16_t vibrato_rate_counter; // 0x78<br />
uint16_t vibrato_form; // 0x7A<br />
uint16_t vibrato_max_amplitude; // 0x7C<br />
uint16_t vibrato_depth; // 0x7E<br />
uint16_t vibrato_depth_slide_length_counter; // 0x80<br />
int16_t vibrato_depth_slope; // 0x82<br />
uint16_t field_84; // 0x84<br />
uint16_t tremolo_delay; // 0x86<br />
uint16_t tremolo_delay_counter; // 0x88<br />
uint16_t tremolo_rate; // 0x8A<br />
uint16_t tremolo_rate_counter; // 0x8C<br />
uint16_t tremolo_form; // 0x8E<br />
uint16_t tremolo_depth; // 0x90<br />
uint16_t tremolo_depth_slide_length_counter; // 0x92<br />
int16_t tremolo_depth_slope; // 0x94<br />
uint16_t field_96; // 0x96<br />
uint16_t pan_lfo_rate; // 0x98<br />
uint16_t pan_lfo_rate_counter; // 0x9A<br />
uint16_t pan_lfo_form; // 0x9C<br />
uint16_t pan_lfo_depth; // 0x9E<br />
uint16_t pan_lfo_depth_slide_length_counter; // 0xA0<br />
int16_t pan_lfo_slope; // 0xA2<br />
uint16_t noise_on_off_delay_counter; // 0xA4<br />
uint16_t pitchmod_on_off_delay_counter; // 0xA6<br />
uint8_t field_A8[16]; // 0xA8<br />
uint16_t loop_layer; // 0xB8<br />
uint16_t loop_counts[4]; // 0xBA<br />
uint16_t previous_delta_time; // 0xC2<br />
uint16_t forced_delta_time; // 0xC4<br />
uint16_t overlay_balance; // 0xC6<br />
int16_t overlay_balance_slope; // 0xC8<br />
int16_t pan_slope; // 0xCA<br />
int16_t transpose; // 0xCC<br />
int16_t tuning; // 0xCE<br />
uint16_t note; // 0xD0<br />
int16_t pitch_slide_amount; // 0xD2<br />
int16_t previous_transpose; // 0xD4<br />
int16_t vibrato_lfo_amplitude; // 0xD6<br />
int16_t tremolo_lfo_amplitude; // 0xD8<br />
int16_t pan_lfo_amplitude; // 0xDA<br />
AkaoSpuVoiceAttr spu_attr; // 0xDC<br />
};</div>
Loveemu
https://wiki.ffrtt.ru/index.php?title=FF7/PSX/Sound/Code_Map&diff=5728
FF7/PSX/Sound/Code Map
2020-06-06T15:03:01Z
<p>Loveemu: Add AkaoPlayerTrack structure</p>
<hr />
<div>= Code Map =<br />
<br />
Introduces functions, variables and data related to sound, contained in SCUS_941.63 (game program of US version). Note that all symbol names below are for convenience only.<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x80029818<br />
|void AkaoLoadInstrSet(const void *sampleSet, const void *instrSet)<br />
|Load additional instrument set<br />
<br />
''sampleSet'': corresponding to SOUND/INSTR2.ALL<br />
<br />
''instrSet'': corresponding to SOUND/INSTR2.DAT<br />
|-<br />
|0x8002988C<br />
|void AkaoInit(const void *sampleSet, const void *instrSet)<br />
|Initialize sound driver and load initial instruments<br />
<br />
''sampleSet'': corresponding to SOUND/INSTR.ALL<br />
<br />
''instrSet'': corresponding to SOUND/INSTR.DAT<br />
|-<br />
|0x8002DA7C<br />
|int AkaoLoadSeq(void)<br />
|Load and start playing new [[FF7/PSX/Sound/AKAO sequence|AKAO sequence]]<br />
<br />
Parameters are given from a global structure<br />
<br />
Returns: 0 for success, 1 for already loaded, and -1 for invalid signature<br />
|-<br />
|0x80030234<br />
|int _AkaoCallback(void)<br />
|Callback event for sound, registered by OpenEvent BIOS function<br />
|-<br />
|0x80030E7C<br />
|void _AkaoDispatchVoice(struct MusicPlayerTrack *track, void *a1, int a2)<br />
|Dispatch voice opcodes until the next note or end of track<br />
|-<br />
|0x80049948<br />
|const unsigned char VOICE_OPCODE_LENGTHS[0x60]<br />
|Length table for voice opcodes 0xa0-0xff<br />
<br />
0 for end of track and branches<br />
|-<br />
|0x80049AA8<br />
|void (* const VOICE_OPCODES[0x60])(struct MusicPlayerTrack *, void *, int)<br />
|Address table for voice opcodes 0xa0-0xff<br />
|-<br />
|0x80049C44<br />
|const unsigned short VOLUME_TABLE_L[256]<br />
|See [[FF7/PSX/Sound/Opcodes/0xa8aa|Opcode 0xAA]] for volume balance calculation<br />
|-<br />
|0x80049E44<br />
|const unsigned short VOLUME_TABLE_R[256]<br />
|See [[FF7/PSX/Sound/Opcodes/0xa8aa|Opcode 0xAA]] for volume balance calculation<br />
|-<br />
|0x80083580<br />
|unsigned char g_AkaoSeqData[]<br />
|RAM area to load AKAO sequence data<br />
|}<br />
<br />
== Runtime Library Functions ==<br />
<br />
=== LIBSPU ===<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x80036298<br />
|void SpuInit(void)<br />
|<br />
|-<br />
|0x80036FFC<br />
|long SpuInitMalloc(long num, char *top)<br />
|<br />
|-<br />
|0x800373AC<br />
|long SpuMallocWithStartAddr(unsigned long addr, long size)<br />
|<br />
|-<br />
|0x80037964<br />
|unsigned long SpuSetNoiseVoice(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x80037B90<br />
|long SpuSetNoiseClock(long n_clock)<br />
|<br />
|-<br />
|0x80037BE0<br />
|unsigned long SpuRead(unsigned char *addr, unsigned long size)<br />
|<br />
|-<br />
|0x80037C40<br />
|long SpuSetReverb(long on_off)<br />
|<br />
|-<br />
|0x80037D90<br />
|long SpuGetReverb(void)<br />
|<br />
|-<br />
|0x80037E1C<br />
|long SpuSetReverbModeParam(SpuReverbAttr *attr)<br />
|<br />
|-<br />
|0x800387FC<br />
|void SpuGetReverbModeParam (SpuReverbAttr *attr)<br />
|<br />
|-<br />
|0x8003884C<br />
|long SpuSetReverbDepth(SpuReverbAttr *attr)<br />
|<br />
|-<br />
|0x800388C4<br />
|unsigned long SpuSetReverbVoice(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x800388E8<br />
|long SpuClearReverbWorkArea(long mode)<br />
|<br />
|-<br />
|0x80038A84<br />
|long SpuSetIRQ(long on_off)<br />
|<br />
|-<br />
|0x80038BC4<br />
|unsigned long SpuSetIRQAddr(unsigned long addr)<br />
|<br />
|-<br />
|0x80038C04<br />
|SpuIRQCallbackProc SpuSetIRQCallback(SpuIRQCallbackProc func)<br />
|<br />
|-<br />
|0x80038C6C<br />
|void SpuSetKey(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x80038F04<br />
|unsigned long SpuWrite(unsigned char *addr, unsigned long size)<br />
|<br />
|-<br />
|0x80038F64<br />
|unsigned long SpuSetTransferStartAddr(unsigned long addr)<br />
|<br />
|-<br />
|0x80038FB8<br />
|long SpuSetTransferMode(long mode)<br />
|<br />
|-<br />
|0x80038FEC<br />
|SpuTransferCallbackProc SpuSetTransferCallback(SpuTransferCallbackProc func)<br />
|<br />
|-<br />
|0x80039010<br />
|unsigned long SpuSetPitchLFOVoice(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x80039034<br />
|void SpuSetCommonAttr(SpuCommonAttr *attr)<br />
|<br />
|-<br />
|0x800393C8<br />
|void SpuSetVoiceVolume(int voiceNum, short volL, short volR)<br />
|<br />
|-<br />
|0x80039450<br />
|void SpuSetVoiceVolumeAttr(int voiceNum, short volL, short volR, short volModeL, short volModeR)<br />
|<br />
|-<br />
|0x800395C8<br />
|void SpuSetVoicePitch(int voiceNum, unsigned short pitch)<br />
|<br />
|-<br />
|0x80039644<br />
|void SpuSetVoiceStartAddr(int voiceNum, unsigned long startAddr)<br />
|<br />
|-<br />
|0x800396C0<br />
|void SpuSetVoiceLoopStartAddr(int voiceNum, unsigned long lsa)<br />
|<br />
|-<br />
|0x8003973C<br />
|void SpuSetVoiceDR(int voiceNum, unsigned short DR)<br />
|<br />
|-<br />
|0x800397C8<br />
|void SpuSetVoiceSL(int voiceNum, unsigned short SL)<br />
|<br />
|-<br />
|0x80039850<br />
|void SpuSetVoiceARAttr(int voiceNum, unsigned short AR, long ARmode)<br />
|<br />
|-<br />
|0x800398EC<br />
|void SpuSetVoiceSRAttr(int voiceNum, unsigned short SR, long SRmode)<br />
|<br />
|-<br />
|0x800399D0<br />
|void SpuSetVoiceRRAttr(int voiceNum, unsigned short RR, long RRmode)<br />
|<br />
|}<br />
<br />
=== LIBETC ===<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x8003D0C0<br />
|int ResetCallback(void)<br />
|<br />
|-<br />
|0x8003D150<br />
|int VSyncCallback(void (*func)(void))<br />
|<br />
|-<br />
|0x8003D1B4<br />
|int StopCallback(void)<br />
|<br />
|-<br />
|0x8003D214<br />
|int CheckCallback(void)<br />
|<br />
|}<br />
<br />
=== LIBAPI ===<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x800429F0<br />
|void DeliverEvent(unsigned long ev1, unsigned long ev2)<br />
|<br />
|-<br />
|0x80042A00<br />
|long OpenEvent(unsigned long desc, long spec, long mode, long (*func)())<br />
|<br />
|-<br />
|0x80042A10<br />
|long CloseEvent(long event)<br />
|<br />
|-<br />
|0x80042A20<br />
|long WaitEvent(long event)<br />
|<br />
|-<br />
|0x80042A40<br />
|long EnableEvent(long event)<br />
|<br />
|-<br />
|0x80042A50<br />
|long DisableEvent(long event)<br />
|<br />
|-<br />
|0x80042BC0<br />
|long SetRCnt(unsigned long spec, unsigned short target, long mode)<br />
|<br />
|-<br />
|0x80042C60<br />
|long GetRCnt(unsigned long spec)<br />
|<br />
|-<br />
|0x80042C98<br />
|long StartRCnt(unsigned long spec)<br />
|<br />
|-<br />
|0x80042CCC<br />
|long StopRCnt(unsigned long spec)<br />
|<br />
|}<br />
<br />
= Structures =<br />
<br />
struct AkaoSpuVoiceAttr<br />
{<br />
uint32_t voice; // 0x00: voice number<br />
uint32_t update_flags; // 0x04: bitset that indicates what SPU registers need to be updated<br />
uint32_t addr; // 0x08: waveform data start address (SPU address)<br />
uint32_t loop_addr; // 0x0c: loop start address (SPU address)<br />
uint32_t a_mode; // 0x10: ADSR: attack rate mode<br />
uint32_t s_mode; // 0x14: ADSR: sustain rate mode<br />
uint32_t r_mode // 0x18: ADSR: release rate mode<br />
uint16_t pitch; // 0x1c: pitch<br />
uint16_t ar; // 0x1e: ADSR: attack rate<br />
uint16_t dr; // 0x20: ADSR: decay rate<br />
uint16_t sl; // 0x22: ADSR: sustain level<br />
uint16_t sr; // 0x24: ADSR: sustain rate<br />
uint16_t rr; // 0x26: ADSR: release rate<br />
SpuVolume volume; // 0x28: volume (left and right)<br />
};<br />
<br />
struct AkaoPlayer // the music player instance exists at 0x8009A104<br />
{<br />
uint32_t stereo_mode; // 0x00: stereo mode (1: stereo, 4: surround, otherwise: mono)<br />
uint32_t active_voices; // 0x04: bitset that indicates the voices currently in use<br />
uint32_t key_on_voices; // 0x08: bitset that indicates the voices to key on<br />
uint32_t keyed_voices; // 0x0c: bitset that indicates the voices currently keyed on<br />
uint32_t key_off_voices; // 0x10: bitset that indicates the voices to key off<br />
uint32_t saved_active_voices; // 0x14: unknown voice bitset<br />
uint32_t tempo; // 0x18: tempo (Q16 fixed-point number)<br />
int32_t tempo_slope; // 0x1c: slope of tempo slider (Q16 fixed-point number)<br />
uint32_t time_counter; // 0x20: time counter (0x10000 = 1 tick)<br />
uint32_t overlay_voices; // 0x24: bitset that indicates the sub-voices used for overlay (opcode 0xF4)<br />
uint32_t alternate_voices; // 0x28: bitset that indicates the sub-voices used for alternate voice (opcode 0xF8)<br />
uint32_t noise_voices; // 0x2c: bitset that indicates the voices with noise mode enabled<br />
uint32_t reverb_voices; // 0x30: bitset that indicates the voices with reverb enabled<br />
uint32_t pitch_lfo_voices; // 0x34: bitset that indicates the voices with pitch LFO (frequency modulation) mode enabled<br />
uint32_t spucnt; // 0x38: SPUCNT shadow<br />
uint32_t reverb_type; // 0x3c: reverb type<br />
uint32_t reverb_depth; // 0x40: reverb depth (Q16 fixed-point number)<br />
int32_t reverb_depth_slope; // 0x44: slope of reverb depth slider (Q16 fixed-point number)<br />
uint16_t tempo_slide_length; // 0x48: tempo slide length<br />
uint16_t song_id; // 0x4a: current song id<br />
uint16_t condition_ack; // 0x4c: the last matched condition value (opcode 0xEF)<br />
uint16_t condition; // 0x4e: condition variable for dynamic branching according to game status (opcode 0xEF)<br />
uint16_t reverb_depth_slide_length; // 0x50: length of reverb depth slide<br />
uint16_t noise_clock; // 0x52: noise clock frequency<br />
uint16_t field_54; // 0x54: unknown<br />
uint16_t beats_per_measure; // 0x56: beats per measure<br />
uint16_t beat; // 0x58: current beat<br />
uint16_t ticks_per_beat; // 0x5a: ticks per beat<br />
uint16_t tick; // 0x5c: current ticks per beat<br />
uint16_t measure; // 0x5e: current measure<br />
};<br />
<br />
struct AkaoPlayerTrack // the music player track instances exist at 0x80096608 + (N * 0x108)<br />
{<br />
uint8_t *addr; // 0x00<br />
uint8_t *loop_addrs[4]; // 0x04<br />
AkaoDrumKeyAttr *drum_addr; // 0x14<br />
int16_t *vibrato_lfo_addr; // 0x18<br />
int16_t *tremolo_lfo_addr; // 0x1C<br />
int16_t *pan_lfo_addr; // 0x20<br />
uint32_t overlay_voice_num; // 0x24<br />
uint32_t alternate_voice_num; // 0x28<br />
uint32_t master_volume; // 0x2C<br />
uint32_t pitch_of_note; // 0x30<br />
int32_t pitch_bend_slide_amplitude; // 0x34<br />
uint16_t voice_effect_flags; // 0x38<br />
uint16_t field_3A; // 0x3A<br />
uint16_t field_3C; // 0x3C<br />
uint16_t field_3E; // 0x3E<br />
uint32_t field_40; // 0x40<br />
uint32_t volume; // 0x44<br />
int32_t volume_slope; // 0x48<br />
int32_t pitch_bend_slope; // 0x4C<br />
uint16_t field_50; // 0x50<br />
uint16_t field_52; // 0x52<br />
uint16_t field_54; // 0x54<br />
uint8_t delta_time_counter; // 0x56<br />
uint8_t gate_time_counter; // 0x57<br />
uint16_t instrument; // 0x58<br />
uint16_t field_5A; // 0x5A<br />
uint16_t volume_slide_length_counter; // 0x5C<br />
uint16_t overlay_balance_slide_length_counter; // 0x5E<br />
uint16_t pan; // 0x60<br />
uint16_t pan_slide_length; // 0x62<br />
int16_t pitch_slide_length_counter; // 0x64<br />
uint16_t octave; // 0x66<br />
uint16_t pitch_slide_length; // 0x68<br />
uint16_t previous_note_number; // 0x6A<br />
uint16_t portamento_speed; // 0x6C<br />
uint16_t legato_flags; // 0x6E<br />
uint16_t field_70; // 0x70<br />
uint16_t vibrato_lfo_delay; // 0x72<br />
uint16_t vibrato_delay_counter; // 0x74<br />
uint16_t vibrato_rate; // 0x76<br />
uint16_t vibrato_rate_counter; // 0x78<br />
uint16_t vibrato_form; // 0x7A<br />
uint16_t vibrato_max_amplitude; // 0x7C<br />
uint16_t vibrato_depth; // 0x7E<br />
uint16_t vibrato_depth_slide_length_counter; // 0x80<br />
int16_t vibrato_depth_slope; // 0x82<br />
uint16_t field_84; // 0x84<br />
uint16_t tremolo_delay; // 0x86<br />
uint16_t tremolo_delay_counter; // 0x88<br />
uint16_t tremolo_rate; // 0x8A<br />
uint16_t tremolo_rate_counter; // 0x8C<br />
uint16_t tremolo_form; // 0x8E<br />
uint16_t tremolo_depth; // 0x90<br />
uint16_t tremolo_depth_slide_length_counter; // 0x92<br />
int16_t tremolo_depth_slope; // 0x94<br />
uint16_t field_96; // 0x96<br />
uint16_t pan_lfo_rate; // 0x98<br />
uint16_t pan_lfo_rate_counter; // 0x9A<br />
uint16_t pan_lfo_form; // 0x9C<br />
uint16_t pan_lfo_depth; // 0x9E<br />
uint16_t pan_lfo_depth_slide_length_counter; // 0xA0<br />
int16_t pan_lfo_slope; // 0xA2<br />
uint16_t noise_on_off_delay_counter; // 0xA4<br />
uint16_t pitchmod_on_off_delay_counter; // 0xA6<br />
uint8_t field_A8[16]; // 0xA8<br />
uint16_t loop_layer; // 0xB8<br />
uint16_t loop_counts[4]; // 0xBA<br />
uint16_t previous_delta_time; // 0xC2<br />
uint16_t forced_delta_time; // 0xC4<br />
uint16_t overlay_balance; // 0xC6<br />
int16_t overlay_balance_slope; // 0xC8<br />
int16_t pan_slope; // 0xCA<br />
int16_t transpose; // 0xCC<br />
int16_t tuning; // 0xCE<br />
uint16_t note; // 0xD0<br />
int16_t pitch_slide_amount; // 0xD2<br />
int16_t previous_transpose; // 0xD4<br />
int16_t vibrato_lfo_amplitude; // 0xD6<br />
int16_t tremolo_lfo_amplitude; // 0xD8<br />
int16_t pan_lfo_amplitude; // 0xDA<br />
AkaoSpuVoiceAttr spu_attr; // 0xDC<br />
};</div>
Loveemu
https://wiki.ffrtt.ru/index.php?title=FF7/PSX/Sound/AKAO_sequence&diff=5727
FF7/PSX/Sound/AKAO sequence
2020-06-06T14:51:01Z
<p>Loveemu: </p>
<hr />
<div>== Introduction ==<br />
AKAO sequence is the most complicated part of the FF7 sound system. ("AKAO" is the signature string, which implies that the sound format has developed by Square Enix sound programmer Minoru Akao.)<br />
<br />
AKAO sequence is similar to MIDI sequence - it's custom tracker format for playing sequence sound, well tuned specially for PSX.<br />
<br />
The sequence data can be found in all FF7 game modules: Field, Battle, Worldmap and in minigames.<br />
<br />
All files with exension *.SND are AKAO.<br />
<br />
* '''MINI/ASERI2.SND''' - Battle Arena theme<br />
* '''MINI/SENSUI.SND''' - used in Submarine minigame<br />
* '''ENEMY6/OVER2.SND''' - game over sequence<br />
* '''ENEMY6/FAN2.SND''' - battle win "fanfare" sequence<br />
* '''MOVIE/OVER2.SND''' - same game over sequence, don't know, why to duplicate data<br />
<br />
Other AKAO sequences are hard-wired in other files.<br />
<br />
<br />
== File Structure ==<br />
=== Header (size: 16 bytes) ===<br />
<br />
struct AkaoHeader<br />
{<br />
static const uint8_t magic[4]; // "AKAO" C-string<br />
uint16_t id; // song ID, used for playing sequence<br />
uint16_t length; // data length - sizeof(header)<br />
uint16_t reverb_type; // reverb type (range from 0 to 9)<br />
struct AkaoTimeStamp<br />
{<br />
uint8_t year_bcd; // year (in binary coded decimal)<br />
uint8_t month_bcd; // month (in binary coded decimal, between 0x01 - 0x12)<br />
uint8_t day_bcd; // day (in binary coded decimal, between 0x01 - 0x31)<br />
uint8_t hours_bcd; // hours (in binary coded decimal, between 0x00 - 0x23)<br />
uint8_t minutes_bcd; // minutes (in binary coded decimal, between 0x00 - 0x59)<br />
uint8_t seconds_bcd; // seconds (in binary coded decimal, between 0x00 - 0x59)<br />
} timestamp;<br />
};<br />
<br />
=== Channel Info (size: 4 bytes + 2 bytes * <channels count>) ===<br />
struct AkaoChannelInfo<br />
{<br />
uint32_t mask; // represents bitmask of used channels in this song<br />
uint32_t start_offsets[num_channels]; // offsets to channel opcode data<br />
};<br />
<br />
int num_channels = 0;<br />
while (int bit = 0; ((info.mask & 0xFFFFFF) & (1 << bit)) != 0; bit++)<br />
num_channels++;<br />
<br />
First there is 32-bit number (offset 0x10), which represents bitmask of used channels in this song.<br />
<br />
After this bitmask, there is <channels count> offsets to channel opcode data counting from current offset. Each offsets is a relative offset based on the address *next to* the offset itself. (This is a general rule for early versions of AKAO to interpret relative offsets.)<br />
<br />
<br />
=== Channel Commands [AKAO Opcodes] ===<br />
For every channels in an AKAO sequence, there is a set of commands to perform. This is similar to Field opcodes. Here I will call this sound commands "opcodes". Every opcode has its own number of arguments (from no-arguments, to 3 arguments).<br />
<br />
=== Drum Instrument Map Table ===<br />
<br />
When a song uses a drum kit with [[FF7/PSX/Sound/Opcodes/0xeced|opcode 0xEC]], a drum instrument map table will be placed at the end of the sequence. The table determines the instrument, channel volume and pan for each keys.<br />
<br />
The table consists of a repetition of 5-byte items.<br />
<br />
struct AkaoDrumKeyAttr<br />
{<br />
uint8_t instrument; // corresponding to opcode 0xA1<br />
uint8_t key; // note number when playing the drum note<br />
uint16_t volume; // corresponding to opcode 0xA8 (lower 8bit is a fractional part of the volume)<br />
uint8_t pan; // corresponding to opcode 0xAA<br />
}<br />
<br />
== Example (Home-Created AKAO Sequence): ==<br />
=== Header ===<br />
'''41 4b 41 4f''' - AKAO string<br />
<br />
'''34 12''' - song ID: 0x1234<br />
<br />
'''16 00''' - data length 0x16 in hex or 22 in decimal<br />
<br />
'''04 00''' - reverb type: 4 (large studio)<br />
<br />
'''96 12 18 22 46 28''' - created at 1996-12-18 22:46:28<br />
<br />
<br />
=== Channel Info ===<br />
'''01 00 00 00''' - this indicates, that used only one channel<br />
<br />
'''00 00''' - offset to first channel opcodes: in our example 0x00 means that next to this offset is opcodes for first channel<br />
<br />
<br />
=== Channel Commands ===<br />
'''e8 a8 66''' - sets tempo, parameter 0x66a8<br />
<br />
'''ea 00 50''' - sets reverb depth<br />
<br />
'''a8 55''' - load sample 0x55 from INSTR.ALL to channel<br />
<br />
'''aa 40''' - sets channel volume<br />
<br />
'''c2''' - turns on reverb effect<br />
<br />
'''a1 0c''' - sets volume pan<br />
<br />
'''c8''' - sets loop point<br />
<br />
'''66''' - 0x66 % 11 = 3 (3 means to take 3rd number from play length table), 0x66 / 11 = 9 (9 means to take pitch[9] from loaded instrument record index)<br />
<br />
'''ca''' - returns to saved loop point with opcode c8<br />
<br />
<br />
This example plays Chocobo "Whoo-Hoo" (instrument number 0x55) repeatedly.<br />
<br />
<br />
== Sound Opcode List ==<br />
<br />
{| class="wikitable"<br />
! Opcode<br />
! Summary<br />
! Length<br />
! Operands<br />
! Note<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0x0099|0x00-0x99]]<br />
|Note, Tie, Rest<br />
|1<br />
|<br />
|The opcode indicates the note key and length. The note will be keyed off 2 ticks before the next note.<br />
|-<br />
|0x9A-0x9F<br />
|Unimplemented<br />
|1<br />
|<br />
|Should not be used.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa0|0xA0]]<br />
|Finish Channel<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa1|0xA1]]<br />
|Load Instrument<br />
|2<br />
|instrument: byte<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0x0099|0xA2]]<br />
|Overwrite Next Note Length<br />
|2<br />
|length: byte<br />
|Ignores the regular length (delta-time) of the next note and overwrites it with the specified length.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa8aa|0xA3]]<br />
|Channel Master Volume<br />
|2<br />
|volume: byte (0-127)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa4|0xA4]]<br />
|Pitch Bend Slide<br />
|3<br />
|length: byte, semitones: signed byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa5|0xA5]]<br />
|Set Octave<br />
|2<br />
|octave: byte (0-15)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa5|0xA6]]<br />
|Increase Octave<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa5|0xA7]]<br />
|Decrease Octave<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa8aa|0xA8]]<br />
|Channel Volume<br />
|2<br />
|volume: byte (0-127)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa9|0xA9]]<br />
|Channel Volume Slide<br />
|3<br />
|length: byte, volume: byte (0-127)<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa8aa|0xAA]]<br />
|Channel Pan<br />
|2<br />
|pan: byte (0-127)<br />
|64 is the center.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xab|0xAB]]<br />
|Channel Pan Slide<br />
|3<br />
|length: byte, pan: byte (0-127)<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xac|0xAC]]<br />
|Noise Clock Frequency<br />
|2<br />
|clock: byte (0x00-0x3f)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/ADSR|0xAD]]<br />
|ADSR: Attack Rate<br />
|2<br />
|attack_rate: byte (0x00-0x7f)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/ADSR|0xAE]]<br />
|ADSR: Decay Rate<br />
|2<br />
|decay_rate: byte (0x00-0x0f)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/ADSR|0xAF]]<br />
|ADSR: Sustain Level<br />
|2<br />
|sustain_level: byte (0x00-0x0f)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/ADSR|0xB0]]<br />
|ADSR: Decay Rate & Sustain Level<br />
|3<br />
|decay_rate: byte (0x00-0x0f), sustain_level: byte (0x00-0x0f)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/ADSR|0xB1]]<br />
|ADSR: Sustain Rate<br />
|2<br />
|sustain_rate: byte (0x00-0x7f)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/ADSR|0xB2]]<br />
|ADSR: Release Rate<br />
|2<br />
|release_rate: byte (0x00-0x1f)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/ADSR|0xB3]]<br />
|ADSR: Reset ADSR<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xb4b5|0xB4]]<br />
|Channel Pitch LFO (Vibrato)<br />
|4<br />
|delay: byte, rate: byte, type: byte (0-15)<br />
|When <code>rate</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xb4b5|0xB5]]<br />
|Channel Pitch LFO Depth<br />
|2<br />
|depth: byte<br />
|The most significant bit of the <code>depth</code> determines the amplitude range.<br />
<br />
When it is 0, the range is up to about ± 50 cents (amplitude is 15/256 compared with range type 1).<br />
<br />
When it is 1, the range is up to about ± 700 cents.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xb4b5|0xB6]]<br />
|Turn Off Channel Pitch LFO<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/ADSR|0xB7]]<br />
|ADSR: Attack Mode<br />
|2<br />
|attack_mode: byte (1 or 5)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xb8b9|0xB8]]<br />
|Channel Volume LFO (Tremolo)<br />
|4<br />
|delay: byte, rate: byte, type: byte (0-15)<br />
|When <code>rate</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xb8b9|0xB9]]<br />
|Channel Volume LFO Depth<br />
|2<br />
|depth: byte<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xb8b9|0xBA]]<br />
|Turn Off Channel Volume LFO<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/ADSR|0xBB]]<br />
|ADSR: Sustain Mode<br />
|2<br />
|sustain_mode: byte (1, 3, 5 or 7)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xbcbd|0xBC]]<br />
|Channel Pan LFO<br />
|3<br />
|rate: byte, type: byte (0-15)<br />
|When <code>rate</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xbcbd|0xBD]]<br />
|Channel Pan LFO Depth<br />
|2<br />
|depth: byte<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xbcbd|0xBE]]<br />
|Turn Off Channel Pan LFO<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xbf|0xBF]]<br />
|ADSR: Release Mode<br />
|2<br />
|release_mode: byte (3 or 7)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc0c1|0xC0]]<br />
|Channel Transpose (Absolute)<br />
|2<br />
|semitones: signed byte<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc0c1|0xC1]]<br />
|Channel Transpose (Relative)<br />
|2<br />
|semitones: signed byte<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc2c3|0xC2]]<br />
|Turn On Reverb<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc2c3|0xC3]]<br />
|Turn Off Reverb<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc4c5|0xC4]]<br />
|Turn On Noise<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc4c5|0xC5]]<br />
|Turn Off Noise<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc6c7|0xC6]]<br />
|Turn On Frequency Modulation<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc6c7|0xC7]]<br />
|Turn Off Frequency Modulation<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc8c9|0xC8]]<br />
|Loop Point<br />
|1<br />
|<br />
|Remember the current offset as a loop point and increase the nesting level of the loop.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc8c9|0xC9]]<br />
|Return to Loop Point Up to N Times<br />
|2<br />
|times: byte<br />
|On the Nth repeat, this instruction will end the current loop by decrementing the nesting level of the loop. Otherwise, it will increment the loop counter and return to the loop point.<br />
When <code>times</code> is 0, it will be translated to 256 times.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc8c9|0xCA]]<br />
|Return to Loop Point<br />
|1<br />
|<br />
|This instruction will increment the loop counter.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xcb|0xCB]]<br />
|Reset Sound Effects<br />
|1<br />
|<br />
|Reset sound effects such as noise, frequency modulation, reverb, overlay voice and alternate voice.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xcccd|0xCC]]<br />
|Turn On Legato<br />
|1<br />
|<br />
|This instruction will stop the regular key on and key off performance of the subsequent notes and update the pitch only.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xcccd|0xCD]]<br />
|Turn Off Legato<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xcecf|0xCE]]<br />
|Turn On Noise and Toggle Noise On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xcecf|0xCF]]<br />
|Toggle Noise On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xd0d1|0xD0]]<br />
|Turn On Full-Length Note Mode<br />
|1<br />
|<br />
|This instruction will stop the regular key off performance of the subsequent notes.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xd0d1|0xD1]]<br />
|Turn Off Full-Length Note Mode<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xd2d3|0xD2]]<br />
|Turn On Frequency Modulation and Toggle Frequency Modulation On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xd2d3|0xD3]]<br />
|Toggle Frequency Modulation On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xd4d5|0xD4]]<br />
|Turn On Playback Rate Side Chain<br />
|1<br />
|<br />
|Duplicate and use the playback frequency of the previous voice channel.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xd4d5|0xD5]]<br />
|Turn Off Playback Rate Side Chain<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xd6d7|0xD6]]<br />
|Turn On Pitch-Volume Side Chain<br />
|1<br />
|<br />
|Multiply the playback frequency of the previous voice channel to the output volume. Lower pitch will make the volume smaller.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xd6d7|0xD7]]<br />
|Turn Off Pitch-Volume Side Chain<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xd8d9|0xD8]]<br />
|Channel Fine Tuning (Absolute)<br />
|2<br />
|amount: signed byte<br />
|The pitch can be changed in the range of one octave above and below.<br />
The <code>amount</code> is the multiplicand for the playback frequency, not a log-based parameter like cents. For example, when the <code>amount</code> is 127, the pitch will be multiplied by 127/128 (about +1 octave). Negative value will lower the pitch.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xd8d9|0xD9]]<br />
|Channel Fine Tuning (Relative)<br />
|2<br />
|amount: signed byte<br />
|The <code>amount</code> will be added to the current tuning amount.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xdadb|0xDA]]<br />
|Turn On Portamento<br />
|2<br />
|speed: byte<br />
|When <code>speed</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xdadb|0xDB]]<br />
|Turn Off Portamento<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0x0099|0xDC]]<br />
|Fix Note Length<br />
|2<br />
|length_to_add: signed byte<br />
|Ignore the regular length (delta-time) of subsequent notes and set to the fixed length. The <code>length_to_add</code> parameter will be added to the current length value. (the initial value is 0)<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xdd|0xDD]]<br />
|Channel Pitch LFO Depth Slide<br />
|3<br />
|length: byte, depth: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xde|0xDE]]<br />
|Channel Volume LFO Depth Slide<br />
|3<br />
|length: byte, depth: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xdf|0xDF]]<br />
|Channel Pan LFO Depth Slide<br />
|3<br />
|length: byte, depth: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa0|0xE0-0xE7]]<br />
|Unimplemented<br />
|1<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xe8e9|0xE8]]<br />
|Tempo<br />
|3<br />
|tempo: uint16<br />
|bpm = tempo / 214.998204 (approximate)<br />
More strictly, <code>bpm = 60.0 / (48 * (65536.0 / tempo) * (0x44E8 / (33868800.0 / 8)))</code><br />
<br />
Note that this coefficient is different from other games with PlayStation AKAO.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xe8e9|0xE9]]<br />
|Tempo Slide<br />
|4<br />
|length: byte, tempo: uint16<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xeaeb|0xEA]]<br />
|Reverb Depth<br />
|3<br />
|depth: uint16<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xeaeb|0xEB]]<br />
|Reverb Depth Slide<br />
|4<br />
|length: byte, depth: uint16<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xeced|0xEC]]<br />
|Turn On Drum Mode<br />
|3<br />
|drum_map_offset: signed int16<br />
|The <code>drum_map_offset</code> is a relative offset pointing to the drum instrument map table, which determines the instrument for each keys.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xeced|0xED]]<br />
|Turn Off Drum Mode<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xee|0xEE]]<br />
|Unconditional Jump<br />
|3<br />
|destination_offset: signed int16<br />
|This instruction can be used to make an infinite loop.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xef|0xEF]]<br />
|CPU-Conditional Jump<br />
|4<br />
|condition: byte, destination_offset: signed int16<br />
|Jump if the condition variable matches <code>condition</code>. The value of the condition variable can be set from the game program.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xf0f1|0xF0]]<br />
|Jump on the Nth Repeat<br />
|4<br />
|times: byte, destination_offset: signed int16<br />
|When <code>times</code> is 0, it will be translated to 256 times.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xf0f1|0xF1]]<br />
|Break the Loop on the Nth Repeat<br />
|4<br />
|times: byte, destination_offset: signed int16<br />
|Unlike 0xF0, this instruction will end the current loop by decrementing the nesting level of the loop.<br />
When <code>times</code> is 0, it will be translated to 256 times.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa1|0xF2]]<br />
|Load Instrument (No Attack Sample)<br />
|2<br />
|instrument: byte<br />
|Unlike 0xA1, the sample before the loop point is replaced by a short, silence sample.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xf3|0xF3]]<br />
|Unknown<br />
|1<br />
|<br />
|There is no actual use in music.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xf4f5|0xF4]]<br />
|Turn On Overlay Voice<br />
|3<br />
|instrument: byte, instrument2: byte<br />
|Play the same melody by different instruments on two voice channels. A free voice channel is required to work. Note that the two channels share the playback rate, and the pitch is not calculated for each instruments.<br />
Used in the song "Anxious Heart".<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xf4f5|0xF5]]<br />
|Turn Off Overlay Voice<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xf4f5|0xF6]]<br />
|Overlay Volume Balance<br />
|2<br />
|balance: byte (0-127)<br />
|When the balance is 0, the volume of the primary voice will be 100% (127/128) of original and that of the secondary voice will be 0%. 127 is the opposite.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xf4f5|0xF7]]<br />
|Overlay Volume Balance Slide<br />
|3<br />
|length: byte, balance: byte (0-127)<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xf8f9|0xF8]]<br />
|Turn On Alternate Voice<br />
|2<br />
|release_rate: byte (0x00-0x1f)<br />
|This instruction allows subsequent notes to be played on two alternating channels. At the same time, the ADSR release rate will be set to the specified value. A free voice channel is required to work. <br />
Check "Opening - Bombing Mission", "Tifa's Theme" and "Fortress of the Condor" for actual usage.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xf8f9|0xF9]]<br />
|Turn Off Alternate Voice<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa0|0xFA-0xFC]]<br />
|Unimplemented<br />
|1<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xfd|0xFD]]<br />
|Time Signature<br />
|3<br />
|ticks_per_beat: byte, beats_per_measure: byte<br />
|Note that two parameters can be 0. This pattern is used for initialization.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xfe|0xFE]]<br />
|Measure Number<br />
|2<br />
|measure: byte<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa0|0xFF]]<br />
|Unimplemented<br />
|1<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|}</div>
Loveemu
https://wiki.ffrtt.ru/index.php?title=FF7/PSX/Sound/AKAO_sequence&diff=5726
FF7/PSX/Sound/AKAO sequence
2020-06-05T21:08:59Z
<p>Loveemu: </p>
<hr />
<div>== Introduction ==<br />
AKAO sequence is the most complicated part of the FF7 sound system. ("AKAO" is the signature string, which implies that the sound format has developed by Square Enix sound programmer Minoru Akao.)<br />
<br />
AKAO sequence is similar to MIDI sequence - it's custom tracker format for playing sequence sound, well tuned specially for PSX.<br />
<br />
The sequence data can be found in all FF7 game modules: Field, Battle, Worldmap and in minigames.<br />
<br />
All files with exension *.SND are AKAO.<br />
<br />
* '''MINI/ASERI2.SND''' - Battle Arena theme<br />
* '''MINI/SENSUI.SND''' - used in Submarine minigame<br />
* '''ENEMY6/OVER2.SND''' - game over sequence<br />
* '''ENEMY6/FAN2.SND''' - battle win "fanfare" sequence<br />
* '''MOVIE/OVER2.SND''' - same game over sequence, don't know, why to duplicate data<br />
<br />
Other AKAO sequences are hard-wired in other files.<br />
<br />
<br />
== File Structure ==<br />
=== Header (size: 16 bytes) ===<br />
<br />
struct AkaoHeader<br />
{<br />
static const uint8_t magic[4]; // "AKAO" C-string<br />
uint16_t id; // song ID, used for playing sequence<br />
uint16_t length; // data length - sizeof(header)<br />
uint16_t reverb_type; // reverb type (range from 0 to 9)<br />
struct AkaoTimeStamp<br />
{<br />
uint8_t year_bcd; // year (in binary coded decimal)<br />
uint8_t month_bcd; // month (in binary coded decimal, between 0x01 - 0x12)<br />
uint8_t day_bcd; // day (in binary coded decimal, between 0x01 - 0x31)<br />
uint8_t hours_bcd; // hours (in binary coded decimal, between 0x00 - 0x23)<br />
uint8_t minutes_bcd; // minutes (in binary coded decimal, between 0x00 - 0x59)<br />
uint8_t seconds_bcd; // seconds (in binary coded decimal, between 0x00 - 0x59)<br />
} timestamp;<br />
};<br />
<br />
=== Channel Info (size: 4 bytes + 2 bytes * <channels count>) ===<br />
struct AkaoChannelInfo<br />
{<br />
uint32_t mask; // represents bitmask of used channels in this song<br />
uint32_t start_offsets[num_channels]; // offsets to channel opcode data<br />
};<br />
<br />
int num_channels = 0;<br />
while (int bit = 0; ((info.mask & 0xFFFFFF) & (1 << bit)) != 0; bit++)<br />
num_channels++;<br />
<br />
First there is 32-bit number (offset 0x10), which represents bitmask of used channels in this song.<br />
<br />
After this bitmask, there is <channels count> offsets to channel opcode data counting from current offset. Each offsets is a relative offset based on the address *next to* the offset itself. (This is a general rule for early versions of AKAO to interpret relative offsets.)<br />
<br />
<br />
=== Channel Commands [AKAO Opcodes] ===<br />
For every channels in an AKAO sequence, there is a set of commands to perform. This is similar to Field opcodes. Here I will call this sound commands "opcodes". Every opcode has its own number of arguments (from no-arguments, to 3 arguments).<br />
<br />
=== Drum Instrument Map Table ===<br />
<br />
When a song uses a drum kit with [[FF7/PSX/Sound/Opcodes/0xeced|opcode 0xEC]], a drum instrument map table will be placed at the end of the sequence. The table determines the instrument, channel volume and pan for each keys.<br />
<br />
The table consists of a repetition of 5-byte items.<br />
<br />
struct AkaoDrumNoteAttr<br />
{<br />
uint8_t instrument; // corresponding to opcode 0xA1<br />
uint8_t key; // note number when playing the drum note<br />
uint16_t volume; // corresponding to opcode 0xA8 (lower 8bit is a fractional part of the volume)<br />
uint8_t pan; // corresponding to opcode 0xAA<br />
}<br />
<br />
== Example (Home-Created AKAO Sequence): ==<br />
=== Header ===<br />
'''41 4b 41 4f''' - AKAO string<br />
<br />
'''34 12''' - song ID: 0x1234<br />
<br />
'''16 00''' - data length 0x16 in hex or 22 in decimal<br />
<br />
'''04 00''' - reverb type: 4 (large studio)<br />
<br />
'''96 12 18 22 46 28''' - created at 1996-12-18 22:46:28<br />
<br />
<br />
=== Channel Info ===<br />
'''01 00 00 00''' - this indicates, that used only one channel<br />
<br />
'''00 00''' - offset to first channel opcodes: in our example 0x00 means that next to this offset is opcodes for first channel<br />
<br />
<br />
=== Channel Commands ===<br />
'''e8 a8 66''' - sets tempo, parameter 0x66a8<br />
<br />
'''ea 00 50''' - sets reverb depth<br />
<br />
'''a8 55''' - load sample 0x55 from INSTR.ALL to channel<br />
<br />
'''aa 40''' - sets channel volume<br />
<br />
'''c2''' - turns on reverb effect<br />
<br />
'''a1 0c''' - sets volume pan<br />
<br />
'''c8''' - sets loop point<br />
<br />
'''66''' - 0x66 % 11 = 3 (3 means to take 3rd number from play length table), 0x66 / 11 = 9 (9 means to take pitch[9] from loaded instrument record index)<br />
<br />
'''ca''' - returns to saved loop point with opcode c8<br />
<br />
<br />
This example plays Chocobo "Whoo-Hoo" (instrument number 0x55) repeatedly.<br />
<br />
<br />
== Sound Opcode List ==<br />
<br />
{| class="wikitable"<br />
! Opcode<br />
! Summary<br />
! Length<br />
! Operands<br />
! Note<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0x0099|0x00-0x99]]<br />
|Note, Tie, Rest<br />
|1<br />
|<br />
|The opcode indicates the note key and length. The note will be keyed off 2 ticks before the next note.<br />
|-<br />
|0x9A-0x9F<br />
|Unimplemented<br />
|1<br />
|<br />
|Should not be used.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa0|0xA0]]<br />
|Finish Channel<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa1|0xA1]]<br />
|Load Instrument<br />
|2<br />
|instrument: byte<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0x0099|0xA2]]<br />
|Overwrite Next Note Length<br />
|2<br />
|length: byte<br />
|Ignores the regular length (delta-time) of the next note and overwrites it with the specified length.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa8aa|0xA3]]<br />
|Channel Master Volume<br />
|2<br />
|volume: byte (0-127)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa4|0xA4]]<br />
|Pitch Bend Slide<br />
|3<br />
|length: byte, semitones: signed byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa5|0xA5]]<br />
|Set Octave<br />
|2<br />
|octave: byte (0-15)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa5|0xA6]]<br />
|Increase Octave<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa5|0xA7]]<br />
|Decrease Octave<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa8aa|0xA8]]<br />
|Channel Volume<br />
|2<br />
|volume: byte (0-127)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa9|0xA9]]<br />
|Channel Volume Slide<br />
|3<br />
|length: byte, volume: byte (0-127)<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa8aa|0xAA]]<br />
|Channel Pan<br />
|2<br />
|pan: byte (0-127)<br />
|64 is the center.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xab|0xAB]]<br />
|Channel Pan Slide<br />
|3<br />
|length: byte, pan: byte (0-127)<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xac|0xAC]]<br />
|Noise Clock Frequency<br />
|2<br />
|clock: byte (0x00-0x3f)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/ADSR|0xAD]]<br />
|ADSR: Attack Rate<br />
|2<br />
|attack_rate: byte (0x00-0x7f)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/ADSR|0xAE]]<br />
|ADSR: Decay Rate<br />
|2<br />
|decay_rate: byte (0x00-0x0f)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/ADSR|0xAF]]<br />
|ADSR: Sustain Level<br />
|2<br />
|sustain_level: byte (0x00-0x0f)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/ADSR|0xB0]]<br />
|ADSR: Decay Rate & Sustain Level<br />
|3<br />
|decay_rate: byte (0x00-0x0f), sustain_level: byte (0x00-0x0f)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/ADSR|0xB1]]<br />
|ADSR: Sustain Rate<br />
|2<br />
|sustain_rate: byte (0x00-0x7f)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/ADSR|0xB2]]<br />
|ADSR: Release Rate<br />
|2<br />
|release_rate: byte (0x00-0x1f)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/ADSR|0xB3]]<br />
|ADSR: Reset ADSR<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xb4b5|0xB4]]<br />
|Channel Pitch LFO (Vibrato)<br />
|4<br />
|delay: byte, rate: byte, type: byte (0-15)<br />
|When <code>rate</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xb4b5|0xB5]]<br />
|Channel Pitch LFO Depth<br />
|2<br />
|depth: byte<br />
|The most significant bit of the <code>depth</code> determines the amplitude range.<br />
<br />
When it is 0, the range is up to about ± 50 cents (amplitude is 15/256 compared with range type 1).<br />
<br />
When it is 1, the range is up to about ± 700 cents.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xb4b5|0xB6]]<br />
|Turn Off Channel Pitch LFO<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/ADSR|0xB7]]<br />
|ADSR: Attack Mode<br />
|2<br />
|attack_mode: byte (1 or 5)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xb8b9|0xB8]]<br />
|Channel Volume LFO (Tremolo)<br />
|4<br />
|delay: byte, rate: byte, type: byte (0-15)<br />
|When <code>rate</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xb8b9|0xB9]]<br />
|Channel Volume LFO Depth<br />
|2<br />
|depth: byte<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xb8b9|0xBA]]<br />
|Turn Off Channel Volume LFO<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/ADSR|0xBB]]<br />
|ADSR: Sustain Mode<br />
|2<br />
|sustain_mode: byte (1, 3, 5 or 7)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xbcbd|0xBC]]<br />
|Channel Pan LFO<br />
|3<br />
|rate: byte, type: byte (0-15)<br />
|When <code>rate</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xbcbd|0xBD]]<br />
|Channel Pan LFO Depth<br />
|2<br />
|depth: byte<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xbcbd|0xBE]]<br />
|Turn Off Channel Pan LFO<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xbf|0xBF]]<br />
|ADSR: Release Mode<br />
|2<br />
|release_mode: byte (3 or 7)<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc0c1|0xC0]]<br />
|Channel Transpose (Absolute)<br />
|2<br />
|semitones: signed byte<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc0c1|0xC1]]<br />
|Channel Transpose (Relative)<br />
|2<br />
|semitones: signed byte<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc2c3|0xC2]]<br />
|Turn On Reverb<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc2c3|0xC3]]<br />
|Turn Off Reverb<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc4c5|0xC4]]<br />
|Turn On Noise<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc4c5|0xC5]]<br />
|Turn Off Noise<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc6c7|0xC6]]<br />
|Turn On Frequency Modulation<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc6c7|0xC7]]<br />
|Turn Off Frequency Modulation<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc8c9|0xC8]]<br />
|Loop Point<br />
|1<br />
|<br />
|Remember the current offset as a loop point and increase the nesting level of the loop.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc8c9|0xC9]]<br />
|Return to Loop Point Up to N Times<br />
|2<br />
|times: byte<br />
|On the Nth repeat, this instruction will end the current loop by decrementing the nesting level of the loop. Otherwise, it will increment the loop counter and return to the loop point.<br />
When <code>times</code> is 0, it will be translated to 256 times.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xc8c9|0xCA]]<br />
|Return to Loop Point<br />
|1<br />
|<br />
|This instruction will increment the loop counter.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xcb|0xCB]]<br />
|Reset Sound Effects<br />
|1<br />
|<br />
|Reset sound effects such as noise, frequency modulation, reverb, overlay voice and alternate voice.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xcccd|0xCC]]<br />
|Turn On Legato<br />
|1<br />
|<br />
|This instruction will stop the regular key on and key off performance of the subsequent notes and update the pitch only.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xcccd|0xCD]]<br />
|Turn Off Legato<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xcecf|0xCE]]<br />
|Turn On Noise and Toggle Noise On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xcecf|0xCF]]<br />
|Toggle Noise On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xd0d1|0xD0]]<br />
|Turn On Full-Length Note Mode<br />
|1<br />
|<br />
|This instruction will stop the regular key off performance of the subsequent notes.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xd0d1|0xD1]]<br />
|Turn Off Full-Length Note Mode<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xd2d3|0xD2]]<br />
|Turn On Frequency Modulation and Toggle Frequency Modulation On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xd2d3|0xD3]]<br />
|Toggle Frequency Modulation On/Off after a Period of Time<br />
|2<br />
|delay: byte<br />
|When <code>delay</code> is 0, it will be translated to 257 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xd4d5|0xD4]]<br />
|Turn On Playback Rate Side Chain<br />
|1<br />
|<br />
|Duplicate and use the playback frequency of the previous voice channel.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xd4d5|0xD5]]<br />
|Turn Off Playback Rate Side Chain<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xd6d7|0xD6]]<br />
|Turn On Pitch-Volume Side Chain<br />
|1<br />
|<br />
|Multiply the playback frequency of the previous voice channel to the output volume. Lower pitch will make the volume smaller.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xd6d7|0xD7]]<br />
|Turn Off Pitch-Volume Side Chain<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xd8d9|0xD8]]<br />
|Channel Fine Tuning (Absolute)<br />
|2<br />
|amount: signed byte<br />
|The pitch can be changed in the range of one octave above and below.<br />
The <code>amount</code> is the multiplicand for the playback frequency, not a log-based parameter like cents. For example, when the <code>amount</code> is 127, the pitch will be multiplied by 127/128 (about +1 octave). Negative value will lower the pitch.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xd8d9|0xD9]]<br />
|Channel Fine Tuning (Relative)<br />
|2<br />
|amount: signed byte<br />
|The <code>amount</code> will be added to the current tuning amount.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xdadb|0xDA]]<br />
|Turn On Portamento<br />
|2<br />
|speed: byte<br />
|When <code>speed</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xdadb|0xDB]]<br />
|Turn Off Portamento<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0x0099|0xDC]]<br />
|Fix Note Length<br />
|2<br />
|length_to_add: signed byte<br />
|Ignore the regular length (delta-time) of subsequent notes and set to the fixed length. The <code>length_to_add</code> parameter will be added to the current length value. (the initial value is 0)<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xdd|0xDD]]<br />
|Channel Pitch LFO Depth Slide<br />
|3<br />
|length: byte, depth: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xde|0xDE]]<br />
|Channel Volume LFO Depth Slide<br />
|3<br />
|length: byte, depth: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xdf|0xDF]]<br />
|Channel Pan LFO Depth Slide<br />
|3<br />
|length: byte, depth: byte<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa0|0xE0-0xE7]]<br />
|Unimplemented<br />
|1<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xe8e9|0xE8]]<br />
|Tempo<br />
|3<br />
|tempo: uint16<br />
|bpm = tempo / 214.998204 (approximate)<br />
More strictly, <code>bpm = 60.0 / (48 * (65536.0 / tempo) * (0x44E8 / (33868800.0 / 8)))</code><br />
<br />
Note that this coefficient is different from other games with PlayStation AKAO.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xe8e9|0xE9]]<br />
|Tempo Slide<br />
|4<br />
|length: byte, tempo: uint16<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xeaeb|0xEA]]<br />
|Reverb Depth<br />
|3<br />
|depth: uint16<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xeaeb|0xEB]]<br />
|Reverb Depth Slide<br />
|4<br />
|length: byte, depth: uint16<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xeced|0xEC]]<br />
|Turn On Drum Mode<br />
|3<br />
|drum_map_offset: signed int16<br />
|The <code>drum_map_offset</code> is a relative offset pointing to the drum instrument map table, which determines the instrument for each keys.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xeced|0xED]]<br />
|Turn Off Drum Mode<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xee|0xEE]]<br />
|Unconditional Jump<br />
|3<br />
|destination_offset: signed int16<br />
|This instruction can be used to make an infinite loop.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xef|0xEF]]<br />
|CPU-Conditional Jump<br />
|4<br />
|condition: byte, destination_offset: signed int16<br />
|Jump if the condition variable matches <code>condition</code>. The value of the condition variable can be set from the game program.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xf0f1|0xF0]]<br />
|Jump on the Nth Repeat<br />
|4<br />
|times: byte, destination_offset: signed int16<br />
|When <code>times</code> is 0, it will be translated to 256 times.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xf0f1|0xF1]]<br />
|Break the Loop on the Nth Repeat<br />
|4<br />
|times: byte, destination_offset: signed int16<br />
|Unlike 0xF0, this instruction will end the current loop by decrementing the nesting level of the loop.<br />
When <code>times</code> is 0, it will be translated to 256 times.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa1|0xF2]]<br />
|Load Instrument (No Attack Sample)<br />
|2<br />
|instrument: byte<br />
|Unlike 0xA1, the sample before the loop point is replaced by a short, silence sample.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xf3|0xF3]]<br />
|Unknown<br />
|1<br />
|<br />
|There is no actual use in music.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xf4f5|0xF4]]<br />
|Turn On Overlay Voice<br />
|3<br />
|instrument: byte, instrument2: byte<br />
|Play the same melody by different instruments on two voice channels. A free voice channel is required to work. Note that the two channels share the playback rate, and the pitch is not calculated for each instruments.<br />
Used in the song "Anxious Heart".<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xf4f5|0xF5]]<br />
|Turn Off Overlay Voice<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xf4f5|0xF6]]<br />
|Overlay Volume Balance<br />
|2<br />
|balance: byte (0-127)<br />
|When the balance is 0, the volume of the primary voice will be 100% (127/128) of original and that of the secondary voice will be 0%. 127 is the opposite.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xf4f5|0xF7]]<br />
|Overlay Volume Balance Slide<br />
|3<br />
|length: byte, balance: byte (0-127)<br />
|When <code>length</code> is 0, it will be translated to 256 ticks.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xf8f9|0xF8]]<br />
|Turn On Alternate Voice<br />
|2<br />
|release_rate: byte (0x00-0x1f)<br />
|This instruction allows subsequent notes to be played on two alternating channels. At the same time, the ADSR release rate will be set to the specified value. A free voice channel is required to work. <br />
Check "Opening - Bombing Mission", "Tifa's Theme" and "Fortress of the Condor" for actual usage.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xf8f9|0xF9]]<br />
|Turn Off Alternate Voice<br />
|1<br />
|<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa0|0xFA-0xFC]]<br />
|Unimplemented<br />
|1<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xfd|0xFD]]<br />
|Time Signature<br />
|3<br />
|ticks_per_beat: byte, beats_per_measure: byte<br />
|Note that two parameters can be 0. This pattern is used for initialization.<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xfe|0xFE]]<br />
|Measure Number<br />
|2<br />
|measure: byte<br />
|<br />
|-<br />
|[[FF7/PSX/Sound/Opcodes/0xa0|0xFF]]<br />
|Unimplemented<br />
|1<br />
|<br />
|Code-referenced to 0xA0. Should not be used.<br />
|}</div>
Loveemu
https://wiki.ffrtt.ru/index.php?title=FF7/PSX/Sound/Code_Map&diff=5725
FF7/PSX/Sound/Code Map
2020-06-05T20:46:32Z
<p>Loveemu: Identify more AkaoPlayer members</p>
<hr />
<div>= Code Map =<br />
<br />
Introduces functions, variables and data related to sound, contained in SCUS_941.63 (game program of US version). Note that all symbol names below are for convenience only.<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x80029818<br />
|void AkaoLoadInstrSet(const void *sampleSet, const void *instrSet)<br />
|Load additional instrument set<br />
<br />
''sampleSet'': corresponding to SOUND/INSTR2.ALL<br />
<br />
''instrSet'': corresponding to SOUND/INSTR2.DAT<br />
|-<br />
|0x8002988C<br />
|void AkaoInit(const void *sampleSet, const void *instrSet)<br />
|Initialize sound driver and load initial instruments<br />
<br />
''sampleSet'': corresponding to SOUND/INSTR.ALL<br />
<br />
''instrSet'': corresponding to SOUND/INSTR.DAT<br />
|-<br />
|0x8002DA7C<br />
|int AkaoLoadSeq(void)<br />
|Load and start playing new [[FF7/PSX/Sound/AKAO sequence|AKAO sequence]]<br />
<br />
Parameters are given from a global structure<br />
<br />
Returns: 0 for success, 1 for already loaded, and -1 for invalid signature<br />
|-<br />
|0x80030234<br />
|int _AkaoCallback(void)<br />
|Callback event for sound, registered by OpenEvent BIOS function<br />
|-<br />
|0x80030E7C<br />
|void _AkaoDispatchVoice(struct MusicPlayerTrack *track, void *a1, int a2)<br />
|Dispatch voice opcodes until the next note or end of track<br />
|-<br />
|0x80049948<br />
|const unsigned char VOICE_OPCODE_LENGTHS[0x60]<br />
|Length table for voice opcodes 0xa0-0xff<br />
<br />
0 for end of track and branches<br />
|-<br />
|0x80049AA8<br />
|void (* const VOICE_OPCODES[0x60])(struct MusicPlayerTrack *, void *, int)<br />
|Address table for voice opcodes 0xa0-0xff<br />
|-<br />
|0x80049C44<br />
|const unsigned short VOLUME_TABLE_L[256]<br />
|See [[FF7/PSX/Sound/Opcodes/0xa8aa|Opcode 0xAA]] for volume balance calculation<br />
|-<br />
|0x80049E44<br />
|const unsigned short VOLUME_TABLE_R[256]<br />
|See [[FF7/PSX/Sound/Opcodes/0xa8aa|Opcode 0xAA]] for volume balance calculation<br />
|-<br />
|0x80083580<br />
|unsigned char g_AkaoSeqData[]<br />
|RAM area to load AKAO sequence data<br />
|}<br />
<br />
== Runtime Library Functions ==<br />
<br />
=== LIBSPU ===<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x80036298<br />
|void SpuInit(void)<br />
|<br />
|-<br />
|0x80036FFC<br />
|long SpuInitMalloc(long num, char *top)<br />
|<br />
|-<br />
|0x800373AC<br />
|long SpuMallocWithStartAddr(unsigned long addr, long size)<br />
|<br />
|-<br />
|0x80037964<br />
|unsigned long SpuSetNoiseVoice(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x80037B90<br />
|long SpuSetNoiseClock(long n_clock)<br />
|<br />
|-<br />
|0x80037BE0<br />
|unsigned long SpuRead(unsigned char *addr, unsigned long size)<br />
|<br />
|-<br />
|0x80037C40<br />
|long SpuSetReverb(long on_off)<br />
|<br />
|-<br />
|0x80037D90<br />
|long SpuGetReverb(void)<br />
|<br />
|-<br />
|0x80037E1C<br />
|long SpuSetReverbModeParam(SpuReverbAttr *attr)<br />
|<br />
|-<br />
|0x800387FC<br />
|void SpuGetReverbModeParam (SpuReverbAttr *attr)<br />
|<br />
|-<br />
|0x8003884C<br />
|long SpuSetReverbDepth(SpuReverbAttr *attr)<br />
|<br />
|-<br />
|0x800388C4<br />
|unsigned long SpuSetReverbVoice(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x800388E8<br />
|long SpuClearReverbWorkArea(long mode)<br />
|<br />
|-<br />
|0x80038A84<br />
|long SpuSetIRQ(long on_off)<br />
|<br />
|-<br />
|0x80038BC4<br />
|unsigned long SpuSetIRQAddr(unsigned long addr)<br />
|<br />
|-<br />
|0x80038C04<br />
|SpuIRQCallbackProc SpuSetIRQCallback(SpuIRQCallbackProc func)<br />
|<br />
|-<br />
|0x80038C6C<br />
|void SpuSetKey(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x80038F04<br />
|unsigned long SpuWrite(unsigned char *addr, unsigned long size)<br />
|<br />
|-<br />
|0x80038F64<br />
|unsigned long SpuSetTransferStartAddr(unsigned long addr)<br />
|<br />
|-<br />
|0x80038FB8<br />
|long SpuSetTransferMode(long mode)<br />
|<br />
|-<br />
|0x80038FEC<br />
|SpuTransferCallbackProc SpuSetTransferCallback(SpuTransferCallbackProc func)<br />
|<br />
|-<br />
|0x80039010<br />
|unsigned long SpuSetPitchLFOVoice(long on_off, unsigned long voice_bit)<br />
|<br />
|-<br />
|0x80039034<br />
|void SpuSetCommonAttr(SpuCommonAttr *attr)<br />
|<br />
|-<br />
|0x800393C8<br />
|void SpuSetVoiceVolume(int voiceNum, short volL, short volR)<br />
|<br />
|-<br />
|0x80039450<br />
|void SpuSetVoiceVolumeAttr(int voiceNum, short volL, short volR, short volModeL, short volModeR)<br />
|<br />
|-<br />
|0x800395C8<br />
|void SpuSetVoicePitch(int voiceNum, unsigned short pitch)<br />
|<br />
|-<br />
|0x80039644<br />
|void SpuSetVoiceStartAddr(int voiceNum, unsigned long startAddr)<br />
|<br />
|-<br />
|0x800396C0<br />
|void SpuSetVoiceLoopStartAddr(int voiceNum, unsigned long lsa)<br />
|<br />
|-<br />
|0x8003973C<br />
|void SpuSetVoiceDR(int voiceNum, unsigned short DR)<br />
|<br />
|-<br />
|0x800397C8<br />
|void SpuSetVoiceSL(int voiceNum, unsigned short SL)<br />
|<br />
|-<br />
|0x80039850<br />
|void SpuSetVoiceARAttr(int voiceNum, unsigned short AR, long ARmode)<br />
|<br />
|-<br />
|0x800398EC<br />
|void SpuSetVoiceSRAttr(int voiceNum, unsigned short SR, long SRmode)<br />
|<br />
|-<br />
|0x800399D0<br />
|void SpuSetVoiceRRAttr(int voiceNum, unsigned short RR, long RRmode)<br />
|<br />
|}<br />
<br />
=== LIBETC ===<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x8003D0C0<br />
|int ResetCallback(void)<br />
|<br />
|-<br />
|0x8003D150<br />
|int VSyncCallback(void (*func)(void))<br />
|<br />
|-<br />
|0x8003D1B4<br />
|int StopCallback(void)<br />
|<br />
|-<br />
|0x8003D214<br />
|int CheckCallback(void)<br />
|<br />
|}<br />
<br />
=== LIBAPI ===<br />
<br />
{| class="wikitable"<br />
! PSX Address<br />
! Declaration<br />
! Description<br />
|-<br />
|0x800429F0<br />
|void DeliverEvent(unsigned long ev1, unsigned long ev2)<br />
|<br />
|-<br />
|0x80042A00<br />
|long OpenEvent(unsigned long desc, long spec, long mode, long (*func)())<br />
|<br />
|-<br />
|0x80042A10<br />
|long CloseEvent(long event)<br />
|<br />
|-<br />
|0x80042A20<br />
|long WaitEvent(long event)<br />
|<br />
|-<br />
|0x80042A40<br />
|long EnableEvent(long event)<br />
|<br />
|-<br />
|0x80042A50<br />
|long DisableEvent(long event)<br />
|<br />
|-<br />
|0x80042BC0<br />
|long SetRCnt(unsigned long spec, unsigned short target, long mode)<br />
|<br />
|-<br />
|0x80042C60<br />
|long GetRCnt(unsigned long spec)<br />
|<br />
|-<br />
|0x80042C98<br />
|long StartRCnt(unsigned long spec)<br />
|<br />
|-<br />
|0x80042CCC<br />
|long StopRCnt(unsigned long spec)<br />
|<br />
|}<br />
<br />
= Structures =<br />
<br />
struct AkaoSpuVoiceAttr<br />
{<br />
uint32_t voice; // 0x00: voice number<br />
uint32_t update_flags; // 0x04: bitset that indicates what SPU registers need to be updated<br />
uint32_t addr; // 0x08: waveform data start address (SPU address)<br />
uint32_t loop_addr; // 0x0c: loop start address (SPU address)<br />
uint32_t a_mode; // 0x10: ADSR: attack rate mode<br />
uint32_t s_mode; // 0x14: ADSR: sustain rate mode<br />
uint32_t r_mode // 0x18: ADSR: release rate mode<br />
uint16_t pitch; // 0x1c: pitch<br />
uint16_t ar; // 0x1e: ADSR: attack rate<br />
uint16_t dr; // 0x20: ADSR: decay rate<br />
uint16_t sl; // 0x22: ADSR: sustain level<br />
uint16_t sr; // 0x24: ADSR: sustain rate<br />
uint16_t rr; // 0x26: ADSR: release rate<br />
SpuVolume volume; // 0x28: volume (left and right)<br />
};<br />
<br />
struct AkaoPlayer // the music player instance exists at 0x8009A104<br />
{<br />
uint32_t stereo_mode; // 0x00: stereo mode (1: stereo, 4: surround, otherwise: mono)<br />
uint32_t active_voices; // 0x04: bitset that indicates the voices currently in use<br />
uint32_t key_on_voices; // 0x08: bitset that indicates the voices to key on<br />
uint32_t keyed_voices; // 0x0c: bitset that indicates the voices currently keyed on<br />
uint32_t key_off_voices; // 0x10: bitset that indicates the voices to key off<br />
uint32_t saved_active_voices; // 0x14: unknown voice bitset<br />
uint32_t tempo; // 0x18: tempo (Q16 fixed-point number)<br />
int32_t tempo_slope; // 0x1c: slope of tempo slider (Q16 fixed-point number)<br />
uint32_t time_counter; // 0x20: time counter (0x10000 = 1 tick)<br />
uint32_t overlay_voices; // 0x24: bitset that indicates the sub-voices used for overlay (opcode 0xF4)<br />
uint32_t alternate_voices; // 0x28: bitset that indicates the sub-voices used for alternate voice (opcode 0xF8)<br />
uint32_t noise_voices; // 0x2c: bitset that indicates the voices with noise mode enabled<br />
uint32_t reverb_voices; // 0x30: bitset that indicates the voices with reverb enabled<br />
uint32_t pitch_lfo_voices; // 0x34: bitset that indicates the voices with pitch LFO (frequency modulation) mode enabled<br />
uint32_t spucnt; // 0x38: SPUCNT shadow<br />
uint32_t reverb_type; // 0x3c: reverb type<br />
uint32_t reverb_depth; // 0x40: reverb depth (Q16 fixed-point number)<br />
int32_t reverb_depth_slope; // 0x44: slope of reverb depth slider (Q16 fixed-point number)<br />
uint16_t tempo_slide_length; // 0x48: tempo slide length<br />
uint16_t song_id; // 0x4a: current song id<br />
uint16_t condition_ack; // 0x4c: the last matched condition value (opcode 0xEF)<br />
uint16_t condition; // 0x4e: condition variable for dynamic branching according to game status (opcode 0xEF)<br />
uint16_t reverb_depth_slide_length; // 0x50: length of reverb depth slide<br />
uint16_t noise_clock; // 0x52: noise clock frequency<br />
uint16_t field_54; // 0x54: unknown<br />
uint16_t beats_per_measure; // 0x56: beats per measure<br />
uint16_t beat; // 0x58: current beat<br />
uint16_t ticks_per_beat; // 0x5a: ticks per beat<br />
uint16_t tick; // 0x5c: current ticks per beat<br />
uint16_t measure; // 0x5e: current measure<br />
};</div>
Loveemu