3 * Copyright (c) 2012 Martin Storsjo
5 * This file is part of FFmpeg.
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.
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.
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
22 #include <fdk-aac/aacenc_lib.h>
24 #include "libavutil/channel_layout.h"
25 #include "libavutil/common.h"
26 #include "libavutil/opt.h"
28 #include "audio_frame_queue.h"
31 typedef struct AACContext {
33 HANDLE_AACENCODER handle;
44 static const AVOption aac_enc_options[] = {
45 { "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 },
46 { "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 },
47 { "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" },
48 { "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" },
49 { "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" },
50 { "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" },
51 { "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" },
52 { "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 },
53 { "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 },
54 { "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 },
58 static const AVClass aac_enc_class = {
59 "libfdk_aac", av_default_item_name, aac_enc_options, LIBAVUTIL_VERSION_INT
62 static const char *aac_get_error(AACENC_ERROR err)
67 case AACENC_INVALID_HANDLE:
68 return "Invalid handle";
69 case AACENC_MEMORY_ERROR:
70 return "Memory allocation error";
71 case AACENC_UNSUPPORTED_PARAMETER:
72 return "Unsupported parameter";
73 case AACENC_INVALID_CONFIG:
74 return "Invalid config";
75 case AACENC_INIT_ERROR:
76 return "Initialization error";
77 case AACENC_INIT_AAC_ERROR:
78 return "AAC library initialization error";
79 case AACENC_INIT_SBR_ERROR:
80 return "SBR library initialization error";
81 case AACENC_INIT_TP_ERROR:
82 return "Transport library initialization error";
83 case AACENC_INIT_META_ERROR:
84 return "Metadata library initialization error";
85 case AACENC_ENCODE_ERROR:
86 return "Encoding error";
87 case AACENC_ENCODE_EOF:
90 return "Unknown error";
94 static int aac_encode_close(AVCodecContext *avctx)
96 AACContext *s = avctx->priv_data;
99 aacEncClose(&s->handle);
100 av_freep(&avctx->extradata);
101 ff_af_queue_close(&s->afq);
106 static av_cold int aac_encode_init(AVCodecContext *avctx)
108 AACContext *s = avctx->priv_data;
109 int ret = AVERROR(EINVAL);
110 AACENC_InfoStruct info = { 0 };
113 int aot = FF_PROFILE_AAC_LOW + 1;
114 int sce = 0, cpe = 0;
116 if ((err = aacEncOpen(&s->handle, 0, avctx->channels)) != AACENC_OK) {
117 av_log(avctx, AV_LOG_ERROR, "Unable to open the encoder: %s\n",
122 if (avctx->profile != FF_PROFILE_UNKNOWN)
123 aot = avctx->profile + 1;
125 if ((err = aacEncoder_SetParam(s->handle, AACENC_AOT, aot)) != AACENC_OK) {
126 av_log(avctx, AV_LOG_ERROR, "Unable to set the AOT %d: %s\n",
127 aot, aac_get_error(err));
131 if (aot == FF_PROFILE_AAC_ELD + 1 && s->eld_sbr) {
132 if ((err = aacEncoder_SetParam(s->handle, AACENC_SBR_MODE,
134 av_log(avctx, AV_LOG_ERROR, "Unable to enable SBR for ELD: %s\n",
140 if ((err = aacEncoder_SetParam(s->handle, AACENC_SAMPLERATE,
141 avctx->sample_rate)) != AACENC_OK) {
142 av_log(avctx, AV_LOG_ERROR, "Unable to set the sample rate %d: %s\n",
143 avctx->sample_rate, aac_get_error(err));
147 switch (avctx->channels) {
148 case 1: mode = MODE_1; sce = 1; cpe = 0; break;
149 case 2: mode = MODE_2; sce = 0; cpe = 1; break;
150 case 3: mode = MODE_1_2; sce = 1; cpe = 1; break;
151 case 4: mode = MODE_1_2_1; sce = 2; cpe = 1; break;
152 case 5: mode = MODE_1_2_2; sce = 1; cpe = 2; break;
153 case 6: mode = MODE_1_2_2_1; sce = 2; cpe = 2; break;
157 if (avctx->channel_layout == AV_CH_LAYOUT_7POINT1) {
158 mode = MODE_7_1_REAR_SURROUND;
160 // MODE_1_2_2_2_1 and MODE_7_1_FRONT_CENTER use the same channel layout
161 mode = MODE_7_1_FRONT_CENTER;
165 av_log(avctx, AV_LOG_ERROR,
166 "Unsupported number of channels %d\n", avctx->channels);
170 if ((err = aacEncoder_SetParam(s->handle, AACENC_CHANNELMODE,
171 mode)) != AACENC_OK) {
172 av_log(avctx, AV_LOG_ERROR,
173 "Unable to set channel mode %d: %s\n", mode, aac_get_error(err));
177 if ((err = aacEncoder_SetParam(s->handle, AACENC_CHANNELORDER,
179 av_log(avctx, AV_LOG_ERROR,
180 "Unable to set wav channel order %d: %s\n",
181 mode, aac_get_error(err));
185 if (avctx->flags & CODEC_FLAG_QSCALE || s->vbr) {
186 int mode = s->vbr ? s->vbr : avctx->global_quality;
187 if (mode < 1 || mode > 5) {
188 av_log(avctx, AV_LOG_WARNING,
189 "VBR quality %d out of range, should be 1-5\n", mode);
190 mode = av_clip(mode, 1, 5);
192 av_log(avctx, AV_LOG_WARNING,
193 "Note, the VBR setting is unsupported and only works with "
194 "some parameter combinations\n");
195 if ((err = aacEncoder_SetParam(s->handle, AACENC_BITRATEMODE,
196 mode)) != AACENC_OK) {
197 av_log(avctx, AV_LOG_ERROR, "Unable to set the VBR bitrate mode %d: %s\n",
198 mode, aac_get_error(err));
202 if (avctx->bit_rate <= 0) {
203 if (avctx->profile == FF_PROFILE_AAC_HE_V2) {
207 avctx->bit_rate = (96*sce + 128*cpe) * avctx->sample_rate / 44;
208 if (avctx->profile == FF_PROFILE_AAC_HE ||
209 avctx->profile == FF_PROFILE_AAC_HE_V2 ||
210 avctx->profile == FF_PROFILE_MPEG2_AAC_HE ||
212 avctx->bit_rate /= 2;
214 if ((err = aacEncoder_SetParam(s->handle, AACENC_BITRATE,
215 avctx->bit_rate)) != AACENC_OK) {
216 av_log(avctx, AV_LOG_ERROR, "Unable to set the bitrate %d: %s\n",
217 avctx->bit_rate, aac_get_error(err));
222 /* Choose bitstream format - if global header is requested, use
223 * raw access units, otherwise use ADTS. */
224 if ((err = aacEncoder_SetParam(s->handle, AACENC_TRANSMUX,
225 avctx->flags & CODEC_FLAG_GLOBAL_HEADER ? 0 : s->latm ? 10 : 2)) != AACENC_OK) {
226 av_log(avctx, AV_LOG_ERROR, "Unable to set the transmux format: %s\n",
231 if (s->latm && s->header_period) {
232 if ((err = aacEncoder_SetParam(s->handle, AACENC_HEADER_PERIOD,
233 s->header_period)) != AACENC_OK) {
234 av_log(avctx, AV_LOG_ERROR, "Unable to set header period: %s\n",
240 /* If no signaling mode is chosen, use explicit hierarchical signaling
241 * if using mp4 mode (raw access units, with global header) and
242 * implicit signaling if using ADTS. */
243 if (s->signaling < 0)
244 s->signaling = avctx->flags & CODEC_FLAG_GLOBAL_HEADER ? 2 : 0;
246 if ((err = aacEncoder_SetParam(s->handle, AACENC_SIGNALING_MODE,
247 s->signaling)) != AACENC_OK) {
248 av_log(avctx, AV_LOG_ERROR, "Unable to set signaling mode %d: %s\n",
249 s->signaling, aac_get_error(err));
253 if ((err = aacEncoder_SetParam(s->handle, AACENC_AFTERBURNER,
254 s->afterburner)) != AACENC_OK) {
255 av_log(avctx, AV_LOG_ERROR, "Unable to set afterburner to %d: %s\n",
256 s->afterburner, aac_get_error(err));
260 if (avctx->cutoff > 0) {
261 if (avctx->cutoff < (avctx->sample_rate + 255) >> 8 || avctx->cutoff > 20000) {
262 av_log(avctx, AV_LOG_ERROR, "cutoff valid range is %d-20000\n",
263 (avctx->sample_rate + 255) >> 8);
266 if ((err = aacEncoder_SetParam(s->handle, AACENC_BANDWIDTH,
267 avctx->cutoff)) != AACENC_OK) {
268 av_log(avctx, AV_LOG_ERROR, "Unable to set the encoder bandwidth to %d: %s\n",
269 avctx->cutoff, aac_get_error(err));
274 if ((err = aacEncEncode(s->handle, NULL, NULL, NULL, NULL)) != AACENC_OK) {
275 av_log(avctx, AV_LOG_ERROR, "Unable to initialize the encoder: %s\n",
277 return AVERROR(EINVAL);
280 if ((err = aacEncInfo(s->handle, &info)) != AACENC_OK) {
281 av_log(avctx, AV_LOG_ERROR, "Unable to get encoder info: %s\n",
286 avctx->frame_size = info.frameLength;
287 avctx->delay = info.encoderDelay;
288 ff_af_queue_init(avctx, &s->afq);
290 if (avctx->flags & CODEC_FLAG_GLOBAL_HEADER) {
291 avctx->extradata_size = info.confSize;
292 avctx->extradata = av_mallocz(avctx->extradata_size +
293 FF_INPUT_BUFFER_PADDING_SIZE);
294 if (!avctx->extradata) {
295 ret = AVERROR(ENOMEM);
299 memcpy(avctx->extradata, info.confBuf, info.confSize);
303 aac_encode_close(avctx);
307 static int aac_encode_frame(AVCodecContext *avctx, AVPacket *avpkt,
308 const AVFrame *frame, int *got_packet_ptr)
310 AACContext *s = avctx->priv_data;
311 AACENC_BufDesc in_buf = { 0 }, out_buf = { 0 };
312 AACENC_InArgs in_args = { 0 };
313 AACENC_OutArgs out_args = { 0 };
314 int in_buffer_identifier = IN_AUDIO_DATA;
315 int in_buffer_size, in_buffer_element_size;
316 int out_buffer_identifier = OUT_BITSTREAM_DATA;
317 int out_buffer_size, out_buffer_element_size;
318 void *in_ptr, *out_ptr;
322 /* handle end-of-stream small frame and flushing */
324 in_args.numInSamples = -1;
326 in_ptr = frame->data[0];
327 in_buffer_size = 2 * avctx->channels * frame->nb_samples;
328 in_buffer_element_size = 2;
330 in_args.numInSamples = avctx->channels * frame->nb_samples;
332 in_buf.bufs = &in_ptr;
333 in_buf.bufferIdentifiers = &in_buffer_identifier;
334 in_buf.bufSizes = &in_buffer_size;
335 in_buf.bufElSizes = &in_buffer_element_size;
337 /* add current frame to the queue */
338 if ((ret = ff_af_queue_add(&s->afq, frame)) < 0)
342 /* The maximum packet size is 6144 bits aka 768 bytes per channel. */
343 if ((ret = ff_alloc_packet2(avctx, avpkt, FFMAX(8192, 768 * avctx->channels))) < 0)
346 out_ptr = avpkt->data;
347 out_buffer_size = avpkt->size;
348 out_buffer_element_size = 1;
350 out_buf.bufs = &out_ptr;
351 out_buf.bufferIdentifiers = &out_buffer_identifier;
352 out_buf.bufSizes = &out_buffer_size;
353 out_buf.bufElSizes = &out_buffer_element_size;
355 if ((err = aacEncEncode(s->handle, &in_buf, &out_buf, &in_args,
356 &out_args)) != AACENC_OK) {
357 if (!frame && err == AACENC_ENCODE_EOF)
359 av_log(avctx, AV_LOG_ERROR, "Unable to encode frame: %s\n",
361 return AVERROR(EINVAL);
364 if (!out_args.numOutBytes)
367 /* Get the next frame pts & duration */
368 ff_af_queue_remove(&s->afq, avctx->frame_size, &avpkt->pts,
371 avpkt->size = out_args.numOutBytes;
376 static const AVProfile profiles[] = {
377 { FF_PROFILE_AAC_LOW, "LC" },
378 { FF_PROFILE_AAC_HE, "HE-AAC" },
379 { FF_PROFILE_AAC_HE_V2, "HE-AACv2" },
380 { FF_PROFILE_AAC_LD, "LD" },
381 { FF_PROFILE_AAC_ELD, "ELD" },
382 { FF_PROFILE_UNKNOWN },
385 static const AVCodecDefault aac_encode_defaults[] = {
390 static const uint64_t aac_channel_layout[] = {
393 AV_CH_LAYOUT_SURROUND,
394 AV_CH_LAYOUT_4POINT0,
395 AV_CH_LAYOUT_5POINT0_BACK,
396 AV_CH_LAYOUT_5POINT1_BACK,
397 AV_CH_LAYOUT_7POINT1_WIDE_BACK,
398 AV_CH_LAYOUT_7POINT1,
402 static const int aac_sample_rates[] = {
403 96000, 88200, 64000, 48000, 44100, 32000,
404 24000, 22050, 16000, 12000, 11025, 8000, 0
407 AVCodec ff_libfdk_aac_encoder = {
408 .name = "libfdk_aac",
409 .long_name = NULL_IF_CONFIG_SMALL("Fraunhofer FDK AAC"),
410 .type = AVMEDIA_TYPE_AUDIO,
411 .id = AV_CODEC_ID_AAC,
412 .priv_data_size = sizeof(AACContext),
413 .init = aac_encode_init,
414 .encode2 = aac_encode_frame,
415 .close = aac_encode_close,
416 .capabilities = CODEC_CAP_SMALL_LAST_FRAME | CODEC_CAP_DELAY,
417 .sample_fmts = (const enum AVSampleFormat[]){ AV_SAMPLE_FMT_S16,
418 AV_SAMPLE_FMT_NONE },
419 .priv_class = &aac_enc_class,
420 .defaults = aac_encode_defaults,
421 .profiles = profiles,
422 .supported_samplerates = aac_sample_rates,
423 .channel_layouts = aac_channel_layout,