FFmpeg
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
iff.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2008 Jaikrishnan Menon <realityman@gmx.net>
3  * Copyright (c) 2010 Peter Ross <pross@xvid.org>
4  * Copyright (c) 2010 Sebastian Vater <cdgs.basty@googlemail.com>
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 /**
24  * @file
25  * IFF file demuxer
26  * by Jaikrishnan Menon
27  * for more information on the .iff file format, visit:
28  * http://wiki.multimedia.cx/index.php?title=IFF
29  */
30 
31 #include "libavutil/avassert.h"
32 #include "libavutil/channel_layout.h"
33 #include "libavutil/intreadwrite.h"
34 #include "libavutil/dict.h"
35 #include "libavcodec/bytestream.h"
36 #include "avformat.h"
37 #include "internal.h"
38 
39 #define ID_8SVX MKTAG('8','S','V','X')
40 #define ID_16SV MKTAG('1','6','S','V')
41 #define ID_MAUD MKTAG('M','A','U','D')
42 #define ID_MHDR MKTAG('M','H','D','R')
43 #define ID_MDAT MKTAG('M','D','A','T')
44 #define ID_VHDR MKTAG('V','H','D','R')
45 #define ID_ATAK MKTAG('A','T','A','K')
46 #define ID_RLSE MKTAG('R','L','S','E')
47 #define ID_CHAN MKTAG('C','H','A','N')
48 #define ID_PBM MKTAG('P','B','M',' ')
49 #define ID_ILBM MKTAG('I','L','B','M')
50 #define ID_BMHD MKTAG('B','M','H','D')
51 #define ID_DGBL MKTAG('D','G','B','L')
52 #define ID_CAMG MKTAG('C','A','M','G')
53 #define ID_CMAP MKTAG('C','M','A','P')
54 #define ID_ACBM MKTAG('A','C','B','M')
55 #define ID_DEEP MKTAG('D','E','E','P')
56 #define ID_RGB8 MKTAG('R','G','B','8')
57 #define ID_RGBN MKTAG('R','G','B','N')
58 
59 #define ID_FORM MKTAG('F','O','R','M')
60 #define ID_ANNO MKTAG('A','N','N','O')
61 #define ID_AUTH MKTAG('A','U','T','H')
62 #define ID_CHRS MKTAG('C','H','R','S')
63 #define ID_COPYRIGHT MKTAG('(','c',')',' ')
64 #define ID_CSET MKTAG('C','S','E','T')
65 #define ID_FVER MKTAG('F','V','E','R')
66 #define ID_NAME MKTAG('N','A','M','E')
67 #define ID_TEXT MKTAG('T','E','X','T')
68 #define ID_ABIT MKTAG('A','B','I','T')
69 #define ID_BODY MKTAG('B','O','D','Y')
70 #define ID_DBOD MKTAG('D','B','O','D')
71 #define ID_DPEL MKTAG('D','P','E','L')
72 #define ID_DLOC MKTAG('D','L','O','C')
73 #define ID_TVDC MKTAG('T','V','D','C')
74 
75 #define LEFT 2
76 #define RIGHT 4
77 #define STEREO 6
78 
79 /**
80  * This number of bytes if added at the beginning of each AVPacket
81  * which contain additional information about video properties
82  * which has to be shared between demuxer and decoder.
83  * This number may change between frames, e.g. the demuxer might
84  * set it to smallest possible size of 2 to indicate that there's
85  * no extradata changing in this frame.
86  */
87 #define IFF_EXTRA_VIDEO_SIZE 41
88 
89 typedef enum {
90  COMP_NONE,
91  COMP_FIB,
92  COMP_EXP
93 } svx8_compression_type;
94 
95 typedef struct {
96  int64_t body_pos;
97  int64_t body_end;
98  uint32_t body_size;
99  svx8_compression_type svx8_compression;
100  unsigned maud_bits;
101  unsigned maud_compression;
102  unsigned bitmap_compression; ///< delta compression method used
103  unsigned bpp; ///< bits per plane to decode (differs from bits_per_coded_sample if HAM)
104  unsigned ham; ///< 0 if non-HAM or number of hold bits (6 for bpp > 6, 4 otherwise)
105  unsigned flags; ///< 1 for EHB, 0 is no extra half darkening
106  unsigned transparency; ///< transparency color index in palette
107  unsigned masking; ///< masking method used
108  uint8_t tvdc[32]; ///< TVDC lookup table
109 } IffDemuxContext;
110 
111 /* Metadata string read */
112 static int get_metadata(AVFormatContext *s,
113  const char *const tag,
114  const unsigned data_size)
115 {
116  uint8_t *buf = ((data_size + 1) == 0) ? NULL : av_malloc(data_size + 1);
117 
118  if (!buf)
119  return AVERROR(ENOMEM);
120 
121  if (avio_read(s->pb, buf, data_size) < 0) {
122  av_free(buf);
123  return AVERROR(EIO);
124  }
125  buf[data_size] = 0;
126  av_dict_set(&s->metadata, tag, buf, AV_DICT_DONT_STRDUP_VAL);
127  return 0;
128 }
129 
130 static int iff_probe(AVProbeData *p)
131 {
132  const uint8_t *d = p->buf;
133 
134  if ( AV_RL32(d) == ID_FORM &&
135  (AV_RL32(d+8) == ID_8SVX ||
136  AV_RL32(d+8) == ID_16SV ||
137  AV_RL32(d+8) == ID_MAUD ||
138  AV_RL32(d+8) == ID_PBM ||
139  AV_RL32(d+8) == ID_ACBM ||
140  AV_RL32(d+8) == ID_DEEP ||
141  AV_RL32(d+8) == ID_ILBM ||
142  AV_RL32(d+8) == ID_RGB8 ||
143  AV_RL32(d+8) == ID_RGBN) )
144  return AVPROBE_SCORE_MAX;
145  return 0;
146 }
147 
148 static const uint8_t deep_rgb24[] = {0, 0, 0, 3, 0, 1, 0, 8, 0, 2, 0, 8, 0, 3, 0, 8};
149 static const uint8_t deep_rgba[] = {0, 0, 0, 4, 0, 1, 0, 8, 0, 2, 0, 8, 0, 3, 0, 8};
150 static const uint8_t deep_bgra[] = {0, 0, 0, 4, 0, 3, 0, 8, 0, 2, 0, 8, 0, 1, 0, 8};
151 static const uint8_t deep_argb[] = {0, 0, 0, 4, 0,17, 0, 8, 0, 1, 0, 8, 0, 2, 0, 8};
152 static const uint8_t deep_abgr[] = {0, 0, 0, 4, 0,17, 0, 8, 0, 3, 0, 8, 0, 2, 0, 8};
153 
154 static int iff_read_header(AVFormatContext *s)
155 {
156  IffDemuxContext *iff = s->priv_data;
157  AVIOContext *pb = s->pb;
158  AVStream *st;
159  uint8_t *buf;
160  uint32_t chunk_id, data_size;
161  uint32_t screenmode = 0, num, den;
162  unsigned transparency = 0;
163  unsigned masking = 0; // no mask
164  uint8_t fmt[16];
165  int fmt_size;
166 
167  st = avformat_new_stream(s, NULL);
168  if (!st)
169  return AVERROR(ENOMEM);
170 
171  st->codec->channels = 1;
172  st->codec->channel_layout = AV_CH_LAYOUT_MONO;
173  avio_skip(pb, 8);
174  // codec_tag used by ByteRun1 decoder to distinguish progressive (PBM) and interlaced (ILBM) content
175  st->codec->codec_tag = avio_rl32(pb);
176  iff->bitmap_compression = -1;
177  iff->svx8_compression = -1;
178  iff->maud_bits = -1;
179  iff->maud_compression = -1;
180 
181  while(!url_feof(pb)) {
182  uint64_t orig_pos;
183  int res;
184  const char *metadata_tag = NULL;
185  chunk_id = avio_rl32(pb);
186  data_size = avio_rb32(pb);
187  orig_pos = avio_tell(pb);
188 
189  switch(chunk_id) {
190  case ID_VHDR:
191  st->codec->codec_type = AVMEDIA_TYPE_AUDIO;
192 
193  if (data_size < 14)
194  return AVERROR_INVALIDDATA;
195  avio_skip(pb, 12);
196  st->codec->sample_rate = avio_rb16(pb);
197  if (data_size >= 16) {
198  avio_skip(pb, 1);
199  iff->svx8_compression = avio_r8(pb);
200  }
201  break;
202 
203  case ID_MHDR:
204  st->codec->codec_type = AVMEDIA_TYPE_AUDIO;
205 
206  if (data_size < 32)
207  return AVERROR_INVALIDDATA;
208  avio_skip(pb, 4);
209  iff->maud_bits = avio_rb16(pb);
210  avio_skip(pb, 2);
211  num = avio_rb32(pb);
212  den = avio_rb16(pb);
213  if (!den)
214  return AVERROR_INVALIDDATA;
215  avio_skip(pb, 2);
216  st->codec->sample_rate = num / den;
217  st->codec->channels = avio_rb16(pb);
218  iff->maud_compression = avio_rb16(pb);
219  if (st->codec->channels == 1)
220  st->codec->channel_layout = AV_CH_LAYOUT_MONO;
221  else if (st->codec->channels == 2)
222  st->codec->channel_layout = AV_CH_LAYOUT_STEREO;
223  break;
224 
225  case ID_ABIT:
226  case ID_BODY:
227  case ID_DBOD:
228  case ID_MDAT:
229  iff->body_pos = avio_tell(pb);
230  iff->body_end = iff->body_pos + data_size;
231  iff->body_size = data_size;
232  break;
233 
234  case ID_CHAN:
235  if (data_size < 4)
236  return AVERROR_INVALIDDATA;
237  if (avio_rb32(pb) < 6) {
238  st->codec->channels = 1;
239  st->codec->channel_layout = AV_CH_LAYOUT_MONO;
240  } else {
241  st->codec->channels = 2;
242  st->codec->channel_layout = AV_CH_LAYOUT_STEREO;
243  }
244  break;
245 
246  case ID_CAMG:
247  if (data_size < 4)
248  return AVERROR_INVALIDDATA;
249  screenmode = avio_rb32(pb);
250  break;
251 
252  case ID_CMAP:
253  if (data_size > INT_MAX - IFF_EXTRA_VIDEO_SIZE - FF_INPUT_BUFFER_PADDING_SIZE)
254  return AVERROR_INVALIDDATA;
255  st->codec->extradata_size = data_size + IFF_EXTRA_VIDEO_SIZE;
256  st->codec->extradata = av_malloc(data_size + IFF_EXTRA_VIDEO_SIZE + FF_INPUT_BUFFER_PADDING_SIZE);
257  if (!st->codec->extradata)
258  return AVERROR(ENOMEM);
259  if (avio_read(pb, st->codec->extradata + IFF_EXTRA_VIDEO_SIZE, data_size) < 0)
260  return AVERROR(EIO);
261  break;
262 
263  case ID_BMHD:
264  st->codec->codec_type = AVMEDIA_TYPE_VIDEO;
265  if (data_size <= 8)
266  return AVERROR_INVALIDDATA;
267  st->codec->width = avio_rb16(pb);
268  st->codec->height = avio_rb16(pb);
269  avio_skip(pb, 4); // x, y offset
270  st->codec->bits_per_coded_sample = avio_r8(pb);
271  if (data_size >= 10)
272  masking = avio_r8(pb);
273  if (data_size >= 11)
274  iff->bitmap_compression = avio_r8(pb);
275  if (data_size >= 14) {
276  avio_skip(pb, 1); // padding
277  transparency = avio_rb16(pb);
278  }
279  if (data_size >= 16) {
280  st->sample_aspect_ratio.num = avio_r8(pb);
281  st->sample_aspect_ratio.den = avio_r8(pb);
282  }
283  break;
284 
285  case ID_DPEL:
286  if (data_size < 4 || (data_size & 3))
287  return AVERROR_INVALIDDATA;
288  if ((fmt_size = avio_read(pb, fmt, sizeof(fmt))) < 0)
289  return fmt_size;
290  if (fmt_size == sizeof(deep_rgb24) && !memcmp(fmt, deep_rgb24, sizeof(deep_rgb24)))
291  st->codec->pix_fmt = AV_PIX_FMT_RGB24;
292  else if (fmt_size == sizeof(deep_rgba) && !memcmp(fmt, deep_rgba, sizeof(deep_rgba)))
293  st->codec->pix_fmt = AV_PIX_FMT_RGBA;
294  else if (fmt_size == sizeof(deep_bgra) && !memcmp(fmt, deep_bgra, sizeof(deep_bgra)))
295  st->codec->pix_fmt = AV_PIX_FMT_BGRA;
296  else if (fmt_size == sizeof(deep_argb) && !memcmp(fmt, deep_argb, sizeof(deep_argb)))
297  st->codec->pix_fmt = AV_PIX_FMT_ARGB;
298  else if (fmt_size == sizeof(deep_abgr) && !memcmp(fmt, deep_abgr, sizeof(deep_abgr)))
299  st->codec->pix_fmt = AV_PIX_FMT_ABGR;
300  else {
301  av_log_ask_for_sample(s, "unsupported color format\n");
302  return AVERROR_PATCHWELCOME;
303  }
304  break;
305 
306  case ID_DGBL:
307  st->codec->codec_type = AVMEDIA_TYPE_VIDEO;
308  if (data_size < 8)
309  return AVERROR_INVALIDDATA;
310  st->codec->width = avio_rb16(pb);
311  st->codec->height = avio_rb16(pb);
312  iff->bitmap_compression = avio_rb16(pb);
313  st->sample_aspect_ratio.num = avio_r8(pb);
314  st->sample_aspect_ratio.den = avio_r8(pb);
315  st->codec->bits_per_coded_sample = 24;
316  break;
317 
318  case ID_DLOC:
319  if (data_size < 4)
320  return AVERROR_INVALIDDATA;
321  st->codec->width = avio_rb16(pb);
322  st->codec->height = avio_rb16(pb);
323  break;
324 
325  case ID_TVDC:
326  if (data_size < sizeof(iff->tvdc))
327  return AVERROR_INVALIDDATA;
328  res = avio_read(pb, iff->tvdc, sizeof(iff->tvdc));
329  if (res < 0)
330  return res;
331  break;
332 
333  case ID_ANNO:
334  case ID_TEXT: metadata_tag = "comment"; break;
335  case ID_AUTH: metadata_tag = "artist"; break;
336  case ID_COPYRIGHT: metadata_tag = "copyright"; break;
337  case ID_NAME: metadata_tag = "title"; break;
338  }
339 
340  if (metadata_tag) {
341  if ((res = get_metadata(s, metadata_tag, data_size)) < 0) {
342  av_log(s, AV_LOG_ERROR, "cannot allocate metadata tag %s!\n", metadata_tag);
343  return res;
344  }
345  }
346  avio_skip(pb, data_size - (avio_tell(pb) - orig_pos) + (data_size & 1));
347  }
348 
349  avio_seek(pb, iff->body_pos, SEEK_SET);
350 
351  switch(st->codec->codec_type) {
352  case AVMEDIA_TYPE_AUDIO:
353  avpriv_set_pts_info(st, 32, 1, st->codec->sample_rate);
354 
355  if (st->codec->codec_tag == ID_16SV)
356  st->codec->codec_id = AV_CODEC_ID_PCM_S16BE_PLANAR;
357  else if (st->codec->codec_tag == ID_MAUD) {
358  if (iff->maud_bits == 8 && !iff->maud_compression) {
359  st->codec->codec_id = AV_CODEC_ID_PCM_U8;
360  } else if (iff->maud_bits == 16 && !iff->maud_compression) {
361  st->codec->codec_id = AV_CODEC_ID_PCM_S16BE;
362  } else if (iff->maud_bits == 8 && iff->maud_compression == 2) {
363  st->codec->codec_id = AV_CODEC_ID_PCM_ALAW;
364  } else if (iff->maud_bits == 8 && iff->maud_compression == 3) {
365  st->codec->codec_id = AV_CODEC_ID_PCM_MULAW;
366  } else {
367  av_log_ask_for_sample(s, "unsupported compression %d and bit depth %d\n", iff->maud_compression, iff->maud_bits);
368  return AVERROR_PATCHWELCOME;
369  }
370 
371  st->codec->bits_per_coded_sample =
372  av_get_bits_per_sample(st->codec->codec_id);
373 
374  st->codec->block_align =
375  st->codec->bits_per_coded_sample * st->codec->channels / 8;
376  } else {
377  switch (iff->svx8_compression) {
378  case COMP_NONE:
379  st->codec->codec_id = AV_CODEC_ID_PCM_S8_PLANAR;
380  break;
381  case COMP_FIB:
382  st->codec->codec_id = AV_CODEC_ID_8SVX_FIB;
383  break;
384  case COMP_EXP:
385  st->codec->codec_id = AV_CODEC_ID_8SVX_EXP;
386  break;
387  default:
388  av_log(s, AV_LOG_ERROR,
389  "Unknown SVX8 compression method '%d'\n", iff->svx8_compression);
390  return -1;
391  }
392  }
393 
394  st->codec->bits_per_coded_sample = av_get_bits_per_sample(st->codec->codec_id);
395  st->codec->bit_rate = st->codec->channels * st->codec->sample_rate * st->codec->bits_per_coded_sample;
396  st->codec->block_align = st->codec->channels * st->codec->bits_per_coded_sample;
397  break;
398 
399  case AVMEDIA_TYPE_VIDEO:
400  iff->bpp = st->codec->bits_per_coded_sample;
401  if ((screenmode & 0x800 /* Hold And Modify */) && iff->bpp <= 8) {
402  iff->ham = iff->bpp > 6 ? 6 : 4;
403  st->codec->bits_per_coded_sample = 24;
404  }
405  iff->flags = (screenmode & 0x80 /* Extra HalfBrite */) && iff->bpp <= 8;
406  iff->masking = masking;
407  iff->transparency = transparency;
408 
409  if (!st->codec->extradata) {
410  st->codec->extradata_size = IFF_EXTRA_VIDEO_SIZE;
411  st->codec->extradata = av_malloc(IFF_EXTRA_VIDEO_SIZE + FF_INPUT_BUFFER_PADDING_SIZE);
412  if (!st->codec->extradata)
413  return AVERROR(ENOMEM);
414  }
415  av_assert0(st->codec->extradata_size >= IFF_EXTRA_VIDEO_SIZE);
416  buf = st->codec->extradata;
417  bytestream_put_be16(&buf, IFF_EXTRA_VIDEO_SIZE);
418  bytestream_put_byte(&buf, iff->bitmap_compression);
419  bytestream_put_byte(&buf, iff->bpp);
420  bytestream_put_byte(&buf, iff->ham);
421  bytestream_put_byte(&buf, iff->flags);
422  bytestream_put_be16(&buf, iff->transparency);
423  bytestream_put_byte(&buf, iff->masking);
424  bytestream_put_buffer(&buf, iff->tvdc, sizeof(iff->tvdc));
425  st->codec->codec_id = AV_CODEC_ID_IFF_ILBM;
426  break;
427  default:
428  return -1;
429  }
430 
431  return 0;
432 }
433 
434 static int iff_read_packet(AVFormatContext *s,
435  AVPacket *pkt)
436 {
437  IffDemuxContext *iff = s->priv_data;
438  AVIOContext *pb = s->pb;
439  AVStream *st = s->streams[0];
440  int ret;
441  int64_t pos = avio_tell(pb);
442 
443  if (pos >= iff->body_end)
444  return AVERROR_EOF;
445 
446  if (st->codec->codec_type == AVMEDIA_TYPE_AUDIO) {
447  if (st->codec->codec_tag == ID_MAUD) {
448  ret = av_get_packet(pb, pkt, FFMIN(iff->body_end - pos, 1024 * st->codec->block_align));
449  } else {
450  ret = av_get_packet(pb, pkt, iff->body_size);
451  }
452  } else if (st->codec->codec_type == AVMEDIA_TYPE_VIDEO) {
453  uint8_t *buf;
454 
455  if (av_new_packet(pkt, iff->body_size + 2) < 0) {
456  return AVERROR(ENOMEM);
457  }
458 
459  buf = pkt->data;
460  bytestream_put_be16(&buf, 2);
461  ret = avio_read(pb, buf, iff->body_size);
462  } else {
463  av_assert0(0);
464  }
465 
466  if (pos == iff->body_pos)
467  pkt->flags |= AV_PKT_FLAG_KEY;
468  if (ret < 0)
469  return ret;
470  pkt->stream_index = 0;
471  return ret;
472 }
473 
474 AVInputFormat ff_iff_demuxer = {
475  .name = "iff",
476  .long_name = NULL_IF_CONFIG_SMALL("IFF (Interchange File Format)"),
477  .priv_data_size = sizeof(IffDemuxContext),
478  .read_probe = iff_probe,
479  .read_header = iff_read_header,
480  .read_packet = iff_read_packet,
481  .flags = AVFMT_GENERIC_INDEX,
482 };
Generated on Sat May 25 2013 04:01:05 for FFmpeg by   doxygen 1.8.2