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)
44 #include "libavutil/mem.h"
46 #include "bytestream.h"
50 #if CONFIG_ZLIB_DECODER
57 typedef struct LclDecContext {
66 // Decompressed data size
67 unsigned int decomp_size;
68 // Decompression buffer
69 unsigned char* decomp_buf;
70 #if CONFIG_ZLIB_DECODER
77 * @param srcptr compressed source buffer, must be padded with at least 5 extra bytes
78 * @param destptr must be padded sufficiently for av_memcpy_backptr
80 static unsigned int mszh_decomp(const unsigned char * srcptr, int srclen, unsigned char * destptr, unsigned int destsize)
82 unsigned char *destptr_bak = destptr;
83 unsigned char *destptr_end = destptr + destsize;
84 const unsigned char *srcptr_end = srcptr + srclen;
85 unsigned mask = *srcptr++;
86 unsigned maskbit = 0x80;
88 while (srcptr < srcptr_end && destptr < destptr_end) {
89 if (!(mask & maskbit)) {
90 memcpy(destptr, srcptr, 4);
94 unsigned ofs = bytestream_get_le16(&srcptr);
95 unsigned cnt = (ofs >> 11) + 1;
97 ofs = FFMIN(ofs, destptr - destptr_bak);
99 cnt = FFMIN(cnt, destptr_end - destptr);
101 av_memcpy_backptr(destptr, ofs, cnt);
103 // Not known what the correct behaviour is, but
104 // this at least avoids uninitialized data.
105 memset(destptr, 0, cnt);
113 if (destptr_end - destptr < 32 || srcptr_end - srcptr < 32) break;
114 memcpy(destptr, srcptr, 32);
123 return destptr - destptr_bak;
127 #if CONFIG_ZLIB_DECODER
129 * @brief decompress a zlib-compressed data block into decomp_buf
130 * @param src compressed input buffer
131 * @param src_len data length in input buffer
132 * @param offset offset in decomp_buf
133 * @param expected expected decompressed length
135 static int zlib_decomp(AVCodecContext *avctx, const uint8_t *src, int src_len, int offset, int expected)
137 LclDecContext *c = avctx->priv_data;
138 int zret = inflateReset(&c->zstream);
140 av_log(avctx, AV_LOG_ERROR, "Inflate reset error: %d\n", zret);
143 c->zstream.next_in = src;
144 c->zstream.avail_in = src_len;
145 c->zstream.next_out = c->decomp_buf + offset;
146 c->zstream.avail_out = c->decomp_size - offset;
147 zret = inflate(&c->zstream, Z_FINISH);
148 if (zret != Z_OK && zret != Z_STREAM_END) {
149 av_log(avctx, AV_LOG_ERROR, "Inflate error: %d\n", zret);
152 if (expected != (unsigned int)c->zstream.total_out) {
153 av_log(avctx, AV_LOG_ERROR, "Decoded size differs (%d != %lu)\n",
154 expected, c->zstream.total_out);
157 return c->zstream.total_out;
167 static int decode_frame(AVCodecContext *avctx, void *data, int *got_frame, AVPacket *avpkt)
169 const uint8_t *buf = avpkt->data;
170 int buf_size = avpkt->size;
171 LclDecContext * const c = avctx->priv_data;
172 unsigned char *encoded = (unsigned char *)buf;
173 unsigned int pixel_ptr;
175 unsigned char *outptr;
176 uint8_t *y_out, *u_out, *v_out;
177 unsigned int width = avctx->width; // Real image width
178 unsigned int height = avctx->height; // Real image height
179 unsigned int mszh_dlen;
180 unsigned char yq, y1q, uq, vq;
182 unsigned int mthread_inlen, mthread_outlen;
183 unsigned int len = buf_size;
186 avctx->release_buffer(avctx, &c->pic);
188 c->pic.reference = 0;
189 c->pic.buffer_hints = FF_BUFFER_HINTS_VALID;
190 if(ff_get_buffer(avctx, &c->pic) < 0){
191 av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
195 outptr = c->pic.data[0]; // Output image pointer
197 /* Decompress frame */
198 switch (avctx->codec_id) {
199 case AV_CODEC_ID_MSZH:
200 switch (c->compression) {
202 if (c->imgtype == IMGTYPE_RGB24 && len == width * height * 3) {
204 } else if (c->flags & FLAG_MULTITHREAD) {
205 mthread_inlen = AV_RL32(encoded);
206 mthread_inlen = FFMIN(mthread_inlen, len - 8);
207 mthread_outlen = AV_RL32(encoded+4);
208 mthread_outlen = FFMIN(mthread_outlen, c->decomp_size);
209 mszh_dlen = mszh_decomp(encoded + 8, mthread_inlen, c->decomp_buf, c->decomp_size);
210 if (mthread_outlen != mszh_dlen) {
211 av_log(avctx, AV_LOG_ERROR, "Mthread1 decoded size differs (%d != %d)\n",
212 mthread_outlen, mszh_dlen);
215 mszh_dlen = mszh_decomp(encoded + 8 + mthread_inlen, len - 8 - mthread_inlen,
216 c->decomp_buf + mthread_outlen, c->decomp_size - mthread_outlen);
217 if (mthread_outlen != mszh_dlen) {
218 av_log(avctx, AV_LOG_ERROR, "Mthread2 decoded size differs (%d != %d)\n",
219 mthread_outlen, mszh_dlen);
222 encoded = c->decomp_buf;
223 len = c->decomp_size;
225 mszh_dlen = mszh_decomp(encoded, len, c->decomp_buf, c->decomp_size);
226 if (c->decomp_size != mszh_dlen) {
227 av_log(avctx, AV_LOG_ERROR, "Decoded size differs (%d != %d)\n",
228 c->decomp_size, mszh_dlen);
231 encoded = c->decomp_buf;
235 case COMP_MSZH_NOCOMP: {
237 switch (c->imgtype) {
251 bppx2 = 0; // will error out below
254 if (len < ((width * height * bppx2) >> 1))
255 return AVERROR_INVALIDDATA;
259 av_log(avctx, AV_LOG_ERROR, "BUG! Unknown MSZH compression in frame decoder.\n");
263 #if CONFIG_ZLIB_DECODER
264 case AV_CODEC_ID_ZLIB:
265 /* Using the original dll with normal compression (-1) and RGB format
266 * gives a file with ZLIB fourcc, but frame is really uncompressed.
267 * To be sure that's true check also frame size */
268 if (c->compression == COMP_ZLIB_NORMAL && c->imgtype == IMGTYPE_RGB24 &&
269 len == width * height * 3) {
270 if (c->flags & FLAG_PNGFILTER) {
271 memcpy(c->decomp_buf, encoded, len);
272 encoded = c->decomp_buf;
276 } else if (c->flags & FLAG_MULTITHREAD) {
278 mthread_inlen = AV_RL32(encoded);
279 mthread_inlen = FFMIN(mthread_inlen, len - 8);
280 mthread_outlen = AV_RL32(encoded+4);
281 mthread_outlen = FFMIN(mthread_outlen, c->decomp_size);
282 ret = zlib_decomp(avctx, encoded + 8, mthread_inlen, 0, mthread_outlen);
283 if (ret < 0) return ret;
284 ret = zlib_decomp(avctx, encoded + 8 + mthread_inlen, len - 8 - mthread_inlen,
285 mthread_outlen, mthread_outlen);
286 if (ret < 0) return ret;
288 int ret = zlib_decomp(avctx, encoded, len, 0, c->decomp_size);
289 if (ret < 0) return ret;
291 encoded = c->decomp_buf;
292 len = c->decomp_size;
296 av_log(avctx, AV_LOG_ERROR, "BUG! Unknown codec in frame decoder compression switch.\n");
301 /* Apply PNG filter */
302 if (avctx->codec_id == AV_CODEC_ID_ZLIB && (c->flags & FLAG_PNGFILTER)) {
303 switch (c->imgtype) {
306 for (row = 0; row < height; row++) {
307 pixel_ptr = row * width * 3;
308 yq = encoded[pixel_ptr++];
309 uqvq = AV_RL16(encoded+pixel_ptr);
311 for (col = 1; col < width; col++) {
312 encoded[pixel_ptr] = yq -= encoded[pixel_ptr];
313 uqvq -= AV_RL16(encoded+pixel_ptr+1);
314 AV_WL16(encoded+pixel_ptr+1, uqvq);
320 for (row = 0; row < height; row++) {
321 pixel_ptr = row * width * 2;
323 for (col = 0; col < width/4; col++) {
324 encoded[pixel_ptr] = yq -= encoded[pixel_ptr];
325 encoded[pixel_ptr+1] = yq -= encoded[pixel_ptr+1];
326 encoded[pixel_ptr+2] = yq -= encoded[pixel_ptr+2];
327 encoded[pixel_ptr+3] = yq -= encoded[pixel_ptr+3];
328 encoded[pixel_ptr+4] = uq -= encoded[pixel_ptr+4];
329 encoded[pixel_ptr+5] = uq -= encoded[pixel_ptr+5];
330 encoded[pixel_ptr+6] = vq -= encoded[pixel_ptr+6];
331 encoded[pixel_ptr+7] = vq -= encoded[pixel_ptr+7];
337 for (row = 0; row < height; row++) {
338 pixel_ptr = row * width / 2 * 3;
340 for (col = 0; col < width/4; col++) {
341 encoded[pixel_ptr] = yq -= encoded[pixel_ptr];
342 encoded[pixel_ptr+1] = yq -= encoded[pixel_ptr+1];
343 encoded[pixel_ptr+2] = yq -= encoded[pixel_ptr+2];
344 encoded[pixel_ptr+3] = yq -= encoded[pixel_ptr+3];
345 encoded[pixel_ptr+4] = uq -= encoded[pixel_ptr+4];
346 encoded[pixel_ptr+5] = vq -= encoded[pixel_ptr+5];
352 for (row = 0; row < height; row++) {
353 pixel_ptr = row * width * 2;
355 for (col = 0; col < width/2; col++) {
356 encoded[pixel_ptr] = yq -= encoded[pixel_ptr];
357 encoded[pixel_ptr+1] = yq -= encoded[pixel_ptr+1];
358 encoded[pixel_ptr+2] = uq -= encoded[pixel_ptr+2];
359 encoded[pixel_ptr+3] = vq -= encoded[pixel_ptr+3];
365 for (row = 0; row < height/2; row++) {
366 pixel_ptr = row * width * 3;
367 yq = y1q = uq = vq =0;
368 for (col = 0; col < width/2; col++) {
369 encoded[pixel_ptr] = yq -= encoded[pixel_ptr];
370 encoded[pixel_ptr+1] = yq -= encoded[pixel_ptr+1];
371 encoded[pixel_ptr+2] = y1q -= encoded[pixel_ptr+2];
372 encoded[pixel_ptr+3] = y1q -= encoded[pixel_ptr+3];
373 encoded[pixel_ptr+4] = uq -= encoded[pixel_ptr+4];
374 encoded[pixel_ptr+5] = vq -= encoded[pixel_ptr+5];
380 av_log(avctx, AV_LOG_ERROR, "BUG! Unknown imagetype in pngfilter switch.\n");
385 /* Convert colorspace */
386 y_out = c->pic.data[0] + (height - 1) * c->pic.linesize[0];
387 u_out = c->pic.data[1] + (height - 1) * c->pic.linesize[1];
388 v_out = c->pic.data[2] + (height - 1) * c->pic.linesize[2];
389 switch (c->imgtype) {
391 for (row = 0; row < height; row++) {
392 for (col = 0; col < width; col++) {
393 y_out[col] = *encoded++;
394 u_out[col] = *encoded++ + 128;
395 v_out[col] = *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 - 3; col += 4) {
405 memcpy(y_out + col, encoded, 4);
407 u_out[ col >> 1 ] = *encoded++ + 128;
408 u_out[(col >> 1) + 1] = *encoded++ + 128;
409 v_out[ col >> 1 ] = *encoded++ + 128;
410 v_out[(col >> 1) + 1] = *encoded++ + 128;
412 y_out -= c->pic.linesize[0];
413 u_out -= c->pic.linesize[1];
414 v_out -= c->pic.linesize[2];
418 for (row = height - 1; row >= 0; row--) {
419 pixel_ptr = row * c->pic.linesize[0];
420 memcpy(outptr + pixel_ptr, encoded, 3 * width);
421 encoded += 3 * width;
425 for (row = 0; row < height; row++) {
426 for (col = 0; col < width - 3; col += 4) {
427 memcpy(y_out + col, encoded, 4);
429 u_out[col >> 2] = *encoded++ + 128;
430 v_out[col >> 2] = *encoded++ + 128;
432 y_out -= c->pic.linesize[0];
433 u_out -= c->pic.linesize[1];
434 v_out -= c->pic.linesize[2];
438 for (row = 0; row < height; row++) {
439 for (col = 0; col < width - 1; col += 2) {
440 memcpy(y_out + col, encoded, 2);
442 u_out[col >> 1] = *encoded++ + 128;
443 v_out[col >> 1] = *encoded++ + 128;
445 y_out -= c->pic.linesize[0];
446 u_out -= c->pic.linesize[1];
447 v_out -= c->pic.linesize[2];
451 u_out = c->pic.data[1] + ((height >> 1) - 1) * c->pic.linesize[1];
452 v_out = c->pic.data[2] + ((height >> 1) - 1) * c->pic.linesize[2];
453 for (row = 0; row < height - 1; row += 2) {
454 for (col = 0; col < width - 1; col += 2) {
455 memcpy(y_out + col, encoded, 2);
457 memcpy(y_out + col - c->pic.linesize[0], encoded, 2);
459 u_out[col >> 1] = *encoded++ + 128;
460 v_out[col >> 1] = *encoded++ + 128;
462 y_out -= c->pic.linesize[0] << 1;
463 u_out -= c->pic.linesize[1];
464 v_out -= c->pic.linesize[2];
468 av_log(avctx, AV_LOG_ERROR, "BUG! Unknown imagetype in image decoder.\n");
473 *(AVFrame*)data = c->pic;
475 /* always report that the buffer was completely consumed */
484 static av_cold int decode_init(AVCodecContext *avctx)
486 LclDecContext * const c = avctx->priv_data;
487 unsigned int basesize = avctx->width * avctx->height;
488 unsigned int max_basesize = FFALIGN(avctx->width, 4) *
489 FFALIGN(avctx->height, 4);
490 unsigned int max_decomp_size;
492 avcodec_get_frame_defaults(&c->pic);
493 if (avctx->extradata_size < 8) {
494 av_log(avctx, AV_LOG_ERROR, "Extradata size too small.\n");
495 return AVERROR_INVALIDDATA;
498 /* Check codec type */
499 if ((avctx->codec_id == AV_CODEC_ID_MSZH && avctx->extradata[7] != CODEC_MSZH) ||
500 (avctx->codec_id == AV_CODEC_ID_ZLIB && avctx->extradata[7] != CODEC_ZLIB)) {
501 av_log(avctx, AV_LOG_ERROR, "Codec id and codec type mismatch. This should not happen.\n");
504 /* Detect image type */
505 switch (c->imgtype = avctx->extradata[4]) {
507 c->decomp_size = basesize * 3;
508 max_decomp_size = max_basesize * 3;
509 avctx->pix_fmt = AV_PIX_FMT_YUV444P;
510 av_log(avctx, AV_LOG_DEBUG, "Image type is YUV 1:1:1.\n");
513 c->decomp_size = basesize * 2;
514 max_decomp_size = max_basesize * 2;
515 avctx->pix_fmt = AV_PIX_FMT_YUV422P;
516 av_log(avctx, AV_LOG_DEBUG, "Image type is YUV 4:2:2.\n");
519 c->decomp_size = basesize * 3;
520 max_decomp_size = max_basesize * 3;
521 avctx->pix_fmt = AV_PIX_FMT_BGR24;
522 av_log(avctx, AV_LOG_DEBUG, "Image type is RGB 24.\n");
525 c->decomp_size = basesize / 2 * 3;
526 max_decomp_size = max_basesize / 2 * 3;
527 avctx->pix_fmt = AV_PIX_FMT_YUV411P;
528 av_log(avctx, AV_LOG_DEBUG, "Image type is YUV 4:1:1.\n");
531 c->decomp_size = basesize * 2;
532 max_decomp_size = max_basesize * 2;
533 avctx->pix_fmt = AV_PIX_FMT_YUV422P;
534 av_log(avctx, AV_LOG_DEBUG, "Image type is YUV 2:1:1.\n");
537 c->decomp_size = basesize / 2 * 3;
538 max_decomp_size = max_basesize / 2 * 3;
539 avctx->pix_fmt = AV_PIX_FMT_YUV420P;
540 av_log(avctx, AV_LOG_DEBUG, "Image type is YUV 4:2:0.\n");
543 av_log(avctx, AV_LOG_ERROR, "Unsupported image format %d.\n", c->imgtype);
544 return AVERROR_INVALIDDATA;
547 /* Detect compression method */
548 c->compression = (int8_t)avctx->extradata[5];
549 switch (avctx->codec_id) {
550 case AV_CODEC_ID_MSZH:
551 switch (c->compression) {
553 av_log(avctx, AV_LOG_DEBUG, "Compression enabled.\n");
555 case COMP_MSZH_NOCOMP:
557 av_log(avctx, AV_LOG_DEBUG, "No compression.\n");
560 av_log(avctx, AV_LOG_ERROR, "Unsupported compression format for MSZH (%d).\n", c->compression);
561 return AVERROR_INVALIDDATA;
564 #if CONFIG_ZLIB_DECODER
565 case AV_CODEC_ID_ZLIB:
566 switch (c->compression) {
567 case COMP_ZLIB_HISPEED:
568 av_log(avctx, AV_LOG_DEBUG, "High speed compression.\n");
570 case COMP_ZLIB_HICOMP:
571 av_log(avctx, AV_LOG_DEBUG, "High compression.\n");
573 case COMP_ZLIB_NORMAL:
574 av_log(avctx, AV_LOG_DEBUG, "Normal compression.\n");
577 if (c->compression < Z_NO_COMPRESSION || c->compression > Z_BEST_COMPRESSION) {
578 av_log(avctx, AV_LOG_ERROR, "Unsupported compression level for ZLIB: (%d).\n", c->compression);
579 return AVERROR_INVALIDDATA;
581 av_log(avctx, AV_LOG_DEBUG, "Compression level for ZLIB: (%d).\n", c->compression);
586 av_log(avctx, AV_LOG_ERROR, "BUG! Unknown codec in compression switch.\n");
587 return AVERROR_INVALIDDATA;
590 /* Allocate decompression buffer */
591 if (c->decomp_size) {
592 if ((c->decomp_buf = av_malloc(max_decomp_size)) == NULL) {
593 av_log(avctx, AV_LOG_ERROR, "Can't allocate decompression buffer.\n");
594 return AVERROR(ENOMEM);
599 c->flags = avctx->extradata[6];
600 if (c->flags & FLAG_MULTITHREAD)
601 av_log(avctx, AV_LOG_DEBUG, "Multithread encoder flag set.\n");
602 if (c->flags & FLAG_NULLFRAME)
603 av_log(avctx, AV_LOG_DEBUG, "Nullframe insertion flag set.\n");
604 if (avctx->codec_id == AV_CODEC_ID_ZLIB && (c->flags & FLAG_PNGFILTER))
605 av_log(avctx, AV_LOG_DEBUG, "PNG filter flag set.\n");
606 if (c->flags & FLAGMASK_UNUSED)
607 av_log(avctx, AV_LOG_ERROR, "Unknown flag set (%d).\n", c->flags);
609 /* If needed init zlib */
610 #if CONFIG_ZLIB_DECODER
611 if (avctx->codec_id == AV_CODEC_ID_ZLIB) {
613 c->zstream.zalloc = Z_NULL;
614 c->zstream.zfree = Z_NULL;
615 c->zstream.opaque = Z_NULL;
616 zret = inflateInit(&c->zstream);
618 av_log(avctx, AV_LOG_ERROR, "Inflate init error: %d\n", zret);
619 av_freep(&c->decomp_buf);
620 return AVERROR_UNKNOWN;
633 static av_cold int decode_end(AVCodecContext *avctx)
635 LclDecContext * const c = avctx->priv_data;
637 av_freep(&c->decomp_buf);
639 avctx->release_buffer(avctx, &c->pic);
640 #if CONFIG_ZLIB_DECODER
641 if (avctx->codec_id == AV_CODEC_ID_ZLIB)
642 inflateEnd(&c->zstream);
648 #if CONFIG_MSZH_DECODER
649 AVCodec ff_mszh_decoder = {
651 .type = AVMEDIA_TYPE_VIDEO,
652 .id = AV_CODEC_ID_MSZH,
653 .priv_data_size = sizeof(LclDecContext),
656 .decode = decode_frame,
657 .capabilities = CODEC_CAP_DR1,
658 .long_name = NULL_IF_CONFIG_SMALL("LCL (LossLess Codec Library) MSZH"),
662 #if CONFIG_ZLIB_DECODER
663 AVCodec ff_zlib_decoder = {
665 .type = AVMEDIA_TYPE_VIDEO,
666 .id = AV_CODEC_ID_ZLIB,
667 .priv_data_size = sizeof(LclDecContext),
670 .decode = decode_frame,
671 .capabilities = CODEC_CAP_DR1,
672 .long_name = NULL_IF_CONFIG_SMALL("LCL (LossLess Codec Library) ZLIB"),