FFmpeg
libkvazaar.c
Go to the documentation of this file.
1 /*
2  * libkvazaar encoder
3  *
4  * Copyright (c) 2015 Tampere University of Technology
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 <kvazaar.h>
24 #include <stdint.h>
25 #include <string.h>
26 
27 #include "libavutil/attributes.h"
28 #include "libavutil/avassert.h"
29 #include "libavutil/dict.h"
30 #include "libavutil/error.h"
31 #include "libavutil/imgutils.h"
32 #include "libavutil/internal.h"
33 #include "libavutil/log.h"
34 #include "libavutil/mem.h"
35 #include "libavutil/pixdesc.h"
36 #include "libavutil/opt.h"
37 
38 #include "avcodec.h"
39 #include "internal.h"
40 #include "packet_internal.h"
41 
42 typedef struct LibkvazaarContext {
43  const AVClass *class;
44 
45  const kvz_api *api;
46  kvz_encoder *encoder;
47  kvz_config *config;
48 
49  char *kvz_params;
51 
53 {
54  LibkvazaarContext *const ctx = avctx->priv_data;
55  const kvz_api *const api = ctx->api = kvz_api_get(8);
56  kvz_config *cfg = NULL;
57  kvz_encoder *enc = NULL;
58 
59  /* Kvazaar requires width and height to be multiples of eight. */
60  if (avctx->width % 8 || avctx->height % 8) {
61  av_log(avctx, AV_LOG_ERROR,
62  "Video dimensions are not a multiple of 8 (%dx%d).\n",
63  avctx->width, avctx->height);
64  return AVERROR(ENOSYS);
65  }
66 
67  ctx->config = cfg = api->config_alloc();
68  if (!cfg) {
69  av_log(avctx, AV_LOG_ERROR,
70  "Could not allocate kvazaar config structure.\n");
71  return AVERROR(ENOMEM);
72  }
73 
74  if (!api->config_init(cfg)) {
75  av_log(avctx, AV_LOG_ERROR,
76  "Could not initialize kvazaar config structure.\n");
77  return AVERROR_BUG;
78  }
79 
80  cfg->width = avctx->width;
81  cfg->height = avctx->height;
82 
83  if (avctx->framerate.num > 0 && avctx->framerate.den > 0) {
84  cfg->framerate_num = avctx->framerate.num;
85  cfg->framerate_denom = avctx->framerate.den;
86  } else {
87  if (avctx->ticks_per_frame > INT_MAX / avctx->time_base.num) {
88  av_log(avctx, AV_LOG_ERROR,
89  "Could not set framerate for kvazaar: integer overflow\n");
90  return AVERROR(EINVAL);
91  }
92  cfg->framerate_num = avctx->time_base.den;
93  cfg->framerate_denom = avctx->time_base.num * avctx->ticks_per_frame;
94  }
95  cfg->target_bitrate = avctx->bit_rate;
96  cfg->vui.sar_width = avctx->sample_aspect_ratio.num;
97  cfg->vui.sar_height = avctx->sample_aspect_ratio.den;
98  if (avctx->bit_rate) {
99  cfg->rc_algorithm = KVZ_LAMBDA;
100  }
101 
102  if (ctx->kvz_params) {
103  AVDictionary *dict = NULL;
104  if (!av_dict_parse_string(&dict, ctx->kvz_params, "=", ",", 0)) {
105  AVDictionaryEntry *entry = NULL;
106  while ((entry = av_dict_get(dict, "", entry, AV_DICT_IGNORE_SUFFIX))) {
107  if (!api->config_parse(cfg, entry->key, entry->value)) {
108  av_log(avctx, AV_LOG_WARNING, "Invalid option: %s=%s.\n",
109  entry->key, entry->value);
110  }
111  }
112  }
113  av_dict_free(&dict);
114  }
115 
116  ctx->encoder = enc = api->encoder_open(cfg);
117  if (!enc) {
118  av_log(avctx, AV_LOG_ERROR, "Could not open kvazaar encoder.\n");
119  return AVERROR_BUG;
120  }
121 
122  if (avctx->flags & AV_CODEC_FLAG_GLOBAL_HEADER) {
123  kvz_data_chunk *data_out = NULL;
124  kvz_data_chunk *chunk = NULL;
125  uint32_t len_out;
126  uint8_t *p;
127 
128  if (!api->encoder_headers(enc, &data_out, &len_out))
129  return AVERROR(ENOMEM);
130 
131  avctx->extradata = p = av_mallocz(len_out + AV_INPUT_BUFFER_PADDING_SIZE);
132  if (!p) {
133  ctx->api->chunk_free(data_out);
134  return AVERROR(ENOMEM);
135  }
136 
137  avctx->extradata_size = len_out;
138 
139  for (chunk = data_out; chunk != NULL; chunk = chunk->next) {
140  memcpy(p, chunk->data, chunk->len);
141  p += chunk->len;
142  }
143 
144  ctx->api->chunk_free(data_out);
145  }
146 
147  return 0;
148 }
149 
151 {
152  LibkvazaarContext *ctx = avctx->priv_data;
153 
154  if (ctx->api) {
155  ctx->api->encoder_close(ctx->encoder);
156  ctx->api->config_destroy(ctx->config);
157  }
158 
159  return 0;
160 }
161 
163  AVPacket *avpkt,
164  const AVFrame *frame,
165  int *got_packet_ptr)
166 {
167  LibkvazaarContext *ctx = avctx->priv_data;
168  kvz_picture *input_pic = NULL;
169  kvz_picture *recon_pic = NULL;
170  kvz_frame_info frame_info;
171  kvz_data_chunk *data_out = NULL;
172  uint32_t len_out = 0;
173  int retval = 0;
174  int pict_type;
175 
176  *got_packet_ptr = 0;
177 
178  if (frame) {
179  if (frame->width != ctx->config->width ||
180  frame->height != ctx->config->height) {
181  av_log(avctx, AV_LOG_ERROR,
182  "Changing video dimensions during encoding is not supported. "
183  "(changed from %dx%d to %dx%d)\n",
184  ctx->config->width, ctx->config->height,
185  frame->width, frame->height);
186  retval = AVERROR_INVALIDDATA;
187  goto done;
188  }
189 
190  if (frame->format != avctx->pix_fmt) {
191  av_log(avctx, AV_LOG_ERROR,
192  "Changing pixel format during encoding is not supported. "
193  "(changed from %s to %s)\n",
195  av_get_pix_fmt_name(frame->format));
196  retval = AVERROR_INVALIDDATA;
197  goto done;
198  }
199 
200  // Allocate input picture for kvazaar.
201  input_pic = ctx->api->picture_alloc(frame->width, frame->height);
202  if (!input_pic) {
203  av_log(avctx, AV_LOG_ERROR, "Failed to allocate picture.\n");
204  retval = AVERROR(ENOMEM);
205  goto done;
206  }
207 
208  // Copy pixels from frame to input_pic.
209  {
210  int dst_linesizes[4] = {
211  frame->width,
212  frame->width / 2,
213  frame->width / 2,
214  0
215  };
216  av_image_copy(input_pic->data, dst_linesizes,
217  (const uint8_t **)frame->data, frame->linesize,
218  frame->format, frame->width, frame->height);
219  }
220 
221  input_pic->pts = frame->pts;
222  }
223 
224  retval = ctx->api->encoder_encode(ctx->encoder,
225  input_pic,
226  &data_out, &len_out,
227  &recon_pic, NULL,
228  &frame_info);
229  if (!retval) {
230  av_log(avctx, AV_LOG_ERROR, "Failed to encode frame.\n");
231  retval = AVERROR_INVALIDDATA;
232  goto done;
233  } else
234  retval = 0; /* kvazaar returns 1 on success */
235 
236  if (data_out) {
237  kvz_data_chunk *chunk = NULL;
238  uint64_t written = 0;
239 
240  retval = ff_alloc_packet2(avctx, avpkt, len_out, len_out);
241  if (retval < 0) {
242  av_log(avctx, AV_LOG_ERROR, "Failed to allocate output packet.\n");
243  goto done;
244  }
245 
246  for (chunk = data_out; chunk != NULL; chunk = chunk->next) {
247  av_assert0(written + chunk->len <= len_out);
248  memcpy(avpkt->data + written, chunk->data, chunk->len);
249  written += chunk->len;
250  }
251 
252  avpkt->pts = recon_pic->pts;
253  avpkt->dts = recon_pic->dts;
254  avpkt->flags = 0;
255  // IRAP VCL NAL unit types span the range
256  // [BLA_W_LP (16), RSV_IRAP_VCL23 (23)].
257  if (frame_info.nal_unit_type >= KVZ_NAL_BLA_W_LP &&
258  frame_info.nal_unit_type <= KVZ_NAL_RSV_IRAP_VCL23) {
259  avpkt->flags |= AV_PKT_FLAG_KEY;
260  }
261 
262  switch (frame_info.slice_type) {
263  case KVZ_SLICE_I:
264  pict_type = AV_PICTURE_TYPE_I;
265  break;
266  case KVZ_SLICE_P:
267  pict_type = AV_PICTURE_TYPE_P;
268  break;
269  case KVZ_SLICE_B:
270  pict_type = AV_PICTURE_TYPE_B;
271  break;
272  default:
273  av_log(avctx, AV_LOG_ERROR, "Unknown picture type encountered.\n");
274  return AVERROR_EXTERNAL;
275  }
276 
277  ff_side_data_set_encoder_stats(avpkt, frame_info.qp * FF_QP2LAMBDA, NULL, 0, pict_type);
278 
279  *got_packet_ptr = 1;
280  }
281 
282 done:
283  ctx->api->picture_free(input_pic);
284  ctx->api->picture_free(recon_pic);
285  ctx->api->chunk_free(data_out);
286  return retval;
287 }
288 
289 static const enum AVPixelFormat pix_fmts[] = {
292 };
293 
294 #define OFFSET(x) offsetof(LibkvazaarContext, x)
295 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
296 static const AVOption options[] = {
297  { "kvazaar-params", "Set kvazaar parameters as a comma-separated list of key=value pairs.",
298  OFFSET(kvz_params), AV_OPT_TYPE_STRING, { .str = NULL }, 0, 0, VE },
299  { NULL },
300 };
301 
302 static const AVClass class = {
303  .class_name = "libkvazaar",
304  .item_name = av_default_item_name,
305  .option = options,
307 };
308 
309 static const AVCodecDefault defaults[] = {
310  { "b", "0" },
311  { NULL },
312 };
313 
315  .name = "libkvazaar",
316  .long_name = NULL_IF_CONFIG_SMALL("libkvazaar H.265 / HEVC"),
317  .type = AVMEDIA_TYPE_VIDEO,
318  .id = AV_CODEC_ID_HEVC,
320  .pix_fmts = pix_fmts,
321 
322  .priv_class = &class,
323  .priv_data_size = sizeof(LibkvazaarContext),
324  .defaults = defaults,
325 
327  .encode2 = libkvazaar_encode,
328  .close = libkvazaar_close,
329 
332 
333  .wrapper_name = "libkvazaar",
334 };
AVCodec
AVCodec.
Definition: codec.h:197
AV_LOG_WARNING
#define AV_LOG_WARNING
Something somehow does not look correct.
Definition: log.h:187
FF_CODEC_CAP_INIT_THREADSAFE
#define FF_CODEC_CAP_INIT_THREADSAFE
The codec does not modify any global variables in the init function, allowing to call the init functi...
Definition: internal.h:41
AVPixelFormat
AVPixelFormat
Pixel format.
Definition: pixfmt.h:64
LibkvazaarContext
Definition: libkvazaar.c:42
OFFSET
#define OFFSET(x)
Definition: libkvazaar.c:294
init
static av_cold int init(AVCodecContext *avctx)
Definition: avrndec.c:31
AVERROR
Filter the word “frame” indicates either a video frame or a group of audio as stored in an AVFrame structure Format for each input and each output the list of supported formats For video that means pixel format For audio that means channel sample they are references to shared objects When the negotiation mechanism computes the intersection of the formats supported at each end of a all references to both lists are replaced with a reference to the intersection And when a single format is eventually chosen for a link amongst the remaining all references to the list are updated That means that if a filter requires that its input and output have the same format amongst a supported all it has to do is use a reference to the same list of formats query_formats can leave some formats unset and return AVERROR(EAGAIN) to cause the negotiation mechanism toagain later. That can be used by filters with complex requirements to use the format negotiated on one link to set the formats supported on another. Frame references ownership and permissions
opt.h
ff_side_data_set_encoder_stats
int ff_side_data_set_encoder_stats(AVPacket *pkt, int quality, int64_t *error, int error_count, int pict_type)
Definition: avpacket.c:586
ff_libkvazaar_encoder
const AVCodec ff_libkvazaar_encoder
Definition: libkvazaar.c:314
options
static const AVOption options[]
Definition: libkvazaar.c:296
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:303
pixdesc.h
internal.h
AVPacket::data
uint8_t * data
Definition: packet.h:365
AVOption
AVOption.
Definition: opt.h:248
LibkvazaarContext::kvz_params
char * kvz_params
Definition: libkvazaar.c:49
AV_DICT_IGNORE_SUFFIX
#define AV_DICT_IGNORE_SUFFIX
Return first entry in a dictionary whose first part corresponds to the search key,...
Definition: dict.h:70
AVDictionary
Definition: dict.c:30
AV_PKT_FLAG_KEY
#define AV_PKT_FLAG_KEY
The packet contains a keyframe.
Definition: packet.h:396
AV_CODEC_FLAG_GLOBAL_HEADER
#define AV_CODEC_FLAG_GLOBAL_HEADER
Place global headers in extradata instead of every keyframe.
Definition: avcodec.h:306
AVCodecContext::framerate
AVRational framerate
Definition: avcodec.h:1816
libkvazaar_init
static av_cold int libkvazaar_init(AVCodecContext *avctx)
Definition: libkvazaar.c:52
AVCodecContext::flags
int flags
AV_CODEC_FLAG_*.
Definition: avcodec.h:581
AVRational::num
int num
Numerator.
Definition: rational.h:59
avassert.h
AV_LOG_ERROR
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:181
av_cold
#define av_cold
Definition: attributes.h:90
av_dict_get
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:40
AVCodecContext::extradata_size
int extradata_size
Definition: avcodec.h:603
LibkvazaarContext::encoder
kvz_encoder * encoder
Definition: libkvazaar.c:46
AVDictionaryEntry::key
char * key
Definition: dict.h:82
AVCodecContext::ticks_per_frame
int ticks_per_frame
For some codecs, the time base is closer to the field rate than the frame rate.
Definition: avcodec.h:633
AV_CODEC_CAP_OTHER_THREADS
#define AV_CODEC_CAP_OTHER_THREADS
Codec supports multithreading through a method other than slice- or frame-level multithreading.
Definition: codec.h:122
LibkvazaarContext::api
const kvz_api * api
Definition: libkvazaar.c:45
av_assert0
#define av_assert0(cond)
assert() equivalent, that is always enabled.
Definition: avassert.h:37
pix_fmts
static enum AVPixelFormat pix_fmts[]
Definition: libkvazaar.c:289
ctx
AVFormatContext * ctx
Definition: movenc.c:48
AV_PIX_FMT_YUV420P
@ AV_PIX_FMT_YUV420P
planar YUV 4:2:0, 12bpp, (1 Cr & Cb sample per 2x2 Y samples)
Definition: pixfmt.h:66
AVCodecDefault
Definition: internal.h:207
LIBAVUTIL_VERSION_INT
#define LIBAVUTIL_VERSION_INT
Definition: version.h:85
AVClass
Describe the class of an AVClass context structure.
Definition: log.h:67
NULL
#define NULL
Definition: coverity.c:32
AVCodecContext::bit_rate
int64_t bit_rate
the average bitrate
Definition: avcodec.h:551
av_default_item_name
const char * av_default_item_name(void *ptr)
Return the context name.
Definition: log.c:235
AV_PICTURE_TYPE_I
@ AV_PICTURE_TYPE_I
Intra.
Definition: avutil.h:274
error.h
AVCodecContext::time_base
AVRational time_base
This is the fundamental unit of time (in seconds) in terms of which frame timestamps are represented.
Definition: avcodec.h:624
FF_CODEC_CAP_AUTO_THREADS
#define FF_CODEC_CAP_AUTO_THREADS
Codec handles avctx->thread_count == 0 (auto) internally.
Definition: internal.h:80
NULL_IF_CONFIG_SMALL
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification.
Definition: internal.h:117
AVPacket::dts
int64_t dts
Decompression timestamp in AVStream->time_base units; the time at which the packet is decompressed.
Definition: packet.h:364
AVERROR_EXTERNAL
#define AVERROR_EXTERNAL
Generic error in an external library.
Definition: error.h:57
attributes.h
AVPacket::flags
int flags
A combination of AV_PKT_FLAG values.
Definition: packet.h:371
av_dict_free
void av_dict_free(AVDictionary **pm)
Free all the memory allocated for an AVDictionary struct and all keys and values.
Definition: dict.c:203
LibkvazaarContext::config
kvz_config * config
Definition: libkvazaar.c:47
VE
#define VE
Definition: libkvazaar.c:295
log.h
defaults
static const AVCodecDefault defaults[]
Definition: libkvazaar.c:309
AVPacket::pts
int64_t pts
Presentation timestamp in AVStream->time_base units; the time at which the decompressed packet will b...
Definition: packet.h:358
AVCodecContext::extradata
uint8_t * extradata
some codecs need / can use extradata like Huffman tables.
Definition: avcodec.h:602
FF_CODEC_CAP_INIT_CLEANUP
#define FF_CODEC_CAP_INIT_CLEANUP
The codec allows calling the close function for deallocation even if the init function returned a fai...
Definition: internal.h:49
internal.h
AV_CODEC_ID_HEVC
@ AV_CODEC_ID_HEVC
Definition: codec_id.h:223
libkvazaar_close
static av_cold int libkvazaar_close(AVCodecContext *avctx)
Definition: libkvazaar.c:150
av_mallocz
void * av_mallocz(size_t size)
Allocate a memory block with alignment suitable for all memory accesses (including vectors if availab...
Definition: mem.c:243
AVCodec::name
const char * name
Name of the codec implementation.
Definition: codec.h:204
AVCodecContext::height
int height
Definition: avcodec.h:674
AVCodecContext::pix_fmt
enum AVPixelFormat pix_fmt
Pixel format, see AV_PIX_FMT_xxx.
Definition: avcodec.h:711
avcodec.h
AVClass::class_name
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:72
frame
these buffered frames must be flushed immediately if a new input produces new the filter must not call request_frame to get more It must just process the frame or queue it The task of requesting more frames is left to the filter s request_frame method or the application If a filter has several the filter must be ready for frames arriving randomly on any input any filter with several inputs will most likely require some kind of queuing mechanism It is perfectly acceptable to have a limited queue and to drop frames when the inputs are too unbalanced request_frame For filters that do not use the this method is called when a frame is wanted on an output For a it should directly call filter_frame on the corresponding output For a if there are queued frames already one of these frames should be pushed If the filter should request a frame on one of its repeatedly until at least one frame has been pushed Return or at least make progress towards producing a frame
Definition: filter_design.txt:264
dict.h
AV_INPUT_BUFFER_PADDING_SIZE
#define AV_INPUT_BUFFER_PADDING_SIZE
Definition: avcodec.h:192
AVCodecContext
main external API structure.
Definition: avcodec.h:501
av_image_copy
void av_image_copy(uint8_t *dst_data[4], int dst_linesizes[4], const uint8_t *src_data[4], const int src_linesizes[4], enum AVPixelFormat pix_fmt, int width, int height)
Copy image in src_data to dst_data.
Definition: imgutils.c:419
AV_PICTURE_TYPE_B
@ AV_PICTURE_TYPE_B
Bi-dir predicted.
Definition: avutil.h:276
AVRational::den
int den
Denominator.
Definition: rational.h:60
AV_PIX_FMT_NONE
@ AV_PIX_FMT_NONE
Definition: pixfmt.h:65
av_dict_parse_string
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:180
AV_CODEC_CAP_DELAY
#define AV_CODEC_CAP_DELAY
Encoder or decoder requires flushing with NULL input at the end in order to give the complete and cor...
Definition: codec.h:77
AV_PICTURE_TYPE_P
@ AV_PICTURE_TYPE_P
Predicted.
Definition: avutil.h:275
AVMEDIA_TYPE_VIDEO
@ AVMEDIA_TYPE_VIDEO
Definition: avutil.h:201
mem.h
packet_internal.h
AVDictionaryEntry
Definition: dict.h:81
AVPacket
This structure stores compressed data.
Definition: packet.h:342
AVCodecContext::priv_data
void * priv_data
Definition: avcodec.h:528
AVCodecContext::width
int width
picture width / height.
Definition: avcodec.h:674
imgutils.h
AVERROR_BUG
#define AVERROR_BUG
Internal bug, also see AVERROR_BUG2.
Definition: error.h:50
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:28
AVERROR_INVALIDDATA
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:59
AVDictionaryEntry::value
char * value
Definition: dict.h:83
AV_OPT_TYPE_STRING
@ AV_OPT_TYPE_STRING
Definition: opt.h:229
FF_QP2LAMBDA
#define FF_QP2LAMBDA
factor to convert from H.263 QP to lambda
Definition: avutil.h:227
ff_alloc_packet2
int ff_alloc_packet2(AVCodecContext *avctx, AVPacket *avpkt, int64_t size, int64_t min_size)
Check AVPacket size and/or allocate data.
Definition: encode.c:33
AVCodecContext::sample_aspect_ratio
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:859
libkvazaar_encode
static int libkvazaar_encode(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame, int *got_packet_ptr)
Definition: libkvazaar.c:162
av_get_pix_fmt_name
const char * av_get_pix_fmt_name(enum AVPixelFormat pix_fmt)
Return the short name for a pixel format, NULL in case pix_fmt is unknown.
Definition: pixdesc.c:2461