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