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
26 #include "os_support.h"
28 #define MAX_URL_SIZE 4096
31 # define hex_dump_debug(class, buf, size) av_hex_dump_log(class, AV_LOG_DEBUG, buf, size)
33 # define hex_dump_debug(class, buf, size)
36 typedef struct AVCodecTag {
41 typedef struct CodecMime{
46 struct AVFormatInternal {
48 * Number of streams relevant for interleaving.
51 int nb_interleaved_streams;
54 void ff_dynarray_add(intptr_t **tab_ptr, int *nb_ptr, intptr_t elem);
57 #define dynarray_add(tab, nb_ptr, elem)\
59 __typeof__(tab) _tab = (tab);\
60 __typeof__(elem) _elem = (elem);\
61 (void)sizeof(**_tab == _elem); /* check that types are compatible */\
62 ff_dynarray_add((intptr_t **)_tab, nb_ptr, (intptr_t)_elem);\
65 #define dynarray_add(tab, nb_ptr, elem)\
67 ff_dynarray_add((intptr_t **)(tab), nb_ptr, (intptr_t)(elem));\
71 struct tm *ff_brktimegm(time_t secs, struct tm *tm);
73 char *ff_data_to_hex(char *buf, const uint8_t *src, int size, int lowercase);
76 * Parse a string of hexadecimal strings. Any space between the hexadecimal
79 * @param data if non-null, the parsed data is written to this pointer
80 * @param p the string to parse
81 * @return the number of bytes written (or to be written, if data is null)
83 int ff_hex_to_data(uint8_t *data, const char *p);
85 void ff_program_add_stream_index(AVFormatContext *ac, int progid, unsigned int idx);
88 * Add packet to AVFormatContext->packet_buffer list, determining its
89 * interleaved position using compare() function argument.
91 int ff_interleave_add_packet(AVFormatContext *s, AVPacket *pkt,
92 int (*compare)(AVFormatContext *, AVPacket *, AVPacket *));
94 void ff_read_frame_flush(AVFormatContext *s);
96 #define NTP_OFFSET 2208988800ULL
97 #define NTP_OFFSET_US (NTP_OFFSET * 1000000ULL)
99 /** Get the current time since NTP epoch in microseconds. */
100 uint64_t ff_ntp_time(void);
103 * Append the media-specific SDP fragment for the media stream c
104 * to the buffer buff.
106 * Note, the buffer needs to be initialized, since it is appended to
109 * @param buff the buffer to append the SDP fragment to
110 * @param size the size of the buff buffer
111 * @param st the AVStream of the media to describe
112 * @param idx the global stream index
113 * @param dest_addr the destination address of the media stream, may be NULL
114 * @param dest_type the destination address type, may be NULL
115 * @param port the destination port of the media stream, 0 if unknown
116 * @param ttl the time to live of the stream, 0 if not multicast
117 * @param fmt the AVFormatContext, which might contain options modifying
120 void ff_sdp_write_media(char *buff, int size, AVStream *st, int idx,
121 const char *dest_addr, const char *dest_type,
122 int port, int ttl, AVFormatContext *fmt);
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.
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
135 int ff_write_chained(AVFormatContext *dst, int dst_stream, AVPacket *pkt,
136 AVFormatContext *src);
139 * Get the length in bytes which is needed to store val as v.
141 int ff_get_v_length(uint64_t val);
144 * Put val using a variable number of bytes.
146 void ff_put_v(AVIOContext *bc, uint64_t val);
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.
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
159 int ff_get_line(AVIOContext *s, char *buf, int maxlen);
161 #define SPACE_CHARS " \t\r\n"
164 * Callback function type for ff_parse_key_value.
166 * @param key a pointer to the key
167 * @param key_len the number of bytes that belong to the key, including the '='
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
173 typedef void (*ff_parse_key_val_cb)(void *context, const char *key,
174 int key_len, char **dest, int *dest_len);
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.
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
184 void ff_parse_key_value(const char *str, ff_parse_key_val_cb callback_get_buf,
188 * Find stream index based on format-specific stream ID
189 * @return stream index, or < 0 on error
191 int ff_find_stream_index(AVFormatContext *s, int id);
194 * Internal version of av_index_search_timestamp
196 int ff_index_search_timestamp(const AVIndexEntry *entries, int nb_entries,
197 int64_t wanted_timestamp, int flags);
200 * Internal version of av_add_index_entry
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);
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
216 * @return AVChapter or NULL on error
218 AVChapter *avpriv_new_chapter(AVFormatContext *s, int id, AVRational time_base,
219 int64_t start, int64_t end, const char *title);
222 * Ensure the index uses less memory than the maximum specified in
223 * AVFormatContext.max_index_size by discarding entries if it grows
226 void ff_reduce_index(AVFormatContext *s, int stream_index);
228 enum AVCodecID ff_guess_image2_codec(const char *filename);
231 * Convert a date string in ISO8601 format to Unix timestamp.
233 int64_t ff_iso8601_to_unix_time(const char *datestr);
236 * Perform a binary search using av_index_search_timestamp() and
237 * AVInputFormat.read_timestamp().
239 * @param target_ts target timestamp in the time base of the given stream
240 * @param stream_index stream number
242 int ff_seek_frame_binary(AVFormatContext *s, int stream_index,
243 int64_t target_ts, int flags);
246 * Update cur_dts of all streams based on the given timestamp and AVStream.
248 * Stream ref_st unchanged, others set cur_dts in their native time base.
249 * Only needed for timestamp wrapping or if (dts not set and pts!=dts).
250 * @param timestamp new dts expressed in time_base of param ref_st
251 * @param ref_st reference stream giving time_base of param timestamp
253 void ff_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
256 * Perform a binary search using read_timestamp().
258 * @param target_ts target timestamp in the time base of the given stream
259 * @param stream_index stream number
261 int64_t ff_gen_search(AVFormatContext *s, int stream_index,
262 int64_t target_ts, int64_t pos_min,
263 int64_t pos_max, int64_t pos_limit,
264 int64_t ts_min, int64_t ts_max,
265 int flags, int64_t *ts_ret,
266 int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
269 * Set the time base and wrapping info for a given stream. This will be used
270 * to interpret the stream's timestamps. If the new time base is invalid
271 * (numerator or denominator are non-positive), it leaves the stream
275 * @param pts_wrap_bits number of bits effectively used by the pts
276 * (used for wrap control)
277 * @param pts_num time base numerator
278 * @param pts_den time base denominator
280 void avpriv_set_pts_info(AVStream *s, int pts_wrap_bits,
281 unsigned int pts_num, unsigned int pts_den);
284 * Add side data to a packet for changing parameters to the given values.
285 * Parameters set to 0 aren't included in the change.
287 int ff_add_param_change(AVPacket *pkt, int32_t channels,
288 uint64_t channel_layout, int32_t sample_rate,
289 int32_t width, int32_t height);
292 * Set the timebase for each stream from the corresponding codec timebase and
295 int ff_framehash_write_header(AVFormatContext *s);
298 * Read a transport packet from a media file.
300 * @param s media file handle
301 * @param pkt is filled
302 * @return 0 if OK, AVERROR_xxx on error
304 int ff_read_packet(AVFormatContext *s, AVPacket *pkt);
307 * Interleave a packet per dts in an output media file.
309 * Packets with pkt->destruct == av_destruct_packet will be freed inside this
310 * function, so they cannot be used after it. Note that calling av_free_packet()
311 * on them is still safe.
313 * @param s media file handle
314 * @param out the interleaved packet will be output here
315 * @param pkt the input packet
316 * @param flush 1 if no further packets are available as input and all
317 * remaining packets should be output
318 * @return 1 if a packet was output, 0 if no packet could be output,
319 * < 0 if an error occurred
321 int ff_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
322 AVPacket *pkt, int flush);
325 * Return the frame duration in seconds. Return 0 if not available.
327 void ff_compute_frame_duration(AVFormatContext *s, int *pnum, int *pden, AVStream *st,
328 AVCodecParserContext *pc, AVPacket *pkt);
330 unsigned int ff_codec_get_tag(const AVCodecTag *tags, enum AVCodecID id);
332 enum AVCodecID ff_codec_get_id(const AVCodecTag *tags, unsigned int tag);
335 * Select a PCM codec based on the given parameters.
337 * @param bps bits-per-sample
338 * @param flt floating-point
339 * @param be big-endian
340 * @param sflags signed flags. each bit corresponds to one byte of bit depth.
341 * e.g. the 1st bit indicates if 8-bit should be signed or
342 * unsigned, the 2nd bit indicates if 16-bit should be signed or
343 * unsigned, etc... This is useful for formats such as WAVE where
344 * only 8-bit is unsigned and all other bit depths are signed.
345 * @return a PCM codec id or AV_CODEC_ID_NONE
347 enum AVCodecID ff_get_pcm_codec_id(int bps, int flt, int be, int sflags);
350 * Generate standard extradata for AVC-Intra based on width/height and field
353 int ff_generate_avci_extradata(AVStream *st);
356 * Wrap errno on rename() error.
358 * @param oldpath source path
359 * @param newpath destination path
360 * @return 0 or AVERROR on failure
362 static inline int ff_rename(const char *oldpath, const char *newpath)
364 if (rename(oldpath, newpath) == -1)
365 return AVERROR(errno);
369 #endif /* AVFORMAT_INTERNAL_H */