libavcodec/ansi.c
beaa963c
 /*
  * ASCII/ANSI art decoder
  * 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
  * ASCII/ANSI art decoder
  */
 
1d9c2dc8
 #include "libavutil/common.h"
759001c5
 #include "libavutil/frame.h"
625bac78
 #include "libavutil/lfg.h"
81bbce9c
 #include "libavutil/xga_font_data.h"
beaa963c
 #include "avcodec.h"
 #include "cga_data.h"
594d4d5d
 #include "internal.h"
beaa963c
 
a20df858
 #define ATTR_BOLD         0x01  /**< Bold/Bright-foreground (mode 1) */
 #define ATTR_FAINT        0x02  /**< Faint (mode 2) */
 #define ATTR_UNDERLINE    0x08  /**< Underline (mode 4) */
 #define ATTR_BLINK        0x10  /**< Blink/Bright-background (mode 5) */
 #define ATTR_REVERSE      0x40  /**< Reverse (mode 7) */
 #define ATTR_CONCEALED    0x80  /**< Concealed (mode 8) */
beaa963c
 
a20df858
 #define DEFAULT_FG_COLOR     7  /**< CGA color index */
beaa963c
 #define DEFAULT_BG_COLOR     0
a20df858
 #define DEFAULT_SCREEN_MODE  3  /**< 80x25 */
beaa963c
 
a20df858
 #define FONT_WIDTH           8  /**< Font width */
beaa963c
 
 /** map ansi color index to cga palette index */
 static const uint8_t ansi_to_cga[16] = {
     0,  4,  2,  6,  1,  5,  3, 7, 8, 12, 10, 14,  9, 13, 11, 15
 };
 
7f9f771e
 typedef struct AnsiContext {
759001c5
     AVFrame *frame;
a20df858
     int x;                /**< x cursor position (pixels) */
     int y;                /**< y cursor position (pixels) */
     int sx;               /**< saved x cursor position (pixels) */
     int sy;               /**< saved y cursor position (pixels) */
     const uint8_t* font;  /**< font */
     int font_height;      /**< font height */
     int attributes;       /**< attribute flags */
     int fg;               /**< foreground color */
     int bg;               /**< background color */
65a31a0d
     int first_frame;
beaa963c
 
     /* ansi parser state machine */
     enum {
         STATE_NORMAL = 0,
         STATE_ESCAPE,
         STATE_CODE,
         STATE_MUSIC_PREAMBLE
     } state;
 #define MAX_NB_ARGS 4
     int args[MAX_NB_ARGS];
a20df858
     int nb_args;          /**< number of arguments (may exceed MAX_NB_ARGS) */
beaa963c
 } AnsiContext;
 
 static av_cold int decode_init(AVCodecContext *avctx)
 {
     AnsiContext *s = avctx->priv_data;
716d413c
     avctx->pix_fmt = AV_PIX_FMT_PAL8;
beaa963c
 
759001c5
     s->frame = av_frame_alloc();
     if (!s->frame)
         return AVERROR(ENOMEM);
 
beaa963c
     /* defaults */
81bbce9c
     s->font        = avpriv_vga16_font;
beaa963c
     s->font_height = 16;
     s->fg          = DEFAULT_FG_COLOR;
     s->bg          = DEFAULT_BG_COLOR;
 
994ab180
     if (!avctx->width || !avctx->height) {
         int ret = ff_set_dimensions(avctx, 80 << 3, 25 << 4);
         if (ret < 0)
             return ret;
     }
beaa963c
     return 0;
 }
 
3ac718d6
 static void set_palette(uint32_t *pal)
 {
     int r, g, b;
     memcpy(pal, ff_cga_palette, 16 * 4);
     pal += 16;
 #define COLOR(x) ((x) * 40 + 55)
     for (r = 0; r < 6; r++)
         for (g = 0; g < 6; g++)
             for (b = 0; b < 6; b++)
                 *pal++ = 0xFF000000 | (COLOR(r) << 16) | (COLOR(g) << 8) | COLOR(b);
 #define GRAY(x) ((x) * 10 + 8)
     for (g = 0; g < 24; g++)
         *pal++ = 0xFF000000 | (GRAY(g) << 16) | (GRAY(g) << 8) | GRAY(g);
 }
 
