FFmpeg  2.6.3
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
libx265.c
Go to the documentation of this file.
1 /*
2  * libx265 encoder
3  *
4  * Copyright (c) 2013-2014 Derek Buitenhuis
5  *
6  * This file is part of FFmpeg.
7  *
8  * FFmpeg is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public
10  * License as published by the Free Software Foundation; either
11  * version 2.1 of the License, or (at your option) any later version.
12  *
13  * FFmpeg is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with FFmpeg; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21  */
22 
23 #if defined(_MSC_VER)
24 #define X265_API_IMPORTS 1
25 #endif
26 
27 #include <x265.h>
28 #include <float.h>
29 
30 #include "libavutil/internal.h"
31 #include "libavutil/common.h"
32 #include "libavutil/opt.h"
33 #include "libavutil/pixdesc.h"
34 #include "avcodec.h"
35 #include "internal.h"
36 
37 typedef struct libx265Context {
38  const AVClass *class;
39 
40  x265_encoder *encoder;
41  x265_param *params;
42 
43  float crf;
44  char *preset;
45  char *tune;
46  char *x265_opts;
48 
49 static int is_keyframe(NalUnitType naltype)
50 {
51  switch (naltype) {
52  case NAL_UNIT_CODED_SLICE_BLA_W_LP:
53  case NAL_UNIT_CODED_SLICE_BLA_W_RADL:
54  case NAL_UNIT_CODED_SLICE_BLA_N_LP:
55  case NAL_UNIT_CODED_SLICE_IDR_W_RADL:
56  case NAL_UNIT_CODED_SLICE_IDR_N_LP:
57  case NAL_UNIT_CODED_SLICE_CRA:
58  return 1;
59  default:
60  return 0;
61  }
62 }
63 
65 {
66  libx265Context *ctx = avctx->priv_data;
67 
68  av_frame_free(&avctx->coded_frame);
69 
70  x265_param_free(ctx->params);
71 
72  if (ctx->encoder)
73  x265_encoder_close(ctx->encoder);
74 
75  return 0;
76 }
77 
79 {
80  libx265Context *ctx = avctx->priv_data;
81 
84  av_log(avctx, AV_LOG_ERROR,
85  "4:2:2 and 4:4:4 support is not fully defined for HEVC yet. "
86  "Set -strict experimental to encode anyway.\n");
87  return AVERROR(ENOSYS);
88  }
89 
90  avctx->coded_frame = av_frame_alloc();
91  if (!avctx->coded_frame) {
92  av_log(avctx, AV_LOG_ERROR, "Could not allocate frame.\n");
93  return AVERROR(ENOMEM);
94  }
95 
96  ctx->params = x265_param_alloc();
97  if (!ctx->params) {
98  av_log(avctx, AV_LOG_ERROR, "Could not allocate x265 param structure.\n");
99  return AVERROR(ENOMEM);
100  }
101 
102  if (x265_param_default_preset(ctx->params, ctx->preset, ctx->tune) < 0) {
103  av_log(avctx, AV_LOG_ERROR, "Invalid preset or tune.\n");
104  return AVERROR(EINVAL);
105  }
106 
107  ctx->params->frameNumThreads = avctx->thread_count;
108  ctx->params->fpsNum = avctx->time_base.den;
109  ctx->params->fpsDenom = avctx->time_base.num * avctx->ticks_per_frame;
110  ctx->params->sourceWidth = avctx->width;
111  ctx->params->sourceHeight = avctx->height;
112  ctx->params->bEnablePsnr = !!(avctx->flags & CODEC_FLAG_PSNR);
113 
114  if (avctx->sample_aspect_ratio.num > 0 && avctx->sample_aspect_ratio.den > 0) {
115  char sar[12];
116  int sar_num, sar_den;
117 
118  av_reduce(&sar_num, &sar_den,
119  avctx->sample_aspect_ratio.num,
120  avctx->sample_aspect_ratio.den, 65535);
121  snprintf(sar, sizeof(sar), "%d:%d", sar_num, sar_den);
122  if (x265_param_parse(ctx->params, "sar", sar) == X265_PARAM_BAD_VALUE) {
123  av_log(avctx, AV_LOG_ERROR, "Invalid SAR: %d:%d.\n", sar_num, sar_den);
124  return AVERROR_INVALIDDATA;
125  }
126  }
127 
128  switch (avctx->pix_fmt) {
129  case AV_PIX_FMT_YUV420P:
131  ctx->params->internalCsp = X265_CSP_I420;
132  break;
133  case AV_PIX_FMT_YUV422P:
135  ctx->params->internalCsp = X265_CSP_I422;
136  break;
137  case AV_PIX_FMT_YUV444P:
139  ctx->params->internalCsp = X265_CSP_I444;
140  break;
141  }
142 
143  if (ctx->crf >= 0) {
144  char crf[6];
145 
146  snprintf(crf, sizeof(crf), "%2.2f", ctx->crf);
147  if (x265_param_parse(ctx->params, "crf", crf) == X265_PARAM_BAD_VALUE) {
148  av_log(avctx, AV_LOG_ERROR, "Invalid crf: %2.2f.\n", ctx->crf);
149  return AVERROR(EINVAL);
150  }
151  } else if (avctx->bit_rate > 0) {
152  ctx->params->rc.bitrate = avctx->bit_rate / 1000;
153  ctx->params->rc.rateControlMode = X265_RC_ABR;
154  }
155 
156  if (!(avctx->flags & CODEC_FLAG_GLOBAL_HEADER))
157  ctx->params->bRepeatHeaders = 1;
158 
159  if (ctx->x265_opts) {
160  AVDictionary *dict = NULL;
161  AVDictionaryEntry *en = NULL;
162 
163  if (!av_dict_parse_string(&dict, ctx->x265_opts, "=", ":", 0)) {
164  while ((en = av_dict_get(dict, "", en, AV_DICT_IGNORE_SUFFIX))) {
165  int parse_ret = x265_param_parse(ctx->params, en->key, en->value);
166 
167  switch (parse_ret) {
168  case X265_PARAM_BAD_NAME:
169  av_log(avctx, AV_LOG_WARNING,
170  "Unknown option: %s.\n", en->key);
171  break;
172  case X265_PARAM_BAD_VALUE:
173  av_log(avctx, AV_LOG_WARNING,
174  "Invalid value for %s: %s.\n", en->key, en->value);
175  break;
176  default:
177  break;
178  }
179  }
180  av_dict_free(&dict);
181  }
182  }
183 
184  ctx->encoder = x265_encoder_open(ctx->params);
185  if (!ctx->encoder) {
186  av_log(avctx, AV_LOG_ERROR, "Cannot open libx265 encoder.\n");
187  libx265_encode_close(avctx);
188  return AVERROR_INVALIDDATA;
189  }
190 
191  if (avctx->flags & CODEC_FLAG_GLOBAL_HEADER) {
192  x265_nal *nal;
193  int nnal;
194 
195  avctx->extradata_size = x265_encoder_headers(ctx->encoder, &nal, &nnal);
196  if (avctx->extradata_size <= 0) {
197  av_log(avctx, AV_LOG_ERROR, "Cannot encode headers.\n");
198  libx265_encode_close(avctx);
199  return AVERROR_INVALIDDATA;
200  }
201 
203  if (!avctx->extradata) {
204  av_log(avctx, AV_LOG_ERROR,
205  "Cannot allocate HEVC header of size %d.\n", avctx->extradata_size);
206  libx265_encode_close(avctx);
207  return AVERROR(ENOMEM);
208  }
209 
210  memcpy(avctx->extradata, nal[0].payload, avctx->extradata_size);
211  }
212 
213  return 0;
214 }
215 
217  const AVFrame *pic, int *got_packet)
218 {
219  libx265Context *ctx = avctx->priv_data;
220  x265_picture x265pic;
221  x265_picture x265pic_out = { { 0 } };
222  x265_nal *nal;
223  uint8_t *dst;
224  int payload = 0;
225  int nnal;
226  int ret;
227  int i;
228 
229  x265_picture_init(ctx->params, &x265pic);
230 
231  if (pic) {
232  for (i = 0; i < 3; i++) {
233  x265pic.planes[i] = pic->data[i];
234  x265pic.stride[i] = pic->linesize[i];
235  }
236 
237  x265pic.pts = pic->pts;
238  x265pic.bitDepth = av_pix_fmt_desc_get(avctx->pix_fmt)->comp[0].depth_minus1 + 1;
239 
240  x265pic.sliceType = pic->pict_type == AV_PICTURE_TYPE_I ? X265_TYPE_I :
241  pic->pict_type == AV_PICTURE_TYPE_P ? X265_TYPE_P :
242  pic->pict_type == AV_PICTURE_TYPE_B ? X265_TYPE_B :
243  X265_TYPE_AUTO;
244  }
245 
246  ret = x265_encoder_encode(ctx->encoder, &nal, &nnal,
247  pic ? &x265pic : NULL, &x265pic_out);
248  if (ret < 0)
249  return AVERROR_EXTERNAL;
250 
251  if (!nnal)
252  return 0;
253 
254  for (i = 0; i < nnal; i++)
255  payload += nal[i].sizeBytes;
256 
257  ret = ff_alloc_packet(pkt, payload);
258  if (ret < 0) {
259  av_log(avctx, AV_LOG_ERROR, "Error getting output packet.\n");
260  return ret;
261  }
262  dst = pkt->data;
263 
264  for (i = 0; i < nnal; i++) {
265  memcpy(dst, nal[i].payload, nal[i].sizeBytes);
266  dst += nal[i].sizeBytes;
267 
268  if (is_keyframe(nal[i].type))
269  pkt->flags |= AV_PKT_FLAG_KEY;
270  }
271 
272  pkt->pts = x265pic_out.pts;
273  pkt->dts = x265pic_out.dts;
274 
275  *got_packet = 1;
276  return 0;
277 }
278 
279 static const enum AVPixelFormat x265_csp_eight[] = {
284 };
285 
286 static const enum AVPixelFormat x265_csp_twelve[] = {
294 };
295 
297 {
298  if (x265_max_bit_depth == 8)
299  codec->pix_fmts = x265_csp_eight;
300  else if (x265_max_bit_depth == 12)
301  codec->pix_fmts = x265_csp_twelve;
302 }
303 
304 #define OFFSET(x) offsetof(libx265Context, x)
305 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
306 static const AVOption options[] = {
307  { "crf", "set the x265 crf", OFFSET(crf), AV_OPT_TYPE_FLOAT, { .dbl = -1 }, -1, FLT_MAX, VE },
308  { "preset", "set the x265 preset", OFFSET(preset), AV_OPT_TYPE_STRING, { 0 }, 0, 0, VE },
309  { "tune", "set the x265 tune parameter", OFFSET(tune), AV_OPT_TYPE_STRING, { 0 }, 0, 0, VE },
310  { "x265-params", "set the x265 configuration using a :-separated list of key=value parameters", OFFSET(x265_opts), AV_OPT_TYPE_STRING, { 0 }, 0, 0, VE },
311  { NULL }
312 };
313 
314 static const AVClass class = {
315  .class_name = "libx265",
316  .item_name = av_default_item_name,
317  .option = options,
319 };
320 
321 static const AVCodecDefault x265_defaults[] = {
322  { "b", "0" },
323  { NULL },
324 };
325 
327  .name = "libx265",
328  .long_name = NULL_IF_CONFIG_SMALL("libx265 H.265 / HEVC"),
329  .type = AVMEDIA_TYPE_VIDEO,
330  .id = AV_CODEC_ID_HEVC,
331  .init = libx265_encode_init,
332  .init_static_data = libx265_encode_init_csp,
333  .encode2 = libx265_encode_frame,
334  .close = libx265_encode_close,
335  .priv_data_size = sizeof(libx265Context),
336  .priv_class = &class,
337  .defaults = x265_defaults,
338  .capabilities = CODEC_CAP_DELAY | CODEC_CAP_AUTO_THREADS,
339 };
#define NULL
Definition: coverity.c:32
static const AVOption options[]
Definition: libx265.c:306
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:59
const AVPixFmtDescriptor * av_pix_fmt_desc_get(enum AVPixelFormat pix_fmt)
Definition: pixdesc.c:2029
This structure describes decoded (raw) audio or video data.
Definition: frame.h:163
AVOption.
Definition: opt.h:255
static int is_keyframe(NalUnitType naltype)
Definition: libx265.c:49
planar YUV 4:4:4, 24bpp, (1 Cr & Cb sample per 1x1 Y samples)
Definition: pixfmt.h:73
#define AV_LOG_WARNING
Something somehow does not look correct.
Definition: log.h:181
#define LIBAVUTIL_VERSION_INT
Definition: version.h:62
float crf
Definition: libx265.c:43
AVFrame * coded_frame
the picture in the bitstream
Definition: avcodec.h:2743
int num
numerator
Definition: rational.h:44
AVRational sample_aspect_ratio
sample aspect ratio (0 if unknown) That is the width of a pixel divided by the height of the pixel...
Definition: avcodec.h:1621
enum AVPixelFormat pix_fmt
Pixel format, see AV_PIX_FMT_xxx.
Definition: avcodec.h:1442
x265_param * params
Definition: libx265.c:41
static AVPacket pkt
AVCodec.
Definition: avcodec.h:3173
uint8_t log2_chroma_w
Amount to shift the luma width right to find the chroma width.
Definition: pixdesc.h:80
AVRational time_base
This is the fundamental unit of time (in seconds) in terms of which frame timestamps are represented...
Definition: avcodec.h:1367
#define CODEC_FLAG_PSNR
error[?] variables will be set during encoding.
Definition: avcodec.h:744
const char * class_name
The name of the class; usually it is the same name as the context structure type to which the AVClass...
Definition: log.h:71
AVComponentDescriptor comp[4]
Parameters that describe how pixels are packed.
Definition: pixdesc.h:100
uint8_t
#define av_cold
Definition: attributes.h:74
#define av_malloc(s)
AVFrame * av_frame_alloc(void)
Allocate an AVFrame and set its fields to default values.
Definition: frame.c:135
AVOptions.
#define CODEC_FLAG_GLOBAL_HEADER
Place global headers in extradata instead of every keyframe.
Definition: avcodec.h:756
#define VE
Definition: libx265.c:305
int64_t pts
Presentation timestamp in time_base units (time when frame should be shown to user).
Definition: frame.h:249
uint8_t * extradata
some codecs need / can use extradata like Huffman tables.
Definition: avcodec.h:1353
AVDictionaryEntry * av_dict_get(const AVDictionary *m, const char *key, const AVDictionaryEntry *prev, int flags)
Get a dictionary entry with matching key.
Definition: dict.c:39
uint8_t * data
Definition: avcodec.h:1160
char * x265_opts
Definition: libx265.c:46
#define av_log(a,...)
#define AV_PKT_FLAG_KEY
The packet contains a keyframe.
Definition: avcodec.h:1206
uint16_t depth_minus1
Number of bits in the component minus 1.
Definition: pixdesc.h:57
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:175
#define CODEC_CAP_DELAY
Encoder or decoder requires flushing with NULL input at the end in order to give the complete and cor...
Definition: avcodec.h:822
av_default_item_name
#define AVERROR(e)
Definition: error.h:43
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:148
static int libx265_encode_frame(AVCodecContext *avctx, AVPacket *pkt, const AVFrame *pic, int *got_packet)
Definition: libx265.c:216
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:180
void av_dict_free(AVDictionary **pm)
Free all the memory allocated for an AVDictionary struct and all keys and values. ...
Definition: dict.c:194
int flags
CODEC_FLAG_*.
Definition: avcodec.h:1333
const char * name
Name of the codec implementation.
Definition: avcodec.h:3180
#define AV_PIX_FMT_YUV444P10
Definition: pixfmt.h:360
Libavcodec external API header.
int flags
A combination of AV_PKT_FLAG values.
Definition: avcodec.h:1166
planar YUV 4:2:2, 16bpp, (1 Cr & Cb sample per 2x1 Y samples)
Definition: pixfmt.h:72
int av_reduce(int *dst_num, int *dst_den, int64_t num, int64_t den, int64_t max)
Reduce a fraction.
Definition: rational.c:35
common internal API header
#define FF_INPUT_BUFFER_PADDING_SIZE
Required number of additionally allocated bytes at the end of the input bitstream for decoding...
Definition: avcodec.h:628
#define FF_COMPLIANCE_EXPERIMENTAL
Allow nonstandardized experimental things.
Definition: avcodec.h:2546
static av_cold void libx265_encode_init_csp(AVCodec *codec)
Definition: libx265.c:296
int bit_rate
the average bitrate
Definition: avcodec.h:1303
enum AVPixelFormat * pix_fmts
array of supported pixel formats, or NULL if unknown, array is terminated by -1
Definition: avcodec.h:3194
enum AVPictureType pict_type
Picture type of the frame.
Definition: frame.h:234
AVCodec ff_libx265_encoder
Definition: libx265.c:326
static av_cold int libx265_encode_init(AVCodecContext *avctx)
Definition: libx265.c:78
ret
Definition: avfilter.c:974
int width
picture width / height.
Definition: avcodec.h:1412
#define CODEC_CAP_AUTO_THREADS
Codec supports avctx->thread_count == 0 (auto).
Definition: avcodec.h:876
int ff_alloc_packet(AVPacket *avpkt, int size)
Definition: utils.c:1776
int ticks_per_frame
For some codecs, the time base is closer to the field rate than the frame rate.
Definition: avcodec.h:1376
#define OFFSET(x)
Definition: libx265.c:304
int thread_count
thread count is used to decide how many independent tasks should be passed to execute() ...
Definition: avcodec.h:2751
char * preset
Definition: libx265.c:44
int av_dict_parse_string(AVDictionary **pm, const char *str, const char *key_val_sep, const char *pairs_sep, int flags)
Parse the key/value pairs list and add the parsed entries to a dictionary.
Definition: dict.c:171
int linesize[AV_NUM_DATA_POINTERS]
For video, size in bytes of each picture line.
Definition: frame.h:191
main external API structure.
Definition: avcodec.h:1239
GLint GLenum type
Definition: opengl_enc.c:105
int extradata_size
Definition: avcodec.h:1354
#define AV_PIX_FMT_YUV420P10
Definition: pixfmt.h:358
Describe the class of an AVClass context structure.
Definition: log.h:66
#define snprintf
Definition: snprintf.h:34
char * tune
Definition: libx265.c:45
#define AV_PIX_FMT_YUV422P10
Definition: pixfmt.h:359
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
Definition: frame.h:174
preset
Definition: vf_curves.c:46
planar YUV 4:2:0, 12bpp, (1 Cr & Cb sample per 2x2 Y samples)
Definition: pixfmt.h:68
common internal api header.
common internal and external API header
static enum AVPixelFormat x265_csp_twelve[]
Definition: libx265.c:286
Bi-dir predicted.
Definition: avutil.h:269
char * key
Definition: dict.h:87
int den
denominator
Definition: rational.h:45
void * priv_data
Definition: avcodec.h:1281
static const AVCodecDefault x265_defaults[]
Definition: libx265.c:321
char * value
Definition: dict.h:88
static av_cold int libx265_encode_close(AVCodecContext *avctx)
Definition: libx265.c:64
static enum AVPixelFormat x265_csp_eight[]
Definition: libx265.c:279
int64_t dts
Decompression timestamp in AVStream->time_base units; the time at which the packet is decompressed...
Definition: avcodec.h:1159
#define AV_DICT_IGNORE_SUFFIX
Return first entry in a dictionary whose first part corresponds to the search key, ignoring the suffix of the found key string.
Definition: dict.h:72
static const AVCodecDefault defaults[]
Definition: dcaenc.c:951
#define AVERROR_EXTERNAL
Generic error in an external library.
Definition: error.h:57
AVPixelFormat
Pixel format.
Definition: pixfmt.h:66
This structure stores compressed data.
Definition: avcodec.h:1137
int strict_std_compliance
strictly follow the standard (MPEG4, ...).
Definition: avcodec.h:2541
int64_t pts
Presentation timestamp in AVStream->time_base units; the time at which the decompressed packet will b...
Definition: avcodec.h:1153
Predicted.
Definition: avutil.h:268
x265_encoder * encoder
Definition: libx265.c:40