From 900893242083a86451d648fe81aa6aff43f9929a Mon Sep 17 00:00:00 2001 From: "Christian R. Helmrich" Date: Fri, 31 Jan 2020 23:10:09 +0000 Subject: [PATCH] Update api --- api.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/api.md b/api.md index 9dd0455..29f5193 100644 --- a/api.md +++ b/api.md @@ -25,7 +25,7 @@ create an *ExhaleEncAPI* object and return a pointer to it. The following parame * *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 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. +* *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, 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,10 @@ unsigned ExhaleEncAPI::`initEncoder`(unsigned char* const audioConfigBuffer, uin **Purpose** -initialize an *ExhaleEncAPI* object for encoding and allocate dynamic object memory. Also checks the validity of the parameters given to `exhaleCreate()`. +initialize an *ExhaleEncAPI* object for encoding and allocate dynamic object memory. Also checks the validity of the parameters given to `exhaleCreate()` and, upon success, generates AudioSpecificConfig (ASC, including UsacConfig) data for bit-stream headers. The following parameters are available storage of this data: + +* *audioConfigBuffer*: pointer to an unsigned 8-bit integer buffer to which the ASC data is written. May be `NULL`, in which case no ASC is generated. +* *audioConfigBytes*: pointer to a single unsigned 32-bit integer to which the size of the ASC data (in bytes) is written. May be `NULL`. **Return value** @@ -67,7 +70,7 @@ unsigned ExhaleEncAPI::`encodeLookahead`( ); **Purpose** -encode the first (lookahead) frame with an *ExhaleEncAPI* object. Requires 1024 new audio samples. +encode the first (lookahead) frame with an *ExhaleEncAPI* object. Requires 1024**numChannels* new audio samples. **Return value** @@ -87,7 +90,7 @@ unsigned ExhaleEncAPI::`encodeFrame`( ); **Purpose** -encode a regular PCM audio frame with an *ExhaleEncAPI* object. Requires 1024 new audio samples. +encode a regular PCM audio frame with an *ExhaleEncAPI* object. Requires 1024**numChannels* new audio samples. **Return value**