AAF - Revision history

Xayrga: Add WSYS / WINF (Incomplete)

2020-05-10T23:19:23Z

Add WSYS / WINF (Incomplete)

Xayrga: missed ]

2020-05-10T01:41:54Z

missed ]

Xayrga: Finish IBNK Documentation

2020-05-10T01:40:09Z

Finish IBNK Documentation

Xayrga: Finish PER2 section for IBNK

2020-05-10T01:04:08Z

Finish PER2 section for IBNK

Xayrga: does not store texture data, oops

2020-05-09T16:49:19Z

does not store texture data, oops

Xayrga: add regions

2020-05-09T16:48:00Z

add regions

Xayrga: Checkpoint / Initial submit

2020-05-09T16:30:05Z

Checkpoint / Initial submit

New page

'''AAF''' stores texture sound effect, wave, instrument, and music data.

=AAF Header=
The file's headers is composed to several int32's packed in a common format.

The first int32 will always read the ID of a section. When you read 0, you stop reading.

Header Entry Structure
{| class="wikitable"
|-
! id !! Structure !! Description
|-
| <center>0</center> || (none) || Tells to stop reading this section
|-
| <center>1</center> || (int32 offset, int32 size, int32 type) || Pointer to the BST (Binary Sound Table)
|-
| <center>2</center> || (int32 offset, int32 size, int32 flags) until offset = 0 then continue || IBNK Pointer Table
|-
| <center>3</center> || (int32 offset, int32 size, int32 flags) until offset = 0 then continue || WSYS Pointer Table
|-
| <center>4</center> || (int32 offset, int32 size, int32 type) || Pointer to BSC (Binary Sequence Collection)
|-
| <center>5</center> || (int32 offset, int32 size, int32 type) || Pointer to the BSM (Binary Stream Map)

|}

=== Sample Parsing Code ===
<nowiki>while (true)
{
var ChunkID = aafRead.ReadUInt32();
switch (ChunkID)
{
case 0:
return;
case 1:
case 5:
case 4:
case 6:
case 7:
{
offset = aafRead.ReadUInt32();
size = aafRead.ReadUInt32();
type = aafRead.ReadUInt32();
break;
}
case 2: // INST
{
while (true)
{
var offset = aafRead.ReadUInt32();
if (offset == 0)
break; // 0 means we reached the end.
var size = aafRead.ReadUInt32();
var type = aafRead.ReadUInt32();
}
}
break;
case 3: // WSYS
{

while (true)
{
var offset = aafRead.ReadUInt32();
if (offset == 0)
break; // 0 means we reached the end.
var size = aafRead.ReadUInt32();
var type = aafRead.ReadUInt32();
}
break;
}
}
}</nowiki>

=IBNK=

IBNK Stands for "Instrument Bank". It holds the parameters required to play one of the sounds out of the WSYS as a melodic instrument. They can also contain sound effects.
All pointers are relative to the 0th byte of the IBNK

==Header==

{| class="wikitable"
|-
! Offset !! Type !! Name !! Description
|-
| <center>0x00</center> || int32 || 0x49424e4b 'IBNK' || Magic
|-
| <center>0x04</center> || int32 || Size || Size of the IBNK
|-
| <center>0x08</center> || int32 || ID || Global IBNK ID
|-
| <center>0x0C</center> || int32 || Flags || Flags
|-
| <center>0x10</center> || byte[0x14] || Padding || Padding
|-
| <center>0x24</center> || int32 || 0x42414E4B 'BANK' || Magic
|-
| <center>0x28</center> || int32*[0xF0] || Instrument Pointers || Pointers to instrument objects
|-
|}

==INST==

