ca08d48f8e0c14efdeff7842384a73bee2f2f62a
[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 static const unsigned char pac2_attribs[32][3] = // Color, font, ident
67 {
68     { CCCOL_WHITE,   CCFONT_REGULAR,            0 },  // 0x40 || 0x60
69     { CCCOL_WHITE,   CCFONT_UNDERLINED,         0 },  // 0x41 || 0x61
70     { CCCOL_GREEN,   CCFONT_REGULAR,            0 },  // 0x42 || 0x62
71     { CCCOL_GREEN,   CCFONT_UNDERLINED,         0 },  // 0x43 || 0x63
72     { CCCOL_BLUE,    CCFONT_REGULAR,            0 },  // 0x44 || 0x64
73     { CCCOL_BLUE,    CCFONT_UNDERLINED,         0 },  // 0x45 || 0x65
74     { CCCOL_CYAN,    CCFONT_REGULAR,            0 },  // 0x46 || 0x66
75     { CCCOL_CYAN,    CCFONT_UNDERLINED,         0 },  // 0x47 || 0x67
76     { CCCOL_RED,     CCFONT_REGULAR,            0 },  // 0x48 || 0x68
77     { CCCOL_RED,     CCFONT_UNDERLINED,         0 },  // 0x49 || 0x69
78     { CCCOL_YELLOW,  CCFONT_REGULAR,            0 },  // 0x4a || 0x6a
79     { CCCOL_YELLOW,  CCFONT_UNDERLINED,         0 },  // 0x4b || 0x6b
80     { CCCOL_MAGENTA, CCFONT_REGULAR,            0 },  // 0x4c || 0x6c
81     { CCCOL_MAGENTA, CCFONT_UNDERLINED,         0 },  // 0x4d || 0x6d
82     { CCCOL_WHITE,   CCFONT_ITALICS,            0 },  // 0x4e || 0x6e
83     { CCCOL_WHITE,   CCFONT_UNDERLINED_ITALICS, 0 },  // 0x4f || 0x6f
84     { CCCOL_WHITE,   CCFONT_REGULAR,            0 },  // 0x50 || 0x70
85     { CCCOL_WHITE,   CCFONT_UNDERLINED,         0 },  // 0x51 || 0x71
86     { CCCOL_WHITE,   CCFONT_REGULAR,            4 },  // 0x52 || 0x72
87     { CCCOL_WHITE,   CCFONT_UNDERLINED,         4 },  // 0x53 || 0x73
88     { CCCOL_WHITE,   CCFONT_REGULAR,            8 },  // 0x54 || 0x74
89     { CCCOL_WHITE,   CCFONT_UNDERLINED,         8 },  // 0x55 || 0x75
90     { CCCOL_WHITE,   CCFONT_REGULAR,           12 },  // 0x56 || 0x76
91     { CCCOL_WHITE,   CCFONT_UNDERLINED,        12 },  // 0x57 || 0x77
92     { CCCOL_WHITE,   CCFONT_REGULAR,           16 },  // 0x58 || 0x78
93     { CCCOL_WHITE,   CCFONT_UNDERLINED,        16 },  // 0x59 || 0x79
94     { CCCOL_WHITE,   CCFONT_REGULAR,           20 },  // 0x5a || 0x7a
95     { CCCOL_WHITE,   CCFONT_UNDERLINED,        20 },  // 0x5b || 0x7b
96     { CCCOL_WHITE,   CCFONT_REGULAR,           24 },  // 0x5c || 0x7c
97     { CCCOL_WHITE,   CCFONT_UNDERLINED,        24 },  // 0x5d || 0x7d
98     { CCCOL_WHITE,   CCFONT_REGULAR,           28 },  // 0x5e || 0x7e
99     { CCCOL_WHITE,   CCFONT_UNDERLINED,        28 }   // 0x5f || 0x7f
100     /* total 32 entries */
101 };
102
103 struct Screen {
104     /* +1 is used to compensate null character of string */
105     uint8_t characters[SCREEN_ROWS][SCREEN_COLUMNS+1];
106     uint8_t colors[SCREEN_ROWS][SCREEN_COLUMNS+1];
107     uint8_t fonts[SCREEN_ROWS][SCREEN_COLUMNS+1];
108     /*
109      * Bitmask of used rows; if a bit is not set, the
110      * corresponding row is not used.
111      * for setting row 1  use row | (1 << 0)
112      * for setting row 15 use row | (1 << 14)
113      */
114     int16_t row_used;
115 };
116
117 typedef struct CCaptionSubContext {
118     AVClass *class;
119     int real_time;
120     struct Screen screen[2];
121     int active_screen;
122     uint8_t cursor_row;
123     uint8_t cursor_column;
124     uint8_t cursor_color;
125     uint8_t cursor_font;
126     AVBPrint buffer;
127     int buffer_changed;
128     int rollup;
129     enum cc_mode mode;
130     int64_t start_time;
131     /* visible screen time */
132     int64_t startv_time;
133     int64_t end_time;
134     int screen_touched;
135     int64_t last_real_time;
136     char prev_cmd[2];
137     /* buffer to store pkt data */
138     AVBufferRef *pktbuf;
139 } CCaptionSubContext;
140
141
142 static av_cold int init_decoder(AVCodecContext *avctx)
143 {
144     int ret;
145     CCaptionSubContext *ctx = avctx->priv_data;
146
147     av_bprint_init(&ctx->buffer, 0, AV_BPRINT_SIZE_UNLIMITED);
148     /* taking by default roll up to 2 */
149     ctx->mode = CCMODE_ROLLUP;
150     ctx->rollup = 2;
151     ret = ff_ass_subtitle_header(avctx, "Monospace",
152                                  ASS_DEFAULT_FONT_SIZE,
153                                  ASS_DEFAULT_COLOR,
154                                  ASS_DEFAULT_BACK_COLOR,
155                                  ASS_DEFAULT_BOLD,
156                                  ASS_DEFAULT_ITALIC,
157                                  ASS_DEFAULT_UNDERLINE,
158                                  3,
159                                  ASS_DEFAULT_ALIGNMENT);
160     if (ret < 0) {
161         return ret;
162     }
163     /* allocate pkt buffer */
164     ctx->pktbuf = av_buffer_alloc(128);
165     if (!ctx->pktbuf) {
166         ret = AVERROR(ENOMEM);
167     }
168     return ret;
169 }
170
171 static av_cold int close_decoder(AVCodecContext *avctx)
172 {
173     CCaptionSubContext *ctx = avctx->priv_data;
174     av_bprint_finalize(&ctx->buffer, NULL);
175     av_buffer_unref(&ctx->pktbuf);
176     return 0;
177 }
178
179 static void flush_decoder(AVCodecContext *avctx)
180 {
181     CCaptionSubContext *ctx = avctx->priv_data;
182     ctx->screen[0].row_used = 0;
183     ctx->screen[1].row_used = 0;
184     ctx->prev_cmd[0] = 0;
185     ctx->prev_cmd[1] = 0;
186     ctx->mode = CCMODE_ROLLUP;
187     ctx->rollup = 2;
188     ctx->cursor_row = 0;
189     ctx->cursor_column = 0;
190     ctx->cursor_font = 0;
191     ctx->cursor_color = 0;
192     ctx->active_screen = 0;
193     ctx->last_real_time = 0;
194     ctx->screen_touched = 0;
195     ctx->buffer_changed = 0;
196     av_bprint_clear(&ctx->buffer);
197 }
198
199 /**
200  * @param ctx closed caption context just to print log
201  */
202 static int write_char(CCaptionSubContext *ctx, struct Screen *screen, char ch)
203 {
204     uint8_t col = ctx->cursor_column;
205     char *row = screen->characters[ctx->cursor_row];
206     char *font = screen->fonts[ctx->cursor_row];
207
208     if (col < SCREEN_COLUMNS) {
209         row[col] = ch;
210         font[col] = ctx->cursor_font;
211         if (ch) ctx->cursor_column++;
212         return 0;
213     }
214     /* We have extra space at end only for null character */
215     else if (col == SCREEN_COLUMNS && ch == 0) {
216         row[col] = ch;
217         return 0;
218     }
219     else {
220         av_log(ctx, AV_LOG_WARNING, "Data Ignored since exceeding screen width\n");
221         return AVERROR_INVALIDDATA;
222     }
223 }
224
225 /**
226  * This function after validating parity bit, also remove it from data pair.
227  * The first byte doesn't pass parity, we replace it with a solid blank
228  * and process the pair.
229  * If the second byte doesn't pass parity, it returns INVALIDDATA
230  * user can ignore the whole pair and pass the other pair.
231  */
232 static int validate_cc_data_pair(uint8_t *cc_data_pair)
233 {
234     uint8_t cc_valid = (*cc_data_pair & 4) >>2;
235     uint8_t cc_type = *cc_data_pair & 3;
236
237     if (!cc_valid)
238         return AVERROR_INVALIDDATA;
239
240     // if EIA-608 data then verify parity.
241     if (cc_type==0 || cc_type==1) {
242         if (!av_parity(cc_data_pair[2])) {
243             return AVERROR_INVALIDDATA;
244         }
245         if (!av_parity(cc_data_pair[1])) {
246             cc_data_pair[1]=0x7F;
247         }
248     }
249
250     //Skip non-data
251     if ((cc_data_pair[0] == 0xFA || cc_data_pair[0] == 0xFC || cc_data_pair[0] == 0xFD)
252          && (cc_data_pair[1] & 0x7F) == 0 && (cc_data_pair[2] & 0x7F) == 0)
253         return AVERROR_PATCHWELCOME;
254
255     //skip 708 data
256     if (cc_type == 3 || cc_type == 2)
257         return AVERROR_PATCHWELCOME;
258
259     /* remove parity bit */
260     cc_data_pair[1] &= 0x7F;
261     cc_data_pair[2] &= 0x7F;
262
263     return 0;
264 }
265
266 static struct Screen *get_writing_screen(CCaptionSubContext *ctx)
267 {
268     switch (ctx->mode) {
269     case CCMODE_POPON:
270         // use Inactive screen
271         return ctx->screen + !ctx->active_screen;
272     case CCMODE_PAINTON:
273     case CCMODE_ROLLUP:
274     case CCMODE_TEXT:
275         // use active screen
276         return ctx->screen + ctx->active_screen;
277     }
278     /* It was never an option */
279     return NULL;
280 }
281
282 static void roll_up(CCaptionSubContext *ctx)
283 {
284     struct Screen *screen;
285     int i, keep_lines;
286
287     if (ctx->mode == CCMODE_TEXT)
288         return;
289
290     screen = get_writing_screen(ctx);
291
292     /* +1 signify cursor_row starts from 0
293      * Can't keep lines less then row cursor pos
294      */
295     keep_lines = FFMIN(ctx->cursor_row + 1, ctx->rollup);
296
297     for (i = 0; i < ctx->cursor_row - keep_lines; i++)
298         UNSET_FLAG(screen->row_used, i);
299
300
301     for (i = 0; i < keep_lines && screen->row_used; i++) {
302         const int i_row = ctx->cursor_row - keep_lines + i + 1;
303
304         memcpy(screen->characters[i_row], screen->characters[i_row+1], SCREEN_COLUMNS);
305         memcpy(screen->colors[i_row], screen->colors[i_row+1], SCREEN_COLUMNS);
306         memcpy(screen->fonts[i_row], screen->fonts[i_row+1], SCREEN_COLUMNS);
307         if (CHECK_FLAG(screen->row_used, i_row + 1))
308             SET_FLAG(screen->row_used, i_row);
309
310     }
311     UNSET_FLAG(screen->row_used, ctx->cursor_row);
312 }
313
314 static int capture_screen(CCaptionSubContext *ctx)
315 {
316     int i;
317     struct Screen *screen = ctx->screen + ctx->active_screen;
318     enum cc_font prev_font = CCFONT_REGULAR;
319     av_bprint_clear(&ctx->buffer);
320
321     for (i = 0; screen->row_used && i < SCREEN_ROWS; i++)
322     {
323         if (CHECK_FLAG(screen->row_used, i)) {
324             const char *row = screen->characters[i];
325             const char *font = screen->fonts[i];
326             int j = 0;
327
328             /* skip leading space */
329             while (row[j] == ' ')
330                 j++;
331
332             for (; j < SCREEN_COLUMNS; j++) {
333                 const char *e_tag = "", *s_tag = "";
334
335                 if (row[j] == 0)
336                     break;
337
338                 if (prev_font != font[j]) {
339                     switch (prev_font) {
340                     case CCFONT_ITALICS:
341                         e_tag = "{\\i0}";
342                         break;
343                     case CCFONT_UNDERLINED:
344                         e_tag = "{\\u0}";
345                         break;
346                     case CCFONT_UNDERLINED_ITALICS:
347                         e_tag = "{\\u0}{\\i0}";
348                         break;
349                     }
350                     switch (font[j]) {
351                     case CCFONT_ITALICS:
352                         s_tag = "{\\i1}";
353                         break;
354                     case CCFONT_UNDERLINED:
355                         s_tag = "{\\u1}";
356                         break;
357                     case CCFONT_UNDERLINED_ITALICS:
358                         s_tag = "{\\u1}{\\i1}";
359                         break;
360                     }
361                 }
362                 prev_font = font[j];
363                 av_bprintf(&ctx->buffer, "%s%s%c", e_tag, s_tag, row[j]);
364             }
365             av_bprintf(&ctx->buffer, "\\N");
366         }
367     }
368     if (!av_bprint_is_complete(&ctx->buffer))
369         return AVERROR(ENOMEM);
370     if (screen->row_used && ctx->buffer.len >= 2) {
371         ctx->buffer.len -= 2;
372         ctx->buffer.str[ctx->buffer.len] = 0;
373     }
374     ctx->buffer_changed = 1;
375     return 0;
376 }
377
378 static int reap_screen(CCaptionSubContext *ctx, int64_t pts)
379 {
380     ctx->start_time = ctx->startv_time;
381     ctx->startv_time = pts;
382     ctx->end_time = pts;
383     return capture_screen(ctx);
384 }
385
386 static void handle_textattr(CCaptionSubContext *ctx, uint8_t hi, uint8_t lo)
387 {
388     int i = lo - 0x20;
389     struct Screen *screen = get_writing_screen(ctx);
390
391     if (i >= 32)
392         return;
393
394     ctx->cursor_color = pac2_attribs[i][0];
395     ctx->cursor_font = pac2_attribs[i][1];
396
397     SET_FLAG(screen->row_used, ctx->cursor_row);
398     write_char(ctx, screen, ' ');
399 }
400
401 static void handle_pac(CCaptionSubContext *ctx, uint8_t hi, uint8_t lo)
402 {
403     static const int8_t row_map[] = {
404         11, -1, 1, 2, 3, 4, 12, 13, 14, 15, 5, 6, 7, 8, 9, 10
405     };
406     const int index = ( (hi<<1) & 0x0e) | ( (lo>>5) & 0x01 );
407     struct Screen *screen = get_writing_screen(ctx);
408     int indent, i;
409
410     if (row_map[index] <= 0) {
411         av_log(ctx, AV_LOG_DEBUG, "Invalid pac index encountered\n");
412         return;
413     }
414
415     lo &= 0x1f;
416
417     ctx->cursor_row = row_map[index] - 1;
418     ctx->cursor_color =  pac2_attribs[lo][0];
419     ctx->cursor_font = pac2_attribs[lo][1];
420     ctx->cursor_column = 0;
421     indent = pac2_attribs[lo][2];
422     for (i = 0; i < indent; i++) {
423         write_char(ctx, screen, ' ');
424     }
425 }
426
427 /**
428  * @param pts it is required to set end time
429  */
430 static void handle_edm(CCaptionSubContext *ctx, int64_t pts)
431 {
432     struct Screen *screen = ctx->screen + ctx->active_screen;
433
434     // In buffered mode, keep writing to screen until it is wiped.
435     // Before wiping the display, capture contents to emit subtitle.
436     if (!ctx->real_time)
437         reap_screen(ctx, pts);
438
439     screen->row_used = 0;
440
441     // In realtime mode, emit an empty caption so the last one doesn't
442     // stay on the screen.
443     if (ctx->real_time)
444         reap_screen(ctx, pts);
445 }
446
447 static void handle_eoc(CCaptionSubContext *ctx, int64_t pts)
448 {
449     // In buffered mode, we wait til the *next* EOC and
450     // reap what was already on the screen since the last EOC.
451     if (!ctx->real_time)
452         handle_edm(ctx,pts);
453
454     ctx->active_screen = !ctx->active_screen;
455     ctx->cursor_column = 0;
456
457     // In realtime mode, we display the buffered contents (after
458     // flipping the buffer to active above) as soon as EOC arrives.
459     if (ctx->real_time)
460         reap_screen(ctx, pts);
461 }
462
463 static void handle_delete_end_of_row(CCaptionSubContext *ctx, char hi, char lo)
464 {
465     struct Screen *screen = get_writing_screen(ctx);
466     write_char(ctx, screen, 0);
467 }
468
469 static void handle_char(CCaptionSubContext *ctx, char hi, char lo, int64_t pts)
470 {
471     struct Screen *screen = get_writing_screen(ctx);
472
473     SET_FLAG(screen->row_used, ctx->cursor_row);
474
475     write_char(ctx, screen, hi);
476
477     if (lo) {
478         write_char(ctx, screen, lo);
479     }
480     write_char(ctx, screen, 0);
481
482     if (ctx->mode != CCMODE_POPON)
483         ctx->screen_touched = 1;
484
485     /* reset prev command since character can repeat */
486     ctx->prev_cmd[0] = 0;
487     ctx->prev_cmd[1] = 0;
488     if (lo)
489        ff_dlog(ctx, "(%c,%c)\n", hi, lo);
490     else
491        ff_dlog(ctx, "(%c)\n", hi);
492 }
493
494 static void process_cc608(CCaptionSubContext *ctx, int64_t pts, uint8_t hi, uint8_t lo)
495 {
496     if (hi == ctx->prev_cmd[0] && lo == ctx->prev_cmd[1]) {
497         /* ignore redundant command */
498     } else if ( (hi == 0x10 && (lo >= 0x40 && lo <= 0x5f)) ||
499               ( (hi >= 0x11 && hi <= 0x17) && (lo >= 0x40 && lo <= 0x7f) ) ) {
500         handle_pac(ctx, hi, lo);
501     } else if ( ( hi == 0x11 && lo >= 0x20 && lo <= 0x2f ) ||
502                 ( hi == 0x17 && lo >= 0x2e && lo <= 0x2f) ) {
503         handle_textattr(ctx, hi, lo);
504     } else if (hi == 0x14 || hi == 0x15 || hi == 0x1c) {
505         switch (lo) {
506         case 0x20:
507             /* resume caption loading */
508             ctx->mode = CCMODE_POPON;
509             break;
510         case 0x24:
511             handle_delete_end_of_row(ctx, hi, lo);
512             break;
513         case 0x25:
514         case 0x26:
515         case 0x27:
516             ctx->rollup = lo - 0x23;
517             ctx->mode = CCMODE_ROLLUP;
518             break;
519         case 0x29:
520             /* resume direct captioning */
521             ctx->mode = CCMODE_PAINTON;
522             break;
523         case 0x2b:
524             /* resume text display */
525             ctx->mode = CCMODE_TEXT;
526             break;
527         case 0x2c:
528             /* erase display memory */
529             handle_edm(ctx, pts);
530             break;
531         case 0x2d:
532             /* carriage return */
533             ff_dlog(ctx, "carriage return\n");
534             if (!ctx->real_time)
535                 reap_screen(ctx, pts);
536             roll_up(ctx);
537             ctx->cursor_column = 0;
538             break;
539         case 0x2e:
540             /* erase buffered (non displayed) memory */
541             // Only in realtime mode. In buffered mode, we re-use the inactive screen
542             // for our own buffering.
543             if (ctx->real_time) {
544                 struct Screen *screen = ctx->screen + !ctx->active_screen;
545                 screen->row_used = 0;
546             }
547             break;
548         case 0x2f:
549             /* end of caption */
550             ff_dlog(ctx, "handle_eoc\n");
551             handle_eoc(ctx, pts);
552             break;
553         default:
554             ff_dlog(ctx, "Unknown command 0x%hhx 0x%hhx\n", hi, lo);
555             break;
556         }
557     } else if (hi >= 0x20) {
558         /* Standard characters (always in pairs) */
559         handle_char(ctx, hi, lo, pts);
560     } else {
561         /* Ignoring all other non data code */
562         ff_dlog(ctx, "Unknown command 0x%hhx 0x%hhx\n", hi, lo);
563     }
564
565     /* set prev command */
566     ctx->prev_cmd[0] = hi;
567     ctx->prev_cmd[1] = lo;
568 }
569
570 static int decode(AVCodecContext *avctx, void *data, int *got_sub, AVPacket *avpkt)
571 {
572     CCaptionSubContext *ctx = avctx->priv_data;
573     AVSubtitle *sub = data;
574     uint8_t *bptr = NULL;
575     int len = avpkt->size;
576     int ret = 0;
577     int i;
578
579     if (ctx->pktbuf->size < len) {
580         ret = av_buffer_realloc(&ctx->pktbuf, len);
581          if (ret < 0) {
582             av_log(ctx, AV_LOG_WARNING, "Insufficient Memory of %d truncated to %d\n", len, ctx->pktbuf->size);
583             len = ctx->pktbuf->size;
584             ret = 0;
585         }
586     }
587     memcpy(ctx->pktbuf->data, avpkt->data, len);
588     bptr = ctx->pktbuf->data;
589
590     for (i  = 0; i < len; i += 3) {
591         uint8_t cc_type = *(bptr + i) & 3;
592         if (validate_cc_data_pair(bptr + i))
593             continue;
594         /* ignoring data field 1 */
595         if(cc_type == 1)
596             continue;
597         else
598             process_cc608(ctx, avpkt->pts, *(bptr + i + 1) & 0x7f, *(bptr + i + 2) & 0x7f);
599
600         if (!ctx->buffer_changed)
601             continue;
602         ctx->buffer_changed = 0;
603
604         if (*ctx->buffer.str || ctx->real_time)
605         {
606             int64_t sub_pts = ctx->real_time ? avpkt->pts : ctx->start_time;
607             int start_time = av_rescale_q(sub_pts, avctx->time_base, ass_tb);
608             int duration = -1;
609             if (!ctx->real_time) {
610                 int end_time = av_rescale_q(ctx->end_time, avctx->time_base, ass_tb);
611                 duration = end_time - start_time;
612             }
613             ff_dlog(ctx, "cdp writing data (%s)\n",ctx->buffer.str);
614             ret = ff_ass_add_rect_bprint(sub, &ctx->buffer, start_time, duration);
615             if (ret < 0)
616                 return ret;
617             sub->pts = av_rescale_q(sub_pts, avctx->time_base, AV_TIME_BASE_Q);
618             ctx->buffer_changed = 0;
619             ctx->last_real_time = avpkt->pts;
620             ctx->screen_touched = 0;
621         }
622     }
623
624     if (ctx->real_time && ctx->screen_touched &&
625         avpkt->pts > ctx->last_real_time + av_rescale_q(20, ass_tb, avctx->time_base)) {
626         ctx->last_real_time = avpkt->pts;
627         ctx->screen_touched = 0;
628
629         capture_screen(ctx);
630         ctx->buffer_changed = 0;
631
632         int start_time = av_rescale_q(avpkt->pts, avctx->time_base, ass_tb);
633         ret = ff_ass_add_rect_bprint(sub, &ctx->buffer, start_time, -1);
634         if (ret < 0)
635             return ret;
636         sub->pts = av_rescale_q(avpkt->pts, avctx->time_base, AV_TIME_BASE_Q);
637     }
638
639     *got_sub = sub->num_rects > 0;
640     return ret;
641 }
642
643 #define OFFSET(x) offsetof(CCaptionSubContext, x)
644 #define SD AV_OPT_FLAG_SUBTITLE_PARAM | AV_OPT_FLAG_DECODING_PARAM
645 static const AVOption options[] = {
646     { "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 },
647     {NULL}
648 };
649
650 static const AVClass ccaption_dec_class = {
651     .class_name = "Closed caption Decoder",
652     .item_name  = av_default_item_name,
653     .option     = options,
654     .version    = LIBAVUTIL_VERSION_INT,
655 };
656
657 AVCodec ff_ccaption_decoder = {
658     .name           = "cc_dec",
659     .long_name      = NULL_IF_CONFIG_SMALL("Closed Caption (EIA-608 / CEA-708) Decoder"),
660     .type           = AVMEDIA_TYPE_SUBTITLE,
661     .id             = AV_CODEC_ID_EIA_608,
662     .priv_data_size = sizeof(CCaptionSubContext),
663     .init           = init_decoder,
664     .close          = close_decoder,
665     .flush          = flush_decoder,
666     .decode         = decode,
667     .priv_class     = &ccaption_dec_class,
668 };