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/intreadwrite.h"
  29 #include "libavutil/mathematics.h"
  30
  31 #include "avcodec.h"
  32 #include "internal.h"
  33
  34 typedef struct SVCContext {
  35     const AVClass *av_class;
  36     ISVCEncoder *encoder;
  37     int slice_mode;
  38     int loopfilter;
  39     char *profile;
  40     int max_nal_size;
  41     int skip_frames;
  42     int skipped;
  43 } SVCContext;
  44
  45 #define OPENH264_VER_AT_LEAST(maj, min) \
  46     ((OPENH264_MAJOR  > (maj)) || \
  47      (OPENH264_MAJOR == (maj) && OPENH264_MINOR >= (min)))
  48
  49 #define OFFSET(x) offsetof(SVCContext, x)
  50 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
  51 static const AVOption options[] = {
  52     { "slice_mode", "set slice mode", OFFSET(slice_mode), AV_OPT_TYPE_INT, { .i64 = SM_AUTO_SLICE }, SM_SINGLE_SLICE, SM_RESERVED, VE, "slice_mode" },
  53         { "fixed", "a fixed number of slices", 0, AV_OPT_TYPE_CONST, { .i64 = SM_FIXEDSLCNUM_SLICE }, 0, 0, VE, "slice_mode" },
  54         { "rowmb", "one slice per row of macroblocks", 0, AV_OPT_TYPE_CONST, { .i64 = SM_ROWMB_SLICE }, 0, 0, VE, "slice_mode" },
  55         { "auto", "automatic number of slices according to number of threads", 0, AV_OPT_TYPE_CONST, { .i64 = SM_AUTO_SLICE }, 0, 0, VE, "slice_mode" },
  56         { "dyn", "Dynamic slicing", 0, AV_OPT_TYPE_CONST, { .i64 = SM_DYN_SLICE }, 0, 0, VE, "slice_mode" },
  57     { "loopfilter", "enable loop filter", OFFSET(loopfilter), AV_OPT_TYPE_INT, { .i64 = 1 }, 0, 1, VE },
  58     { "profile", "set profile restrictions", OFFSET(profile), AV_OPT_TYPE_STRING, { .str = NULL }, 0, 0, VE },
  59     { "max_nal_size", "set maximum NAL size in bytes", OFFSET(max_nal_size), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, VE },
  60     { "allow_skip_frames", "allow skipping frames to hit the target bitrate", OFFSET(skip_frames), AV_OPT_TYPE_BOOL, { .i64 = 0 }, 0, 1, VE },
  61     { NULL }
  62 };
  63
  64 static const AVClass class = {
  65     "libopenh264enc", av_default_item_name, options, LIBAVUTIL_VERSION_INT
  66 };
  67
  68 // Convert libopenh264 log level to equivalent ffmpeg log level.
  69 static int libopenh264_to_ffmpeg_log_level(int libopenh264_log_level)
  70 {
  71     if      (libopenh264_log_level >= WELS_LOG_DETAIL)  return AV_LOG_TRACE;
  72     else if (libopenh264_log_level >= WELS_LOG_DEBUG)   return AV_LOG_DEBUG;
  73     else if (libopenh264_log_level >= WELS_LOG_INFO)    return AV_LOG_VERBOSE;
  74     else if (libopenh264_log_level >= WELS_LOG_WARNING) return AV_LOG_WARNING;
  75     else if (libopenh264_log_level >= WELS_LOG_ERROR)   return AV_LOG_ERROR;
  76     else                                                return AV_LOG_QUIET;
  77 }
  78
  79 // This function will be provided to the libopenh264 library.  The function will be called
  80 // when libopenh264 wants to log a message (error, warning, info, etc.).  The signature for
  81 // this function (defined in .../codec/api/svc/codec_api.h) is:
  82 //
  83 //        typedef void (*WelsTraceCallback) (void* ctx, int level, const char* string);
  84
  85 static void libopenh264_trace_callback(void *ctx, int level, char const *msg)
  86 {
  87     // The message will be logged only if the requested EQUIVALENT ffmpeg log level is
  88     // less than or equal to the current ffmpeg log level.
  89     int equiv_ffmpeg_log_level = libopenh264_to_ffmpeg_log_level(level);
  90     av_log(ctx, equiv_ffmpeg_log_level, "%s\n", msg);
  91 }
  92
  93 static av_cold int svc_encode_close(AVCodecContext *avctx)
  94 {
  95     SVCContext *s = avctx->priv_data;
  96
  97     if (s->encoder)
  98         WelsDestroySVCEncoder(s->encoder);
  99     if (s->skipped > 0)
 100         av_log(avctx, AV_LOG_WARNING, "%d frames skipped\n", s->skipped);
 101     return 0;
 102 }
 103
 104 static av_cold int svc_encode_init(AVCodecContext *avctx)
 105 {
 106     SVCContext *s = avctx->priv_data;
 107     SEncParamExt param = { 0 };
 108     int err = AVERROR_UNKNOWN;
 109     int log_level;
 110     WelsTraceCallback callback_function;
 111     AVCPBProperties *props;
 112
 113     // Mingw GCC < 4.7 on x86_32 uses an incorrect/buggy ABI for the WelsGetCodecVersion
 114     // function (for functions returning larger structs), thus skip the check in those
 115     // configurations.
 116 #if !defined(_WIN32) || !defined(__GNUC__) || !ARCH_X86_32 || AV_GCC_VERSION_AT_LEAST(4, 7)
 117     OpenH264Version libver = WelsGetCodecVersion();
 118     if (memcmp(&libver, &g_stCodecVersion, sizeof(libver))) {
 119         av_log(avctx, AV_LOG_ERROR, "Incorrect library version loaded\n");
 120         return AVERROR(EINVAL);
 121     }
 122 #endif
 123
 124     if (WelsCreateSVCEncoder(&s->encoder)) {
 125         av_log(avctx, AV_LOG_ERROR, "Unable to create encoder\n");
 126         return AVERROR_UNKNOWN;
 127     }
 128
 129     // Pass all libopenh264 messages to our callback, to allow ourselves to filter them.
 130     log_level = WELS_LOG_DETAIL;
 131     (*s->encoder)->SetOption(s->encoder, ENCODER_OPTION_TRACE_LEVEL, &log_level);
 132
 133     // Set the logging callback function to one that uses av_log() (see implementation above).
 134     callback_function = (WelsTraceCallback) libopenh264_trace_callback;
 135     (*s->encoder)->SetOption(s->encoder, ENCODER_OPTION_TRACE_CALLBACK, (void *)&callback_function);
 136
 137     // Set the AVCodecContext as the libopenh264 callback context so that it can be passed to av_log().
 138     (*s->encoder)->SetOption(s->encoder, ENCODER_OPTION_TRACE_CALLBACK_CONTEXT, (void *)&avctx);
 139
 140     (*s->encoder)->GetDefaultParams(s->encoder, &param);
 141
 142     param.fMaxFrameRate              = 1/av_q2d(avctx->time_base);
 143     param.iPicWidth                  = avctx->width;
 144     param.iPicHeight                 = avctx->height;
 145     param.iTargetBitrate             = avctx->bit_rate;
 146     param.iMaxBitrate                = FFMAX(avctx->rc_max_rate, avctx->bit_rate);
 147     param.iRCMode                    = RC_QUALITY_MODE;
 148     param.iTemporalLayerNum          = 1;
 149     param.iSpatialLayerNum           = 1;
 150     param.bEnableDenoise             = 0;
 151     param.bEnableBackgroundDetection = 1;
 152     param.bEnableAdaptiveQuant       = 1;
 153     param.bEnableFrameSkip           = s->skip_frames;
 154     param.bEnableLongTermReference   = 0;
 155     param.iLtrMarkPeriod             = 30;
 156     param.uiIntraPeriod              = avctx->gop_size;
 157 #if OPENH264_VER_AT_LEAST(1, 4)
 158     param.eSpsPpsIdStrategy          = CONSTANT_ID;
 159 #else
 160     param.bEnableSpsPpsIdAddition    = 0;
 161 #endif
 162     param.bPrefixNalAddingCtrl       = 0;
 163     param.iLoopFilterDisableIdc      = !s->loopfilter;
 164     param.iEntropyCodingModeFlag     = 0;
 165     param.iMultipleThreadIdc         = avctx->thread_count;
 166     if (s->profile && !strcmp(s->profile, "main"))
 167         param.iEntropyCodingModeFlag = 1;
 168     else if (!s->profile && avctx->coder_type == FF_CODER_TYPE_AC)
 169         param.iEntropyCodingModeFlag = 1;
 170
 171     param.sSpatialLayers[0].iVideoWidth         = param.iPicWidth;
 172     param.sSpatialLayers[0].iVideoHeight        = param.iPicHeight;
 173     param.sSpatialLayers[0].fFrameRate          = param.fMaxFrameRate;
 174     param.sSpatialLayers[0].iSpatialBitrate     = param.iTargetBitrate;
 175     param.sSpatialLayers[0].iMaxSpatialBitrate  = param.iMaxBitrate;
 176
 177     if ((avctx->slices > 1) && (s->max_nal_size)){
 178         av_log(avctx,AV_LOG_ERROR,"Invalid combination -slices %d and -max_nal_size %d.\n",avctx->slices,s->max_nal_size);
 179         goto fail;
 180     }
 181
 182     if (avctx->slices > 1)
 183         s->slice_mode = SM_FIXEDSLCNUM_SLICE;
 184
 185     if (s->max_nal_size)
 186         s->slice_mode = SM_DYN_SLICE;
 187
 188     param.sSpatialLayers[0].sSliceCfg.uiSliceMode               = s->slice_mode;
 189     param.sSpatialLayers[0].sSliceCfg.sSliceArgument.uiSliceNum = avctx->slices;
 190
 191     if (s->slice_mode == SM_DYN_SLICE) {
 192         if (s->max_nal_size){
 193             param.uiMaxNalSize = s->max_nal_size;
 194             param.sSpatialLayers[0].sSliceCfg.sSliceArgument.uiSliceSizeConstraint = s->max_nal_size;
 195         } else {
 196             if (avctx->rtp_payload_size) {
 197                 av_log(avctx,AV_LOG_DEBUG,"Using RTP Payload size for uiMaxNalSize");
 198                 param.uiMaxNalSize = avctx->rtp_payload_size;
 199                 param.sSpatialLayers[0].sSliceCfg.sSliceArgument.uiSliceSizeConstraint = avctx->rtp_payload_size;
 200             } else {
 201                 av_log(avctx,AV_LOG_ERROR,"Invalid -max_nal_size, specify a valid max_nal_size to use -slice_mode dyn\n");
 202                 goto fail;
 203             }
 204         }
 205     }
 206
 207     if ((*s->encoder)->InitializeExt(s->encoder, &param) != cmResultSuccess) {
 208         av_log(avctx, AV_LOG_ERROR, "Initialize failed\n");
 209         goto fail;
 210     }
 211
 212     if (avctx->flags & AV_CODEC_FLAG_GLOBAL_HEADER) {
 213         SFrameBSInfo fbi = { 0 };
 214         int i, size = 0;
 215         (*s->encoder)->EncodeParameterSets(s->encoder, &fbi);
 216         for (i = 0; i < fbi.sLayerInfo[0].iNalCount; i++)
 217             size += fbi.sLayerInfo[0].pNalLengthInByte[i];
 218         avctx->extradata = av_mallocz(size + AV_INPUT_BUFFER_PADDING_SIZE);
 219         if (!avctx->extradata) {
 220             err = AVERROR(ENOMEM);
 221             goto fail;
 222         }
 223         avctx->extradata_size = size;
 224         memcpy(avctx->extradata, fbi.sLayerInfo[0].pBsBuf, size);
 225     }
 226
 227     props = ff_add_cpb_side_data(avctx);
 228     if (!props) {
 229         err = AVERROR(ENOMEM);
 230         goto fail;
 231     }
 232     props->max_bitrate = param.iMaxBitrate;
 233     props->avg_bitrate = param.iTargetBitrate;
 234
 235     return 0;
 236
 237 fail:
 238     svc_encode_close(avctx);
 239     return err;
 240 }
 241
 242 static int svc_encode_frame(AVCodecContext *avctx, AVPacket *avpkt,
 243                             const AVFrame *frame, int *got_packet)
 244 {
 245     SVCContext *s = avctx->priv_data;
 246     SFrameBSInfo fbi = { 0 };
 247     int i, ret;
 248     int encoded;
 249     SSourcePicture sp = { 0 };
 250     int size = 0, layer, first_layer = 0;
 251     int layer_size[MAX_LAYER_NUM_OF_FRAME] = { 0 };
 252
 253     sp.iColorFormat = videoFormatI420;
 254     for (i = 0; i < 3; i++) {
 255         sp.iStride[i] = frame->linesize[i];
 256         sp.pData[i]   = frame->data[i];
 257     }
 258     sp.iPicWidth  = avctx->width;
 259     sp.iPicHeight = avctx->height;
 260
 261     encoded = (*s->encoder)->EncodeFrame(s->encoder, &sp, &fbi);
 262     if (encoded != cmResultSuccess) {
 263         av_log(avctx, AV_LOG_ERROR, "EncodeFrame failed\n");
 264         return AVERROR_UNKNOWN;
 265     }
 266     if (fbi.eFrameType == videoFrameTypeSkip) {
 267         s->skipped++;
 268         av_log(avctx, AV_LOG_DEBUG, "frame skipped\n");
 269         return 0;
 270     }
 271     first_layer = 0;
 272     // Normal frames are returned with one single layer, while IDR
 273     // frames have two layers, where the first layer contains the SPS/PPS.
 274     // If using global headers, don't include the SPS/PPS in the returned
 275     // packet - thus, only return one layer.
 276     if (avctx->flags & AV_CODEC_FLAG_GLOBAL_HEADER)
 277         first_layer = fbi.iLayerNum - 1;
 278
 279     for (layer = first_layer; layer < fbi.iLayerNum; layer++) {
 280         for (i = 0; i < fbi.sLayerInfo[layer].iNalCount; i++)
 281             layer_size[layer] += fbi.sLayerInfo[layer].pNalLengthInByte[i];
 282         size += layer_size[layer];
 283     }
 284     av_log(avctx, AV_LOG_DEBUG, "%d slices\n", fbi.sLayerInfo[fbi.iLayerNum - 1].iNalCount);
 285
 286     if ((ret = ff_alloc_packet2(avctx, avpkt, size, size))) {
 287         av_log(avctx, AV_LOG_ERROR, "Error getting output packet\n");
 288         return ret;
 289     }
 290     size = 0;
 291     for (layer = first_layer; layer < fbi.iLayerNum; layer++) {
 292         memcpy(avpkt->data + size, fbi.sLayerInfo[layer].pBsBuf, layer_size[layer]);
 293         size += layer_size[layer];
 294     }
 295     avpkt->pts = frame->pts;
 296     if (fbi.eFrameType == videoFrameTypeIDR)
 297         avpkt->flags |= AV_PKT_FLAG_KEY;
 298     *got_packet = 1;
 299     return 0;
 300 }
 301
 302 AVCodec ff_libopenh264_encoder = {
 303     .name           = "libopenh264",
 304     .long_name      = NULL_IF_CONFIG_SMALL("OpenH264 H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10"),
 305     .type           = AVMEDIA_TYPE_VIDEO,
 306     .id             = AV_CODEC_ID_H264,
 307     .priv_data_size = sizeof(SVCContext),
 308     .init           = svc_encode_init,
 309     .encode2        = svc_encode_frame,
 310     .close          = svc_encode_close,
 311     .capabilities   = AV_CODEC_CAP_AUTO_THREADS,
 312     .pix_fmts       = (const enum AVPixelFormat[]){ AV_PIX_FMT_YUV420P,
 313                                                     AV_PIX_FMT_NONE },
 314     .priv_class     = &class,
 315 };