ansi.c 15.9 KB
Newer Older
Peter Ross's avatar
Peter Ross committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
/*
 * 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
 */

27
#include "libavutil/common.h"
28
#include "libavutil/frame.h"
29
#include "libavutil/lfg.h"
30
#include "libavutil/xga_font_data.h"
Peter Ross's avatar
Peter Ross committed
31 32
#include "avcodec.h"
#include "cga_data.h"
33
#include "internal.h"
Peter Ross's avatar
Peter Ross committed
34

35 36 37 38 39 40
#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) */
Peter Ross's avatar
Peter Ross committed
41

42
#define DEFAULT_FG_COLOR     7  /**< CGA color index */
Peter Ross's avatar
Peter Ross committed
43
#define DEFAULT_BG_COLOR     0
44
#define DEFAULT_SCREEN_MODE  3  /**< 80x25 */
Peter Ross's avatar
Peter Ross committed
45

46
#define FONT_WIDTH           8  /**< Font width */
Peter Ross's avatar
Peter Ross committed
47 48 49 50 51 52

/** 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
};

53
typedef struct AnsiContext {
54
    AVFrame *frame;
55 56 57 58 59 60 61 62 63
    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 */
64
    int first_frame;
Peter Ross's avatar
Peter Ross committed
65 66 67 68 69 70 71 72 73 74

    /* 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];
75
    int nb_args;          /**< number of arguments (may exceed MAX_NB_ARGS) */
Peter Ross's avatar
Peter Ross committed
76 77 78 79 80
} AnsiContext;

static av_cold int decode_init(AVCodecContext *avctx)
{
    AnsiContext *s = avctx->priv_data;
81
    avctx->pix_fmt = AV_PIX_FMT_PAL8;
Peter Ross's avatar
Peter Ross committed
82 83

    /* defaults */
84
    s->font        = avpriv_vga16_font;
Peter Ross's avatar
Peter Ross committed
85 86 87 88
    s->font_height = 16;
    s->fg          = DEFAULT_FG_COLOR;
    s->bg          = DEFAULT_BG_COLOR;

89 90 91 92
    if (!avctx->width || !avctx->height) {
        int ret = ff_set_dimensions(avctx, 80 << 3, 25 << 4);
        if (ret < 0)
            return ret;
93 94 95
    } else if (avctx->width % FONT_WIDTH || avctx->height % s->font_height) {
        av_log(avctx, AV_LOG_ERROR, "Invalid dimensions %d %d\n", avctx->width, avctx->height);
        return AVERROR(EINVAL);
96
    }
97 98 99 100 101

    s->frame = av_frame_alloc();
    if (!s->frame)
        return AVERROR(ENOMEM);

Peter Ross's avatar
Peter Ross committed
102 103 104
    return 0;
}

Peter Ross's avatar
Peter Ross committed
105 106 107 108 109 110 111 112 113 114 115 116 117 118 119
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);
}

Peter Ross's avatar
Peter Ross committed
120 121 122 123 124
static void hscroll(AVCodecContext *avctx)
{
    AnsiContext *s = avctx->priv_data;
    int i;

125
    if (s->y <= avctx->height - 2*s->font_height) {
Peter Ross's avatar
Peter Ross committed
126 127 128 129 130 131
        s->y += s->font_height;
        return;
    }

    i = 0;
    for (; i < avctx->height - s->font_height; i++)
132 133
        memcpy(s->frame->data[0] + i * s->frame->linesize[0],
               s->frame->data[0] + (i + s->font_height) * s->frame->linesize[0],
Peter Ross's avatar
Peter Ross committed
134 135
               avctx->width);
    for (; i < avctx->height; i++)
136
        memset(s->frame->data[0] + i * s->frame->linesize[0],
Peter Ross's avatar
Peter Ross committed
137 138 139 140 141 142 143 144
            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++)
145
        memset(s->frame->data[0] + (s->y + i)*s->frame->linesize[0] + xoffset,
Peter Ross's avatar
Peter Ross committed
146 147 148 149 150 151 152 153
            DEFAULT_BG_COLOR, xlength);
}

static void erase_screen(AVCodecContext *avctx)
{
    AnsiContext *s = avctx->priv_data;
    int i;
    for (i = 0; i < avctx->height; i++)
154
        memset(s->frame->data[0] + i * s->frame->linesize[0], DEFAULT_BG_COLOR, avctx->width);
Peter Ross's avatar
Peter Ross committed
155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174
    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;
175 176
    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);
