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)
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);
100 av_memcpy_backptr(destptr, ofs, cnt);
102 // Not known what the correct behaviour is, but
103 // this at least avoids uninitialized data.
104 memset(destptr, 0, cnt);
112 if (destptr_end - destptr < 32 || srcptr_end - srcptr < 32) break;
113 memcpy(destptr, srcptr, 32);
122 return destptr - destptr_bak;
126 #if CONFIG_ZLIB_DECODER
128 * @brief decompress a zlib-compressed data block into decomp_buf
129 * @param src compressed input buffer
130 * @param src_len data length in input buffer
131 * @param offset offset in decomp_buf
132 * @param expected expected decompressed length
134 static int zlib_decomp(AVCodecContext *avctx, const uint8_t *src, int src_len, int offset, int expected)
136 LclDecContext *c = avctx->priv_data;
137 int zret = inflateReset(&c->zstream);
139 av_log(avctx, AV_LOG_ERROR, "Inflate reset error: %d\n", zret);
142 c->zstream.next_in = src;
143 c->zstream.avail_in = src_len;
144 c->zstream.next_out = c->decomp_buf + offset;
145 c->zstream.avail_out = c->decomp_size - offset;
146 zret = inflate(&c->zstream, Z_FINISH);
147 if (zret != Z_OK && zret != Z_STREAM_END) {
148 av_log(avctx, AV_LOG_ERROR, "Inflate error: %d\n", zret);
151 if (expected != (unsigned int)c->zstream.total_out) {
152 av_log(avctx, AV_LOG_ERROR, "Decoded size differs (%d != %lu)\n",
153 expected, c->zstream.total_out);
156 return c->zstream.total_out;
166 static int decode_frame(AVCodecContext *avctx, void *data, int *data_size, AVPacket *avpkt)
168 const uint8_t *buf = avpkt->data;
169 int buf_size = avpkt->size;
170 LclDecContext * const c = avctx->priv_data;
171 unsigned char *encoded = (unsigned char *)buf;
172 unsigned int pixel_ptr;
174 unsigned char *outptr;
175 uint8_t *y_out, *u_out, *v_out;
176 unsigned int width = avctx->width; // Real image width
177 unsigned int height = avctx->height; // Real image height
178 unsigned int mszh_dlen;
179 unsigned char yq, y1q, uq, vq;
181 unsigned int mthread_inlen, mthread_outlen;
182 unsigned int len = buf_size;
185 avctx->release_buffer(avctx, &c->pic);
187 c->pic.reference = 0;
188 c->pic.buffer_hints = FF_BUFFER_HINTS_VALID;
189 if(avctx->get_buffer(avctx, &c->pic) < 0){
190 av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
194 outptr = c->pic.data[0]; // Output image pointer
196 /* Decompress frame */
197 switch (avctx->codec_id) {
199 switch (c->compression) {
201 if (c->flags & FLAG_MULTITHREAD) {
202 mthread_inlen = AV_RL32(encoded);
203 mthread_inlen = FFMIN(mthread_inlen, len - 8);
204 mthread_outlen = AV_RL32(encoded+4);
205 mthread_outlen = FFMIN(mthread_outlen, c->decomp_size);
206 mszh_dlen = mszh_decomp(encoded + 8, mthread_inlen, c->decomp_buf, c->decomp_size);
207 if (mthread_outlen != mszh_dlen) {
208 av_log(avctx, AV_LOG_ERROR, "Mthread1 decoded size differs (%d != %d)\n",
209 mthread_outlen, mszh_dlen);
212 mszh_dlen = mszh_decomp(encoded + 8 + mthread_inlen, len - 8 - mthread_inlen,
213 c->decomp_buf + mthread_outlen, c->decomp_size - mthread_outlen);
214 if (mthread_outlen != mszh_dlen) {
215 av_log(avctx, AV_LOG_ERROR, "Mthread2 decoded size differs (%d != %d)\n",
216 mthread_outlen, mszh_dlen);
219 encoded = c->decomp_buf;
220 len = c->decomp_size;
222 mszh_dlen = mszh_decomp(encoded, len, c->decomp_buf, c->decomp_size);
223 if (c->decomp_size != mszh_dlen) {
224 av_log(avctx, AV_LOG_ERROR, "Decoded size differs (%d != %d)\n",
225 c->decomp_size, mszh_dlen);
228 encoded = c->decomp_buf;
232 case COMP_MSZH_NOCOMP:
235 av_log(avctx, AV_LOG_ERROR, "BUG! Unknown MSZH compression in frame decoder.\n");
239 #if CONFIG_ZLIB_DECODER
241 /* Using the original dll with normal compression (-1) and RGB format
242 * gives a file with ZLIB fourcc, but frame is really uncompressed.
243 * To be sure that's true check also frame size */
244 if (c->compression == COMP_ZLIB_NORMAL && c->imgtype == IMGTYPE_RGB24 &&
245 len == width * height * 3)
247 if (c->flags & FLAG_MULTITHREAD) {
249 mthread_inlen = AV_RL32(encoded);
250 mthread_inlen = FFMIN(mthread_inlen, len - 8);
251 mthread_outlen = AV_RL32(encoded+4);
252 mthread_outlen = FFMIN(mthread_outlen, c->decomp_size);
253 ret = zlib_decomp(avctx, encoded + 8, mthread_inlen, 0, mthread_outlen);
254 if (ret < 0) return ret;
255 ret = zlib_decomp(avctx, encoded + 8 + mthread_inlen, len - 8 - mthread_inlen,
256 mthread_outlen, mthread_outlen);
257 if (ret < 0) return ret;
259 int ret = zlib_decomp(avctx, encoded, len, 0, c->decomp_size);
260 if (ret < 0) return ret;
262 encoded = c->decomp_buf;
263 len = c->decomp_size;
267 av_log(avctx, AV_LOG_ERROR, "BUG! Unknown codec in frame decoder compression switch.\n");
272 /* Apply PNG filter */
273 if (avctx->codec_id == CODEC_ID_ZLIB && (c->flags & FLAG_PNGFILTER)) {
274 switch (c->imgtype) {
277 for (row = 0; row < height; row++) {
278 pixel_ptr = row * width * 3;
279 yq = encoded[pixel_ptr++];
280 uqvq = AV_RL16(encoded+pixel_ptr);
282 for (col = 1; col < width; col++) {
283 encoded[pixel_ptr] = yq -= encoded[pixel_ptr];
284 uqvq -= AV_RL16(encoded+pixel_ptr+1);
285 AV_WL16(encoded+pixel_ptr+1, uqvq);
291 for (row = 0; row < height; row++) {
292 pixel_ptr = row * width * 2;
294 for (col = 0; col < width/4; col++) {
295 encoded[pixel_ptr] = yq -= encoded[pixel_ptr];
296 encoded[pixel_ptr+1] = yq -= encoded[pixel_ptr+1];
297 encoded[pixel_ptr+2] = yq -= encoded[pixel_ptr+2];
298 encoded[pixel_ptr+3] = yq -= encoded[pixel_ptr+3];
299 encoded[pixel_ptr+4] = uq -= encoded[pixel_ptr+4];
300 encoded[pixel_ptr+5] = uq -= encoded[pixel_ptr+5];
301 encoded[pixel_ptr+6] = vq -= encoded[pixel_ptr+6];
302 encoded[pixel_ptr+7] = vq -= encoded[pixel_ptr+7];
308 for (row = 0; row < height; row++) {
309 pixel_ptr = row * width / 2 * 3;
311 for (col = 0; col < width/4; col++) {
312 encoded[pixel_ptr] = yq -= encoded[pixel_ptr];
313 encoded[pixel_ptr+1] = yq -= encoded[pixel_ptr+1];
314 encoded[pixel_ptr+2] = yq -= encoded[pixel_ptr+2];
315 encoded[pixel_ptr+3] = yq -= encoded[pixel_ptr+3];
316 encoded[pixel_ptr+4] = uq -= encoded[pixel_ptr+4];
317 encoded[pixel_ptr+5] = vq -= encoded[pixel_ptr+5];
323 for (row = 0; row < height; row++) {
324 pixel_ptr = row * width * 2;
326 for (col = 0; col < width/2; col++) {
327 encoded[pixel_ptr] = yq -= encoded[pixel_ptr];
328 encoded[pixel_ptr+1] = yq -= encoded[pixel_ptr+1];
329 encoded[pixel_ptr+2] = uq -= encoded[pixel_ptr+2];
330 encoded[pixel_ptr+3] = vq -= encoded[pixel_ptr+3];
336 for (row = 0; row < height/2; row++) {
337 pixel_ptr = row * width * 3;
338 yq = y1q = uq = vq =0;
339 for (col = 0; col < width/2; col++) {
340 encoded[pixel_ptr] = yq -= encoded[pixel_ptr];
341 encoded[pixel_ptr+1] = yq -= encoded[pixel_ptr+1];
342 encoded[pixel_ptr+2] = y1q -= encoded[pixel_ptr+2];
343 encoded[pixel_ptr+3] = y1q -= encoded[pixel_ptr+3];
344 encoded[pixel_ptr+4] = uq -= encoded[pixel_ptr+4];
345 encoded[pixel_ptr+5] = vq -= encoded[pixel_ptr+5];
351 av_log(avctx, AV_LOG_ERROR, "BUG! Unknown imagetype in pngfilter switch.\n");
356 /* Convert colorspace */
357 y_out = c->pic.data[0] + (height - 1) * c->pic.linesize[0];
358 u_out = c->pic.data[1] + (height - 1) * c->pic.linesize[1];
359 v_out = c->pic.data[2] + (height - 1) * c->pic.linesize[2];
360 switch (c->imgtype) {
362 for (row = 0; row < height; row++) {
363 for (col = 0; col < width; col++) {
364 y_out[col] = *encoded++;
365 u_out[col] = *encoded++ + 128;
366 v_out[col] = *encoded++ + 128;
368 y_out -= c->pic.linesize[0];
369 u_out -= c->pic.linesize[1];
370 v_out -= c->pic.linesize[2];
374 for (row = 0; row < height; row++) {
375 for (col = 0; col < width - 3; col += 4) {
376 memcpy(y_out + col, encoded, 4);
378 u_out[ col >> 1 ] = *encoded++ + 128;
379 u_out[(col >> 1) + 1] = *encoded++ + 128;
380 v_out[ col >> 1 ] = *encoded++ + 128;
381 v_out[(col >> 1) + 1] = *encoded++ + 128;
383 y_out -= c->pic.linesize[0];
384 u_out -= c->pic.linesize[1];
385 v_out -= c->pic.linesize[2];
389 for (row = height - 1; row >= 0; row--) {
390 pixel_ptr = row * c->pic.linesize[0];
391 memcpy(outptr + pixel_ptr, encoded, 3 * width);
392 encoded += 3 * width;
396 for (row = 0; row < height; row++) {
397 for (col = 0; col < width - 3; col += 4) {
398 memcpy(y_out + col, encoded, 4);
400 u_out[col >> 2] = *encoded++ + 128;
401 v_out[col >> 2] = *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 = 0; row < height; row++) {
410 for (col = 0; col < width - 1; col += 2) {
411 memcpy(y_out + col, encoded, 2);
413 u_out[col >> 1] = *encoded++ + 128;
414 v_out[col >> 1] = *encoded++ + 128;
416 y_out -= c->pic.linesize[0];
417 u_out -= c->pic.linesize[1];
418 v_out -= c->pic.linesize[2];
422 u_out = c->pic.data[1] + ((height >> 1) - 1) * c->pic.linesize[1];
423 v_out = c->pic.data[2] + ((height >> 1) - 1) * c->pic.linesize[2];
424 for (row = 0; row < height - 1; row += 2) {
425 for (col = 0; col < width - 1; col += 2) {
426 memcpy(y_out + col, encoded, 2);
428 memcpy(y_out + col - c->pic.linesize[0], encoded, 2);
430 u_out[col >> 1] = *encoded++ + 128;
431 v_out[col >> 1] = *encoded++ + 128;
433 y_out -= c->pic.linesize[0] << 1;
434 u_out -= c->pic.linesize[1];
435 v_out -= c->pic.linesize[2];
439 av_log(avctx, AV_LOG_ERROR, "BUG! Unknown imagetype in image decoder.\n");
443 *data_size = sizeof(AVFrame);
444 *(AVFrame*)data = c->pic;
446 /* always report that the buffer was completely consumed */
455 static av_cold int decode_init(AVCodecContext *avctx)
457 LclDecContext * const c = avctx->priv_data;
458 unsigned int basesize = avctx->width * avctx->height;
459 unsigned int max_basesize = FFALIGN(avctx->width, 4) * FFALIGN(avctx->height, 4) + AV_LZO_OUTPUT_PADDING;
460 unsigned int max_decomp_size;
462 avcodec_get_frame_defaults(&c->pic);
463 if (avctx->extradata_size < 8) {
464 av_log(avctx, AV_LOG_ERROR, "Extradata size too small.\n");
468 /* Check codec type */
469 if ((avctx->codec_id == CODEC_ID_MSZH && avctx->extradata[7] != CODEC_MSZH) ||
470 (avctx->codec_id == CODEC_ID_ZLIB && avctx->extradata[7] != CODEC_ZLIB)) {
471 av_log(avctx, AV_LOG_ERROR, "Codec id and codec type mismatch. This should not happen.\n");
474 /* Detect image type */
475 switch (c->imgtype = avctx->extradata[4]) {
477 c->decomp_size = basesize * 3;
478 max_decomp_size = max_basesize * 3;
479 avctx->pix_fmt = PIX_FMT_YUV444P;
480 av_log(avctx, AV_LOG_DEBUG, "Image type is YUV 1:1:1.\n");
483 c->decomp_size = basesize * 2;
484 max_decomp_size = max_basesize * 2;
485 avctx->pix_fmt = PIX_FMT_YUV422P;
486 av_log(avctx, AV_LOG_DEBUG, "Image type is YUV 4:2:2.\n");
489 c->decomp_size = basesize * 3;
490 max_decomp_size = max_basesize * 3;
491 avctx->pix_fmt = PIX_FMT_BGR24;
492 av_log(avctx, AV_LOG_DEBUG, "Image type is RGB 24.\n");
495 c->decomp_size = basesize / 2 * 3;
496 max_decomp_size = max_basesize / 2 * 3;
497 avctx->pix_fmt = PIX_FMT_YUV411P;
498 av_log(avctx, AV_LOG_DEBUG, "Image type is YUV 4:1:1.\n");
501 c->decomp_size = basesize * 2;
502 max_decomp_size = max_basesize * 2;
503 avctx->pix_fmt = PIX_FMT_YUV422P;
504 av_log(avctx, AV_LOG_DEBUG, "Image type is YUV 2:1:1.\n");
507 c->decomp_size = basesize / 2 * 3;
508 max_decomp_size = max_basesize / 2 * 3;
509 avctx->pix_fmt = PIX_FMT_YUV420P;
510 av_log(avctx, AV_LOG_DEBUG, "Image type is YUV 4:2:0.\n");
513 av_log(avctx, AV_LOG_ERROR, "Unsupported image format %d.\n", c->imgtype);
517 /* Detect compression method */
518 c->compression = (int8_t)avctx->extradata[5];
519 switch (avctx->codec_id) {
521 switch (c->compression) {
523 av_log(avctx, AV_LOG_DEBUG, "Compression enabled.\n");
525 case COMP_MSZH_NOCOMP:
527 av_log(avctx, AV_LOG_DEBUG, "No compression.\n");
530 av_log(avctx, AV_LOG_ERROR, "Unsupported compression format for MSZH (%d).\n", c->compression);
534 #if CONFIG_ZLIB_DECODER
536 switch (c->compression) {
537 case COMP_ZLIB_HISPEED:
538 av_log(avctx, AV_LOG_DEBUG, "High speed compression.\n");
540 case COMP_ZLIB_HICOMP:
541 av_log(avctx, AV_LOG_DEBUG, "High compression.\n");
543 case COMP_ZLIB_NORMAL:
544 av_log(avctx, AV_LOG_DEBUG, "Normal compression.\n");
547 if (c->compression < Z_NO_COMPRESSION || c->compression > Z_BEST_COMPRESSION) {
548 av_log(avctx, AV_LOG_ERROR, "Unsupported compression level for ZLIB: (%d).\n", c->compression);
551 av_log(avctx, AV_LOG_DEBUG, "Compression level for ZLIB: (%d).\n", c->compression);
556 av_log(avctx, AV_LOG_ERROR, "BUG! Unknown codec in compression switch.\n");
560 /* Allocate decompression buffer */
561 if (c->decomp_size) {
562 if ((c->decomp_buf = av_malloc(max_decomp_size)) == NULL) {
563 av_log(avctx, AV_LOG_ERROR, "Can't allocate decompression buffer.\n");
569 c->flags = avctx->extradata[6];
570 if (c->flags & FLAG_MULTITHREAD)
571 av_log(avctx, AV_LOG_DEBUG, "Multithread encoder flag set.\n");
572 if (c->flags & FLAG_NULLFRAME)
573 av_log(avctx, AV_LOG_DEBUG, "Nullframe insertion flag set.\n");
574 if (avctx->codec_id == CODEC_ID_ZLIB && (c->flags & FLAG_PNGFILTER))
575 av_log(avctx, AV_LOG_DEBUG, "PNG filter flag set.\n");
576 if (c->flags & FLAGMASK_UNUSED)
577 av_log(avctx, AV_LOG_ERROR, "Unknown flag set (%d).\n", c->flags);
579 /* If needed init zlib */
580 #if CONFIG_ZLIB_DECODER
581 if (avctx->codec_id == CODEC_ID_ZLIB) {
583 c->zstream.zalloc = Z_NULL;
584 c->zstream.zfree = Z_NULL;
585 c->zstream.opaque = Z_NULL;
586 zret = inflateInit(&c->zstream);
588 av_log(avctx, AV_LOG_ERROR, "Inflate init error: %d\n", zret);
589 av_freep(&c->decomp_buf);
603 static av_cold int decode_end(AVCodecContext *avctx)
605 LclDecContext * const c = avctx->priv_data;
607 av_freep(&c->decomp_buf);
609 avctx->release_buffer(avctx, &c->pic);
610 #if CONFIG_ZLIB_DECODER
611 if (avctx->codec_id == CODEC_ID_ZLIB)
612 inflateEnd(&c->zstream);
618 #if CONFIG_MSZH_DECODER
619 AVCodec ff_mszh_decoder = {
621 .type = AVMEDIA_TYPE_VIDEO,
623 .priv_data_size = sizeof(LclDecContext),
626 .decode = decode_frame,
627 .capabilities = CODEC_CAP_DR1,
628 .long_name = NULL_IF_CONFIG_SMALL("LCL (LossLess Codec Library) MSZH"),
632 #if CONFIG_ZLIB_DECODER
633 AVCodec ff_zlib_decoder = {
635 .type = AVMEDIA_TYPE_VIDEO,
637 .priv_data_size = sizeof(LclDecContext),
640 .decode = decode_frame,
641 .capabilities = CODEC_CAP_DR1,
642 .long_name = NULL_IF_CONFIG_SMALL("LCL (LossLess Codec Library) ZLIB"),