2 * copyright (c) 2001 Fabrice Bellard
4 * This file is part of Libav.
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.
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.
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
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{
45 void ff_dynarray_add(intptr_t **tab_ptr, int *nb_ptr, intptr_t elem);
48 #define dynarray_add(tab, nb_ptr, elem)\
50 __typeof__(tab) _tab = (tab);\
51 __typeof__(elem) _elem = (elem);\
52 (void)sizeof(**_tab == _elem); /* check that types are compatible */\
53 ff_dynarray_add((intptr_t **)_tab, nb_ptr, (intptr_t)_elem);\
56 #define dynarray_add(tab, nb_ptr, elem)\
58 ff_dynarray_add((intptr_t **)(tab), nb_ptr, (intptr_t)(elem));\
62 struct tm *ff_brktimegm(time_t secs, struct tm *tm);
64 char *ff_data_to_hex(char *buf, const uint8_t *src, int size, int lowercase);
67 * Parse a string of hexadecimal strings. Any space between the hexadecimal
70 * @param data if non-null, the parsed data is written to this pointer
71 * @param p the string to parse
72 * @return the number of bytes written (or to be written, if data is null)
74 int ff_hex_to_data(uint8_t *data, const char *p);
76 void ff_program_add_stream_index(AVFormatContext *ac, int progid, unsigned int idx);
79 * Add packet to AVFormatContext->packet_buffer list, determining its
80 * interleaved position using compare() function argument.
82 void ff_interleave_add_packet(AVFormatContext *s, AVPacket *pkt,
83 int (*compare)(AVFormatContext *, AVPacket *, AVPacket *));
85 void ff_read_frame_flush(AVFormatContext *s);
87 #define NTP_OFFSET 2208988800ULL
88 #define NTP_OFFSET_US (NTP_OFFSET * 1000000ULL)
90 /** Get the current time since NTP epoch in microseconds. */
91 uint64_t ff_ntp_time(void);
94 * Append the media-specific SDP fragment for the media stream c
97 * Note, the buffer needs to be initialized, since it is appended to
100 * @param buff the buffer to append the SDP fragment to
101 * @param size the size of the buff buffer
102 * @param st the AVStream of the media to describe
103 * @param idx the global stream index
104 * @param dest_addr the destination address of the media stream, may be NULL
105 * @param dest_type the destination address type, may be NULL
106 * @param port the destination port of the media stream, 0 if unknown
107 * @param ttl the time to live of the stream, 0 if not multicast
108 * @param fmt the AVFormatContext, which might contain options modifying
111 void ff_sdp_write_media(char *buff, int size, AVStream *st, int idx,
112 const char *dest_addr, const char *dest_type,
113 int port, int ttl, AVFormatContext *fmt);
116 * Write a packet to another muxer than the one the user originally
117 * intended. Useful when chaining muxers, where one muxer internally
118 * writes a received packet to another muxer.
120 * @param dst the muxer to write the packet to
121 * @param dst_stream the stream index within dst to write the packet to
122 * @param pkt the packet to be written
123 * @param src the muxer the packet originally was intended for
124 * @return the value av_write_frame returned
126 int ff_write_chained(AVFormatContext *dst, int dst_stream, AVPacket *pkt,
127 AVFormatContext *src);
130 * Get the length in bytes which is needed to store val as v.
132 int ff_get_v_length(uint64_t val);
135 * Put val using a variable number of bytes.
137 void ff_put_v(AVIOContext *bc, uint64_t val);
140 * Read a whole line of text from AVIOContext. Stop reading after reaching
141 * either a \\n, a \\0 or EOF. The returned string is always \\0-terminated,
142 * and may be truncated if the buffer is too small.
144 * @param s the read-only AVIOContext
145 * @param buf buffer to store the read line
146 * @param maxlen size of the buffer
147 * @return the length of the string written in the buffer, not including the
150 int ff_get_line(AVIOContext *s, char *buf, int maxlen);
152 #define SPACE_CHARS " \t\r\n"
155 * Callback function type for ff_parse_key_value.
157 * @param key a pointer to the key
158 * @param key_len the number of bytes that belong to the key, including the '='
160 * @param dest return the destination pointer for the value in *dest, may
161 * be null to ignore the value
162 * @param dest_len the length of the *dest buffer
164 typedef void (*ff_parse_key_val_cb)(void *context, const char *key,
165 int key_len, char **dest, int *dest_len);
167 * Parse a string with comma-separated key=value pairs. The value strings
168 * may be quoted and may contain escaped characters within quoted strings.
170 * @param str the string to parse
171 * @param callback_get_buf function that returns where to store the
172 * unescaped value string.
173 * @param context the opaque context pointer to pass to callback_get_buf
175 void ff_parse_key_value(const char *str, ff_parse_key_val_cb callback_get_buf,
179 * Find stream index based on format-specific stream ID
180 * @return stream index, or < 0 on error
182 int ff_find_stream_index(AVFormatContext *s, int id);
185 * Internal version of av_index_search_timestamp
187 int ff_index_search_timestamp(const AVIndexEntry *entries, int nb_entries,
188 int64_t wanted_timestamp, int flags);
191 * Internal version of av_add_index_entry
193 int ff_add_index_entry(AVIndexEntry **index_entries,
194 int *nb_index_entries,
195 unsigned int *index_entries_allocated_size,
196 int64_t pos, int64_t timestamp, int size, int distance, int flags);
201 * @param s media file handle
202 * @param id unique ID for this chapter
203 * @param start chapter start time in time_base units
204 * @param end chapter end time in time_base units
205 * @param title chapter title
207 * @return AVChapter or NULL on error
209 AVChapter *avpriv_new_chapter(AVFormatContext *s, int id, AVRational time_base,
210 int64_t start, int64_t end, const char *title);
213 * Ensure the index uses less memory than the maximum specified in
214 * AVFormatContext.max_index_size by discarding entries if it grows
217 void ff_reduce_index(AVFormatContext *s, int stream_index);
219 enum AVCodecID ff_guess_image2_codec(const char *filename);
222 * Convert a date string in ISO8601 format to Unix timestamp.
224 int64_t ff_iso8601_to_unix_time(const char *datestr);
227 * Perform a binary search using av_index_search_timestamp() and
228 * AVInputFormat.read_timestamp().
230 * @param target_ts target timestamp in the time base of the given stream
231 * @param stream_index stream number
233 int ff_seek_frame_binary(AVFormatContext *s, int stream_index,
234 int64_t target_ts, int flags);
237 * Update cur_dts of all streams based on the given timestamp and AVStream.
239 * Stream ref_st unchanged, others set cur_dts in their native time base.
240 * Only needed for timestamp wrapping or if (dts not set and pts!=dts).
241 * @param timestamp new dts expressed in time_base of param ref_st
242 * @param ref_st reference stream giving time_base of param timestamp
244 void ff_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
247 * Perform a binary search using read_timestamp().
249 * @param target_ts target timestamp in the time base of the given stream
250 * @param stream_index stream number
252 int64_t ff_gen_search(AVFormatContext *s, int stream_index,
253 int64_t target_ts, int64_t pos_min,
254 int64_t pos_max, int64_t pos_limit,
255 int64_t ts_min, int64_t ts_max,
256 int flags, int64_t *ts_ret,
257 int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
260 * Set the time base and wrapping info for a given stream. This will be used
261 * to interpret the stream's timestamps. If the new time base is invalid
262 * (numerator or denominator are non-positive), it leaves the stream
266 * @param pts_wrap_bits number of bits effectively used by the pts
267 * (used for wrap control)
268 * @param pts_num time base numerator
269 * @param pts_den time base denominator
271 void avpriv_set_pts_info(AVStream *s, int pts_wrap_bits,
272 unsigned int pts_num, unsigned int pts_den);
275 * Add side data to a packet for changing parameters to the given values.
276 * Parameters set to 0 aren't included in the change.
278 int ff_add_param_change(AVPacket *pkt, int32_t channels,
279 uint64_t channel_layout, int32_t sample_rate,
280 int32_t width, int32_t height);
283 * Set the timebase for each stream from the corresponding codec timebase and
286 int ff_framehash_write_header(AVFormatContext *s);
289 * Read a transport packet from a media file.
291 * @param s media file handle
292 * @param pkt is filled
293 * @return 0 if OK, AVERROR_xxx on error
295 int ff_read_packet(AVFormatContext *s, AVPacket *pkt);
298 * Interleave a packet per dts in an output media file.
300 * Packets with pkt->destruct == av_destruct_packet will be freed inside this
301 * function, so they cannot be used after it. Note that calling av_free_packet()
302 * on them is still safe.
304 * @param s media file handle
305 * @param out the interleaved packet will be output here
306 * @param pkt the input packet
307 * @param flush 1 if no further packets are available as input and all
308 * remaining packets should be output
309 * @return 1 if a packet was output, 0 if no packet could be output,
310 * < 0 if an error occurred
312 int ff_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
313 AVPacket *pkt, int flush);
316 * Return the frame duration in seconds. Return 0 if not available.
318 void ff_compute_frame_duration(int *pnum, int *pden, AVStream *st,
319 AVCodecParserContext *pc, AVPacket *pkt);
321 int ff_get_audio_frame_size(AVCodecContext *enc, int size, int mux);
323 unsigned int ff_codec_get_tag(const AVCodecTag *tags, enum AVCodecID id);
325 enum AVCodecID ff_codec_get_id(const AVCodecTag *tags, unsigned int tag);
328 * Select a PCM codec based on the given parameters.
330 * @param bps bits-per-sample
331 * @param flt floating-point
332 * @param be big-endian
333 * @param sflags signed flags. each bit corresponds to one byte of bit depth.
334 * e.g. the 1st bit indicates if 8-bit should be signed or
335 * unsigned, the 2nd bit indicates if 16-bit should be signed or
336 * unsigned, etc... This is useful for formats such as WAVE where
337 * only 8-bit is unsigned and all other bit depths are signed.
338 * @return a PCM codec id or AV_CODEC_ID_NONE
340 enum AVCodecID ff_get_pcm_codec_id(int bps, int flt, int be, int sflags);
342 #endif /* AVFORMAT_INTERNAL_H */