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

Christian R. Helmrich 2020-02-28 23:00:03 +00:00
parent f3659c8f39
commit c954cfa1ff
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
api.md

@ -47,15 +47,15 @@ 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()` and, upon success, generates AudioSpecificConfig (ASC, including UsacConfig) data for the bit-stream header. The following parameters are available for storage of this data:
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 the bit-stream header. The following parameters are available for storage of this data:
* *audioConfigBuffer*: pointer to an unsigned 8-bit integer buffer to which the ASC data will be written. The buffer must be at least 16 bytes large. May be `NULL`, in which case no ASC is generated.
* *audioConfigBytes*: pointer to a single unsigned 32-bit integer to which the byte-size of the ASC data is written. Optional parameter, may be `NULL`, in which case the size information is discarded.
**Since exhale 1.0.1**:
If, when calling this function, the integer pointed to by *audioConfigBytes* is nonzero, that
integer is interpreted as program *loudnessInfo( )* payload according to [ISO/IEC 23003-4](https://www.iso.org/standard/75930.html), Dynamic
Range Control (DRC), and included in the *UsacConfig( )* data generated by this function. The
integer is interpreted as program *loudnessInfo* payload according to [ISO/IEC 23003-4](https://www.iso.org/standard/75930.html), Dynamic
Range Control (DRC), and included in the *UsacConfig* data generated by this function. The
bits of the nonzero integer pointed to by *audioConfigBytes* are interpreted as follows:
| Bit Offset | Number of Bits | Syntax Element (Specification Table in ISO/IEC 23003-4) |