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 * Timestamp of the end of the shortest stream.
126 int64_t shortest_end;
129 * Whether or not avformat_init_output has already been called
134 * Whether or not avformat_init_output fully initialized streams
136 int streams_initialized;
139 * ID3v2 tag useful for MP3 demuxing
141 AVDictionary *id3v2_meta;
144 * Prefer the codec framerate for avg_frame_rate computation.
146 int prefer_codec_framerate;
149 struct AVStreamInternal {
151 * Set to 1 if the codec allows reordering, so pts can be different
157 * bitstream filters to run on stream
158 * - encoding: Set by muxer using ff_stream_add_bitstream_filter
161 AVBSFContext **bsfcs;
165 * Whether or not check_bitstream should still be run on each packet
167 int bitstream_checked;
170 * The codec context used by avformat_find_stream_info, the parser, etc.
172 AVCodecContext *avctx;
174 * 1 if avctx has been initialized with the values from the codec parameters
178 enum AVCodecID orig_codec_id;
180 /* the context for extracting extradata in find_stream_info()
181 * inited=1/bsf=NULL signals that extracting is not possible (codec not
190 * Whether the internal avctx needs to be updated from codecpar (after a late change to codecpar)
192 int need_context_update;
198 #define dynarray_add(tab, nb_ptr, elem)\
200 __typeof__(tab) _tab = (tab);\
201 __typeof__(elem) _elem = (elem);\
202 (void)sizeof(**_tab == _elem); /* check that types are compatible */\
203 av_dynarray_add(_tab, nb_ptr, _elem);\
206 #define dynarray_add(tab, nb_ptr, elem)\
208 av_dynarray_add((tab), nb_ptr, (elem));\
212 struct tm *ff_brktimegm(time_t secs, struct tm *tm);
215 * Automatically create sub-directories
217 * @param path will create sub-directories by path
218 * @return 0, or < 0 on error
220 int ff_mkdir_p(const char *path);
222 char *ff_data_to_hex(char *buf, const uint8_t *src, int size, int lowercase);
225 * Parse a string of hexadecimal strings. Any space between the hexadecimal
228 * @param data if non-null, the parsed data is written to this pointer
229 * @param p the string to parse
230 * @return the number of bytes written (or to be written, if data is null)
232 int ff_hex_to_data(uint8_t *data, const char *p);
235 * Add packet to AVFormatContext->packet_buffer list, determining its
236 * interleaved position using compare() function argument.
237 * @return 0, or < 0 on error
239 int ff_interleave_add_packet(AVFormatContext *s, AVPacket *pkt,
240 int (*compare)(AVFormatContext *, AVPacket *, AVPacket *));
242 void ff_read_frame_flush(AVFormatContext *s);
244 #define NTP_OFFSET 2208988800ULL
245 #define NTP_OFFSET_US (NTP_OFFSET * 1000000ULL)
247 /** Get the current time since NTP epoch in microseconds. */
248 uint64_t ff_ntp_time(void);
251 * Get the NTP time stamp formatted as per the RFC-5905.
253 * @param ntp_time NTP time in micro seconds (since NTP epoch)
254 * @return the formatted NTP time stamp
256 uint64_t ff_get_formatted_ntp_time(uint64_t ntp_time_us);
259 * Append the media-specific SDP fragment for the media stream c
260 * to the buffer buff.
262 * Note, the buffer needs to be initialized, since it is appended to
265 * @param buff the buffer to append the SDP fragment to
266 * @param size the size of the buff buffer
267 * @param st the AVStream of the media to describe
268 * @param idx the global stream index
269 * @param dest_addr the destination address of the media stream, may be NULL
270 * @param dest_type the destination address type, may be NULL
271 * @param port the destination port of the media stream, 0 if unknown
272 * @param ttl the time to live of the stream, 0 if not multicast
273 * @param fmt the AVFormatContext, which might contain options modifying
276 void ff_sdp_write_media(char *buff, int size, AVStream *st, int idx,
277 const char *dest_addr, const char *dest_type,
278 int port, int ttl, AVFormatContext *fmt);
281 * Write a packet to another muxer than the one the user originally
282 * intended. Useful when chaining muxers, where one muxer internally
283 * writes a received packet to another muxer.
285 * @param dst the muxer to write the packet to
286 * @param dst_stream the stream index within dst to write the packet to
287 * @param pkt the packet to be written
288 * @param src the muxer the packet originally was intended for
289 * @param interleave 0->use av_write_frame, 1->av_interleaved_write_frame
290 * @return the value av_write_frame returned
292 int ff_write_chained(AVFormatContext *dst, int dst_stream, AVPacket *pkt,
293 AVFormatContext *src, int interleave);
296 * Get the length in bytes which is needed to store val as v.
298 int ff_get_v_length(uint64_t val);
301 * Put val using a variable number of bytes.
303 void ff_put_v(AVIOContext *bc, uint64_t val);
306 * Read a whole line of text from AVIOContext. Stop reading after reaching
307 * either a \\n, a \\0 or EOF. The returned string is always \\0-terminated,
308 * and may be truncated if the buffer is too small.
310 * @param s the read-only AVIOContext
311 * @param buf buffer to store the read line
312 * @param maxlen size of the buffer
313 * @return the length of the string written in the buffer, not including the
316 int ff_get_line(AVIOContext *s, char *buf, int maxlen);
319 * Same as ff_get_line but strip the white-space characters in the text tail
321 * @param s the read-only AVIOContext
322 * @param buf buffer to store the read line
323 * @param maxlen size of the buffer
324 * @return the length of the string written in the buffer
326 int ff_get_chomp_line(AVIOContext *s, char *buf, int maxlen);
329 * Read a whole line of text from AVIOContext to an AVBPrint buffer. Stop
330 * reading after reaching a \\r, a \\n, a \\r\\n, a \\0 or EOF. The line
331 * ending characters are NOT included in the buffer, but they are skipped on
334 * @param s the read-only AVIOContext
335 * @param bp the AVBPrint buffer
336 * @return the length of the read line, not including the line endings,
339 int64_t ff_read_line_to_bprint(AVIOContext *s, AVBPrint *bp);
342 * Read a whole line of text from AVIOContext to an AVBPrint buffer overwriting
343 * its contents. Stop reading after reaching a \\r, a \\n, a \\r\\n, a \\0 or
344 * EOF. The line ending characters are NOT included in the buffer, but they
345 * are skipped on the input.
347 * @param s the read-only AVIOContext
348 * @param bp the AVBPrint buffer
349 * @return the length of the read line not including the line endings,
350 * negative on error, or if the buffer becomes truncated.
352 int64_t ff_read_line_to_bprint_overwrite(AVIOContext *s, AVBPrint *bp);
354 #define SPACE_CHARS " \t\r\n"
357 * Callback function type for ff_parse_key_value.
359 * @param key a pointer to the key
360 * @param key_len the number of bytes that belong to the key, including the '='
362 * @param dest return the destination pointer for the value in *dest, may
363 * be null to ignore the value
364 * @param dest_len the length of the *dest buffer
366 typedef void (*ff_parse_key_val_cb)(void *context, const char *key,
367 int key_len, char **dest, int *dest_len);
369 * Parse a string with comma-separated key=value pairs. The value strings
370 * may be quoted and may contain escaped characters within quoted strings.
372 * @param str the string to parse
373 * @param callback_get_buf function that returns where to store the
374 * unescaped value string.
375 * @param context the opaque context pointer to pass to callback_get_buf
377 void ff_parse_key_value(const char *str, ff_parse_key_val_cb callback_get_buf,
381 * Find stream index based on format-specific stream ID
382 * @return stream index, or < 0 on error
384 int ff_find_stream_index(AVFormatContext *s, int id);
387 * Internal version of av_index_search_timestamp
389 int ff_index_search_timestamp(const AVIndexEntry *entries, int nb_entries,
390 int64_t wanted_timestamp, int flags);
393 * Internal version of av_add_index_entry
395 int ff_add_index_entry(AVIndexEntry **index_entries,
396 int *nb_index_entries,
397 unsigned int *index_entries_allocated_size,
398 int64_t pos, int64_t timestamp, int size, int distance, int flags);
400 void ff_configure_buffers_for_index(AVFormatContext *s, int64_t time_tolerance);
405 * @param s media file handle
406 * @param id unique ID for this chapter
407 * @param start chapter start time in time_base units
408 * @param end chapter end time in time_base units
409 * @param title chapter title
411 * @return AVChapter or NULL on error
413 AVChapter *avpriv_new_chapter(AVFormatContext *s, int id, AVRational time_base,
414 int64_t start, int64_t end, const char *title);
417 * Ensure the index uses less memory than the maximum specified in
418 * AVFormatContext.max_index_size by discarding entries if it grows
421 void ff_reduce_index(AVFormatContext *s, int stream_index);
423 enum AVCodecID ff_guess_image2_codec(const char *filename);
426 * Perform a binary search using av_index_search_timestamp() and
427 * AVInputFormat.read_timestamp().
429 * @param target_ts target timestamp in the time base of the given stream
430 * @param stream_index stream number
432 int ff_seek_frame_binary(AVFormatContext *s, int stream_index,
433 int64_t target_ts, int flags);
436 * Update cur_dts of all streams based on the given timestamp and AVStream.
438 * Stream ref_st unchanged, others set cur_dts in their native time base.
439 * Only needed for timestamp wrapping or if (dts not set and pts!=dts).
440 * @param timestamp new dts expressed in time_base of param ref_st
441 * @param ref_st reference stream giving time_base of param timestamp
443 void ff_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
445 int ff_find_last_ts(AVFormatContext *s, int stream_index, int64_t *ts, int64_t *pos,
446 int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
449 * Perform a binary search using read_timestamp().
451 * @param target_ts target timestamp in the time base of the given stream
452 * @param stream_index stream number
454 int64_t ff_gen_search(AVFormatContext *s, int stream_index,
455 int64_t target_ts, int64_t pos_min,
456 int64_t pos_max, int64_t pos_limit,
457 int64_t ts_min, int64_t ts_max,
458 int flags, int64_t *ts_ret,
459 int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
462 * Set the time base and wrapping info for a given stream. This will be used
463 * to interpret the stream's timestamps. If the new time base is invalid
464 * (numerator or denominator are non-positive), it leaves the stream
468 * @param pts_wrap_bits number of bits effectively used by the pts
469 * (used for wrap control)
470 * @param pts_num time base numerator
471 * @param pts_den time base denominator
473 void avpriv_set_pts_info(AVStream *s, int pts_wrap_bits,
474 unsigned int pts_num, unsigned int pts_den);
477 * Add side data to a packet for changing parameters to the given values.
478 * Parameters set to 0 aren't included in the change.
480 int ff_add_param_change(AVPacket *pkt, int32_t channels,
481 uint64_t channel_layout, int32_t sample_rate,
482 int32_t width, int32_t height);
485 * Set the timebase for each stream from the corresponding codec timebase and
488 int ff_framehash_write_header(AVFormatContext *s);
491 * Read a transport packet from a media file.
493 * @param s media file handle
494 * @param pkt is filled
495 * @return 0 if OK, AVERROR_xxx on error
497 int ff_read_packet(AVFormatContext *s, AVPacket *pkt);
500 * Interleave a packet per dts in an output media file.
502 * Packets with pkt->destruct == av_destruct_packet will be freed inside this
503 * function, so they cannot be used after it. Note that calling av_packet_unref()
504 * on them is still safe.
506 * @param s media file handle
507 * @param out the interleaved packet will be output here
508 * @param pkt the input packet
509 * @param flush 1 if no further packets are available as input and all
510 * remaining packets should be output
511 * @return 1 if a packet was output, 0 if no packet could be output,
512 * < 0 if an error occurred
514 int ff_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
515 AVPacket *pkt, int flush);
517 void ff_free_stream(AVFormatContext *s, AVStream *st);
520 * Return the frame duration in seconds. Return 0 if not available.
522 void ff_compute_frame_duration(AVFormatContext *s, int *pnum, int *pden, AVStream *st,
523 AVCodecParserContext *pc, AVPacket *pkt);
525 unsigned int ff_codec_get_tag(const AVCodecTag *tags, enum AVCodecID id);
527 enum AVCodecID ff_codec_get_id(const AVCodecTag *tags, unsigned int tag);
530 * Select a PCM codec based on the given parameters.
532 * @param bps bits-per-sample
533 * @param flt floating-point
534 * @param be big-endian
535 * @param sflags signed flags. each bit corresponds to one byte of bit depth.
536 * e.g. the 1st bit indicates if 8-bit should be signed or
537 * unsigned, the 2nd bit indicates if 16-bit should be signed or
538 * unsigned, etc... This is useful for formats such as WAVE where
539 * only 8-bit is unsigned and all other bit depths are signed.
540 * @return a PCM codec id or AV_CODEC_ID_NONE
542 enum AVCodecID ff_get_pcm_codec_id(int bps, int flt, int be, int sflags);
545 * Chooses a timebase for muxing the specified stream.
547 * The chosen timebase allows sample accurate timestamps based
548 * on the framerate or sample rate for audio streams. It also is
549 * at least as precise as 1/min_precision would be.
551 AVRational ff_choose_timebase(AVFormatContext *s, AVStream *st, int min_precision);
554 * Chooses a timebase for muxing the specified stream.
556 enum AVChromaLocation ff_choose_chroma_location(AVFormatContext *s, AVStream *st);
559 * Generate standard extradata for AVC-Intra based on width/height and field
562 int ff_generate_avci_extradata(AVStream *st);
565 * Add a bitstream filter to a stream.
567 * @param st output stream to add a filter to
568 * @param name the name of the filter to add
569 * @param args filter-specific argument string
570 * @return >0 on success;
571 * AVERROR code on failure
573 int ff_stream_add_bitstream_filter(AVStream *st, const char *name, const char *args);
576 * Copy encoding parameters from source to destination stream
578 * @param dst pointer to destination AVStream
579 * @param src pointer to source AVStream
580 * @return >=0 on success, AVERROR code on error
582 int ff_stream_encode_params_copy(AVStream *dst, const AVStream *src);
585 * Wrap errno on rename() error.
587 * @param oldpath source path
588 * @param newpath destination path
589 * @return 0 or AVERROR on failure
591 static inline int ff_rename(const char *oldpath, const char *newpath, void *logctx)
594 if (rename(oldpath, newpath) == -1) {
595 ret = AVERROR(errno);
597 char err[AV_ERROR_MAX_STRING_SIZE] = {0};
598 av_make_error_string(err, AV_ERROR_MAX_STRING_SIZE, ret);
599 av_log(logctx, AV_LOG_ERROR, "failed to rename file %s to %s: %s\n", oldpath, newpath, err);
606 * Allocate extradata with additional AV_INPUT_BUFFER_PADDING_SIZE at end
607 * which is always set to 0.
609 * Previously allocated extradata in par will be freed.
611 * @param size size of extradata
612 * @return 0 if OK, AVERROR_xxx on error
614 int ff_alloc_extradata(AVCodecParameters *par, int size);
617 * Allocate extradata with additional AV_INPUT_BUFFER_PADDING_SIZE at end
618 * which is always set to 0 and fill it from pb.
620 * @param size size of extradata
621 * @return >= 0 if OK, AVERROR_xxx on error
623 int ff_get_extradata(AVFormatContext *s, AVCodecParameters *par, AVIOContext *pb, int size);
626 * add frame for rfps calculation.
628 * @param dts timestamp of the i-th frame
629 * @return 0 if OK, AVERROR_xxx on error
631 int ff_rfps_add_frame(AVFormatContext *ic, AVStream *st, int64_t dts);
633 void ff_rfps_calculate(AVFormatContext *ic);
636 * Flags for AVFormatContext.write_uncoded_frame()
638 enum AVWriteUncodedFrameFlags {
641 * Query whether the feature is possible on this stream.
642 * The frame argument is ignored.
644 AV_WRITE_UNCODED_FRAME_QUERY = 0x0001,
649 * Copies the whilelists from one context to the other
651 int ff_copy_whiteblacklists(AVFormatContext *dst, const AVFormatContext *src);
653 int ffio_open2_wrapper(struct AVFormatContext *s, AVIOContext **pb, const char *url, int flags,
654 const AVIOInterruptCB *int_cb, AVDictionary **options);
657 * Returned by demuxers to indicate that data was consumed but discarded
658 * (ignored streams or junk data). The framework will re-call the demuxer.
660 #define FFERROR_REDO FFERRTAG('R','E','D','O')
663 * Utility function to open IO stream of output format.
665 * @param s AVFormatContext
666 * @param url URL or file name to open for writing
667 * @options optional options which will be passed to io_open callback
668 * @return >=0 on success, negative AVERROR in case of failure
670 int ff_format_output_open(AVFormatContext *s, const char *url, AVDictionary **options);
673 * A wrapper around AVFormatContext.io_close that should be used
674 * instead of calling the pointer directly.
676 void ff_format_io_close(AVFormatContext *s, AVIOContext **pb);
679 * Utility function to check if the file uses http or https protocol
681 * @param s AVFormatContext
682 * @param filename URL or file name to open for writing
684 int ff_is_http_proto(char *filename);
687 * Parse creation_time in AVFormatContext metadata if exists and warn if the
690 * @param s AVFormatContext
691 * @param timestamp parsed timestamp in microseconds, only set on successful parsing
692 * @param return_seconds set this to get the number of seconds in timestamp instead of microseconds
693 * @return 1 if OK, 0 if the metadata was not present, AVERROR(EINVAL) on parse error
695 int ff_parse_creation_time_metadata(AVFormatContext *s, int64_t *timestamp, int return_seconds);
698 * Standardize creation_time metadata in AVFormatContext to an ISO-8601
701 * @param s AVFormatContext
702 * @return <0 on error
704 int ff_standardize_creation_time(AVFormatContext *s);
706 #define CONTAINS_PAL 2
708 * Reshuffles the lines to use the user specified stride.
710 * @param ppkt input and output packet
711 * @return negative error code or
712 * 0 if no new packet was allocated
713 * non-zero if a new packet was allocated and ppkt has to be freed
714 * CONTAINS_PAL if in addition to a new packet the old contained a palette
716 int ff_reshuffle_raw_rgb(AVFormatContext *s, AVPacket **ppkt, AVCodecParameters *par, int expected_stride);
719 * Retrieves the palette from a packet, either from side data, or
720 * appended to the video data in the packet itself (raw video only).
721 * It is commonly used after a call to ff_reshuffle_raw_rgb().
723 * Use 0 for the ret parameter to check for side data only.
725 * @param pkt pointer to packet before calling ff_reshuffle_raw_rgb()
726 * @param ret return value from ff_reshuffle_raw_rgb(), or 0
727 * @param palette pointer to palette buffer
728 * @return negative error code or
729 * 1 if the packet has a palette, else 0
731 int ff_get_packet_palette(AVFormatContext *s, AVPacket *pkt, int ret, uint32_t *palette);
734 * Finalize buf into extradata and set its size appropriately.
736 int ff_bprint_to_codecpar_extradata(AVCodecParameters *par, struct AVBPrint *buf);
739 * Find the next packet in the interleaving queue for the given stream.
740 * The pkt parameter is filled in with the queued packet, including
741 * references to the data (which the caller is not allowed to keep or
744 * @return 0 if a packet was found, a negative value if no packet was found
746 int ff_interleaved_peek(AVFormatContext *s, int stream,
747 AVPacket *pkt, int add_offset);
750 int ff_lock_avformat(void);
751 int ff_unlock_avformat(void);
754 * Set AVFormatContext url field to the provided pointer. The pointer must
755 * point to a valid string. The existing url field is freed if necessary. Also
756 * set the legacy filename field to the same string which was provided in url.
758 void ff_format_set_url(AVFormatContext *s, char *url);
760 #define FF_PACKETLIST_FLAG_REF_PACKET (1 << 0) /**< Create a new reference for the packet instead of
761 transferring the ownership of the existing one to the
765 * Append an AVPacket to the list.
767 * @param head List head element
768 * @param tail List tail element
769 * @param pkt The packet being appended
770 * @param flags Any combination of FF_PACKETLIST_FLAG_* flags
771 * @return 0 on success, negative AVERROR value on failure. On failure,
772 the list is unchanged
774 int ff_packet_list_put(AVPacketList **head, AVPacketList **tail,
775 AVPacket *pkt, int flags);
778 * Remove the oldest AVPacket in the list and return it.
780 * @note The pkt will be overwritten completely. The caller owns the
781 * packet and must unref it by itself.
783 * @param head List head element
784 * @param tail List tail element
785 * @param pkt Pointer to an initialized AVPacket struct
787 int ff_packet_list_get(AVPacketList **head, AVPacketList **tail,
791 * Wipe the list and unref all the packets in it.
793 * @param head List head element
794 * @param tail List tail element
796 void ff_packet_list_free(AVPacketList **head, AVPacketList **tail);
798 void avpriv_register_devices(const AVOutputFormat * const o[], const AVInputFormat * const i[]);
800 #endif /* AVFORMAT_INTERNAL_H */