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