libfdk-aac: Warn the user that the VBR modes are unsupported
[libav.git] / libavcodec / libfdk-aacenc.c
CommitLineData
37eeb5e2
MS
1/*
2 * AAC encoder wrapper
3 * Copyright (c) 2012 Martin Storsjo
4 *
5 * This file is part of Libav.
6 *
7 * Libav 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 * Libav 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 Libav; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20 */
21
22#include <fdk-aac/aacenc_lib.h>
23
24#include "avcodec.h"
25#include "audio_frame_queue.h"
26#include "internal.h"
27#include "libavutil/audioconvert.h"
1d9c2dc8 28#include "libavutil/common.h"
37eeb5e2
MS
29#include "libavutil/opt.h"
30
31typedef struct AACContext {
32 const AVClass *class;
33 HANDLE_AACENCODER handle;
34 int afterburner;
35 int eld_sbr;
36 int signaling;
160a27c5
KK
37 int latm;
38 int header_period;
37eeb5e2
MS
39
40 AudioFrameQueue afq;
41} AACContext;
42
43static const AVOption aac_enc_options[] = {
e6153f17
MS
44 { "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 },
45 { "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 },
46 { "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" },
124134e4
MS
47 { "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" },
48 { "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" },
49 { "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" },
50 { "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" },
e6153f17
MS
51 { "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 },
52 { "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 },
37eeb5e2
MS
53 { NULL }
54};
55
56static const AVClass aac_enc_class = {
57 "libfdk_aac", av_default_item_name, aac_enc_options, LIBAVUTIL_VERSION_INT
58};
59
60static const char *aac_get_error(AACENC_ERROR err)
61{
62 switch (err) {
63 case AACENC_OK:
64 return "No error";
65 case AACENC_INVALID_HANDLE:
66 return "Invalid handle";
67 case AACENC_MEMORY_ERROR:
68 return "Memory allocation error";
69 case AACENC_UNSUPPORTED_PARAMETER:
70 return "Unsupported parameter";
71 case AACENC_INVALID_CONFIG:
72 return "Invalid config";
73 case AACENC_INIT_ERROR:
74 return "Initialization error";
75 case AACENC_INIT_AAC_ERROR:
76 return "AAC library initialization error";
77 case AACENC_INIT_SBR_ERROR:
78 return "SBR library initialization error";
79 case AACENC_INIT_TP_ERROR:
80 return "Transport library initialization error";
81 case AACENC_INIT_META_ERROR:
82 return "Metadata library initialization error";
83 case AACENC_ENCODE_ERROR:
84 return "Encoding error";
85 case AACENC_ENCODE_EOF:
86 return "End of file";
87 default:
88 return "Unknown error";
89 }
90}
91
92static int aac_encode_close(AVCodecContext *avctx)
93{
94 AACContext *s = avctx->priv_data;
95
96 if (s->handle)
97 aacEncClose(&s->handle);
98#if FF_API_OLD_ENCODE_AUDIO
99 av_freep(&avctx->coded_frame);
100#endif
101 av_freep(&avctx->extradata);
102 ff_af_queue_close(&s->afq);
103
104 return 0;
105}
106
107static av_cold int aac_encode_init(AVCodecContext *avctx)
108{
109 AACContext *s = avctx->priv_data;
110 int ret = AVERROR(EINVAL);
111 AACENC_InfoStruct info = { 0 };
112 CHANNEL_MODE mode;
113 AACENC_ERROR err;
114 int aot = FF_PROFILE_AAC_LOW + 1;
115 int sce = 0, cpe = 0;
116
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",
119 aac_get_error(err));
120 goto error;
121 }
122
123 if (avctx->profile != FF_PROFILE_UNKNOWN)
124 aot = avctx->profile + 1;
125
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));
129 goto error;
130 }
131
132 if (aot == FF_PROFILE_AAC_ELD + 1 && s->eld_sbr) {
133 if ((err = aacEncoder_SetParam(s->handle, AACENC_SBR_MODE,
134 1)) != AACENC_OK) {
135 av_log(avctx, AV_LOG_ERROR, "Unable to enable SBR for ELD: %s\n",
136 aac_get_error(err));
137 goto error;
138 }
139 }
140
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));
145 goto error;
146 }
147
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 default:
156 av_log(avctx, AV_LOG_ERROR,
157 "Unsupported number of channels %d\n", avctx->channels);
158 goto error;
159 }
160
161 if ((err = aacEncoder_SetParam(s->handle, AACENC_CHANNELMODE,
162 mode)) != AACENC_OK) {
163 av_log(avctx, AV_LOG_ERROR,
164 "Unable to set channel mode %d: %s\n", mode, aac_get_error(err));
165 goto error;
166 }
167
168 if ((err = aacEncoder_SetParam(s->handle, AACENC_CHANNELORDER,
169 1)) != AACENC_OK) {
170 av_log(avctx, AV_LOG_ERROR,
171 "Unable to set wav channel order %d: %s\n",
172 mode, aac_get_error(err));
173 goto error;
174 }
175
176 if (avctx->flags & CODEC_FLAG_QSCALE) {
177 int mode = avctx->global_quality;
178 if (mode < 1 || mode > 5) {
179 av_log(avctx, AV_LOG_WARNING,
180 "VBR quality %d out of range, should be 1-5\n", mode);
181 mode = av_clip(mode, 1, 5);
182 }
a10190dc
MS
183 av_log(avctx, AV_LOG_WARNING,
184 "Note, the VBR setting is unsupported and only works with "
185 "some parameter combinations\n");
37eeb5e2
MS
186 if ((err = aacEncoder_SetParam(s->handle, AACENC_BITRATEMODE,
187 mode)) != AACENC_OK) {
188 av_log(avctx, AV_LOG_ERROR, "Unable to set the VBR bitrate mode %d: %s\n",
189 mode, aac_get_error(err));
190 goto error;
191 }
192 } else {
193 if (avctx->bit_rate <= 0) {
194 if (avctx->profile == FF_PROFILE_AAC_HE_V2) {
195 sce = 1;
196 cpe = 0;
197 }
198 avctx->bit_rate = (96*sce + 128*cpe) * avctx->sample_rate / 44;
199 if (avctx->profile == FF_PROFILE_AAC_HE ||
200 avctx->profile == FF_PROFILE_AAC_HE_V2 ||
201 s->eld_sbr)
202 avctx->bit_rate /= 2;
203 }
204 if ((err = aacEncoder_SetParam(s->handle, AACENC_BITRATE,
205 avctx->bit_rate)) != AACENC_OK) {
206 av_log(avctx, AV_LOG_ERROR, "Unable to set the bitrate %d: %s\n",
207 avctx->bit_rate, aac_get_error(err));
208 goto error;
209 }
210 }
211
212 /* Choose bitstream format - if global header is requested, use
213 * raw access units, otherwise use ADTS. */
214 if ((err = aacEncoder_SetParam(s->handle, AACENC_TRANSMUX,
160a27c5 215 avctx->flags & CODEC_FLAG_GLOBAL_HEADER ? 0 : s->latm ? 10 : 2)) != AACENC_OK) {
37eeb5e2
MS
216 av_log(avctx, AV_LOG_ERROR, "Unable to set the transmux format: %s\n",
217 aac_get_error(err));
218 goto error;
219 }
220
160a27c5
KK
221 if (s->latm && s->header_period) {
222 if ((err = aacEncoder_SetParam(s->handle, AACENC_HEADER_PERIOD,
223 s->header_period)) != AACENC_OK) {
224 av_log(avctx, AV_LOG_ERROR, "Unable to set header period: %s\n",
225 aac_get_error(err));
226 goto error;
227 }
228 }
229
37eeb5e2
MS
230 /* If no signaling mode is chosen, use explicit hierarchical signaling
231 * if using mp4 mode (raw access units, with global header) and
232 * implicit signaling if using ADTS. */
233 if (s->signaling < 0)
234 s->signaling = avctx->flags & CODEC_FLAG_GLOBAL_HEADER ? 2 : 0;
235
236 if ((err = aacEncoder_SetParam(s->handle, AACENC_SIGNALING_MODE,
237 s->signaling)) != AACENC_OK) {
238 av_log(avctx, AV_LOG_ERROR, "Unable to set signaling mode %d: %s\n",
239 s->signaling, aac_get_error(err));
240 goto error;
241 }
242
243 if ((err = aacEncoder_SetParam(s->handle, AACENC_AFTERBURNER,
244 s->afterburner)) != AACENC_OK) {
245 av_log(avctx, AV_LOG_ERROR, "Unable to set afterburner to %d: %s\n",
246 s->afterburner, aac_get_error(err));
247 goto error;
248 }
249
7548831c 250 if (avctx->cutoff > 0) {
c37c383e
MA
251 if (avctx->cutoff < (avctx->sample_rate + 255) >> 8) {
252 av_log(avctx, AV_LOG_ERROR, "cutoff valid range is %d-20000\n",
253 (avctx->sample_rate + 255) >> 8);
254 goto error;
255 }
7548831c
MS
256 if ((err = aacEncoder_SetParam(s->handle, AACENC_BANDWIDTH,
257 avctx->cutoff)) != AACENC_OK) {
258 av_log(avctx, AV_LOG_ERROR, "Unable to set the encoder bandwith to %d: %s\n",
259 avctx->cutoff, aac_get_error(err));
260 goto error;
261 }
262 }
263
37eeb5e2
MS
264 if ((err = aacEncEncode(s->handle, NULL, NULL, NULL, NULL)) != AACENC_OK) {
265 av_log(avctx, AV_LOG_ERROR, "Unable to initialize the encoder: %s\n",
266 aac_get_error(err));
267 return AVERROR(EINVAL);
268 }
269
270 if ((err = aacEncInfo(s->handle, &info)) != AACENC_OK) {
271 av_log(avctx, AV_LOG_ERROR, "Unable to get encoder info: %s\n",
272 aac_get_error(err));
273 goto error;
274 }
275
276#if FF_API_OLD_ENCODE_AUDIO
277 avctx->coded_frame = avcodec_alloc_frame();
278 if (!avctx->coded_frame) {
279 ret = AVERROR(ENOMEM);
280 goto error;
281 }
282#endif
283 avctx->frame_size = info.frameLength;
284 avctx->delay = info.encoderDelay;
285 ff_af_queue_init(avctx, &s->afq);
286
287 if (avctx->flags & CODEC_FLAG_GLOBAL_HEADER) {
288 avctx->extradata_size = info.confSize;
289 avctx->extradata = av_mallocz(avctx->extradata_size +
290 FF_INPUT_BUFFER_PADDING_SIZE);
291 if (!avctx->extradata) {
292 ret = AVERROR(ENOMEM);
293 goto error;
294 }
295
296 memcpy(avctx->extradata, info.confBuf, info.confSize);
297 }
298 return 0;
299error:
300 aac_encode_close(avctx);
301 return ret;
302}
303
304static int aac_encode_frame(AVCodecContext *avctx, AVPacket *avpkt,
305 const AVFrame *frame, int *got_packet_ptr)
306{
307 AACContext *s = avctx->priv_data;
308 AACENC_BufDesc in_buf = { 0 }, out_buf = { 0 };
309 AACENC_InArgs in_args = { 0 };
310 AACENC_OutArgs out_args = { 0 };
311 int in_buffer_identifier = IN_AUDIO_DATA;
312 int in_buffer_size, in_buffer_element_size;
313 int out_buffer_identifier = OUT_BITSTREAM_DATA;
314 int out_buffer_size, out_buffer_element_size;
315 void *in_ptr, *out_ptr;
316 int ret;
317 AACENC_ERROR err;
318
319 /* handle end-of-stream small frame and flushing */
320 if (!frame) {
321 in_args.numInSamples = -1;
322 } else {
323 in_ptr = frame->data[0];
324 in_buffer_size = 2 * avctx->channels * frame->nb_samples;
325 in_buffer_element_size = 2;
326
327 in_args.numInSamples = avctx->channels * frame->nb_samples;
328 in_buf.numBufs = 1;
329 in_buf.bufs = &in_ptr;
330 in_buf.bufferIdentifiers = &in_buffer_identifier;
331 in_buf.bufSizes = &in_buffer_size;
332 in_buf.bufElSizes = &in_buffer_element_size;
333
334 /* add current frame to the queue */
335 if ((ret = ff_af_queue_add(&s->afq, frame) < 0))
336 return ret;
337 }
338
339 /* The maximum packet size is 6144 bits aka 768 bytes per channel. */
340 if ((ret = ff_alloc_packet(avpkt, FFMAX(8192, 768 * avctx->channels)))) {
341 av_log(avctx, AV_LOG_ERROR, "Error getting output packet\n");
342 return ret;
343 }
344
345 out_ptr = avpkt->data;
346 out_buffer_size = avpkt->size;
347 out_buffer_element_size = 1;
348 out_buf.numBufs = 1;
349 out_buf.bufs = &out_ptr;
350 out_buf.bufferIdentifiers = &out_buffer_identifier;
351 out_buf.bufSizes = &out_buffer_size;
352 out_buf.bufElSizes = &out_buffer_element_size;
353
354 if ((err = aacEncEncode(s->handle, &in_buf, &out_buf, &in_args,
355 &out_args)) != AACENC_OK) {
356 if (!frame && err == AACENC_ENCODE_EOF)
357 return 0;
358 av_log(avctx, AV_LOG_ERROR, "Unable to encode frame: %s\n",
359 aac_get_error(err));
360 return AVERROR(EINVAL);
361 }
362
363 if (!out_args.numOutBytes)
364 return 0;
365
366 /* Get the next frame pts & duration */
367 ff_af_queue_remove(&s->afq, avctx->frame_size, &avpkt->pts,
368 &avpkt->duration);
369
370 avpkt->size = out_args.numOutBytes;
371 *got_packet_ptr = 1;
372 return 0;
373}
374
375static const AVProfile profiles[] = {
376 { FF_PROFILE_AAC_LOW, "LC" },
377 { FF_PROFILE_AAC_HE, "HE-AAC" },
378 { FF_PROFILE_AAC_HE_V2, "HE-AACv2" },
379 { FF_PROFILE_AAC_LD, "LD" },
380 { FF_PROFILE_AAC_ELD, "ELD" },
381 { FF_PROFILE_UNKNOWN },
382};
383
384static const AVCodecDefault aac_encode_defaults[] = {
385 { "b", "0" },
386 { NULL }
387};
388
389static const uint64_t aac_channel_layout[] = {
390 AV_CH_LAYOUT_MONO,
391 AV_CH_LAYOUT_STEREO,
392 AV_CH_LAYOUT_SURROUND,
393 AV_CH_LAYOUT_4POINT0,
394 AV_CH_LAYOUT_5POINT0_BACK,
395 AV_CH_LAYOUT_5POINT1_BACK,
396 0,
397};
398
94a69dee
NC
399static const int aac_sample_rates[] = {
400 96000, 88200, 64000, 48000, 44100, 32000,
401 24000, 22050, 16000, 12000, 11025, 8000, 0
402};
403
37eeb5e2 404AVCodec ff_libfdk_aac_encoder = {
c8ba8be2
NC
405 .name = "libfdk_aac",
406 .type = AVMEDIA_TYPE_AUDIO,
407 .id = AV_CODEC_ID_AAC,
408 .priv_data_size = sizeof(AACContext),
409 .init = aac_encode_init,
410 .encode2 = aac_encode_frame,
411 .close = aac_encode_close,
412 .capabilities = CODEC_CAP_SMALL_LAST_FRAME | CODEC_CAP_DELAY,
413 .sample_fmts = (const enum AVSampleFormat[]){ AV_SAMPLE_FMT_S16,
414 AV_SAMPLE_FMT_NONE },
415 .long_name = NULL_IF_CONFIG_SMALL("Fraunhofer FDK AAC"),
416 .priv_class = &aac_enc_class,
417 .defaults = aac_encode_defaults,
418 .profiles = profiles,
94a69dee 419 .supported_samplerates = aac_sample_rates,
c8ba8be2 420 .channel_layouts = aac_channel_layout,
37eeb5e2 421};