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
26 #include "os_support.h"
28 #define MAX_URL_SIZE 4096
30 /** size of probe buffer, for guessing file type from file contents */
31 #define PROBE_BUF_MIN 2048
32 #define PROBE_BUF_MAX (1 << 20)
35 # define hex_dump_debug(class, buf, size) av_hex_dump_log(class, AV_LOG_DEBUG, buf, size)
37 # define hex_dump_debug(class, buf, size)
40 typedef struct AVCodecTag {
45 typedef struct CodecMime{
50 struct AVFormatInternal {
52 * Number of streams relevant for interleaving.
55 int nb_interleaved_streams;
58 * This buffer is only needed when packets were already buffered but
59 * not decoded, for example to get the codec parameters in MPEG
62 struct AVPacketList *packet_buffer;
63 struct AVPacketList *packet_buffer_end;
65 /* av_seek_frame() support */
66 int64_t data_offset; /**< offset of the first packet */
69 * Raw packets from the demuxer, prior to parsing and decoding.
70 * This buffer is used for buffering packets until the codec can
71 * be identified, as parsing cannot be done without knowing the
74 struct AVPacketList *raw_packet_buffer;
75 struct AVPacketList *raw_packet_buffer_end;
77 * Packets split by the parser get queued here.
79 struct AVPacketList *parse_queue;
80 struct AVPacketList *parse_queue_end;
82 * Remaining size available for raw_packet_buffer, in bytes.
84 #define RAW_PACKET_BUFFER_SIZE 2500000
85 int raw_packet_buffer_remaining_size;
88 * Offset to remap timestamps to be non-negative.
89 * Expressed in timebase units.
90 * @see AVStream.mux_ts_offset
95 * Timebase for the timestamp offset.
97 AVRational offset_timebase;
99 int inject_global_side_data;
103 #define dynarray_add(tab, nb_ptr, elem)\
105 __typeof__(tab) _tab = (tab);\
106 __typeof__(elem) _elem = (elem);\
107 (void)sizeof(**_tab == _elem); /* check that types are compatible */\
108 av_dynarray_add(_tab, nb_ptr, _elem);\
111 #define dynarray_add(tab, nb_ptr, elem)\
113 av_dynarray_add((tab), nb_ptr, (elem));\
117 struct tm *ff_brktimegm(time_t secs, struct tm *tm);
119 char *ff_data_to_hex(char *buf, const uint8_t *src, int size, int lowercase);
122 * Parse a string of hexadecimal strings. Any space between the hexadecimal
125 * @param data if non-null, the parsed data is written to this pointer
126 * @param p the string to parse
127 * @return the number of bytes written (or to be written, if data is null)
129 int ff_hex_to_data(uint8_t *data, const char *p);
131 void ff_program_add_stream_index(AVFormatContext *ac, int progid, unsigned int idx);
134 * Add packet to AVFormatContext->packet_buffer list, determining its
135 * interleaved position using compare() function argument.
136 * @return 0, or < 0 on error
138 int ff_interleave_add_packet(AVFormatContext *s, AVPacket *pkt,
139 int (*compare)(AVFormatContext *, AVPacket *, AVPacket *));
141 void ff_read_frame_flush(AVFormatContext *s);
143 #define NTP_OFFSET 2208988800ULL
144 #define NTP_OFFSET_US (NTP_OFFSET * 1000000ULL)
146 /** Get the current time since NTP epoch in microseconds. */
147 uint64_t ff_ntp_time(void);
150 * Append the media-specific SDP fragment for the media stream c
151 * to the buffer buff.
153 * Note, the buffer needs to be initialized, since it is appended to
156 * @param buff the buffer to append the SDP fragment to
157 * @param size the size of the buff buffer
158 * @param st the AVStream of the media to describe
159 * @param idx the global stream index
160 * @param dest_addr the destination address of the media stream, may be NULL
161 * @param dest_type the destination address type, may be NULL
162 * @param port the destination port of the media stream, 0 if unknown
163 * @param ttl the time to live of the stream, 0 if not multicast
164 * @param fmt the AVFormatContext, which might contain options modifying
167 void ff_sdp_write_media(char *buff, int size, AVStream *st, int idx,
168 const char *dest_addr, const char *dest_type,
169 int port, int ttl, AVFormatContext *fmt);
172 * Write a packet to another muxer than the one the user originally
173 * intended. Useful when chaining muxers, where one muxer internally
174 * writes a received packet to another muxer.
176 * @param dst the muxer to write the packet to
177 * @param dst_stream the stream index within dst to write the packet to
178 * @param pkt the packet to be written
179 * @param src the muxer the packet originally was intended for
180 * @param interleave 0->use av_write_frame, 1->av_interleaved_write_frame
181 * @return the value av_write_frame returned
183 int ff_write_chained(AVFormatContext *dst, int dst_stream, AVPacket *pkt,
184 AVFormatContext *src, int interleave);
187 * Get the length in bytes which is needed to store val as v.
189 int ff_get_v_length(uint64_t val);
192 * Put val using a variable number of bytes.
194 void ff_put_v(AVIOContext *bc, uint64_t val);
197 * Read a whole line of text from AVIOContext. Stop reading after reaching
198 * either a \\n, a \\0 or EOF. The returned string is always \\0-terminated,
199 * and may be truncated if the buffer is too small.
201 * @param s the read-only AVIOContext
202 * @param buf buffer to store the read line
203 * @param maxlen size of the buffer
204 * @return the length of the string written in the buffer, not including the
207 int ff_get_line(AVIOContext *s, char *buf, int maxlen);
209 #define SPACE_CHARS " \t\r\n"
212 * Callback function type for ff_parse_key_value.
214 * @param key a pointer to the key
215 * @param key_len the number of bytes that belong to the key, including the '='
217 * @param dest return the destination pointer for the value in *dest, may
218 * be null to ignore the value
219 * @param dest_len the length of the *dest buffer
221 typedef void (*ff_parse_key_val_cb)(void *context, const char *key,
222 int key_len, char **dest, int *dest_len);
224 * Parse a string with comma-separated key=value pairs. The value strings
225 * may be quoted and may contain escaped characters within quoted strings.
227 * @param str the string to parse
228 * @param callback_get_buf function that returns where to store the
229 * unescaped value string.
230 * @param context the opaque context pointer to pass to callback_get_buf
232 void ff_parse_key_value(const char *str, ff_parse_key_val_cb callback_get_buf,
236 * Find stream index based on format-specific stream ID
237 * @return stream index, or < 0 on error
239 int ff_find_stream_index(AVFormatContext *s, int id);
242 * Internal version of av_index_search_timestamp
244 int ff_index_search_timestamp(const AVIndexEntry *entries, int nb_entries,
245 int64_t wanted_timestamp, int flags);
248 * Internal version of av_add_index_entry
250 int ff_add_index_entry(AVIndexEntry **index_entries,
251 int *nb_index_entries,
252 unsigned int *index_entries_allocated_size,
253 int64_t pos, int64_t timestamp, int size, int distance, int flags);
258 * @param s media file handle
259 * @param id unique ID for this chapter
260 * @param start chapter start time in time_base units
261 * @param end chapter end time in time_base units
262 * @param title chapter title
264 * @return AVChapter or NULL on error
266 AVChapter *avpriv_new_chapter(AVFormatContext *s, int id, AVRational time_base,
267 int64_t start, int64_t end, const char *title);
270 * Ensure the index uses less memory than the maximum specified in
271 * AVFormatContext.max_index_size by discarding entries if it grows
274 void ff_reduce_index(AVFormatContext *s, int stream_index);
276 enum AVCodecID ff_guess_image2_codec(const char *filename);
279 * Convert a date string in ISO8601 format to Unix timestamp.
281 int64_t ff_iso8601_to_unix_time(const char *datestr);
284 * Perform a binary search using av_index_search_timestamp() and
285 * AVInputFormat.read_timestamp().
287 * @param target_ts target timestamp in the time base of the given stream
288 * @param stream_index stream number
290 int ff_seek_frame_binary(AVFormatContext *s, int stream_index,
291 int64_t target_ts, int flags);
294 * Update cur_dts of all streams based on the given timestamp and AVStream.
296 * Stream ref_st unchanged, others set cur_dts in their native time base.
297 * Only needed for timestamp wrapping or if (dts not set and pts!=dts).
298 * @param timestamp new dts expressed in time_base of param ref_st
299 * @param ref_st reference stream giving time_base of param timestamp
301 void ff_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
303 int ff_find_last_ts(AVFormatContext *s, int stream_index, int64_t *ts, int64_t *pos,
304 int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
307 * Perform a binary search using read_timestamp().
309 * @param target_ts target timestamp in the time base of the given stream
310 * @param stream_index stream number
312 int64_t ff_gen_search(AVFormatContext *s, int stream_index,
313 int64_t target_ts, int64_t pos_min,
314 int64_t pos_max, int64_t pos_limit,
315 int64_t ts_min, int64_t ts_max,
316 int flags, int64_t *ts_ret,
317 int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
320 * Set the time base and wrapping info for a given stream. This will be used
321 * to interpret the stream's timestamps. If the new time base is invalid
322 * (numerator or denominator are non-positive), it leaves the stream
326 * @param pts_wrap_bits number of bits effectively used by the pts
327 * (used for wrap control)
328 * @param pts_num time base numerator
329 * @param pts_den time base denominator
331 void avpriv_set_pts_info(AVStream *s, int pts_wrap_bits,
332 unsigned int pts_num, unsigned int pts_den);
335 * Add side data to a packet for changing parameters to the given values.
336 * Parameters set to 0 aren't included in the change.
338 int ff_add_param_change(AVPacket *pkt, int32_t channels,
339 uint64_t channel_layout, int32_t sample_rate,
340 int32_t width, int32_t height);
343 * Set the timebase for each stream from the corresponding codec timebase and
346 int ff_framehash_write_header(AVFormatContext *s);
349 * Read a transport packet from a media file.
351 * @param s media file handle
352 * @param pkt is filled
353 * @return 0 if OK, AVERROR_xxx on error
355 int ff_read_packet(AVFormatContext *s, AVPacket *pkt);
358 * Interleave a packet per dts in an output media file.
360 * Packets with pkt->destruct == av_destruct_packet will be freed inside this
361 * function, so they cannot be used after it. Note that calling av_free_packet()
362 * on them is still safe.
364 * @param s media file handle
365 * @param out the interleaved packet will be output here
366 * @param pkt the input packet
367 * @param flush 1 if no further packets are available as input and all
368 * remaining packets should be output
369 * @return 1 if a packet was output, 0 if no packet could be output,
370 * < 0 if an error occurred
372 int ff_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
373 AVPacket *pkt, int flush);
375 void ff_free_stream(AVFormatContext *s, AVStream *st);
378 * Return the frame duration in seconds. Return 0 if not available.
380 void ff_compute_frame_duration(AVFormatContext *s, int *pnum, int *pden, AVStream *st,
381 AVCodecParserContext *pc, AVPacket *pkt);
383 unsigned int ff_codec_get_tag(const AVCodecTag *tags, enum AVCodecID id);
385 enum AVCodecID ff_codec_get_id(const AVCodecTag *tags, unsigned int tag);
388 * Select a PCM codec based on the given parameters.
390 * @param bps bits-per-sample
391 * @param flt floating-point
392 * @param be big-endian
393 * @param sflags signed flags. each bit corresponds to one byte of bit depth.
394 * e.g. the 1st bit indicates if 8-bit should be signed or
395 * unsigned, the 2nd bit indicates if 16-bit should be signed or
396 * unsigned, etc... This is useful for formats such as WAVE where
397 * only 8-bit is unsigned and all other bit depths are signed.
398 * @return a PCM codec id or AV_CODEC_ID_NONE
400 enum AVCodecID ff_get_pcm_codec_id(int bps, int flt, int be, int sflags);
403 * Chooses a timebase for muxing the specified stream.
405 * The chosen timebase allows sample accurate timestamps based
406 * on the framerate or sample rate for audio streams. It also is
407 * at least as precise as 1/min_precision would be.
409 AVRational ff_choose_timebase(AVFormatContext *s, AVStream *st, int min_precision);
412 * Generate standard extradata for AVC-Intra based on width/height and field
415 int ff_generate_avci_extradata(AVStream *st);
418 * Wrap errno on rename() error.
420 * @param oldpath source path
421 * @param newpath destination path
422 * @return 0 or AVERROR on failure
424 static inline int ff_rename(const char *oldpath, const char *newpath, void *logctx)
427 if (rename(oldpath, newpath) == -1) {
428 ret = AVERROR(errno);
430 av_log(logctx, AV_LOG_ERROR, "failed to rename file %s to %s\n", oldpath, newpath);
436 * Add new side data to a stream. If a side data of this type already exists, it
439 uint8_t *ff_stream_new_side_data(AVStream *st, enum AVPacketSideDataType type,
443 * Allocate extradata with additional FF_INPUT_BUFFER_PADDING_SIZE at end
444 * which is always set to 0.
446 * @param size size of extradata
447 * @return 0 if OK, AVERROR_xxx on error
449 int ff_alloc_extradata(AVCodecContext *avctx, int size);
452 * Allocate extradata with additional FF_INPUT_BUFFER_PADDING_SIZE at end
453 * which is always set to 0 and fill it from pb.
455 * @param size size of extradata
456 * @return >= 0 if OK, AVERROR_xxx on error
458 int ff_get_extradata(AVCodecContext *avctx, AVIOContext *pb, int size);
461 * add frame for rfps calculation.
463 * @param dts timestamp of the i-th frame
464 * @return 0 if OK, AVERROR_xxx on error
466 int ff_rfps_add_frame(AVFormatContext *ic, AVStream *st, int64_t dts);
468 void ff_rfps_calculate(AVFormatContext *ic);
471 * Flags for AVFormatContext.write_uncoded_frame()
473 enum AVWriteUncodedFrameFlags {
476 * Query whether the feature is possible on this stream.
477 * The frame argument is ignored.
479 AV_WRITE_UNCODED_FRAME_QUERY = 0x0001,
484 * Copies the whilelists from one context to the other
486 int ff_copy_whitelists(AVFormatContext *dst, AVFormatContext *src);
488 #endif /* AVFORMAT_INTERNAL_H */