2 * LCL (LossLess Codec Library) Codec
3 * Copyright (c) 2002-2004 Roberto Togni
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 * LCL (LossLess Codec Library) Video Codec
25 * Decoder for MSZH and ZLIB codecs
26 * Experimental encoder for ZLIB RGB24
31 * Ver2.23 By Kenji Oshima 2000.09.20
32 * avimszh.dll, avizlib.dll
34 * A description of the decoding algorithm can be found here:
35 * http://www.pcisys.net/~melanson/codecs
37 * Supports: BGR24 (RGB 24bpp)
45 #include "bytestream.h"
47 #include "libavutil/lzo.h"
49 #if CONFIG_ZLIB_DECODER
56 typedef struct LclDecContext {
65 // Decompressed data size
66 unsigned int decomp_size;
67 // Decompression buffer
68 unsigned char* decomp_buf;
69 #if CONFIG_ZLIB_DECODER
76 * \param srcptr compressed source buffer, must be padded with at least 5 extra bytes
77 * \param destptr must be padded sufficiently for av_memcpy_backptr
79 static unsigned int mszh_decomp(const unsigned char * srcptr, int srclen, unsigned char * destptr, unsigned int destsize)
81 unsigned char *destptr_bak = destptr;
82 unsigned char *destptr_end = destptr + destsize;
83 const unsigned char *srcptr_end = srcptr + srclen;
84 unsigned mask = *srcptr++;
85 unsigned maskbit = 0x80;
87 while (srcptr < srcptr_end && destptr < destptr_end) {
88 if (!(mask & maskbit)) {
89 memcpy(destptr, srcptr, 4);
93 unsigned ofs = bytestream_get_le16(&srcptr);
94 unsigned cnt = (ofs >> 11) + 1;
96 ofs = FFMIN(ofs, destptr - destptr_bak);
98 cnt = FFMIN(cnt, destptr_end - destptr);
99 av_memcpy_backptr(destptr, ofs, cnt);
106 if (destptr_end - destptr < 32 || srcptr_end - srcptr < 32) break;
107 memcpy(destptr, srcptr, 32);
116 return destptr - destptr_bak;
120 #if CONFIG_ZLIB_DECODER
122 * \brief decompress a zlib-compressed data block into decomp_buf
123 * \param src compressed input buffer
124 * \param src_len data length in input buffer
125 * \param offset offset in decomp_buf
126 * \param expected expected decompressed length
128 static int zlib_decomp(AVCodecContext *avctx, const uint8_t *src, int src_len, int offset, int expected)
130 LclDecContext *c = avctx->priv_data;
131 int zret = inflateReset(&c->zstream);
133 av_log(avctx, AV_LOG_ERROR, "Inflate reset error: %d\n", zret);
136 c->zstream.next_in = src;
137 c->zstream.avail_in = src_len;
138 c->zstream.next_out = c->decomp_buf + offset;
139 c->zstream.avail_out = c->decomp_size - offset;
140 zret = inflate(&c->zstream, Z_FINISH);
141 if (zret != Z_OK && zret != Z_STREAM_END) {
142 av_log(avctx, AV_LOG_ERROR, "Inflate error: %d\n", zret);
145 if (expected != (unsigned int)c->zstream.total_out) {
146 av_log(avctx, AV_LOG_ERROR, "Decoded size differs (%d != %lu)\n",
147 expected, c->zstream.total_out);
150 return c->zstream.total_out;
160 static int decode_frame(AVCodecContext *avctx, void *data, int *data_size, AVPacket *avpkt)
162 const uint8_t *buf = avpkt->data;
163 int buf_size = avpkt->size;
164 LclDecContext * const c = avctx->priv_data;
165 unsigned char *encoded = (unsigned char *)buf;
166 unsigned int pixel_ptr;
168 unsigned char *outptr;
169 uint8_t *y_out, *u_out, *v_out;
170 unsigned int width = avctx->width; // Real image width
171 unsigned int height = avctx->height; // Real image height
172 unsigned int mszh_dlen;
173 unsigned char yq, y1q, uq, vq;
175 unsigned int mthread_inlen, mthread_outlen;
176 unsigned int len = buf_size;
179 avctx->release_buffer(avctx, &c->pic);
181 c->pic.reference = 0;
182 c->pic.buffer_hints = FF_BUFFER_HINTS_VALID;
183 if(avctx->get_buffer(avctx, &c->pic) < 0){
184 av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
188 outptr = c->pic.data[0]; // Output image pointer
190 /* Decompress frame */
191 switch (avctx->codec_id) {
193 switch (c->compression) {
195 if (c->flags & FLAG_MULTITHREAD) {
196 mthread_inlen = AV_RL32(encoded);
197 mthread_inlen = FFMIN(mthread_inlen, len - 8);
198 mthread_outlen = AV_RL32(encoded+4);
199 mthread_outlen = FFMIN(mthread_outlen, c->decomp_size);
200 mszh_dlen = mszh_decomp(encoded + 8, mthread_inlen, c->decomp_buf, c->decomp_size);
201 if (mthread_outlen != mszh_dlen) {
202 av_log(avctx, AV_LOG_ERROR, "Mthread1 decoded size differs (%d != %d)\n",
203 mthread_outlen, mszh_dlen);
206 mszh_dlen = mszh_decomp(encoded + 8 + mthread_inlen, len - 8 - mthread_inlen,
207 c->decomp_buf + mthread_outlen, c->decomp_size - mthread_outlen);
208 if (mthread_outlen != mszh_dlen) {
209 av_log(avctx, AV_LOG_ERROR, "Mthread2 decoded size differs (%d != %d)\n",
210 mthread_outlen, mszh_dlen);
213 encoded = c->decomp_buf;
214 len = c->decomp_size;
216 mszh_dlen = mszh_decomp(encoded, len, c->decomp_buf, c->decomp_size);
217 if (c->decomp_size != mszh_dlen) {
218 av_log(avctx, AV_LOG_ERROR, "Decoded size differs (%d != %d)\n",
219 c->decomp_size, mszh_dlen);
222 encoded = c->decomp_buf;
226 case COMP_MSZH_NOCOMP:
229 av_log(avctx, AV_LOG_ERROR, "BUG! Unknown MSZH compression in frame decoder.\n");
233 #if CONFIG_ZLIB_DECODER
235 /* Using the original dll with normal compression (-1) and RGB format
236 * gives a file with ZLIB fourcc, but frame is really uncompressed.
237 * To be sure that's true check also frame size */
238 if (c->compression == COMP_ZLIB_NORMAL && c->imgtype == IMGTYPE_RGB24 &&
239 len == width * height * 3)
241 if (c->flags & FLAG_MULTITHREAD) {
243 mthread_inlen = AV_RL32(encoded);
244 mthread_inlen = FFMIN(mthread_inlen, len - 8);
245 mthread_outlen = AV_RL32(encoded+4);
246 mthread_outlen = FFMIN(mthread_outlen, c->decomp_size);
247 ret = zlib_decomp(avctx, encoded + 8, mthread_inlen, 0, mthread_outlen);
248 if (ret < 0) return ret;
249 ret = zlib_decomp(avctx, encoded + 8 + mthread_inlen, len - 8 - mthread_inlen,
250 mthread_outlen, mthread_outlen);
251 if (ret < 0) return ret;
253 int ret = zlib_decomp(avctx, encoded, len, 0, c->decomp_size);
254 if (ret < 0) return ret;
256 encoded = c->decomp_buf;
257 len = c->decomp_size;
261 av_log(avctx, AV_LOG_ERROR, "BUG! Unknown codec in frame decoder compression switch.\n");
266 /* Apply PNG filter */
267 if (avctx->codec_id == CODEC_ID_ZLIB && (c->flags & FLAG_PNGFILTER)) {
268 switch (c->imgtype) {
271 for (row = 0; row < height; row++) {
272 pixel_ptr = row * width * 3;
273 yq = encoded[pixel_ptr++];
274 uqvq = AV_RL16(encoded+pixel_ptr);
276 for (col = 1; col < width; col++) {
277 encoded[pixel_ptr] = yq -= encoded[pixel_ptr];
278 uqvq -= AV_RL16(encoded+pixel_ptr+1);
279 AV_WL16(encoded+pixel_ptr+1, uqvq);
285 for (row = 0; row < height; row++) {
286 pixel_ptr = row * width * 2;
288 for (col = 0; col < width/4; col++) {
289 encoded[pixel_ptr] = yq -= encoded[pixel_ptr];
290 encoded[pixel_ptr+1] = yq -= encoded[pixel_ptr+1];
291 encoded[pixel_ptr+2] = yq -= encoded[pixel_ptr+2];
292 encoded[pixel_ptr+3] = yq -= encoded[pixel_ptr+3];
293 encoded[pixel_ptr+4] = uq -= encoded[pixel_ptr+4];
294 encoded[pixel_ptr+5] = uq -= encoded[pixel_ptr+5];
295 encoded[pixel_ptr+6] = vq -= encoded[pixel_ptr+6];
296 encoded[pixel_ptr+7] = vq -= encoded[pixel_ptr+7];
302 for (row = 0; row < height; row++) {
303 pixel_ptr = row * width / 2 * 3;
305 for (col = 0; col < width/4; col++) {
306 encoded[pixel_ptr] = yq -= encoded[pixel_ptr];
307 encoded[pixel_ptr+1] = yq -= encoded[pixel_ptr+1];
308 encoded[pixel_ptr+2] = yq -= encoded[pixel_ptr+2];
309 encoded[pixel_ptr+3] = yq -= encoded[pixel_ptr+3];
310 encoded[pixel_ptr+4] = uq -= encoded[pixel_ptr+4];
311 encoded[pixel_ptr+5] = vq -= encoded[pixel_ptr+5];
317 for (row = 0; row < height; row++) {
318 pixel_ptr = row * width * 2;
320 for (col = 0; col < width/2; col++) {
321 encoded[pixel_ptr] = yq -= encoded[pixel_ptr];
322 encoded[pixel_ptr+1] = yq -= encoded[pixel_ptr+1];
323 encoded[pixel_ptr+2] = uq -= encoded[pixel_ptr+2];
324 encoded[pixel_ptr+3] = vq -= encoded[pixel_ptr+3];
330 for (row = 0; row < height/2; row++) {
331 pixel_ptr = row * width * 3;
332 yq = y1q = uq = vq =0;
333 for (col = 0; col < width/2; col++) {
334 encoded[pixel_ptr] = yq -= encoded[pixel_ptr];
335 encoded[pixel_ptr+1] = yq -= encoded[pixel_ptr+1];
336 encoded[pixel_ptr+2] = y1q -= encoded[pixel_ptr+2];
337 encoded[pixel_ptr+3] = y1q -= encoded[pixel_ptr+3];
338 encoded[pixel_ptr+4] = uq -= encoded[pixel_ptr+4];
339 encoded[pixel_ptr+5] = vq -= encoded[pixel_ptr+5];
345 av_log(avctx, AV_LOG_ERROR, "BUG! Unknown imagetype in pngfilter switch.\n");
350 /* Convert colorspace */
351 y_out = c->pic.data[0] + (height - 1) * c->pic.linesize[0];
352 u_out = c->pic.data[1] + (height - 1) * c->pic.linesize[1];
353 v_out = c->pic.data[2] + (height - 1) * c->pic.linesize[2];
354 switch (c->imgtype) {
356 for (row = 0; row < height; row++) {
357 for (col = 0; col < width; col++) {
358 y_out[col] = *encoded++;
359 u_out[col] = *encoded++ + 128;
360 v_out[col] = *encoded++ + 128;
362 y_out -= c->pic.linesize[0];
363 u_out -= c->pic.linesize[1];
364 v_out -= c->pic.linesize[2];
368 for (row = 0; row < height; row++) {
369 for (col = 0; col < width - 3; col += 4) {
370 memcpy(y_out + col, encoded, 4);
372 u_out[ col >> 1 ] = *encoded++ + 128;
373 u_out[(col >> 1) + 1] = *encoded++ + 128;
374 v_out[ col >> 1 ] = *encoded++ + 128;
375 v_out[(col >> 1) + 1] = *encoded++ + 128;
377 y_out -= c->pic.linesize[0];
378 u_out -= c->pic.linesize[1];
379 v_out -= c->pic.linesize[2];
383 for (row = height - 1; row >= 0; row--) {
384 pixel_ptr = row * c->pic.linesize[0];
385 memcpy(outptr + pixel_ptr, encoded, 3 * width);
386 encoded += 3 * width;
390 for (row = 0; row < height; row++) {
391 for (col = 0; col < width - 3; col += 4) {
392 memcpy(y_out + col, encoded, 4);
394 u_out[col >> 2] = *encoded++ + 128;
395 v_out[col >> 2] = *encoded++ + 128;
397 y_out -= c->pic.linesize[0];
398 u_out -= c->pic.linesize[1];
399 v_out -= c->pic.linesize[2];
403 for (row = 0; row < height; row++) {
404 for (col = 0; col < width - 1; col += 2) {
405 memcpy(y_out + col, encoded, 2);
407 u_out[col >> 1] = *encoded++ + 128;
408 v_out[col >> 1] = *encoded++ + 128;
410 y_out -= c->pic.linesize[0];
411 u_out -= c->pic.linesize[1];
412 v_out -= c->pic.linesize[2];
416 u_out = c->pic.data[1] + ((height >> 1) - 1) * c->pic.linesize[1];
417 v_out = c->pic.data[2] + ((height >> 1) - 1) * c->pic.linesize[2];
418 for (row = 0; row < height - 1; row += 2) {
419 for (col = 0; col < width - 1; col += 2) {
420 memcpy(y_out + col, encoded, 2);
422 memcpy(y_out + col - c->pic.linesize[0], encoded, 2);
424 u_out[col >> 1] = *encoded++ + 128;
425 v_out[col >> 1] = *encoded++ + 128;
427 y_out -= c->pic.linesize[0] << 1;
428 u_out -= c->pic.linesize[1];
429 v_out -= c->pic.linesize[2];
433 av_log(avctx, AV_LOG_ERROR, "BUG! Unknown imagetype in image decoder.\n");
437 *data_size = sizeof(AVFrame);
438 *(AVFrame*)data = c->pic;
440 /* always report that the buffer was completely consumed */
449 static av_cold int decode_init(AVCodecContext *avctx)
451 LclDecContext * const c = avctx->priv_data;
452 unsigned int basesize = avctx->width * avctx->height;
453 unsigned int max_basesize = FFALIGN(avctx->width, 4) * FFALIGN(avctx->height, 4) + AV_LZO_OUTPUT_PADDING;
454 unsigned int max_decomp_size;
456 avcodec_get_frame_defaults(&c->pic);
457 if (avctx->extradata_size < 8) {
458 av_log(avctx, AV_LOG_ERROR, "Extradata size too small.\n");
462 /* Check codec type */
463 if ((avctx->codec_id == CODEC_ID_MSZH && avctx->extradata[7] != CODEC_MSZH) ||
464 (avctx->codec_id == CODEC_ID_ZLIB && avctx->extradata[7] != CODEC_ZLIB)) {
465 av_log(avctx, AV_LOG_ERROR, "Codec id and codec type mismatch. This should not happen.\n");
468 /* Detect image type */
469 switch (c->imgtype = avctx->extradata[4]) {
471 c->decomp_size = basesize * 3;
472 max_decomp_size = max_basesize * 3;
473 avctx->pix_fmt = PIX_FMT_YUV444P;
474 av_log(avctx, AV_LOG_DEBUG, "Image type is YUV 1:1:1.\n");
477 c->decomp_size = basesize * 2;
478 max_decomp_size = max_basesize * 2;
479 avctx->pix_fmt = PIX_FMT_YUV422P;
480 av_log(avctx, AV_LOG_DEBUG, "Image type is YUV 4:2:2.\n");
483 c->decomp_size = basesize * 3;
484 max_decomp_size = max_basesize * 3;
485 avctx->pix_fmt = PIX_FMT_BGR24;
486 av_log(avctx, AV_LOG_DEBUG, "Image type is RGB 24.\n");
489 c->decomp_size = basesize / 2 * 3;
490 max_decomp_size = max_basesize / 2 * 3;
491 avctx->pix_fmt = PIX_FMT_YUV411P;
492 av_log(avctx, AV_LOG_DEBUG, "Image type is YUV 4:1:1.\n");
495 c->decomp_size = basesize * 2;
496 max_decomp_size = max_basesize * 2;
497 avctx->pix_fmt = PIX_FMT_YUV422P;
498 av_log(avctx, AV_LOG_DEBUG, "Image type is YUV 2:1:1.\n");
501 c->decomp_size = basesize / 2 * 3;
502 max_decomp_size = max_basesize / 2 * 3;
503 avctx->pix_fmt = PIX_FMT_YUV420P;
504 av_log(avctx, AV_LOG_DEBUG, "Image type is YUV 4:2:0.\n");
507 av_log(avctx, AV_LOG_ERROR, "Unsupported image format %d.\n", c->imgtype);
511 /* Detect compression method */
512 c->compression = (int8_t)avctx->extradata[5];
513 switch (avctx->codec_id) {
515 switch (c->compression) {
517 av_log(avctx, AV_LOG_DEBUG, "Compression enabled.\n");
519 case COMP_MSZH_NOCOMP:
521 av_log(avctx, AV_LOG_DEBUG, "No compression.\n");
524 av_log(avctx, AV_LOG_ERROR, "Unsupported compression format for MSZH (%d).\n", c->compression);
528 #if CONFIG_ZLIB_DECODER
530 switch (c->compression) {
531 case COMP_ZLIB_HISPEED:
532 av_log(avctx, AV_LOG_DEBUG, "High speed compression.\n");
534 case COMP_ZLIB_HICOMP:
535 av_log(avctx, AV_LOG_DEBUG, "High compression.\n");
537 case COMP_ZLIB_NORMAL:
538 av_log(avctx, AV_LOG_DEBUG, "Normal compression.\n");
541 if (c->compression < Z_NO_COMPRESSION || c->compression > Z_BEST_COMPRESSION) {
542 av_log(avctx, AV_LOG_ERROR, "Unsupported compression level for ZLIB: (%d).\n", c->compression);
545 av_log(avctx, AV_LOG_DEBUG, "Compression level for ZLIB: (%d).\n", c->compression);
550 av_log(avctx, AV_LOG_ERROR, "BUG! Unknown codec in compression switch.\n");
554 /* Allocate decompression buffer */
555 if (c->decomp_size) {
556 if ((c->decomp_buf = av_malloc(max_decomp_size)) == NULL) {
557 av_log(avctx, AV_LOG_ERROR, "Can't allocate decompression buffer.\n");
563 c->flags = avctx->extradata[6];
564 if (c->flags & FLAG_MULTITHREAD)
565 av_log(avctx, AV_LOG_DEBUG, "Multithread encoder flag set.\n");
566 if (c->flags & FLAG_NULLFRAME)
567 av_log(avctx, AV_LOG_DEBUG, "Nullframe insertion flag set.\n");
568 if (avctx->codec_id == CODEC_ID_ZLIB && (c->flags & FLAG_PNGFILTER))
569 av_log(avctx, AV_LOG_DEBUG, "PNG filter flag set.\n");
570 if (c->flags & FLAGMASK_UNUSED)
571 av_log(avctx, AV_LOG_ERROR, "Unknown flag set (%d).\n", c->flags);
573 /* If needed init zlib */
574 #if CONFIG_ZLIB_DECODER
575 if (avctx->codec_id == CODEC_ID_ZLIB) {
577 c->zstream.zalloc = Z_NULL;
578 c->zstream.zfree = Z_NULL;
579 c->zstream.opaque = Z_NULL;
580 zret = inflateInit(&c->zstream);
582 av_log(avctx, AV_LOG_ERROR, "Inflate init error: %d\n", zret);
583 av_freep(&c->decomp_buf);
597 static av_cold int decode_end(AVCodecContext *avctx)
599 LclDecContext * const c = avctx->priv_data;
601 av_freep(&c->decomp_buf);
603 avctx->release_buffer(avctx, &c->pic);
604 #if CONFIG_ZLIB_DECODER
605 if (avctx->codec_id == CODEC_ID_ZLIB)
606 inflateEnd(&c->zstream);
612 #if CONFIG_MSZH_DECODER
613 AVCodec ff_mszh_decoder = {
617 sizeof(LclDecContext),
623 .long_name = NULL_IF_CONFIG_SMALL("LCL (LossLess Codec Library) MSZH"),
627 #if CONFIG_ZLIB_DECODER
628 AVCodec ff_zlib_decoder = {
632 sizeof(LclDecContext),
638 .long_name = NULL_IF_CONFIG_SMALL("LCL (LossLess Codec Library) ZLIB"),