3 * Copyright (c) 2012 Martin Storsjo
5 * This file is part of FFmpeg.
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.
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.
20 #include <fdk-aac/aacenc_lib.h>
22 #include "libavutil/channel_layout.h"
23 #include "libavutil/common.h"
24 #include "libavutil/opt.h"
26 #include "audio_frame_queue.h"
29 typedef struct AACContext {
31 HANDLE_AACENCODER handle;
42 static const AVOption aac_enc_options[] = {
43 { "afterburner", "Afterburner (improved quality)", offsetof(AACContext, afterburner), AV_OPT_TYPE_INT, { .i64 = 1 }, 0, 1, AV_OPT_FLAG_AUDIO_PARAM | AV_OPT_FLAG_ENCODING_PARAM },
44 { "eld_sbr", "Enable SBR for ELD (for SBR in other configurations, use the -profile parameter)", offsetof(AACContext, eld_sbr), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, AV_OPT_FLAG_AUDIO_PARAM | AV_OPT_FLAG_ENCODING_PARAM },
45 { "signaling", "SBR/PS signaling style", offsetof(AACContext, signaling), AV_OPT_TYPE_INT, { .i64 = -1 }, -1, 2, AV_OPT_FLAG_AUDIO_PARAM | AV_OPT_FLAG_ENCODING_PARAM, "signaling" },
46 { "default", "Choose signaling implicitly (explicit hierarchical by default, implicit if global header is disabled)", 0, AV_OPT_TYPE_CONST, { .i64 = -1 }, 0, 0, AV_OPT_FLAG_AUDIO_PARAM | AV_OPT_FLAG_ENCODING_PARAM, "signaling" },
47 { "implicit", "Implicit backwards compatible signaling", 0, AV_OPT_TYPE_CONST, { .i64 = 0 }, 0, 0, AV_OPT_FLAG_AUDIO_PARAM | AV_OPT_FLAG_ENCODING_PARAM, "signaling" },
48 { "explicit_sbr", "Explicit SBR, implicit PS signaling", 0, AV_OPT_TYPE_CONST, { .i64 = 1 }, 0, 0, AV_OPT_FLAG_AUDIO_PARAM | AV_OPT_FLAG_ENCODING_PARAM, "signaling" },
49 { "explicit_hierarchical", "Explicit hierarchical signaling", 0, AV_OPT_TYPE_CONST, { .i64 = 2 }, 0, 0, AV_OPT_FLAG_AUDIO_PARAM | AV_OPT_FLAG_ENCODING_PARAM, "signaling" },
50 { "latm", "Output LATM/LOAS encapsulated data", offsetof(AACContext, latm), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, AV_OPT_FLAG_AUDIO_PARAM | AV_OPT_FLAG_ENCODING_PARAM },
51 { "header_period", "StreamMuxConfig and PCE repetition period (in frames)", offsetof(AACContext, header_period), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 0xffff, AV_OPT_FLAG_AUDIO_PARAM | AV_OPT_FLAG_ENCODING_PARAM },
52 { "vbr", "VBR mode (1-5)", offsetof(AACContext, vbr), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 5, AV_OPT_FLAG_AUDIO_PARAM | AV_OPT_FLAG_ENCODING_PARAM },
56 static const AVClass aac_enc_class = {
57 .class_name = "libfdk_aac",
58 .item_name = av_default_item_name,
59 .option = aac_enc_options,
60 .version = LIBAVUTIL_VERSION_INT,
63 static const char *aac_get_error(AACENC_ERROR err)
68 case AACENC_INVALID_HANDLE:
69 return "Invalid handle";
70 case AACENC_MEMORY_ERROR:
71 return "Memory allocation error";
72 case AACENC_UNSUPPORTED_PARAMETER:
73 return "Unsupported parameter";
74 case AACENC_INVALID_CONFIG:
75 return "Invalid config";
76 case AACENC_INIT_ERROR:
77 return "Initialization error";
78 case AACENC_INIT_AAC_ERROR:
79 return "AAC library initialization error";
80 case AACENC_INIT_SBR_ERROR:
81 return "SBR library initialization error";
82 case AACENC_INIT_TP_ERROR:
83 return "Transport library initialization error";
84 case AACENC_INIT_META_ERROR:
85 return "Metadata library initialization error";
86 case AACENC_ENCODE_ERROR:
87 return "Encoding error";
88 case AACENC_ENCODE_EOF:
91 return "Unknown error";
95 static int aac_encode_close(AVCodecContext *avctx)
97 AACContext *s = avctx->priv_data;
100 aacEncClose(&s->handle);
101 av_freep(&avctx->extradata);
102 ff_af_queue_close(&s->afq);
107 static av_cold int aac_encode_init(AVCodecContext *avctx)
109 AACContext *s = avctx->priv_data;
110 int ret = AVERROR(EINVAL);
111 AACENC_InfoStruct info = { 0 };
114 int aot = FF_PROFILE_AAC_LOW + 1;
115 int sce = 0, cpe = 0;
117 if ((err = aacEncOpen(&s->handle, 0, avctx->channels)) != AACENC_OK) {
118 av_log(avctx, AV_LOG_ERROR, "Unable to open the encoder: %s\n",
123 if (avctx->profile != FF_PROFILE_UNKNOWN)
124 aot = avctx->profile + 1;
126 if ((err = aacEncoder_SetParam(s->handle, AACENC_AOT, aot)) != AACENC_OK) {
127 av_log(avctx, AV_LOG_ERROR, "Unable to set the AOT %d: %s\n",
128 aot, aac_get_error(err));
132 if (aot == FF_PROFILE_AAC_ELD + 1 && s->eld_sbr) {
133 if ((err = aacEncoder_SetParam(s->handle, AACENC_SBR_MODE,
135 av_log(avctx, AV_LOG_ERROR, "Unable to enable SBR for ELD: %s\n",
141 if ((err = aacEncoder_SetParam(s->handle, AACENC_SAMPLERATE,
142 avctx->sample_rate)) != AACENC_OK) {
143 av_log(avctx, AV_LOG_ERROR, "Unable to set the sample rate %d: %s\n",
144 avctx->sample_rate, aac_get_error(err));
148 switch (avctx->channels) {
149 case 1: mode = MODE_1; sce = 1; cpe = 0; break;
150 case 2: mode = MODE_2; sce = 0; cpe = 1; break;
151 case 3: mode = MODE_1_2; sce = 1; cpe = 1; break;
152 case 4: mode = MODE_1_2_1; sce = 2; cpe = 1; break;
153 case 5: mode = MODE_1_2_2; sce = 1; cpe = 2; break;
154 case 6: mode = MODE_1_2_2_1; sce = 2; cpe = 2; break;
155 /* The version macro is introduced the same time as the 7.1 support, so this
157 #ifdef AACENCODER_LIB_VL0
161 if (avctx->channel_layout == AV_CH_LAYOUT_7POINT1) {
162 mode = MODE_7_1_REAR_SURROUND;
164 // MODE_1_2_2_2_1 and MODE_7_1_FRONT_CENTER use the same channel layout
165 mode = MODE_7_1_FRONT_CENTER;
170 av_log(avctx, AV_LOG_ERROR,
171 "Unsupported number of channels %d\n", avctx->channels);
175 if ((err = aacEncoder_SetParam(s->handle, AACENC_CHANNELMODE,
176 mode)) != AACENC_OK) {
177 av_log(avctx, AV_LOG_ERROR,
178 "Unable to set channel mode %d: %s\n", mode, aac_get_error(err));
182 if ((err = aacEncoder_SetParam(s->handle, AACENC_CHANNELORDER,
184 av_log(avctx, AV_LOG_ERROR,
185 "Unable to set wav channel order %d: %s\n",
186 mode, aac_get_error(err));
190 if (avctx->flags & AV_CODEC_FLAG_QSCALE || s->vbr) {
191 int mode = s->vbr ? s->vbr : avctx->global_quality;
192 if (mode < 1 || mode > 5) {
193 av_log(avctx, AV_LOG_WARNING,
194 "VBR quality %d out of range, should be 1-5\n", mode);
195 mode = av_clip(mode, 1, 5);
197 av_log(avctx, AV_LOG_WARNING,
198 "Note, the VBR setting is unsupported and only works with "
199 "some parameter combinations\n");
200 if ((err = aacEncoder_SetParam(s->handle, AACENC_BITRATEMODE,
201 mode)) != AACENC_OK) {
202 av_log(avctx, AV_LOG_ERROR, "Unable to set the VBR bitrate mode %d: %s\n",
203 mode, aac_get_error(err));
207 if (avctx->bit_rate <= 0) {
208 if (avctx->profile == FF_PROFILE_AAC_HE_V2) {
212 avctx->bit_rate = (96*sce + 128*cpe) * avctx->sample_rate / 44;
213 if (avctx->profile == FF_PROFILE_AAC_HE ||
214 avctx->profile == FF_PROFILE_AAC_HE_V2 ||
215 avctx->profile == FF_PROFILE_MPEG2_AAC_HE ||
217 avctx->bit_rate /= 2;
219 if ((err = aacEncoder_SetParam(s->handle, AACENC_BITRATE,
220 avctx->bit_rate)) != AACENC_OK) {
221 av_log(avctx, AV_LOG_ERROR, "Unable to set the bitrate %"PRId64": %s\n",
222 avctx->bit_rate, aac_get_error(err));
227 /* Choose bitstream format - if global header is requested, use
228 * raw access units, otherwise use ADTS. */
229 if ((err = aacEncoder_SetParam(s->handle, AACENC_TRANSMUX,
230 avctx->flags & AV_CODEC_FLAG_GLOBAL_HEADER ? 0 : s->latm ? 10 : 2)) != AACENC_OK) {
231 av_log(avctx, AV_LOG_ERROR, "Unable to set the transmux format: %s\n",
236 if (s->latm && s->header_period) {
237 if ((err = aacEncoder_SetParam(s->handle, AACENC_HEADER_PERIOD,
238 s->header_period)) != AACENC_OK) {
239 av_log(avctx, AV_LOG_ERROR, "Unable to set header period: %s\n",
245 /* If no signaling mode is chosen, use explicit hierarchical signaling
246 * if using mp4 mode (raw access units, with global header) and
247 * implicit signaling if using ADTS. */
248 if (s->signaling < 0)
249 s->signaling = avctx->flags & AV_CODEC_FLAG_GLOBAL_HEADER ? 2 : 0;
251 if ((err = aacEncoder_SetParam(s->handle, AACENC_SIGNALING_MODE,
252 s->signaling)) != AACENC_OK) {
253 av_log(avctx, AV_LOG_ERROR, "Unable to set signaling mode %d: %s\n",
254 s->signaling, aac_get_error(err));
258 if ((err = aacEncoder_SetParam(s->handle, AACENC_AFTERBURNER,
259 s->afterburner)) != AACENC_OK) {
260 av_log(avctx, AV_LOG_ERROR, "Unable to set afterburner to %d: %s\n",
261 s->afterburner, aac_get_error(err));
265 if (avctx->cutoff > 0) {
266 if (avctx->cutoff < (avctx->sample_rate + 255) >> 8 || avctx->cutoff > 20000) {
267 av_log(avctx, AV_LOG_ERROR, "cutoff valid range is %d-20000\n",
268 (avctx->sample_rate + 255) >> 8);
271 if ((err = aacEncoder_SetParam(s->handle, AACENC_BANDWIDTH,
272 avctx->cutoff)) != AACENC_OK) {
273 av_log(avctx, AV_LOG_ERROR, "Unable to set the encoder bandwidth to %d: %s\n",
274 avctx->cutoff, aac_get_error(err));
279 if ((err = aacEncEncode(s->handle, NULL, NULL, NULL, NULL)) != AACENC_OK) {
280 av_log(avctx, AV_LOG_ERROR, "Unable to initialize the encoder: %s\n",
282 return AVERROR(EINVAL);
285 if ((err = aacEncInfo(s->handle, &info)) != AACENC_OK) {
286 av_log(avctx, AV_LOG_ERROR, "Unable to get encoder info: %s\n",
291 avctx->frame_size = info.frameLength;
292 avctx->initial_padding = info.encoderDelay;
293 ff_af_queue_init(avctx, &s->afq);
295 if (avctx->flags & AV_CODEC_FLAG_GLOBAL_HEADER) {
296 avctx->extradata_size = info.confSize;
297 avctx->extradata = av_mallocz(avctx->extradata_size +
298 AV_INPUT_BUFFER_PADDING_SIZE);
299 if (!avctx->extradata) {
300 ret = AVERROR(ENOMEM);
304 memcpy(avctx->extradata, info.confBuf, info.confSize);
308 aac_encode_close(avctx);
312 static int aac_encode_frame(AVCodecContext *avctx, AVPacket *avpkt,
313 const AVFrame *frame, int *got_packet_ptr)
315 AACContext *s = avctx->priv_data;
316 AACENC_BufDesc in_buf = { 0 }, out_buf = { 0 };
317 AACENC_InArgs in_args = { 0 };
318 AACENC_OutArgs out_args = { 0 };
319 int in_buffer_identifier = IN_AUDIO_DATA;
320 int in_buffer_size, in_buffer_element_size;
321 int out_buffer_identifier = OUT_BITSTREAM_DATA;
322 int out_buffer_size, out_buffer_element_size;
323 void *in_ptr, *out_ptr;
327 /* handle end-of-stream small frame and flushing */
329 in_args.numInSamples = -1;
331 in_ptr = frame->data[0];
332 in_buffer_size = 2 * avctx->channels * frame->nb_samples;
333 in_buffer_element_size = 2;
335 in_args.numInSamples = avctx->channels * frame->nb_samples;
337 in_buf.bufs = &in_ptr;
338 in_buf.bufferIdentifiers = &in_buffer_identifier;
339 in_buf.bufSizes = &in_buffer_size;
340 in_buf.bufElSizes = &in_buffer_element_size;
342 /* add current frame to the queue */
343 if ((ret = ff_af_queue_add(&s->afq, frame)) < 0)
347 /* The maximum packet size is 6144 bits aka 768 bytes per channel. */
348 if ((ret = ff_alloc_packet2(avctx, avpkt, FFMAX(8192, 768 * avctx->channels), 0)) < 0)
351 out_ptr = avpkt->data;
352 out_buffer_size = avpkt->size;
353 out_buffer_element_size = 1;
355 out_buf.bufs = &out_ptr;
356 out_buf.bufferIdentifiers = &out_buffer_identifier;
357 out_buf.bufSizes = &out_buffer_size;
358 out_buf.bufElSizes = &out_buffer_element_size;
360 if ((err = aacEncEncode(s->handle, &in_buf, &out_buf, &in_args,
361 &out_args)) != AACENC_OK) {
362 if (!frame && err == AACENC_ENCODE_EOF)
364 av_log(avctx, AV_LOG_ERROR, "Unable to encode frame: %s\n",
366 return AVERROR(EINVAL);
369 if (!out_args.numOutBytes)
372 /* Get the next frame pts & duration */
373 ff_af_queue_remove(&s->afq, avctx->frame_size, &avpkt->pts,
376 avpkt->size = out_args.numOutBytes;
381 static const AVProfile profiles[] = {
382 { FF_PROFILE_AAC_LOW, "LC" },
383 { FF_PROFILE_AAC_HE, "HE-AAC" },
384 { FF_PROFILE_AAC_HE_V2, "HE-AACv2" },
385 { FF_PROFILE_AAC_LD, "LD" },
386 { FF_PROFILE_AAC_ELD, "ELD" },
387 { FF_PROFILE_UNKNOWN },
390 static const AVCodecDefault aac_encode_defaults[] = {
395 static const uint64_t aac_channel_layout[] = {
398 AV_CH_LAYOUT_SURROUND,
399 AV_CH_LAYOUT_4POINT0,
400 AV_CH_LAYOUT_5POINT0_BACK,
401 AV_CH_LAYOUT_5POINT1_BACK,
402 #ifdef AACENCODER_LIB_VL0
403 AV_CH_LAYOUT_7POINT1_WIDE_BACK,
404 AV_CH_LAYOUT_7POINT1,
409 static const int aac_sample_rates[] = {
410 96000, 88200, 64000, 48000, 44100, 32000,
411 24000, 22050, 16000, 12000, 11025, 8000, 0
414 AVCodec ff_libfdk_aac_encoder = {
415 .name = "libfdk_aac",
416 .long_name = NULL_IF_CONFIG_SMALL("Fraunhofer FDK AAC"),
417 .type = AVMEDIA_TYPE_AUDIO,
418 .id = AV_CODEC_ID_AAC,
419 .priv_data_size = sizeof(AACContext),
420 .init = aac_encode_init,
421 .encode2 = aac_encode_frame,
422 .close = aac_encode_close,
423 .capabilities = AV_CODEC_CAP_SMALL_LAST_FRAME | AV_CODEC_CAP_DELAY,
424 .sample_fmts = (const enum AVSampleFormat[]){ AV_SAMPLE_FMT_S16,
425 AV_SAMPLE_FMT_NONE },
426 .priv_class = &aac_enc_class,
427 .defaults = aac_encode_defaults,
428 .profiles = profiles,
429 .supported_samplerates = aac_sample_rates,
430 .channel_layouts = aac_channel_layout,
431 .wrapper_name = "libfdk",