FFmpeg coverage

GCC Code Coverage Report

Directory:	../../../ffmpeg/		Exec	Total	Coverage
File:	src/libavcodec/tscc.c	Lines:	54	72	75.0 %
Date:	2021-04-15 16:04:23	Branches:	19	35	54.3 %


/*
 * TechSmith Camtasia decoder
 * Copyright (c) 2004 Konstantin Shishkov
 *
 * 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
 * TechSmith Camtasia decoder
 *
 * Fourcc: TSCC
 *
 * Codec is very simple:
 *  it codes picture (picture difference, really)
 *  with algorithm almost identical to Windows RLE8,
 *  only without padding and with greater pixel sizes,
 *  then this coded picture is packed with ZLib
 *
 * Supports: BGR8,BGR555,BGR24 - only BGR8 and BGR555 tested
 */

#include <stdio.h>
#include <stdlib.h>

#include "avcodec.h"
#include "decode.h"
#include "internal.h"
#include "msrledec.h"

#include <zlib.h>

typedef struct TsccContext {

    AVCodecContext *avctx;
    AVFrame *frame;

    // Bits per pixel
    int bpp;
    // Decompressed data size
    unsigned int decomp_size;
    // Decompression buffer
    unsigned char* decomp_buf;
    GetByteContext gb;
    int height;
    z_stream zstream;

    uint32_t pal[256];
} CamtasiaContext;

static int decode_frame(AVCodecContext *avctx, void *data, int *got_frame,
                        AVPacket *avpkt)
{
    const uint8_t *buf = avpkt->data;
    int buf_size = avpkt->size;
    CamtasiaContext * const c = avctx->priv_data;
    AVFrame *frame = c->frame;
    int ret;
    int palette_has_changed = 0;

    if (c->avctx->pix_fmt == AV_PIX_FMT_PAL8) {
        palette_has_changed = ff_copy_palette(c->pal, avpkt, avctx);
    }

    ret = inflateReset(&c->zstream);
    if (ret != Z_OK) {
        av_log(avctx, AV_LOG_ERROR, "Inflate reset error: %d\n", ret);
        return AVERROR_UNKNOWN;
    }
    c->zstream.next_in   = buf;
    c->zstream.avail_in  = buf_size;
    c->zstream.next_out = c->decomp_buf;
    c->zstream.avail_out = c->decomp_size;
    ret = inflate(&c->zstream, Z_FINISH);
    // Z_DATA_ERROR means empty picture
    if (ret == Z_DATA_ERROR && !palette_has_changed) {
        return buf_size;
    }

    if ((ret != Z_OK) && (ret != Z_STREAM_END) && (ret != Z_DATA_ERROR)) {
        av_log(avctx, AV_LOG_ERROR, "Inflate error: %d\n", ret);
        return AVERROR_UNKNOWN;
    }

    if ((ret = ff_reget_buffer(avctx, frame, 0)) < 0)
        return ret;

    if (ret != Z_DATA_ERROR) {
        bytestream2_init(&c->gb, c->decomp_buf,
                         c->decomp_size - c->zstream.avail_out);
        ff_msrle_decode(avctx, frame, c->bpp, &c->gb);
    }

    /* make the palette available on the way out */
    if (c->avctx->pix_fmt == AV_PIX_FMT_PAL8) {
        frame->palette_has_changed = palette_has_changed;
        memcpy(frame->data[1], c->pal, AVPALETTE_SIZE);
    }

    if ((ret = av_frame_ref(data, frame)) < 0)
        return ret;
    *got_frame      = 1;

    /* always report that the buffer was completely consumed */
    return buf_size;
}

