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