FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
bintext.c
Go to the documentation of this file.
1 /*
2  * Binary text demuxer
3  * eXtended BINary text (XBIN) demuxer
4  * Artworx Data Format demuxer
5  * iCEDraw File demuxer
6  * Copyright (c) 2010 Peter Ross <pross@xvid.org>
7  *
8  * This file is part of FFmpeg.
9  *
10  * FFmpeg is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU Lesser General Public
12  * License as published by the Free Software Foundation; either
13  * version 2.1 of the License, or (at your option) any later version.
14  *
15  * FFmpeg is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18  * Lesser General Public License for more details.
19  *
20  * You should have received a copy of the GNU Lesser General Public
21  * License along with FFmpeg; if not, write to the Free Software
22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23  */
24 
25 /**
26  * @file
27  * Binary text demuxer
28  * eXtended BINary text (XBIN) demuxer
29  * Artworx Data Format demuxer
30  * iCEDraw File demuxer
31  */
32 
33 #include "libavutil/intreadwrite.h"
34 #include "libavutil/opt.h"
35 #include "libavutil/parseutils.h"
36 #include "avformat.h"
37 #include "internal.h"
38 #include "sauce.h"
39 #include "libavcodec/bintext.h"
40 
41 typedef struct {
42  const AVClass *class;
43  int chars_per_frame; /**< characters to send decoder per frame;
44  set by private options as characters per second, and then
45  converted to characters per frame at runtime */
46  int width, height; /**< video size (WxH pixels) (private option) */
47  AVRational framerate; /**< frames per second (private option) */
48  uint64_t fsize; /**< file size less metadata buffer */
50 
52 {
53  BinDemuxContext *bin = s->priv_data;
55  if (!st)
56  return NULL;
57  st->codecpar->codec_tag = 0;
59 
60  if (!bin->width) {
61  st->codecpar->width = (80<<3);
62  st->codecpar->height = (25<<4);
63  }
64 
65  avpriv_set_pts_info(st, 60, bin->framerate.den, bin->framerate.num);
66 
67  /* simulate tty display speed */
68  bin->chars_per_frame = av_clip(av_q2d(st->time_base) * bin->chars_per_frame, 1, INT_MAX);
69 
70  return st;
71 }
72 
73 #if CONFIG_BINTEXT_DEMUXER | CONFIG_ADF_DEMUXER | CONFIG_IDF_DEMUXER
74 /**
75  * Given filesize and width, calculate height (assume font_height of 16)
76  */
77 static void calculate_height(AVCodecParameters *par, uint64_t fsize)
78 {
79  par->height = (fsize / ((par->width>>3)*2)) << 4;
80 }
81 #endif
82 
83 #if CONFIG_BINTEXT_DEMUXER
84 static const uint8_t next_magic[]={
85  0x1A, 0x1B, '[', '0', ';', '3', '0', ';', '4', '0', 'm', 'N', 'E', 'X', 'T', 0x00
86 };
87 
88 static int next_tag_read(AVFormatContext *avctx, uint64_t *fsize)
89 {
90  AVIOContext *pb = avctx->pb;
91  char buf[36];
92  int len;
93  uint64_t start_pos = avio_size(pb) - 256;
94 
95  avio_seek(pb, start_pos, SEEK_SET);
96  if (avio_read(pb, buf, sizeof(next_magic)) != sizeof(next_magic))
97  return -1;
98  if (memcmp(buf, next_magic, sizeof(next_magic)))
99  return -1;
100  if (avio_r8(pb) != 0x01)
101  return -1;
102 
103  *fsize -= 256;
104 
105 #define GET_EFI2_META(name,size) \
106  len = avio_r8(pb); \
107  if (len < 1 || len > size) \
108  return -1; \
109  if (avio_read(pb, buf, size) == size && *buf) { \
110  buf[len] = 0; \
111  av_dict_set(&avctx->metadata, name, buf, 0); \
112  }
113 
114  GET_EFI2_META("filename", 12)
115  GET_EFI2_META("author", 20)
116  GET_EFI2_META("publisher", 20)
117  GET_EFI2_META("title", 35)
118 
119  return 0;
120 }
121 
122 static void predict_width(AVCodecParameters *par, uint64_t fsize, int got_width)
123 {
124  /** attempt to guess width */
125  if (!got_width)
126  par->width = fsize > 4000 ? (160<<3) : (80<<3);
127 }
128 
129 static int bin_probe(AVProbeData *p)
130 {
131  const uint8_t *d = p->buf;
132  int magic = 0, sauce = 0;
133  int invisible = 0;
134  int i;
135 
136  if (p->buf_size > 256)
137  magic = !memcmp(d + p->buf_size - 256, next_magic, sizeof(next_magic));
138  if (p->buf_size > 128)
139  sauce = !memcmp(d + p->buf_size - 128, "SAUCE00", 7);
140 
141  if (magic)
142  return AVPROBE_SCORE_EXTENSION + 1;
143 
144  if (av_match_ext(p->filename, "bin")) {
145  AVCodecParameters par;
146  int got_width = 0;
147  par.width = par.height = 0;
148  if (sauce)
149  return AVPROBE_SCORE_EXTENSION + 1;
150 
151  predict_width(&par, p->buf_size, got_width);
152  if (par.width <= 0)
153  return 0;
154  calculate_height(&par, p->buf_size);
155  if (par.height <= 0)
156  return 0;
157 
158  for (i = 0; i < p->buf_size - 256; i+=2) {
159  if ((d[i+1] & 15) == (d[i+1] >> 4) && d[i] && d[i] != 0xFF && d[i] != ' ') {
160  invisible ++;
161  }
162  }
163 
164  if (par.width * par.height * 2 / (8*16) == p->buf_size)
165  return AVPROBE_SCORE_MAX / 2;
166  return 0;
167  }
168 
169  if (sauce)
170  return 1;
171 
172  return 0;
173 }
174 
175 
176 static int bintext_read_header(AVFormatContext *s)
177 {
178  BinDemuxContext *bin = s->priv_data;
179  AVIOContext *pb = s->pb;
180 
181  AVStream *st = init_stream(s);
182  if (!st)
183  return AVERROR(ENOMEM);
185 
186  if (ff_alloc_extradata(st->codecpar, 2))
187  return AVERROR(ENOMEM);
188  st->codecpar->extradata[0] = 16;
189  st->codecpar->extradata[1] = 0;
190 
191  if (pb->seekable & AVIO_SEEKABLE_NORMAL) {
192  int got_width = 0;
193  bin->fsize = avio_size(pb);
194  if (ff_sauce_read(s, &bin->fsize, &got_width, 0) < 0)
195  next_tag_read(s, &bin->fsize);
196  if (!bin->width) {
197  predict_width(st->codecpar, bin->fsize, got_width);
198  calculate_height(st->codecpar, bin->fsize);
199  }
200  avio_seek(pb, 0, SEEK_SET);
201  }
202  return 0;
203 }
204 #endif /* CONFIG_BINTEXT_DEMUXER */
205 
206 #if CONFIG_XBIN_DEMUXER
207 static int xbin_probe(AVProbeData *p)
208 {
209  const uint8_t *d = p->buf;
210 
211  if (AV_RL32(d) == MKTAG('X','B','I','N') && d[4] == 0x1A &&
212  AV_RL16(d+5) > 0 && AV_RL16(d+5) <= 160 &&
213  d[9] > 0 && d[9] <= 32)
214  return AVPROBE_SCORE_MAX;
215  return 0;
216 }
217 
218 static int xbin_read_header(AVFormatContext *s)
219 {
220  BinDemuxContext *bin = s->priv_data;
221  AVIOContext *pb = s->pb;
222  char fontheight, flags;
223 
224  AVStream *st = init_stream(s);
225  if (!st)
226  return AVERROR(ENOMEM);
227 
228  avio_skip(pb, 5);
229  st->codecpar->width = avio_rl16(pb)<<3;
230  st->codecpar->height = avio_rl16(pb);
231  fontheight = avio_r8(pb);
232  st->codecpar->height *= fontheight;
233  flags = avio_r8(pb);
234 
235  st->codecpar->extradata_size = 2;
236  if ((flags & BINTEXT_PALETTE))
237  st->codecpar->extradata_size += 48;
238  if ((flags & BINTEXT_FONT))
239  st->codecpar->extradata_size += fontheight * (flags & 0x10 ? 512 : 256);
241 
243  return AVERROR(ENOMEM);
244  st->codecpar->extradata[0] = fontheight;
245  st->codecpar->extradata[1] = flags;
246  if (avio_read(pb, st->codecpar->extradata + 2, st->codecpar->extradata_size - 2) < 0)
247  return AVERROR(EIO);
248 
249  if (pb->seekable & AVIO_SEEKABLE_NORMAL) {
250  bin->fsize = avio_size(pb) - 9 - st->codecpar->extradata_size;
251  ff_sauce_read(s, &bin->fsize, NULL, 0);
252  avio_seek(pb, 9 + st->codecpar->extradata_size, SEEK_SET);
253  }
254 
255  return 0;
256 }
257 #endif /* CONFIG_XBIN_DEMUXER */
258 
259 #if CONFIG_ADF_DEMUXER
260 static int adf_read_header(AVFormatContext *s)
261 {
262  BinDemuxContext *bin = s->priv_data;
263  AVIOContext *pb = s->pb;
264  AVStream *st;
265 
266  if (avio_r8(pb) != 1)
267  return AVERROR_INVALIDDATA;
268 
269  st = init_stream(s);
270  if (!st)
271  return AVERROR(ENOMEM);
273 
274  if (ff_alloc_extradata(st->codecpar, 2 + 48 + 4096))
275  return AVERROR(ENOMEM);
276  st->codecpar->extradata[0] = 16;
277  st->codecpar->extradata[1] = BINTEXT_PALETTE|BINTEXT_FONT;
278 
279  if (avio_read(pb, st->codecpar->extradata + 2, 24) < 0)
280  return AVERROR(EIO);
281  avio_skip(pb, 144);
282  if (avio_read(pb, st->codecpar->extradata + 2 + 24, 24) < 0)
283  return AVERROR(EIO);
284  if (avio_read(pb, st->codecpar->extradata + 2 + 48, 4096) < 0)
285  return AVERROR(EIO);
286 
287  if (pb->seekable & AVIO_SEEKABLE_NORMAL) {
288  int got_width = 0;
289  bin->fsize = avio_size(pb) - 1 - 192 - 4096;
290  st->codecpar->width = 80<<3;
291  ff_sauce_read(s, &bin->fsize, &got_width, 0);
292  if (!bin->width)
293  calculate_height(st->codecpar, bin->fsize);
294  avio_seek(pb, 1 + 192 + 4096, SEEK_SET);
295  }
296  return 0;
297 }
298 #endif /* CONFIG_ADF_DEMUXER */
299 
300 #if CONFIG_IDF_DEMUXER
301 static const uint8_t idf_magic[] = {
302  0x04, 0x31, 0x2e, 0x34, 0x00, 0x00, 0x00, 0x00, 0x4f, 0x00, 0x15, 0x00
303 };
304 
305 static int idf_probe(AVProbeData *p)
306 {
307  if (p->buf_size < sizeof(idf_magic))
308  return 0;
309  if (!memcmp(p->buf, idf_magic, sizeof(idf_magic)))
310  return AVPROBE_SCORE_MAX;
311  return 0;
312 }
313 
314 static int idf_read_header(AVFormatContext *s)
315 {
316  BinDemuxContext *bin = s->priv_data;
317  AVIOContext *pb = s->pb;
318  AVStream *st;
319  int got_width = 0;
320 
321  if (!(pb->seekable & AVIO_SEEKABLE_NORMAL))
322  return AVERROR(EIO);
323 
324  st = init_stream(s);
325  if (!st)
326  return AVERROR(ENOMEM);
328 
329  if (ff_alloc_extradata(st->codecpar, 2 + 48 + 4096))
330  return AVERROR(ENOMEM);
331  st->codecpar->extradata[0] = 16;
332  st->codecpar->extradata[1] = BINTEXT_PALETTE|BINTEXT_FONT;
333 
334  avio_seek(pb, avio_size(pb) - 4096 - 48, SEEK_SET);
335 
336  if (avio_read(pb, st->codecpar->extradata + 2 + 48, 4096) < 0)
337  return AVERROR(EIO);
338  if (avio_read(pb, st->codecpar->extradata + 2, 48) < 0)
339  return AVERROR(EIO);
340 
341  bin->fsize = avio_size(pb) - 12 - 4096 - 48;
342  ff_sauce_read(s, &bin->fsize, &got_width, 0);
343  if (!bin->width)
344  calculate_height(st->codecpar, bin->fsize);
345  avio_seek(pb, 12, SEEK_SET);
346  return 0;
347 }
348 #endif /* CONFIG_IDF_DEMUXER */
349 
351  AVPacket *pkt)
352 {
353  BinDemuxContext *bin = s->priv_data;
354 
355  if (bin->fsize > 0) {
356  if (av_get_packet(s->pb, pkt, bin->fsize) < 0)
357  return AVERROR(EIO);
358  bin->fsize = -1; /* done */
359  } else if (!bin->fsize) {
360  if (avio_feof(s->pb))
361  return AVERROR(EIO);
362  if (av_get_packet(s->pb, pkt, bin->chars_per_frame) < 0)
363  return AVERROR(EIO);
364  } else {
365  return AVERROR(EIO);
366  }
367 
368  pkt->flags |= AV_PKT_FLAG_KEY;
369  return 0;
370 }
371 
372 #define OFFSET(x) offsetof(BinDemuxContext, x)
373 static const AVOption options[] = {
374  { "linespeed", "set simulated line speed (bytes per second)", OFFSET(chars_per_frame), AV_OPT_TYPE_INT, {.i64 = 6000}, 1, INT_MAX, AV_OPT_FLAG_DECODING_PARAM},
375  { "video_size", "set video size, such as 640x480 or hd720.", OFFSET(width), AV_OPT_TYPE_IMAGE_SIZE, {.str = NULL}, 0, 0, AV_OPT_FLAG_DECODING_PARAM },
376  { "framerate", "set framerate (frames per second)", OFFSET(framerate), AV_OPT_TYPE_VIDEO_RATE, {.str = "25"}, 0, INT_MAX, AV_OPT_FLAG_DECODING_PARAM },
377  { NULL },
378 };
379 
380 #define CLASS(name) \
381 (const AVClass[1]){{ \
382  .class_name = name, \
383  .item_name = av_default_item_name, \
384  .option = options, \
385  .version = LIBAVUTIL_VERSION_INT, \
386 }}
387 
388 #if CONFIG_BINTEXT_DEMUXER
390  .name = "bin",
391  .long_name = NULL_IF_CONFIG_SMALL("Binary text"),
392  .priv_data_size = sizeof(BinDemuxContext),
393  .read_probe = bin_probe,
394  .read_header = bintext_read_header,
396  .priv_class = CLASS("Binary text demuxer"),
397 };
398 #endif
399 
400 #if CONFIG_XBIN_DEMUXER
402  .name = "xbin",
403  .long_name = NULL_IF_CONFIG_SMALL("eXtended BINary text (XBIN)"),
404  .priv_data_size = sizeof(BinDemuxContext),
405  .read_probe = xbin_probe,
406  .read_header = xbin_read_header,
408  .priv_class = CLASS("eXtended BINary text (XBIN) demuxer"),
409 };
410 #endif
411 
412 #if CONFIG_ADF_DEMUXER
414  .name = "adf",
415  .long_name = NULL_IF_CONFIG_SMALL("Artworx Data Format"),
416  .priv_data_size = sizeof(BinDemuxContext),
417  .read_header = adf_read_header,
419  .extensions = "adf",
420  .priv_class = CLASS("Artworx Data Format demuxer"),
421 };
422 #endif
423 
424 #if CONFIG_IDF_DEMUXER
426  .name = "idf",
427  .long_name = NULL_IF_CONFIG_SMALL("iCE Draw File"),
428  .priv_data_size = sizeof(BinDemuxContext),
429  .read_probe = idf_probe,
430  .read_header = idf_read_header,
432  .extensions = "idf",
433  .priv_class = CLASS("iCE Draw File demuxer"),
434 };
435 #endif
Binary text decoder.
#define NULL
Definition: coverity.c:32
#define OFFSET(x)
Definition: bintext.c:372
Bytestream IO Context.
Definition: avio.h:161
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:59
int64_t avio_size(AVIOContext *s)
Get the filesize.
Definition: aviobuf.c:336
AVOption.
Definition: opt.h:246
const char * filename
Definition: avformat.h:449
void avpriv_set_pts_info(AVStream *s, int pts_wrap_bits, unsigned int pts_num, unsigned int pts_den)
Set the time base and wrapping info for a given stream.
Definition: utils.c:4849
enum AVCodecID codec_id
Specific type of the encoded data (the codec used).
Definition: avcodec.h:3885
int num
Numerator.
Definition: rational.h:59
int64_t avio_seek(AVIOContext *s, int64_t offset, int whence)
fseek() equivalent for AVIOContext.
Definition: aviobuf.c:246
int64_t avio_skip(AVIOContext *s, int64_t offset)
Skip given number of bytes forward.
Definition: aviobuf.c:331
static AVPacket pkt
uint64_t_TMPL AV_WL64 unsigned int_TMPL AV_WL32 unsigned int_TMPL AV_WL24 unsigned int_TMPL AV_RL16
Definition: bytestream.h:87
This struct describes the properties of an encoded stream.
Definition: avcodec.h:3877
int chars_per_frame
characters to send decoder per frame; set by private options as characters per second, and then converted to characters per frame at runtime
Definition: bintext.c:43
Format I/O context.
Definition: avformat.h:1351
uint8_t
int width
Video only.
Definition: avcodec.h:3951
AVOptions.
AVStream * avformat_new_stream(AVFormatContext *s, const AVCodec *c)
Add a new stream to a media file.
Definition: utils.c:4456
#define height
static double av_q2d(AVRational a)
Convert an AVRational to a double.
Definition: rational.h:104
static const AVOption options[]
Definition: bintext.c:373
int av_get_packet(AVIOContext *s, AVPacket *pkt, int size)
Allocate and read the payload of a packet and initialize its fields with default values.
Definition: utils.c:310
int av_match_ext(const char *filename, const char *extensions)
Return a positive value if the given filename has one of the given extensions, 0 otherwise.
Definition: format.c:38
#define flags(name, subs,...)
Definition: cbs_h2645.c:263
int avio_read(AVIOContext *s, unsigned char *buf, int size)
Read size bytes from AVIOContext into buf.
Definition: aviobuf.c:648
#define AV_PKT_FLAG_KEY
The packet contains a keyframe.
Definition: avcodec.h:1463
#define BINTEXT_PALETTE
Definition: bintext.h:34
#define AVERROR(e)
Definition: error.h:43
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:186
int ff_sauce_read(AVFormatContext *avctx, uint64_t *fsize, int *got_width, int get_height)
Definition: sauce.c:32
enum AVMediaType codec_type
General type of the encoded data.
Definition: avcodec.h:3881
uint16_t width
Definition: gdv.c:47
int flags
A combination of AV_PKT_FLAG values.
Definition: avcodec.h:1437
int extradata_size
Size of the extradata content in bytes.
Definition: avcodec.h:3903
int avio_r8(AVIOContext *s)
Definition: aviobuf.c:639
return
int buf_size
Size of buf except extra allocated bytes.
Definition: avformat.h:451
unsigned char * buf
Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero.
Definition: avformat.h:450
int seekable
A combination of AVIO_SEEKABLE_ flags or 0 when the stream is not seekable.
Definition: avio.h:260
int ff_alloc_extradata(AVCodecParameters *par, int size)
Allocate extradata with additional AV_INPUT_BUFFER_PADDING_SIZE at end which is always set to 0...
Definition: utils.c:3286
static int read_probe(AVProbeData *pd)
Definition: jvdec.c:55
AVInputFormat ff_adf_demuxer
AVInputFormat ff_bintext_demuxer
#define s(width, name)
Definition: cbs_vp9.c:257
uint64_t fsize
file size less metadata buffer
Definition: bintext.c:48
static int read_header(FFV1Context *f)
Definition: ffv1dec.c:530
Stream structure.
Definition: avformat.h:874
#define AVIO_SEEKABLE_NORMAL
Seeking works like for a local file.
Definition: avio.h:40
AVInputFormat ff_xbin_demuxer
AVRational framerate
frames per second (private option)
Definition: bintext.c:47
AVIOContext * pb
I/O context.
Definition: avformat.h:1393
AVInputFormat ff_idf_demuxer
void * buf
Definition: avisynth_c.h:690
Describe the class of an AVClass context structure.
Definition: log.h:67
Rational number (pair of numerator and denominator).
Definition: rational.h:58
#define AV_OPT_FLAG_DECODING_PARAM
a generic parameter which can be set by the user for demuxing or decoding
Definition: opt.h:277
offset must point to AVRational
Definition: opt.h:236
#define AVPROBE_SCORE_EXTENSION
score for file extension
Definition: avformat.h:458
static int read_packet(AVFormatContext *s, AVPacket *pkt)
Definition: bintext.c:350
offset must point to two consecutive integers
Definition: opt.h:233
This structure contains the data a format has to probe a file.
Definition: avformat.h:448
misc parsing utilities
SAUCE header parser.
static AVStream * init_stream(AVFormatContext *s)
Definition: bintext.c:51
#define AVPROBE_SCORE_MAX
maximum score
Definition: avformat.h:460
unsigned int avio_rl16(AVIOContext *s)
Definition: aviobuf.c:754
Main libavformat public API header.
int den
Denominator.
Definition: rational.h:60
int len
void * priv_data
Format private data.
Definition: avformat.h:1379
#define CLASS(name)
Definition: bintext.c:380
uint8_t * extradata
Extra binary data needed for initializing the decoder, codec-dependent.
Definition: avcodec.h:3899
const char * name
A comma separated list of short names for the format.
Definition: avformat.h:647
AVCodecParameters * codecpar
Codec parameters associated with this stream.
Definition: avformat.h:1021
int avio_feof(AVIOContext *s)
feof() equivalent for AVIOContext.
Definition: aviobuf.c:358
uint32_t codec_tag
Additional information about the codec (corresponds to the AVI FOURCC).
Definition: avcodec.h:3889
static int64_t fsize(FILE *f)
Definition: audiomatch.c:28
AVRational time_base
This is the fundamental unit of time (in seconds) in terms of which frame timestamps are represented...
Definition: avformat.h:903
#define MKTAG(a, b, c, d)
Definition: common.h:366
#define BINTEXT_FONT
Definition: bintext.h:35
uint64_t_TMPL AV_WL64 unsigned int_TMPL AV_RL32
Definition: bytestream.h:87
This structure stores compressed data.
Definition: avcodec.h:1408