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
23 * @file libavcodec/lcldec.c
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)
55 typedef struct LclDecContext {
64 // Decompressed data size
65 unsigned int decomp_size;
66 // Decompression buffer
67 unsigned char* decomp_buf;
79 static inline unsigned char fix (int pix14)
83 tmp = (pix14 + 0x80000) >> 20;
84 return av_clip_uint8(tmp);
89 static inline unsigned char get_b (unsigned char yq, signed char bq)
91 return fix((yq << 20) + bq * 1858076);
96 static inline unsigned char get_g (unsigned char yq, signed char bq, signed char rq)
98 return fix((yq << 20) - bq * 360857 - rq * 748830);
103 static inline unsigned char get_r (unsigned char yq, signed char rq)
105 return fix((yq << 20) + rq * 1470103);
110 static unsigned int mszh_decomp(unsigned char * srcptr, int srclen, unsigned char * destptr, unsigned int destsize)
112 unsigned char *destptr_bak = destptr;
113 unsigned char *destptr_end = destptr + destsize;
114 unsigned char mask = 0;
115 unsigned char maskbit = 0;
116 unsigned int ofs, cnt;
118 while (srclen > 0 && destptr < destptr_end) {
125 if ((mask & (1 << (--maskbit))) == 0) {
126 if (destptr + 4 > destptr_end)
128 AV_WN32(destptr, AV_RN32(srcptr));
136 cnt = ((cnt >> 3) & 0x1f) + 1;
140 if (destptr + cnt > destptr_end) {
141 cnt = destptr_end - destptr;
143 for (; cnt > 0; cnt--) {
144 *destptr = *(destptr - ofs);
150 return destptr - destptr_bak;
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 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;
176 int zret; // Zlib return code
178 unsigned int len = buf_size;
181 avctx->release_buffer(avctx, &c->pic);
183 c->pic.reference = 0;
184 c->pic.buffer_hints = FF_BUFFER_HINTS_VALID;
185 if(avctx->get_buffer(avctx, &c->pic) < 0){
186 av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
190 outptr = c->pic.data[0]; // Output image pointer
192 /* Decompress frame */
193 switch (avctx->codec_id) {
195 switch (c->compression) {
197 if (c->flags & FLAG_MULTITHREAD) {
198 mthread_inlen = *(unsigned int*)encoded;
199 mthread_outlen = *(unsigned int*)(encoded+4);
200 if (mthread_outlen > c->decomp_size) // this should not happen
201 mthread_outlen = c->decomp_size;
202 mszh_dlen = mszh_decomp(encoded + 8, mthread_inlen, c->decomp_buf, c->decomp_size);
203 if (mthread_outlen != mszh_dlen) {
204 av_log(avctx, AV_LOG_ERROR, "Mthread1 decoded size differs (%d != %d)\n",
205 mthread_outlen, mszh_dlen);
208 mszh_dlen = mszh_decomp(encoded + 8 + mthread_inlen, len - mthread_inlen,
209 c->decomp_buf + mthread_outlen, c->decomp_size - mthread_outlen);
210 if (mthread_outlen != mszh_dlen) {
211 av_log(avctx, AV_LOG_ERROR, "Mthread2 decoded size differs (%d != %d)\n",
212 mthread_outlen, mszh_dlen);
215 encoded = c->decomp_buf;
216 len = c->decomp_size;
218 mszh_dlen = mszh_decomp(encoded, len, c->decomp_buf, c->decomp_size);
219 if (c->decomp_size != mszh_dlen) {
220 av_log(avctx, AV_LOG_ERROR, "Decoded size differs (%d != %d)\n",
221 c->decomp_size, mszh_dlen);
224 encoded = c->decomp_buf;
228 case COMP_MSZH_NOCOMP:
231 av_log(avctx, AV_LOG_ERROR, "BUG! Unknown MSZH compression in frame decoder.\n");
237 /* Using the original dll with normal compression (-1) and RGB format
238 * gives a file with ZLIB fourcc, but frame is really uncompressed.
239 * To be sure that's true check also frame size */
240 if (c->compression == COMP_ZLIB_NORMAL && c->imgtype == IMGTYPE_RGB24 &&
241 len == width * height * 3)
243 zret = inflateReset(&c->zstream);
245 av_log(avctx, AV_LOG_ERROR, "Inflate reset error: %d\n", zret);
248 if (c->flags & FLAG_MULTITHREAD) {
249 mthread_inlen = *(unsigned int*)encoded;
250 mthread_outlen = *(unsigned int*)(encoded+4);
251 if (mthread_outlen > c->decomp_size)
252 mthread_outlen = c->decomp_size;
253 c->zstream.next_in = encoded + 8;
254 c->zstream.avail_in = mthread_inlen;
255 c->zstream.next_out = c->decomp_buf;
256 c->zstream.avail_out = c->decomp_size;
257 zret = inflate(&c->zstream, Z_FINISH);
258 if (zret != Z_OK && zret != Z_STREAM_END) {
259 av_log(avctx, AV_LOG_ERROR, "Mthread1 inflate error: %d\n", zret);
262 if (mthread_outlen != (unsigned int)c->zstream.total_out) {
263 av_log(avctx, AV_LOG_ERROR, "Mthread1 decoded size differs (%u != %lu)\n",
264 mthread_outlen, c->zstream.total_out);
267 zret = inflateReset(&c->zstream);
269 av_log(avctx, AV_LOG_ERROR, "Mthread2 inflate reset error: %d\n", zret);
272 c->zstream.next_in = encoded + 8 + mthread_inlen;
273 c->zstream.avail_in = len - mthread_inlen;
274 c->zstream.next_out = c->decomp_buf + mthread_outlen;
275 c->zstream.avail_out = c->decomp_size - mthread_outlen;
276 zret = inflate(&c->zstream, Z_FINISH);
277 if (zret != Z_OK && zret != Z_STREAM_END) {
278 av_log(avctx, AV_LOG_ERROR, "Mthread2 inflate error: %d\n", zret);
281 if (mthread_outlen != (unsigned int)c->zstream.total_out) {
282 av_log(avctx, AV_LOG_ERROR, "Mthread2 decoded size differs (%d != %lu)\n",
283 mthread_outlen, c->zstream.total_out);
287 c->zstream.next_in = encoded;
288 c->zstream.avail_in = len;
289 c->zstream.next_out = c->decomp_buf;
290 c->zstream.avail_out = c->decomp_size;
291 zret = inflate(&c->zstream, Z_FINISH);
292 if (zret != Z_OK && zret != Z_STREAM_END) {
293 av_log(avctx, AV_LOG_ERROR, "Inflate error: %d\n", zret);
296 if (c->decomp_size != (unsigned int)c->zstream.total_out) {
297 av_log(avctx, AV_LOG_ERROR, "Decoded size differs (%d != %lu)\n",
298 c->decomp_size, c->zstream.total_out);
302 encoded = c->decomp_buf;
303 len = c->decomp_size;
305 av_log(avctx, AV_LOG_ERROR, "BUG! Zlib support not compiled in frame decoder.\n");
310 av_log(avctx, AV_LOG_ERROR, "BUG! Unknown codec in frame decoder compression switch.\n");
315 /* Apply PNG filter */
316 if (avctx->codec_id == CODEC_ID_ZLIB && (c->flags & FLAG_PNGFILTER)) {
317 switch (c->imgtype) {
320 for (row = 0; row < height; row++) {
321 pixel_ptr = row * width * 3;
322 yq = encoded[pixel_ptr++];
323 uqvq = AV_RL16(encoded+pixel_ptr);
325 for (col = 1; col < width; col++) {
326 encoded[pixel_ptr] = yq -= encoded[pixel_ptr];
327 uqvq -= AV_RL16(encoded+pixel_ptr+1);
328 AV_WL16(encoded+pixel_ptr+1, uqvq);
334 for (row = 0; row < height; row++) {
335 pixel_ptr = row * width * 2;
337 for (col = 0; col < width/4; col++) {
338 encoded[pixel_ptr] = yq -= encoded[pixel_ptr];
339 encoded[pixel_ptr+1] = yq -= encoded[pixel_ptr+1];
340 encoded[pixel_ptr+2] = yq -= encoded[pixel_ptr+2];
341 encoded[pixel_ptr+3] = yq -= encoded[pixel_ptr+3];
342 encoded[pixel_ptr+4] = uq -= encoded[pixel_ptr+4];
343 encoded[pixel_ptr+5] = uq -= encoded[pixel_ptr+5];
344 encoded[pixel_ptr+6] = vq -= encoded[pixel_ptr+6];
345 encoded[pixel_ptr+7] = vq -= encoded[pixel_ptr+7];
351 for (row = 0; row < height; row++) {
352 pixel_ptr = row * width / 2 * 3;
354 for (col = 0; col < width/4; col++) {
355 encoded[pixel_ptr] = yq -= encoded[pixel_ptr];
356 encoded[pixel_ptr+1] = yq -= encoded[pixel_ptr+1];
357 encoded[pixel_ptr+2] = yq -= encoded[pixel_ptr+2];
358 encoded[pixel_ptr+3] = yq -= encoded[pixel_ptr+3];
359 encoded[pixel_ptr+4] = uq -= encoded[pixel_ptr+4];
360 encoded[pixel_ptr+5] = vq -= encoded[pixel_ptr+5];
366 for (row = 0; row < height; row++) {
367 pixel_ptr = row * width * 2;
369 for (col = 0; col < width/2; col++) {
370 encoded[pixel_ptr] = yq -= encoded[pixel_ptr];
371 encoded[pixel_ptr+1] = yq -= encoded[pixel_ptr+1];
372 encoded[pixel_ptr+2] = uq -= encoded[pixel_ptr+2];
373 encoded[pixel_ptr+3] = vq -= encoded[pixel_ptr+3];
379 for (row = 0; row < height/2; row++) {
380 pixel_ptr = row * width * 3;
381 yq = y1q = uq = vq =0;
382 for (col = 0; col < width/2; col++) {
383 encoded[pixel_ptr] = yq -= encoded[pixel_ptr];
384 encoded[pixel_ptr+1] = yq -= encoded[pixel_ptr+1];
385 encoded[pixel_ptr+2] = y1q -= encoded[pixel_ptr+2];
386 encoded[pixel_ptr+3] = y1q -= encoded[pixel_ptr+3];
387 encoded[pixel_ptr+4] = uq -= encoded[pixel_ptr+4];
388 encoded[pixel_ptr+5] = vq -= encoded[pixel_ptr+5];
394 av_log(avctx, AV_LOG_ERROR, "BUG! Unknown imagetype in pngfilter switch.\n");
399 /* Convert colorspace */
400 switch (c->imgtype) {
402 for (row = height - 1; row >= 0; row--) {
403 pixel_ptr = row * c->pic.linesize[0];
404 for (col = 0; col < width; col++) {
405 outptr[pixel_ptr++] = get_b(encoded[0], encoded[1]);
406 outptr[pixel_ptr++] = get_g(encoded[0], encoded[1], encoded[2]);
407 outptr[pixel_ptr++] = get_r(encoded[0], encoded[2]);
413 for (row = height - 1; row >= 0; row--) {
414 pixel_ptr = row * c->pic.linesize[0];
415 for (col = 0; col < width/4; col++) {
416 outptr[pixel_ptr++] = get_b(encoded[0], encoded[4]);
417 outptr[pixel_ptr++] = get_g(encoded[0], encoded[4], encoded[6]);
418 outptr[pixel_ptr++] = get_r(encoded[0], encoded[6]);
419 outptr[pixel_ptr++] = get_b(encoded[1], encoded[4]);
420 outptr[pixel_ptr++] = get_g(encoded[1], encoded[4], encoded[6]);
421 outptr[pixel_ptr++] = get_r(encoded[1], encoded[6]);
422 outptr[pixel_ptr++] = get_b(encoded[2], encoded[5]);
423 outptr[pixel_ptr++] = get_g(encoded[2], encoded[5], encoded[7]);
424 outptr[pixel_ptr++] = get_r(encoded[2], encoded[7]);
425 outptr[pixel_ptr++] = get_b(encoded[3], encoded[5]);
426 outptr[pixel_ptr++] = get_g(encoded[3], encoded[5], encoded[7]);
427 outptr[pixel_ptr++] = get_r(encoded[3], encoded[7]);
433 for (row = height - 1; row >= 0; row--) {
434 pixel_ptr = row * c->pic.linesize[0];
435 memcpy(outptr + pixel_ptr, encoded, 3 * width);
436 encoded += 3 * width;
440 for (row = height - 1; row >= 0; row--) {
441 pixel_ptr = row * c->pic.linesize[0];
442 for (col = 0; col < width/4; col++) {
443 outptr[pixel_ptr++] = get_b(encoded[0], encoded[4]);
444 outptr[pixel_ptr++] = get_g(encoded[0], encoded[4], encoded[5]);
445 outptr[pixel_ptr++] = get_r(encoded[0], encoded[5]);
446 outptr[pixel_ptr++] = get_b(encoded[1], encoded[4]);
447 outptr[pixel_ptr++] = get_g(encoded[1], encoded[4], encoded[5]);
448 outptr[pixel_ptr++] = get_r(encoded[1], encoded[5]);
449 outptr[pixel_ptr++] = get_b(encoded[2], encoded[4]);
450 outptr[pixel_ptr++] = get_g(encoded[2], encoded[4], encoded[5]);
451 outptr[pixel_ptr++] = get_r(encoded[2], encoded[5]);
452 outptr[pixel_ptr++] = get_b(encoded[3], encoded[4]);
453 outptr[pixel_ptr++] = get_g(encoded[3], encoded[4], encoded[5]);
454 outptr[pixel_ptr++] = get_r(encoded[3], encoded[5]);
460 for (row = height - 1; row >= 0; row--) {
461 pixel_ptr = row * c->pic.linesize[0];
462 for (col = 0; col < width/2; col++) {
463 outptr[pixel_ptr++] = get_b(encoded[0], encoded[2]);
464 outptr[pixel_ptr++] = get_g(encoded[0], encoded[2], encoded[3]);
465 outptr[pixel_ptr++] = get_r(encoded[0], encoded[3]);
466 outptr[pixel_ptr++] = get_b(encoded[1], encoded[2]);
467 outptr[pixel_ptr++] = get_g(encoded[1], encoded[2], encoded[3]);
468 outptr[pixel_ptr++] = get_r(encoded[1], encoded[3]);
474 for (row = height / 2 - 1; row >= 0; row--) {
475 pixel_ptr = 2 * row * c->pic.linesize[0];
476 for (col = 0; col < width/2; col++) {
477 outptr[pixel_ptr] = get_b(encoded[0], encoded[4]);
478 outptr[pixel_ptr+1] = get_g(encoded[0], encoded[4], encoded[5]);
479 outptr[pixel_ptr+2] = get_r(encoded[0], encoded[5]);
480 outptr[pixel_ptr+3] = get_b(encoded[1], encoded[4]);
481 outptr[pixel_ptr+4] = get_g(encoded[1], encoded[4], encoded[5]);
482 outptr[pixel_ptr+5] = get_r(encoded[1], encoded[5]);
483 outptr[pixel_ptr-c->pic.linesize[0]] = get_b(encoded[2], encoded[4]);
484 outptr[pixel_ptr-c->pic.linesize[0]+1] = get_g(encoded[2], encoded[4], encoded[5]);
485 outptr[pixel_ptr-c->pic.linesize[0]+2] = get_r(encoded[2], encoded[5]);
486 outptr[pixel_ptr-c->pic.linesize[0]+3] = get_b(encoded[3], encoded[4]);
487 outptr[pixel_ptr-c->pic.linesize[0]+4] = get_g(encoded[3], encoded[4], encoded[5]);
488 outptr[pixel_ptr-c->pic.linesize[0]+5] = get_r(encoded[3], encoded[5]);
495 av_log(avctx, AV_LOG_ERROR, "BUG! Unknown imagetype in image decoder.\n");
499 *data_size = sizeof(AVFrame);
500 *(AVFrame*)data = c->pic;
502 /* always report that the buffer was completely consumed */
511 static av_cold int decode_init(AVCodecContext *avctx)
513 LclDecContext * const c = avctx->priv_data;
514 unsigned int basesize = avctx->width * avctx->height;
515 unsigned int max_basesize = ((avctx->width + 3) & ~3) * ((avctx->height + 3) & ~3);
516 unsigned int max_decomp_size;
517 int zret; // Zlib return code
519 c->pic.data[0] = NULL;
522 // Needed if zlib unused or init aborted before inflateInit
523 memset(&c->zstream, 0, sizeof(z_stream));
526 if (avctx->extradata_size < 8) {
527 av_log(avctx, AV_LOG_ERROR, "Extradata size too small.\n");
531 if (avcodec_check_dimensions(avctx, avctx->width, avctx->height) < 0) {
535 /* Check codec type */
536 if ((avctx->codec_id == CODEC_ID_MSZH && *((char *)avctx->extradata + 7) != CODEC_MSZH) ||
537 (avctx->codec_id == CODEC_ID_ZLIB && *((char *)avctx->extradata + 7) != CODEC_ZLIB)) {
538 av_log(avctx, AV_LOG_ERROR, "Codec id and codec type mismatch. This should not happen.\n");
541 /* Detect image type */
542 switch (c->imgtype = *((char *)avctx->extradata + 4)) {
544 c->decomp_size = basesize * 3;
545 max_decomp_size = max_basesize * 3;
546 av_log(avctx, AV_LOG_INFO, "Image type is YUV 1:1:1.\n");
549 c->decomp_size = basesize * 2;
550 max_decomp_size = max_basesize * 2;
551 av_log(avctx, AV_LOG_INFO, "Image type is YUV 4:2:2.\n");
554 c->decomp_size = basesize * 3;
555 max_decomp_size = max_basesize * 3;
556 av_log(avctx, AV_LOG_INFO, "Image type is RGB 24.\n");
559 c->decomp_size = basesize / 2 * 3;
560 max_decomp_size = max_basesize / 2 * 3;
561 av_log(avctx, AV_LOG_INFO, "Image type is YUV 4:1:1.\n");
564 c->decomp_size = basesize * 2;
565 max_decomp_size = max_basesize * 2;
566 av_log(avctx, AV_LOG_INFO, "Image type is YUV 2:1:1.\n");
569 c->decomp_size = basesize / 2 * 3;
570 max_decomp_size = max_basesize / 2 * 3;
571 av_log(avctx, AV_LOG_INFO, "Image type is YUV 4:2:0.\n");
574 av_log(avctx, AV_LOG_ERROR, "Unsupported image format %d.\n", c->imgtype);
578 /* Detect compression method */
579 c->compression = *((char *)avctx->extradata + 5);
580 switch (avctx->codec_id) {
582 switch (c->compression) {
584 av_log(avctx, AV_LOG_INFO, "Compression enabled.\n");
586 case COMP_MSZH_NOCOMP:
588 av_log(avctx, AV_LOG_INFO, "No compression.\n");
591 av_log(avctx, AV_LOG_ERROR, "Unsupported compression format for MSZH (%d).\n", c->compression);
597 switch (c->compression) {
598 case COMP_ZLIB_HISPEED:
599 av_log(avctx, AV_LOG_INFO, "High speed compression.\n");
601 case COMP_ZLIB_HICOMP:
602 av_log(avctx, AV_LOG_INFO, "High compression.\n");
604 case COMP_ZLIB_NORMAL:
605 av_log(avctx, AV_LOG_INFO, "Normal compression.\n");
608 if (c->compression < Z_NO_COMPRESSION || c->compression > Z_BEST_COMPRESSION) {
609 av_log(avctx, AV_LOG_ERROR, "Unsupported compression level for ZLIB: (%d).\n", c->compression);
612 av_log(avctx, AV_LOG_INFO, "Compression level for ZLIB: (%d).\n", c->compression);
615 av_log(avctx, AV_LOG_ERROR, "Zlib support not compiled.\n");
620 av_log(avctx, AV_LOG_ERROR, "BUG! Unknown codec in compression switch.\n");
624 /* Allocate decompression buffer */
625 if (c->decomp_size) {
626 if ((c->decomp_buf = av_malloc(max_decomp_size)) == NULL) {
627 av_log(avctx, AV_LOG_ERROR, "Can't allocate decompression buffer.\n");
633 c->flags = *((char *)avctx->extradata + 6);
634 if (c->flags & FLAG_MULTITHREAD)
635 av_log(avctx, AV_LOG_INFO, "Multithread encoder flag set.\n");
636 if (c->flags & FLAG_NULLFRAME)
637 av_log(avctx, AV_LOG_INFO, "Nullframe insertion flag set.\n");
638 if ((avctx->codec_id == CODEC_ID_ZLIB) && (c->flags & FLAG_PNGFILTER))
639 av_log(avctx, AV_LOG_INFO, "PNG filter flag set.\n");
640 if (c->flags & FLAGMASK_UNUSED)
641 av_log(avctx, AV_LOG_ERROR, "Unknown flag set (%d).\n", c->flags);
643 /* If needed init zlib */
644 if (avctx->codec_id == CODEC_ID_ZLIB) {
646 c->zstream.zalloc = Z_NULL;
647 c->zstream.zfree = Z_NULL;
648 c->zstream.opaque = Z_NULL;
649 zret = inflateInit(&c->zstream);
651 av_log(avctx, AV_LOG_ERROR, "Inflate init error: %d\n", zret);
655 av_log(avctx, AV_LOG_ERROR, "Zlib support not compiled.\n");
660 avctx->pix_fmt = PIX_FMT_BGR24;
670 static av_cold int decode_end(AVCodecContext *avctx)
672 LclDecContext * const c = avctx->priv_data;
675 avctx->release_buffer(avctx, &c->pic);
677 inflateEnd(&c->zstream);
683 #if CONFIG_MSZH_DECODER
684 AVCodec mszh_decoder = {
688 sizeof(LclDecContext),
694 .long_name = NULL_IF_CONFIG_SMALL("LCL (LossLess Codec Library) MSZH"),
698 #if CONFIG_ZLIB_DECODER
699 AVCodec zlib_decoder = {
703 sizeof(LclDecContext),
709 .long_name = NULL_IF_CONFIG_SMALL("LCL (LossLess Codec Library) ZLIB"),