libavcodec/msvideo1.c
2fdf638b
 /*
  * Microsoft Video-1 Decoder
41ed7ab4
  * Copyright (C) 2003 The FFmpeg project
2fdf638b
  *
b78e7197
  * This file is part of FFmpeg.
  *
  * FFmpeg is free software; you can redistribute it and/or
2fdf638b
  * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
b78e7197
  * version 2.1 of the License, or (at your option) any later version.
2fdf638b
  *
b78e7197
  * FFmpeg is distributed in the hope that it will be useful,
2fdf638b
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
b78e7197
  * License along with FFmpeg; if not, write to the Free Software
5509bffa
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
2fdf638b
  */
 
 /**
ba87f080
  * @file
2fdf638b
  * Microsoft Video-1 Decoder by Mike Melanson (melanson@pcisys.net)
  * For more information about the MS Video-1 format, visit:
  *   http://www.pcisys.net/~melanson/codecs/
  */
 
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
 
1d9c2dc8
 #include "libavutil/internal.h"
6a5d31ac
 #include "libavutil/intreadwrite.h"
2fdf638b
 #include "avcodec.h"
759001c5
 #include "internal.h"
2fdf638b
 
 #define PALETTE_COUNT 256
 #define CHECK_STREAM_PTR(n) \
   if ((stream_ptr + n) > s->size ) { \
9b879566
     av_log(s->avctx, AV_LOG_ERROR, " MS Video-1 warning: stream_ptr out of bounds (%d >= %d)\n", \
2fdf638b
       stream_ptr + n, s->size); \
     return; \
   }
 
 typedef struct Msvideo1Context {
 
     AVCodecContext *avctx;
ef2a99c7
     AVFrame *frame;
2fdf638b
 
7993df65
     const unsigned char *buf;
2fdf638b
     int size;
 
     int mode_8bit;  /* if it's not 8-bit, it's 16-bit */
 
2d8591c2
     uint32_t pal[256];
2fdf638b
 } Msvideo1Context;
 
98a6fff9
 static av_cold int msvideo1_decode_init(AVCodecContext *avctx)
