FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
tscc.c
Go to the documentation of this file.
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 "internal.h"
43 #include "msrledec.h"
44 
45 #include <zlib.h>
46 
47 typedef struct TsccContext {
48 
51 
52  // Bits per pixel
53  int bpp;
54  // Decompressed data size
55  unsigned int decomp_size;
56  // Decompression buffer
57  unsigned char* decomp_buf;
59  int height;
60  z_stream zstream;
61 
62  uint32_t pal[256];
64 
65 static int decode_frame(AVCodecContext *avctx, void *data, int *got_frame,
66  AVPacket *avpkt)
67 {
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;
72  int ret;
73 
74  if ((ret = ff_reget_buffer(avctx, frame)) < 0)
75  return ret;
76 
77  ret = inflateReset(&c->zstream);
78  if (ret != Z_OK) {
79  av_log(avctx, AV_LOG_ERROR, "Inflate reset error: %d\n", ret);
80  return AVERROR_UNKNOWN;
81  }
82  c->zstream.next_in = buf;
83  c->zstream.avail_in = buf_size;
84  c->zstream.next_out = c->decomp_buf;
85  c->zstream.avail_out = c->decomp_size;
86  ret = inflate(&c->zstream, Z_FINISH);
87  // Z_DATA_ERROR means empty picture
88  if ((ret != Z_OK) && (ret != Z_STREAM_END) && (ret != Z_DATA_ERROR)) {
89  av_log(avctx, AV_LOG_ERROR, "Inflate error: %d\n", ret);
90  return AVERROR_UNKNOWN;
91  }
92 
93 
94  if (ret != Z_DATA_ERROR) {
96  c->decomp_size - c->zstream.avail_out);
97  ff_msrle_decode(avctx, (AVPicture*)frame, c->bpp, &c->gb);
98  }
99 
100  /* make the palette available on the way out */
101  if (c->avctx->pix_fmt == AV_PIX_FMT_PAL8) {
103 
104  if (pal) {
105  frame->palette_has_changed = 1;
106  memcpy(c->pal, pal, AVPALETTE_SIZE);
107  }
108  memcpy(frame->data[1], c->pal, AVPALETTE_SIZE);
109  }
110 
111  if ((ret = av_frame_ref(data, frame)) < 0)
112  return ret;
113  *got_frame = 1;
114 
115  /* always report that the buffer was completely consumed */
116  return buf_size;
117 }
118 
120 {
121  CamtasiaContext * const c = avctx->priv_data;
122  int zret; // Zlib return code
123 
124  c->avctx = avctx;
125 
126  c->height = avctx->height;
127 
128  // Needed if zlib unused or init aborted before inflateInit
129  memset(&c->zstream, 0, sizeof(z_stream));
130  switch(avctx->bits_per_coded_sample){
131  case 8: avctx->pix_fmt = AV_PIX_FMT_PAL8; break;
132  case 16: avctx->pix_fmt = AV_PIX_FMT_RGB555; break;
133  case 24:
134  avctx->pix_fmt = AV_PIX_FMT_BGR24;
135  break;
136  case 32: avctx->pix_fmt = AV_PIX_FMT_0RGB32; break;
137  default: av_log(avctx, AV_LOG_ERROR, "Camtasia error: unknown depth %i bpp\n", avctx->bits_per_coded_sample);
138  return AVERROR_PATCHWELCOME;
139  }
140  c->bpp = avctx->bits_per_coded_sample;
141  // buffer size for RLE 'best' case when 2-byte code precedes each pixel and there may be padding after it too
142  c->decomp_size = (((avctx->width * c->bpp + 7) >> 3) + 3 * avctx->width + 2) * avctx->height + 2;
143 
144  /* Allocate decompression buffer */
145  if (c->decomp_size) {
146  if (!(c->decomp_buf = av_malloc(c->decomp_size))) {
147  av_log(avctx, AV_LOG_ERROR, "Can't allocate decompression buffer.\n");
148  return AVERROR(ENOMEM);
149  }
150  }
151 
152  c->zstream.zalloc = Z_NULL;
153  c->zstream.zfree = Z_NULL;
154  c->zstream.opaque = Z_NULL;
155  zret = inflateInit(&c->zstream);
156  if (zret != Z_OK) {
157  av_log(avctx, AV_LOG_ERROR, "Inflate init error: %d\n", zret);
158  return AVERROR_UNKNOWN;
159  }
160 
161  c->frame = av_frame_alloc();
162 
163  return 0;
164 }
165 
167 {
168  CamtasiaContext * const c = avctx->priv_data;
169 
170  av_freep(&c->decomp_buf);
171  av_frame_free(&c->frame);
172 
173  inflateEnd(&c->zstream);
174 
175  return 0;
176 }
177 
179  .name = "camtasia",
180  .long_name = NULL_IF_CONFIG_SMALL("TechSmith Screen Capture Codec"),
181  .type = AVMEDIA_TYPE_VIDEO,
182  .id = AV_CODEC_ID_TSCC,
183  .priv_data_size = sizeof(CamtasiaContext),
184  .init = decode_init,
185  .close = decode_end,
186  .decode = decode_frame,
187  .capabilities = CODEC_CAP_DR1,
188 };
#define NULL
Definition: coverity.c:32
This structure describes decoded (raw) audio or video data.
Definition: frame.h:171
ptrdiff_t const GLvoid * data
Definition: opengl_enc.c:101
static av_cold int init(AVCodecContext *avctx)
Definition: avrndec.c:35
int size
Definition: avcodec.h:1163
enum AVPixelFormat pix_fmt
Pixel format, see AV_PIX_FMT_xxx.
Definition: avcodec.h:1444
static av_always_inline void bytestream2_init(GetByteContext *g, const uint8_t *buf, int buf_size)
Definition: bytestream.h:131
unsigned char * decomp_buf
Definition: tscc.c:57
Picture data structure.
Definition: avcodec.h:3452
AVCodec.
Definition: avcodec.h:3181
z_stream zstream
Definition: tscc.c:60
if()
Definition: avfilter.c:975
uint8_t
#define av_cold
Definition: attributes.h:74
#define av_malloc(s)
AVFrame * av_frame_alloc(void)
Allocate an AVFrame and set its fields to default values.
Definition: frame.c:135
8 bit with AV_PIX_FMT_RGB32 palette
Definition: pixfmt.h:74
#define AVPALETTE_SIZE
Definition: pixfmt.h:33
int av_frame_ref(AVFrame *dst, const AVFrame *src)
Set up a new reference to the data described by the source frame.
Definition: frame.c:363
static av_cold int decode_init(AVCodecContext *avctx)
Definition: tscc.c:119
#define CODEC_CAP_DR1
Codec uses get_buffer() for allocating buffers and supports custom allocators.
Definition: avcodec.h:789
static AVFrame * frame
uint8_t * data
Definition: avcodec.h:1162
int bits_per_coded_sample
bits per sample/pixel from the demuxer (needed for huffyuv).
Definition: avcodec.h:2720
#define av_log(a,...)
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:176
#define AVERROR(e)
Definition: error.h:43
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:148
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:175
const char * name
Name of the codec implementation.
Definition: avcodec.h:3188
Libavcodec external API header.
AVCodecContext * avctx
Definition: tscc.c:49
GetByteContext gb
Definition: tscc.c:58
int ff_reget_buffer(AVCodecContext *avctx, AVFrame *frame)
Identical in function to av_frame_make_writable(), except it uses ff_get_buffer() to allocate the buf...
Definition: utils.c:1082
AVCodec ff_tscc_decoder
Definition: tscc.c:178
ret
Definition: avfilter.c:974
int width
picture width / height.
Definition: avcodec.h:1414
packed RGB 8:8:8, 24bpp, BGRBGR...
Definition: pixfmt.h:66
#define AVERROR_PATCHWELCOME
Not yet implemented in FFmpeg, patches welcome.
Definition: error.h:62
main external API structure.
Definition: avcodec.h:1241
void * buf
Definition: avisynth_c.h:553
uint32_t pal[256]
Definition: tscc.c:62
int palette_has_changed
Tell user application that palette has changed from previous frame.
Definition: frame.h:377
AVFrame * frame
Definition: tscc.c:50
unsigned int decomp_size
Definition: tscc.c:55
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
Definition: frame.h:182
static int decode(AVCodecContext *avctx, void *data, int *got_sub, AVPacket *avpkt)
Definition: ccaption_dec.c:522
common internal api header.
static double c[64]
#define AV_PIX_FMT_RGB555
Definition: pixfmt.h:352
#define AVERROR_UNKNOWN
Unknown error, typically from an external library.
Definition: error.h:71
void * priv_data
Definition: avcodec.h:1283
int ff_msrle_decode(AVCodecContext *avctx, AVPicture *pic, int depth, GetByteContext *gb)
Decode stream in MS RLE format into frame.
Definition: msrledec.c:249
static av_cold int decode_end(AVCodecContext *avctx)
Definition: tscc.c:166
int height
Definition: tscc.c:59
#define av_freep(p)
uint8_t * av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type, int *size)
Get side information from packet.
Definition: avpacket.c:324
This structure stores compressed data.
Definition: avcodec.h:1139
static int decode_frame(AVCodecContext *avctx, void *data, int *got_frame, AVPacket *avpkt)
Definition: tscc.c:65
#define AV_PIX_FMT_0RGB32
Definition: pixfmt.h:345