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