2 * Gremlin Digital Video (GDV) decoder
3 * Copyright (c) 2017 Konstantin Shishkov
4 * Copyright (c) 2017 Paul B Mahol
6 * This file is part of FFmpeg.
8 * FFmpeg is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public
10 * License as published by the Free Software Foundation; either
11 * version 2.1 of the License, or (at your option) any later version.
13 * FFmpeg is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with FFmpeg; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23 #include "libavutil/common.h"
25 #include "bytestream.h"
28 typedef struct GDVContext {
29 AVCodecContext *avctx;
38 unsigned scale_h, scale_v;
41 typedef struct Bits8 {
46 typedef struct Bits32 {
51 #define PREAMBLE_SIZE 4096
53 static av_cold int gdv_decode_init(AVCodecContext *avctx)
55 GDVContext *gdv = avctx->priv_data;
58 avctx->pix_fmt = AV_PIX_FMT_PAL8;
59 gdv->frame_size = avctx->width * avctx->height + PREAMBLE_SIZE;
60 gdv->frame = av_calloc(gdv->frame_size, 1);
62 return AVERROR(ENOMEM);
64 for (i = 0; i < 2; i++) {
65 for (j = 0; j < 256; j++) {
66 for (k = 0; k < 8; k++) {
67 gdv->frame[i * 2048 + j * 8 + k] = j;
75 static void scaleup(uint8_t *dst, const uint8_t *src, int w)
78 for (x = 0; x < w - 7; x+=8) {
80 dst[x + 1] = src[(x>>1) + 0];
82 dst[x + 3] = src[(x>>1) + 1];
84 dst[x + 5] = src[(x>>1) + 2];
86 dst[x + 7] = src[(x>>1) + 3];
93 static void scaleup_rev(uint8_t *dst, const uint8_t *src, int w)
97 for (x = w - 1; (x+1) & 7; x--) {
100 for (x -= 7; x >= 0; x -= 8) {
102 dst[x + 7] = src[(x>>1) + 3];
104 dst[x + 5] = src[(x>>1) + 2];
106 dst[x + 3] = src[(x>>1) + 1];
108 dst[x + 1] = src[(x>>1) + 0];
112 static void scaledown(uint8_t *dst, const uint8_t *src, int w)
115 for (x = 0; x < w - 7; x+=8) {
116 dst[x + 0] = src[2*x + 0];
117 dst[x + 1] = src[2*x + 2];
118 dst[x + 2] = src[2*x + 4];
119 dst[x + 3] = src[2*x + 6];
120 dst[x + 4] = src[2*x + 8];
121 dst[x + 5] = src[2*x +10];
122 dst[x + 6] = src[2*x +12];
123 dst[x + 7] = src[2*x +14];
130 static void rescale(GDVContext *gdv, uint8_t *dst, int w, int h, int scale_v, int scale_h)
134 if ((gdv->scale_v == scale_v) && (gdv->scale_h == scale_h)) {
139 for (j = 0; j < h; j++) {
141 uint8_t *dst1 = dst + PREAMBLE_SIZE + y * w;
142 uint8_t *src1 = dst + PREAMBLE_SIZE + (y>>!!gdv->scale_h) * (w>>1);
144 scaleup_rev(dst1, src1, w);
146 } else if (gdv->scale_h) {
147 for (j = 0; j < h; j++) {
149 uint8_t *dst1 = dst + PREAMBLE_SIZE + y * w;
150 uint8_t *src1 = dst + PREAMBLE_SIZE + (y>>1) * w;
151 memcpy(dst1, src1, w);
155 if (scale_h && scale_v) {
156 for (y = 0; y < (h>>1); y++) {
157 uint8_t *dst1 = dst + PREAMBLE_SIZE + y * (w>>1);
158 uint8_t *src1 = dst + PREAMBLE_SIZE + y*2 * w;
159 scaledown(dst1, src1, w>>1);
161 } else if (scale_h) {
162 for (y = 0; y < (h>>1); y++) {
163 uint8_t *dst1 = dst + PREAMBLE_SIZE + y * w;
164 uint8_t *src1 = dst + PREAMBLE_SIZE + y*2 * w;
165 memcpy(dst1, src1, w);
167 } else if (scale_v) {
168 for (y = 0; y < h; y++) {
169 uint8_t *dst1 = dst + PREAMBLE_SIZE + y * w;
170 scaledown(dst1, dst1, w>>1);
174 gdv->scale_v = scale_v;
175 gdv->scale_h = scale_h;
178 static int read_bits2(Bits8 *bits, GetByteContext *gb)
182 if (bits->fill == 0) {
183 bits->queue |= bytestream2_get_byte(gb);
186 res = bits->queue >> 6;
193 static void fill_bits32(Bits32 *bits, GetByteContext *gb)
195 bits->queue = bytestream2_get_le32(gb);
199 static int read_bits32(Bits32 *bits, GetByteContext *gb, int nbits)
201 int res = bits->queue & ((1 << nbits) - 1);
203 bits->queue >>= nbits;
205 if (bits->fill <= 16) {
206 bits->queue |= bytestream2_get_le16(gb) << bits->fill;
213 static void lz_copy(PutByteContext *pb, GetByteContext *g2, int offset, unsigned len)
220 bytestream2_seek(g2, bytestream2_tell_p(pb) - 1, SEEK_SET);
221 c = bytestream2_get_byte(g2);
222 for (i = 0; i < len; i++) {
223 bytestream2_put_byte(pb, c);
225 } else if (offset < 0) {
226 int start = bytestream2_tell_p(pb) - (-offset);
228 bytestream2_seek(g2, start, SEEK_SET);
229 for (i = 0; i < len; i++) {
230 bytestream2_put_byte(pb, bytestream2_get_byte(g2));
233 int start = bytestream2_tell_p(pb) + offset;
235 bytestream2_seek(g2, start, SEEK_SET);
236 for (i = 0; i < len; i++) {
237 bytestream2_put_byte(pb, bytestream2_get_byte(g2));
242 static int decompress_2(AVCodecContext *avctx)
244 GDVContext *gdv = avctx->priv_data;
245 GetByteContext *gb = &gdv->gb;
246 GetByteContext *g2 = &gdv->g2;
247 PutByteContext *pb = &gdv->pb;
251 bytestream2_init(g2, gdv->frame, gdv->frame_size);
252 bytestream2_skip_p(pb, PREAMBLE_SIZE);
254 for (c = 0; c < 256; c++) {
255 for (i = 0; i < 16; i++) {
256 gdv->frame[c * 16 + i] = c;
260 while (bytestream2_get_bytes_left_p(pb) > 0 && bytestream2_get_bytes_left(gb) > 0) {
261 int tag = read_bits2(&bits, gb);
263 bytestream2_put_byte(pb, bytestream2_get_byte(gb));
264 } else if (tag == 1) {
265 int b = bytestream2_get_byte(gb);
266 int len = (b & 0xF) + 3;
267 int top = (b >> 4) & 0xF;
268 int off = (bytestream2_get_byte(gb) << 4) + top - 4096;
269 lz_copy(pb, g2, off, len);
270 } else if (tag == 2) {
271 int len = (bytestream2_get_byte(gb)) + 2;
272 bytestream2_skip_p(pb, len);
278 if (bytestream2_get_bytes_left_p(pb) > 0)
279 return AVERROR_INVALIDDATA;
284 static int decompress_5(AVCodecContext *avctx, unsigned skip)
286 GDVContext *gdv = avctx->priv_data;
287 GetByteContext *gb = &gdv->gb;
288 GetByteContext *g2 = &gdv->g2;
289 PutByteContext *pb = &gdv->pb;
292 bytestream2_init(g2, gdv->frame, gdv->frame_size);
293 bytestream2_skip_p(pb, skip + PREAMBLE_SIZE);
295 while (bytestream2_get_bytes_left_p(pb) > 0 && bytestream2_get_bytes_left(gb) > 0) {
296 int tag = read_bits2(&bits, gb);
297 if (bytestream2_get_bytes_left(gb) < 1)
298 return AVERROR_INVALIDDATA;
300 bytestream2_put_byte(pb, bytestream2_get_byte(gb));
301 } else if (tag == 1) {
302 int b = bytestream2_get_byte(gb);
303 int len = (b & 0xF) + 3;
305 int off = (bytestream2_get_byte(gb) << 4) + top - 4096;
306 lz_copy(pb, g2, off, len);
307 } else if (tag == 2) {
309 int b = bytestream2_get_byte(gb);
316 len = bytestream2_get_le16(gb);
318 bytestream2_skip_p(pb, len + 1);
320 int b = bytestream2_get_byte(gb);
321 int len = (b & 0x3) + 2;
322 int off = -(b >> 2) - 1;
323 lz_copy(pb, g2, off, len);
326 if (bytestream2_get_bytes_left_p(pb) > 0)
327 return AVERROR_INVALIDDATA;
331 static int decompress_68(AVCodecContext *avctx, unsigned skip, unsigned use8)
333 GDVContext *gdv = avctx->priv_data;
334 GetByteContext *gb = &gdv->gb;
335 GetByteContext *g2 = &gdv->g2;
336 PutByteContext *pb = &gdv->pb;
339 bytestream2_init(g2, gdv->frame, gdv->frame_size);
340 bytestream2_skip_p(pb, skip + PREAMBLE_SIZE);
341 fill_bits32(&bits, gb);
343 while (bytestream2_get_bytes_left_p(pb) > 0 && bytestream2_get_bytes_left(gb) > 0) {
344 int tag = read_bits32(&bits, gb, 2);
346 int b = read_bits32(&bits, gb, 1);
348 bytestream2_put_byte(pb, bytestream2_get_byte(gb));
356 val = read_bits32(&bits, gb, lbits);
358 if (val != ((1 << lbits) - 1)) {
362 return AVERROR_INVALIDDATA;
364 for (i = 0; i < len; i++) {
365 bytestream2_put_byte(pb, bytestream2_get_byte(gb));
368 } else if (tag == 1) {
369 int b = read_bits32(&bits, gb, 1);
373 len = (read_bits32(&bits, gb, 4)) + 2;
375 int bb = bytestream2_get_byte(gb);
376 if ((bb & 0x80) == 0) {
379 int top = (bb & 0x7F) << 8;
380 len = top + bytestream2_get_byte(gb) + 146;
383 bytestream2_skip_p(pb, len);
384 } else if (tag == 2) {
385 int i, subtag = read_bits32(&bits, gb, 2);
388 int top = (read_bits32(&bits, gb, 4)) << 8;
389 int offs = top + bytestream2_get_byte(gb);
390 if ((subtag != 0) || (offs <= 0xF80)) {
391 int len = (subtag) + 3;
392 lz_copy(pb, g2, (offs) - 4096, len);
394 int real_off, len, c1, c2;
400 real_off = ((offs >> 4) & 0x7) + 1;
401 len = ((offs & 0xF) + 2) * 2;
402 c1 = gdv->frame[bytestream2_tell_p(pb) - real_off];
403 c2 = gdv->frame[bytestream2_tell_p(pb) - real_off + 1];
404 for (i = 0; i < len/2; i++) {
405 bytestream2_put_byte(pb, c1);
406 bytestream2_put_byte(pb, c2);
410 int b = bytestream2_get_byte(gb);
411 int off = ((b & 0x7F)) + 1;
412 int len = ((b & 0x80) == 0) ? 2 : 3;
414 lz_copy(pb, g2, -off, len);
420 int q, b = bytestream2_get_byte(gb);
421 if ((b & 0xC0) == 0xC0) {
422 len = ((b & 0x3F)) + 8;
423 q = read_bits32(&bits, gb, 4);
424 off = (q << 8) + (bytestream2_get_byte(gb)) + 1;
427 if ((b & 0x80) == 0) {
428 len = ((b >> 4)) + 6;
431 len = ((b & 0x3F)) + 14;
432 ofs1 = read_bits32(&bits, gb, 4);
434 off = (ofs1 << 8) + (bytestream2_get_byte(gb)) - 4096;
437 int ofs1, b = bytestream2_get_byte(gb);
439 if ((b >> 4) == 0xF) {
440 len = bytestream2_get_byte(gb) + 21;
445 off = (ofs1 << 8) + bytestream2_get_byte(gb) - 4096;
447 lz_copy(pb, g2, off, len);
451 if (bytestream2_get_bytes_left_p(pb) > 0)
452 return AVERROR_INVALIDDATA;
457 static int gdv_decode_frame(AVCodecContext *avctx, void *data,
458 int *got_frame, AVPacket *avpkt)
460 GDVContext *gdv = avctx->priv_data;
461 GetByteContext *gb = &gdv->gb;
462 PutByteContext *pb = &gdv->pb;
463 AVFrame *frame = data;
464 int ret, i, pal_size;
465 const uint8_t *pal = av_packet_get_side_data(avpkt, AV_PKT_DATA_PALETTE, &pal_size);
470 bytestream2_init(gb, avpkt->data, avpkt->size);
471 bytestream2_init_writer(pb, gdv->frame, gdv->frame_size);
473 flags = bytestream2_get_le32(gb);
474 compression = flags & 0xF;
476 if (compression == 4 || compression == 7 || compression > 8)
477 return AVERROR_INVALIDDATA;
479 if ((ret = ff_get_buffer(avctx, frame, 0)) < 0)
481 if (pal && pal_size == AVPALETTE_SIZE)
482 memcpy(gdv->pal, pal, AVPALETTE_SIZE);
484 if (compression < 2 && bytestream2_get_bytes_left(gb) < 256*3)
485 return AVERROR_INVALIDDATA;
486 rescale(gdv, gdv->frame, avctx->width, avctx->height,
487 !!(flags & 0x10), !!(flags & 0x20));
489 switch (compression) {
491 memset(gdv->frame + PREAMBLE_SIZE, 0, gdv->frame_size - PREAMBLE_SIZE);
493 for (i = 0; i < 256; i++) {
494 unsigned r = bytestream2_get_byte(gb);
495 unsigned g = bytestream2_get_byte(gb);
496 unsigned b = bytestream2_get_byte(gb);
497 gdv->pal[i] = 0xFFU << 24 | r << 18 | g << 10 | b << 2;
501 ret = decompress_2(avctx);
506 ret = decompress_5(avctx, flags >> 8);
509 ret = decompress_68(avctx, flags >> 8, 0);
512 ret = decompress_68(avctx, flags >> 8, 1);
520 memcpy(frame->data[1], gdv->pal, AVPALETTE_SIZE);
521 dst = frame->data[0];
523 if (!gdv->scale_v && !gdv->scale_h) {
524 int sidx = PREAMBLE_SIZE, didx = 0;
527 for (y = 0; y < avctx->height; y++) {
528 memcpy(dst + didx, gdv->frame + sidx, avctx->width);
529 sidx += avctx->width;
530 didx += frame->linesize[0];
533 int sidx = PREAMBLE_SIZE, didx = 0;
536 for (y = 0; y < avctx->height; y++) {
538 memcpy(dst + didx, gdv->frame + sidx, avctx->width);
540 uint8_t *dst2 = dst + didx;
541 uint8_t *src2 = gdv->frame + sidx;
543 scaleup(dst2, src2, avctx->width);
545 if (!gdv->scale_h || ((y & 1) == 1)) {
546 sidx += !gdv->scale_v ? avctx->width : avctx->width/2;
548 didx += frame->linesize[0];
554 return ret < 0 ? ret : avpkt->size;
557 static av_cold int gdv_decode_close(AVCodecContext *avctx)
559 GDVContext *gdv = avctx->priv_data;
560 av_freep(&gdv->frame);
564 AVCodec ff_gdv_decoder = {
566 .long_name = NULL_IF_CONFIG_SMALL("Gremlin Digital Video"),
567 .type = AVMEDIA_TYPE_VIDEO,
568 .id = AV_CODEC_ID_GDV,
569 .priv_data_size = sizeof(GDVContext),
570 .init = gdv_decode_init,
571 .close = gdv_decode_close,
572 .decode = gdv_decode_frame,
573 .capabilities = AV_CODEC_CAP_DR1,
574 .caps_internal = FF_CODEC_CAP_INIT_THREADSAFE,