2 * Microsoft RLE video decoder
3 * Copyright (C) 2003 the ffmpeg project
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 * MS RLE video decoder by Mike Melanson (melanson@pcisys.net)
25 * For more information about the MS RLE format, visit:
26 * http://www.pcisys.net/~melanson/codecs/
28 * The MS RLE decoder outputs PAL8 colorspace data.
39 typedef struct MsrleContext {
40 AVCodecContext *avctx;
44 const unsigned char *buf;
50 static av_cold int msrle_decode_init(AVCodecContext *avctx)
52 MsrleContext *s = avctx->priv_data;
57 switch (avctx->bits_per_coded_sample) {
59 avctx->pix_fmt = AV_PIX_FMT_MONOWHITE;
63 avctx->pix_fmt = AV_PIX_FMT_PAL8;
66 avctx->pix_fmt = AV_PIX_FMT_BGR24;
69 av_log(avctx, AV_LOG_ERROR, "unsupported bits per sample\n");
70 return AVERROR_INVALIDDATA;
73 avcodec_get_frame_defaults(&s->frame);
74 s->frame.data[0] = NULL;
76 if (avctx->extradata_size >= 4)
77 for (i = 0; i < FFMIN(avctx->extradata_size, AVPALETTE_SIZE)/4; i++)
78 s->pal[i] = 0xFFU<<24 | AV_RL32(avctx->extradata+4*i);
83 static int msrle_decode_frame(AVCodecContext *avctx,
84 void *data, int *got_frame,
87 const uint8_t *buf = avpkt->data;
88 int buf_size = avpkt->size;
89 MsrleContext *s = avctx->priv_data;
90 int istride = FFALIGN(avctx->width*avctx->bits_per_coded_sample, 32) / 8;
96 s->frame.reference = 3;
97 s->frame.buffer_hints = FF_BUFFER_HINTS_VALID | FF_BUFFER_HINTS_PRESERVE | FF_BUFFER_HINTS_REUSABLE;
98 if ((ret = avctx->reget_buffer(avctx, &s->frame)) < 0) {
99 av_log(avctx, AV_LOG_ERROR, "reget_buffer() failed\n");
103 if (avctx->bits_per_coded_sample > 1 && avctx->bits_per_coded_sample <= 8) {
104 const uint8_t *pal = av_packet_get_side_data(avpkt, AV_PKT_DATA_PALETTE, NULL);
107 s->frame.palette_has_changed = 1;
108 memcpy(s->pal, pal, AVPALETTE_SIZE);
110 /* make the palette available */
111 memcpy(s->frame.data[1], s->pal, AVPALETTE_SIZE);
114 /* FIXME how to correctly detect RLE ??? */
115 if (avctx->height * istride == avpkt->size) { /* assume uncompressed */
116 int linesize = (avctx->width * avctx->bits_per_coded_sample + 7) / 8;
117 uint8_t *ptr = s->frame.data[0];
118 uint8_t *buf = avpkt->data + (avctx->height-1)*istride;
121 for (i = 0; i < avctx->height; i++) {
122 if (avctx->bits_per_coded_sample == 4) {
123 for (j = 0; j < avctx->width - 1; j += 2) {
124 ptr[j+0] = buf[j>>1] >> 4;
125 ptr[j+1] = buf[j>>1] & 0xF;
127 if (avctx->width & 1)
128 ptr[j+0] = buf[j>>1] >> 4;
130 memcpy(ptr, buf, linesize);
133 ptr += s->frame.linesize[0];
136 bytestream2_init(&s->gb, buf, buf_size);
137 ff_msrle_decode(avctx, (AVPicture*)&s->frame, avctx->bits_per_coded_sample, &s->gb);
141 *(AVFrame*)data = s->frame;
143 /* report that the buffer was completely consumed */
147 static av_cold int msrle_decode_end(AVCodecContext *avctx)
149 MsrleContext *s = avctx->priv_data;
151 /* release the last frame */
152 if (s->frame.data[0])
153 avctx->release_buffer(avctx, &s->frame);
158 AVCodec ff_msrle_decoder = {
160 .type = AVMEDIA_TYPE_VIDEO,
161 .id = AV_CODEC_ID_MSRLE,
162 .priv_data_size = sizeof(MsrleContext),
163 .init = msrle_decode_init,
164 .close = msrle_decode_end,
165 .decode = msrle_decode_frame,
166 .capabilities = CODEC_CAP_DR1,
167 .long_name = NULL_IF_CONFIG_SMALL("Microsoft RLE"),