Peter Ross's avatar
Peter Ross committed
177
    s->x += FONT_WIDTH;
178
    if (s->x > avctx->width - FONT_WIDTH) {
Peter Ross's avatar
Peter Ross committed
179 180 181 182 183 184 185
        s->x = 0;
        hscroll(avctx);
    }
}

/**
 * Execute ANSI escape code
186
 * @return 0 on success, negative on error
Peter Ross's avatar
Peter Ross committed
187 188 189 190
 */
static int execute_code(AVCodecContext * avctx, int c)
{
    AnsiContext *s = avctx->priv_data;
191
    int ret, i;
192 193
    int width  = avctx->width;
    int height = avctx->height;
194

Peter Ross's avatar
Peter Ross committed
195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212
    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;
213
    case 'h': //set screen mode
Peter Ross's avatar
Peter Ross committed
214 215 216 217 218
    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)
219
            s->font = avpriv_cga_font;
Peter Ross's avatar
Peter Ross committed
220 221 222 223 224
            s->font_height = 8;
            width  = 40<<3;
            height = 25<<3;
            break;
        case 2: case 3: //640x400 (25 rows)
225
            s->font = avpriv_vga16_font;
Peter Ross's avatar
Peter Ross committed
226 227 228 229 230
            s->font_height = 16;
            width  = 80<<3;
            height = 25<<4;
            break;
        case 6: case 14: //640x200 (25 rows)
231
            s->font = avpriv_cga_font;
Peter Ross's avatar
Peter Ross committed
232 233 234 235 236 237 238
            s->font_height = 8;
            width  = 80<<3;
            height = 25<<3;
            break;
        case 7: //set line wrapping
            break;
        case 15: case 16: //640x350 (43 rows)
239
            s->font = avpriv_cga_font;
Peter Ross's avatar
Peter Ross committed
240 241 242 243 244
            s->font_height = 8;
            width  = 80<<3;
            height = 43<<3;
            break;
        case 17: case 18: //640x480 (60 rows)
245
            s->font = avpriv_cga_font;
Peter Ross's avatar
Peter Ross committed
246 247 248 249 250
            s->font_height = 8;
            width  = 80<<3;
            height = 60<<4;
            break;
        default:
251
            avpriv_request_sample(avctx, "Unsupported screen mode");
Peter Ross's avatar
Peter Ross committed
252
        }
253 254
        s->x = av_clip(s->x, 0, width  - FONT_WIDTH);
        s->y = av_clip(s->y, 0, height - s->font_height);
Peter Ross's avatar
Peter Ross committed
255
        if (width != avctx->width || height != avctx->height) {
256
            av_frame_unref(s->frame);
257 258 259
            ret = ff_set_dimensions(avctx, width, height);
            if (ret < 0)
                return ret;
260 261
            if ((ret = ff_get_buffer(avctx, s->frame,
                                     AV_GET_BUFFER_FLAG_REF)) < 0)
Peter Ross's avatar
Peter Ross committed
262
                return ret;
263 264
            s->frame->pict_type           = AV_PICTURE_TYPE_I;
            s->frame->palette_has_changed = 1;
265
            set_palette((uint32_t *)s->frame->data[1]);
Peter Ross's avatar
Peter Ross committed
266 267 268 269 270 271 272 273 274 275
            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)
276 277
                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]);
Peter Ross's avatar
Peter Ross committed
278 279 280 281
            break;
        case 1:
            erase_line(avctx, 0, s->x);
            if (s->y > 0)
282
                memset(s->frame->data[0], DEFAULT_BG_COLOR, s->y * s->frame->linesize[0]);
Peter Ross's avatar
Peter Ross committed
283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312
            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);
Peter Ross's avatar
Peter Ross committed
313
            } else if (m >= 30 && m <= 37) {
Peter Ross's avatar
Peter Ross committed
314
                s->fg = ansi_to_cga[m - 30];
315
            } else if (m == 38 && i + 2 < FFMIN(s->nb_args, MAX_NB_ARGS) && s->args[i + 1] == 5 && s->args[i + 2] < 256) {
Peter Ross's avatar
Peter Ross committed
316 317 318
                int index = s->args[i + 2];
                s->fg = index < 16 ? ansi_to_cga[index] : index;
                i += 2;
Peter Ross's avatar
Peter Ross committed
319 320 321 322
            } 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];
