rvlc.h revision 4f0d97057c5c640b25518358886f8c47da9fc052
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/*!
85  \file
86  \brief  Defines structures and prototypes for RVLC
87  \author Robert Weidner
88*/
89
90#ifndef RVLC_H
91#define RVLC_H
92
93
94
95#include "aacdecoder.h"
96#include "channel.h"
97#include "rvlc_info.h"
98
99/* ------------------------------------------------------------------- */
100/*    errorLogRvlc: A word of 32 bits used for logging possible errors */
101/*                  within RVLC in case of distorted bitstreams.       */
102/* ------------------------------------------------------------------- */
103#define RVLC_ERROR_ALL_ESCAPE_WORDS_INVALID              0x80000000   /*  ESC-Dec  During RVLC-Escape-decoding there have been more bits decoded as there are available */
104#define RVLC_ERROR_RVL_SUM_BIT_COUNTER_BELOW_ZERO_FWD    0x40000000   /*  RVL-Dec  negative sum-bitcounter during RVL-fwd-decoding (long+shrt) */
105#define RVLC_ERROR_RVL_SUM_BIT_COUNTER_BELOW_ZERO_BWD    0x20000000   /*  RVL-Dec  negative sum-bitcounter during RVL-fwd-decoding (long+shrt) */
106#define RVLC_ERROR_FORBIDDEN_CW_DETECTED_FWD             0x08000000   /*  RVL-Dec  forbidden codeword detected fwd (long+shrt) */
107#define RVLC_ERROR_FORBIDDEN_CW_DETECTED_BWD             0x04000000   /*  RVL-Dec  forbidden codeword detected bwd (long+shrt) */
108
109
110
111void CRvlc_Read (CAacDecoderChannelInfo *pAacDecoderChannelInfo,
112                 HANDLE_FDK_BITSTREAM    bs);
113
114void CRvlc_Decode (CAacDecoderChannelInfo  *pAacDecoderChannelInfo,
115                   CAacDecoderStaticChannelInfo *pAacDecoderStaticChannelInfo,
116                   HANDLE_FDK_BITSTREAM     bs);
117
118/**
119 * \brief performe sanity checks to the channel data corresponding to one channel element.
120 * \param pAacDecoderChannelInfo
121 * \param pAacDecoderStaticChannelInfo
122 * \param elChannels amount of channels of the channel element.
123 */
124void CRvlc_ElementCheck (
125        CAacDecoderChannelInfo *pAacDecoderChannelInfo[],
126        CAacDecoderStaticChannelInfo *pAacDecoderStaticChannelInfo[],
127        const UINT flags,
128        const INT elChannels
129        );
130
131
132
133
134#endif /* RVLC_H */
135