git.sesse.net Git - ffmpeg/blob - libavcodec/libopenh264enc.c

   1 /*
   2  * OpenH264 video encoder
   3  * Copyright (C) 2014 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 <wels/codec_api.h>
  23 #include <wels/codec_ver.h>
  24
  25 #include "libavutil/attributes.h"
  26 #include "libavutil/common.h"
  27 #include "libavutil/opt.h"
  28 #include "libavutil/internal.h"
  29 #include "libavutil/intreadwrite.h"
  30 #include "libavutil/mathematics.h"
  31
  32 #include "avcodec.h"
  33 #include "internal.h"
  34 #include "libopenh264.h"
  35
  36 #if !OPENH264_VER_AT_LEAST(1, 6)
  37 #define SM_SIZELIMITED_SLICE SM_DYN_SLICE
  38 #endif
  39
  40 #define TARGET_BITRATE_DEFAULT 2*1000*1000
  41
  42 typedef struct SVCContext {
  43     const AVClass *av_class;
  44     ISVCEncoder *encoder;
  45     int slice_mode;
  46     int loopfilter;
  47     char *profile;
  48     int max_nal_size;
  49     int skip_frames;
  50     int skipped;
  51     int cabac;
  52
  53     // rate control mode
  54     int rc_mode;
  55 } SVCContext;
  56
  57 #define OFFSET(x) offsetof(SVCContext, x)
  58 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
  59 static const AVOption options[] = {
  60 #if OPENH264_VER_AT_LEAST(1, 6)
  61     { "slice_mode", "set slice mode", OFFSET(slice_mode), AV_OPT_TYPE_INT, { .i64 = SM_FIXEDSLCNUM_SLICE }, SM_SINGLE_SLICE, SM_RESERVED, VE, "slice_mode" },
  62 #else
  63     { "slice_mode", "set slice mode", OFFSET(slice_mode), AV_OPT_TYPE_INT, { .i64 = SM_AUTO_SLICE }, SM_SINGLE_SLICE, SM_RESERVED, VE, "slice_mode" },
  64 #endif
  65         { "fixed", "a fixed number of slices", 0, AV_OPT_TYPE_CONST, { .i64 = SM_FIXEDSLCNUM_SLICE }, 0, 0, VE, "slice_mode" },
  66 #if OPENH264_VER_AT_LEAST(1, 6)
  67         { "dyn", "Size limited (compatibility name)", 0, AV_OPT_TYPE_CONST, { .i64 = SM_SIZELIMITED_SLICE }, 0, 0, VE, "slice_mode" },
  68         { "sizelimited", "Size limited", 0, AV_OPT_TYPE_CONST, { .i64 = SM_SIZELIMITED_SLICE }, 0, 0, VE, "slice_mode" },
  69 #else
  70         { "rowmb", "one slice per row of macroblocks", 0, AV_OPT_TYPE_CONST, { .i64 = SM_ROWMB_SLICE }, 0, 0, VE, "slice_mode" },
  71         { "auto", "automatic number of slices according to number of threads", 0, AV_OPT_TYPE_CONST, { .i64 = SM_AUTO_SLICE }, 0, 0, VE, "slice_mode" },
  72         { "dyn", "Dynamic slicing", 0, AV_OPT_TYPE_CONST, { .i64 = SM_DYN_SLICE }, 0, 0, VE, "slice_mode" },
  73 #endif
  74     { "loopfilter", "enable loop filter", OFFSET(loopfilter), AV_OPT_TYPE_INT, { .i64 = 1 }, 0, 1, VE },
  75     { "profile", "set profile restrictions", OFFSET(profile), AV_OPT_TYPE_STRING, { .str = NULL }, 0, 0, VE },
  76     { "max_nal_size", "set maximum NAL size in bytes", OFFSET(max_nal_size), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, VE },
  77     { "allow_skip_frames", "allow skipping frames to hit the target bitrate", OFFSET(skip_frames), AV_OPT_TYPE_BOOL, { .i64 = 0 }, 0, 1, VE },
  78     { "cabac", "Enable cabac", OFFSET(cabac), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, VE },
  79
  80     { "rc_mode", "Select rate control mode", OFFSET(rc_mode), AV_OPT_TYPE_INT, { .i64 = RC_QUALITY_MODE }, RC_OFF_MODE, RC_TIMESTAMP_MODE, VE, "rc_mode" },
  81         { "off",       "bit rate control off",                                                 0, AV_OPT_TYPE_CONST, { .i64 = RC_OFF_MODE },         0, 0, VE, "rc_mode" },
  82         { "quality",   "quality mode",                                                         0, AV_OPT_TYPE_CONST, { .i64 = RC_QUALITY_MODE },     0, 0, VE, "rc_mode" },
  83         { "bitrate",   "bitrate mode",                                                         0, AV_OPT_TYPE_CONST, { .i64 = RC_BITRATE_MODE },     0, 0, VE, "rc_mode" },
  84         { "buffer",    "using buffer status to adjust the video quality (no bitrate control)", 0, AV_OPT_TYPE_CONST, { .i64 = RC_BUFFERBASED_MODE }, 0, 0, VE, "rc_mode" },
  85 #if OPENH264_VER_AT_LEAST(1, 4)
  86         { "timestamp", "bit rate control based on timestamp",                                  0, AV_OPT_TYPE_CONST, { .i64 = RC_TIMESTAMP_MODE },   0, 0, VE, "rc_mode" },
  87 #endif
  88
  89     { NULL }
  90 };
  91
  92 static const AVClass class = {
  93     .class_name = "libopenh264enc",
  94     .item_name  = av_default_item_name,
  95     .option     = options,
  96     .version    = LIBAVUTIL_VERSION_INT,
  97 };
  98
  99 static av_cold int svc_encode_close(AVCodecContext *avctx)
 100 {
 101     SVCContext *s = avctx->priv_data;
 102
 103     if (s->encoder)
 104         WelsDestroySVCEncoder(s->encoder);
 105     if (s->skipped > 0)
 106         av_log(avctx, AV_LOG_WARNING, "%d frames skipped\n", s->skipped);
 107     return 0;
 108 }
 109
 110 static av_cold int svc_encode_init(AVCodecContext *avctx)
 111 {
 112     SVCContext *s = avctx->priv_data;
 113     SEncParamExt param = { 0 };
 114     int err;
 115     int log_level;
 116     WelsTraceCallback callback_function;
 117     AVCPBProperties *props;
 118
 119     if ((err = ff_libopenh264_check_version(avctx)) < 0)
 120         return err;
 121
 122     if (WelsCreateSVCEncoder(&s->encoder)) {
 123         av_log(avctx, AV_LOG_ERROR, "Unable to create encoder\n");
 124         return AVERROR_UNKNOWN;
 125     }
 126
 127     // Pass all libopenh264 messages to our callback, to allow ourselves to filter them.
 128     log_level = WELS_LOG_DETAIL;
 129     (*s->encoder)->SetOption(s->encoder, ENCODER_OPTION_TRACE_LEVEL, &log_level);
 130
 131     // Set the logging callback function to one that uses av_log() (see implementation above).
 132     callback_function = (WelsTraceCallback) ff_libopenh264_trace_callback;
 133     (*s->encoder)->SetOption(s->encoder, ENCODER_OPTION_TRACE_CALLBACK, &callback_function);
 134
 135     // Set the AVCodecContext as the libopenh264 callback context so that it can be passed to av_log().
 136     (*s->encoder)->SetOption(s->encoder, ENCODER_OPTION_TRACE_CALLBACK_CONTEXT, &avctx);
 137
 138     (*s->encoder)->GetDefaultParams(s->encoder, &param);
 139
 140 #if FF_API_CODER_TYPE
 141 FF_DISABLE_DEPRECATION_WARNINGS
 142     if (!s->cabac)
 143         s->cabac = avctx->coder_type == FF_CODER_TYPE_AC;
 144 FF_ENABLE_DEPRECATION_WARNINGS
 145 #endif
 146
 147     param.fMaxFrameRate              = 1/av_q2d(avctx->time_base);
 148     param.iPicWidth                  = avctx->width;
 149     param.iPicHeight                 = avctx->height;
 150     param.iTargetBitrate             = avctx->bit_rate > 0 ? avctx->bit_rate : TARGET_BITRATE_DEFAULT;
 151     param.iMaxBitrate                = FFMAX(avctx->rc_max_rate, avctx->bit_rate);
 152     param.iRCMode                    = s->rc_mode;
 153     if (avctx->qmax >= 0)
 154         param.iMaxQp                 = av_clip(avctx->qmax, 1, 51);
 155     if (avctx->qmin >= 0)
 156         param.iMinQp                 = av_clip(avctx->qmin, 1, param.iMaxQp);
 157     param.iTemporalLayerNum          = 1;
 158     param.iSpatialLayerNum           = 1;
 159     param.bEnableDenoise             = 0;
 160     param.bEnableBackgroundDetection = 1;
 161     param.bEnableAdaptiveQuant       = 1;
 162     param.bEnableFrameSkip           = s->skip_frames;
 163     param.bEnableLongTermReference   = 0;
 164     param.iLtrMarkPeriod             = 30;
 165     if (avctx->gop_size >= 0)
 166         param.uiIntraPeriod          = avctx->gop_size;
 167 #if OPENH264_VER_AT_LEAST(1, 4)
 168     param.eSpsPpsIdStrategy          = CONSTANT_ID;
 169 #else
 170     param.bEnableSpsPpsIdAddition    = 0;
 171 #endif
 172     param.bPrefixNalAddingCtrl       = 0;
 173     param.iLoopFilterDisableIdc      = !s->loopfilter;
 174     param.iEntropyCodingModeFlag     = 0;
 175     param.iMultipleThreadIdc         = avctx->thread_count;
 176     if (s->profile && !strcmp(s->profile, "main"))
 177         param.iEntropyCodingModeFlag = 1;
 178     else if (!s->profile && s->cabac)
 179         param.iEntropyCodingModeFlag = 1;
 180
 181     param.sSpatialLayers[0].iVideoWidth         = param.iPicWidth;
 182     param.sSpatialLayers[0].iVideoHeight        = param.iPicHeight;
 183     param.sSpatialLayers[0].fFrameRate          = param.fMaxFrameRate;
 184     param.sSpatialLayers[0].iSpatialBitrate     = param.iTargetBitrate;
 185     param.sSpatialLayers[0].iMaxSpatialBitrate  = param.iMaxBitrate;
 186
 187 #if OPENH264_VER_AT_LEAST(1, 7)
 188     if (avctx->sample_aspect_ratio.num && avctx->sample_aspect_ratio.den) {
 189         // Table E-1.
 190         static const AVRational sar_idc[] = {
 191             {   0,  0 }, // Unspecified (never written here).
 192             {   1,  1 }, {  12, 11 }, {  10, 11 }, {  16, 11 },
 193             {  40, 33 }, {  24, 11 }, {  20, 11 }, {  32, 11 },
 194             {  80, 33 }, {  18, 11 }, {  15, 11 }, {  64, 33 },
 195             { 160, 99 }, // Last 3 are unknown to openh264: {   4,  3 }, {   3,  2 }, {   2,  1 },
 196         };
 197         static const ESampleAspectRatio asp_idc[] = {
 198             ASP_UNSPECIFIED,
 199             ASP_1x1,      ASP_12x11,   ASP_10x11,   ASP_16x11,
 200             ASP_40x33,    ASP_24x11,   ASP_20x11,   ASP_32x11,
 201             ASP_80x33,    ASP_18x11,   ASP_15x11,   ASP_64x33,
 202             ASP_160x99,
 203         };
 204         int num, den, i;
 205
 206         av_reduce(&num, &den, avctx->sample_aspect_ratio.num,
 207                   avctx->sample_aspect_ratio.den, 65535);
 208
 209         for (i = 1; i < FF_ARRAY_ELEMS(sar_idc); i++) {
 210             if (num == sar_idc[i].num &&
 211                 den == sar_idc[i].den)
 212                 break;
 213         }
 214         if (i == FF_ARRAY_ELEMS(sar_idc)) {
 215             param.sSpatialLayers[0].eAspectRatio = ASP_EXT_SAR;
 216             param.sSpatialLayers[0].sAspectRatioExtWidth = num;
 217             param.sSpatialLayers[0].sAspectRatioExtHeight = den;
 218         } else {
 219             param.sSpatialLayers[0].eAspectRatio = asp_idc[i];
 220         }
 221         param.sSpatialLayers[0].bAspectRatioPresent = true;
 222     } else {
 223         param.sSpatialLayers[0].bAspectRatioPresent = false;
 224     }
 225 #endif
 226
 227     if ((avctx->slices > 1) && (s->max_nal_size)) {
 228         av_log(avctx, AV_LOG_ERROR,
 229                "Invalid combination -slices %d and -max_nal_size %d.\n",
 230                avctx->slices, s->max_nal_size);
 231         return AVERROR(EINVAL);
 232     }
 233
 234     if (avctx->slices > 1)
 235         s->slice_mode = SM_FIXEDSLCNUM_SLICE;
 236
 237     if (s->max_nal_size)
 238         s->slice_mode = SM_SIZELIMITED_SLICE;
 239
 240 #if OPENH264_VER_AT_LEAST(1, 6)
 241     param.sSpatialLayers[0].sSliceArgument.uiSliceMode = s->slice_mode;
 242     param.sSpatialLayers[0].sSliceArgument.uiSliceNum  = avctx->slices;
 243 #else
 244     param.sSpatialLayers[0].sSliceCfg.uiSliceMode               = s->slice_mode;
 245     param.sSpatialLayers[0].sSliceCfg.sSliceArgument.uiSliceNum = avctx->slices;
 246 #endif
 247     if (avctx->slices == 0 && s->slice_mode == SM_FIXEDSLCNUM_SLICE)
 248         av_log(avctx, AV_LOG_WARNING, "Slice count will be set automatically\n");
 249
 250     if (s->slice_mode == SM_SIZELIMITED_SLICE) {
 251         if (s->max_nal_size) {
 252             param.uiMaxNalSize = s->max_nal_size;
 253 #if OPENH264_VER_AT_LEAST(1, 6)
 254             param.sSpatialLayers[0].sSliceArgument.uiSliceSizeConstraint = s->max_nal_size;
 255 #else
 256             param.sSpatialLayers[0].sSliceCfg.sSliceArgument.uiSliceSizeConstraint = s->max_nal_size;
 257 #endif
 258         } else {
 259             av_log(avctx, AV_LOG_ERROR, "Invalid -max_nal_size, "
 260                    "specify a valid max_nal_size to use -slice_mode dyn\n");
 261             return AVERROR(EINVAL);
 262         }
 263     }
 264
 265     if ((*s->encoder)->InitializeExt(s->encoder, &param) != cmResultSuccess) {
 266         av_log(avctx, AV_LOG_ERROR, "Initialize failed\n");
 267         return AVERROR_UNKNOWN;
 268     }
 269
 270     if (avctx->flags & AV_CODEC_FLAG_GLOBAL_HEADER) {
 271         SFrameBSInfo fbi = { 0 };
 272         int i, size = 0;
 273         (*s->encoder)->EncodeParameterSets(s->encoder, &fbi);
 274         for (i = 0; i < fbi.sLayerInfo[0].iNalCount; i++)
 275             size += fbi.sLayerInfo[0].pNalLengthInByte[i];
 276         avctx->extradata = av_mallocz(size + AV_INPUT_BUFFER_PADDING_SIZE);
 277         if (!avctx->extradata)
 278             return AVERROR(ENOMEM);
 279         avctx->extradata_size = size;
 280         memcpy(avctx->extradata, fbi.sLayerInfo[0].pBsBuf, size);
 281     }
 282
 283     props = ff_add_cpb_side_data(avctx);
 284     if (!props)
 285         return AVERROR(ENOMEM);
 286     props->max_bitrate = param.iMaxBitrate;
 287     props->avg_bitrate = param.iTargetBitrate;
 288
 289     return 0;
 290 }
 291
 292 static int svc_encode_frame(AVCodecContext *avctx, AVPacket *avpkt,
 293                             const AVFrame *frame, int *got_packet)
 294 {
 295     SVCContext *s = avctx->priv_data;
 296     SFrameBSInfo fbi = { 0 };
 297     int i, ret;
 298     int encoded;
 299     SSourcePicture sp = { 0 };
 300     int size = 0, layer, first_layer = 0;
 301     int layer_size[MAX_LAYER_NUM_OF_FRAME] = { 0 };
 302
 303     sp.iColorFormat = videoFormatI420;
 304     for (i = 0; i < 3; i++) {
 305         sp.iStride[i] = frame->linesize[i];
 306         sp.pData[i]   = frame->data[i];
 307     }
 308     sp.iPicWidth  = avctx->width;
 309     sp.iPicHeight = avctx->height;
 310
 311     if (frame->pict_type == AV_PICTURE_TYPE_I) {
 312         (*s->encoder)->ForceIntraFrame(s->encoder, true);
 313     }
 314
 315     encoded = (*s->encoder)->EncodeFrame(s->encoder, &sp, &fbi);
 316     if (encoded != cmResultSuccess) {
 317         av_log(avctx, AV_LOG_ERROR, "EncodeFrame failed\n");
 318         return AVERROR_UNKNOWN;
 319     }
 320     if (fbi.eFrameType == videoFrameTypeSkip) {
 321         s->skipped++;
 322         av_log(avctx, AV_LOG_DEBUG, "frame skipped\n");
 323         return 0;
 324     }
 325     first_layer = 0;
 326     // Normal frames are returned with one single layer, while IDR
 327     // frames have two layers, where the first layer contains the SPS/PPS.
 328     // If using global headers, don't include the SPS/PPS in the returned
 329     // packet - thus, only return one layer.
 330     if (avctx->flags & AV_CODEC_FLAG_GLOBAL_HEADER)
 331         first_layer = fbi.iLayerNum - 1;
 332
 333     for (layer = first_layer; layer < fbi.iLayerNum; layer++) {
 334         for (i = 0; i < fbi.sLayerInfo[layer].iNalCount; i++)
 335             layer_size[layer] += fbi.sLayerInfo[layer].pNalLengthInByte[i];
 336         size += layer_size[layer];
 337     }
 338     av_log(avctx, AV_LOG_DEBUG, "%d slices\n", fbi.sLayerInfo[fbi.iLayerNum - 1].iNalCount);
 339
 340     if ((ret = ff_alloc_packet2(avctx, avpkt, size, size))) {
 341         av_log(avctx, AV_LOG_ERROR, "Error getting output packet\n");
 342         return ret;
 343     }
 344     size = 0;
 345     for (layer = first_layer; layer < fbi.iLayerNum; layer++) {
 346         memcpy(avpkt->data + size, fbi.sLayerInfo[layer].pBsBuf, layer_size[layer]);
 347         size += layer_size[layer];
 348     }
 349     avpkt->pts = frame->pts;
 350     if (fbi.eFrameType == videoFrameTypeIDR)
 351         avpkt->flags |= AV_PKT_FLAG_KEY;
 352     *got_packet = 1;
 353     return 0;
 354 }
 355
 356 static const AVCodecDefault svc_enc_defaults[] = {
 357     { "b",         "0"     },
 358     { "g",         "-1"    },
 359     { "qmin",      "-1"    },
 360     { "qmax",      "-1"    },
 361     { NULL },
 362 };
 363
 364 AVCodec ff_libopenh264_encoder = {
 365     .name           = "libopenh264",
 366     .long_name      = NULL_IF_CONFIG_SMALL("OpenH264 H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10"),
 367     .type           = AVMEDIA_TYPE_VIDEO,
 368     .id             = AV_CODEC_ID_H264,
 369     .priv_data_size = sizeof(SVCContext),
 370     .init           = svc_encode_init,
 371     .encode2        = svc_encode_frame,
 372     .close          = svc_encode_close,
 373     .capabilities   = AV_CODEC_CAP_AUTO_THREADS,
 374     .caps_internal  = FF_CODEC_CAP_INIT_THREADSAFE | FF_CODEC_CAP_INIT_CLEANUP,
 375     .pix_fmts       = (const enum AVPixelFormat[]){ AV_PIX_FMT_YUV420P,
 376                                                     AV_PIX_FMT_NONE },
 377     .defaults       = svc_enc_defaults,
 378     .priv_class     = &class,
 379     .wrapper_name   = "libopenh264",
 380 };