2fdf638b
 {
e4141433
     Msvideo1Context *s = avctx->priv_data;
2fdf638b
 
     s->avctx = avctx;
 
875efafa
     /* figure out the colorspace based on the presence of a palette */
2d8591c2
     if (s->avctx->bits_per_coded_sample == 8) {
2fdf638b
         s->mode_8bit = 1;
716d413c
         avctx->pix_fmt = AV_PIX_FMT_PAL8;
f3eef027
         if (avctx->extradata_size >= AVPALETTE_SIZE)
             memcpy(s->pal, avctx->extradata, AVPALETTE_SIZE);
2fdf638b
     } else {
         s->mode_8bit = 0;
716d413c
         avctx->pix_fmt = AV_PIX_FMT_RGB555;
2fdf638b
     }
 
ef2a99c7
     s->frame = av_frame_alloc();
     if (!s->frame)
         return AVERROR(ENOMEM);
2fdf638b
 
     return 0;
 }
 
 static void msvideo1_decode_8bit(Msvideo1Context *s)
 {
     int block_ptr, pixel_ptr;
     int total_blocks;
     int pixel_x, pixel_y;  /* pixel width and height iterators */
     int block_x, block_y;  /* block width and height iterators */
     int blocks_wide, blocks_high;  /* width and height in 4x4 blocks */
     int block_inc;
     int row_dec;
 
     /* decoding parameters */
     int stream_ptr;
     unsigned char byte_a, byte_b;
     unsigned short flags;
     int skip_blocks;
     unsigned char colors[8];
ef2a99c7
     unsigned char *pixels = s->frame->data[0];
     int stride = s->frame->linesize[0];
2fdf638b
 
     stream_ptr = 0;
     skip_blocks = 0;
     blocks_wide = s->avctx->width / 4;
     blocks_high = s->avctx->height / 4;
     total_blocks = blocks_wide * blocks_high;
     block_inc = 4;
     row_dec = stride + 4;
 
     for (block_y = blocks_high; block_y > 0; block_y--) {
         block_ptr = ((block_y * 4) - 1) * stride;
         for (block_x = blocks_wide; block_x > 0; block_x--) {
             /* check if this block should be skipped */
             if (skip_blocks) {
                 block_ptr += block_inc;
                 skip_blocks--;
                 total_blocks--;
                 continue;
             }
 
             pixel_ptr = block_ptr;
 
             /* get the next two bytes in the encoded data stream */
             CHECK_STREAM_PTR(2);
             byte_a = s->buf[stream_ptr++];
             byte_b = s->buf[stream_ptr++];
 
             /* check if the decode is finished */
             if ((byte_a == 0) && (byte_b == 0) && (total_blocks == 0))
                 return;
             else if ((byte_b & 0xFC) == 0x84) {
                 /* skip code, but don't count the current block */
                 skip_blocks = ((byte_b - 0x84) << 8) + byte_a - 1;
             } else if (byte_b < 0x80) {
                 /* 2-color encoding */
                 flags = (byte_b << 8) | byte_a;
 
                 CHECK_STREAM_PTR(2);
                 colors[0] = s->buf[stream_ptr++];
                 colors[1] = s->buf[stream_ptr++];
 
                 for (pixel_y = 0; pixel_y < 4; pixel_y++) {
                     for (pixel_x = 0; pixel_x < 4; pixel_x++, flags >>= 1)
                         pixels[pixel_ptr++] = colors[(flags & 0x1) ^ 1];
                     pixel_ptr -= row_dec;
                 }
             } else if (byte_b >= 0x90) {
                 /* 8-color encoding */
                 flags = (byte_b << 8) | byte_a;
 
                 CHECK_STREAM_PTR(8);
                 memcpy(colors, &s->buf[stream_ptr], 8);
                 stream_ptr += 8;
 
                 for (pixel_y = 0; pixel_y < 4; pixel_y++) {
                     for (pixel_x = 0; pixel_x < 4; pixel_x++, flags >>= 1)
115329f1
                         pixels[pixel_ptr++] =
                             colors[((pixel_y & 0x2) << 1) +
2fdf638b
                                 (pixel_x & 0x2) + ((flags & 0x1) ^ 1)];
                     pixel_ptr -= row_dec;
                 }
             } else {
                 /* 1-color encoding */
                 colors[0] = byte_a;
 
                 for (pixel_y = 0; pixel_y < 4; pixel_y++) {
                     for (pixel_x = 0; pixel_x < 4; pixel_x++)
                         pixels[pixel_ptr++] = colors[0];
                     pixel_ptr -= row_dec;
                 }
             }
 
             block_ptr += block_inc;
             total_blocks--;
         }
     }
 
     /* make the palette available on the way out */
716d413c
     if (s->avctx->pix_fmt == AV_PIX_FMT_PAL8)
ef2a99c7
         memcpy(s->frame->data[1], s->pal, AVPALETTE_SIZE);
2fdf638b
 }
 
 static void msvideo1_decode_16bit(Msvideo1Context *s)
 {
     int block_ptr, pixel_ptr;
     int total_blocks;
     int pixel_x, pixel_y;  /* pixel width and height iterators */
     int block_x, block_y;  /* block width and height iterators */
     int blocks_wide, blocks_high;  /* width and height in 4x4 blocks */
     int block_inc;
     int row_dec;
 
     /* decoding parameters */
     int stream_ptr;
     unsigned char byte_a, byte_b;
     unsigned short flags;
     int skip_blocks;
     unsigned short colors[8];
ef2a99c7
     unsigned short *pixels = (unsigned short *)s->frame->data[0];
     int stride = s->frame->linesize[0] / 2;
2fdf638b
 
     stream_ptr = 0;
     skip_blocks = 0;
     blocks_wide = s->avctx->width / 4;
     blocks_high = s->avctx->height / 4;
     total_blocks = blocks_wide * blocks_high;
     block_inc = 4;
     row_dec = stride + 4;
 
     for (block_y = blocks_high; block_y > 0; block_y--) {
         block_ptr = ((block_y * 4) - 1) * stride;
         for (block_x = blocks_wide; block_x > 0; block_x--) {
             /* check if this block should be skipped */
             if (skip_blocks) {
                 block_ptr += block_inc;
                 skip_blocks--;
                 total_blocks--;
                 continue;
             }
 
             pixel_ptr = block_ptr;
 
             /* get the next two bytes in the encoded data stream */
             CHECK_STREAM_PTR(2);
             byte_a = s->buf[stream_ptr++];
             byte_b = s->buf[stream_ptr++];
 
             /* check if the decode is finished */
             if ((byte_a == 0) && (byte_b == 0) && (total_blocks == 0)) {
                 return;
             } else if ((byte_b & 0xFC) == 0x84) {
                 /* skip code, but don't count the current block */
                 skip_blocks = ((byte_b - 0x84) << 8) + byte_a - 1;
             } else if (byte_b < 0x80) {
                 /* 2- or 8-color encoding modes */
                 flags = (byte_b << 8) | byte_a;
 
                 CHECK_STREAM_PTR(4);
fead30d4
                 colors[0] = AV_RL16(&s->buf[stream_ptr]);
2fdf638b
                 stream_ptr += 2;
fead30d4
                 colors[1] = AV_RL16(&s->buf[stream_ptr]);
2fdf638b
                 stream_ptr += 2;
 
                 if (colors[0] & 0x8000) {
                     /* 8-color encoding */
                     CHECK_STREAM_PTR(12);
fead30d4
                     colors[2] = AV_RL16(&s->buf[stream_ptr]);
2fdf638b
                     stream_ptr += 2;
fead30d4
                     colors[3] = AV_RL16(&s->buf[stream_ptr]);
2fdf638b
                     stream_ptr += 2;
fead30d4
                     colors[4] = AV_RL16(&s->buf[stream_ptr]);
2fdf638b
                     stream_ptr += 2;
fead30d4
                     colors[5] = AV_RL16(&s->buf[stream_ptr]);
2fdf638b
                     stream_ptr += 2;
fead30d4
                     colors[6] = AV_RL16(&s->buf[stream_ptr]);
2fdf638b
                     stream_ptr += 2;
fead30d4
                     colors[7] = AV_RL16(&s->buf[stream_ptr]);
2fdf638b
                     stream_ptr += 2;
 
                     for (pixel_y = 0; pixel_y < 4; pixel_y++) {
                         for (pixel_x = 0; pixel_x < 4; pixel_x++, flags >>= 1)
115329f1
                             pixels[pixel_ptr++] =
                                 colors[((pixel_y & 0x2) << 1) +
2fdf638b
                                     (pixel_x & 0x2) + ((flags & 0x1) ^ 1)];
                         pixel_ptr -= row_dec;
                     }
                 } else {
                     /* 2-color encoding */
                     for (pixel_y = 0; pixel_y < 4; pixel_y++) {
                         for (pixel_x = 0; pixel_x < 4; pixel_x++, flags >>= 1)
                             pixels[pixel_ptr++] = colors[(flags & 0x1) ^ 1];
                         pixel_ptr -= row_dec;
                     }
                 }
             } else {
                 /* otherwise, it's a 1-color block */
                 colors[0] = (byte_b << 8) | byte_a;
 
                 for (pixel_y = 0; pixel_y < 4; pixel_y++) {
                     for (pixel_x = 0; pixel_x < 4; pixel_x++)
                         pixels[pixel_ptr++] = colors[0];
                     pixel_ptr -= row_dec;
                 }
             }
 
             block_ptr += block_inc;
             total_blocks--;
         }
     }
 }
 
 static int msvideo1_decode_frame(AVCodecContext *avctx,
df9b9567
                                 void *data, int *got_frame,
7a00bbad
                                 AVPacket *avpkt)
