libavformat/bintext.c
07a70cab
 /*
  * Binary text demuxer
  * eXtended BINary text (XBIN) demuxer
  * Artworx Data Format demuxer
  * iCEDraw File demuxer
  * Copyright (c) 2010 Peter Ross <pross@xvid.org>
  *
  * This file is part of FFmpeg.
  *
  * FFmpeg is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
  * version 2.1 of the License, or (at your option) any later version.
  *
  * FFmpeg is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
  * License along with FFmpeg; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
 /**
  * @file
  * Binary text demuxer
  * eXtended BINary text (XBIN) demuxer
  * Artworx Data Format demuxer
  * iCEDraw File demuxer
  */
 
 #include "libavutil/intreadwrite.h"
15d838b7
 #include "libavutil/opt.h"
 #include "libavutil/parseutils.h"
07a70cab
 #include "avformat.h"
215b7724
 #include "internal.h"
07a70cab
 #include "sauce.h"
 #include "libavcodec/bintext.h"
 
 typedef struct {
15d838b7
     const AVClass *class;
     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 */
     char *video_size;    /**< video size (WxH pixels) (private option) */
     char *framerate;     /**< frames per second (private option) */
07a70cab
     uint64_t fsize;  /**< file size less metadata buffer */
 } BinDemuxContext;
 
169dae81
 static AVStream * init_stream(AVFormatContext *s)
 {
     BinDemuxContext *bin = s->priv_data;
     AVStream *st = avformat_new_stream(s, NULL);
     if (!st)
         return NULL;
     st->codec->codec_tag   = 0;
     st->codec->codec_type  = AVMEDIA_TYPE_VIDEO;
 
     if (bin->video_size) {
         if (av_parse_video_size(&st->codec->width, &st->codec->height, bin->video_size) < 0) {
             av_log(s, AV_LOG_ERROR, "Could not parse video size: '%s'\n", bin->video_size);
             return NULL;
         }
     } else {
         st->codec->width  = (80<<3);
         st->codec->height = (25<<4);
     }
 
     if (bin->framerate) {
         AVRational framerate;
         if (av_parse_video_rate(&framerate, bin->framerate) < 0) {
             av_log(s, AV_LOG_ERROR, "Could not parse framerate: '%s'\n", bin->framerate);
             return NULL;
         }
         avpriv_set_pts_info(st, 60, framerate.den, framerate.num);
     } else {
         avpriv_set_pts_info(st, 60, 1, 25);
     }
 
     /* simulate tty display speed */
     bin->chars_per_frame = FFMAX(av_q2d(st->time_base) * bin->chars_per_frame, 1);
 
     return st;
 }
 
07a70cab
 #if CONFIG_BINTEXT_DEMUXER | CONFIG_ADF_DEMUXER | CONFIG_IDF_DEMUXER
 /**
  * Given filesize and width, calculate height (assume font_height of 16)
  */
 static void calculate_height(AVCodecContext *avctx, uint64_t fsize)
 {
     avctx->height = (fsize / ((avctx->width>>3)*2)) << 4;
 }
 #endif
 
 #if CONFIG_BINTEXT_DEMUXER
 static const uint8_t next_magic[]={
     0x1A, 0x1B, '[', '0', ';', '3', '0', ';', '4', '0', 'm', 'N', 'E', 'X', 'T', 0x00
 };
 
 static int next_tag_read(AVFormatContext *avctx, uint64_t *fsize)
 {
eef3ea8c
     AVIOContext *pb = avctx->pb;
07a70cab
     char buf[36];
     int len;
f3c47e41
     uint64_t start_pos = avio_size(pb) - 256;
07a70cab
 
39edfcc9
     avio_seek(pb, start_pos, SEEK_SET);
53d70a33
     if (avio_read(pb, buf, sizeof(next_magic)) != sizeof(next_magic))
07a70cab
         return -1;
     if (memcmp(buf, next_magic, sizeof(next_magic)))
         return -1;
055cda8a
     if (avio_r8(pb) != 0x01)
07a70cab
         return -1;
 
     *fsize -= 256;
 
 #define GET_EFI2_META(name,size) \
055cda8a
     len = avio_r8(pb); \
07a70cab
     if (len < 1 || len > size) \
         return -1; \
53d70a33
     if (avio_read(pb, buf, size) == size && *buf) { \
07a70cab
         buf[len] = 0; \
b04ee900
         av_dict_set(&avctx->metadata, name, buf, 0); \
07a70cab
     }
 
     GET_EFI2_META("filename",  12)
     GET_EFI2_META("author",    20)
     GET_EFI2_META("publisher", 20)
     GET_EFI2_META("title",     35)
 
     return 0;
 }
 
 static void predict_width(AVCodecContext *avctx, uint64_t fsize, int got_width)
 {
     /** attempt to guess width */
     if (!got_width)
         avctx->width = fsize > 4000 ? (160<<3) : (80<<3);
 }
 
