2 * TechSmith Camtasia decoder
3 * Copyright (c) 2004 Konstantin Shishkov
5 * This file is part of FFmpeg.
7 * FFmpeg is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * FFmpeg is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with FFmpeg; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
24 * TechSmith Camtasia decoder
28 * Codec is very simple:
29 * it codes picture (picture difference, really)
30 * with algorithm almost identical to Windows RLE8,
31 * only without padding and with greater pixel sizes,
32 * then this coded picture is packed with ZLib
34 * Supports: BGR8,BGR555,BGR24 - only BGR8 and BGR555 tested
47 typedef struct TsccContext {
49 AVCodecContext *avctx;
54 // Decompressed data size
55 unsigned int decomp_size;
56 // Decompression buffer
57 unsigned char* decomp_buf;
65 static int decode_frame(AVCodecContext *avctx, void *data, int *got_frame,
68 const uint8_t *buf = avpkt->data;
69 int buf_size = avpkt->size;
70 CamtasiaContext * const c = avctx->priv_data;
71 AVFrame *frame = c->frame;
73 int palette_has_changed = 0;
75 if (c->avctx->pix_fmt == AV_PIX_FMT_PAL8) {
76 palette_has_changed = ff_copy_palette(c->pal, avpkt, avctx);
79 ret = inflateReset(&c->zstream);
81 av_log(avctx, AV_LOG_ERROR, "Inflate reset error: %d\n", ret);
82 return AVERROR_UNKNOWN;
84 c->zstream.next_in = buf;
85 c->zstream.avail_in = buf_size;
86 c->zstream.next_out = c->decomp_buf;
87 c->zstream.avail_out = c->decomp_size;
88 ret = inflate(&c->zstream, Z_FINISH);
89 // Z_DATA_ERROR means empty picture
90 if (ret == Z_DATA_ERROR && !palette_has_changed) {
94 if ((ret != Z_OK) && (ret != Z_STREAM_END) && (ret != Z_DATA_ERROR)) {
95 av_log(avctx, AV_LOG_ERROR, "Inflate error: %d\n", ret);
96 return AVERROR_UNKNOWN;
99 if ((ret = ff_reget_buffer(avctx, frame, 0)) < 0)
102 if (ret != Z_DATA_ERROR) {
103 bytestream2_init(&c->gb, c->decomp_buf,
104 c->decomp_size - c->zstream.avail_out);
105 ff_msrle_decode(avctx, frame, c->bpp, &c->gb);
108 /* make the palette available on the way out */
109 if (c->avctx->pix_fmt == AV_PIX_FMT_PAL8) {
110 frame->palette_has_changed = palette_has_changed;
111 memcpy(frame->data[1], c->pal, AVPALETTE_SIZE);
114 if ((ret = av_frame_ref(data, frame)) < 0)
118 /* always report that the buffer was completely consumed */
122 static av_cold int decode_init(AVCodecContext *avctx)
124 CamtasiaContext * const c = avctx->priv_data;
125 int zret; // Zlib return code
129 c->height = avctx->height;
131 // Needed if zlib unused or init aborted before inflateInit
132 memset(&c->zstream, 0, sizeof(z_stream));
133 switch(avctx->bits_per_coded_sample){
134 case 8: avctx->pix_fmt = AV_PIX_FMT_PAL8; break;
135 case 16: avctx->pix_fmt = AV_PIX_FMT_RGB555; break;
137 avctx->pix_fmt = AV_PIX_FMT_BGR24;
139 case 32: avctx->pix_fmt = AV_PIX_FMT_0RGB32; break;
140 default: av_log(avctx, AV_LOG_ERROR, "Camtasia error: unknown depth %i bpp\n", avctx->bits_per_coded_sample);
141 return AVERROR_PATCHWELCOME;
143 c->bpp = avctx->bits_per_coded_sample;
144 // buffer size for RLE 'best' case when 2-byte code precedes each pixel and there may be padding after it too
145 c->decomp_size = (((avctx->width * c->bpp + 7) >> 3) + 3 * avctx->width + 2) * avctx->height + 2;
147 /* Allocate decompression buffer */
148 if (c->decomp_size) {
149 if (!(c->decomp_buf = av_malloc(c->decomp_size))) {
150 av_log(avctx, AV_LOG_ERROR, "Can't allocate decompression buffer.\n");
151 return AVERROR(ENOMEM);
155 c->zstream.zalloc = Z_NULL;
156 c->zstream.zfree = Z_NULL;
157 c->zstream.opaque = Z_NULL;
158 zret = inflateInit(&c->zstream);
160 av_log(avctx, AV_LOG_ERROR, "Inflate init error: %d\n", zret);
161 return AVERROR_UNKNOWN;
164 c->frame = av_frame_alloc();
166 return AVERROR(ENOMEM);
171 static av_cold int decode_end(AVCodecContext *avctx)
173 CamtasiaContext * const c = avctx->priv_data;
175 av_freep(&c->decomp_buf);
176 av_frame_free(&c->frame);
178 inflateEnd(&c->zstream);
183 const AVCodec ff_tscc_decoder = {
185 .long_name = NULL_IF_CONFIG_SMALL("TechSmith Screen Capture Codec"),
186 .type = AVMEDIA_TYPE_VIDEO,
187 .id = AV_CODEC_ID_TSCC,
188 .priv_data_size = sizeof(CamtasiaContext),
191 .decode = decode_frame,
192 .capabilities = AV_CODEC_CAP_DR1,
193 .caps_internal = FF_CODEC_CAP_INIT_CLEANUP,