e84c4800c802cd95249a3aa8296a6bda2fbb44b8
[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     struct Screen screen[2];
120     int active_screen;
121     uint8_t cursor_row;
122     uint8_t cursor_column;
123     uint8_t cursor_color;
124     uint8_t cursor_font;
125     AVBPrint buffer;
126     int buffer_changed;
127     int rollup;
128     enum cc_mode mode;
129     int64_t start_time;
130     /* visible screen time */
131     int64_t startv_time;
132     int64_t end_time;
133     char prev_cmd[2];
134     /* buffer to store pkt data */
135     AVBufferRef *pktbuf;
136 } CCaptionSubContext;
137
138
139 static av_cold int init_decoder(AVCodecContext *avctx)
140 {
141     int ret;
142     CCaptionSubContext *ctx = avctx->priv_data;
143
144     av_bprint_init(&ctx->buffer, 0, AV_BPRINT_SIZE_UNLIMITED);
145     /* taking by default roll up to 2 */
146     ctx->mode = CCMODE_ROLLUP;
147     ctx->rollup = 2;
148     ret = ff_ass_subtitle_header_default(avctx);
149     if (ret < 0) {
150         return ret;
151     }
152     /* allocate pkt buffer */
153     ctx->pktbuf = av_buffer_alloc(128);
154     if (!ctx->pktbuf) {
155         ret = AVERROR(ENOMEM);
156     }
157     return ret;
158 }
159
160 static av_cold int close_decoder(AVCodecContext *avctx)
161 {
162     CCaptionSubContext *ctx = avctx->priv_data;
163     av_bprint_finalize(&ctx->buffer, NULL);
164     av_buffer_unref(&ctx->pktbuf);
165     return 0;
166 }
167
168 /**
169  * @param ctx closed caption context just to print log
170  */
171 static int write_char(CCaptionSubContext *ctx, struct Screen *screen, char ch)
172 {
173     uint8_t col = ctx->cursor_column;
174     char *row = screen->characters[ctx->cursor_row];
175     char *font = screen->fonts[ctx->cursor_row];
176
177     if (col < SCREEN_COLUMNS) {
178         row[col] = ch;
179         font[col] = ctx->cursor_font;
180         if (ch) ctx->cursor_column++;
181         return 0;
182     }
183     /* We have extra space at end only for null character */
184     else if (col == SCREEN_COLUMNS && ch == 0) {
185         row[col] = ch;
186         return 0;
187     }
188     else {
189         av_log(ctx, AV_LOG_WARNING, "Data Ignored since exceeding screen width\n");
190         return AVERROR_INVALIDDATA;
191     }
192 }
193
194 /**
195  * This function after validating parity bit, also remove it from data pair.
196  * The first byte doesn't pass parity, we replace it with a solid blank
197  * and process the pair.
198  * If the second byte doesn't pass parity, it returns INVALIDDATA
199  * user can ignore the whole pair and pass the other pair.
200  */
201 static int validate_cc_data_pair(uint8_t *cc_data_pair)
202 {
203     uint8_t cc_valid = (*cc_data_pair & 4) >>2;
204     uint8_t cc_type = *cc_data_pair & 3;
205
206     if (!cc_valid)
207         return AVERROR_INVALIDDATA;
208
209     // if EIA-608 data then verify parity.
210     if (cc_type==0 || cc_type==1) {
211         if (!av_parity(cc_data_pair[2])) {
212             return AVERROR_INVALIDDATA;
213         }
214         if (!av_parity(cc_data_pair[1])) {
215             cc_data_pair[1]=0x7F;
216         }
217     }
218
219     //Skip non-data
220     if ((cc_data_pair[0] == 0xFA || cc_data_pair[0] == 0xFC || cc_data_pair[0] == 0xFD)
221          && (cc_data_pair[1] & 0x7F) == 0 && (cc_data_pair[2] & 0x7F) == 0)
222         return AVERROR_PATCHWELCOME;
223
224     //skip 708 data
225     if (cc_type == 3 || cc_type == 2)
226         return AVERROR_PATCHWELCOME;
227
228     /* remove parity bit */
229     cc_data_pair[1] &= 0x7F;
230     cc_data_pair[2] &= 0x7F;
231
232     return 0;
233 }
234
235 static struct Screen *get_writing_screen(CCaptionSubContext *ctx)
236 {
237     switch (ctx->mode) {
238     case CCMODE_POPON:
239         // use Inactive screen
240         return ctx->screen + !ctx->active_screen;
241     case CCMODE_PAINTON:
242     case CCMODE_ROLLUP:
243     case CCMODE_TEXT:
244         // use active screen
245         return ctx->screen + ctx->active_screen;
246     }
247     /* It was never an option */
248     return NULL;
249 }
250
251 static void roll_up(CCaptionSubContext *ctx)
252 {
253     struct Screen *screen;
254     int i, keep_lines;
255
256     if (ctx->mode == CCMODE_TEXT)
257         return;
258
259     screen = get_writing_screen(ctx);
260
261     /* +1 signify cursor_row starts from 0
262      * Can't keep lines less then row cursor pos
263      */
264     keep_lines = FFMIN(ctx->cursor_row + 1, ctx->rollup);
265
266     for (i = 0; i < ctx->cursor_row - keep_lines; i++)
267         UNSET_FLAG(screen->row_used, i);
268
269
270     for (i = 0; i < keep_lines && screen->row_used; i++) {
271         const int i_row = ctx->cursor_row - keep_lines + i + 1;
272
273         memcpy(screen->characters[i_row], screen->characters[i_row+1], SCREEN_COLUMNS);
274         memcpy(screen->colors[i_row], screen->colors[i_row+1], SCREEN_COLUMNS);
275         memcpy(screen->fonts[i_row], screen->fonts[i_row+1], SCREEN_COLUMNS);
276         if (CHECK_FLAG(screen->row_used, i_row + 1))
277             SET_FLAG(screen->row_used, i_row);
278
279     }
280     UNSET_FLAG(screen->row_used, ctx->cursor_row);
281 }
282
283 static int capture_screen(CCaptionSubContext *ctx)
284 {
285     int i;
286     int ret = 0;
287     struct Screen *screen = ctx->screen + ctx->active_screen;
288     enum cc_font prev_font = CCFONT_REGULAR;
289     av_bprint_clear(&ctx->buffer);
290
291     for (i = 0; screen->row_used && i < SCREEN_ROWS; i++)
292     {
293         if (CHECK_FLAG(screen->row_used, i)) {
294             const char *row = screen->characters[i];
295             const char *font = screen->fonts[i];
296             int j = 0;
297
298             /* skip leading space */
299             while (row[j] == ' ')
300                 j++;
301
302             for (; j < SCREEN_COLUMNS; j++) {
303                 const char *e_tag = "", *s_tag = "";
304
305                 if (row[j] == 0)
306                     break;
307
308                 if (prev_font != font[j]) {
309                     switch (prev_font) {
310                     case CCFONT_ITALICS:
311                         e_tag = "{/i0}";
312                         break;
313                     case CCFONT_UNDERLINED:
314                         e_tag = "{/u0}";
315                         break;
316                     case CCFONT_UNDERLINED_ITALICS:
317                         e_tag = "{/u0}{/i0}";
318                         break;
319                     }
320                     switch (font[j]) {
321                     case CCFONT_ITALICS:
322                         s_tag = "{/i1}";
323                         break;
324                     case CCFONT_UNDERLINED:
325                         s_tag = "{/u1}";
326                         break;
327                     case CCFONT_UNDERLINED_ITALICS:
328                         s_tag = "{/u1}{/i1}";
329                         break;
330                     }
331                 }
332                 prev_font = font[j];
333
334                 av_bprintf(&ctx->buffer, "%s%s%c", e_tag, s_tag, row[j]);
335             }
336
337             av_bprintf(&ctx->buffer, "\\N");
338             ret = av_bprint_is_complete(&ctx->buffer);
339             if (ret == 0) {
340                 ret = AVERROR(ENOMEM);
341                 break;
342             }
343         }
344
345     }
346     if (screen->row_used && ctx->buffer.len >= 2) {
347         ctx->buffer.len -= 2;
348         ctx->buffer.str[ctx->buffer.len] = 0;
349     }
350     ctx->buffer_changed = 1;
351     return ret;
352 }
353
354 static int reap_screen(CCaptionSubContext *ctx, int64_t pts)
355 {
356     ctx->start_time = ctx->startv_time;
357     ctx->startv_time = pts;
358     ctx->end_time = pts;
359     return capture_screen(ctx);
360 }
361
362 static void handle_textattr(CCaptionSubContext *ctx, uint8_t hi, uint8_t lo)
363 {
364     int i = lo - 0x20;
365     struct Screen *screen = get_writing_screen(ctx);
366
367     if (i >= 32)
368         return;
369
370     ctx->cursor_color = pac2_attribs[i][0];
371     ctx->cursor_font = pac2_attribs[i][1];
372
373     SET_FLAG(screen->row_used, ctx->cursor_row);
374     write_char(ctx, screen, ' ');
375 }
376
377 static void handle_pac(CCaptionSubContext *ctx, uint8_t hi, uint8_t lo)
378 {
379     static const int8_t row_map[] = {
380         11, -1, 1, 2, 3, 4, 12, 13, 14, 15, 5, 6, 7, 8, 9, 10
381     };
382     const int index = ( (hi<<1) & 0x0e) | ( (lo>>5) & 0x01 );
383     struct Screen *screen = get_writing_screen(ctx);
384     int indent, i;
385
386     if (row_map[index] <= 0) {
387         av_log(ctx, AV_LOG_DEBUG, "Invalid pac index encountered\n");
388         return;
389     }
390
391     lo &= 0x1f;
392
393     ctx->cursor_row = row_map[index] - 1;
394     ctx->cursor_color =  pac2_attribs[lo][0];
395     ctx->cursor_font = pac2_attribs[lo][1];
396     ctx->cursor_column = 0;
397     indent = pac2_attribs[lo][2];
398     for (i = 0; i < indent; i++) {
399         write_char(ctx, screen, ' ');
400     }
401 }
402
403 /**
404  * @param pts it is required to set end time
405  */
406 static void handle_edm(CCaptionSubContext *ctx, int64_t pts)
407 {
408     struct Screen *screen = ctx->screen + ctx->active_screen;
409
410     reap_screen(ctx, pts);
411     screen->row_used = 0;
412 }
413
414 static void handle_eoc(CCaptionSubContext *ctx, int64_t pts)
415 {
416     handle_edm(ctx,pts);
417     ctx->active_screen = !ctx->active_screen;
418     ctx->cursor_column = 0;
419 }
420
421 static void handle_delete_end_of_row(CCaptionSubContext *ctx, char hi, char lo)
422 {
423     struct Screen *screen = get_writing_screen(ctx);
424     write_char(ctx, screen, 0);
425 }
426
427 static void handle_char(CCaptionSubContext *ctx, char hi, char lo, int64_t pts)
428 {
429     struct Screen *screen = get_writing_screen(ctx);
430
431     SET_FLAG(screen->row_used, ctx->cursor_row);
432
433     write_char(ctx, screen, hi);
434
435     if (lo) {
436         write_char(ctx, screen, lo);
437     }
438     write_char(ctx, screen, 0);
439
440     /* reset prev command since character can repeat */
441     ctx->prev_cmd[0] = 0;
442     ctx->prev_cmd[1] = 0;
443     if (lo)
444        ff_dlog(ctx, "(%c,%c)\n", hi, lo);
445     else
446        ff_dlog(ctx, "(%c)\n", hi);
447 }
448
449 static void process_cc608(CCaptionSubContext *ctx, int64_t pts, uint8_t hi, uint8_t lo)
450 {
451     if (hi == ctx->prev_cmd[0] && lo == ctx->prev_cmd[1]) {
452         /* ignore redundant command */
453     } else if ( (hi == 0x10 && (lo >= 0x40 && lo <= 0x5f)) ||
454               ( (hi >= 0x11 && hi <= 0x17) && (lo >= 0x40 && lo <= 0x7f) ) ) {
455         handle_pac(ctx, hi, lo);
456     } else if ( ( hi == 0x11 && lo >= 0x20 && lo <= 0x2f ) ||
457                 ( hi == 0x17 && lo >= 0x2e && lo <= 0x2f) ) {
458         handle_textattr(ctx, hi, lo);
459     } else if (hi == 0x14 || hi == 0x15 || hi == 0x1c) {
460         switch (lo) {
461         case 0x20:
462             /* resume caption loading */
463             ctx->mode = CCMODE_POPON;
464             break;
465         case 0x24:
466             handle_delete_end_of_row(ctx, hi, lo);
467             break;
468         case 0x25:
469             ctx->rollup = 2;
470             ctx->mode = CCMODE_ROLLUP;
471             break;
472         case 0x26:
473             ctx->rollup = 3;
474             ctx->mode = CCMODE_ROLLUP;
475             break;
476         case 0x27:
477             ctx->rollup = 4;
478             ctx->mode = CCMODE_ROLLUP;
479             break;
480         case 0x29:
481             /* resume direct captioning */
482             ctx->mode = CCMODE_PAINTON;
483             break;
484         case 0x2b:
485             /* resume text display */
486             ctx->mode = CCMODE_TEXT;
487             break;
488         case 0x2c:
489             /* erase display memory */
490             handle_edm(ctx, pts);
491             break;
492         case 0x2d:
493             /* carriage return */
494             ff_dlog(ctx, "carriage return\n");
495             reap_screen(ctx, pts);
496             roll_up(ctx);
497             ctx->cursor_column = 0;
498             break;
499         case 0x2f:
500             /* end of caption */
501             ff_dlog(ctx, "handle_eoc\n");
502             handle_eoc(ctx, pts);
503             break;
504         default:
505             ff_dlog(ctx, "Unknown command 0x%hhx 0x%hhx\n", hi, lo);
506             break;
507         }
508     } else if (hi >= 0x20) {
509         /* Standard characters (always in pairs) */
510         handle_char(ctx, hi, lo, pts);
511     } else {
512         /* Ignoring all other non data code */
513         ff_dlog(ctx, "Unknown command 0x%hhx 0x%hhx\n", hi, lo);
514     }
515
516     /* set prev command */
517     ctx->prev_cmd[0] = hi;
518     ctx->prev_cmd[1] = lo;
519 }
520
521 static int decode(AVCodecContext *avctx, void *data, int *got_sub, AVPacket *avpkt)
522 {
523     CCaptionSubContext *ctx = avctx->priv_data;
524     AVSubtitle *sub = data;
525     uint8_t *bptr = NULL;
526     int len = avpkt->size;
527     int ret = 0;
528     int i;
529
530     if (ctx->pktbuf->size < len) {
531         ret = av_buffer_realloc(&ctx->pktbuf, len);
532          if (ret < 0) {
533             av_log(ctx, AV_LOG_WARNING, "Insufficient Memory of %d truncated to %d\n", len, ctx->pktbuf->size);
534             len = ctx->pktbuf->size;
535             ret = 0;
536         }
537     }
538     memcpy(ctx->pktbuf->data, avpkt->data, len);
539     bptr = ctx->pktbuf->data;
540
541     for (i  = 0; i < len; i += 3) {
542         uint8_t cc_type = *(bptr + i) & 3;
543         if (validate_cc_data_pair(bptr + i))
544             continue;
545         /* ignoring data field 1 */
546         if(cc_type == 1)
547             continue;
548         else
549             process_cc608(ctx, avpkt->pts, *(bptr + i + 1) & 0x7f, *(bptr + i + 2) & 0x7f);
550         if (ctx->buffer_changed && *ctx->buffer.str)
551         {
552             int start_time = av_rescale_q(ctx->start_time, avctx->time_base, ass_tb);
553             int end_time = av_rescale_q(ctx->end_time, avctx->time_base, ass_tb);
554             ff_dlog(ctx, "cdp writing data (%s)\n",ctx->buffer.str);
555             ret = ff_ass_add_rect_bprint(sub, &ctx->buffer, start_time, end_time - start_time);
556             if (ret < 0)
557                 return ret;
558             sub->pts = av_rescale_q(ctx->start_time, avctx->time_base, AV_TIME_BASE_Q);
559             ctx->buffer_changed = 0;
560         }
561     }
562
563     *got_sub = sub->num_rects > 0;
564     return ret;
565 }
566
567 static const AVOption options[] = {
568     {NULL}
569 };
570
571 static const AVClass ccaption_dec_class = {
572     .class_name = "Closed caption Decoder",
573     .item_name  = av_default_item_name,
574     .option     = options,
575     .version    = LIBAVUTIL_VERSION_INT,
576 };
577
578 AVCodec ff_ccaption_decoder = {
579     .name           = "cc_dec",
580     .long_name      = NULL_IF_CONFIG_SMALL("Closed Caption (EIA-608 / CEA-708) Decoder"),
581     .type           = AVMEDIA_TYPE_SUBTITLE,
582     .id             = AV_CODEC_ID_EIA_608,
583     .priv_data_size = sizeof(CCaptionSubContext),
584     .init           = init_decoder,
585     .close          = close_decoder,
586     .decode         = decode,
587     .priv_class     = &ccaption_dec_class,
588 };