e37f161e
 static int bintext_read_header(AVFormatContext *s)
07a70cab
 {
     BinDemuxContext *bin = s->priv_data;
eef3ea8c
     AVIOContext *pb = s->pb;
07a70cab
 
e37f161e
     AVStream *st = init_stream(s);
07a70cab
     if (!st)
         return AVERROR(ENOMEM);
7a72695c
     st->codec->codec_id    = AV_CODEC_ID_BINTEXT;
07a70cab
 
     st->codec->extradata_size = 2;
c61c8536
     st->codec->extradata = av_malloc(st->codec->extradata_size + FF_INPUT_BUFFER_PADDING_SIZE);
07a70cab
     if (!st->codec->extradata)
         return AVERROR(ENOMEM);
     st->codec->extradata[0] = 16;
     st->codec->extradata[1] = 0;
 
49651063
     if (pb->seekable) {
07a70cab
         int got_width = 0;
f3c47e41
         bin->fsize = avio_size(pb);
07a70cab
         if (ff_sauce_read(s, &bin->fsize, &got_width, 0) < 0)
             next_tag_read(s, &bin->fsize);
15d838b7
         if (!bin->video_size) {
07a70cab
             predict_width(st->codec, bin->fsize, got_width);
             calculate_height(st->codec, bin->fsize);
15d838b7
         }
39edfcc9
         avio_seek(pb, 0, SEEK_SET);
07a70cab
     }
     return 0;
e234301c
 }
07a70cab
 #endif /* CONFIG_BINTEXT_DEMUXER */
 
 #if CONFIG_XBIN_DEMUXER
 static int xbin_probe(AVProbeData *p)
 {
     const uint8_t *d = p->buf;
 
     if (AV_RL32(d) == MKTAG('X','B','I','N') && d[4] == 0x1A &&
         AV_RL16(d+5) > 0 && AV_RL16(d+5) <= 160 &&
         d[9] > 0 && d[9] <= 32)
         return AVPROBE_SCORE_MAX;
     return 0;
 }
 
e37f161e
 static int xbin_read_header(AVFormatContext *s)
07a70cab
 {
     BinDemuxContext *bin = s->priv_data;
eef3ea8c
     AVIOContext *pb = s->pb;
07a70cab
     char fontheight, flags;
 
e37f161e
     AVStream *st = init_stream(s);
07a70cab
     if (!st)
         return AVERROR(ENOMEM);
 
7b79305a
     avio_skip(pb, 5);
c142e2a0
     st->codec->width   = avio_rl16(pb)<<3;
     st->codec->height  = avio_rl16(pb);
055cda8a
     fontheight         = avio_r8(pb);
07a70cab
     st->codec->height *= fontheight;
055cda8a
     flags              = avio_r8(pb);
07a70cab
 
     st->codec->extradata_size = 2;
     if ((flags & BINTEXT_PALETTE))
         st->codec->extradata_size += 48;
     if ((flags & BINTEXT_FONT))
         st->codec->extradata_size += fontheight * (flags & 0x10 ? 512 : 256);
7a72695c
     st->codec->codec_id    = flags & 4 ? AV_CODEC_ID_XBIN : AV_CODEC_ID_BINTEXT;
07a70cab
 
c61c8536
     st->codec->extradata = av_malloc(st->codec->extradata_size + FF_INPUT_BUFFER_PADDING_SIZE);
07a70cab
     if (!st->codec->extradata)
         return AVERROR(ENOMEM);
     st->codec->extradata[0] = fontheight;
     st->codec->extradata[1] = flags;
53d70a33
     if (avio_read(pb, st->codec->extradata + 2, st->codec->extradata_size - 2) < 0)
07a70cab
         return AVERROR(EIO);
 
49651063
     if (pb->seekable) {
f3c47e41
         bin->fsize = avio_size(pb) - 9 - st->codec->extradata_size;
07a70cab
         ff_sauce_read(s, &bin->fsize, NULL, 0);
39edfcc9
         avio_seek(pb, 9 + st->codec->extradata_size, SEEK_SET);
07a70cab
     }
 
     return 0;
 }
 #endif /* CONFIG_XBIN_DEMUXER */
 
 #if CONFIG_ADF_DEMUXER
