FFmpeg
msrle.c
Go to the documentation of this file.
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 "internal.h"
37 #include "msrledec.h"
38 #include "libavutil/imgutils.h"
39 
40 typedef struct MsrleContext {
43 
45 
46  uint32_t pal[256];
47 } MsrleContext;
48 
50 {
51  MsrleContext *s = avctx->priv_data;
52  int i;
53 
54  s->avctx = avctx;
55 
56  switch (avctx->bits_per_coded_sample) {
57  case 1:
59  break;
60  case 4:
61  case 8:
62  avctx->pix_fmt = AV_PIX_FMT_PAL8;
63  break;
64  case 24:
65  avctx->pix_fmt = AV_PIX_FMT_BGR24;
66  break;
67  default:
68  av_log(avctx, AV_LOG_ERROR, "unsupported bits per sample\n");
69  return AVERROR_INVALIDDATA;
70  }
71 
72  s->frame = av_frame_alloc();
73  if (!s->frame)
74  return AVERROR(ENOMEM);
75 
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);
79 
80  return 0;
81 }
82 
84  void *data, int *got_frame,
85  AVPacket *avpkt)
86 {
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;
91  int ret;
92 
93  if (buf_size < 2) //Minimally a end of picture code should be there
94  return AVERROR_INVALIDDATA;
95 
96  if ((ret = ff_reget_buffer(avctx, s->frame, 0)) < 0)
97  return ret;
98 
99  if (avctx->bits_per_coded_sample > 1 && avctx->bits_per_coded_sample <= 8) {
100  int size;
101  const uint8_t *pal = av_packet_get_side_data(avpkt, AV_PKT_DATA_PALETTE, &size);
102 
103  if (pal && size == AVPALETTE_SIZE) {
104  s->frame->palette_has_changed = 1;
105  memcpy(s->pal, pal, AVPALETTE_SIZE);
106  } else if (pal) {
107  av_log(avctx, AV_LOG_ERROR, "Palette size %d is wrong\n", size);
108  }
109  /* make the palette available */
110  memcpy(s->frame->data[1], s->pal, AVPALETTE_SIZE);
111  }
112 
113  /* FIXME how to correctly detect RLE ??? */
114  if (avctx->height * istride == avpkt->size) { /* assume uncompressed */
115  int linesize = av_image_get_linesize(avctx->pix_fmt, avctx->width, 0);
116  uint8_t *ptr = s->frame->data[0];
117  uint8_t *buf = avpkt->data + (avctx->height-1)*istride;
118  int i, j;
119 
120  if (linesize < 0)
121  return linesize;
122 
123  for (i = 0; i < avctx->height; i++) {
124  if (avctx->bits_per_coded_sample == 4) {
125  for (j = 0; j < avctx->width - 1; j += 2) {
126  ptr[j+0] = buf[j>>1] >> 4;
127  ptr[j+1] = buf[j>>1] & 0xF;
128  }
129  if (avctx->width & 1)
130  ptr[j+0] = buf[j>>1] >> 4;
131  } else {
132  memcpy(ptr, buf, linesize);
133  }
134  buf -= istride;
135  ptr += s->frame->linesize[0];
136  }
137  } else {
138  bytestream2_init(&s->gb, buf, buf_size);
139  ff_msrle_decode(avctx, s->frame, avctx->bits_per_coded_sample, &s->gb);
140  }
141 
142  if ((ret = av_frame_ref(data, s->frame)) < 0)
143  return ret;
144 
145  *got_frame = 1;
146 
147  /* report that the buffer was completely consumed */
148  return buf_size;
149 }
150 
152 {
153  MsrleContext *s = avctx->priv_data;
154 
155  av_frame_unref(s->frame);
156 }
157 
159 {
160  MsrleContext *s = avctx->priv_data;
161 
162  /* release the last frame */
163  av_frame_free(&s->frame);
164 
165  return 0;
166 }
167 
169  .name = "msrle",
170  .long_name = NULL_IF_CONFIG_SMALL("Microsoft RLE"),
171  .type = AVMEDIA_TYPE_VIDEO,
172  .id = AV_CODEC_ID_MSRLE,
173  .priv_data_size = sizeof(MsrleContext),
175  .close = msrle_decode_end,
178  .capabilities = AV_CODEC_CAP_DR1,
179 };
int av_image_get_linesize(enum AVPixelFormat pix_fmt, int width, int plane)
Compute the size of an image line with format pix_fmt and width width for the plane plane...
Definition: imgutils.c:76
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:59
AVCodecContext * avctx
Definition: msrle.c:41
This structure describes decoded (raw) audio or video data.
Definition: frame.h:295
int ff_msrle_decode(AVCodecContext *avctx, AVFrame *pic, int depth, GetByteContext *gb)
Decode stream in MS RLE format into frame.
Definition: msrledec.c:249
ptrdiff_t const GLvoid * data
Definition: opengl_enc.c:100
static void flush(AVCodecContext *avctx)
misc image utilities
static av_cold int init(AVCodecContext *avctx)
Definition: avrndec.c:35
int size
Definition: avcodec.h:1481
enum AVPixelFormat pix_fmt
Pixel format, see AV_PIX_FMT_xxx.
Definition: avcodec.h:1778
static av_always_inline void bytestream2_init(GetByteContext *g, const uint8_t *buf, int buf_size)
Definition: bytestream.h:133
static void msrle_decode_flush(AVCodecContext *avctx)
Definition: msrle.c:151
GetByteContext gb
Definition: msrle.c:44
AVCodec.
Definition: avcodec.h:3492
static void decode(AVCodecContext *dec_ctx, AVPacket *pkt, AVFrame *frame, FILE *outfile)
Definition: decode_audio.c:71
uint8_t
#define av_cold
Definition: attributes.h:82
AVFrame * av_frame_alloc(void)
Allocate an AVFrame and set its fields to default values.
Definition: frame.c:189
8 bits with AV_PIX_FMT_RGB32 palette
Definition: pixfmt.h:77
#define AVPALETTE_SIZE
Definition: pixfmt.h:32
int av_frame_ref(AVFrame *dst, const AVFrame *src)
Set up a new reference to the data described by the source frame.
Definition: frame.c:443
uint8_t * extradata
some codecs need / can use extradata like Huffman tables.
Definition: avcodec.h:1669
uint8_t * data
Definition: avcodec.h:1480
ptrdiff_t size
Definition: opengl_enc.c:100
int bits_per_coded_sample
bits per sample/pixel from the demuxer (needed for huffyuv).
Definition: avcodec.h:2792
#define FFALIGN(x, a)
Definition: macros.h:48
#define av_log(a,...)
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:259
static int msrle_decode_frame(AVCodecContext *avctx, void *data, int *got_frame, AVPacket *avpkt)
Definition: msrle.c:83
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:176
An AV_PKT_DATA_PALETTE side data packet contains exactly AVPALETTE_SIZE bytes worth of palette...
Definition: avcodec.h:1193
uint8_t * av_packet_get_side_data(const AVPacket *pkt, enum AVPacketSideDataType type, int *size)
Get side information from packet.
Definition: avpacket.c:350
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:202
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:186
int ff_reget_buffer(AVCodecContext *avctx, AVFrame *frame, int flags)
Identical in function to ff_get_buffer(), except it reuses the existing buffer if available...
Definition: decode.c:2015
const char * name
Name of the codec implementation.
Definition: avcodec.h:3499
#define FFMIN(a, b)
Definition: common.h:96
int width
picture width / height.
Definition: avcodec.h:1741
#define s(width, name)
Definition: cbs_vp9.c:257
packed RGB 8:8:8, 24bpp, BGRBGR...
Definition: pixfmt.h:69
AVCodec ff_msrle_decoder
Definition: msrle.c:168
Libavcodec external API header.
int linesize[AV_NUM_DATA_POINTERS]
For video, size in bytes of each picture line.
Definition: frame.h:326
main external API structure.
Definition: avcodec.h:1568
void * buf
Definition: avisynth_c.h:766
int extradata_size
Definition: avcodec.h:1670
int palette_has_changed
Tell user application that palette has changed from previous frame.
Definition: frame.h:452
void av_frame_unref(AVFrame *frame)
Unreference all the buffers referenced by frame and reset the frame fields.
Definition: frame.c:553
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
Definition: frame.h:309
AVFrame * frame
Definition: msrle.c:42
common internal api header.
Y , 1bpp, 0 is white, 1 is black, in each byte pixels are ordered from the msb to the lsb...
Definition: pixfmt.h:75
void * priv_data
Definition: avcodec.h:1595
static av_cold int msrle_decode_init(AVCodecContext *avctx)
Definition: msrle.c:49
Filter the word “frame” indicates either a video frame or a group of audio as stored in an AVFrame structure Format for each input and each output the list of supported formats For video that means pixel format For audio that means channel sample they are references to shared objects When the negotiation mechanism computes the intersection of the formats supported at each end of a all references to both lists are replaced with a reference to the intersection And when a single format is eventually chosen for a link amongst the remaining all references to the list are updated That means that if a filter requires that its input and output have the same format amongst a supported all it has to do is use a reference to the same list of formats query_formats can leave some formats unset and return AVERROR(EAGAIN) to cause the negotiation mechanism toagain later.That can be used by filters with complex requirements to use the format negotiated on one link to set the formats supported on another.Frame references ownership and permissions
static av_cold int msrle_decode_end(AVCodecContext *avctx)
Definition: msrle.c:158
uint32_t pal[256]
Definition: msrle.c:46
uint64_t_TMPL AV_WL64 unsigned int_TMPL AV_RL32
Definition: bytestream.h:87
This structure stores compressed data.
Definition: avcodec.h:1457
#define AV_CODEC_CAP_DR1
Codec uses get_buffer() for allocating buffers and supports custom allocators.
Definition: avcodec.h:984