Deprecate avctx.coded_frame
[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/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", "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 static av_cold int svc_encode_close(AVCodecContext *avctx)
63 {
64     SVCContext *s = avctx->priv_data;
65
66     if (s->encoder)
67         WelsDestroySVCEncoder(s->encoder);
68     return 0;
69 }
70
71 static av_cold int svc_encode_init(AVCodecContext *avctx)
72 {
73     SVCContext *s = avctx->priv_data;
74     SEncParamExt param = { 0 };
75     int err = AVERROR_UNKNOWN;
76
77     // Mingw GCC < 4.7 on x86_32 uses an incorrect/buggy ABI for the WelsGetCodecVersion
78     // function (for functions returning larger structs), thus skip the check in those
79     // configurations.
80 #if !defined(_WIN32) || !defined(__GNUC__) || !ARCH_X86_32 || AV_GCC_VERSION_AT_LEAST(4, 7)
81     OpenH264Version libver = WelsGetCodecVersion();
82     if (memcmp(&libver, &g_stCodecVersion, sizeof(libver))) {
83         av_log(avctx, AV_LOG_ERROR, "Incorrect library version loaded\n");
84         return AVERROR(EINVAL);
85     }
86 #endif
87
88     if (WelsCreateSVCEncoder(&s->encoder)) {
89         av_log(avctx, AV_LOG_ERROR, "Unable to create encoder\n");
90         return AVERROR_UNKNOWN;
91     }
92
93     (*s->encoder)->GetDefaultParams(s->encoder, &param);
94
95     param.fMaxFrameRate              = avctx->time_base.den / avctx->time_base.num;
96     param.iPicWidth                  = avctx->width;
97     param.iPicHeight                 = avctx->height;
98     param.iTargetBitrate             = avctx->bit_rate;
99     param.iMaxBitrate                = FFMAX(avctx->rc_max_rate, avctx->bit_rate);
100     param.iRCMode                    = RC_QUALITY_MODE;
101     param.iTemporalLayerNum          = 1;
102     param.iSpatialLayerNum           = 1;
103     param.bEnableDenoise             = 0;
104     param.bEnableBackgroundDetection = 1;
105     param.bEnableAdaptiveQuant       = 1;
106     param.bEnableFrameSkip           = 0;
107     param.bEnableLongTermReference   = 0;
108     param.iLtrMarkPeriod             = 30;
109     param.uiIntraPeriod              = avctx->gop_size;
110 #if OPENH264_VER_AT_LEAST(1, 4)
111     param.eSpsPpsIdStrategy          = CONSTANT_ID;
112 #else
113     param.bEnableSpsPpsIdAddition    = 0;
114 #endif
115     param.bPrefixNalAddingCtrl       = 0;
116     param.iLoopFilterDisableIdc      = !s->loopfilter;
117     param.iEntropyCodingModeFlag     = 0;
118     param.iMultipleThreadIdc         = avctx->thread_count;
119     if (s->profile && !strcmp(s->profile, "main"))
120         param.iEntropyCodingModeFlag = 1;
121     else if (!s->profile && avctx->coder_type == FF_CODER_TYPE_AC)
122         param.iEntropyCodingModeFlag = 1;
123
124     param.sSpatialLayers[0].iVideoWidth         = param.iPicWidth;
125     param.sSpatialLayers[0].iVideoHeight        = param.iPicHeight;
126     param.sSpatialLayers[0].fFrameRate          = param.fMaxFrameRate;
127     param.sSpatialLayers[0].iSpatialBitrate     = param.iTargetBitrate;
128     param.sSpatialLayers[0].iMaxSpatialBitrate  = param.iMaxBitrate;
129
130     if (avctx->slices > 1)
131         s->slice_mode = SM_FIXEDSLCNUM_SLICE;
132     param.sSpatialLayers[0].sSliceCfg.uiSliceMode               = s->slice_mode;
133     param.sSpatialLayers[0].sSliceCfg.sSliceArgument.uiSliceNum = avctx->slices;
134
135     if ((*s->encoder)->InitializeExt(s->encoder, &param) != cmResultSuccess) {
136         av_log(avctx, AV_LOG_ERROR, "Initialize failed\n");
137         goto fail;
138     }
139
140     if (avctx->flags & CODEC_FLAG_GLOBAL_HEADER) {
141         SFrameBSInfo fbi = { 0 };
142         int i, size = 0;
143         (*s->encoder)->EncodeParameterSets(s->encoder, &fbi);
144         for (i = 0; i < fbi.sLayerInfo[0].iNalCount; i++)
145             size += fbi.sLayerInfo[0].pNalLengthInByte[i];
146         avctx->extradata = av_mallocz(size + FF_INPUT_BUFFER_PADDING_SIZE);
147         if (!avctx->extradata) {
148             err = AVERROR(ENOMEM);
149             goto fail;
150         }
151         avctx->extradata_size = size;
152         memcpy(avctx->extradata, fbi.sLayerInfo[0].pBsBuf, size);
153     }
154
155     return 0;
156
157 fail:
158     svc_encode_close(avctx);
159     return err;
160 }
161
162 static int svc_encode_frame(AVCodecContext *avctx, AVPacket *avpkt,
163                             const AVFrame *frame, int *got_packet)
164 {
165     SVCContext *s = avctx->priv_data;
166     SFrameBSInfo fbi = { 0 };
167     int i, ret;
168     int encoded;
169     SSourcePicture sp = { 0 };
170     int size = 0, layer, first_layer = 0;
171     int layer_size[MAX_LAYER_NUM_OF_FRAME] = { 0 };
172
173     sp.iColorFormat = videoFormatI420;
174     for (i = 0; i < 3; i++) {
175         sp.iStride[i] = frame->linesize[i];
176         sp.pData[i]   = frame->data[i];
177     }
178     sp.iPicWidth  = avctx->width;
179     sp.iPicHeight = avctx->height;
180
181     encoded = (*s->encoder)->EncodeFrame(s->encoder, &sp, &fbi);
182     if (encoded != cmResultSuccess) {
183         av_log(avctx, AV_LOG_ERROR, "EncodeFrame failed\n");
184         return AVERROR_UNKNOWN;
185     }
186     if (fbi.eFrameType == videoFrameTypeSkip) {
187         av_log(avctx, AV_LOG_DEBUG, "frame skipped\n");
188         return 0;
189     }
190     first_layer = 0;
191     // Normal frames are returned with one single layer, while IDR
192     // frames have two layers, where the first layer contains the SPS/PPS.
193     // If using global headers, don't include the SPS/PPS in the returned
194     // packet - thus, only return one layer.
195     if (avctx->flags & CODEC_FLAG_GLOBAL_HEADER)
196         first_layer = fbi.iLayerNum - 1;
197
198     for (layer = first_layer; layer < fbi.iLayerNum; layer++) {
199         for (i = 0; i < fbi.sLayerInfo[layer].iNalCount; i++)
200             layer_size[layer] += fbi.sLayerInfo[layer].pNalLengthInByte[i];
201         size += layer_size[layer];
202     }
203     av_log(avctx, AV_LOG_DEBUG, "%d slices\n", fbi.sLayerInfo[fbi.iLayerNum - 1].iNalCount);
204
205     if ((ret = ff_alloc_packet(avpkt, size))) {
206         av_log(avctx, AV_LOG_ERROR, "Error getting output packet\n");
207         return ret;
208     }
209     size = 0;
210     for (layer = first_layer; layer < fbi.iLayerNum; layer++) {
211         memcpy(avpkt->data + size, fbi.sLayerInfo[layer].pBsBuf, layer_size[layer]);
212         size += layer_size[layer];
213     }
214     avpkt->pts = frame->pts;
215     if (fbi.eFrameType == videoFrameTypeIDR)
216         avpkt->flags |= AV_PKT_FLAG_KEY;
217     *got_packet = 1;
218     return 0;
219 }
220
221 AVCodec ff_libopenh264_encoder = {
222     .name           = "libopenh264",
223     .long_name      = NULL_IF_CONFIG_SMALL("OpenH264 H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10"),
224     .type           = AVMEDIA_TYPE_VIDEO,
225     .id             = AV_CODEC_ID_H264,
226     .priv_data_size = sizeof(SVCContext),
227     .init           = svc_encode_init,
228     .encode2        = svc_encode_frame,
229     .close          = svc_encode_close,
230     .capabilities   = CODEC_CAP_AUTO_THREADS,
231     .pix_fmts       = (const enum AVPixelFormat[]){ AV_PIX_FMT_YUV420P,
232                                                     AV_PIX_FMT_NONE },
233     .priv_class     = &class,
234 };