FFmpeg
lclenc.c
Go to the documentation of this file.
1 /*
2  * LCL (LossLess Codec Library) Codec
3  * Copyright (c) 2002-2004 Roberto Togni
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  * LCL (LossLess Codec Library) Video Codec
25  * Decoder for MSZH and ZLIB codecs
26  * Experimental encoder for ZLIB RGB24
27  *
28  * Fourcc: MSZH, ZLIB
29  *
30  * Original Win32 dll:
31  * Ver2.23 By Kenji Oshima 2000.09.20
32  * avimszh.dll, avizlib.dll
33  *
34  * A description of the decoding algorithm can be found here:
35  * http://www.pcisys.net/~melanson/codecs
36  *
37  * Supports: BGR24 (RGB 24bpp)
38  */
39 
40 #include <stdio.h>
41 #include <stdlib.h>
42 
43 #include "libavutil/avassert.h"
44 #include "avcodec.h"
45 #include "codec_internal.h"
46 #include "encode.h"
47 #include "lcl.h"
48 #include "zlib_wrapper.h"
49 #include "libavutil/internal.h"
50 #include "libavutil/mem.h"
51 
52 #include <zlib.h>
53 
54 typedef struct LclEncContext {
55 
57 
58  // Image type
59  int imgtype;
60  // Compression type
62  // Flags
63  int flags;
66 
68  const AVFrame *p, int *got_packet)
69 {
70  LclEncContext *c = avctx->priv_data;
71  z_stream *const zstream = &c->zstream.zstream;
72  int i, ret;
73  int zret; // Zlib return code
74  int max_size = deflateBound(zstream, avctx->width * avctx->height * 3);
75 
76  if ((ret = ff_alloc_packet(avctx, pkt, max_size)) < 0)
77  return ret;
78 
79  if(avctx->pix_fmt != AV_PIX_FMT_BGR24){
80  av_log(avctx, AV_LOG_ERROR, "Format not supported!\n");
81  return -1;
82  }
83 
84  zret = deflateReset(zstream);
85  if (zret != Z_OK) {
86  av_log(avctx, AV_LOG_ERROR, "Deflate reset error: %d\n", zret);
87  return -1;
88  }
89  zstream->next_out = pkt->data;
90  zstream->avail_out = pkt->size;
91 
92  for(i = avctx->height - 1; i >= 0; i--) {
93  zstream->next_in = p->data[0] + p->linesize[0] * i;
94  zstream->avail_in = avctx->width * 3;
95  zret = deflate(zstream, Z_NO_FLUSH);
96  if (zret != Z_OK) {
97  av_log(avctx, AV_LOG_ERROR, "Deflate error: %d\n", zret);
98  return -1;
99  }
100  }
101  zret = deflate(zstream, Z_FINISH);
102  if (zret != Z_STREAM_END) {
103  av_log(avctx, AV_LOG_ERROR, "Deflate error: %d\n", zret);
104  return -1;
105  }
106 
107  pkt->size = zstream->total_out;
108  *got_packet = 1;
109 
110  return 0;
111 }
112 
114 {
115  LclEncContext *c = avctx->priv_data;
116 
117  c->avctx= avctx;
118 
119  av_assert0(avctx->width && avctx->height);
120 
122  if (!avctx->extradata)
123  return AVERROR(ENOMEM);
124 
125  c->compression = avctx->compression_level == FF_COMPRESSION_DEFAULT ?
127  av_clip(avctx->compression_level, 0, 9);
128  c->flags = 0;
129  c->imgtype = IMGTYPE_RGB24;
130  avctx->bits_per_coded_sample= 24;
131 
132  avctx->extradata[0]= 4;
133  avctx->extradata[1]= 0;
134  avctx->extradata[2]= 0;
135  avctx->extradata[3]= 0;
136  avctx->extradata[4]= c->imgtype;
137  avctx->extradata[5]= c->compression;
138  avctx->extradata[6]= c->flags;
139  avctx->extradata[7]= CODEC_ZLIB;
140  c->avctx->extradata_size= 8;
141 
142  return ff_deflate_init(&c->zstream, c->compression, avctx);
143 }
144 
146 {
147  LclEncContext *c = avctx->priv_data;
148 
149  ff_deflate_end(&c->zstream);
150 
151  return 0;
152 }
153 
155  .p.name = "zlib",
156  .p.long_name = NULL_IF_CONFIG_SMALL("LCL (LossLess Codec Library) ZLIB"),
157  .p.type = AVMEDIA_TYPE_VIDEO,
158  .p.id = AV_CODEC_ID_ZLIB,
159  .priv_data_size = sizeof(LclEncContext),
160  .init = encode_init,
162  .close = encode_end,
163  .p.capabilities = AV_CODEC_CAP_FRAME_THREADS,
164  .p.pix_fmts = (const enum AVPixelFormat[]) { AV_PIX_FMT_BGR24, AV_PIX_FMT_NONE },
165  .caps_internal = FF_CODEC_CAP_INIT_CLEANUP,
166 };
AVPixelFormat
AVPixelFormat
Pixel format.
Definition: pixfmt.h:64
av_clip
#define av_clip
Definition: common.h:95
FF_CODEC_CAP_INIT_CLEANUP
#define FF_CODEC_CAP_INIT_CLEANUP
The codec allows calling the close function for deallocation even if the init function returned a fai...
Definition: codec_internal.h:41
AVERROR
Filter the word “frame” indicates either a video frame or a group of audio as stored in an AVFrame structure Format for each input and each output the list of supported formats For video that means pixel format For audio that means channel sample they are references to shared objects When the negotiation mechanism computes the intersection of the formats supported at each end of a all references to both lists are replaced with a reference to the intersection And when a single format is eventually chosen for a link amongst the remaining all references to the list are updated That means that if a filter requires that its input and output have the same format amongst a supported all it has to do is use a reference to the same list of formats query_formats can leave some formats unset and return AVERROR(EAGAIN) to cause the negotiation mechanism toagain later. That can be used by filters with complex requirements to use the format negotiated on one link to set the formats supported on another. Frame references ownership and permissions
CODEC_ZLIB
#define CODEC_ZLIB
Definition: lcl.h:47
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:325
AVPacket::data
uint8_t * data
Definition: packet.h:374
encode.h
FFCodec
Definition: codec_internal.h:118
AV_PIX_FMT_BGR24
@ AV_PIX_FMT_BGR24
packed RGB 8:8:8, 24bpp, BGRBGR...
Definition: pixfmt.h:69
ff_deflate_end
void ff_deflate_end(FFZStream *zstream)
Wrapper around deflateEnd().
FF_COMPRESSION_DEFAULT
#define FF_COMPRESSION_DEFAULT
Definition: avcodec.h:471
AVFrame::data
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
Definition: frame.h:346
lcl.h
init
static int init
Definition: av_tx.c:47
FFCodec::p
AVCodec p
The public AVCodec.
Definition: codec_internal.h:122
LclEncContext::imgtype
int imgtype
Definition: lclenc.c:59
FF_CODEC_ENCODE_CB
#define FF_CODEC_ENCODE_CB(func)
Definition: codec_internal.h:269
avassert.h
pkt
AVPacket * pkt
Definition: movenc.c:59
AV_LOG_ERROR
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:180
zlib_wrapper.h
av_cold
#define av_cold
Definition: attributes.h:90
LclEncContext::flags
int flags
Definition: lclenc.c:63
COMP_ZLIB_NORMAL
#define COMP_ZLIB_NORMAL
Definition: lcl.h:39
av_assert0
#define av_assert0(cond)
assert() equivalent, that is always enabled.
Definition: avassert.h:37
IMGTYPE_RGB24
#define IMGTYPE_RGB24
Definition: lcl.h:30
ff_zlib_encoder
const FFCodec ff_zlib_encoder
Definition: lclenc.c:154
AV_CODEC_CAP_FRAME_THREADS
#define AV_CODEC_CAP_FRAME_THREADS
Codec supports frame-level multithreading.
Definition: codec.h:113
AV_CODEC_ID_ZLIB
@ AV_CODEC_ID_ZLIB
Definition: codec_id.h:104
deflate
static void deflate(uint8_t *dst, const uint8_t *p1, int width, int threshold, const uint8_t *coordinates[], int coord, int maxc)
Definition: vf_neighbor.c:162
c
Undefined Behavior In the C some operations are like signed integer dereferencing freed accessing outside allocated Undefined Behavior must not occur in a C it is not safe even if the output of undefined operations is unused The unsafety may seem nit picking but Optimizing compilers have in fact optimized code on the assumption that no undefined Behavior occurs Optimizing code based on wrong assumptions can and has in some cases lead to effects beyond the output of computations The signed integer overflow problem in speed critical code Code which is highly optimized and works with signed integers sometimes has the problem that often the output of the computation does not c
Definition: undefined.txt:32
LclEncContext::compression
int compression
Definition: lclenc.c:61
AVPacket::size
int size
Definition: packet.h:375
NULL_IF_CONFIG_SMALL
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification.
Definition: internal.h:117
codec_internal.h
AVCodecContext::bits_per_coded_sample
int bits_per_coded_sample
bits per sample/pixel from the demuxer (needed for huffyuv).
Definition: avcodec.h:1450
i
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:269
AVCodecContext::extradata
uint8_t * extradata
some codecs need / can use extradata like Huffman tables.
Definition: avcodec.h:499
internal.h
av_mallocz
void * av_mallocz(size_t size)
Allocate a memory block with alignment suitable for all memory accesses (including vectors if availab...
Definition: mem.c:264
AVCodec::name
const char * name
Name of the codec implementation.
Definition: codec.h:211
LclEncContext
Definition: lclenc.c:54
AVCodecContext::height
int height
Definition: avcodec.h:571
encode_end
static av_cold int encode_end(AVCodecContext *avctx)
Definition: lclenc.c:145
AVCodecContext::pix_fmt
enum AVPixelFormat pix_fmt
Pixel format, see AV_PIX_FMT_xxx.
Definition: avcodec.h:608
avcodec.h
LclEncContext::avctx
AVCodecContext * avctx
Definition: lclenc.c:56
ret
ret
Definition: filter_design.txt:187
AV_INPUT_BUFFER_PADDING_SIZE
#define AV_INPUT_BUFFER_PADDING_SIZE
Definition: defs.h:40
AVCodecContext
main external API structure.
Definition: avcodec.h:398
AV_PIX_FMT_NONE
@ AV_PIX_FMT_NONE
Definition: pixfmt.h:65
AVMEDIA_TYPE_VIDEO
@ AVMEDIA_TYPE_VIDEO
Definition: avutil.h:201
FFZStream
Definition: zlib_wrapper.h:27
mem.h
encode_frame
static int encode_frame(AVCodecContext *avctx, AVPacket *pkt, const AVFrame *p, int *got_packet)
Definition: lclenc.c:67
encode_init
static av_cold int encode_init(AVCodecContext *avctx)
Definition: lclenc.c:113
AVCodecContext::priv_data
void * priv_data
Definition: avcodec.h:425
AVPacket
This structure stores compressed data.
Definition: packet.h:351
AVCodecContext::width
int width
picture width / height.
Definition: avcodec.h:571
AVFrame::linesize
int linesize[AV_NUM_DATA_POINTERS]
For video, a positive or negative value, which is typically indicating the size in bytes of each pict...
Definition: frame.h:370
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:27
ff_alloc_packet
int ff_alloc_packet(AVCodecContext *avctx, AVPacket *avpkt, int64_t size)
Check AVPacket size and allocate data.
Definition: encode.c:35
ff_deflate_init
int ff_deflate_init(FFZStream *zstream, int level, void *logctx)
Wrapper around deflateInit().
AVCodecContext::compression_level
int compression_level
Definition: avcodec.h:470
LclEncContext::zstream
FFZStream zstream
Definition: lclenc.c:64