FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
libopenh264enc.c
Go to the documentation of this file.
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;
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 = {
60 };
61 
63 {
64  SVCContext *s = avctx->priv_data;
65 
66  if (s->encoder)
67  WelsDestroySVCEncoder(s->encoder);
68  return 0;
69 }
70 
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];
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 
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),
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 };
#define NULL
Definition: coverity.c:32
const char * s
Definition: avisynth_c.h:631
This structure describes decoded (raw) audio or video data.
Definition: frame.h:171
AVOption.
Definition: opt.h:255
#define LIBAVUTIL_VERSION_INT
Definition: version.h:62
static av_cold int init(AVCodecContext *avctx)
Definition: avrndec.c:35
int num
numerator
Definition: rational.h:44
AVCodec.
Definition: avcodec.h:3181
Macro definitions for various function/variable attributes.
AVRational time_base
This is the fundamental unit of time (in seconds) in terms of which frame timestamps are represented...
Definition: avcodec.h:1369
#define av_cold
Definition: attributes.h:74
AVOptions.
#define CODEC_FLAG_GLOBAL_HEADER
Place global headers in extradata instead of every keyframe.
Definition: avcodec.h:758
int64_t pts
Presentation timestamp in time_base units (time when frame should be shown to user).
Definition: frame.h:257
uint8_t * extradata
some codecs need / can use extradata like Huffman tables.
Definition: avcodec.h:1355
static AVFrame * frame
int coder_type
coder type
Definition: avcodec.h:2380
uint8_t * data
Definition: avcodec.h:1162
#define OFFSET(x)
#define sp
Definition: regdef.h:63
ptrdiff_t size
Definition: opengl_enc.c:101
ISVCEncoder * encoder
#define av_log(a,...)
#define AV_PKT_FLAG_KEY
The packet contains a keyframe.
Definition: avcodec.h:1208
static const AVOption options[]
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:176
int profile
Definition: mxfenc.c:1804
av_default_item_name
#define AVERROR(e)
Definition: error.h:43
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:175
#define AV_LOG_DEBUG
Stuff which is only useful for libav* developers.
Definition: log.h:197
const AVClass * av_class
int flags
CODEC_FLAG_*.
Definition: avcodec.h:1335
int rc_max_rate
maximum bitrate
Definition: avcodec.h:2327
const char * name
Name of the codec implementation.
Definition: avcodec.h:3188
static av_cold int svc_encode_close(AVCodecContext *avctx)
#define FFMAX(a, b)
Definition: common.h:64
Libavcodec external API header.
int flags
A combination of AV_PKT_FLAG values.
Definition: avcodec.h:1168
static av_cold int svc_encode_init(AVCodecContext *avctx)
#define FF_INPUT_BUFFER_PADDING_SIZE
Required number of additionally allocated bytes at the end of the input bitstream for decoding...
Definition: avcodec.h:630
int bit_rate
the average bitrate
Definition: avcodec.h:1305
#define VE
ret
Definition: avfilter.c:974
int width
picture width / height.
Definition: avcodec.h:1414
#define CODEC_CAP_AUTO_THREADS
Codec supports avctx->thread_count == 0 (auto).
Definition: avcodec.h:878
int ff_alloc_packet(AVPacket *avpkt, int size)
Definition: utils.c:1792
int thread_count
thread count is used to decide how many independent tasks should be passed to execute() ...
Definition: avcodec.h:2753
int linesize[AV_NUM_DATA_POINTERS]
For video, size in bytes of each picture line.
Definition: frame.h:199
main external API structure.
Definition: avcodec.h:1241
char * profile
int extradata_size
Definition: avcodec.h:1356
Describe the class of an AVClass context structure.
Definition: log.h:67
static int svc_encode_frame(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame, int *got_packet)
#define FF_CODER_TYPE_AC
Definition: avcodec.h:2369
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
Definition: frame.h:182
int gop_size
the number of pictures in a group of pictures, or 0 for intra_only
Definition: avcodec.h:1435
planar YUV 4:2:0, 12bpp, (1 Cr & Cb sample per 2x2 Y samples)
Definition: pixfmt.h:63
common internal api header.
common internal and external API header
int den
denominator
Definition: rational.h:45
#define AVERROR_UNKNOWN
Unknown error, typically from an external library.
Definition: error.h:71
int slices
Number of slices.
Definition: avcodec.h:1976
void * priv_data
Definition: avcodec.h:1283
AVCodec ff_libopenh264_encoder
AVPixelFormat
Pixel format.
Definition: pixfmt.h:61
This structure stores compressed data.
Definition: avcodec.h:1139
void * av_mallocz(size_t size)
Allocate a block of size bytes with alignment suitable for all memory accesses (including vectors if ...
Definition: mem.c:250
int64_t pts
Presentation timestamp in AVStream->time_base units; the time at which the decompressed packet will b...
Definition: avcodec.h:1155