Move the internal function declarations in avformat.h to internal.h.
[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 void ff_dynarray_add(intptr_t **tab_ptr, int *nb_ptr, intptr_t elem);
28
29 #ifdef __GNUC__
30 #define dynarray_add(tab, nb_ptr, elem)\
31 do {\
32     __typeof__(tab) _tab = (tab);\
33     __typeof__(elem) _elem = (elem);\
34     (void)sizeof(**_tab == _elem); /* check that types are compatible */\
35     ff_dynarray_add((intptr_t **)_tab, nb_ptr, (intptr_t)_elem);\
36 } while(0)
37 #else
38 #define dynarray_add(tab, nb_ptr, elem)\
39 do {\
40     ff_dynarray_add((intptr_t **)(tab), nb_ptr, (intptr_t)(elem));\
41 } while(0)
42 #endif
43
44 time_t mktimegm(struct tm *tm);
45 struct tm *brktimegm(time_t secs, struct tm *tm);
46 const char *small_strptime(const char *p, const char *fmt,
47                            struct tm *dt);
48
49 char *ff_data_to_hex(char *buf, const uint8_t *src, int size, int lowercase);
50
51 void ff_program_add_stream_index(AVFormatContext *ac, int progid, unsigned int idx);
52
53 /**
54  * Add packet to AVFormatContext->packet_buffer list, determining its
55  * interleaved position using compare() function argument.
56  */
57 void ff_interleave_add_packet(AVFormatContext *s, AVPacket *pkt,
58                               int (*compare)(AVFormatContext *, AVPacket *, AVPacket *));
59
60 void ff_read_frame_flush(AVFormatContext *s);
61
62 #define NTP_OFFSET 2208988800ULL
63 #define NTP_OFFSET_US (NTP_OFFSET * 1000000ULL)
64
65 /** Gets the current time since NTP epoch in microseconds. */
66 uint64_t ff_ntp_time(void);
67
68 /**
69  * Probes a bytestream to determine the input format. Each time a probe returns
70  * with a score that is too low, the probe buffer size is increased and another
71  * attempt is made. When the maximum probe size is reached, the input format
72  * with the highest score is returned.
73  *
74  * @param pb the bytestream to probe, it may be closed and opened again
75  * @param fmt the input format is put here
76  * @param filename the filename of the stream
77  * @param logctx the log context
78  * @param offset the offset within the bytestream to probe from
79  * @param max_probe_size the maximum probe buffer size (zero for default)
80  * @return 0 in case of success, a negative value corresponding to an
81  * AVERROR code otherwise
82  */
83 int ff_probe_input_buffer(ByteIOContext **pb, AVInputFormat **fmt,
84                           const char *filename, void *logctx,
85                           unsigned int offset, unsigned int max_probe_size);
86
87 /**
88  * Splits a URL string into components. To reassemble components back into
89  * a URL, use ff_url_join instead of using snprintf directly.
90  *
91  * The pointers to buffers for storing individual components may be null,
92  * in order to ignore that component. Buffers for components not found are
93  * set to empty strings. If the port isn't found, it is set to a negative
94  * value.
95  *
96  * @see ff_url_join
97  *
98  * @param proto the buffer for the protocol
99  * @param proto_size the size of the proto buffer
100  * @param authorization the buffer for the authorization
101  * @param authorization_size the size of the authorization buffer
102  * @param hostname the buffer for the host name
103  * @param hostname_size the size of the hostname buffer
104  * @param port_ptr a pointer to store the port number in
105  * @param path the buffer for the path
106  * @param path_size the size of the path buffer
107  * @param url the URL to split
108  */
109 void ff_url_split(char *proto, int proto_size,
110                   char *authorization, int authorization_size,
111                   char *hostname, int hostname_size,
112                   int *port_ptr,
113                   char *path, int path_size,
114                   const char *url);
115
116 /**
117  * Assembles a URL string from components. This is the reverse operation
118  * of ff_url_split.
119  *
120  * Note, this requires networking to be initialized, so the caller must
121  * ensure ff_network_init has been called.
122  *
123  * @see ff_url_split
124  *
125  * @param str the buffer to fill with the url
126  * @param size the size of the str buffer
127  * @param proto the protocol identifier, if null, the separator
128  *              after the identifier is left out, too
129  * @param authorization an optional authorization string, may be null
130  * @param hostname the host name string
131  * @param port the port number, left out from the string if negative
132  * @param fmt a generic format string for everything to add after the
133  *            host/port, may be null
134  * @return the number of characters written to the destination buffer
135  */
136 int ff_url_join(char *str, int size, const char *proto,
137                 const char *authorization, const char *hostname,
138                 int port, const char *fmt, ...);
139
140 #endif /* AVFORMAT_INTERNAL_H */