2 * Copyright (c) 2021 Paul B Mahol
4 * This file is part of FFmpeg.
6 * FFmpeg is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * FFmpeg is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with FFmpeg; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 #include "libavutil/avassert.h"
22 #include "libavutil/common.h"
25 #include "bytestream.h"
28 #define PALDATA_FOLLOWS_TILEDATA 4
29 #define HAVE_COMPRESSED_TILEMAP 32
30 #define HAVE_TILEMAP 128
32 typedef struct SGAVideoContext {
39 int tilemapdata_offset;
42 int palmapdata_offset;
54 uint8_t *tileindex_data;
55 unsigned tileindex_size;
56 uint8_t *palmapindex_data;
57 unsigned palmapindex_size;
58 uint8_t uncompressed[65536];
61 static av_cold int sga_decode_init(AVCodecContext *avctx)
63 avctx->pix_fmt = AV_PIX_FMT_PAL8;
67 static int decode_palette(GetByteContext *gb, uint32_t *pal)
71 if (bytestream2_get_bytes_left(gb) < 18)
72 return AVERROR_INVALIDDATA;
74 memset(pal, 0, 16 * sizeof(*pal));
75 init_get_bits8(&gbit, gb->buffer, 18);
77 for (int RGBIndex = 0; RGBIndex < 3; RGBIndex++) {
78 for (int index = 0; index < 16; index++) {
79 unsigned color = get_bits1(&gbit) << RGBIndex;
80 pal[15 - index] |= color << (5 + 16);
84 for (int RGBIndex = 0; RGBIndex < 3; RGBIndex++) {
85 for (int index = 0; index < 16; index++) {
86 unsigned color = get_bits1(&gbit) << RGBIndex;
87 pal[15 - index] |= color << (5 + 8);
91 for (int RGBIndex = 0; RGBIndex < 3; RGBIndex++) {
92 for (int index = 0; index < 16; index++) {
93 unsigned color = get_bits1(&gbit) << RGBIndex;
94 pal[15 - index] |= color << (5 + 0);
98 for (int index = 0; index < 16; index++)
99 pal[index] = (0xFFU << 24) | pal[index] | (pal[index] >> 3);
101 bytestream2_skip(gb, 18);
106 static int decode_index_palmap(SGAVideoContext *s, AVFrame *frame)
108 const uint8_t *tt = s->tileindex_data;
110 for (int y = 0; y < s->tiles_h; y++) {
111 for (int x = 0; x < s->tiles_w; x++) {
112 int pal_idx = s->palmapindex_data[y * s->tiles_w + x] * 16;
113 uint8_t *dst = frame->data[0] + y * 8 * frame->linesize[0] + x * 8;
115 for (int yy = 0; yy < 8; yy++) {
116 for (int xx = 0; xx < 8; xx++)
117 dst[xx] = pal_idx + tt[xx];
120 dst += frame->linesize[0];
128 static int decode_index_tilemap(SGAVideoContext *s, AVFrame *frame)
130 GetByteContext *gb = &s->gb;
133 bytestream2_seek(gb, s->tilemapdata_offset, SEEK_SET);
134 if (bytestream2_get_bytes_left(gb) < s->tilemapdata_size)
135 return AVERROR_INVALIDDATA;
137 init_get_bits8(&pm, gb->buffer, s->tilemapdata_size);
139 for (int y = 0; y < s->tiles_h; y++) {
140 for (int x = 0; x < s->tiles_w; x++) {
142 int tilemap = get_bits(&pm, 16);
143 int flip_x = (tilemap >> 11) & 1;
144 int flip_y = (tilemap >> 12) & 1;
145 int tindex = av_clip((tilemap & 511) - 1, 0, s->nb_tiles - 1);
146 const uint8_t *tt = s->tileindex_data + tindex * 64;
147 int pal_idx = ((tilemap >> 13) & 3) * 16;
148 uint8_t *dst = frame->data[0] + y * 8 * frame->linesize[0] + x * 8;
150 if (!flip_x && !flip_y) {
151 memcpy(tile, tt, 64);
152 } else if (flip_x && flip_y) {
153 for (int i = 0; i < 8; i++) {
154 for (int j = 0; j < 8; j++)
155 tile[i * 8 + j] = tt[(7 - i) * 8 + 7 - j];
158 for (int i = 0; i < 8; i++) {
159 for (int j = 0; j < 8; j++)
160 tile[i * 8 + j] = tt[i * 8 + 7 - j];
163 for (int i = 0; i < 8; i++) {
164 for (int j = 0; j < 8; j++)
165 tile[i * 8 + j] = tt[(7 - i) * 8 + j];
169 for (int yy = 0; yy < 8; yy++) {
170 for (int xx = 0; xx < 8; xx++)
171 dst[xx] = pal_idx + tile[xx + yy * 8];
173 dst += frame->linesize[0];
181 static int decode_index(SGAVideoContext *s, AVFrame *frame)
183 const uint8_t *src = s->tileindex_data;
184 uint8_t *dst = frame->data[0];
186 for (int y = 0; y < frame->height; y += 8) {
187 for (int x = 0; x < frame->width; x += 8) {
188 for (int yy = 0; yy < 8; yy++) {
189 for (int xx = 0; xx < 8; xx++)
190 dst[x + xx + yy * frame->linesize[0]] = src[xx];
195 dst += 8 * frame->linesize[0];
201 static int lzss_decompress(AVCodecContext *avctx,
202 GetByteContext *gb, uint8_t *dst,
203 int dst_size, int shift, int plus)
207 while (bytestream2_get_bytes_left(gb) > 0 && oi < dst_size) {
208 uint16_t displace, header = bytestream2_get_be16(gb);
211 for (int i = 0; i < 16; i++) {
212 switch (header >> 15) {
214 if (oi + 2 < dst_size) {
215 dst[oi++] = bytestream2_get_byte(gb);
216 dst[oi++] = bytestream2_get_byte(gb);
220 displace = bytestream2_get_be16(gb);
221 count = displace >> shift;
222 offset = displace & ((1 << shift) - 1);
225 while (bytestream2_get_bytes_left(gb) > 0 &&
227 dst[oi++] = bytestream2_get_byte(gb);
236 return AVERROR_INVALIDDATA;
237 for (int j = 0; j < count * 2; j++) {
238 dst[oi] = dst[oi - offset];
248 return AVERROR_INVALIDDATA;
251 static int decode_palmapdata(AVCodecContext *avctx)
253 SGAVideoContext *s = avctx->priv_data;
254 const int bits = (s->nb_pal + 1) / 2;
255 GetByteContext *gb = &s->gb;
258 bytestream2_seek(gb, s->palmapdata_offset, SEEK_SET);
259 if (bytestream2_get_bytes_left(gb) < s->palmapdata_size)
260 return AVERROR_INVALIDDATA;
261 init_get_bits8(&pm, gb->buffer, s->palmapdata_size);
263 for (int y = 0; y < s->tiles_h; y++) {
264 uint8_t *dst = s->palmapindex_data + y * s->tiles_w;
266 for (int x = 0; x < s->tiles_w; x++)
267 dst[x] = get_bits(&pm, bits);
275 static int decode_tiledata(AVCodecContext *avctx)
277 SGAVideoContext *s = avctx->priv_data;
278 GetByteContext *gb = &s->gb;
281 bytestream2_seek(gb, s->tiledata_offset, SEEK_SET);
282 if (bytestream2_get_bytes_left(gb) < s->tiledata_size)
283 return AVERROR_INVALIDDATA;
284 init_get_bits8(&tm, gb->buffer, s->tiledata_size);
286 for (int n = 0; n < s->nb_tiles; n++) {
287 uint8_t *dst = s->tileindex_data + n * 64;
289 for (int yy = 0; yy < 8; yy++) {
290 for (int xx = 0; xx < 8; xx++)
291 dst[xx] = get_bits(&tm, 4);
297 for (int i = 0; i < s->nb_tiles && s->swap; i++) {
298 uint8_t *dst = s->tileindex_data + i * 64;
300 for (int j = 8; j < 64; j += 16) {
301 for (int k = 0; k < 8; k += 2)
302 FFSWAP(uint8_t, dst[j + k], dst[j+k+1]);
309 static int sga_decode_frame(AVCodecContext *avctx, void *data,
310 int *got_frame, AVPacket *avpkt)
312 SGAVideoContext *s = avctx->priv_data;
313 GetByteContext *gb = &s->gb;
314 AVFrame *frame = data;
317 if (avpkt->size <= 14)
318 return AVERROR_INVALIDDATA;
320 s->flags = avpkt->data[8];
321 s->nb_pal = avpkt->data[9];
322 s->tiles_w = avpkt->data[10];
323 s->tiles_h = avpkt->data[11];
326 return AVERROR_INVALIDDATA;
328 if ((ret = ff_set_dimensions(avctx,
330 s->tiles_h * 8)) < 0)
333 av_fast_padded_malloc(&s->tileindex_data, &s->tileindex_size,
334 avctx->width * avctx->height);
335 if (!s->tileindex_data)
336 return AVERROR(ENOMEM);
338 av_fast_padded_malloc(&s->palmapindex_data, &s->palmapindex_size,
339 s->tiles_w * s->tiles_h);
340 if (!s->palmapindex_data)
341 return AVERROR(ENOMEM);
343 if ((ret = ff_get_buffer(avctx, frame, 0)) < 0)
346 bytestream2_init(gb, avpkt->data, avpkt->size);
348 type = bytestream2_get_byte(gb);
349 s->metadata_size = 12 + ((!!(s->flags & HAVE_TILEMAP)) * 2);
350 s->nb_tiles = s->flags & HAVE_TILEMAP ? AV_RB16(avpkt->data + 12) : s->tiles_w * s->tiles_h;
351 if (s->nb_tiles > s->tiles_w * s->tiles_h)
352 return AVERROR_INVALIDDATA;
354 av_log(avctx, AV_LOG_DEBUG, "type: %X flags: %X nb_tiles: %d\n", type, s->flags, s->nb_tiles);
387 int offset = s->metadata_size, left;
390 bytestream2_seek(gb, s->metadata_size, SEEK_SET);
392 for (int i = 0; i < 3; i++)
393 sizes[i] = bytestream2_get_be16(gb);
395 for (int i = 0; i < 3; i++) {
397 int raw = size >> 15;
399 size &= (1 << 15) - 1;
402 if (bytestream2_get_bytes_left(gb) < size)
403 return AVERROR_INVALIDDATA;
405 if (sizeof(s->uncompressed) - offset < size)
406 return AVERROR_INVALIDDATA;
408 memcpy(s->uncompressed + offset, gb->buffer, size);
409 bytestream2_skip(gb, size);
413 if (bytestream2_get_bytes_left(gb) < size)
414 return AVERROR_INVALIDDATA;
416 bytestream2_init(&gb2, gb->buffer, size);
417 ret = lzss_decompress(avctx, &gb2, s->uncompressed + offset,
418 sizeof(s->uncompressed) - offset, s->shift, s->plus);
421 bytestream2_skip(gb, size);
428 left = bytestream2_get_bytes_left(gb);
429 if (sizeof(s->uncompressed) - offset < left)
430 return AVERROR_INVALIDDATA;
432 bytestream2_get_buffer(gb, s->uncompressed + offset, left);
435 bytestream2_init(gb, s->uncompressed, offset);
445 bytestream2_seek(gb, s->metadata_size, SEEK_SET);
446 ret = lzss_decompress(avctx, gb, s->uncompressed + s->metadata_size,
447 sizeof(s->uncompressed) - s->metadata_size, s->shift, s->plus);
450 bytestream2_init(gb, s->uncompressed, ret + s->metadata_size);
453 s->tiledata_size = s->nb_tiles * 32;
454 s->paldata_size = s->nb_pal * 18;
455 s->tiledata_offset = s->flags & PALDATA_FOLLOWS_TILEDATA ? s->metadata_size : s->metadata_size + s->paldata_size;
456 s->paldata_offset = s->flags & PALDATA_FOLLOWS_TILEDATA ? s->metadata_size + s->tiledata_size : s->metadata_size;
457 s->palmapdata_offset = (s->flags & HAVE_TILEMAP) ? -1 : s->paldata_offset + s->paldata_size;
458 s->palmapdata_size = (s->flags & HAVE_TILEMAP) || s->nb_pal < 2 ? 0 : (s->tiles_w * s->tiles_h * ((s->nb_pal + 1) / 2) + 7) / 8;
459 s->tilemapdata_size = (s->flags & HAVE_TILEMAP) ? s->tiles_w * s->tiles_h * 2 : 0;
460 s->tilemapdata_offset = (s->flags & HAVE_TILEMAP) ? s->paldata_offset + s->paldata_size: -1;
462 bytestream2_seek(gb, s->paldata_offset, SEEK_SET);
463 for (int n = 0; n < s->nb_pal; n++) {
464 ret = decode_palette(gb, s->pal + 16 * n);
469 if (s->tiledata_size > 0) {
470 ret = decode_tiledata(avctx);
475 if (s->palmapdata_size > 0) {
476 ret = decode_palmapdata(avctx);
481 if (s->palmapdata_size > 0 && s->tiledata_size > 0) {
482 ret = decode_index_palmap(s, frame);
485 } else if (s->tilemapdata_size > 0 && s->tiledata_size > 0) {
486 ret = decode_index_tilemap(s, frame);
489 } else if (s->tiledata_size > 0) {
490 ret = decode_index(s, frame);
496 av_log(avctx, AV_LOG_ERROR, "Unknown type: %X\n", type);
497 return AVERROR_INVALIDDATA;
500 memcpy(frame->data[1], s->pal, AVPALETTE_SIZE);
501 frame->palette_has_changed = 1;
502 frame->pict_type = AV_PICTURE_TYPE_I;
503 frame->key_frame = 1;
510 static av_cold int sga_decode_end(AVCodecContext *avctx)
512 SGAVideoContext *s = avctx->priv_data;
514 av_freep(&s->tileindex_data);
515 s->tileindex_size = 0;
517 av_freep(&s->palmapindex_data);
518 s->palmapindex_size = 0;
523 AVCodec ff_sga_decoder = {
525 .long_name = NULL_IF_CONFIG_SMALL("Digital Pictures SGA Video"),
526 .type = AVMEDIA_TYPE_VIDEO,
527 .id = AV_CODEC_ID_SGA_VIDEO,
528 .priv_data_size = sizeof(SGAVideoContext),
529 .init = sga_decode_init,
530 .decode = sga_decode_frame,
531 .close = sga_decode_end,
532 .capabilities = AV_CODEC_CAP_DR1,
533 .caps_internal = FF_CODEC_CAP_INIT_THREADSAFE,