1 
2 /* -----------------------------------------------------------------------------------------------------------
3 Software 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
9 The Fraunhofer FDK AAC Codec Library for Android ("FDK AAC Codec") is software that implements
10 the MPEG Advanced Audio Coding ("AAC") encoding and decoding scheme for digital audio.
11 This FDK AAC Codec software is intended to be used on a wide variety of Android devices.
12 
13 AAC's HE-AAC and HE-AAC v2 versions are regarded as today's most efficient general perceptual
14 audio codecs. AAC-ELD is considered the best-performing full-bandwidth communications codec by
15 independent studies and is widely deployed. AAC has been standardized by ISO and IEC as part
16 of the MPEG specifications.
17 
18 Patent licenses for necessary patent claims for the FDK AAC Codec (including those of Fraunhofer)
19 may be obtained through Via Licensing (www.vialicensing.com) or through the respective patent owners
20 individually for the purpose of encoding or decoding bit streams in products that are compliant with
21 the ISO/IEC MPEG audio standards. Please note that most manufacturers of Android devices already license
22 these patent claims through Via Licensing or directly from the patent owners, and therefore FDK AAC Codec
23 software may already be covered under those patent licenses when it is used for those licensed purposes only.
24 
25 Commercially-licensed AAC software libraries, including floating-point versions with enhanced sound quality,
26 are also available from Fraunhofer. Users are encouraged to check the Fraunhofer website for additional
27 applications information and documentation.
28 
29 2.    COPYRIGHT LICENSE
30 
31 Redistribution and use in source and binary forms, with or without modification, are permitted without
32 payment of copyright license fees provided that you satisfy the following conditions:
33 
34 You must retain the complete text of this software license in redistributions of the FDK AAC Codec or
35 your modifications thereto in source code form.
36 
37 You must retain the complete text of this software license in the documentation and/or other materials
38 provided with redistributions of the FDK AAC Codec or your modifications thereto in binary form.
39 You must make available free of charge copies of the complete source code of the FDK AAC Codec and your
40 modifications thereto to recipients of copies in binary form.
41 
42 The name of Fraunhofer may not be used to endorse or promote products derived from this library without
43 prior written permission.
44 
45 You may not charge copyright license fees for anyone to use, copy or distribute the FDK AAC Codec
46 software or your modifications thereto.
47 
48 Your modified versions of the FDK AAC Codec must carry prominent notices stating that you changed the software
49 and 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 
53 3.    NO PATENT LICENSE
54 
55 NO EXPRESS OR IMPLIED LICENSES TO ANY PATENT CLAIMS, including without limitation the patents of Fraunhofer,
56 ARE GRANTED BY THIS SOFTWARE LICENSE. Fraunhofer provides no warranty of patent non-infringement with
57 respect to this software.
58 
59 You may use this FDK AAC Codec software or modifications thereto only for purposes that are authorized
60 by appropriate patent licenses.
61 
62 4.    DISCLAIMER
63 
64 This 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
66 of merchantability and fitness for a particular purpose. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
67 CONTRIBUTORS BE LIABLE for any direct, indirect, incidental, special, exemplary, or consequential damages,
68 including but not limited to procurement of substitute goods or services; loss of use, data, or profits,
69 or business interruption, however caused and on any theory of liability, whether in contract, strict
70 liability, or tort (including negligence), arising in any way out of the use of this software, even if
71 advised of the possibility of such damage.
72 
73 5.    CONTACT INFORMATION
74 
75 Fraunhofer Institute for Integrated Circuits IIS
76 Attention: Audio and Multimedia Departments - FDK AAC LL
77 Am Wolfsmantel 33
78 91058 Erlangen, Germany
79 
80 www.iis.fraunhofer.de/amm
81 amm-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 
112 typedef enum { LATMVAR_SIMPLE_SEQUENCE } LATM_VAR_MODE;
113 
114 typedef struct {
115   signed int frameLengthType;
116   signed int frameLengthBits;
117   signed int varFrameLengthTable[4];
118   signed int streamID;
119 } LATM_LAYER_INFO;
120 
121 
122 typedef 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 
157 typedef 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  */
174 TRANSPORTENC_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  */
191 unsigned 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  */
207 TRANSPORTENC_ERROR
208 transportEnc_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  */
225 void 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  */
239 void 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  */
255 TRANSPORTENC_ERROR
256 CreateStreamMuxConfig(
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