FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups 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 #include <x265.h>
24 
25 #include "libavutil/internal.h"
26 #include "libavutil/common.h"
27 #include "libavutil/opt.h"
28 #include "libavutil/pixdesc.h"
29 #include "avcodec.h"
30 #include "internal.h"
31 
32 #if defined(_MSC_VER)
33 #define X265_API_IMPORTS 1
34 #endif
35 
36 typedef struct libx265Context {
37  const AVClass *class;
38 
39  x265_encoder *encoder;
40  x265_param *params;
43 
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  av_freep(&ctx->header);
70 
71  x265_param_free(ctx->params);
72 
73  if (ctx->encoder)
74  x265_encoder_close(ctx->encoder);
75 
76  return 0;
77 }
78 
80 {
81  libx265Context *ctx = avctx->priv_data;
82  x265_nal *nal;
83  uint8_t *buf;
84  int sar_num, sar_den;
85  int nnal;
86  int ret;
87  int i;
88 
92  av_log(avctx, AV_LOG_ERROR,
93  "4:4:4 support is not fully defined for HEVC yet. "
94  "Set -strict experimental to encode anyway.\n");
95  return AVERROR(ENOSYS);
96  }
97 
98  avctx->coded_frame = av_frame_alloc();
99  if (!avctx->coded_frame) {
100  av_log(avctx, AV_LOG_ERROR, "Could not allocate frame.\n");
101  return AVERROR(ENOMEM);
102  }
103 
104  ctx->params = x265_param_alloc();
105  if (!ctx->params) {
106  av_log(avctx, AV_LOG_ERROR, "Could not allocate x265 param structure.\n");
107  return AVERROR(ENOMEM);
108  }
109 
110  if (x265_param_default_preset(ctx->params, ctx->preset, ctx->tune) < 0) {
111  av_log(avctx, AV_LOG_ERROR, "Invalid preset or tune.\n");
112  return AVERROR(EINVAL);
113  }
114 
115  ctx->params->frameNumThreads = avctx->thread_count;
116  ctx->params->fpsNum = avctx->time_base.den;
117  ctx->params->fpsDenom = avctx->time_base.num * avctx->ticks_per_frame;
118  ctx->params->sourceWidth = avctx->width;
119  ctx->params->sourceHeight = avctx->height;
120 
121  av_reduce(&sar_num, &sar_den,
122  avctx->sample_aspect_ratio.num,
123  avctx->sample_aspect_ratio.den, 4096);
124  ctx->params->bEnableVuiParametersPresentFlag = 1;
125  ctx->params->bEnableAspectRatioIdc = 1;
126  ctx->params->aspectRatioIdc = 255;
127  ctx->params->sarWidth = sar_num;
128  ctx->params->sarHeight = sar_den;
129 
130  if (x265_max_bit_depth == 8)
131  ctx->params->internalBitDepth = 8;
132  else if (x265_max_bit_depth == 12)
133  ctx->params->internalBitDepth = 10;
134 
135  switch (avctx->pix_fmt) {
136  case AV_PIX_FMT_YUV420P:
138  ctx->params->internalCsp = X265_CSP_I420;
139  break;
140  case AV_PIX_FMT_YUV444P:
142  ctx->params->internalCsp = X265_CSP_I444;
143  break;
144  }
145 
146  if (avctx->bit_rate > 0) {
147  ctx->params->rc.bitrate = avctx->bit_rate / 1000;
148  ctx->params->rc.rateControlMode = X265_RC_ABR;
149  }
150 
151  if (ctx->x265_opts) {
152  AVDictionary *dict = NULL;
153  AVDictionaryEntry *en = NULL;
154 
155  if (!av_dict_parse_string(&dict, ctx->x265_opts, "=", ":", 0)) {
156  while ((en = av_dict_get(dict, "", en, AV_DICT_IGNORE_SUFFIX))) {
157  int parse_ret = x265_param_parse(ctx->params, en->key, en->value);
158 
159  switch (parse_ret) {
160  case X265_PARAM_BAD_NAME:
161  av_log(avctx, AV_LOG_WARNING,
162  "Unknown option: %s.\n", en->key);
163  break;
164  case X265_PARAM_BAD_VALUE:
165  av_log(avctx, AV_LOG_WARNING,
166  "Invalid value for %s: %s.\n", en->key, en->value);
167  break;
168  default:
169  break;
170  }
171  }
172  av_dict_free(&dict);
173  }
174  }
175 
176  ctx->encoder = x265_encoder_open(ctx->params);
177  if (!ctx->encoder) {
178  av_log(avctx, AV_LOG_ERROR, "Cannot open libx265 encoder.\n");
179  libx265_encode_close(avctx);
180  return AVERROR_INVALIDDATA;
181  }
182 
183  ret = x265_encoder_headers(ctx->encoder, &nal, &nnal);
184  if (ret < 0) {
185  av_log(avctx, AV_LOG_ERROR, "Cannot encode headers.\n");
186  libx265_encode_close(avctx);
187  return AVERROR_INVALIDDATA;
188  }
189 
190  for (i = 0; i < nnal; i++)
191  ctx->header_size += nal[i].sizeBytes;
192 
194  if (!ctx->header) {
195  av_log(avctx, AV_LOG_ERROR,
196  "Cannot allocate HEVC header of size %d.\n", ctx->header_size);
197  libx265_encode_close(avctx);
198  return AVERROR(ENOMEM);
199  }
200 
201  buf = ctx->header;
202  for (i = 0; i < nnal; i++) {
203  memcpy(buf, nal[i].payload, nal[i].sizeBytes);
204  buf += nal[i].sizeBytes;
205  }
206 
207  if (avctx->flags & CODEC_FLAG_GLOBAL_HEADER) {
208  avctx->extradata_size = ctx->header_size;
209  avctx->extradata = ctx->header;
210  ctx->header_size = 0;
211  ctx->header = NULL;
212  }
213 
214  return 0;
215 }
216 
218  const AVFrame *pic, int *got_packet)
219 {
220  libx265Context *ctx = avctx->priv_data;
221  x265_picture x265pic;
222  x265_picture x265pic_out = { { 0 } };
223  x265_nal *nal;
224  uint8_t *dst;
225  int payload = 0;
226  int nnal;
227  int ret;
228  int i;
229 
230  x265_picture_init(ctx->params, &x265pic);
231 
232  if (pic) {
233  for (i = 0; i < 3; i++) {
234  x265pic.planes[i] = pic->data[i];
235  x265pic.stride[i] = pic->linesize[i];
236  }
237 
238  x265pic.pts = pic->pts;
239  x265pic.bitDepth = av_pix_fmt_desc_get(avctx->pix_fmt)->comp[0].depth_minus1 + 1;
240  }
241 
242  ret = x265_encoder_encode(ctx->encoder, &nal, &nnal,
243  pic ? &x265pic : NULL, &x265pic_out);
244  if (ret < 0)
245  return AVERROR_EXTERNAL;
246 
247  if (!nnal)
248  return 0;
249 
250  for (i = 0; i < nnal; i++)
251  payload += nal[i].sizeBytes;
252 
253  payload += ctx->header_size;
254 
255  ret = ff_alloc_packet(pkt, payload);
256  if (ret < 0) {
257  av_log(avctx, AV_LOG_ERROR, "Error getting output packet.\n");
258  return ret;
259  }
260  dst = pkt->data;
261 
262  if (ctx->header) {
263  memcpy(dst, ctx->header, ctx->header_size);
264  dst += ctx->header_size;
265 
266  av_freep(&ctx->header);
267  ctx->header_size = 0;
268  }
269 
270  for (i = 0; i < nnal; i++) {
271  memcpy(dst, nal[i].payload, nal[i].sizeBytes);
272  dst += nal[i].sizeBytes;
273 
274  if (is_keyframe(nal[i].type))
275  pkt->flags |= AV_PKT_FLAG_KEY;
276  }
277 
278  pkt->pts = x265pic_out.pts;
279  pkt->dts = x265pic_out.dts;
280 
281  *got_packet = 1;
282  return 0;
283 }
284 
285 static const enum AVPixelFormat x265_csp_eight[] = {
289 };
290 
291 static const enum AVPixelFormat x265_csp_twelve[] = {
297 };
298 
300 {
301  if (x265_max_bit_depth == 8)
302  codec->pix_fmts = x265_csp_eight;
303  else if (x265_max_bit_depth == 12)
304  codec->pix_fmts = x265_csp_twelve;
305 }
306 
307 #define OFFSET(x) offsetof(libx265Context, x)
308 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
309 static const AVOption options[] = {
310  { "preset", "set the x265 preset", OFFSET(preset), AV_OPT_TYPE_STRING, { 0 }, 0, 0, VE },
311  { "tune", "set the x265 tune parameter", OFFSET(tune), AV_OPT_TYPE_STRING, { 0 }, 0, 0, VE },
312  { "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 },
313  { NULL }
314 };
315 
316 static const AVClass class = {
317  .class_name = "libx265",
318  .item_name = av_default_item_name,
319  .option = options,
321 };
322 
324  .name = "libx265",
325  .long_name = NULL_IF_CONFIG_SMALL("libx265 H.265 / HEVC"),
326  .type = AVMEDIA_TYPE_VIDEO,
327  .id = AV_CODEC_ID_HEVC,
328  .init = libx265_encode_init,
329  .init_static_data = libx265_encode_init_csp,
330  .encode2 = libx265_encode_frame,
331  .close = libx265_encode_close,
332  .priv_data_size = sizeof(libx265Context),
333  .priv_class = &class,
334  .capabilities = CODEC_CAP_DELAY | CODEC_CAP_AUTO_THREADS,
335 };