2 * LCL (LossLess Codec Library) Codec
3 * Copyright (c) 2002-2004 Roberto Togni
5 * This file is part of Libav.
7 * Libav 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 * Libav 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 Libav; 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) {
192 case AV_CODEC_ID_MSZH:
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: {
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");
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, encoded, len);
263 encoded = c->decomp_buf;
267 } else if (c->flags & FLAG_MULTITHREAD) {
269 mthread_inlen = AV_RL32(encoded);
270 mthread_inlen = FFMIN(mthread_inlen, len - 8);
271 mthread_outlen = AV_RL32(encoded+4);
272 mthread_outlen = FFMIN(mthread_outlen, c->decomp_size);
273 ret = zlib_decomp(avctx, encoded + 8, mthread_inlen, 0, mthread_outlen);
274 if (ret < 0) return ret;
275 ret = zlib_decomp(avctx, encoded + 8 + mthread_inlen, len - 8 - mthread_inlen,
276 mthread_outlen, mthread_outlen);
277 if (ret < 0) return ret;
279 int ret = zlib_decomp(avctx, encoded, len, 0, c->decomp_size);
280 if (ret < 0) return ret;
282 encoded = c->decomp_buf;
283 len = c->decomp_size;
287 av_log(avctx, AV_LOG_ERROR, "BUG! Unknown codec in frame decoder compression switch.\n");
292 /* Apply PNG filter */
293 if (avctx->codec_id == AV_CODEC_ID_ZLIB && (c->flags & FLAG_PNGFILTER)) {
294 switch (c->imgtype) {
297 for (row = 0; row < height; row++) {
298 pixel_ptr = row * width * 3;
299 yq = encoded[pixel_ptr++];
300 uqvq = AV_RL16(encoded+pixel_ptr);
302 for (col = 1; col < width; col++) {
303 encoded[pixel_ptr] = yq -= encoded[pixel_ptr];
304 uqvq -= AV_RL16(encoded+pixel_ptr+1);
305 AV_WL16(encoded+pixel_ptr+1, uqvq);
311 for (row = 0; row < height; row++) {
312 pixel_ptr = row * width * 2;
314 for (col = 0; col < width/4; col++) {
315 encoded[pixel_ptr] = yq -= encoded[pixel_ptr];
316 encoded[pixel_ptr+1] = yq -= encoded[pixel_ptr+1];
317 encoded[pixel_ptr+2] = yq -= encoded[pixel_ptr+2];
318 encoded[pixel_ptr+3] = yq -= encoded[pixel_ptr+3];
319 encoded[pixel_ptr+4] = uq -= encoded[pixel_ptr+4];
320 encoded[pixel_ptr+5] = uq -= encoded[pixel_ptr+5];
321 encoded[pixel_ptr+6] = vq -= encoded[pixel_ptr+6];
322 encoded[pixel_ptr+7] = vq -= encoded[pixel_ptr+7];
328 for (row = 0; row < height; row++) {
329 pixel_ptr = row * width / 2 * 3;
331 for (col = 0; col < width/4; col++) {
332 encoded[pixel_ptr] = yq -= encoded[pixel_ptr];
333 encoded[pixel_ptr+1] = yq -= encoded[pixel_ptr+1];
334 encoded[pixel_ptr+2] = yq -= encoded[pixel_ptr+2];
335 encoded[pixel_ptr+3] = yq -= encoded[pixel_ptr+3];
336 encoded[pixel_ptr+4] = uq -= encoded[pixel_ptr+4];
337 encoded[pixel_ptr+5] = vq -= encoded[pixel_ptr+5];
343 for (row = 0; row < height; row++) {
344 pixel_ptr = row * width * 2;
346 for (col = 0; col < width/2; col++) {
347 encoded[pixel_ptr] = yq -= encoded[pixel_ptr];
348 encoded[pixel_ptr+1] = yq -= encoded[pixel_ptr+1];
349 encoded[pixel_ptr+2] = uq -= encoded[pixel_ptr+2];
350 encoded[pixel_ptr+3] = vq -= encoded[pixel_ptr+3];
356 for (row = 0; row < height/2; row++) {
357 pixel_ptr = row * width * 3;
358 yq = y1q = uq = vq =0;
359 for (col = 0; col < width/2; col++) {
360 encoded[pixel_ptr] = yq -= encoded[pixel_ptr];
361 encoded[pixel_ptr+1] = yq -= encoded[pixel_ptr+1];
362 encoded[pixel_ptr+2] = y1q -= encoded[pixel_ptr+2];
363 encoded[pixel_ptr+3] = y1q -= encoded[pixel_ptr+3];
364 encoded[pixel_ptr+4] = uq -= encoded[pixel_ptr+4];
365 encoded[pixel_ptr+5] = vq -= encoded[pixel_ptr+5];
371 av_log(avctx, AV_LOG_ERROR, "BUG! Unknown imagetype in pngfilter switch.\n");
376 /* Convert colorspace */
377 y_out = c->pic.data[0] + (height - 1) * c->pic.linesize[0];
378 u_out = c->pic.data[1] + (height - 1) * c->pic.linesize[1];
379 v_out = c->pic.data[2] + (height - 1) * c->pic.linesize[2];
380 switch (c->imgtype) {
382 for (row = 0; row < height; row++) {
383 for (col = 0; col < width; col++) {
384 y_out[col] = *encoded++;
385 u_out[col] = *encoded++ + 128;
386 v_out[col] = *encoded++ + 128;
388 y_out -= c->pic.linesize[0];
389 u_out -= c->pic.linesize[1];
390 v_out -= c->pic.linesize[2];
394 for (row = 0; row < height; row++) {
395 for (col = 0; col < width - 3; col += 4) {
396 memcpy(y_out + col, encoded, 4);
398 u_out[ col >> 1 ] = *encoded++ + 128;
399 u_out[(col >> 1) + 1] = *encoded++ + 128;
400 v_out[ col >> 1 ] = *encoded++ + 128;
401 v_out[(col >> 1) + 1] = *encoded++ + 128;
403 y_out -= c->pic.linesize[0];
404 u_out -= c->pic.linesize[1];
405 v_out -= c->pic.linesize[2];
409 for (row = height - 1; row >= 0; row--) {
410 pixel_ptr = row * c->pic.linesize[0];
411 memcpy(outptr + pixel_ptr, encoded, 3 * width);
412 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 -= c->pic.linesize[0];
424 u_out -= c->pic.linesize[1];
425 v_out -= c->pic.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 -= c->pic.linesize[0];
437 u_out -= c->pic.linesize[1];
438 v_out -= c->pic.linesize[2];
442 u_out = c->pic.data[1] + ((height >> 1) - 1) * c->pic.linesize[1];
443 v_out = c->pic.data[2] + ((height >> 1) - 1) * c->pic.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 - c->pic.linesize[0], encoded, 2);
450 u_out[col >> 1] = *encoded++ + 128;
451 v_out[col >> 1] = *encoded++ + 128;
453 y_out -= c->pic.linesize[0] << 1;
454 u_out -= c->pic.linesize[1];
455 v_out -= c->pic.linesize[2];
459 av_log(avctx, AV_LOG_ERROR, "BUG! Unknown imagetype in image decoder.\n");
463 *data_size = sizeof(AVFrame);
464 *(AVFrame*)data = c->pic;
466 /* always report that the buffer was completely consumed */
475 static av_cold int decode_init(AVCodecContext *avctx)
477 LclDecContext * const c = avctx->priv_data;
478 unsigned int basesize = avctx->width * avctx->height;
479 unsigned int max_basesize = FFALIGN(avctx->width, 4) * FFALIGN(avctx->height, 4) + AV_LZO_OUTPUT_PADDING;
480 unsigned int max_decomp_size;
482 if (avctx->extradata_size < 8) {
483 av_log(avctx, AV_LOG_ERROR, "Extradata size too small.\n");
484 return AVERROR_INVALIDDATA;
487 /* Check codec type */
488 if ((avctx->codec_id == AV_CODEC_ID_MSZH && avctx->extradata[7] != CODEC_MSZH) ||
489 (avctx->codec_id == AV_CODEC_ID_ZLIB && avctx->extradata[7] != CODEC_ZLIB)) {
490 av_log(avctx, AV_LOG_ERROR, "Codec id and codec type mismatch. This should not happen.\n");
493 /* Detect image type */
494 switch (c->imgtype = avctx->extradata[4]) {
496 c->decomp_size = basesize * 3;
497 max_decomp_size = max_basesize * 3;
498 avctx->pix_fmt = PIX_FMT_YUV444P;
499 av_log(avctx, AV_LOG_DEBUG, "Image type is YUV 1:1:1.\n");
502 c->decomp_size = basesize * 2;
503 max_decomp_size = max_basesize * 2;
504 avctx->pix_fmt = PIX_FMT_YUV422P;
505 av_log(avctx, AV_LOG_DEBUG, "Image type is YUV 4:2:2.\n");
508 c->decomp_size = basesize * 3;
509 max_decomp_size = max_basesize * 3;
510 avctx->pix_fmt = PIX_FMT_BGR24;
511 av_log(avctx, AV_LOG_DEBUG, "Image type is RGB 24.\n");
514 c->decomp_size = basesize / 2 * 3;
515 max_decomp_size = max_basesize / 2 * 3;
516 avctx->pix_fmt = PIX_FMT_YUV411P;
517 av_log(avctx, AV_LOG_DEBUG, "Image type is YUV 4:1:1.\n");
520 c->decomp_size = basesize * 2;
521 max_decomp_size = max_basesize * 2;
522 avctx->pix_fmt = PIX_FMT_YUV422P;
523 av_log(avctx, AV_LOG_DEBUG, "Image type is YUV 2:1:1.\n");
526 c->decomp_size = basesize / 2 * 3;
527 max_decomp_size = max_basesize / 2 * 3;
528 avctx->pix_fmt = PIX_FMT_YUV420P;
529 av_log(avctx, AV_LOG_DEBUG, "Image type is YUV 4:2:0.\n");
532 av_log(avctx, AV_LOG_ERROR, "Unsupported image format %d.\n", c->imgtype);
533 return AVERROR_INVALIDDATA;
536 /* Detect compression method */
537 c->compression = (int8_t)avctx->extradata[5];
538 switch (avctx->codec_id) {
539 case AV_CODEC_ID_MSZH:
540 switch (c->compression) {
542 av_log(avctx, AV_LOG_DEBUG, "Compression enabled.\n");
544 case COMP_MSZH_NOCOMP:
546 av_log(avctx, AV_LOG_DEBUG, "No compression.\n");
549 av_log(avctx, AV_LOG_ERROR, "Unsupported compression format for MSZH (%d).\n", c->compression);
550 return AVERROR_INVALIDDATA;
553 #if CONFIG_ZLIB_DECODER
554 case AV_CODEC_ID_ZLIB:
555 switch (c->compression) {
556 case COMP_ZLIB_HISPEED:
557 av_log(avctx, AV_LOG_DEBUG, "High speed compression.\n");
559 case COMP_ZLIB_HICOMP:
560 av_log(avctx, AV_LOG_DEBUG, "High compression.\n");
562 case COMP_ZLIB_NORMAL:
563 av_log(avctx, AV_LOG_DEBUG, "Normal compression.\n");
566 if (c->compression < Z_NO_COMPRESSION || c->compression > Z_BEST_COMPRESSION) {
567 av_log(avctx, AV_LOG_ERROR, "Unsupported compression level for ZLIB: (%d).\n", c->compression);
568 return AVERROR_INVALIDDATA;
570 av_log(avctx, AV_LOG_DEBUG, "Compression level for ZLIB: (%d).\n", c->compression);
575 av_log(avctx, AV_LOG_ERROR, "BUG! Unknown codec in compression switch.\n");
576 return AVERROR_INVALIDDATA;
579 /* Allocate decompression buffer */
580 if (c->decomp_size) {
581 if ((c->decomp_buf = av_malloc(max_decomp_size)) == NULL) {
582 av_log(avctx, AV_LOG_ERROR, "Can't allocate decompression buffer.\n");
583 return AVERROR(ENOMEM);
588 c->flags = avctx->extradata[6];
589 if (c->flags & FLAG_MULTITHREAD)
590 av_log(avctx, AV_LOG_DEBUG, "Multithread encoder flag set.\n");
591 if (c->flags & FLAG_NULLFRAME)
592 av_log(avctx, AV_LOG_DEBUG, "Nullframe insertion flag set.\n");
593 if (avctx->codec_id == AV_CODEC_ID_ZLIB && (c->flags & FLAG_PNGFILTER))
594 av_log(avctx, AV_LOG_DEBUG, "PNG filter flag set.\n");
595 if (c->flags & FLAGMASK_UNUSED)
596 av_log(avctx, AV_LOG_ERROR, "Unknown flag set (%d).\n", c->flags);
598 /* If needed init zlib */
599 #if CONFIG_ZLIB_DECODER
600 if (avctx->codec_id == AV_CODEC_ID_ZLIB) {
602 c->zstream.zalloc = Z_NULL;
603 c->zstream.zfree = Z_NULL;
604 c->zstream.opaque = Z_NULL;
605 zret = inflateInit(&c->zstream);
607 av_log(avctx, AV_LOG_ERROR, "Inflate init error: %d\n", zret);
608 av_freep(&c->decomp_buf);
609 return AVERROR_UNKNOWN;
622 static av_cold int decode_end(AVCodecContext *avctx)
624 LclDecContext * const c = avctx->priv_data;
626 av_freep(&c->decomp_buf);
628 avctx->release_buffer(avctx, &c->pic);
629 #if CONFIG_ZLIB_DECODER
630 if (avctx->codec_id == AV_CODEC_ID_ZLIB)
631 inflateEnd(&c->zstream);
637 #if CONFIG_MSZH_DECODER
638 AVCodec ff_mszh_decoder = {
640 .type = AVMEDIA_TYPE_VIDEO,
641 .id = AV_CODEC_ID_MSZH,
642 .priv_data_size = sizeof(LclDecContext),
645 .decode = decode_frame,
646 .capabilities = CODEC_CAP_DR1,
647 .long_name = NULL_IF_CONFIG_SMALL("LCL (LossLess Codec Library) MSZH"),
651 #if CONFIG_ZLIB_DECODER
652 AVCodec ff_zlib_decoder = {
654 .type = AVMEDIA_TYPE_VIDEO,
655 .id = AV_CODEC_ID_ZLIB,
656 .priv_data_size = sizeof(LclDecContext),
659 .decode = decode_frame,
660 .capabilities = CODEC_CAP_DR1,
661 .long_name = NULL_IF_CONFIG_SMALL("LCL (LossLess Codec Library) ZLIB"),