1
2/* -----------------------------------------------------------------------------------------------------------
3Software License for The Fraunhofer FDK AAC Codec Library for Android
4
5� Copyright  1995 - 2013 Fraunhofer-Gesellschaft zur F�rderung der angewandten Forschung e.V.
6  All rights reserved.
7
8 1.    INTRODUCTION
9The Fraunhofer FDK AAC Codec Library for Android ("FDK AAC Codec") is software that implements
10the MPEG Advanced Audio Coding ("AAC") encoding and decoding scheme for digital audio.
11This FDK AAC Codec software is intended to be used on a wide variety of Android devices.
12
13AAC's HE-AAC and HE-AAC v2 versions are regarded as today's most efficient general perceptual
14audio codecs. AAC-ELD is considered the best-performing full-bandwidth communications codec by
15independent studies and is widely deployed. AAC has been standardized by ISO and IEC as part
16of the MPEG specifications.
17
18Patent licenses for necessary patent claims for the FDK AAC Codec (including those of Fraunhofer)
19may be obtained through Via Licensing (www.vialicensing.com) or through the respective patent owners
20individually for the purpose of encoding or decoding bit streams in products that are compliant with
21the ISO/IEC MPEG audio standards. Please note that most manufacturers of Android devices already license
22these patent claims through Via Licensing or directly from the patent owners, and therefore FDK AAC Codec
23software may already be covered under those patent licenses when it is used for those licensed purposes only.
24
25Commercially-licensed AAC software libraries, including floating-point versions with enhanced sound quality,
26are also available from Fraunhofer. Users are encouraged to check the Fraunhofer website for additional
27applications information and documentation.
28
292.    COPYRIGHT LICENSE
30
31Redistribution and use in source and binary forms, with or without modification, are permitted without
32payment of copyright license fees provided that you satisfy the following conditions:
33
34You must retain the complete text of this software license in redistributions of the FDK AAC Codec or
35your modifications thereto in source code form.
36
37You must retain the complete text of this software license in the documentation and/or other materials
38provided with redistributions of the FDK AAC Codec or your modifications thereto in binary form.
39You must make available free of charge copies of the complete source code of the FDK AAC Codec and your
40modifications thereto to recipients of copies in binary form.
41
42The name of Fraunhofer may not be used to endorse or promote products derived from this library without
43prior written permission.
44
45You may not charge copyright license fees for anyone to use, copy or distribute the FDK AAC Codec
46software or your modifications thereto.
47
48Your modified versions of the FDK AAC Codec must carry prominent notices stating that you changed the software
49and the date of any change. For modified versions of the FDK AAC Codec, the term
50"Fraunhofer FDK AAC Codec Library for Android" must be replaced by the term
51"Third-Party Modified Version of the Fraunhofer FDK AAC Codec Library for Android."
52
533.    NO PATENT LICENSE
54
55NO EXPRESS OR IMPLIED LICENSES TO ANY PATENT CLAIMS, including without limitation the patents of Fraunhofer,
56ARE GRANTED BY THIS SOFTWARE LICENSE. Fraunhofer provides no warranty of patent non-infringement with
57respect to this software.
58
59You may use this FDK AAC Codec software or modifications thereto only for purposes that are authorized
60by appropriate patent licenses.
61
624.    DISCLAIMER
63
64This FDK AAC Codec software is provided by Fraunhofer on behalf of the copyright holders and contributors
65"AS IS" and WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, including but not limited to the implied warranties
66of merchantability and fitness for a particular purpose. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
67CONTRIBUTORS BE LIABLE for any direct, indirect, incidental, special, exemplary, or consequential damages,
68including but not limited to procurement of substitute goods or services; loss of use, data, or profits,
69or business interruption, however caused and on any theory of liability, whether in contract, strict
70liability, or tort (including negligence), arising in any way out of the use of this software, even if
71advised of the possibility of such damage.
72
735.    CONTACT INFORMATION
74
75Fraunhofer Institute for Integrated Circuits IIS
76Attention: Audio and Multimedia Departments - FDK AAC LL
77Am Wolfsmantel 33
7891058 Erlangen, Germany
79
80www.iis.fraunhofer.de/amm
81amm-info@iis.fraunhofer.de
82----------------------------------------------------------------------------------------------------------- */
83
84/*****************************  MPEG-4 AAC Encoder  **************************
85
86   Author(s):
87   Description:
88
89******************************************************************************/
90
91#ifndef TPENC_LATM_H
92#define TPENC_LATM_H
93
94
95
96#include "tpenc_lib.h"
97#include "FDK_bitstream.h"
98
99
100#define DEFAULT_LATM_NR_OF_SUBFRAMES 1
101#define DEFAULT_LATM_SMC_REPEAT      8
102
103#define MAX_AAC_LAYERS        9
104
105#define LATM_MAX_PROGRAMS     1
106#define LATM_MAX_STREAM_ID   16
107
108#define LATM_MAX_LAYERS       1 /*MAX_AAC_LAYERS*/
109
110#define MAX_NR_OF_SUBFRAMES   2           /* set this carefully to avoid buffer overflows */
111
112typedef enum { LATMVAR_SIMPLE_SEQUENCE } LATM_VAR_MODE;
113
114typedef struct {
115  signed int frameLengthType;
116  signed int frameLengthBits;
117  signed int varFrameLengthTable[4];
118  signed int streamID;
119} LATM_LAYER_INFO;
120
121
122typedef struct {
123  LATM_LAYER_INFO      m_linfo[LATM_MAX_PROGRAMS][LATM_MAX_LAYERS];
124  CODER_CONFIG        *config[LATM_MAX_PROGRAMS][LATM_MAX_LAYERS];
125
126  LATM_VAR_MODE        varMode;
127  TRANSPORT_TYPE       tt;
128
129  int                  audioMuxLengthBytes;
130
131  int                  audioMuxLengthBytesPos;
132  int                  taraBufferFullness; /* state of the bit reservoir */
133  int                  varStreamCnt;
134  unsigned int         otherDataLenBytes;
135
136  UCHAR                latmFrameCounter;   /* Current frame number. Counts modulo muxConfigPeriod */
137  UCHAR                muxConfigPeriod;    /* Distance in frames between MuxConfig */
138
139  UCHAR                audioMuxVersion;    /* AMV1 supports transmission of taraBufferFullness and ASC lengths */
140  UCHAR                audioMuxVersionA;   /* for future extensions */
141
142  UCHAR                noProgram;
143  UCHAR                noLayer[LATM_MAX_PROGRAMS];
144  UCHAR                fractDelayPresent;
145
146  UCHAR                allStreamsSameTimeFraming;
147  UCHAR                subFrameCnt;        /* Current Subframe frame */
148  UCHAR                noSubframes;        /* Number of subframes    */
149  UINT                 latmSubframeStart;  /* Position of current subframe start */
150  UCHAR                noSubframes_next;
151
152  UCHAR                fillBits;           /* AudioMuxElement fill bits */
153  UCHAR                streamMuxConfigBits;
154
155} LATM_STREAM;
156
157typedef LATM_STREAM *HANDLE_LATM_STREAM;
158
159/**
160 * \brief Initialize LATM_STREAM Handle. Creates automatically one program with one layer with
161 *        the given layerConfig. The layerConfig must be persisten because references to this pointer
162 *        are made at any time again.
163 *        Use transportEnc_Latm_AddLayer() to add more programs/layers.
164 *
165 * \param hLatmStreamInfo HANDLE_LATM_STREAM handle
166 * \param hBs Bitstream handle
167 * \param layerConfig a valid CODER_CONFIG struct containing the current audio configuration parameters
168 * \param audioMuxVersion the LATM audioMuxVersion to be used
169 * \param tt the specific TRANSPORT_TYPE to be used, either TT_MP4_LOAS, TT_MP4_LATM_MCP1 or TT_MP4_LATM_MCP0 LOAS
170 * \param cb callback information structure.
171 *
172 * \return an TRANSPORTENC_ERROR error code
173 */
174TRANSPORTENC_ERROR transportEnc_Latm_Init(
175        HANDLE_LATM_STREAM hLatmStreamInfo,
176        HANDLE_FDK_BITSTREAM hBs,
177        CODER_CONFIG *layerConfig,
178        UINT audioMuxVersion,
179        TRANSPORT_TYPE tt,
180        CSTpCallBacks *cb
181        );
182
183/**
184 * \brief Get bit demand of next LATM/LOAS header
185 *
186 * \param hAss HANDLE_LATM_STREAM handle
187 * \param streamDataLength the length of the payload
188 *
189 * \return the number of bits required by the LATM/LOAS headers
190 */
191unsigned int transportEnc_LatmCountTotalBitDemandHeader (
192                                                          HANDLE_LATM_STREAM hAss,
193                                                          unsigned int streamDataLength
194                                                         );
195
196/**
197 * \brief Write LATM/LOAS header into given bitstream handle
198 *
199 * \param hLatmStreamInfo HANDLE_LATM_STREAM handle
200 * \param hBitstream Bitstream handle
201 * \param auBits amount of current payload bits
202 * \param bufferFullness LATM buffer fullness value
203 * \param cb callback information structure.
204 *
205 * \return an TRANSPORTENC_ERROR error code
206 */
207TRANSPORTENC_ERROR
208transportEnc_LatmWrite (
209        HANDLE_LATM_STREAM    hAss,
210        HANDLE_FDK_BITSTREAM  hBitstream,
211        int                   auBits,
212        int                   bufferFullness,
213        CSTpCallBacks     *cb
214        );
215
216/**
217 * \brief Adjust bit count relative to current subframe
218 *
219 * \param hAss HANDLE_LATM_STREAM handle
220 * \param pBits pointer to an int, where the current frame bit count is contained,
221 *        and where the subframe relative bit count will be returned into
222 *
223 * \return void
224 */
225void transportEnc_LatmAdjustSubframeBits(HANDLE_LATM_STREAM    hAss,
226                                         int                  *pBits);
227
228/**
229 * \brief Request an LATM frame, which may, or may not be available
230 *
231 * \param hAss HANDLE_LATM_STREAM handle
232 * \param hBs Bitstream handle
233 * \param pBytes pointer to an int, where the current frame byte count stored into.
234 *        A return value of zero means that currently no LATM/LOAS frame can be returned.
235 *        The latter is expected in case of multiple subframes being used.
236 *
237 * \return void
238 */
239void transportEnc_LatmGetFrame(
240                               HANDLE_LATM_STREAM    hAss,
241                               HANDLE_FDK_BITSTREAM  hBs,
242                               int                  *pBytes
243                               );
244
245/**
246 * \brief Write a StreamMuxConfig into the given bitstream handle
247 *
248 * \param hAss HANDLE_LATM_STREAM handle
249 * \param hBs Bitstream handle
250 * \param bufferFullness LATM buffer fullness value
251 * \param cb callback information structure.
252 *
253 * \return void
254 */
255TRANSPORTENC_ERROR
256CreateStreamMuxConfig(
257        HANDLE_LATM_STREAM hAss,
258        HANDLE_FDK_BITSTREAM hBs,
259        int bufferFullness,
260        CSTpCallBacks *cb
261        );
262
263
264#endif /* TPENC_LATM_H */
265