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