Merge remote-tracking branch 'qatar/master'
[ffmpeg.git] / libavcodec / msrle.c
1 /*
2  * Microsoft RLE video decoder
3  * Copyright (C) 2003 the ffmpeg project
4  *
5  * This file is part of FFmpeg.
6  *
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.
11  *
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.
16  *
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
20  */
21
22 /**
23  * @file
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/
27  *
28  * The MS RLE decoder outputs PAL8 colorspace data.
29  */
30
31 #include <stdio.h>
32 #include <stdlib.h>
33 #include <string.h>
34
35 #include "avcodec.h"
36 #include "dsputil.h"
37 #include "msrledec.h"
38
39 typedef struct MsrleContext {
40     AVCodecContext *avctx;
41     AVFrame frame;
42
43     GetByteContext gb;
44     const unsigned char *buf;
45     int size;
46
47     uint32_t pal[256];
48 } MsrleContext;
49
50 static av_cold int msrle_decode_init(AVCodecContext *avctx)
51 {
52     MsrleContext *s = avctx->priv_data;
53
54     s->avctx = avctx;
55
56     switch (avctx->bits_per_coded_sample) {
57     case 1:
58         avctx->pix_fmt = PIX_FMT_MONOWHITE;
59         break;
60     case 4:
61     case 8:
62         avctx->pix_fmt = PIX_FMT_PAL8;
63         break;
64     case 24:
65         avctx->pix_fmt = PIX_FMT_BGR24;
66         break;
67     default:
68         av_log(avctx, AV_LOG_ERROR, "unsupported bits per sample\n");
69         return -1;
70     }
71
72     avcodec_get_frame_defaults(&s->frame);
73     s->frame.data[0] = NULL;
74
75     return 0;
76 }
77
78 static int msrle_decode_frame(AVCodecContext *avctx,
79                               void *data, int *data_size,
80                               AVPacket *avpkt)
81 {
82     const uint8_t *buf = avpkt->data;
83     int buf_size = avpkt->size;
84     MsrleContext *s = avctx->priv_data;
85     int istride = FFALIGN(avctx->width*avctx->bits_per_coded_sample, 32) / 8;
86
87     s->buf = buf;
88     s->size = buf_size;
89
90     s->frame.reference = 3;
91     s->frame.buffer_hints = FF_BUFFER_HINTS_VALID | FF_BUFFER_HINTS_PRESERVE | FF_BUFFER_HINTS_REUSABLE;
92     if (avctx->reget_buffer(avctx, &s->frame)) {
93         av_log(avctx, AV_LOG_ERROR, "reget_buffer() failed\n");
94         return -1;
95     }
96
97     if (avctx->bits_per_coded_sample > 1 && avctx->bits_per_coded_sample <= 8) {
98         const uint8_t *pal = av_packet_get_side_data(avpkt, AV_PKT_DATA_PALETTE, NULL);
99
100         if (pal) {
101             s->frame.palette_has_changed = 1;
102             memcpy(s->pal, pal, AVPALETTE_SIZE);
103         }
104
105         /* make the palette available */
106         memcpy(s->frame.data[1], s->pal, AVPALETTE_SIZE);
107     }
108
109     /* FIXME how to correctly detect RLE ??? */
110     if (avctx->height * istride == avpkt->size) { /* assume uncompressed */
111         int linesize = (avctx->width * avctx->bits_per_coded_sample + 7) / 8;
112         uint8_t *ptr = s->frame.data[0];
113         uint8_t *buf = avpkt->data + (avctx->height-1)*istride;
114         int i, j;
115
116         for (i = 0; i < avctx->height; i++) {
117             if (avctx->bits_per_coded_sample == 4) {
118                 for (j = 0; j < avctx->width - 1; j += 2) {
119                     ptr[j+0] = buf[j>>1] >> 4;
120                     ptr[j+1] = buf[j>>1] & 0xF;
121                 }
122                 if (avctx->width & 1)
123                     ptr[j+0] = buf[j>>1] >> 4;
124             } else {
125                 memcpy(ptr, buf, linesize);
126             }
127             buf -= istride;
128             ptr += s->frame.linesize[0];
129         }
130     } else {
131         bytestream2_init(&s->gb, buf, buf_size);
132         ff_msrle_decode(avctx, (AVPicture*)&s->frame, avctx->bits_per_coded_sample, &s->gb);
133     }
134
135     *data_size = sizeof(AVFrame);
136     *(AVFrame*)data = s->frame;
137
138     /* report that the buffer was completely consumed */
139     return buf_size;
140 }
141
142 static av_cold int msrle_decode_end(AVCodecContext *avctx)
143 {
144     MsrleContext *s = avctx->priv_data;
145
146     /* release the last frame */
147     if (s->frame.data[0])
148         avctx->release_buffer(avctx, &s->frame);
149
150     return 0;
151 }
152
153 AVCodec ff_msrle_decoder = {
154     .name           = "msrle",
155     .type           = AVMEDIA_TYPE_VIDEO,
156     .id             = CODEC_ID_MSRLE,
157     .priv_data_size = sizeof(MsrleContext),
158     .init           = msrle_decode_init,
159     .close          = msrle_decode_end,
160     .decode         = msrle_decode_frame,
161     .capabilities   = CODEC_CAP_DR1,
162     .long_name      = NULL_IF_CONFIG_SMALL("Microsoft RLE"),
163 };