static av_cold int decode_init(AVCodecContext *avctx)
{
    CamtasiaContext * const c = avctx->priv_data;
    int zret; // Zlib return code

    c->avctx = avctx;

    c->height = avctx->height;

    // Needed if zlib unused or init aborted before inflateInit
    memset(&c->zstream, 0, sizeof(z_stream));
    switch(avctx->bits_per_coded_sample){
    case  8: avctx->pix_fmt = AV_PIX_FMT_PAL8; break;
    case 16: avctx->pix_fmt = AV_PIX_FMT_RGB555; break;
    case 24:
             avctx->pix_fmt = AV_PIX_FMT_BGR24;
             break;
    case 32: avctx->pix_fmt = AV_PIX_FMT_0RGB32; break;
    default: av_log(avctx, AV_LOG_ERROR, "Camtasia error: unknown depth %i bpp\n", avctx->bits_per_coded_sample);
             return AVERROR_PATCHWELCOME;
    }
    c->bpp = avctx->bits_per_coded_sample;
    // buffer size for RLE 'best' case when 2-byte code precedes each pixel and there may be padding after it too
    c->decomp_size = (((avctx->width * c->bpp + 7) >> 3) + 3 * avctx->width + 2) * avctx->height + 2;

    /* Allocate decompression buffer */
    if (c->decomp_size) {
        if (!(c->decomp_buf = av_malloc(c->decomp_size))) {
            av_log(avctx, AV_LOG_ERROR, "Can't allocate decompression buffer.\n");
            return AVERROR(ENOMEM);
        }
    }

    c->zstream.zalloc = Z_NULL;
    c->zstream.zfree = Z_NULL;
    c->zstream.opaque = Z_NULL;
    zret = inflateInit(&c->zstream);
    if (zret != Z_OK) {
        av_log(avctx, AV_LOG_ERROR, "Inflate init error: %d\n", zret);
        return AVERROR_UNKNOWN;
    }

    c->frame = av_frame_alloc();
    if (!c->frame)
        return AVERROR(ENOMEM);

    return 0;
}

static av_cold int decode_end(AVCodecContext *avctx)
{
    CamtasiaContext * const c = avctx->priv_data;

    av_freep(&c->decomp_buf);
    av_frame_free(&c->frame);

    inflateEnd(&c->zstream);

    return 0;
}

AVCodec ff_tscc_decoder = {
    .name           = "camtasia",
    .long_name      = NULL_IF_CONFIG_SMALL("TechSmith Screen Capture Codec"),
    .type           = AVMEDIA_TYPE_VIDEO,
    .id             = AV_CODEC_ID_TSCC,
    .priv_data_size = sizeof(CamtasiaContext),
    .init           = decode_init,
    .close          = decode_end,
    .decode         = decode_frame,
    .capabilities   = AV_CODEC_CAP_DR1,
    .caps_internal  = FF_CODEC_CAP_INIT_CLEANUP,
};


Generated by: GCOVR (Version 4.2)

