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 decoder
3  * eXtended BINary text (XBIN) decoder
4  * iCEDraw File decoder
5  * Copyright (c) 2010 Peter Ross (pross@xvid.org)
6  *
7  * This file is part of FFmpeg.
8  *
9  * FFmpeg is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU Lesser General Public
11  * License as published by the Free Software Foundation; either
12  * version 2.1 of the License, or (at your option) any later version.
13  *
14  * FFmpeg is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17  * Lesser General Public License for more details.
18  *
19  * You should have received a copy of the GNU Lesser General Public
20  * License along with FFmpeg; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22  */
23 
24 /**
25  * @file
26  * Binary text decoder
27  * eXtended BINary text (XBIN) decoder
28  * iCEDraw File decoder
29  */
30 
31 #include "libavutil/intreadwrite.h"
33 #include "avcodec.h"
34 #include "cga_data.h"
35 #include "bintext.h"
36 #include "internal.h"
37 
38 typedef struct XbinContext {
40  int palette[16];
41  int flags;
43  const uint8_t *font;
44  int x, y;
45 } XbinContext;
46 
48 {
49  XbinContext *s = avctx->priv_data;
50  uint8_t *p;
51  int i;
52 
53  avctx->pix_fmt = AV_PIX_FMT_PAL8;
54  p = avctx->extradata;
55  if (p) {
56  s->font_height = p[0];
57  s->flags = p[1];
58  p += 2;
59  if(avctx->extradata_size < 2 + (!!(s->flags & BINTEXT_PALETTE))*3*16
60  + (!!(s->flags & BINTEXT_FONT))*s->font_height*256) {
61  av_log(avctx, AV_LOG_ERROR, "not enough extradata\n");
62  return AVERROR_INVALIDDATA;
63  }
64  } else {
65  s->font_height = 8;
66  s->flags = 0;
67  }
68 
69  if ((s->flags & BINTEXT_PALETTE)) {
70  for (i = 0; i < 16; i++) {
71  s->palette[i] = 0xFF000000 | (AV_RB24(p) << 2) | ((AV_RB24(p) >> 4) & 0x30303);
72  p += 3;
73  }
74  } else {
75  for (i = 0; i < 16; i++)
76  s->palette[i] = 0xFF000000 | ff_cga_palette[i];
77  }
78 
79  if ((s->flags & BINTEXT_FONT)) {
80  s->font = p;
81  } else {
82  switch(s->font_height) {
83  default:
84  av_log(avctx, AV_LOG_WARNING, "font height %i not supported\n", s->font_height);
85  s->font_height = 8;
86  case 8:
87  s->font = avpriv_cga_font;
88  break;
89  case 16:
91  break;
92  }
93  }
94 
95  s->frame = av_frame_alloc();
96  if (!s->frame)
97  return AVERROR(ENOMEM);
98 
99  return 0;
100 }
101 
102 #define DEFAULT_BG_COLOR 0
103 av_unused static void hscroll(AVCodecContext *avctx)
104 {
105  XbinContext *s = avctx->priv_data;
106  if (s->y < avctx->height - s->font_height) {
107  s->y += s->font_height;
108  } else {
109  memmove(s->frame->data[0], s->frame->data[0] + s->font_height*s->frame->linesize[0],
110  (avctx->height - s->font_height)*s->frame->linesize[0]);
111  memset(s->frame->data[0] + (avctx->height - s->font_height)*s->frame->linesize[0],
113  }
114 }
115 
116 #define FONT_WIDTH 8
117 
118 /**
119  * Draw character to screen
120  */
121 static void draw_char(AVCodecContext *avctx, int c, int a)
122 {
123  XbinContext *s = avctx->priv_data;
124  if (s->y > avctx->height - s->font_height)
125  return;
126  ff_draw_pc_font(s->frame->data[0] + s->y * s->frame->linesize[0] + s->x,
127  s->frame->linesize[0], s->font, s->font_height, c,
128  a & 0x0F, a >> 4);
129  s->x += FONT_WIDTH;
130  if (s->x > avctx->width - FONT_WIDTH) {
131  s->x = 0;
132  s->y += s->font_height;
133  }
134 }
135 
136 static int decode_frame(AVCodecContext *avctx,
137  void *data, int *got_frame,
138  AVPacket *avpkt)
139 {
140  XbinContext *s = avctx->priv_data;
141  const uint8_t *buf = avpkt->data;
142  int buf_size = avpkt->size;
143  const uint8_t *buf_end = buf+buf_size;
144  int ret;
145 
146  s->x = s->y = 0;
147  if ((ret = ff_reget_buffer(avctx, s->frame)) < 0)
148  return ret;
150  s->frame->palette_has_changed = 1;
151  memcpy(s->frame->data[1], s->palette, 16 * 4);
152 
153  if (avctx->codec_id == AV_CODEC_ID_XBIN) {
154  while (buf + 2 < buf_end) {
155  int i,c,a;
156  int type = *buf >> 6;
157  int count = (*buf & 0x3F) + 1;
158  buf++;
159  switch (type) {
160  case 0: //no compression
161  for (i = 0; i < count && buf + 1 < buf_end; i++) {
162  draw_char(avctx, buf[0], buf[1]);
163  buf += 2;
164  }
165  break;
166  case 1: //character compression
167  c = *buf++;
168  for (i = 0; i < count && buf < buf_end; i++)
169  draw_char(avctx, c, *buf++);
170  break;
171  case 2: //attribute compression
172  a = *buf++;
173  for (i = 0; i < count && buf < buf_end; i++)
174  draw_char(avctx, *buf++, a);
175  break;
176  case 3: //character/attribute compression
177  c = *buf++;
178  a = *buf++;
179  for (i = 0; i < count && buf < buf_end; i++)
180  draw_char(avctx, c, a);
181  break;
182  }
183  }
184  } else if (avctx->codec_id == AV_CODEC_ID_IDF) {
185  while (buf + 2 < buf_end) {
186  if (AV_RL16(buf) == 1) {
187  int i;
188  if (buf + 6 > buf_end)
189  break;
190  for (i = 0; i < buf[2]; i++)
191  draw_char(avctx, buf[4], buf[5]);
192  buf += 6;
193  } else {
194  draw_char(avctx, buf[0], buf[1]);
195  buf += 2;
196  }
197  }
198  } else {
199  while (buf + 1 < buf_end) {
200  draw_char(avctx, buf[0], buf[1]);
201  buf += 2;
202  }
203  }
204 
205  if ((ret = av_frame_ref(data, s->frame)) < 0)
206  return ret;
207  *got_frame = 1;
208  return buf_size;
209 }
210 
212 {
213  XbinContext *s = avctx->priv_data;
214 
215  av_frame_free(&s->frame);
216 
217  return 0;
218 }
219 
220 #if CONFIG_BINTEXT_DECODER
221 AVCodec ff_bintext_decoder = {
222  .name = "bintext",
223  .long_name = NULL_IF_CONFIG_SMALL("Binary text"),
224  .type = AVMEDIA_TYPE_VIDEO,
225  .id = AV_CODEC_ID_BINTEXT,
226  .priv_data_size = sizeof(XbinContext),
227  .init = decode_init,
228  .close = decode_end,
229  .decode = decode_frame,
230  .capabilities = AV_CODEC_CAP_DR1,
231 };
232 #endif
233 #if CONFIG_XBIN_DECODER
234 AVCodec ff_xbin_decoder = {
235  .name = "xbin",
236  .long_name = NULL_IF_CONFIG_SMALL("eXtended BINary text"),
237  .type = AVMEDIA_TYPE_VIDEO,
238  .id = AV_CODEC_ID_XBIN,
239  .priv_data_size = sizeof(XbinContext),
240  .init = decode_init,
241  .close = decode_end,
242  .decode = decode_frame,
243  .capabilities = AV_CODEC_CAP_DR1,
244 };
245 #endif
246 #if CONFIG_IDF_DECODER
247 AVCodec ff_idf_decoder = {
248  .name = "idf",
249  .long_name = NULL_IF_CONFIG_SMALL("iCEDraw text"),
250  .type = AVMEDIA_TYPE_VIDEO,
251  .id = AV_CODEC_ID_IDF,
252  .priv_data_size = sizeof(XbinContext),
253  .init = decode_init,
254  .close = decode_end,
255  .decode = decode_frame,
256  .capabilities = AV_CODEC_CAP_DR1,
257 };
258 #endif
Binary text decoder.
const char * s
Definition: avisynth_c.h:631
#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:184
const uint8_t * font
Definition: bintext.c:43
ptrdiff_t const GLvoid * data
Definition: opengl_enc.c:101
#define AV_LOG_WARNING
Something somehow does not look correct.
Definition: log.h:182
static av_cold int init(AVCodecContext *avctx)
Definition: avrndec.c:35
int flags
Definition: bintext.c:41
int size
Definition: avcodec.h:1589
enum AVPixelFormat pix_fmt
Pixel format, see AV_PIX_FMT_xxx.
Definition: avcodec.h:1885
const uint8_t avpriv_vga16_font[4096]
static av_unused void hscroll(AVCodecContext *avctx)
Definition: bintext.c:103
AVCodec.
Definition: avcodec.h:3559
uint64_t_TMPL AV_WL64 unsigned int_TMPL AV_WL32 unsigned int_TMPL AV_WL24 unsigned int_TMPL AV_RL16
Definition: bytestream.h:87
static av_cold int decode_init(AVCodecContext *avctx)
Definition: bintext.c:47
uint8_t
#define av_cold
Definition: attributes.h:82
AVFrame * av_frame_alloc(void)
Allocate an AVFrame and set its fields to default values.
Definition: frame.c:140
8 bits with AV_PIX_FMT_RGB32 palette
Definition: pixfmt.h:73
int av_frame_ref(AVFrame *dst, const AVFrame *src)
Set up a new reference to the data described by the source frame.
Definition: frame.c:374
uint8_t * extradata
some codecs need / can use extradata like Huffman tables.
Definition: avcodec.h:1772
uint8_t * data
Definition: avcodec.h:1588
CGA/EGA/VGA ROM data.
static av_cold int decode_end(AVCodecContext *avctx)
Definition: bintext.c:211
#define av_log(a,...)
#define BINTEXT_PALETTE
Definition: bintext.h:34
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:176
const uint8_t avpriv_cga_font[2048]
Definition: xga_font_data.c:29
#define AVERROR(e)
Definition: error.h:43
#define DEFAULT_BG_COLOR
Definition: bintext.c:102
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:153
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:176
const char * name
Name of the codec implementation.
Definition: avcodec.h:3566
GLsizei count
Definition: opengl_enc.c:109
int palette[16]
Definition: bintext.c:40
int ff_reget_buffer(AVCodecContext *avctx, AVFrame *frame)
Identical in function to av_frame_make_writable(), except it uses ff_get_buffer() to allocate the buf...
Definition: utils.c:977
enum AVPictureType pict_type
Picture type of the frame.
Definition: frame.h:258
int width
picture width / height.
Definition: avcodec.h:1844
static void draw_char(AVCodecContext *avctx, int c, int a)
Draw character to screen.
Definition: bintext.c:121
int font_height
Definition: bintext.c:42
#define FONT_WIDTH
Definition: bintext.c:116
void ff_draw_pc_font(uint8_t *dst, int linesize, const uint8_t *font, int font_height, int ch, int fg, int bg)
Draw CGA/EGA/VGA font to 8-bit pixel buffer.
Definition: cga_data.c:46
Libavcodec external API header.
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_WB32 unsigned int_TMPL AV_RB24
Definition: bytestream.h:87
enum AVCodecID codec_id
Definition: avcodec.h:1674
int linesize[AV_NUM_DATA_POINTERS]
For video, size in bytes of each picture line.
Definition: frame.h:215
static int decode_frame(AVCodecContext *avctx, void *data, int *got_frame, AVPacket *avpkt)
Definition: bintext.c:136
main external API structure.
Definition: avcodec.h:1657
void * buf
Definition: avisynth_c.h:553
GLint GLenum type
Definition: opengl_enc.c:105
int extradata_size
Definition: avcodec.h:1773
int palette_has_changed
Tell user application that palette has changed from previous frame.
Definition: frame.h:328
AVFrame * frame
Definition: bintext.c:39
const uint32_t ff_cga_palette[16]
Definition: cga_data.c:30
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
Definition: frame.h:198
static int decode(AVCodecContext *avctx, void *data, int *got_sub, AVPacket *avpkt)
Definition: ccaption_dec.c:752
common internal api header.
static double c[64]
void * priv_data
Definition: avcodec.h:1699
#define BINTEXT_FONT
Definition: bintext.h:35
This structure stores compressed data.
Definition: avcodec.h:1565
#define AV_CODEC_CAP_DR1
Codec uses get_buffer() for allocating buffers and supports custom allocators.
Definition: avcodec.h:956
CGA/EGA/VGA ROM font data.
#define av_unused
Definition: attributes.h:126