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