udp: Fix receiving RTP data over multicast
[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 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 /**
83  * Assemble a URL string from components. This is the reverse operation
84  * of av_url_split.
85  *
86  * Note, this requires networking to be initialized, so the caller must
87  * ensure ff_network_init has been called.
88  *
89  * @see av_url_split
90  *
91  * @param str the buffer to fill with the url
92  * @param size the size of the str buffer
93  * @param proto the protocol identifier, if null, the separator
94  *              after the identifier is left out, too
95  * @param authorization an optional authorization string, may be null.
96  *                      An empty string is treated the same as a null string.
97  * @param hostname the host name string
98  * @param port the port number, left out from the string if negative
99  * @param fmt a generic format string for everything to add after the
100  *            host/port, may be null
101  * @return the number of characters written to the destination buffer
102  */
103 int ff_url_join(char *str, int size, const char *proto,
104                 const char *authorization, const char *hostname,
105                 int port, const char *fmt, ...);
106
107 /**
108  * Append the media-specific SDP fragment for the media stream c
109  * to the buffer buff.
110  *
111  * Note, the buffer needs to be initialized, since it is appended to
112  * existing content.
113  *
114  * @param buff the buffer to append the SDP fragment to
115  * @param size the size of the buff buffer
116  * @param c the AVCodecContext of the media to describe
117  * @param dest_addr the destination address of the media stream, may be NULL
118  * @param dest_type the destination address type, may be NULL
119  * @param port the destination port of the media stream, 0 if unknown
120  * @param ttl the time to live of the stream, 0 if not multicast
121  */
122 void ff_sdp_write_media(char *buff, int size, AVCodecContext *c,
123                         const char *dest_addr, const char *dest_type,
124                         int port, int ttl);
125
126 /**
127  * Write a packet to another muxer than the one the user originally
128  * intended. Useful when chaining muxers, where one muxer internally
129  * writes a received packet to another muxer.
130  *
131  * @param dst the muxer to write the packet to
132  * @param dst_stream the stream index within dst to write the packet to
133  * @param pkt the packet to be written
134  * @param src the muxer the packet originally was intended for
135  * @return the value av_write_frame returned
136  */
137 int ff_write_chained(AVFormatContext *dst, int dst_stream, AVPacket *pkt,
138                      AVFormatContext *src);
139
140 /**
141  * Get the length in bytes which is needed to store val as v.
142  */
143 int ff_get_v_length(uint64_t val);
144
145 /**
146  * Put val using a variable number of bytes.
147  */
148 void ff_put_v(AVIOContext *bc, uint64_t val);
149
150 /**
151  * Read a whole line of text from AVIOContext. Stop reading after reaching
152  * either a \n, a \0 or EOF. The returned string is always \0 terminated,
153  * and may be truncated if the buffer is too small.
154  *
155  * @param s the read-only AVIOContext
156  * @param buf buffer to store the read line
157  * @param maxlen size of the buffer
158  * @return the length of the string written in the buffer, not including the
159  *         final \0
160  */
161 int ff_get_line(AVIOContext *s, char *buf, int maxlen);
162
163 #define SPACE_CHARS " \t\r\n"
164
165 /**
166  * Callback function type for ff_parse_key_value.
167  *
168  * @param key a pointer to the key
169  * @param key_len the number of bytes that belong to the key, including the '='
170  *                char
171  * @param dest return the destination pointer for the value in *dest, may
172  *             be null to ignore the value
173  * @param dest_len the length of the *dest buffer
174  */
175 typedef void (*ff_parse_key_val_cb)(void *context, const char *key,
176                                     int key_len, char **dest, int *dest_len);
177 /**
178  * Parse a string with comma-separated key=value pairs. The value strings
179  * may be quoted and may contain escaped characters within quoted strings.
180  *
181  * @param str the string to parse
182  * @param callback_get_buf function that returns where to store the
183  *                         unescaped value string.
184  * @param context the opaque context pointer to pass to callback_get_buf
185  */
186 void ff_parse_key_value(const char *str, ff_parse_key_val_cb callback_get_buf,
187                         void *context);
188
189 /**
190  * Find stream index based on format-specific stream ID
191  * @return stream index, or < 0 on error
192  */
193 int ff_find_stream_index(AVFormatContext *s, int id);
194
195 /**
196  * Internal version of av_index_search_timestamp
197  */
198 int ff_index_search_timestamp(const AVIndexEntry *entries, int nb_entries,
199                               int64_t wanted_timestamp, int flags);
200
201 /**
202  * Internal version of av_add_index_entry
203  */
204 int ff_add_index_entry(AVIndexEntry **index_entries,
205                        int *nb_index_entries,
206                        unsigned int *index_entries_allocated_size,
207                        int64_t pos, int64_t timestamp, int size, int distance, int flags);
208
209 /**
210  * Add a new chapter.
211  *
212  * @param s media file handle
213  * @param id unique ID for this chapter
214  * @param start chapter start time in time_base units
215  * @param end chapter end time in time_base units
216  * @param title chapter title
217  *
218  * @return AVChapter or NULL on error
219  */
220 AVChapter *ff_new_chapter(AVFormatContext *s, int id, AVRational time_base,
221                           int64_t start, int64_t end, const char *title);
222
223 /**
224  * Ensure the index uses less memory than the maximum specified in
225  * AVFormatContext.max_index_size by discarding entries if it grows
226  * too large.
227  */
228 void ff_reduce_index(AVFormatContext *s, int stream_index);
229
230 /*
231  * Convert a relative url into an absolute url, given a base url.
232  *
233  * @param buf the buffer where output absolute url is written
234  * @param size the size of buf
235  * @param base the base url, may be equal to buf.
236  * @param rel the new url, which is interpreted relative to base
237  */
238 void ff_make_absolute_url(char *buf, int size, const char *base,
239                           const char *rel);
240
241 enum CodecID ff_guess_image2_codec(const char *filename);
242
243 #endif /* AVFORMAT_INTERNAL_H */