cd703e7c8a918356a613b216b2726ee3a02ed90d
[ffmpeg.git] / libavcodec / magicyuv.c
1 /*
2  * MagicYUV decoder
3  * Copyright (c) 2016 Paul B Mahol
4  *
5  * This file is part of FFmpeg.
6  *
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.
11  *
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.
16  *
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
20  */
21
22 #include <stdio.h>
23 #include <stdlib.h>
24 #include <string.h>
25
26 #include "libavutil/qsort.h"
27 #include "avcodec.h"
28 #include "bytestream.h"
29 #include "get_bits.h"
30 #include "huffyuvdsp.h"
31 #include "internal.h"
32 #include "thread.h"
33
34 typedef struct Slice {
35     uint32_t start;
36     uint32_t size;
37 } Slice;
38
39 typedef enum Prediction {
40     LEFT = 1,
41     GRADIENT,
42     MEDIAN,
43 } Prediction;
44
45 typedef struct MagicYUVContext {
46     AVFrame            *p;
47     int                 slice_height;
48     int                 nb_slices;
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
53     int                 hshift[4];
54     int                 vshift[4];
55     Slice               *slices[4];     // slice positions and size in bitstream for each plane
56     int                 slices_size[4];
57     uint8_t             len[4][256];    // table of code lengths for each plane
58     VLC                 vlc[4];         // VLC for each plane
59     HuffYUVDSPContext   hdsp;
60 } MagicYUVContext;
61
62 static av_cold int decode_init(AVCodecContext *avctx)
63 {
64     MagicYUVContext *s = avctx->priv_data;
65     ff_huffyuvdsp_init(&s->hdsp);
66     return 0;
67 }
68
69 typedef struct HuffEntry {
70     uint8_t  sym;
71     uint8_t  len;
72     uint32_t code;
73 } HuffEntry;
74
75 static int ff_magy_huff_cmp_len(const void *a, const void *b)
76 {
77     const HuffEntry *aa = a, *bb = b;
78     return (aa->len - bb->len) * 256 + aa->sym - bb->sym;
79 }
80
81 static int build_huff(VLC *vlc, uint8_t *len)
82 {
83     HuffEntry he[256];
84     uint32_t codes[256];
85     uint8_t bits[256];
86     uint8_t syms[256];
87     uint32_t code;
88     int i;
89
90     for (i = 0; i < 256; i++) {
91         he[i].sym = 255 - i;
92         he[i].len = len[i];
93     }
94     AV_QSORT(he, 256, HuffEntry, ff_magy_huff_cmp_len);
95
96     code = 1;
97     for (i = 255; i >= 0; i--) {
98         codes[i] = code >> (32 - he[i].len);
99         bits[i]  = he[i].len;
100         syms[i]  = he[i].sym;
101         code += 0x80000000u >> (he[i].len - 1);
102     }
103
104     ff_free_vlc(vlc);
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);
109 }
110
111 static int decode_slice(AVCodecContext *avctx, void *tdata,
112                         int j, int threadnr)
113 {
114     MagicYUVContext *s = avctx->priv_data;
115     int interlaced = s->interlaced;
116     AVFrame *p = s->p;
117     int i, k, x, ret;
118     GetBitContext b;
119     uint8_t *dst;
120
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];
127         int flags, pred;
128
129         if ((ret = init_get_bits8(&b, s->buf + s->slices[i][j].start, s->slices[i][j].size)) < 0)
130             return ret;
131
132         flags = get_bits(&b, 8);
133         pred  = get_bits(&b, 8);
134
135         dst = p->data[i] + j * sheight * stride;
136         if (flags & 1) {
137             for (k = 0; k < height; k++) {
138                 for (x = 0; x < width; x++) {
139                     dst[x] = get_bits(&b, 8);
140                 }
141                 dst += stride;
142             }
143         } else {
144             for (k = 0; k < height; k++) {
145                 for (x = 0; x < width; x++) {
146                     int pix;
147                     if (get_bits_left(&b) <= 0) {
148                         return AVERROR_INVALIDDATA;
149                     }
150                     pix = get_vlc2(&b, s->vlc[i].table, s->vlc[i].bits, 3);
151                     if (pix < 0) {
152                         return AVERROR_INVALIDDATA;
153                     }
154                     dst[x] = 255 - pix;
155                 }
156                 dst += stride;
157             }
158         }
159
160         if (pred == LEFT) {
161             dst = p->data[i] + j * sheight * stride;
162             s->hdsp.add_hfyu_left_pred(dst, dst, width, 0);
163             dst += stride;
164             if (interlaced) {
165                 s->hdsp.add_hfyu_left_pred(dst, dst, width, 0);
166                 dst += stride;
167             }
168             for (k = 1 + interlaced; k < height; k++) {
169                 s->hdsp.add_hfyu_left_pred(dst, dst, width, dst[-fake_stride]);
170                 dst += stride;
171             }
172         } else if (pred == GRADIENT) {
173             int left, lefttop, top;
174
175             dst = p->data[i] + j * sheight * stride;
176             s->hdsp.add_hfyu_left_pred(dst, dst, width, 0);
177             left = lefttop = 0;
178             dst += stride;
179             if (interlaced) {
180                 s->hdsp.add_hfyu_left_pred(dst, dst, width, 0);
181                 left = lefttop = 0;
182                 dst += stride;
183             }
184             for (k = 1 + interlaced; k < height; k++) {
185                 top = dst[-fake_stride];
186                 left = top + dst[0];
187                 dst[0] = left;
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];
192                     dst[x] = left;
193                 }
194                 dst += stride;
195             }
196         } else if (pred == MEDIAN) {
197             int left, lefttop;
198
199             dst = p->data[i] + j * sheight * stride;
200             lefttop = left = dst[0];
201             s->hdsp.add_hfyu_left_pred(dst, dst, width, 0);
202             dst += stride;
203             if (interlaced) {
204                 lefttop = left = dst[0];
205                 s->hdsp.add_hfyu_left_pred(dst, dst, width, 0);
206                 dst += stride;
207             }
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];
211                 dst += stride;
212             }
213         } else {
214             avpriv_request_sample(avctx, "unknown prediction: %d", pred);
215         }
216     }
217
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];
224
225         for (i = 0; i < height; i++) {
226             s->hdsp.add_bytes(b, g, width);
227             s->hdsp.add_bytes(r, g, width);
228             b += p->linesize[0];
229             g += p->linesize[1];
230             r += p->linesize[2];
231         }
232     }
233
234     return 0;
235 }
236
237 static int decode_frame(AVCodecContext *avctx,
238                         void *data, int *got_frame,
239                         AVPacket *avpkt)
240 {
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 };
245     AVFrame *p = data;
246     GetByteContext gb;
247     GetBitContext b;
248     int i, j, k;
249
250     bytestream2_init(&gb, avpkt->data, avpkt->size);
251     if (bytestream2_get_le32(&gb) != MKTAG('M','A','G','Y'))
252         return AVERROR_INVALIDDATA;
253
254     header_size = bytestream2_get_le32(&gb);
255     if (header_size < 32 || header_size >= avpkt->size)
256         return AVERROR_INVALIDDATA;
257
258     version = bytestream2_get_byte(&gb);
259     if (version != 7) {
260         avpriv_request_sample(avctx, "unsupported version: %d", version);
261         return AVERROR_PATCHWELCOME;
262     }
263
264     s->hshift[1] = s->vshift[1] = 0;
265     s->hshift[2] = s->vshift[2] = 0;
266     s->decorrelate = 0;
267
268     format = bytestream2_get_byte(&gb);
269     switch (format) {
270     case 0x65:
271         avctx->pix_fmt = AV_PIX_FMT_GBRP;
272         s->decorrelate = 1;
273         s->planes = 3;
274         break;
275     case 0x66:
276         avctx->pix_fmt = AV_PIX_FMT_GBRAP;
277         s->decorrelate = 1;
278         s->planes = 4;
279         break;
280     case 0x67:
281         avctx->pix_fmt = AV_PIX_FMT_YUV444P;
282         s->planes = 3;
283         break;
284     case 0x68:
285         avctx->pix_fmt = AV_PIX_FMT_YUV422P;
286         s->planes = 3;
287         s->hshift[1] = s->hshift[2] = 1;
288         break;
289     case 0x69:
290         avctx->pix_fmt = AV_PIX_FMT_YUV420P;
291         s->planes = 3;
292         s->hshift[1] = s->vshift[1] = 1;
293         s->hshift[2] = s->vshift[2] = 1;
294         break;
295     case 0x6a:
296         avctx->pix_fmt = AV_PIX_FMT_YUVA444P;
297         s->planes = 4;
298         break;
299     case 0x6b:
300         avctx->pix_fmt = AV_PIX_FMT_GRAY8;
301         s->planes = 1;
302         break;
303     default:
304         avpriv_request_sample(avctx, "unsupported format: 0x%X", format);
305         return AVERROR_PATCHWELCOME;
306     }
307
308     bytestream2_skip(&gb, 2);
309     s->interlaced = !!(bytestream2_get_byte(&gb) & 2);
310     bytestream2_skip(&gb, 3);
311
312     avctx->coded_width  = bytestream2_get_le32(&gb);
313     avctx->coded_height = bytestream2_get_le32(&gb);
314     slice_width = bytestream2_get_le32(&gb);
315     if (slice_width != avctx->coded_width) {
316         avpriv_request_sample(avctx, "unsupported slice width: %d", slice_width);
317         return AVERROR_PATCHWELCOME;
318     }
319     s->slice_height = bytestream2_get_le32(&gb);
320     if ((s->slice_height <= 0) || (s->slice_height > INT_MAX - avctx->coded_height)) {
321         av_log(avctx, AV_LOG_ERROR, "invalid slice height: %d\n", s->slice_height);
322         return AVERROR_INVALIDDATA;
323     }
324
325     bytestream2_skip(&gb, 4);
326
327     s->nb_slices = (avctx->coded_height + s->slice_height - 1) / s->slice_height;
328     if (s->nb_slices > INT_MAX / sizeof(Slice)) {
329         av_log(avctx, AV_LOG_ERROR, "invalid number of slices: %d\n", s->nb_slices);
330         return AVERROR_INVALIDDATA;
331     }
332
333     for (i = 0; i < s->planes; i++) {
334         av_fast_malloc(&s->slices[i], &s->slices_size[i], s->nb_slices * sizeof(Slice));
335         if (!s->slices[i])
336             return AVERROR(ENOMEM);
337
338         offset = bytestream2_get_le32(&gb);
339         if (offset >= avpkt->size - header_size)
340             return AVERROR_INVALIDDATA;
341
342         if (i == 0)
343             first_offset = offset;
344
345         for (j = 0; j < s->nb_slices - 1; j++) {
346             s->slices[i][j].start = offset + header_size;
347             next_offset = bytestream2_get_le32(&gb);
348             s->slices[i][j].size  = next_offset - offset;
349             offset = next_offset;
350
351             if (offset >= avpkt->size - header_size)
352                 return AVERROR_INVALIDDATA;
353         }
354
355         s->slices[i][j].start = offset + header_size;
356         s->slices[i][j].size  = avpkt->size - s->slices[i][j].start;
357     }
358
359     if (bytestream2_get_byte(&gb) != s->planes)
360         return AVERROR_INVALIDDATA;
361
362     bytestream2_skip(&gb, s->nb_slices * s->planes);
363
364     table_size = header_size + first_offset - bytestream2_tell(&gb);
365     if (table_size < 2)
366         return AVERROR_INVALIDDATA;
367
368     if ((ret = init_get_bits8(&b, avpkt->data + bytestream2_tell(&gb), table_size)) < 0)
369         return ret;
370
371     memset(s->len, 0, sizeof(s->len));
372     j = i = 0;
373     while (get_bits_left(&b) >= 8) {
374         int l = get_bits(&b, 4);
375         int x = get_bits(&b, 4);
376         int L = get_bitsz(&b, l) + 1;
377
378         for (k = 0; k < L; k++) {
379             if (j + k < 256)
380                 s->len[i][j + k] = x;
381         }
382
383         j += L;
384         if (j == 256) {
385             j = 0;
386             if (build_huff(&s->vlc[i], s->len[i])) {
387                 av_log(avctx, AV_LOG_ERROR, "Cannot build Huffman codes\n");
388                 return AVERROR_INVALIDDATA;
389             }
390             i++;
391             if (i == s->planes) {
392                 break;
393             }
394         } else if (j > 256) {
395             return AVERROR_INVALIDDATA;
396         }
397     }
398
399     if (i != s->planes) {
400         av_log(avctx, AV_LOG_ERROR, "Huffman tables too short\n");
401         return AVERROR_INVALIDDATA;
402     }
403
404     p->pict_type = AV_PICTURE_TYPE_I;
405     p->key_frame = 1;
406
407     if ((ret = ff_thread_get_buffer(avctx, &frame, 0)) < 0)
408         return ret;
409
410     s->buf = avpkt->data;
411     s->p = p;
412     avctx->execute2(avctx, decode_slice, NULL, NULL, s->nb_slices);
413
414     if (avctx->pix_fmt == AV_PIX_FMT_GBRP ||
415         avctx->pix_fmt == AV_PIX_FMT_GBRAP) {
416         FFSWAP(uint8_t*, p->data[0], p->data[1]);
417         FFSWAP(int, p->linesize[0], p->linesize[1]);
418     }
419
420     *got_frame = 1;
421
422     if (ret < 0)
423         return ret;
424     return avpkt->size;
425 }
426
427 #if HAVE_THREADS
428 static int decode_init_thread_copy(AVCodecContext *avctx)
429 {
430     MagicYUVContext *s = avctx->priv_data;
431
432     s->slices[0] = 0;
433     s->slices[1] = 0;
434     s->slices[2] = 0;
435     s->slices[3] = 0;
436     s->slices_size[0] = 0;
437     s->slices_size[1] = 0;
438     s->slices_size[2] = 0;
439     s->slices_size[3] = 0;
440
441     return 0;
442 }
443 #endif
444
445 static av_cold int decode_end(AVCodecContext *avctx)
446 {
447     MagicYUVContext * const s = avctx->priv_data;
448
449     av_freep(&s->slices[0]);
450     av_freep(&s->slices[1]);
451     av_freep(&s->slices[2]);
452     av_freep(&s->slices[3]);
453     s->slices_size[0] = 0;
454     s->slices_size[1] = 0;
455     s->slices_size[2] = 0;
456     s->slices_size[3] = 0;
457     ff_free_vlc(&s->vlc[0]);
458     ff_free_vlc(&s->vlc[1]);
459     ff_free_vlc(&s->vlc[2]);
460     ff_free_vlc(&s->vlc[3]);
461
462     return 0;
463 }
464
465 AVCodec ff_magicyuv_decoder = {
466     .name             = "magicyuv",
467     .long_name        = NULL_IF_CONFIG_SMALL("MagicYUV Lossless Video"),
468     .type             = AVMEDIA_TYPE_VIDEO,
469     .id               = AV_CODEC_ID_MAGICYUV,
470     .priv_data_size   = sizeof(MagicYUVContext),
471     .init             = decode_init,
472     .init_thread_copy = ONLY_IF_THREADS_ENABLED(decode_init_thread_copy),
473     .close            = decode_end,
474     .decode           = decode_frame,
475     .capabilities     = AV_CODEC_CAP_DR1 | AV_CODEC_CAP_FRAME_THREADS | AV_CODEC_CAP_SLICE_THREADS,
476 };