{| class="wikitable"
|-
! Offset !! Type !! Name !! Description
|-
| <center>0x00</center> || int32 || 0x494E5354 'INST' || Magic
|-
| <center>0x04</center> || int32 || 0 || Zero (Padding)
|-
| <center>0x08</center> || float || frequencyMultiplier || Frequency Multiplier
|-
| <center>0x0C</center> || float || gainMultiplier || gainMultiplier
|-
| <center>0x10</center> || int32* || Osc1* || Pointer to first oscillator (0 = null)
|-
| <center>0x14</center> || int32* || Osc2* || Pointer to second oscillator (0 = null)
|-
| <center>0x18</center> || int32* || Eff1* || Pointer to first Effect (0 = null)
|-
| <center>0x1C</center> || int32* || Eff2* || Pointer to second Effect (0 = null)
|-
| <center>0x20</center> || int32* || Sen1* || Pointer to first sensor (0 = null)
|-
| <center>0x24</center> || int32* || Sen2* || Pointer to second swnsor (0 = null)
|-
| <center>0x28</center> || int32 || keyRegionCount || Count of key regions
|-
| <center>0x2C</center> || [[AAF#InstrumentKeyRegion|InstrumentKeyRegion]]*[keyRegionCount] || Key Regions || Pointers to key regions
|-

|}

@@ Line 148: / Line 148: @@
 | <center>0x04</center> || int32 || velocityRegionCount || Count of velocity regions
 |-
-| <center>0x08</center> || [[AAF#InstrumentVeloRegion|InstrumentVeloRegion]*[velocityRegionCount] || velregptr || Int32 pointers to each velocity region.
+| <center>0x08</center> || [[AAF#InstrumentVeloRegion|InstrumentVeloRegion]]*[velocityRegionCount] || velregptr || Int32 pointers to each velocity region.
 |-
 |}

← Older revision		Revision as of 16:49, 9 May 2020
Line 1:		Line 1:
−	'''AAF''' stores ~~texture~~ sound effect, wave, instrument, and music data.	+	'''AAF''' stores sound effect, wave, instrument, and music data.

	=AAF Header=		=AAF Header=

@@ Line 294: / Line 294: @@
 | <center>0x0F</center> || Stop || Stops both the instrument and the envelope
 |-
 |}

@@ Line 113: / Line 113: @@
 | <center>0x0C</center> || float || gainMultiplier || gainMultiplier
 |-
-| <center>0x10</center> || int32*  || Osc1* || Pointer to first oscillator  (0 = null)
+| <center>0x10</center> || int32*  || Osc1* || Pointer to first [[AAF#JOscillator|JOscillator]]  (0 = null)
 |-
-| <center>0x14</center> || int32*  || Osc2* || Pointer to second oscillator (0 = null)
+| <center>0x14</center> || int32*  || Osc2* || Pointer to second [[AAF#JOscillator|JOscillator]](0 = null)
 |-
 | <center>0x18</center> || int32*  || Eff1* || Pointer to first Effect (0 = null)
@@ Line 127: / Line 127: @@
 | <center>0x28</center> || int32  || keyRegionCount || Count of key regions
 |-
-| <center>0x2C</center> || [[AAF#InstrumentKeyRegion|InstrumentKeyRegion]]*[keyRegionCount]  || Key Regions || Pointers to key regions
+| <center>0x2C</center> || [[AAF#InstrumentKeyRegion|InstrumentKeyRegion]]*[keyRegionCount]  || Key Regions || int32 pointers to key regions
 |-
 |}
@@ Line 148: / Line 148: @@
 | <center>0x04</center> || int32 || velocityRegionCount || Count of velocity regions
 |-
-| <center>0x08</center> || [[AAF#InstrumentVeloRegion|InstrumentVeloRegion]*[velocityRegionCount] || velregptr || Pointers to each velocity region.
+| <center>0x08</center> || [[AAF#InstrumentVeloRegion|InstrumentVeloRegion]*[velocityRegionCount] || velregptr || Int32 pointers to each velocity region.
 |-
 |}
@@ Line 183: / Line 183: @@
 | <center>0x04</center> || byte[0x84] || 0 || Unused
 |-
-| <center>0x8C</center> || [[AAF#PercussionKey|PercussionKey]]*[100] || 100 percussion entries || Frequency Multiplier
+| <center>0x8C</center> || [[AAF#PercussionKey|PercussionKey]]*[100] || 100 percussion entries || Int32 pointers to percussion keys
 |-
 |}
@@ Line 203: / Line 203: @@
 | <center>0x10</center> || int32 || velocityRegionCount || Count of velocity regions
 |-
-| <center>0x14</center> || [[AAF#InstrumentVeloRegion|InstrumentVeloRegion]]*[velocityRegionCount] || velregptr || Pointers to each velocity region.
+| <center>0x14</center> || [[AAF#InstrumentVeloRegion|InstrumentVeloRegion]]*[velocityRegionCount] || velregptr || Int32 Pointers to each velocity region.
 |-
 |}

@@ Line 95: / Line 95: @@
 | <center>0x24</center> || int32 || 0x42414E4B 'BANK' || Magic
 |-
-| <center>0x28</center> || int32*[0xF0] || Instrument Pointers || Pointers to instrument objects
+| <center>0x28</center> || int32*[0xF0] || Instrument Pointers || Pointers to instrument objects (0 = empty slot)
 |-
 |}
@@ Line 148: / Line 148: @@
 | <center>0x04</center> || int32 || velocityRegionCount || Count of velocity regions
 |-
-| <center>0x08</center> || InstrumentVeloRegion*[velocityRegionCount] || velregptr || Pointers to each velocity region.
+| <center>0x08</center> || [[AAF#InstrumentVeloRegion|InstrumentVeloRegion]*[velocityRegionCount] || velregptr || Pointers to each velocity region.
 |-
 |}
@@ Line 170: / Line 170: @@
 |-
 | <center>0x0C</center> || float || freqMultFT || Finetune float for pitch / frequency
 |-
 |}