2fdf638b
 {
7a00bbad
     const uint8_t *buf = avpkt->data;
     int buf_size = avpkt->size;
e4141433
     Msvideo1Context *s = avctx->priv_data;
759001c5
     int ret;
2fdf638b
 
     s->buf = buf;
     s->size = buf_size;
 
5219afc0
     if ((ret = ff_reget_buffer(avctx, s->frame)) < 0)
759001c5
         return ret;
2fdf638b
 
2d8591c2
     if (s->mode_8bit) {
         const uint8_t *pal = av_packet_get_side_data(avpkt, AV_PKT_DATA_PALETTE, NULL);
 
         if (pal) {
             memcpy(s->pal, pal, AVPALETTE_SIZE);
ef2a99c7
             s->frame->palette_has_changed = 1;
2d8591c2
         }
     }
 
2fdf638b
     if (s->mode_8bit)
         msvideo1_decode_8bit(s);
     else
         msvideo1_decode_16bit(s);
 
ef2a99c7
     if ((ret = av_frame_ref(data, s->frame)) < 0)
759001c5
         return ret;
 
df9b9567
     *got_frame      = 1;
2fdf638b
 
     /* report that the buffer was completely consumed */
     return buf_size;
 }
 
98a6fff9
 static av_cold int msvideo1_decode_end(AVCodecContext *avctx)
2fdf638b
 {
e4141433
     Msvideo1Context *s = avctx->priv_data;
2fdf638b
 
ef2a99c7
     av_frame_free(&s->frame);
2fdf638b
 
     return 0;
 }
 
e7e2df27
 AVCodec ff_msvideo1_decoder = {
ec6402b7
     .name           = "msvideo1",
b2bed932
     .long_name      = NULL_IF_CONFIG_SMALL("Microsoft Video 1"),
ec6402b7
     .type           = AVMEDIA_TYPE_VIDEO,
36ef5369
     .id             = AV_CODEC_ID_MSVIDEO1,
ec6402b7
     .priv_data_size = sizeof(Msvideo1Context),
     .init           = msvideo1_decode_init,
     .close          = msvideo1_decode_end,
     .decode         = msvideo1_decode_frame,
def97856
     .capabilities   = AV_CODEC_CAP_DR1,
2fdf638b
 };