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
25 #include "libavutil/pixdesc.h"
26 #include "libavutil/qsort.h"
29 #include "bytestream.h"
31 #include "huffyuvdsp.h"
33 #include "lossless_videodsp.h"
36 typedef struct Slice {
41 typedef enum Prediction {
47 typedef struct HuffEntry {
53 typedef struct MagicYUVContext {
59 int planes; // number of encoded planes in bitstream
60 int decorrelate; // postprocessing work
61 int color_matrix; // video color matrix
63 int interlaced; // video is interlaced
64 uint8_t *buf; // pointer to AVPacket->data
67 Slice *slices[4]; // slice bitstream positions for each plane
68 unsigned int slices_size[4]; // slice sizes for each plane
69 uint8_t len[4][4096]; // table of code lengths for each plane
70 VLC vlc[4]; // VLC for each plane
71 int (*huff_build)(VLC *vlc, uint8_t *len);
72 int (*magy_decode_slice)(AVCodecContext *avctx, void *tdata,
74 LLVidDSPContext llviddsp;
77 static int huff_cmp_len(const void *a, const void *b)
79 const HuffEntry *aa = a, *bb = b;
80 return (aa->len - bb->len) * 256 + aa->sym - bb->sym;
83 static int huff_cmp_len10(const void *a, const void *b)
85 const HuffEntry *aa = a, *bb = b;
86 return (aa->len - bb->len) * 1024 + aa->sym - bb->sym;
89 static int huff_cmp_len12(const void *a, const void *b)
91 const HuffEntry *aa = a, *bb = b;
92 return (aa->len - bb->len) * 4096 + aa->sym - bb->sym;
95 static int huff_build10(VLC *vlc, uint8_t *len)
104 for (i = 0; i < 1024; i++) {
105 he[i].sym = 1023 - i;
107 if (len[i] == 0 || len[i] > 32)
108 return AVERROR_INVALIDDATA;
110 AV_QSORT(he, 1024, HuffEntry, huff_cmp_len10);
113 for (i = 1023; i >= 0; i--) {
114 codes[i] = code >> (32 - he[i].len);
117 code += 0x80000000u >> (he[i].len - 1);
121 return ff_init_vlc_sparse(vlc, FFMIN(he[1023].len, 12), 1024,
122 bits, sizeof(*bits), sizeof(*bits),
123 codes, sizeof(*codes), sizeof(*codes),
124 syms, sizeof(*syms), sizeof(*syms), 0);
127 static int huff_build12(VLC *vlc, uint8_t *len)
130 uint32_t codes[4096];
136 for (i = 0; i < 4096; i++) {
137 he[i].sym = 4095 - i;
139 if (len[i] == 0 || len[i] > 32)
140 return AVERROR_INVALIDDATA;
142 AV_QSORT(he, 4096, HuffEntry, huff_cmp_len12);
145 for (i = 4095; i >= 0; i--) {
146 codes[i] = code >> (32 - he[i].len);
149 code += 0x80000000u >> (he[i].len - 1);
153 return ff_init_vlc_sparse(vlc, FFMIN(he[4095].len, 14), 4096,
154 bits, sizeof(*bits), sizeof(*bits),
155 codes, sizeof(*codes), sizeof(*codes),
156 syms, sizeof(*syms), sizeof(*syms), 0);
159 static int huff_build(VLC *vlc, uint8_t *len)
168 for (i = 0; i < 256; i++) {
171 if (len[i] == 0 || len[i] > 32)
172 return AVERROR_INVALIDDATA;
174 AV_QSORT(he, 256, HuffEntry, huff_cmp_len);
177 for (i = 255; i >= 0; i--) {
178 codes[i] = code >> (32 - he[i].len);
181 code += 0x80000000u >> (he[i].len - 1);
185 return ff_init_vlc_sparse(vlc, FFMIN(he[255].len, 12), 256,
186 bits, sizeof(*bits), sizeof(*bits),
187 codes, sizeof(*codes), sizeof(*codes),
188 syms, sizeof(*syms), sizeof(*syms), 0);
191 static void magicyuv_median_pred16(uint16_t *dst, const uint16_t *src1,
192 const uint16_t *diff, intptr_t w,
193 int *left, int *left_top, int max)
201 for (i = 0; i < w; i++) {
202 l = mid_pred(l, src1[i], (l + src1[i] - lt)) + diff[i];
212 static int magy_decode_slice10(AVCodecContext *avctx, void *tdata,
215 MagicYUVContext *s = avctx->priv_data;
216 int interlaced = s->interlaced;
217 const int bps = s->bps;
218 const int max = s->max - 1;
224 for (i = 0; i < s->planes; i++) {
225 int left, lefttop, top;
226 int height = AV_CEIL_RSHIFT(FFMIN(s->slice_height, avctx->coded_height - j * s->slice_height), s->vshift[i]);
227 int width = AV_CEIL_RSHIFT(avctx->coded_width, s->hshift[i]);
228 int sheight = AV_CEIL_RSHIFT(s->slice_height, s->vshift[i]);
229 ptrdiff_t fake_stride = (p->linesize[i] / 2) * (1 + interlaced);
230 ptrdiff_t stride = p->linesize[i] / 2;
232 int ret = init_get_bits8(&gb, s->buf + s->slices[i][j].start,
233 s->slices[i][j].size);
238 flags = get_bits(&gb, 8);
239 pred = get_bits(&gb, 8);
241 dst = (uint16_t *)p->data[i] + j * sheight * stride;
243 for (k = 0; k < height; k++) {
244 for (x = 0; x < width; x++)
245 dst[x] = get_bits(&gb, bps);
250 for (k = 0; k < height; k++) {
251 for (x = 0; x < width; x++) {
253 if (get_bits_left(&gb) <= 0)
254 return AVERROR_INVALIDDATA;
256 pix = get_vlc2(&gb, s->vlc[i].table, s->vlc[i].bits, 3);
258 return AVERROR_INVALIDDATA;
268 dst = (uint16_t *)p->data[i] + j * sheight * stride;
269 s->llviddsp.add_left_pred_int16(dst, dst, max, width, 0);
272 s->llviddsp.add_left_pred_int16(dst, dst, max, width, 0);
275 for (k = 1 + interlaced; k < height; k++) {
276 s->llviddsp.add_left_pred_int16(dst, dst, max, width, dst[-fake_stride]);
281 dst = (uint16_t *)p->data[i] + j * sheight * stride;
282 s->llviddsp.add_left_pred_int16(dst, dst, max, width, 0);
285 s->llviddsp.add_left_pred_int16(dst, dst, max, width, 0);
288 for (k = 1 + interlaced; k < height; k++) {
289 top = dst[-fake_stride];
292 for (x = 1; x < width; x++) {
293 top = dst[x - fake_stride];
294 lefttop = dst[x - (fake_stride + 1)];
295 left += top - lefttop + dst[x];
302 dst = (uint16_t *)p->data[i] + j * sheight * stride;
303 s->llviddsp.add_left_pred_int16(dst, dst, max, width, 0);
306 s->llviddsp.add_left_pred_int16(dst, dst, max, width, 0);
309 lefttop = left = dst[0];
310 for (k = 1 + interlaced; k < height; k++) {
311 magicyuv_median_pred16(dst, dst - fake_stride, dst, width, &left, &lefttop, max);
312 lefttop = left = dst[0];
317 avpriv_request_sample(avctx, "Unknown prediction: %d", pred);
321 if (s->decorrelate) {
322 int height = FFMIN(s->slice_height, avctx->coded_height - j * s->slice_height);
323 int width = avctx->coded_width;
324 uint16_t *r = (uint16_t *)p->data[0] + j * s->slice_height * p->linesize[0] / 2;
325 uint16_t *g = (uint16_t *)p->data[1] + j * s->slice_height * p->linesize[1] / 2;
326 uint16_t *b = (uint16_t *)p->data[2] + j * s->slice_height * p->linesize[2] / 2;
328 for (i = 0; i < height; i++) {
329 for (k = 0; k < width; k++) {
330 b[k] = (b[k] + g[k]) & max;
331 r[k] = (r[k] + g[k]) & max;
333 b += p->linesize[0] / 2;
334 g += p->linesize[1] / 2;
335 r += p->linesize[2] / 2;
342 static int magy_decode_slice(AVCodecContext *avctx, void *tdata,
345 MagicYUVContext *s = avctx->priv_data;
346 int interlaced = s->interlaced;
348 int i, k, x, min_width;
352 for (i = 0; i < s->planes; i++) {
353 int left, lefttop, top;
354 int height = AV_CEIL_RSHIFT(FFMIN(s->slice_height, avctx->coded_height - j * s->slice_height), s->vshift[i]);
355 int width = AV_CEIL_RSHIFT(avctx->coded_width, s->hshift[i]);
356 int sheight = AV_CEIL_RSHIFT(s->slice_height, s->vshift[i]);
357 ptrdiff_t fake_stride = p->linesize[i] * (1 + interlaced);
358 ptrdiff_t stride = p->linesize[i];
360 int ret = init_get_bits8(&gb, s->buf + s->slices[i][j].start,
361 s->slices[i][j].size);
366 flags = get_bits(&gb, 8);
367 pred = get_bits(&gb, 8);
369 dst = p->data[i] + j * sheight * stride;
371 for (k = 0; k < height; k++) {
372 for (x = 0; x < width; x++)
373 dst[x] = get_bits(&gb, 8);
378 for (k = 0; k < height; k++) {
379 for (x = 0; x < width; x++) {
381 if (get_bits_left(&gb) <= 0)
382 return AVERROR_INVALIDDATA;
384 pix = get_vlc2(&gb, s->vlc[i].table, s->vlc[i].bits, 3);
386 return AVERROR_INVALIDDATA;
396 dst = p->data[i] + j * sheight * stride;
397 s->llviddsp.add_left_pred(dst, dst, width, 0);
400 s->llviddsp.add_left_pred(dst, dst, width, 0);
403 for (k = 1 + interlaced; k < height; k++) {
404 s->llviddsp.add_left_pred(dst, dst, width, dst[-fake_stride]);
409 dst = p->data[i] + j * sheight * stride;
410 s->llviddsp.add_left_pred(dst, dst, width, 0);
413 s->llviddsp.add_left_pred(dst, dst, width, 0);
416 min_width = FFMIN(width, 32);
417 for (k = 1 + interlaced; k < height; k++) {
418 top = dst[-fake_stride];
421 for (x = 1; x < min_width; x++) { /* dsp need aligned 32 */
422 top = dst[x - fake_stride];
423 lefttop = dst[x - (fake_stride + 1)];
424 left += top - lefttop + dst[x];
428 s->llviddsp.add_gradient_pred(dst + 32, fake_stride, width - 32);
433 dst = p->data[i] + j * sheight * stride;
434 s->llviddsp.add_left_pred(dst, dst, width, 0);
437 s->llviddsp.add_left_pred(dst, dst, width, 0);
440 lefttop = left = dst[0];
441 for (k = 1 + interlaced; k < height; k++) {
442 s->llviddsp.add_median_pred(dst, dst - fake_stride,
443 dst, width, &left, &lefttop);
444 lefttop = left = dst[0];
449 avpriv_request_sample(avctx, "Unknown prediction: %d", pred);
453 if (s->decorrelate) {
454 int height = FFMIN(s->slice_height, avctx->coded_height - j * s->slice_height);
455 int width = avctx->coded_width;
456 uint8_t *b = p->data[0] + j * s->slice_height * p->linesize[0];
457 uint8_t *g = p->data[1] + j * s->slice_height * p->linesize[1];
458 uint8_t *r = p->data[2] + j * s->slice_height * p->linesize[2];
460 for (i = 0; i < height; i++) {
461 s->llviddsp.add_bytes(b, g, width);
462 s->llviddsp.add_bytes(r, g, width);
472 static int build_huffman(AVCodecContext *avctx, GetBitContext *gbit, int max)
474 MagicYUVContext *s = avctx->priv_data;
477 memset(s->len, 0, sizeof(s->len));
478 while (get_bits_left(gbit) >= 8) {
479 int b = get_bits(gbit, 1);
480 int x = get_bits(gbit, 7);
481 int l = get_bitsz(gbit, b * 8) + 1;
483 for (k = 0; k < l; k++)
485 s->len[i][j + k] = x;
490 if (s->huff_build(&s->vlc[i], s->len[i])) {
491 av_log(avctx, AV_LOG_ERROR, "Cannot build Huffman codes\n");
492 return AVERROR_INVALIDDATA;
495 if (i == s->planes) {
498 } else if (j > max) {
499 av_log(avctx, AV_LOG_ERROR, "Invalid Huffman codes\n");
500 return AVERROR_INVALIDDATA;
504 if (i != s->planes) {
505 av_log(avctx, AV_LOG_ERROR, "Huffman tables too short\n");
506 return AVERROR_INVALIDDATA;
512 static int magy_decode_frame(AVCodecContext *avctx, void *data,
513 int *got_frame, AVPacket *avpkt)
515 MagicYUVContext *s = avctx->priv_data;
516 ThreadFrame frame = { .f = data };
518 GetByteContext gbyte;
520 uint32_t first_offset, offset, next_offset, header_size, slice_width;
521 int width, height, format, version, table_size;
524 bytestream2_init(&gbyte, avpkt->data, avpkt->size);
525 if (bytestream2_get_le32(&gbyte) != MKTAG('M', 'A', 'G', 'Y'))
526 return AVERROR_INVALIDDATA;
528 header_size = bytestream2_get_le32(&gbyte);
529 if (header_size < 32 || header_size >= avpkt->size) {
530 av_log(avctx, AV_LOG_ERROR,
531 "header or packet too small %"PRIu32"\n", header_size);
532 return AVERROR_INVALIDDATA;
535 version = bytestream2_get_byte(&gbyte);
537 avpriv_request_sample(avctx, "Version %d", version);
538 return AVERROR_PATCHWELCOME;
548 s->huff_build = huff_build;
549 s->magy_decode_slice = magy_decode_slice;
551 format = bytestream2_get_byte(&gbyte);
554 avctx->pix_fmt = AV_PIX_FMT_GBRP;
558 avctx->pix_fmt = AV_PIX_FMT_GBRAP;
562 avctx->pix_fmt = AV_PIX_FMT_YUV444P;
565 avctx->pix_fmt = AV_PIX_FMT_YUV422P;
570 avctx->pix_fmt = AV_PIX_FMT_YUV420P;
577 avctx->pix_fmt = AV_PIX_FMT_YUVA444P;
580 avctx->pix_fmt = AV_PIX_FMT_GRAY8;
583 avctx->pix_fmt = AV_PIX_FMT_YUV422P10;
587 s->huff_build = huff_build10;
588 s->magy_decode_slice = magy_decode_slice10;
592 avctx->pix_fmt = AV_PIX_FMT_GBRP10;
595 s->huff_build = huff_build10;
596 s->magy_decode_slice = magy_decode_slice10;
600 avctx->pix_fmt = AV_PIX_FMT_GBRAP10;
603 s->huff_build = huff_build10;
604 s->magy_decode_slice = magy_decode_slice10;
608 avctx->pix_fmt = AV_PIX_FMT_GBRP12;
611 s->huff_build = huff_build12;
612 s->magy_decode_slice = magy_decode_slice10;
616 avctx->pix_fmt = AV_PIX_FMT_GBRAP12;
619 s->huff_build = huff_build12;
620 s->magy_decode_slice = magy_decode_slice10;
624 avctx->pix_fmt = AV_PIX_FMT_GRAY10;
626 s->huff_build = huff_build10;
627 s->magy_decode_slice = magy_decode_slice10;
631 avpriv_request_sample(avctx, "Format 0x%X", format);
632 return AVERROR_PATCHWELCOME;
634 s->planes = av_pix_fmt_count_planes(avctx->pix_fmt);
636 bytestream2_skip(&gbyte, 1);
637 s->color_matrix = bytestream2_get_byte(&gbyte);
638 s->flags = bytestream2_get_byte(&gbyte);
639 s->interlaced = !!(s->flags & 2);
640 bytestream2_skip(&gbyte, 3);
642 width = bytestream2_get_le32(&gbyte);
643 height = bytestream2_get_le32(&gbyte);
644 ret = ff_set_dimensions(avctx, width, height);
648 slice_width = bytestream2_get_le32(&gbyte);
649 if (slice_width != avctx->coded_width) {
650 avpriv_request_sample(avctx, "Slice width %"PRIu32, slice_width);
651 return AVERROR_PATCHWELCOME;
653 s->slice_height = bytestream2_get_le32(&gbyte);
654 if (s->slice_height <= 0 || s->slice_height > INT_MAX - avctx->coded_height) {
655 av_log(avctx, AV_LOG_ERROR,
656 "invalid slice height: %d\n", s->slice_height);
657 return AVERROR_INVALIDDATA;
660 bytestream2_skip(&gbyte, 4);
662 s->nb_slices = (avctx->coded_height + s->slice_height - 1) / s->slice_height;
663 if (s->nb_slices > INT_MAX / sizeof(Slice)) {
664 av_log(avctx, AV_LOG_ERROR,
665 "invalid number of slices: %d\n", s->nb_slices);
666 return AVERROR_INVALIDDATA;
669 for (i = 0; i < s->planes; i++) {
670 av_fast_malloc(&s->slices[i], &s->slices_size[i], s->nb_slices * sizeof(Slice));
672 return AVERROR(ENOMEM);
674 offset = bytestream2_get_le32(&gbyte);
675 if (offset >= avpkt->size - header_size)
676 return AVERROR_INVALIDDATA;
679 first_offset = offset;
681 for (j = 0; j < s->nb_slices - 1; j++) {
682 s->slices[i][j].start = offset + header_size;
684 next_offset = bytestream2_get_le32(&gbyte);
685 if (next_offset <= offset || next_offset >= avpkt->size - header_size)
686 return AVERROR_INVALIDDATA;
688 s->slices[i][j].size = next_offset - offset;
689 offset = next_offset;
692 s->slices[i][j].start = offset + header_size;
693 s->slices[i][j].size = avpkt->size - s->slices[i][j].start;
696 if (bytestream2_get_byte(&gbyte) != s->planes)
697 return AVERROR_INVALIDDATA;
699 bytestream2_skip(&gbyte, s->nb_slices * s->planes);
701 table_size = header_size + first_offset - bytestream2_tell(&gbyte);
703 return AVERROR_INVALIDDATA;
705 ret = init_get_bits8(&gbit, avpkt->data + bytestream2_tell(&gbyte), table_size);
709 ret = build_huffman(avctx, &gbit, s->max);
713 p->pict_type = AV_PICTURE_TYPE_I;
716 if ((ret = ff_thread_get_buffer(avctx, &frame, 0)) < 0)
719 s->buf = avpkt->data;
721 avctx->execute2(avctx, s->magy_decode_slice, NULL, NULL, s->nb_slices);
723 if (avctx->pix_fmt == AV_PIX_FMT_GBRP ||
724 avctx->pix_fmt == AV_PIX_FMT_GBRAP ||
725 avctx->pix_fmt == AV_PIX_FMT_GBRP10 ||
726 avctx->pix_fmt == AV_PIX_FMT_GBRAP10||
727 avctx->pix_fmt == AV_PIX_FMT_GBRAP12||
728 avctx->pix_fmt == AV_PIX_FMT_GBRP12) {
729 FFSWAP(uint8_t*, p->data[0], p->data[1]);
730 FFSWAP(int, p->linesize[0], p->linesize[1]);
732 switch (s->color_matrix) {
734 p->colorspace = AVCOL_SPC_BT470BG;
737 p->colorspace = AVCOL_SPC_BT709;
740 p->color_range = (s->flags & 4) ? AVCOL_RANGE_JPEG : AVCOL_RANGE_MPEG;
749 static int magy_init_thread_copy(AVCodecContext *avctx)
751 MagicYUVContext *s = avctx->priv_data;
754 for (i = 0; i < FF_ARRAY_ELEMS(s->slices); i++) {
756 s->slices_size[i] = 0;
763 static av_cold int magy_decode_init(AVCodecContext *avctx)
765 MagicYUVContext *s = avctx->priv_data;
766 ff_llviddsp_init(&s->llviddsp);
770 static av_cold int magy_decode_end(AVCodecContext *avctx)
772 MagicYUVContext * const s = avctx->priv_data;
775 for (i = 0; i < FF_ARRAY_ELEMS(s->slices); i++) {
776 av_freep(&s->slices[i]);
777 s->slices_size[i] = 0;
778 ff_free_vlc(&s->vlc[i]);
784 AVCodec ff_magicyuv_decoder = {
786 .long_name = NULL_IF_CONFIG_SMALL("MagicYUV video"),
787 .type = AVMEDIA_TYPE_VIDEO,
788 .id = AV_CODEC_ID_MAGICYUV,
789 .priv_data_size = sizeof(MagicYUVContext),
790 .init = magy_decode_init,
791 .init_thread_copy = ONLY_IF_THREADS_ENABLED(magy_init_thread_copy),
792 .close = magy_decode_end,
793 .decode = magy_decode_frame,
794 .capabilities = AV_CODEC_CAP_DR1 |
795 AV_CODEC_CAP_FRAME_THREADS |
796 AV_CODEC_CAP_SLICE_THREADS,
797 .caps_internal = FF_CODEC_CAP_INIT_THREADSAFE,