ansi: support 256-colors
[ffmpeg.git] / libavcodec / ansi.c
1 /*
2  * ASCII/ANSI art decoder
3  * Copyright (c) 2010 Peter Ross <pross@xvid.org>
4  *
5  * This file is part of FFmpeg.
6  *
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.
11  *
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.
16  *
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
20  */
21
22 /**
23  * @file
24  * ASCII/ANSI art decoder
25  */
26
27 #include "libavutil/common.h"
28 #include "libavutil/lfg.h"
29 #include "avcodec.h"
30 #include "cga_data.h"
31
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) */
38
39 #define DEFAULT_FG_COLOR     7  /**< CGA color index */
40 #define DEFAULT_BG_COLOR     0
41 #define DEFAULT_SCREEN_MODE  3  /**< 80x25 */
42
43 #define FONT_WIDTH           8  /**< Font width */
44
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
48 };
49
50 typedef struct {
51     AVFrame frame;
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 */
61
62     /* ansi parser state machine */
63     enum {
64         STATE_NORMAL = 0,
65         STATE_ESCAPE,
66         STATE_CODE,
67         STATE_MUSIC_PREAMBLE
68     } state;
69 #define MAX_NB_ARGS 4
70     int args[MAX_NB_ARGS];
71     int nb_args;          /**< number of arguments (may exceed MAX_NB_ARGS) */
72 } AnsiContext;
73
74 static av_cold int decode_init(AVCodecContext *avctx)
75 {
76     AnsiContext *s = avctx->priv_data;
77     avctx->pix_fmt = PIX_FMT_PAL8;
78
79     /* defaults */
80     s->font        = ff_vga16_font;
81     s->font_height = 16;
82     s->fg          = DEFAULT_FG_COLOR;
83     s->bg          = DEFAULT_BG_COLOR;
84
85     avcodec_get_frame_defaults(&s->frame);
86     if (!avctx->width || !avctx->height)
87         avcodec_set_dimensions(avctx, 80<<3, 25<<4);
88
89     return 0;
90 }
91
92 static void set_palette(uint32_t *pal)
93 {
94     int r, g, b;
95     memcpy(pal, ff_cga_palette, 16 * 4);
96     pal += 16;
97 #define COLOR(x) ((x) * 40 + 55)
98     for (r = 0; r < 6; r++)
99         for (g = 0; g < 6; g++)
100             for (b = 0; b < 6; b++)
101                 *pal++ = 0xFF000000 | (COLOR(r) << 16) | (COLOR(g) << 8) | COLOR(b);
102 #define GRAY(x) ((x) * 10 + 8)
103     for (g = 0; g < 24; g++)
104         *pal++ = 0xFF000000 | (GRAY(g) << 16) | (GRAY(g) << 8) | GRAY(g);
105 }
106
107 static void hscroll(AVCodecContext *avctx)
108 {
109     AnsiContext *s = avctx->priv_data;
110     int i;
111
112     if (s->y < avctx->height - s->font_height) {
113         s->y += s->font_height;
114         return;
115     }
116
117     i = 0;
118     for (; i < avctx->height - s->font_height; i++)
119         memcpy(s->frame.data[0] + i * s->frame.linesize[0],
120                s->frame.data[0] + (i + s->font_height) * s->frame.linesize[0],
121                avctx->width);
122     for (; i < avctx->height; i++)
123         memset(s->frame.data[0] + i * s->frame.linesize[0],
124             DEFAULT_BG_COLOR, avctx->width);
125 }
126
127 static void erase_line(AVCodecContext * avctx, int xoffset, int xlength)
128 {
129     AnsiContext *s = avctx->priv_data;
130     int i;
131     for (i = 0; i < s->font_height; i++)
132         memset(s->frame.data[0] + (s->y + i)*s->frame.linesize[0] + xoffset,
133             DEFAULT_BG_COLOR, xlength);
134 }
135
136 static void erase_screen(AVCodecContext *avctx)
137 {
138     AnsiContext *s = avctx->priv_data;
139     int i;
140     for (i = 0; i < avctx->height; i++)
141         memset(s->frame.data[0] + i * s->frame.linesize[0], DEFAULT_BG_COLOR, avctx->width);
142     s->x = s->y = 0;
143 }
144
145 /**
146  * Draw character to screen
147  */
148 static void draw_char(AVCodecContext *avctx, int c)
149 {
150     AnsiContext *s = avctx->priv_data;
151     int fg = s->fg;
152     int bg = s->bg;
153
154     if ((s->attributes & ATTR_BOLD))
155         fg += 8;
156     if ((s->attributes & ATTR_BLINK))
157         bg += 8;
158     if ((s->attributes & ATTR_REVERSE))
159         FFSWAP(int, fg, bg);
160     if ((s->attributes & ATTR_CONCEALED))
161         fg = bg;
162     ff_draw_pc_font(s->frame.data[0] + s->y * s->frame.linesize[0] + s->x,
163                     s->frame.linesize[0], s->font, s->font_height, c, fg, bg);
164     s->x += FONT_WIDTH;
165     if (s->x >= avctx->width) {
166         s->x = 0;
167         hscroll(avctx);
168     }
169 }
170
171 /**
172  * Execute ANSI escape code
173  * @return 0 on success, negative on error
174  */
175 static int execute_code(AVCodecContext * avctx, int c)
176 {
177     AnsiContext *s = avctx->priv_data;
178     int ret, i, width, height;
179     switch(c) {
180     case 'A': //Cursor Up
181         s->y = FFMAX(s->y - (s->nb_args > 0 ? s->args[0]*s->font_height : s->font_height), 0);
182         break;
183     case 'B': //Cursor Down
184         s->y = FFMIN(s->y + (s->nb_args > 0 ? s->args[0]*s->font_height : s->font_height), avctx->height - s->font_height);
185         break;
186     case 'C': //Cursor Right
187         s->x = FFMIN(s->x + (s->nb_args > 0 ? s->args[0]*FONT_WIDTH : FONT_WIDTH), avctx->width  - FONT_WIDTH);
188         break;
189     case 'D': //Cursor Left
190         s->x = FFMAX(s->x - (s->nb_args > 0 ? s->args[0]*FONT_WIDTH : FONT_WIDTH), 0);
191         break;
192     case 'H': //Cursor Position
193     case 'f': //Horizontal and Vertical Position
194         s->y = s->nb_args > 0 ? av_clip((s->args[0] - 1)*s->font_height, 0, avctx->height - s->font_height) : 0;
195         s->x = s->nb_args > 1 ? av_clip((s->args[1] - 1)*FONT_WIDTH,     0, avctx->width  - FONT_WIDTH) : 0;
196         break;
197     case 'h': //set creen mode
198     case 'l': //reset screen mode
199         if (s->nb_args < 2)
200             s->args[0] = DEFAULT_SCREEN_MODE;
201         width = avctx->width;
202         height = avctx->height;
203         switch(s->args[0]) {
204         case 0: case 1: case 4: case 5: case 13: case 19: //320x200 (25 rows)
205             s->font = ff_cga_font;
206             s->font_height = 8;
207             width  = 40<<3;
208             height = 25<<3;
209             break;
210         case 2: case 3: //640x400 (25 rows)
211             s->font = ff_vga16_font;
212             s->font_height = 16;
213             width  = 80<<3;
214             height = 25<<4;
215             break;
216         case 6: case 14: //640x200 (25 rows)
217             s->font = ff_cga_font;
218             s->font_height = 8;
219             width  = 80<<3;
220             height = 25<<3;
221             break;
222         case 7: //set line wrapping
223             break;
224         case 15: case 16: //640x350 (43 rows)
225             s->font = ff_cga_font;
226             s->font_height = 8;
227             width  = 80<<3;
228             height = 43<<3;
229             break;
230         case 17: case 18: //640x480 (60 rows)
231             s->font = ff_cga_font;
232             s->font_height = 8;
233             width  = 80<<3;
234             height = 60<<4;
235             break;
236         default:
237             av_log_ask_for_sample(avctx, "unsupported screen mode\n");
238         }
239         if (width != avctx->width || height != avctx->height) {
240             if (s->frame.data[0])
241                 avctx->release_buffer(avctx, &s->frame);
242             avcodec_set_dimensions(avctx, width, height);
243             ret = avctx->get_buffer(avctx, &s->frame);
244             if (ret < 0) {
245                 av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
246                 return ret;
247             }
248             s->frame.pict_type           = AV_PICTURE_TYPE_I;
249             s->frame.palette_has_changed = 1;
250             set_palette((uint32_t *)s->frame.data[1]);
251             erase_screen(avctx);
252         } else if (c == 'l') {
253             erase_screen(avctx);
254         }
255         break;
256     case 'J': //Erase in Page
257         switch (s->args[0]) {
258         case 0:
259             erase_line(avctx, s->x, avctx->width - s->x);
260             if (s->y < avctx->height - s->font_height)
261                 memset(s->frame.data[0] + (s->y + s->font_height)*s->frame.linesize[0],
262                     DEFAULT_BG_COLOR, (avctx->height - s->y - s->font_height)*s->frame.linesize[0]);
263             break;
264         case 1:
265             erase_line(avctx, 0, s->x);
266             if (s->y > 0)
267                 memset(s->frame.data[0], DEFAULT_BG_COLOR, s->y * s->frame.linesize[0]);
268             break;
269         case 2:
270             erase_screen(avctx);
271         }
272         break;
273     case 'K': //Erase in Line
274         switch(s->args[0]) {
275         case 0:
276             erase_line(avctx, s->x, avctx->width - s->x);
277             break;
278         case 1:
279             erase_line(avctx, 0, s->x);
280             break;
281         case 2:
282             erase_line(avctx, 0, avctx->width);
283         }
284         break;
285     case 'm': //Select Graphics Rendition
286         if (s->nb_args == 0) {
287             s->nb_args = 1;
288             s->args[0] = 0;
289         }
290         for (i = 0; i < FFMIN(s->nb_args, MAX_NB_ARGS); i++) {
291             int m = s->args[i];
292             if (m == 0) {
293                 s->attributes = 0;
294                 s->fg = DEFAULT_FG_COLOR;
295                 s->bg = DEFAULT_BG_COLOR;
296             } else if (m == 1 || m == 2 || m == 4 || m == 5 || m == 7 || m == 8) {
297                 s->attributes |= 1 << (m - 1);
298             } else if (m >= 30 && m <= 37) {
299                 s->fg = ansi_to_cga[m - 30];
300             } else if (m == 38 && i + 2 < s->nb_args && s->args[i + 1] == 5 && s->args[i + 2] < 256) {
301                 int index = s->args[i + 2];
302                 s->fg = index < 16 ? ansi_to_cga[index] : index;
303                 i += 2;
304             } else if (m == 39) {
305                 s->fg = ansi_to_cga[DEFAULT_FG_COLOR];
306             } else if (m >= 40 && m <= 47) {
307                 s->bg = ansi_to_cga[m - 40];
308             } else if (m == 48 && i + 2 < s->nb_args && s->args[i + 1] == 5 && s->args[i + 2] < 256) {
309                 int index = s->args[i + 2];
310                 s->bg = index < 16 ? ansi_to_cga[index] : index;
311                 i += 2;
312             } else if (m == 49) {
313                 s->fg = ansi_to_cga[DEFAULT_BG_COLOR];
314             } else {
315                 av_log_ask_for_sample(avctx, "unsupported rendition parameter\n");
316             }
317         }
318         break;
319     case 'n': //Device Status Report
320     case 'R': //report current line and column
321         /* ignore */
322         break;
323     case 's': //Save Cursor Position
324         s->sx = s->x;
325         s->sy = s->y;
326         break;
327     case 'u': //Restore Cursor Position
328         s->x = av_clip(s->sx, 0, avctx->width  - FONT_WIDTH);
329         s->y = av_clip(s->sy, 0, avctx->height - s->font_height);
330         break;
331     default:
332         av_log_ask_for_sample(avctx, "unsupported escape code\n");
333         break;
334     }
335     return 0;
336 }
337
338 static int decode_frame(AVCodecContext *avctx,
339                             void *data, int *data_size,
340                             AVPacket *avpkt)
341 {
342     AnsiContext *s = avctx->priv_data;
343     uint8_t *buf = avpkt->data;
344     int buf_size = avpkt->size;
345     const uint8_t *buf_end   = buf+buf_size;
346     int ret, i, count;
347
348     ret = avctx->reget_buffer(avctx, &s->frame);
349     if (ret < 0){
350         av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
351         return ret;
352     }
353     s->frame.pict_type           = AV_PICTURE_TYPE_I;
354     s->frame.palette_has_changed = 1;
355     set_palette((uint32_t *)s->frame.data[1]);
356
357     while(buf < buf_end) {
358         switch(s->state) {
359         case STATE_NORMAL:
360             switch (buf[0]) {
361             case 0x00: //NUL
362             case 0x07: //BEL
363             case 0x1A: //SUB
364                 /* ignore */
365                 break;
366             case 0x08: //BS
367                 s->x = FFMAX(s->x - 1, 0);
368                 break;
369             case 0x09: //HT
370                 i = s->x / FONT_WIDTH;
371                 count = ((i + 8) & ~7) - i;
372                 for (i = 0; i < count; i++)
373                     draw_char(avctx, ' ');
374                 break;
375             case 0x0A: //LF
376                 hscroll(avctx);
377             case 0x0D: //CR
378                 s->x = 0;
379                 break;
380             case 0x0C: //FF
381                 erase_screen(avctx);
382                 break;
383             case 0x1B: //ESC
384                 s->state = STATE_ESCAPE;
385                 break;
386             default:
387                 draw_char(avctx, buf[0]);
388             }
389             break;
390         case STATE_ESCAPE:
391             if (buf[0] == '[') {
392                 s->state   = STATE_CODE;
393                 s->nb_args = 0;
394                 s->args[0] = -1;
395             } else {
396                 s->state = STATE_NORMAL;
397                 draw_char(avctx, 0x1B);
398                 continue;
399             }
400             break;
401         case STATE_CODE:
402             switch(buf[0]) {
403             case '0': case '1': case '2': case '3': case '4':
404             case '5': case '6': case '7': case '8': case '9':
405                 if (s->nb_args < MAX_NB_ARGS)
406                     s->args[s->nb_args] = FFMAX(s->args[s->nb_args], 0) * 10 + buf[0] - '0';
407                 break;
408             case ';':
409                 s->nb_args++;
410                 if (s->nb_args < MAX_NB_ARGS)
411                     s->args[s->nb_args] = 0;
412                 break;
413             case 'M':
414                 s->state = STATE_MUSIC_PREAMBLE;
415                 break;
416             case '=': case '?':
417                 /* ignore */
418                 break;
419             default:
420                 if (s->nb_args > MAX_NB_ARGS)
421                     av_log(avctx, AV_LOG_WARNING, "args overflow (%i)\n", s->nb_args);
422                 if (s->nb_args < MAX_NB_ARGS && s->args[s->nb_args] >= 0)
423                     s->nb_args++;
424                 if (execute_code(avctx, buf[0]) < 0)
425                     return -1;
426                 s->state = STATE_NORMAL;
427             }
428             break;
429         case STATE_MUSIC_PREAMBLE:
430             if (buf[0] == 0x0E || buf[0] == 0x1B)
431                 s->state = STATE_NORMAL;
432             /* ignore music data */
433             break;
434         }
435         buf++;
436     }
437
438     *data_size = sizeof(AVFrame);
439     *(AVFrame*)data = s->frame;
440     return buf_size;
441 }
442
443 static av_cold int decode_close(AVCodecContext *avctx)
444 {
445     AnsiContext *s = avctx->priv_data;
446     if (s->frame.data[0])
447         avctx->release_buffer(avctx, &s->frame);
448     return 0;
449 }
450
451 AVCodec ff_ansi_decoder = {
452     .name           = "ansi",
453     .type           = AVMEDIA_TYPE_VIDEO,
454     .id             = AV_CODEC_ID_ANSI,
455     .priv_data_size = sizeof(AnsiContext),
456     .init           = decode_init,
457     .close          = decode_close,
458     .decode         = decode_frame,
459     .capabilities   = CODEC_CAP_DR1,
460     .long_name      = NULL_IF_CONFIG_SMALL("ASCII/ANSI art"),
461 };