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 {
40 typedef struct CodecMime{
46 #define dynarray_add(tab, nb_ptr, elem)\
48 __typeof__(tab) _tab = (tab);\
49 __typeof__(elem) _elem = (elem);\
50 (void)sizeof(**_tab == _elem); /* check that types are compatible */\
51 av_dynarray_add(_tab, nb_ptr, _elem);\
54 #define dynarray_add(tab, nb_ptr, elem)\
56 av_dynarray_add((tab), nb_ptr, (elem));\
60 struct tm *ff_brktimegm(time_t secs, struct tm *tm);
62 char *ff_data_to_hex(char *buf, const uint8_t *src, int size, int lowercase);
65 * Parse a string of hexadecimal strings. Any space between the hexadecimal
68 * @param data if non-null, the parsed data is written to this pointer
69 * @param p the string to parse
70 * @return the number of bytes written (or to be written, if data is null)
72 int ff_hex_to_data(uint8_t *data, const char *p);
74 void ff_program_add_stream_index(AVFormatContext *ac, int progid, unsigned int idx);
77 * Add packet to AVFormatContext->packet_buffer list, determining its
78 * interleaved position using compare() function argument.
79 * @return 0, or < 0 on error
81 int ff_interleave_add_packet(AVFormatContext *s, AVPacket *pkt,
82 int (*compare)(AVFormatContext *, AVPacket *, AVPacket *));
84 void ff_read_frame_flush(AVFormatContext *s);
86 #define NTP_OFFSET 2208988800ULL
87 #define NTP_OFFSET_US (NTP_OFFSET * 1000000ULL)
89 /** Get the current time since NTP epoch in microseconds. */
90 uint64_t ff_ntp_time(void);
93 * Assemble a URL string from components. This is the reverse operation
96 * Note, this requires networking to be initialized, so the caller must
97 * ensure ff_network_init has been called.
101 * @param str the buffer to fill with the url
102 * @param size the size of the str buffer
103 * @param proto the protocol identifier, if null, the separator
104 * after the identifier is left out, too
105 * @param authorization an optional authorization string, may be null.
106 * An empty string is treated the same as a null string.
107 * @param hostname the host name string
108 * @param port the port number, left out from the string if negative
109 * @param fmt a generic format string for everything to add after the
110 * host/port, may be null
111 * @return the number of characters written to the destination buffer
113 int ff_url_join(char *str, int size, const char *proto,
114 const char *authorization, const char *hostname,
115 int port, const char *fmt, ...) av_printf_format(7, 8);
118 * Append the media-specific SDP fragment for the media stream c
119 * to the buffer buff.
121 * Note, the buffer needs to be initialized, since it is appended to
124 * @param buff the buffer to append the SDP fragment to
125 * @param size the size of the buff buffer
126 * @param st the AVStream of the media to describe
127 * @param idx the global stream index
128 * @param dest_addr the destination address of the media stream, may be NULL
129 * @param dest_type the destination address type, may be NULL
130 * @param port the destination port of the media stream, 0 if unknown
131 * @param ttl the time to live of the stream, 0 if not multicast
132 * @param fmt the AVFormatContext, which might contain options modifying
135 void ff_sdp_write_media(char *buff, int size, AVStream *st, int idx,
136 const char *dest_addr, const char *dest_type,
137 int port, int ttl, AVFormatContext *fmt);
140 * Write a packet to another muxer than the one the user originally
141 * intended. Useful when chaining muxers, where one muxer internally
142 * writes a received packet to another muxer.
144 * @param dst the muxer to write the packet to
145 * @param dst_stream the stream index within dst to write the packet to
146 * @param pkt the packet to be written
147 * @param src the muxer the packet originally was intended for
148 * @return the value av_write_frame returned
150 int ff_write_chained(AVFormatContext *dst, int dst_stream, AVPacket *pkt,
151 AVFormatContext *src);
154 * Get the length in bytes which is needed to store val as v.
156 int ff_get_v_length(uint64_t val);
159 * Put val using a variable number of bytes.
161 void ff_put_v(AVIOContext *bc, uint64_t val);
164 * Read a whole line of text from AVIOContext. Stop reading after reaching
165 * either a \\n, a \\0 or EOF. The returned string is always \\0-terminated,
166 * and may be truncated if the buffer is too small.
168 * @param s the read-only AVIOContext
169 * @param buf buffer to store the read line
170 * @param maxlen size of the buffer
171 * @return the length of the string written in the buffer, not including the
174 int ff_get_line(AVIOContext *s, char *buf, int maxlen);
176 #define SPACE_CHARS " \t\r\n"
179 * Callback function type for ff_parse_key_value.
181 * @param key a pointer to the key
182 * @param key_len the number of bytes that belong to the key, including the '='
184 * @param dest return the destination pointer for the value in *dest, may
185 * be null to ignore the value
186 * @param dest_len the length of the *dest buffer
188 typedef void (*ff_parse_key_val_cb)(void *context, const char *key,
189 int key_len, char **dest, int *dest_len);
191 * Parse a string with comma-separated key=value pairs. The value strings
192 * may be quoted and may contain escaped characters within quoted strings.
194 * @param str the string to parse
195 * @param callback_get_buf function that returns where to store the
196 * unescaped value string.
197 * @param context the opaque context pointer to pass to callback_get_buf
199 void ff_parse_key_value(const char *str, ff_parse_key_val_cb callback_get_buf,
203 * Find stream index based on format-specific stream ID
204 * @return stream index, or < 0 on error
206 int ff_find_stream_index(AVFormatContext *s, int id);
209 * Internal version of av_index_search_timestamp
211 int ff_index_search_timestamp(const AVIndexEntry *entries, int nb_entries,
212 int64_t wanted_timestamp, int flags);
215 * Internal version of av_add_index_entry
217 int ff_add_index_entry(AVIndexEntry **index_entries,
218 int *nb_index_entries,
219 unsigned int *index_entries_allocated_size,
220 int64_t pos, int64_t timestamp, int size, int distance, int flags);
225 * @param s media file handle
226 * @param id unique ID for this chapter
227 * @param start chapter start time in time_base units
228 * @param end chapter end time in time_base units
229 * @param title chapter title
231 * @return AVChapter or NULL on error
233 AVChapter *avpriv_new_chapter(AVFormatContext *s, int id, AVRational time_base,
234 int64_t start, int64_t end, const char *title);
237 * Ensure the index uses less memory than the maximum specified in
238 * AVFormatContext.max_index_size by discarding entries if it grows
241 void ff_reduce_index(AVFormatContext *s, int stream_index);
244 * Convert a relative url into an absolute url, given a base url.
246 * @param buf the buffer where output absolute url is written
247 * @param size the size of buf
248 * @param base the base url, may be equal to buf.
249 * @param rel the new url, which is interpreted relative to base
251 void ff_make_absolute_url(char *buf, int size, const char *base,
254 enum AVCodecID ff_guess_image2_codec(const char *filename);
257 * Convert a date string in ISO8601 format to Unix timestamp.
259 int64_t ff_iso8601_to_unix_time(const char *datestr);
262 * Perform a binary search using av_index_search_timestamp() and
263 * AVInputFormat.read_timestamp().
265 * @param target_ts target timestamp in the time base of the given stream
266 * @param stream_index stream number
268 int ff_seek_frame_binary(AVFormatContext *s, int stream_index,
269 int64_t target_ts, int flags);
272 * Update cur_dts of all streams based on the given timestamp and AVStream.
274 * Stream ref_st unchanged, others set cur_dts in their native time base.
275 * Only needed for timestamp wrapping or if (dts not set and pts!=dts).
276 * @param timestamp new dts expressed in time_base of param ref_st
277 * @param ref_st reference stream giving time_base of param timestamp
279 void ff_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
282 * Perform a binary search using read_timestamp().
284 * @param target_ts target timestamp in the time base of the given stream
285 * @param stream_index stream number
287 int64_t ff_gen_search(AVFormatContext *s, int stream_index,
288 int64_t target_ts, int64_t pos_min,
289 int64_t pos_max, int64_t pos_limit,
290 int64_t ts_min, int64_t ts_max,
291 int flags, int64_t *ts_ret,
292 int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
295 * Set the pts for a given stream. If the new values would be invalid
296 * (<= 0), it leaves the AVStream unchanged.
299 * @param pts_wrap_bits number of bits effectively used by the pts
300 * (used for wrap control, 33 is the value for MPEG)
301 * @param pts_num numerator to convert to seconds (MPEG: 1)
302 * @param pts_den denominator to convert to seconds (MPEG: 90000)
304 void avpriv_set_pts_info(AVStream *s, int pts_wrap_bits,
305 unsigned int pts_num, unsigned int pts_den);
308 * Add side data to a packet for changing parameters to the given values.
309 * Parameters set to 0 aren't included in the change.
311 int ff_add_param_change(AVPacket *pkt, int32_t channels,
312 uint64_t channel_layout, int32_t sample_rate,
313 int32_t width, int32_t height);
316 * Set the timebase for each stream from the corresponding codec timebase and
319 int ff_framehash_write_header(AVFormatContext *s);
322 * Read a transport packet from a media file.
324 * @param s media file handle
325 * @param pkt is filled
326 * @return 0 if OK, AVERROR_xxx on error
328 int ff_read_packet(AVFormatContext *s, AVPacket *pkt);
331 * Interleave a packet per dts in an output media file.
333 * Packets with pkt->destruct == av_destruct_packet will be freed inside this
334 * function, so they cannot be used after it. Note that calling av_free_packet()
335 * on them is still safe.
337 * @param s media file handle
338 * @param out the interleaved packet will be output here
339 * @param pkt the input packet
340 * @param flush 1 if no further packets are available as input and all
341 * remaining packets should be output
342 * @return 1 if a packet was output, 0 if no packet could be output,
343 * < 0 if an error occurred
345 int ff_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
346 AVPacket *pkt, int flush);
348 void ff_free_stream(AVFormatContext *s, AVStream *st);
351 * Return the frame duration in seconds. Return 0 if not available.
353 void ff_compute_frame_duration(int *pnum, int *pden, AVStream *st,
354 AVCodecParserContext *pc, AVPacket *pkt);
356 int ff_get_audio_frame_size(AVCodecContext *enc, int size, int mux);
358 unsigned int ff_codec_get_tag(const AVCodecTag *tags, enum AVCodecID id);
360 enum AVCodecID ff_codec_get_id(const AVCodecTag *tags, unsigned int tag);
363 * Select a PCM codec based on the given parameters.
365 * @param bps bits-per-sample
366 * @param flt floating-point
367 * @param be big-endian
368 * @param sflags signed flags. each bit corresponds to one byte of bit depth.
369 * e.g. the 1st bit indicates if 8-bit should be signed or
370 * unsigned, the 2nd bit indicates if 16-bit should be signed or
371 * unsigned, etc... This is useful for formats such as WAVE where
372 * only 8-bit is unsigned and all other bit depths are signed.
373 * @return a PCM codec id or AV_CODEC_ID_NONE
375 enum AVCodecID ff_get_pcm_codec_id(int bps, int flt, int be, int sflags);
378 * Chooses a timebase for muxing the specified stream.
380 * The choosen timebase allows sample accurate timestamps based
381 * on the framerate or sample rate for audio streams. It also is
382 * at least as precisse as 1/min_precission would be.
384 AVRational ff_choose_timebase(AVFormatContext *s, AVStream *st, int min_precission);
386 #endif /* AVFORMAT_INTERNAL_H */