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