FF9/Sound/AKAO sequence - Revision history

Loveemu: Fix AkaoChannelInfo mask bits

2020-07-30T09:38:31Z

Fix AkaoChannelInfo mask bits

2020-07-25T07:54:00Z

"The note will be keyed off 2 ticks before the next note." Lied. This cannot be applied to the late version of AKAO.

2020-07-12T15:38:59Z

2020-07-12T15:27:14Z

Add description to 0xFE 0x10, 0x11, 0x1D and 0x1E

2020-07-11T22:27:49Z

Rename: Subroutine Jump -> Pattern

2020-07-11T22:21:42Z

2020-07-11T22:10:02Z

Channel Pitch LFO -> Vibrato, Channel Volume LFO -> Tremolo

2020-07-11T22:06:51Z

Identify opcode 0xFE 0x0A

2020-07-11T21:54:47Z

Size of all opcodes identified

2020-07-11T21:36:13Z

@@ Line 37: / Line 37: @@
   AkaoSeqHeader *header;
   int num_channels = 0;
-  while (int bit = 0; header->mask & (1 << bit)) != 0; bit++)
+  while (int bit = 0; bit < 32; bit++)
-   num_channels++;
+   if (info.mask & (1 << bit)) != 0)
 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.

@@ Line 100: / Line 100: @@
 |1
+|
-|The opcode indicates the note key and length. The note will be keyed off 2 ticks before the next note.
+|The opcode indicates the note key and length.
 |-
 |0x9A-0x9F

@@ Line 714: / Line 714: @@
 |3
 |value: byte
-|Obsoleted opcode? It probably does nothing.
+|Obsoleted opcode? As far as I learned from the assembly code, it probably does nothing.
 |-
 |[[FF9/Sound/Opcodes/0xfe1d|0xFE 0x1D]]

@@ Line 645: / Line 645: @@
 |-
 |[[FF9/Sound/Opcodes/0xfe10|0xFE 0x10]]
-|Unknown
+|Allocate Reserved Voices
 |3
-|value: byte
+|count: byte
+|Reserve the specified <code>count</code> of hardware voices. Reserved voices will not be used unless explicitly specified in opcode 0xFE 0x1D.
 |-
 |[[FF9/Sound/Opcodes/0xfe10|0xFE 0x11]]
-|Unknown
+|Free Reserved Voices
 |2
+|
-|Same as 0xFE 0x10 0x00
+|Set the count of reserved voices to 0.
 |-
 |[[FF9/Sound/Opcodes/0xa3|0xFE 0x12]]
@@ Line 717: / Line 717: @@
 |-
 |[[FF9/Sound/Opcodes/0xfe1d|0xFE 0x1D]]
-|Unknown
+|Use Reserved Voices
 |2
+|
-|Turn something on.
+|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.
 |-
 |[[FF9/Sound/Opcodes/0xfe1e|0xFE 0x1E]]
-|Unknown
+|Use No Reserved Voices
 |2
+|
-|Clears the effect of opcode 0xFE 0x1D.
+|Disable the effect of opcode 0xFE 0x1D.
 |-
 |[[FF9/Sound/Opcodes/0xa0|0xFE 0x1F]]

@@ Line 633: / Line 633: @@
 |-
 |[[FF9/Sound/Opcodes/0xfe0e|0xFE 0x0E]]
-|Subroutine Jump
+|Pattern
 |4
 |destination_offset: signed int16
-|The subroutine jump cannot be nested. It will overwrite the return address.
+|Remember the return address and jump to the specified location. It cannot be nested.
 |-
 |[[FF9/Sound/Opcodes/0xfe0f|0xFE 0x0F]]
-|Return from Subroutine
+|End Pattern
 |2
+|
+|Return from opcode 0xFE 0x0E.
 |-
 |[[FF9/Sound/Opcodes/0xfe10|0xFE 0x10]]

@@ Line 229: / Line 229: @@
 |-
 |[[FF9/Sound/Opcodes/0xb4b5|0xB4]]
-|Channel Pitch LFO (Vibrato)
+|Vibrato (Channel Pitch LFO)
 |4
 |delay: byte, rate: byte, type: byte (0-15)
@@ Line 235: / Line 235: @@
 |-
 |[[FF9/Sound/Opcodes/0xb4b5|0xB5]]
-|Channel Pitch LFO Depth
+|Vibrato Depth
 |2
 |depth: byte
@@ Line 245: / Line 245: @@
 |-
 |[[FF9/Sound/Opcodes/0xb4b5|0xB6]]
-|Turn Off Channel Pitch LFO
+|Turn Off Vibrato
 |1
+|
@@ Line 257: / Line 257: @@
 |-
 |[[FF9/Sound/Opcodes/0xb8b9|0xB8]]
-|Channel Volume LFO (Tremolo)
+|Tremolo (Channel Volume LFO)
 |4
 |delay: byte, rate: byte, type: byte (0-15)
@@ Line 263: / Line 263: @@
 |-
 |[[FF9/Sound/Opcodes/0xb8b9|0xB9]]
-|Channel Volume LFO Depth
+|Tremolo Depth
 |2
 |depth: byte
@@ Line 269: / Line 269: @@
 |-
 |[[FF9/Sound/Opcodes/0xb8b9|0xBA]]
-|Turn Off Channel Volume LFO
+|Turn Off Tremolo
 |1
+|
@@ Line 481: / Line 481: @@
 |-
 |[[FF9/Sound/Opcodes/0xdd|0xDD]]
-|Channel Pitch LFO Depth Slide
+|Vibrato Depth Slide
 |3
 |length: byte, depth: byte
@@ Line 487: / Line 487: @@
 |-
 |[[FF9/Sound/Opcodes/0xde|0xDE]]
-|Channel Volume LFO Depth Slide
+|Tremolo Depth Slide
 |3
 |length: byte, depth: byte
@@ Line 523: / Line 523: @@
 |-
 |[[FF9/Sound/Opcodes/0xe4|0xE4]]
-|Channel Pitch LFO Rate Slide
+|Vibrato Rate Slide
 |3
 |length: byte, rate: byte
@@ Line 529: / Line 529: @@
 |-
 |[[FF9/Sound/Opcodes/0xe5|0xE5]]
-|Channel Volume LFO Rate Slide
+|Tremolo Rate Slide
 |3
 |length: byte, rate: byte

@@ Line 614: / Line 614: @@
 When <code>times</code> is 0, it will be translated to 256 times.
 |-
-|[[FF9/Sound/Opcodes/0xa1|0xFE 0x0A]]
+|[[FF7/PSX/Sound/Opcodes/0xa1|0xFE 0x0A]]
-|Load Instrument (With Some Unknown Effect)
+|Load Instrument (No Attack Sample)
 |3
 |instrument: byte
+|Unlike 0xA1, the sample before the loop point is replaced by a short, silence sample.
 |-
 |[[FF9/Sound/Opcodes/0xfe0b|0xFE 0x0B]]

@@ Line 558: / Line 558: @@
 |bpm = tempo / 218.453333 (approximate)
 More strictly, <code>bpm = 60.0 / (48 * (65536.0 / tempo) * (0x43D1 / (33868800.0 / 8)))</code>
 |-
 |[[FF9/Sound/Opcodes/0xfe00|0xFE 0x01]]