fenix/exhale
1
0
Fork 0
mirror of https://gitlab.com/ecodis/exhale.git synced 2025-02-20 05:20:47 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update api to exhale 1.1.x

Christian R. Helmrich 2021-01-01 12:00:39 +00:00
parent bd45573b3f
commit 21d7e794a3
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
api.md

@ -23,7 +23,7 @@ create an *ExhaleEncAPI* object and return a pointer to it. The following parame
* *outputAuData*: pointer to an unsigned 8-bit integer buffer to which the compressed access unit (AU, raw frame-wise encoded audio) data will be written by the encoder. The buffer must be at least (6144/8)**numChannels* bytes large.
* *sampleRate*: audio input and output sampling rate in Hertz (Hz). Note that not all sampling rates are supported. Recommended rates are 96000, 88200, 64000, 48000, 44100, 32000, 24000, 22050, 16000, 12000, 11025, 8000, and 7350.
* *numChannels*: number of channels in the input PCM audio data. Must be between 1 (mono) and 8 (7.1 surround), or 0 to indicate two-channel input which will be encoded channel-independently in dual-mono two-SCE configuration.
* *frameLength*: number of audio samples per channel and encoded frame. Must equal 1024 for now.
* *frameLength*: number of audio samples per channel and encoded frame. Must equal 1024 in exhale 1.0.x. **Since exhale 1.1.0**: Passing 2048 results in encoding with 2:1 Spectral Band Replication (SBR) enabled.
* *indepPeriod*: random-access (also called "tune-in") period for broadcasting and streaming purposes, particularly when the audio is accompanied by video. Recommended values are 45 with 25 or 50-Hz video (Europe, Asia) and 50 with 30 or 60-Hz video (North America).
* *varBitRateMode*: the CVBR mode controlling the overall bit-rate. See the [FAQ](https://gitlab.com/ecodis/exhale/-/wikis/faq) for details. Must be between 0 (lowest rate) and 9 (highest rate). Note that mode 0 is **not** intended for content production, use it only for scientific research.
* *useNoiseFilling*: enable (true) or disable (false) the noise substitution functionality provided by the ISO/IEC 23003-3 standard. It is recommended to enable this feature for best possible audio quality especially at the low bit-rate modes.