2 * OpenH264 video encoder
3 * Copyright (C) 2014 Martin Storsjo
5 * This file is part of FFmpeg.
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.
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.
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
22 #include <wels/codec_api.h>
23 #include <wels/codec_ver.h>
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"
35 typedef struct SVCContext {
36 const AVClass *av_class;
47 #define OPENH264_VER_AT_LEAST(maj, min) \
48 ((OPENH264_MAJOR > (maj)) || \
49 (OPENH264_MAJOR == (maj) && OPENH264_MINOR >= (min)))
51 #define OFFSET(x) offsetof(SVCContext, x)
52 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
53 static const AVOption options[] = {
54 { "slice_mode", "set slice mode", OFFSET(slice_mode), AV_OPT_TYPE_INT, { .i64 = SM_AUTO_SLICE }, SM_SINGLE_SLICE, SM_RESERVED, VE, "slice_mode" },
55 { "fixed", "a fixed number of slices", 0, AV_OPT_TYPE_CONST, { .i64 = SM_FIXEDSLCNUM_SLICE }, 0, 0, VE, "slice_mode" },
56 { "rowmb", "one slice per row of macroblocks", 0, AV_OPT_TYPE_CONST, { .i64 = SM_ROWMB_SLICE }, 0, 0, VE, "slice_mode" },
57 { "auto", "automatic number of slices according to number of threads", 0, AV_OPT_TYPE_CONST, { .i64 = SM_AUTO_SLICE }, 0, 0, VE, "slice_mode" },
58 { "dyn", "Dynamic slicing", 0, AV_OPT_TYPE_CONST, { .i64 = SM_DYN_SLICE }, 0, 0, VE, "slice_mode" },
59 { "loopfilter", "enable loop filter", OFFSET(loopfilter), AV_OPT_TYPE_INT, { .i64 = 1 }, 0, 1, VE },
60 { "profile", "set profile restrictions", OFFSET(profile), AV_OPT_TYPE_STRING, { .str = NULL }, 0, 0, VE },
61 { "max_nal_size", "set maximum NAL size in bytes", OFFSET(max_nal_size), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, VE },
62 { "allow_skip_frames", "allow skipping frames to hit the target bitrate", OFFSET(skip_frames), AV_OPT_TYPE_BOOL, { .i64 = 0 }, 0, 1, VE },
63 { "cabac", "Enable cabac", OFFSET(cabac), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, VE },
67 static const AVClass class = {
68 "libopenh264enc", av_default_item_name, options, LIBAVUTIL_VERSION_INT
71 // Convert libopenh264 log level to equivalent ffmpeg log level.
72 static int libopenh264_to_ffmpeg_log_level(int libopenh264_log_level)
74 if (libopenh264_log_level >= WELS_LOG_DETAIL) return AV_LOG_TRACE;
75 else if (libopenh264_log_level >= WELS_LOG_DEBUG) return AV_LOG_DEBUG;
76 else if (libopenh264_log_level >= WELS_LOG_INFO) return AV_LOG_VERBOSE;
77 else if (libopenh264_log_level >= WELS_LOG_WARNING) return AV_LOG_WARNING;
78 else if (libopenh264_log_level >= WELS_LOG_ERROR) return AV_LOG_ERROR;
79 else return AV_LOG_QUIET;
82 // This function will be provided to the libopenh264 library. The function will be called
83 // when libopenh264 wants to log a message (error, warning, info, etc.). The signature for
84 // this function (defined in .../codec/api/svc/codec_api.h) is:
86 // typedef void (*WelsTraceCallback) (void* ctx, int level, const char* string);
88 static void libopenh264_trace_callback(void *ctx, int level, const char *msg)
90 // The message will be logged only if the requested EQUIVALENT ffmpeg log level is
91 // less than or equal to the current ffmpeg log level.
92 int equiv_ffmpeg_log_level = libopenh264_to_ffmpeg_log_level(level);
93 av_log(ctx, equiv_ffmpeg_log_level, "%s\n", msg);
96 static av_cold int svc_encode_close(AVCodecContext *avctx)
98 SVCContext *s = avctx->priv_data;
101 WelsDestroySVCEncoder(s->encoder);
103 av_log(avctx, AV_LOG_WARNING, "%d frames skipped\n", s->skipped);
107 static av_cold int svc_encode_init(AVCodecContext *avctx)
109 SVCContext *s = avctx->priv_data;
110 SEncParamExt param = { 0 };
111 int err = AVERROR_UNKNOWN;
113 WelsTraceCallback callback_function;
114 AVCPBProperties *props;
116 // Mingw GCC < 4.7 on x86_32 uses an incorrect/buggy ABI for the WelsGetCodecVersion
117 // function (for functions returning larger structs), thus skip the check in those
119 #if !defined(_WIN32) || !defined(__GNUC__) || !ARCH_X86_32 || AV_GCC_VERSION_AT_LEAST(4, 7)
120 OpenH264Version libver = WelsGetCodecVersion();
121 if (memcmp(&libver, &g_stCodecVersion, sizeof(libver))) {
122 av_log(avctx, AV_LOG_ERROR, "Incorrect library version loaded\n");
123 return AVERROR(EINVAL);
127 if (WelsCreateSVCEncoder(&s->encoder)) {
128 av_log(avctx, AV_LOG_ERROR, "Unable to create encoder\n");
129 return AVERROR_UNKNOWN;
132 // Pass all libopenh264 messages to our callback, to allow ourselves to filter them.
133 log_level = WELS_LOG_DETAIL;
134 (*s->encoder)->SetOption(s->encoder, ENCODER_OPTION_TRACE_LEVEL, &log_level);
136 // Set the logging callback function to one that uses av_log() (see implementation above).
137 callback_function = (WelsTraceCallback) libopenh264_trace_callback;
138 (*s->encoder)->SetOption(s->encoder, ENCODER_OPTION_TRACE_CALLBACK, (void *)&callback_function);
140 // Set the AVCodecContext as the libopenh264 callback context so that it can be passed to av_log().
141 (*s->encoder)->SetOption(s->encoder, ENCODER_OPTION_TRACE_CALLBACK_CONTEXT, (void *)&avctx);
143 (*s->encoder)->GetDefaultParams(s->encoder, ¶m);
145 #if FF_API_CODER_TYPE
146 FF_DISABLE_DEPRECATION_WARNINGS
148 s->cabac = avctx->coder_type == FF_CODER_TYPE_AC;
149 FF_ENABLE_DEPRECATION_WARNINGS
152 param.fMaxFrameRate = 1/av_q2d(avctx->time_base);
153 param.iPicWidth = avctx->width;
154 param.iPicHeight = avctx->height;
155 param.iTargetBitrate = avctx->bit_rate;
156 param.iMaxBitrate = FFMAX(avctx->rc_max_rate, avctx->bit_rate);
157 param.iRCMode = RC_QUALITY_MODE;
158 param.iTemporalLayerNum = 1;
159 param.iSpatialLayerNum = 1;
160 param.bEnableDenoise = 0;
161 param.bEnableBackgroundDetection = 1;
162 param.bEnableAdaptiveQuant = 1;
163 param.bEnableFrameSkip = s->skip_frames;
164 param.bEnableLongTermReference = 0;
165 param.iLtrMarkPeriod = 30;
166 param.uiIntraPeriod = avctx->gop_size;
167 #if OPENH264_VER_AT_LEAST(1, 4)
168 param.eSpsPpsIdStrategy = CONSTANT_ID;
170 param.bEnableSpsPpsIdAddition = 0;
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;
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;
187 if ((avctx->slices > 1) && (s->max_nal_size)){
188 av_log(avctx,AV_LOG_ERROR,"Invalid combination -slices %d and -max_nal_size %d.\n",avctx->slices,s->max_nal_size);
192 if (avctx->slices > 1)
193 s->slice_mode = SM_FIXEDSLCNUM_SLICE;
196 s->slice_mode = SM_DYN_SLICE;
198 param.sSpatialLayers[0].sSliceCfg.uiSliceMode = s->slice_mode;
199 param.sSpatialLayers[0].sSliceCfg.sSliceArgument.uiSliceNum = avctx->slices;
201 if (s->slice_mode == SM_DYN_SLICE) {
202 if (s->max_nal_size){
203 param.uiMaxNalSize = s->max_nal_size;
204 param.sSpatialLayers[0].sSliceCfg.sSliceArgument.uiSliceSizeConstraint = s->max_nal_size;
206 av_log(avctx, AV_LOG_ERROR, "Invalid -max_nal_size, "
207 "specify a valid max_nal_size to use -slice_mode dyn\n");
212 if ((*s->encoder)->InitializeExt(s->encoder, ¶m) != cmResultSuccess) {
213 av_log(avctx, AV_LOG_ERROR, "Initialize failed\n");
217 if (avctx->flags & AV_CODEC_FLAG_GLOBAL_HEADER) {
218 SFrameBSInfo fbi = { 0 };
220 (*s->encoder)->EncodeParameterSets(s->encoder, &fbi);
221 for (i = 0; i < fbi.sLayerInfo[0].iNalCount; i++)
222 size += fbi.sLayerInfo[0].pNalLengthInByte[i];
223 avctx->extradata = av_mallocz(size + AV_INPUT_BUFFER_PADDING_SIZE);
224 if (!avctx->extradata) {
225 err = AVERROR(ENOMEM);
228 avctx->extradata_size = size;
229 memcpy(avctx->extradata, fbi.sLayerInfo[0].pBsBuf, size);
232 props = ff_add_cpb_side_data(avctx);
234 err = AVERROR(ENOMEM);
237 props->max_bitrate = param.iMaxBitrate;
238 props->avg_bitrate = param.iTargetBitrate;
243 svc_encode_close(avctx);
247 static int svc_encode_frame(AVCodecContext *avctx, AVPacket *avpkt,
248 const AVFrame *frame, int *got_packet)
250 SVCContext *s = avctx->priv_data;
251 SFrameBSInfo fbi = { 0 };
254 SSourcePicture sp = { 0 };
255 int size = 0, layer, first_layer = 0;
256 int layer_size[MAX_LAYER_NUM_OF_FRAME] = { 0 };
258 sp.iColorFormat = videoFormatI420;
259 for (i = 0; i < 3; i++) {
260 sp.iStride[i] = frame->linesize[i];
261 sp.pData[i] = frame->data[i];
263 sp.iPicWidth = avctx->width;
264 sp.iPicHeight = avctx->height;
266 encoded = (*s->encoder)->EncodeFrame(s->encoder, &sp, &fbi);
267 if (encoded != cmResultSuccess) {
268 av_log(avctx, AV_LOG_ERROR, "EncodeFrame failed\n");
269 return AVERROR_UNKNOWN;
271 if (fbi.eFrameType == videoFrameTypeSkip) {
273 av_log(avctx, AV_LOG_DEBUG, "frame skipped\n");
277 // Normal frames are returned with one single layer, while IDR
278 // frames have two layers, where the first layer contains the SPS/PPS.
279 // If using global headers, don't include the SPS/PPS in the returned
280 // packet - thus, only return one layer.
281 if (avctx->flags & AV_CODEC_FLAG_GLOBAL_HEADER)
282 first_layer = fbi.iLayerNum - 1;
284 for (layer = first_layer; layer < fbi.iLayerNum; layer++) {
285 for (i = 0; i < fbi.sLayerInfo[layer].iNalCount; i++)
286 layer_size[layer] += fbi.sLayerInfo[layer].pNalLengthInByte[i];
287 size += layer_size[layer];
289 av_log(avctx, AV_LOG_DEBUG, "%d slices\n", fbi.sLayerInfo[fbi.iLayerNum - 1].iNalCount);
291 if ((ret = ff_alloc_packet2(avctx, avpkt, size, size))) {
292 av_log(avctx, AV_LOG_ERROR, "Error getting output packet\n");
296 for (layer = first_layer; layer < fbi.iLayerNum; layer++) {
297 memcpy(avpkt->data + size, fbi.sLayerInfo[layer].pBsBuf, layer_size[layer]);
298 size += layer_size[layer];
300 avpkt->pts = frame->pts;
301 if (fbi.eFrameType == videoFrameTypeIDR)
302 avpkt->flags |= AV_PKT_FLAG_KEY;
307 AVCodec ff_libopenh264_encoder = {
308 .name = "libopenh264",
309 .long_name = NULL_IF_CONFIG_SMALL("OpenH264 H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10"),
310 .type = AVMEDIA_TYPE_VIDEO,
311 .id = AV_CODEC_ID_H264,
312 .priv_data_size = sizeof(SVCContext),
313 .init = svc_encode_init,
314 .encode2 = svc_encode_frame,
315 .close = svc_encode_close,
316 .capabilities = AV_CODEC_CAP_AUTO_THREADS,
317 .pix_fmts = (const enum AVPixelFormat[]){ AV_PIX_FMT_YUV420P,
319 .priv_class = &class,