Merge remote-tracking branch 'qatar/master'
[ffmpeg.git] / libavcodec / ulti.c
1 /*
2  * IBM Ultimotion Video Decoder
3  * Copyright (C) 2004 Konstantin Shishkov
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 /**
23  * @file
24  * IBM Ultimotion Video Decoder.
25  */
26
27 #include <stdio.h>
28 #include <stdlib.h>
29 #include <string.h>
30
31 #include "avcodec.h"
32 #include "bytestream.h"
33
34 #include "ulti_cb.h"
35
36 typedef struct UltimotionDecodeContext {
37     AVCodecContext *avctx;
38     int width, height, blocks;
39     AVFrame frame;
40     const uint8_t *ulti_codebook;
41     GetByteContext gb;
42 } UltimotionDecodeContext;
43
44 static av_cold int ulti_decode_init(AVCodecContext *avctx)
45 {
46     UltimotionDecodeContext *s = avctx->priv_data;
47
48     s->avctx = avctx;
49     s->width = avctx->width;
50     s->height = avctx->height;
51     s->blocks = (s->width / 8) * (s->height / 8);
52     avctx->pix_fmt = PIX_FMT_YUV410P;
53     avctx->coded_frame = &s->frame;
54     avctx->coded_frame = (AVFrame*) &s->frame;
55     s->ulti_codebook = ulti_codebook;
56
57     return 0;
58 }
59
60 static av_cold int ulti_decode_end(AVCodecContext *avctx){
61     UltimotionDecodeContext *s = avctx->priv_data;
62     AVFrame *pic = &s->frame;
63
64     if (pic->data[0])
65         avctx->release_buffer(avctx, pic);
66
67     return 0;
68 }
69
70 static const int block_coords[8] = // 4x4 block coords in 8x8 superblock
71     { 0, 0, 0, 4, 4, 4, 4, 0};
72
73 static const int angle_by_index[4] = { 0, 2, 6, 12};
74
75 /* Lookup tables for luma and chroma - used by ulti_convert_yuv() */
76 static const uint8_t ulti_lumas[64] =
77     { 0x10, 0x13, 0x17, 0x1A, 0x1E, 0x21, 0x25, 0x28,
78       0x2C, 0x2F, 0x33, 0x36, 0x3A, 0x3D, 0x41, 0x44,
79       0x48, 0x4B, 0x4F, 0x52, 0x56, 0x59, 0x5C, 0x60,
80       0x63, 0x67, 0x6A, 0x6E, 0x71, 0x75, 0x78, 0x7C,
81       0x7F, 0x83, 0x86, 0x8A, 0x8D, 0x91, 0x94, 0x98,
82       0x9B, 0x9F, 0xA2, 0xA5, 0xA9, 0xAC, 0xB0, 0xB3,
83       0xB7, 0xBA, 0xBE, 0xC1, 0xC5, 0xC8, 0xCC, 0xCF,
84       0xD3, 0xD6, 0xDA, 0xDD, 0xE1, 0xE4, 0xE8, 0xEB};
85
86 static const uint8_t ulti_chromas[16] =
87     { 0x60, 0x67, 0x6D, 0x73, 0x7A, 0x80, 0x86, 0x8D,
88       0x93, 0x99, 0xA0, 0xA6, 0xAC, 0xB3, 0xB9, 0xC0};
89
90 /* convert Ultimotion YUV block (sixteen 6-bit Y samples and
91  two 4-bit chroma samples) into standard YUV and put it into frame */
92 static void ulti_convert_yuv(AVFrame *frame, int x, int y,
93                              uint8_t *luma,int chroma)
94 {
95     uint8_t *y_plane, *cr_plane, *cb_plane;
96     int i;
97
98     y_plane = frame->data[0] + x + y * frame->linesize[0];
99     cr_plane = frame->data[1] + (x / 4) + (y / 4) * frame->linesize[1];
100     cb_plane = frame->data[2] + (x / 4) + (y / 4) * frame->linesize[2];
101
102     cr_plane[0] = ulti_chromas[chroma >> 4];
103
104     cb_plane[0] = ulti_chromas[chroma & 0xF];
105
106
107     for(i = 0; i < 16; i++){
108         y_plane[i & 3] = ulti_lumas[luma[i]];
109         if((i & 3) == 3) { //next row
110             y_plane += frame->linesize[0];
111         }
112     }
113 }
114
115 /* generate block like in MS Video1 */
116 static void ulti_pattern(AVFrame *frame, int x, int y,
117                          int f0, int f1, int Y0, int Y1, int chroma)
118 {
119     uint8_t Luma[16];
120     int mask, i;
121     for(mask = 0x80, i = 0; mask; mask >>= 1, i++) {
122         if(f0 & mask)
123             Luma[i] = Y1;
124         else
125             Luma[i] = Y0;
126     }
127
128     for(mask = 0x80, i = 8; mask; mask >>= 1, i++) {
129         if(f1 & mask)
130             Luma[i] = Y1;
131         else
132             Luma[i] = Y0;
133     }
134
135     ulti_convert_yuv(frame, x, y, Luma, chroma);
136 }
137
138 /* fill block with some gradient */
139 static void ulti_grad(AVFrame *frame, int x, int y, uint8_t *Y, int chroma, int angle)
140 {
141     uint8_t Luma[16];
142     if(angle & 8) { //reverse order
143         int t;
144         angle &= 0x7;
145         t = Y[0];
146         Y[0] = Y[3];
147         Y[3] = t;
148         t = Y[1];
149         Y[1] = Y[2];
150         Y[2] = t;
151     }
152     switch(angle){
153     case 0:
154         Luma[0]  = Y[0]; Luma[1]  = Y[1]; Luma[2]  = Y[2]; Luma[3]  = Y[3];
155         Luma[4]  = Y[0]; Luma[5]  = Y[1]; Luma[6]  = Y[2]; Luma[7]  = Y[3];
156         Luma[8]  = Y[0]; Luma[9]  = Y[1]; Luma[10] = Y[2]; Luma[11] = Y[3];
157         Luma[12] = Y[0]; Luma[13] = Y[1]; Luma[14] = Y[2]; Luma[15] = Y[3];
158         break;
159     case 1:
160         Luma[0]  = Y[1]; Luma[1]  = Y[2]; Luma[2]  = Y[3]; Luma[3]  = Y[3];
161         Luma[4]  = Y[0]; Luma[5]  = Y[1]; Luma[6]  = Y[2]; Luma[7]  = Y[3];
162         Luma[8]  = Y[0]; Luma[9]  = Y[1]; Luma[10] = Y[2]; Luma[11] = Y[3];
163         Luma[12] = Y[0]; Luma[13] = Y[0]; Luma[14] = Y[1]; Luma[15] = Y[2];
164         break;
165     case 2:
166         Luma[0]  = Y[1]; Luma[1]  = Y[2]; Luma[2]  = Y[3]; Luma[3]  = Y[3];
167         Luma[4]  = Y[1]; Luma[5]  = Y[2]; Luma[6]  = Y[2]; Luma[7]  = Y[3];
168         Luma[8]  = Y[0]; Luma[9]  = Y[1]; Luma[10] = Y[1]; Luma[11] = Y[2];
169         Luma[12] = Y[0]; Luma[13] = Y[0]; Luma[14] = Y[1]; Luma[15] = Y[2];
170         break;
171     case 3:
172         Luma[0]  = Y[2]; Luma[1]  = Y[3]; Luma[2]  = Y[3]; Luma[3]  = Y[3];
173         Luma[4]  = Y[1]; Luma[5]  = Y[2]; Luma[6]  = Y[2]; Luma[7]  = Y[3];
174         Luma[8]  = Y[0]; Luma[9]  = Y[1]; Luma[10] = Y[1]; Luma[11] = Y[2];
175         Luma[12] = Y[0]; Luma[13] = Y[0]; Luma[14] = Y[0]; Luma[15] = Y[1];
176         break;
177     case 4:
178         Luma[0]  = Y[3]; Luma[1]  = Y[3]; Luma[2]  = Y[3]; Luma[3]  = Y[3];
179         Luma[4]  = Y[2]; Luma[5]  = Y[2]; Luma[6]  = Y[2]; Luma[7]  = Y[2];
180         Luma[8]  = Y[1]; Luma[9]  = Y[1]; Luma[10] = Y[1]; Luma[11] = Y[1];
181         Luma[12] = Y[0]; Luma[13] = Y[0]; Luma[14] = Y[0]; Luma[15] = Y[0];
182         break;
183     case 5:
184         Luma[0]  = Y[3]; Luma[1]  = Y[3]; Luma[2]  = Y[3]; Luma[3]  = Y[2];
185         Luma[4]  = Y[3]; Luma[5]  = Y[2]; Luma[6]  = Y[2]; Luma[7]  = Y[1];
186         Luma[8]  = Y[2]; Luma[9]  = Y[1]; Luma[10] = Y[1]; Luma[11] = Y[0];
187         Luma[12] = Y[1]; Luma[13] = Y[0]; Luma[14] = Y[0]; Luma[15] = Y[0];
188         break;
189     case 6:
190         Luma[0]  = Y[3]; Luma[1]  = Y[3]; Luma[2]  = Y[2]; Luma[3]  = Y[2];
191         Luma[4]  = Y[3]; Luma[5]  = Y[2]; Luma[6]  = Y[1]; Luma[7]  = Y[1];
192         Luma[8]  = Y[2]; Luma[9]  = Y[2]; Luma[10] = Y[1]; Luma[11] = Y[0];
193         Luma[12] = Y[1]; Luma[13] = Y[1]; Luma[14] = Y[0]; Luma[15] = Y[0];
194         break;
195     case 7:
196         Luma[0]  = Y[3]; Luma[1]  = Y[3]; Luma[2]  = Y[2]; Luma[3]  = Y[1];
197         Luma[4]  = Y[3]; Luma[5]  = Y[2]; Luma[6]  = Y[1]; Luma[7]  = Y[0];
198         Luma[8]  = Y[3]; Luma[9]  = Y[2]; Luma[10] = Y[1]; Luma[11] = Y[0];
199         Luma[12] = Y[2]; Luma[13] = Y[1]; Luma[14] = Y[0]; Luma[15] = Y[0];
200         break;
201     default:
202         Luma[0]  = Y[0]; Luma[1]  = Y[0]; Luma[2]  = Y[1]; Luma[3]  = Y[1];
203         Luma[4]  = Y[0]; Luma[5]  = Y[0]; Luma[6]  = Y[1]; Luma[7]  = Y[1];
204         Luma[8]  = Y[2]; Luma[9]  = Y[2]; Luma[10] = Y[3]; Luma[11] = Y[3];
205         Luma[12] = Y[2]; Luma[13] = Y[2]; Luma[14] = Y[3]; Luma[15] = Y[3];
206         break;
207     }
208
209     ulti_convert_yuv(frame, x, y, Luma, chroma);
210 }
211
212 static int ulti_decode_frame(AVCodecContext *avctx,
213                              void *data, int *data_size,
214                              AVPacket *avpkt)
215 {
216     const uint8_t *buf = avpkt->data;
217     int buf_size = avpkt->size;
218     UltimotionDecodeContext *s=avctx->priv_data;
219     int modifier = 0;
220     int uniq = 0;
221     int mode = 0;
222     int blocks = 0;
223     int done = 0;
224     int x = 0, y = 0;
225     int i;
226     int skip;
227     int tmp;
228
229     s->frame.reference = 3;
230     s->frame.buffer_hints = FF_BUFFER_HINTS_VALID | FF_BUFFER_HINTS_PRESERVE | FF_BUFFER_HINTS_REUSABLE;
231     if (avctx->reget_buffer(avctx, &s->frame) < 0) {
232         av_log(avctx, AV_LOG_ERROR, "reget_buffer() failed\n");
233         return -1;
234     }
235
236     bytestream2_init(&s->gb, buf, buf_size);
237
238     while(!done) {
239         int idx;
240         if(blocks >= s->blocks || y >= s->height)
241             break;//all blocks decoded
242
243         if (bytestream2_get_bytes_left(&s->gb) < 1)
244             goto err;
245         idx = bytestream2_get_byteu(&s->gb);
246         if((idx & 0xF8) == 0x70) {
247             switch(idx) {
248             case 0x70: //change modifier
249                 modifier = bytestream2_get_byte(&s->gb);
250                 if(modifier>1)
251                     av_log(avctx, AV_LOG_INFO, "warning: modifier must be 0 or 1, got %i\n", modifier);
252                 break;
253             case 0x71: // set uniq flag
254                 uniq = 1;
255                 break;
256             case 0x72: //toggle mode
257                 mode = !mode;
258                 break;
259             case 0x73: //end-of-frame
260                 done = 1;
261                 break;
262             case 0x74: //skip some blocks
263                 skip = bytestream2_get_byte(&s->gb);
264                 if ((blocks + skip) >= s->blocks)
265                     break;
266                 blocks += skip;
267                 x += skip * 8;
268                 while(x >= s->width) {
269                     x -= s->width;
270                     y += 8;
271                 }
272                 break;
273             default:
274                 av_log(avctx, AV_LOG_INFO, "warning: unknown escape 0x%02X\n", idx);
275             }
276         } else { //handle one block
277             int code;
278             int cf;
279             int angle = 0;
280             uint8_t Y[4]; // luma samples of block
281             int tx = 0, ty = 0; //coords of subblock
282             int chroma = 0;
283             if (mode || uniq) {
284                 uniq = 0;
285                 cf = 1;
286                 chroma = 0;
287             } else {
288                 cf = 0;
289                 if (idx) {
290                     chroma = bytestream2_get_byte(&s->gb);
291                 }
292             }
293             for (i = 0; i < 4; i++) { // for every subblock
294                 code = (idx >> (6 - i*2)) & 3; //extract 2 bits
295                 if(!code) //skip subblock
296                     continue;
297                 if(cf) {
298                     chroma = bytestream2_get_byte(&s->gb);
299                 }
300                 tx = x + block_coords[i * 2];
301                 ty = y + block_coords[(i * 2) + 1];
302                 switch(code) {
303                 case 1:
304                     tmp = bytestream2_get_byte(&s->gb);
305
306                     angle = angle_by_index[(tmp >> 6) & 0x3];
307
308                     Y[0] = tmp & 0x3F;
309                     Y[1] = Y[0];
310
311                     if (angle) {
312                         Y[2] = Y[0]+1;
313                         if (Y[2] > 0x3F)
314                             Y[2] = 0x3F;
315                         Y[3] = Y[2];
316                     } else {
317                         Y[2] = Y[0];
318                         Y[3] = Y[0];
319                     }
320                     break;
321
322                 case 2:
323                     if (modifier) { // unpack four luma samples
324                         tmp = bytestream2_get_be24(&s->gb);
325
326                         Y[0] = (tmp >> 18) & 0x3F;
327                         Y[1] = (tmp >> 12) & 0x3F;
328                         Y[2] = (tmp >> 6) & 0x3F;
329                         Y[3] = tmp & 0x3F;
330                         angle = 16;
331                     } else { // retrieve luma samples from codebook
332                         tmp = bytestream2_get_be16(&s->gb);
333
334                         angle = (tmp >> 12) & 0xF;
335                         tmp &= 0xFFF;
336                         tmp <<= 2;
337                         Y[0] = s->ulti_codebook[tmp];
338                         Y[1] = s->ulti_codebook[tmp + 1];
339                         Y[2] = s->ulti_codebook[tmp + 2];
340                         Y[3] = s->ulti_codebook[tmp + 3];
341                     }
342                     break;
343
344                 case 3:
345                     if (modifier) { // all 16 luma samples
346                         uint8_t Luma[16];
347
348                         if (bytestream2_get_bytes_left(&s->gb) < 12)
349                             goto err;
350                         tmp = bytestream2_get_be24u(&s->gb);
351                         Luma[0] = (tmp >> 18) & 0x3F;
352                         Luma[1] = (tmp >> 12) & 0x3F;
353                         Luma[2] = (tmp >> 6) & 0x3F;
354                         Luma[3] = tmp & 0x3F;
355
356                         tmp = bytestream2_get_be24u(&s->gb);
357                         Luma[4] = (tmp >> 18) & 0x3F;
358                         Luma[5] = (tmp >> 12) & 0x3F;
359                         Luma[6] = (tmp >> 6) & 0x3F;
360                         Luma[7] = tmp & 0x3F;
361
362                         tmp = bytestream2_get_be24u(&s->gb);
363                         Luma[8] = (tmp >> 18) & 0x3F;
364                         Luma[9] = (tmp >> 12) & 0x3F;
365                         Luma[10] = (tmp >> 6) & 0x3F;
366                         Luma[11] = tmp & 0x3F;
367
368                         tmp = bytestream2_get_be24u(&s->gb);
369                         Luma[12] = (tmp >> 18) & 0x3F;
370                         Luma[13] = (tmp >> 12) & 0x3F;
371                         Luma[14] = (tmp >> 6) & 0x3F;
372                         Luma[15] = tmp & 0x3F;
373
374                         ulti_convert_yuv(&s->frame, tx, ty, Luma, chroma);
375                     } else {
376                         if (bytestream2_get_bytes_left(&s->gb) < 4)
377                             goto err;
378                         tmp = bytestream2_get_byteu(&s->gb);
379                         if(tmp & 0x80) {
380                             angle = (tmp >> 4) & 0x7;
381                             tmp = (tmp << 8) + bytestream2_get_byteu(&s->gb);
382                             Y[0] = (tmp >> 6) & 0x3F;
383                             Y[1] = tmp & 0x3F;
384                             Y[2] = bytestream2_get_byteu(&s->gb) & 0x3F;
385                             Y[3] = bytestream2_get_byteu(&s->gb) & 0x3F;
386                             ulti_grad(&s->frame, tx, ty, Y, chroma, angle); //draw block
387                         } else { // some patterns
388                             int f0, f1;
389                             f0 = bytestream2_get_byteu(&s->gb);
390                             f1 = tmp;
391                             Y[0] = bytestream2_get_byteu(&s->gb) & 0x3F;
392                             Y[1] = bytestream2_get_byteu(&s->gb) & 0x3F;
393                             ulti_pattern(&s->frame, tx, ty, f1, f0, Y[0], Y[1], chroma);
394                         }
395                     }
396                     break;
397                 }
398                 if(code != 3)
399                     ulti_grad(&s->frame, tx, ty, Y, chroma, angle); // draw block
400             }
401             blocks++;
402                 x += 8;
403             if(x >= s->width) {
404                 x = 0;
405                 y += 8;
406             }
407         }
408     }
409
410     *data_size=sizeof(AVFrame);
411     *(AVFrame*)data= s->frame;
412
413     return buf_size;
414
415 err:
416     av_log(avctx, AV_LOG_ERROR,
417            "Insufficient data\n");
418     return AVERROR_INVALIDDATA;
419 }
420
421 AVCodec ff_ulti_decoder = {
422     .name           = "ultimotion",
423     .type           = AVMEDIA_TYPE_VIDEO,
424     .id             = CODEC_ID_ULTI,
425     .priv_data_size = sizeof(UltimotionDecodeContext),
426     .init           = ulti_decode_init,
427     .close          = ulti_decode_end,
428     .decode         = ulti_decode_frame,
429     .capabilities   = CODEC_CAP_DR1,
430     .long_name = NULL_IF_CONFIG_SMALL("IBM UltiMotion"),
431 };