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