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

Update api

Christian R. Helmrich 2020-01-31 00:00:36 +00:00
parent 7e9dccc648
commit bdef873bab
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
api.md

@ -20,12 +20,12 @@ ExhaleEncAPI* `exhaleCreate`(int32_t* const inputPcmData, unsigned char* const o
create an *ExhaleEncAPI* object and return a pointer to it. The following parameters are available for configuration of the encoder instance:
* *inputPcmData*: pointer to a signed 32-bit integer buffer from which the uncompressed, unpacked, channel-interleaved, 24-bit PCM audio data (sample value range -8388608..8388607, one sample value per integer value) will be read.
* *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.
* *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 a "dual-mono" two-SCE configuration.
* *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.
* *indepPeriod*: random-access (also called "tune-in") period for streaming purposes, particulary when the audio is accompanied by video. Recommended values are 45 with 25 or 50-Hz video (Europe) and 50 with 30 or 60-Hz video (USA).
* *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** recommended.
* *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** recommended for production, only for scientific research.
* *useNoiseFilling*: enable (true) or disable (false) the noise substitution functionality. It is recommended to enable this feature.
* *useEcodisExt*: additional, reserved parameter for future use. Currently ignored, should be set to false.
@ -47,7 +47,7 @@ unsigned ExhaleEncAPI::`initEncoder`(unsigned char* const audioConfigBuffer, uin
**Purpose**
initialize an *ExhaleEncAPI* object for encoding and allocate dynamic object memory. Also checks the validity for the parameters of `exhaleCreate()`.
initialize an *ExhaleEncAPI* object for encoding and allocate dynamic object memory. Also checks the validity of the parameters given to `exhaleCreate()`.
**Return value**
@ -67,7 +67,7 @@ unsigned ExhaleEncAPI::`encodeLookahead`( );
**Purpose**
encode the first (lookahead) frame with an *ExhaleEncAPI* object
encode the first (lookahead) frame with an *ExhaleEncAPI* object. Requires 1024 new audio samples.
**Return value**
@ -87,7 +87,7 @@ unsigned ExhaleEncAPI::`encodeFrame`( );
**Purpose**
encode a regular PCM audio frame with an *ExhaleEncAPI* object
encode a regular PCM audio frame with an *ExhaleEncAPI* object. Requires 1024 new audio samples.
**Return value**