e37f161e
 static int adf_read_header(AVFormatContext *s)
07a70cab
 {
     BinDemuxContext *bin = s->priv_data;
eef3ea8c
     AVIOContext *pb = s->pb;
07a70cab
     AVStream *st;
 
055cda8a
     if (avio_r8(pb) != 1)
07a70cab
         return AVERROR_INVALIDDATA;
 
e37f161e
     st = init_stream(s);
07a70cab
     if (!st)
         return AVERROR(ENOMEM);
7a72695c
     st->codec->codec_id    = AV_CODEC_ID_BINTEXT;
07a70cab
 
     st->codec->extradata_size = 2 + 48 + 4096;
c61c8536
     st->codec->extradata = av_malloc(st->codec->extradata_size + FF_INPUT_BUFFER_PADDING_SIZE);
07a70cab
     if (!st->codec->extradata)
         return AVERROR(ENOMEM);
     st->codec->extradata[0] = 16;
     st->codec->extradata[1] = BINTEXT_PALETTE|BINTEXT_FONT;
 
53d70a33
     if (avio_read(pb, st->codec->extradata + 2, 24) < 0)
07a70cab
         return AVERROR(EIO);
7b79305a
     avio_skip(pb, 144);
53d70a33
     if (avio_read(pb, st->codec->extradata + 2 + 24, 24) < 0)
07a70cab
         return AVERROR(EIO);
53d70a33
     if (avio_read(pb, st->codec->extradata + 2 + 48, 4096) < 0)
07a70cab
         return AVERROR(EIO);
 
49651063
     if (pb->seekable) {
07a70cab
         int got_width = 0;
f3c47e41
         bin->fsize = avio_size(pb) - 1 - 192 - 4096;
07a70cab
         st->codec->width = 80<<3;
         ff_sauce_read(s, &bin->fsize, &got_width, 0);
15d838b7
         if (!bin->video_size)
07a70cab
             calculate_height(st->codec, bin->fsize);
39edfcc9
         avio_seek(pb, 1 + 192 + 4096, SEEK_SET);
07a70cab
     }
     return 0;
 }
 #endif /* CONFIG_ADF_DEMUXER */
 
 #if CONFIG_IDF_DEMUXER
 static const uint8_t idf_magic[] = {
     0x04, 0x31, 0x2e, 0x34, 0x00, 0x00, 0x00, 0x00, 0x4f, 0x00, 0x15, 0x00
 };
 
 static int idf_probe(AVProbeData *p)
 {
658c5209
     if (p->buf_size < sizeof(idf_magic))
         return 0;
     if (!memcmp(p->buf, idf_magic, sizeof(idf_magic)))
07a70cab
         return AVPROBE_SCORE_MAX;
     return 0;
 }
 
e37f161e
 static int idf_read_header(AVFormatContext *s)
