git.sesse.net Git - ffmpeg/blob - libavcodec/rl2.c

   1 /*
   2  * RL2 Video Decoder
   3  * Copyright (C) 2008 Sascha Sommer (saschasommer@freenet.de)
   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  * RL2 Video Decoder
  25  * @author Sascha Sommer (saschasommer@freenet.de)
  26  * @see http://wiki.multimedia.cx/index.php?title=RL2
  27  */
  28
  29 #include <stdio.h>
  30 #include <stdlib.h>
  31 #include <string.h>
  32
  33 #include "libavutil/internal.h"
  34 #include "libavutil/intreadwrite.h"
  35 #include "libavutil/mem.h"
  36 #include "avcodec.h"
  37
  38
  39 #define EXTRADATA1_SIZE (6 + 256 * 3) ///< video base, clr count, palette
  40
  41 typedef struct Rl2Context {
  42     AVCodecContext *avctx;
  43     AVFrame frame;
  44
  45     unsigned short video_base; ///< initial drawing offset
  46     unsigned int clr_count;    ///< number of used colors (currently unused)
  47     unsigned char* back_frame; ///< background frame
  48     unsigned int palette[AVPALETTE_COUNT];
  49 } Rl2Context;
  50
  51 /**
  52  * Run Length Decode a single 320x200 frame
  53  * @param s rl2 context
  54  * @param in input buffer
  55  * @param size input buffer size
  56  * @param out output buffer
  57  * @param stride stride of the output buffer
  58  * @param video_base offset of the rle data inside the frame
  59  */
  60 static void rl2_rle_decode(Rl2Context *s,const unsigned char* in,int size,
  61                                unsigned char* out,int stride,int video_base){
  62     int base_x = video_base % s->avctx->width;
  63     int base_y = video_base / s->avctx->width;
  64     int stride_adj = stride - s->avctx->width;
  65     int i;
  66     const unsigned char* back_frame = s->back_frame;
  67     const unsigned char* in_end = in + size;
  68     const unsigned char* out_end = out + stride * s->avctx->height;
  69     unsigned char* line_end;
  70
  71     /** copy start of the background frame */
  72     for(i=0;i<=base_y;i++){
  73         if(s->back_frame)
  74             memcpy(out,back_frame,s->avctx->width);
  75         out += stride;
  76         back_frame += s->avctx->width;
  77     }
  78     back_frame += base_x - s->avctx->width;
  79     line_end = out - stride_adj;
  80     out += base_x - stride;
  81
  82     /** decode the variable part of the frame */
  83     while(in < in_end){
  84         unsigned char val = *in++;
  85         int len = 1;
  86         if(val >= 0x80){
  87             if(in >= in_end)
  88                 break;
  89             len = *in++;
  90             if(!len)
  91                 break;
  92         }
  93
  94         if(len >= out_end - out)
  95             break;
  96
  97         if(s->back_frame)
  98             val |= 0x80;
  99         else
 100             val &= ~0x80;
 101
 102         while(len--){
 103             *out++ = (val == 0x80)? *back_frame:val;
 104             back_frame++;
 105             if(out == line_end){
 106                  out += stride_adj;
 107                  line_end += stride;
 108                  if(len >= out_end - out)
 109                      break;
 110             }
 111         }
 112     }
 113
 114     /** copy the rest from the background frame */
 115     if(s->back_frame){
 116         while(out < out_end){
 117             memcpy(out, back_frame, line_end - out);
 118             back_frame += line_end - out;
 119             out = line_end + stride_adj;
 120             line_end += stride;
 121         }
 122     }
 123 }
 124
 125
 126 /**
 127  * Initialize the decoder
 128  * @param avctx decoder context
 129  * @return 0 success, -1 on error
 130  */
 131 static av_cold int rl2_decode_init(AVCodecContext *avctx)
 132 {
 133     Rl2Context *s = avctx->priv_data;
 134     int back_size;
 135     int i;
 136     s->avctx = avctx;
 137     avctx->pix_fmt = AV_PIX_FMT_PAL8;
 138     avcodec_get_frame_defaults(&s->frame);
 139
 140     /** parse extra data */
 141     if(!avctx->extradata || avctx->extradata_size < EXTRADATA1_SIZE){
 142         av_log(avctx, AV_LOG_ERROR, "invalid extradata size\n");
 143         return AVERROR_INVALIDDATA;
 144     }
 145
 146     /** get frame_offset */
 147     s->video_base = AV_RL16(&avctx->extradata[0]);
 148     s->clr_count = AV_RL32(&avctx->extradata[2]);
 149
 150     if(s->video_base >= avctx->width * avctx->height){
 151         av_log(avctx, AV_LOG_ERROR, "invalid video_base\n");
 152         return AVERROR_INVALIDDATA;
 153     }
 154
 155     /** initialize palette */
 156     for(i=0;i<AVPALETTE_COUNT;i++)
 157         s->palette[i] = 0xFFU << 24 | AV_RB24(&avctx->extradata[6 + i * 3]);
 158
 159     /** decode background frame if present */
 160     back_size = avctx->extradata_size - EXTRADATA1_SIZE;
 161
 162     if(back_size > 0){
 163         unsigned char* back_frame = av_mallocz(avctx->width*avctx->height);
 164         if(!back_frame)
 165             return AVERROR(ENOMEM);
 166         rl2_rle_decode(s,avctx->extradata + EXTRADATA1_SIZE,back_size,
 167                            back_frame,avctx->width,0);
 168         s->back_frame = back_frame;
 169     }
 170     return 0;
 171 }
 172
 173
 174 static int rl2_decode_frame(AVCodecContext *avctx,
 175                               void *data, int *data_size,
 176                               AVPacket *avpkt)
 177 {
 178     const uint8_t *buf = avpkt->data;
 179     int buf_size = avpkt->size;
 180     Rl2Context *s = avctx->priv_data;
 181     int ret;
 182
 183     if(s->frame.data[0])
 184         avctx->release_buffer(avctx, &s->frame);
 185
 186     /** get buffer */
 187     s->frame.reference= 0;
 188     if ((ret = avctx->get_buffer(avctx, &s->frame)) < 0) {
 189         av_log(s->avctx, AV_LOG_ERROR, "get_buffer() failed\n");
 190         return ret;
 191     }
 192
 193     /** run length decode */
 194     rl2_rle_decode(s,buf,buf_size,s->frame.data[0],s->frame.linesize[0],s->video_base);
 195
 196     /** make the palette available on the way out */
 197     memcpy(s->frame.data[1], s->palette, AVPALETTE_SIZE);
 198
 199     *data_size = sizeof(AVFrame);
 200     *(AVFrame*)data = s->frame;
 201
 202     /** report that the buffer was completely consumed */
 203     return buf_size;
 204 }
 205
 206
 207 /**
 208  * Uninit decoder
 209  * @param avctx decoder context
 210  * @return 0 success, -1 on error
 211  */
 212 static av_cold int rl2_decode_end(AVCodecContext *avctx)
 213 {
 214     Rl2Context *s = avctx->priv_data;
 215
 216     if(s->frame.data[0])
 217         avctx->release_buffer(avctx, &s->frame);
 218
 219     av_free(s->back_frame);
 220
 221     return 0;
 222 }
 223
 224
 225 AVCodec ff_rl2_decoder = {
 226     .name           = "rl2",
 227     .type           = AVMEDIA_TYPE_VIDEO,
 228     .id             = AV_CODEC_ID_RL2,
 229     .priv_data_size = sizeof(Rl2Context),
 230     .init           = rl2_decode_init,
 231     .close          = rl2_decode_end,
 232     .decode         = rl2_decode_frame,
 233     .capabilities   = CODEC_CAP_DR1,
 234     .long_name      = NULL_IF_CONFIG_SMALL("RL2 video"),
 235 };