xwddec.c
Go to the documentation of this file.
1 /*
2  * XWD image format
3  *
4  * Copyright (c) 2012 Paul B Mahol
5  *
6  * This file is part of FFmpeg.
7  *
8  * FFmpeg is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public
10  * License as published by the Free Software Foundation; either
11  * version 2.1 of the License, or (at your option) any later version.
12  *
13  * FFmpeg is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with FFmpeg; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21  */
22 
23 #include "libavutil/imgutils.h"
24 #include "avcodec.h"
25 #include "bytestream.h"
26 #include "internal.h"
27 #include "xwd.h"
28 
29 static int xwd_decode_frame(AVCodecContext *avctx, void *data,
30  int *got_frame, AVPacket *avpkt)
31 {
32  AVFrame *p = data;
33  const uint8_t *buf = avpkt->data;
34  int i, ret, buf_size = avpkt->size;
35  uint32_t version, header_size, vclass, ncolors;
36  uint32_t xoffset, be, bpp, lsize, rsize;
37  uint32_t pixformat, pixdepth, bunit, bitorder, bpad;
38  uint32_t rgb[3];
39  uint8_t *ptr;
40  GetByteContext gb;
41 
42  if (buf_size < XWD_HEADER_SIZE)
43  return AVERROR_INVALIDDATA;
44 
45  bytestream2_init(&gb, buf, buf_size);
46  header_size = bytestream2_get_be32u(&gb);
47 
48  version = bytestream2_get_be32u(&gb);
49  if (version != XWD_VERSION) {
50  av_log(avctx, AV_LOG_ERROR, "unsupported version\n");
51  return AVERROR_INVALIDDATA;
52  }
53 
54  if (buf_size < header_size || header_size < XWD_HEADER_SIZE) {
55  av_log(avctx, AV_LOG_ERROR, "invalid header size\n");
56  return AVERROR_INVALIDDATA;
57  }
58 
59  pixformat = bytestream2_get_be32u(&gb);
60  pixdepth = bytestream2_get_be32u(&gb);
61  avctx->width = bytestream2_get_be32u(&gb);
62  avctx->height = bytestream2_get_be32u(&gb);
63  xoffset = bytestream2_get_be32u(&gb);
64  be = bytestream2_get_be32u(&gb);
65  bunit = bytestream2_get_be32u(&gb);
66  bitorder = bytestream2_get_be32u(&gb);
67  bpad = bytestream2_get_be32u(&gb);
68  bpp = bytestream2_get_be32u(&gb);
69  lsize = bytestream2_get_be32u(&gb);
70  vclass = bytestream2_get_be32u(&gb);
71  rgb[0] = bytestream2_get_be32u(&gb);
72  rgb[1] = bytestream2_get_be32u(&gb);
73  rgb[2] = bytestream2_get_be32u(&gb);
74  bytestream2_skipu(&gb, 8);
75  ncolors = bytestream2_get_be32u(&gb);
76  bytestream2_skipu(&gb, header_size - (XWD_HEADER_SIZE - 20));
77 
78  av_log(avctx, AV_LOG_DEBUG, "pixformat %d, pixdepth %d, bunit %d, bitorder %d, bpad %d\n",
79  pixformat, pixdepth, bunit, bitorder, bpad);
80  av_log(avctx, AV_LOG_DEBUG, "vclass %d, ncolors %d, bpp %d, be %d, lsize %d, xoffset %d\n",
81  vclass, ncolors, bpp, be, lsize, xoffset);
82  av_log(avctx, AV_LOG_DEBUG, "red %0x, green %0x, blue %0x\n", rgb[0], rgb[1], rgb[2]);
83 
84  if (pixformat > XWD_Z_PIXMAP) {
85  av_log(avctx, AV_LOG_ERROR, "invalid pixmap format\n");
86  return AVERROR_INVALIDDATA;
87  }
88 
89  if (pixdepth == 0 || pixdepth > 32) {
90  av_log(avctx, AV_LOG_ERROR, "invalid pixmap depth\n");
91  return AVERROR_INVALIDDATA;
92  }
93 
94  if (xoffset) {
95  avpriv_request_sample(avctx, "xoffset %d", xoffset);
96  return AVERROR_PATCHWELCOME;
97  }
98 
99  if (be > 1) {
100  av_log(avctx, AV_LOG_ERROR, "invalid byte order\n");
101  return AVERROR_INVALIDDATA;
102  }
103 
104  if (bitorder > 1) {
105  av_log(avctx, AV_LOG_ERROR, "invalid bitmap bit order\n");
106  return AVERROR_INVALIDDATA;
107  }
108 
109  if (bunit != 8 && bunit != 16 && bunit != 32) {
110  av_log(avctx, AV_LOG_ERROR, "invalid bitmap unit\n");
111  return AVERROR_INVALIDDATA;
112  }
113 
114  if (bpad != 8 && bpad != 16 && bpad != 32) {
115  av_log(avctx, AV_LOG_ERROR, "invalid bitmap scan-line pad\n");
116  return AVERROR_INVALIDDATA;
117  }
118 
119  if (bpp == 0 || bpp > 32) {
120  av_log(avctx, AV_LOG_ERROR, "invalid bits per pixel\n");
121  return AVERROR_INVALIDDATA;
122  }
123 
124  if (ncolors > 256) {
125  av_log(avctx, AV_LOG_ERROR, "invalid number of entries in colormap\n");
126  return AVERROR_INVALIDDATA;
127  }
128 
129  if ((ret = av_image_check_size(avctx->width, avctx->height, 0, NULL)) < 0)
130  return ret;
131 
132  rsize = FFALIGN(avctx->width * bpp, bpad) / 8;
133  if (lsize < rsize) {
134  av_log(avctx, AV_LOG_ERROR, "invalid bytes per scan-line\n");
135  return AVERROR_INVALIDDATA;
136  }
137 
138  if (bytestream2_get_bytes_left(&gb) < ncolors * XWD_CMAP_SIZE + avctx->height * lsize) {
139  av_log(avctx, AV_LOG_ERROR, "input buffer too small\n");
140  return AVERROR_INVALIDDATA;
141  }
142 
143  if (pixformat != XWD_Z_PIXMAP) {
144  av_log(avctx, AV_LOG_ERROR, "pixmap format %d unsupported\n", pixformat);
145  return AVERROR_PATCHWELCOME;
146  }
147 
148  avctx->pix_fmt = AV_PIX_FMT_NONE;
149  switch (vclass) {
150  case XWD_STATIC_GRAY:
151  case XWD_GRAY_SCALE:
152  if (bpp != 1 && bpp != 8)
153  return AVERROR_INVALIDDATA;
154  if (pixdepth == 1) {
155  avctx->pix_fmt = AV_PIX_FMT_MONOWHITE;
156  } else if (pixdepth == 8) {
157  avctx->pix_fmt = AV_PIX_FMT_GRAY8;
158  }
159  break;
160  case XWD_STATIC_COLOR:
161  case XWD_PSEUDO_COLOR:
162  if (bpp == 8)
163  avctx->pix_fmt = AV_PIX_FMT_PAL8;
164  break;
165  case XWD_TRUE_COLOR:
166  case XWD_DIRECT_COLOR:
167  if (bpp != 16 && bpp != 24 && bpp != 32)
168  return AVERROR_INVALIDDATA;
169  if (bpp == 16 && pixdepth == 15) {
170  if (rgb[0] == 0x7C00 && rgb[1] == 0x3E0 && rgb[2] == 0x1F)
172  else if (rgb[0] == 0x1F && rgb[1] == 0x3E0 && rgb[2] == 0x7C00)
174  } else if (bpp == 16 && pixdepth == 16) {
175  if (rgb[0] == 0xF800 && rgb[1] == 0x7E0 && rgb[2] == 0x1F)
177  else if (rgb[0] == 0x1F && rgb[1] == 0x7E0 && rgb[2] == 0xF800)
179  } else if (bpp == 24) {
180  if (rgb[0] == 0xFF0000 && rgb[1] == 0xFF00 && rgb[2] == 0xFF)
181  avctx->pix_fmt = be ? AV_PIX_FMT_RGB24 : AV_PIX_FMT_BGR24;
182  else if (rgb[0] == 0xFF && rgb[1] == 0xFF00 && rgb[2] == 0xFF0000)
183  avctx->pix_fmt = be ? AV_PIX_FMT_BGR24 : AV_PIX_FMT_RGB24;
184  } else if (bpp == 32) {
185  if (rgb[0] == 0xFF0000 && rgb[1] == 0xFF00 && rgb[2] == 0xFF)
186  avctx->pix_fmt = be ? AV_PIX_FMT_ARGB : AV_PIX_FMT_BGRA;
187  else if (rgb[0] == 0xFF && rgb[1] == 0xFF00 && rgb[2] == 0xFF0000)
188  avctx->pix_fmt = be ? AV_PIX_FMT_ABGR : AV_PIX_FMT_RGBA;
189  }
190  bytestream2_skipu(&gb, ncolors * XWD_CMAP_SIZE);
191  break;
192  default:
193  av_log(avctx, AV_LOG_ERROR, "invalid visual class\n");
194  return AVERROR_INVALIDDATA;
195  }
196 
197  if (avctx->pix_fmt == AV_PIX_FMT_NONE) {
198  avpriv_request_sample(avctx,
199  "Unknown file: bpp %d, pixdepth %d, vclass %d",
200  bpp, pixdepth, vclass);
201  return AVERROR_PATCHWELCOME;
202  }
203 
204  if ((ret = ff_get_buffer(avctx, p, 0)) < 0)
205  return ret;
206 
207  p->key_frame = 1;
209 
210  if (avctx->pix_fmt == AV_PIX_FMT_PAL8) {
211  uint32_t *dst = (uint32_t *)p->data[1];
212  uint8_t red, green, blue;
213 
214  for (i = 0; i < ncolors; i++) {
215 
216  bytestream2_skipu(&gb, 4); // skip colormap entry number
217  red = bytestream2_get_byteu(&gb);
218  bytestream2_skipu(&gb, 1);
219  green = bytestream2_get_byteu(&gb);
220  bytestream2_skipu(&gb, 1);
221  blue = bytestream2_get_byteu(&gb);
222  bytestream2_skipu(&gb, 3); // skip bitmask flag and padding
223 
224  dst[i] = red << 16 | green << 8 | blue;
225  }
226  }
227 
228  ptr = p->data[0];
229  for (i = 0; i < avctx->height; i++) {
230  bytestream2_get_bufferu(&gb, ptr, rsize);
231  bytestream2_skipu(&gb, lsize - rsize);
232  ptr += p->linesize[0];
233  }
234 
235  *got_frame = 1;
236 
237  return buf_size;
238 }
239 
241  .name = "xwd",
242  .type = AVMEDIA_TYPE_VIDEO,
243  .id = AV_CODEC_ID_XWD,
244  .decode = xwd_decode_frame,
245  .capabilities = CODEC_CAP_DR1,
246  .long_name = NULL_IF_CONFIG_SMALL("XWD (X Window Dump) image"),
247 };
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:59
This structure describes decoded (raw) audio or video data.
Definition: frame.h:76
#define XWD_GRAY_SCALE
Definition: xwd.h:35
misc image utilities
packed RGB 8:8:8, 24bpp, RGBRGB...
Definition: pixfmt.h:70
packed RGB 5:5:5, 16bpp, (msb)1A 5R 5G 5B(lsb), little-endian, most significant bit to 0 ...
Definition: pixfmt.h:117
enum AVPixelFormat pix_fmt
Pixel format, see AV_PIX_FMT_xxx.
static av_always_inline void bytestream2_init(GetByteContext *g, const uint8_t *buf, int buf_size)
Definition: bytestream.h:130
packed BGR 5:6:5, 16bpp, (msb) 5B 6G 5R(lsb), little-endian
Definition: pixfmt.h:120
int version
Definition: avisynth_c.h:666
#define XWD_DIRECT_COLOR
Definition: xwd.h:39
static av_always_inline unsigned int bytestream2_get_bufferu(GetByteContext *g, uint8_t *dst, unsigned int size)
Definition: bytestream.h:268
#define FFALIGN(x, a)
Definition: common.h:63
packed RGB 5:6:5, 16bpp, (msb) 5R 6G 5B(lsb), little-endian
Definition: pixfmt.h:115
void void avpriv_request_sample(void *avc, const char *msg,...) av_printf_format(2
Log a generic warning message about a missing feature.
uint8_t
8 bit with PIX_FMT_RGB32 palette
Definition: pixfmt.h:79
#define XWD_STATIC_GRAY
Definition: xwd.h:34
packed RGB 5:6:5, 16bpp, (msb) 5R 6G 5B(lsb), big-endian
Definition: pixfmt.h:114
packed ABGR 8:8:8:8, 32bpp, ABGRABGR...
Definition: pixfmt.h:98
#define CODEC_CAP_DR1
Codec uses get_buffer() for allocating buffers and supports custom allocators.
uint8_t * data
#define XWD_HEADER_SIZE
Definition: xwd.h:27
static av_always_inline void bytestream2_skipu(GetByteContext *g, unsigned int size)
Definition: bytestream.h:165
#define XWD_CMAP_SIZE
Definition: xwd.h:28
#define XWD_VERSION
Definition: xwd.h:26
#define XWD_Z_PIXMAP
Definition: xwd.h:32
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
packed BGRA 8:8:8:8, 32bpp, BGRABGRA...
Definition: pixfmt.h:99
Spectrum Plot time data
static av_always_inline unsigned int bytestream2_get_bytes_left(GetByteContext *g)
Definition: bytestream.h:149
void av_log(void *avcl, int level, const char *fmt,...)
Definition: log.c:246
const char * name
Name of the codec implementation.
external API header
packed ARGB 8:8:8:8, 32bpp, ARGBARGB...
Definition: pixfmt.h:96
packed RGBA 8:8:8:8, 32bpp, RGBARGBA...
Definition: pixfmt.h:97
int av_image_check_size(unsigned int w, unsigned int h, int log_offset, void *log_ctx)
Check if the given dimension of an image is valid, meaning that all bytes of the image can be address...
Definition: imgutils.c:231
enum AVPictureType pict_type
Picture type of the frame.
Definition: frame.h:144
ret
Definition: avfilter.c:821
int width
picture width / height.
static int xwd_decode_frame(AVCodecContext *avctx, void *data, int *got_frame, AVPacket *avpkt)
Definition: xwddec.c:29
AVCodec ff_xwd_decoder
Definition: xwddec.c:240
packed RGB 8:8:8, 24bpp, BGRBGR...
Definition: pixfmt.h:71
packed BGR 5:6:5, 16bpp, (msb) 5B 6G 5R(lsb), big-endian
Definition: pixfmt.h:119
#define AVERROR_PATCHWELCOME
Not yet implemented in FFmpeg, patches welcome.
Definition: error.h:62
NULL
Definition: eval.c:55
int linesize[AV_NUM_DATA_POINTERS]
For video, size in bytes of each picture line.
Definition: frame.h:101
main external API structure.
int ff_get_buffer(AVCodecContext *avctx, AVFrame *frame, int flags)
Get a buffer for a frame.
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:148
void * buf
Definition: avisynth_c.h:594
synthesis window for stochastic i
packed BGR 5:5:5, 16bpp, (msb)1A 5B 5G 5R(lsb), little-endian, most significant bit to 1 ...
Definition: pixfmt.h:122
#define XWD_STATIC_COLOR
Definition: xwd.h:36
packed RGB 5:5:5, 16bpp, (msb)1A 5R 5G 5B(lsb), big-endian, most significant bit to 0 ...
Definition: pixfmt.h:116
#define XWD_TRUE_COLOR
Definition: xwd.h:38
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
Definition: frame.h:87
Y , 8bpp.
Definition: pixfmt.h:76
common internal api header.
#define XWD_PSEUDO_COLOR
Definition: xwd.h:37
#define AV_LOG_DEBUG
Stuff which is only useful for libav* developers.
Definition: log.h:162
Y , 1bpp, 0 is white, 1 is black, in each byte pixels are ordered from the msb to the lsb...
Definition: pixfmt.h:77
else dst[i][x+y *dst_stride[i]]
Definition: vf_mcdeint.c:160
int key_frame
1 -> keyframe, 0-> not
Definition: frame.h:139
packed BGR 5:5:5, 16bpp, (msb)1A 5B 5G 5R(lsb), big-endian, most significant bit to 1 ...
Definition: pixfmt.h:121
This structure stores compressed data.
for(j=16;j >0;--j)