FFmpeg
sunrast.c
Go to the documentation of this file.
1 /*
2  * Sun Rasterfile (.sun/.ras/im{1,8,24}/.sunras) image decoder
3  * Copyright (c) 2007, 2008 Ivo van Poorten
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 #include "libavutil/avassert.h"
23 #include "libavutil/common.h"
24 #include "libavutil/intreadwrite.h"
25 #include "libavutil/mem.h"
26 #include "avcodec.h"
27 #include "codec_internal.h"
28 #include "decode.h"
29 #include "sunrast.h"
30 
32  int *got_frame, AVPacket *avpkt)
33 {
34  const uint8_t *buf = avpkt->data;
35  const uint8_t *buf_end = avpkt->data + avpkt->size;
36  unsigned int w, h, depth, type, maptype, maplength, x, y, len, alen;
37  ptrdiff_t stride;
38  uint8_t *ptr, *ptr2 = NULL;
39  const uint8_t *bufstart = buf;
40  int ret;
41 
42  if (avpkt->size < 32)
43  return AVERROR_INVALIDDATA;
44 
45  if (AV_RB32(buf) != RAS_MAGIC) {
46  av_log(avctx, AV_LOG_ERROR, "this is not sunras encoded data\n");
47  return AVERROR_INVALIDDATA;
48  }
49 
50  w = AV_RB32(buf + 4);
51  h = AV_RB32(buf + 8);
52  depth = AV_RB32(buf + 12);
53  type = AV_RB32(buf + 20);
54  maptype = AV_RB32(buf + 24);
55  maplength = AV_RB32(buf + 28);
56  buf += 32;
57 
58  if (type == RT_EXPERIMENTAL) {
59  avpriv_request_sample(avctx, "TIFF/IFF/EXPERIMENTAL (compression) type");
60  return AVERROR_PATCHWELCOME;
61  }
62  if (type > RT_FORMAT_IFF) {
63  av_log(avctx, AV_LOG_ERROR, "invalid (compression) type\n");
64  return AVERROR_INVALIDDATA;
65  }
66  if (maptype == RMT_RAW) {
67  avpriv_request_sample(avctx, "Unknown colormap type");
68  return AVERROR_PATCHWELCOME;
69  }
70  if (maptype > RMT_RAW) {
71  av_log(avctx, AV_LOG_ERROR, "invalid colormap type\n");
72  return AVERROR_INVALIDDATA;
73  }
74 
75  if (type == RT_FORMAT_TIFF || type == RT_FORMAT_IFF) {
76  av_log(avctx, AV_LOG_ERROR, "unsupported (compression) type\n");
77  return AVERROR_PATCHWELCOME;
78  }
79 
80  if (maplength > 768) {
81  av_log(avctx, AV_LOG_WARNING, "invalid colormap length\n");
82  return AVERROR_INVALIDDATA;
83  }
84 
85  // This also checks depth to be valid
86  switch (depth) {
87  case 1:
88  avctx->pix_fmt = maplength ? AV_PIX_FMT_PAL8 : AV_PIX_FMT_MONOWHITE;
89  break;
90  case 4:
91  avctx->pix_fmt = maplength ? AV_PIX_FMT_PAL8 : AV_PIX_FMT_NONE;
92  break;
93  case 8:
94  avctx->pix_fmt = maplength ? AV_PIX_FMT_PAL8 : AV_PIX_FMT_GRAY8;
95  break;
96  case 24:
98  break;
99  case 32:
101  break;
102  default:
103  av_log(avctx, AV_LOG_ERROR, "invalid depth\n");
104  return AVERROR_INVALIDDATA;
105  }
106 
107  // This checks w and h to be valid in the sense that bytes of a padded bitmap are addressable with 32bit int
108  ret = ff_set_dimensions(avctx, w, h);
109  if (ret < 0)
110  return ret;
111 
112  // ensured by ff_set_dimensions()
113  av_assert0(w <= (INT32_MAX - 7) / depth);
114 
115  /* scanlines are aligned on 16 bit boundaries */
116  len = (depth * w + 7) >> 3;
117  alen = len + (len & 1);
118 
119  // ensured by ff_set_dimensions()
120  av_assert0(h <= INT32_MAX / (3 * len));
121 
122  // maplength is limited to 768 and the right term is limited to INT32_MAX / 256 so the add needs no check
123  if (buf_end - buf < (uint64_t)maplength + (len * h) * 3 / 256)
124  return AVERROR_INVALIDDATA;
125 
126  if ((ret = ff_get_buffer(avctx, p, 0)) < 0)
127  return ret;
128 
130 
131  if (depth > 8 && maplength) {
132  av_log(avctx, AV_LOG_WARNING, "useless colormap found or file is corrupted, trying to recover\n");
133 
134  } else if (maplength) {
135  unsigned int len = maplength / 3;
136 
137  if (maplength % 3) {
138  av_log(avctx, AV_LOG_WARNING, "invalid colormap length\n");
139  return AVERROR_INVALIDDATA;
140  }
141 
142  ptr = p->data[1];
143  for (x = 0; x < len; x++, ptr += 4)
144  *(uint32_t *)ptr = (0xFFU<<24) + (buf[x]<<16) + (buf[len+x]<<8) + buf[len+len+x];
145  }
146 
147  buf += maplength;
148 
149  if (maplength && depth < 8) {
150  ptr = ptr2 = av_malloc_array((w + 15), h);
151  if (!ptr)
152  return AVERROR(ENOMEM);
153  stride = (w + 15 >> 3) * depth;
154  } else {
155  ptr = p->data[0];
156  stride = p->linesize[0];
157  }
158 
159  if (type == RT_BYTE_ENCODED) {
160  int value, run;
161  uint8_t *end = ptr + (ptrdiff_t)h * stride;
162 
163  x = 0;
164  while (ptr != end && buf < buf_end) {
165  run = 1;
166  if (buf_end - buf < 1)
167  return AVERROR_INVALIDDATA;
168 
169  if ((value = *buf++) == RLE_TRIGGER) {
170  run = *buf++ + 1;
171  if (run != 1)
172  value = *buf++;
173  }
174  while (run--) {
175  if (x < len)
176  ptr[x] = value;
177  if (++x >= alen) {
178  x = 0;
179  ptr += stride;
180  if (ptr == end)
181  break;
182  }
183  }
184  }
185  } else {
186  for (y = 0; y < h; y++) {
187  if (buf_end - buf < alen)
188  break;
189  memcpy(ptr, buf, len);
190  ptr += stride;
191  buf += alen;
192  }
193  }
194  if (avctx->pix_fmt == AV_PIX_FMT_PAL8 && depth < 8) {
195  uint8_t *ptr_free = ptr2;
196  ptr = p->data[0];
197  for (y=0; y<h; y++) {
198  for (x = 0; x < (w + 7 >> 3) * depth; x++) {
199  if (depth == 1) {
200  ptr[8*x] = ptr2[x] >> 7;
201  ptr[8*x+1] = ptr2[x] >> 6 & 1;
202  ptr[8*x+2] = ptr2[x] >> 5 & 1;
203  ptr[8*x+3] = ptr2[x] >> 4 & 1;
204  ptr[8*x+4] = ptr2[x] >> 3 & 1;
205  ptr[8*x+5] = ptr2[x] >> 2 & 1;
206  ptr[8*x+6] = ptr2[x] >> 1 & 1;
207  ptr[8*x+7] = ptr2[x] & 1;
208  } else {
209  ptr[2*x] = ptr2[x] >> 4;
210  ptr[2*x+1] = ptr2[x] & 0xF;
211  }
212  }
213  ptr += p->linesize[0];
214  ptr2 += (w + 15 >> 3) * depth;
215  }
216  av_freep(&ptr_free);
217  }
218 
219  *got_frame = 1;
220 
221  return buf - bufstart;
222 }
223 
225  .p.name = "sunrast",
226  CODEC_LONG_NAME("Sun Rasterfile image"),
227  .p.type = AVMEDIA_TYPE_VIDEO,
228  .p.id = AV_CODEC_ID_SUNRAST,
229  .p.capabilities = AV_CODEC_CAP_DR1,
231 };
AV_LOG_WARNING
#define AV_LOG_WARNING
Something somehow does not look correct.
Definition: log.h:186
AVERROR
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
sunrast_decode_frame
static int sunrast_decode_frame(AVCodecContext *avctx, AVFrame *p, int *got_frame, AVPacket *avpkt)
Definition: sunrast.c:31
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:374
w
uint8_t w
Definition: llviddspenc.c:38
AVPacket::data
uint8_t * data
Definition: packet.h:524
AV_PIX_FMT_MONOWHITE
@ AV_PIX_FMT_MONOWHITE
Y , 1bpp, 0 is white, 1 is black, in each byte pixels are ordered from the msb to the lsb.
Definition: pixfmt.h:82
FFCodec
Definition: codec_internal.h:126
AV_PIX_FMT_BGR24
@ AV_PIX_FMT_BGR24
packed RGB 8:8:8, 24bpp, BGRBGR...
Definition: pixfmt.h:76
RMT_RAW
#define RMT_RAW
the data layout of this map type is unknown
Definition: sunrast.h:29
ff_set_dimensions
int ff_set_dimensions(AVCodecContext *s, int width, int height)
Check that the provided frame dimensions are valid and set them on the codec context.
Definition: utils.c:94
AVFrame::data
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
Definition: frame.h:395
FFCodec::p
AVCodec p
The public AVCodec.
Definition: codec_internal.h:130
type
it s the only field you need to keep assuming you have a context There is some magic you don t need to care about around this just let it vf type
Definition: writing_filters.txt:86
RT_FORMAT_RGB
#define RT_FORMAT_RGB
Definition: sunrast.h:43
avassert.h
AV_LOG_ERROR
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:180
FF_CODEC_DECODE_CB
#define FF_CODEC_DECODE_CB(func)
Definition: codec_internal.h:286
intreadwrite.h
av_assert0
#define av_assert0(cond)
assert() equivalent, that is always enabled.
Definition: avassert.h:40
decode.h
ff_sunrast_decoder
const FFCodec ff_sunrast_decoder
Definition: sunrast.c:224
CODEC_LONG_NAME
#define CODEC_LONG_NAME(str)
Definition: codec_internal.h:271
NULL
#define NULL
Definition: coverity.c:32
AVERROR_PATCHWELCOME
#define AVERROR_PATCHWELCOME
Not yet implemented in FFmpeg, patches welcome.
Definition: error.h:64
run
uint8_t run
Definition: svq3.c:204
AV_PICTURE_TYPE_I
@ AV_PICTURE_TYPE_I
Intra.
Definition: avutil.h:279
RT_EXPERIMENTAL
#define RT_EXPERIMENTAL
Definition: sunrast.h:54
sunrast.h
AV_PIX_FMT_GRAY8
@ AV_PIX_FMT_GRAY8
Y , 8bpp.
Definition: pixfmt.h:81
AVFrame::pict_type
enum AVPictureType pict_type
Picture type of the frame.
Definition: frame.h:476
ff_get_buffer
int ff_get_buffer(AVCodecContext *avctx, AVFrame *frame, int flags)
Get a buffer for a frame.
Definition: decode.c:1575
AV_PIX_FMT_RGB24
@ AV_PIX_FMT_RGB24
packed RGB 8:8:8, 24bpp, RGBRGB...
Definition: pixfmt.h:75
AV_CODEC_CAP_DR1
#define AV_CODEC_CAP_DR1
Codec uses get_buffer() or get_encode_buffer() for allocating buffers and supports custom allocators.
Definition: codec.h:52
AVPacket::size
int size
Definition: packet.h:525
codec_internal.h
AV_RB32
uint64_t_TMPL AV_WL64 unsigned int_TMPL AV_WL32 unsigned int_TMPL AV_WL24 unsigned int_TMPL AV_WL16 uint64_t_TMPL AV_WB64 unsigned int_TMPL AV_RB32
Definition: bytestream.h:96
RLE_TRIGGER
#define RLE_TRIGGER
Definition: sunrast.h:39
av_malloc_array
#define av_malloc_array(a, b)
Definition: tableprint_vlc.h:31
common.h
value
it s the only field you need to keep assuming you have a context There is some magic you don t need to care about around this just let it vf default value
Definition: writing_filters.txt:86
AVCodec::name
const char * name
Name of the codec implementation.
Definition: codec.h:194
len
int len
Definition: vorbis_enc_data.h:426
AVCodecContext::pix_fmt
enum AVPixelFormat pix_fmt
Pixel format, see AV_PIX_FMT_xxx.
Definition: avcodec.h:657
avcodec.h
stride
#define stride
Definition: h264pred_template.c:537
AV_PIX_FMT_PAL8
@ AV_PIX_FMT_PAL8
8 bits with AV_PIX_FMT_RGB32 palette
Definition: pixfmt.h:84
ret
ret
Definition: filter_design.txt:187
AV_PIX_FMT_0BGR
@ AV_PIX_FMT_0BGR
packed BGR 8:8:8, 32bpp, XBGRXBGR... X=unused/undefined
Definition: pixfmt.h:264
U
#define U(x)
Definition: vpx_arith.h:37
AVCodecContext
main external API structure.
Definition: avcodec.h:445
AV_PIX_FMT_NONE
@ AV_PIX_FMT_NONE
Definition: pixfmt.h:72
AVMEDIA_TYPE_VIDEO
@ AVMEDIA_TYPE_VIDEO
Definition: avutil.h:201
mem.h
RT_BYTE_ENCODED
#define RT_BYTE_ENCODED
Definition: sunrast.h:38
avpriv_request_sample
#define avpriv_request_sample(...)
Definition: tableprint_vlc.h:36
AVPacket
This structure stores compressed data.
Definition: packet.h:501
av_freep
#define av_freep(p)
Definition: tableprint_vlc.h:34
AVFrame::linesize
int linesize[AV_NUM_DATA_POINTERS]
For video, a positive or negative value, which is typically indicating the size in bytes of each pict...
Definition: frame.h:419
AV_PIX_FMT_0RGB
@ AV_PIX_FMT_0RGB
packed RGB 8:8:8, 32bpp, XRGBXRGB... X=unused/undefined
Definition: pixfmt.h:262
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:27
AVERROR_INVALIDDATA
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:61
AV_CODEC_ID_SUNRAST
@ AV_CODEC_ID_SUNRAST
Definition: codec_id.h:162
h
h
Definition: vp9dsp_template.c:2038
RT_FORMAT_TIFF
#define RT_FORMAT_TIFF
Definition: sunrast.h:48
RAS_MAGIC
#define RAS_MAGIC
Definition: sunrast.h:25
RT_FORMAT_IFF
#define RT_FORMAT_IFF
Definition: sunrast.h:49