FFmpeg coverage


Directory: ../../../ffmpeg/
File: src/libavcodec/cdgraphics.c
Date: 2025-04-25 22:50:00
Exec Total Coverage
Lines: 100 189 52.9%
Functions: 6 11 54.5%
Branches: 48 105 45.7%

Line Branch Exec Source
1 /*
2 * CD Graphics Video Decoder
3 * Copyright (c) 2009 Michael Tison
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 #include "avcodec.h"
23 #include "bytestream.h"
24 #include "codec_internal.h"
25 #include "decode.h"
26
27 /**
28 * @file
29 * @brief CD Graphics Video Decoder
30 * @author Michael Tison
31 * @see http://wiki.multimedia.cx/index.php?title=CD_Graphics
32 * @see http://www.ccs.neu.edu/home/bchafy/cdb/info/cdg
33 */
34
35 /// default screen sizes
36 #define CDG_FULL_WIDTH 300
37 #define CDG_FULL_HEIGHT 216
38 #define CDG_DISPLAY_WIDTH 294
39 #define CDG_DISPLAY_HEIGHT 204
40 #define CDG_BORDER_WIDTH 6
41 #define CDG_BORDER_HEIGHT 12
42
43 /// masks
44 #define CDG_COMMAND 0x09
45 #define CDG_MASK 0x3F
46
47 /// instruction codes
48 #define CDG_INST_MEMORY_PRESET 1
49 #define CDG_INST_BORDER_PRESET 2
50 #define CDG_INST_TILE_BLOCK 6
51 #define CDG_INST_SCROLL_PRESET 20
52 #define CDG_INST_SCROLL_COPY 24
53 #define CDG_INST_TRANSPARENT_COL 28
54 #define CDG_INST_LOAD_PAL_LO 30
55 #define CDG_INST_LOAD_PAL_HIGH 31
56 #define CDG_INST_TILE_BLOCK_XOR 38
57
58 /// data sizes
59 #define CDG_PACKET_SIZE 24
60 #define CDG_DATA_SIZE 16
61 #define CDG_TILE_HEIGHT 12
62 #define CDG_TILE_WIDTH 6
63 #define CDG_MINIMUM_PKT_SIZE 6
64 #define CDG_MINIMUM_SCROLL_SIZE 3
65 #define CDG_HEADER_SIZE 8
66 #define CDG_PALETTE_SIZE 16
67
68 typedef struct CDGraphicsContext {
69 AVFrame *frame;
70 int hscroll;
71 int vscroll;
72 uint8_t alpha[CDG_PALETTE_SIZE];
73 int cleared;
74 } CDGraphicsContext;
75
76 2 static av_cold int cdg_decode_init(AVCodecContext *avctx)
77 {
78 2 CDGraphicsContext *cc = avctx->priv_data;
79
80 2 cc->frame = av_frame_alloc();
81
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 2 times.
2 if (!cc->frame)
82 return AVERROR(ENOMEM);
83
84
2/2
✓ Branch 0 taken 32 times.
✓ Branch 1 taken 2 times.
34 for (int i = 0; i < CDG_PALETTE_SIZE; i++)
85 32 cc->alpha[i] = 0xFFU;
86
87 2 avctx->pix_fmt = AV_PIX_FMT_PAL8;
88 2 return ff_set_dimensions(avctx, CDG_FULL_WIDTH, CDG_FULL_HEIGHT);
89 }
90
91 6 static void cdg_border_preset(CDGraphicsContext *cc, uint8_t *data)
92 {
93 6 ptrdiff_t lsize = cc->frame->linesize[0];
94 6 uint8_t *buf = cc->frame->data[0];
95 6 int color = data[0] & 0x0F;
96
97
1/2
✓ Branch 0 taken 6 times.
✗ Branch 1 not taken.
6 if (!(data[1] & 0x0F)) {
98 /// fill the top and bottom borders
99
2/2
✓ Branch 0 taken 72 times.
✓ Branch 1 taken 6 times.
78 for (int y = 0; y < CDG_BORDER_HEIGHT; y++)
100 72 memset(buf + y * lsize, color, cc->frame->width);
101
2/2
✓ Branch 0 taken 72 times.
✓ Branch 1 taken 6 times.
78 for (int y = CDG_FULL_HEIGHT-CDG_BORDER_HEIGHT; y < CDG_FULL_HEIGHT; y++)
102 72 memset(buf + y * lsize, color, cc->frame->width);
103
104 /// fill the side borders
105
2/2
✓ Branch 0 taken 1152 times.
✓ Branch 1 taken 6 times.
1158 for (int y = CDG_BORDER_HEIGHT; y < CDG_FULL_HEIGHT - CDG_BORDER_HEIGHT; y++) {
106 1152 memset(buf + y * lsize, color, CDG_BORDER_WIDTH);
107 1152 memset(buf + CDG_FULL_WIDTH - CDG_BORDER_WIDTH + y * lsize,
108 color, CDG_BORDER_WIDTH);
109 }
110 }
111 6 }
112
113 10 static void cdg_load_palette(CDGraphicsContext *cc, uint8_t *data, int low)
114 {
115 uint8_t r, g, b;
116 uint16_t color;
117 int i;
118
2/2
✓ Branch 0 taken 5 times.
✓ Branch 1 taken 5 times.
10 int array_offset = low ? 0 : 8;
119 10 uint32_t *palette = (uint32_t *) cc->frame->data[1];
120
121
2/2
✓ Branch 0 taken 80 times.
✓ Branch 1 taken 10 times.
90 for (i = 0; i < 8; i++) {
122 80 color = (data[2 * i] << 6) + (data[2 * i + 1] & 0x3F);
123 80 r = ((color >> 8) & 0x000F) * 17;
124 80 g = ((color >> 4) & 0x000F) * 17;
125 80 b = ((color ) & 0x000F) * 17;
126 80 palette[i + array_offset] = (uint32_t)cc->alpha[i + array_offset] << 24 | r << 16 | g << 8 | b;
127 }
128 10 }
129
130 189 static int cdg_tile_block(CDGraphicsContext *cc, uint8_t *data, int b)
131 {
132 unsigned ci, ri;
133 int color;
134 int x, y;
135 int ai;
136 189 ptrdiff_t stride = cc->frame->linesize[0];
137 189 uint8_t *buf = cc->frame->data[0];
138
139 189 ri = (data[2] & 0x1F) * CDG_TILE_HEIGHT + cc->vscroll;
140 189 ci = (data[3] & 0x3F) * CDG_TILE_WIDTH + cc->hscroll;
141
142
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 189 times.
189 if (ri > (CDG_FULL_HEIGHT - CDG_TILE_HEIGHT))
143 return AVERROR(EINVAL);
144
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 189 times.
189 if (ci > (CDG_FULL_WIDTH - CDG_TILE_WIDTH))
145 return AVERROR(EINVAL);
146
147
2/2
✓ Branch 0 taken 2268 times.
✓ Branch 1 taken 189 times.
2457 for (y = 0; y < CDG_TILE_HEIGHT; y++) {
148
2/2
✓ Branch 0 taken 13608 times.
✓ Branch 1 taken 2268 times.
15876 for (x = 0; x < CDG_TILE_WIDTH; x++) {
149
2/2
✓ Branch 0 taken 10669 times.
✓ Branch 1 taken 2939 times.
13608 if (!((data[4 + y] >> (5 - x)) & 0x01))
150 10669 color = data[0] & 0x0F;
151 else
152 2939 color = data[1] & 0x0F;
153
154 13608 ai = ci + x + (stride * (ri + y));
155
1/2
✓ Branch 0 taken 13608 times.
✗ Branch 1 not taken.
13608 if (b)
156 13608 color ^= buf[ai];
157 13608 buf[ai] = color;
158 }
159 }
160
161 189 return 0;
162 }
163
164 #define UP 2
165 #define DOWN 1
166 #define LEFT 2
167 #define RIGHT 1
168
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)
172 {
173 int y;
174
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);
179 }
180
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)
183 {
184 int y;
185
186 for (y = tl_y; y < tl_y + h; y++)
187 memset(out + tl_x + y * stride, color, w);
188 }
189
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)
193 {
194 if (roll) {
195 cdg_copy_rect_buf(out_tl_x, out_tl_y, out, in_tl_x, in_tl_y,
196 in, w, h, stride);
197 } else {
198 cdg_fill_rect_preset(out_tl_x, out_tl_y, out, color, w, h, stride);
199 }
200 }
201
202 static void cdg_scroll(CDGraphicsContext *cc, uint8_t *data,
203 AVFrame *new_frame, int roll_over)
204 {
205 int color;
206 int hscmd, h_off, hinc, vscmd, v_off, vinc;
207 int y;
208 ptrdiff_t stride = cc->frame->linesize[0];
209 uint8_t *in = cc->frame->data[0];
210 uint8_t *out = new_frame->data[0];
211
212 color = data[0] & 0x0F;
213 hscmd = (data[1] & 0x30) >> 4;
214 vscmd = (data[2] & 0x30) >> 4;
215
216 h_off = FFMIN(data[1] & 0x07, CDG_BORDER_WIDTH - 1);
217 v_off = FFMIN(data[2] & 0x0F, CDG_BORDER_HEIGHT - 1);
218
219 /// find the difference and save the offset for cdg_tile_block usage
220 hinc = h_off - cc->hscroll;
221 vinc = cc->vscroll - v_off;
222 cc->hscroll = h_off;
223 cc->vscroll = v_off;
224
225 if (vscmd == UP)
226 vinc -= 12;
227 if (vscmd == DOWN)
228 vinc += 12;
229 if (hscmd == LEFT)
230 hinc -= 6;
231 if (hscmd == RIGHT)
232 hinc += 6;
233
234 if (!hinc && !vinc)
235 return;
236
237 memcpy(new_frame->data[1], cc->frame->data[1], CDG_PALETTE_SIZE * 4);
238
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 FFABS(stride) - FFABS(hinc));
243
244 if (vinc > 0)
245 cdg_fill_wrapper(0, 0, out,
246 0, CDG_FULL_HEIGHT - vinc, in, color,
247 FFABS(stride), vinc, stride, roll_over);
248 else if (vinc < 0)
249 cdg_fill_wrapper(0, CDG_FULL_HEIGHT + vinc, out,
250 0, 0, in, color,
251 FFABS(stride), -1 * vinc, stride, roll_over);
252
253 if (hinc > 0)
254 cdg_fill_wrapper(0, 0, out,
255 CDG_FULL_WIDTH - hinc, 0, in, color,
256 hinc, CDG_FULL_HEIGHT, stride, roll_over);
257 else if (hinc < 0)
258 cdg_fill_wrapper(CDG_FULL_WIDTH + hinc, 0, out,
259 0, 0, in, color,
260 -1 * hinc, CDG_FULL_HEIGHT, stride, roll_over);
261
262 }
263
264 315 static int cdg_decode_frame(AVCodecContext *avctx, AVFrame *frame,
265 int *got_frame, AVPacket *avpkt)
266 {
267 GetByteContext gb;
268 315 int buf_size = avpkt->size;
269 int ret;
270 uint8_t command, inst;
271 315 uint8_t cdg_data[CDG_DATA_SIZE] = {0};
272 315 CDGraphicsContext *cc = avctx->priv_data;
273
274
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 315 times.
315 if (buf_size < CDG_MINIMUM_PKT_SIZE) {
275 av_log(avctx, AV_LOG_ERROR, "buffer too small for decoder\n");
276 return AVERROR(EINVAL);
277 }
278
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 315 times.
315 if (buf_size > CDG_HEADER_SIZE + CDG_DATA_SIZE) {
279 av_log(avctx, AV_LOG_ERROR, "buffer too big for decoder\n");
280 return AVERROR(EINVAL);
281 }
282
283 315 bytestream2_init(&gb, avpkt->data, avpkt->size);
284
285
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 315 times.
315 if ((ret = ff_reget_buffer(avctx, cc->frame, 0)) < 0)
286 return ret;
287
2/2
✓ Branch 0 taken 1 times.
✓ Branch 1 taken 314 times.
315 if (!cc->cleared) {
288
2/2
✓ Branch 0 taken 216 times.
✓ Branch 1 taken 1 times.
217 for (int y = 0; y < avctx->height; y++)
289 216 memset(cc->frame->data[0] + y * cc->frame->linesize[0], 0, avctx->width);
290 1 memset(cc->frame->data[1], 0, AVPALETTE_SIZE);
291 1 cc->cleared = 1;
292 }
293
294 315 command = bytestream2_get_byte(&gb);
295 315 inst = bytestream2_get_byte(&gb);
296 315 inst &= CDG_MASK;
297 315 bytestream2_skip(&gb, 2);
298 315 bytestream2_get_buffer(&gb, cdg_data, sizeof(cdg_data));
299
300
2/2
✓ Branch 0 taken 222 times.
✓ Branch 1 taken 93 times.
315 if ((command & CDG_MASK) == CDG_COMMAND) {
301
5/7
✓ Branch 0 taken 16 times.
✓ Branch 1 taken 10 times.
✓ Branch 2 taken 6 times.
✓ Branch 3 taken 189 times.
✗ Branch 4 not taken.
✓ Branch 5 taken 1 times.
✗ Branch 6 not taken.
222 switch (inst) {
302 16 case CDG_INST_MEMORY_PRESET:
303
2/2
✓ Branch 0 taken 1 times.
✓ Branch 1 taken 15 times.
16 if (!(cdg_data[1] & 0x0F)) {
304
2/2
✓ Branch 0 taken 216 times.
✓ Branch 1 taken 1 times.
217 for (int y = 0; y < avctx->height; y++)
305 216 memset(cc->frame->data[0] + y * cc->frame->linesize[0],
306 216 cdg_data[0] & 0x0F, avctx->width);
307 }
308 16 break;
309 10 case CDG_INST_LOAD_PAL_LO:
310 case CDG_INST_LOAD_PAL_HIGH:
311
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 10 times.
10 if (buf_size - CDG_HEADER_SIZE < CDG_DATA_SIZE) {
312 av_log(avctx, AV_LOG_ERROR, "buffer too small for loading palette\n");
313 return AVERROR(EINVAL);
314 }
315
316 10 cdg_load_palette(cc, cdg_data, inst == CDG_INST_LOAD_PAL_LO);
317 10 break;
318 6 case CDG_INST_BORDER_PRESET:
319 6 cdg_border_preset(cc, cdg_data);
320 6 break;
321 189 case CDG_INST_TILE_BLOCK_XOR:
322 case CDG_INST_TILE_BLOCK:
323
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 189 times.
189 if (buf_size - CDG_HEADER_SIZE < CDG_DATA_SIZE) {
324 av_log(avctx, AV_LOG_ERROR, "buffer too small for drawing tile\n");
325 return AVERROR(EINVAL);
326 }
327
328 189 ret = cdg_tile_block(cc, cdg_data, inst == CDG_INST_TILE_BLOCK_XOR);
329
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 189 times.
189 if (ret) {
330 av_log(avctx, AV_LOG_ERROR, "tile is out of range\n");
331 return ret;
332 }
333 189 break;
334 case CDG_INST_SCROLL_PRESET:
335 case CDG_INST_SCROLL_COPY:
336 if (buf_size - CDG_HEADER_SIZE < CDG_MINIMUM_SCROLL_SIZE) {
337 av_log(avctx, AV_LOG_ERROR, "buffer too small for scrolling\n");
338 return AVERROR(EINVAL);
339 }
340
341 if ((ret = ff_get_buffer(avctx, frame, AV_GET_BUFFER_FLAG_REF)) < 0)
342 return ret;
343
344 cdg_scroll(cc, cdg_data, frame, inst == CDG_INST_SCROLL_COPY);
345 ret = av_frame_replace(cc->frame, frame);
346 if (ret < 0)
347 return ret;
348 break;
349 1 case CDG_INST_TRANSPARENT_COL:
350
2/2
✓ Branch 0 taken 16 times.
✓ Branch 1 taken 1 times.
17 for (int i = 0; i < CDG_PALETTE_SIZE; i++)
351 16 cc->alpha[i] = 255 - ((cdg_data[i] & 0x3f) << 2);
352 1 break;
353 default:
354 break;
355 }
356
357
1/2
✓ Branch 0 taken 222 times.
✗ Branch 1 not taken.
222 if (!frame->data[0]) {
358 222 ret = av_frame_ref(frame, cc->frame);
359
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 222 times.
222 if (ret < 0)
360 return ret;
361 }
362 222 *got_frame = 1;
363 } else {
364 93 *got_frame = 0;
365 }
366
367 315 return avpkt->size;
368 }
369
370 static void cdg_decode_flush(AVCodecContext *avctx)
371 {
372 CDGraphicsContext *cc = avctx->priv_data;
373
374 if (!cc->frame->data[0])
375 return;
376
377 for (int y = 0; y < avctx->height; y++)
378 memset(cc->frame->data[0] + y * cc->frame->linesize[0], 0, avctx->width);
379 if (!avctx->frame_num)
380 memset(cc->frame->data[1], 0, AVPALETTE_SIZE);
381 }
382
383 2 static av_cold int cdg_decode_end(AVCodecContext *avctx)
384 {
385 2 CDGraphicsContext *cc = avctx->priv_data;
386
387 2 av_frame_free(&cc->frame);
388
389 2 return 0;
390 }
391
392 const FFCodec ff_cdgraphics_decoder = {
393 .p.name = "cdgraphics",
394 CODEC_LONG_NAME("CD Graphics video"),
395 .p.type = AVMEDIA_TYPE_VIDEO,
396 .p.id = AV_CODEC_ID_CDGRAPHICS,
397 .priv_data_size = sizeof(CDGraphicsContext),
398 .init = cdg_decode_init,
399 .close = cdg_decode_end,
400 FF_CODEC_DECODE_CB(cdg_decode_frame),
401 .flush = cdg_decode_flush,
402 .p.capabilities = AV_CODEC_CAP_DR1,
403 };
404