2 * Copyright (c) 2012 Clément Bœsch
4 * This file is part of FFmpeg.
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.
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.
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
21 #ifndef AVFORMAT_SUBTITLES_H
22 #define AVFORMAT_SUBTITLES_H
26 #include "libavutil/bprint.h"
29 AVPacket *subs; ///< array of subtitles packets
30 int nb_subs; ///< number of subtitles packets
31 int allocated_size; ///< allocated size for subs
32 int current_sub_idx; ///< current position for the read packet callback
33 } FFDemuxSubtitlesQueue;
36 * Insert a new subtitle event.
38 * @param event the subtitle line, may not be zero terminated
39 * @param len the length of the event (in strlen() sense, so without '\0')
40 * @param merge set to 1 if the current event should be concatenated with the
41 * previous one instead of adding a new entry, 0 otherwise
43 AVPacket *ff_subtitles_queue_insert(FFDemuxSubtitlesQueue *q,
44 const uint8_t *event, int len, int merge);
47 * Set missing durations and sort subtitles by PTS, and then byte position.
49 void ff_subtitles_queue_finalize(FFDemuxSubtitlesQueue *q);
52 * Generic read_packet() callback for subtitles demuxers using this queue
55 int ff_subtitles_queue_read_packet(FFDemuxSubtitlesQueue *q, AVPacket *pkt);
58 * Update current_sub_idx to emulate a seek. Except the first parameter, it
59 * matches AVInputFormat->read_seek2 prototypes.
61 int ff_subtitles_queue_seek(FFDemuxSubtitlesQueue *q, AVFormatContext *s, int stream_index,
62 int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
65 * Remove and destroy all the subtitles packets.
67 void ff_subtitles_queue_clean(FFDemuxSubtitlesQueue *q);
70 * SMIL helper to load next chunk ("<...>" or untagged content) in buf.
72 * @param c cached character, to avoid a backward seek
74 int ff_smil_extract_next_chunk(AVIOContext *pb, AVBPrint *buf, char *c);
77 * SMIL helper to point on the value of an attribute in the given tag.
79 * @param s SMIL tag ("<...>")
80 * @param attr the attribute to look for
82 const char *ff_smil_get_attr_ptr(const char *s, const char *attr);
85 * @brief Read a subtitles chunk.
87 * A chunk is defined by a multiline "event", ending with a second line break.
88 * The trailing line breaks are trimmed. CRLF are supported.
89 * Example: "foo\r\nbar\r\n\r\nnext" will print "foo\r\nbar" into buf, and pb
90 * will focus on the 'n' of the "next" string.
92 * @param pb I/O context
93 * @param buf an initialized buf where the chunk is written
95 * @note buf is cleared before writing into it.
97 void ff_subtitles_read_chunk(AVIOContext *pb, AVBPrint *buf);
100 * Get the number of characters to increment to jump to the next line, or to
101 * the end of the string.
103 static av_always_inline int ff_subtitles_next_line(const char *ptr)
105 int n = strcspn(ptr, "\n");
109 #endif /* AVFORMAT_SUBTITLES_H */