git.sesse.net Git - ffmpeg/blob - libavcodec/ccaption_dec.c

   1 /*
   2  * Closed Caption Decoding
   3  * Copyright (c) 2015 Anshul Maheshwari
   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 #include "avcodec.h"
  23 #include "ass.h"
  24 #include "libavutil/opt.h"
  25
  26 #define SCREEN_ROWS 15
  27 #define SCREEN_COLUMNS 32
  28
  29 #define SET_FLAG(var, val)   ( (var) |=   ( 1 << (val)) )
  30 #define UNSET_FLAG(var, val) ( (var) &=  ~( 1 << (val)) )
  31 #define CHECK_FLAG(var, val) ( (var) &    ( 1 << (val)) )
  32
  33 static const AVRational ms_tb = {1, 1000};
  34
  35 enum cc_mode {
  36     CCMODE_POPON,
  37     CCMODE_PAINTON,
  38     CCMODE_ROLLUP,
  39     CCMODE_TEXT,
  40 };
  41
  42 enum cc_color_code {
  43     CCCOL_WHITE,
  44     CCCOL_GREEN,
  45     CCCOL_BLUE,
  46     CCCOL_CYAN,
  47     CCCOL_RED,
  48     CCCOL_YELLOW,
  49     CCCOL_MAGENTA,
  50     CCCOL_USERDEFINED,
  51     CCCOL_BLACK,
  52     CCCOL_TRANSPARENT,
  53 };
  54
  55 enum cc_font {
  56     CCFONT_REGULAR,
  57     CCFONT_ITALICS,
  58     CCFONT_UNDERLINED,
  59     CCFONT_UNDERLINED_ITALICS,
  60 };
  61
  62 enum cc_charset {
  63     CCSET_BASIC_AMERICAN,
  64     CCSET_SPECIAL_AMERICAN,
  65     CCSET_EXTENDED_SPANISH_FRENCH_MISC,
  66     CCSET_EXTENDED_PORTUGUESE_GERMAN_DANISH,
  67 };
  68
  69 static const char *charset_overrides[4][128] =
  70 {
  71     [CCSET_BASIC_AMERICAN] = {
  72         [0x27] = "\u2019",
  73         [0x2a] = "\u00e1",
  74         [0x5c] = "\u00e9",
  75         [0x5e] = "\u00ed",
  76         [0x5f] = "\u00f3",
  77         [0x60] = "\u00fa",
  78         [0x7b] = "\u00e7",
  79         [0x7c] = "\u00f7",
  80         [0x7d] = "\u00d1",
  81         [0x7e] = "\u00f1",
  82         [0x7f] = "\u2588"
  83     },
  84     [CCSET_SPECIAL_AMERICAN] = {
  85         [0x30] = "\u00ae",
  86         [0x31] = "\u00b0",
  87         [0x32] = "\u00bd",
  88         [0x33] = "\u00bf",
  89         [0x34] = "\u2122",
  90         [0x35] = "\u00a2",
  91         [0x36] = "\u00a3",
  92         [0x37] = "\u266a",
  93         [0x38] = "\u00e0",
  94         [0x39] = "\u00A0",
  95         [0x3a] = "\u00e8",
  96         [0x3b] = "\u00e2",
  97         [0x3c] = "\u00ea",
  98         [0x3d] = "\u00ee",
  99         [0x3e] = "\u00f4",
 100         [0x3f] = "\u00fb",
 101     },
 102     [CCSET_EXTENDED_SPANISH_FRENCH_MISC] = {
 103         [0x20] = "\u00c1",
 104         [0x21] = "\u00c9",
 105         [0x22] = "\u00d3",
 106         [0x23] = "\u00da",
 107         [0x24] = "\u00dc",
 108         [0x25] = "\u00fc",
 109         [0x26] = "\u00b4",
 110         [0x27] = "\u00a1",
 111         [0x28] = "*",
 112         [0x29] = "\u2018",
 113         [0x2a] = "-",
 114         [0x2b] = "\u00a9",
 115         [0x2c] = "\u2120",
 116         [0x2d] = "\u00b7",
 117         [0x2e] = "\u201c",
 118         [0x2f] = "\u201d",
 119         [0x30] = "\u00c0",
 120         [0x31] = "\u00c2",
 121         [0x32] = "\u00c7",
 122         [0x33] = "\u00c8",
 123         [0x34] = "\u00ca",
 124         [0x35] = "\u00cb",
 125         [0x36] = "\u00eb",
 126         [0x37] = "\u00ce",
 127         [0x38] = "\u00cf",
 128         [0x39] = "\u00ef",
 129         [0x3a] = "\u00d4",
 130         [0x3b] = "\u00d9",
 131         [0x3c] = "\u00f9",
 132         [0x3d] = "\u00db",
 133         [0x3e] = "\u00ab",
 134         [0x3f] = "\u00bb",
 135     },
 136     [CCSET_EXTENDED_PORTUGUESE_GERMAN_DANISH] = {
 137         [0x20] = "\u00c3",
 138         [0x21] = "\u00e3",
 139         [0x22] = "\u00cd",
 140         [0x23] = "\u00cc",
 141         [0x24] = "\u00ec",
 142         [0x25] = "\u00d2",
 143         [0x26] = "\u00f2",
 144         [0x27] = "\u00d5",
 145         [0x28] = "\u00f5",
 146         [0x29] = "{",
 147         [0x2a] = "}",
 148         [0x2b] = "\\",
 149         [0x2c] = "^",
 150         [0x2d] = "_",
 151         [0x2e] = "|",
 152         [0x2f] = "~",
 153         [0x30] = "\u00c4",
 154         [0x31] = "\u00e4",
 155         [0x32] = "\u00d6",
 156         [0x33] = "\u00f6",
 157         [0x34] = "\u00df",
 158         [0x35] = "\u00a5",
 159         [0x36] = "\u00a4",
 160         [0x37] = "\u00a6",
 161         [0x38] = "\u00c5",
 162         [0x39] = "\u00e5",
 163         [0x3a] = "\u00d8",
 164         [0x3b] = "\u00f8",
 165         [0x3c] = "\u250c",
 166         [0x3d] = "\u2510",
 167         [0x3e] = "\u2514",
 168         [0x3f] = "\u2518",
 169     },
 170 };
 171
 172 static const unsigned char pac2_attribs[32][3] = // Color, font, ident
 173 {
 174     { CCCOL_WHITE,   CCFONT_REGULAR,            0 },  // 0x40 || 0x60
 175     { CCCOL_WHITE,   CCFONT_UNDERLINED,         0 },  // 0x41 || 0x61
 176     { CCCOL_GREEN,   CCFONT_REGULAR,            0 },  // 0x42 || 0x62
 177     { CCCOL_GREEN,   CCFONT_UNDERLINED,         0 },  // 0x43 || 0x63
 178     { CCCOL_BLUE,    CCFONT_REGULAR,            0 },  // 0x44 || 0x64
 179     { CCCOL_BLUE,    CCFONT_UNDERLINED,         0 },  // 0x45 || 0x65
 180     { CCCOL_CYAN,    CCFONT_REGULAR,            0 },  // 0x46 || 0x66
 181     { CCCOL_CYAN,    CCFONT_UNDERLINED,         0 },  // 0x47 || 0x67
 182     { CCCOL_RED,     CCFONT_REGULAR,            0 },  // 0x48 || 0x68
 183     { CCCOL_RED,     CCFONT_UNDERLINED,         0 },  // 0x49 || 0x69
 184     { CCCOL_YELLOW,  CCFONT_REGULAR,            0 },  // 0x4a || 0x6a
 185     { CCCOL_YELLOW,  CCFONT_UNDERLINED,         0 },  // 0x4b || 0x6b
 186     { CCCOL_MAGENTA, CCFONT_REGULAR,            0 },  // 0x4c || 0x6c
 187     { CCCOL_MAGENTA, CCFONT_UNDERLINED,         0 },  // 0x4d || 0x6d
 188     { CCCOL_WHITE,   CCFONT_ITALICS,            0 },  // 0x4e || 0x6e
 189     { CCCOL_WHITE,   CCFONT_UNDERLINED_ITALICS, 0 },  // 0x4f || 0x6f
 190     { CCCOL_WHITE,   CCFONT_REGULAR,            0 },  // 0x50 || 0x70
 191     { CCCOL_WHITE,   CCFONT_UNDERLINED,         0 },  // 0x51 || 0x71
 192     { CCCOL_WHITE,   CCFONT_REGULAR,            4 },  // 0x52 || 0x72
 193     { CCCOL_WHITE,   CCFONT_UNDERLINED,         4 },  // 0x53 || 0x73
 194     { CCCOL_WHITE,   CCFONT_REGULAR,            8 },  // 0x54 || 0x74
 195     { CCCOL_WHITE,   CCFONT_UNDERLINED,         8 },  // 0x55 || 0x75
 196     { CCCOL_WHITE,   CCFONT_REGULAR,           12 },  // 0x56 || 0x76
 197     { CCCOL_WHITE,   CCFONT_UNDERLINED,        12 },  // 0x57 || 0x77
 198     { CCCOL_WHITE,   CCFONT_REGULAR,           16 },  // 0x58 || 0x78
 199     { CCCOL_WHITE,   CCFONT_UNDERLINED,        16 },  // 0x59 || 0x79
 200     { CCCOL_WHITE,   CCFONT_REGULAR,           20 },  // 0x5a || 0x7a
 201     { CCCOL_WHITE,   CCFONT_UNDERLINED,        20 },  // 0x5b || 0x7b
 202     { CCCOL_WHITE,   CCFONT_REGULAR,           24 },  // 0x5c || 0x7c
 203     { CCCOL_WHITE,   CCFONT_UNDERLINED,        24 },  // 0x5d || 0x7d
 204     { CCCOL_WHITE,   CCFONT_REGULAR,           28 },  // 0x5e || 0x7e
 205     { CCCOL_WHITE,   CCFONT_UNDERLINED,        28 }   // 0x5f || 0x7f
 206     /* total 32 entries */
 207 };
 208
 209 struct Screen {
 210     /* +1 is used to compensate null character of string */
 211     uint8_t characters[SCREEN_ROWS+1][SCREEN_COLUMNS+1];
 212     uint8_t charsets[SCREEN_ROWS+1][SCREEN_COLUMNS+1];
 213     uint8_t colors[SCREEN_ROWS+1][SCREEN_COLUMNS+1];
 214     uint8_t fonts[SCREEN_ROWS+1][SCREEN_COLUMNS+1];
 215     /*
 216      * Bitmask of used rows; if a bit is not set, the
 217      * corresponding row is not used.
 218      * for setting row 1  use row | (1 << 0)
 219      * for setting row 15 use row | (1 << 14)
 220      */
 221     int16_t row_used;
 222 };
 223
 224 typedef struct CCaptionSubContext {
 225     AVClass *class;
 226     int real_time;
 227     int data_field;
 228     struct Screen screen[2];
 229     int active_screen;
 230     uint8_t cursor_row;
 231     uint8_t cursor_column;
 232     uint8_t cursor_color;
 233     uint8_t cursor_font;
 234     uint8_t cursor_charset;
 235     AVBPrint buffer[2];
 236     int buffer_index;
 237     int buffer_changed;
 238     int rollup;
 239     enum cc_mode mode;
 240     int64_t buffer_time[2];
 241     int screen_touched;
 242     int64_t last_real_time;
 243     char prev_cmd[2];
 244     int readorder;
 245 } CCaptionSubContext;
 246
 247 static av_cold int init_decoder(AVCodecContext *avctx)
 248 {
 249     int ret;
 250     CCaptionSubContext *ctx = avctx->priv_data;
 251
 252     av_bprint_init(&ctx->buffer[0], 0, AV_BPRINT_SIZE_UNLIMITED);
 253     av_bprint_init(&ctx->buffer[1], 0, AV_BPRINT_SIZE_UNLIMITED);
 254     /* taking by default roll up to 2 */
 255     ctx->mode = CCMODE_ROLLUP;
 256     ctx->rollup = 2;
 257     ctx->cursor_row = 10;
 258     ret = ff_ass_subtitle_header(avctx, "Monospace",
 259                                  ASS_DEFAULT_FONT_SIZE,
 260                                  ASS_DEFAULT_COLOR,
 261                                  ASS_DEFAULT_BACK_COLOR,
 262                                  ASS_DEFAULT_BOLD,
 263                                  ASS_DEFAULT_ITALIC,
 264                                  ASS_DEFAULT_UNDERLINE,
 265                                  3,
 266                                  ASS_DEFAULT_ALIGNMENT);
 267     if (ret < 0) {
 268         return ret;
 269     }
 270
 271     return ret;
 272 }
 273
 274 static av_cold int close_decoder(AVCodecContext *avctx)
 275 {
 276     CCaptionSubContext *ctx = avctx->priv_data;
 277     av_bprint_finalize(&ctx->buffer[0], NULL);
 278     av_bprint_finalize(&ctx->buffer[1], NULL);
 279     return 0;
 280 }
 281
 282 static void flush_decoder(AVCodecContext *avctx)
 283 {
 284     CCaptionSubContext *ctx = avctx->priv_data;
 285     ctx->screen[0].row_used = 0;
 286     ctx->screen[1].row_used = 0;
 287     ctx->prev_cmd[0] = 0;
 288     ctx->prev_cmd[1] = 0;
 289     ctx->mode = CCMODE_ROLLUP;
 290     ctx->rollup = 2;
 291     ctx->cursor_row = 10;
 292     ctx->cursor_column = 0;
 293     ctx->cursor_font = 0;
 294     ctx->cursor_color = 0;
 295     ctx->cursor_charset = 0;
 296     ctx->active_screen = 0;
 297     ctx->last_real_time = 0;
 298     ctx->screen_touched = 0;
 299     ctx->buffer_changed = 0;
 300     if (!(avctx->flags2 & AV_CODEC_FLAG2_RO_FLUSH_NOOP))
 301         ctx->readorder = 0;
 302     av_bprint_clear(&ctx->buffer[0]);
 303     av_bprint_clear(&ctx->buffer[1]);
 304 }
 305
 306 /**
 307  * @param ctx closed caption context just to print log
 308  */
 309 static void write_char(CCaptionSubContext *ctx, struct Screen *screen, char ch)
 310 {
 311     uint8_t col = ctx->cursor_column;
 312     char *row = screen->characters[ctx->cursor_row];
 313     char *font = screen->fonts[ctx->cursor_row];
 314     char *color = screen->colors[ctx->cursor_row];
 315     char *charset = screen->charsets[ctx->cursor_row];
 316
 317     if (col < SCREEN_COLUMNS) {
 318         row[col] = ch;
 319         font[col] = ctx->cursor_font;
 320         color[col] = ctx->cursor_color;
 321         charset[col] = ctx->cursor_charset;
 322         ctx->cursor_charset = CCSET_BASIC_AMERICAN;
 323         if (ch) ctx->cursor_column++;
 324         return;
 325     }
 326     /* We have extra space at end only for null character */
 327     else if (col == SCREEN_COLUMNS && ch == 0) {
 328         row[col] = ch;
 329         return;
 330     }
 331     else {
 332         av_log(ctx, AV_LOG_WARNING, "Data Ignored since exceeding screen width\n");
 333         return;
 334     }
 335 }
 336
 337 /**
 338  * This function after validating parity bit, also remove it from data pair.
 339  * The first byte doesn't pass parity, we replace it with a solid blank
 340  * and process the pair.
 341  * If the second byte doesn't pass parity, it returns INVALIDDATA
 342  * user can ignore the whole pair and pass the other pair.
 343  */
 344 static int validate_cc_data_pair(uint8_t *cc_data_pair)
 345 {
 346     uint8_t cc_valid = (*cc_data_pair & 4) >>2;
 347     uint8_t cc_type = *cc_data_pair & 3;
 348
 349     if (!cc_valid)
 350         return AVERROR_INVALIDDATA;
 351
 352     // if EIA-608 data then verify parity.
 353     if (cc_type==0 || cc_type==1) {
 354         if (!av_parity(cc_data_pair[2])) {
 355             return AVERROR_INVALIDDATA;
 356         }
 357         if (!av_parity(cc_data_pair[1])) {
 358             cc_data_pair[1]=0x7F;
 359         }
 360     }
 361
 362     //Skip non-data
 363     if ((cc_data_pair[0] == 0xFA || cc_data_pair[0] == 0xFC || cc_data_pair[0] == 0xFD)
 364          && (cc_data_pair[1] & 0x7F) == 0 && (cc_data_pair[2] & 0x7F) == 0)
 365         return AVERROR_PATCHWELCOME;
 366
 367     //skip 708 data
 368     if (cc_type == 3 || cc_type == 2)
 369         return AVERROR_PATCHWELCOME;
 370
 371     return 0;
 372 }
 373
 374 static struct Screen *get_writing_screen(CCaptionSubContext *ctx)
 375 {
 376     switch (ctx->mode) {
 377     case CCMODE_POPON:
 378         // use Inactive screen
 379         return ctx->screen + !ctx->active_screen;
 380     case CCMODE_PAINTON:
 381     case CCMODE_ROLLUP:
 382     case CCMODE_TEXT:
 383         // use active screen
 384         return ctx->screen + ctx->active_screen;
 385     }
 386     /* It was never an option */
 387     return NULL;
 388 }
 389
 390 static void roll_up(CCaptionSubContext *ctx)
 391 {
 392     struct Screen *screen;
 393     int i, keep_lines;
 394
 395     if (ctx->mode == CCMODE_TEXT)
 396         return;
 397
 398     screen = get_writing_screen(ctx);
 399
 400     /* +1 signify cursor_row starts from 0
 401      * Can't keep lines less then row cursor pos
 402      */
 403     keep_lines = FFMIN(ctx->cursor_row + 1, ctx->rollup);
 404
 405     for (i = 0; i < SCREEN_ROWS; i++) {
 406         if (i > ctx->cursor_row - keep_lines && i <= ctx->cursor_row)
 407             continue;
 408         UNSET_FLAG(screen->row_used, i);
 409     }
 410
 411     for (i = 0; i < keep_lines && screen->row_used; i++) {
 412         const int i_row = ctx->cursor_row - keep_lines + i + 1;
 413
 414         memcpy(screen->characters[i_row], screen->characters[i_row+1], SCREEN_COLUMNS);
 415         memcpy(screen->colors[i_row], screen->colors[i_row+1], SCREEN_COLUMNS);
 416         memcpy(screen->fonts[i_row], screen->fonts[i_row+1], SCREEN_COLUMNS);
 417         memcpy(screen->charsets[i_row], screen->charsets[i_row+1], SCREEN_COLUMNS);
 418         if (CHECK_FLAG(screen->row_used, i_row + 1))
 419             SET_FLAG(screen->row_used, i_row);
 420     }
 421
 422     UNSET_FLAG(screen->row_used, ctx->cursor_row);
 423 }
 424
 425 static int capture_screen(CCaptionSubContext *ctx)
 426 {
 427     int i, j, tab = 0;
 428     struct Screen *screen = ctx->screen + ctx->active_screen;
 429     enum cc_font prev_font = CCFONT_REGULAR;
 430     enum cc_color_code prev_color = CCCOL_WHITE;
 431     const int bidx = ctx->buffer_index;
 432
 433     av_bprint_clear(&ctx->buffer[bidx]);
 434
 435     for (i = 0; screen->row_used && i < SCREEN_ROWS; i++)
 436     {
 437         if (CHECK_FLAG(screen->row_used, i)) {
 438             const char *row = screen->characters[i];
 439             const char *charset = screen->charsets[i];
 440             j = 0;
 441             while (row[j] == ' ' && charset[j] == CCSET_BASIC_AMERICAN)
 442                 j++;
 443             if (!tab || j < tab)
 444                 tab = j;
 445         }
 446     }
 447
 448     for (i = 0; screen->row_used && i < SCREEN_ROWS; i++)
 449     {
 450         if (CHECK_FLAG(screen->row_used, i)) {
 451             const char *row = screen->characters[i];
 452             const char *font = screen->fonts[i];
 453             const char *color = screen->colors[i];
 454             const char *charset = screen->charsets[i];
 455             const char *override;
 456             int x, y, seen_char = 0;
 457             j = 0;
 458
 459             /* skip leading space */
 460             while (row[j] == ' ' && charset[j] == CCSET_BASIC_AMERICAN && j < tab)
 461                 j++;
 462
 463             x = ASS_DEFAULT_PLAYRESX * (0.1 + 0.0250 * j);
 464             y = ASS_DEFAULT_PLAYRESY * (0.1 + 0.0533 * i);
 465             av_bprintf(&ctx->buffer[bidx], "{\\an7}{\\pos(%d,%d)}", x, y);
 466
 467             for (; j < SCREEN_COLUMNS; j++) {
 468                 const char *e_tag = "", *s_tag = "", *c_tag = "";
 469
 470                 if (row[j] == 0)
 471                     break;
 472
 473                 if (prev_font != font[j]) {
 474                     switch (prev_font) {
 475                     case CCFONT_ITALICS:
 476                         e_tag = "{\\i0}";
 477                         break;
 478                     case CCFONT_UNDERLINED:
 479                         e_tag = "{\\u0}";
 480                         break;
 481                     case CCFONT_UNDERLINED_ITALICS:
 482                         e_tag = "{\\u0}{\\i0}";
 483                         break;
 484                     }
 485                     switch (font[j]) {
 486                     case CCFONT_ITALICS:
 487                         s_tag = "{\\i1}";
 488                         break;
 489                     case CCFONT_UNDERLINED:
 490                         s_tag = "{\\u1}";
 491                         break;
 492                     case CCFONT_UNDERLINED_ITALICS:
 493                         s_tag = "{\\u1}{\\i1}";
 494                         break;
 495                     }
 496                 }
 497                 if (prev_color != color[j]) {
 498                     switch (color[j]) {
 499                     case CCCOL_WHITE:
 500                         c_tag = "{\\c&HFFFFFF&}";
 501                         break;
 502                     case CCCOL_GREEN:
 503                         c_tag = "{\\c&H00FF00&}";
 504                         break;
 505                     case CCCOL_BLUE:
 506                         c_tag = "{\\c&HFF0000&}";
 507                         break;
 508                     case CCCOL_CYAN:
 509                         c_tag = "{\\c&HFFFF00&}";
 510                         break;
 511                     case CCCOL_RED:
 512                         c_tag = "{\\c&H0000FF&}";
 513                         break;
 514                     case CCCOL_YELLOW:
 515                         c_tag = "{\\c&H00FFFF&}";
 516                         break;
 517                     case CCCOL_MAGENTA:
 518                         c_tag = "{\\c&HFF00FF&}";
 519                         break;
 520                     }
 521                 }
 522
 523                 prev_font = font[j];
 524                 prev_color = color[j];
 525                 override = charset_overrides[(int)charset[j]][(int)row[j]];
 526                 if (override) {
 527                     av_bprintf(&ctx->buffer[bidx], "%s%s%s%s", e_tag, s_tag, c_tag, override);
 528                     seen_char = 1;
 529                 } else if (row[j] == ' ' && !seen_char) {
 530                     av_bprintf(&ctx->buffer[bidx], "%s%s%s\\h", e_tag, s_tag, c_tag);
 531                 } else {
 532                     av_bprintf(&ctx->buffer[bidx], "%s%s%s%c", e_tag, s_tag, c_tag, row[j]);
 533                     seen_char = 1;
 534                 }
 535
 536             }
 537             av_bprintf(&ctx->buffer[bidx], "\\N");
 538         }
 539     }
 540     if (!av_bprint_is_complete(&ctx->buffer[bidx]))
 541         return AVERROR(ENOMEM);
 542     if (screen->row_used && ctx->buffer[bidx].len >= 2) {
 543         ctx->buffer[bidx].len -= 2;
 544         ctx->buffer[bidx].str[ctx->buffer[bidx].len] = 0;
 545     }
 546     ctx->buffer_changed = 1;
 547     return 0;
 548 }
 549
 550 static void update_time(CCaptionSubContext *ctx, int64_t pts)
 551 {
 552     ctx->buffer_time[0] = ctx->buffer_time[1];
 553     ctx->buffer_time[1] = pts;
 554 }
 555
 556 static void handle_textattr(CCaptionSubContext *ctx, uint8_t hi, uint8_t lo)
 557 {
 558     int i = lo - 0x20;
 559     struct Screen *screen = get_writing_screen(ctx);
 560
 561     if (i >= 32)
 562         return;
 563
 564     ctx->cursor_color = pac2_attribs[i][0];
 565     ctx->cursor_font = pac2_attribs[i][1];
 566
 567     SET_FLAG(screen->row_used, ctx->cursor_row);
 568     write_char(ctx, screen, ' ');
 569 }
 570
 571 static void handle_pac(CCaptionSubContext *ctx, uint8_t hi, uint8_t lo)
 572 {
 573     static const int8_t row_map[] = {
 574         11, -1, 1, 2, 3, 4, 12, 13, 14, 15, 5, 6, 7, 8, 9, 10
 575     };
 576     const int index = ( (hi<<1) & 0x0e) | ( (lo>>5) & 0x01 );
 577     struct Screen *screen = get_writing_screen(ctx);
 578     int indent, i;
 579
 580     if (row_map[index] <= 0) {
 581         av_log(ctx, AV_LOG_DEBUG, "Invalid pac index encountered\n");
 582         return;
 583     }
 584
 585     lo &= 0x1f;
 586
 587     ctx->cursor_row = row_map[index] - 1;
 588     ctx->cursor_color =  pac2_attribs[lo][0];
 589     ctx->cursor_font = pac2_attribs[lo][1];
 590     ctx->cursor_charset = CCSET_BASIC_AMERICAN;
 591     ctx->cursor_column = 0;
 592     indent = pac2_attribs[lo][2];
 593     for (i = 0; i < indent; i++) {
 594         write_char(ctx, screen, ' ');
 595     }
 596 }
 597
 598 static int handle_edm(CCaptionSubContext *ctx)
 599 {
 600     struct Screen *screen = ctx->screen + ctx->active_screen;
 601     int ret;
 602
 603     // In buffered mode, keep writing to screen until it is wiped.
 604     // Before wiping the display, capture contents to emit subtitle.
 605     if (!ctx->real_time)
 606         ret = capture_screen(ctx);
 607
 608     screen->row_used = 0;
 609
 610     // In realtime mode, emit an empty caption so the last one doesn't
 611     // stay on the screen.
 612     if (ctx->real_time)
 613         ret = capture_screen(ctx);
 614
 615     return ret;
 616 }
 617
 618 static int handle_eoc(CCaptionSubContext *ctx)
 619 {
 620     int ret;
 621
 622     ctx->active_screen = !ctx->active_screen;
 623
 624     // In buffered mode, we wait til the *next* EOC and
 625     // capture what was already on the screen since the last EOC.
 626     if (!ctx->real_time)
 627         ret = handle_edm(ctx);
 628
 629     ctx->cursor_column = 0;
 630
 631     // In realtime mode, we display the buffered contents (after
 632     // flipping the buffer to active above) as soon as EOC arrives.
 633     if (ctx->real_time)
 634         ret = capture_screen(ctx);
 635
 636     return ret;
 637 }
 638
 639 static void handle_delete_end_of_row(CCaptionSubContext *ctx)
 640 {
 641     struct Screen *screen = get_writing_screen(ctx);
 642     write_char(ctx, screen, 0);
 643 }
 644
 645 static void handle_char(CCaptionSubContext *ctx, char hi, char lo)
 646 {
 647     struct Screen *screen = get_writing_screen(ctx);
 648
 649     SET_FLAG(screen->row_used, ctx->cursor_row);
 650
 651     switch (hi) {
 652       case 0x11:
 653         ctx->cursor_charset = CCSET_SPECIAL_AMERICAN;
 654         break;
 655       case 0x12:
 656         if (ctx->cursor_column > 0)
 657             ctx->cursor_column -= 1;
 658         ctx->cursor_charset = CCSET_EXTENDED_SPANISH_FRENCH_MISC;
 659         break;
 660       case 0x13:
 661         if (ctx->cursor_column > 0)
 662             ctx->cursor_column -= 1;
 663         ctx->cursor_charset = CCSET_EXTENDED_PORTUGUESE_GERMAN_DANISH;
 664         break;
 665       default:
 666         ctx->cursor_charset = CCSET_BASIC_AMERICAN;
 667         write_char(ctx, screen, hi);
 668         break;
 669     }
 670
 671     if (lo) {
 672         write_char(ctx, screen, lo);
 673     }
 674     write_char(ctx, screen, 0);
 675
 676     if (ctx->mode != CCMODE_POPON)
 677         ctx->screen_touched = 1;
 678
 679     if (lo)
 680        ff_dlog(ctx, "(%c,%c)\n", hi, lo);
 681     else
 682        ff_dlog(ctx, "(%c)\n", hi);
 683 }
 684
 685 static int process_cc608(CCaptionSubContext *ctx, uint8_t hi, uint8_t lo)
 686 {
 687     int ret = 0;
 688
 689     if (hi == ctx->prev_cmd[0] && lo == ctx->prev_cmd[1]) {
 690         return 0;
 691     }
 692
 693     /* set prev command */
 694     ctx->prev_cmd[0] = hi;
 695     ctx->prev_cmd[1] = lo;
 696
 697     if ( (hi == 0x10 && (lo >= 0x40 && lo <= 0x5f)) ||
 698        ( (hi >= 0x11 && hi <= 0x17) && (lo >= 0x40 && lo <= 0x7f) ) ) {
 699         handle_pac(ctx, hi, lo);
 700     } else if ( ( hi == 0x11 && lo >= 0x20 && lo <= 0x2f ) ||
 701                 ( hi == 0x17 && lo >= 0x2e && lo <= 0x2f) ) {
 702         handle_textattr(ctx, hi, lo);
 703     } else if (hi == 0x14 || hi == 0x15 || hi == 0x1c) {
 704         switch (lo) {
 705         case 0x20:
 706             /* resume caption loading */
 707             ctx->mode = CCMODE_POPON;
 708             break;
 709         case 0x24:
 710             handle_delete_end_of_row(ctx);
 711             break;
 712         case 0x25:
 713         case 0x26:
 714         case 0x27:
 715             ctx->rollup = lo - 0x23;
 716             ctx->mode = CCMODE_ROLLUP;
 717             break;
 718         case 0x29:
 719             /* resume direct captioning */
 720             ctx->mode = CCMODE_PAINTON;
 721             break;
 722         case 0x2b:
 723             /* resume text display */
 724             ctx->mode = CCMODE_TEXT;
 725             break;
 726         case 0x2c:
 727             /* erase display memory */
 728             handle_edm(ctx);
 729             break;
 730         case 0x2d:
 731             /* carriage return */
 732             ff_dlog(ctx, "carriage return\n");
 733             if (!ctx->real_time)
 734                 ret = capture_screen(ctx);
 735             roll_up(ctx);
 736             ctx->cursor_column = 0;
 737             break;
 738         case 0x2e:
 739             /* erase buffered (non displayed) memory */
 740             // Only in realtime mode. In buffered mode, we re-use the inactive screen
 741             // for our own buffering.
 742             if (ctx->real_time) {
 743                 struct Screen *screen = ctx->screen + !ctx->active_screen;
 744                 screen->row_used = 0;
 745             }
 746             break;
 747         case 0x2f:
 748             /* end of caption */
 749             ff_dlog(ctx, "handle_eoc\n");
 750             ret = handle_eoc(ctx);
 751             break;
 752         default:
 753             ff_dlog(ctx, "Unknown command 0x%hhx 0x%hhx\n", hi, lo);
 754             break;
 755         }
 756     } else if (hi >= 0x11 && hi <= 0x13) {
 757         /* Special characters */
 758         handle_char(ctx, hi, lo);
 759     } else if (hi >= 0x20) {
 760         /* Standard characters (always in pairs) */
 761         handle_char(ctx, hi, lo);
 762         ctx->prev_cmd[0] = ctx->prev_cmd[1] = 0;
 763     } else if (hi == 0x17 && lo >= 0x21 && lo <= 0x23) {
 764         int i;
 765         /* Tab offsets (spacing) */
 766         for (i = 0; i < lo - 0x20; i++) {
 767             handle_char(ctx, ' ', 0);
 768         }
 769     } else {
 770         /* Ignoring all other non data code */
 771         ff_dlog(ctx, "Unknown command 0x%hhx 0x%hhx\n", hi, lo);
 772     }
 773
 774     return ret;
 775 }
 776
 777 static int decode(AVCodecContext *avctx, void *data, int *got_sub, AVPacket *avpkt)
 778 {
 779     CCaptionSubContext *ctx = avctx->priv_data;
 780     AVSubtitle *sub = data;
 781     int64_t in_time = sub->pts;
 782     int64_t start_time;
 783     int64_t end_time;
 784     int bidx = ctx->buffer_index;
 785     uint8_t *bptr = NULL;
 786     int len = avpkt->size;
 787     int ret = 0;
 788     int i;
 789
 790     bptr = avpkt->data;
 791
 792     for (i = 0; i < len; i += 3) {
 793         uint8_t cc_type = bptr[i] & 1;
 794
 795         if (ctx->data_field < 0)
 796             ctx->data_field = cc_type;
 797
 798         if (validate_cc_data_pair(bptr + i))
 799             continue;
 800
 801         if (cc_type != ctx->data_field)
 802             continue;
 803
 804         ret = process_cc608(ctx, bptr[i + 1] & 0x7f, bptr[i + 2] & 0x7f);
 805         if (ret < 0)
 806             return ret;
 807
 808         if (!ctx->buffer_changed)
 809             continue;
 810         ctx->buffer_changed = 0;
 811
 812         if (!ctx->real_time && ctx->mode == CCMODE_POPON)
 813             ctx->buffer_index = bidx = !ctx->buffer_index;
 814
 815         update_time(ctx, in_time);
 816
 817         if (ctx->buffer[bidx].str[0] || ctx->real_time) {
 818             ff_dlog(ctx, "cdp writing data (%s)\n", ctx->buffer[bidx].str);
 819             start_time = ctx->buffer_time[0];
 820             sub->pts = start_time;
 821             end_time = ctx->buffer_time[1];
 822             if (!ctx->real_time)
 823                 sub->end_display_time = av_rescale_q(end_time - start_time,
 824                                                      AV_TIME_BASE_Q, ms_tb);
 825             else
 826                 sub->end_display_time = -1;
 827             ret = ff_ass_add_rect(sub, ctx->buffer[bidx].str, ctx->readorder++, 0, NULL, NULL);
 828             if (ret < 0)
 829                 return ret;
 830             ctx->last_real_time = sub->pts;
 831             ctx->screen_touched = 0;
 832         }
 833     }
 834
 835     if (!bptr && !ctx->real_time && ctx->buffer[!ctx->buffer_index].str[0]) {
 836         bidx = !ctx->buffer_index;
 837         ret = ff_ass_add_rect(sub, ctx->buffer[bidx].str, ctx->readorder++, 0, NULL, NULL);
 838         if (ret < 0)
 839             return ret;
 840         sub->pts = ctx->buffer_time[1];
 841         sub->end_display_time = av_rescale_q(ctx->buffer_time[1] - ctx->buffer_time[0],
 842                                              AV_TIME_BASE_Q, ms_tb);
 843         if (sub->end_display_time == 0)
 844             sub->end_display_time = ctx->buffer[bidx].len * 20;
 845     }
 846
 847     if (ctx->real_time && ctx->screen_touched &&
 848         sub->pts > ctx->last_real_time + av_rescale_q(200, ms_tb, AV_TIME_BASE_Q)) {
 849         ctx->last_real_time = sub->pts;
 850         ctx->screen_touched = 0;
 851
 852         capture_screen(ctx);
 853         ctx->buffer_changed = 0;
 854
 855         ret = ff_ass_add_rect(sub, ctx->buffer[bidx].str, ctx->readorder++, 0, NULL, NULL);
 856         if (ret < 0)
 857             return ret;
 858         sub->end_display_time = -1;
 859     }
 860
 861     *got_sub = sub->num_rects > 0;
 862     return ret;
 863 }
 864
 865 #define OFFSET(x) offsetof(CCaptionSubContext, x)
 866 #define SD AV_OPT_FLAG_SUBTITLE_PARAM | AV_OPT_FLAG_DECODING_PARAM
 867 static const AVOption options[] = {
 868     { "real_time", "emit subtitle events as they are decoded for real-time display", OFFSET(real_time), AV_OPT_TYPE_BOOL, { .i64 = 0 }, 0, 1, SD },
 869     { "data_field", "select data field", OFFSET(data_field), AV_OPT_TYPE_INT, { .i64 = -1 }, -1, 1, SD, "data_field" },
 870     { "auto",   "pick first one that appears", 0, AV_OPT_TYPE_CONST, { .i64 =-1 }, 0, 0, SD, "data_field" },
 871     { "first",  NULL, 0, AV_OPT_TYPE_CONST, { .i64 = 0 }, 0, 0, SD, "data_field" },
 872     { "second", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = 1 }, 0, 0, SD, "data_field" },
 873     {NULL}
 874 };
 875
 876 static const AVClass ccaption_dec_class = {
 877     .class_name = "Closed caption Decoder",
 878     .item_name  = av_default_item_name,
 879     .option     = options,
 880     .version    = LIBAVUTIL_VERSION_INT,
 881 };
 882
 883 AVCodec ff_ccaption_decoder = {
 884     .name           = "cc_dec",
 885     .long_name      = NULL_IF_CONFIG_SMALL("Closed Caption (EIA-608 / CEA-708)"),
 886     .type           = AVMEDIA_TYPE_SUBTITLE,
 887     .id             = AV_CODEC_ID_EIA_608,
 888     .priv_data_size = sizeof(CCaptionSubContext),
 889     .init           = init_decoder,
 890     .close          = close_decoder,
 891     .flush          = flush_decoder,
 892     .decode         = decode,
 893     .priv_class     = &ccaption_dec_class,
 894     .capabilities   = AV_CODEC_CAP_DELAY,
 895 };