FFmpeg  2.1.1
jacosubdec.c
Go to the documentation of this file.
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/internal.h"
32 #include "libavcodec/jacosub.h"
33 #include "libavutil/avstring.h"
34 #include "libavutil/bprint.h"
35 #include "libavutil/intreadwrite.h"
36 
37 typedef struct {
38  int shift;
39  unsigned timeres;
42 
43 static int timed_line(const char *ptr)
44 {
45  char c;
46  return (sscanf(ptr, "%*u:%*u:%*u.%*u %*u:%*u:%*u.%*u %c", &c) == 1 ||
47  sscanf(ptr, "@%*u @%*u %c", &c) == 1);
48 }
49 
50 static int jacosub_probe(AVProbeData *p)
51 {
52  const char *ptr = p->buf;
53  const char *ptr_end = p->buf + p->buf_size;
54 
55  if (AV_RB24(ptr) == 0xEFBBBF)
56  ptr += 3; /* skip UTF-8 BOM */
57 
58  while (ptr < ptr_end) {
59  while (jss_whitespace(*ptr))
60  ptr++;
61  if (*ptr != '#' && *ptr != '\n') {
62  if (timed_line(ptr))
63  return AVPROBE_SCORE_EXTENSION + 1;
64  return 0;
65  }
66  ptr += ff_subtitles_next_line(ptr);
67  }
68  return 0;
69 }
70 
71 static const char * const cmds[] = {
72  "CLOCKPAUSE",
73  "DIRECTIVE",
74  "FONT",
75  "HRES",
76  "INCLUDE",
77  "PALETTE",
78  "QUANTIZE",
79  "RAMP",
80  "SHIFT",
81  "TIMERES",
82 };
83 
84 static int get_jss_cmd(char k)
85 {
86  int i;
87 
88  k = av_toupper(k);
89  for (i = 0; i < FF_ARRAY_ELEMS(cmds); i++)
90  if (k == cmds[i][0])
91  return i;
92  return -1;
93 }
94 
96 {
97  JACOsubContext *jacosub = s->priv_data;
98  ff_subtitles_queue_clean(&jacosub->q);
99  return 0;
100 }
101 
102 static const char *read_ts(JACOsubContext *jacosub, const char *buf,
103  int64_t *start, int *duration)
104 {
105  int len;
106  unsigned hs, ms, ss, fs; // hours, minutes, seconds, frame start
107  unsigned he, me, se, fe; // hours, minutes, seconds, frame end
108  int ts_start, ts_end;
109 
110  /* timed format */
111  if (sscanf(buf, "%u:%u:%u.%u %u:%u:%u.%u %n",
112  &hs, &ms, &ss, &fs,
113  &he, &me, &se, &fe, &len) == 8) {
114  ts_start = (hs*3600 + ms*60 + ss) * jacosub->timeres + fs;
115  ts_end = (he*3600 + me*60 + se) * jacosub->timeres + fe;
116  goto shift_and_ret;
117  }
118 
119  /* timestamps format */
120  if (sscanf(buf, "@%u @%u %n", &ts_start, &ts_end, &len) == 2)
121  goto shift_and_ret;
122 
123  return NULL;
124 
125 shift_and_ret:
126  ts_start = (ts_start + jacosub->shift) * 100 / jacosub->timeres;
127  ts_end = (ts_end + jacosub->shift) * 100 / jacosub->timeres;
128  *start = ts_start;
129  *duration = ts_start + ts_end;
130  return buf + len;
131 }
132 
133 static int get_shift(int timeres, const char *buf)
134 {
135  int sign = 1;
136  int a = 0, b = 0, c = 0, d = 0;
137 #define SSEP "%*1[.:]"
138  int n = sscanf(buf, "%d"SSEP"%d"SSEP"%d"SSEP"%d", &a, &b, &c, &d);
139 #undef SSEP
140 
141  if (*buf == '-' || a < 0) {
142  sign = -1;
143  a = FFABS(a);
144  }
145 
146  switch (n) {
147  case 4: return sign * ((a*3600 + b*60 + c) * timeres + d);
148  case 3: return sign * (( a*60 + b) * timeres + c);
149  case 2: return sign * (( a) * timeres + b);
150  }
151 
152  return 0;
153 }
154 
156 {
157  AVBPrint header;
158  AVIOContext *pb = s->pb;
159  char line[JSS_MAX_LINESIZE];
160  JACOsubContext *jacosub = s->priv_data;
161  int shift_set = 0; // only the first shift matters
162  int merge_line = 0;
163  int i, ret;
164 
165  AVStream *st = avformat_new_stream(s, NULL);
166  if (!st)
167  return AVERROR(ENOMEM);
168  avpriv_set_pts_info(st, 64, 1, 100);
171 
172  jacosub->timeres = 30;
173 
174  av_bprint_init(&header, 1024+FF_INPUT_BUFFER_PADDING_SIZE, 4096);
175 
176  while (!url_feof(pb)) {
177  int cmd_len;
178  const char *p = line;
179  int64_t pos = avio_tell(pb);
180  int len = ff_get_line(pb, line, sizeof(line));
181 
182  p = jss_skip_whitespace(p);
183 
184  /* queue timed line */
185  if (merge_line || timed_line(p)) {
186  AVPacket *sub;
187 
188  sub = ff_subtitles_queue_insert(&jacosub->q, line, len, merge_line);
189  if (!sub)
190  return AVERROR(ENOMEM);
191  sub->pos = pos;
192  merge_line = len > 1 && !strcmp(&line[len - 2], "\\\n");
193  continue;
194  }
195 
196  /* skip all non-compiler commands and focus on the command */
197  if (*p != '#')
198  continue;
199  p++;
200  i = get_jss_cmd(p[0]);
201  if (i == -1)
202  continue;
203 
204  /* trim command + spaces */
205  cmd_len = strlen(cmds[i]);
206  if (av_strncasecmp(p, cmds[i], cmd_len) == 0)
207  p += cmd_len;
208  else
209  p++;
210  p = jss_skip_whitespace(p);
211 
212  /* handle commands which affect the whole script */
213  switch (cmds[i][0]) {
214  case 'S': // SHIFT command affect the whole script...
215  if (!shift_set) {
216  jacosub->shift = get_shift(jacosub->timeres, p);
217  shift_set = 1;
218  }
219  av_bprintf(&header, "#S %s", p);
220  break;
221  case 'T': // ...but must be placed after TIMERES
222  jacosub->timeres = strtol(p, NULL, 10);
223  if (!jacosub->timeres)
224  jacosub->timeres = 30;
225  else
226  av_bprintf(&header, "#T %s", p);
227  break;
228  }
229  }
230 
231  /* general/essential directives in the extradata */
232  ret = avpriv_bprint_to_extradata(st->codec, &header);
233  if (ret < 0)
234  return ret;
235 
236  /* SHIFT and TIMERES affect the whole script so packet timing can only be
237  * done in a second pass */
238  for (i = 0; i < jacosub->q.nb_subs; i++) {
239  AVPacket *sub = &jacosub->q.subs[i];
240  read_ts(jacosub, sub->data, &sub->pts, &sub->duration);
241  }
242  ff_subtitles_queue_finalize(&jacosub->q);
243 
244  return 0;
245 }
246 
248 {
249  JACOsubContext *jacosub = s->priv_data;
250  return ff_subtitles_queue_read_packet(&jacosub->q, pkt);
251 }
252 
253 static int jacosub_read_seek(AVFormatContext *s, int stream_index,
254  int64_t min_ts, int64_t ts, int64_t max_ts, int flags)
255 {
256  JACOsubContext *jacosub = s->priv_data;
257  return ff_subtitles_queue_seek(&jacosub->q, s, stream_index,
258  min_ts, ts, max_ts, flags);
259 }
260 
262  .name = "jacosub",
263  .long_name = NULL_IF_CONFIG_SMALL("JACOsub subtitle format"),
264  .priv_data_size = sizeof(JACOsubContext),
268  .read_seek2 = jacosub_read_seek,
270 };
const char * s
Definition: avisynth_c.h:668
Bytestream IO Context.
Definition: avio.h:68
const char * name
A comma separated list of short names for the format.
Definition: avformat.h:478
int64_t pos
byte position in stream, -1 if unknown
Definition: avcodec.h:1092
void avpriv_set_pts_info(AVStream *s, int pts_wrap_bits, unsigned int pts_num, unsigned int pts_den)
Set the time base and wrapping info for a given stream.
Definition: utils.c:3922
static int jacosub_read_header(AVFormatContext *s)
Definition: jacosubdec.c:155
AVCodecContext * codec
Codec context associated with this stream.
Definition: avformat.h:686
#define me
const char * b
Definition: vf_curves.c:105
void ff_subtitles_queue_clean(FFDemuxSubtitlesQueue *q)
Remove and destroy all the subtitles packets.
Definition: subtitles.c:185
int av_strncasecmp(const char *a, const char *b, size_t n)
Locale-independent case-insensitive compare.
Definition: avstring.c:222
JACOsub shared utils.
AVPacket * ff_subtitles_queue_insert(FFDemuxSubtitlesQueue *q, const uint8_t *event, int len, int merge)
Insert a new subtitle event.
Definition: subtitles.c:26
Format I/O context.
Definition: avformat.h:968
static const char *const cmds[]
Definition: jacosubdec.c:71
int ff_subtitles_queue_read_packet(FFDemuxSubtitlesQueue *q, AVPacket *pkt)
Generic read_packet() callback for subtitles demuxers using this queue system.
Definition: subtitles.c:96
unsigned char * buf
Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero.
Definition: avformat.h:336
static av_always_inline int64_t avio_tell(AVIOContext *s)
ftell() equivalent for AVIOContext.
Definition: avio.h:248
FFDemuxSubtitlesQueue q
Definition: jacosubdec.c:40
static av_cold int read_close(AVFormatContext *ctx)
Definition: libcdio.c:145
static int64_t duration
Definition: ffplay.c:306
AVStream * avformat_new_stream(AVFormatContext *s, const AVCodec *c)
Add a new stream to a media file.
Definition: utils.c:3348
int duration
Duration of this packet in AVStream-&gt;time_base units, 0 if unknown.
Definition: avcodec.h:1085
int avpriv_bprint_to_extradata(AVCodecContext *avctx, struct AVBPrint *buf)
Finalize buf into extradata and set its size appropriately.
Definition: utils.c:3371
static int get_shift(int timeres, const char *buf)
Definition: jacosubdec.c:133
void * priv_data
Format private data.
Definition: avformat.h:988
#define JSS_MAX_LINESIZE
Definition: jacosub.h:31
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:151
Definition: graph2dot.c:48
int buf_size
Size of buf except extra allocated bytes.
Definition: avformat.h:337
static int jacosub_read_close(AVFormatContext *s)
Definition: jacosubdec.c:95
void av_bprint_init(AVBPrint *buf, unsigned size_init, unsigned size_max)
Init a print buffer.
Definition: bprint.c:69
#define FF_INPUT_BUFFER_PADDING_SIZE
Required number of additionally allocated bytes at the end of the input bitstream for decoding...
Definition: avcodec.h:580
#define FF_ARRAY_ELEMS(a)
Definition: avcodec.h:929
static const char * read_ts(JACOsubContext *jacosub, const char *buf, int64_t *start, int *duration)
Definition: jacosubdec.c:102
Buffer to print data progressively.
Definition: bprint.h:77
static int read_probe(AVProbeData *pd)
Definition: jvdec.c:54
ret
Definition: avfilter.c:961
#define AVPROBE_SCORE_EXTENSION
score for file extension
Definition: avformat.h:341
static int jacosub_read_seek(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags)
Definition: jacosubdec.c:253
void ff_subtitles_queue_finalize(FFDemuxSubtitlesQueue *q)
Set missing durations and sort subtitles by PTS, and then byte position.
Definition: subtitles.c:84
int n
Definition: avisynth_c.h:588
int ff_get_line(AVIOContext *s, char *buf, int maxlen)
Read a whole line of text from AVIOContext.
Definition: aviobuf.c:632
static int read_header(FFV1Context *f)
Definition: ffv1dec.c:592
Stream structure.
Definition: avformat.h:667
static av_always_inline int jss_whitespace(char c)
Definition: jacosub.h:33
int ff_subtitles_queue_seek(FFDemuxSubtitlesQueue *q, AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags)
Update current_sub_idx to emulate a seek.
Definition: subtitles.c:133
static int timed_line(const char *ptr)
Definition: jacosubdec.c:43
enum AVMediaType codec_type
Definition: avcodec.h:1154
enum AVCodecID codec_id
Definition: avcodec.h:1157
AVInputFormat ff_jacosub_demuxer
Definition: jacosubdec.c:261
static int jacosub_read_packet(AVFormatContext *s, AVPacket *pkt)
Definition: jacosubdec.c:247
unsigned timeres
Definition: jacosubdec.c:39
AVIOContext * pb
I/O context.
Definition: avformat.h:1001
void * buf
Definition: avisynth_c.h:594
static int read_packet(AVFormatContext *ctx, AVPacket *pkt)
Definition: libcdio.c:114
uint8_t * data
Definition: avcodec.h:1063
#define AV_RB24(x)
Definition: intreadwrite.h:436
This structure contains the data a format has to probe a file.
Definition: avformat.h:334
#define FFABS(a)
Definition: avcodec.h:920
static av_always_inline int ff_subtitles_next_line(const char *ptr)
Get the number of characters to increment to jump to the next line, or to the end of the string...
Definition: subtitles.h:111
static int flags
Definition: cpu.c:45
static int av_toupper(int c)
Locale-independent conversion of ASCII characters to uppercase.
Definition: avstring.h:206
int url_feof(AVIOContext *s)
feof() equivalent for AVIOContext.
Definition: aviobuf.c:280
static av_always_inline const char * jss_skip_whitespace(const char *p)
Definition: jacosub.h:38
common internal api header.
static double c[64]
Main libavformat public API header.
AVPacket * subs
array of subtitles packets
Definition: subtitles.h:34
static int get_jss_cmd(char k)
Definition: jacosubdec.c:84
void av_bprintf(AVBPrint *buf, const char *fmt,...) av_printf_format(2
Append a formatted string to a print buffer.
static int jacosub_probe(AVProbeData *p)
Definition: jacosubdec.c:50
int len
#define AVERROR(e)
void INT64 start
Definition: avisynth_c.h:594
static AVPacket pkt
Definition: demuxing.c:52
#define SSEP
This structure stores compressed data.
Definition: avcodec.h:1040
int nb_subs
number of subtitles packets
Definition: subtitles.h:35
int64_t pts
Presentation timestamp in AVStream-&gt;time_base units; the time at which the decompressed packet will b...
Definition: avcodec.h:1056