2 * CD Graphics Video Decoder
3 * Copyright (c) 2009 Michael Tison
5 * This file is part of FFmpeg.
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.
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.
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
23 #include "bytestream.h"
28 * @brief CD Graphics Video Decoder
29 * @author Michael Tison
30 * @see http://wiki.multimedia.cx/index.php?title=CD_Graphics
31 * @see http://www.ccs.neu.edu/home/bchafy/cdb/info/cdg
34 /// default screen sizes
35 #define CDG_FULL_WIDTH 300
36 #define CDG_FULL_HEIGHT 216
37 #define CDG_DISPLAY_WIDTH 294
38 #define CDG_DISPLAY_HEIGHT 204
39 #define CDG_BORDER_WIDTH 6
40 #define CDG_BORDER_HEIGHT 12
43 #define CDG_COMMAND 0x09
47 #define CDG_INST_MEMORY_PRESET 1
48 #define CDG_INST_BORDER_PRESET 2
49 #define CDG_INST_TILE_BLOCK 6
50 #define CDG_INST_SCROLL_PRESET 20
51 #define CDG_INST_SCROLL_COPY 24
52 #define CDG_INST_TRANSPARENT_COL 28
53 #define CDG_INST_LOAD_PAL_LO 30
54 #define CDG_INST_LOAD_PAL_HIGH 31
55 #define CDG_INST_TILE_BLOCK_XOR 38
58 #define CDG_PACKET_SIZE 24
59 #define CDG_DATA_SIZE 16
60 #define CDG_TILE_HEIGHT 12
61 #define CDG_TILE_WIDTH 6
62 #define CDG_MINIMUM_PKT_SIZE 6
63 #define CDG_MINIMUM_SCROLL_SIZE 3
64 #define CDG_HEADER_SIZE 8
65 #define CDG_PALETTE_SIZE 16
67 typedef struct CDGraphicsContext {
75 static av_cold int cdg_decode_init(AVCodecContext *avctx)
77 CDGraphicsContext *cc = avctx->priv_data;
79 cc->frame = av_frame_alloc();
81 return AVERROR(ENOMEM);
82 cc->transparency = -1;
84 avctx->pix_fmt = AV_PIX_FMT_PAL8;
85 return ff_set_dimensions(avctx, CDG_FULL_WIDTH, CDG_FULL_HEIGHT);
88 static void cdg_border_preset(CDGraphicsContext *cc, uint8_t *data)
91 int lsize = cc->frame->linesize[0];
92 uint8_t *buf = cc->frame->data[0];
93 int color = data[0] & 0x0F;
95 if (!(data[1] & 0x0F)) {
96 /// fill the top and bottom borders
97 memset(buf, color, CDG_BORDER_HEIGHT * lsize);
98 memset(buf + (CDG_FULL_HEIGHT - CDG_BORDER_HEIGHT) * lsize,
99 color, CDG_BORDER_HEIGHT * lsize);
101 /// fill the side borders
102 for (y = CDG_BORDER_HEIGHT; y < CDG_FULL_HEIGHT - CDG_BORDER_HEIGHT; y++) {
103 memset(buf + y * lsize, color, CDG_BORDER_WIDTH);
104 memset(buf + CDG_FULL_WIDTH - CDG_BORDER_WIDTH + y * lsize,
105 color, CDG_BORDER_WIDTH);
110 static void cdg_load_palette(CDGraphicsContext *cc, uint8_t *data, int low)
115 int array_offset = low ? 0 : 8;
116 uint32_t *palette = (uint32_t *) cc->frame->data[1];
118 for (i = 0; i < 8; i++) {
119 color = (data[2 * i] << 6) + (data[2 * i + 1] & 0x3F);
120 r = ((color >> 8) & 0x000F) * 17;
121 g = ((color >> 4) & 0x000F) * 17;
122 b = ((color ) & 0x000F) * 17;
123 palette[i + array_offset] = 0xFFU << 24 | r << 16 | g << 8 | b;
124 if (cc->transparency >= 0)
125 palette[cc->transparency] &= 0xFFFFFF;
127 cc->frame->palette_has_changed = 1;
130 static int cdg_tile_block(CDGraphicsContext *cc, uint8_t *data, int b)
136 int stride = cc->frame->linesize[0];
137 uint8_t *buf = cc->frame->data[0];
139 ri = (data[2] & 0x1F) * CDG_TILE_HEIGHT + cc->vscroll;
140 ci = (data[3] & 0x3F) * CDG_TILE_WIDTH + cc->hscroll;
142 if (ri > (CDG_FULL_HEIGHT - CDG_TILE_HEIGHT))
143 return AVERROR(EINVAL);
144 if (ci > (CDG_FULL_WIDTH - CDG_TILE_WIDTH))
145 return AVERROR(EINVAL);
147 for (y = 0; y < CDG_TILE_HEIGHT; y++) {
148 for (x = 0; x < CDG_TILE_WIDTH; x++) {
149 if (!((data[4 + y] >> (5 - x)) & 0x01))
150 color = data[0] & 0x0F;
152 color = data[1] & 0x0F;
154 ai = ci + x + (stride * (ri + y));
169 static void cdg_copy_rect_buf(int out_tl_x, int out_tl_y, uint8_t *out,
170 int in_tl_x, int in_tl_y, uint8_t *in,
171 int w, int h, int stride)
175 in += in_tl_x + in_tl_y * stride;
176 out += out_tl_x + out_tl_y * stride;
177 for (y = 0; y < h; y++)
178 memcpy(out + y * stride, in + y * stride, w);
181 static void cdg_fill_rect_preset(int tl_x, int tl_y, uint8_t *out,
182 int color, int w, int h, int stride)
186 for (y = tl_y; y < tl_y + h; y++)
187 memset(out + tl_x + y * stride, color, w);
190 static void cdg_fill_wrapper(int out_tl_x, int out_tl_y, uint8_t *out,
191 int in_tl_x, int in_tl_y, uint8_t *in,
192 int color, int w, int h, int stride, int roll)
195 cdg_copy_rect_buf(out_tl_x, out_tl_y, out, in_tl_x, in_tl_y,
198 cdg_fill_rect_preset(out_tl_x, out_tl_y, out, color, w, h, stride);
202 static void cdg_scroll(CDGraphicsContext *cc, uint8_t *data,
203 AVFrame *new_frame, int roll_over)
206 int hscmd, h_off, hinc, vscmd, v_off, vinc;
208 int stride = cc->frame->linesize[0];
209 uint8_t *in = cc->frame->data[0];
210 uint8_t *out = new_frame->data[0];
212 color = data[0] & 0x0F;
213 hscmd = (data[1] & 0x30) >> 4;
214 vscmd = (data[2] & 0x30) >> 4;
216 h_off = FFMIN(data[1] & 0x07, CDG_BORDER_WIDTH - 1);
217 v_off = FFMIN(data[2] & 0x0F, CDG_BORDER_HEIGHT - 1);
219 /// find the difference and save the offset for cdg_tile_block usage
220 hinc = h_off - cc->hscroll;
221 vinc = v_off - cc->vscroll;
237 memcpy(new_frame->data[1], cc->frame->data[1], CDG_PALETTE_SIZE * 4);
239 for (y = FFMAX(0, vinc); y < FFMIN(CDG_FULL_HEIGHT + vinc, CDG_FULL_HEIGHT); y++)
240 memcpy(out + FFMAX(0, hinc) + stride * y,
241 in + FFMAX(0, hinc) - hinc + (y - vinc) * stride,
242 FFMIN(stride + hinc, stride));
245 cdg_fill_wrapper(0, 0, out,
246 0, CDG_FULL_HEIGHT - vinc, in, color,
247 stride, vinc, stride, roll_over);
249 cdg_fill_wrapper(0, CDG_FULL_HEIGHT + vinc, out,
251 stride, -1 * vinc, stride, roll_over);
254 cdg_fill_wrapper(0, 0, out,
255 CDG_FULL_WIDTH - hinc, 0, in, color,
256 hinc, CDG_FULL_HEIGHT, stride, roll_over);
258 cdg_fill_wrapper(CDG_FULL_WIDTH + hinc, 0, out,
260 -1 * hinc, CDG_FULL_HEIGHT, stride, roll_over);
264 static int cdg_decode_frame(AVCodecContext *avctx,
265 void *data, int *got_frame, AVPacket *avpkt)
268 int buf_size = avpkt->size;
270 uint8_t command, inst;
271 uint8_t cdg_data[CDG_DATA_SIZE] = {0};
272 AVFrame *frame = data;
273 CDGraphicsContext *cc = avctx->priv_data;
275 if (buf_size < CDG_MINIMUM_PKT_SIZE) {
276 av_log(avctx, AV_LOG_ERROR, "buffer too small for decoder\n");
277 return AVERROR(EINVAL);
279 if (buf_size > CDG_HEADER_SIZE + CDG_DATA_SIZE) {
280 av_log(avctx, AV_LOG_ERROR, "buffer too big for decoder\n");
281 return AVERROR(EINVAL);
284 bytestream2_init(&gb, avpkt->data, avpkt->size);
286 if ((ret = ff_reget_buffer(avctx, cc->frame, 0)) < 0)
289 memset(cc->frame->data[0], 0, cc->frame->linesize[0] * avctx->height);
290 memset(cc->frame->data[1], 0, AVPALETTE_SIZE);
294 command = bytestream2_get_byte(&gb);
295 inst = bytestream2_get_byte(&gb);
297 bytestream2_skip(&gb, 2);
298 bytestream2_get_buffer(&gb, cdg_data, sizeof(cdg_data));
300 if ((command & CDG_MASK) == CDG_COMMAND) {
302 case CDG_INST_MEMORY_PRESET:
303 if (!(cdg_data[1] & 0x0F))
304 memset(cc->frame->data[0], cdg_data[0] & 0x0F,
305 cc->frame->linesize[0] * CDG_FULL_HEIGHT);
307 case CDG_INST_LOAD_PAL_LO:
308 case CDG_INST_LOAD_PAL_HIGH:
309 if (buf_size - CDG_HEADER_SIZE < CDG_DATA_SIZE) {
310 av_log(avctx, AV_LOG_ERROR, "buffer too small for loading palette\n");
311 return AVERROR(EINVAL);
314 cdg_load_palette(cc, cdg_data, inst == CDG_INST_LOAD_PAL_LO);
316 case CDG_INST_BORDER_PRESET:
317 cdg_border_preset(cc, cdg_data);
319 case CDG_INST_TILE_BLOCK_XOR:
320 case CDG_INST_TILE_BLOCK:
321 if (buf_size - CDG_HEADER_SIZE < CDG_DATA_SIZE) {
322 av_log(avctx, AV_LOG_ERROR, "buffer too small for drawing tile\n");
323 return AVERROR(EINVAL);
326 ret = cdg_tile_block(cc, cdg_data, inst == CDG_INST_TILE_BLOCK_XOR);
328 av_log(avctx, AV_LOG_ERROR, "tile is out of range\n");
332 case CDG_INST_SCROLL_PRESET:
333 case CDG_INST_SCROLL_COPY:
334 if (buf_size - CDG_HEADER_SIZE < CDG_MINIMUM_SCROLL_SIZE) {
335 av_log(avctx, AV_LOG_ERROR, "buffer too small for scrolling\n");
336 return AVERROR(EINVAL);
339 if ((ret = ff_get_buffer(avctx, frame, AV_GET_BUFFER_FLAG_REF)) < 0)
342 cdg_scroll(cc, cdg_data, frame, inst == CDG_INST_SCROLL_COPY);
343 av_frame_unref(cc->frame);
344 ret = av_frame_ref(cc->frame, frame);
348 case CDG_INST_TRANSPARENT_COL:
349 cc->transparency = cdg_data[0] & 0xF;
355 if (!frame->data[0]) {
356 ret = av_frame_ref(frame, cc->frame);
368 static av_cold int cdg_decode_end(AVCodecContext *avctx)
370 CDGraphicsContext *cc = avctx->priv_data;
372 av_frame_free(&cc->frame);
377 AVCodec ff_cdgraphics_decoder = {
378 .name = "cdgraphics",
379 .long_name = NULL_IF_CONFIG_SMALL("CD Graphics video"),
380 .type = AVMEDIA_TYPE_VIDEO,
381 .id = AV_CODEC_ID_CDGRAPHICS,
382 .priv_data_size = sizeof(CDGraphicsContext),
383 .init = cdg_decode_init,
384 .close = cdg_decode_end,
385 .decode = cdg_decode_frame,
386 .capabilities = AV_CODEC_CAP_DR1,