232b40b25345fe07db5ed116a1af444e70b9c4c0
[libav.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 typedef struct AVCodecTag {
28 enum CodecID id;
29 unsigned int tag;
30 } AVCodecTag;
31
32 void ff_dynarray_add(intptr_t **tab_ptr, int *nb_ptr, intptr_t elem);
33
34 #ifdef __GNUC__
35 #define dynarray_add(tab, nb_ptr, elem)\
36 do {\
37 __typeof__(tab) _tab = (tab);\
38 __typeof__(elem) _elem = (elem);\
39 (void)sizeof(**_tab == _elem); /* check that types are compatible */\
40 ff_dynarray_add((intptr_t **)_tab, nb_ptr, (intptr_t)_elem);\
41 } while(0)
42 #else
43 #define dynarray_add(tab, nb_ptr, elem)\
44 do {\
45 ff_dynarray_add((intptr_t **)(tab), nb_ptr, (intptr_t)(elem));\
46 } while(0)
47 #endif
48
49 time_t mktimegm(struct tm *tm);
50 struct tm *brktimegm(time_t secs, struct tm *tm);
51 const char *small_strptime(const char *p, const char *fmt,
52 struct tm *dt);
53
54 char *ff_data_to_hex(char *buf, const uint8_t *src, int size, int lowercase);
55
56 void ff_program_add_stream_index(AVFormatContext *ac, int progid, unsigned int idx);
57
58 /**
59 * Add packet to AVFormatContext->packet_buffer list, determining its
60 * interleaved position using compare() function argument.
61 */
62 void ff_interleave_add_packet(AVFormatContext *s, AVPacket *pkt,
63 int (*compare)(AVFormatContext *, AVPacket *, AVPacket *));
64
65 void ff_read_frame_flush(AVFormatContext *s);
66
67 #define NTP_OFFSET 2208988800ULL
68 #define NTP_OFFSET_US (NTP_OFFSET * 1000000ULL)
69
70 /** Get the current time since NTP epoch in microseconds. */
71 uint64_t ff_ntp_time(void);
72
73 /**
74 * Probe a bytestream to determine the input format. Each time a probe returns
75 * with a score that is too low, the probe buffer size is increased and another
76 * attempt is made. When the maximum probe size is reached, the input format
77 * with the highest score is returned.
78 *
79 * @param pb the bytestream to probe, it may be closed and opened again
80 * @param fmt the input format is put here
81 * @param filename the filename of the stream
82 * @param logctx the log context
83 * @param offset the offset within the bytestream to probe from
84 * @param max_probe_size the maximum probe buffer size (zero for default)
85 * @return 0 in case of success, a negative value corresponding to an
86 * AVERROR code otherwise
87 */
88 int ff_probe_input_buffer(ByteIOContext **pb, AVInputFormat **fmt,
89 const char *filename, void *logctx,
90 unsigned int offset, unsigned int max_probe_size);
91
92 #if LIBAVFORMAT_VERSION_MAJOR < 53
93 /**
94 * @deprecated use av_url_split() instead
95 */
96 void ff_url_split(char *proto, int proto_size,
97 char *authorization, int authorization_size,
98 char *hostname, int hostname_size,
99 int *port_ptr,
100 char *path, int path_size,
101 const char *url);
102 #endif
103
104 /**
105 * Assemble a URL string from components. This is the reverse operation
106 * of av_url_split.
107 *
108 * Note, this requires networking to be initialized, so the caller must
109 * ensure ff_network_init has been called.
110 *
111 * @see av_url_split
112 *
113 * @param str the buffer to fill with the url
114 * @param size the size of the str buffer
115 * @param proto the protocol identifier, if null, the separator
116 * after the identifier is left out, too
117 * @param authorization an optional authorization string, may be null.
118 * An empty string is treated the same as a null string.
119 * @param hostname the host name string
120 * @param port the port number, left out from the string if negative
121 * @param fmt a generic format string for everything to add after the
122 * host/port, may be null
123 * @return the number of characters written to the destination buffer
124 */
125 int ff_url_join(char *str, int size, const char *proto,
126 const char *authorization, const char *hostname,
127 int port, const char *fmt, ...);
128
129 /**
130 * Append the media-specific SDP fragment for the media stream c
131 * to the buffer buff.
132 *
133 * Note, the buffer needs to be initialized, since it is appended to
134 * existing content.
135 *
136 * @param buff the buffer to append the SDP fragment to
137 * @param size the size of the buff buffer
138 * @param c the AVCodecContext of the media to describe
139 * @param dest_addr the destination address of the media stream, may be NULL
140 * @param port the destination port of the media stream, 0 if unknown
141 * @param ttl the time to live of the stream, 0 if not multicast
142 */
143 void ff_sdp_write_media(char *buff, int size, AVCodecContext *c,
144 const char *dest_addr, int port, int ttl);
145
146 /**
147 * Write a packet to another muxer than the one the user originally
148 * intended. Useful when chaining muxers, where one muxer internally
149 * writes a received packet to another muxer.
150 *
151 * @param dst the muxer to write the packet to
152 * @param dst_stream the stream index within dst to write the packet to
153 * @param pkt the packet to be written
154 * @param src the muxer the packet originally was intended for
155 * @return the value av_write_frame returned
156 */
157 int ff_write_chained(AVFormatContext *dst, int dst_stream, AVPacket *pkt,
158 AVFormatContext *src);
159
160 /**
161 * Get the length in bytes which is needed to store val as v.
162 */
163 int ff_get_v_length(uint64_t val);
164
165 /**
166 * Put val using a variable number of bytes.
167 */
168 void ff_put_v(ByteIOContext *bc, uint64_t val);
169
170 /**
171 * Read a whole line of text from ByteIOContext. Stop reading after reaching
172 * either a \n, a \0 or EOF. The returned string is always \0 terminated,
173 * and may be truncated if the buffer is too small.
174 *
175 * @param s the read-only ByteIOContext
176 * @param buf buffer to store the read line
177 * @param maxlen size of the buffer
178 * @return the length of the string written in the buffer, not including the
179 * final \0
180 */
181 int ff_get_line(ByteIOContext *s, char *buf, int maxlen);
182
183 #define SPACE_CHARS " \t\r\n"
184
185 #endif /* AVFORMAT_INTERNAL_H */