]> git.sesse.net Git - ffmpeg/blob - libavcodec/movtextdec.c
e46c932c2087510e807ac48f794b5dd9bae5b922
[ffmpeg] / libavcodec / movtextdec.c
1 /*
2  * 3GPP TS 26.245 Timed Text decoder
3  * Copyright (c) 2012  Philip Langdale <philipl@overt.org>
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 #include "libavutil/avstring.h"
26 #include "libavutil/common.h"
27 #include "libavutil/bprint.h"
28 #include "libavutil/intreadwrite.h"
29 #include "libavutil/mem.h"
30
31 #define STYLE_FLAG_BOLD         (1<<0)
32 #define STYLE_FLAG_ITALIC       (1<<1)
33 #define STYLE_FLAG_UNDERLINE    (1<<2)
34
35 #define BOX_SIZE_INITIAL    40
36
37 #define STYL_BOX   (1<<0)
38 #define HLIT_BOX   (1<<1)
39 #define HCLR_BOX   (1<<2)
40 #define TWRP_BOX   (1<<3)
41
42 #define BOTTOM_LEFT     1
43 #define BOTTOM_CENTER   2
44 #define BOTTOM_RIGHT    3
45 #define MIDDLE_LEFT     4
46 #define MIDDLE_CENTER   5
47 #define MIDDLE_RIGHT    6
48 #define TOP_LEFT        7
49 #define TOP_CENTER      8
50 #define TOP_RIGHT       9
51
52 #define RGB_TO_BGR(c) (((c) & 0xff) << 16 | ((c) & 0xff00) | (((c) >> 16) & 0xff))
53
54 typedef struct {
55     uint16_t fontID;
56     const char *font;
57     uint8_t fontsize;
58     int color;
59     uint8_t alpha;
60     int back_color;
61     uint8_t back_alpha;
62     uint8_t bold;
63     uint8_t italic;
64     uint8_t underline;
65     int alignment;
66 } MovTextDefault;
67
68 typedef struct {
69     uint16_t fontID;
70     char *font;
71 } FontRecord;
72
73 typedef struct {
74     uint16_t style_start;
75     uint16_t style_end;
76     uint8_t style_flag;
77     uint8_t bold;
78     uint8_t italic;
79     uint8_t underline;
80     int color;
81     uint8_t alpha;
82     uint8_t fontsize;
83     uint16_t style_fontID;
84 } StyleBox;
85
86 typedef struct {
87     uint16_t hlit_start;
88     uint16_t hlit_end;
89 } HighlightBox;
90
91 typedef struct {
92    uint8_t hlit_color[4];
93 } HilightcolorBox;
94
95 typedef struct {
96     uint8_t wrap_flag;
97 } TextWrapBox;
98
99 typedef struct {
100     AVClass *class;
101     StyleBox **s;
102     StyleBox *s_temp;
103     HighlightBox h;
104     HilightcolorBox c;
105     FontRecord *ftab;
106     TextWrapBox w;
107     MovTextDefault d;
108     uint8_t box_flags;
109     uint16_t style_entries, ftab_entries;
110     uint64_t tracksize;
111     int size_var;
112     int count_s;
113     int readorder;
114     int frame_width;
115     int frame_height;
116 } MovTextContext;
117
118 typedef struct {
119     uint32_t type;
120     size_t base_size;
121     int (*decode)(const uint8_t *tsmb, MovTextContext *m, AVPacket *avpkt);
122 } Box;
123
124 static void mov_text_cleanup(MovTextContext *m)
125 {
126     int i;
127     if (m->box_flags & STYL_BOX) {
128         for(i = 0; i < m->count_s; i++) {
129             av_freep(&m->s[i]);
130         }
131         av_freep(&m->s);
132         m->count_s = 0;
133         m->style_entries = 0;
134     }
135 }
136
137 static void mov_text_cleanup_ftab(MovTextContext *m)
138 {
139     for (unsigned i = 0; i < m->ftab_entries; i++)
140         av_freep(&m->ftab[i].font);
141     av_freep(&m->ftab);
142     m->ftab_entries = 0;
143 }
144
145 static int mov_text_tx3g(AVCodecContext *avctx, MovTextContext *m)
146 {
147     uint8_t *tx3g_ptr = avctx->extradata;
148     int i, font_length, remaining = avctx->extradata_size - BOX_SIZE_INITIAL;
149     int8_t v_align, h_align;
150     unsigned ftab_entries;
151     StyleBox s_default;
152
153     m->ftab_entries = 0;
154     if (remaining < 0)
155         return -1;
156
157     // Display Flags
158     tx3g_ptr += 4;
159     // Alignment
160     h_align = *tx3g_ptr++;
161     v_align = *tx3g_ptr++;
162     if (h_align == 0) {
163         if (v_align == 0)
164             m->d.alignment = TOP_LEFT;
165         if (v_align == 1)
166             m->d.alignment = MIDDLE_LEFT;
167         if (v_align == -1)
168             m->d.alignment = BOTTOM_LEFT;
169     }
170     if (h_align == 1) {
171         if (v_align == 0)
172             m->d.alignment = TOP_CENTER;
173         if (v_align == 1)
174             m->d.alignment = MIDDLE_CENTER;
175         if (v_align == -1)
176             m->d.alignment = BOTTOM_CENTER;
177     }
178     if (h_align == -1) {
179         if (v_align == 0)
180             m->d.alignment = TOP_RIGHT;
181         if (v_align == 1)
182             m->d.alignment = MIDDLE_RIGHT;
183         if (v_align == -1)
184             m->d.alignment = BOTTOM_RIGHT;
185     }
186     // Background Color
187     m->d.back_color = AV_RB24(tx3g_ptr);
188     tx3g_ptr += 3;
189     m->d.back_alpha = AV_RB8(tx3g_ptr);
190     tx3g_ptr += 1;
191     // BoxRecord
192     tx3g_ptr += 8;
193     // StyleRecord
194     tx3g_ptr += 4;
195     // fontID
196     m->d.fontID = AV_RB16(tx3g_ptr);
197     tx3g_ptr += 2;
198     // face-style-flags
199     s_default.style_flag = *tx3g_ptr++;
200     m->d.bold = !!(s_default.style_flag & STYLE_FLAG_BOLD);
201     m->d.italic = !!(s_default.style_flag & STYLE_FLAG_ITALIC);
202     m->d.underline = !!(s_default.style_flag & STYLE_FLAG_UNDERLINE);
203     // fontsize
204     m->d.fontsize = *tx3g_ptr++;
205     // Primary color
206     m->d.color = AV_RB24(tx3g_ptr);
207     tx3g_ptr += 3;
208     m->d.alpha = AV_RB8(tx3g_ptr);
209     tx3g_ptr += 1;
210     // FontRecord
211     // FontRecord Size
212     tx3g_ptr += 4;
213     // ftab
214     tx3g_ptr += 4;
215
216     // In case of broken header, init default font
217     m->d.font = ASS_DEFAULT_FONT;
218
219     ftab_entries = AV_RB16(tx3g_ptr);
220     if (!ftab_entries)
221         return 0;
222     remaining   -= 3 * ftab_entries;
223     if (remaining < 0)
224         return AVERROR_INVALIDDATA;
225     m->ftab = av_calloc(ftab_entries, sizeof(*m->ftab));
226     if (!m->ftab)
227         return AVERROR(ENOMEM);
228     m->ftab_entries = ftab_entries;
229     tx3g_ptr += 2;
230
231     for (i = 0; i < m->ftab_entries; i++) {
232         m->ftab[i].fontID = AV_RB16(tx3g_ptr);
233         tx3g_ptr += 2;
234         font_length = *tx3g_ptr++;
235
236         remaining  -= font_length;
237         if (remaining < 0) {
238             mov_text_cleanup_ftab(m);
239             return -1;
240         }
241         m->ftab[i].font = av_malloc(font_length + 1);
242         if (!m->ftab[i].font) {
243             mov_text_cleanup_ftab(m);
244             return AVERROR(ENOMEM);
245         }
246         memcpy(m->ftab[i].font, tx3g_ptr, font_length);
247         m->ftab[i].font[font_length] = '\0';
248         tx3g_ptr = tx3g_ptr + font_length;
249     }
250     for (i = 0; i < m->ftab_entries; i++) {
251         if (m->d.fontID == m->ftab[i].fontID)
252             m->d.font = m->ftab[i].font;
253     }
254     return 0;
255 }
256
257 static int decode_twrp(const uint8_t *tsmb, MovTextContext *m, AVPacket *avpkt)
258 {
259     m->box_flags |= TWRP_BOX;
260     m->w.wrap_flag = *tsmb++;
261     return 0;
262 }
263
264 static int decode_hlit(const uint8_t *tsmb, MovTextContext *m, AVPacket *avpkt)
265 {
266     m->box_flags |= HLIT_BOX;
267     m->h.hlit_start = AV_RB16(tsmb);
268     tsmb += 2;
269     m->h.hlit_end = AV_RB16(tsmb);
270     tsmb += 2;
271     return 0;
272 }
273
274 static int decode_hclr(const uint8_t *tsmb, MovTextContext *m, AVPacket *avpkt)
275 {
276     m->box_flags |= HCLR_BOX;
277     memcpy(m->c.hlit_color, tsmb, 4);
278     tsmb += 4;
279     return 0;
280 }
281
282 static int decode_styl(const uint8_t *tsmb, MovTextContext *m, AVPacket *avpkt)
283 {
284     int i;
285     int style_entries = AV_RB16(tsmb);
286     tsmb += 2;
287     // A single style record is of length 12 bytes.
288     if (m->tracksize + m->size_var + 2 + style_entries * 12 > avpkt->size)
289         return -1;
290
291     m->style_entries = style_entries;
292
293     m->box_flags |= STYL_BOX;
294     for(i = 0; i < m->style_entries; i++) {
295         m->s_temp = av_malloc(sizeof(*m->s_temp));
296         if (!m->s_temp) {
297             mov_text_cleanup(m);
298             return AVERROR(ENOMEM);
299         }
300         m->s_temp->style_start = AV_RB16(tsmb);
301         tsmb += 2;
302         m->s_temp->style_end = AV_RB16(tsmb);
303
304         if (   m->s_temp->style_end < m->s_temp->style_start
305             || (m->count_s && m->s_temp->style_start < m->s[m->count_s - 1]->style_end)) {
306             av_freep(&m->s_temp);
307             mov_text_cleanup(m);
308             return AVERROR(ENOMEM);
309         }
310
311         tsmb += 2;
312         m->s_temp->style_fontID = AV_RB16(tsmb);
313         tsmb += 2;
314         m->s_temp->style_flag = AV_RB8(tsmb);
315         m->s_temp->bold = !!(m->s_temp->style_flag & STYLE_FLAG_BOLD);
316         m->s_temp->italic = !!(m->s_temp->style_flag & STYLE_FLAG_ITALIC);
317         m->s_temp->underline = !!(m->s_temp->style_flag & STYLE_FLAG_UNDERLINE);
318         tsmb++;
319         m->s_temp->fontsize = AV_RB8(tsmb);
320         tsmb++;
321         m->s_temp->color = AV_RB24(tsmb);
322         tsmb += 3;
323         m->s_temp->alpha = AV_RB8(tsmb);
324         tsmb++;
325         av_dynarray_add(&m->s, &m->count_s, m->s_temp);
326         if(!m->s) {
327             mov_text_cleanup(m);
328             return AVERROR(ENOMEM);
329         }
330     }
331     return 0;
332 }
333
334 static const Box box_types[] = {
335     { MKBETAG('s','t','y','l'), 2, decode_styl },
336     { MKBETAG('h','l','i','t'), 4, decode_hlit },
337     { MKBETAG('h','c','l','r'), 4, decode_hclr },
338     { MKBETAG('t','w','r','p'), 1, decode_twrp }
339 };
340
341 const static size_t box_count = FF_ARRAY_ELEMS(box_types);
342
343 // Return byte length of the UTF-8 sequence starting at text[0]. 0 on error.
344 static int get_utf8_length_at(const char *text, const char *text_end)
345 {
346     const char *start = text;
347     int err = 0;
348     uint32_t c;
349     GET_UTF8(c, text < text_end ? (uint8_t)*text++ : (err = 1, 0), goto error;);
350     if (err)
351         goto error;
352     return text - start;
353 error:
354     return 0;
355 }
356
357 static int text_to_ass(AVBPrint *buf, const char *text, const char *text_end,
358                        AVCodecContext *avctx)
359 {
360     MovTextContext *m = avctx->priv_data;
361     int i = 0;
362     int text_pos = 0;
363     int style_active = 0;
364     int entry = 0;
365     int color = m->d.color;
366
367     if (text < text_end && m->box_flags & TWRP_BOX) {
368         if (m->w.wrap_flag == 1) {
369             av_bprintf(buf, "{\\q1}"); /* End of line wrap */
370         } else {
371             av_bprintf(buf, "{\\q2}"); /* No wrap */
372         }
373     }
374
375     while (text < text_end) {
376         int len;
377
378         if ((m->box_flags & STYL_BOX) && entry < m->style_entries) {
379             if (text_pos == m->s[entry]->style_start) {
380                 style_active = 1;
381                 if (m->s[entry]->bold ^ m->d.bold)
382                     av_bprintf(buf, "{\\b%d}", m->s[entry]->bold);
383                 if (m->s[entry]->italic ^ m->d.italic)
384                     av_bprintf(buf, "{\\i%d}", m->s[entry]->italic);
385                 if (m->s[entry]->underline ^ m->d.underline)
386                     av_bprintf(buf, "{\\u%d}", m->s[entry]->underline);
387                 if (m->s[entry]->fontsize != m->d.fontsize)
388                     av_bprintf(buf, "{\\fs%d}", m->s[entry]->fontsize);
389                 if (m->s[entry]->style_fontID != m->d.fontID)
390                     for (i = 0; i < m->ftab_entries; i++) {
391                         if (m->s[entry]->style_fontID == m->ftab[i].fontID)
392                             av_bprintf(buf, "{\\fn%s}", m->ftab[i].font);
393                     }
394                 if (m->d.color != m->s[entry]->color) {
395                     color = m->s[entry]->color;
396                     av_bprintf(buf, "{\\1c&H%X&}", RGB_TO_BGR(color));
397                 }
398                 if (m->d.alpha != m->s[entry]->alpha)
399                     av_bprintf(buf, "{\\1a&H%02X&}", 255 - m->s[entry]->alpha);
400             }
401             if (text_pos == m->s[entry]->style_end) {
402                 if (style_active) {
403                     av_bprintf(buf, "{\\r}");
404                     style_active = 0;
405                     color = m->d.color;
406                 }
407                 entry++;
408             }
409         }
410         if (m->box_flags & HLIT_BOX) {
411             if (text_pos == m->h.hlit_start) {
412                 /* If hclr box is present, set the secondary color to the color
413                  * specified. Otherwise, set primary color to white and secondary
414                  * color to black. These colors will come from TextSampleModifier
415                  * boxes in future and inverse video technique for highlight will
416                  * be implemented.
417                  */
418                 if (m->box_flags & HCLR_BOX) {
419                     av_bprintf(buf, "{\\2c&H%02x%02x%02x&}", m->c.hlit_color[2],
420                                 m->c.hlit_color[1], m->c.hlit_color[0]);
421                 } else {
422                     av_bprintf(buf, "{\\1c&H000000&}{\\2c&HFFFFFF&}");
423                 }
424             }
425             if (text_pos == m->h.hlit_end) {
426                 if (m->box_flags & HCLR_BOX) {
427                     av_bprintf(buf, "{\\2c&H%X&}", RGB_TO_BGR(m->d.color));
428                 } else {
429                     av_bprintf(buf, "{\\1c&H%X&}{\\2c&H%X&}",
430                                RGB_TO_BGR(color), RGB_TO_BGR(m->d.color));
431                 }
432             }
433         }
434
435         len = get_utf8_length_at(text, text_end);
436         if (len < 1) {
437             av_log(avctx, AV_LOG_ERROR, "invalid UTF-8 byte in subtitle\n");
438             len = 1;
439         }
440         for (i = 0; i < len; i++) {
441             switch (*text) {
442             case '\r':
443                 break;
444             case '\n':
445                 av_bprintf(buf, "\\N");
446                 break;
447             default:
448                 av_bprint_chars(buf, *text, 1);
449                 break;
450             }
451             text++;
452         }
453         text_pos++;
454     }
455
456     return 0;
457 }
458
459 static int mov_text_init(AVCodecContext *avctx) {
460     /*
461      * TODO: Handle the default text style.
462      * NB: Most players ignore styles completely, with the result that
463      * it's very common to find files where the default style is broken
464      * and respecting it results in a worse experience than ignoring it.
465      */
466     int ret;
467     MovTextContext *m = avctx->priv_data;
468     ret = mov_text_tx3g(avctx, m);
469     if (ret == 0) {
470         if (!m->frame_width || !m->frame_height) {
471             m->frame_width = ASS_DEFAULT_PLAYRESX;
472             m->frame_height = ASS_DEFAULT_PLAYRESY;
473         }
474         return ff_ass_subtitle_header_full(avctx,
475                     m->frame_width, m->frame_height,
476                     m->d.font, m->d.fontsize,
477                     (255U - m->d.alpha) << 24 | RGB_TO_BGR(m->d.color),
478                     (255U - m->d.alpha) << 24 | RGB_TO_BGR(m->d.color),
479                     (255U - m->d.back_alpha) << 24 | RGB_TO_BGR(m->d.back_color),
480                     (255U - m->d.back_alpha) << 24 | RGB_TO_BGR(m->d.back_color),
481                     m->d.bold, m->d.italic, m->d.underline,
482                     ASS_DEFAULT_BORDERSTYLE, m->d.alignment);
483     } else
484         return ff_ass_subtitle_header_default(avctx);
485 }
486
487 static int mov_text_decode_frame(AVCodecContext *avctx,
488                             void *data, int *got_sub_ptr, AVPacket *avpkt)
489 {
490     AVSubtitle *sub = data;
491     MovTextContext *m = avctx->priv_data;
492     int ret;
493     AVBPrint buf;
494     char *ptr = avpkt->data;
495     char *end;
496     int text_length, tsmb_type, ret_tsmb;
497     uint64_t tsmb_size;
498     const uint8_t *tsmb;
499     size_t i;
500
501     if (!ptr || avpkt->size < 2)
502         return AVERROR_INVALIDDATA;
503
504     /*
505      * A packet of size two with value zero is an empty subtitle
506      * used to mark the end of the previous non-empty subtitle.
507      * We can just drop them here as we have duration information
508      * already. If the value is non-zero, then it's technically a
509      * bad packet.
510      */
511     if (avpkt->size == 2)
512         return AV_RB16(ptr) == 0 ? 0 : AVERROR_INVALIDDATA;
513
514     /*
515      * The first two bytes of the packet are the length of the text string
516      * In complex cases, there are style descriptors appended to the string
517      * so we can't just assume the packet size is the string size.
518      */
519     text_length = AV_RB16(ptr);
520     end = ptr + FFMIN(2 + text_length, avpkt->size);
521     ptr += 2;
522
523     mov_text_cleanup(m);
524
525     tsmb_size = 0;
526     m->tracksize = 2 + text_length;
527     m->style_entries = 0;
528     m->box_flags = 0;
529     m->count_s = 0;
530     // Note that the spec recommends lines be no longer than 2048 characters.
531     av_bprint_init(&buf, 0, AV_BPRINT_SIZE_UNLIMITED);
532     if (text_length + 2 != avpkt->size) {
533         while (m->tracksize + 8 <= avpkt->size) {
534             // A box is a minimum of 8 bytes.
535             tsmb = ptr + m->tracksize - 2;
536             tsmb_size = AV_RB32(tsmb);
537             tsmb += 4;
538             tsmb_type = AV_RB32(tsmb);
539             tsmb += 4;
540
541             if (tsmb_size == 1) {
542                 if (m->tracksize + 16 > avpkt->size)
543                     break;
544                 tsmb_size = AV_RB64(tsmb);
545                 tsmb += 8;
546                 m->size_var = 16;
547             } else
548                 m->size_var = 8;
549             //size_var is equal to 8 or 16 depending on the size of box
550
551             if (tsmb_size == 0) {
552                 av_log(avctx, AV_LOG_ERROR, "tsmb_size is 0\n");
553                 return AVERROR_INVALIDDATA;
554             }
555
556             if (tsmb_size > avpkt->size - m->tracksize)
557                 break;
558
559             for (i = 0; i < box_count; i++) {
560                 if (tsmb_type == box_types[i].type) {
561                     if (m->tracksize + m->size_var + box_types[i].base_size > avpkt->size)
562                         break;
563                     ret_tsmb = box_types[i].decode(tsmb, m, avpkt);
564                     if (ret_tsmb == -1)
565                         break;
566                 }
567             }
568             m->tracksize = m->tracksize + tsmb_size;
569         }
570         text_to_ass(&buf, ptr, end, avctx);
571         mov_text_cleanup(m);
572     } else
573         text_to_ass(&buf, ptr, end, avctx);
574
575     ret = ff_ass_add_rect(sub, buf.str, m->readorder++, 0, NULL, NULL);
576     av_bprint_finalize(&buf, NULL);
577     if (ret < 0)
578         return ret;
579     *got_sub_ptr = sub->num_rects > 0;
580     return avpkt->size;
581 }
582
583 static int mov_text_decode_close(AVCodecContext *avctx)
584 {
585     MovTextContext *m = avctx->priv_data;
586     mov_text_cleanup_ftab(m);
587     mov_text_cleanup(m);
588     return 0;
589 }
590
591 static void mov_text_flush(AVCodecContext *avctx)
592 {
593     MovTextContext *m = avctx->priv_data;
594     if (!(avctx->flags2 & AV_CODEC_FLAG2_RO_FLUSH_NOOP))
595         m->readorder = 0;
596 }
597
598 #define OFFSET(x) offsetof(MovTextContext, x)
599 #define FLAGS AV_OPT_FLAG_DECODING_PARAM | AV_OPT_FLAG_SUBTITLE_PARAM
600 static const AVOption options[] = {
601     { "width", "Frame width, usually video width", OFFSET(frame_width), AV_OPT_TYPE_INT, {.i64=0}, 0, INT_MAX, FLAGS },
602     { "height", "Frame height, usually video height", OFFSET(frame_height), AV_OPT_TYPE_INT, {.i64=0}, 0, INT_MAX, FLAGS },
603     { NULL },
604 };
605
606 static const AVClass mov_text_decoder_class = {
607     .class_name = "MOV text decoder",
608     .item_name  = av_default_item_name,
609     .option     = options,
610     .version    = LIBAVUTIL_VERSION_INT,
611 };
612
613 AVCodec ff_movtext_decoder = {
614     .name         = "mov_text",
615     .long_name    = NULL_IF_CONFIG_SMALL("3GPP Timed Text subtitle"),
616     .type         = AVMEDIA_TYPE_SUBTITLE,
617     .id           = AV_CODEC_ID_MOV_TEXT,
618     .priv_data_size = sizeof(MovTextContext),
619     .priv_class   = &mov_text_decoder_class,
620     .init         = mov_text_init,
621     .decode       = mov_text_decode_frame,
622     .close        = mov_text_decode_close,
623     .flush        = mov_text_flush,
624 };