3 * Copyright (c) 2016 Paul B Mahol
5 * This file is part of FFmpeg.
7 * FFmpeg is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * FFmpeg is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with FFmpeg; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
26 #include "libavutil/qsort.h"
28 #include "bytestream.h"
30 #include "huffyuvdsp.h"
34 typedef struct Slice {
39 typedef enum Prediction {
45 typedef struct MagicYUVContext {
49 int planes; // number of encoded planes in bitstream
50 int decorrelate; // postprocessing work
51 int interlaced; // video is interlaced
52 uint8_t *buf; // pointer to AVPacket->data
55 Slice *slices[4]; // slice positions and size in bitstream for each plane
57 uint8_t len[4][256]; // table of code lengths for each plane
58 VLC vlc[4]; // VLC for each plane
59 HuffYUVDSPContext hdsp;
62 static av_cold int decode_init(AVCodecContext *avctx)
64 MagicYUVContext *s = avctx->priv_data;
65 ff_huffyuvdsp_init(&s->hdsp);
69 typedef struct HuffEntry {
75 static int ff_magy_huff_cmp_len(const void *a, const void *b)
77 const HuffEntry *aa = a, *bb = b;
78 return (aa->len - bb->len) * 256 + aa->sym - bb->sym;
81 static int build_huff(VLC *vlc, uint8_t *len)
90 for (i = 0; i < 256; i++) {
94 AV_QSORT(he, 256, HuffEntry, ff_magy_huff_cmp_len);
97 for (i = 255; i >= 0; i--) {
98 codes[i] = code >> (32 - he[i].len);
101 code += 0x80000000u >> (he[i].len - 1);
105 return ff_init_vlc_sparse(vlc, FFMIN(he[255].len, 12), 256,
106 bits, sizeof(*bits), sizeof(*bits),
107 codes, sizeof(*codes), sizeof(*codes),
108 syms, sizeof(*syms), sizeof(*syms), 0);
111 static int decode_slice(AVCodecContext *avctx, void *tdata,
114 MagicYUVContext *s = avctx->priv_data;
115 int interlaced = s->interlaced;
121 for (i = 0; i < s->planes; i++) {
122 int height = AV_CEIL_RSHIFT(FFMIN(s->slice_height, avctx->coded_height - j * s->slice_height), s->vshift[i]);
123 int width = AV_CEIL_RSHIFT(avctx->coded_width, s->hshift[i]);
124 int sheight = AV_CEIL_RSHIFT(s->slice_height, s->vshift[i]);
125 int fake_stride = p->linesize[i] * (1 + interlaced);
126 int stride = p->linesize[i];
129 if ((ret = init_get_bits8(&b, s->buf + s->slices[i][j].start, s->slices[i][j].size)) < 0)
132 flags = get_bits(&b, 8);
133 pred = get_bits(&b, 8);
135 dst = p->data[i] + j * sheight * stride;
137 for (k = 0; k < height; k++) {
138 for (x = 0; x < width; x++) {
139 dst[x] = get_bits(&b, 8);
144 for (k = 0; k < height; k++) {
145 for (x = 0; x < width; x++) {
147 if (get_bits_left(&b) <= 0) {
148 return AVERROR_INVALIDDATA;
150 pix = get_vlc2(&b, s->vlc[i].table, s->vlc[i].bits, 3);
152 return AVERROR_INVALIDDATA;
161 dst = p->data[i] + j * sheight * stride;
162 s->hdsp.add_hfyu_left_pred(dst, dst, width, 0);
165 s->hdsp.add_hfyu_left_pred(dst, dst, width, 0);
168 for (k = 1 + interlaced; k < height; k++) {
169 s->hdsp.add_hfyu_left_pred(dst, dst, width, dst[-fake_stride]);
172 } else if (pred == GRADIENT) {
173 int left, lefttop, top;
175 dst = p->data[i] + j * sheight * stride;
176 s->hdsp.add_hfyu_left_pred(dst, dst, width, 0);
180 s->hdsp.add_hfyu_left_pred(dst, dst, width, 0);
184 for (k = 1 + interlaced; k < height; k++) {
185 top = dst[-fake_stride];
188 for (x = 1; x < width; x++) {
189 top = dst[x - fake_stride];
190 lefttop = dst[x - (fake_stride + 1)];
191 left += top - lefttop + dst[x];
196 } else if (pred == MEDIAN) {
199 dst = p->data[i] + j * sheight * stride;
200 lefttop = left = dst[0];
201 s->hdsp.add_hfyu_left_pred(dst, dst, width, 0);
204 lefttop = left = dst[0];
205 s->hdsp.add_hfyu_left_pred(dst, dst, width, 0);
208 for (k = 1 + interlaced; k < height; k++) {
209 s->hdsp.add_hfyu_median_pred(dst, dst - fake_stride, dst, width, &left, &lefttop);
210 lefttop = left = dst[0];
214 avpriv_request_sample(avctx, "unknown prediction: %d", pred);
218 if (s->decorrelate) {
219 int height = FFMIN(s->slice_height, avctx->coded_height - j * s->slice_height);
220 int width = avctx->coded_width;
221 uint8_t *b = p->data[0] + j * s->slice_height * p->linesize[0];
222 uint8_t *g = p->data[1] + j * s->slice_height * p->linesize[1];
223 uint8_t *r = p->data[2] + j * s->slice_height * p->linesize[2];
225 for (i = 0; i < height; i++) {
226 s->hdsp.add_bytes(b, g, width);
227 s->hdsp.add_bytes(r, g, width);
237 static int decode_frame(AVCodecContext *avctx,
238 void *data, int *got_frame,
241 uint32_t first_offset, offset, next_offset, header_size, slice_width;
242 int ret, format, version, table_size;
243 MagicYUVContext *s = avctx->priv_data;
244 ThreadFrame frame = { .f = data };
248 int i, j, k, width, height;
250 bytestream2_init(&gb, avpkt->data, avpkt->size);
251 if (bytestream2_get_le32(&gb) != MKTAG('M','A','G','Y'))
252 return AVERROR_INVALIDDATA;
254 header_size = bytestream2_get_le32(&gb);
255 if (header_size < 32 || header_size >= avpkt->size)
256 return AVERROR_INVALIDDATA;
258 version = bytestream2_get_byte(&gb);
260 avpriv_request_sample(avctx, "unsupported version: %d", version);
261 return AVERROR_PATCHWELCOME;
264 s->hshift[1] = s->vshift[1] = 0;
265 s->hshift[2] = s->vshift[2] = 0;
268 format = bytestream2_get_byte(&gb);
271 avctx->pix_fmt = AV_PIX_FMT_GBRP;
276 avctx->pix_fmt = AV_PIX_FMT_GBRAP;
281 avctx->pix_fmt = AV_PIX_FMT_YUV444P;
285 avctx->pix_fmt = AV_PIX_FMT_YUV422P;
287 s->hshift[1] = s->hshift[2] = 1;
290 avctx->pix_fmt = AV_PIX_FMT_YUV420P;
292 s->hshift[1] = s->vshift[1] = 1;
293 s->hshift[2] = s->vshift[2] = 1;
296 avctx->pix_fmt = AV_PIX_FMT_YUVA444P;
300 avctx->pix_fmt = AV_PIX_FMT_GRAY8;
304 avpriv_request_sample(avctx, "unsupported format: 0x%X", format);
305 return AVERROR_PATCHWELCOME;
308 bytestream2_skip(&gb, 2);
309 s->interlaced = !!(bytestream2_get_byte(&gb) & 2);
310 bytestream2_skip(&gb, 3);
312 width = bytestream2_get_le32(&gb);
313 height = bytestream2_get_le32(&gb);
314 if ((ret = ff_set_dimensions(avctx, width, height)) < 0)
317 slice_width = bytestream2_get_le32(&gb);
318 if (slice_width != avctx->coded_width) {
319 avpriv_request_sample(avctx, "unsupported slice width: %d", slice_width);
320 return AVERROR_PATCHWELCOME;
322 s->slice_height = bytestream2_get_le32(&gb);
323 if ((s->slice_height <= 0) || (s->slice_height > INT_MAX - avctx->coded_height)) {
324 av_log(avctx, AV_LOG_ERROR, "invalid slice height: %d\n", s->slice_height);
325 return AVERROR_INVALIDDATA;
328 bytestream2_skip(&gb, 4);
330 s->nb_slices = (avctx->coded_height + s->slice_height - 1) / s->slice_height;
331 if (s->nb_slices > INT_MAX / sizeof(Slice)) {
332 av_log(avctx, AV_LOG_ERROR, "invalid number of slices: %d\n", s->nb_slices);
333 return AVERROR_INVALIDDATA;
336 for (i = 0; i < s->planes; i++) {
337 av_fast_malloc(&s->slices[i], &s->slices_size[i], s->nb_slices * sizeof(Slice));
339 return AVERROR(ENOMEM);
341 offset = bytestream2_get_le32(&gb);
342 if (offset >= avpkt->size - header_size)
343 return AVERROR_INVALIDDATA;
346 first_offset = offset;
348 for (j = 0; j < s->nb_slices - 1; j++) {
349 s->slices[i][j].start = offset + header_size;
350 next_offset = bytestream2_get_le32(&gb);
351 s->slices[i][j].size = next_offset - offset;
352 offset = next_offset;
354 if (offset >= avpkt->size - header_size)
355 return AVERROR_INVALIDDATA;
358 s->slices[i][j].start = offset + header_size;
359 s->slices[i][j].size = avpkt->size - s->slices[i][j].start;
362 if (bytestream2_get_byte(&gb) != s->planes)
363 return AVERROR_INVALIDDATA;
365 bytestream2_skip(&gb, s->nb_slices * s->planes);
367 table_size = header_size + first_offset - bytestream2_tell(&gb);
369 return AVERROR_INVALIDDATA;
371 if ((ret = init_get_bits8(&b, avpkt->data + bytestream2_tell(&gb), table_size)) < 0)
374 memset(s->len, 0, sizeof(s->len));
376 while (get_bits_left(&b) >= 8) {
377 int l = get_bits(&b, 4);
378 int x = get_bits(&b, 4);
379 int L = get_bitsz(&b, l) + 1;
381 for (k = 0; k < L; k++) {
383 s->len[i][j + k] = x;
389 if (build_huff(&s->vlc[i], s->len[i])) {
390 av_log(avctx, AV_LOG_ERROR, "Cannot build Huffman codes\n");
391 return AVERROR_INVALIDDATA;
394 if (i == s->planes) {
397 } else if (j > 256) {
398 return AVERROR_INVALIDDATA;
402 if (i != s->planes) {
403 av_log(avctx, AV_LOG_ERROR, "Huffman tables too short\n");
404 return AVERROR_INVALIDDATA;
407 p->pict_type = AV_PICTURE_TYPE_I;
410 if ((ret = ff_thread_get_buffer(avctx, &frame, 0)) < 0)
413 s->buf = avpkt->data;
415 avctx->execute2(avctx, decode_slice, NULL, NULL, s->nb_slices);
417 if (avctx->pix_fmt == AV_PIX_FMT_GBRP ||
418 avctx->pix_fmt == AV_PIX_FMT_GBRAP) {
419 FFSWAP(uint8_t*, p->data[0], p->data[1]);
420 FFSWAP(int, p->linesize[0], p->linesize[1]);
431 static int decode_init_thread_copy(AVCodecContext *avctx)
433 MagicYUVContext *s = avctx->priv_data;
439 s->slices_size[0] = 0;
440 s->slices_size[1] = 0;
441 s->slices_size[2] = 0;
442 s->slices_size[3] = 0;
448 static av_cold int decode_end(AVCodecContext *avctx)
450 MagicYUVContext * const s = avctx->priv_data;
452 av_freep(&s->slices[0]);
453 av_freep(&s->slices[1]);
454 av_freep(&s->slices[2]);
455 av_freep(&s->slices[3]);
456 s->slices_size[0] = 0;
457 s->slices_size[1] = 0;
458 s->slices_size[2] = 0;
459 s->slices_size[3] = 0;
460 ff_free_vlc(&s->vlc[0]);
461 ff_free_vlc(&s->vlc[1]);
462 ff_free_vlc(&s->vlc[2]);
463 ff_free_vlc(&s->vlc[3]);
468 AVCodec ff_magicyuv_decoder = {
470 .long_name = NULL_IF_CONFIG_SMALL("MagicYUV Lossless Video"),
471 .type = AVMEDIA_TYPE_VIDEO,
472 .id = AV_CODEC_ID_MAGICYUV,
473 .priv_data_size = sizeof(MagicYUVContext),
475 .init_thread_copy = ONLY_IF_THREADS_ENABLED(decode_init_thread_copy),
477 .decode = decode_frame,
478 .capabilities = AV_CODEC_CAP_DR1 | AV_CODEC_CAP_FRAME_THREADS | AV_CODEC_CAP_SLICE_THREADS,