1 /*
2 * Copyright (c) 2010, Google, Inc.
3 *
4 * This file is part of FFmpeg.
5 *
6 * FFmpeg is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
10 *
11 * FFmpeg is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with FFmpeg; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 */
20
21 /**
22 * @file
23 * VP8/9 decoder support via libvpx
24 */
25
26 #define VPX_CODEC_DISABLE_COMPAT 1
27 #include <vpx/vpx_decoder.h>
28 #include <vpx/vpx_frame_buffer.h>
29 #include <vpx/vp8dx.h>
30
31 #include "libavutil/common.h"
32 #include "libavutil/imgutils.h"
33 #include "libavutil/intreadwrite.h"
34 #include "avcodec.h"
35 #include "internal.h"
36 #include "libvpx.h"
37 #include "profiles.h"
38
39 typedef struct VPxDecoderContext {
40 struct vpx_codec_ctx decoder;
41 struct vpx_codec_ctx decoder_alpha;
42 AVBufferPool *pool;
43 size_t pool_size;
44 int has_alpha_channel;
45 } VPxContext;
46
47
get_frame_buffer(void * priv,size_t min_size,vpx_codec_frame_buffer_t * fb)48 static int get_frame_buffer(void *priv, size_t min_size, vpx_codec_frame_buffer_t *fb)
49 {
50 VPxContext *ctx = priv;
51 AVBufferRef *buf;
52
53 if (min_size > ctx->pool_size) {
54 av_buffer_pool_uninit(&ctx->pool);
55 /* According to the libvpx docs the buffer must be zeroed out. */
56 ctx->pool = av_buffer_pool_init(min_size, av_buffer_allocz);
57 if (!ctx->pool) {
58 ctx->pool_size = 0;
59 return AVERROR(ENOMEM);
60 }
61 ctx->pool_size = min_size;
62 }
63
64 buf = av_buffer_pool_get(ctx->pool);
65 if (!buf)
66 return AVERROR(ENOMEM);
67
68 fb->priv = buf;
69 fb->size = ctx->pool_size;
70 fb->data = buf->data;
71
72 return 0;
73 }
74
release_frame_buffer(void * priv,vpx_codec_frame_buffer_t * fb)75 static int release_frame_buffer(void *priv, vpx_codec_frame_buffer_t *fb)
76 {
77 AVBufferRef *buf = fb->priv;
78 av_buffer_unref(&buf);
79 return 0;
80 }
81
vpx_init(AVCodecContext * avctx,struct vpx_codec_ctx * decoder,const struct vpx_codec_iface * iface)82 static av_cold int vpx_init(AVCodecContext *avctx,
83 struct vpx_codec_ctx* decoder,
84 const struct vpx_codec_iface *iface)
85 {
86 struct vpx_codec_dec_cfg deccfg = {
87 .threads = FFMIN(avctx->thread_count ? avctx->thread_count : av_cpu_count(), 16)
88 };
89
90 av_log(avctx, AV_LOG_INFO, "%s\n", vpx_codec_version_str());
91 av_log(avctx, AV_LOG_VERBOSE, "%s\n", vpx_codec_build_config());
92
93 if (vpx_codec_dec_init(decoder, iface, &deccfg, 0) != VPX_CODEC_OK) {
94 const char *error = vpx_codec_error(decoder);
95 av_log(avctx, AV_LOG_ERROR, "Failed to initialize decoder: %s\n",
96 error);
97 return AVERROR(EINVAL);
98 }
99
100 if (avctx->codec_id == AV_CODEC_ID_VP9)
101 vpx_codec_set_frame_buffer_functions(decoder, get_frame_buffer, release_frame_buffer, avctx->priv_data);
102
103 return 0;
104 }
105
106 // returns 0 on success, AVERROR_INVALIDDATA otherwise
set_pix_fmt(AVCodecContext * avctx,struct vpx_image * img,int has_alpha_channel)107 static int set_pix_fmt(AVCodecContext *avctx, struct vpx_image *img,
108 int has_alpha_channel)
109 {
110 static const enum AVColorSpace colorspaces[8] = {
111 AVCOL_SPC_UNSPECIFIED, AVCOL_SPC_BT470BG, AVCOL_SPC_BT709, AVCOL_SPC_SMPTE170M,
112 AVCOL_SPC_SMPTE240M, AVCOL_SPC_BT2020_NCL, AVCOL_SPC_RESERVED, AVCOL_SPC_RGB,
113 };
114 #if VPX_IMAGE_ABI_VERSION >= 4
115 static const enum AVColorRange color_ranges[] = {
116 AVCOL_RANGE_MPEG, AVCOL_RANGE_JPEG
117 };
118 avctx->color_range = color_ranges[img->range];
119 #endif
120 avctx->colorspace = colorspaces[img->cs];
121 if (avctx->codec_id == AV_CODEC_ID_VP8 && img->fmt != VPX_IMG_FMT_I420)
122 return AVERROR_INVALIDDATA;
123 switch (img->fmt) {
124 case VPX_IMG_FMT_I420:
125 if (avctx->codec_id == AV_CODEC_ID_VP9)
126 avctx->profile = FF_PROFILE_VP9_0;
127 avctx->pix_fmt =
128 has_alpha_channel ? AV_PIX_FMT_YUVA420P : AV_PIX_FMT_YUV420P;
129 return 0;
130 #if CONFIG_LIBVPX_VP9_DECODER
131 case VPX_IMG_FMT_I422:
132 avctx->profile = FF_PROFILE_VP9_1;
133 avctx->pix_fmt = AV_PIX_FMT_YUV422P;
134 return 0;
135 case VPX_IMG_FMT_I440:
136 avctx->profile = FF_PROFILE_VP9_1;
137 avctx->pix_fmt = AV_PIX_FMT_YUV440P;
138 return 0;
139 case VPX_IMG_FMT_I444:
140 avctx->profile = FF_PROFILE_VP9_1;
141 avctx->pix_fmt = avctx->colorspace == AVCOL_SPC_RGB ?
142 AV_PIX_FMT_GBRP : AV_PIX_FMT_YUV444P;
143 return 0;
144 case VPX_IMG_FMT_I42016:
145 avctx->profile = FF_PROFILE_VP9_2;
146 if (img->bit_depth == 10) {
147 avctx->pix_fmt = AV_PIX_FMT_YUV420P10;
148 return 0;
149 } else if (img->bit_depth == 12) {
150 avctx->pix_fmt = AV_PIX_FMT_YUV420P12;
151 return 0;
152 } else {
153 return AVERROR_INVALIDDATA;
154 }
155 case VPX_IMG_FMT_I42216:
156 avctx->profile = FF_PROFILE_VP9_3;
157 if (img->bit_depth == 10) {
158 avctx->pix_fmt = AV_PIX_FMT_YUV422P10;
159 return 0;
160 } else if (img->bit_depth == 12) {
161 avctx->pix_fmt = AV_PIX_FMT_YUV422P12;
162 return 0;
163 } else {
164 return AVERROR_INVALIDDATA;
165 }
166 case VPX_IMG_FMT_I44016:
167 avctx->profile = FF_PROFILE_VP9_3;
168 if (img->bit_depth == 10) {
169 avctx->pix_fmt = AV_PIX_FMT_YUV440P10;
170 return 0;
171 } else if (img->bit_depth == 12) {
172 avctx->pix_fmt = AV_PIX_FMT_YUV440P12;
173 return 0;
174 } else {
175 return AVERROR_INVALIDDATA;
176 }
177 case VPX_IMG_FMT_I44416:
178 avctx->profile = FF_PROFILE_VP9_3;
179 if (img->bit_depth == 10) {
180 avctx->pix_fmt = avctx->colorspace == AVCOL_SPC_RGB ?
181 AV_PIX_FMT_GBRP10 : AV_PIX_FMT_YUV444P10;
182 return 0;
183 } else if (img->bit_depth == 12) {
184 avctx->pix_fmt = avctx->colorspace == AVCOL_SPC_RGB ?
185 AV_PIX_FMT_GBRP12 : AV_PIX_FMT_YUV444P12;
186 return 0;
187 } else {
188 return AVERROR_INVALIDDATA;
189 }
190 #endif
191 default:
192 return AVERROR_INVALIDDATA;
193 }
194 }
195
decode_frame(AVCodecContext * avctx,vpx_codec_ctx_t * decoder,uint8_t * data,uint32_t data_sz)196 static int decode_frame(AVCodecContext *avctx, vpx_codec_ctx_t *decoder,
197 uint8_t *data, uint32_t data_sz)
198 {
199 if (vpx_codec_decode(decoder, data, data_sz, NULL, 0) != VPX_CODEC_OK) {
200 const char *error = vpx_codec_error(decoder);
201 const char *detail = vpx_codec_error_detail(decoder);
202
203 av_log(avctx, AV_LOG_ERROR, "Failed to decode frame: %s\n", error);
204 if (detail) {
205 av_log(avctx, AV_LOG_ERROR, " Additional information: %s\n",
206 detail);
207 }
208 return AVERROR_INVALIDDATA;
209 }
210 return 0;
211 }
212
vpx_decode(AVCodecContext * avctx,void * data,int * got_frame,AVPacket * avpkt)213 static int vpx_decode(AVCodecContext *avctx,
214 void *data, int *got_frame, AVPacket *avpkt)
215 {
216 VPxContext *ctx = avctx->priv_data;
217 AVFrame *picture = data;
218 const void *iter = NULL;
219 const void *iter_alpha = NULL;
220 struct vpx_image *img, *img_alpha;
221 int ret;
222 uint8_t *side_data = NULL;
223 int side_data_size = 0;
224
225 ret = decode_frame(avctx, &ctx->decoder, avpkt->data, avpkt->size);
226 if (ret)
227 return ret;
228
229 side_data = av_packet_get_side_data(avpkt,
230 AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
231 &side_data_size);
232 if (side_data_size >= 8) {
233 const uint64_t additional_id = AV_RB64(side_data);
234 side_data += 8;
235 side_data_size -= 8;
236 if (additional_id == 1) { // 1 stands for alpha channel data.
237 if (!ctx->has_alpha_channel) {
238 ctx->has_alpha_channel = 1;
239 ret = vpx_init(avctx,
240 &ctx->decoder_alpha,
241 #if CONFIG_LIBVPX_VP8_DECODER && CONFIG_LIBVPX_VP9_DECODER
242 (avctx->codec_id == AV_CODEC_ID_VP8) ?
243 &vpx_codec_vp8_dx_algo : &vpx_codec_vp9_dx_algo
244 #elif CONFIG_LIBVPX_VP8_DECODER
245 &vpx_codec_vp8_dx_algo
246 #else
247 &vpx_codec_vp9_dx_algo
248 #endif
249 );
250 if (ret)
251 return ret;
252 }
253 ret = decode_frame(avctx, &ctx->decoder_alpha, side_data,
254 side_data_size);
255 if (ret)
256 return ret;
257 }
258 }
259
260 if ((img = vpx_codec_get_frame(&ctx->decoder, &iter)) &&
261 (!ctx->has_alpha_channel ||
262 (img_alpha = vpx_codec_get_frame(&ctx->decoder_alpha, &iter_alpha)))) {
263 uint8_t *planes[4];
264 int linesizes[4];
265
266 if (img->d_w > img->w || img->d_h > img->h) {
267 av_log(avctx, AV_LOG_ERROR, "Display dimensions %dx%d exceed storage %dx%d\n",
268 img->d_w, img->d_h, img->w, img->h);
269 return AVERROR_EXTERNAL;
270 }
271
272 if ((ret = set_pix_fmt(avctx, img, ctx->has_alpha_channel)) < 0) {
273 av_log(avctx, AV_LOG_ERROR, "Unsupported output colorspace (%d) / bit_depth (%d)\n",
274 img->fmt, img->bit_depth);
275 return ret;
276 }
277
278 if ((int) img->d_w != avctx->width || (int) img->d_h != avctx->height) {
279 av_log(avctx, AV_LOG_INFO, "dimension change! %dx%d -> %dx%d\n",
280 avctx->width, avctx->height, img->d_w, img->d_h);
281 ret = ff_set_dimensions(avctx, img->d_w, img->d_h);
282 if (ret < 0)
283 return ret;
284 }
285
286 if (ctx->has_alpha_channel &&
287 (img->d_w != img_alpha->d_w ||
288 img->d_h != img_alpha->d_h ||
289 img->bit_depth != img_alpha->bit_depth)) {
290 av_log(avctx, AV_LOG_ERROR,
291 "Video dimensions %dx%d@%dbpc differ from alpha dimensions %dx%d@%dbpc\n",
292 img->d_w, img->d_h, img->bit_depth,
293 img_alpha->d_w, img_alpha->d_h, img_alpha->bit_depth);
294 return AVERROR_INVALIDDATA;
295 }
296
297 planes[0] = img->planes[VPX_PLANE_Y];
298 planes[1] = img->planes[VPX_PLANE_U];
299 planes[2] = img->planes[VPX_PLANE_V];
300 planes[3] =
301 ctx->has_alpha_channel ? img_alpha->planes[VPX_PLANE_Y] : NULL;
302 linesizes[0] = img->stride[VPX_PLANE_Y];
303 linesizes[1] = img->stride[VPX_PLANE_U];
304 linesizes[2] = img->stride[VPX_PLANE_V];
305 linesizes[3] =
306 ctx->has_alpha_channel ? img_alpha->stride[VPX_PLANE_Y] : 0;
307
308 if (img->fb_priv && (!ctx->has_alpha_channel || img_alpha->fb_priv)) {
309 ret = ff_decode_frame_props(avctx, picture);
310 if (ret < 0)
311 return ret;
312 picture->buf[0] = av_buffer_ref(img->fb_priv);
313 if (!picture->buf[0])
314 return AVERROR(ENOMEM);
315 if (ctx->has_alpha_channel) {
316 picture->buf[1] = av_buffer_ref(img_alpha->fb_priv);
317 if (!picture->buf[1]) {
318 av_frame_unref(picture);
319 return AVERROR(ENOMEM);
320 }
321 }
322 for (int i = 0; i < 4; i++) {
323 picture->data[i] = planes[i];
324 picture->linesize[i] = linesizes[i];
325 }
326 } else {
327 if ((ret = ff_get_buffer(avctx, picture, 0)) < 0)
328 return ret;
329 av_image_copy(picture->data, picture->linesize, (const uint8_t**)planes,
330 linesizes, avctx->pix_fmt, img->d_w, img->d_h);
331 }
332 *got_frame = 1;
333 }
334 return avpkt->size;
335 }
336
vpx_free(AVCodecContext * avctx)337 static av_cold int vpx_free(AVCodecContext *avctx)
338 {
339 VPxContext *ctx = avctx->priv_data;
340 vpx_codec_destroy(&ctx->decoder);
341 if (ctx->has_alpha_channel)
342 vpx_codec_destroy(&ctx->decoder_alpha);
343 av_buffer_pool_uninit(&ctx->pool);
344 return 0;
345 }
346
347 #if CONFIG_LIBVPX_VP8_DECODER
vp8_init(AVCodecContext * avctx)348 static av_cold int vp8_init(AVCodecContext *avctx)
349 {
350 VPxContext *ctx = avctx->priv_data;
351 return vpx_init(avctx, &ctx->decoder, &vpx_codec_vp8_dx_algo);
352 }
353
354 AVCodec ff_libvpx_vp8_decoder = {
355 .name = "libvpx",
356 .long_name = NULL_IF_CONFIG_SMALL("libvpx VP8"),
357 .type = AVMEDIA_TYPE_VIDEO,
358 .id = AV_CODEC_ID_VP8,
359 .priv_data_size = sizeof(VPxContext),
360 .init = vp8_init,
361 .close = vpx_free,
362 .decode = vpx_decode,
363 .capabilities = AV_CODEC_CAP_AUTO_THREADS | AV_CODEC_CAP_DR1,
364 .wrapper_name = "libvpx",
365 };
366 #endif /* CONFIG_LIBVPX_VP8_DECODER */
367
368 #if CONFIG_LIBVPX_VP9_DECODER
vp9_init(AVCodecContext * avctx)369 static av_cold int vp9_init(AVCodecContext *avctx)
370 {
371 VPxContext *ctx = avctx->priv_data;
372 return vpx_init(avctx, &ctx->decoder, &vpx_codec_vp9_dx_algo);
373 }
374
375 AVCodec ff_libvpx_vp9_decoder = {
376 .name = "libvpx-vp9",
377 .long_name = NULL_IF_CONFIG_SMALL("libvpx VP9"),
378 .type = AVMEDIA_TYPE_VIDEO,
379 .id = AV_CODEC_ID_VP9,
380 .priv_data_size = sizeof(VPxContext),
381 .init = vp9_init,
382 .close = vpx_free,
383 .decode = vpx_decode,
384 .capabilities = AV_CODEC_CAP_AUTO_THREADS,
385 .init_static_data = ff_vp9_init_static,
386 .profiles = NULL_IF_CONFIG_SMALL(ff_vp9_profiles),
387 .wrapper_name = "libvpx",
388 };
389 #endif /* CONFIG_LIBVPX_VP9_DECODER */
390