ffv1dec: support decoding older 1.3 bitstream variant
[ffmpeg.git] / libavcodec / tscc.c
1 /*
2  * TechSmith Camtasia decoder
3  * Copyright (c) 2004 Konstantin Shishkov
4  *
5  * This file is part of FFmpeg.
6  *
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.
11  *
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.
16  *
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
20  */
21
22 /**
23  * @file
24  * TechSmith Camtasia decoder
25  *
26  * Fourcc: TSCC
27  *
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
33  *
34  * Supports: BGR8,BGR555,BGR24 - only BGR8 and BGR555 tested
35  *
36  */
37
38 #include <stdio.h>
39 #include <stdlib.h>
40
41 #include "avcodec.h"
42 #include "msrledec.h"
43
44 #include <zlib.h>
45
46
47 /*
48  * Decoder context
49  */
50 typedef struct TsccContext {
51
52     AVCodecContext *avctx;
53     AVFrame pic;
54
55     // Bits per pixel
56     int bpp;
57     // Decompressed data size
58     unsigned int decomp_size;
59     // Decompression buffer
60     unsigned char* decomp_buf;
61     GetByteContext gb;
62     int height;
63     z_stream zstream;
64
65     uint32_t pal[256];
66 } CamtasiaContext;
67
68 /*
69  *
70  * Decode a frame
71  *
72  */
73 static int decode_frame(AVCodecContext *avctx, void *data, int *data_size, AVPacket *avpkt)
74 {
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;
81
82     c->pic.reference = 3;
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");
86         return ret;
87     }
88
89     zret = inflateReset(&c->zstream);
90     if (zret != Z_OK) {
91         av_log(avctx, AV_LOG_ERROR, "Inflate reset error: %d\n", zret);
92         return AVERROR(EINVAL);
93     }
94     c->zstream.next_in = 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);
103     }
104
105
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);
110     }
111
112     /* make the palette available on the way out */
113     if (c->avctx->pix_fmt == PIX_FMT_PAL8) {
114         const uint8_t *pal = av_packet_get_side_data(avpkt, AV_PKT_DATA_PALETTE, NULL);
115
116         if (pal) {
117             c->pic.palette_has_changed = 1;
118             memcpy(c->pal, pal, AVPALETTE_SIZE);
119         }
120         memcpy(c->pic.data[1], c->pal, AVPALETTE_SIZE);
121     }
122
123     *data_size = sizeof(AVFrame);
124     *(AVFrame*)data = c->pic;
125
126     /* always report that the buffer was completely consumed */
127     return buf_size;
128 }
129
130
131
132 /*
133  *
134  * Init tscc decoder
135  *
136  */
137 static av_cold int decode_init(AVCodecContext *avctx)
138 {
139     CamtasiaContext * const c = avctx->priv_data;
140     int zret; // Zlib return code
141
142     c->avctx = avctx;
143
144     c->height = avctx->height;
145
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 = PIX_FMT_PAL8; break;
151     case 16: avctx->pix_fmt = PIX_FMT_RGB555; break;
152     case 24:
153              avctx->pix_fmt = PIX_FMT_BGR24;
154              break;
155     case 32: avctx->pix_fmt = 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;
158     }
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;
162
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);
168         }
169     }
170
171     c->zstream.zalloc = Z_NULL;
172     c->zstream.zfree = Z_NULL;
173     c->zstream.opaque = Z_NULL;
174     zret = inflateInit(&c->zstream);
175     if (zret != Z_OK) {
176         av_log(avctx, AV_LOG_ERROR, "Inflate init error: %d\n", zret);
177         return AVERROR(ENOMEM);
178     }
179
180     return 0;
181 }
182
183
184
185 /*
186  *
187  * Uninit tscc decoder
188  *
189  */
190 static av_cold int decode_end(AVCodecContext *avctx)
191 {
192     CamtasiaContext * const c = avctx->priv_data;
193
194     av_freep(&c->decomp_buf);
195
196     if (c->pic.data[0])
197         avctx->release_buffer(avctx, &c->pic);
198     inflateEnd(&c->zstream);
199
200     return 0;
201 }
202
203 AVCodec ff_tscc_decoder = {
204     .name           = "camtasia",
205     .type           = AVMEDIA_TYPE_VIDEO,
206     .id             = AV_CODEC_ID_TSCC,
207     .priv_data_size = sizeof(CamtasiaContext),
208     .init           = decode_init,
209     .close          = decode_end,
210     .decode         = decode_frame,
211     .capabilities   = CODEC_CAP_DR1,
212     .long_name      = NULL_IF_CONFIG_SMALL("TechSmith Screen Capture Codec"),
213 };