| Message ID | 20200105215735.GA12050@zall.org |
|---|---|
| State | New |
| Headers | show |
| Series | [FFmpeg-devel] CDToons decoder | expand |
| Context | Check | Description |
|---|---|---|
| andriy/ffmpeg-patchwork | success | Make fate finished |
On 1/5/2020 6:57 PM, Alyssa Milburn wrote: > This adds a decoder for Broderbund's sprite-based QuickTime CDToons > codec, based on the decoder I wrote for ScummVM. > > A couple of samples can be found at http://noopwafel.net/cdtoons/. > > Signed-off-by: Alyssa Milburn <amilburn@zall.org> > --- > Changelog | 1 + > doc/general.texi | 2 + > libavcodec/Makefile | 1 + > libavcodec/allcodecs.c | 1 + > libavcodec/avcodec.h | 1 + > libavcodec/cdtoons.c | 438 ++++++++++++++++++++++++++++++++++++++++ > libavcodec/codec_desc.c | 7 + > libavcodec/version.h | 2 +- > libavformat/isom.c | 1 + > libavformat/riff.c | 1 + > 10 files changed, 454 insertions(+), 1 deletion(-) > create mode 100644 libavcodec/cdtoons.c > > diff --git a/Changelog b/Changelog > index b9401aaab6..9cac485bb5 100644 > --- a/Changelog > +++ b/Changelog > @@ -29,6 +29,7 @@ version <next>: > - mvha decoder > - MPEG-H 3D Audio support in mp4 > - thistogram filter > +- CDToons decoder > > > version 4.2: > diff --git a/doc/general.texi b/doc/general.texi > index a5b77e0de1..8fdf8af9fe 100644 > --- a/doc/general.texi > +++ b/doc/general.texi > @@ -844,6 +844,8 @@ following image formats are supported: > @tab Codec used in Delphine Software International games. > @item Discworld II BMV Video @tab @tab X > @item Canopus Lossless Codec @tab @tab X > +@item CDToons @tab @tab X > + @tab Codec used in various Broderbund games. > @item Cinepak @tab @tab X > @item Cirrus Logic AccuPak @tab X @tab X > @tab fourcc: CLJR > diff --git a/libavcodec/Makefile b/libavcodec/Makefile > index c1f35b40d8..383a6da32d 100644 > --- a/libavcodec/Makefile > +++ b/libavcodec/Makefile > @@ -244,6 +244,7 @@ OBJS-$(CONFIG_CAVS_DECODER) += cavs.o cavsdec.o cavsdsp.o \ > cavsdata.o > OBJS-$(CONFIG_CCAPTION_DECODER) += ccaption_dec.o ass.o > OBJS-$(CONFIG_CDGRAPHICS_DECODER) += cdgraphics.o > +OBJS-$(CONFIG_CDTOONS_DECODER) += cdtoons.o > OBJS-$(CONFIG_CDXL_DECODER) += cdxl.o > OBJS-$(CONFIG_CFHD_DECODER) += cfhd.o cfhddata.o > OBJS-$(CONFIG_CINEPAK_DECODER) += cinepak.o > diff --git a/libavcodec/allcodecs.c b/libavcodec/allcodecs.c > index ec7366144f..a87f29829d 100644 > --- a/libavcodec/allcodecs.c > +++ b/libavcodec/allcodecs.c > @@ -68,6 +68,7 @@ extern AVCodec ff_brender_pix_decoder; > extern AVCodec ff_c93_decoder; > extern AVCodec ff_cavs_decoder; > extern AVCodec ff_cdgraphics_decoder; > +extern AVCodec ff_cdtoons_decoder; > extern AVCodec ff_cdxl_decoder; > extern AVCodec ff_cfhd_decoder; > extern AVCodec ff_cinepak_encoder; > diff --git a/libavcodec/avcodec.h b/libavcodec/avcodec.h > index 119b32dc1f..e9a24165ed 100644 > --- a/libavcodec/avcodec.h > +++ b/libavcodec/avcodec.h > @@ -460,6 +460,7 @@ enum AVCodecID { > AV_CODEC_ID_IMM5, > AV_CODEC_ID_MVDV, > AV_CODEC_ID_MVHA, > + AV_CODEC_ID_CDTOONS, > > /* various PCM "codecs" */ > AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs > diff --git a/libavcodec/cdtoons.c b/libavcodec/cdtoons.c > new file mode 100644 > index 0000000000..d6c441b8e3 > --- /dev/null > +++ b/libavcodec/cdtoons.c > @@ -0,0 +1,438 @@ > +/* > + * CDToons video decoder > + * Copyright (C) 2011 The FFmpeg project 2011? > + * > + * This file is part of FFmpeg. > + * > + * FFmpeg is free software; you can redistribute it and/or > + * modify it under the terms of the GNU Lesser General Public > + * License as published by the Free Software Foundation; either > + * version 2.1 of the License, or (at your option) any later version. > + * > + * FFmpeg is distributed in the hope that it will be useful, > + * but WITHOUT ANY WARRANTY; without even the implied warranty of > + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU > + * Lesser General Public License for more details. > + * > + * You should have received a copy of the GNU Lesser General Public > + * License along with FFmpeg; if not, write to the Free Software > + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA > + */ > + > +/** > + * @file > + * CDToons video decoder > + * @author Alyssa Milburn <amilburn@zall.org> You could add this as a copyright line above instead. > + */ > + > +#include <stdint.h> > + > +#include "libavutil/attributes.h" > +#include "libavutil/internal.h" > +#include "avcodec.h" > +#include "bytestream.h" > +#include "internal.h" > + > +#define CDTOONS_HEADER_SIZE 44 > +#define CDTOONS_MAX_SPRITES 1200 > + > +typedef struct CDToonsSprite { > + uint16_t flags; > + uint16_t owner_frame; > + uint16_t start_frame; > + uint16_t end_frame; > + uint32_t size; > + uint8_t *data; > +} CDToonsSprite; > + > +typedef struct CDToonsContext { > + AVCodecContext *avctx; > + AVFrame *frame; > + > + uint16_t last_pal_id; ///< The index of the active palette sprite. > + uint32_t pal[256]; ///< The currently-used palette data. > + CDToonsSprite sprites[CDTOONS_MAX_SPRITES]; > +} CDToonsContext; > + > +static int cdtoons_render_sprite(AVCodecContext *avctx, const uint8_t *data, > + uint32_t data_size, > + int dst_x, int dst_y, int width, int height) > +{ > + CDToonsContext *c = avctx->priv_data; > + const uint8_t *next_line = data; > + uint16_t line_size; > + uint8_t *dest; > + int skip = 0, to_skip, x; > + > + if (dst_x + width > avctx->width) > + width = avctx->width - dst_x; > + if (dst_y + height > avctx->height) > + height = avctx->height - dst_y; > + > + if (dst_x < 0) { > + /* we need to skip the start of the scanlines */ > + skip = -dst_x; > + if (width <= skip) > + return 0; > + dst_x = 0; > + } > + > + for (int y = 0; y < height; y++) { > + /* one scanline at a time, size is provided */ > + data = next_line; > + line_size = bytestream_get_be16(&data); > + next_line = data + line_size; > + if (dst_y + y < 0) > + continue; > + > + dest = c->frame->data[0] + (dst_y + y) * c->frame->linesize[0] + dst_x; > + > + to_skip = skip; > + x = 0; > + while (x < width - skip) { > + uint8_t val = bytestream_get_byte(&data); > + int raw = !(val & 0x80); > + int size = (int)(val & 0x7F) + 1; > + > + /* skip the start of a scanline if it is off-screen */ > + if (to_skip >= size) { > + to_skip -= size; > + if (raw) { > + data += size; > + } else { > + data += 1; > + } > + if (data > next_line) > + return 1; > + continue; > + } else if (to_skip) { > + size -= to_skip; > + if (raw) > + data += to_skip; > + to_skip = 0; > + if (data > next_line) > + return 1; > + } > + > + if (x + size >= width - skip) > + size = width - skip - x; > + > + /* either raw data, or a run of a single color */ > + if (raw) { > + memcpy(dest + x, data, size); > + data += size; > + if (data > next_line) > + return 1; > + } else { > + uint8_t color = bytestream_get_byte(&data); > + /* ignore transparent runs */ > + if (color) > + memset(dest + x, color, size); > + } > + x += size; > + } > + } > + > + return 0; > +} > + > +static int cdtoons_decode_frame(AVCodecContext *avctx, void *data, > + int *got_frame, AVPacket *avpkt) > +{ > + CDToonsContext *c = avctx->priv_data; > + const uint8_t *buf = avpkt->data; > + const uint8_t *eod = avpkt->data + avpkt->size; > + int buf_size = avpkt->size; > + uint16_t frame_id; > + uint8_t background_color; > + uint16_t sprite_count, sprite_offset; > + uint8_t referenced_count; > + uint16_t palette_id; > + uint8_t palette_set; > + int ret, i; > + int saw_embedded_sprites = 0; > + > + if (buf_size < CDTOONS_HEADER_SIZE) > + return AVERROR_INVALIDDATA; > + > + if ((ret = ff_reget_buffer(avctx, c->frame, 0))) { > + av_log(avctx, AV_LOG_ERROR, "reget_buffer() failed\n"); > + return ret; > + } > + > + /* a lot of the header is useless junk in the absence of > + * dirty rectangling etc */ > + buf += 2; /* version? (always 9?) */ > + frame_id = bytestream_get_be16(&buf); > + buf += 2; /* blocks_valid_until */ > + buf += 1; > + background_color = bytestream_get_byte(&buf); > + buf += 16; /* clip rect, dirty rect */ > + buf += 4; /* flags */ > + sprite_count = bytestream_get_be16(&buf); > + sprite_offset = bytestream_get_be16(&buf); > + buf += 2; /* max block id? */ > + referenced_count = bytestream_get_byte(&buf); > + buf += 1; > + palette_id = bytestream_get_be16(&buf); > + palette_set = bytestream_get_byte(&buf); > + buf += 5; > + > + /* read new sprites introduced in this frame */ > + buf = avpkt->data + sprite_offset; > + while (sprite_count--) { > + uint32_t size; > + uint16_t sprite_id; > + > + if (buf + 14 > eod) > + return AVERROR_INVALIDDATA; > + > + sprite_id = bytestream_get_be16(&buf); > + if (sprite_id >= CDTOONS_MAX_SPRITES) { > + av_log(avctx, AV_LOG_ERROR, > + "Sprite ID %d is too high.\n", sprite_id); > + return AVERROR_INVALIDDATA; > + } > + if (c->sprites[sprite_id].data) { > + av_log(avctx, AV_LOG_ERROR, > + "Sprite ID %d is a duplicate.\n", sprite_id); > + return AVERROR_INVALIDDATA; > + } > + > + c->sprites[sprite_id].flags = bytestream_get_be16(&buf); > + size = bytestream_get_be32(&buf); > + if (size < 14) { > + av_log(avctx, AV_LOG_ERROR, > + "Sprite only has %d bytes of data.\n", size); > + return AVERROR_INVALIDDATA; > + } > + size -= 14; > + c->sprites[sprite_id].size = size; > + c->sprites[sprite_id].owner_frame = frame_id; > + c->sprites[sprite_id].start_frame = bytestream_get_be16(&buf); > + c->sprites[sprite_id].end_frame = bytestream_get_be16(&buf); > + buf += 2; > + > + if (size > buf_size || buf + size > eod) > + return AVERROR_INVALIDDATA; > + > + c->sprites[sprite_id].data = av_malloc(size); Use av_fast_malloc() instead of constantly freeing and reallocating these buffers. See libavutil/mem.h > + if (!c->sprites[sprite_id].data) > + return AVERROR(ENOMEM); > + > + bytestream_get_buffer(&buf, c->sprites[sprite_id].data, size); > + } > + > + /* render any embedded sprites */ > + while (buf < eod) { > + uint32_t tag, size; > + if (buf + 8 > eod) { > + av_log(avctx, AV_LOG_WARNING, "Ran (seriously) out of data for embedded sprites.\n"); > + return AVERROR_INVALIDDATA; > + } > + tag = bytestream_get_be32(&buf); > + size = bytestream_get_be32(&buf); > + if (tag == MKBETAG('D', 'i', 'f', 'f')) { > + uint16_t diff_count; > + if (buf + 10 > eod) { > + av_log(avctx, AV_LOG_WARNING, "Ran (seriously) out of data for Diff frame.\n"); > + return AVERROR_INVALIDDATA; > + } > + diff_count = bytestream_get_be16(&buf); > + buf += 8; /* clip rect? */ > + for (i = 0; i < diff_count; i++) { > + int16_t top, left; > + uint16_t diff_size, width, height; > + > + if (buf + 16 > eod) { > + av_log(avctx, AV_LOG_WARNING, "Ran (seriously) out of data for Diff frame header.\n"); > + return AVERROR_INVALIDDATA; > + } > + > + top = bytestream_get_be16(&buf); > + left = bytestream_get_be16(&buf); > + buf += 4; /* bottom, right */ > + diff_size = bytestream_get_be32(&buf); > + width = bytestream_get_be16(&buf); > + height = bytestream_get_be16(&buf); > + if (diff_size < 4 || diff_size - 4 > eod - buf) { > + av_log(avctx, AV_LOG_WARNING, "Ran (seriously) out of data for Diff frame data.\n"); > + return AVERROR_INVALIDDATA; > + } > + if (cdtoons_render_sprite(avctx, buf + 4, diff_size - 8, > + left, top, width, height)) { > + av_log(avctx, AV_LOG_WARNING, "Ran beyond end of sprite while rendering.\n"); > + } > + buf += diff_size - 4; > + } > + saw_embedded_sprites = 1; > + } else { > + /* we don't care about any other entries */ > + if (size < 8 || size - 8 > eod - buf) { > + av_log(avctx, AV_LOG_WARNING, "Ran out of data for ignored entry (size %d, %d left).\n", size, (int)(eod - buf)); > + return AVERROR_INVALIDDATA; > + } > + buf += (size - 8); > + } > + } > + > + /* was an intra frame? */ > + if (saw_embedded_sprites) > + goto done; > + > + /* render any referenced sprites */ > + buf = avpkt->data + CDTOONS_HEADER_SIZE; > + eod = avpkt->data + sprite_offset; > + for (i = 0; i < referenced_count; i++) { > + const uint8_t *block_data; > + uint16_t sprite_id, width, height; > + int16_t top, left, right; > + > + if (buf + 10 > eod) { > + av_log(avctx, AV_LOG_WARNING, "Ran (seriously) out of data when rendering.\n"); > + return AVERROR_INVALIDDATA; > + } > + > + sprite_id = bytestream_get_be16(&buf); > + top = bytestream_get_be16(&buf); > + left = bytestream_get_be16(&buf); > + buf += 2; /* bottom */ > + right = bytestream_get_be16(&buf); > + > + if ((i == 0) && (sprite_id == 0)) { > + /* clear background */ > + memset(c->frame->data[0], background_color, > + c->frame->linesize[0] * avctx->height); > + } > + > + if (!right) > + continue; > + block_data = c->sprites[sprite_id].data; > + if (!block_data) { > + /* this can happen when seeking around */ Set size to 0 in cdtoons_flush() and check for that instead (Assuming you switch to av_fast_malloc). > + av_log(avctx, AV_LOG_WARNING, "Sprite %d is missing.\n", sprite_id); > + continue; > + } > + if (c->sprites[sprite_id].size < 14) { > + av_log(avctx, AV_LOG_ERROR, "Sprite %d is too small.\n", sprite_id); > + continue; > + } > + > + height = bytestream_get_be16(&block_data); > + width = bytestream_get_be16(&block_data); > + block_data += 10; > + if (cdtoons_render_sprite(avctx, block_data, > + c->sprites[sprite_id].size - 14, > + left, top, width, height)) { > + av_log(avctx, AV_LOG_WARNING, "Ran beyond end of sprite while rendering.\n"); > + } > + } > + > + if (palette_id && (palette_id != c->last_pal_id)) { > + if (palette_id >= CDTOONS_MAX_SPRITES) { > + av_log(avctx, AV_LOG_ERROR, > + "Palette ID %d is too high.\n", palette_id); > + return AVERROR_INVALIDDATA; > + } > + if (!c->sprites[palette_id].data) { > + /* this can happen when seeking around */ > + av_log(avctx, AV_LOG_WARNING, > + "Palette ID %d is missing.\n", palette_id); > + goto done; > + } > + if (c->sprites[palette_id].size != 256 * 2 * 3) { > + av_log(avctx, AV_LOG_ERROR, > + "Palette ID %d is wrong size (%d).\n", > + palette_id, c->sprites[palette_id].size); > + return AVERROR_INVALIDDATA; > + } > + c->last_pal_id = palette_id; > + if (!palette_set) { > + uint8_t *palette_data = c->sprites[palette_id].data; > + for (i = 0; i < 256; i++) { > + /* QuickTime-ish palette: 16-bit RGB components */ > + uint8_t r, g, b; > + r = *palette_data; > + g = *(palette_data + 2); > + b = *(palette_data + 4); > + c->pal[i] = (0xff << 24) | (r << 16) | (g << 8) | (b); > + palette_data += 6; > + } > + /* first palette entry indicates transparency */ > + c->pal[0] = 0; > + c->frame->palette_has_changed = 1; > + } > + } > + > +done: > + /* discard outdated blocks */ > + for (i = 0; i < CDTOONS_MAX_SPRITES; i++) { > + if (c->sprites[i].end_frame > frame_id) > + continue; > + av_free(c->sprites[i].data); > + c->sprites[i].data = NULL; Same here, just set size to 0 and leave the buffers alone. Only free them in cdtoons_decode_end(). Also, for future reference, av_freep(&c->sprites[i].data) both frees the buffer and sets the pointer to NULL in one call. > + } > + > + memcpy(c->frame->data[1], c->pal, AVPALETTE_SIZE); > + > + if ((ret = av_frame_ref(data, c->frame)) < 0) > + return ret; > + > + *got_frame = 1; > + > + /* always report that the buffer was completely consumed */ > + return buf_size; > +} > + > +static av_cold int cdtoons_decode_init(AVCodecContext *avctx) > +{ > + CDToonsContext *c = avctx->priv_data; > + > + c->avctx = avctx; Seems unused. > + avctx->pix_fmt = AV_PIX_FMT_PAL8; > + c->last_pal_id = 0; > + c->frame = av_frame_alloc(); > + if (!c->frame) > + return AVERROR(ENOMEM); > + memset(c->sprites, 0, sizeof(c->sprites)); Not needed. The private struct is zeroed when it's allocated. > + > + return 0; > +} > + > +static void cdtoons_flush(AVCodecContext *avctx) > +{ > + CDToonsContext *c = avctx->priv_data; > + int i; > + > + c->last_pal_id = 0; > + for (i = 0; i < CDTOONS_MAX_SPRITES; i++) { > + av_free(c->sprites[i].data); > + c->sprites[i].data = NULL; > + } > +} > + > +static av_cold int cdtoons_decode_end(AVCodecContext *avctx) > +{ > + CDToonsContext *c = avctx->priv_data; > + int i; > + > + for (i = 0; i < CDTOONS_MAX_SPRITES; i++) > + av_free(c->sprites[i].data); > + > + av_frame_free(&c->frame); > + > + return 0; > +} > + > +AVCodec ff_cdtoons_decoder = { > + .name = "cdtoons", > + .long_name = NULL_IF_CONFIG_SMALL("CDToons"), > + .type = AVMEDIA_TYPE_VIDEO, > + .id = AV_CODEC_ID_CDTOONS, > + .priv_data_size = sizeof(CDToonsContext), > + .init = cdtoons_decode_init, > + .close = cdtoons_decode_end, > + .decode = cdtoons_decode_frame, > + .capabilities = AV_CODEC_CAP_DR1, > + .flush = cdtoons_flush, > +}; > diff --git a/libavcodec/codec_desc.c b/libavcodec/codec_desc.c > index 529b838e5b..55003ab1d7 100644 > --- a/libavcodec/codec_desc.c > +++ b/libavcodec/codec_desc.c > @@ -1747,6 +1747,13 @@ static const AVCodecDescriptor codec_descriptors[] = { > .long_name = NULL_IF_CONFIG_SMALL("MidiVid Archive Codec"), > .props = AV_CODEC_PROP_INTRA_ONLY | AV_CODEC_PROP_LOSSY, > }, > + { > + .id = AV_CODEC_ID_CDTOONS, > + .type = AVMEDIA_TYPE_VIDEO, > + .name = "cdtoons", > + .long_name = NULL_IF_CONFIG_SMALL("CDToons video"), > + .props = AV_CODEC_PROP_LOSSLESS, > + }, > > /* various PCM "codecs" */ > { > diff --git a/libavcodec/version.h b/libavcodec/version.h > index 77da913df0..1a88432460 100644 > --- a/libavcodec/version.h > +++ b/libavcodec/version.h > @@ -29,7 +29,7 @@ > > #define LIBAVCODEC_VERSION_MAJOR 58 > #define LIBAVCODEC_VERSION_MINOR 65 > -#define LIBAVCODEC_VERSION_MICRO 102 > +#define LIBAVCODEC_VERSION_MICRO 103 New codec IDs and modules like decoders bump minor instead. > > #define LIBAVCODEC_VERSION_INT AV_VERSION_INT(LIBAVCODEC_VERSION_MAJOR, \ > LIBAVCODEC_VERSION_MINOR, \ > diff --git a/libavformat/isom.c b/libavformat/isom.c > index 824e811177..eefe9277b4 100644 > --- a/libavformat/isom.c > +++ b/libavformat/isom.c > @@ -158,6 +158,7 @@ const AVCodecTag ff_codec_movvideo_tags[] = { > { AV_CODEC_ID_SGIRLE, MKTAG('r', 'l', 'e', '1') }, /* SGI RLE 8-bit */ > { AV_CODEC_ID_MSRLE, MKTAG('W', 'R', 'L', 'E') }, > { AV_CODEC_ID_QDRAW, MKTAG('q', 'd', 'r', 'w') }, /* QuickDraw */ > + { AV_CODEC_ID_CDTOONS, MKTAG('Q', 'k', 'B', 'k') }, /* CDToons */ > > { AV_CODEC_ID_RAWVIDEO, MKTAG('W', 'R', 'A', 'W') }, > > diff --git a/libavformat/riff.c b/libavformat/riff.c > index c73f6e9db0..560a3aa208 100644 > --- a/libavformat/riff.c > +++ b/libavformat/riff.c > @@ -491,6 +491,7 @@ const AVCodecTag ff_codec_bmp_tags[] = { > { AV_CODEC_ID_IMM5, MKTAG('I', 'M', 'M', '5') }, > { AV_CODEC_ID_MVDV, MKTAG('M', 'V', 'D', 'V') }, > { AV_CODEC_ID_MVHA, MKTAG('M', 'V', 'H', 'A') }, > + { AV_CODEC_ID_CDTOONS, MKTAG('Q', 'k', 'B', 'k') }, > { AV_CODEC_ID_NONE, 0 } > }; > >
Am So., 5. Jan. 2020 um 22:57 Uhr schrieb Alyssa Milburn <amilburn@zall.org>: > diff --git a/libavformat/riff.c b/libavformat/riff.c > index c73f6e9db0..560a3aa208 100644 > --- a/libavformat/riff.c > +++ b/libavformat/riff.c > @@ -491,6 +491,7 @@ const AVCodecTag ff_codec_bmp_tags[] = { > { AV_CODEC_ID_IMM5, MKTAG('I', 'M', 'M', '5') }, > { AV_CODEC_ID_MVDV, MKTAG('M', 'V', 'D', 'V') }, > { AV_CODEC_ID_MVHA, MKTAG('M', 'V', 'H', 'A') }, > + { AV_CODEC_ID_CDTOONS, MKTAG('Q', 'k', 'B', 'k') }, > { AV_CODEC_ID_NONE, 0 } Does the codec really exist in avi? I ask because the sample files you provide are mov. If no avi files exist, please remove above hunk. And please put your name in the copyright line as suggested by James. Thank you, Carl Eugen
On Sun, Jan 05, 2020 at 07:37:06PM -0300, James Almer wrote: > > + * Copyright (C) 2011 The FFmpeg project > > 2011? This patch has been lying around for a while. :/ Will update to 2020. > Use av_fast_malloc() instead of constantly freeing and reallocating > these buffers. See libavutil/mem.h Sprites are typically only allocated once for a given sprite_id, so for most situations the only difference would be to delay deallocation until the end of the video. Do you think it's worth doing anyway? (Easy enough to do.) Otherwise: ACK, thank you for the fast review. - Alyssa
On 1/5/20, Alyssa Milburn <amilburn@zall.org> wrote: > This adds a decoder for Broderbund's sprite-based QuickTime CDToons > codec, based on the decoder I wrote for ScummVM. > > A couple of samples can be found at http://noopwafel.net/cdtoons/. > > Signed-off-by: Alyssa Milburn <amilburn@zall.org> > --- > Changelog | 1 + > doc/general.texi | 2 + > libavcodec/Makefile | 1 + > libavcodec/allcodecs.c | 1 + > libavcodec/avcodec.h | 1 + > libavcodec/cdtoons.c | 438 ++++++++++++++++++++++++++++++++++++++++ > libavcodec/codec_desc.c | 7 + > libavcodec/version.h | 2 +- > libavformat/isom.c | 1 + > libavformat/riff.c | 1 + > 10 files changed, 454 insertions(+), 1 deletion(-) > create mode 100644 libavcodec/cdtoons.c > > diff --git a/Changelog b/Changelog > index b9401aaab6..9cac485bb5 100644 > --- a/Changelog > +++ b/Changelog > @@ -29,6 +29,7 @@ version <next>: > - mvha decoder > - MPEG-H 3D Audio support in mp4 > - thistogram filter > +- CDToons decoder > > > version 4.2: > diff --git a/doc/general.texi b/doc/general.texi > index a5b77e0de1..8fdf8af9fe 100644 > --- a/doc/general.texi > +++ b/doc/general.texi > @@ -844,6 +844,8 @@ following image formats are supported: > @tab Codec used in Delphine Software International games. > @item Discworld II BMV Video @tab @tab X > @item Canopus Lossless Codec @tab @tab X > +@item CDToons @tab @tab X > + @tab Codec used in various Broderbund games. > @item Cinepak @tab @tab X > @item Cirrus Logic AccuPak @tab X @tab X > @tab fourcc: CLJR > diff --git a/libavcodec/Makefile b/libavcodec/Makefile > index c1f35b40d8..383a6da32d 100644 > --- a/libavcodec/Makefile > +++ b/libavcodec/Makefile > @@ -244,6 +244,7 @@ OBJS-$(CONFIG_CAVS_DECODER) += cavs.o > cavsdec.o cavsdsp.o \ > cavsdata.o > OBJS-$(CONFIG_CCAPTION_DECODER) += ccaption_dec.o ass.o > OBJS-$(CONFIG_CDGRAPHICS_DECODER) += cdgraphics.o > +OBJS-$(CONFIG_CDTOONS_DECODER) += cdtoons.o > OBJS-$(CONFIG_CDXL_DECODER) += cdxl.o > OBJS-$(CONFIG_CFHD_DECODER) += cfhd.o cfhddata.o > OBJS-$(CONFIG_CINEPAK_DECODER) += cinepak.o > diff --git a/libavcodec/allcodecs.c b/libavcodec/allcodecs.c > index ec7366144f..a87f29829d 100644 > --- a/libavcodec/allcodecs.c > +++ b/libavcodec/allcodecs.c > @@ -68,6 +68,7 @@ extern AVCodec ff_brender_pix_decoder; > extern AVCodec ff_c93_decoder; > extern AVCodec ff_cavs_decoder; > extern AVCodec ff_cdgraphics_decoder; > +extern AVCodec ff_cdtoons_decoder; > extern AVCodec ff_cdxl_decoder; > extern AVCodec ff_cfhd_decoder; > extern AVCodec ff_cinepak_encoder; > diff --git a/libavcodec/avcodec.h b/libavcodec/avcodec.h > index 119b32dc1f..e9a24165ed 100644 > --- a/libavcodec/avcodec.h > +++ b/libavcodec/avcodec.h > @@ -460,6 +460,7 @@ enum AVCodecID { > AV_CODEC_ID_IMM5, > AV_CODEC_ID_MVDV, > AV_CODEC_ID_MVHA, > + AV_CODEC_ID_CDTOONS, > > /* various PCM "codecs" */ > AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the > start of audio codecs > diff --git a/libavcodec/cdtoons.c b/libavcodec/cdtoons.c > new file mode 100644 > index 0000000000..d6c441b8e3 > --- /dev/null > +++ b/libavcodec/cdtoons.c > @@ -0,0 +1,438 @@ > +/* > + * CDToons video decoder > + * Copyright (C) 2011 The FFmpeg project > + * > + * This file is part of FFmpeg. > + * > + * FFmpeg is free software; you can redistribute it and/or > + * modify it under the terms of the GNU Lesser General Public > + * License as published by the Free Software Foundation; either > + * version 2.1 of the License, or (at your option) any later version. > + * > + * FFmpeg is distributed in the hope that it will be useful, > + * but WITHOUT ANY WARRANTY; without even the implied warranty of > + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU > + * Lesser General Public License for more details. > + * > + * You should have received a copy of the GNU Lesser General Public > + * License along with FFmpeg; if not, write to the Free Software > + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 > USA > + */ > + > +/** > + * @file > + * CDToons video decoder > + * @author Alyssa Milburn <amilburn@zall.org> > + */ > + > +#include <stdint.h> > + > +#include "libavutil/attributes.h" > +#include "libavutil/internal.h" > +#include "avcodec.h" > +#include "bytestream.h" > +#include "internal.h" > + > +#define CDTOONS_HEADER_SIZE 44 > +#define CDTOONS_MAX_SPRITES 1200 > + > +typedef struct CDToonsSprite { > + uint16_t flags; > + uint16_t owner_frame; > + uint16_t start_frame; > + uint16_t end_frame; > + uint32_t size; > + uint8_t *data; > +} CDToonsSprite; > + > +typedef struct CDToonsContext { > + AVCodecContext *avctx; > + AVFrame *frame; > + > + uint16_t last_pal_id; ///< The index of the active palette sprite. > + uint32_t pal[256]; ///< The currently-used palette data. > + CDToonsSprite sprites[CDTOONS_MAX_SPRITES]; > +} CDToonsContext; > + > +static int cdtoons_render_sprite(AVCodecContext *avctx, const uint8_t > *data, > + uint32_t data_size, > + int dst_x, int dst_y, int width, int > height) > +{ > + CDToonsContext *c = avctx->priv_data; > + const uint8_t *next_line = data; > + uint16_t line_size; > + uint8_t *dest; > + int skip = 0, to_skip, x; > + > + if (dst_x + width > avctx->width) > + width = avctx->width - dst_x; > + if (dst_y + height > avctx->height) > + height = avctx->height - dst_y; > + > + if (dst_x < 0) { > + /* we need to skip the start of the scanlines */ > + skip = -dst_x; > + if (width <= skip) > + return 0; > + dst_x = 0; > + } > + > + for (int y = 0; y < height; y++) { > + /* one scanline at a time, size is provided */ > + data = next_line; > + line_size = bytestream_get_be16(&data); > + next_line = data + line_size; > + if (dst_y + y < 0) > + continue; > + > + dest = c->frame->data[0] + (dst_y + y) * c->frame->linesize[0] + > dst_x; > + > + to_skip = skip; > + x = 0; > + while (x < width - skip) { > + uint8_t val = bytestream_get_byte(&data); > + int raw = !(val & 0x80); > + int size = (int)(val & 0x7F) + 1; > + > + /* skip the start of a scanline if it is off-screen */ > + if (to_skip >= size) { > + to_skip -= size; > + if (raw) { > + data += size; > + } else { > + data += 1; > + } > + if (data > next_line) > + return 1; > + continue; > + } else if (to_skip) { > + size -= to_skip; > + if (raw) > + data += to_skip; > + to_skip = 0; > + if (data > next_line) > + return 1; > + } > + > + if (x + size >= width - skip) > + size = width - skip - x; > + > + /* either raw data, or a run of a single color */ > + if (raw) { > + memcpy(dest + x, data, size); > + data += size; > + if (data > next_line) > + return 1; > + } else { > + uint8_t color = bytestream_get_byte(&data); > + /* ignore transparent runs */ > + if (color) > + memset(dest + x, color, size); > + } > + x += size; > + } > + } > + > + return 0; > +} > + > +static int cdtoons_decode_frame(AVCodecContext *avctx, void *data, > + int *got_frame, AVPacket *avpkt) > +{ > + CDToonsContext *c = avctx->priv_data; > + const uint8_t *buf = avpkt->data; > + const uint8_t *eod = avpkt->data + avpkt->size; > + int buf_size = avpkt->size; > + uint16_t frame_id; > + uint8_t background_color; > + uint16_t sprite_count, sprite_offset; > + uint8_t referenced_count; > + uint16_t palette_id; > + uint8_t palette_set; > + int ret, i; > + int saw_embedded_sprites = 0; > + > + if (buf_size < CDTOONS_HEADER_SIZE) > + return AVERROR_INVALIDDATA; > + > + if ((ret = ff_reget_buffer(avctx, c->frame, 0))) { > + av_log(avctx, AV_LOG_ERROR, "reget_buffer() failed\n"); This message is not needed anymore, please remove. > + return ret; > + } > + > + /* a lot of the header is useless junk in the absence of > + * dirty rectangling etc */ > + buf += 2; /* version? (always 9?) */ > + frame_id = bytestream_get_be16(&buf); > + buf += 2; /* blocks_valid_until */ > + buf += 1; > + background_color = bytestream_get_byte(&buf); > + buf += 16; /* clip rect, dirty rect */ > + buf += 4; /* flags */ > + sprite_count = bytestream_get_be16(&buf); > + sprite_offset = bytestream_get_be16(&buf); > + buf += 2; /* max block id? */ > + referenced_count = bytestream_get_byte(&buf); > + buf += 1; > + palette_id = bytestream_get_be16(&buf); > + palette_set = bytestream_get_byte(&buf); > + buf += 5; > + > + /* read new sprites introduced in this frame */ > + buf = avpkt->data + sprite_offset; > + while (sprite_count--) { > + uint32_t size; > + uint16_t sprite_id; > + > + if (buf + 14 > eod) > + return AVERROR_INVALIDDATA; > + > + sprite_id = bytestream_get_be16(&buf); > + if (sprite_id >= CDTOONS_MAX_SPRITES) { > + av_log(avctx, AV_LOG_ERROR, > + "Sprite ID %d is too high.\n", sprite_id); > + return AVERROR_INVALIDDATA; > + } > + if (c->sprites[sprite_id].data) { > + av_log(avctx, AV_LOG_ERROR, > + "Sprite ID %d is a duplicate.\n", sprite_id); > + return AVERROR_INVALIDDATA; > + } > + > + c->sprites[sprite_id].flags = bytestream_get_be16(&buf); > + size = bytestream_get_be32(&buf); > + if (size < 14) { > + av_log(avctx, AV_LOG_ERROR, > + "Sprite only has %d bytes of data.\n", size); > + return AVERROR_INVALIDDATA; > + } > + size -= 14; > + c->sprites[sprite_id].size = size; > + c->sprites[sprite_id].owner_frame = frame_id; > + c->sprites[sprite_id].start_frame = bytestream_get_be16(&buf); > + c->sprites[sprite_id].end_frame = bytestream_get_be16(&buf); > + buf += 2; > + > + if (size > buf_size || buf + size > eod) > + return AVERROR_INVALIDDATA; > + > + c->sprites[sprite_id].data = av_malloc(size); > + if (!c->sprites[sprite_id].data) > + return AVERROR(ENOMEM); > + > + bytestream_get_buffer(&buf, c->sprites[sprite_id].data, size); > + } > + > + /* render any embedded sprites */ > + while (buf < eod) { > + uint32_t tag, size; > + if (buf + 8 > eod) { > + av_log(avctx, AV_LOG_WARNING, "Ran (seriously) out of data for > embedded sprites.\n"); > + return AVERROR_INVALIDDATA; > + } > + tag = bytestream_get_be32(&buf); > + size = bytestream_get_be32(&buf); > + if (tag == MKBETAG('D', 'i', 'f', 'f')) { > + uint16_t diff_count; > + if (buf + 10 > eod) { > + av_log(avctx, AV_LOG_WARNING, "Ran (seriously) out of data > for Diff frame.\n"); > + return AVERROR_INVALIDDATA; > + } > + diff_count = bytestream_get_be16(&buf); > + buf += 8; /* clip rect? */ > + for (i = 0; i < diff_count; i++) { > + int16_t top, left; > + uint16_t diff_size, width, height; > + > + if (buf + 16 > eod) { > + av_log(avctx, AV_LOG_WARNING, "Ran (seriously) out of > data for Diff frame header.\n"); > + return AVERROR_INVALIDDATA; > + } > + > + top = bytestream_get_be16(&buf); > + left = bytestream_get_be16(&buf); > + buf += 4; /* bottom, right */ > + diff_size = bytestream_get_be32(&buf); > + width = bytestream_get_be16(&buf); > + height = bytestream_get_be16(&buf); > + if (diff_size < 4 || diff_size - 4 > eod - buf) { > + av_log(avctx, AV_LOG_WARNING, "Ran (seriously) out of > data for Diff frame data.\n"); > + return AVERROR_INVALIDDATA; > + } > + if (cdtoons_render_sprite(avctx, buf + 4, diff_size - 8, > + left, top, width, height)) { > + av_log(avctx, AV_LOG_WARNING, "Ran beyond end of sprite > while rendering.\n"); > + } > + buf += diff_size - 4; > + } > + saw_embedded_sprites = 1; > + } else { > + /* we don't care about any other entries */ > + if (size < 8 || size - 8 > eod - buf) { > + av_log(avctx, AV_LOG_WARNING, "Ran out of data for ignored > entry (size %d, %d left).\n", size, (int)(eod - buf)); > + return AVERROR_INVALIDDATA; > + } > + buf += (size - 8); > + } > + } > + > + /* was an intra frame? */ > + if (saw_embedded_sprites) > + goto done; > + > + /* render any referenced sprites */ > + buf = avpkt->data + CDTOONS_HEADER_SIZE; > + eod = avpkt->data + sprite_offset; > + for (i = 0; i < referenced_count; i++) { > + const uint8_t *block_data; > + uint16_t sprite_id, width, height; > + int16_t top, left, right; > + > + if (buf + 10 > eod) { > + av_log(avctx, AV_LOG_WARNING, "Ran (seriously) out of data when > rendering.\n"); > + return AVERROR_INVALIDDATA; > + } > + > + sprite_id = bytestream_get_be16(&buf); > + top = bytestream_get_be16(&buf); > + left = bytestream_get_be16(&buf); > + buf += 2; /* bottom */ > + right = bytestream_get_be16(&buf); > + > + if ((i == 0) && (sprite_id == 0)) { > + /* clear background */ > + memset(c->frame->data[0], background_color, > + c->frame->linesize[0] * avctx->height); > + } > + > + if (!right) > + continue; > + block_data = c->sprites[sprite_id].data; > + if (!block_data) { > + /* this can happen when seeking around */ > + av_log(avctx, AV_LOG_WARNING, "Sprite %d is missing.\n", > sprite_id); > + continue; > + } > + if (c->sprites[sprite_id].size < 14) { > + av_log(avctx, AV_LOG_ERROR, "Sprite %d is too small.\n", > sprite_id); > + continue; > + } > + > + height = bytestream_get_be16(&block_data); > + width = bytestream_get_be16(&block_data); > + block_data += 10; > + if (cdtoons_render_sprite(avctx, block_data, > + c->sprites[sprite_id].size - 14, > + left, top, width, height)) { > + av_log(avctx, AV_LOG_WARNING, "Ran beyond end of sprite while > rendering.\n"); > + } > + } > + > + if (palette_id && (palette_id != c->last_pal_id)) { > + if (palette_id >= CDTOONS_MAX_SPRITES) { > + av_log(avctx, AV_LOG_ERROR, > + "Palette ID %d is too high.\n", palette_id); > + return AVERROR_INVALIDDATA; > + } > + if (!c->sprites[palette_id].data) { > + /* this can happen when seeking around */ > + av_log(avctx, AV_LOG_WARNING, > + "Palette ID %d is missing.\n", palette_id); > + goto done; > + } > + if (c->sprites[palette_id].size != 256 * 2 * 3) { > + av_log(avctx, AV_LOG_ERROR, > + "Palette ID %d is wrong size (%d).\n", > + palette_id, c->sprites[palette_id].size); > + return AVERROR_INVALIDDATA; > + } > + c->last_pal_id = palette_id; > + if (!palette_set) { > + uint8_t *palette_data = c->sprites[palette_id].data; > + for (i = 0; i < 256; i++) { > + /* QuickTime-ish palette: 16-bit RGB components */ > + uint8_t r, g, b; > + r = *palette_data; > + g = *(palette_data + 2); > + b = *(palette_data + 4); > + c->pal[i] = (0xff << 24) | (r << 16) | (g << 8) | (b); > + palette_data += 6; > + } > + /* first palette entry indicates transparency */ > + c->pal[0] = 0; > + c->frame->palette_has_changed = 1; > + } > + } > + Is this safe regarding overreads? If not, use bytestream2 instead. > +done: > + /* discard outdated blocks */ > + for (i = 0; i < CDTOONS_MAX_SPRITES; i++) { > + if (c->sprites[i].end_frame > frame_id) > + continue; > + av_free(c->sprites[i].data); > + c->sprites[i].data = NULL; > + } > + > + memcpy(c->frame->data[1], c->pal, AVPALETTE_SIZE); > + > + if ((ret = av_frame_ref(data, c->frame)) < 0) > + return ret; > + > + *got_frame = 1; > + > + /* always report that the buffer was completely consumed */ > + return buf_size; > +} > + > +static av_cold int cdtoons_decode_init(AVCodecContext *avctx) > +{ > + CDToonsContext *c = avctx->priv_data; > + > + c->avctx = avctx; > + avctx->pix_fmt = AV_PIX_FMT_PAL8; > + c->last_pal_id = 0; > + c->frame = av_frame_alloc(); > + if (!c->frame) > + return AVERROR(ENOMEM); > + memset(c->sprites, 0, sizeof(c->sprites)); > + > + return 0; > +} > + > +static void cdtoons_flush(AVCodecContext *avctx) > +{ > + CDToonsContext *c = avctx->priv_data; > + int i; > + > + c->last_pal_id = 0; > + for (i = 0; i < CDTOONS_MAX_SPRITES; i++) { > + av_free(c->sprites[i].data); > + c->sprites[i].data = NULL; > + } > +} > + > +static av_cold int cdtoons_decode_end(AVCodecContext *avctx) > +{ > + CDToonsContext *c = avctx->priv_data; > + int i; > + > + for (i = 0; i < CDTOONS_MAX_SPRITES; i++) > + av_free(c->sprites[i].data); > + > + av_frame_free(&c->frame); > + > + return 0; > +} > + > +AVCodec ff_cdtoons_decoder = { > + .name = "cdtoons", > + .long_name = NULL_IF_CONFIG_SMALL("CDToons"), > + .type = AVMEDIA_TYPE_VIDEO, > + .id = AV_CODEC_ID_CDTOONS, > + .priv_data_size = sizeof(CDToonsContext), > + .init = cdtoons_decode_init, > + .close = cdtoons_decode_end, > + .decode = cdtoons_decode_frame, > + .capabilities = AV_CODEC_CAP_DR1, > + .flush = cdtoons_flush, > +}; > diff --git a/libavcodec/codec_desc.c b/libavcodec/codec_desc.c > index 529b838e5b..55003ab1d7 100644 > --- a/libavcodec/codec_desc.c > +++ b/libavcodec/codec_desc.c > @@ -1747,6 +1747,13 @@ static const AVCodecDescriptor codec_descriptors[] = > { > .long_name = NULL_IF_CONFIG_SMALL("MidiVid Archive Codec"), > .props = AV_CODEC_PROP_INTRA_ONLY | AV_CODEC_PROP_LOSSY, > }, > + { > + .id = AV_CODEC_ID_CDTOONS, > + .type = AVMEDIA_TYPE_VIDEO, > + .name = "cdtoons", > + .long_name = NULL_IF_CONFIG_SMALL("CDToons video"), > + .props = AV_CODEC_PROP_LOSSLESS, > + }, > > /* various PCM "codecs" */ > { > diff --git a/libavcodec/version.h b/libavcodec/version.h > index 77da913df0..1a88432460 100644 > --- a/libavcodec/version.h > +++ b/libavcodec/version.h > @@ -29,7 +29,7 @@ > > #define LIBAVCODEC_VERSION_MAJOR 58 > #define LIBAVCODEC_VERSION_MINOR 65 > -#define LIBAVCODEC_VERSION_MICRO 102 > +#define LIBAVCODEC_VERSION_MICRO 103 > > #define LIBAVCODEC_VERSION_INT AV_VERSION_INT(LIBAVCODEC_VERSION_MAJOR, \ > LIBAVCODEC_VERSION_MINOR, \ > diff --git a/libavformat/isom.c b/libavformat/isom.c > index 824e811177..eefe9277b4 100644 > --- a/libavformat/isom.c > +++ b/libavformat/isom.c > @@ -158,6 +158,7 @@ const AVCodecTag ff_codec_movvideo_tags[] = { > { AV_CODEC_ID_SGIRLE, MKTAG('r', 'l', 'e', '1') }, /* SGI RLE 8-bit */ > { AV_CODEC_ID_MSRLE, MKTAG('W', 'R', 'L', 'E') }, > { AV_CODEC_ID_QDRAW, MKTAG('q', 'd', 'r', 'w') }, /* QuickDraw */ > + { AV_CODEC_ID_CDTOONS, MKTAG('Q', 'k', 'B', 'k') }, /* CDToons */ > > { AV_CODEC_ID_RAWVIDEO, MKTAG('W', 'R', 'A', 'W') }, > > diff --git a/libavformat/riff.c b/libavformat/riff.c > index c73f6e9db0..560a3aa208 100644 > --- a/libavformat/riff.c > +++ b/libavformat/riff.c > @@ -491,6 +491,7 @@ const AVCodecTag ff_codec_bmp_tags[] = { > { AV_CODEC_ID_IMM5, MKTAG('I', 'M', 'M', '5') }, > { AV_CODEC_ID_MVDV, MKTAG('M', 'V', 'D', 'V') }, > { AV_CODEC_ID_MVHA, MKTAG('M', 'V', 'H', 'A') }, > + { AV_CODEC_ID_CDTOONS, MKTAG('Q', 'k', 'B', 'k') }, > { AV_CODEC_ID_NONE, 0 } > }; > > -- > 2.17.1 > > _______________________________________________ > ffmpeg-devel mailing list > ffmpeg-devel@ffmpeg.org > https://ffmpeg.org/mailman/listinfo/ffmpeg-devel > > To unsubscribe, visit link above, or email > ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
What's status of this? On 1/5/20, Alyssa Milburn <amilburn@zall.org> wrote: > This adds a decoder for Broderbund's sprite-based QuickTime CDToons > codec, based on the decoder I wrote for ScummVM. > > A couple of samples can be found at http://noopwafel.net/cdtoons/. > If you do not plan on sending updated patch, i would happy to finish this patch so it can be pushed to master.
diff --git a/Changelog b/Changelog index b9401aaab6..9cac485bb5 100644 --- a/Changelog +++ b/Changelog @@ -29,6 +29,7 @@ version <next>: - mvha decoder - MPEG-H 3D Audio support in mp4 - thistogram filter +- CDToons decoder version 4.2: diff --git a/doc/general.texi b/doc/general.texi index a5b77e0de1..8fdf8af9fe 100644 --- a/doc/general.texi +++ b/doc/general.texi @@ -844,6 +844,8 @@ following image formats are supported: @tab Codec used in Delphine Software International games. @item Discworld II BMV Video @tab @tab X @item Canopus Lossless Codec @tab @tab X +@item CDToons @tab @tab X + @tab Codec used in various Broderbund games. @item Cinepak @tab @tab X @item Cirrus Logic AccuPak @tab X @tab X @tab fourcc: CLJR diff --git a/libavcodec/Makefile b/libavcodec/Makefile index c1f35b40d8..383a6da32d 100644 --- a/libavcodec/Makefile +++ b/libavcodec/Makefile @@ -244,6 +244,7 @@ OBJS-$(CONFIG_CAVS_DECODER) += cavs.o cavsdec.o cavsdsp.o \ cavsdata.o OBJS-$(CONFIG_CCAPTION_DECODER) += ccaption_dec.o ass.o OBJS-$(CONFIG_CDGRAPHICS_DECODER) += cdgraphics.o +OBJS-$(CONFIG_CDTOONS_DECODER) += cdtoons.o OBJS-$(CONFIG_CDXL_DECODER) += cdxl.o OBJS-$(CONFIG_CFHD_DECODER) += cfhd.o cfhddata.o OBJS-$(CONFIG_CINEPAK_DECODER) += cinepak.o diff --git a/libavcodec/allcodecs.c b/libavcodec/allcodecs.c index ec7366144f..a87f29829d 100644 --- a/libavcodec/allcodecs.c +++ b/libavcodec/allcodecs.c @@ -68,6 +68,7 @@ extern AVCodec ff_brender_pix_decoder; extern AVCodec ff_c93_decoder; extern AVCodec ff_cavs_decoder; extern AVCodec ff_cdgraphics_decoder; +extern AVCodec ff_cdtoons_decoder; extern AVCodec ff_cdxl_decoder; extern AVCodec ff_cfhd_decoder; extern AVCodec ff_cinepak_encoder; diff --git a/libavcodec/avcodec.h b/libavcodec/avcodec.h index 119b32dc1f..e9a24165ed 100644 --- a/libavcodec/avcodec.h +++ b/libavcodec/avcodec.h @@ -460,6 +460,7 @@ enum AVCodecID { AV_CODEC_ID_IMM5, AV_CODEC_ID_MVDV, AV_CODEC_ID_MVHA, + AV_CODEC_ID_CDTOONS, /* various PCM "codecs" */ AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs diff --git a/libavcodec/cdtoons.c b/libavcodec/cdtoons.c new file mode 100644 index 0000000000..d6c441b8e3 --- /dev/null +++ b/libavcodec/cdtoons.c @@ -0,0 +1,438 @@ +/* + * CDToons video decoder + * Copyright (C) 2011 The FFmpeg project + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +/** + * @file + * CDToons video decoder + * @author Alyssa Milburn <amilburn@zall.org> + */ + +#include <stdint.h> + +#include "libavutil/attributes.h" +#include "libavutil/internal.h" +#include "avcodec.h" +#include "bytestream.h" +#include "internal.h" + +#define CDTOONS_HEADER_SIZE 44 +#define CDTOONS_MAX_SPRITES 1200 + +typedef struct CDToonsSprite { + uint16_t flags; + uint16_t owner_frame; + uint16_t start_frame; + uint16_t end_frame; + uint32_t size; + uint8_t *data; +} CDToonsSprite; + +typedef struct CDToonsContext { + AVCodecContext *avctx; + AVFrame *frame; + + uint16_t last_pal_id; ///< The index of the active palette sprite. + uint32_t pal[256]; ///< The currently-used palette data. + CDToonsSprite sprites[CDTOONS_MAX_SPRITES]; +} CDToonsContext; + +static int cdtoons_render_sprite(AVCodecContext *avctx, const uint8_t *data, + uint32_t data_size, + int dst_x, int dst_y, int width, int height) +{ + CDToonsContext *c = avctx->priv_data; + const uint8_t *next_line = data; + uint16_t line_size; + uint8_t *dest; + int skip = 0, to_skip, x; + + if (dst_x + width > avctx->width) + width = avctx->width - dst_x; + if (dst_y + height > avctx->height) + height = avctx->height - dst_y; + + if (dst_x < 0) { + /* we need to skip the start of the scanlines */ + skip = -dst_x; + if (width <= skip) + return 0; + dst_x = 0; + } + + for (int y = 0; y < height; y++) { + /* one scanline at a time, size is provided */ + data = next_line; + line_size = bytestream_get_be16(&data); + next_line = data + line_size; + if (dst_y + y < 0) + continue; + + dest = c->frame->data[0] + (dst_y + y) * c->frame->linesize[0] + dst_x; + + to_skip = skip; + x = 0; + while (x < width - skip) { + uint8_t val = bytestream_get_byte(&data); + int raw = !(val & 0x80); + int size = (int)(val & 0x7F) + 1; + + /* skip the start of a scanline if it is off-screen */ + if (to_skip >= size) { + to_skip -= size; + if (raw) { + data += size; + } else { + data += 1; + } + if (data > next_line) + return 1; + continue; + } else if (to_skip) { + size -= to_skip; + if (raw) + data += to_skip; + to_skip = 0; + if (data > next_line) + return 1; + } + + if (x + size >= width - skip) + size = width - skip - x; + + /* either raw data, or a run of a single color */ + if (raw) { + memcpy(dest + x, data, size); + data += size; + if (data > next_line) + return 1; + } else { + uint8_t color = bytestream_get_byte(&data); + /* ignore transparent runs */ + if (color) + memset(dest + x, color, size); + } + x += size; + } + } + + return 0; +} + +static int cdtoons_decode_frame(AVCodecContext *avctx, void *data, + int *got_frame, AVPacket *avpkt) +{ + CDToonsContext *c = avctx->priv_data; + const uint8_t *buf = avpkt->data; + const uint8_t *eod = avpkt->data + avpkt->size; + int buf_size = avpkt->size; + uint16_t frame_id; + uint8_t background_color; + uint16_t sprite_count, sprite_offset; + uint8_t referenced_count; + uint16_t palette_id; + uint8_t palette_set; + int ret, i; + int saw_embedded_sprites = 0; + + if (buf_size < CDTOONS_HEADER_SIZE) + return AVERROR_INVALIDDATA; + + if ((ret = ff_reget_buffer(avctx, c->frame, 0))) { + av_log(avctx, AV_LOG_ERROR, "reget_buffer() failed\n"); + return ret; + } + + /* a lot of the header is useless junk in the absence of + * dirty rectangling etc */ + buf += 2; /* version? (always 9?) */ + frame_id = bytestream_get_be16(&buf); + buf += 2; /* blocks_valid_until */ + buf += 1; + background_color = bytestream_get_byte(&buf); + buf += 16; /* clip rect, dirty rect */ + buf += 4; /* flags */ + sprite_count = bytestream_get_be16(&buf); + sprite_offset = bytestream_get_be16(&buf); + buf += 2; /* max block id? */ + referenced_count = bytestream_get_byte(&buf); + buf += 1; + palette_id = bytestream_get_be16(&buf); + palette_set = bytestream_get_byte(&buf); + buf += 5; + + /* read new sprites introduced in this frame */ + buf = avpkt->data + sprite_offset; + while (sprite_count--) { + uint32_t size; + uint16_t sprite_id; + + if (buf + 14 > eod) + return AVERROR_INVALIDDATA; + + sprite_id = bytestream_get_be16(&buf); + if (sprite_id >= CDTOONS_MAX_SPRITES) { + av_log(avctx, AV_LOG_ERROR, + "Sprite ID %d is too high.\n", sprite_id); + return AVERROR_INVALIDDATA; + } + if (c->sprites[sprite_id].data) { + av_log(avctx, AV_LOG_ERROR, + "Sprite ID %d is a duplicate.\n", sprite_id); + return AVERROR_INVALIDDATA; + } + + c->sprites[sprite_id].flags = bytestream_get_be16(&buf); + size = bytestream_get_be32(&buf); + if (size < 14) { + av_log(avctx, AV_LOG_ERROR, + "Sprite only has %d bytes of data.\n", size); + return AVERROR_INVALIDDATA; + } + size -= 14; + c->sprites[sprite_id].size = size; + c->sprites[sprite_id].owner_frame = frame_id; + c->sprites[sprite_id].start_frame = bytestream_get_be16(&buf); + c->sprites[sprite_id].end_frame = bytestream_get_be16(&buf); + buf += 2; + + if (size > buf_size || buf + size > eod) + return AVERROR_INVALIDDATA; + + c->sprites[sprite_id].data = av_malloc(size); + if (!c->sprites[sprite_id].data) + return AVERROR(ENOMEM); + + bytestream_get_buffer(&buf, c->sprites[sprite_id].data, size); + } + + /* render any embedded sprites */ + while (buf < eod) { + uint32_t tag, size; + if (buf + 8 > eod) { + av_log(avctx, AV_LOG_WARNING, "Ran (seriously) out of data for embedded sprites.\n"); + return AVERROR_INVALIDDATA; + } + tag = bytestream_get_be32(&buf); + size = bytestream_get_be32(&buf); + if (tag == MKBETAG('D', 'i', 'f', 'f')) { + uint16_t diff_count; + if (buf + 10 > eod) { + av_log(avctx, AV_LOG_WARNING, "Ran (seriously) out of data for Diff frame.\n"); + return AVERROR_INVALIDDATA; + } + diff_count = bytestream_get_be16(&buf); + buf += 8; /* clip rect? */ + for (i = 0; i < diff_count; i++) { + int16_t top, left; + uint16_t diff_size, width, height; + + if (buf + 16 > eod) { + av_log(avctx, AV_LOG_WARNING, "Ran (seriously) out of data for Diff frame header.\n"); + return AVERROR_INVALIDDATA; + } + + top = bytestream_get_be16(&buf); + left = bytestream_get_be16(&buf); + buf += 4; /* bottom, right */ + diff_size = bytestream_get_be32(&buf); + width = bytestream_get_be16(&buf); + height = bytestream_get_be16(&buf); + if (diff_size < 4 || diff_size - 4 > eod - buf) { + av_log(avctx, AV_LOG_WARNING, "Ran (seriously) out of data for Diff frame data.\n"); + return AVERROR_INVALIDDATA; + } + if (cdtoons_render_sprite(avctx, buf + 4, diff_size - 8, + left, top, width, height)) { + av_log(avctx, AV_LOG_WARNING, "Ran beyond end of sprite while rendering.\n"); + } + buf += diff_size - 4; + } + saw_embedded_sprites = 1; + } else { + /* we don't care about any other entries */ + if (size < 8 || size - 8 > eod - buf) { + av_log(avctx, AV_LOG_WARNING, "Ran out of data for ignored entry (size %d, %d left).\n", size, (int)(eod - buf)); + return AVERROR_INVALIDDATA; + } + buf += (size - 8); + } + } + + /* was an intra frame? */ + if (saw_embedded_sprites) + goto done; + + /* render any referenced sprites */ + buf = avpkt->data + CDTOONS_HEADER_SIZE; + eod = avpkt->data + sprite_offset; + for (i = 0; i < referenced_count; i++) { + const uint8_t *block_data; + uint16_t sprite_id, width, height; + int16_t top, left, right; + + if (buf + 10 > eod) { + av_log(avctx, AV_LOG_WARNING, "Ran (seriously) out of data when rendering.\n"); + return AVERROR_INVALIDDATA; + } + + sprite_id = bytestream_get_be16(&buf); + top = bytestream_get_be16(&buf); + left = bytestream_get_be16(&buf); + buf += 2; /* bottom */ + right = bytestream_get_be16(&buf); + + if ((i == 0) && (sprite_id == 0)) { + /* clear background */ + memset(c->frame->data[0], background_color, + c->frame->linesize[0] * avctx->height); + } + + if (!right) + continue; + block_data = c->sprites[sprite_id].data; + if (!block_data) { + /* this can happen when seeking around */ + av_log(avctx, AV_LOG_WARNING, "Sprite %d is missing.\n", sprite_id); + continue; + } + if (c->sprites[sprite_id].size < 14) { + av_log(avctx, AV_LOG_ERROR, "Sprite %d is too small.\n", sprite_id); + continue; + } + + height = bytestream_get_be16(&block_data); + width = bytestream_get_be16(&block_data); + block_data += 10; + if (cdtoons_render_sprite(avctx, block_data, + c->sprites[sprite_id].size - 14, + left, top, width, height)) { + av_log(avctx, AV_LOG_WARNING, "Ran beyond end of sprite while rendering.\n"); + } + } + + if (palette_id && (palette_id != c->last_pal_id)) { + if (palette_id >= CDTOONS_MAX_SPRITES) { + av_log(avctx, AV_LOG_ERROR, + "Palette ID %d is too high.\n", palette_id); + return AVERROR_INVALIDDATA; + } + if (!c->sprites[palette_id].data) { + /* this can happen when seeking around */ + av_log(avctx, AV_LOG_WARNING, + "Palette ID %d is missing.\n", palette_id); + goto done; + } + if (c->sprites[palette_id].size != 256 * 2 * 3) { + av_log(avctx, AV_LOG_ERROR, + "Palette ID %d is wrong size (%d).\n", + palette_id, c->sprites[palette_id].size); + return AVERROR_INVALIDDATA; + } + c->last_pal_id = palette_id; + if (!palette_set) { + uint8_t *palette_data = c->sprites[palette_id].data; + for (i = 0; i < 256; i++) { + /* QuickTime-ish palette: 16-bit RGB components */ + uint8_t r, g, b; + r = *palette_data; + g = *(palette_data + 2); + b = *(palette_data + 4); + c->pal[i] = (0xff << 24) | (r << 16) | (g << 8) | (b); + palette_data += 6; + } + /* first palette entry indicates transparency */ + c->pal[0] = 0; + c->frame->palette_has_changed = 1; + } + } + +done: + /* discard outdated blocks */ + for (i = 0; i < CDTOONS_MAX_SPRITES; i++) { + if (c->sprites[i].end_frame > frame_id) + continue; + av_free(c->sprites[i].data); + c->sprites[i].data = NULL; + } + + memcpy(c->frame->data[1], c->pal, AVPALETTE_SIZE); + + if ((ret = av_frame_ref(data, c->frame)) < 0) + return ret; + + *got_frame = 1; + + /* always report that the buffer was completely consumed */ + return buf_size; +} + +static av_cold int cdtoons_decode_init(AVCodecContext *avctx) +{ + CDToonsContext *c = avctx->priv_data; + + c->avctx = avctx; + avctx->pix_fmt = AV_PIX_FMT_PAL8; + c->last_pal_id = 0; + c->frame = av_frame_alloc(); + if (!c->frame) + return AVERROR(ENOMEM); + memset(c->sprites, 0, sizeof(c->sprites)); + + return 0; +} + +static void cdtoons_flush(AVCodecContext *avctx) +{ + CDToonsContext *c = avctx->priv_data; + int i; + + c->last_pal_id = 0; + for (i = 0; i < CDTOONS_MAX_SPRITES; i++) { + av_free(c->sprites[i].data); + c->sprites[i].data = NULL; + } +} + +static av_cold int cdtoons_decode_end(AVCodecContext *avctx) +{ + CDToonsContext *c = avctx->priv_data; + int i; + + for (i = 0; i < CDTOONS_MAX_SPRITES; i++) + av_free(c->sprites[i].data); + + av_frame_free(&c->frame); + + return 0; +} + +AVCodec ff_cdtoons_decoder = { + .name = "cdtoons", + .long_name = NULL_IF_CONFIG_SMALL("CDToons"), + .type = AVMEDIA_TYPE_VIDEO, + .id = AV_CODEC_ID_CDTOONS, + .priv_data_size = sizeof(CDToonsContext), + .init = cdtoons_decode_init, + .close = cdtoons_decode_end, + .decode = cdtoons_decode_frame, + .capabilities = AV_CODEC_CAP_DR1, + .flush = cdtoons_flush, +}; diff --git a/libavcodec/codec_desc.c b/libavcodec/codec_desc.c index 529b838e5b..55003ab1d7 100644 --- a/libavcodec/codec_desc.c +++ b/libavcodec/codec_desc.c @@ -1747,6 +1747,13 @@ static const AVCodecDescriptor codec_descriptors[] = { .long_name = NULL_IF_CONFIG_SMALL("MidiVid Archive Codec"), .props = AV_CODEC_PROP_INTRA_ONLY | AV_CODEC_PROP_LOSSY, }, + { + .id = AV_CODEC_ID_CDTOONS, + .type = AVMEDIA_TYPE_VIDEO, + .name = "cdtoons", + .long_name = NULL_IF_CONFIG_SMALL("CDToons video"), + .props = AV_CODEC_PROP_LOSSLESS, + }, /* various PCM "codecs" */ { diff --git a/libavcodec/version.h b/libavcodec/version.h index 77da913df0..1a88432460 100644 --- a/libavcodec/version.h +++ b/libavcodec/version.h @@ -29,7 +29,7 @@ #define LIBAVCODEC_VERSION_MAJOR 58 #define LIBAVCODEC_VERSION_MINOR 65 -#define LIBAVCODEC_VERSION_MICRO 102 +#define LIBAVCODEC_VERSION_MICRO 103 #define LIBAVCODEC_VERSION_INT AV_VERSION_INT(LIBAVCODEC_VERSION_MAJOR, \ LIBAVCODEC_VERSION_MINOR, \ diff --git a/libavformat/isom.c b/libavformat/isom.c index 824e811177..eefe9277b4 100644 --- a/libavformat/isom.c +++ b/libavformat/isom.c @@ -158,6 +158,7 @@ const AVCodecTag ff_codec_movvideo_tags[] = { { AV_CODEC_ID_SGIRLE, MKTAG('r', 'l', 'e', '1') }, /* SGI RLE 8-bit */ { AV_CODEC_ID_MSRLE, MKTAG('W', 'R', 'L', 'E') }, { AV_CODEC_ID_QDRAW, MKTAG('q', 'd', 'r', 'w') }, /* QuickDraw */ + { AV_CODEC_ID_CDTOONS, MKTAG('Q', 'k', 'B', 'k') }, /* CDToons */ { AV_CODEC_ID_RAWVIDEO, MKTAG('W', 'R', 'A', 'W') }, diff --git a/libavformat/riff.c b/libavformat/riff.c index c73f6e9db0..560a3aa208 100644 --- a/libavformat/riff.c +++ b/libavformat/riff.c @@ -491,6 +491,7 @@ const AVCodecTag ff_codec_bmp_tags[] = { { AV_CODEC_ID_IMM5, MKTAG('I', 'M', 'M', '5') }, { AV_CODEC_ID_MVDV, MKTAG('M', 'V', 'D', 'V') }, { AV_CODEC_ID_MVHA, MKTAG('M', 'V', 'H', 'A') }, + { AV_CODEC_ID_CDTOONS, MKTAG('Q', 'k', 'B', 'k') }, { AV_CODEC_ID_NONE, 0 } };
This adds a decoder for Broderbund's sprite-based QuickTime CDToons codec, based on the decoder I wrote for ScummVM. A couple of samples can be found at http://noopwafel.net/cdtoons/. Signed-off-by: Alyssa Milburn <amilburn@zall.org> --- Changelog | 1 + doc/general.texi | 2 + libavcodec/Makefile | 1 + libavcodec/allcodecs.c | 1 + libavcodec/avcodec.h | 1 + libavcodec/cdtoons.c | 438 ++++++++++++++++++++++++++++++++++++++++ libavcodec/codec_desc.c | 7 + libavcodec/version.h | 2 +- libavformat/isom.c | 1 + libavformat/riff.c | 1 + 10 files changed, 454 insertions(+), 1 deletion(-) create mode 100644 libavcodec/cdtoons.c