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
50 typedef struct TsccContext {
52 AVCodecContext *avctx;
57 // Decompressed data size
58 unsigned int decomp_size;
59 // Decompression buffer
60 unsigned char* decomp_buf;
73 static int decode_frame(AVCodecContext *avctx, void *data, int *data_size, AVPacket *avpkt)
75 const uint8_t *buf = avpkt->data;
76 int buf_size = avpkt->size;
77 CamtasiaContext * const c = avctx->priv_data;
78 const unsigned char *encoded = buf;
79 int zret; // Zlib return code
80 int ret, len = buf_size;
83 c->pic.buffer_hints = FF_BUFFER_HINTS_VALID;
84 if((ret = avctx->reget_buffer(avctx, &c->pic)) < 0){
85 av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
89 zret = inflateReset(&c->zstream);
91 av_log(avctx, AV_LOG_ERROR, "Inflate reset error: %d\n", zret);
92 return AVERROR(EINVAL);
94 c->zstream.next_in = (uint8_t*)encoded;
95 c->zstream.avail_in = len;
96 c->zstream.next_out = c->decomp_buf;
97 c->zstream.avail_out = c->decomp_size;
98 zret = inflate(&c->zstream, Z_FINISH);
99 // Z_DATA_ERROR means empty picture
100 if ((zret != Z_OK) && (zret != Z_STREAM_END) && (zret != Z_DATA_ERROR)) {
101 av_log(avctx, AV_LOG_ERROR, "Inflate error: %d\n", zret);
102 return AVERROR(EINVAL);
106 if (zret != Z_DATA_ERROR) {
107 bytestream2_init(&c->gb, c->decomp_buf,
108 c->decomp_size - c->zstream.avail_out);
109 ff_msrle_decode(avctx, (AVPicture*)&c->pic, c->bpp, &c->gb);
112 /* make the palette available on the way out */
113 if (c->avctx->pix_fmt == AV_PIX_FMT_PAL8) {
114 const uint8_t *pal = av_packet_get_side_data(avpkt, AV_PKT_DATA_PALETTE, NULL);
117 c->pic.palette_has_changed = 1;
118 memcpy(c->pal, pal, AVPALETTE_SIZE);
120 memcpy(c->pic.data[1], c->pal, AVPALETTE_SIZE);
123 *data_size = sizeof(AVFrame);
124 *(AVFrame*)data = c->pic;
126 /* always report that the buffer was completely consumed */
137 static av_cold int decode_init(AVCodecContext *avctx)
139 CamtasiaContext * const c = avctx->priv_data;
140 int zret; // Zlib return code
144 c->height = avctx->height;
146 avcodec_get_frame_defaults(&c->pic);
147 // Needed if zlib unused or init aborted before inflateInit
148 memset(&c->zstream, 0, sizeof(z_stream));
149 switch(avctx->bits_per_coded_sample){
150 case 8: avctx->pix_fmt = AV_PIX_FMT_PAL8; break;
151 case 16: avctx->pix_fmt = AV_PIX_FMT_RGB555; break;
153 avctx->pix_fmt = AV_PIX_FMT_BGR24;
155 case 32: avctx->pix_fmt = AV_PIX_FMT_RGB32; break;
156 default: av_log(avctx, AV_LOG_ERROR, "Camtasia error: unknown depth %i bpp\n", avctx->bits_per_coded_sample);
157 return AVERROR_PATCHWELCOME;
159 c->bpp = avctx->bits_per_coded_sample;
160 // buffer size for RLE 'best' case when 2-byte code precedes each pixel and there may be padding after it too
161 c->decomp_size = (((avctx->width * c->bpp + 7) >> 3) + 3 * avctx->width + 2) * avctx->height + 2;
163 /* Allocate decompression buffer */
164 if (c->decomp_size) {
165 if ((c->decomp_buf = av_malloc(c->decomp_size)) == NULL) {
166 av_log(avctx, AV_LOG_ERROR, "Can't allocate decompression buffer.\n");
167 return AVERROR(ENOMEM);
171 c->zstream.zalloc = Z_NULL;
172 c->zstream.zfree = Z_NULL;
173 c->zstream.opaque = Z_NULL;
174 zret = inflateInit(&c->zstream);
176 av_log(avctx, AV_LOG_ERROR, "Inflate init error: %d\n", zret);
177 return AVERROR(ENOMEM);
187 * Uninit tscc decoder
190 static av_cold int decode_end(AVCodecContext *avctx)
192 CamtasiaContext * const c = avctx->priv_data;
194 av_freep(&c->decomp_buf);
197 avctx->release_buffer(avctx, &c->pic);
198 inflateEnd(&c->zstream);
203 AVCodec ff_tscc_decoder = {
205 .type = AVMEDIA_TYPE_VIDEO,
206 .id = AV_CODEC_ID_TSCC,
207 .priv_data_size = sizeof(CamtasiaContext),
210 .decode = decode_frame,
211 .capabilities = CODEC_CAP_DR1,
212 .long_name = NULL_IF_CONFIG_SMALL("TechSmith Screen Capture Codec"),