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 * Append the media-specific SDP fragment for the media stream c
96 * Note, the buffer needs to be initialized, since it is appended to
99 * @param buff the buffer to append the SDP fragment to
100 * @param size the size of the buff buffer
101 * @param st the AVStream of the media to describe
102 * @param idx the global stream index
103 * @param dest_addr the destination address of the media stream, may be NULL
104 * @param dest_type the destination address type, may be NULL
105 * @param port the destination port of the media stream, 0 if unknown
106 * @param ttl the time to live of the stream, 0 if not multicast
107 * @param fmt the AVFormatContext, which might contain options modifying
110 void ff_sdp_write_media(char *buff, int size, AVStream *st, int idx,
111 const char *dest_addr, const char *dest_type,
112 int port, int ttl, AVFormatContext *fmt);
115 * Write a packet to another muxer than the one the user originally
116 * intended. Useful when chaining muxers, where one muxer internally
117 * writes a received packet to another muxer.
119 * @param dst the muxer to write the packet to
120 * @param dst_stream the stream index within dst to write the packet to
121 * @param pkt the packet to be written
122 * @param src the muxer the packet originally was intended for
123 * @return the value av_write_frame returned
125 int ff_write_chained(AVFormatContext *dst, int dst_stream, AVPacket *pkt,
126 AVFormatContext *src);
129 * Get the length in bytes which is needed to store val as v.
131 int ff_get_v_length(uint64_t val);
134 * Put val using a variable number of bytes.
136 void ff_put_v(AVIOContext *bc, uint64_t val);
139 * Read a whole line of text from AVIOContext. Stop reading after reaching
140 * either a \\n, a \\0 or EOF. The returned string is always \\0-terminated,
141 * and may be truncated if the buffer is too small.
143 * @param s the read-only AVIOContext
144 * @param buf buffer to store the read line
145 * @param maxlen size of the buffer
146 * @return the length of the string written in the buffer, not including the
149 int ff_get_line(AVIOContext *s, char *buf, int maxlen);
151 #define SPACE_CHARS " \t\r\n"
154 * Callback function type for ff_parse_key_value.
156 * @param key a pointer to the key
157 * @param key_len the number of bytes that belong to the key, including the '='
159 * @param dest return the destination pointer for the value in *dest, may
160 * be null to ignore the value
161 * @param dest_len the length of the *dest buffer
163 typedef void (*ff_parse_key_val_cb)(void *context, const char *key,
164 int key_len, char **dest, int *dest_len);
166 * Parse a string with comma-separated key=value pairs. The value strings
167 * may be quoted and may contain escaped characters within quoted strings.
169 * @param str the string to parse
170 * @param callback_get_buf function that returns where to store the
171 * unescaped value string.
172 * @param context the opaque context pointer to pass to callback_get_buf
174 void ff_parse_key_value(const char *str, ff_parse_key_val_cb callback_get_buf,
178 * Find stream index based on format-specific stream ID
179 * @return stream index, or < 0 on error
181 int ff_find_stream_index(AVFormatContext *s, int id);
184 * Internal version of av_index_search_timestamp
186 int ff_index_search_timestamp(const AVIndexEntry *entries, int nb_entries,
187 int64_t wanted_timestamp, int flags);
190 * Internal version of av_add_index_entry
192 int ff_add_index_entry(AVIndexEntry **index_entries,
193 int *nb_index_entries,
194 unsigned int *index_entries_allocated_size,
195 int64_t pos, int64_t timestamp, int size, int distance, int flags);
200 * @param s media file handle
201 * @param id unique ID for this chapter
202 * @param start chapter start time in time_base units
203 * @param end chapter end time in time_base units
204 * @param title chapter title
206 * @return AVChapter or NULL on error
208 AVChapter *avpriv_new_chapter(AVFormatContext *s, int id, AVRational time_base,
209 int64_t start, int64_t end, const char *title);
212 * Ensure the index uses less memory than the maximum specified in
213 * AVFormatContext.max_index_size by discarding entries if it grows
216 void ff_reduce_index(AVFormatContext *s, int stream_index);
218 enum AVCodecID ff_guess_image2_codec(const char *filename);
221 * Convert a date string in ISO8601 format to Unix timestamp.
223 int64_t ff_iso8601_to_unix_time(const char *datestr);
226 * Perform a binary search using av_index_search_timestamp() and
227 * AVInputFormat.read_timestamp().
229 * @param target_ts target timestamp in the time base of the given stream
230 * @param stream_index stream number
232 int ff_seek_frame_binary(AVFormatContext *s, int stream_index,
233 int64_t target_ts, int flags);
236 * Update cur_dts of all streams based on the given timestamp and AVStream.
238 * Stream ref_st unchanged, others set cur_dts in their native time base.
239 * Only needed for timestamp wrapping or if (dts not set and pts!=dts).
240 * @param timestamp new dts expressed in time_base of param ref_st
241 * @param ref_st reference stream giving time_base of param timestamp
243 void ff_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
246 * Perform a binary search using read_timestamp().
248 * @param target_ts target timestamp in the time base of the given stream
249 * @param stream_index stream number
251 int64_t ff_gen_search(AVFormatContext *s, int stream_index,
252 int64_t target_ts, int64_t pos_min,
253 int64_t pos_max, int64_t pos_limit,
254 int64_t ts_min, int64_t ts_max,
255 int flags, int64_t *ts_ret,
256 int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
259 * Set the time base and wrapping info for a given stream. This will be used
260 * to interpret the stream's timestamps. If the new time base is invalid
261 * (numerator or denominator are non-positive), it leaves the stream
265 * @param pts_wrap_bits number of bits effectively used by the pts
266 * (used for wrap control)
267 * @param pts_num time base numerator
268 * @param pts_den time base denominator
270 void avpriv_set_pts_info(AVStream *s, int pts_wrap_bits,
271 unsigned int pts_num, unsigned int pts_den);
274 * Add side data to a packet for changing parameters to the given values.
275 * Parameters set to 0 aren't included in the change.
277 int ff_add_param_change(AVPacket *pkt, int32_t channels,
278 uint64_t channel_layout, int32_t sample_rate,
279 int32_t width, int32_t height);
282 * Set the timebase for each stream from the corresponding codec timebase and
285 int ff_framehash_write_header(AVFormatContext *s);
288 * Read a transport packet from a media file.
290 * @param s media file handle
291 * @param pkt is filled
292 * @return 0 if OK, AVERROR_xxx on error
294 int ff_read_packet(AVFormatContext *s, AVPacket *pkt);
297 * Interleave a packet per dts in an output media file.
299 * Packets with pkt->destruct == av_destruct_packet will be freed inside this
300 * function, so they cannot be used after it. Note that calling av_free_packet()
301 * on them is still safe.
303 * @param s media file handle
304 * @param out the interleaved packet will be output here
305 * @param pkt the input packet
306 * @param flush 1 if no further packets are available as input and all
307 * remaining packets should be output
308 * @return 1 if a packet was output, 0 if no packet could be output,
309 * < 0 if an error occurred
311 int ff_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
312 AVPacket *pkt, int flush);
314 void ff_free_stream(AVFormatContext *s, AVStream *st);
317 * Return the frame duration in seconds. Return 0 if not available.
319 void ff_compute_frame_duration(int *pnum, int *pden, AVStream *st,
320 AVCodecParserContext *pc, AVPacket *pkt);
322 int ff_get_audio_frame_size(AVCodecContext *enc, int size, int mux);
324 unsigned int ff_codec_get_tag(const AVCodecTag *tags, enum AVCodecID id);
326 enum AVCodecID ff_codec_get_id(const AVCodecTag *tags, unsigned int tag);
329 * Select a PCM codec based on the given parameters.
331 * @param bps bits-per-sample
332 * @param flt floating-point
333 * @param be big-endian
334 * @param sflags signed flags. each bit corresponds to one byte of bit depth.
335 * e.g. the 1st bit indicates if 8-bit should be signed or
336 * unsigned, the 2nd bit indicates if 16-bit should be signed or
337 * unsigned, etc... This is useful for formats such as WAVE where
338 * only 8-bit is unsigned and all other bit depths are signed.
339 * @return a PCM codec id or AV_CODEC_ID_NONE
341 enum AVCodecID ff_get_pcm_codec_id(int bps, int flt, int be, int sflags);
344 * Chooses a timebase for muxing the specified stream.
346 * The choosen timebase allows sample accurate timestamps based
347 * on the framerate or sample rate for audio streams. It also is
348 * at least as precisse as 1/min_precission would be.
350 AVRational ff_choose_timebase(AVFormatContext *s, AVStream *st, int min_precission);
353 * Generate standard extradata for AVC-Intra based on width/height and field order.
355 void ff_generate_avci_extradata(AVStream *st);
357 #endif /* AVFORMAT_INTERNAL_H */