git.sesse.net Git - ffmpeg/blob - 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  * 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.
  10  *
  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.
  18  */
  19
  20 #include <fdk-aac/aacenc_lib.h>
  21
  22 #include "libavutil/channel_layout.h"
  23 #include "libavutil/common.h"
  24 #include "libavutil/opt.h"
  25 #include "avcodec.h"
  26 #include "audio_frame_queue.h"
  27 #include "internal.h"
  28
  29 #define FDKENC_VER_AT_LEAST(vl0, vl1) \
  30     (defined(AACENCODER_LIB_VL0) && \
  31         ((AACENCODER_LIB_VL0 > vl0) || \
  32          (AACENCODER_LIB_VL0 == vl0 && AACENCODER_LIB_VL1 >= vl1)))
  33
  34 typedef struct AACContext {
  35     const AVClass *class;
  36     HANDLE_AACENCODER handle;
  37     int afterburner;
  38     int eld_sbr;
  39     int eld_v2;
  40     int signaling;
  41     int latm;
  42     int header_period;
  43     int vbr;
  44
  45     AudioFrameQueue afq;
  46 } AACContext;
  47
  48 static const AVOption aac_enc_options[] = {
  49     { "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 },
  50     { "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 },
  51 #if FDKENC_VER_AT_LEAST(4, 0) // 4.0.0
  52     { "eld_v2", "Enable ELDv2 (LD-MPS extension for ELD stereo signals)", offsetof(AACContext, eld_v2), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, AV_OPT_FLAG_AUDIO_PARAM | AV_OPT_FLAG_ENCODING_PARAM },
  53 #endif
  54     { "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" },
  55     { "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" },
  56     { "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" },
  57     { "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" },
  58     { "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" },
  59     { "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 },
  60     { "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 },
  61     { "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 },
  62     { NULL }
  63 };
  64
  65 static const AVClass aac_enc_class = {
  66     .class_name = "libfdk_aac",
  67     .item_name  = av_default_item_name,
  68     .option     = aac_enc_options,
  69     .version    = LIBAVUTIL_VERSION_INT,
  70 };
  71
  72 static const char *aac_get_error(AACENC_ERROR err)
  73 {
  74     switch (err) {
  75     case AACENC_OK:
  76         return "No error";
  77     case AACENC_INVALID_HANDLE:
  78         return "Invalid handle";
  79     case AACENC_MEMORY_ERROR:
  80         return "Memory allocation error";
  81     case AACENC_UNSUPPORTED_PARAMETER:
  82         return "Unsupported parameter";
  83     case AACENC_INVALID_CONFIG:
  84         return "Invalid config";
  85     case AACENC_INIT_ERROR:
  86         return "Initialization error";
  87     case AACENC_INIT_AAC_ERROR:
  88         return "AAC library initialization error";
  89     case AACENC_INIT_SBR_ERROR:
  90         return "SBR library initialization error";
  91     case AACENC_INIT_TP_ERROR:
  92         return "Transport library initialization error";
  93     case AACENC_INIT_META_ERROR:
  94         return "Metadata library initialization error";
  95     case AACENC_ENCODE_ERROR:
  96         return "Encoding error";
  97     case AACENC_ENCODE_EOF:
  98         return "End of file";
  99     default:
 100         return "Unknown error";
 101     }
 102 }
 103
 104 static int aac_encode_close(AVCodecContext *avctx)
 105 {
 106     AACContext *s = avctx->priv_data;
 107
 108     if (s->handle)
 109         aacEncClose(&s->handle);
 110     av_freep(&avctx->extradata);
 111     ff_af_queue_close(&s->afq);
 112
 113     return 0;
 114 }
 115
 116 static av_cold int aac_encode_init(AVCodecContext *avctx)
 117 {
 118     AACContext *s = avctx->priv_data;
 119     int ret = AVERROR(EINVAL);
 120     AACENC_InfoStruct info = { 0 };
 121     CHANNEL_MODE mode;
 122     AACENC_ERROR err;
 123     int aot = FF_PROFILE_AAC_LOW + 1;
 124     int sce = 0, cpe = 0;
 125
 126     if ((err = aacEncOpen(&s->handle, 0, avctx->channels)) != AACENC_OK) {
 127         av_log(avctx, AV_LOG_ERROR, "Unable to open the encoder: %s\n",
 128                aac_get_error(err));
 129         goto error;
 130     }
 131
 132     if (avctx->profile != FF_PROFILE_UNKNOWN)
 133         aot = avctx->profile + 1;
 134
 135     if ((err = aacEncoder_SetParam(s->handle, AACENC_AOT, aot)) != AACENC_OK) {
 136         av_log(avctx, AV_LOG_ERROR, "Unable to set the AOT %d: %s\n",
 137                aot, aac_get_error(err));
 138         goto error;
 139     }
 140
 141     if (aot == FF_PROFILE_AAC_ELD + 1 && s->eld_sbr) {
 142         if ((err = aacEncoder_SetParam(s->handle, AACENC_SBR_MODE,
 143                                        1)) != AACENC_OK) {
 144             av_log(avctx, AV_LOG_ERROR, "Unable to enable SBR for ELD: %s\n",
 145                    aac_get_error(err));
 146             goto error;
 147         }
 148     }
 149
 150     if ((err = aacEncoder_SetParam(s->handle, AACENC_SAMPLERATE,
 151                                    avctx->sample_rate)) != AACENC_OK) {
 152         av_log(avctx, AV_LOG_ERROR, "Unable to set the sample rate %d: %s\n",
 153                avctx->sample_rate, aac_get_error(err));
 154         goto error;
 155     }
 156
 157     switch (avctx->channels) {
 158     case 1: mode = MODE_1;       sce = 1; cpe = 0; break;
 159     case 2:
 160 #if FDKENC_VER_AT_LEAST(4, 0) // 4.0.0
 161       // (profile + 1) to map from profile range to AOT range
 162       if (aot == FF_PROFILE_AAC_ELD + 1 && s->eld_v2) {
 163           if ((err = aacEncoder_SetParam(s->handle, AACENC_CHANNELMODE,
 164                                          128)) != AACENC_OK) {
 165               av_log(avctx, AV_LOG_ERROR, "Unable to enable ELDv2: %s\n",
 166                      aac_get_error(err));
 167               goto error;
 168           } else {
 169             mode = MODE_212;
 170             sce = 1;
 171             cpe = 0;
 172           }
 173       } else
 174 #endif
 175       {
 176         mode = MODE_2;
 177         sce = 0;
 178         cpe = 1;
 179       }
 180       break;
 181     case 3: mode = MODE_1_2;     sce = 1; cpe = 1; break;
 182     case 4: mode = MODE_1_2_1;   sce = 2; cpe = 1; break;
 183     case 5: mode = MODE_1_2_2;   sce = 1; cpe = 2; break;
 184     case 6: mode = MODE_1_2_2_1; sce = 2; cpe = 2; break;
 185 /* The version macro is introduced the same time as the 7.1 support, so this
 186    should suffice. */
 187 #if FDKENC_VER_AT_LEAST(3, 4) // 3.4.12
 188     case 8:
 189         sce = 2;
 190         cpe = 3;
 191         if (avctx->channel_layout == AV_CH_LAYOUT_7POINT1) {
 192             mode = MODE_7_1_REAR_SURROUND;
 193         } else {
 194             // MODE_1_2_2_2_1 and MODE_7_1_FRONT_CENTER use the same channel layout
 195             mode = MODE_7_1_FRONT_CENTER;
 196         }
 197         break;
 198 #endif
 199     default:
 200         av_log(avctx, AV_LOG_ERROR,
 201                "Unsupported number of channels %d\n", avctx->channels);
 202         goto error;
 203     }
 204
 205     if ((err = aacEncoder_SetParam(s->handle, AACENC_CHANNELMODE,
 206                                    mode)) != AACENC_OK) {
 207         av_log(avctx, AV_LOG_ERROR,
 208                "Unable to set channel mode %d: %s\n", mode, aac_get_error(err));
 209         goto error;
 210     }
 211
 212     if ((err = aacEncoder_SetParam(s->handle, AACENC_CHANNELORDER,
 213                                    1)) != AACENC_OK) {
 214         av_log(avctx, AV_LOG_ERROR,
 215                "Unable to set wav channel order %d: %s\n",
 216                mode, aac_get_error(err));
 217         goto error;
 218     }
 219
 220     if (avctx->flags & AV_CODEC_FLAG_QSCALE || s->vbr) {
 221         int mode = s->vbr ? s->vbr : avctx->global_quality;
 222         if (mode <  1 || mode > 5) {
 223             av_log(avctx, AV_LOG_WARNING,
 224                    "VBR quality %d out of range, should be 1-5\n", mode);
 225             mode = av_clip(mode, 1, 5);
 226         }
 227         av_log(avctx, AV_LOG_WARNING,
 228                "Note, the VBR setting is unsupported and only works with "
 229                "some parameter combinations\n");
 230         if ((err = aacEncoder_SetParam(s->handle, AACENC_BITRATEMODE,
 231                                        mode)) != AACENC_OK) {
 232             av_log(avctx, AV_LOG_ERROR, "Unable to set the VBR bitrate mode %d: %s\n",
 233                    mode, aac_get_error(err));
 234             goto error;
 235         }
 236     } else {
 237         if (avctx->bit_rate <= 0) {
 238             if (avctx->profile == FF_PROFILE_AAC_HE_V2) {
 239                 sce = 1;
 240                 cpe = 0;
 241             }
 242             avctx->bit_rate = (96*sce + 128*cpe) * avctx->sample_rate / 44;
 243             if (avctx->profile == FF_PROFILE_AAC_HE ||
 244                 avctx->profile == FF_PROFILE_AAC_HE_V2 ||
 245                 avctx->profile == FF_PROFILE_MPEG2_AAC_HE ||
 246                 s->eld_sbr)
 247                 avctx->bit_rate /= 2;
 248         }
 249         if ((err = aacEncoder_SetParam(s->handle, AACENC_BITRATE,
 250                                        avctx->bit_rate)) != AACENC_OK) {
 251             av_log(avctx, AV_LOG_ERROR, "Unable to set the bitrate %"PRId64": %s\n",
 252                    avctx->bit_rate, aac_get_error(err));
 253             goto error;
 254         }
 255     }
 256
 257     /* Choose bitstream format - if global header is requested, use
 258      * raw access units, otherwise use ADTS. */
 259     if ((err = aacEncoder_SetParam(s->handle, AACENC_TRANSMUX,
 260                                    avctx->flags & AV_CODEC_FLAG_GLOBAL_HEADER ? TT_MP4_RAW :
 261                                    s->latm ? TT_MP4_LOAS : TT_MP4_ADTS)) != AACENC_OK) {
 262         av_log(avctx, AV_LOG_ERROR, "Unable to set the transmux format: %s\n",
 263                aac_get_error(err));
 264         goto error;
 265     }
 266
 267     if (s->latm && s->header_period) {
 268         if ((err = aacEncoder_SetParam(s->handle, AACENC_HEADER_PERIOD,
 269                                        s->header_period)) != AACENC_OK) {
 270              av_log(avctx, AV_LOG_ERROR, "Unable to set header period: %s\n",
 271                     aac_get_error(err));
 272              goto error;
 273         }
 274     }
 275
 276     /* If no signaling mode is chosen, use explicit hierarchical signaling
 277      * if using mp4 mode (raw access units, with global header) and
 278      * implicit signaling if using ADTS. */
 279     if (s->signaling < 0)
 280         s->signaling = avctx->flags & AV_CODEC_FLAG_GLOBAL_HEADER ? 2 : 0;
 281
 282     if ((err = aacEncoder_SetParam(s->handle, AACENC_SIGNALING_MODE,
 283                                    s->signaling)) != AACENC_OK) {
 284         av_log(avctx, AV_LOG_ERROR, "Unable to set signaling mode %d: %s\n",
 285                s->signaling, aac_get_error(err));
 286         goto error;
 287     }
 288
 289     if ((err = aacEncoder_SetParam(s->handle, AACENC_AFTERBURNER,
 290                                    s->afterburner)) != AACENC_OK) {
 291         av_log(avctx, AV_LOG_ERROR, "Unable to set afterburner to %d: %s\n",
 292                s->afterburner, aac_get_error(err));
 293         goto error;
 294     }
 295
 296     if (avctx->cutoff > 0) {
 297         if (avctx->cutoff < (avctx->sample_rate + 255) >> 8 || avctx->cutoff > 20000) {
 298             av_log(avctx, AV_LOG_ERROR, "cutoff valid range is %d-20000\n",
 299                    (avctx->sample_rate + 255) >> 8);
 300             goto error;
 301         }
 302         if ((err = aacEncoder_SetParam(s->handle, AACENC_BANDWIDTH,
 303                                        avctx->cutoff)) != AACENC_OK) {
 304             av_log(avctx, AV_LOG_ERROR, "Unable to set the encoder bandwidth to %d: %s\n",
 305                    avctx->cutoff, aac_get_error(err));
 306             goto error;
 307         }
 308     }
 309
 310     if ((err = aacEncEncode(s->handle, NULL, NULL, NULL, NULL)) != AACENC_OK) {
 311         av_log(avctx, AV_LOG_ERROR, "Unable to initialize the encoder: %s\n",
 312                aac_get_error(err));
 313         return AVERROR(EINVAL);
 314     }
 315
 316     if ((err = aacEncInfo(s->handle, &info)) != AACENC_OK) {
 317         av_log(avctx, AV_LOG_ERROR, "Unable to get encoder info: %s\n",
 318                aac_get_error(err));
 319         goto error;
 320     }
 321
 322     avctx->frame_size = info.frameLength;
 323 #if FDKENC_VER_AT_LEAST(4, 0) // 4.0.0
 324     avctx->initial_padding = info.nDelay;
 325 #else
 326     avctx->initial_padding = info.encoderDelay;
 327 #endif
 328     ff_af_queue_init(avctx, &s->afq);
 329
 330     if (avctx->flags & AV_CODEC_FLAG_GLOBAL_HEADER) {
 331         avctx->extradata_size = info.confSize;
 332         avctx->extradata      = av_mallocz(avctx->extradata_size +
 333                                            AV_INPUT_BUFFER_PADDING_SIZE);
 334         if (!avctx->extradata) {
 335             ret = AVERROR(ENOMEM);
 336             goto error;
 337         }
 338
 339         memcpy(avctx->extradata, info.confBuf, info.confSize);
 340     }
 341     return 0;
 342 error:
 343     aac_encode_close(avctx);
 344     return ret;
 345 }
 346
 347 static int aac_encode_frame(AVCodecContext *avctx, AVPacket *avpkt,
 348                             const AVFrame *frame, int *got_packet_ptr)
 349 {
 350     AACContext    *s        = avctx->priv_data;
 351     AACENC_BufDesc in_buf   = { 0 }, out_buf = { 0 };
 352     AACENC_InArgs  in_args  = { 0 };
 353     AACENC_OutArgs out_args = { 0 };
 354     int in_buffer_identifier = IN_AUDIO_DATA;
 355     int in_buffer_size, in_buffer_element_size;
 356     int out_buffer_identifier = OUT_BITSTREAM_DATA;
 357     int out_buffer_size, out_buffer_element_size;
 358     void *in_ptr, *out_ptr;
 359     int ret;
 360     uint8_t dummy_buf[1];
 361     AACENC_ERROR err;
 362
 363     /* handle end-of-stream small frame and flushing */
 364     if (!frame) {
 365         /* Must be a non-null pointer, even if it's a dummy. We could use
 366          * the address of anything else on the stack as well. */
 367         in_ptr               = dummy_buf;
 368         in_buffer_size       = 0;
 369
 370         in_args.numInSamples = -1;
 371     } else {
 372         in_ptr               = frame->data[0];
 373         in_buffer_size       = 2 * avctx->channels * frame->nb_samples;
 374
 375         in_args.numInSamples = avctx->channels * frame->nb_samples;
 376
 377         /* add current frame to the queue */
 378         if ((ret = ff_af_queue_add(&s->afq, frame)) < 0)
 379             return ret;
 380     }
 381
 382     in_buffer_element_size   = 2;
 383     in_buf.numBufs           = 1;
 384     in_buf.bufs              = &in_ptr;
 385     in_buf.bufferIdentifiers = &in_buffer_identifier;
 386     in_buf.bufSizes          = &in_buffer_size;
 387     in_buf.bufElSizes        = &in_buffer_element_size;
 388
 389     /* The maximum packet size is 6144 bits aka 768 bytes per channel. */
 390     if ((ret = ff_alloc_packet2(avctx, avpkt, FFMAX(8192, 768 * avctx->channels), 0)) < 0)
 391         return ret;
 392
 393     out_ptr                   = avpkt->data;
 394     out_buffer_size           = avpkt->size;
 395     out_buffer_element_size   = 1;
 396     out_buf.numBufs           = 1;
 397     out_buf.bufs              = &out_ptr;
 398     out_buf.bufferIdentifiers = &out_buffer_identifier;
 399     out_buf.bufSizes          = &out_buffer_size;
 400     out_buf.bufElSizes        = &out_buffer_element_size;
 401
 402     if ((err = aacEncEncode(s->handle, &in_buf, &out_buf, &in_args,
 403                             &out_args)) != AACENC_OK) {
 404         if (!frame && err == AACENC_ENCODE_EOF)
 405             return 0;
 406         av_log(avctx, AV_LOG_ERROR, "Unable to encode frame: %s\n",
 407                aac_get_error(err));
 408         return AVERROR(EINVAL);
 409     }
 410
 411     if (!out_args.numOutBytes)
 412         return 0;
 413
 414     /* Get the next frame pts & duration */
 415     ff_af_queue_remove(&s->afq, avctx->frame_size, &avpkt->pts,
 416                        &avpkt->duration);
 417
 418     avpkt->size     = out_args.numOutBytes;
 419     *got_packet_ptr = 1;
 420     return 0;
 421 }
 422
 423 static const AVProfile profiles[] = {
 424     { FF_PROFILE_AAC_LOW,   "LC"       },
 425     { FF_PROFILE_AAC_HE,    "HE-AAC"   },
 426     { FF_PROFILE_AAC_HE_V2, "HE-AACv2" },
 427     { FF_PROFILE_AAC_LD,    "LD"       },
 428     { FF_PROFILE_AAC_ELD,   "ELD"      },
 429     { FF_PROFILE_UNKNOWN },
 430 };
 431
 432 static const AVCodecDefault aac_encode_defaults[] = {
 433     { "b", "0" },
 434     { NULL }
 435 };
 436
 437 static const uint64_t aac_channel_layout[] = {
 438     AV_CH_LAYOUT_MONO,
 439     AV_CH_LAYOUT_STEREO,
 440     AV_CH_LAYOUT_SURROUND,
 441     AV_CH_LAYOUT_4POINT0,
 442     AV_CH_LAYOUT_5POINT0_BACK,
 443     AV_CH_LAYOUT_5POINT1_BACK,
 444 #if FDKENC_VER_AT_LEAST(3, 4) // 3.4.12
 445     AV_CH_LAYOUT_7POINT1_WIDE_BACK,
 446     AV_CH_LAYOUT_7POINT1,
 447 #endif
 448     0,
 449 };
 450
 451 static const int aac_sample_rates[] = {
 452     96000, 88200, 64000, 48000, 44100, 32000,
 453     24000, 22050, 16000, 12000, 11025, 8000, 0
 454 };
 455
 456 AVCodec ff_libfdk_aac_encoder = {
 457     .name                  = "libfdk_aac",
 458     .long_name             = NULL_IF_CONFIG_SMALL("Fraunhofer FDK AAC"),
 459     .type                  = AVMEDIA_TYPE_AUDIO,
 460     .id                    = AV_CODEC_ID_AAC,
 461     .priv_data_size        = sizeof(AACContext),
 462     .init                  = aac_encode_init,
 463     .encode2               = aac_encode_frame,
 464     .close                 = aac_encode_close,
 465     .capabilities          = AV_CODEC_CAP_SMALL_LAST_FRAME | AV_CODEC_CAP_DELAY,
 466     .sample_fmts           = (const enum AVSampleFormat[]){ AV_SAMPLE_FMT_S16,
 467                                                             AV_SAMPLE_FMT_NONE },
 468     .priv_class            = &aac_enc_class,
 469     .defaults              = aac_encode_defaults,
 470     .profiles              = profiles,
 471     .supported_samplerates = aac_sample_rates,
 472     .channel_layouts       = aac_channel_layout,
 473     .wrapper_name          = "libfdk",
 474 };