Merge remote-tracking branch 'qatar/master'
[ffmpeg.git] / libavcodec / utvideo.c
1 /*
2  * Ut Video decoder
3  * Copyright (c) 2011 Konstantin Shishkov
4  *
5  * This file is part of Libav.
6  *
7  * Libav 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  * Libav 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 Libav; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21
22 /**
23  * @file
24  * Ut Video decoder
25  */
26
27 #include <stdlib.h>
28
29 #include "libavutil/intreadwrite.h"
30 #include "avcodec.h"
31 #include "bytestream.h"
32 #include "get_bits.h"
33 #include "dsputil.h"
34 #include "thread.h"
35
36 enum {
37     PRED_NONE = 0,
38     PRED_LEFT,
39     PRED_GRADIENT,
40     PRED_MEDIAN,
41 };
42
43 typedef struct UtvideoContext {
44     AVCodecContext *avctx;
45     AVFrame pic;
46     DSPContext dsp;
47
48     uint32_t frame_info_size, flags, frame_info;
49     int planes;
50     int slices;
51     int compression;
52     int interlaced;
53     int frame_pred;
54
55     uint8_t *slice_bits;
56     int slice_bits_size;
57 } UtvideoContext;
58
59 typedef struct HuffEntry {
60     uint8_t sym;
61     uint8_t len;
62 } HuffEntry;
63
64 static int huff_cmp(const void *a, const void *b)
65 {
66     const HuffEntry *aa = a, *bb = b;
67     return (aa->len - bb->len)*256 + aa->sym - bb->sym;
68 }
69
70 static int build_huff(const uint8_t *src, VLC *vlc, int *fsym)
71 {
72     int i;
73     HuffEntry he[256];
74     int last;
75     uint32_t codes[256];
76     uint8_t bits[256];
77     uint8_t syms[256];
78     uint32_t code;
79
80     *fsym = -1;
81     for (i = 0; i < 256; i++) {
82         he[i].sym = i;
83         he[i].len = *src++;
84     }
85     qsort(he, 256, sizeof(*he), huff_cmp);
86
87     if (!he[0].len) {
88         *fsym = he[0].sym;
89         return 0;
90     }
91     if (he[0].len > 32)
92         return -1;
93
94     last = 255;
95     while (he[last].len == 255 && last)
96         last--;
97
98     code = 1;
99     for (i = last; i >= 0; i--) {
100         codes[i] = code >> (32 - he[i].len);
101         bits[i]  = he[i].len;
102         syms[i]  = he[i].sym;
103         code += 0x80000000u >> (he[i].len - 1);
104     }
105
106     return ff_init_vlc_sparse(vlc, FFMIN(he[last].len, 9), last + 1,
107                               bits,  sizeof(*bits),  sizeof(*bits),
108                               codes, sizeof(*codes), sizeof(*codes),
109                               syms,  sizeof(*syms),  sizeof(*syms), 0);
110 }
111
112 static int decode_plane(UtvideoContext *c, int plane_no,
113                         uint8_t *dst, int step, int stride,
114                         int width, int height,
115                         const uint8_t *src, int use_pred)
116 {
117     int i, j, slice, pix;
118     int sstart, send;
119     VLC vlc;
120     GetBitContext gb;
121     int prev, fsym;
122     const int cmask = ~(!plane_no && c->avctx->pix_fmt == PIX_FMT_YUV420P);
123
124     if (build_huff(src, &vlc, &fsym)) {
125         av_log(c->avctx, AV_LOG_ERROR, "Cannot build Huffman codes\n");
126         return AVERROR_INVALIDDATA;
127     }
128     if (fsym >= 0) { // build_huff reported a symbol to fill slices with
129         send = 0;
130         for (slice = 0; slice < c->slices; slice++) {
131             uint8_t *dest;
132
133             sstart = send;
134             send   = (height * (slice + 1) / c->slices) & cmask;
135             dest   = dst + sstart * stride;
136
137             prev = 0x80;
138             for (j = sstart; j < send; j++) {
139                 for (i = 0; i < width * step; i += step) {
140                     pix = fsym;
141                     if (use_pred) {
142                         prev += pix;
143                         pix   = prev;
144                     }
145                     dest[i] = pix;
146                 }
147                 dest += stride;
148             }
149         }
150         return 0;
151     }
152
153     src      += 256;
154
155     send = 0;
156     for (slice = 0; slice < c->slices; slice++) {
157         uint8_t *dest;
158         int slice_data_start, slice_data_end, slice_size;
159
160         sstart = send;
161         send   = (height * (slice + 1) / c->slices) & cmask;
162         dest   = dst + sstart * stride;
163
164         // slice offset and size validation was done earlier
165         slice_data_start = slice ? AV_RL32(src + slice * 4 - 4) : 0;
166         slice_data_end   = AV_RL32(src + slice * 4);
167         slice_size       = slice_data_end - slice_data_start;
168
169         if (!slice_size) {
170             for (j = sstart; j < send; j++) {
171                 for (i = 0; i < width * step; i += step)
172                     dest[i] = 0x80;
173                 dest += stride;
174             }
175             continue;
176         }
177
178         memcpy(c->slice_bits, src + slice_data_start + c->slices * 4,
179                slice_size);
180         memset(c->slice_bits + slice_size, 0, FF_INPUT_BUFFER_PADDING_SIZE);
181         c->dsp.bswap_buf((uint32_t *) c->slice_bits, (uint32_t *) c->slice_bits,
182                          (slice_data_end - slice_data_start + 3) >> 2);
183         init_get_bits(&gb, c->slice_bits, slice_size * 8);
184
185         prev = 0x80;
186         for (j = sstart; j < send; j++) {
187             for (i = 0; i < width * step; i += step) {
188                 if (get_bits_left(&gb) <= 0) {
189                     av_log(c->avctx, AV_LOG_ERROR,
190                            "Slice decoding ran out of bits\n");
191                     goto fail;
192                 }
193                 pix = get_vlc2(&gb, vlc.table, vlc.bits, 4);
194                 if (pix < 0) {
195                     av_log(c->avctx, AV_LOG_ERROR, "Decoding error\n");
196                     goto fail;
197                 }
198                 if (use_pred) {
199                     prev += pix;
200                     pix   = prev;
201                 }
202                 dest[i] = pix;
203             }
204             dest += stride;
205         }
206         if (get_bits_left(&gb) > 32)
207             av_log(c->avctx, AV_LOG_WARNING,
208                    "%d bits left after decoding slice\n", get_bits_left(&gb));
209     }
210
211     ff_free_vlc(&vlc);
212
213     return 0;
214 fail:
215     ff_free_vlc(&vlc);
216     return AVERROR_INVALIDDATA;
217 }
218
219 static const int rgb_order[4] = { 1, 2, 0, 3 };
220
221 static void restore_rgb_planes(uint8_t *src, int step, int stride, int width,
222                                int height)
223 {
224     int i, j;
225     uint8_t r, g, b;
226
227     for (j = 0; j < height; j++) {
228         for (i = 0; i < width * step; i += step) {
229             r = src[i];
230             g = src[i + 1];
231             b = src[i + 2];
232             src[i]     = r + g - 0x80;
233             src[i + 2] = b + g - 0x80;
234         }
235         src += stride;
236     }
237 }
238
239 static void restore_median(uint8_t *src, int step, int stride,
240                            int width, int height, int slices, int rmode)
241 {
242     int i, j, slice;
243     int A, B, C;
244     uint8_t *bsrc;
245     int slice_start, slice_height;
246     const int cmask = ~rmode;
247
248     for (slice = 0; slice < slices; slice++) {
249         slice_start  = ((slice * height) / slices) & cmask;
250         slice_height = ((((slice + 1) * height) / slices) & cmask) -
251                        slice_start;
252
253         bsrc = src + slice_start * stride;
254
255         // first line - left neighbour prediction
256         bsrc[0] += 0x80;
257         A = bsrc[0];
258         for (i = step; i < width * step; i += step) {
259             bsrc[i] += A;
260             A        = bsrc[i];
261         }
262         bsrc += stride;
263         if (slice_height == 1)
264             continue;
265         // second line - first element has top prediction, the rest uses median
266         C        = bsrc[-stride];
267         bsrc[0] += C;
268         A        = bsrc[0];
269         for (i = step; i < width * step; i += step) {
270             B        = bsrc[i - stride];
271             bsrc[i] += mid_pred(A, B, (uint8_t)(A + B - C));
272             C        = B;
273             A        = bsrc[i];
274         }
275         bsrc += stride;
276         // the rest of lines use continuous median prediction
277         for (j = 2; j < slice_height; j++) {
278             for (i = 0; i < width * step; i += step) {
279                 B        = bsrc[i - stride];
280                 bsrc[i] += mid_pred(A, B, (uint8_t)(A + B - C));
281                 C        = B;
282                 A        = bsrc[i];
283             }
284             bsrc += stride;
285         }
286     }
287 }
288
289 /* UtVideo interlaced mode treats every two lines as a single one,
290  * so restoring function should take care of possible padding between
291  * two parts of the same "line".
292  */
293 static void restore_median_il(uint8_t *src, int step, int stride,
294                               int width, int height, int slices, int rmode)
295 {
296     int i, j, slice;
297     int A, B, C;
298     uint8_t *bsrc;
299     int slice_start, slice_height;
300     const int cmask   = ~(rmode ? 3 : 1);
301     const int stride2 = stride << 1;
302
303     for (slice = 0; slice < slices; slice++) {
304         slice_start    = ((slice * height) / slices) & cmask;
305         slice_height   = ((((slice + 1) * height) / slices) & cmask) -
306                          slice_start;
307         slice_height >>= 1;
308
309         bsrc = src + slice_start * stride;
310
311         // first line - left neighbour prediction
312         bsrc[0] += 0x80;
313         A        = bsrc[0];
314         for (i = step; i < width * step; i += step) {
315             bsrc[i] += A;
316             A        = bsrc[i];
317         }
318         for (i = 0; i < width * step; i += step) {
319             bsrc[stride + i] += A;
320             A                 = bsrc[stride + i];
321         }
322         bsrc += stride2;
323         if (slice_height == 1)
324             continue;
325         // second line - first element has top prediction, the rest uses median
326         C        = bsrc[-stride2];
327         bsrc[0] += C;
328         A        = bsrc[0];
329         for (i = step; i < width * step; i += step) {
330             B        = bsrc[i - stride2];
331             bsrc[i] += mid_pred(A, B, (uint8_t)(A + B - C));
332             C        = B;
333             A        = bsrc[i];
334         }
335         for (i = 0; i < width * step; i += step) {
336             B                 = bsrc[i - stride];
337             bsrc[stride + i] += mid_pred(A, B, (uint8_t)(A + B - C));
338             C                 = B;
339             A                 = bsrc[stride + i];
340         }
341         bsrc += stride2;
342         // the rest of lines use continuous median prediction
343         for (j = 2; j < slice_height; j++) {
344             for (i = 0; i < width * step; i += step) {
345                 B        = bsrc[i - stride2];
346                 bsrc[i] += mid_pred(A, B, (uint8_t)(A + B - C));
347                 C        = B;
348                 A        = bsrc[i];
349             }
350             for (i = 0; i < width * step; i += step) {
351                 B                 = bsrc[i - stride];
352                 bsrc[i + stride] += mid_pred(A, B, (uint8_t)(A + B - C));
353                 C                 = B;
354                 A                 = bsrc[i + stride];
355             }
356             bsrc += stride2;
357         }
358     }
359 }
360
361 static int decode_frame(AVCodecContext *avctx, void *data, int *data_size,
362                         AVPacket *avpkt)
363 {
364     const uint8_t *buf = avpkt->data;
365     int buf_size = avpkt->size;
366     UtvideoContext *c = avctx->priv_data;
367     int i, j;
368     const uint8_t *plane_start[5];
369     int plane_size, max_slice_size = 0, slice_start, slice_end, slice_size;
370     int ret;
371     GetByteContext gb;
372
373     if (c->pic.data[0])
374         ff_thread_release_buffer(avctx, &c->pic);
375
376     c->pic.reference = 3;
377     c->pic.buffer_hints = FF_BUFFER_HINTS_VALID;
378     if ((ret = ff_thread_get_buffer(avctx, &c->pic)) < 0) {
379         av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
380         return ret;
381     }
382
383     /* parse plane structure to get frame flags and validate slice offsets */
384     bytestream2_init(&gb, buf, buf_size);
385     for (i = 0; i < c->planes; i++) {
386         plane_start[i] = gb.buffer;
387         if (bytestream2_get_bytes_left(&gb) < 256 + 4 * c->slices) {
388             av_log(avctx, AV_LOG_ERROR, "Insufficient data for a plane\n");
389             return AVERROR_INVALIDDATA;
390         }
391         bytestream2_skipu(&gb, 256);
392         slice_start = 0;
393         slice_end   = 0;
394         for (j = 0; j < c->slices; j++) {
395             slice_end   = bytestream2_get_le32u(&gb);
396             slice_size  = slice_end - slice_start;
397             if (slice_end <= 0 || slice_size <= 0 ||
398                 bytestream2_get_bytes_left(&gb) < slice_end) {
399                 av_log(avctx, AV_LOG_ERROR, "Incorrect slice size\n");
400                 return AVERROR_INVALIDDATA;
401             }
402             slice_start = slice_end;
403             max_slice_size = FFMAX(max_slice_size, slice_size);
404         }
405         plane_size = slice_end;
406         bytestream2_skipu(&gb, plane_size);
407     }
408     plane_start[c->planes] = gb.buffer;
409     if (bytestream2_get_bytes_left(&gb) < c->frame_info_size) {
410         av_log(avctx, AV_LOG_ERROR, "Not enough data for frame information\n");
411         return AVERROR_INVALIDDATA;
412     }
413     c->frame_info = bytestream2_get_le32u(&gb);
414     av_log(avctx, AV_LOG_DEBUG, "frame information flags %X\n", c->frame_info);
415
416     c->frame_pred = (c->frame_info >> 8) & 3;
417
418     if (c->frame_pred == PRED_GRADIENT) {
419         av_log_ask_for_sample(avctx, "Frame uses gradient prediction\n");
420         return AVERROR_PATCHWELCOME;
421     }
422
423     av_fast_malloc(&c->slice_bits, &c->slice_bits_size,
424                    max_slice_size + FF_INPUT_BUFFER_PADDING_SIZE);
425
426     if (!c->slice_bits) {
427         av_log(avctx, AV_LOG_ERROR, "Cannot allocate temporary buffer\n");
428         return AVERROR(ENOMEM);
429     }
430
431     switch (c->avctx->pix_fmt) {
432     case PIX_FMT_RGB24:
433     case PIX_FMT_RGBA:
434         for (i = 0; i < c->planes; i++) {
435             ret = decode_plane(c, i, c->pic.data[0] + rgb_order[i], c->planes,
436                                c->pic.linesize[0], avctx->width, avctx->height,
437                                plane_start[i], c->frame_pred == PRED_LEFT);
438             if (ret)
439                 return ret;
440             if (c->frame_pred == PRED_MEDIAN)
441                 if (!c->interlaced) {
442                 restore_median(c->pic.data[0] + rgb_order[i], c->planes,
443                                c->pic.linesize[0], avctx->width, avctx->height,
444                                c->slices, 0);
445                 } else {
446                     restore_median_il(c->pic.data[0] + rgb_order[i], c->planes,
447                                       c->pic.linesize[0], avctx->width, avctx->height,
448                                       c->slices, 0);
449                 }
450         }
451         restore_rgb_planes(c->pic.data[0], c->planes, c->pic.linesize[0],
452                            avctx->width, avctx->height);
453         break;
454     case PIX_FMT_YUV420P:
455         for (i = 0; i < 3; i++) {
456             ret = decode_plane(c, i, c->pic.data[i], 1, c->pic.linesize[i],
457                                avctx->width >> !!i, avctx->height >> !!i,
458                                plane_start[i], c->frame_pred == PRED_LEFT);
459             if (ret)
460                 return ret;
461             if (c->frame_pred == PRED_MEDIAN) {
462                 if (!c->interlaced) {
463                     restore_median(c->pic.data[i], 1, c->pic.linesize[i],
464                                    avctx->width >> !!i, avctx->height >> !!i,
465                                    c->slices, !i);
466                 } else {
467                     restore_median_il(c->pic.data[i], 1, c->pic.linesize[i],
468                                       avctx->width  >> !!i,
469                                       avctx->height >> !!i,
470                                       c->slices, !i);
471                 }
472             }
473         }
474         break;
475     case PIX_FMT_YUV422P:
476         for (i = 0; i < 3; i++) {
477             ret = decode_plane(c, i, c->pic.data[i], 1, c->pic.linesize[i],
478                                avctx->width >> !!i, avctx->height,
479                                plane_start[i], c->frame_pred == PRED_LEFT);
480             if (ret)
481                 return ret;
482             if (c->frame_pred == PRED_MEDIAN) {
483                 if (!c->interlaced) {
484                     restore_median(c->pic.data[i], 1, c->pic.linesize[i],
485                                    avctx->width >> !!i, avctx->height,
486                                    c->slices, 0);
487                 } else {
488                     restore_median_il(c->pic.data[i], 1, c->pic.linesize[i],
489                                       avctx->width >> !!i, avctx->height,
490                                       c->slices, 0);
491                 }
492             }
493         }
494         break;
495     }
496
497     c->pic.key_frame = 1;
498     c->pic.pict_type = AV_PICTURE_TYPE_I;
499     c->pic.interlaced_frame = !!c->interlaced;
500
501     *data_size = sizeof(AVFrame);
502     *(AVFrame*)data = c->pic;
503
504     /* always report that the buffer was completely consumed */
505     return buf_size;
506 }
507
508 static av_cold int decode_init(AVCodecContext *avctx)
509 {
510     UtvideoContext * const c = avctx->priv_data;
511
512     c->avctx = avctx;
513
514     ff_dsputil_init(&c->dsp, avctx);
515
516     if (avctx->extradata_size < 16) {
517         av_log(avctx, AV_LOG_ERROR,
518                "Insufficient extradata size %d, should be at least 16\n",
519                avctx->extradata_size);
520         return AVERROR_INVALIDDATA;
521     }
522
523     av_log(avctx, AV_LOG_DEBUG, "Encoder version %d.%d.%d.%d\n",
524            avctx->extradata[3], avctx->extradata[2],
525            avctx->extradata[1], avctx->extradata[0]);
526     av_log(avctx, AV_LOG_DEBUG, "Original format %X\n",
527            AV_RB32(avctx->extradata + 4));
528     c->frame_info_size = AV_RL32(avctx->extradata + 8);
529     c->flags           = AV_RL32(avctx->extradata + 12);
530
531     if (c->frame_info_size != 4)
532         av_log_ask_for_sample(avctx, "Frame info is not 4 bytes\n");
533     av_log(avctx, AV_LOG_DEBUG, "Encoding parameters %08X\n", c->flags);
534     c->slices      = (c->flags >> 24) + 1;
535     c->compression = c->flags & 1;
536     c->interlaced  = c->flags & 0x800;
537
538     c->slice_bits_size = 0;
539
540     switch (avctx->codec_tag) {
541     case MKTAG('U', 'L', 'R', 'G'):
542         c->planes      = 3;
543         avctx->pix_fmt = PIX_FMT_RGB24;
544         break;
545     case MKTAG('U', 'L', 'R', 'A'):
546         c->planes      = 4;
547         avctx->pix_fmt = PIX_FMT_RGBA;
548         break;
549     case MKTAG('U', 'L', 'Y', '0'):
550         c->planes      = 3;
551         avctx->pix_fmt = PIX_FMT_YUV420P;
552         break;
553     case MKTAG('U', 'L', 'Y', '2'):
554         c->planes      = 3;
555         avctx->pix_fmt = PIX_FMT_YUV422P;
556         break;
557     default:
558         av_log(avctx, AV_LOG_ERROR, "Unknown Ut Video FOURCC provided (%08X)\n",
559                avctx->codec_tag);
560         return AVERROR_INVALIDDATA;
561     }
562
563     return 0;
564 }
565
566 static av_cold int decode_end(AVCodecContext *avctx)
567 {
568     UtvideoContext * const c = avctx->priv_data;
569
570     if (c->pic.data[0])
571         ff_thread_release_buffer(avctx, &c->pic);
572
573     av_freep(&c->slice_bits);
574
575     return 0;
576 }
577
578 AVCodec ff_utvideo_decoder = {
579     .name           = "utvideo",
580     .type           = AVMEDIA_TYPE_VIDEO,
581     .id             = CODEC_ID_UTVIDEO,
582     .priv_data_size = sizeof(UtvideoContext),
583     .init           = decode_init,
584     .close          = decode_end,
585     .decode         = decode_frame,
586     .capabilities   = CODEC_CAP_DR1 | CODEC_CAP_FRAME_THREADS,
587     .long_name      = NULL_IF_CONFIG_SMALL("Ut Video"),
588 };