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)
34 #define MAX_PROBE_PACKETS 2500
37 # define hex_dump_debug(class, buf, size) av_hex_dump_log(class, AV_LOG_DEBUG, buf, size)
39 # define hex_dump_debug(class, buf, size) do { if (0) av_hex_dump_log(class, AV_LOG_DEBUG, buf, size); } while(0)
42 typedef struct AVCodecTag {
47 typedef struct CodecMime{
52 struct AVFormatInternal {
54 * Number of streams relevant for interleaving.
57 int nb_interleaved_streams;
60 * This buffer is only needed when packets were already buffered but
61 * not decoded, for example to get the codec parameters in MPEG
64 struct AVPacketList *packet_buffer;
65 struct AVPacketList *packet_buffer_end;
67 /* av_seek_frame() support */
68 int64_t data_offset; /**< offset of the first packet */
71 * Raw packets from the demuxer, prior to parsing and decoding.
72 * This buffer is used for buffering packets until the codec can
73 * be identified, as parsing cannot be done without knowing the
76 struct AVPacketList *raw_packet_buffer;
77 struct AVPacketList *raw_packet_buffer_end;
79 * Packets split by the parser get queued here.
81 struct AVPacketList *parse_queue;
82 struct AVPacketList *parse_queue_end;
84 * Remaining size available for raw_packet_buffer, in bytes.
86 #define RAW_PACKET_BUFFER_SIZE 2500000
87 int raw_packet_buffer_remaining_size;
90 * Offset to remap timestamps to be non-negative.
91 * Expressed in timebase units.
92 * @see AVStream.mux_ts_offset
97 * Timebase for the timestamp offset.
99 AVRational offset_timebase;
101 int inject_global_side_data;
103 int avoid_negative_ts_use_pts;
107 #define dynarray_add(tab, nb_ptr, elem)\
109 __typeof__(tab) _tab = (tab);\
110 __typeof__(elem) _elem = (elem);\
111 (void)sizeof(**_tab == _elem); /* check that types are compatible */\
112 av_dynarray_add(_tab, nb_ptr, _elem);\
115 #define dynarray_add(tab, nb_ptr, elem)\
117 av_dynarray_add((tab), nb_ptr, (elem));\
121 struct tm *ff_brktimegm(time_t secs, struct tm *tm);
123 char *ff_data_to_hex(char *buf, const uint8_t *src, int size, int lowercase);
126 * Parse a string of hexadecimal strings. Any space between the hexadecimal
129 * @param data if non-null, the parsed data is written to this pointer
130 * @param p the string to parse
131 * @return the number of bytes written (or to be written, if data is null)
133 int ff_hex_to_data(uint8_t *data, const char *p);
135 void ff_program_add_stream_index(AVFormatContext *ac, int progid, unsigned int idx);
138 * Add packet to AVFormatContext->packet_buffer list, determining its
139 * interleaved position using compare() function argument.
140 * @return 0, or < 0 on error
142 int ff_interleave_add_packet(AVFormatContext *s, AVPacket *pkt,
143 int (*compare)(AVFormatContext *, AVPacket *, AVPacket *));
145 void ff_read_frame_flush(AVFormatContext *s);
147 #define NTP_OFFSET 2208988800ULL
148 #define NTP_OFFSET_US (NTP_OFFSET * 1000000ULL)
150 /** Get the current time since NTP epoch in microseconds. */
151 uint64_t ff_ntp_time(void);
154 * Append the media-specific SDP fragment for the media stream c
155 * to the buffer buff.
157 * Note, the buffer needs to be initialized, since it is appended to
160 * @param buff the buffer to append the SDP fragment to
161 * @param size the size of the buff buffer
162 * @param st the AVStream of the media to describe
163 * @param idx the global stream index
164 * @param dest_addr the destination address of the media stream, may be NULL
165 * @param dest_type the destination address type, may be NULL
166 * @param port the destination port of the media stream, 0 if unknown
167 * @param ttl the time to live of the stream, 0 if not multicast
168 * @param fmt the AVFormatContext, which might contain options modifying
171 void ff_sdp_write_media(char *buff, int size, AVStream *st, int idx,
172 const char *dest_addr, const char *dest_type,
173 int port, int ttl, AVFormatContext *fmt);
176 * Write a packet to another muxer than the one the user originally
177 * intended. Useful when chaining muxers, where one muxer internally
178 * writes a received packet to another muxer.
180 * @param dst the muxer to write the packet to
181 * @param dst_stream the stream index within dst to write the packet to
182 * @param pkt the packet to be written
183 * @param src the muxer the packet originally was intended for
184 * @param interleave 0->use av_write_frame, 1->av_interleaved_write_frame
185 * @return the value av_write_frame returned
187 int ff_write_chained(AVFormatContext *dst, int dst_stream, AVPacket *pkt,
188 AVFormatContext *src, int interleave);
191 * Get the length in bytes which is needed to store val as v.
193 int ff_get_v_length(uint64_t val);
196 * Put val using a variable number of bytes.
198 void ff_put_v(AVIOContext *bc, uint64_t val);
201 * Read a whole line of text from AVIOContext. Stop reading after reaching
202 * either a \\n, a \\0 or EOF. The returned string is always \\0-terminated,
203 * and may be truncated if the buffer is too small.
205 * @param s the read-only AVIOContext
206 * @param buf buffer to store the read line
207 * @param maxlen size of the buffer
208 * @return the length of the string written in the buffer, not including the
211 int ff_get_line(AVIOContext *s, char *buf, int maxlen);
213 #define SPACE_CHARS " \t\r\n"
216 * Callback function type for ff_parse_key_value.
218 * @param key a pointer to the key
219 * @param key_len the number of bytes that belong to the key, including the '='
221 * @param dest return the destination pointer for the value in *dest, may
222 * be null to ignore the value
223 * @param dest_len the length of the *dest buffer
225 typedef void (*ff_parse_key_val_cb)(void *context, const char *key,
226 int key_len, char **dest, int *dest_len);
228 * Parse a string with comma-separated key=value pairs. The value strings
229 * may be quoted and may contain escaped characters within quoted strings.
231 * @param str the string to parse
232 * @param callback_get_buf function that returns where to store the
233 * unescaped value string.
234 * @param context the opaque context pointer to pass to callback_get_buf
236 void ff_parse_key_value(const char *str, ff_parse_key_val_cb callback_get_buf,
240 * Find stream index based on format-specific stream ID
241 * @return stream index, or < 0 on error
243 int ff_find_stream_index(AVFormatContext *s, int id);
246 * Internal version of av_index_search_timestamp
248 int ff_index_search_timestamp(const AVIndexEntry *entries, int nb_entries,
249 int64_t wanted_timestamp, int flags);
252 * Internal version of av_add_index_entry
254 int ff_add_index_entry(AVIndexEntry **index_entries,
255 int *nb_index_entries,
256 unsigned int *index_entries_allocated_size,
257 int64_t pos, int64_t timestamp, int size, int distance, int flags);
259 void ff_configure_buffers_for_index(AVFormatContext *s, int64_t time_tolerance);
264 * @param s media file handle
265 * @param id unique ID for this chapter
266 * @param start chapter start time in time_base units
267 * @param end chapter end time in time_base units
268 * @param title chapter title
270 * @return AVChapter or NULL on error
272 AVChapter *avpriv_new_chapter(AVFormatContext *s, int id, AVRational time_base,
273 int64_t start, int64_t end, const char *title);
276 * Ensure the index uses less memory than the maximum specified in
277 * AVFormatContext.max_index_size by discarding entries if it grows
280 void ff_reduce_index(AVFormatContext *s, int stream_index);
282 enum AVCodecID ff_guess_image2_codec(const char *filename);
285 * Convert a date string in ISO8601 format to Unix timestamp.
287 int64_t ff_iso8601_to_unix_time(const char *datestr);
290 * Perform a binary search using av_index_search_timestamp() and
291 * AVInputFormat.read_timestamp().
293 * @param target_ts target timestamp in the time base of the given stream
294 * @param stream_index stream number
296 int ff_seek_frame_binary(AVFormatContext *s, int stream_index,
297 int64_t target_ts, int flags);
300 * Update cur_dts of all streams based on the given timestamp and AVStream.
302 * Stream ref_st unchanged, others set cur_dts in their native time base.
303 * Only needed for timestamp wrapping or if (dts not set and pts!=dts).
304 * @param timestamp new dts expressed in time_base of param ref_st
305 * @param ref_st reference stream giving time_base of param timestamp
307 void ff_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
309 int ff_find_last_ts(AVFormatContext *s, int stream_index, int64_t *ts, int64_t *pos,
310 int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
313 * Perform a binary search using read_timestamp().
315 * @param target_ts target timestamp in the time base of the given stream
316 * @param stream_index stream number
318 int64_t ff_gen_search(AVFormatContext *s, int stream_index,
319 int64_t target_ts, int64_t pos_min,
320 int64_t pos_max, int64_t pos_limit,
321 int64_t ts_min, int64_t ts_max,
322 int flags, int64_t *ts_ret,
323 int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
326 * Set the time base and wrapping info for a given stream. This will be used
327 * to interpret the stream's timestamps. If the new time base is invalid
328 * (numerator or denominator are non-positive), it leaves the stream
332 * @param pts_wrap_bits number of bits effectively used by the pts
333 * (used for wrap control)
334 * @param pts_num time base numerator
335 * @param pts_den time base denominator
337 void avpriv_set_pts_info(AVStream *s, int pts_wrap_bits,
338 unsigned int pts_num, unsigned int pts_den);
341 * Add side data to a packet for changing parameters to the given values.
342 * Parameters set to 0 aren't included in the change.
344 int ff_add_param_change(AVPacket *pkt, int32_t channels,
345 uint64_t channel_layout, int32_t sample_rate,
346 int32_t width, int32_t height);
349 * Set the timebase for each stream from the corresponding codec timebase and
352 int ff_framehash_write_header(AVFormatContext *s);
355 * Read a transport packet from a media file.
357 * @param s media file handle
358 * @param pkt is filled
359 * @return 0 if OK, AVERROR_xxx on error
361 int ff_read_packet(AVFormatContext *s, AVPacket *pkt);
364 * Interleave a packet per dts in an output media file.
366 * Packets with pkt->destruct == av_destruct_packet will be freed inside this
367 * function, so they cannot be used after it. Note that calling av_free_packet()
368 * on them is still safe.
370 * @param s media file handle
371 * @param out the interleaved packet will be output here
372 * @param pkt the input packet
373 * @param flush 1 if no further packets are available as input and all
374 * remaining packets should be output
375 * @return 1 if a packet was output, 0 if no packet could be output,
376 * < 0 if an error occurred
378 int ff_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
379 AVPacket *pkt, int flush);
381 void ff_free_stream(AVFormatContext *s, AVStream *st);
384 * Return the frame duration in seconds. Return 0 if not available.
386 void ff_compute_frame_duration(AVFormatContext *s, int *pnum, int *pden, AVStream *st,
387 AVCodecParserContext *pc, AVPacket *pkt);
389 unsigned int ff_codec_get_tag(const AVCodecTag *tags, enum AVCodecID id);
391 enum AVCodecID ff_codec_get_id(const AVCodecTag *tags, unsigned int tag);
394 * Select a PCM codec based on the given parameters.
396 * @param bps bits-per-sample
397 * @param flt floating-point
398 * @param be big-endian
399 * @param sflags signed flags. each bit corresponds to one byte of bit depth.
400 * e.g. the 1st bit indicates if 8-bit should be signed or
401 * unsigned, the 2nd bit indicates if 16-bit should be signed or
402 * unsigned, etc... This is useful for formats such as WAVE where
403 * only 8-bit is unsigned and all other bit depths are signed.
404 * @return a PCM codec id or AV_CODEC_ID_NONE
406 enum AVCodecID ff_get_pcm_codec_id(int bps, int flt, int be, int sflags);
409 * Chooses a timebase for muxing the specified stream.
411 * The chosen timebase allows sample accurate timestamps based
412 * on the framerate or sample rate for audio streams. It also is
413 * at least as precise as 1/min_precision would be.
415 AVRational ff_choose_timebase(AVFormatContext *s, AVStream *st, int min_precision);
418 * Chooses a timebase for muxing the specified stream.
420 enum AVChromaLocation ff_choose_chroma_location(AVFormatContext *s, AVStream *st);
423 * Generate standard extradata for AVC-Intra based on width/height and field
426 int ff_generate_avci_extradata(AVStream *st);
429 * Wrap errno on rename() error.
431 * @param oldpath source path
432 * @param newpath destination path
433 * @return 0 or AVERROR on failure
435 static inline int ff_rename(const char *oldpath, const char *newpath, void *logctx)
438 if (rename(oldpath, newpath) == -1) {
439 ret = AVERROR(errno);
441 av_log(logctx, AV_LOG_ERROR, "failed to rename file %s to %s\n", oldpath, newpath);
447 * Add new side data to a stream. If a side data of this type already exists, it
450 uint8_t *ff_stream_new_side_data(AVStream *st, enum AVPacketSideDataType type,
454 * Allocate extradata with additional AV_INPUT_BUFFER_PADDING_SIZE at end
455 * which is always set to 0.
457 * @param size size of extradata
458 * @return 0 if OK, AVERROR_xxx on error
460 int ff_alloc_extradata(AVCodecContext *avctx, int size);
463 * Allocate extradata with additional AV_INPUT_BUFFER_PADDING_SIZE at end
464 * which is always set to 0 and fill it from pb.
466 * @param size size of extradata
467 * @return >= 0 if OK, AVERROR_xxx on error
469 int ff_get_extradata(AVCodecContext *avctx, AVIOContext *pb, int size);
472 * add frame for rfps calculation.
474 * @param dts timestamp of the i-th frame
475 * @return 0 if OK, AVERROR_xxx on error
477 int ff_rfps_add_frame(AVFormatContext *ic, AVStream *st, int64_t dts);
479 void ff_rfps_calculate(AVFormatContext *ic);
482 * Flags for AVFormatContext.write_uncoded_frame()
484 enum AVWriteUncodedFrameFlags {
487 * Query whether the feature is possible on this stream.
488 * The frame argument is ignored.
490 AV_WRITE_UNCODED_FRAME_QUERY = 0x0001,
495 * Copies the whilelists from one context to the other
497 int ff_copy_whitelists(AVFormatContext *dst, AVFormatContext *src);
499 int ffio_open2_wrapper(struct AVFormatContext *s, AVIOContext **pb, const char *url, int flags,
500 const AVIOInterruptCB *int_cb, AVDictionary **options);
502 #endif /* AVFORMAT_INTERNAL_H */