2 * IBM Ultimotion Video Decoder
3 * Copyright (C) 2004 Konstantin Shishkov
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
24 * IBM Ultimotion Video Decoder.
32 #include "bytestream.h"
36 typedef struct UltimotionDecodeContext {
37 AVCodecContext *avctx;
38 int width, height, blocks;
40 const uint8_t *ulti_codebook;
41 } UltimotionDecodeContext;
43 static av_cold int ulti_decode_init(AVCodecContext *avctx)
45 UltimotionDecodeContext *s = avctx->priv_data;
48 s->width = avctx->width;
49 s->height = avctx->height;
50 s->blocks = (s->width / 8) * (s->height / 8);
51 avctx->pix_fmt = PIX_FMT_YUV410P;
52 avctx->coded_frame = (AVFrame*) &s->frame;
53 s->ulti_codebook = ulti_codebook;
58 static av_cold int ulti_decode_end(AVCodecContext *avctx){
59 UltimotionDecodeContext *s = avctx->priv_data;
60 AVFrame *pic = &s->frame;
63 avctx->release_buffer(avctx, pic);
68 static const int block_coords[8] = // 4x4 block coords in 8x8 superblock
69 { 0, 0, 0, 4, 4, 4, 4, 0};
71 static const int angle_by_index[4] = { 0, 2, 6, 12};
73 /* Lookup tables for luma and chroma - used by ulti_convert_yuv() */
74 static const uint8_t ulti_lumas[64] =
75 { 0x10, 0x13, 0x17, 0x1A, 0x1E, 0x21, 0x25, 0x28,
76 0x2C, 0x2F, 0x33, 0x36, 0x3A, 0x3D, 0x41, 0x44,
77 0x48, 0x4B, 0x4F, 0x52, 0x56, 0x59, 0x5C, 0x60,
78 0x63, 0x67, 0x6A, 0x6E, 0x71, 0x75, 0x78, 0x7C,
79 0x7F, 0x83, 0x86, 0x8A, 0x8D, 0x91, 0x94, 0x98,
80 0x9B, 0x9F, 0xA2, 0xA5, 0xA9, 0xAC, 0xB0, 0xB3,
81 0xB7, 0xBA, 0xBE, 0xC1, 0xC5, 0xC8, 0xCC, 0xCF,
82 0xD3, 0xD6, 0xDA, 0xDD, 0xE1, 0xE4, 0xE8, 0xEB};
84 static const uint8_t ulti_chromas[16] =
85 { 0x60, 0x67, 0x6D, 0x73, 0x7A, 0x80, 0x86, 0x8D,
86 0x93, 0x99, 0xA0, 0xA6, 0xAC, 0xB3, 0xB9, 0xC0};
88 /* convert Ultimotion YUV block (sixteen 6-bit Y samples and
89 two 4-bit chroma samples) into standard YUV and put it into frame */
90 static void ulti_convert_yuv(AVFrame *frame, int x, int y,
91 uint8_t *luma,int chroma)
93 uint8_t *y_plane, *cr_plane, *cb_plane;
96 y_plane = frame->data[0] + x + y * frame->linesize[0];
97 cr_plane = frame->data[1] + (x / 4) + (y / 4) * frame->linesize[1];
98 cb_plane = frame->data[2] + (x / 4) + (y / 4) * frame->linesize[2];
100 cr_plane[0] = ulti_chromas[chroma >> 4];
102 cb_plane[0] = ulti_chromas[chroma & 0xF];
105 for(i = 0; i < 16; i++){
106 y_plane[i & 3] = ulti_lumas[luma[i]];
107 if((i & 3) == 3) { //next row
108 y_plane += frame->linesize[0];
113 /* generate block like in MS Video1 */
114 static void ulti_pattern(AVFrame *frame, int x, int y,
115 int f0, int f1, int Y0, int Y1, int chroma)
119 for(mask = 0x80, i = 0; mask; mask >>= 1, i++) {
126 for(mask = 0x80, i = 8; mask; mask >>= 1, i++) {
133 ulti_convert_yuv(frame, x, y, Luma, chroma);
136 /* fill block with some gradient */
137 static void ulti_grad(AVFrame *frame, int x, int y, uint8_t *Y, int chroma, int angle)
140 if(angle & 8) { //reverse order
152 Luma[0] = Y[0]; Luma[1] = Y[1]; Luma[2] = Y[2]; Luma[3] = Y[3];
153 Luma[4] = Y[0]; Luma[5] = Y[1]; Luma[6] = Y[2]; Luma[7] = Y[3];
154 Luma[8] = Y[0]; Luma[9] = Y[1]; Luma[10] = Y[2]; Luma[11] = Y[3];
155 Luma[12] = Y[0]; Luma[13] = Y[1]; Luma[14] = Y[2]; Luma[15] = Y[3];
158 Luma[0] = Y[1]; Luma[1] = Y[2]; Luma[2] = Y[3]; Luma[3] = Y[3];
159 Luma[4] = Y[0]; Luma[5] = Y[1]; Luma[6] = Y[2]; Luma[7] = Y[3];
160 Luma[8] = Y[0]; Luma[9] = Y[1]; Luma[10] = Y[2]; Luma[11] = Y[3];
161 Luma[12] = Y[0]; Luma[13] = Y[0]; Luma[14] = Y[1]; Luma[15] = Y[2];
164 Luma[0] = Y[1]; Luma[1] = Y[2]; Luma[2] = Y[3]; Luma[3] = Y[3];
165 Luma[4] = Y[1]; Luma[5] = Y[2]; Luma[6] = Y[2]; Luma[7] = Y[3];
166 Luma[8] = Y[0]; Luma[9] = Y[1]; Luma[10] = Y[1]; Luma[11] = Y[2];
167 Luma[12] = Y[0]; Luma[13] = Y[0]; Luma[14] = Y[1]; Luma[15] = Y[2];
170 Luma[0] = Y[2]; Luma[1] = Y[3]; Luma[2] = Y[3]; Luma[3] = Y[3];
171 Luma[4] = Y[1]; Luma[5] = Y[2]; Luma[6] = Y[2]; Luma[7] = Y[3];
172 Luma[8] = Y[0]; Luma[9] = Y[1]; Luma[10] = Y[1]; Luma[11] = Y[2];
173 Luma[12] = Y[0]; Luma[13] = Y[0]; Luma[14] = Y[0]; Luma[15] = Y[1];
176 Luma[0] = Y[3]; Luma[1] = Y[3]; Luma[2] = Y[3]; Luma[3] = Y[3];
177 Luma[4] = Y[2]; Luma[5] = Y[2]; Luma[6] = Y[2]; Luma[7] = Y[2];
178 Luma[8] = Y[1]; Luma[9] = Y[1]; Luma[10] = Y[1]; Luma[11] = Y[1];
179 Luma[12] = Y[0]; Luma[13] = Y[0]; Luma[14] = Y[0]; Luma[15] = Y[0];
182 Luma[0] = Y[3]; Luma[1] = Y[3]; Luma[2] = Y[3]; Luma[3] = Y[2];
183 Luma[4] = Y[3]; Luma[5] = Y[2]; Luma[6] = Y[2]; Luma[7] = Y[1];
184 Luma[8] = Y[2]; Luma[9] = Y[1]; Luma[10] = Y[1]; Luma[11] = Y[0];
185 Luma[12] = Y[1]; Luma[13] = Y[0]; Luma[14] = Y[0]; Luma[15] = Y[0];
188 Luma[0] = Y[3]; Luma[1] = Y[3]; Luma[2] = Y[2]; Luma[3] = Y[2];
189 Luma[4] = Y[3]; Luma[5] = Y[2]; Luma[6] = Y[1]; Luma[7] = Y[1];
190 Luma[8] = Y[2]; Luma[9] = Y[2]; Luma[10] = Y[1]; Luma[11] = Y[0];
191 Luma[12] = Y[1]; Luma[13] = Y[1]; Luma[14] = Y[0]; Luma[15] = Y[0];
194 Luma[0] = Y[3]; Luma[1] = Y[3]; Luma[2] = Y[2]; Luma[3] = Y[1];
195 Luma[4] = Y[3]; Luma[5] = Y[2]; Luma[6] = Y[1]; Luma[7] = Y[0];
196 Luma[8] = Y[3]; Luma[9] = Y[2]; Luma[10] = Y[1]; Luma[11] = Y[0];
197 Luma[12] = Y[2]; Luma[13] = Y[1]; Luma[14] = Y[0]; Luma[15] = Y[0];
200 Luma[0] = Y[0]; Luma[1] = Y[0]; Luma[2] = Y[1]; Luma[3] = Y[1];
201 Luma[4] = Y[0]; Luma[5] = Y[0]; Luma[6] = Y[1]; Luma[7] = Y[1];
202 Luma[8] = Y[2]; Luma[9] = Y[2]; Luma[10] = Y[3]; Luma[11] = Y[3];
203 Luma[12] = Y[2]; Luma[13] = Y[2]; Luma[14] = Y[3]; Luma[15] = Y[3];
207 ulti_convert_yuv(frame, x, y, Luma, chroma);
210 static int ulti_decode_frame(AVCodecContext *avctx,
211 void *data, int *data_size,
214 const uint8_t *buf = avpkt->data;
215 int buf_size = avpkt->size;
216 UltimotionDecodeContext *s=avctx->priv_data;
228 avctx->release_buffer(avctx, &s->frame);
230 s->frame.reference = 1;
231 s->frame.buffer_hints = FF_BUFFER_HINTS_VALID | FF_BUFFER_HINTS_PRESERVE | FF_BUFFER_HINTS_REUSABLE;
232 if(avctx->get_buffer(avctx, &s->frame) < 0) {
233 av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
239 if(blocks >= s->blocks || y >= s->height)
240 break;//all blocks decoded
243 if((idx & 0xF8) == 0x70) {
245 case 0x70: //change modifier
248 av_log(avctx, AV_LOG_INFO, "warning: modifier must be 0 or 1, got %i\n", modifier);
250 case 0x71: // set uniq flag
253 case 0x72: //toggle mode
256 case 0x73: //end-of-frame
259 case 0x74: //skip some blocks
261 if ((blocks + skip) >= s->blocks)
265 while(x >= s->width) {
271 av_log(avctx, AV_LOG_INFO, "warning: unknown escape 0x%02X\n", idx);
273 } else { //handle one block
277 uint8_t Y[4]; // luma samples of block
278 int tx = 0, ty = 0; //coords of subblock
289 for (i = 0; i < 4; i++) { // for every subblock
290 code = (idx >> (6 - i*2)) & 3; //extract 2 bits
291 if(!code) //skip subblock
295 tx = x + block_coords[i * 2];
296 ty = y + block_coords[(i * 2) + 1];
301 angle = angle_by_index[(tmp >> 6) & 0x3];
318 if (modifier) { // unpack four luma samples
319 tmp = bytestream_get_be24(&buf);
321 Y[0] = (tmp >> 18) & 0x3F;
322 Y[1] = (tmp >> 12) & 0x3F;
323 Y[2] = (tmp >> 6) & 0x3F;
326 } else { // retrieve luma samples from codebook
327 tmp = bytestream_get_be16(&buf);
329 angle = (tmp >> 12) & 0xF;
332 Y[0] = s->ulti_codebook[tmp];
333 Y[1] = s->ulti_codebook[tmp + 1];
334 Y[2] = s->ulti_codebook[tmp + 2];
335 Y[3] = s->ulti_codebook[tmp + 3];
340 if (modifier) { // all 16 luma samples
343 tmp = bytestream_get_be24(&buf);
344 Luma[0] = (tmp >> 18) & 0x3F;
345 Luma[1] = (tmp >> 12) & 0x3F;
346 Luma[2] = (tmp >> 6) & 0x3F;
347 Luma[3] = tmp & 0x3F;
349 tmp = bytestream_get_be24(&buf);
350 Luma[4] = (tmp >> 18) & 0x3F;
351 Luma[5] = (tmp >> 12) & 0x3F;
352 Luma[6] = (tmp >> 6) & 0x3F;
353 Luma[7] = tmp & 0x3F;
355 tmp = bytestream_get_be24(&buf);
356 Luma[8] = (tmp >> 18) & 0x3F;
357 Luma[9] = (tmp >> 12) & 0x3F;
358 Luma[10] = (tmp >> 6) & 0x3F;
359 Luma[11] = tmp & 0x3F;
361 tmp = bytestream_get_be24(&buf);
362 Luma[12] = (tmp >> 18) & 0x3F;
363 Luma[13] = (tmp >> 12) & 0x3F;
364 Luma[14] = (tmp >> 6) & 0x3F;
365 Luma[15] = tmp & 0x3F;
367 ulti_convert_yuv(&s->frame, tx, ty, Luma, chroma);
371 angle = (tmp >> 4) & 0x7;
372 tmp = (tmp << 8) + *buf++;
373 Y[0] = (tmp >> 6) & 0x3F;
375 Y[2] = (*buf++) & 0x3F;
376 Y[3] = (*buf++) & 0x3F;
377 ulti_grad(&s->frame, tx, ty, Y, chroma, angle); //draw block
378 } else { // some patterns
382 Y[0] = (*buf++) & 0x3F;
383 Y[1] = (*buf++) & 0x3F;
384 ulti_pattern(&s->frame, tx, ty, f1, f0, Y[0], Y[1], chroma);
390 ulti_grad(&s->frame, tx, ty, Y, chroma, angle); // draw block
401 *data_size=sizeof(AVFrame);
402 *(AVFrame*)data= s->frame;
407 AVCodec ulti_decoder = {
411 sizeof(UltimotionDecodeContext),
418 .long_name = NULL_IF_CONFIG_SMALL("IBM UltiMotion"),