2 * copyright (c) 2001 Fabrice Bellard
4 * This file is part of FFmpeg.
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.
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.
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
21 #ifndef AVFORMAT_INTERNAL_H
22 #define AVFORMAT_INTERNAL_H
27 #define MAX_URL_SIZE 4096
30 # define hex_dump_debug(class, buf, size) av_hex_dump_log(class, AV_LOG_DEBUG, buf, size)
32 # define hex_dump_debug(class, buf, size)
35 typedef struct AVCodecTag {
41 #define dynarray_add(tab, nb_ptr, elem)\
43 __typeof__(tab) _tab = (tab);\
44 __typeof__(elem) _elem = (elem);\
45 (void)sizeof(**_tab == _elem); /* check that types are compatible */\
46 av_dynarray_add(_tab, nb_ptr, _elem);\
49 #define dynarray_add(tab, nb_ptr, elem)\
51 av_dynarray_add((tab), nb_ptr, (elem));\
55 struct tm *brktimegm(time_t secs, struct tm *tm);
57 char *ff_data_to_hex(char *buf, const uint8_t *src, int size, int lowercase);
60 * Parse a string of hexadecimal strings. Any space between the hexadecimal
63 * @param data if non-null, the parsed data is written to this pointer
64 * @param p the string to parse
65 * @return the number of bytes written (or to be written, if data is null)
67 int ff_hex_to_data(uint8_t *data, const char *p);
69 void ff_program_add_stream_index(AVFormatContext *ac, int progid, unsigned int idx);
72 * Add packet to AVFormatContext->packet_buffer list, determining its
73 * interleaved position using compare() function argument.
74 * @return 0, or < 0 on error
76 int ff_interleave_add_packet(AVFormatContext *s, AVPacket *pkt,
77 int (*compare)(AVFormatContext *, AVPacket *, AVPacket *));
79 void ff_read_frame_flush(AVFormatContext *s);
81 #define NTP_OFFSET 2208988800ULL
82 #define NTP_OFFSET_US (NTP_OFFSET * 1000000ULL)
84 /** Get the current time since NTP epoch in microseconds. */
85 uint64_t ff_ntp_time(void);
88 * Assemble a URL string from components. This is the reverse operation
91 * Note, this requires networking to be initialized, so the caller must
92 * ensure ff_network_init has been called.
96 * @param str the buffer to fill with the url
97 * @param size the size of the str buffer
98 * @param proto the protocol identifier, if null, the separator
99 * after the identifier is left out, too
100 * @param authorization an optional authorization string, may be null.
101 * An empty string is treated the same as a null string.
102 * @param hostname the host name string
103 * @param port the port number, left out from the string if negative
104 * @param fmt a generic format string for everything to add after the
105 * host/port, may be null
106 * @return the number of characters written to the destination buffer
108 int ff_url_join(char *str, int size, const char *proto,
109 const char *authorization, const char *hostname,
110 int port, const char *fmt, ...) av_printf_format(7, 8);
113 * Append the media-specific SDP fragment for the media stream c
114 * to the buffer buff.
116 * Note, the buffer needs to be initialized, since it is appended to
119 * @param buff the buffer to append the SDP fragment to
120 * @param size the size of the buff buffer
121 * @param c the AVCodecContext of the media to describe
122 * @param dest_addr the destination address of the media stream, may be NULL
123 * @param dest_type the destination address type, may be NULL
124 * @param port the destination port of the media stream, 0 if unknown
125 * @param ttl the time to live of the stream, 0 if not multicast
126 * @param fmt the AVFormatContext, which might contain options modifying
129 void ff_sdp_write_media(char *buff, int size, AVCodecContext *c,
130 const char *dest_addr, const char *dest_type,
131 int port, int ttl, AVFormatContext *fmt);
134 * Write a packet to another muxer than the one the user originally
135 * intended. Useful when chaining muxers, where one muxer internally
136 * writes a received packet to another muxer.
138 * @param dst the muxer to write the packet to
139 * @param dst_stream the stream index within dst to write the packet to
140 * @param pkt the packet to be written
141 * @param src the muxer the packet originally was intended for
142 * @return the value av_write_frame returned
144 int ff_write_chained(AVFormatContext *dst, int dst_stream, AVPacket *pkt,
145 AVFormatContext *src);
148 * Get the length in bytes which is needed to store val as v.
150 int ff_get_v_length(uint64_t val);
153 * Put val using a variable number of bytes.
155 void ff_put_v(AVIOContext *bc, uint64_t val);
158 * Read a whole line of text from AVIOContext. Stop reading after reaching
159 * either a \\n, a \\0 or EOF. The returned string is always \\0-terminated,
160 * and may be truncated if the buffer is too small.
162 * @param s the read-only AVIOContext
163 * @param buf buffer to store the read line
164 * @param maxlen size of the buffer
165 * @return the length of the string written in the buffer, not including the
168 int ff_get_line(AVIOContext *s, char *buf, int maxlen);
170 #define SPACE_CHARS " \t\r\n"
173 * Callback function type for ff_parse_key_value.
175 * @param key a pointer to the key
176 * @param key_len the number of bytes that belong to the key, including the '='
178 * @param dest return the destination pointer for the value in *dest, may
179 * be null to ignore the value
180 * @param dest_len the length of the *dest buffer
182 typedef void (*ff_parse_key_val_cb)(void *context, const char *key,
183 int key_len, char **dest, int *dest_len);
185 * Parse a string with comma-separated key=value pairs. The value strings
186 * may be quoted and may contain escaped characters within quoted strings.
188 * @param str the string to parse
189 * @param callback_get_buf function that returns where to store the
190 * unescaped value string.
191 * @param context the opaque context pointer to pass to callback_get_buf
193 void ff_parse_key_value(const char *str, ff_parse_key_val_cb callback_get_buf,
197 * Find stream index based on format-specific stream ID
198 * @return stream index, or < 0 on error
200 int ff_find_stream_index(AVFormatContext *s, int id);
203 * Internal version of av_index_search_timestamp
205 int ff_index_search_timestamp(const AVIndexEntry *entries, int nb_entries,
206 int64_t wanted_timestamp, int flags);
209 * Internal version of av_add_index_entry
211 int ff_add_index_entry(AVIndexEntry **index_entries,
212 int *nb_index_entries,
213 unsigned int *index_entries_allocated_size,
214 int64_t pos, int64_t timestamp, int size, int distance, int flags);
219 * @param s media file handle
220 * @param id unique ID for this chapter
221 * @param start chapter start time in time_base units
222 * @param end chapter end time in time_base units
223 * @param title chapter title
225 * @return AVChapter or NULL on error
227 AVChapter *avpriv_new_chapter(AVFormatContext *s, int id, AVRational time_base,
228 int64_t start, int64_t end, const char *title);
231 * Ensure the index uses less memory than the maximum specified in
232 * AVFormatContext.max_index_size by discarding entries if it grows
235 void ff_reduce_index(AVFormatContext *s, int stream_index);
238 * Convert a relative url into an absolute url, given a base url.
240 * @param buf the buffer where output absolute url is written
241 * @param size the size of buf
242 * @param base the base url, may be equal to buf.
243 * @param rel the new url, which is interpreted relative to base
245 void ff_make_absolute_url(char *buf, int size, const char *base,
248 enum CodecID ff_guess_image2_codec(const char *filename);
251 * Convert a date string in ISO8601 format to Unix timestamp.
253 int64_t ff_iso8601_to_unix_time(const char *datestr);
256 * Perform a binary search using av_index_search_timestamp() and
257 * AVInputFormat.read_timestamp().
259 * @param target_ts target timestamp in the time base of the given stream
260 * @param stream_index stream number
262 int ff_seek_frame_binary(AVFormatContext *s, int stream_index,
263 int64_t target_ts, int flags);
266 * Update cur_dts of all streams based on the given timestamp and AVStream.
268 * Stream ref_st unchanged, others set cur_dts in their native time base.
269 * Only needed for timestamp wrapping or if (dts not set and pts!=dts).
270 * @param timestamp new dts expressed in time_base of param ref_st
271 * @param ref_st reference stream giving time_base of param timestamp
273 void ff_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
276 * Perform a binary search using read_timestamp().
278 * @param target_ts target timestamp in the time base of the given stream
279 * @param stream_index stream number
281 int64_t ff_gen_search(AVFormatContext *s, int stream_index,
282 int64_t target_ts, int64_t pos_min,
283 int64_t pos_max, int64_t pos_limit,
284 int64_t ts_min, int64_t ts_max,
285 int flags, int64_t *ts_ret,
286 int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
289 * Set the pts for a given stream. If the new values would be invalid
290 * (<= 0), it leaves the AVStream unchanged.
293 * @param pts_wrap_bits number of bits effectively used by the pts
294 * (used for wrap control, 33 is the value for MPEG)
295 * @param pts_num numerator to convert to seconds (MPEG: 1)
296 * @param pts_den denominator to convert to seconds (MPEG: 90000)
298 void avpriv_set_pts_info(AVStream *s, int pts_wrap_bits,
299 unsigned int pts_num, unsigned int pts_den);
302 * Add side data to a packet for changing parameters to the given values.
303 * Parameters set to 0 aren't included in the change.
305 int ff_add_param_change(AVPacket *pkt, int32_t channels,
306 uint64_t channel_layout, int32_t sample_rate,
307 int32_t width, int32_t height);
309 #endif /* AVFORMAT_INTERNAL_H */