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)
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 /*************************************************/
53 /* fractional numbers for exact pts handling */
56 * The exact value of the fractional number is: 'val + num / den'.
57 * num is assumed to be 0 <= num < den.
59 typedef struct FFFrac {
60 int64_t val, num, den;
64 struct AVFormatInternal {
66 * Number of streams relevant for interleaving.
69 int nb_interleaved_streams;
72 * This buffer is only needed when packets were already buffered but
73 * not decoded, for example to get the codec parameters in MPEG
76 struct AVPacketList *packet_buffer;
77 struct AVPacketList *packet_buffer_end;
79 /* av_seek_frame() support */
80 int64_t data_offset; /**< offset of the first packet */
83 * Raw packets from the demuxer, prior to parsing and decoding.
84 * This buffer is used for buffering packets until the codec can
85 * be identified, as parsing cannot be done without knowing the
88 struct AVPacketList *raw_packet_buffer;
89 struct AVPacketList *raw_packet_buffer_end;
91 * Packets split by the parser get queued here.
93 struct AVPacketList *parse_queue;
94 struct AVPacketList *parse_queue_end;
96 * Remaining size available for raw_packet_buffer, in bytes.
98 #define RAW_PACKET_BUFFER_SIZE 2500000
99 int raw_packet_buffer_remaining_size;
102 * Offset to remap timestamps to be non-negative.
103 * Expressed in timebase units.
104 * @see AVStream.mux_ts_offset
109 * Timebase for the timestamp offset.
111 AVRational offset_timebase;
113 #if FF_API_COMPUTE_PKT_FIELDS2
114 int missing_ts_warning;
117 int inject_global_side_data;
119 int avoid_negative_ts_use_pts;
122 * Timestamp of the end of the shortest stream.
124 int64_t shortest_end;
127 * Whether or not avformat_init_output has already been called
132 * Whether or not avformat_init_output fully initialized streams
134 int streams_initialized;
137 * ID3v2 tag useful for MP3 demuxing
139 AVDictionary *id3v2_meta;
142 * Prefer the codec framerate for avg_frame_rate computation.
144 int prefer_codec_framerate;
147 struct AVStreamInternal {
149 * Set to 1 if the codec allows reordering, so pts can be different
155 * bitstream filter to run on stream
156 * - encoding: Set by muxer using ff_stream_add_bitstream_filter
162 * Whether or not check_bitstream should still be run on each packet
164 int bitstream_checked;
167 * The codec context used by avformat_find_stream_info, the parser, etc.
169 AVCodecContext *avctx;
171 * 1 if avctx has been initialized with the values from the codec parameters
175 enum AVCodecID orig_codec_id;
177 /* the context for extracting extradata in find_stream_info()
178 * inited=1/bsf=NULL signals that extracting is not possible (codec not
187 * Whether the internal avctx needs to be updated from codecpar (after a late change to codecpar)
189 int need_context_update;
195 #define MAX_STD_TIMEBASES (30*12+30+3+6)
197 * Stream information used internally by avformat_find_stream_info()
201 int64_t duration_gcd;
203 int64_t rfps_duration_sum;
204 double (*duration_error)[2][MAX_STD_TIMEBASES];
205 int64_t codec_info_duration;
206 int64_t codec_info_duration_fields;
207 int frame_delay_evidence;
210 * 0 -> decoder has not been searched for yet.
211 * >0 -> decoder found
212 * <0 -> decoder with codec_id == -found_decoder has not been found
216 int64_t last_duration;
219 * Those are used for average framerate estimation.
221 int64_t fps_first_dts;
222 int fps_first_dts_idx;
223 int64_t fps_last_dts;
224 int fps_last_dts_idx;
229 * Number of internally decoded frames, used internally in libavformat, do not access
230 * its lifetime differs from info which is why it is not in that structure.
232 int nb_decoded_frames;
235 * Timestamp offset added to timestamps before muxing
237 int64_t mux_ts_offset;
240 * Internal data to check for wrapping of the time stamp
242 int64_t pts_wrap_reference;
245 * Options for behavior, when a wrap is detected.
247 * Defined by AV_PTS_WRAP_ values.
249 * If correction is enabled, there are two possibilities:
250 * If the first time stamp is near the wrap point, the wrap offset
251 * will be subtracted, which will create negative time stamps.
252 * Otherwise the offset will be added.
254 int pts_wrap_behavior;
257 * Internal data to prevent doing update_initial_durations() twice
259 int update_initial_durations_done;
262 * Internal data to generate dts from pts
264 int64_t pts_reorder_error[MAX_REORDER_DELAY+1];
265 uint8_t pts_reorder_error_count[MAX_REORDER_DELAY+1];
268 * Internal data to analyze DTS and detect faulty mpeg streams
270 int64_t last_dts_for_order_check;
272 uint8_t dts_misordered;
275 * Internal data to inject global side data
277 int inject_global_side_data;
280 * display aspect ratio (0 if unknown)
282 * - decoding: Set by libavformat to calculate sample_aspect_ratio internally
284 AVRational display_aspect_ratio;
288 #define dynarray_add(tab, nb_ptr, elem)\
290 __typeof__(tab) _tab = (tab);\
291 __typeof__(elem) _elem = (elem);\
292 (void)sizeof(**_tab == _elem); /* check that types are compatible */\
293 av_dynarray_add(_tab, nb_ptr, _elem);\
296 #define dynarray_add(tab, nb_ptr, elem)\
298 av_dynarray_add((tab), nb_ptr, (elem));\
302 struct tm *ff_brktimegm(time_t secs, struct tm *tm);
305 * Automatically create sub-directories
307 * @param path will create sub-directories by path
308 * @return 0, or < 0 on error
310 int ff_mkdir_p(const char *path);
312 char *ff_data_to_hex(char *buf, const uint8_t *src, int size, int lowercase);
315 * Parse a string of hexadecimal strings. Any space between the hexadecimal
318 * @param data if non-null, the parsed data is written to this pointer
319 * @param p the string to parse
320 * @return the number of bytes written (or to be written, if data is null)
322 int ff_hex_to_data(uint8_t *data, const char *p);
325 * Add packet to an AVFormatContext's packet_buffer list, determining its
326 * interleaved position using compare() function argument.
327 * @return 0 on success, < 0 on error. pkt will always be blank on return.
329 int ff_interleave_add_packet(AVFormatContext *s, AVPacket *pkt,
330 int (*compare)(AVFormatContext *, const AVPacket *, const AVPacket *));
332 void ff_read_frame_flush(AVFormatContext *s);
334 #define NTP_OFFSET 2208988800ULL
335 #define NTP_OFFSET_US (NTP_OFFSET * 1000000ULL)
337 /** Get the current time since NTP epoch in microseconds. */
338 uint64_t ff_ntp_time(void);
341 * Get the NTP time stamp formatted as per the RFC-5905.
343 * @param ntp_time NTP time in micro seconds (since NTP epoch)
344 * @return the formatted NTP time stamp
346 uint64_t ff_get_formatted_ntp_time(uint64_t ntp_time_us);
349 * Append the media-specific SDP fragment for the media stream c
350 * to the buffer buff.
352 * Note, the buffer needs to be initialized, since it is appended to
355 * @param buff the buffer to append the SDP fragment to
356 * @param size the size of the buff buffer
357 * @param st the AVStream of the media to describe
358 * @param idx the global stream index
359 * @param dest_addr the destination address of the media stream, may be NULL
360 * @param dest_type the destination address type, may be NULL
361 * @param port the destination port of the media stream, 0 if unknown
362 * @param ttl the time to live of the stream, 0 if not multicast
363 * @param fmt the AVFormatContext, which might contain options modifying
366 void ff_sdp_write_media(char *buff, int size, AVStream *st, int idx,
367 const char *dest_addr, const char *dest_type,
368 int port, int ttl, AVFormatContext *fmt);
371 * Write a packet to another muxer than the one the user originally
372 * intended. Useful when chaining muxers, where one muxer internally
373 * writes a received packet to another muxer.
375 * @param dst the muxer to write the packet to
376 * @param dst_stream the stream index within dst to write the packet to
377 * @param pkt the packet to be written
378 * @param src the muxer the packet originally was intended for
379 * @param interleave 0->use av_write_frame, 1->av_interleaved_write_frame
380 * @return the value av_write_frame returned
382 int ff_write_chained(AVFormatContext *dst, int dst_stream, AVPacket *pkt,
383 AVFormatContext *src, int interleave);
386 * Read a whole line of text from AVIOContext. Stop reading after reaching
387 * either a \\n, a \\0 or EOF. The returned string is always \\0-terminated,
388 * and may be truncated if the buffer is too small.
390 * @param s the read-only AVIOContext
391 * @param buf buffer to store the read line
392 * @param maxlen size of the buffer
393 * @return the length of the string written in the buffer, not including the
396 int ff_get_line(AVIOContext *s, char *buf, int maxlen);
399 * Same as ff_get_line but strip the white-space characters in the text tail
401 * @param s the read-only AVIOContext
402 * @param buf buffer to store the read line
403 * @param maxlen size of the buffer
404 * @return the length of the string written in the buffer
406 int ff_get_chomp_line(AVIOContext *s, char *buf, int maxlen);
409 * Read a whole line of text from AVIOContext to an AVBPrint buffer. Stop
410 * reading after reaching a \\r, a \\n, a \\r\\n, a \\0 or EOF. The line
411 * ending characters are NOT included in the buffer, but they are skipped on
414 * @param s the read-only AVIOContext
415 * @param bp the AVBPrint buffer
416 * @return the length of the read line, not including the line endings,
419 int64_t ff_read_line_to_bprint(AVIOContext *s, AVBPrint *bp);
422 * Read a whole line of text from AVIOContext to an AVBPrint buffer overwriting
423 * its contents. Stop reading after reaching a \\r, a \\n, a \\r\\n, a \\0 or
424 * EOF. The line ending characters are NOT included in the buffer, but they
425 * are skipped on the input.
427 * @param s the read-only AVIOContext
428 * @param bp the AVBPrint buffer
429 * @return the length of the read line not including the line endings,
430 * negative on error, or if the buffer becomes truncated.
432 int64_t ff_read_line_to_bprint_overwrite(AVIOContext *s, AVBPrint *bp);
434 #define SPACE_CHARS " \t\r\n"
437 * Callback function type for ff_parse_key_value.
439 * @param key a pointer to the key
440 * @param key_len the number of bytes that belong to the key, including the '='
442 * @param dest return the destination pointer for the value in *dest, may
443 * be null to ignore the value
444 * @param dest_len the length of the *dest buffer
446 typedef void (*ff_parse_key_val_cb)(void *context, const char *key,
447 int key_len, char **dest, int *dest_len);
449 * Parse a string with comma-separated key=value pairs. The value strings
450 * may be quoted and may contain escaped characters within quoted strings.
452 * @param str the string to parse
453 * @param callback_get_buf function that returns where to store the
454 * unescaped value string.
455 * @param context the opaque context pointer to pass to callback_get_buf
457 void ff_parse_key_value(const char *str, ff_parse_key_val_cb callback_get_buf,
461 * Find stream index based on format-specific stream ID
462 * @return stream index, or < 0 on error
464 int ff_find_stream_index(AVFormatContext *s, int id);
467 * Internal version of av_index_search_timestamp
469 int ff_index_search_timestamp(const AVIndexEntry *entries, int nb_entries,
470 int64_t wanted_timestamp, int flags);
473 * Internal version of av_add_index_entry
475 int ff_add_index_entry(AVIndexEntry **index_entries,
476 int *nb_index_entries,
477 unsigned int *index_entries_allocated_size,
478 int64_t pos, int64_t timestamp, int size, int distance, int flags);
480 void ff_configure_buffers_for_index(AVFormatContext *s, int64_t time_tolerance);
485 * @param s media file handle
486 * @param id unique ID for this chapter
487 * @param start chapter start time in time_base units
488 * @param end chapter end time in time_base units
489 * @param title chapter title
491 * @return AVChapter or NULL on error
493 AVChapter *avpriv_new_chapter(AVFormatContext *s, int id, AVRational time_base,
494 int64_t start, int64_t end, const char *title);
497 * Ensure the index uses less memory than the maximum specified in
498 * AVFormatContext.max_index_size by discarding entries if it grows
501 void ff_reduce_index(AVFormatContext *s, int stream_index);
503 enum AVCodecID ff_guess_image2_codec(const char *filename);
506 * Perform a binary search using av_index_search_timestamp() and
507 * AVInputFormat.read_timestamp().
509 * @param target_ts target timestamp in the time base of the given stream
510 * @param stream_index stream number
512 int ff_seek_frame_binary(AVFormatContext *s, int stream_index,
513 int64_t target_ts, int flags);
516 * Update cur_dts of all streams based on the given timestamp and AVStream.
518 * Stream ref_st unchanged, others set cur_dts in their native time base.
519 * Only needed for timestamp wrapping or if (dts not set and pts!=dts).
520 * @param timestamp new dts expressed in time_base of param ref_st
521 * @param ref_st reference stream giving time_base of param timestamp
523 void ff_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
525 int ff_find_last_ts(AVFormatContext *s, int stream_index, int64_t *ts, int64_t *pos,
526 int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
529 * Perform a binary search using read_timestamp().
531 * @param target_ts target timestamp in the time base of the given stream
532 * @param stream_index stream number
534 int64_t ff_gen_search(AVFormatContext *s, int stream_index,
535 int64_t target_ts, int64_t pos_min,
536 int64_t pos_max, int64_t pos_limit,
537 int64_t ts_min, int64_t ts_max,
538 int flags, int64_t *ts_ret,
539 int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
542 * Set the time base and wrapping info for a given stream. This will be used
543 * to interpret the stream's timestamps. If the new time base is invalid
544 * (numerator or denominator are non-positive), it leaves the stream
548 * @param pts_wrap_bits number of bits effectively used by the pts
549 * (used for wrap control)
550 * @param pts_num time base numerator
551 * @param pts_den time base denominator
553 void avpriv_set_pts_info(AVStream *s, int pts_wrap_bits,
554 unsigned int pts_num, unsigned int pts_den);
557 * Add side data to a packet for changing parameters to the given values.
558 * Parameters set to 0 aren't included in the change.
560 int ff_add_param_change(AVPacket *pkt, int32_t channels,
561 uint64_t channel_layout, int32_t sample_rate,
562 int32_t width, int32_t height);
565 * Set the timebase for each stream from the corresponding codec timebase and
568 int ff_framehash_write_header(AVFormatContext *s);
571 * Read a transport packet from a media file.
573 * @param s media file handle
574 * @param pkt is filled
575 * @return 0 if OK, AVERROR_xxx on error
577 int ff_read_packet(AVFormatContext *s, AVPacket *pkt);
580 * Interleave an AVPacket per dts so it can be muxed.
582 * @param s an AVFormatContext for output. pkt resp. out will be added to
583 * resp. taken from its packet buffer.
584 * @param out the interleaved packet will be output here
585 * @param pkt the input packet; will be blank on return if not NULL
586 * @param flush 1 if no further packets are available as input and all
587 * remaining packets should be output
588 * @return 1 if a packet was output, 0 if no packet could be output
589 * (in which case out may be uninitialized), < 0 if an error occurred
591 int ff_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
592 AVPacket *pkt, int flush);
594 void ff_free_stream(AVFormatContext *s, AVStream *st);
597 * Return the frame duration in seconds. Return 0 if not available.
599 void ff_compute_frame_duration(AVFormatContext *s, int *pnum, int *pden, AVStream *st,
600 AVCodecParserContext *pc, AVPacket *pkt);
602 unsigned int ff_codec_get_tag(const AVCodecTag *tags, enum AVCodecID id);
604 enum AVCodecID ff_codec_get_id(const AVCodecTag *tags, unsigned int tag);
606 int ff_is_intra_only(enum AVCodecID id);
609 * Select a PCM codec based on the given parameters.
611 * @param bps bits-per-sample
612 * @param flt floating-point
613 * @param be big-endian
614 * @param sflags signed flags. each bit corresponds to one byte of bit depth.
615 * e.g. the 1st bit indicates if 8-bit should be signed or
616 * unsigned, the 2nd bit indicates if 16-bit should be signed or
617 * unsigned, etc... This is useful for formats such as WAVE where
618 * only 8-bit is unsigned and all other bit depths are signed.
619 * @return a PCM codec id or AV_CODEC_ID_NONE
621 enum AVCodecID ff_get_pcm_codec_id(int bps, int flt, int be, int sflags);
624 * Chooses a timebase for muxing the specified stream.
626 * The chosen timebase allows sample accurate timestamps based
627 * on the framerate or sample rate for audio streams. It also is
628 * at least as precise as 1/min_precision would be.
630 AVRational ff_choose_timebase(AVFormatContext *s, AVStream *st, int min_precision);
633 * Chooses a timebase for muxing the specified stream.
635 enum AVChromaLocation ff_choose_chroma_location(AVFormatContext *s, AVStream *st);
638 * Generate standard extradata for AVC-Intra based on width/height and field
641 int ff_generate_avci_extradata(AVStream *st);
644 * Add a bitstream filter to a stream.
646 * @param st output stream to add a filter to
647 * @param name the name of the filter to add
648 * @param args filter-specific argument string
649 * @return >0 on success;
650 * AVERROR code on failure
652 int ff_stream_add_bitstream_filter(AVStream *st, const char *name, const char *args);
655 * Copy encoding parameters from source to destination stream
657 * @param dst pointer to destination AVStream
658 * @param src pointer to source AVStream
659 * @return >=0 on success, AVERROR code on error
661 int ff_stream_encode_params_copy(AVStream *dst, const AVStream *src);
664 * Wrap avpriv_io_move and log if error happens.
666 * @param url_src source path
667 * @param url_dst destination path
668 * @return 0 or AVERROR on failure
670 int ff_rename(const char *url_src, const char *url_dst, void *logctx);
673 * Allocate extradata with additional AV_INPUT_BUFFER_PADDING_SIZE at end
674 * which is always set to 0.
676 * Previously allocated extradata in par will be freed.
678 * @param size size of extradata
679 * @return 0 if OK, AVERROR_xxx on error
681 int ff_alloc_extradata(AVCodecParameters *par, int size);
684 * Allocate extradata with additional AV_INPUT_BUFFER_PADDING_SIZE at end
685 * which is always set to 0 and fill it from pb.
687 * @param size size of extradata
688 * @return >= 0 if OK, AVERROR_xxx on error
690 int ff_get_extradata(AVFormatContext *s, AVCodecParameters *par, AVIOContext *pb, int size);
693 * add frame for rfps calculation.
695 * @param dts timestamp of the i-th frame
696 * @return 0 if OK, AVERROR_xxx on error
698 int ff_rfps_add_frame(AVFormatContext *ic, AVStream *st, int64_t dts);
700 void ff_rfps_calculate(AVFormatContext *ic);
703 * Flags for AVFormatContext.write_uncoded_frame()
705 enum AVWriteUncodedFrameFlags {
708 * Query whether the feature is possible on this stream.
709 * The frame argument is ignored.
711 AV_WRITE_UNCODED_FRAME_QUERY = 0x0001,
716 * Copies the whilelists from one context to the other
718 int ff_copy_whiteblacklists(AVFormatContext *dst, const AVFormatContext *src);
721 * Returned by demuxers to indicate that data was consumed but discarded
722 * (ignored streams or junk data). The framework will re-call the demuxer.
724 #define FFERROR_REDO FFERRTAG('R','E','D','O')
727 * Utility function to open IO stream of output format.
729 * @param s AVFormatContext
730 * @param url URL or file name to open for writing
731 * @options optional options which will be passed to io_open callback
732 * @return >=0 on success, negative AVERROR in case of failure
734 int ff_format_output_open(AVFormatContext *s, const char *url, AVDictionary **options);
737 * A wrapper around AVFormatContext.io_close that should be used
738 * instead of calling the pointer directly.
740 void ff_format_io_close(AVFormatContext *s, AVIOContext **pb);
743 * Utility function to check if the file uses http or https protocol
745 * @param s AVFormatContext
746 * @param filename URL or file name to open for writing
748 int ff_is_http_proto(char *filename);
751 * Parse creation_time in AVFormatContext metadata if exists and warn if the
754 * @param s AVFormatContext
755 * @param timestamp parsed timestamp in microseconds, only set on successful parsing
756 * @param return_seconds set this to get the number of seconds in timestamp instead of microseconds
757 * @return 1 if OK, 0 if the metadata was not present, AVERROR(EINVAL) on parse error
759 int ff_parse_creation_time_metadata(AVFormatContext *s, int64_t *timestamp, int return_seconds);
762 * Standardize creation_time metadata in AVFormatContext to an ISO-8601
765 * @param s AVFormatContext
766 * @return <0 on error
768 int ff_standardize_creation_time(AVFormatContext *s);
770 #define CONTAINS_PAL 2
772 * Reshuffles the lines to use the user specified stride.
774 * @param ppkt input and output packet
775 * @return negative error code or
776 * 0 if no new packet was allocated
777 * non-zero if a new packet was allocated and ppkt has to be freed
778 * CONTAINS_PAL if in addition to a new packet the old contained a palette
780 int ff_reshuffle_raw_rgb(AVFormatContext *s, AVPacket **ppkt, AVCodecParameters *par, int expected_stride);
783 * Retrieves the palette from a packet, either from side data, or
784 * appended to the video data in the packet itself (raw video only).
785 * It is commonly used after a call to ff_reshuffle_raw_rgb().
787 * Use 0 for the ret parameter to check for side data only.
789 * @param pkt pointer to packet before calling ff_reshuffle_raw_rgb()
790 * @param ret return value from ff_reshuffle_raw_rgb(), or 0
791 * @param palette pointer to palette buffer
792 * @return negative error code or
793 * 1 if the packet has a palette, else 0
795 int ff_get_packet_palette(AVFormatContext *s, AVPacket *pkt, int ret, uint32_t *palette);
798 * Finalize buf into extradata and set its size appropriately.
800 int ff_bprint_to_codecpar_extradata(AVCodecParameters *par, struct AVBPrint *buf);
803 * Find the next packet in the interleaving queue for the given stream.
804 * The pkt parameter is filled in with the queued packet, including
805 * references to the data (which the caller is not allowed to keep or
808 * @return 0 if a packet was found, a negative value if no packet was found
810 int ff_interleaved_peek(AVFormatContext *s, int stream,
811 AVPacket *pkt, int add_offset);
814 int ff_lock_avformat(void);
815 int ff_unlock_avformat(void);
818 * Set AVFormatContext url field to the provided pointer. The pointer must
819 * point to a valid string. The existing url field is freed if necessary. Also
820 * set the legacy filename field to the same string which was provided in url.
822 void ff_format_set_url(AVFormatContext *s, char *url);
824 void avpriv_register_devices(const AVOutputFormat * const o[], const AVInputFormat * const i[]);
826 #endif /* AVFORMAT_INTERNAL_H */