movtextdec.c: Improve upon dynarrays and text_to_ass
[ffmpeg.git] / 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/avstring.h"
25 #include "libavutil/common.h"
26 #include "libavutil/bprint.h"
27 #include "libavutil/intreadwrite.h"
28 #include "libavutil/mem.h"
29
30 #define STYLE_FLAG_BOLD         (1<<0)
31 #define STYLE_FLAG_ITALIC       (1<<1)
32 #define STYLE_FLAG_UNDERLINE    (1<<2)
33
34 typedef struct {
35     uint16_t style_start;
36     uint16_t style_end;
37     uint8_t style_flag;
38 } StyleBox;
39
40 static int text_to_ass(AVBPrint *buf, const char *text, const char *text_end,
41                         StyleBox **s, int style_entries)
42 {
43     int i = 0;
44     int text_pos = 0;
45     while (text < text_end) {
46         for (i = 0; i < style_entries; i++) {
47             if (s[i]->style_flag && text_pos == s[i]->style_end) {
48                 if (s[i]->style_flag & STYLE_FLAG_BOLD)
49                     av_bprintf(buf, "{\\b0}");
50                 if (s[i]->style_flag & STYLE_FLAG_ITALIC)
51                     av_bprintf(buf, "{\\i0}");
52                 if (s[i]->style_flag & STYLE_FLAG_UNDERLINE)
53                     av_bprintf(buf, "{\\u0}");
54             }
55         }
56
57         for (i = 0; i < style_entries; i++) {
58             if (s[i]->style_flag && text_pos == s[i]->style_start) {
59                 if (s[i]->style_flag & STYLE_FLAG_BOLD)
60                     av_bprintf(buf, "{\\b1}");
61                 if (s[i]->style_flag & STYLE_FLAG_ITALIC)
62                     av_bprintf(buf, "{\\i1}");
63                 if (s[i]->style_flag & STYLE_FLAG_UNDERLINE)
64                     av_bprintf(buf, "{\\u1}");
65             }
66         }
67
68         switch (*text) {
69         case '\r':
70             break;
71         case '\n':
72             av_bprintf(buf, "\\N");
73             break;
74         default:
75             av_bprint_chars(buf, *text, 1);
76             break;
77         }
78         text++;
79         text_pos++;
80     }
81
82     return 0;
83 }
84
85 static int mov_text_init(AVCodecContext *avctx) {
86     /*
87      * TODO: Handle the default text style.
88      * NB: Most players ignore styles completely, with the result that
89      * it's very common to find files where the default style is broken
90      * and respecting it results in a worse experience than ignoring it.
91      */
92     return ff_ass_subtitle_header_default(avctx);
93 }
94
95 static int mov_text_decode_frame(AVCodecContext *avctx,
96                             void *data, int *got_sub_ptr, AVPacket *avpkt)
97 {
98     AVSubtitle *sub = data;
99     int ret, ts_start, ts_end;
100     AVBPrint buf;
101     char *ptr = avpkt->data;
102     char *end;
103     //char *ptr_temp;
104     int text_length, tsmb_type, style_entries;
105     uint64_t tsmb_size, tracksize;
106     StyleBox **s = {0, };
107     StyleBox *s_temp;
108     const uint8_t *tsmb;
109     int count, i, size_var;
110
111     if (!ptr || avpkt->size < 2)
112         return AVERROR_INVALIDDATA;
113
114     /*
115      * A packet of size two with value zero is an empty subtitle
116      * used to mark the end of the previous non-empty subtitle.
117      * We can just drop them here as we have duration information
118      * already. If the value is non-zero, then it's technically a
119      * bad packet.
120      */
121     if (avpkt->size == 2)
122         return AV_RB16(ptr) == 0 ? 0 : AVERROR_INVALIDDATA;
123
124     /*
125      * The first two bytes of the packet are the length of the text string
126      * In complex cases, there are style descriptors appended to the string
127      * so we can't just assume the packet size is the string size.
128      */
129     text_length = AV_RB16(ptr);
130     end = ptr + FFMIN(2 + text_length, avpkt->size);
131     ptr += 2;
132
133     ts_start = av_rescale_q(avpkt->pts,
134                             avctx->time_base,
135                             (AVRational){1,100});
136     ts_end   = av_rescale_q(avpkt->pts + avpkt->duration,
137                             avctx->time_base,
138                             (AVRational){1,100});
139
140     tsmb_size = 0;
141     tracksize = 2 + text_length;
142     // Note that the spec recommends lines be no longer than 2048 characters.
143     av_bprint_init(&buf, 0, AV_BPRINT_SIZE_UNLIMITED);
144     if (text_length + 2 != avpkt->size) {
145         while (tracksize + 8 <= avpkt->size) {
146             // A box is a minimum of 8 bytes.
147             tsmb = ptr + tracksize - 2;
148             tsmb_size = AV_RB32(tsmb);
149             tsmb += 4;
150             tsmb_type = AV_RB32(tsmb);
151             tsmb += 4;
152
153             if (tsmb_size == 1) {
154                 if (tracksize + 16 > avpkt->size)
155                     break;
156                 tsmb_size = AV_RB64(tsmb);
157                 tsmb += 8;
158                 size_var = 18;
159             } else
160                 size_var = 10;
161             //size_var is equal to 10 or 18 depending on the size of box
162
163             if (tracksize + tsmb_size > avpkt->size)
164                 break;
165
166             if (tsmb_type == MKBETAG('s','t','y','l')) {
167                 if (tracksize + size_var > avpkt->size)
168                     break;
169                 style_entries = AV_RB16(tsmb);
170                 tsmb += 2;
171
172                 // A single style record is of length 12 bytes.
173                 if (tracksize + size_var + style_entries * 12 > avpkt->size)
174                     break;
175                 count = 0;
176
177                 for(i = 0; i < style_entries; i++) {
178                     s_temp = av_malloc(sizeof(*s_temp));
179                     if (!s_temp)
180                         goto error;
181
182                     s_temp->style_start = AV_RB16(tsmb);
183                     tsmb += 2;
184                     s_temp->style_end = AV_RB16(tsmb);
185                     tsmb += 2;
186                     // fontID = AV_RB16(tsmb);
187                     tsmb += 2;
188                     s_temp->style_flag = AV_RB8(tsmb);
189                     av_dynarray_add(&s, &count, s_temp);
190                     if(!s)
191                         goto error;
192                     //fontsize=AV_RB8(tsmb);
193                     tsmb += 2;
194                     // text-color-rgba
195                     tsmb += 4;
196                 }
197                 text_to_ass(&buf, ptr, end, s, style_entries);
198
199                 for(i = 0; i < count; i++) {
200                     av_freep(&s[i]);
201                 }
202                 av_freep(&s);
203             }
204             tracksize = tracksize + tsmb_size;
205         }
206     } else
207         text_to_ass(&buf, ptr, end, NULL, 0);
208
209     ret = ff_ass_add_rect_bprint(sub, &buf, ts_start, ts_end - ts_start);
210     av_bprint_finalize(&buf, NULL);
211     if (ret < 0)
212         return ret;
213     *got_sub_ptr = sub->num_rects > 0;
214     return avpkt->size;
215
216 error:
217     for(i = 0; i < count; i++) {
218         av_freep(&s[i]);
219     }
220     av_freep(&s);
221     if (s_temp)
222         av_freep(&s_temp);
223     av_bprint_finalize(&buf, NULL);
224     return AVERROR(ENOMEM);
225 }
226
227 AVCodec ff_movtext_decoder = {
228     .name         = "mov_text",
229     .long_name    = NULL_IF_CONFIG_SMALL("3GPP Timed Text subtitle"),
230     .type         = AVMEDIA_TYPE_SUBTITLE,
231     .id           = AV_CODEC_ID_MOV_TEXT,
232     .init         = mov_text_init,
233     .decode       = mov_text_decode_frame,
234 };