a368e6b47072fb3a7321c20b6f1098f5b7326223
[ffmpeg.git] / libavcodec / rl2.c
1 /*
2  * RL2 Video Decoder
3  * Copyright (C) 2008 Sascha Sommer (saschasommer@freenet.de)
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  * 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 #include "internal.h"
38
39
40 #define EXTRADATA1_SIZE (6 + 256 * 3) ///< video base, clr count, palette
41
42 typedef struct Rl2Context {
43     AVCodecContext *avctx;
44     AVFrame frame;
45
46     uint16_t video_base;  ///< initial drawing offset
47     uint32_t clr_count;   ///< number of used colors (currently unused)
48     uint8_t *back_frame;  ///< background frame
49     uint32_t palette[AVPALETTE_COUNT];
50 } Rl2Context;
51
52 /**
53  * Run Length Decode a single 320x200 frame
54  * @param s rl2 context
55  * @param in input buffer
56  * @param size input buffer size
57  * @param out ouput buffer
58  * @param stride stride of the output buffer
59  * @param video_base offset of the rle data inside the frame
60  */
61 static void rl2_rle_decode(Rl2Context *s, const uint8_t *in, int size,
62                                uint8_t *out, int stride, int video_base)
63 {
64     int base_x = video_base % s->avctx->width;
65     int base_y = video_base / s->avctx->width;
66     int stride_adj = stride - s->avctx->width;
67     int i;
68     const uint8_t *back_frame = s->back_frame;
69     const uint8_t *in_end = in + size;
70     const uint8_t *out_end = out + stride * s->avctx->height;
71     uint8_t *line_end;
72
73     /** copy start of the background frame */
74     for(i=0;i<=base_y;i++){
75         if(s->back_frame)
76             memcpy(out,back_frame,s->avctx->width);
77         out += stride;
78         back_frame += s->avctx->width;
79     }
80     back_frame += base_x - s->avctx->width;
81     line_end = out - stride_adj;
82     out += base_x - stride;
83
84     /** decode the variable part of the frame */
85     while(in < in_end){
86         uint8_t val = *in++;
87         int len = 1;
88         if(val >= 0x80){
89             if(in >= in_end)
90                 break;
91             len = *in++;
92             if(!len)
93                 break;
94         }
95
96         if(len >= out_end - out)
97             break;
98
99         if(s->back_frame)
100             val |= 0x80;
101         else
102             val &= ~0x80;
103
104         while(len--){
105             *out++ = (val == 0x80)? *back_frame:val;
106             back_frame++;
107             if(out == line_end){
108                  out += stride_adj;
109                  line_end += stride;
110                  if(len >= out_end - out)
111                      break;
112             }
113         }
114     }
115
116     /** copy the rest from the background frame */
117     if(s->back_frame){
118         while(out < out_end){
119             memcpy(out, back_frame, line_end - out);
120             back_frame += line_end - out;
121             out = line_end + stride_adj;
122             line_end += stride;
123         }
124     }
125 }
126
127
128 /**
129  * Initialize the decoder
130  * @param avctx decoder context
131  * @return 0 success, -1 on error
132  */
133 static av_cold int rl2_decode_init(AVCodecContext *avctx)
134 {
135     Rl2Context *s = avctx->priv_data;
136     int back_size;
137     int i;
138     s->avctx = avctx;
139     avctx->pix_fmt = AV_PIX_FMT_PAL8;
140
141     /** parse extra data */
142     if(!avctx->extradata || avctx->extradata_size < EXTRADATA1_SIZE){
143         av_log(avctx, AV_LOG_ERROR, "invalid extradata size\n");
144         return AVERROR(EINVAL);
145     }
146
147     /** get frame_offset */
148     s->video_base = AV_RL16(&avctx->extradata[0]);
149     s->clr_count = AV_RL32(&avctx->extradata[2]);
150
151     if(s->video_base >= avctx->width * avctx->height){
152         av_log(avctx, AV_LOG_ERROR, "invalid video_base\n");
153         return AVERROR_INVALIDDATA;
154     }
155
156     /** initialize palette */
157     for(i=0;i<AVPALETTE_COUNT;i++)
158         s->palette[i] = AV_RB24(&avctx->extradata[6 + i * 3]);
159
160     /** decode background frame if present */
161     back_size = avctx->extradata_size - EXTRADATA1_SIZE;
162
163     if(back_size > 0){
164         uint8_t *back_frame = av_mallocz(avctx->width*avctx->height);
165         if(!back_frame)
166             return AVERROR(ENOMEM);
167         rl2_rle_decode(s,avctx->extradata + EXTRADATA1_SIZE,back_size,
168                            back_frame,avctx->width,0);
169         s->back_frame = back_frame;
170     }
171     return 0;
172 }
173
174
175 static int rl2_decode_frame(AVCodecContext *avctx,
176                               void *data, int *got_frame,
177                               AVPacket *avpkt)
178 {
179     const uint8_t *buf = avpkt->data;
180     int ret, buf_size = avpkt->size;
181     Rl2Context *s = avctx->priv_data;
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 = ff_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     *got_frame = 1;
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 };