FFmpeg
stldec.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2014 Eejya Singh
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  * STL subtitles format demuxer
24  * @see https://documentation.apple.com/en/dvdstudiopro/usermanual/index.html#chapter=19%26section=13%26tasks=true
25  */
26 
27 #include "avformat.h"
28 #include "internal.h"
29 #include "subtitles.h"
30 #include "libavutil/intreadwrite.h"
31 #include "libavutil/avstring.h"
32 
33 typedef struct {
35 } STLContext;
36 
37 static int stl_probe(const AVProbeData *p)
38 {
39  char c;
40  const unsigned char *ptr = p->buf;
41 
42  if (AV_RB24(ptr) == 0xEFBBBF)
43  ptr += 3; /* skip UTF-8 BOM */
44 
45  while (*ptr == '\r' || *ptr == '\n' || *ptr == '$' || !strncmp(ptr, "//" , 2))
46  ptr += ff_subtitles_next_line(ptr);
47 
48  if (sscanf(ptr, "%*d:%*d:%*d:%*d , %*d:%*d:%*d:%*d , %c", &c) == 1)
49  return AVPROBE_SCORE_MAX;
50 
51  return 0;
52 }
53 
54 static int64_t get_pts(char **buf, int *duration)
55 {
56  int hh1, mm1, ss1, ms1;
57  int hh2, mm2, ss2, ms2;
58  int len = 0;
59 
60  if (sscanf(*buf, "%2d:%2d:%2d:%2d , %2d:%2d:%2d:%2d , %n",
61  &hh1, &mm1, &ss1, &ms1,
62  &hh2, &mm2, &ss2, &ms2, &len) >= 8 && len > 0) {
63  int64_t start = (hh1*3600LL + mm1*60LL + ss1) * 100LL + ms1;
64  int64_t end = (hh2*3600LL + mm2*60LL + ss2) * 100LL + ms2;
65  *duration = end - start;
66  *buf += len;
67  return start;
68  }
69  return AV_NOPTS_VALUE;
70 }
71 
73 {
74  STLContext *stl = s->priv_data;
76 
77  if (!st)
78  return AVERROR(ENOMEM);
79  avpriv_set_pts_info(st, 64, 1, 100);
82 
83  while (!avio_feof(s->pb)) {
84  char line[4096];
85  char *p = line;
86  const int64_t pos = avio_tell(s->pb);
87  int len = ff_get_line(s->pb, line, sizeof(line));
88  int64_t pts_start;
89  int duration;
90 
91  if (!len)
92  break;
93 
94  line[strcspn(line, "\r\n")] = 0;
95  pts_start = get_pts(&p , &duration);
96 
97  if (pts_start != AV_NOPTS_VALUE) {
98  AVPacket *sub;
99  sub = ff_subtitles_queue_insert(&stl->q, p, strlen(p), 0);
100  if (!sub) {
102  return AVERROR(ENOMEM);
103  }
104  sub->pos = pos;
105  sub->pts = pts_start;
106  sub->duration = duration;
107  }
108  }
110  return 0;
111 }
113 {
114  STLContext *stl = s->priv_data;
116 }
117 
118 static int stl_read_seek(AVFormatContext *s, int stream_index,
119  int64_t min_ts, int64_t ts, int64_t max_ts, int flags)
120 {
121  STLContext *stl = s->priv_data;
122  return ff_subtitles_queue_seek(&stl->q, s, stream_index,
123  min_ts, ts, max_ts, flags);
124 }
125 
127 {
128  STLContext *stl = s->priv_data;
130  return 0;
131 }
132 
134  .name = "stl",
135  .long_name = NULL_IF_CONFIG_SMALL("Spruce subtitle format"),
136  .priv_data_size = sizeof(STLContext),
140  .read_seek2 = stl_read_seek,
142  .extensions = "stl",
143 };
AVMEDIA_TYPE_SUBTITLE
@ AVMEDIA_TYPE_SUBTITLE
Definition: avutil.h:204
AVERROR
Filter the word “frame” indicates either a video frame or a group of audio as stored in an AVFrame structure Format for each input and each output the list of supported formats For video that means pixel format For audio that means channel sample they are references to shared objects When the negotiation mechanism computes the intersection of the formats supported at each end of a all references to both lists are replaced with a reference to the intersection And when a single format is eventually chosen for a link amongst the remaining all references to the list are updated That means that if a filter requires that its input and output have the same format amongst a supported all it has to do is use a reference to the same list of formats query_formats can leave some formats unset and return AVERROR(EAGAIN) to cause the negotiation mechanism toagain later. That can be used by filters with complex requirements to use the format negotiated on one link to set the formats supported on another. Frame references ownership and permissions
avformat_new_stream
AVStream * avformat_new_stream(AVFormatContext *s, const AVCodec *c)
Add a new stream to a media file.
Definition: utils.c:4480
AVCodecParameters::codec_type
enum AVMediaType codec_type
General type of the encoded data.
Definition: avcodec.h:3953
end
static av_cold int end(AVCodecContext *avctx)
Definition: avrndec.c:90
AVPacket::duration
int64_t duration
Duration of this packet in AVStream->time_base units, 0 if unknown.
Definition: avcodec.h:1495
AVPROBE_SCORE_MAX
#define AVPROBE_SCORE_MAX
maximum score
Definition: avformat.h:458
start
void INT64 start
Definition: avisynth_c.h:767
read_close
static av_cold int read_close(AVFormatContext *ctx)
Definition: libcdio.c:145
avio_tell
static av_always_inline int64_t avio_tell(AVIOContext *s)
ftell() equivalent for AVIOContext.
Definition: avio.h:557
ff_subtitles_queue_seek
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:249
buf
void * buf
Definition: avisynth_c.h:766
AVInputFormat
Definition: avformat.h:640
duration
int64_t duration
Definition: movenc.c:63
intreadwrite.h
s
#define s(width, name)
Definition: cbs_vp9.c:257
get_pts
static int64_t get_pts(char **buf, int *duration)
Definition: stldec.c:54
AVInputFormat::name
const char * name
A comma separated list of short names for the format.
Definition: avformat.h:645
AVProbeData::buf
unsigned char * buf
Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero.
Definition: avformat.h:448
ff_subtitles_queue_read_packet
int ff_subtitles_queue_read_packet(FFDemuxSubtitlesQueue *q, AVPacket *pkt)
Generic read_packet() callback for subtitles demuxers using this queue system.
Definition: subtitles.c:212
AVFormatContext
Format I/O context.
Definition: avformat.h:1342
internal.h
AVStream::codecpar
AVCodecParameters * codecpar
Codec parameters associated with this stream.
Definition: avformat.h:1017
read_header
static int read_header(FFV1Context *f)
Definition: ffv1dec.c:530
NULL
#define NULL
Definition: coverity.c:32
read_probe
static int read_probe(const AVProbeData *pd)
Definition: jvdec.c:55
stl_read_header
static int stl_read_header(AVFormatContext *s)
Definition: stldec.c:72
AVProbeData
This structure contains the data a format has to probe a file.
Definition: avformat.h:446
ff_subtitles_queue_insert
AVPacket * ff_subtitles_queue_insert(FFDemuxSubtitlesQueue *q, const uint8_t *event, size_t len, int merge)
Insert a new subtitle event.
Definition: subtitles.c:111
c
Undefined Behavior In the C some operations are like signed integer dereferencing freed accessing outside allocated Undefined Behavior must not occur in a C it is not safe even if the output of undefined operations is unused The unsafety may seem nit picking but Optimizing compilers have in fact optimized code on the assumption that no undefined Behavior occurs Optimizing code based on wrong assumptions can and has in some cases lead to effects beyond the output of computations The signed integer overflow problem in speed critical code Code which is highly optimized and works with signed integers sometimes has the problem that often the output of the computation does not c
Definition: undefined.txt:32
stl_read_packet
static int stl_read_packet(AVFormatContext *s, AVPacket *pkt)
Definition: stldec.c:112
NULL_IF_CONFIG_SMALL
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification.
Definition: internal.h:188
avpriv_set_pts_info
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:4910
AV_NOPTS_VALUE
#define AV_NOPTS_VALUE
Undefined timestamp value.
Definition: avutil.h:248
stl
#define stl(l, p)
Definition: asm.h:76
ff_subtitles_queue_finalize
void ff_subtitles_queue_finalize(void *log_ctx, FFDemuxSubtitlesQueue *q)
Set missing durations, sort subtitles by PTS (and then byte position), and drop duplicated events.
Definition: subtitles.c:194
FFDemuxSubtitlesQueue
Definition: subtitles.h:102
ff_subtitles_queue_clean
void ff_subtitles_queue_clean(FFDemuxSubtitlesQueue *q)
Remove and destroy all the subtitles packets.
Definition: subtitles.c:301
line
Definition: graph2dot.c:48
AV_CODEC_ID_STL
@ AV_CODEC_ID_STL
Definition: avcodec.h:673
AVPacket::pts
int64_t pts
Presentation timestamp in AVStream->time_base units; the time at which the decompressed packet will b...
Definition: avcodec.h:1470
ff_get_line
int ff_get_line(AVIOContext *s, char *buf, int maxlen)
Read a whole line of text from AVIOContext.
Definition: aviobuf.c:808
len
int len
Definition: vorbis_enc_data.h:452
STLContext
Definition: stldec.c:33
stl_probe
static int stl_probe(const AVProbeData *p)
Definition: stldec.c:37
read_packet
static int read_packet(void *opaque, uint8_t *buf, int buf_size)
Definition: avio_reading.c:42
AVStream
Stream structure.
Definition: avformat.h:870
avformat.h
subtitles.h
pkt
static AVPacket pkt
Definition: demuxing_decoding.c:54
stl_read_close
static int stl_read_close(AVFormatContext *s)
Definition: stldec.c:126
ff_stl_demuxer
AVInputFormat ff_stl_demuxer
Definition: stldec.c:133
stl_read_seek
static int stl_read_seek(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags)
Definition: stldec.c:118
AVCodecParameters::codec_id
enum AVCodecID codec_id
Specific type of the encoded data (the codec used).
Definition: avcodec.h:3957
AVPacket
This structure stores compressed data.
Definition: avcodec.h:1454
AVPacket::pos
int64_t pos
byte position in stream, -1 if unknown
Definition: avcodec.h:1497
flags
#define flags(name, subs,...)
Definition: cbs_av1.c:565
ff_subtitles_next_line
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:187
avstring.h
AV_RB24
uint64_t_TMPL AV_WL64 unsigned int_TMPL AV_WL32 unsigned int_TMPL AV_WL24 unsigned int_TMPL AV_WL16 uint64_t_TMPL AV_WB64 unsigned int_TMPL AV_WB32 unsigned int_TMPL AV_RB24
Definition: bytestream.h:93
line
The official guide to swscale for confused that consecutive non overlapping rectangles of slice_bottom special converter These generally are unscaled converters of common like for each output line the vertical scaler pulls lines from a ring buffer When the ring buffer does not contain the wanted line
Definition: swscale.txt:40
STLContext::q
FFDemuxSubtitlesQueue q
Definition: stldec.c:34
avio_feof
int avio_feof(AVIOContext *s)
Similar to feof() but also returns nonzero on read errors.
Definition: aviobuf.c:358