Merge commit '831018b0bbe26a603802a9022472f714a59293be'
[ffmpeg.git] / libavcodec / mpeg4audio.h
1 /*
2  * MPEG-4 Audio common header
3  * Copyright (c) 2008 Baptiste Coudurier <baptiste.coudurier@free.fr>
4  *
5  * This file is part of FFmpeg.
6  *
7  * FFmpeg is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * FFmpeg is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with FFmpeg; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21
22 #ifndef AVCODEC_MPEG4AUDIO_H
23 #define AVCODEC_MPEG4AUDIO_H
24
25 #include <stdint.h>
26
27 #include "libavutil/attributes.h"
28
29 #include "get_bits.h"
30 #include "put_bits.h"
31
32 typedef struct MPEG4AudioConfig {
33     int object_type;
34     int sampling_index;
35     int sample_rate;
36     int chan_config;
37     int sbr; ///< -1 implicit, 1 presence
38     int ext_object_type;
39     int ext_sampling_index;
40     int ext_sample_rate;
41     int ext_chan_config;
42     int channels;
43     int ps;  ///< -1 implicit, 1 presence
44     int frame_length_short;
45 } MPEG4AudioConfig;
46
47 extern av_export const int avpriv_mpeg4audio_sample_rates[16];
48 extern const uint8_t ff_mpeg4audio_channels[8];
49
50 /**
51  * Parse MPEG-4 systems extradata from a potentially unaligned GetBitContext to retrieve audio configuration.
52  * @param[in] c        MPEG4AudioConfig structure to fill.
53  * @param[in] gb       Extradata from container.
54  * @param[in] sync_extension look for a sync extension after config if true.
55  * @return On error -1 is returned, on success AudioSpecificConfig bit index in extradata.
56  */
57 int ff_mpeg4audio_get_config_gb(MPEG4AudioConfig *c, GetBitContext *gb,
58                                 int sync_extension);
59
60 /**
61  * Parse MPEG-4 systems extradata from a raw buffer to retrieve audio configuration.
62  * @param[in] c        MPEG4AudioConfig structure to fill.
63  * @param[in] buf      Extradata from container.
64  * @param[in] bit_size Extradata size in bits.
65  * @param[in] sync_extension look for a sync extension after config if true.
66  * @return On error -1 is returned, on success AudioSpecificConfig bit index in extradata.
67  */
68 int avpriv_mpeg4audio_get_config(MPEG4AudioConfig *c, const uint8_t *buf,
69                                  int bit_size, int sync_extension);
70
71 enum AudioObjectType {
72     AOT_NULL,
73                                // Support?                Name
74     AOT_AAC_MAIN,              ///< Y                       Main
75     AOT_AAC_LC,                ///< Y                       Low Complexity
76     AOT_AAC_SSR,               ///< N (code in SoC repo)    Scalable Sample Rate
77     AOT_AAC_LTP,               ///< Y                       Long Term Prediction
78     AOT_SBR,                   ///< Y                       Spectral Band Replication
79     AOT_AAC_SCALABLE,          ///< N                       Scalable
80     AOT_TWINVQ,                ///< N                       Twin Vector Quantizer
81     AOT_CELP,                  ///< N                       Code Excited Linear Prediction
82     AOT_HVXC,                  ///< N                       Harmonic Vector eXcitation Coding
83     AOT_TTSI             = 12, ///< N                       Text-To-Speech Interface
84     AOT_MAINSYNTH,             ///< N                       Main Synthesis
85     AOT_WAVESYNTH,             ///< N                       Wavetable Synthesis
86     AOT_MIDI,                  ///< N                       General MIDI
87     AOT_SAFX,                  ///< N                       Algorithmic Synthesis and Audio Effects
88     AOT_ER_AAC_LC,             ///< N                       Error Resilient Low Complexity
89     AOT_ER_AAC_LTP       = 19, ///< N                       Error Resilient Long Term Prediction
90     AOT_ER_AAC_SCALABLE,       ///< N                       Error Resilient Scalable
91     AOT_ER_TWINVQ,             ///< N                       Error Resilient Twin Vector Quantizer
92     AOT_ER_BSAC,               ///< N                       Error Resilient Bit-Sliced Arithmetic Coding
93     AOT_ER_AAC_LD,             ///< N                       Error Resilient Low Delay
94     AOT_ER_CELP,               ///< N                       Error Resilient Code Excited Linear Prediction
95     AOT_ER_HVXC,               ///< N                       Error Resilient Harmonic Vector eXcitation Coding
96     AOT_ER_HILN,               ///< N                       Error Resilient Harmonic and Individual Lines plus Noise
97     AOT_ER_PARAM,              ///< N                       Error Resilient Parametric
98     AOT_SSC,                   ///< N                       SinuSoidal Coding
99     AOT_PS,                    ///< N                       Parametric Stereo
100     AOT_SURROUND,              ///< N                       MPEG Surround
101     AOT_ESCAPE,                ///< Y                       Escape Value
102     AOT_L1,                    ///< Y                       Layer 1
103     AOT_L2,                    ///< Y                       Layer 2
104     AOT_L3,                    ///< Y                       Layer 3
105     AOT_DST,                   ///< N                       Direct Stream Transfer
106     AOT_ALS,                   ///< Y                       Audio LosslesS
107     AOT_SLS,                   ///< N                       Scalable LosslesS
108     AOT_SLS_NON_CORE,          ///< N                       Scalable LosslesS (non core)
109     AOT_ER_AAC_ELD,            ///< N                       Error Resilient Enhanced Low Delay
110     AOT_SMR_SIMPLE,            ///< N                       Symbolic Music Representation Simple
111     AOT_SMR_MAIN,              ///< N                       Symbolic Music Representation Main
112     AOT_USAC_NOSBR,            ///< N                       Unified Speech and Audio Coding (no SBR)
113     AOT_SAOC,                  ///< N                       Spatial Audio Object Coding
114     AOT_LD_SURROUND,           ///< N                       Low Delay MPEG Surround
115     AOT_USAC,                  ///< N                       Unified Speech and Audio Coding
116 };
117
118 #define MAX_PCE_SIZE 320 ///<Maximum size of a PCE including the 3-bit ID_PCE
119                          ///<marker and the comment
120
121 static av_always_inline unsigned int ff_pce_copy_bits(PutBitContext *pb,
122                                                       GetBitContext *gb,
123                                                       int bits)
124 {
125     unsigned int el = get_bits(gb, bits);
126     put_bits(pb, bits, el);
127     return el;
128 }
129
130 static inline int ff_copy_pce_data(PutBitContext *pb, GetBitContext *gb)
131 {
132     int five_bit_ch, four_bit_ch, comment_size, bits;
133     int offset = put_bits_count(pb);
134
135     ff_pce_copy_bits(pb, gb, 10);               // Tag, Object Type, Frequency
136     five_bit_ch  = ff_pce_copy_bits(pb, gb, 4); // Front
137     five_bit_ch += ff_pce_copy_bits(pb, gb, 4); // Side
138     five_bit_ch += ff_pce_copy_bits(pb, gb, 4); // Back
139     four_bit_ch  = ff_pce_copy_bits(pb, gb, 2); // LFE
140     four_bit_ch += ff_pce_copy_bits(pb, gb, 3); // Data
141     five_bit_ch += ff_pce_copy_bits(pb, gb, 4); // Coupling
142     if (ff_pce_copy_bits(pb, gb, 1))            // Mono Mixdown
143         ff_pce_copy_bits(pb, gb, 4);
144     if (ff_pce_copy_bits(pb, gb, 1))            // Stereo Mixdown
145         ff_pce_copy_bits(pb, gb, 4);
146     if (ff_pce_copy_bits(pb, gb, 1))            // Matrix Mixdown
147         ff_pce_copy_bits(pb, gb, 3);
148     for (bits = five_bit_ch*5+four_bit_ch*4; bits > 16; bits -= 16)
149         ff_pce_copy_bits(pb, gb, 16);
150     if (bits)
151         ff_pce_copy_bits(pb, gb, bits);
152     avpriv_align_put_bits(pb);
153     align_get_bits(gb);
154     comment_size = ff_pce_copy_bits(pb, gb, 8);
155     for (; comment_size > 0; comment_size--)
156         ff_pce_copy_bits(pb, gb, 8);
157
158     return put_bits_count(pb) - offset;
159 }
160
161 #endif /* AVCODEC_MPEG4AUDIO_H */