lavf: add internal demuxer helpers for subtitles.
[ffmpeg.git] / libavformat / subtitles.h
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 #ifndef AVFORMAT_SUBTITLES_H
22 #define AVFORMAT_SUBTITLES_H
23
24 #include <stdint.h>
25 #include "avformat.h"
26
27 typedef struct {
28     AVPacket *subs;         ///< array of subtitles packets
29     int nb_subs;            ///< number of subtitles packets
30     int allocated_size;     ///< allocated size for subs
31     int current_sub_idx;    ///< current position for the read packet callback
32 } FFDemuxSubtitlesQueue;
33
34 /**
35  * Insert a new subtitle event.
36  *
37  * @param event the subtitle line, may not be zero terminated
38  * @param len   the length of the event (in strlen() sense, so without '\0')
39  * @param merge set to 1 if the current event should be concatenated with the
40  *              previous one instead of adding a new entry, 0 otherwise
41  */
42 AVPacket *ff_subtitles_queue_insert(FFDemuxSubtitlesQueue *q,
43                                     const uint8_t *event, int len, int merge);
44
45 /**
46  * Set missing durations and sort subtitles by PTS, and then byte position.
47  */
48 void ff_subtitles_queue_finalize(FFDemuxSubtitlesQueue *q);
49
50 /**
51  * Generic read_packet() callback for subtitles demuxers using this queue
52  * system.
53  */
54 int ff_subtitles_queue_read_packet(FFDemuxSubtitlesQueue *q, AVPacket *pkt);
55
56 /**
57  * Remove and destroy all the subtitles packets.
58  */
59 void ff_subtitles_queue_clean(FFDemuxSubtitlesQueue *q);
60
61 #endif /* AVFORMAT_SUBTITLES_H */