2 * ASCII/ANSI art decoder
3 * Copyright (c) 2010 Peter Ross <pross@xvid.org>
5 * This file is part of FFmpeg.
7 * FFmpeg is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * FFmpeg is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with FFmpeg; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
24 * ASCII/ANSI art decoder
27 #include "libavutil/common.h"
28 #include "libavutil/lfg.h"
32 #define ATTR_BOLD 0x01 /**< Bold/Bright-foreground (mode 1) */
33 #define ATTR_FAINT 0x02 /**< Faint (mode 2) */
34 #define ATTR_UNDERLINE 0x08 /**< Underline (mode 4) */
35 #define ATTR_BLINK 0x10 /**< Blink/Bright-background (mode 5) */
36 #define ATTR_REVERSE 0x40 /**< Reverse (mode 7) */
37 #define ATTR_CONCEALED 0x80 /**< Concealed (mode 8) */
39 #define DEFAULT_FG_COLOR 7 /**< CGA color index */
40 #define DEFAULT_BG_COLOR 0
41 #define DEFAULT_SCREEN_MODE 3 /**< 80x25 */
43 #define FONT_WIDTH 8 /**< Font width */
45 /** map ansi color index to cga palette index */
46 static const uint8_t ansi_to_cga[16] = {
47 0, 4, 2, 6, 1, 5, 3, 7, 8, 12, 10, 14, 9, 13, 11, 15
52 int x; /**< x cursor position (pixels) */
53 int y; /**< y cursor position (pixels) */
54 int sx; /**< saved x cursor position (pixels) */
55 int sy; /**< saved y cursor position (pixels) */
56 const uint8_t* font; /**< font */
57 int font_height; /**< font height */
58 int attributes; /**< attribute flags */
59 int fg; /**< foreground color */
60 int bg; /**< background color */
62 /* ansi parser state machine */
70 int args[MAX_NB_ARGS];
71 int nb_args; /**< number of arguments (may exceed MAX_NB_ARGS) */
74 static av_cold int decode_init(AVCodecContext *avctx)
76 AnsiContext *s = avctx->priv_data;
77 avctx->pix_fmt = PIX_FMT_PAL8;
80 s->font = ff_vga16_font;
82 s->fg = DEFAULT_FG_COLOR;
83 s->bg = DEFAULT_BG_COLOR;
85 avcodec_get_frame_defaults(&s->frame);
86 if (!avctx->width || !avctx->height)
87 avcodec_set_dimensions(avctx, 80<<3, 25<<4);
92 static void hscroll(AVCodecContext *avctx)
94 AnsiContext *s = avctx->priv_data;
97 if (s->y < avctx->height - s->font_height) {
98 s->y += s->font_height;
103 for (; i < avctx->height - s->font_height; i++)
104 memcpy(s->frame.data[0] + i * s->frame.linesize[0],
105 s->frame.data[0] + (i + s->font_height) * s->frame.linesize[0],
107 for (; i < avctx->height; i++)
108 memset(s->frame.data[0] + i * s->frame.linesize[0],
109 DEFAULT_BG_COLOR, avctx->width);
112 static void erase_line(AVCodecContext * avctx, int xoffset, int xlength)
114 AnsiContext *s = avctx->priv_data;
116 for (i = 0; i < s->font_height; i++)
117 memset(s->frame.data[0] + (s->y + i)*s->frame.linesize[0] + xoffset,
118 DEFAULT_BG_COLOR, xlength);
121 static void erase_screen(AVCodecContext *avctx)
123 AnsiContext *s = avctx->priv_data;
125 for (i = 0; i < avctx->height; i++)
126 memset(s->frame.data[0] + i * s->frame.linesize[0], DEFAULT_BG_COLOR, avctx->width);
131 * Draw character to screen
133 static void draw_char(AVCodecContext *avctx, int c)
135 AnsiContext *s = avctx->priv_data;
139 if ((s->attributes & ATTR_BOLD))
141 if ((s->attributes & ATTR_BLINK))
143 if ((s->attributes & ATTR_REVERSE))
145 if ((s->attributes & ATTR_CONCEALED))
147 ff_draw_pc_font(s->frame.data[0] + s->y * s->frame.linesize[0] + s->x,
148 s->frame.linesize[0], s->font, s->font_height, c, fg, bg);
150 if (s->x >= avctx->width) {
157 * Execute ANSI escape code
158 * @return 0 on success, negative on error
160 static int execute_code(AVCodecContext * avctx, int c)
162 AnsiContext *s = avctx->priv_data;
163 int ret, i, width, height;
165 case 'A': //Cursor Up
166 s->y = FFMAX(s->y - (s->nb_args > 0 ? s->args[0]*s->font_height : s->font_height), 0);
168 case 'B': //Cursor Down
169 s->y = FFMIN(s->y + (s->nb_args > 0 ? s->args[0]*s->font_height : s->font_height), avctx->height - s->font_height);
171 case 'C': //Cursor Right
172 s->x = FFMIN(s->x + (s->nb_args > 0 ? s->args[0]*FONT_WIDTH : FONT_WIDTH), avctx->width - FONT_WIDTH);
174 case 'D': //Cursor Left
175 s->x = FFMAX(s->x - (s->nb_args > 0 ? s->args[0]*FONT_WIDTH : FONT_WIDTH), 0);
177 case 'H': //Cursor Position
178 case 'f': //Horizontal and Vertical Position
179 s->y = s->nb_args > 0 ? av_clip((s->args[0] - 1)*s->font_height, 0, avctx->height - s->font_height) : 0;
180 s->x = s->nb_args > 1 ? av_clip((s->args[1] - 1)*FONT_WIDTH, 0, avctx->width - FONT_WIDTH) : 0;
182 case 'h': //set creen mode
183 case 'l': //reset screen mode
185 s->args[0] = DEFAULT_SCREEN_MODE;
186 width = avctx->width;
187 height = avctx->height;
189 case 0: case 1: case 4: case 5: case 13: case 19: //320x200 (25 rows)
190 s->font = ff_cga_font;
195 case 2: case 3: //640x400 (25 rows)
196 s->font = ff_vga16_font;
201 case 6: case 14: //640x200 (25 rows)
202 s->font = ff_cga_font;
207 case 7: //set line wrapping
209 case 15: case 16: //640x350 (43 rows)
210 s->font = ff_cga_font;
215 case 17: case 18: //640x480 (60 rows)
216 s->font = ff_cga_font;
222 av_log_ask_for_sample(avctx, "unsupported screen mode\n");
224 if (width != avctx->width || height != avctx->height) {
225 if (s->frame.data[0])
226 avctx->release_buffer(avctx, &s->frame);
227 avcodec_set_dimensions(avctx, width, height);
228 ret = avctx->get_buffer(avctx, &s->frame);
230 av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
233 s->frame.pict_type = AV_PICTURE_TYPE_I;
234 s->frame.palette_has_changed = 1;
235 memcpy(s->frame.data[1], ff_cga_palette, 16 * 4);
237 } else if (c == 'l') {
241 case 'J': //Erase in Page
242 switch (s->args[0]) {
244 erase_line(avctx, s->x, avctx->width - s->x);
245 if (s->y < avctx->height - s->font_height)
246 memset(s->frame.data[0] + (s->y + s->font_height)*s->frame.linesize[0],
247 DEFAULT_BG_COLOR, (avctx->height - s->y - s->font_height)*s->frame.linesize[0]);
250 erase_line(avctx, 0, s->x);
252 memset(s->frame.data[0], DEFAULT_BG_COLOR, s->y * s->frame.linesize[0]);
258 case 'K': //Erase in Line
261 erase_line(avctx, s->x, avctx->width - s->x);
264 erase_line(avctx, 0, s->x);
267 erase_line(avctx, 0, avctx->width);
270 case 'm': //Select Graphics Rendition
271 if (s->nb_args == 0) {
275 for (i = 0; i < FFMIN(s->nb_args, MAX_NB_ARGS); i++) {
279 s->fg = DEFAULT_FG_COLOR;
280 s->bg = DEFAULT_BG_COLOR;
281 } else if (m == 1 || m == 2 || m == 4 || m == 5 || m == 7 || m == 8) {
282 s->attributes |= 1 << (m - 1);
283 } else if (m >= 30 && m <= 38) {
284 s->fg = ansi_to_cga[m - 30];
285 } else if (m == 39) {
286 s->fg = ansi_to_cga[DEFAULT_FG_COLOR];
287 } else if (m >= 40 && m <= 47) {
288 s->bg = ansi_to_cga[m - 40];
289 } else if (m == 49) {
290 s->fg = ansi_to_cga[DEFAULT_BG_COLOR];
292 av_log_ask_for_sample(avctx, "unsupported rendition parameter\n");
296 case 'n': //Device Status Report
297 case 'R': //report current line and column
300 case 's': //Save Cursor Position
304 case 'u': //Restore Cursor Position
305 s->x = av_clip(s->sx, 0, avctx->width - FONT_WIDTH);
306 s->y = av_clip(s->sy, 0, avctx->height - s->font_height);
309 av_log_ask_for_sample(avctx, "unsupported escape code\n");
315 static int decode_frame(AVCodecContext *avctx,
316 void *data, int *data_size,
319 AnsiContext *s = avctx->priv_data;
320 uint8_t *buf = avpkt->data;
321 int buf_size = avpkt->size;
322 const uint8_t *buf_end = buf+buf_size;
325 ret = avctx->reget_buffer(avctx, &s->frame);
327 av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
330 s->frame.pict_type = AV_PICTURE_TYPE_I;
331 s->frame.palette_has_changed = 1;
332 memcpy(s->frame.data[1], ff_cga_palette, 16 * 4);
334 while(buf < buf_end) {
344 s->x = FFMAX(s->x - 1, 0);
347 i = s->x / FONT_WIDTH;
348 count = ((i + 8) & ~7) - i;
349 for (i = 0; i < count; i++)
350 draw_char(avctx, ' ');
361 s->state = STATE_ESCAPE;
364 draw_char(avctx, buf[0]);
369 s->state = STATE_CODE;
373 s->state = STATE_NORMAL;
374 draw_char(avctx, 0x1B);
381 case '0': case '1': case '2': case '3': case '4':
382 case '5': case '6': case '7': case '8': case '9':
383 if (s->nb_args < MAX_NB_ARGS)
384 s->args[s->nb_args] = s->args[s->nb_args] * 10 + buf[0] - '0';
388 if (s->nb_args < MAX_NB_ARGS)
389 s->args[s->nb_args] = 0;
392 s->state = STATE_MUSIC_PREAMBLE;
398 if (s->nb_args > MAX_NB_ARGS)
399 av_log(avctx, AV_LOG_WARNING, "args overflow (%i)\n", s->nb_args);
400 if (s->nb_args < MAX_NB_ARGS && s->args[s->nb_args])
402 if (execute_code(avctx, buf[0]) < 0)
404 s->state = STATE_NORMAL;
407 case STATE_MUSIC_PREAMBLE:
408 if (buf[0] == 0x0E || buf[0] == 0x1B)
409 s->state = STATE_NORMAL;
410 /* ignore music data */
416 *data_size = sizeof(AVFrame);
417 *(AVFrame*)data = s->frame;
421 static av_cold int decode_close(AVCodecContext *avctx)
423 AnsiContext *s = avctx->priv_data;
424 if (s->frame.data[0])
425 avctx->release_buffer(avctx, &s->frame);
429 AVCodec ff_ansi_decoder = {
431 .type = AVMEDIA_TYPE_VIDEO,
432 .id = AV_CODEC_ID_ANSI,
433 .priv_data_size = sizeof(AnsiContext),
435 .close = decode_close,
436 .decode = decode_frame,
437 .capabilities = CODEC_CAP_DR1,
438 .long_name = NULL_IF_CONFIG_SMALL("ASCII/ANSI art"),