Line	Branch	Exec	Source
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			#include <stdio.h>
38			#include <stdlib.h>
39
40			#include "avcodec.h"
41			#include "decode.h"
42			#include "internal.h"
43			#include "msrledec.h"
44
45			#include <zlib.h>
46
47			typedef struct TsccContext {
48
49			AVCodecContext *avctx;
50			AVFrame *frame;
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;
58			GetByteContext gb;
59			int height;
60			z_stream zstream;
61
62			uint32_t pal[256];
63			} CamtasiaContext;
64
65		392	static int decode_frame(AVCodecContext avctx, void data, int *got_frame,
66			AVPacket *avpkt)
67			{
68		392	const uint8_t *buf = avpkt->data;
69		392	int buf_size = avpkt->size;
70		392	CamtasiaContext * const c = avctx->priv_data;
71		392	AVFrame *frame = c->frame;
72			int ret;
73		392	int palette_has_changed = 0;
74
75	✗✓	392	if (c->avctx->pix_fmt == AV_PIX_FMT_PAL8) {
76			palette_has_changed = ff_copy_palette(c->pal, avpkt, avctx);
77			}
78
79		392	ret = inflateReset(&c->zstream);
80	✗✓	392	if (ret != Z_OK) {
81			av_log(avctx, AV_LOG_ERROR, "Inflate reset error: %d\n", ret);
82			return AVERROR_UNKNOWN;
83			}
84		392	c->zstream.next_in = buf;
85		392	c->zstream.avail_in = buf_size;
86		392	c->zstream.next_out = c->decomp_buf;
87		392	c->zstream.avail_out = c->decomp_size;
88		392	ret = inflate(&c->zstream, Z_FINISH);
89			// Z_DATA_ERROR means empty picture
90	✓✓✓✗	392	if (ret == Z_DATA_ERROR && !palette_has_changed) {
91		268	return buf_size;
92			}
93
94	✓✗✓✓ ✓✗	124	if ((ret != Z_OK) && (ret != Z_STREAM_END) && (ret != Z_DATA_ERROR)) {
95		1	av_log(avctx, AV_LOG_ERROR, "Inflate error: %d\n", ret);
96		1	return AVERROR_UNKNOWN;
97			}
98
99	✗✓	123	if ((ret = ff_reget_buffer(avctx, frame, 0)) < 0)
100			return ret;
101
102	✓✗	123	if (ret != Z_DATA_ERROR) {
103		123	bytestream2_init(&c->gb, c->decomp_buf,
104		123	c->decomp_size - c->zstream.avail_out);
105		123	ff_msrle_decode(avctx, frame, c->bpp, &c->gb);
106			}
107
108			/* make the palette available on the way out */
109	✗✓	123	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);
112			}
113
114	✗✓	123	if ((ret = av_frame_ref(data, frame)) < 0)
115			return ret;
116		123	*got_frame = 1;
117
118			/* always report that the buffer was completely consumed */
119		123	return buf_size;
120			}
121
122		4	static av_cold int decode_init(AVCodecContext *avctx)
123			{
124		4	CamtasiaContext * const c = avctx->priv_data;
125			int zret; // Zlib return code
126
127		4	c->avctx = avctx;
128
129		4	c->height = avctx->height;
130
131			// Needed if zlib unused or init aborted before inflateInit
132		4	memset(&c->zstream, 0, sizeof(z_stream));
133	✗✓✗✓ ✗	4	switch(avctx->bits_per_coded_sample){
134			case 8: avctx->pix_fmt = AV_PIX_FMT_PAL8; break;
135		2	case 16: avctx->pix_fmt = AV_PIX_FMT_RGB555; break;
136			case 24:
137			avctx->pix_fmt = AV_PIX_FMT_BGR24;
138			break;
139		2	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;
142			}
143		4	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		4	c->decomp_size = (((avctx->width * c->bpp + 7) >> 3) + 3 * avctx->width + 2) * avctx->height + 2;
146
147			/* Allocate decompression buffer */
148	✓✗	4	if (c->decomp_size) {
149	✗✓	4	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);
152			}
153			}
154
155		4	c->zstream.zalloc = Z_NULL;
156		4	c->zstream.zfree = Z_NULL;
157		4	c->zstream.opaque = Z_NULL;
158		4	zret = inflateInit(&c->zstream);
159	✗✓	4	if (zret != Z_OK) {
160			av_log(avctx, AV_LOG_ERROR, "Inflate init error: %d\n", zret);
161			return AVERROR_UNKNOWN;
162			}
163
164		4	c->frame = av_frame_alloc();
165	✗✓	4	if (!c->frame)
166			return AVERROR(ENOMEM);
167
168		4	return 0;
169			}
170
171		4	static av_cold int decode_end(AVCodecContext *avctx)
172			{
173		4	CamtasiaContext * const c = avctx->priv_data;
174
175		4	av_freep(&c->decomp_buf);
176		4	av_frame_free(&c->frame);
177
178		4	inflateEnd(&c->zstream);
179
180		4	return 0;
181			}
182
183			AVCodec ff_tscc_decoder = {
184			.name = "camtasia",
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),
189			.init = decode_init,
190			.close = decode_end,
191			.decode = decode_frame,
192			.capabilities = AV_CODEC_CAP_DR1,
193			.caps_internal = FF_CODEC_CAP_INIT_CLEANUP,
194			};