07a70cab
 {
     BinDemuxContext *bin = s->priv_data;
eef3ea8c
     AVIOContext *pb = s->pb;
07a70cab
     AVStream *st;
     int got_width = 0;
 
49651063
     if (!pb->seekable)
07a70cab
         return AVERROR(EIO);
 
e37f161e
     st = init_stream(s);
07a70cab
     if (!st)
         return AVERROR(ENOMEM);
7a72695c
     st->codec->codec_id    = AV_CODEC_ID_IDF;
07a70cab
 
     st->codec->extradata_size = 2 + 48 + 4096;
c61c8536
     st->codec->extradata = av_malloc(st->codec->extradata_size + FF_INPUT_BUFFER_PADDING_SIZE);
07a70cab
     if (!st->codec->extradata)
         return AVERROR(ENOMEM);
     st->codec->extradata[0] = 16;
     st->codec->extradata[1] = BINTEXT_PALETTE|BINTEXT_FONT;
 
39edfcc9
     avio_seek(pb, avio_size(pb) - 4096 - 48, SEEK_SET);
07a70cab
 
53d70a33
     if (avio_read(pb, st->codec->extradata + 2 + 48, 4096) < 0)
07a70cab
         return AVERROR(EIO);
53d70a33
     if (avio_read(pb, st->codec->extradata + 2, 48) < 0)
07a70cab
         return AVERROR(EIO);
 
f3c47e41
     bin->fsize = avio_size(pb) - 12 - 4096 - 48;
07a70cab
     ff_sauce_read(s, &bin->fsize, &got_width, 0);
15d838b7
     if (!bin->video_size)
07a70cab
         calculate_height(st->codec, bin->fsize);
39edfcc9
     avio_seek(pb, 12, SEEK_SET);
07a70cab
     return 0;
 }
 #endif /* CONFIG_IDF_DEMUXER */
 
 static int read_packet(AVFormatContext *s,
                            AVPacket *pkt)
 {
     BinDemuxContext *bin = s->priv_data;
 
     if (bin->fsize > 0) {
         if (av_get_packet(s->pb, pkt, bin->fsize) < 0)
             return AVERROR(EIO);
         bin->fsize = -1; /* done */
     } else if (!bin->fsize) {
         if (url_feof(s->pb))
             return AVERROR(EIO);
         if (av_get_packet(s->pb, pkt, bin->chars_per_frame) < 0)
             return AVERROR(EIO);
     } else {
         return AVERROR(EIO);
     }
 
     pkt->flags |= AV_PKT_FLAG_KEY;
     return 0;
 }
 
15d838b7
 #define OFFSET(x) offsetof(BinDemuxContext, x)
 static const AVOption options[] = {
d46c1c72
     { "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},
15d838b7
     { "video_size", "set video size, such as 640x480 or hd720.", OFFSET(video_size), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, AV_OPT_FLAG_DECODING_PARAM },
     { "framerate", "set framerate (frames per second)", OFFSET(framerate), AV_OPT_TYPE_STRING, {.str = "25"}, 0, 0, AV_OPT_FLAG_DECODING_PARAM },
     { NULL },
 };
 
 #define CLASS(name) \
 (const AVClass[1]){{ \
     .class_name     = name, \
     .item_name      = av_default_item_name, \
     .option         = options, \
     .version        = LIBAVUTIL_VERSION_INT, \
 }}
 
07a70cab
 #if CONFIG_BINTEXT_DEMUXER
 AVInputFormat ff_bintext_demuxer = {
c894449f
     .name           = "bin",
     .long_name      = NULL_IF_CONFIG_SMALL("Binary text"),
     .priv_data_size = sizeof(BinDemuxContext),
     .read_header    = bintext_read_header,
     .read_packet    = read_packet,
     .extensions     = "bin",
15d838b7
     .priv_class     = CLASS("Binary text demuxer"),
07a70cab
 };
 #endif
 
 #if CONFIG_XBIN_DEMUXER
 AVInputFormat ff_xbin_demuxer = {
c894449f
     .name           = "xbin",
     .long_name      = NULL_IF_CONFIG_SMALL("eXtended BINary text (XBIN)"),
     .priv_data_size = sizeof(BinDemuxContext),
     .read_probe     = xbin_probe,
     .read_header    = xbin_read_header,
     .read_packet    = read_packet,
15d838b7
     .priv_class     = CLASS("eXtended BINary text (XBIN) demuxer"),
07a70cab
 };
 #endif
 
 #if CONFIG_ADF_DEMUXER
 AVInputFormat ff_adf_demuxer = {
c894449f
     .name           = "adf",
     .long_name      = NULL_IF_CONFIG_SMALL("Artworx Data Format"),
     .priv_data_size = sizeof(BinDemuxContext),
     .read_header    = adf_read_header,
     .read_packet    = read_packet,
     .extensions     = "adf",
15d838b7
     .priv_class     = CLASS("Artworx Data Format demuxer"),
07a70cab
 };
 #endif
 
 #if CONFIG_IDF_DEMUXER
 AVInputFormat ff_idf_demuxer = {
c894449f
     .name           = "idf",
     .long_name      = NULL_IF_CONFIG_SMALL("iCE Draw File"),
     .priv_data_size = sizeof(BinDemuxContext),
     .read_probe     = idf_probe,
     .read_header    = idf_read_header,
     .read_packet    = read_packet,
     .extensions     = "idf",
15d838b7
     .priv_class     = CLASS("iCE Draw File demuxer"),
07a70cab
 };
 #endif