libavformat: Rename the applehttp protocol to hls
[ffmpeg.git] / libavformat / internal.h
1 /*
2  * copyright (c) 2001 Fabrice Bellard
3  *
4  * This file is part of Libav.
5  *
6  * Libav 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  * Libav 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 Libav; 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_INTERNAL_H
22 #define AVFORMAT_INTERNAL_H
23
24 #include <stdint.h>
25 #include "avformat.h"
26
27 #define MAX_URL_SIZE 4096
28
29 #ifdef DEBUG
30 #    define hex_dump_debug(class, buf, size) av_hex_dump_log(class, AV_LOG_DEBUG, buf, size)
31 #else
32 #    define hex_dump_debug(class, buf, size)
33 #endif
34
35 typedef struct AVCodecTag {
36     enum CodecID id;
37     unsigned int tag;
38 } AVCodecTag;
39
40 void ff_dynarray_add(intptr_t **tab_ptr, int *nb_ptr, intptr_t elem);
41
42 #ifdef __GNUC__
43 #define dynarray_add(tab, nb_ptr, elem)\
44 do {\
45     __typeof__(tab) _tab = (tab);\
46     __typeof__(elem) _elem = (elem);\
47     (void)sizeof(**_tab == _elem); /* check that types are compatible */\
48     ff_dynarray_add((intptr_t **)_tab, nb_ptr, (intptr_t)_elem);\
49 } while(0)
50 #else
51 #define dynarray_add(tab, nb_ptr, elem)\
52 do {\
53     ff_dynarray_add((intptr_t **)(tab), nb_ptr, (intptr_t)(elem));\
54 } while(0)
55 #endif
56
57 struct tm *brktimegm(time_t secs, struct tm *tm);
58
59 char *ff_data_to_hex(char *buf, const uint8_t *src, int size, int lowercase);
60
61 /**
62  * Parse a string of hexadecimal strings. Any space between the hexadecimal
63  * digits is ignored.
64  *
65  * @param data if non-null, the parsed data is written to this pointer
66  * @param p the string to parse
67  * @return the number of bytes written (or to be written, if data is null)
68  */
69 int ff_hex_to_data(uint8_t *data, const char *p);
70
71 void ff_program_add_stream_index(AVFormatContext *ac, int progid, unsigned int idx);
72
73 /**
74  * Add packet to AVFormatContext->packet_buffer list, determining its
75  * interleaved position using compare() function argument.
76  */
77 void ff_interleave_add_packet(AVFormatContext *s, AVPacket *pkt,
78                               int (*compare)(AVFormatContext *, AVPacket *, AVPacket *));
79
80 void ff_read_frame_flush(AVFormatContext *s);
81
82 #define NTP_OFFSET 2208988800ULL
83 #define NTP_OFFSET_US (NTP_OFFSET * 1000000ULL)
84
85 /** Get the current time since NTP epoch in microseconds. */
86 uint64_t ff_ntp_time(void);
87
88 /**
89  * Assemble a URL string from components. This is the reverse operation
90  * of av_url_split.
91  *
92  * Note, this requires networking to be initialized, so the caller must
93  * ensure ff_network_init has been called.
94  *
95  * @see av_url_split
96  *
97  * @param str the buffer to fill with the url
98  * @param size the size of the str buffer
99  * @param proto the protocol identifier, if null, the separator
100  *              after the identifier is left out, too
101  * @param authorization an optional authorization string, may be null.
102  *                      An empty string is treated the same as a null string.
103  * @param hostname the host name string
104  * @param port the port number, left out from the string if negative
105  * @param fmt a generic format string for everything to add after the
106  *            host/port, may be null
107  * @return the number of characters written to the destination buffer
108  */
109 int ff_url_join(char *str, int size, const char *proto,
110                 const char *authorization, const char *hostname,
111                 int port, const char *fmt, ...) av_printf_format(7, 8);
112
113 /**
114  * Append the media-specific SDP fragment for the media stream c
115  * to the buffer buff.
116  *
117  * Note, the buffer needs to be initialized, since it is appended to
118  * existing content.
119  *
120  * @param buff the buffer to append the SDP fragment to
121  * @param size the size of the buff buffer
122  * @param c the AVCodecContext of the media to describe
123  * @param dest_addr the destination address of the media stream, may be NULL
124  * @param dest_type the destination address type, may be NULL
125  * @param port the destination port of the media stream, 0 if unknown
126  * @param ttl the time to live of the stream, 0 if not multicast
127  * @param fmt the AVFormatContext, which might contain options modifying
128  *            the generated SDP
129  */
130 void ff_sdp_write_media(char *buff, int size, AVCodecContext *c,
131                         const char *dest_addr, const char *dest_type,
132                         int port, int ttl, AVFormatContext *fmt);
133
134 /**
135  * Write a packet to another muxer than the one the user originally
136  * intended. Useful when chaining muxers, where one muxer internally
137  * writes a received packet to another muxer.
138  *
139  * @param dst the muxer to write the packet to
140  * @param dst_stream the stream index within dst to write the packet to
141  * @param pkt the packet to be written
142  * @param src the muxer the packet originally was intended for
143  * @return the value av_write_frame returned
144  */
145 int ff_write_chained(AVFormatContext *dst, int dst_stream, AVPacket *pkt,
146                      AVFormatContext *src);
147
148 /**
149  * Get the length in bytes which is needed to store val as v.
150  */
151 int ff_get_v_length(uint64_t val);
152
153 /**
154  * Put val using a variable number of bytes.
155  */
156 void ff_put_v(AVIOContext *bc, uint64_t val);
157
158 /**
159  * Read a whole line of text from AVIOContext. Stop reading after reaching
160  * either a \\n, a \\0 or EOF. The returned string is always \\0-terminated,
161  * and may be truncated if the buffer is too small.
162  *
163  * @param s the read-only AVIOContext
164  * @param buf buffer to store the read line
165  * @param maxlen size of the buffer
166  * @return the length of the string written in the buffer, not including the
167  *         final \\0
168  */
169 int ff_get_line(AVIOContext *s, char *buf, int maxlen);
170
171 #define SPACE_CHARS " \t\r\n"
172
173 /**
174  * Callback function type for ff_parse_key_value.
175  *
176  * @param key a pointer to the key
177  * @param key_len the number of bytes that belong to the key, including the '='
178  *                char
179  * @param dest return the destination pointer for the value in *dest, may
180  *             be null to ignore the value
181  * @param dest_len the length of the *dest buffer
182  */
183 typedef void (*ff_parse_key_val_cb)(void *context, const char *key,
184                                     int key_len, char **dest, int *dest_len);
185 /**
186  * Parse a string with comma-separated key=value pairs. The value strings
187  * may be quoted and may contain escaped characters within quoted strings.
188  *
189  * @param str the string to parse
190  * @param callback_get_buf function that returns where to store the
191  *                         unescaped value string.
192  * @param context the opaque context pointer to pass to callback_get_buf
193  */
194 void ff_parse_key_value(const char *str, ff_parse_key_val_cb callback_get_buf,
195                         void *context);
196
197 /**
198  * Find stream index based on format-specific stream ID
199  * @return stream index, or < 0 on error
200  */
201 int ff_find_stream_index(AVFormatContext *s, int id);
202
203 /**
204  * Internal version of av_index_search_timestamp
205  */
206 int ff_index_search_timestamp(const AVIndexEntry *entries, int nb_entries,
207                               int64_t wanted_timestamp, int flags);
208
209 /**
210  * Internal version of av_add_index_entry
211  */
212 int ff_add_index_entry(AVIndexEntry **index_entries,
213                        int *nb_index_entries,
214                        unsigned int *index_entries_allocated_size,
215                        int64_t pos, int64_t timestamp, int size, int distance, int flags);
216
217 /**
218  * Add a new chapter.
219  *
220  * @param s media file handle
221  * @param id unique ID for this chapter
222  * @param start chapter start time in time_base units
223  * @param end chapter end time in time_base units
224  * @param title chapter title
225  *
226  * @return AVChapter or NULL on error
227  */
228 AVChapter *avpriv_new_chapter(AVFormatContext *s, int id, AVRational time_base,
229                               int64_t start, int64_t end, const char *title);
230
231 /**
232  * Ensure the index uses less memory than the maximum specified in
233  * AVFormatContext.max_index_size by discarding entries if it grows
234  * too large.
235  */
236 void ff_reduce_index(AVFormatContext *s, int stream_index);
237
238 /*
239  * Convert a relative url into an absolute url, given a base url.
240  *
241  * @param buf the buffer where output absolute url is written
242  * @param size the size of buf
243  * @param base the base url, may be equal to buf.
244  * @param rel the new url, which is interpreted relative to base
245  */
246 void ff_make_absolute_url(char *buf, int size, const char *base,
247                           const char *rel);
248
249 enum CodecID ff_guess_image2_codec(const char *filename);
250
251 /**
252  * Convert a date string in ISO8601 format to Unix timestamp.
253  */
254 int64_t ff_iso8601_to_unix_time(const char *datestr);
255
256 /**
257  * Perform a binary search using av_index_search_timestamp() and
258  * AVInputFormat.read_timestamp().
259  *
260  * @param target_ts target timestamp in the time base of the given stream
261  * @param stream_index stream number
262  */
263 int ff_seek_frame_binary(AVFormatContext *s, int stream_index,
264                          int64_t target_ts, int flags);
265
266 /**
267  * Update cur_dts of all streams based on the given timestamp and AVStream.
268  *
269  * Stream ref_st unchanged, others set cur_dts in their native time base.
270  * Only needed for timestamp wrapping or if (dts not set and pts!=dts).
271  * @param timestamp new dts expressed in time_base of param ref_st
272  * @param ref_st reference stream giving time_base of param timestamp
273  */
274 void ff_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
275
276 /**
277  * Perform a binary search using read_timestamp().
278  *
279  * @param target_ts target timestamp in the time base of the given stream
280  * @param stream_index stream number
281  */
282 int64_t ff_gen_search(AVFormatContext *s, int stream_index,
283                       int64_t target_ts, int64_t pos_min,
284                       int64_t pos_max, int64_t pos_limit,
285                       int64_t ts_min, int64_t ts_max,
286                       int flags, int64_t *ts_ret,
287                       int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
288
289 /**
290  * Set the pts for a given stream. If the new values would be invalid
291  * (<= 0), it leaves the AVStream unchanged.
292  *
293  * @param s stream
294  * @param pts_wrap_bits number of bits effectively used by the pts
295  *        (used for wrap control, 33 is the value for MPEG)
296  * @param pts_num numerator to convert to seconds (MPEG: 1)
297  * @param pts_den denominator to convert to seconds (MPEG: 90000)
298  */
299 void avpriv_set_pts_info(AVStream *s, int pts_wrap_bits,
300                          unsigned int pts_num, unsigned int pts_den);
301
302 /**
303  * Add side data to a packet for changing parameters to the given values.
304  * Parameters set to 0 aren't included in the change.
305  */
306 int ff_add_param_change(AVPacket *pkt, int32_t channels,
307                         uint64_t channel_layout, int32_t sample_rate,
308                         int32_t width, int32_t height);
309
310 /**
311  * Set the timebase for each stream from the corresponding codec timebase and
312  * print it.
313  */
314 int ff_framehash_write_header(AVFormatContext *s);
315
316 #endif /* AVFORMAT_INTERNAL_H */