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