avformat/assdec: UTF-16 support
[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 #include "libavutil/bprint.h"
27
28 enum sub_sort {
29     SUB_SORT_TS_POS = 0,    ///< sort by timestamps, then position
30     SUB_SORT_POS_TS,        ///< sort by position, then timestamps
31 };
32
33 enum ff_utf_type {
34     FF_UTF_8,       // or other 8 bit encodings
35     FF_UTF16LE,
36     FF_UTF16BE,
37 };
38
39 typedef struct {
40     int type;
41     AVIOContext *pb;
42     unsigned char buf[8];
43     int buf_pos, buf_len;
44     AVIOContext buf_pb;
45 } FFTextReader;
46
47 /**
48  * Initialize the FFTextReader from the given AVIOContext. This function will
49  * read some bytes from pb, and test for UTF-8 or UTF-16 BOMs. Further accesses
50  * to FFTextReader will read more data from pb.
51  *
52  * The purpose of FFTextReader is to transparently convert read data to UTF-8
53  * if the stream had a UTF-16 BOM.
54  *
55  * @param r object which will be initialized
56  * @param pb stream to read from (referenced as long as FFTextReader is in use)
57  */
58 void ff_text_init_avio(FFTextReader *r, AVIOContext *pb);
59
60 /**
61  * Similar to ff_text_init_avio(), but sets it up to read from a bounded buffer.
62  *
63  * @param r object which will be initialized
64  * @param buf buffer to read from (referenced as long as FFTextReader is in use)
65  * @param size size of buf
66  */
67 void ff_text_init_buf(FFTextReader *r, void *buf, size_t size);
68
69 /**
70  * Return the byte position of the next byte returned by ff_text_r8(). For
71  * UTF-16 source streams, this will return the original position, but it will
72  * be incorrect if a codepoint was only partially read with ff_text_r8().
73  */
74 int64_t ff_text_pos(FFTextReader *r);
75
76 /**
77  * Return the next byte. The return value is always 0 - 255. Returns 0 on EOF.
78  * If the source stream is UTF-16, this reads from the stream converted to
79  * UTF-8. On invalid UTF-16, 0 is returned.
80  */
81 int ff_text_r8(FFTextReader *r);
82
83 /**
84  * Read the given number of bytes (in UTF-8). On error or EOF, \0 bytes are
85  * written.
86  */
87 void ff_text_read(FFTextReader *r, char *buf, size_t size);
88
89 typedef struct {
90     AVPacket *subs;         ///< array of subtitles packets
91     int nb_subs;            ///< number of subtitles packets
92     int allocated_size;     ///< allocated size for subs
93     int current_sub_idx;    ///< current position for the read packet callback
94     enum sub_sort sort;     ///< sort method to use when finalizing subtitles
95 } FFDemuxSubtitlesQueue;
96
97 /**
98  * Insert a new subtitle event.
99  *
100  * @param event the subtitle line, may not be zero terminated
101  * @param len   the length of the event (in strlen() sense, so without '\0')
102  * @param merge set to 1 if the current event should be concatenated with the
103  *              previous one instead of adding a new entry, 0 otherwise
104  */
105 AVPacket *ff_subtitles_queue_insert(FFDemuxSubtitlesQueue *q,
106                                     const uint8_t *event, int len, int merge);
107
108 /**
109  * Set missing durations and sort subtitles by PTS, and then byte position.
110  */
111 void ff_subtitles_queue_finalize(FFDemuxSubtitlesQueue *q);
112
113 /**
114  * Generic read_packet() callback for subtitles demuxers using this queue
115  * system.
116  */
117 int ff_subtitles_queue_read_packet(FFDemuxSubtitlesQueue *q, AVPacket *pkt);
118
119 /**
120  * Update current_sub_idx to emulate a seek. Except the first parameter, it
121  * matches AVInputFormat->read_seek2 prototypes.
122  */
123 int ff_subtitles_queue_seek(FFDemuxSubtitlesQueue *q, AVFormatContext *s, int stream_index,
124                             int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
125
126 /**
127  * Remove and destroy all the subtitles packets.
128  */
129 void ff_subtitles_queue_clean(FFDemuxSubtitlesQueue *q);
130
131 /**
132  * SMIL helper to load next chunk ("<...>" or untagged content) in buf.
133  *
134  * @param c cached character, to avoid a backward seek
135  */
136 int ff_smil_extract_next_chunk(AVIOContext *pb, AVBPrint *buf, char *c);
137
138 /**
139  * SMIL helper to point on the value of an attribute in the given tag.
140  *
141  * @param s    SMIL tag ("<...>")
142  * @param attr the attribute to look for
143  */
144 const char *ff_smil_get_attr_ptr(const char *s, const char *attr);
145
146 /**
147  * @brief Read a subtitles chunk.
148  *
149  * A chunk is defined by a multiline "event", ending with a second line break.
150  * The trailing line breaks are trimmed. CRLF are supported.
151  * Example: "foo\r\nbar\r\n\r\nnext" will print "foo\r\nbar" into buf, and pb
152  * will focus on the 'n' of the "next" string.
153  *
154  * @param pb  I/O context
155  * @param buf an initialized buf where the chunk is written
156  *
157  * @note buf is cleared before writing into it.
158  */
159 void ff_subtitles_read_chunk(AVIOContext *pb, AVBPrint *buf);
160
161 /**
162  * Get the number of characters to increment to jump to the next line, or to
163  * the end of the string.
164  * The function handles the following line breaks schemes:
165  * LF, CRLF (MS), or standalone CR (old MacOS).
166  */
167 static av_always_inline int ff_subtitles_next_line(const char *ptr)
168 {
169     int n = strcspn(ptr, "\r\n");
170     ptr += n;
171     if (*ptr == '\r') {
172         ptr++;
173         n++;
174     }
175     if (*ptr == '\n')
176         n++;
177     return n;
178 }
179
180 #endif /* AVFORMAT_SUBTITLES_H */