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)
43 #include "libavutil/mem.h"
44 #include "libavutil/pixdesc.h"
46 #include "bytestream.h"
51 #if CONFIG_ZLIB_DECODER
55 typedef struct LclDecContext {
62 // Decompressed data size
63 unsigned int decomp_size;
64 // Decompression buffer
65 unsigned char* decomp_buf;
66 #if CONFIG_ZLIB_DECODER
73 * @param srcptr compressed source buffer, must be padded with at least 5 extra bytes
74 * @param destptr must be padded sufficiently for av_memcpy_backptr
76 static unsigned int mszh_decomp(const unsigned char * srcptr, int srclen, unsigned char * destptr, unsigned int destsize)
78 unsigned char *destptr_bak = destptr;
79 unsigned char *destptr_end = destptr + destsize;
80 const unsigned char *srcptr_end = srcptr + srclen;
81 unsigned mask = *srcptr++;
82 unsigned maskbit = 0x80;
84 while (srcptr < srcptr_end && destptr < destptr_end) {
85 if (!(mask & maskbit)) {
86 memcpy(destptr, srcptr, 4);
90 unsigned ofs = bytestream_get_le16(&srcptr);
91 unsigned cnt = (ofs >> 11) + 1;
93 ofs = FFMIN(ofs, destptr - destptr_bak);
95 cnt = FFMIN(cnt, destptr_end - destptr);
97 av_memcpy_backptr(destptr, ofs, cnt);
99 // Not known what the correct behaviour is, but
100 // this at least avoids uninitialized data.
101 memset(destptr, 0, cnt);
109 if (destptr_end - destptr < 32 || srcptr_end - srcptr < 32) break;
110 memcpy(destptr, srcptr, 32);
119 return destptr - destptr_bak;
123 #if CONFIG_ZLIB_DECODER
125 * @brief decompress a zlib-compressed data block into decomp_buf
126 * @param src compressed input buffer
127 * @param src_len data length in input buffer
128 * @param offset offset in decomp_buf
129 * @param expected expected decompressed length
131 static int zlib_decomp(AVCodecContext *avctx, const uint8_t *src, int src_len, int offset, int expected)
133 LclDecContext *c = avctx->priv_data;
134 int zret = inflateReset(&c->zstream);
136 av_log(avctx, AV_LOG_ERROR, "Inflate reset error: %d\n", zret);
137 return AVERROR_UNKNOWN;
139 c->zstream.next_in = (uint8_t *)src;
140 c->zstream.avail_in = src_len;
141 c->zstream.next_out = c->decomp_buf + offset;
142 c->zstream.avail_out = c->decomp_size - offset;
143 zret = inflate(&c->zstream, Z_FINISH);
144 if (zret != Z_OK && zret != Z_STREAM_END) {
145 av_log(avctx, AV_LOG_ERROR, "Inflate error: %d\n", zret);
146 return AVERROR_UNKNOWN;
148 if (expected != (unsigned int)c->zstream.total_out) {
149 av_log(avctx, AV_LOG_ERROR, "Decoded size differs (%d != %lu)\n",
150 expected, c->zstream.total_out);
151 return AVERROR_UNKNOWN;
153 return c->zstream.total_out;
158 static int decode_frame(AVCodecContext *avctx, void *data, int *got_frame, AVPacket *avpkt)
160 AVFrame *frame = data;
161 ThreadFrame tframe = { .f = data };
162 const uint8_t *buf = avpkt->data;
163 int buf_size = avpkt->size;
164 LclDecContext * const c = avctx->priv_data;
165 unsigned int pixel_ptr;
167 unsigned char *encoded = avpkt->data, *outptr;
168 uint8_t *y_out, *u_out, *v_out;
169 unsigned int width = avctx->width; // Real image width
170 unsigned int height = avctx->height; // Real image height
171 unsigned int mszh_dlen;
172 unsigned char yq, y1q, uq, vq;
174 unsigned int mthread_inlen, mthread_outlen;
175 unsigned int len = buf_size;
178 if ((ret = ff_thread_get_buffer(avctx, &tframe, 0)) < 0)
181 outptr = frame->data[0]; // Output image pointer
183 /* Decompress frame */
184 switch (avctx->codec_id) {
185 case AV_CODEC_ID_MSZH:
186 switch (c->compression) {
188 if (c->imgtype == IMGTYPE_RGB24 && len == FFALIGN(width * 3, 4) * height ||
189 c->imgtype == IMGTYPE_YUV111 && len == width * height * 3) {
191 } else if (c->flags & FLAG_MULTITHREAD) {
192 mthread_inlen = AV_RL32(buf);
194 av_log(avctx, AV_LOG_ERROR, "len %d is too small\n", len);
195 return AVERROR_INVALIDDATA;
197 mthread_inlen = FFMIN(mthread_inlen, len - 8);
198 mthread_outlen = AV_RL32(buf + 4);
199 mthread_outlen = FFMIN(mthread_outlen, c->decomp_size);
200 mszh_dlen = mszh_decomp(buf + 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);
204 return AVERROR_INVALIDDATA;
206 mszh_dlen = mszh_decomp(buf + 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);
211 return AVERROR_INVALIDDATA;
213 encoded = c->decomp_buf;
214 len = c->decomp_size;
216 mszh_dlen = mszh_decomp(buf, 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);
220 return AVERROR_INVALIDDATA;
222 encoded = c->decomp_buf;
226 case COMP_MSZH_NOCOMP: {
228 switch (c->imgtype) {
242 bppx2 = 0; // will error out below
245 if (len < ((width * height * bppx2) >> 1))
246 return AVERROR_INVALIDDATA;
250 av_log(avctx, AV_LOG_ERROR, "BUG! Unknown MSZH compression in frame decoder.\n");
251 return AVERROR_INVALIDDATA;
254 #if CONFIG_ZLIB_DECODER
255 case AV_CODEC_ID_ZLIB:
256 /* Using the original dll with normal compression (-1) and RGB format
257 * gives a file with ZLIB fourcc, but frame is really uncompressed.
258 * To be sure that's true check also frame size */
259 if (c->compression == COMP_ZLIB_NORMAL && c->imgtype == IMGTYPE_RGB24 &&
260 len == width * height * 3) {
261 if (c->flags & FLAG_PNGFILTER) {
262 memcpy(c->decomp_buf, buf, len);
263 encoded = c->decomp_buf;
267 } else if (c->flags & FLAG_MULTITHREAD) {
268 mthread_inlen = AV_RL32(buf);
269 mthread_inlen = FFMIN(mthread_inlen, len - 8);
270 mthread_outlen = AV_RL32(buf + 4);
271 mthread_outlen = FFMIN(mthread_outlen, c->decomp_size);
272 ret = zlib_decomp(avctx, buf + 8, mthread_inlen, 0, mthread_outlen);
273 if (ret < 0) return ret;
274 ret = zlib_decomp(avctx, buf + 8 + mthread_inlen, len - 8 - mthread_inlen,
275 mthread_outlen, mthread_outlen);
276 if (ret < 0) return ret;
278 int ret = zlib_decomp(avctx, buf, len, 0, c->decomp_size);
279 if (ret < 0) return ret;
281 encoded = c->decomp_buf;
282 len = c->decomp_size;
286 av_log(avctx, AV_LOG_ERROR, "BUG! Unknown codec in frame decoder compression switch.\n");
287 return AVERROR_INVALIDDATA;
291 /* Apply PNG filter */
292 if (avctx->codec_id == AV_CODEC_ID_ZLIB && (c->flags & FLAG_PNGFILTER)) {
293 switch (c->imgtype) {
296 for (row = 0; row < height; row++) {
297 pixel_ptr = row * width * 3;
298 yq = encoded[pixel_ptr++];
299 uqvq = AV_RL16(encoded+pixel_ptr);
301 for (col = 1; col < width; col++) {
302 encoded[pixel_ptr] = yq -= encoded[pixel_ptr];
303 uqvq -= AV_RL16(encoded+pixel_ptr+1);
304 AV_WL16(encoded+pixel_ptr+1, uqvq);
310 for (row = 0; row < height; row++) {
311 pixel_ptr = row * width * 2;
313 for (col = 0; col < width/4; col++) {
314 encoded[pixel_ptr] = yq -= encoded[pixel_ptr];
315 encoded[pixel_ptr+1] = yq -= encoded[pixel_ptr+1];
316 encoded[pixel_ptr+2] = yq -= encoded[pixel_ptr+2];
317 encoded[pixel_ptr+3] = yq -= encoded[pixel_ptr+3];
318 encoded[pixel_ptr+4] = uq -= encoded[pixel_ptr+4];
319 encoded[pixel_ptr+5] = uq -= encoded[pixel_ptr+5];
320 encoded[pixel_ptr+6] = vq -= encoded[pixel_ptr+6];
321 encoded[pixel_ptr+7] = vq -= encoded[pixel_ptr+7];
327 for (row = 0; row < height; row++) {
328 pixel_ptr = row * width / 2 * 3;
330 for (col = 0; col < width/4; col++) {
331 encoded[pixel_ptr] = yq -= encoded[pixel_ptr];
332 encoded[pixel_ptr+1] = yq -= encoded[pixel_ptr+1];
333 encoded[pixel_ptr+2] = yq -= encoded[pixel_ptr+2];
334 encoded[pixel_ptr+3] = yq -= encoded[pixel_ptr+3];
335 encoded[pixel_ptr+4] = uq -= encoded[pixel_ptr+4];
336 encoded[pixel_ptr+5] = vq -= encoded[pixel_ptr+5];
342 for (row = 0; row < height; row++) {
343 pixel_ptr = row * width * 2;
345 for (col = 0; col < width/2; col++) {
346 encoded[pixel_ptr] = yq -= encoded[pixel_ptr];
347 encoded[pixel_ptr+1] = yq -= encoded[pixel_ptr+1];
348 encoded[pixel_ptr+2] = uq -= encoded[pixel_ptr+2];
349 encoded[pixel_ptr+3] = vq -= encoded[pixel_ptr+3];
355 for (row = 0; row < height/2; row++) {
356 pixel_ptr = row * width * 3;
357 yq = y1q = uq = vq =0;
358 for (col = 0; col < width/2; col++) {
359 encoded[pixel_ptr] = yq -= encoded[pixel_ptr];
360 encoded[pixel_ptr+1] = yq -= encoded[pixel_ptr+1];
361 encoded[pixel_ptr+2] = y1q -= encoded[pixel_ptr+2];
362 encoded[pixel_ptr+3] = y1q -= encoded[pixel_ptr+3];
363 encoded[pixel_ptr+4] = uq -= encoded[pixel_ptr+4];
364 encoded[pixel_ptr+5] = vq -= encoded[pixel_ptr+5];
370 av_log(avctx, AV_LOG_ERROR, "BUG! Unknown imagetype in pngfilter switch.\n");
371 return AVERROR_INVALIDDATA;
375 /* Convert colorspace */
376 y_out = frame->data[0] + (height - 1) * frame->linesize[0];
377 u_out = frame->data[1] + (height - 1) * frame->linesize[1];
378 v_out = frame->data[2] + (height - 1) * frame->linesize[2];
379 switch (c->imgtype) {
381 for (row = 0; row < height; row++) {
382 for (col = 0; col < width; col++) {
383 y_out[col] = *encoded++;
384 u_out[col] = *encoded++ + 128;
385 v_out[col] = *encoded++ + 128;
387 y_out -= frame->linesize[0];
388 u_out -= frame->linesize[1];
389 v_out -= frame->linesize[2];
393 for (row = 0; row < height; row++) {
394 for (col = 0; col < width - 3; col += 4) {
395 memcpy(y_out + col, encoded, 4);
397 u_out[ col >> 1 ] = *encoded++ + 128;
398 u_out[(col >> 1) + 1] = *encoded++ + 128;
399 v_out[ col >> 1 ] = *encoded++ + 128;
400 v_out[(col >> 1) + 1] = *encoded++ + 128;
402 y_out -= frame->linesize[0];
403 u_out -= frame->linesize[1];
404 v_out -= frame->linesize[2];
408 linesize = len < FFALIGN(3 * width, 4) * height ? 3 * width : FFALIGN(3 * width, 4);
409 for (row = height - 1; row >= 0; row--) {
410 pixel_ptr = row * frame->linesize[0];
411 memcpy(outptr + pixel_ptr, encoded, 3 * width);
416 for (row = 0; row < height; row++) {
417 for (col = 0; col < width - 3; col += 4) {
418 memcpy(y_out + col, encoded, 4);
420 u_out[col >> 2] = *encoded++ + 128;
421 v_out[col >> 2] = *encoded++ + 128;
423 y_out -= frame->linesize[0];
424 u_out -= frame->linesize[1];
425 v_out -= frame->linesize[2];
429 for (row = 0; row < height; row++) {
430 for (col = 0; col < width - 1; col += 2) {
431 memcpy(y_out + col, encoded, 2);
433 u_out[col >> 1] = *encoded++ + 128;
434 v_out[col >> 1] = *encoded++ + 128;
436 y_out -= frame->linesize[0];
437 u_out -= frame->linesize[1];
438 v_out -= frame->linesize[2];
442 u_out = frame->data[1] + ((height >> 1) - 1) * frame->linesize[1];
443 v_out = frame->data[2] + ((height >> 1) - 1) * frame->linesize[2];
444 for (row = 0; row < height - 1; row += 2) {
445 for (col = 0; col < width - 1; col += 2) {
446 memcpy(y_out + col, encoded, 2);
448 memcpy(y_out + col - frame->linesize[0], encoded, 2);
450 u_out[col >> 1] = *encoded++ + 128;
451 v_out[col >> 1] = *encoded++ + 128;
453 y_out -= frame->linesize[0] << 1;
454 u_out -= frame->linesize[1];
455 v_out -= frame->linesize[2];
459 av_log(avctx, AV_LOG_ERROR, "BUG! Unknown imagetype in image decoder.\n");
460 return AVERROR_INVALIDDATA;
463 frame->key_frame = 1;
464 frame->pict_type = AV_PICTURE_TYPE_I;
468 /* always report that the buffer was completely consumed */
472 static av_cold int decode_init(AVCodecContext *avctx)
474 LclDecContext * const c = avctx->priv_data;
475 unsigned int basesize = avctx->width * avctx->height;
476 unsigned int max_basesize = FFALIGN(avctx->width, 4) *
477 FFALIGN(avctx->height, 4);
478 unsigned int max_decomp_size;
479 int subsample_h, subsample_v;
481 if (avctx->extradata_size < 8) {
482 av_log(avctx, AV_LOG_ERROR, "Extradata size too small.\n");
483 return AVERROR_INVALIDDATA;
486 /* Check codec type */
487 if ((avctx->codec_id == AV_CODEC_ID_MSZH && avctx->extradata[7] != CODEC_MSZH) ||
488 (avctx->codec_id == AV_CODEC_ID_ZLIB && avctx->extradata[7] != CODEC_ZLIB)) {
489 av_log(avctx, AV_LOG_ERROR, "Codec id and codec type mismatch. This should not happen.\n");
492 /* Detect image type */
493 switch (c->imgtype = avctx->extradata[4]) {
495 c->decomp_size = basesize * 3;
496 max_decomp_size = max_basesize * 3;
497 avctx->pix_fmt = AV_PIX_FMT_YUV444P;
498 av_log(avctx, AV_LOG_DEBUG, "Image type is YUV 1:1:1.\n");
501 c->decomp_size = basesize * 2;
502 max_decomp_size = max_basesize * 2;
503 avctx->pix_fmt = AV_PIX_FMT_YUV422P;
504 av_log(avctx, AV_LOG_DEBUG, "Image type is YUV 4:2:2.\n");
505 if (avctx->width % 4) {
506 avpriv_request_sample(avctx, "Unsupported dimensions");
507 return AVERROR_INVALIDDATA;
511 c->decomp_size = basesize * 3;
512 max_decomp_size = max_basesize * 3;
513 avctx->pix_fmt = AV_PIX_FMT_BGR24;
514 av_log(avctx, AV_LOG_DEBUG, "Image type is RGB 24.\n");
517 c->decomp_size = basesize / 2 * 3;
518 max_decomp_size = max_basesize / 2 * 3;
519 avctx->pix_fmt = AV_PIX_FMT_YUV411P;
520 av_log(avctx, AV_LOG_DEBUG, "Image type is YUV 4:1:1.\n");
523 c->decomp_size = basesize * 2;
524 max_decomp_size = max_basesize * 2;
525 avctx->pix_fmt = AV_PIX_FMT_YUV422P;
526 av_log(avctx, AV_LOG_DEBUG, "Image type is YUV 2:1:1.\n");
529 c->decomp_size = basesize / 2 * 3;
530 max_decomp_size = max_basesize / 2 * 3;
531 avctx->pix_fmt = AV_PIX_FMT_YUV420P;
532 av_log(avctx, AV_LOG_DEBUG, "Image type is YUV 4:2:0.\n");
535 av_log(avctx, AV_LOG_ERROR, "Unsupported image format %d.\n", c->imgtype);
536 return AVERROR_INVALIDDATA;
539 av_pix_fmt_get_chroma_sub_sample(avctx->pix_fmt, &subsample_h, &subsample_v);
540 if (avctx->width % (1<<subsample_h) || avctx->height % (1<<subsample_v)) {
541 avpriv_request_sample(avctx, "Unsupported dimensions");
542 return AVERROR_INVALIDDATA;
545 /* Detect compression method */
546 c->compression = (int8_t)avctx->extradata[5];
547 switch (avctx->codec_id) {
548 case AV_CODEC_ID_MSZH:
549 switch (c->compression) {
551 av_log(avctx, AV_LOG_DEBUG, "Compression enabled.\n");
553 case COMP_MSZH_NOCOMP:
555 av_log(avctx, AV_LOG_DEBUG, "No compression.\n");
558 av_log(avctx, AV_LOG_ERROR, "Unsupported compression format for MSZH (%d).\n", c->compression);
559 return AVERROR_INVALIDDATA;
562 #if CONFIG_ZLIB_DECODER
563 case AV_CODEC_ID_ZLIB:
564 switch (c->compression) {
565 case COMP_ZLIB_HISPEED:
566 av_log(avctx, AV_LOG_DEBUG, "High speed compression.\n");
568 case COMP_ZLIB_HICOMP:
569 av_log(avctx, AV_LOG_DEBUG, "High compression.\n");
571 case COMP_ZLIB_NORMAL:
572 av_log(avctx, AV_LOG_DEBUG, "Normal compression.\n");
575 if (c->compression < Z_NO_COMPRESSION || c->compression > Z_BEST_COMPRESSION) {
576 av_log(avctx, AV_LOG_ERROR, "Unsupported compression level for ZLIB: (%d).\n", c->compression);
577 return AVERROR_INVALIDDATA;
579 av_log(avctx, AV_LOG_DEBUG, "Compression level for ZLIB: (%d).\n", c->compression);
584 av_log(avctx, AV_LOG_ERROR, "BUG! Unknown codec in compression switch.\n");
585 return AVERROR_INVALIDDATA;
588 /* Allocate decompression buffer */
589 if (c->decomp_size) {
590 if (!(c->decomp_buf = av_malloc(max_decomp_size))) {
591 av_log(avctx, AV_LOG_ERROR, "Can't allocate decompression buffer.\n");
592 return AVERROR(ENOMEM);
597 c->flags = avctx->extradata[6];
598 if (c->flags & FLAG_MULTITHREAD)
599 av_log(avctx, AV_LOG_DEBUG, "Multithread encoder flag set.\n");
600 if (c->flags & FLAG_NULLFRAME)
601 av_log(avctx, AV_LOG_DEBUG, "Nullframe insertion flag set.\n");
602 if (avctx->codec_id == AV_CODEC_ID_ZLIB && (c->flags & FLAG_PNGFILTER))
603 av_log(avctx, AV_LOG_DEBUG, "PNG filter flag set.\n");
604 if (c->flags & FLAGMASK_UNUSED)
605 av_log(avctx, AV_LOG_ERROR, "Unknown flag set (%d).\n", c->flags);
607 /* If needed init zlib */
608 #if CONFIG_ZLIB_DECODER
609 if (avctx->codec_id == AV_CODEC_ID_ZLIB) {
611 c->zstream.zalloc = Z_NULL;
612 c->zstream.zfree = Z_NULL;
613 c->zstream.opaque = Z_NULL;
614 zret = inflateInit(&c->zstream);
616 av_log(avctx, AV_LOG_ERROR, "Inflate init error: %d\n", zret);
617 av_freep(&c->decomp_buf);
618 return AVERROR_UNKNOWN;
627 static int init_thread_copy(AVCodecContext *avctx)
629 return decode_init(avctx);
633 static av_cold int decode_end(AVCodecContext *avctx)
635 LclDecContext * const c = avctx->priv_data;
637 av_freep(&c->decomp_buf);
638 #if CONFIG_ZLIB_DECODER
639 if (avctx->codec_id == AV_CODEC_ID_ZLIB)
640 inflateEnd(&c->zstream);
646 #if CONFIG_MSZH_DECODER
647 AVCodec ff_mszh_decoder = {
649 .long_name = NULL_IF_CONFIG_SMALL("LCL (LossLess Codec Library) MSZH"),
650 .type = AVMEDIA_TYPE_VIDEO,
651 .id = AV_CODEC_ID_MSZH,
652 .priv_data_size = sizeof(LclDecContext),
654 .init_thread_copy = ONLY_IF_THREADS_ENABLED(init_thread_copy),
656 .decode = decode_frame,
657 .capabilities = AV_CODEC_CAP_DR1 | AV_CODEC_CAP_FRAME_THREADS,
658 .caps_internal = FF_CODEC_CAP_INIT_THREADSAFE,
662 #if CONFIG_ZLIB_DECODER
663 AVCodec ff_zlib_decoder = {
665 .long_name = NULL_IF_CONFIG_SMALL("LCL (LossLess Codec Library) ZLIB"),
666 .type = AVMEDIA_TYPE_VIDEO,
667 .id = AV_CODEC_ID_ZLIB,
668 .priv_data_size = sizeof(LclDecContext),
670 .init_thread_copy = ONLY_IF_THREADS_ENABLED(init_thread_copy),
672 .decode = decode_frame,
673 .capabilities = AV_CODEC_CAP_DR1 | AV_CODEC_CAP_FRAME_THREADS,
674 .caps_internal = FF_CODEC_CAP_INIT_THREADSAFE,