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 = 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);
193 if (len < 8 || len - 8 < mthread_inlen) {
194 av_log(avctx, AV_LOG_ERROR, "len %d is too small\n", len);
195 return AVERROR_INVALIDDATA;
197 mthread_outlen = AV_RL32(buf + 4);
198 mthread_outlen = FFMIN(mthread_outlen, c->decomp_size);
199 mszh_dlen = mszh_decomp(buf + 8, mthread_inlen, c->decomp_buf, c->decomp_size);
200 if (mthread_outlen != mszh_dlen) {
201 av_log(avctx, AV_LOG_ERROR, "Mthread1 decoded size differs (%d != %d)\n",
202 mthread_outlen, mszh_dlen);
203 return AVERROR_INVALIDDATA;
205 mszh_dlen = mszh_decomp(buf + 8 + mthread_inlen, len - 8 - mthread_inlen,
206 c->decomp_buf + mthread_outlen, c->decomp_size - mthread_outlen);
207 if (mthread_outlen != mszh_dlen) {
208 av_log(avctx, AV_LOG_ERROR, "Mthread2 decoded size differs (%d != %d)\n",
209 mthread_outlen, mszh_dlen);
210 return AVERROR_INVALIDDATA;
212 encoded = c->decomp_buf;
213 len = c->decomp_size;
215 mszh_dlen = mszh_decomp(buf, len, c->decomp_buf, c->decomp_size);
216 if (c->decomp_size != mszh_dlen) {
217 av_log(avctx, AV_LOG_ERROR, "Decoded size differs (%d != %d)\n",
218 c->decomp_size, mszh_dlen);
219 return AVERROR_INVALIDDATA;
221 encoded = c->decomp_buf;
225 case COMP_MSZH_NOCOMP: {
227 switch (c->imgtype) {
241 bppx2 = 0; // will error out below
244 if (len < ((width * height * bppx2) >> 1))
245 return AVERROR_INVALIDDATA;
249 av_log(avctx, AV_LOG_ERROR, "BUG! Unknown MSZH compression in frame decoder.\n");
250 return AVERROR_INVALIDDATA;
253 #if CONFIG_ZLIB_DECODER
254 case AV_CODEC_ID_ZLIB:
255 /* Using the original dll with normal compression (-1) and RGB format
256 * gives a file with ZLIB fourcc, but frame is really uncompressed.
257 * To be sure that's true check also frame size */
258 if (c->compression == COMP_ZLIB_NORMAL && c->imgtype == IMGTYPE_RGB24 &&
259 len == width * height * 3) {
260 if (c->flags & FLAG_PNGFILTER) {
261 memcpy(c->decomp_buf, buf, len);
262 encoded = c->decomp_buf;
266 } else if (c->flags & FLAG_MULTITHREAD) {
267 mthread_inlen = AV_RL32(buf);
268 mthread_inlen = FFMIN(mthread_inlen, len - 8);
269 mthread_outlen = AV_RL32(buf + 4);
270 mthread_outlen = FFMIN(mthread_outlen, c->decomp_size);
271 ret = zlib_decomp(avctx, buf + 8, mthread_inlen, 0, mthread_outlen);
272 if (ret < 0) return ret;
273 ret = zlib_decomp(avctx, buf + 8 + mthread_inlen, len - 8 - mthread_inlen,
274 mthread_outlen, mthread_outlen);
275 if (ret < 0) return ret;
277 int ret = zlib_decomp(avctx, buf, len, 0, c->decomp_size);
278 if (ret < 0) return ret;
280 encoded = c->decomp_buf;
281 len = c->decomp_size;
285 av_log(avctx, AV_LOG_ERROR, "BUG! Unknown codec in frame decoder compression switch.\n");
286 return AVERROR_INVALIDDATA;
290 /* Apply PNG filter */
291 if (avctx->codec_id == AV_CODEC_ID_ZLIB && (c->flags & FLAG_PNGFILTER)) {
292 switch (c->imgtype) {
295 for (row = 0; row < height; row++) {
296 pixel_ptr = row * width * 3;
297 yq = encoded[pixel_ptr++];
298 uqvq = AV_RL16(encoded+pixel_ptr);
300 for (col = 1; col < width; col++) {
301 encoded[pixel_ptr] = yq -= encoded[pixel_ptr];
302 uqvq -= AV_RL16(encoded+pixel_ptr+1);
303 AV_WL16(encoded+pixel_ptr+1, uqvq);
309 for (row = 0; row < height; row++) {
310 pixel_ptr = row * width * 2;
312 for (col = 0; col < width/4; col++) {
313 encoded[pixel_ptr] = yq -= encoded[pixel_ptr];
314 encoded[pixel_ptr+1] = yq -= encoded[pixel_ptr+1];
315 encoded[pixel_ptr+2] = yq -= encoded[pixel_ptr+2];
316 encoded[pixel_ptr+3] = yq -= encoded[pixel_ptr+3];
317 encoded[pixel_ptr+4] = uq -= encoded[pixel_ptr+4];
318 encoded[pixel_ptr+5] = uq -= encoded[pixel_ptr+5];
319 encoded[pixel_ptr+6] = vq -= encoded[pixel_ptr+6];
320 encoded[pixel_ptr+7] = vq -= encoded[pixel_ptr+7];
326 for (row = 0; row < height; row++) {
327 pixel_ptr = row * width / 2 * 3;
329 for (col = 0; col < width/4; col++) {
330 encoded[pixel_ptr] = yq -= encoded[pixel_ptr];
331 encoded[pixel_ptr+1] = yq -= encoded[pixel_ptr+1];
332 encoded[pixel_ptr+2] = yq -= encoded[pixel_ptr+2];
333 encoded[pixel_ptr+3] = yq -= encoded[pixel_ptr+3];
334 encoded[pixel_ptr+4] = uq -= encoded[pixel_ptr+4];
335 encoded[pixel_ptr+5] = vq -= encoded[pixel_ptr+5];
341 for (row = 0; row < height; row++) {
342 pixel_ptr = row * width * 2;
344 for (col = 0; col < width/2; col++) {
345 encoded[pixel_ptr] = yq -= encoded[pixel_ptr];
346 encoded[pixel_ptr+1] = yq -= encoded[pixel_ptr+1];
347 encoded[pixel_ptr+2] = uq -= encoded[pixel_ptr+2];
348 encoded[pixel_ptr+3] = vq -= encoded[pixel_ptr+3];
354 for (row = 0; row < height/2; row++) {
355 pixel_ptr = row * width * 3;
356 yq = y1q = uq = vq =0;
357 for (col = 0; col < width/2; col++) {
358 encoded[pixel_ptr] = yq -= encoded[pixel_ptr];
359 encoded[pixel_ptr+1] = yq -= encoded[pixel_ptr+1];
360 encoded[pixel_ptr+2] = y1q -= encoded[pixel_ptr+2];
361 encoded[pixel_ptr+3] = y1q -= encoded[pixel_ptr+3];
362 encoded[pixel_ptr+4] = uq -= encoded[pixel_ptr+4];
363 encoded[pixel_ptr+5] = vq -= encoded[pixel_ptr+5];
369 av_log(avctx, AV_LOG_ERROR, "BUG! Unknown imagetype in pngfilter switch.\n");
370 return AVERROR_INVALIDDATA;
374 /* Convert colorspace */
375 y_out = frame->data[0] + (height - 1) * frame->linesize[0];
376 u_out = frame->data[1] + (height - 1) * frame->linesize[1];
377 v_out = frame->data[2] + (height - 1) * frame->linesize[2];
378 switch (c->imgtype) {
380 for (row = 0; row < height; row++) {
381 for (col = 0; col < width; col++) {
382 y_out[col] = *encoded++;
383 u_out[col] = *encoded++ + 128;
384 v_out[col] = *encoded++ + 128;
386 y_out -= frame->linesize[0];
387 u_out -= frame->linesize[1];
388 v_out -= frame->linesize[2];
392 for (row = 0; row < height; row++) {
393 for (col = 0; col < width - 3; col += 4) {
394 memcpy(y_out + col, encoded, 4);
396 u_out[ col >> 1 ] = *encoded++ + 128;
397 u_out[(col >> 1) + 1] = *encoded++ + 128;
398 v_out[ col >> 1 ] = *encoded++ + 128;
399 v_out[(col >> 1) + 1] = *encoded++ + 128;
401 y_out -= frame->linesize[0];
402 u_out -= frame->linesize[1];
403 v_out -= frame->linesize[2];
407 linesize = len < FFALIGN(3 * width, 4) * height ? 3 * width : FFALIGN(3 * width, 4);
408 for (row = height - 1; row >= 0; row--) {
409 pixel_ptr = row * frame->linesize[0];
410 memcpy(outptr + pixel_ptr, encoded, 3 * width);
415 for (row = 0; row < height; row++) {
416 for (col = 0; col < width - 3; col += 4) {
417 memcpy(y_out + col, encoded, 4);
419 u_out[col >> 2] = *encoded++ + 128;
420 v_out[col >> 2] = *encoded++ + 128;
422 y_out -= frame->linesize[0];
423 u_out -= frame->linesize[1];
424 v_out -= frame->linesize[2];
428 for (row = 0; row < height; row++) {
429 for (col = 0; col < width - 1; col += 2) {
430 memcpy(y_out + col, encoded, 2);
432 u_out[col >> 1] = *encoded++ + 128;
433 v_out[col >> 1] = *encoded++ + 128;
435 y_out -= frame->linesize[0];
436 u_out -= frame->linesize[1];
437 v_out -= frame->linesize[2];
441 u_out = frame->data[1] + ((height >> 1) - 1) * frame->linesize[1];
442 v_out = frame->data[2] + ((height >> 1) - 1) * frame->linesize[2];
443 for (row = 0; row < height - 1; row += 2) {
444 for (col = 0; col < width - 1; col += 2) {
445 memcpy(y_out + col, encoded, 2);
447 memcpy(y_out + col - frame->linesize[0], encoded, 2);
449 u_out[col >> 1] = *encoded++ + 128;
450 v_out[col >> 1] = *encoded++ + 128;
452 y_out -= frame->linesize[0] << 1;
453 u_out -= frame->linesize[1];
454 v_out -= frame->linesize[2];
458 av_log(avctx, AV_LOG_ERROR, "BUG! Unknown imagetype in image decoder.\n");
459 return AVERROR_INVALIDDATA;
462 frame->key_frame = 1;
463 frame->pict_type = AV_PICTURE_TYPE_I;
467 /* always report that the buffer was completely consumed */
471 static av_cold int decode_init(AVCodecContext *avctx)
473 LclDecContext * const c = avctx->priv_data;
474 unsigned int basesize = avctx->width * avctx->height;
475 unsigned int max_basesize = FFALIGN(avctx->width, 4) *
476 FFALIGN(avctx->height, 4);
477 unsigned int max_decomp_size;
478 int subsample_h, subsample_v;
480 if (avctx->extradata_size < 8) {
481 av_log(avctx, AV_LOG_ERROR, "Extradata size too small.\n");
482 return AVERROR_INVALIDDATA;
485 /* Check codec type */
486 if ((avctx->codec_id == AV_CODEC_ID_MSZH && avctx->extradata[7] != CODEC_MSZH) ||
487 (avctx->codec_id == AV_CODEC_ID_ZLIB && avctx->extradata[7] != CODEC_ZLIB)) {
488 av_log(avctx, AV_LOG_ERROR, "Codec id and codec type mismatch. This should not happen.\n");
491 /* Detect image type */
492 switch (c->imgtype = avctx->extradata[4]) {
494 c->decomp_size = basesize * 3;
495 max_decomp_size = max_basesize * 3;
496 avctx->pix_fmt = AV_PIX_FMT_YUV444P;
497 av_log(avctx, AV_LOG_DEBUG, "Image type is YUV 1:1:1.\n");
500 c->decomp_size = basesize * 2;
501 max_decomp_size = max_basesize * 2;
502 avctx->pix_fmt = AV_PIX_FMT_YUV422P;
503 av_log(avctx, AV_LOG_DEBUG, "Image type is YUV 4:2:2.\n");
504 if (avctx->width % 4) {
505 avpriv_request_sample(avctx, "Unsupported dimensions");
506 return AVERROR_INVALIDDATA;
510 c->decomp_size = basesize * 3;
511 max_decomp_size = max_basesize * 3;
512 avctx->pix_fmt = AV_PIX_FMT_BGR24;
513 av_log(avctx, AV_LOG_DEBUG, "Image type is RGB 24.\n");
516 c->decomp_size = basesize / 2 * 3;
517 max_decomp_size = max_basesize / 2 * 3;
518 avctx->pix_fmt = AV_PIX_FMT_YUV411P;
519 av_log(avctx, AV_LOG_DEBUG, "Image type is YUV 4:1:1.\n");
522 c->decomp_size = basesize * 2;
523 max_decomp_size = max_basesize * 2;
524 avctx->pix_fmt = AV_PIX_FMT_YUV422P;
525 av_log(avctx, AV_LOG_DEBUG, "Image type is YUV 2:1:1.\n");
528 c->decomp_size = basesize / 2 * 3;
529 max_decomp_size = max_basesize / 2 * 3;
530 avctx->pix_fmt = AV_PIX_FMT_YUV420P;
531 av_log(avctx, AV_LOG_DEBUG, "Image type is YUV 4:2:0.\n");
534 av_log(avctx, AV_LOG_ERROR, "Unsupported image format %d.\n", c->imgtype);
535 return AVERROR_INVALIDDATA;
538 av_pix_fmt_get_chroma_sub_sample(avctx->pix_fmt, &subsample_h, &subsample_v);
539 if (avctx->width % (1<<subsample_h) || avctx->height % (1<<subsample_v)) {
540 avpriv_request_sample(avctx, "Unsupported dimensions");
541 return AVERROR_INVALIDDATA;
544 /* Detect compression method */
545 c->compression = (int8_t)avctx->extradata[5];
546 switch (avctx->codec_id) {
547 case AV_CODEC_ID_MSZH:
548 switch (c->compression) {
550 av_log(avctx, AV_LOG_DEBUG, "Compression enabled.\n");
552 case COMP_MSZH_NOCOMP:
554 av_log(avctx, AV_LOG_DEBUG, "No compression.\n");
557 av_log(avctx, AV_LOG_ERROR, "Unsupported compression format for MSZH (%d).\n", c->compression);
558 return AVERROR_INVALIDDATA;
561 #if CONFIG_ZLIB_DECODER
562 case AV_CODEC_ID_ZLIB:
563 switch (c->compression) {
564 case COMP_ZLIB_HISPEED:
565 av_log(avctx, AV_LOG_DEBUG, "High speed compression.\n");
567 case COMP_ZLIB_HICOMP:
568 av_log(avctx, AV_LOG_DEBUG, "High compression.\n");
570 case COMP_ZLIB_NORMAL:
571 av_log(avctx, AV_LOG_DEBUG, "Normal compression.\n");
574 if (c->compression < Z_NO_COMPRESSION || c->compression > Z_BEST_COMPRESSION) {
575 av_log(avctx, AV_LOG_ERROR, "Unsupported compression level for ZLIB: (%d).\n", c->compression);
576 return AVERROR_INVALIDDATA;
578 av_log(avctx, AV_LOG_DEBUG, "Compression level for ZLIB: (%d).\n", c->compression);
583 av_log(avctx, AV_LOG_ERROR, "BUG! Unknown codec in compression switch.\n");
584 return AVERROR_INVALIDDATA;
587 /* Allocate decompression buffer */
588 if (c->decomp_size) {
589 if (!(c->decomp_buf = av_malloc(max_decomp_size))) {
590 av_log(avctx, AV_LOG_ERROR, "Can't allocate decompression buffer.\n");
591 return AVERROR(ENOMEM);
596 c->flags = avctx->extradata[6];
597 if (c->flags & FLAG_MULTITHREAD)
598 av_log(avctx, AV_LOG_DEBUG, "Multithread encoder flag set.\n");
599 if (c->flags & FLAG_NULLFRAME)
600 av_log(avctx, AV_LOG_DEBUG, "Nullframe insertion flag set.\n");
601 if (avctx->codec_id == AV_CODEC_ID_ZLIB && (c->flags & FLAG_PNGFILTER))
602 av_log(avctx, AV_LOG_DEBUG, "PNG filter flag set.\n");
603 if (c->flags & FLAGMASK_UNUSED)
604 av_log(avctx, AV_LOG_ERROR, "Unknown flag set (%d).\n", c->flags);
606 /* If needed init zlib */
607 #if CONFIG_ZLIB_DECODER
608 if (avctx->codec_id == AV_CODEC_ID_ZLIB) {
610 c->zstream.zalloc = Z_NULL;
611 c->zstream.zfree = Z_NULL;
612 c->zstream.opaque = Z_NULL;
613 zret = inflateInit(&c->zstream);
615 av_log(avctx, AV_LOG_ERROR, "Inflate init error: %d\n", zret);
616 av_freep(&c->decomp_buf);
617 return AVERROR_UNKNOWN;
625 static av_cold int decode_end(AVCodecContext *avctx)
627 LclDecContext * const c = avctx->priv_data;
629 av_freep(&c->decomp_buf);
630 #if CONFIG_ZLIB_DECODER
631 if (avctx->codec_id == AV_CODEC_ID_ZLIB)
632 inflateEnd(&c->zstream);
638 #if CONFIG_MSZH_DECODER
639 AVCodec ff_mszh_decoder = {
641 .long_name = NULL_IF_CONFIG_SMALL("LCL (LossLess Codec Library) MSZH"),
642 .type = AVMEDIA_TYPE_VIDEO,
643 .id = AV_CODEC_ID_MSZH,
644 .priv_data_size = sizeof(LclDecContext),
647 .decode = decode_frame,
648 .capabilities = AV_CODEC_CAP_DR1 | AV_CODEC_CAP_FRAME_THREADS,
649 .caps_internal = FF_CODEC_CAP_INIT_THREADSAFE,
653 #if CONFIG_ZLIB_DECODER
654 AVCodec ff_zlib_decoder = {
656 .long_name = NULL_IF_CONFIG_SMALL("LCL (LossLess Codec Library) ZLIB"),
657 .type = AVMEDIA_TYPE_VIDEO,
658 .id = AV_CODEC_ID_ZLIB,
659 .priv_data_size = sizeof(LclDecContext),
662 .decode = decode_frame,
663 .capabilities = AV_CODEC_CAP_DR1 | AV_CODEC_CAP_FRAME_THREADS,
664 .caps_internal = FF_CODEC_CAP_INIT_THREADSAFE,