lavf/jacosubdec: use subtitles queue API.
[ffmpeg.git] / libavformat / jacosubdec.c
1 /*
2  * Copyright (c) 2012 Clément Bœsch
3  *
4  * This file is part of FFmpeg.
5  *
6  * FFmpeg is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * FFmpeg is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with FFmpeg; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20
21 /**
22  * @file
23  * JACOsub subtitle demuxer
24  * @see http://unicorn.us.com/jacosub/jscripts.html
25  * @todo Support P[ALETTE] directive.
26  */
27
28 #include "avformat.h"
29 #include "internal.h"
30 #include "subtitles.h"
31 #include "libavcodec/jacosub.h"
32 #include "libavutil/avstring.h"
33 #include "libavutil/bprint.h"
34 #include "libavutil/intreadwrite.h"
35
36 typedef struct {
37     int shift;
38     unsigned timeres;
39     FFDemuxSubtitlesQueue q;
40 } JACOsubContext;
41
42 static int timed_line(const char *ptr)
43 {
44     char c;
45     return (sscanf(ptr, "%*u:%*u:%*u.%*u %*u:%*u:%*u.%*u %c", &c) == 1 ||
46             sscanf(ptr, "@%*u @%*u %c",                       &c) == 1);
47 }
48
49 static int jacosub_probe(AVProbeData *p)
50 {
51     const char *ptr     = p->buf;
52     const char *ptr_end = p->buf + p->buf_size;
53
54     if (AV_RB24(ptr) == 0xEFBBBF)
55         ptr += 3; /* skip UTF-8 BOM */
56
57     while (ptr < ptr_end) {
58         while (jss_whitespace(*ptr))
59             ptr++;
60         if (*ptr != '#' && *ptr != '\n') {
61             if (timed_line(ptr))
62                 return AVPROBE_SCORE_MAX/2 + 1;
63             return 0;
64         }
65         ptr += strcspn(ptr, "\n") + 1;
66     }
67     return 0;
68 }
69
70 static const char * const cmds[] = {
71     "CLOCKPAUSE",
72     "DIRECTIVE",
73     "FONT",
74     "HRES",
75     "INCLUDE",
76     "PALETTE",
77     "QUANTIZE",
78     "RAMP",
79     "SHIFT",
80     "TIMERES",
81 };
82
83 static int get_jss_cmd(char k)
84 {
85     int i;
86
87     k = av_toupper(k);
88     for (i = 0; i < FF_ARRAY_ELEMS(cmds); i++)
89         if (k == cmds[i][0])
90             return i;
91     return -1;
92 }
93
94 static int jacosub_read_close(AVFormatContext *s)
95 {
96     JACOsubContext *jacosub = s->priv_data;
97     ff_subtitles_queue_clean(&jacosub->q);
98     return 0;
99 }
100
101 static const char *read_ts(JACOsubContext *jacosub, const char *buf,
102                            int64_t *start, int *duration)
103 {
104     int len;
105     unsigned hs, ms, ss, fs; // hours, minutes, seconds, frame start
106     unsigned he, me, se, fe; // hours, minutes, seconds, frame end
107     int ts_start, ts_end;
108
109     /* timed format */
110     if (sscanf(buf, "%u:%u:%u.%u %u:%u:%u.%u %n",
111                &hs, &ms, &ss, &fs,
112                &he, &me, &se, &fe, &len) == 8) {
113         ts_start = (hs*3600 + ms*60 + ss) * jacosub->timeres + fs;
114         ts_end   = (he*3600 + me*60 + se) * jacosub->timeres + fe;
115         goto shift_and_ret;
116     }
117
118     /* timestamps format */
119     if (sscanf(buf, "@%u @%u %n", &ts_start, &ts_end, &len) == 2)
120         goto shift_and_ret;
121
122     return NULL;
123
124 shift_and_ret:
125     ts_start  = (ts_start + jacosub->shift) * 100 / jacosub->timeres;
126     ts_end    = (ts_end   + jacosub->shift) * 100 / jacosub->timeres;
127     *start    = ts_start;
128     *duration = ts_start + ts_end;
129     return buf + len;
130 }
131
132 static int get_shift(int timeres, const char *buf)
133 {
134     int sign = 1;
135     int a = 0, b = 0, c = 0, d = 0;
136 #define SSEP "%*1[.:]"
137     int n = sscanf(buf, "%d"SSEP"%d"SSEP"%d"SSEP"%d", &a, &b, &c, &d);
138 #undef SSEP
139
140     if (*buf == '-' || a < 0) {
141         sign = -1;
142         a = FFABS(a);
143     }
144
145     switch (n) {
146     case 4: return sign * ((a*3600 + b*60 + c) * timeres + d);
147     case 3: return sign * ((         a*60 + b) * timeres + c);
148     case 2: return sign * ((                a) * timeres + b);
149     }
150
151     return 0;
152 }
153
154 static int jacosub_read_header(AVFormatContext *s)
155 {
156     AVBPrint header;
157     AVIOContext *pb = s->pb;
158     char line[JSS_MAX_LINESIZE];
159     JACOsubContext *jacosub = s->priv_data;
160     int shift_set = 0; // only the first shift matters
161     int merge_line = 0;
162     int i;
163
164     AVStream *st = avformat_new_stream(s, NULL);
165     if (!st)
166         return AVERROR(ENOMEM);
167     avpriv_set_pts_info(st, 64, 1, 100);
168     st->codec->codec_type = AVMEDIA_TYPE_SUBTITLE;
169     st->codec->codec_id   = CODEC_ID_JACOSUB;
170
171     jacosub->timeres = 30;
172
173     av_bprint_init(&header, 1024+FF_INPUT_BUFFER_PADDING_SIZE, 4096);
174
175     while (!url_feof(pb)) {
176         int cmd_len;
177         const char *p = line;
178         int64_t pos = avio_tell(pb);
179         int len = ff_get_line(pb, line, sizeof(line));
180
181         p = jss_skip_whitespace(p);
182
183         /* queue timed line */
184         if (merge_line || timed_line(p)) {
185             AVPacket *sub;
186
187             sub = ff_subtitles_queue_insert(&jacosub->q, line, len, merge_line);
188             if (!sub)
189                 return AVERROR(ENOMEM);
190             sub->pos = pos;
191             merge_line = len > 1 && !strcmp(&line[len - 2], "\\\n");
192             continue;
193         }
194
195         /* skip all non-compiler commands and focus on the command */
196         if (*p != '#')
197             continue;
198         p++;
199         i = get_jss_cmd(p[0]);
200         if (i == -1)
201             continue;
202
203         /* trim command + spaces */
204         cmd_len = strlen(cmds[i]);
205         if (av_strncasecmp(p, cmds[i], cmd_len) == 0)
206             p += cmd_len;
207         else
208             p++;
209         p = jss_skip_whitespace(p);
210
211         /* handle commands which affect the whole script */
212         switch (cmds[i][0]) {
213         case 'S': // SHIFT command affect the whole script...
214             if (!shift_set) {
215                 jacosub->shift = get_shift(jacosub->timeres, p);
216                 shift_set = 1;
217             }
218             av_bprintf(&header, "#S %s", p);
219             break;
220         case 'T': // ...but must be placed after TIMERES
221             jacosub->timeres = strtol(p, NULL, 10);
222             av_bprintf(&header, "#T %s", p);
223             break;
224         }
225     }
226
227     /* general/essential directives in the extradata */
228     av_bprint_finalize(&header, (char **)&st->codec->extradata);
229     st->codec->extradata_size = header.len + 1;
230
231     /* SHIFT and TIMERES affect the whole script so packet timing can only be
232      * done in a second pass */
233     for (i = 0; i < jacosub->q.nb_subs; i++) {
234         AVPacket *sub = &jacosub->q.subs[i];
235         read_ts(jacosub, sub->data, &sub->pts, &sub->duration);
236     }
237     ff_subtitles_queue_finalize(&jacosub->q);
238
239     return 0;
240 }
241
242 static int jacosub_read_packet(AVFormatContext *s, AVPacket *pkt)
243 {
244     JACOsubContext *jacosub = s->priv_data;
245     return ff_subtitles_queue_read_packet(&jacosub->q, pkt);
246 }
247
248 AVInputFormat ff_jacosub_demuxer = {
249     .name           = "jacosub",
250     .long_name      = NULL_IF_CONFIG_SMALL("JACOsub subtitle format"),
251     .priv_data_size = sizeof(JACOsubContext),
252     .read_probe     = jacosub_probe,
253     .read_header    = jacosub_read_header,
254     .read_packet    = jacosub_read_packet,
255     .read_close     = jacosub_read_close,
256     .flags          = AVFMT_GENERIC_INDEX,
257 };