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