avio: rename ByteIOContext to AVIOContext.
[ffmpeg.git] / libavformat / internal.h
1 /*
2  * copyright (c) 2001 Fabrice Bellard
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_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 typedef struct AVCodecTag {
30     enum CodecID id;
31     unsigned int tag;
32 } AVCodecTag;
33
34 void ff_dynarray_add(intptr_t **tab_ptr, int *nb_ptr, intptr_t elem);
35
36 #ifdef __GNUC__
37 #define dynarray_add(tab, nb_ptr, elem)\
38 do {\
39     __typeof__(tab) _tab = (tab);\
40     __typeof__(elem) _elem = (elem);\
41     (void)sizeof(**_tab == _elem); /* check that types are compatible */\
42     ff_dynarray_add((intptr_t **)_tab, nb_ptr, (intptr_t)_elem);\
43 } while(0)
44 #else
45 #define dynarray_add(tab, nb_ptr, elem)\
46 do {\
47     ff_dynarray_add((intptr_t **)(tab), nb_ptr, (intptr_t)(elem));\
48 } while(0)
49 #endif
50
51 struct tm *brktimegm(time_t secs, struct tm *tm);
52
53 char *ff_data_to_hex(char *buf, const uint8_t *src, int size, int lowercase);
54
55 /**
56  * Parse a string of hexadecimal strings. Any space between the hexadecimal
57  * digits is ignored.
58  *
59  * @param data if non-null, the parsed data is written to this pointer
60  * @param p the string to parse
61  * @return the number of bytes written (or to be written, if data is null)
62  */
63 int ff_hex_to_data(uint8_t *data, const char *p);
64
65 void ff_program_add_stream_index(AVFormatContext *ac, int progid, unsigned int idx);
66
67 /**
68  * Add packet to AVFormatContext->packet_buffer list, determining its
69  * interleaved position using compare() function argument.
70  */
71 void ff_interleave_add_packet(AVFormatContext *s, AVPacket *pkt,
72                               int (*compare)(AVFormatContext *, AVPacket *, AVPacket *));
73
74 void ff_read_frame_flush(AVFormatContext *s);
75
76 #define NTP_OFFSET 2208988800ULL
77 #define NTP_OFFSET_US (NTP_OFFSET * 1000000ULL)
78
79 /** Get the current time since NTP epoch in microseconds. */
80 uint64_t ff_ntp_time(void);
81
82 #if FF_API_URL_SPLIT
83 /**
84  * @deprecated use av_url_split() instead
85  */
86 void ff_url_split(char *proto, int proto_size,
87                   char *authorization, int authorization_size,
88                   char *hostname, int hostname_size,
89                   int *port_ptr,
90                   char *path, int path_size,
91                   const char *url);
92 #endif
93
94 /**
95  * Assemble a URL string from components. This is the reverse operation
96  * of av_url_split.
97  *
98  * Note, this requires networking to be initialized, so the caller must
99  * ensure ff_network_init has been called.
100  *
101  * @see av_url_split
102  *
103  * @param str the buffer to fill with the url
104  * @param size the size of the str buffer
105  * @param proto the protocol identifier, if null, the separator
106  *              after the identifier is left out, too
107  * @param authorization an optional authorization string, may be null.
108  *                      An empty string is treated the same as a null string.
109  * @param hostname the host name string
110  * @param port the port number, left out from the string if negative
111  * @param fmt a generic format string for everything to add after the
112  *            host/port, may be null
113  * @return the number of characters written to the destination buffer
114  */
115 int ff_url_join(char *str, int size, const char *proto,
116                 const char *authorization, const char *hostname,
117                 int port, const char *fmt, ...);
118
119 /**
120  * Append the media-specific SDP fragment for the media stream c
121  * to the buffer buff.
122  *
123  * Note, the buffer needs to be initialized, since it is appended to
124  * existing content.
125  *
126  * @param buff the buffer to append the SDP fragment to
127  * @param size the size of the buff buffer
128  * @param c the AVCodecContext of the media to describe
129  * @param dest_addr the destination address of the media stream, may be NULL
130  * @param dest_type the destination address type, may be NULL
131  * @param port the destination port of the media stream, 0 if unknown
132  * @param ttl the time to live of the stream, 0 if not multicast
133  */
134 void ff_sdp_write_media(char *buff, int size, AVCodecContext *c,
135                         const char *dest_addr, const char *dest_type,
136                         int port, int ttl);
137
138 /**
139  * Write a packet to another muxer than the one the user originally
140  * intended. Useful when chaining muxers, where one muxer internally
141  * writes a received packet to another muxer.
142  *
143  * @param dst the muxer to write the packet to
144  * @param dst_stream the stream index within dst to write the packet to
145  * @param pkt the packet to be written
146  * @param src the muxer the packet originally was intended for
147  * @return the value av_write_frame returned
148  */
149 int ff_write_chained(AVFormatContext *dst, int dst_stream, AVPacket *pkt,
150                      AVFormatContext *src);
151
152 /**
153  * Get the length in bytes which is needed to store val as v.
154  */
155 int ff_get_v_length(uint64_t val);
156
157 /**
158  * Put val using a variable number of bytes.
159  */
160 void ff_put_v(AVIOContext *bc, uint64_t val);
161
162 /**
163  * Read a whole line of text from AVIOContext. Stop reading after reaching
164  * either a \n, a \0 or EOF. The returned string is always \0 terminated,
165  * and may be truncated if the buffer is too small.
166  *
167  * @param s the read-only AVIOContext
168  * @param buf buffer to store the read line
169  * @param maxlen size of the buffer
170  * @return the length of the string written in the buffer, not including the
171  *         final \0
172  */
173 int ff_get_line(AVIOContext *s, char *buf, int maxlen);
174
175 #define SPACE_CHARS " \t\r\n"
176
177 /**
178  * Callback function type for ff_parse_key_value.
179  *
180  * @param key a pointer to the key
181  * @param key_len the number of bytes that belong to the key, including the '='
182  *                char
183  * @param dest return the destination pointer for the value in *dest, may
184  *             be null to ignore the value
185  * @param dest_len the length of the *dest buffer
186  */
187 typedef void (*ff_parse_key_val_cb)(void *context, const char *key,
188                                     int key_len, char **dest, int *dest_len);
189 /**
190  * Parse a string with comma-separated key=value pairs. The value strings
191  * may be quoted and may contain escaped characters within quoted strings.
192  *
193  * @param str the string to parse
194  * @param callback_get_buf function that returns where to store the
195  *                         unescaped value string.
196  * @param context the opaque context pointer to pass to callback_get_buf
197  */
198 void ff_parse_key_value(const char *str, ff_parse_key_val_cb callback_get_buf,
199                         void *context);
200
201 /**
202  * Find stream index based on format-specific stream ID
203  * @return stream index, or < 0 on error
204  */
205 int ff_find_stream_index(AVFormatContext *s, int id);
206
207 /**
208  * Internal version of av_index_search_timestamp
209  */
210 int ff_index_search_timestamp(const AVIndexEntry *entries, int nb_entries,
211                               int64_t wanted_timestamp, int flags);
212
213 /**
214  * Internal version of av_add_index_entry
215  */
216 int ff_add_index_entry(AVIndexEntry **index_entries,
217                        int *nb_index_entries,
218                        unsigned int *index_entries_allocated_size,
219                        int64_t pos, int64_t timestamp, int size, int distance, int flags);
220
221 /**
222  * Add a new chapter.
223  *
224  * @param s media file handle
225  * @param id unique ID for this chapter
226  * @param start chapter start time in time_base units
227  * @param end chapter end time in time_base units
228  * @param title chapter title
229  *
230  * @return AVChapter or NULL on error
231  */
232 AVChapter *ff_new_chapter(AVFormatContext *s, int id, AVRational time_base,
233                           int64_t start, int64_t end, const char *title);
234
235 /**
236  * Ensure the index uses less memory than the maximum specified in
237  * AVFormatContext.max_index_size by discarding entries if it grows
238  * too large.
239  */
240 void ff_reduce_index(AVFormatContext *s, int stream_index);
241
242 #endif /* AVFORMAT_INTERNAL_H */