FFmpeg
realtextdec.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  * RealText subtitle demuxer
24  * @see http://service.real.com/help/library/guides/ProductionGuide/prodguide/htmfiles/realtext.htm
25  */
26 
27 #include "avformat.h"
28 #include "internal.h"
29 #include "subtitles.h"
30 #include "libavutil/avstring.h"
31 #include "libavutil/bprint.h"
32 #include "libavutil/intreadwrite.h"
33 
34 typedef struct {
37 
38 static int realtext_probe(const AVProbeData *p)
39 {
40  char buf[7];
41  FFTextReader tr;
42  ff_text_init_buf(&tr, p->buf, p->buf_size);
43  ff_text_read(&tr, buf, sizeof(buf));
44 
45  return !av_strncasecmp(buf, "<window", 7) ? AVPROBE_SCORE_EXTENSION : 0;
46 }
47 
48 static int read_ts(const char *s)
49 {
50  int hh, mm, ss, ms;
51 
52  if (sscanf(s, "%u:%u:%u.%u", &hh, &mm, &ss, &ms) == 4) return (hh*3600 + mm*60 + ss) * 100 + ms;
53  if (sscanf(s, "%u:%u:%u" , &hh, &mm, &ss ) == 3) return (hh*3600 + mm*60 + ss) * 100;
54  if (sscanf(s, "%u:%u.%u", &mm, &ss, &ms) == 3) return ( mm*60 + ss) * 100 + ms;
55  if (sscanf(s, "%u:%u" , &mm, &ss ) == 2) return ( mm*60 + ss) * 100;
56  if (sscanf(s, "%u.%u", &ss, &ms) == 2) return ( ss) * 100 + ms;
57  return strtol(s, NULL, 10) * 100;
58 }
59 
61 {
62  RealTextContext *rt = s->priv_data;
64  AVBPrint buf;
65  char c = 0;
66  int res = 0, duration = read_ts("60"); // default duration is 60 seconds
67  FFTextReader tr;
68  ff_text_init_avio(s, &tr, s->pb);
69 
70  if (!st)
71  return AVERROR(ENOMEM);
72  avpriv_set_pts_info(st, 64, 1, 100);
75 
77 
78  while (!ff_text_eof(&tr)) {
79  AVPacket *sub;
80  const int64_t pos = ff_text_pos(&tr) - (c != 0);
81  int n = ff_smil_extract_next_text_chunk(&tr, &buf, &c);
82 
83  if (n == 0)
84  break;
85 
86  if (!av_strncasecmp(buf.str, "<window", 7)) {
87  /* save header to extradata */
88  const char *p = ff_smil_get_attr_ptr(buf.str, "duration");
89 
90  if (st->codecpar->extradata) {
91  res = AVERROR_INVALIDDATA;
92  goto end;
93  }
94  if (p)
95  duration = read_ts(p);
96  st->codecpar->extradata = av_strdup(buf.str);
97  if (!st->codecpar->extradata) {
98  res = AVERROR(ENOMEM);
99  goto end;
100  }
101  st->codecpar->extradata_size = buf.len + 1;
102  } else {
103  /* if we just read a <time> tag, introduce a new event, otherwise merge
104  * with the previous one */
105  int merge = !av_strncasecmp(buf.str, "<time", 5) ? 0 : 1;
106  sub = ff_subtitles_queue_insert(&rt->q, buf.str, buf.len, merge);
107  if (!sub) {
108  res = AVERROR(ENOMEM);
109  goto end;
110  }
111  if (!merge) {
112  const char *begin = ff_smil_get_attr_ptr(buf.str, "begin");
113  const char *end = ff_smil_get_attr_ptr(buf.str, "end");
114 
115  sub->pos = pos;
116  sub->pts = begin ? read_ts(begin) : 0;
117  sub->duration = end ? (read_ts(end) - sub->pts) : duration;
118  }
119  }
120  av_bprint_clear(&buf);
121  }
123 
124 end:
125  av_bprint_finalize(&buf, NULL);
126  return res;
127 }
128 
130 {
131  RealTextContext *rt = s->priv_data;
132  return ff_subtitles_queue_read_packet(&rt->q, pkt);
133 }
134 
135 static int realtext_read_seek(AVFormatContext *s, int stream_index,
136  int64_t min_ts, int64_t ts, int64_t max_ts, int flags)
137 {
138  RealTextContext *rt = s->priv_data;
139  return ff_subtitles_queue_seek(&rt->q, s, stream_index,
140  min_ts, ts, max_ts, flags);
141 }
142 
144 {
145  RealTextContext *rt = s->priv_data;
147  return 0;
148 }
149 
151  .name = "realtext",
152  .long_name = NULL_IF_CONFIG_SMALL("RealText subtitle format"),
153  .priv_data_size = sizeof(RealTextContext),
157  .read_seek2 = realtext_read_seek,
159  .extensions = "rt",
160 };
static int realtext_read_close(AVFormatContext *s)
Definition: realtextdec.c:143
#define NULL
Definition: coverity.c:32
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:59
int64_t pos
byte position in stream, -1 if unknown
Definition: avcodec.h:1497
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:4892
enum AVCodecID codec_id
Specific type of the encoded data (the codec used).
Definition: avcodec.h:3957
static int realtext_read_packet(AVFormatContext *s, AVPacket *pkt)
Definition: realtextdec.c:129
static int read_ts(const char *s)
Definition: realtextdec.c:48
void ff_subtitles_queue_clean(FFDemuxSubtitlesQueue *q)
Remove and destroy all the subtitles packets.
Definition: subtitles.c:297
int av_strncasecmp(const char *a, const char *b, size_t n)
Locale-independent case-insensitive compare.
Definition: avstring.c:223
static AVPacket pkt
int av_bprint_finalize(AVBPrint *buf, char **ret_str)
Finalize a print buffer.
Definition: bprint.c:235
Format I/O context.
Definition: avformat.h:1358
const char * ff_smil_get_attr_ptr(const char *s, const char *attr)
SMIL helper to point on the value of an attribute in the given tag.
Definition: subtitles.c:330
int ff_subtitles_queue_read_packet(FFDemuxSubtitlesQueue *q, AVPacket *pkt)
Generic read_packet() callback for subtitles demuxers using this queue system.
Definition: subtitles.c:208
static av_cold int end(AVCodecContext *avctx)
Definition: avrndec.c:90
int64_t duration
Duration of this packet in AVStream->time_base units, 0 if unknown.
Definition: avcodec.h:1495
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
AVStream * avformat_new_stream(AVFormatContext *s, const AVCodec *c)
Add a new stream to a media file.
Definition: utils.c:4465
int64_t duration
Definition: movenc.c:63
static av_cold int read_close(AVFormatContext *ctx)
Definition: libcdio.c:145
FFDemuxSubtitlesQueue q
Definition: realtextdec.c:35
#define AV_BPRINT_SIZE_UNLIMITED
int ff_text_eof(FFTextReader *r)
Return non-zero if EOF was reached.
Definition: subtitles.c:92
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:186
void av_bprint_init(AVBPrint *buf, unsigned size_init, unsigned size_max)
Definition: bprint.c:69
enum AVMediaType codec_type
General type of the encoded data.
Definition: avcodec.h:3953
void ff_text_init_avio(void *s, FFTextReader *r, AVIOContext *pb)
Initialize the FFTextReader from the given AVIOContext.
Definition: subtitles.c:27
int extradata_size
Size of the extradata content in bytes.
Definition: avcodec.h:3975
int buf_size
Size of buf except extra allocated bytes.
Definition: avformat.h:449
unsigned char * buf
Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero.
Definition: avformat.h:448
int64_t ff_text_pos(FFTextReader *r)
Return the byte position of the next byte returned by ff_text_r8().
Definition: subtitles.c:60
static int realtext_read_seek(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags)
Definition: realtextdec.c:135
#define ss(width, name, subs,...)
Definition: cbs_vp9.c:261
static int realtext_read_header(AVFormatContext *s)
Definition: realtextdec.c:60
#define s(width, name)
Definition: cbs_vp9.c:257
int n
Definition: avisynth_c.h:760
void ff_text_read(FFTextReader *r, char *buf, size_t size)
Read the given number of bytes (in UTF-8).
Definition: subtitles.c:86
static int read_header(FFV1Context *f)
Definition: ffv1dec.c:530
Stream structure.
Definition: avformat.h:881
static int read_packet(void *opaque, uint8_t *buf, int buf_size)
Definition: avio_reading.c:42
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:245
char * av_strdup(const char *s)
Duplicate a string.
Definition: mem.c:251
int ff_smil_extract_next_text_chunk(FFTextReader *tr, AVBPrint *buf, char *c)
SMIL helper to load next chunk ("<...>" or untagged content) in buf.
Definition: subtitles.c:307
AVIOContext * pb
I/O context.
Definition: avformat.h:1400
AVInputFormat ff_realtext_demuxer
Definition: realtextdec.c:150
void * buf
Definition: avisynth_c.h:766
#define AVPROBE_SCORE_EXTENSION
score for file extension
Definition: avformat.h:456
This structure contains the data a format has to probe a file.
Definition: avformat.h:446
static void merge(GetBitContext *gb, uint8_t *dst, uint8_t *src, int size)
Merge two consequent lists of equal size depending on bits read.
Definition: bink.c:217
#define flags(name, subs,...)
Definition: cbs_av1.c:561
static int realtext_probe(const AVProbeData *p)
Definition: realtextdec.c:38
static int read_probe(const AVProbeData *pd)
Definition: jvdec.c:55
void av_bprint_clear(AVBPrint *buf)
Reset the string to "" but keep internal allocated data.
Definition: bprint.c:227
Main libavformat public API header.
void ff_text_init_buf(FFTextReader *r, void *buf, size_t size)
Similar to ff_text_init_avio(), but sets it up to read from a bounded buffer.
Definition: subtitles.c:53
void * priv_data
Format private data.
Definition: avformat.h:1386
uint8_t * extradata
Extra binary data needed for initializing the decoder, codec-dependent.
Definition: avcodec.h:3971
const char * name
A comma separated list of short names for the format.
Definition: avformat.h:654
AVCodecParameters * codecpar
Codec parameters associated with this stream.
Definition: avformat.h:1028
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
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
This structure stores compressed data.
Definition: avcodec.h:1454
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:193
int64_t pts
Presentation timestamp in AVStream->time_base units; the time at which the decompressed packet will b...
Definition: avcodec.h:1470