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) {
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:
229 av_log(avctx, AV_LOG_ERROR, "BUG! Unknown MSZH compression in frame decoder.\n");
233 #if CONFIG_ZLIB_DECODER
235 /* Using the original dll with normal compression (-1) and RGB format
236 * gives a file with ZLIB fourcc, but frame is really uncompressed.
237 * To be sure that's true check also frame size */
238 if (c->compression == COMP_ZLIB_NORMAL && c->imgtype == IMGTYPE_RGB24 &&
239 len == width * height * 3) {
240 if (c->flags & FLAG_PNGFILTER) {
241 memcpy(c->decomp_buf, encoded, len);
242 encoded = c->decomp_buf;
246 } else if (c->flags & FLAG_MULTITHREAD) {
248 mthread_inlen = AV_RL32(encoded);
249 mthread_inlen = FFMIN(mthread_inlen, len - 8);
250 mthread_outlen = AV_RL32(encoded+4);
251 mthread_outlen = FFMIN(mthread_outlen, c->decomp_size);
252 ret = zlib_decomp(avctx, encoded + 8, mthread_inlen, 0, mthread_outlen);
253 if (ret < 0) return ret;
254 ret = zlib_decomp(avctx, encoded + 8 + mthread_inlen, len - 8 - mthread_inlen,
255 mthread_outlen, mthread_outlen);
256 if (ret < 0) return ret;
258 int ret = zlib_decomp(avctx, encoded, len, 0, c->decomp_size);
259 if (ret < 0) return ret;
261 encoded = c->decomp_buf;
262 len = c->decomp_size;
266 av_log(avctx, AV_LOG_ERROR, "BUG! Unknown codec in frame decoder compression switch.\n");
271 /* Apply PNG filter */
272 if (avctx->codec_id == CODEC_ID_ZLIB && (c->flags & FLAG_PNGFILTER)) {
273 switch (c->imgtype) {
276 for (row = 0; row < height; row++) {
277 pixel_ptr = row * width * 3;
278 yq = encoded[pixel_ptr++];
279 uqvq = AV_RL16(encoded+pixel_ptr);
281 for (col = 1; col < width; col++) {
282 encoded[pixel_ptr] = yq -= encoded[pixel_ptr];
283 uqvq -= AV_RL16(encoded+pixel_ptr+1);
284 AV_WL16(encoded+pixel_ptr+1, uqvq);
290 for (row = 0; row < height; row++) {
291 pixel_ptr = row * width * 2;
293 for (col = 0; col < width/4; col++) {
294 encoded[pixel_ptr] = yq -= encoded[pixel_ptr];
295 encoded[pixel_ptr+1] = yq -= encoded[pixel_ptr+1];
296 encoded[pixel_ptr+2] = yq -= encoded[pixel_ptr+2];
297 encoded[pixel_ptr+3] = yq -= encoded[pixel_ptr+3];
298 encoded[pixel_ptr+4] = uq -= encoded[pixel_ptr+4];
299 encoded[pixel_ptr+5] = uq -= encoded[pixel_ptr+5];
300 encoded[pixel_ptr+6] = vq -= encoded[pixel_ptr+6];
301 encoded[pixel_ptr+7] = vq -= encoded[pixel_ptr+7];
307 for (row = 0; row < height; row++) {
308 pixel_ptr = row * width / 2 * 3;
310 for (col = 0; col < width/4; col++) {
311 encoded[pixel_ptr] = yq -= encoded[pixel_ptr];
312 encoded[pixel_ptr+1] = yq -= encoded[pixel_ptr+1];
313 encoded[pixel_ptr+2] = yq -= encoded[pixel_ptr+2];
314 encoded[pixel_ptr+3] = yq -= encoded[pixel_ptr+3];
315 encoded[pixel_ptr+4] = uq -= encoded[pixel_ptr+4];
316 encoded[pixel_ptr+5] = vq -= encoded[pixel_ptr+5];
322 for (row = 0; row < height; row++) {
323 pixel_ptr = row * width * 2;
325 for (col = 0; col < width/2; col++) {
326 encoded[pixel_ptr] = yq -= encoded[pixel_ptr];
327 encoded[pixel_ptr+1] = yq -= encoded[pixel_ptr+1];
328 encoded[pixel_ptr+2] = uq -= encoded[pixel_ptr+2];
329 encoded[pixel_ptr+3] = vq -= encoded[pixel_ptr+3];
335 for (row = 0; row < height/2; row++) {
336 pixel_ptr = row * width * 3;
337 yq = y1q = uq = vq =0;
338 for (col = 0; col < width/2; col++) {
339 encoded[pixel_ptr] = yq -= encoded[pixel_ptr];
340 encoded[pixel_ptr+1] = yq -= encoded[pixel_ptr+1];
341 encoded[pixel_ptr+2] = y1q -= encoded[pixel_ptr+2];
342 encoded[pixel_ptr+3] = y1q -= encoded[pixel_ptr+3];
343 encoded[pixel_ptr+4] = uq -= encoded[pixel_ptr+4];
344 encoded[pixel_ptr+5] = vq -= encoded[pixel_ptr+5];
350 av_log(avctx, AV_LOG_ERROR, "BUG! Unknown imagetype in pngfilter switch.\n");
355 /* Convert colorspace */
356 y_out = c->pic.data[0] + (height - 1) * c->pic.linesize[0];
357 u_out = c->pic.data[1] + (height - 1) * c->pic.linesize[1];
358 v_out = c->pic.data[2] + (height - 1) * c->pic.linesize[2];
359 switch (c->imgtype) {
361 for (row = 0; row < height; row++) {
362 for (col = 0; col < width; col++) {
363 y_out[col] = *encoded++;
364 u_out[col] = *encoded++ + 128;
365 v_out[col] = *encoded++ + 128;
367 y_out -= c->pic.linesize[0];
368 u_out -= c->pic.linesize[1];
369 v_out -= c->pic.linesize[2];
373 for (row = 0; row < height; row++) {
374 for (col = 0; col < width - 3; col += 4) {
375 memcpy(y_out + col, encoded, 4);
377 u_out[ col >> 1 ] = *encoded++ + 128;
378 u_out[(col >> 1) + 1] = *encoded++ + 128;
379 v_out[ col >> 1 ] = *encoded++ + 128;
380 v_out[(col >> 1) + 1] = *encoded++ + 128;
382 y_out -= c->pic.linesize[0];
383 u_out -= c->pic.linesize[1];
384 v_out -= c->pic.linesize[2];
388 for (row = height - 1; row >= 0; row--) {
389 pixel_ptr = row * c->pic.linesize[0];
390 memcpy(outptr + pixel_ptr, encoded, 3 * width);
391 encoded += 3 * width;
395 for (row = 0; row < height; row++) {
396 for (col = 0; col < width - 3; col += 4) {
397 memcpy(y_out + col, encoded, 4);
399 u_out[col >> 2] = *encoded++ + 128;
400 v_out[col >> 2] = *encoded++ + 128;
402 y_out -= c->pic.linesize[0];
403 u_out -= c->pic.linesize[1];
404 v_out -= c->pic.linesize[2];
408 for (row = 0; row < height; row++) {
409 for (col = 0; col < width - 1; col += 2) {
410 memcpy(y_out + col, encoded, 2);
412 u_out[col >> 1] = *encoded++ + 128;
413 v_out[col >> 1] = *encoded++ + 128;
415 y_out -= c->pic.linesize[0];
416 u_out -= c->pic.linesize[1];
417 v_out -= c->pic.linesize[2];
421 u_out = c->pic.data[1] + ((height >> 1) - 1) * c->pic.linesize[1];
422 v_out = c->pic.data[2] + ((height >> 1) - 1) * c->pic.linesize[2];
423 for (row = 0; row < height - 1; row += 2) {
424 for (col = 0; col < width - 1; col += 2) {
425 memcpy(y_out + col, encoded, 2);
427 memcpy(y_out + col - c->pic.linesize[0], encoded, 2);
429 u_out[col >> 1] = *encoded++ + 128;
430 v_out[col >> 1] = *encoded++ + 128;
432 y_out -= c->pic.linesize[0] << 1;
433 u_out -= c->pic.linesize[1];
434 v_out -= c->pic.linesize[2];
438 av_log(avctx, AV_LOG_ERROR, "BUG! Unknown imagetype in image decoder.\n");
442 *data_size = sizeof(AVFrame);
443 *(AVFrame*)data = c->pic;
445 /* always report that the buffer was completely consumed */
454 static av_cold int decode_init(AVCodecContext *avctx)
456 LclDecContext * const c = avctx->priv_data;
457 unsigned int basesize = avctx->width * avctx->height;
458 unsigned int max_basesize = FFALIGN(avctx->width, 4) * FFALIGN(avctx->height, 4) + AV_LZO_OUTPUT_PADDING;
459 unsigned int max_decomp_size;
461 if (avctx->extradata_size < 8) {
462 av_log(avctx, AV_LOG_ERROR, "Extradata size too small.\n");
466 /* Check codec type */
467 if ((avctx->codec_id == CODEC_ID_MSZH && avctx->extradata[7] != CODEC_MSZH) ||
468 (avctx->codec_id == CODEC_ID_ZLIB && avctx->extradata[7] != CODEC_ZLIB)) {
469 av_log(avctx, AV_LOG_ERROR, "Codec id and codec type mismatch. This should not happen.\n");
472 /* Detect image type */
473 switch (c->imgtype = avctx->extradata[4]) {
475 c->decomp_size = basesize * 3;
476 max_decomp_size = max_basesize * 3;
477 avctx->pix_fmt = PIX_FMT_YUV444P;
478 av_log(avctx, AV_LOG_DEBUG, "Image type is YUV 1:1:1.\n");
481 c->decomp_size = basesize * 2;
482 max_decomp_size = max_basesize * 2;
483 avctx->pix_fmt = PIX_FMT_YUV422P;
484 av_log(avctx, AV_LOG_DEBUG, "Image type is YUV 4:2:2.\n");
487 c->decomp_size = basesize * 3;
488 max_decomp_size = max_basesize * 3;
489 avctx->pix_fmt = PIX_FMT_BGR24;
490 av_log(avctx, AV_LOG_DEBUG, "Image type is RGB 24.\n");
493 c->decomp_size = basesize / 2 * 3;
494 max_decomp_size = max_basesize / 2 * 3;
495 avctx->pix_fmt = PIX_FMT_YUV411P;
496 av_log(avctx, AV_LOG_DEBUG, "Image type is YUV 4:1:1.\n");
499 c->decomp_size = basesize * 2;
500 max_decomp_size = max_basesize * 2;
501 avctx->pix_fmt = PIX_FMT_YUV422P;
502 av_log(avctx, AV_LOG_DEBUG, "Image type is YUV 2:1:1.\n");
505 c->decomp_size = basesize / 2 * 3;
506 max_decomp_size = max_basesize / 2 * 3;
507 avctx->pix_fmt = PIX_FMT_YUV420P;
508 av_log(avctx, AV_LOG_DEBUG, "Image type is YUV 4:2:0.\n");
511 av_log(avctx, AV_LOG_ERROR, "Unsupported image format %d.\n", c->imgtype);
515 /* Detect compression method */
516 c->compression = (int8_t)avctx->extradata[5];
517 switch (avctx->codec_id) {
519 switch (c->compression) {
521 av_log(avctx, AV_LOG_DEBUG, "Compression enabled.\n");
523 case COMP_MSZH_NOCOMP:
525 av_log(avctx, AV_LOG_DEBUG, "No compression.\n");
528 av_log(avctx, AV_LOG_ERROR, "Unsupported compression format for MSZH (%d).\n", c->compression);
532 #if CONFIG_ZLIB_DECODER
534 switch (c->compression) {
535 case COMP_ZLIB_HISPEED:
536 av_log(avctx, AV_LOG_DEBUG, "High speed compression.\n");
538 case COMP_ZLIB_HICOMP:
539 av_log(avctx, AV_LOG_DEBUG, "High compression.\n");
541 case COMP_ZLIB_NORMAL:
542 av_log(avctx, AV_LOG_DEBUG, "Normal compression.\n");
545 if (c->compression < Z_NO_COMPRESSION || c->compression > Z_BEST_COMPRESSION) {
546 av_log(avctx, AV_LOG_ERROR, "Unsupported compression level for ZLIB: (%d).\n", c->compression);
549 av_log(avctx, AV_LOG_DEBUG, "Compression level for ZLIB: (%d).\n", c->compression);
554 av_log(avctx, AV_LOG_ERROR, "BUG! Unknown codec in compression switch.\n");
558 /* Allocate decompression buffer */
559 if (c->decomp_size) {
560 if ((c->decomp_buf = av_malloc(max_decomp_size)) == NULL) {
561 av_log(avctx, AV_LOG_ERROR, "Can't allocate decompression buffer.\n");
567 c->flags = avctx->extradata[6];
568 if (c->flags & FLAG_MULTITHREAD)
569 av_log(avctx, AV_LOG_DEBUG, "Multithread encoder flag set.\n");
570 if (c->flags & FLAG_NULLFRAME)
571 av_log(avctx, AV_LOG_DEBUG, "Nullframe insertion flag set.\n");
572 if (avctx->codec_id == CODEC_ID_ZLIB && (c->flags & FLAG_PNGFILTER))
573 av_log(avctx, AV_LOG_DEBUG, "PNG filter flag set.\n");
574 if (c->flags & FLAGMASK_UNUSED)
575 av_log(avctx, AV_LOG_ERROR, "Unknown flag set (%d).\n", c->flags);
577 /* If needed init zlib */
578 #if CONFIG_ZLIB_DECODER
579 if (avctx->codec_id == CODEC_ID_ZLIB) {
581 c->zstream.zalloc = Z_NULL;
582 c->zstream.zfree = Z_NULL;
583 c->zstream.opaque = Z_NULL;
584 zret = inflateInit(&c->zstream);
586 av_log(avctx, AV_LOG_ERROR, "Inflate init error: %d\n", zret);
587 av_freep(&c->decomp_buf);
601 static av_cold int decode_end(AVCodecContext *avctx)
603 LclDecContext * const c = avctx->priv_data;
605 av_freep(&c->decomp_buf);
607 avctx->release_buffer(avctx, &c->pic);
608 #if CONFIG_ZLIB_DECODER
609 if (avctx->codec_id == CODEC_ID_ZLIB)
610 inflateEnd(&c->zstream);
616 #if CONFIG_MSZH_DECODER
617 AVCodec ff_mszh_decoder = {
619 .type = AVMEDIA_TYPE_VIDEO,
621 .priv_data_size = sizeof(LclDecContext),
624 .decode = decode_frame,
625 .capabilities = CODEC_CAP_DR1,
626 .long_name = NULL_IF_CONFIG_SMALL("LCL (LossLess Codec Library) MSZH"),
630 #if CONFIG_ZLIB_DECODER
631 AVCodec ff_zlib_decoder = {
633 .type = AVMEDIA_TYPE_VIDEO,
635 .priv_data_size = sizeof(LclDecContext),
638 .decode = decode_frame,
639 .capabilities = CODEC_CAP_DR1,
640 .long_name = NULL_IF_CONFIG_SMALL("LCL (LossLess Codec Library) ZLIB"),