beaa963c
 static void hscroll(AVCodecContext *avctx)
 {
     AnsiContext *s = avctx->priv_data;
     int i;
 
6021615b
     if (s->y <= avctx->height - 2*s->font_height) {
beaa963c
         s->y += s->font_height;
         return;
     }
 
     i = 0;
     for (; i < avctx->height - s->font_height; i++)
759001c5
         memcpy(s->frame->data[0] + i * s->frame->linesize[0],
                s->frame->data[0] + (i + s->font_height) * s->frame->linesize[0],
beaa963c
                avctx->width);
     for (; i < avctx->height; i++)
759001c5
         memset(s->frame->data[0] + i * s->frame->linesize[0],
beaa963c
             DEFAULT_BG_COLOR, avctx->width);
 }
 
 static void erase_line(AVCodecContext * avctx, int xoffset, int xlength)
 {
     AnsiContext *s = avctx->priv_data;
     int i;
     for (i = 0; i < s->font_height; i++)
759001c5
         memset(s->frame->data[0] + (s->y + i)*s->frame->linesize[0] + xoffset,
beaa963c
             DEFAULT_BG_COLOR, xlength);
 }
 
 static void erase_screen(AVCodecContext *avctx)
 {
     AnsiContext *s = avctx->priv_data;
     int i;
     for (i = 0; i < avctx->height; i++)
759001c5
         memset(s->frame->data[0] + i * s->frame->linesize[0], DEFAULT_BG_COLOR, avctx->width);
beaa963c
     s->x = s->y = 0;
 }
 
 /**
  * Draw character to screen
  */
 static void draw_char(AVCodecContext *avctx, int c)
 {
     AnsiContext *s = avctx->priv_data;
     int fg = s->fg;
     int bg = s->bg;
 
     if ((s->attributes & ATTR_BOLD))
         fg += 8;
     if ((s->attributes & ATTR_BLINK))
         bg += 8;
     if ((s->attributes & ATTR_REVERSE))
         FFSWAP(int, fg, bg);
     if ((s->attributes & ATTR_CONCEALED))
         fg = bg;
759001c5
     ff_draw_pc_font(s->frame->data[0] + s->y * s->frame->linesize[0] + s->x,
                     s->frame->linesize[0], s->font, s->font_height, c, fg, bg);
beaa963c
     s->x += FONT_WIDTH;
6021615b
     if (s->x > avctx->width - FONT_WIDTH) {
beaa963c
         s->x = 0;
         hscroll(avctx);
     }
 }
 
 /**
  * Execute ANSI escape code
3d85acc8
  * @return 0 on success, negative on error
beaa963c
  */
 static int execute_code(AVCodecContext * avctx, int c)
 {
     AnsiContext *s = avctx->priv_data;
3ea5f64f
     int ret, i;
cf49d590
     int width  = avctx->width;
     int height = avctx->height;
3ea5f64f
 
beaa963c
     switch(c) {
     case 'A': //Cursor Up
         s->y = FFMAX(s->y - (s->nb_args > 0 ? s->args[0]*s->font_height : s->font_height), 0);
         break;
     case 'B': //Cursor Down
         s->y = FFMIN(s->y + (s->nb_args > 0 ? s->args[0]*s->font_height : s->font_height), avctx->height - s->font_height);
         break;
     case 'C': //Cursor Right
         s->x = FFMIN(s->x + (s->nb_args > 0 ? s->args[0]*FONT_WIDTH : FONT_WIDTH), avctx->width  - FONT_WIDTH);
         break;
     case 'D': //Cursor Left
         s->x = FFMAX(s->x - (s->nb_args > 0 ? s->args[0]*FONT_WIDTH : FONT_WIDTH), 0);
         break;
     case 'H': //Cursor Position
     case 'f': //Horizontal and Vertical Position
         s->y = s->nb_args > 0 ? av_clip((s->args[0] - 1)*s->font_height, 0, avctx->height - s->font_height) : 0;
         s->x = s->nb_args > 1 ? av_clip((s->args[1] - 1)*FONT_WIDTH,     0, avctx->width  - FONT_WIDTH) : 0;
         break;
41ed7ab4
     case 'h': //set screen mode
beaa963c
     case 'l': //reset screen mode
         if (s->nb_args < 2)
             s->args[0] = DEFAULT_SCREEN_MODE;
         switch(s->args[0]) {
         case 0: case 1: case 4: case 5: case 13: case 19: //320x200 (25 rows)
81bbce9c
             s->font = avpriv_cga_font;
beaa963c
             s->font_height = 8;
             width  = 40<<3;
             height = 25<<3;
             break;
         case 2: case 3: //640x400 (25 rows)
81bbce9c
             s->font = avpriv_vga16_font;
beaa963c
             s->font_height = 16;
             width  = 80<<3;
             height = 25<<4;
             break;
         case 6: case 14: //640x200 (25 rows)
81bbce9c
             s->font = avpriv_cga_font;
beaa963c
             s->font_height = 8;
             width  = 80<<3;
             height = 25<<3;
             break;
         case 7: //set line wrapping
             break;
         case 15: case 16: //640x350 (43 rows)
81bbce9c
             s->font = avpriv_cga_font;
beaa963c
             s->font_height = 8;
             width  = 80<<3;
             height = 43<<3;
             break;
         case 17: case 18: //640x480 (60 rows)
81bbce9c
             s->font = avpriv_cga_font;
beaa963c
             s->font_height = 8;
             width  = 80<<3;
             height = 60<<4;
             break;
         default:
6d97484d
             avpriv_request_sample(avctx, "Unsupported screen mode");
beaa963c
         }
e91fd754
         s->x = av_clip(s->x, 0, width  - FONT_WIDTH);
         s->y = av_clip(s->y, 0, height - s->font_height);
beaa963c
         if (width != avctx->width || height != avctx->height) {
759001c5
             av_frame_unref(s->frame);
78780c8b
             ret = ff_set_dimensions(avctx, width, height);
             if (ret < 0)
                 return ret;
1ec94b0f
             if ((ret = ff_get_buffer(avctx, s->frame,
                                      AV_GET_BUFFER_FLAG_REF)) < 0)
beaa963c
                 return ret;
759001c5
             s->frame->pict_type           = AV_PICTURE_TYPE_I;
             s->frame->palette_has_changed = 1;
80e9e63c
             set_palette((uint32_t *)s->frame->data[1]);
beaa963c
             erase_screen(avctx);
         } else if (c == 'l') {
             erase_screen(avctx);
         }
         break;
     case 'J': //Erase in Page
         switch (s->args[0]) {
         case 0:
             erase_line(avctx, s->x, avctx->width - s->x);
             if (s->y < avctx->height - s->font_height)
759001c5
                 memset(s->frame->data[0] + (s->y + s->font_height)*s->frame->linesize[0],
                     DEFAULT_BG_COLOR, (avctx->height - s->y - s->font_height)*s->frame->linesize[0]);
beaa963c
             break;
         case 1:
             erase_line(avctx, 0, s->x);
             if (s->y > 0)
759001c5
                 memset(s->frame->data[0], DEFAULT_BG_COLOR, s->y * s->frame->linesize[0]);
beaa963c
             break;
         case 2:
             erase_screen(avctx);
         }
         break;
     case 'K': //Erase in Line
         switch(s->args[0]) {
         case 0:
             erase_line(avctx, s->x, avctx->width - s->x);
             break;
         case 1:
             erase_line(avctx, 0, s->x);
             break;
         case 2:
             erase_line(avctx, 0, avctx->width);
         }
         break;
     case 'm': //Select Graphics Rendition
         if (s->nb_args == 0) {
             s->nb_args = 1;
             s->args[0] = 0;
         }
         for (i = 0; i < FFMIN(s->nb_args, MAX_NB_ARGS); i++) {
             int m = s->args[i];
             if (m == 0) {
                 s->attributes = 0;
                 s->fg = DEFAULT_FG_COLOR;
                 s->bg = DEFAULT_BG_COLOR;
             } else if (m == 1 || m == 2 || m == 4 || m == 5 || m == 7 || m == 8) {
                 s->attributes |= 1 << (m - 1);
3ac718d6
             } else if (m >= 30 && m <= 37) {
beaa963c
                 s->fg = ansi_to_cga[m - 30];
0ea55365
             } else if (m == 38 && i + 2 < FFMIN(s->nb_args, MAX_NB_ARGS) && s->args[i + 1] == 5 && s->args[i + 2] < 256) {
3ac718d6
                 int index = s->args[i + 2];
                 s->fg = index < 16 ? ansi_to_cga[index] : index;
                 i += 2;
beaa963c
             } else if (m == 39) {
                 s->fg = ansi_to_cga[DEFAULT_FG_COLOR];
             } else if (m >= 40 && m <= 47) {
                 s->bg = ansi_to_cga[m - 40];
0ea55365
             } else if (m == 48 && i + 2 < FFMIN(s->nb_args, MAX_NB_ARGS) && s->args[i + 1] == 5 && s->args[i + 2] < 256) {
3ac718d6
                 int index = s->args[i + 2];
                 s->bg = index < 16 ? ansi_to_cga[index] : index;
                 i += 2;
beaa963c
             } else if (m == 49) {
                 s->fg = ansi_to_cga[DEFAULT_BG_COLOR];
             } else {
6d97484d
                 avpriv_request_sample(avctx, "Unsupported rendition parameter");
beaa963c
             }
         }
         break;
     case 'n': //Device Status Report
     case 'R': //report current line and column
         /* ignore */
         break;
     case 's': //Save Cursor Position
         s->sx = s->x;
         s->sy = s->y;
         break;
     case 'u': //Restore Cursor Position
         s->x = av_clip(s->sx, 0, avctx->width  - FONT_WIDTH);
         s->y = av_clip(s->sy, 0, avctx->height - s->font_height);
         break;
     default:
6d97484d
         avpriv_request_sample(avctx, "Unknown escape code");
beaa963c
         break;
     }
e91fd754
     s->x = av_clip(s->x, 0, avctx->width  - FONT_WIDTH);
     s->y = av_clip(s->y, 0, avctx->height - s->font_height);
beaa963c
     return 0;
 }
 
 static int decode_frame(AVCodecContext *avctx,
df9b9567
                             void *data, int *got_frame,
beaa963c
                             AVPacket *avpkt)
 {
     AnsiContext *s = avctx->priv_data;
     uint8_t *buf = avpkt->data;
     int buf_size = avpkt->size;
     const uint8_t *buf_end   = buf+buf_size;
     int ret, i, count;
 
1ec94b0f
     if ((ret = ff_reget_buffer(avctx, s->frame)) < 0)
beaa963c
         return ret;
99e36ddd
     if (!avctx->frame_number) {
7681b8e9
         for (i=0; i<avctx->height; i++)
80e9e63c
             memset(s->frame->data[0]+ i*s->frame->linesize[0], 0, avctx->width);
759001c5
         memset(s->frame->data[1], 0, AVPALETTE_SIZE);
99e36ddd
     }
 
759001c5
     s->frame->pict_type           = AV_PICTURE_TYPE_I;
     s->frame->palette_has_changed = 1;
80e9e63c
     set_palette((uint32_t *)s->frame->data[1]);
65a31a0d
     if (!s->first_frame) {
         erase_screen(avctx);
         s->first_frame = 1;
     }
beaa963c
 
     while(buf < buf_end) {
         switch(s->state) {
         case STATE_NORMAL:
             switch (buf[0]) {
             case 0x00: //NUL
             case 0x07: //BEL
             case 0x1A: //SUB
                 /* ignore */
                 break;
             case 0x08: //BS
                 s->x = FFMAX(s->x - 1, 0);
                 break;
             case 0x09: //HT
                 i = s->x / FONT_WIDTH;
                 count = ((i + 8) & ~7) - i;
                 for (i = 0; i < count; i++)
                     draw_char(avctx, ' ');
                 break;
             case 0x0A: //LF
                 hscroll(avctx);
             case 0x0D: //CR
                 s->x = 0;
                 break;
             case 0x0C: //FF
                 erase_screen(avctx);
                 break;
             case 0x1B: //ESC
                 s->state = STATE_ESCAPE;
                 break;
             default:
                 draw_char(avctx, buf[0]);
             }
             break;
         case STATE_ESCAPE:
             if (buf[0] == '[') {
                 s->state   = STATE_CODE;
                 s->nb_args = 0;
95b9e56b
                 s->args[0] = -1;
beaa963c
             } else {
                 s->state = STATE_NORMAL;
                 draw_char(avctx, 0x1B);
                 continue;
             }
             break;
         case STATE_CODE:
             switch(buf[0]) {
             case '0': case '1': case '2': case '3': case '4':
             case '5': case '6': case '7': case '8': case '9':
d42ec843
                 if (s->nb_args < MAX_NB_ARGS && s->args[s->nb_args] < 6553)
95b9e56b
                     s->args[s->nb_args] = FFMAX(s->args[s->nb_args], 0) * 10 + buf[0] - '0';
beaa963c
                 break;
             case ';':
                 s->nb_args++;
                 if (s->nb_args < MAX_NB_ARGS)
                     s->args[s->nb_args] = 0;
                 break;
             case 'M':
                 s->state = STATE_MUSIC_PREAMBLE;
                 break;
             case '=': case '?':
                 /* ignore */
                 break;
             default:
                 if (s->nb_args > MAX_NB_ARGS)
                     av_log(avctx, AV_LOG_WARNING, "args overflow (%i)\n", s->nb_args);
95b9e56b
                 if (s->nb_args < MAX_NB_ARGS && s->args[s->nb_args] >= 0)
beaa963c
                     s->nb_args++;
b3b17f78
                 if ((ret = execute_code(avctx, buf[0])) < 0)
                     return ret;
beaa963c
                 s->state = STATE_NORMAL;
             }
             break;
         case STATE_MUSIC_PREAMBLE:
             if (buf[0] == 0x0E || buf[0] == 0x1B)
                 s->state = STATE_NORMAL;
             /* ignore music data */
             break;
         }
         buf++;
     }
 
df9b9567
     *got_frame = 1;
759001c5
     if ((ret = av_frame_ref(data, s->frame)) < 0)
         return ret;
beaa963c
     return buf_size;
 }
 
 static av_cold int decode_close(AVCodecContext *avctx)
 {
     AnsiContext *s = avctx->priv_data;
759001c5
 
     av_frame_free(&s->frame);
beaa963c
     return 0;
 }
 
e7e2df27
 AVCodec ff_ansi_decoder = {
beaa963c
     .name           = "ansi",
b2bed932
     .long_name      = NULL_IF_CONFIG_SMALL("ASCII/ANSI art"),
b9f9e59a
     .type           = AVMEDIA_TYPE_VIDEO,
36ef5369
     .id             = AV_CODEC_ID_ANSI,
beaa963c
     .priv_data_size = sizeof(AnsiContext),
     .init           = decode_init,
     .close          = decode_close,
     .decode         = decode_frame,
def97856
     .capabilities   = AV_CODEC_CAP_DR1,
beaa963c
 };