89b024a3792d66a1b2ad65eb7dc28105d2e908f2
[ffmpeg.git] / libavcodec / libkvazaar.c
1 /*
2  * libkvazaar encoder
3  *
4  * Copyright (c) 2015 Tampere University of Technology
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 #include <kvazaar.h>
24 #include <string.h>
25
26 #include "libavutil/dict.h"
27 #include "libavutil/error.h"
28 #include "libavutil/imgutils.h"
29 #include "libavutil/internal.h"
30 #include "libavutil/pixdesc.h"
31 #include "libavutil/opt.h"
32
33 #include "avcodec.h"
34 #include "internal.h"
35
36 typedef struct LibkvazaarContext {
37     const AVClass *class;
38
39     const kvz_api *api;
40     kvz_encoder *encoder;
41     kvz_config *config;
42
43     char *kvz_params;
44 } LibkvazaarContext;
45
46 static av_cold int libkvazaar_init(AVCodecContext *avctx)
47 {
48     LibkvazaarContext *const ctx = avctx->priv_data;
49     const kvz_api *const api = ctx->api = kvz_api_get(8);
50     kvz_config *cfg = NULL;
51     kvz_encoder *enc = NULL;
52
53     if (avctx->strict_std_compliance > FF_COMPLIANCE_EXPERIMENTAL) {
54         av_log(avctx, AV_LOG_ERROR,
55                "Set -strict experimental to use this encoder.\n");
56         return AVERROR_EXPERIMENTAL;
57     }
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     cfg->framerate =
84       avctx->time_base.den / (double)(avctx->time_base.num * avctx->ticks_per_frame);
85     cfg->target_bitrate = avctx->bit_rate;
86     cfg->vui.sar_width  = avctx->sample_aspect_ratio.num;
87     cfg->vui.sar_height = avctx->sample_aspect_ratio.den;
88
89     if (ctx->kvz_params) {
90         AVDictionary *dict = NULL;
91         if (!av_dict_parse_string(&dict, ctx->kvz_params, "=", ",", 0)) {
92             AVDictionaryEntry *entry = NULL;
93             while ((entry = av_dict_get(dict, "", entry, AV_DICT_IGNORE_SUFFIX))) {
94                 if (!api->config_parse(cfg, entry->key, entry->value)) {
95                     av_log(avctx, AV_LOG_WARNING, "Invalid option: %s=%s.\n",
96                            entry->key, entry->value);
97                 }
98             }
99             av_dict_free(&dict);
100         }
101     }
102
103     ctx->encoder = enc = api->encoder_open(cfg);
104     if (!enc) {
105         av_log(avctx, AV_LOG_ERROR, "Could not open kvazaar encoder.\n");
106         return AVERROR_BUG;
107     }
108
109     if (avctx->flags & AV_CODEC_FLAG_GLOBAL_HEADER) {
110         kvz_data_chunk *data_out = NULL;
111         kvz_data_chunk *chunk = NULL;
112         uint32_t len_out;
113         uint8_t *p;
114
115         if (!api->encoder_headers(enc, &data_out, &len_out))
116             return AVERROR(ENOMEM);
117
118         avctx->extradata = p = av_mallocz(len_out + AV_INPUT_BUFFER_PADDING_SIZE);
119         if (!p) {
120             ctx->api->chunk_free(data_out);
121             return AVERROR(ENOMEM);
122         }
123
124         avctx->extradata_size = len_out;
125
126         for (chunk = data_out; chunk != NULL; chunk = chunk->next) {
127             memcpy(p, chunk->data, chunk->len);
128             p += chunk->len;
129         }
130
131         ctx->api->chunk_free(data_out);
132     }
133
134     return 0;
135 }
136
137 static av_cold int libkvazaar_close(AVCodecContext *avctx)
138 {
139     LibkvazaarContext *ctx = avctx->priv_data;
140
141     if (ctx->api) {
142       ctx->api->encoder_close(ctx->encoder);
143       ctx->api->config_destroy(ctx->config);
144     }
145
146     if (avctx->extradata)
147         av_freep(&avctx->extradata);
148
149     return 0;
150 }
151
152 static int libkvazaar_encode(AVCodecContext *avctx,
153                              AVPacket *avpkt,
154                              const AVFrame *frame,
155                              int *got_packet_ptr)
156 {
157     LibkvazaarContext *ctx = avctx->priv_data;
158     kvz_picture *input_pic = NULL;
159     kvz_picture *recon_pic = NULL;
160     kvz_frame_info frame_info;
161     kvz_data_chunk *data_out = NULL;
162     uint32_t len_out = 0;
163     int retval = 0;
164
165     if (frame) {
166         if (frame->width != ctx->config->width ||
167                 frame->height != ctx->config->height) {
168             av_log(avctx, AV_LOG_ERROR,
169                    "Changing video dimensions during encoding is not supported. "
170                    "(changed from %dx%d to %dx%d)\n",
171                    ctx->config->width, ctx->config->height,
172                    frame->width, frame->height);
173             retval = AVERROR_INVALIDDATA;
174             goto done;
175         }
176
177         if (frame->format != avctx->pix_fmt) {
178             av_log(avctx, AV_LOG_ERROR,
179                    "Changing pixel format during encoding is not supported. "
180                    "(changed from %s to %s)\n",
181                    av_get_pix_fmt_name(avctx->pix_fmt),
182                    av_get_pix_fmt_name(frame->format));
183             retval = AVERROR_INVALIDDATA;
184             goto done;
185         }
186
187         // Allocate input picture for kvazaar.
188         input_pic = ctx->api->picture_alloc(frame->width, frame->height);
189         if (!input_pic) {
190             av_log(avctx, AV_LOG_ERROR, "Failed to allocate picture.\n");
191             retval = AVERROR(ENOMEM);
192             goto done;
193         }
194
195         // Copy pixels from frame to input_pic.
196         {
197             int dst_linesizes[4] = {
198               frame->width,
199               frame->width / 2,
200               frame->width / 2,
201               0
202             };
203             av_image_copy(input_pic->data, dst_linesizes,
204                           frame->data, frame->linesize,
205                           frame->format, frame->width, frame->height);
206         }
207
208         input_pic->pts = frame->pts;
209     }
210
211     retval = ctx->api->encoder_encode(ctx->encoder,
212                                       input_pic,
213                                       &data_out, &len_out,
214                                       &recon_pic, NULL,
215                                       &frame_info);
216     if (!retval) {
217         av_log(avctx, AV_LOG_ERROR, "Failed to encode frame.\n");
218         retval = AVERROR_INVALIDDATA;
219         goto done;
220     }
221
222     if (data_out) {
223         kvz_data_chunk *chunk = NULL;
224         uint64_t written = 0;
225
226         retval = ff_alloc_packet(avpkt, len_out);
227         if (retval < 0) {
228             av_log(avctx, AV_LOG_ERROR, "Failed to allocate output packet.\n");
229             goto done;
230         }
231
232         for (chunk = data_out; chunk != NULL; chunk = chunk->next) {
233             memcpy(avpkt->data + written, chunk->data, chunk->len);
234             written += chunk->len;
235         }
236
237         avpkt->pts = recon_pic->pts;
238         avpkt->dts = recon_pic->dts;
239         avpkt->flags = 0;
240         // IRAP VCL NAL unit types span the range
241         // [BLA_W_LP (16), RSV_IRAP_VCL23 (23)].
242         if (frame_info.nal_unit_type >= KVZ_NAL_BLA_W_LP &&
243                 frame_info.nal_unit_type <= KVZ_NAL_RSV_IRAP_VCL23) {
244             avpkt->flags |= AV_PKT_FLAG_KEY;
245         }
246
247         *got_packet_ptr = 1;
248     }
249
250 done:
251     ctx->api->picture_free(input_pic);
252     ctx->api->picture_free(recon_pic);
253     ctx->api->chunk_free(data_out);
254     return retval;
255 }
256
257 static const enum AVPixelFormat pix_fmts[] = {
258     AV_PIX_FMT_YUV420P,
259     AV_PIX_FMT_NONE
260 };
261
262 #define OFFSET(x) offsetof(LibkvazaarContext, x)
263 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
264 static const AVOption options[] = {
265     { "kvazaar-params", "Set kvazaar parameters as a comma-separated list of key=value pairs.",
266         OFFSET(kvz_params), AV_OPT_TYPE_STRING, { .str = NULL }, 0, 0, VE },
267
268     { NULL },
269 };
270
271 static const AVClass class = {
272     .class_name = "libkvazaar",
273     .item_name  = av_default_item_name,
274     .option     = options,
275     .version    = LIBAVUTIL_VERSION_INT,
276 };
277
278 static const AVCodecDefault defaults[] = {
279     { "b", "0" },
280     { NULL },
281 };
282
283 AVCodec ff_libkvazaar_encoder = {
284     .name             = "libkvazaar",
285     .long_name        = NULL_IF_CONFIG_SMALL("libkvazaar H.265 / HEVC"),
286     .type             = AVMEDIA_TYPE_VIDEO,
287     .id               = AV_CODEC_ID_HEVC,
288     .capabilities     = AV_CODEC_CAP_DELAY,
289     .pix_fmts         = pix_fmts,
290
291     .priv_class       = &class,
292     .priv_data_size   = sizeof(LibkvazaarContext),
293     .defaults         = defaults,
294
295     .init             = libkvazaar_init,
296     .encode2          = libkvazaar_encode,
297     .close            = libkvazaar_close,
298
299     .caps_internal    = FF_CODEC_CAP_INIT_THREADSAFE | FF_CODEC_CAP_INIT_CLEANUP,
300 };