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 "libavutil/bprint.h"
28 #include "os_support.h"
30 #define MAX_URL_SIZE 4096
32 /** size of probe buffer, for guessing file type from file contents */
33 #define PROBE_BUF_MIN 2048
34 #define PROBE_BUF_MAX (1 << 20)
36 #define MAX_PROBE_PACKETS 2500
39 # define hex_dump_debug(class, buf, size) av_hex_dump_log(class, AV_LOG_DEBUG, buf, size)
41 # define hex_dump_debug(class, buf, size) do { if (0) av_hex_dump_log(class, AV_LOG_DEBUG, buf, size); } while(0)
44 typedef struct AVCodecTag {
49 typedef struct CodecMime{
54 /*************************************************/
55 /* fractional numbers for exact pts handling */
58 * The exact value of the fractional number is: 'val + num / den'.
59 * num is assumed to be 0 <= num < den.
61 typedef struct FFFrac {
62 int64_t val, num, den;
66 struct AVFormatInternal {
68 * Number of streams relevant for interleaving.
71 int nb_interleaved_streams;
74 * This buffer is only needed when packets were already buffered but
75 * not decoded, for example to get the codec parameters in MPEG
78 struct AVPacketList *packet_buffer;
79 struct AVPacketList *packet_buffer_end;
81 /* av_seek_frame() support */
82 int64_t data_offset; /**< offset of the first packet */
85 * Raw packets from the demuxer, prior to parsing and decoding.
86 * This buffer is used for buffering packets until the codec can
87 * be identified, as parsing cannot be done without knowing the
90 struct AVPacketList *raw_packet_buffer;
91 struct AVPacketList *raw_packet_buffer_end;
93 * Packets split by the parser get queued here.
95 struct AVPacketList *parse_queue;
96 struct AVPacketList *parse_queue_end;
98 * Remaining size available for raw_packet_buffer, in bytes.
100 #define RAW_PACKET_BUFFER_SIZE 2500000
101 int raw_packet_buffer_remaining_size;
104 * Offset to remap timestamps to be non-negative.
105 * Expressed in timebase units.
106 * @see AVStream.mux_ts_offset
111 * Timebase for the timestamp offset.
113 AVRational offset_timebase;
115 #if FF_API_COMPUTE_PKT_FIELDS2
116 int missing_ts_warning;
119 int inject_global_side_data;
121 int avoid_negative_ts_use_pts;
124 * Whether or not a header has already been written
127 int write_header_ret;
130 * Timestamp of the end of the shortest stream.
132 int64_t shortest_end;
135 struct AVStreamInternal {
137 * Set to 1 if the codec allows reordering, so pts can be different
143 * bitstream filters to run on stream
144 * - encoding: Set by muxer using ff_stream_add_bitstream_filter
147 AVBSFContext **bsfcs;
151 * Whether or not check_bitstream should still be run on each packet
153 int bitstream_checked;
156 * The codec context used by avformat_find_stream_info, the parser, etc.
158 AVCodecContext *avctx;
160 * 1 if avctx has been initialized with the values from the codec parameters
164 enum AVCodecID orig_codec_id;
167 * Whether the internal avctx needs to be updated from codecpar (after a late change to codecpar)
169 int need_context_update;
173 #define dynarray_add(tab, nb_ptr, elem)\
175 __typeof__(tab) _tab = (tab);\
176 __typeof__(elem) _elem = (elem);\
177 (void)sizeof(**_tab == _elem); /* check that types are compatible */\
178 av_dynarray_add(_tab, nb_ptr, _elem);\
181 #define dynarray_add(tab, nb_ptr, elem)\
183 av_dynarray_add((tab), nb_ptr, (elem));\
187 struct tm *ff_brktimegm(time_t secs, struct tm *tm);
189 char *ff_data_to_hex(char *buf, const uint8_t *src, int size, int lowercase);
192 * Parse a string of hexadecimal strings. Any space between the hexadecimal
195 * @param data if non-null, the parsed data is written to this pointer
196 * @param p the string to parse
197 * @return the number of bytes written (or to be written, if data is null)
199 int ff_hex_to_data(uint8_t *data, const char *p);
202 * Add packet to AVFormatContext->packet_buffer list, determining its
203 * interleaved position using compare() function argument.
204 * @return 0, or < 0 on error
206 int ff_interleave_add_packet(AVFormatContext *s, AVPacket *pkt,
207 int (*compare)(AVFormatContext *, AVPacket *, AVPacket *));
209 void ff_read_frame_flush(AVFormatContext *s);
211 #define NTP_OFFSET 2208988800ULL
212 #define NTP_OFFSET_US (NTP_OFFSET * 1000000ULL)
214 /** Get the current time since NTP epoch in microseconds. */
215 uint64_t ff_ntp_time(void);
218 * Append the media-specific SDP fragment for the media stream c
219 * to the buffer buff.
221 * Note, the buffer needs to be initialized, since it is appended to
224 * @param buff the buffer to append the SDP fragment to
225 * @param size the size of the buff buffer
226 * @param st the AVStream of the media to describe
227 * @param idx the global stream index
228 * @param dest_addr the destination address of the media stream, may be NULL
229 * @param dest_type the destination address type, may be NULL
230 * @param port the destination port of the media stream, 0 if unknown
231 * @param ttl the time to live of the stream, 0 if not multicast
232 * @param fmt the AVFormatContext, which might contain options modifying
235 void ff_sdp_write_media(char *buff, int size, AVStream *st, int idx,
236 const char *dest_addr, const char *dest_type,
237 int port, int ttl, AVFormatContext *fmt);
240 * Write a packet to another muxer than the one the user originally
241 * intended. Useful when chaining muxers, where one muxer internally
242 * writes a received packet to another muxer.
244 * @param dst the muxer to write the packet to
245 * @param dst_stream the stream index within dst to write the packet to
246 * @param pkt the packet to be written
247 * @param src the muxer the packet originally was intended for
248 * @param interleave 0->use av_write_frame, 1->av_interleaved_write_frame
249 * @return the value av_write_frame returned
251 int ff_write_chained(AVFormatContext *dst, int dst_stream, AVPacket *pkt,
252 AVFormatContext *src, int interleave);
255 * Get the length in bytes which is needed to store val as v.
257 int ff_get_v_length(uint64_t val);
260 * Put val using a variable number of bytes.
262 void ff_put_v(AVIOContext *bc, uint64_t val);
265 * Read a whole line of text from AVIOContext. Stop reading after reaching
266 * either a \\n, a \\0 or EOF. The returned string is always \\0-terminated,
267 * and may be truncated if the buffer is too small.
269 * @param s the read-only AVIOContext
270 * @param buf buffer to store the read line
271 * @param maxlen size of the buffer
272 * @return the length of the string written in the buffer, not including the
275 int ff_get_line(AVIOContext *s, char *buf, int maxlen);
277 #define SPACE_CHARS " \t\r\n"
280 * Callback function type for ff_parse_key_value.
282 * @param key a pointer to the key
283 * @param key_len the number of bytes that belong to the key, including the '='
285 * @param dest return the destination pointer for the value in *dest, may
286 * be null to ignore the value
287 * @param dest_len the length of the *dest buffer
289 typedef void (*ff_parse_key_val_cb)(void *context, const char *key,
290 int key_len, char **dest, int *dest_len);
292 * Parse a string with comma-separated key=value pairs. The value strings
293 * may be quoted and may contain escaped characters within quoted strings.
295 * @param str the string to parse
296 * @param callback_get_buf function that returns where to store the
297 * unescaped value string.
298 * @param context the opaque context pointer to pass to callback_get_buf
300 void ff_parse_key_value(const char *str, ff_parse_key_val_cb callback_get_buf,
304 * Find stream index based on format-specific stream ID
305 * @return stream index, or < 0 on error
307 int ff_find_stream_index(AVFormatContext *s, int id);
310 * Internal version of av_index_search_timestamp
312 int ff_index_search_timestamp(const AVIndexEntry *entries, int nb_entries,
313 int64_t wanted_timestamp, int flags);
316 * Internal version of av_add_index_entry
318 int ff_add_index_entry(AVIndexEntry **index_entries,
319 int *nb_index_entries,
320 unsigned int *index_entries_allocated_size,
321 int64_t pos, int64_t timestamp, int size, int distance, int flags);
323 void ff_configure_buffers_for_index(AVFormatContext *s, int64_t time_tolerance);
328 * @param s media file handle
329 * @param id unique ID for this chapter
330 * @param start chapter start time in time_base units
331 * @param end chapter end time in time_base units
332 * @param title chapter title
334 * @return AVChapter or NULL on error
336 AVChapter *avpriv_new_chapter(AVFormatContext *s, int id, AVRational time_base,
337 int64_t start, int64_t end, const char *title);
340 * Ensure the index uses less memory than the maximum specified in
341 * AVFormatContext.max_index_size by discarding entries if it grows
344 void ff_reduce_index(AVFormatContext *s, int stream_index);
346 enum AVCodecID ff_guess_image2_codec(const char *filename);
349 * Perform a binary search using av_index_search_timestamp() and
350 * AVInputFormat.read_timestamp().
352 * @param target_ts target timestamp in the time base of the given stream
353 * @param stream_index stream number
355 int ff_seek_frame_binary(AVFormatContext *s, int stream_index,
356 int64_t target_ts, int flags);
359 * Update cur_dts of all streams based on the given timestamp and AVStream.
361 * Stream ref_st unchanged, others set cur_dts in their native time base.
362 * Only needed for timestamp wrapping or if (dts not set and pts!=dts).
363 * @param timestamp new dts expressed in time_base of param ref_st
364 * @param ref_st reference stream giving time_base of param timestamp
366 void ff_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
368 int ff_find_last_ts(AVFormatContext *s, int stream_index, int64_t *ts, int64_t *pos,
369 int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
372 * Perform a binary search using read_timestamp().
374 * @param target_ts target timestamp in the time base of the given stream
375 * @param stream_index stream number
377 int64_t ff_gen_search(AVFormatContext *s, int stream_index,
378 int64_t target_ts, int64_t pos_min,
379 int64_t pos_max, int64_t pos_limit,
380 int64_t ts_min, int64_t ts_max,
381 int flags, int64_t *ts_ret,
382 int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
385 * Set the time base and wrapping info for a given stream. This will be used
386 * to interpret the stream's timestamps. If the new time base is invalid
387 * (numerator or denominator are non-positive), it leaves the stream
391 * @param pts_wrap_bits number of bits effectively used by the pts
392 * (used for wrap control)
393 * @param pts_num time base numerator
394 * @param pts_den time base denominator
396 void avpriv_set_pts_info(AVStream *s, int pts_wrap_bits,
397 unsigned int pts_num, unsigned int pts_den);
400 * Add side data to a packet for changing parameters to the given values.
401 * Parameters set to 0 aren't included in the change.
403 int ff_add_param_change(AVPacket *pkt, int32_t channels,
404 uint64_t channel_layout, int32_t sample_rate,
405 int32_t width, int32_t height);
408 * Set the timebase for each stream from the corresponding codec timebase and
411 int ff_framehash_write_header(AVFormatContext *s);
414 * Read a transport packet from a media file.
416 * @param s media file handle
417 * @param pkt is filled
418 * @return 0 if OK, AVERROR_xxx on error
420 int ff_read_packet(AVFormatContext *s, AVPacket *pkt);
423 * Interleave a packet per dts in an output media file.
425 * Packets with pkt->destruct == av_destruct_packet will be freed inside this
426 * function, so they cannot be used after it. Note that calling av_packet_unref()
427 * on them is still safe.
429 * @param s media file handle
430 * @param out the interleaved packet will be output here
431 * @param pkt the input packet
432 * @param flush 1 if no further packets are available as input and all
433 * remaining packets should be output
434 * @return 1 if a packet was output, 0 if no packet could be output,
435 * < 0 if an error occurred
437 int ff_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
438 AVPacket *pkt, int flush);
440 void ff_free_stream(AVFormatContext *s, AVStream *st);
443 * Return the frame duration in seconds. Return 0 if not available.
445 void ff_compute_frame_duration(AVFormatContext *s, int *pnum, int *pden, AVStream *st,
446 AVCodecParserContext *pc, AVPacket *pkt);
448 unsigned int ff_codec_get_tag(const AVCodecTag *tags, enum AVCodecID id);
450 enum AVCodecID ff_codec_get_id(const AVCodecTag *tags, unsigned int tag);
453 * Select a PCM codec based on the given parameters.
455 * @param bps bits-per-sample
456 * @param flt floating-point
457 * @param be big-endian
458 * @param sflags signed flags. each bit corresponds to one byte of bit depth.
459 * e.g. the 1st bit indicates if 8-bit should be signed or
460 * unsigned, the 2nd bit indicates if 16-bit should be signed or
461 * unsigned, etc... This is useful for formats such as WAVE where
462 * only 8-bit is unsigned and all other bit depths are signed.
463 * @return a PCM codec id or AV_CODEC_ID_NONE
465 enum AVCodecID ff_get_pcm_codec_id(int bps, int flt, int be, int sflags);
468 * Chooses a timebase for muxing the specified stream.
470 * The chosen timebase allows sample accurate timestamps based
471 * on the framerate or sample rate for audio streams. It also is
472 * at least as precise as 1/min_precision would be.
474 AVRational ff_choose_timebase(AVFormatContext *s, AVStream *st, int min_precision);
477 * Chooses a timebase for muxing the specified stream.
479 enum AVChromaLocation ff_choose_chroma_location(AVFormatContext *s, AVStream *st);
482 * Generate standard extradata for AVC-Intra based on width/height and field
485 int ff_generate_avci_extradata(AVStream *st);
488 * Add a bitstream filter to a stream.
490 * @param st output stream to add a filter to
491 * @param name the name of the filter to add
492 * @param args filter-specific argument string
493 * @return >0 on success;
494 * AVERROR code on failure
496 int ff_stream_add_bitstream_filter(AVStream *st, const char *name, const char *args);
499 * Copy encoding parameters from source to destination stream
501 * @param dst pointer to destination AVStream
502 * @param src pointer to source AVStream
503 * @return >=0 on success, AVERROR code on error
505 int ff_stream_encode_params_copy(AVStream *dst, const AVStream *src);
508 * Wrap errno on rename() error.
510 * @param oldpath source path
511 * @param newpath destination path
512 * @return 0 or AVERROR on failure
514 static inline int ff_rename(const char *oldpath, const char *newpath, void *logctx)
517 if (rename(oldpath, newpath) == -1) {
518 ret = AVERROR(errno);
520 av_log(logctx, AV_LOG_ERROR, "failed to rename file %s to %s\n", oldpath, newpath);
526 * Allocate extradata with additional AV_INPUT_BUFFER_PADDING_SIZE at end
527 * which is always set to 0.
529 * @param size size of extradata
530 * @return 0 if OK, AVERROR_xxx on error
532 int ff_alloc_extradata(AVCodecParameters *par, int size);
535 * Allocate extradata with additional AV_INPUT_BUFFER_PADDING_SIZE at end
536 * which is always set to 0 and fill it from pb.
538 * @param size size of extradata
539 * @return >= 0 if OK, AVERROR_xxx on error
541 int ff_get_extradata(AVFormatContext *s, AVCodecParameters *par, AVIOContext *pb, int size);
544 * add frame for rfps calculation.
546 * @param dts timestamp of the i-th frame
547 * @return 0 if OK, AVERROR_xxx on error
549 int ff_rfps_add_frame(AVFormatContext *ic, AVStream *st, int64_t dts);
551 void ff_rfps_calculate(AVFormatContext *ic);
554 * Flags for AVFormatContext.write_uncoded_frame()
556 enum AVWriteUncodedFrameFlags {
559 * Query whether the feature is possible on this stream.
560 * The frame argument is ignored.
562 AV_WRITE_UNCODED_FRAME_QUERY = 0x0001,
567 * Copies the whilelists from one context to the other
569 int ff_copy_whiteblacklists(AVFormatContext *dst, const AVFormatContext *src);
571 int ffio_open2_wrapper(struct AVFormatContext *s, AVIOContext **pb, const char *url, int flags,
572 const AVIOInterruptCB *int_cb, AVDictionary **options);
575 * Returned by demuxers to indicate that data was consumed but discarded
576 * (ignored streams or junk data). The framework will re-call the demuxer.
578 #define FFERROR_REDO FFERRTAG('R','E','D','O')
581 * Utility function to open IO stream of output format.
583 * @param s AVFormatContext
584 * @param url URL or file name to open for writing
585 * @options optional options which will be passed to io_open callback
586 * @return >=0 on success, negative AVERROR in case of failure
588 int ff_format_output_open(AVFormatContext *s, const char *url, AVDictionary **options);
591 * A wrapper around AVFormatContext.io_close that should be used
592 * instead of calling the pointer directly.
594 void ff_format_io_close(AVFormatContext *s, AVIOContext **pb);
597 * Parse creation_time in AVFormatContext metadata if exists and warn if the
600 * @param s AVFormatContext
601 * @param timestamp parsed timestamp in microseconds, only set on successful parsing
602 * @param return_seconds set this to get the number of seconds in timestamp instead of microseconds
603 * @return 1 if OK, 0 if the metadata was not present, AVERROR(EINVAL) on parse error
605 int ff_parse_creation_time_metadata(AVFormatContext *s, int64_t *timestamp, int return_seconds);
608 * Standardize creation_time metadata in AVFormatContext to an ISO-8601
611 * @param s AVFormatContext
612 * @return <0 on error
614 int ff_standardize_creation_time(AVFormatContext *s);
616 #define CONTAINS_PAL 2
618 * Reshuffles the lines to use the user specified stride.
620 * @param ppkt input and output packet
621 * @return negative error code or
622 * 0 if no new packet was allocated
623 * non-zero if a new packet was allocated and ppkt has to be freed
624 * CONTAINS_PAL if in addition to a new packet the old contained a palette
626 int ff_reshuffle_raw_rgb(AVFormatContext *s, AVPacket **ppkt, AVCodecParameters *par, int expected_stride);
629 * Retrieves the palette from a packet, either from side data, or
630 * appended to the video data in the packet itself (raw video only).
631 * It is commonly used after a call to ff_reshuffle_raw_rgb().
633 * Use 0 for the ret parameter to check for side data only.
635 * @param pkt pointer to packet before calling ff_reshuffle_raw_rgb()
636 * @param ret return value from ff_reshuffle_raw_rgb(), or 0
637 * @param palette pointer to palette buffer
638 * @return negative error code or
639 * 1 if the packet has a palette, else 0
641 int ff_get_packet_palette(AVFormatContext *s, AVPacket *pkt, int ret, uint32_t *palette);
644 * Finalize buf into extradata and set its size appropriately.
646 int ff_bprint_to_codecpar_extradata(AVCodecParameters *par, struct AVBPrint *buf);
649 * Find the next packet in the interleaving queue for the given stream.
650 * The packet is not removed from the interleaving queue, but only
651 * a pointer to it is returned.
653 * @param ts_offset the ts difference between packet in the que and the muxer.
655 * @return a pointer to the next packet, or NULL if no packet is queued
658 const AVPacket *ff_interleaved_peek(AVFormatContext *s, int stream, int64_t *ts_offset);
660 #endif /* AVFORMAT_INTERNAL_H */