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