Libav
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 Libav.
7  *
8  * Libav 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  * Libav 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 Libav; 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 
29 #include "libavutil/internal.h"
30 #include "libavutil/common.h"
31 #include "libavutil/opt.h"
32 #include "libavutil/pixdesc.h"
33 #include "avcodec.h"
34 #include "internal.h"
35 
36 typedef struct libx265Context {
37  const AVClass *class;
38 
39  x265_encoder *encoder;
40  x265_param *params;
41 
42  char *preset;
43  char *tune;
44  char *x265_opts;
46 
47 static int is_keyframe(NalUnitType naltype)
48 {
49  switch (naltype) {
50  case NAL_UNIT_CODED_SLICE_BLA_W_LP:
51  case NAL_UNIT_CODED_SLICE_BLA_W_RADL:
52  case NAL_UNIT_CODED_SLICE_BLA_N_LP:
53  case NAL_UNIT_CODED_SLICE_IDR_W_RADL:
54  case NAL_UNIT_CODED_SLICE_IDR_N_LP:
55  case NAL_UNIT_CODED_SLICE_CRA:
56  return 1;
57  default:
58  return 0;
59  }
60 }
61 
63 {
64  libx265Context *ctx = avctx->priv_data;
65 
66  av_frame_free(&avctx->coded_frame);
67 
68  x265_param_free(ctx->params);
69 
70  if (ctx->encoder)
71  x265_encoder_close(ctx->encoder);
72 
73  return 0;
74 }
75 
77 {
78  libx265Context *ctx = avctx->priv_data;
79  x265_nal *nal;
80  char sar[12];
81  int sar_num, sar_den;
82  int nnal;
83 
86  av_log(avctx, AV_LOG_ERROR,
87  "4:2:2 and 4:4:4 support is not fully defined for HEVC yet. "
88  "Set -strict experimental to encode anyway.\n");
89  return AVERROR(ENOSYS);
90  }
91 
92  avctx->coded_frame = av_frame_alloc();
93  if (!avctx->coded_frame) {
94  av_log(avctx, AV_LOG_ERROR, "Could not allocate frame.\n");
95  return AVERROR(ENOMEM);
96  }
97 
98  ctx->params = x265_param_alloc();
99  if (!ctx->params) {
100  av_log(avctx, AV_LOG_ERROR, "Could not allocate x265 param structure.\n");
101  return AVERROR(ENOMEM);
102  }
103 
104  if (x265_param_default_preset(ctx->params, ctx->preset, ctx->tune) < 0) {
105  av_log(avctx, AV_LOG_ERROR, "Invalid preset or tune.\n");
106  return AVERROR(EINVAL);
107  }
108 
109  ctx->params->frameNumThreads = avctx->thread_count;
110  ctx->params->fpsNum = avctx->time_base.den;
111  ctx->params->fpsDenom = avctx->time_base.num * avctx->ticks_per_frame;
112  ctx->params->sourceWidth = avctx->width;
113  ctx->params->sourceHeight = avctx->height;
114 
115  if (avctx->sample_aspect_ratio.num > 0 && avctx->sample_aspect_ratio.den > 0) {
116  av_reduce(&sar_num, &sar_den,
117  avctx->sample_aspect_ratio.num,
118  avctx->sample_aspect_ratio.den, 65535);
119  snprintf(sar, sizeof(sar), "%d:%d", sar_num, sar_den);
120  if (x265_param_parse(ctx->params, "sar", sar) == X265_PARAM_BAD_VALUE) {
121  av_log(avctx, AV_LOG_ERROR, "Invalid SAR: %d:%d.\n", sar_num, sar_den);
122  return AVERROR_INVALIDDATA;
123  }
124  }
125 
126  switch (avctx->pix_fmt) {
127  case AV_PIX_FMT_YUV420P:
129  ctx->params->internalCsp = X265_CSP_I420;
130  break;
131  case AV_PIX_FMT_YUV422P:
133  ctx->params->internalCsp = X265_CSP_I422;
134  break;
135  case AV_PIX_FMT_YUV444P:
137  ctx->params->internalCsp = X265_CSP_I444;
138  break;
139  }
140 
141  if (avctx->bit_rate > 0) {
142  ctx->params->rc.bitrate = avctx->bit_rate / 1000;
143  ctx->params->rc.rateControlMode = X265_RC_ABR;
144  }
145 
146  if (!(avctx->flags & CODEC_FLAG_GLOBAL_HEADER))
147  ctx->params->bRepeatHeaders = 1;
148 
149  if (ctx->x265_opts) {
150  AVDictionary *dict = NULL;
151  AVDictionaryEntry *en = NULL;
152 
153  if (!av_dict_parse_string(&dict, ctx->x265_opts, "=", ":", 0)) {
154  while ((en = av_dict_get(dict, "", en, AV_DICT_IGNORE_SUFFIX))) {
155  int parse_ret = x265_param_parse(ctx->params, en->key, en->value);
156 
157  switch (parse_ret) {
158  case X265_PARAM_BAD_NAME:
159  av_log(avctx, AV_LOG_WARNING,
160  "Unknown option: %s.\n", en->key);
161  break;
162  case X265_PARAM_BAD_VALUE:
163  av_log(avctx, AV_LOG_WARNING,
164  "Invalid value for %s: %s.\n", en->key, en->value);
165  break;
166  default:
167  break;
168  }
169  }
170  av_dict_free(&dict);
171  }
172  }
173 
174  ctx->encoder = x265_encoder_open(ctx->params);
175  if (!ctx->encoder) {
176  av_log(avctx, AV_LOG_ERROR, "Cannot open libx265 encoder.\n");
177  libx265_encode_close(avctx);
178  return AVERROR_INVALIDDATA;
179  }
180 
181  if (avctx->flags & CODEC_FLAG_GLOBAL_HEADER) {
182  avctx->extradata_size = x265_encoder_headers(ctx->encoder, &nal, &nnal);
183  if (avctx->extradata_size <= 0) {
184  av_log(avctx, AV_LOG_ERROR, "Cannot encode headers.\n");
185  libx265_encode_close(avctx);
186  return AVERROR_INVALIDDATA;
187  }
188 
190  if (!avctx->extradata) {
191  av_log(avctx, AV_LOG_ERROR,
192  "Cannot allocate HEVC header of size %d.\n", avctx->extradata_size);
193  libx265_encode_close(avctx);
194  return AVERROR(ENOMEM);
195  }
196 
197  memcpy(avctx->extradata, nal[0].payload, avctx->extradata_size);
198  }
199 
200  return 0;
201 }
202 
204  const AVFrame *pic, int *got_packet)
205 {
206  libx265Context *ctx = avctx->priv_data;
207  x265_picture x265pic;
208  x265_picture x265pic_out = { { 0 } };
209  x265_nal *nal;
210  uint8_t *dst;
211  int payload = 0;
212  int nnal;
213  int ret;
214  int i;
215 
216  x265_picture_init(ctx->params, &x265pic);
217 
218  if (pic) {
219  for (i = 0; i < 3; i++) {
220  x265pic.planes[i] = pic->data[i];
221  x265pic.stride[i] = pic->linesize[i];
222  }
223 
224  x265pic.pts = pic->pts;
225  x265pic.bitDepth = av_pix_fmt_desc_get(avctx->pix_fmt)->comp[0].depth_minus1 + 1;
226  }
227 
228  ret = x265_encoder_encode(ctx->encoder, &nal, &nnal,
229  pic ? &x265pic : NULL, &x265pic_out);
230  if (ret < 0)
231  return AVERROR_UNKNOWN;
232 
233  if (!nnal)
234  return 0;
235 
236  for (i = 0; i < nnal; i++)
237  payload += nal[i].sizeBytes;
238 
239  ret = ff_alloc_packet(pkt, payload);
240  if (ret < 0) {
241  av_log(avctx, AV_LOG_ERROR, "Error getting output packet.\n");
242  return ret;
243  }
244  dst = pkt->data;
245 
246  for (i = 0; i < nnal; i++) {
247  memcpy(dst, nal[i].payload, nal[i].sizeBytes);
248  dst += nal[i].sizeBytes;
249 
250  if (is_keyframe(nal[i].type))
251  pkt->flags |= AV_PKT_FLAG_KEY;
252  }
253 
254  pkt->pts = x265pic_out.pts;
255  pkt->dts = x265pic_out.dts;
256 
257  *got_packet = 1;
258  return 0;
259 }
260 
261 static const enum AVPixelFormat x265_csp_eight[] = {
266 };
267 
268 static const enum AVPixelFormat x265_csp_twelve[] = {
276 };
277 
279 {
280  if (x265_max_bit_depth == 8)
281  codec->pix_fmts = x265_csp_eight;
282  else if (x265_max_bit_depth == 12)
283  codec->pix_fmts = x265_csp_twelve;
284 }
285 
286 #define OFFSET(x) offsetof(libx265Context, x)
287 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
288 static const AVOption options[] = {
289  { "preset", "set the x265 preset", OFFSET(preset), AV_OPT_TYPE_STRING, { 0 }, 0, 0, VE },
290  { "tune", "set the x265 tune parameter", OFFSET(tune), AV_OPT_TYPE_STRING, { 0 }, 0, 0, VE },
291  { "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 },
292  { NULL }
293 };
294 
295 static const AVClass class = {
296  .class_name = "libx265",
297  .item_name = av_default_item_name,
298  .option = options,
300 };
301 
303  .name = "libx265",
304  .long_name = NULL_IF_CONFIG_SMALL("libx265 H.265 / HEVC"),
305  .type = AVMEDIA_TYPE_VIDEO,
306  .id = AV_CODEC_ID_HEVC,
307  .init = libx265_encode_init,
308  .init_static_data = libx265_encode_init_csp,
309  .encode2 = libx265_encode_frame,
310  .close = libx265_encode_close,
311  .priv_data_size = sizeof(libx265Context),
312  .priv_class = &class,
313  .capabilities = CODEC_CAP_DELAY | CODEC_CAP_AUTO_THREADS,
314 };
#define FF_COMPLIANCE_EXPERIMENTAL
Allow nonstandardized experimental things.
Definition: avcodec.h:2362
static const AVOption options[]
Definition: libx265.c:288
void * av_malloc(size_t size)
Allocate a block of size bytes with alignment suitable for all memory accesses (including vectors if ...
Definition: mem.c:62
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:54
const AVPixFmtDescriptor * av_pix_fmt_desc_get(enum AVPixelFormat pix_fmt)
Definition: pixdesc.c:1599
This structure describes decoded (raw) audio or video data.
Definition: frame.h:135
AVOption.
Definition: opt.h:234
static int is_keyframe(NalUnitType naltype)
Definition: libx265.c:47
planar YUV 4:4:4, 24bpp, (1 Cr & Cb sample per 1x1 Y samples)
Definition: pixfmt.h:70
#define AV_LOG_WARNING
Something somehow does not look correct.
Definition: log.h:129
AVFrame * coded_frame
the picture in the bitstream
Definition: avcodec.h:2548
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:1445
enum AVPixelFormat pix_fmt
Pixel format, see AV_PIX_FMT_xxx.
Definition: avcodec.h:1270
x265_param * params
Definition: libx265.c:40
AVCodec.
Definition: avcodec.h:2812
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:1175
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:38
AVComponentDescriptor comp[4]
Parameters that describe how pixels are packed.
Definition: pixdesc.h:97
uint8_t
#define av_cold
Definition: attributes.h:66
AVFrame * av_frame_alloc(void)
Allocate an AVFrame and set its fields to default values.
Definition: frame.c:57
AVOptions.
#define CODEC_FLAG_GLOBAL_HEADER
Place global headers in extradata instead of every keyframe.
Definition: avcodec.h:657
#define VE
Definition: libx265.c:287
int64_t pts
Presentation timestamp in time_base units (time when frame should be shown to user).
Definition: frame.h:211
uint8_t * extradata
some codecs need / can use extradata like Huffman tables.
Definition: avcodec.h:1164
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:38
uint8_t * data
Definition: avcodec.h:973
char * x265_opts
Definition: libx265.c:44
#define AV_PKT_FLAG_KEY
The packet contains a keyframe.
Definition: avcodec.h:1019
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:123
#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:713
#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:69
static int libx265_encode_frame(AVCodecContext *avctx, AVPacket *pkt, const AVFrame *pic, int *got_packet)
Definition: libx265.c:203
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:145
void av_dict_free(AVDictionary **pm)
Free all the memory allocated for an AVDictionary struct and all keys and values. ...
Definition: dict.c:170
int flags
CODEC_FLAG_*.
Definition: avcodec.h:1144
void av_log(void *avcl, int level, const char *fmt,...)
Definition: log.c:169
const char * name
Name of the codec implementation.
Definition: avcodec.h:2819
#define AV_PIX_FMT_YUV444P10
Definition: pixfmt.h:245
int flags
A combination of AV_PKT_FLAG values.
Definition: avcodec.h:979
planar YUV 4:2:2, 16bpp, (1 Cr & Cb sample per 2x1 Y samples)
Definition: pixfmt.h:69
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:531
static av_cold void libx265_encode_init_csp(AVCodec *codec)
Definition: libx265.c:278
int bit_rate
the average bitrate
Definition: avcodec.h:1114
enum AVPixelFormat * pix_fmts
array of supported pixel formats, or NULL if unknown, array is terminated by -1
Definition: avcodec.h:2833
AVCodec ff_libx265_encoder
Definition: libx265.c:302
static av_cold int libx265_encode_init(AVCodecContext *avctx)
Definition: libx265.c:76
int width
picture width / height.
Definition: avcodec.h:1229
#define CODEC_CAP_AUTO_THREADS
Codec supports avctx->thread_count == 0 (auto).
Definition: avcodec.h:767
int ff_alloc_packet(AVPacket *avpkt, int size)
Check AVPacket size and/or allocate data.
Definition: utils.c:1257
int ticks_per_frame
For some codecs, the time base is closer to the field rate than the frame rate.
Definition: avcodec.h:1184
#define OFFSET(x)
Definition: libx265.c:286
LIBAVUTIL_VERSION_INT
Definition: eval.c:55
int thread_count
thread count is used to decide how many independent tasks should be passed to execute() ...
Definition: avcodec.h:2556
char * preset
Definition: libx265.c:42
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 to a dictionary.
Definition: dict.c:147
NULL
Definition: eval.c:55
Libavcodec external API header.
int linesize[AV_NUM_DATA_POINTERS]
For video, size in bytes of each picture line.
Definition: frame.h:153
av_default_item_name
Definition: dnxhdenc.c:52
main external API structure.
Definition: avcodec.h:1050
int extradata_size
Definition: avcodec.h:1165
#define AV_PIX_FMT_YUV420P10
Definition: pixfmt.h:243
Describe the class of an AVClass context structure.
Definition: log.h:33
char * tune
Definition: libx265.c:43
#define AV_PIX_FMT_YUV422P10
Definition: pixfmt.h:244
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
Definition: frame.h:141
planar YUV 4:2:0, 12bpp, (1 Cr & Cb sample per 2x2 Y samples)
Definition: pixfmt.h:65
common internal api header.
common internal and external API header
static enum AVPixelFormat x265_csp_twelve[]
Definition: libx265.c:268
char * key
Definition: dict.h:75
int den
denominator
Definition: rational.h:45
#define AVERROR_UNKNOWN
Unknown error, typically from an external library.
Definition: error.h:61
void * priv_data
Definition: avcodec.h:1092
char * value
Definition: dict.h:76
static av_cold int libx265_encode_close(AVCodecContext *avctx)
Definition: libx265.c:62
static enum AVPixelFormat x265_csp_eight[]
Definition: libx265.c:261
int64_t dts
Decompression timestamp in AVStream->time_base units; the time at which the packet is decompressed...
Definition: avcodec.h:972
#define AV_DICT_IGNORE_SUFFIX
Definition: dict.h:62
AVPixelFormat
Pixel format.
Definition: pixfmt.h:63
This structure stores compressed data.
Definition: avcodec.h:950
int strict_std_compliance
strictly follow the standard (MPEG4, ...).
Definition: avcodec.h:2357
int64_t pts
Presentation timestamp in AVStream->time_base units; the time at which the decompressed packet will b...
Definition: avcodec.h:966
x265_encoder * encoder
Definition: libx265.c:39