[FFmpeg-devel] [PATCH] Add libx265 encoder
Clément Bœsch
u at pkh.me
Tue Feb 11 20:12:26 CET 2014
On Tue, Feb 11, 2014 at 06:39:50PM +0000, Derek Buitenhuis wrote:
[...]
> +enabled libx265 && require_pkg_config x265 x265.h x265_encoder_encode &&
> + { check_cpp_condition x265.h "X265_BUILD >= 5" ||
> + die "ERROR: libx265 version must be >= 5."; }
maybe require_pkg_config "x265 >= 5" x265.h x265_encoder_encode
> enabled libxavs && require libxavs xavs.h xavs_encoder_encode -lxavs
> enabled libxvid && require libxvid xvid.h xvid_global -lxvidcore
> enabled libzmq && require_pkg_config libzmq zmq.h zmq_ctx_new
> diff --git a/libavcodec/Makefile b/libavcodec/Makefile
> index 05463a0..3c3b4ff 100644
> --- a/libavcodec/Makefile
> +++ b/libavcodec/Makefile
> @@ -742,6 +742,7 @@ OBJS-$(CONFIG_LIBVPX_VP9_ENCODER) += libvpxenc.o libvpx.o
> OBJS-$(CONFIG_LIBWAVPACK_ENCODER) += libwavpackenc.o
> OBJS-$(CONFIG_LIBWEBP_ENCODER) += libwebpenc.o
> OBJS-$(CONFIG_LIBX264_ENCODER) += libx264.o
> +OBJS-$(CONFIG_LIBX265_ENCODER) += libx265.o
> OBJS-$(CONFIG_LIBXAVS_ENCODER) += libxavs.o
> OBJS-$(CONFIG_LIBXVID_ENCODER) += libxvid.o
> OBJS-$(CONFIG_LIBZVBI_TELETEXT_DECODER) += libzvbi-teletextdec.o
> diff --git a/libavcodec/allcodecs.c b/libavcodec/allcodecs.c
> index cf11f9c..715837e 100644
> --- a/libavcodec/allcodecs.c
> +++ b/libavcodec/allcodecs.c
> @@ -516,6 +516,7 @@ void avcodec_register_all(void)
> REGISTER_ENCODER(LIBWEBP, libwebp);
> REGISTER_ENCODER(LIBX264, libx264);
> REGISTER_ENCODER(LIBX264RGB, libx264rgb);
> + REGISTER_ENCODER(LIBX265, libx265);
> REGISTER_ENCODER(LIBXAVS, libxavs);
> REGISTER_ENCODER(LIBXVID, libxvid);
> REGISTER_DECODER(LIBZVBI_TELETEXT, libzvbi_teletext);
> diff --git a/libavcodec/libx265.c b/libavcodec/libx265.c
> new file mode 100644
> index 0000000..a655dc0
> --- /dev/null
> +++ b/libavcodec/libx265.c
> @@ -0,0 +1,279 @@
> +/*
> + * libx265 encoder
> + *
probably more appropriate as a /** @file ... */
> + * Copyright (c) 2013-2014 Derek Buitenhuis
> + *
> + * This file is part of Libav.
We tend to use another project name here.
> + *
> + * Libav is free software; you can redistribute it and/or
> + * modify it under the terms of the GNU Lesser General Public
> + * License as published by the Free Software Foundation; either
> + * version 2.1 of the License, or (at your option) any later version.
> + *
> + * Libav is distributed in the hope that it will be useful,
> + * but WITHOUT ANY WARRANTY; without even the implied warranty of
> + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
> + * Lesser General Public License for more details.
> + *
> + * You should have received a copy of the GNU Lesser General Public
> + * License along with Libav; if not, write to the Free Software
> + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
> + */
> +
> +#include "libavutil/internal.h"
> +#include "libavutil/common.h"
> +#include "libavutil/opt.h"
> +#include "libavutil/pixdesc.h"
> +#include "avcodec.h"
> +#include "internal.h"
> +
> +#include <x265.h>
> +
> +typedef struct libx265Context {
> + x265_encoder *encoder;
> + x265_param *params;
> + uint8_t *header;
> + int header_size;
> +
> + char *preset;
> + char *tune;
> + char *x265_opts;
> +} libx265Context;
> +
> +static av_cold int libx265_encode_close(AVCodecContext *avctx)
> +{
> + libx265Context *ctx = avctx->priv_data;
> +
> + av_freep(&avctx->coded_frame);
av_frame_free()?
> + av_freep(&ctx->header);
> +
> + if (ctx->params)
> + x265_param_free(ctx->params);
> +
> + if (ctx->encoder)
> + x265_encoder_close(ctx->encoder);
> +
I guess it's pointless to ask if those function are smart enough to deal
with NULL pointers.
> + return 0;
> +}
> +
> +static av_cold int libx265_encode_init(AVCodecContext *avctx)
> +{
> + libx265Context *ctx = avctx->priv_data;
> + x265_nal *nal;
> + uint8_t *buf;
> + int nnal;
> + int ret;
> + int i;
> +
> + avctx->coded_frame = av_frame_alloc();
> + if (!avctx->coded_frame) {
> + av_log(avctx, AV_LOG_ERROR, "Could not allocate frame.\n");
> + return AVERROR(ENOMEM);
> + }
> +
> + ctx->params = x265_param_alloc();
> + if (!ctx->params) {
> + av_log(avctx, AV_LOG_ERROR, "Could not allocate x265 param structure.\n");
> + return AVERROR(ENOMEM);
> + }
> +
> + x265_param_default(ctx->params);
> + if (x265_param_default_preset(ctx->params, ctx->preset, ctx->tune) < 0)
> + av_log(avctx, AV_LOG_WARNING, "Invalid preset or tune.\n");
> +
> + ctx->params->frameNumThreads = avctx->thread_count;
> + ctx->params->frameRate = (int) (avctx->time_base.den / avctx->time_base.num);
> + ctx->params->sourceWidth = avctx->width;
> + ctx->params->sourceHeight = avctx->height;
> + ctx->params->inputBitDepth = av_pix_fmt_desc_get(avctx->pix_fmt)->comp[0].depth_minus1 + 1;
> +
> + if (avctx->bit_rate > 0) {
> + ctx->params->rc.bitrate = avctx->bit_rate / 1000;
> + ctx->params->rc.rateControlMode = X265_RC_ABR;
> + }
> +
> + if (ctx->x265_opts) {
> + AVDictionary *dict = NULL;
> + AVDictionaryEntry *en = NULL;
> +
> + if (!av_dict_parse_string(&dict, ctx->x265_opts, "=", ":", 0)) {
> + while ((en = av_dict_get(dict, "", en, AV_DICT_IGNORE_SUFFIX))) {
> + int parse_ret = x265_param_parse(ctx->params, en->key, en->value);
> +
> + switch (parse_ret) {
> + case X265_PARAM_BAD_NAME:
> + av_log(avctx, AV_LOG_WARNING,
> + "Unknown option: %s.\n", en->key);
> + break;
> + case X265_PARAM_BAD_VALUE:
> + av_log(avctx, AV_LOG_WARNING,
> + "Invalid value for %s: %s.\n", en->key, en->value);
> + break;
> + default:
> + break;
> + }
> + }
> + av_dict_free(&dict);
> + }
> + }
> +
> + if (avctx->width % ctx->params->maxCUSize) {
> + av_log(avctx, AV_LOG_ERROR,
> + "libx265 requires a width that is a multiple of %d.\n",
> + ctx->params->maxCUSize);
> + libx265_encode_close(avctx);
> + return AVERROR_INVALIDDATA;
invalid data doesn't refer to invalid user input data, but invalid data
stream. You probably want to use AVERROR(EINVAL). Same below.
> + }
> +
> + if (avctx->height % 8) {
> + av_log(avctx, AV_LOG_ERROR,
> + "libx265 requires a height that is a multiple of 8.\n");
> + libx265_encode_close(avctx);
> + return AVERROR_INVALIDDATA;
> + }
> +
> + ctx->encoder = x265_encoder_open(ctx->params);
> + if (!ctx->encoder) {
> + av_log(avctx, AV_LOG_ERROR, "Cannot open libx265 encoder.\n");
> + libx265_encode_close(avctx);
> + return AVERROR_INVALIDDATA;
I think you want AVERROR_EXTERNAL.
> + }
> +
> + ret = x265_encoder_headers(ctx->encoder, &nal, &nnal);
> + if (ret < 0) {
> + av_log(avctx, AV_LOG_ERROR, "Cannot encode headers.\n");
> + libx265_encode_close(avctx);
> + return AVERROR_INVALIDDATA;
> + }
> +
> + for (i = 0; i < nnal; i++)
> + ctx->header_size += nal[i].sizeBytes;
> +
> + ctx->header = av_malloc(ctx->header_size);
> + if (!ctx->header) {
> + av_log(avctx, AV_LOG_ERROR, "Cannot allocate HEVC header.\n");
Since you're being pedantic about printing error message, you probably
want to print the size here.
> + libx265_encode_close(avctx);
> + return AVERROR(ENOMEM);
> + }
> +
> + buf = ctx->header;
> + for (i = 0; i < nnal; i++) {
> + memcpy(buf, nal[i].payload, nal[i].sizeBytes);
> + buf += nal[i].sizeBytes;
> + }
> +
> + return 0;
> +}
> +
> +static int libx265_encode_frame(AVCodecContext *avctx, AVPacket *pkt,
> + const AVFrame *pic, int *got_packet)
> +{
> + libx265Context *ctx = avctx->priv_data;
> + x265_picture x265pic;
> + x265_picture x265pic_out;
> + x265_nal *nal;
> + uint8_t *dst;
> + int payload = 0;
> + int nnal;
> + int ret;
> + int i;
> +
> + memset(&x265pic_out, 0, sizeof(x265pic_out));
{0} raises random warnings?
> +
> + if (pic) {
> + for (i = 0; i < 3; i++) {
> + x265pic.planes[i] = pic->data[i];
> + x265pic.stride[i] = pic->linesize[i];
> + }
> +
> + x265pic.pts = pic->pts;
> + }
> +
> + ret = x265_encoder_encode(ctx->encoder, &nal, &nnal,
> + pic ? &x265pic : NULL, &x265pic_out);
> + if (ret < 0)
> + return AVERROR_UNKNOWN;
> +
> + if (!nnal)
> + return 0;
> +
> + for (i = 0; i < nnal; i++)
> + payload += nal[i].sizeBytes;
> +
> + payload += ctx->header_size;
> +
> + ret = ff_alloc_packet(pkt, payload);
> + if (ret < 0) {
> + av_log(avctx, AV_LOG_ERROR, "Error getting output packet.\n");
> + return ret;
> + }
> + dst = pkt->data;
> +
> + if (ctx->header) {
> + memcpy(dst, ctx->header, ctx->header_size);
> + dst += ctx->header_size;
> +
> + av_freep(&ctx->header);
> + ctx->header_size = 0;
> + }
> +
> + for (i = 0; i < nnal; i++) {
> + memcpy(dst, nal[i].payload, nal[i].sizeBytes);
> + dst += nal[i].sizeBytes;
> + }
> +
> + pkt->pts = x265pic_out.pts;
> + pkt->dts = x265pic_out.dts;
> +
> + *got_packet = 1;
> + return 0;
> +}
> +
> +static const enum AVPixelFormat x265_csp_eight[] = {
> + AV_PIX_FMT_YUV420P,
> + AV_PIX_FMT_NONE
> +};
> +
> +static const enum AVPixelFormat x265_csp_twelve[] = {
> + AV_PIX_FMT_YUV420P,
> + AV_PIX_FMT_YUV420P10,
> + AV_PIX_FMT_NONE
> +};
> +
> +static av_cold void libx265_encode_init_csp(AVCodec *codec)
> +{
> + if (x265_max_bit_depth == 8)
> + codec->pix_fmts = x265_csp_eight;
> + else if (x265_max_bit_depth == 12)
> + codec->pix_fmts = x265_csp_twelve;
> +}
> +
> +#define OFFSET(x) offsetof(libx265Context, x)
> +#define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
> +static const AVOption options[] = {
> + { "preset", "Set the x265 preset.", OFFSET(preset), AV_OPT_TYPE_STRING, { 0 }, 0, 0, VE },
> + { "tune", "Set teh x265 tune parameter.", OFFSET(tune), AV_OPT_TYPE_STRING, { 0 }, 0, 0, VE },
> + { "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 },
undo the initial cap and remove trailing '.' for current style.
> + { NULL },
trailing comma uneeded.
> +};
> +
> +static const AVClass class = {
> + .class_name = "libx265",
> + .item_name = av_default_item_name,
> + .option = options,
> + .version = LIBAVUTIL_VERSION_INT,
> +};
> +
> +AVCodec ff_libx265_encoder = {
> + .name = "libx265",
> + .type = AVMEDIA_TYPE_VIDEO,
> + .id = AV_CODEC_ID_HEVC,
> + .init = libx265_encode_init,
> + .init_static_data = libx265_encode_init_csp,
> + .encode2 = libx265_encode_frame,
> + .close = libx265_encode_close,
> + .priv_data_size = sizeof(libx265Context),
> + .priv_class = &class,
> + .long_name = NULL_IF_CONFIG_SMALL("libx265 H.265 / HEVC"),
nit: probably belongs below .name; I think that's the current convention.
> + .capabilities = CODEC_CAP_DELAY | CODEC_CAP_AUTO_THREADS,
> +};
> diff --git a/libavcodec/version.h b/libavcodec/version.h
> index 240113b..a698321 100644
> --- a/libavcodec/version.h
> +++ b/libavcodec/version.h
> @@ -29,7 +29,7 @@
> #include "libavutil/version.h"
>
> #define LIBAVCODEC_VERSION_MAJOR 55
> -#define LIBAVCODEC_VERSION_MINOR 50
> +#define LIBAVCODEC_VERSION_MINOR 51
> #define LIBAVCODEC_VERSION_MICRO 100
>
> #define LIBAVCODEC_VERSION_INT AV_VERSION_INT(LIBAVCODEC_VERSION_MAJOR, \
> --
> 1.9.0.rc3
>
Changelog entry welcome.
--
Clément B.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 490 bytes
Desc: not available
URL: <http://ffmpeg.org/pipermail/ffmpeg-devel/attachments/20140211/5fd40b44/attachment.asc>
More information about the ffmpeg-devel
mailing list