323
            } else if (m == 48 && i + 2 < FFMIN(s->nb_args, MAX_NB_ARGS) && s->args[i + 1] == 5 && s->args[i + 2] < 256) {
Peter Ross's avatar
Peter Ross committed
324 325 326
                int index = s->args[i + 2];
                s->bg = index < 16 ? ansi_to_cga[index] : index;
                i += 2;
Peter Ross's avatar
Peter Ross committed
327 328 329
            } else if (m == 49) {
                s->fg = ansi_to_cga[DEFAULT_BG_COLOR];
            } else {
330
                avpriv_request_sample(avctx, "Unsupported rendition parameter");
Peter Ross's avatar
Peter Ross committed
331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346
            }
        }
        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:
347
        avpriv_request_sample(avctx, "Unknown escape code");
Peter Ross's avatar
Peter Ross committed
348 349
        break;
    }
350 351
    s->x = av_clip(s->x, 0, avctx->width  - FONT_WIDTH);
    s->y = av_clip(s->y, 0, avctx->height - s->font_height);
Peter Ross's avatar
Peter Ross committed
352 353 354 355
    return 0;
}

static int decode_frame(AVCodecContext *avctx,
356
                            void *data, int *got_frame,
Peter Ross's avatar
Peter Ross committed
357 358 359 360 361 362 363 364
                            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;

365
    if ((ret = ff_reget_buffer(avctx, s->frame)) < 0)
Peter Ross's avatar
Peter Ross committed
366
        return ret;
367
    if (!avctx->frame_number) {
368
        for (i=0; i<avctx->height; i++)
369
            memset(s->frame->data[0]+ i*s->frame->linesize[0], 0, avctx->width);
370
        memset(s->frame->data[1], 0, AVPALETTE_SIZE);
371 372
    }

373 374
    s->frame->pict_type           = AV_PICTURE_TYPE_I;
    s->frame->palette_has_changed = 1;
375
    set_palette((uint32_t *)s->frame->data[1]);
376 377 378 379
    if (!s->first_frame) {
        erase_screen(avctx);
        s->first_frame = 1;
    }
Peter Ross's avatar
Peter Ross committed
380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417

    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;
418
                s->args[0] = -1;
Peter Ross's avatar
Peter Ross committed
419 420 421 422 423 424 425 426 427 428
            } 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':
429
                if (s->nb_args < MAX_NB_ARGS && s->args[s->nb_args] < 6553)
430
                    s->args[s->nb_args] = FFMAX(s->args[s->nb_args], 0) * 10 + buf[0] - '0';
Peter Ross's avatar
Peter Ross committed
431 432 433 434 435 436 437 438 439 440 441 442 443 444 445
                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);
446
                if (s->nb_args < MAX_NB_ARGS && s->args[s->nb_args] >= 0)
Peter Ross's avatar
Peter Ross committed
447
                    s->nb_args++;
448 449
                if ((ret = execute_code(avctx, buf[0])) < 0)
                    return ret;
Peter Ross's avatar
Peter Ross committed
450 451 452 453 454 455 456 457 458 459 460 461
                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++;
    }

462
    *got_frame = 1;
463 464
    if ((ret = av_frame_ref(data, s->frame)) < 0)
        return ret;
Peter Ross's avatar
Peter Ross committed
465 466 467 468 469 470
    return buf_size;
}

static av_cold int decode_close(AVCodecContext *avctx)
{
    AnsiContext *s = avctx->priv_data;
471 472

    av_frame_free(&s->frame);
Peter Ross's avatar
Peter Ross committed
473 474 475
    return 0;
}

476
AVCodec ff_ansi_decoder = {
Peter Ross's avatar
Peter Ross committed
477
    .name           = "ansi",
478
    .long_name      = NULL_IF_CONFIG_SMALL("ASCII/ANSI art"),
479
    .type           = AVMEDIA_TYPE_VIDEO,
480
    .id             = AV_CODEC_ID_ANSI,
Peter Ross's avatar
Peter Ross committed
481 482 483 484
    .priv_data_size = sizeof(AnsiContext),
    .init           = decode_init,
    .close          = decode_close,
    .decode         = decode_frame,
485
    .capabilities   = AV_CODEC_CAP_DR1,
486
    .caps_internal  = FF_CODEC_CAP_INIT_THREADSAFE,
Peter Ross's avatar
Peter Ross committed
487
};