[Audio 10/10] Loose ends #2337
[Audio 10/10] Loose ends #2337
Conversation
docs/audio/Samplebank_XML.md
Outdated
| ``` | ||
| Begins a new samplebank. | ||
|
|
||
| **Properties** |
There was a problem hiding this comment.
technically in XML parlance these are called "attributes", and what's called "Sub-Attributes" below are "tags" (maybe "child tags" or "children"?). I think using the word "properties" is probably fine, but using the word "attribute" for tags could be confusing
(ditto with other XML docs)
docs/audio/Samplebank_XML.md
Outdated
| **Properties** | ||
|
|
||
| - **Name**: Name of this blob. Must be a valid C language identifier. | ||
| - **Path**: Path to binary file, relative to the project root (typically in `assets/samples/`) |
There was a problem hiding this comment.
should be $(BUILD_DIR)/assets/audio/samples/?
docs/audio/Samplebank_XML.md
Outdated
| - **Medium**: The storage medium, from the SampleMedium enum. | ||
| - **CachePolicy**: The cache policy, from the AudioCacheLoadType enum. |
There was a problem hiding this comment.
super nit: in the soundfont XML you put SampleMedium and AudioCacheLoadType in monospace font
docs/audio/Soundfont_XML.md
Outdated
| **Properties** | ||
|
|
||
| - **Name**: Unique name for this envelope. Must be a valid C identifier. | ||
| - **Release**: Release rate index for this envelope |
There was a problem hiding this comment.
what does this index into exactly? I tried searching for "release rate" but didn't find much
There was a problem hiding this comment.
It indexes gAudioCtx.adsrDecayTable, I mentioned this but didn't add much explanation for it, I think the code surrounding this probably needs some docs before reviewing again how it's presented here
docs/audio/Soundfont_XML.md
Outdated
| Name="<C Identifier>" | ||
| Sample="<Sample Name>" | ||
| SampleRate="[Sample Rate]" | ||
| BaseNote="[Note Number]" |
There was a problem hiding this comment.
Define "Note Number"? If I didn't know better I'd attempt to put "C4" or something here
There was a problem hiding this comment.
C4 would actually be correct, I've changed it to say Note Name and added a brief explanation of the field at the top of the file.
The final PR in the series of initial audio work. With this PR everything I had worked on in my branch is merged, but new improvements may still happen in the future.
afile_sizesto generate sizes headers for Soundfonts and Sequences foraudio/session_config.c.nameand.fontsto.note.nameand.note.fontsI originally planned to also include a doc about how VADPCM works but writing it was taking too long so I didn't include it here.