libfdk-aac: Limit to supported sample rates.
[ffmpeg.git] / libavcodec / libfdk-aacenc.c
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"
28 #include "libavutil/common.h"
29 #include "libavutil/opt.h"
30
31 typedef struct AACContext {
32     const AVClass *class;
33     HANDLE_AACENCODER handle;
34     int afterburner;
35     int eld_sbr;
36     int signaling;
37     int latm;
38     int header_period;
39
40     AudioFrameQueue afq;
41 } AACContext;
42
43 static const AVOption aac_enc_options[] = {
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" },
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" },
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 },
53     { NULL }
54 };
55
56 static const AVClass aac_enc_class = {
57     "libfdk_aac", av_default_item_name, aac_enc_options, LIBAVUTIL_VERSION_INT
58 };
59
60 static 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
92 static 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
107 static 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         }
183         if ((err = aacEncoder_SetParam(s->handle, AACENC_BITRATEMODE,
184                                        mode)) != AACENC_OK) {
185             av_log(avctx, AV_LOG_ERROR, "Unable to set the VBR bitrate mode %d: %s\n",
186                    mode, aac_get_error(err));
187             goto error;
188         }
189     } else {
190         if (avctx->bit_rate <= 0) {
191             if (avctx->profile == FF_PROFILE_AAC_HE_V2) {
192                 sce = 1;
193                 cpe = 0;
194             }
195             avctx->bit_rate = (96*sce + 128*cpe) * avctx->sample_rate / 44;
196             if (avctx->profile == FF_PROFILE_AAC_HE ||
197                 avctx->profile == FF_PROFILE_AAC_HE_V2 ||
198                 s->eld_sbr)
199                 avctx->bit_rate /= 2;
200         }
201         if ((err = aacEncoder_SetParam(s->handle, AACENC_BITRATE,
202                                        avctx->bit_rate)) != AACENC_OK) {
203             av_log(avctx, AV_LOG_ERROR, "Unable to set the bitrate %d: %s\n",
204                    avctx->bit_rate, aac_get_error(err));
205             goto error;
206         }
207     }
208
209     /* Choose bitstream format - if global header is requested, use
210      * raw access units, otherwise use ADTS. */
211     if ((err = aacEncoder_SetParam(s->handle, AACENC_TRANSMUX,
212                                    avctx->flags & CODEC_FLAG_GLOBAL_HEADER ? 0 : s->latm ? 10 : 2)) != AACENC_OK) {
213         av_log(avctx, AV_LOG_ERROR, "Unable to set the transmux format: %s\n",
214                aac_get_error(err));
215         goto error;
216     }
217
218     if (s->latm && s->header_period) {
219         if ((err = aacEncoder_SetParam(s->handle, AACENC_HEADER_PERIOD,
220                                        s->header_period)) != AACENC_OK) {
221              av_log(avctx, AV_LOG_ERROR, "Unable to set header period: %s\n",
222                     aac_get_error(err));
223              goto error;
224         }
225     }
226
227     /* If no signaling mode is chosen, use explicit hierarchical signaling
228      * if using mp4 mode (raw access units, with global header) and
229      * implicit signaling if using ADTS. */
230     if (s->signaling < 0)
231         s->signaling = avctx->flags & CODEC_FLAG_GLOBAL_HEADER ? 2 : 0;
232
233     if ((err = aacEncoder_SetParam(s->handle, AACENC_SIGNALING_MODE,
234                                    s->signaling)) != AACENC_OK) {
235         av_log(avctx, AV_LOG_ERROR, "Unable to set signaling mode %d: %s\n",
236                s->signaling, aac_get_error(err));
237         goto error;
238     }
239
240     if ((err = aacEncoder_SetParam(s->handle, AACENC_AFTERBURNER,
241                                    s->afterburner)) != AACENC_OK) {
242         av_log(avctx, AV_LOG_ERROR, "Unable to set afterburner to %d: %s\n",
243                s->afterburner, aac_get_error(err));
244         goto error;
245     }
246
247     if (avctx->cutoff > 0) {
248         if (avctx->cutoff < (avctx->sample_rate + 255) >> 8) {
249             av_log(avctx, AV_LOG_ERROR, "cutoff valid range is %d-20000\n",
250                    (avctx->sample_rate + 255) >> 8);
251             goto error;
252         }
253         if ((err = aacEncoder_SetParam(s->handle, AACENC_BANDWIDTH,
254                                        avctx->cutoff)) != AACENC_OK) {
255             av_log(avctx, AV_LOG_ERROR, "Unable to set the encoder bandwith to %d: %s\n",
256                    avctx->cutoff, aac_get_error(err));
257             goto error;
258         }
259     }
260
261     if ((err = aacEncEncode(s->handle, NULL, NULL, NULL, NULL)) != AACENC_OK) {
262         av_log(avctx, AV_LOG_ERROR, "Unable to initialize the encoder: %s\n",
263                aac_get_error(err));
264         return AVERROR(EINVAL);
265     }
266
267     if ((err = aacEncInfo(s->handle, &info)) != AACENC_OK) {
268         av_log(avctx, AV_LOG_ERROR, "Unable to get encoder info: %s\n",
269                aac_get_error(err));
270         goto error;
271     }
272
273 #if FF_API_OLD_ENCODE_AUDIO
274     avctx->coded_frame = avcodec_alloc_frame();
275     if (!avctx->coded_frame) {
276         ret = AVERROR(ENOMEM);
277         goto error;
278     }
279 #endif
280     avctx->frame_size = info.frameLength;
281     avctx->delay      = info.encoderDelay;
282     ff_af_queue_init(avctx, &s->afq);
283
284     if (avctx->flags & CODEC_FLAG_GLOBAL_HEADER) {
285         avctx->extradata_size = info.confSize;
286         avctx->extradata      = av_mallocz(avctx->extradata_size +
287                                            FF_INPUT_BUFFER_PADDING_SIZE);
288         if (!avctx->extradata) {
289             ret = AVERROR(ENOMEM);
290             goto error;
291         }
292
293         memcpy(avctx->extradata, info.confBuf, info.confSize);
294     }
295     return 0;
296 error:
297     aac_encode_close(avctx);
298     return ret;
299 }
300
301 static int aac_encode_frame(AVCodecContext *avctx, AVPacket *avpkt,
302                             const AVFrame *frame, int *got_packet_ptr)
303 {
304     AACContext    *s        = avctx->priv_data;
305     AACENC_BufDesc in_buf   = { 0 }, out_buf = { 0 };
306     AACENC_InArgs  in_args  = { 0 };
307     AACENC_OutArgs out_args = { 0 };
308     int in_buffer_identifier = IN_AUDIO_DATA;
309     int in_buffer_size, in_buffer_element_size;
310     int out_buffer_identifier = OUT_BITSTREAM_DATA;
311     int out_buffer_size, out_buffer_element_size;
312     void *in_ptr, *out_ptr;
313     int ret;
314     AACENC_ERROR err;
315
316     /* handle end-of-stream small frame and flushing */
317     if (!frame) {
318         in_args.numInSamples = -1;
319     } else {
320         in_ptr                   = frame->data[0];
321         in_buffer_size           = 2 * avctx->channels * frame->nb_samples;
322         in_buffer_element_size   = 2;
323
324         in_args.numInSamples     = avctx->channels * frame->nb_samples;
325         in_buf.numBufs           = 1;
326         in_buf.bufs              = &in_ptr;
327         in_buf.bufferIdentifiers = &in_buffer_identifier;
328         in_buf.bufSizes          = &in_buffer_size;
329         in_buf.bufElSizes        = &in_buffer_element_size;
330
331         /* add current frame to the queue */
332         if ((ret = ff_af_queue_add(&s->afq, frame) < 0))
333             return ret;
334     }
335
336     /* The maximum packet size is 6144 bits aka 768 bytes per channel. */
337     if ((ret = ff_alloc_packet(avpkt, FFMAX(8192, 768 * avctx->channels)))) {
338         av_log(avctx, AV_LOG_ERROR, "Error getting output packet\n");
339         return ret;
340     }
341
342     out_ptr                   = avpkt->data;
343     out_buffer_size           = avpkt->size;
344     out_buffer_element_size   = 1;
345     out_buf.numBufs           = 1;
346     out_buf.bufs              = &out_ptr;
347     out_buf.bufferIdentifiers = &out_buffer_identifier;
348     out_buf.bufSizes          = &out_buffer_size;
349     out_buf.bufElSizes        = &out_buffer_element_size;
350
351     if ((err = aacEncEncode(s->handle, &in_buf, &out_buf, &in_args,
352                             &out_args)) != AACENC_OK) {
353         if (!frame && err == AACENC_ENCODE_EOF)
354             return 0;
355         av_log(avctx, AV_LOG_ERROR, "Unable to encode frame: %s\n",
356                aac_get_error(err));
357         return AVERROR(EINVAL);
358     }
359
360     if (!out_args.numOutBytes)
361         return 0;
362
363     /* Get the next frame pts & duration */
364     ff_af_queue_remove(&s->afq, avctx->frame_size, &avpkt->pts,
365                        &avpkt->duration);
366
367     avpkt->size     = out_args.numOutBytes;
368     *got_packet_ptr = 1;
369     return 0;
370 }
371
372 static const AVProfile profiles[] = {
373     { FF_PROFILE_AAC_LOW,   "LC"       },
374     { FF_PROFILE_AAC_HE,    "HE-AAC"   },
375     { FF_PROFILE_AAC_HE_V2, "HE-AACv2" },
376     { FF_PROFILE_AAC_LD,    "LD"       },
377     { FF_PROFILE_AAC_ELD,   "ELD"      },
378     { FF_PROFILE_UNKNOWN },
379 };
380
381 static const AVCodecDefault aac_encode_defaults[] = {
382     { "b", "0" },
383     { NULL }
384 };
385
386 static const uint64_t aac_channel_layout[] = {
387     AV_CH_LAYOUT_MONO,
388     AV_CH_LAYOUT_STEREO,
389     AV_CH_LAYOUT_SURROUND,
390     AV_CH_LAYOUT_4POINT0,
391     AV_CH_LAYOUT_5POINT0_BACK,
392     AV_CH_LAYOUT_5POINT1_BACK,
393     0,
394 };
395
396 static const int aac_sample_rates[] = {
397     96000, 88200, 64000, 48000, 44100, 32000,
398     24000, 22050, 16000, 12000, 11025, 8000, 0
399 };
400
401 AVCodec ff_libfdk_aac_encoder = {
402     .name            = "libfdk_aac",
403     .type            = AVMEDIA_TYPE_AUDIO,
404     .id              = AV_CODEC_ID_AAC,
405     .priv_data_size  = sizeof(AACContext),
406     .init            = aac_encode_init,
407     .encode2         = aac_encode_frame,
408     .close           = aac_encode_close,
409     .capabilities    = CODEC_CAP_SMALL_LAST_FRAME | CODEC_CAP_DELAY,
410     .sample_fmts     = (const enum AVSampleFormat[]){ AV_SAMPLE_FMT_S16,
411                                                       AV_SAMPLE_FMT_NONE },
412     .long_name       = NULL_IF_CONFIG_SMALL("Fraunhofer FDK AAC"),
413     .priv_class      = &aac_enc_class,
414     .defaults        = aac_encode_defaults,
415     .profiles        = profiles,
416     .supported_samplerates = aac_sample_rates,
417     .channel_layouts = aac_channel_layout,
418 };