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"
34 #include "libopenh264.h"
36 typedef struct SVCContext {
37 const AVClass *av_class;
48 #define OFFSET(x) offsetof(SVCContext, x)
49 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
50 static const AVOption options[] = {
51 { "slice_mode", "set slice mode", OFFSET(slice_mode), AV_OPT_TYPE_INT, { .i64 = SM_AUTO_SLICE }, SM_SINGLE_SLICE, SM_RESERVED, VE, "slice_mode" },
52 { "fixed", "a fixed number of slices", 0, AV_OPT_TYPE_CONST, { .i64 = SM_FIXEDSLCNUM_SLICE }, 0, 0, VE, "slice_mode" },
53 { "rowmb", "one slice per row of macroblocks", 0, AV_OPT_TYPE_CONST, { .i64 = SM_ROWMB_SLICE }, 0, 0, VE, "slice_mode" },
54 { "auto", "automatic number of slices according to number of threads", 0, AV_OPT_TYPE_CONST, { .i64 = SM_AUTO_SLICE }, 0, 0, VE, "slice_mode" },
55 { "dyn", "Dynamic slicing", 0, AV_OPT_TYPE_CONST, { .i64 = SM_DYN_SLICE }, 0, 0, VE, "slice_mode" },
56 { "loopfilter", "enable loop filter", OFFSET(loopfilter), AV_OPT_TYPE_INT, { .i64 = 1 }, 0, 1, VE },
57 { "profile", "set profile restrictions", OFFSET(profile), AV_OPT_TYPE_STRING, { .str = NULL }, 0, 0, VE },
58 { "max_nal_size", "set maximum NAL size in bytes", OFFSET(max_nal_size), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, VE },
59 { "allow_skip_frames", "allow skipping frames to hit the target bitrate", OFFSET(skip_frames), AV_OPT_TYPE_BOOL, { .i64 = 0 }, 0, 1, VE },
60 { "cabac", "Enable cabac", OFFSET(cabac), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, VE },
64 static const AVClass class = {
65 "libopenh264enc", av_default_item_name, options, LIBAVUTIL_VERSION_INT
68 static av_cold int svc_encode_close(AVCodecContext *avctx)
70 SVCContext *s = avctx->priv_data;
73 WelsDestroySVCEncoder(s->encoder);
75 av_log(avctx, AV_LOG_WARNING, "%d frames skipped\n", s->skipped);
79 static av_cold int svc_encode_init(AVCodecContext *avctx)
81 SVCContext *s = avctx->priv_data;
82 SEncParamExt param = { 0 };
85 WelsTraceCallback callback_function;
86 AVCPBProperties *props;
88 if ((err = ff_libopenh264_check_version(avctx)) < 0)
90 // Use a default error for multiple error paths below
91 err = AVERROR_UNKNOWN;
93 if (WelsCreateSVCEncoder(&s->encoder)) {
94 av_log(avctx, AV_LOG_ERROR, "Unable to create encoder\n");
95 return AVERROR_UNKNOWN;
98 // Pass all libopenh264 messages to our callback, to allow ourselves to filter them.
99 log_level = WELS_LOG_DETAIL;
100 (*s->encoder)->SetOption(s->encoder, ENCODER_OPTION_TRACE_LEVEL, &log_level);
102 // Set the logging callback function to one that uses av_log() (see implementation above).
103 callback_function = (WelsTraceCallback) ff_libopenh264_trace_callback;
104 (*s->encoder)->SetOption(s->encoder, ENCODER_OPTION_TRACE_CALLBACK, (void *)&callback_function);
106 // Set the AVCodecContext as the libopenh264 callback context so that it can be passed to av_log().
107 (*s->encoder)->SetOption(s->encoder, ENCODER_OPTION_TRACE_CALLBACK_CONTEXT, (void *)&avctx);
109 (*s->encoder)->GetDefaultParams(s->encoder, ¶m);
111 #if FF_API_CODER_TYPE
112 FF_DISABLE_DEPRECATION_WARNINGS
114 s->cabac = avctx->coder_type == FF_CODER_TYPE_AC;
115 FF_ENABLE_DEPRECATION_WARNINGS
118 param.fMaxFrameRate = 1/av_q2d(avctx->time_base);
119 param.iPicWidth = avctx->width;
120 param.iPicHeight = avctx->height;
121 param.iTargetBitrate = avctx->bit_rate;
122 param.iMaxBitrate = FFMAX(avctx->rc_max_rate, avctx->bit_rate);
123 param.iRCMode = RC_QUALITY_MODE;
124 param.iTemporalLayerNum = 1;
125 param.iSpatialLayerNum = 1;
126 param.bEnableDenoise = 0;
127 param.bEnableBackgroundDetection = 1;
128 param.bEnableAdaptiveQuant = 1;
129 param.bEnableFrameSkip = s->skip_frames;
130 param.bEnableLongTermReference = 0;
131 param.iLtrMarkPeriod = 30;
132 param.uiIntraPeriod = avctx->gop_size;
133 #if OPENH264_VER_AT_LEAST(1, 4)
134 param.eSpsPpsIdStrategy = CONSTANT_ID;
136 param.bEnableSpsPpsIdAddition = 0;
138 param.bPrefixNalAddingCtrl = 0;
139 param.iLoopFilterDisableIdc = !s->loopfilter;
140 param.iEntropyCodingModeFlag = 0;
141 param.iMultipleThreadIdc = avctx->thread_count;
142 if (s->profile && !strcmp(s->profile, "main"))
143 param.iEntropyCodingModeFlag = 1;
144 else if (!s->profile && s->cabac)
145 param.iEntropyCodingModeFlag = 1;
147 param.sSpatialLayers[0].iVideoWidth = param.iPicWidth;
148 param.sSpatialLayers[0].iVideoHeight = param.iPicHeight;
149 param.sSpatialLayers[0].fFrameRate = param.fMaxFrameRate;
150 param.sSpatialLayers[0].iSpatialBitrate = param.iTargetBitrate;
151 param.sSpatialLayers[0].iMaxSpatialBitrate = param.iMaxBitrate;
153 if ((avctx->slices > 1) && (s->max_nal_size)){
154 av_log(avctx,AV_LOG_ERROR,"Invalid combination -slices %d and -max_nal_size %d.\n",avctx->slices,s->max_nal_size);
158 if (avctx->slices > 1)
159 s->slice_mode = SM_FIXEDSLCNUM_SLICE;
162 s->slice_mode = SM_DYN_SLICE;
164 param.sSpatialLayers[0].sSliceCfg.uiSliceMode = s->slice_mode;
165 param.sSpatialLayers[0].sSliceCfg.sSliceArgument.uiSliceNum = avctx->slices;
167 if (s->slice_mode == SM_DYN_SLICE) {
168 if (s->max_nal_size){
169 param.uiMaxNalSize = s->max_nal_size;
170 param.sSpatialLayers[0].sSliceCfg.sSliceArgument.uiSliceSizeConstraint = s->max_nal_size;
172 av_log(avctx, AV_LOG_ERROR, "Invalid -max_nal_size, "
173 "specify a valid max_nal_size to use -slice_mode dyn\n");
178 if ((*s->encoder)->InitializeExt(s->encoder, ¶m) != cmResultSuccess) {
179 av_log(avctx, AV_LOG_ERROR, "Initialize failed\n");
183 if (avctx->flags & AV_CODEC_FLAG_GLOBAL_HEADER) {
184 SFrameBSInfo fbi = { 0 };
186 (*s->encoder)->EncodeParameterSets(s->encoder, &fbi);
187 for (i = 0; i < fbi.sLayerInfo[0].iNalCount; i++)
188 size += fbi.sLayerInfo[0].pNalLengthInByte[i];
189 avctx->extradata = av_mallocz(size + AV_INPUT_BUFFER_PADDING_SIZE);
190 if (!avctx->extradata) {
191 err = AVERROR(ENOMEM);
194 avctx->extradata_size = size;
195 memcpy(avctx->extradata, fbi.sLayerInfo[0].pBsBuf, size);
198 props = ff_add_cpb_side_data(avctx);
200 err = AVERROR(ENOMEM);
203 props->max_bitrate = param.iMaxBitrate;
204 props->avg_bitrate = param.iTargetBitrate;
209 svc_encode_close(avctx);
213 static int svc_encode_frame(AVCodecContext *avctx, AVPacket *avpkt,
214 const AVFrame *frame, int *got_packet)
216 SVCContext *s = avctx->priv_data;
217 SFrameBSInfo fbi = { 0 };
220 SSourcePicture sp = { 0 };
221 int size = 0, layer, first_layer = 0;
222 int layer_size[MAX_LAYER_NUM_OF_FRAME] = { 0 };
224 sp.iColorFormat = videoFormatI420;
225 for (i = 0; i < 3; i++) {
226 sp.iStride[i] = frame->linesize[i];
227 sp.pData[i] = frame->data[i];
229 sp.iPicWidth = avctx->width;
230 sp.iPicHeight = avctx->height;
232 encoded = (*s->encoder)->EncodeFrame(s->encoder, &sp, &fbi);
233 if (encoded != cmResultSuccess) {
234 av_log(avctx, AV_LOG_ERROR, "EncodeFrame failed\n");
235 return AVERROR_UNKNOWN;
237 if (fbi.eFrameType == videoFrameTypeSkip) {
239 av_log(avctx, AV_LOG_DEBUG, "frame skipped\n");
243 // Normal frames are returned with one single layer, while IDR
244 // frames have two layers, where the first layer contains the SPS/PPS.
245 // If using global headers, don't include the SPS/PPS in the returned
246 // packet - thus, only return one layer.
247 if (avctx->flags & AV_CODEC_FLAG_GLOBAL_HEADER)
248 first_layer = fbi.iLayerNum - 1;
250 for (layer = first_layer; layer < fbi.iLayerNum; layer++) {
251 for (i = 0; i < fbi.sLayerInfo[layer].iNalCount; i++)
252 layer_size[layer] += fbi.sLayerInfo[layer].pNalLengthInByte[i];
253 size += layer_size[layer];
255 av_log(avctx, AV_LOG_DEBUG, "%d slices\n", fbi.sLayerInfo[fbi.iLayerNum - 1].iNalCount);
257 if ((ret = ff_alloc_packet2(avctx, avpkt, size, size))) {
258 av_log(avctx, AV_LOG_ERROR, "Error getting output packet\n");
262 for (layer = first_layer; layer < fbi.iLayerNum; layer++) {
263 memcpy(avpkt->data + size, fbi.sLayerInfo[layer].pBsBuf, layer_size[layer]);
264 size += layer_size[layer];
266 avpkt->pts = frame->pts;
267 if (fbi.eFrameType == videoFrameTypeIDR)
268 avpkt->flags |= AV_PKT_FLAG_KEY;
273 AVCodec ff_libopenh264_encoder = {
274 .name = "libopenh264",
275 .long_name = NULL_IF_CONFIG_SMALL("OpenH264 H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10"),
276 .type = AVMEDIA_TYPE_VIDEO,
277 .id = AV_CODEC_ID_H264,
278 .priv_data_size = sizeof(SVCContext),
279 .init = svc_encode_init,
280 .encode2 = svc_encode_frame,
281 .close = svc_encode_close,
282 .capabilities = AV_CODEC_CAP_AUTO_THREADS,
283 .pix_fmts = (const enum AVPixelFormat[]){ AV_PIX_FMT_YUV420P,
285 .priv_class = &class,