5fb2ec62931d753a9ba1fdfb28dc036beaf818a2
[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 < SCREEN_ROWS; i++) {
298         if (i > ctx->cursor_row - keep_lines && i <= ctx->cursor_row)
299             continue;
300         UNSET_FLAG(screen->row_used, i);
301     }
302
303     for (i = 0; i < keep_lines && screen->row_used; i++) {
304         const int i_row = ctx->cursor_row - keep_lines + i + 1;
305
306         memcpy(screen->characters[i_row], screen->characters[i_row+1], SCREEN_COLUMNS);
307         memcpy(screen->colors[i_row], screen->colors[i_row+1], SCREEN_COLUMNS);
308         memcpy(screen->fonts[i_row], screen->fonts[i_row+1], SCREEN_COLUMNS);
309         if (CHECK_FLAG(screen->row_used, i_row + 1))
310             SET_FLAG(screen->row_used, i_row);
311     }
312
313     UNSET_FLAG(screen->row_used, ctx->cursor_row);
314 }
315
316 static int capture_screen(CCaptionSubContext *ctx)
317 {
318     int i;
319     struct Screen *screen = ctx->screen + ctx->active_screen;
320     enum cc_font prev_font = CCFONT_REGULAR;
321     av_bprint_clear(&ctx->buffer);
322
323     for (i = 0; screen->row_used && i < SCREEN_ROWS; i++)
324     {
325         if (CHECK_FLAG(screen->row_used, i)) {
326             const char *row = screen->characters[i];
327             const char *font = screen->fonts[i];
328             int j = 0;
329
330             /* skip leading space */
331             while (row[j] == ' ')
332                 j++;
333
334             for (; j < SCREEN_COLUMNS; j++) {
335                 const char *e_tag = "", *s_tag = "";
336
337                 if (row[j] == 0)
338                     break;
339
340                 if (prev_font != font[j]) {
341                     switch (prev_font) {
342                     case CCFONT_ITALICS:
343                         e_tag = "{\\i0}";
344                         break;
345                     case CCFONT_UNDERLINED:
346                         e_tag = "{\\u0}";
347                         break;
348                     case CCFONT_UNDERLINED_ITALICS:
349                         e_tag = "{\\u0}{\\i0}";
350                         break;
351                     }
352                     switch (font[j]) {
353                     case CCFONT_ITALICS:
354                         s_tag = "{\\i1}";
355                         break;
356                     case CCFONT_UNDERLINED:
357                         s_tag = "{\\u1}";
358                         break;
359                     case CCFONT_UNDERLINED_ITALICS:
360                         s_tag = "{\\u1}{\\i1}";
361                         break;
362                     }
363                 }
364                 prev_font = font[j];
365                 av_bprintf(&ctx->buffer, "%s%s%c", e_tag, s_tag, row[j]);
366             }
367             av_bprintf(&ctx->buffer, "\\N");
368         }
369     }
370     if (!av_bprint_is_complete(&ctx->buffer))
371         return AVERROR(ENOMEM);
372     if (screen->row_used && ctx->buffer.len >= 2) {
373         ctx->buffer.len -= 2;
374         ctx->buffer.str[ctx->buffer.len] = 0;
375     }
376     ctx->buffer_changed = 1;
377     return 0;
378 }
379
380 static int reap_screen(CCaptionSubContext *ctx, int64_t pts)
381 {
382     ctx->start_time = ctx->startv_time;
383     ctx->startv_time = pts;
384     ctx->end_time = pts;
385     return capture_screen(ctx);
386 }
387
388 static void handle_textattr(CCaptionSubContext *ctx, uint8_t hi, uint8_t lo)
389 {
390     int i = lo - 0x20;
391     struct Screen *screen = get_writing_screen(ctx);
392
393     if (i >= 32)
394         return;
395
396     ctx->cursor_color = pac2_attribs[i][0];
397     ctx->cursor_font = pac2_attribs[i][1];
398
399     SET_FLAG(screen->row_used, ctx->cursor_row);
400     write_char(ctx, screen, ' ');
401 }
402
403 static void handle_pac(CCaptionSubContext *ctx, uint8_t hi, uint8_t lo)
404 {
405     static const int8_t row_map[] = {
406         11, -1, 1, 2, 3, 4, 12, 13, 14, 15, 5, 6, 7, 8, 9, 10
407     };
408     const int index = ( (hi<<1) & 0x0e) | ( (lo>>5) & 0x01 );
409     struct Screen *screen = get_writing_screen(ctx);
410     int indent, i;
411
412     if (row_map[index] <= 0) {
413         av_log(ctx, AV_LOG_DEBUG, "Invalid pac index encountered\n");
414         return;
415     }
416
417     lo &= 0x1f;
418
419     ctx->cursor_row = row_map[index] - 1;
420     ctx->cursor_color =  pac2_attribs[lo][0];
421     ctx->cursor_font = pac2_attribs[lo][1];
422     ctx->cursor_column = 0;
423     indent = pac2_attribs[lo][2];
424     for (i = 0; i < indent; i++) {
425         write_char(ctx, screen, ' ');
426     }
427 }
428
429 /**
430  * @param pts it is required to set end time
431  */
432 static void handle_edm(CCaptionSubContext *ctx, int64_t pts)
433 {
434     struct Screen *screen = ctx->screen + ctx->active_screen;
435
436     // In buffered mode, keep writing to screen until it is wiped.
437     // Before wiping the display, capture contents to emit subtitle.
438     if (!ctx->real_time)
439         reap_screen(ctx, pts);
440
441     screen->row_used = 0;
442
443     // In realtime mode, emit an empty caption so the last one doesn't
444     // stay on the screen.
445     if (ctx->real_time)
446         reap_screen(ctx, pts);
447 }
448
449 static void handle_eoc(CCaptionSubContext *ctx, int64_t pts)
450 {
451     // In buffered mode, we wait til the *next* EOC and
452     // reap what was already on the screen since the last EOC.
453     if (!ctx->real_time)
454         handle_edm(ctx,pts);
455
456     ctx->active_screen = !ctx->active_screen;
457     ctx->cursor_column = 0;
458
459     // In realtime mode, we display the buffered contents (after
460     // flipping the buffer to active above) as soon as EOC arrives.
461     if (ctx->real_time)
462         reap_screen(ctx, pts);
463 }
464
465 static void handle_delete_end_of_row(CCaptionSubContext *ctx, char hi, char lo)
466 {
467     struct Screen *screen = get_writing_screen(ctx);
468     write_char(ctx, screen, 0);
469 }
470
471 static void handle_char(CCaptionSubContext *ctx, char hi, char lo, int64_t pts)
472 {
473     struct Screen *screen = get_writing_screen(ctx);
474
475     SET_FLAG(screen->row_used, ctx->cursor_row);
476
477     write_char(ctx, screen, hi);
478
479     if (lo) {
480         write_char(ctx, screen, lo);
481     }
482     write_char(ctx, screen, 0);
483
484     if (ctx->mode != CCMODE_POPON)
485         ctx->screen_touched = 1;
486
487     if (lo)
488        ff_dlog(ctx, "(%c,%c)\n", hi, lo);
489     else
490        ff_dlog(ctx, "(%c)\n", hi);
491 }
492
493 static void process_cc608(CCaptionSubContext *ctx, int64_t pts, uint8_t hi, uint8_t lo)
494 {
495     if (hi == ctx->prev_cmd[0] && lo == ctx->prev_cmd[1]) {
496         /* ignore redundant command */
497         return;
498     }
499
500     /* set prev command */
501     ctx->prev_cmd[0] = hi;
502     ctx->prev_cmd[1] = lo;
503
504     if ( (hi == 0x10 && (lo >= 0x40 && lo <= 0x5f)) ||
505        ( (hi >= 0x11 && hi <= 0x17) && (lo >= 0x40 && lo <= 0x7f) ) ) {
506         handle_pac(ctx, hi, lo);
507     } else if ( ( hi == 0x11 && lo >= 0x20 && lo <= 0x2f ) ||
508                 ( hi == 0x17 && lo >= 0x2e && lo <= 0x2f) ) {
509         handle_textattr(ctx, hi, lo);
510     } else if (hi == 0x14 || hi == 0x15 || hi == 0x1c) {
511         switch (lo) {
512         case 0x20:
513             /* resume caption loading */
514             ctx->mode = CCMODE_POPON;
515             break;
516         case 0x24:
517             handle_delete_end_of_row(ctx, hi, lo);
518             break;
519         case 0x25:
520         case 0x26:
521         case 0x27:
522             ctx->rollup = lo - 0x23;
523             ctx->mode = CCMODE_ROLLUP;
524             break;
525         case 0x29:
526             /* resume direct captioning */
527             ctx->mode = CCMODE_PAINTON;
528             break;
529         case 0x2b:
530             /* resume text display */
531             ctx->mode = CCMODE_TEXT;
532             break;
533         case 0x2c:
534             /* erase display memory */
535             handle_edm(ctx, pts);
536             break;
537         case 0x2d:
538             /* carriage return */
539             ff_dlog(ctx, "carriage return\n");
540             if (!ctx->real_time)
541                 reap_screen(ctx, pts);
542             roll_up(ctx);
543             ctx->cursor_column = 0;
544             break;
545         case 0x2e:
546             /* erase buffered (non displayed) memory */
547             // Only in realtime mode. In buffered mode, we re-use the inactive screen
548             // for our own buffering.
549             if (ctx->real_time) {
550                 struct Screen *screen = ctx->screen + !ctx->active_screen;
551                 screen->row_used = 0;
552             }
553             break;
554         case 0x2f:
555             /* end of caption */
556             ff_dlog(ctx, "handle_eoc\n");
557             handle_eoc(ctx, pts);
558             break;
559         default:
560             ff_dlog(ctx, "Unknown command 0x%hhx 0x%hhx\n", hi, lo);
561             break;
562         }
563     } else if (hi >= 0x20) {
564         /* Standard characters (always in pairs) */
565         handle_char(ctx, hi, lo, pts);
566         ctx->prev_cmd[0] = ctx->prev_cmd[1] = 0;
567     } else {
568         /* Ignoring all other non data code */
569         ff_dlog(ctx, "Unknown command 0x%hhx 0x%hhx\n", hi, lo);
570     }
571 }
572
573 static int decode(AVCodecContext *avctx, void *data, int *got_sub, AVPacket *avpkt)
574 {
575     CCaptionSubContext *ctx = avctx->priv_data;
576     AVSubtitle *sub = data;
577     uint8_t *bptr = NULL;
578     int len = avpkt->size;
579     int ret = 0;
580     int i;
581
582     if (ctx->pktbuf->size < len) {
583         ret = av_buffer_realloc(&ctx->pktbuf, len);
584          if (ret < 0) {
585             av_log(ctx, AV_LOG_WARNING, "Insufficient Memory of %d truncated to %d\n", len, ctx->pktbuf->size);
586             len = ctx->pktbuf->size;
587             ret = 0;
588         }
589     }
590     memcpy(ctx->pktbuf->data, avpkt->data, len);
591     bptr = ctx->pktbuf->data;
592
593     for (i  = 0; i < len; i += 3) {
594         uint8_t cc_type = *(bptr + i) & 3;
595         if (validate_cc_data_pair(bptr + i))
596             continue;
597         /* ignoring data field 1 */
598         if(cc_type == 1)
599             continue;
600         else
601             process_cc608(ctx, avpkt->pts, *(bptr + i + 1) & 0x7f, *(bptr + i + 2) & 0x7f);
602
603         if (!ctx->buffer_changed)
604             continue;
605         ctx->buffer_changed = 0;
606
607         if (*ctx->buffer.str || ctx->real_time)
608         {
609             int64_t sub_pts = ctx->real_time ? avpkt->pts : ctx->start_time;
610             int start_time = av_rescale_q(sub_pts, avctx->time_base, ass_tb);
611             int duration = -1;
612             if (!ctx->real_time) {
613                 int end_time = av_rescale_q(ctx->end_time, avctx->time_base, ass_tb);
614                 duration = end_time - start_time;
615             }
616             ff_dlog(ctx, "cdp writing data (%s)\n",ctx->buffer.str);
617             ret = ff_ass_add_rect_bprint(sub, &ctx->buffer, start_time, duration);
618             if (ret < 0)
619                 return ret;
620             sub->pts = av_rescale_q(sub_pts, avctx->time_base, AV_TIME_BASE_Q);
621             ctx->buffer_changed = 0;
622             ctx->last_real_time = avpkt->pts;
623             ctx->screen_touched = 0;
624         }
625     }
626
627     if (ctx->real_time && ctx->screen_touched &&
628         avpkt->pts > ctx->last_real_time + av_rescale_q(20, ass_tb, avctx->time_base)) {
629         int start_time;
630         ctx->last_real_time = avpkt->pts;
631         ctx->screen_touched = 0;
632
633         capture_screen(ctx);
634         ctx->buffer_changed = 0;
635
636         start_time = av_rescale_q(avpkt->pts, avctx->time_base, ass_tb);
637         ret = ff_ass_add_rect_bprint(sub, &ctx->buffer, start_time, -1);
638         if (ret < 0)
639             return ret;
640         sub->pts = av_rescale_q(avpkt->pts, avctx->time_base, AV_TIME_BASE_Q);
641     }
642
643     *got_sub = sub->num_rects > 0;
644     return ret;
645 }
646
647 #define OFFSET(x) offsetof(CCaptionSubContext, x)
648 #define SD AV_OPT_FLAG_SUBTITLE_PARAM | AV_OPT_FLAG_DECODING_PARAM
649 static const AVOption options[] = {
650     { "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 },
651     {NULL}
652 };
653
654 static const AVClass ccaption_dec_class = {
655     .class_name = "Closed caption Decoder",
656     .item_name  = av_default_item_name,
657     .option     = options,
658     .version    = LIBAVUTIL_VERSION_INT,
659 };
660
661 AVCodec ff_ccaption_decoder = {
662     .name           = "cc_dec",
663     .long_name      = NULL_IF_CONFIG_SMALL("Closed Caption (EIA-608 / CEA-708) Decoder"),
664     .type           = AVMEDIA_TYPE_SUBTITLE,
665     .id             = AV_CODEC_ID_EIA_608,
666     .priv_data_size = sizeof(CCaptionSubContext),
667     .init           = init_decoder,
668     .close          = close_decoder,
669     .flush          = flush_decoder,
670     .decode         = decode,
671     .priv_class     = &ccaption_dec_class,
672 };