FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
libfdk-aacdec.c
Go to the documentation of this file.
1 /*
2  * AAC decoder wrapper
3  * Copyright (c) 2012 Martin Storsjo
4  *
5  * This file is part of FFmpeg.
6  *
7  * Permission to use, copy, modify, and/or distribute this software for any
8  * purpose with or without fee is hereby granted, provided that the above
9  * copyright notice and this permission notice appear in all copies.
10  *
11  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
12  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
13  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
14  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
15  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
16  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
17  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18  */
19 
20 #include <fdk-aac/aacdecoder_lib.h>
21 
23 #include "libavutil/common.h"
24 #include "libavutil/opt.h"
25 #include "avcodec.h"
26 #include "internal.h"
27 
28 #ifdef AACDECODER_LIB_VL0
29 #define FDKDEC_VER_AT_LEAST(vl0, vl1) \
30  ((AACDECODER_LIB_VL0 > vl0) || \
31  (AACDECODER_LIB_VL0 == vl0 && AACDECODER_LIB_VL1 >= vl1))
32 #else
33 #define FDKDEC_VER_AT_LEAST(vl0, vl1) 0
34 #endif
35 
36 #if !FDKDEC_VER_AT_LEAST(2, 5) // < 2.5.10
37 #define AAC_PCM_MAX_OUTPUT_CHANNELS AAC_PCM_OUTPUT_CHANNELS
38 #endif
39 
45 };
46 
47 typedef struct FDKAACDecContext {
48  const AVClass *class;
49  HANDLE_AACDECODER handle;
54  int drc_level;
55  int drc_boost;
56  int drc_heavy;
58  int drc_cut;
61 
62 
63 #define DMX_ANC_BUFFSIZE 128
64 #define DECODER_MAX_CHANNELS 8
65 #define DECODER_BUFFSIZE 2048 * sizeof(INT_PCM)
66 
67 #define OFFSET(x) offsetof(FDKAACDecContext, x)
68 #define AD AV_OPT_FLAG_AUDIO_PARAM | AV_OPT_FLAG_DECODING_PARAM
69 static const AVOption fdk_aac_dec_options[] = {
70  { "conceal", "Error concealment method", OFFSET(conceal_method), AV_OPT_TYPE_INT, { .i64 = CONCEAL_METHOD_NOISE_SUBSTITUTION }, CONCEAL_METHOD_SPECTRAL_MUTING, CONCEAL_METHOD_NB - 1, AD, "conceal" },
71  { "spectral", "Spectral muting", 0, AV_OPT_TYPE_CONST, { .i64 = CONCEAL_METHOD_SPECTRAL_MUTING }, INT_MIN, INT_MAX, AD, "conceal" },
72  { "noise", "Noise Substitution", 0, AV_OPT_TYPE_CONST, { .i64 = CONCEAL_METHOD_NOISE_SUBSTITUTION }, INT_MIN, INT_MAX, AD, "conceal" },
73  { "energy", "Energy Interpolation", 0, AV_OPT_TYPE_CONST, { .i64 = CONCEAL_METHOD_ENERGY_INTERPOLATION }, INT_MIN, INT_MAX, AD, "conceal" },
74  { "drc_boost", "Dynamic Range Control: boost, where [0] is none and [127] is max boost",
75  OFFSET(drc_boost), AV_OPT_TYPE_INT, { .i64 = -1 }, -1, 127, AD, NULL },
76  { "drc_cut", "Dynamic Range Control: attenuation factor, where [0] is none and [127] is max compression",
77  OFFSET(drc_cut), AV_OPT_TYPE_INT, { .i64 = -1 }, -1, 127, AD, NULL },
78  { "drc_level", "Dynamic Range Control: reference level, quantized to 0.25dB steps where [0] is 0dB and [127] is -31.75dB",
79  OFFSET(drc_level), AV_OPT_TYPE_INT, { .i64 = -1}, -1, 127, AD, NULL },
80  { "drc_heavy", "Dynamic Range Control: heavy compression, where [1] is on (RF mode) and [0] is off",
81  OFFSET(drc_heavy), AV_OPT_TYPE_INT, { .i64 = -1}, -1, 1, AD, NULL },
82 #if FDKDEC_VER_AT_LEAST(2, 5) // 2.5.10
83  { "level_limit", "Signal level limiting", OFFSET(level_limit), AV_OPT_TYPE_INT, { .i64 = 0 }, -1, 1, AD },
84 #endif
85 #if FDKDEC_VER_AT_LEAST(3, 0) // 3.0.0
86  { "drc_effect","Dynamic Range Control: effect type, where e.g. [0] is none and [6] is general",
87  OFFSET(drc_effect), AV_OPT_TYPE_INT, { .i64 = -1}, -1, 8, AD, NULL },
88 #endif
89  { NULL }
90 };
91 
92 static const AVClass fdk_aac_dec_class = {
93  .class_name = "libfdk-aac decoder",
94  .item_name = av_default_item_name,
95  .option = fdk_aac_dec_options,
96  .version = LIBAVUTIL_VERSION_INT,
97 };
98 
99 static int get_stream_info(AVCodecContext *avctx)
100 {
101  FDKAACDecContext *s = avctx->priv_data;
102  CStreamInfo *info = aacDecoder_GetStreamInfo(s->handle);
103  int channel_counts[0x24] = { 0 };
104  int i, ch_error = 0;
105  uint64_t ch_layout = 0;
106 
107  if (!info) {
108  av_log(avctx, AV_LOG_ERROR, "Unable to get stream info\n");
109  return AVERROR_UNKNOWN;
110  }
111 
112  if (info->sampleRate <= 0) {
113  av_log(avctx, AV_LOG_ERROR, "Stream info not initialized\n");
114  return AVERROR_UNKNOWN;
115  }
116  avctx->sample_rate = info->sampleRate;
117  avctx->frame_size = info->frameSize;
118 
119  for (i = 0; i < info->numChannels; i++) {
120  AUDIO_CHANNEL_TYPE ctype = info->pChannelType[i];
121  if (ctype <= ACT_NONE || ctype >= FF_ARRAY_ELEMS(channel_counts)) {
122  av_log(avctx, AV_LOG_WARNING, "unknown channel type\n");
123  break;
124  }
125  channel_counts[ctype]++;
126  }
127  av_log(avctx, AV_LOG_DEBUG,
128  "%d channels - front:%d side:%d back:%d lfe:%d top:%d\n",
129  info->numChannels,
130  channel_counts[ACT_FRONT], channel_counts[ACT_SIDE],
131  channel_counts[ACT_BACK], channel_counts[ACT_LFE],
132  channel_counts[ACT_FRONT_TOP] + channel_counts[ACT_SIDE_TOP] +
133  channel_counts[ACT_BACK_TOP] + channel_counts[ACT_TOP]);
134 
135  switch (channel_counts[ACT_FRONT]) {
136  case 4:
139  break;
140  case 3:
142  break;
143  case 2:
144  ch_layout |= AV_CH_LAYOUT_STEREO;
145  break;
146  case 1:
147  ch_layout |= AV_CH_FRONT_CENTER;
148  break;
149  default:
150  av_log(avctx, AV_LOG_WARNING,
151  "unsupported number of front channels: %d\n",
152  channel_counts[ACT_FRONT]);
153  ch_error = 1;
154  break;
155  }
156  if (channel_counts[ACT_SIDE] > 0) {
157  if (channel_counts[ACT_SIDE] == 2) {
158  ch_layout |= AV_CH_SIDE_LEFT | AV_CH_SIDE_RIGHT;
159  } else {
160  av_log(avctx, AV_LOG_WARNING,
161  "unsupported number of side channels: %d\n",
162  channel_counts[ACT_SIDE]);
163  ch_error = 1;
164  }
165  }
166  if (channel_counts[ACT_BACK] > 0) {
167  switch (channel_counts[ACT_BACK]) {
168  case 3:
170  break;
171  case 2:
172  ch_layout |= AV_CH_BACK_LEFT | AV_CH_BACK_RIGHT;
173  break;
174  case 1:
175  ch_layout |= AV_CH_BACK_CENTER;
176  break;
177  default:
178  av_log(avctx, AV_LOG_WARNING,
179  "unsupported number of back channels: %d\n",
180  channel_counts[ACT_BACK]);
181  ch_error = 1;
182  break;
183  }
184  }
185  if (channel_counts[ACT_LFE] > 0) {
186  if (channel_counts[ACT_LFE] == 1) {
187  ch_layout |= AV_CH_LOW_FREQUENCY;
188  } else {
189  av_log(avctx, AV_LOG_WARNING,
190  "unsupported number of LFE channels: %d\n",
191  channel_counts[ACT_LFE]);
192  ch_error = 1;
193  }
194  }
195  if (!ch_error &&
196  av_get_channel_layout_nb_channels(ch_layout) != info->numChannels) {
197  av_log(avctx, AV_LOG_WARNING, "unsupported channel configuration\n");
198  ch_error = 1;
199  }
200  if (ch_error)
201  avctx->channel_layout = 0;
202  else
203  avctx->channel_layout = ch_layout;
204 
205  avctx->channels = info->numChannels;
206 
207  return 0;
208 }
209 
211 {
212  FDKAACDecContext *s = avctx->priv_data;
213 
214  if (s->handle)
215  aacDecoder_Close(s->handle);
217  av_freep(&s->anc_buffer);
218 
219  return 0;
220 }
221 
223 {
224  FDKAACDecContext *s = avctx->priv_data;
225  AAC_DECODER_ERROR err;
226 
227  s->handle = aacDecoder_Open(avctx->extradata_size ? TT_MP4_RAW : TT_MP4_ADTS, 1);
228  if (!s->handle) {
229  av_log(avctx, AV_LOG_ERROR, "Error opening decoder\n");
230  return AVERROR_UNKNOWN;
231  }
232 
233  if (avctx->extradata_size) {
234  if ((err = aacDecoder_ConfigRaw(s->handle, &avctx->extradata,
235  &avctx->extradata_size)) != AAC_DEC_OK) {
236  av_log(avctx, AV_LOG_ERROR, "Unable to set extradata\n");
237  return AVERROR_INVALIDDATA;
238  }
239  }
240 
241  if ((err = aacDecoder_SetParam(s->handle, AAC_CONCEAL_METHOD,
242  s->conceal_method)) != AAC_DEC_OK) {
243  av_log(avctx, AV_LOG_ERROR, "Unable to set error concealment method\n");
244  return AVERROR_UNKNOWN;
245  }
246 
247  if (avctx->request_channel_layout > 0 &&
249  int downmix_channels = -1;
250 
251  switch (avctx->request_channel_layout) {
252  case AV_CH_LAYOUT_STEREO:
254  downmix_channels = 2;
255  break;
256  case AV_CH_LAYOUT_MONO:
257  downmix_channels = 1;
258  break;
259  default:
260  av_log(avctx, AV_LOG_WARNING, "Invalid request_channel_layout\n");
261  break;
262  }
263 
264  if (downmix_channels != -1) {
265  if (aacDecoder_SetParam(s->handle, AAC_PCM_MAX_OUTPUT_CHANNELS,
266  downmix_channels) != AAC_DEC_OK) {
267  av_log(avctx, AV_LOG_WARNING, "Unable to set output channels in the decoder\n");
268  } else {
270  if (!s->anc_buffer) {
271  av_log(avctx, AV_LOG_ERROR, "Unable to allocate ancillary buffer for the decoder\n");
272  return AVERROR(ENOMEM);
273  }
274  if (aacDecoder_AncDataInit(s->handle, s->anc_buffer, DMX_ANC_BUFFSIZE)) {
275  av_log(avctx, AV_LOG_ERROR, "Unable to register downmix ancillary buffer in the decoder\n");
276  return AVERROR_UNKNOWN;
277  }
278  }
279  }
280  }
281 
282  if (s->drc_boost != -1) {
283  if (aacDecoder_SetParam(s->handle, AAC_DRC_BOOST_FACTOR, s->drc_boost) != AAC_DEC_OK) {
284  av_log(avctx, AV_LOG_ERROR, "Unable to set DRC boost factor in the decoder\n");
285  return AVERROR_UNKNOWN;
286  }
287  }
288 
289  if (s->drc_cut != -1) {
290  if (aacDecoder_SetParam(s->handle, AAC_DRC_ATTENUATION_FACTOR, s->drc_cut) != AAC_DEC_OK) {
291  av_log(avctx, AV_LOG_ERROR, "Unable to set DRC attenuation factor in the decoder\n");
292  return AVERROR_UNKNOWN;
293  }
294  }
295 
296  if (s->drc_level != -1) {
297  if (aacDecoder_SetParam(s->handle, AAC_DRC_REFERENCE_LEVEL, s->drc_level) != AAC_DEC_OK) {
298  av_log(avctx, AV_LOG_ERROR, "Unable to set DRC reference level in the decoder\n");
299  return AVERROR_UNKNOWN;
300  }
301  }
302 
303  if (s->drc_heavy != -1) {
304  if (aacDecoder_SetParam(s->handle, AAC_DRC_HEAVY_COMPRESSION, s->drc_heavy) != AAC_DEC_OK) {
305  av_log(avctx, AV_LOG_ERROR, "Unable to set DRC heavy compression in the decoder\n");
306  return AVERROR_UNKNOWN;
307  }
308  }
309 
310 #if FDKDEC_VER_AT_LEAST(2, 5) // 2.5.10
311  if (aacDecoder_SetParam(s->handle, AAC_PCM_LIMITER_ENABLE, s->level_limit) != AAC_DEC_OK) {
312  av_log(avctx, AV_LOG_ERROR, "Unable to set in signal level limiting in the decoder\n");
313  return AVERROR_UNKNOWN;
314  }
315 #endif
316 
317 #if FDKDEC_VER_AT_LEAST(3, 0) // 3.0.0
318  if (s->drc_effect != -1) {
319  if (aacDecoder_SetParam(s->handle, AAC_UNIDRC_SET_EFFECT, s->drc_effect) != AAC_DEC_OK) {
320  av_log(avctx, AV_LOG_ERROR, "Unable to set DRC effect type in the decoder\n");
321  return AVERROR_UNKNOWN;
322  }
323  }
324 #endif
325 
326  avctx->sample_fmt = AV_SAMPLE_FMT_S16;
327 
330  if (!s->decoder_buffer)
331  return AVERROR(ENOMEM);
332 
333  return 0;
334 }
335 
336 static int fdk_aac_decode_frame(AVCodecContext *avctx, void *data,
337  int *got_frame_ptr, AVPacket *avpkt)
338 {
339  FDKAACDecContext *s = avctx->priv_data;
340  AVFrame *frame = data;
341  int ret;
342  AAC_DECODER_ERROR err;
343  UINT valid = avpkt->size;
344 
345  err = aacDecoder_Fill(s->handle, &avpkt->data, &avpkt->size, &valid);
346  if (err != AAC_DEC_OK) {
347  av_log(avctx, AV_LOG_ERROR, "aacDecoder_Fill() failed: %x\n", err);
348  return AVERROR_INVALIDDATA;
349  }
350 
351  err = aacDecoder_DecodeFrame(s->handle, (INT_PCM *) s->decoder_buffer, s->decoder_buffer_size / sizeof(INT_PCM), 0);
352  if (err == AAC_DEC_NOT_ENOUGH_BITS) {
353  ret = avpkt->size - valid;
354  goto end;
355  }
356  if (err != AAC_DEC_OK) {
357  av_log(avctx, AV_LOG_ERROR,
358  "aacDecoder_DecodeFrame() failed: %x\n", err);
359  ret = AVERROR_UNKNOWN;
360  goto end;
361  }
362 
363  if ((ret = get_stream_info(avctx)) < 0)
364  goto end;
365  frame->nb_samples = avctx->frame_size;
366 
367  if ((ret = ff_get_buffer(avctx, frame, 0)) < 0)
368  goto end;
369 
370  memcpy(frame->extended_data[0], s->decoder_buffer,
371  avctx->channels * avctx->frame_size *
373 
374  *got_frame_ptr = 1;
375  ret = avpkt->size - valid;
376 
377 end:
378  return ret;
379 }
380 
382 {
383  FDKAACDecContext *s = avctx->priv_data;
384  AAC_DECODER_ERROR err;
385 
386  if (!s->handle)
387  return;
388 
389  if ((err = aacDecoder_SetParam(s->handle,
390  AAC_TPDEC_CLEAR_BUFFER, 1)) != AAC_DEC_OK)
391  av_log(avctx, AV_LOG_WARNING, "failed to clear buffer when flushing\n");
392 }
393 
395  .name = "libfdk_aac",
396  .long_name = NULL_IF_CONFIG_SMALL("Fraunhofer FDK AAC"),
397  .type = AVMEDIA_TYPE_AUDIO,
398  .id = AV_CODEC_ID_AAC,
399  .priv_data_size = sizeof(FDKAACDecContext),
402  .close = fdk_aac_decode_close,
405  .priv_class = &fdk_aac_dec_class,
406  .caps_internal = FF_CODEC_CAP_INIT_THREADSAFE |
408  .wrapper_name = "libfdk",
409 };
#define FF_CODEC_CAP_INIT_CLEANUP
The codec allows calling the close function for deallocation even if the init function returned a fai...
Definition: internal.h:48
#define NULL
Definition: coverity.c:32
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:59
#define DECODER_BUFFSIZE
Definition: libfdk-aacdec.c:65
This structure describes decoded (raw) audio or video data.
Definition: frame.h:226
AVOption.
Definition: opt.h:246
ptrdiff_t const GLvoid * data
Definition: opengl_enc.c:101
static void flush(AVCodecContext *avctx)
#define AV_LOG_WARNING
Something somehow does not look correct.
Definition: log.h:182
#define LIBAVUTIL_VERSION_INT
Definition: version.h:85
static av_cold int init(AVCodecContext *avctx)
Definition: avrndec.c:35
int size
Definition: avcodec.h:1453
const char * av_default_item_name(void *ptr)
Return the context name.
Definition: log.c:191
#define AV_CODEC_CAP_CHANNEL_CONF
Codec should fill in channel configuration and samplerate instead of container.
Definition: avcodec.h:1020
#define AV_CH_LAYOUT_STEREO
#define DMX_ANC_BUFFSIZE
Definition: libfdk-aacdec.c:63
AVCodec.
Definition: avcodec.h:3441
static void decode(AVCodecContext *dec_ctx, AVPacket *pkt, AVFrame *frame, FILE *outfile)
Definition: decode_audio.c:42
int av_get_channel_layout_nb_channels(uint64_t channel_layout)
Return the number of channels in the channel layout.
const char * class_name
The name of the class; usually it is the same name as the context structure type to which the AVClass...
Definition: log.h:72
#define FF_CODEC_CAP_INIT_THREADSAFE
The codec does not modify any global variables in the init function, allowing to call the init functi...
Definition: internal.h:40
enum AVSampleFormat sample_fmt
audio sample format
Definition: avcodec.h:2204
uint8_t
#define OFFSET(x)
Definition: libfdk-aacdec.c:67
#define av_cold
Definition: attributes.h:82
#define av_malloc(s)
#define AD
Definition: libfdk-aacdec.c:68
AVOptions.
static av_cold int end(AVCodecContext *avctx)
Definition: avrndec.c:90
uint8_t * extradata
some codecs need / can use extradata like Huffman tables.
Definition: avcodec.h:1641
#define AV_CH_LOW_FREQUENCY
static AVFrame * frame
uint8_t * data
Definition: avcodec.h:1452
static int get_stream_info(AVCodecContext *avctx)
Definition: libfdk-aacdec.c:99
#define AV_CH_BACK_LEFT
#define av_log(a,...)
HANDLE_AACDECODER handle
Definition: libfdk-aacdec.c:49
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:176
static av_cold void fdk_aac_decode_flush(AVCodecContext *avctx)
#define AVERROR(e)
Definition: error.h:43
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:186
AVCodec ff_libfdk_aac_decoder
#define AV_LOG_DEBUG
Stuff which is only useful for libav* developers.
Definition: log.h:197
const char * name
Name of the codec implementation.
Definition: avcodec.h:3448
uint64_t channel_layout
Audio channel layout.
Definition: avcodec.h:2247
#define AAC_PCM_MAX_OUTPUT_CHANNELS
Definition: libfdk-aacdec.c:37
uint8_t * decoder_buffer
Definition: libfdk-aacdec.c:50
ConcealMethod
Definition: libfdk-aacdec.c:40
audio channel layout utility functions
#define AV_CH_LAYOUT_STEREO_DOWNMIX
static const AVOption fdk_aac_dec_options[]
Definition: libfdk-aacdec.c:69
#define s(width, name)
Definition: cbs_vp9.c:257
#define AV_CH_FRONT_LEFT_OF_CENTER
#define AV_CH_FRONT_CENTER
static const uint8_t channel_counts[7]
Definition: dca_lbr.c:109
#define FF_ARRAY_ELEMS(a)
#define AV_CH_FRONT_RIGHT_OF_CENTER
int frame_size
Number of samples per channel in an audio frame.
Definition: avcodec.h:2216
Libavcodec external API header.
int sample_rate
samples per second
Definition: avcodec.h:2196
static int fdk_aac_decode_frame(AVCodecContext *avctx, void *data, int *got_frame_ptr, AVPacket *avpkt)
static const AVClass fdk_aac_dec_class
Definition: libfdk-aacdec.c:92
#define AV_CH_LAYOUT_NATIVE
Channel mask value used for AVCodecContext.request_channel_layout to indicate that the user requests ...
main external API structure.
Definition: avcodec.h:1540
int ff_get_buffer(AVCodecContext *avctx, AVFrame *frame, int flags)
Get a buffer for a frame.
Definition: decode.c:1918
int extradata_size
Definition: avcodec.h:1642
Describe the class of an AVClass context structure.
Definition: log.h:67
uint8_t * anc_buffer
Definition: libfdk-aacdec.c:52
#define AV_CH_BACK_CENTER
#define AV_CH_SIDE_RIGHT
int av_get_bytes_per_sample(enum AVSampleFormat sample_fmt)
Return number of bytes per sample.
Definition: samplefmt.c:106
common internal api header.
static av_cold int fdk_aac_decode_close(AVCodecContext *avctx)
common internal and external API header
signed 16 bits
Definition: samplefmt.h:61
static av_cold int fdk_aac_decode_init(AVCodecContext *avctx)
#define AVERROR_UNKNOWN
Unknown error, typically from an external library.
Definition: error.h:71
void * priv_data
Definition: avcodec.h:1567
int channels
number of audio channels
Definition: avcodec.h:2197
#define DECODER_MAX_CHANNELS
Definition: libfdk-aacdec.c:64
#define av_freep(p)
unsigned int UINT
#define AV_CH_SIDE_LEFT
uint8_t ** extended_data
pointers to the data planes/channels.
Definition: frame.h:273
#define AV_CH_LAYOUT_MONO
uint64_t request_channel_layout
Request decoder to use this channel layout if it can (0 for default)
Definition: avcodec.h:2254
This structure stores compressed data.
Definition: avcodec.h:1429
int nb_samples
number of audio samples (per channel) described by this frame
Definition: frame.h:292
#define AV_CODEC_CAP_DR1
Codec uses get_buffer() for allocating buffers and supports custom allocators.
Definition: avcodec.h:968
#define AV_CH_BACK_RIGHT