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 filters to run on stream
156 * - encoding: Set by muxer using ff_stream_add_bitstream_filter
159 AVBSFContext **bsfcs;
163 * Whether or not check_bitstream should still be run on each packet
165 int bitstream_checked;
168 * The codec context used by avformat_find_stream_info, the parser, etc.
170 AVCodecContext *avctx;
172 * 1 if avctx has been initialized with the values from the codec parameters
176 enum AVCodecID orig_codec_id;
178 /* the context for extracting extradata in find_stream_info()
179 * inited=1/bsf=NULL signals that extracting is not possible (codec not
188 * Whether the internal avctx needs to be updated from codecpar (after a late change to codecpar)
190 int need_context_update;
196 #define dynarray_add(tab, nb_ptr, elem)\
198 __typeof__(tab) _tab = (tab);\
199 __typeof__(elem) _elem = (elem);\
200 (void)sizeof(**_tab == _elem); /* check that types are compatible */\
201 av_dynarray_add(_tab, nb_ptr, _elem);\
204 #define dynarray_add(tab, nb_ptr, elem)\
206 av_dynarray_add((tab), nb_ptr, (elem));\
210 struct tm *ff_brktimegm(time_t secs, struct tm *tm);
213 * Automatically create sub-directories
215 * @param path will create sub-directories by path
216 * @return 0, or < 0 on error
218 int ff_mkdir_p(const char *path);
220 char *ff_data_to_hex(char *buf, const uint8_t *src, int size, int lowercase);
223 * Parse a string of hexadecimal strings. Any space between the hexadecimal
226 * @param data if non-null, the parsed data is written to this pointer
227 * @param p the string to parse
228 * @return the number of bytes written (or to be written, if data is null)
230 int ff_hex_to_data(uint8_t *data, const char *p);
233 * Add packet to AVFormatContext->packet_buffer list, determining its
234 * interleaved position using compare() function argument.
235 * @return 0, or < 0 on error
237 int ff_interleave_add_packet(AVFormatContext *s, AVPacket *pkt,
238 int (*compare)(AVFormatContext *, const AVPacket *, const AVPacket *));
240 void ff_read_frame_flush(AVFormatContext *s);
242 #define NTP_OFFSET 2208988800ULL
243 #define NTP_OFFSET_US (NTP_OFFSET * 1000000ULL)
245 /** Get the current time since NTP epoch in microseconds. */
246 uint64_t ff_ntp_time(void);
249 * Get the NTP time stamp formatted as per the RFC-5905.
251 * @param ntp_time NTP time in micro seconds (since NTP epoch)
252 * @return the formatted NTP time stamp
254 uint64_t ff_get_formatted_ntp_time(uint64_t ntp_time_us);
257 * Append the media-specific SDP fragment for the media stream c
258 * to the buffer buff.
260 * Note, the buffer needs to be initialized, since it is appended to
263 * @param buff the buffer to append the SDP fragment to
264 * @param size the size of the buff buffer
265 * @param st the AVStream of the media to describe
266 * @param idx the global stream index
267 * @param dest_addr the destination address of the media stream, may be NULL
268 * @param dest_type the destination address type, may be NULL
269 * @param port the destination port of the media stream, 0 if unknown
270 * @param ttl the time to live of the stream, 0 if not multicast
271 * @param fmt the AVFormatContext, which might contain options modifying
274 void ff_sdp_write_media(char *buff, int size, AVStream *st, int idx,
275 const char *dest_addr, const char *dest_type,
276 int port, int ttl, AVFormatContext *fmt);
279 * Write a packet to another muxer than the one the user originally
280 * intended. Useful when chaining muxers, where one muxer internally
281 * writes a received packet to another muxer.
283 * @param dst the muxer to write the packet to
284 * @param dst_stream the stream index within dst to write the packet to
285 * @param pkt the packet to be written
286 * @param src the muxer the packet originally was intended for
287 * @param interleave 0->use av_write_frame, 1->av_interleaved_write_frame
288 * @return the value av_write_frame returned
290 int ff_write_chained(AVFormatContext *dst, int dst_stream, AVPacket *pkt,
291 AVFormatContext *src, int interleave);
294 * Get the length in bytes which is needed to store val as v.
296 int ff_get_v_length(uint64_t val);
299 * Put val using a variable number of bytes.
301 void ff_put_v(AVIOContext *bc, uint64_t val);
304 * Read a whole line of text from AVIOContext. Stop reading after reaching
305 * either a \\n, a \\0 or EOF. The returned string is always \\0-terminated,
306 * and may be truncated if the buffer is too small.
308 * @param s the read-only AVIOContext
309 * @param buf buffer to store the read line
310 * @param maxlen size of the buffer
311 * @return the length of the string written in the buffer, not including the
314 int ff_get_line(AVIOContext *s, char *buf, int maxlen);
317 * Same as ff_get_line but strip the white-space characters in the text tail
319 * @param s the read-only AVIOContext
320 * @param buf buffer to store the read line
321 * @param maxlen size of the buffer
322 * @return the length of the string written in the buffer
324 int ff_get_chomp_line(AVIOContext *s, char *buf, int maxlen);
327 * Read a whole line of text from AVIOContext to an AVBPrint buffer. Stop
328 * reading after reaching a \\r, a \\n, a \\r\\n, a \\0 or EOF. The line
329 * ending characters are NOT included in the buffer, but they are skipped on
332 * @param s the read-only AVIOContext
333 * @param bp the AVBPrint buffer
334 * @return the length of the read line, not including the line endings,
337 int64_t ff_read_line_to_bprint(AVIOContext *s, AVBPrint *bp);
340 * Read a whole line of text from AVIOContext to an AVBPrint buffer overwriting
341 * its contents. Stop reading after reaching a \\r, a \\n, a \\r\\n, a \\0 or
342 * EOF. The line ending characters are NOT included in the buffer, but they
343 * are skipped on the input.
345 * @param s the read-only AVIOContext
346 * @param bp the AVBPrint buffer
347 * @return the length of the read line not including the line endings,
348 * negative on error, or if the buffer becomes truncated.
350 int64_t ff_read_line_to_bprint_overwrite(AVIOContext *s, AVBPrint *bp);
352 #define SPACE_CHARS " \t\r\n"
355 * Callback function type for ff_parse_key_value.
357 * @param key a pointer to the key
358 * @param key_len the number of bytes that belong to the key, including the '='
360 * @param dest return the destination pointer for the value in *dest, may
361 * be null to ignore the value
362 * @param dest_len the length of the *dest buffer
364 typedef void (*ff_parse_key_val_cb)(void *context, const char *key,
365 int key_len, char **dest, int *dest_len);
367 * Parse a string with comma-separated key=value pairs. The value strings
368 * may be quoted and may contain escaped characters within quoted strings.
370 * @param str the string to parse
371 * @param callback_get_buf function that returns where to store the
372 * unescaped value string.
373 * @param context the opaque context pointer to pass to callback_get_buf
375 void ff_parse_key_value(const char *str, ff_parse_key_val_cb callback_get_buf,
379 * Find stream index based on format-specific stream ID
380 * @return stream index, or < 0 on error
382 int ff_find_stream_index(AVFormatContext *s, int id);
385 * Internal version of av_index_search_timestamp
387 int ff_index_search_timestamp(const AVIndexEntry *entries, int nb_entries,
388 int64_t wanted_timestamp, int flags);
391 * Internal version of av_add_index_entry
393 int ff_add_index_entry(AVIndexEntry **index_entries,
394 int *nb_index_entries,
395 unsigned int *index_entries_allocated_size,
396 int64_t pos, int64_t timestamp, int size, int distance, int flags);
398 void ff_configure_buffers_for_index(AVFormatContext *s, int64_t time_tolerance);
403 * @param s media file handle
404 * @param id unique ID for this chapter
405 * @param start chapter start time in time_base units
406 * @param end chapter end time in time_base units
407 * @param title chapter title
409 * @return AVChapter or NULL on error
411 AVChapter *avpriv_new_chapter(AVFormatContext *s, int id, AVRational time_base,
412 int64_t start, int64_t end, const char *title);
415 * Ensure the index uses less memory than the maximum specified in
416 * AVFormatContext.max_index_size by discarding entries if it grows
419 void ff_reduce_index(AVFormatContext *s, int stream_index);
421 enum AVCodecID ff_guess_image2_codec(const char *filename);
424 * Perform a binary search using av_index_search_timestamp() and
425 * AVInputFormat.read_timestamp().
427 * @param target_ts target timestamp in the time base of the given stream
428 * @param stream_index stream number
430 int ff_seek_frame_binary(AVFormatContext *s, int stream_index,
431 int64_t target_ts, int flags);
434 * Update cur_dts of all streams based on the given timestamp and AVStream.
436 * Stream ref_st unchanged, others set cur_dts in their native time base.
437 * Only needed for timestamp wrapping or if (dts not set and pts!=dts).
438 * @param timestamp new dts expressed in time_base of param ref_st
439 * @param ref_st reference stream giving time_base of param timestamp
441 void ff_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
443 int ff_find_last_ts(AVFormatContext *s, int stream_index, int64_t *ts, int64_t *pos,
444 int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
447 * Perform a binary search using read_timestamp().
449 * @param target_ts target timestamp in the time base of the given stream
450 * @param stream_index stream number
452 int64_t ff_gen_search(AVFormatContext *s, int stream_index,
453 int64_t target_ts, int64_t pos_min,
454 int64_t pos_max, int64_t pos_limit,
455 int64_t ts_min, int64_t ts_max,
456 int flags, int64_t *ts_ret,
457 int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
460 * Set the time base and wrapping info for a given stream. This will be used
461 * to interpret the stream's timestamps. If the new time base is invalid
462 * (numerator or denominator are non-positive), it leaves the stream
466 * @param pts_wrap_bits number of bits effectively used by the pts
467 * (used for wrap control)
468 * @param pts_num time base numerator
469 * @param pts_den time base denominator
471 void avpriv_set_pts_info(AVStream *s, int pts_wrap_bits,
472 unsigned int pts_num, unsigned int pts_den);
475 * Add side data to a packet for changing parameters to the given values.
476 * Parameters set to 0 aren't included in the change.
478 int ff_add_param_change(AVPacket *pkt, int32_t channels,
479 uint64_t channel_layout, int32_t sample_rate,
480 int32_t width, int32_t height);
483 * Set the timebase for each stream from the corresponding codec timebase and
486 int ff_framehash_write_header(AVFormatContext *s);
489 * Read a transport packet from a media file.
491 * @param s media file handle
492 * @param pkt is filled
493 * @return 0 if OK, AVERROR_xxx on error
495 int ff_read_packet(AVFormatContext *s, AVPacket *pkt);
498 * Interleave a packet per dts in an output media file.
500 * Packets with pkt->destruct == av_destruct_packet will be freed inside this
501 * function, so they cannot be used after it. Note that calling av_packet_unref()
502 * on them is still safe.
504 * @param s media file handle
505 * @param out the interleaved packet will be output here
506 * @param pkt the input packet
507 * @param flush 1 if no further packets are available as input and all
508 * remaining packets should be output
509 * @return 1 if a packet was output, 0 if no packet could be output,
510 * < 0 if an error occurred
512 int ff_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
513 AVPacket *pkt, int flush);
515 void ff_free_stream(AVFormatContext *s, AVStream *st);
518 * Return the frame duration in seconds. Return 0 if not available.
520 void ff_compute_frame_duration(AVFormatContext *s, int *pnum, int *pden, AVStream *st,
521 AVCodecParserContext *pc, AVPacket *pkt);
523 unsigned int ff_codec_get_tag(const AVCodecTag *tags, enum AVCodecID id);
525 enum AVCodecID ff_codec_get_id(const AVCodecTag *tags, unsigned int tag);
528 * Select a PCM codec based on the given parameters.
530 * @param bps bits-per-sample
531 * @param flt floating-point
532 * @param be big-endian
533 * @param sflags signed flags. each bit corresponds to one byte of bit depth.
534 * e.g. the 1st bit indicates if 8-bit should be signed or
535 * unsigned, the 2nd bit indicates if 16-bit should be signed or
536 * unsigned, etc... This is useful for formats such as WAVE where
537 * only 8-bit is unsigned and all other bit depths are signed.
538 * @return a PCM codec id or AV_CODEC_ID_NONE
540 enum AVCodecID ff_get_pcm_codec_id(int bps, int flt, int be, int sflags);
543 * Chooses a timebase for muxing the specified stream.
545 * The chosen timebase allows sample accurate timestamps based
546 * on the framerate or sample rate for audio streams. It also is
547 * at least as precise as 1/min_precision would be.
549 AVRational ff_choose_timebase(AVFormatContext *s, AVStream *st, int min_precision);
552 * Chooses a timebase for muxing the specified stream.
554 enum AVChromaLocation ff_choose_chroma_location(AVFormatContext *s, AVStream *st);
557 * Generate standard extradata for AVC-Intra based on width/height and field
560 int ff_generate_avci_extradata(AVStream *st);
563 * Add a bitstream filter to a stream.
565 * @param st output stream to add a filter to
566 * @param name the name of the filter to add
567 * @param args filter-specific argument string
568 * @return >0 on success;
569 * AVERROR code on failure
571 int ff_stream_add_bitstream_filter(AVStream *st, const char *name, const char *args);
574 * Copy encoding parameters from source to destination stream
576 * @param dst pointer to destination AVStream
577 * @param src pointer to source AVStream
578 * @return >=0 on success, AVERROR code on error
580 int ff_stream_encode_params_copy(AVStream *dst, const AVStream *src);
583 * Wrap avpriv_io_move and log if error happens.
585 * @param url_src source path
586 * @param url_dst destination path
587 * @return 0 or AVERROR on failure
589 int ff_rename(const char *url_src, const char *url_dst, void *logctx);
592 * Allocate extradata with additional AV_INPUT_BUFFER_PADDING_SIZE at end
593 * which is always set to 0.
595 * Previously allocated extradata in par will be freed.
597 * @param size size of extradata
598 * @return 0 if OK, AVERROR_xxx on error
600 int ff_alloc_extradata(AVCodecParameters *par, int size);
603 * Allocate extradata with additional AV_INPUT_BUFFER_PADDING_SIZE at end
604 * which is always set to 0 and fill it from pb.
606 * @param size size of extradata
607 * @return >= 0 if OK, AVERROR_xxx on error
609 int ff_get_extradata(AVFormatContext *s, AVCodecParameters *par, AVIOContext *pb, int size);
612 * add frame for rfps calculation.
614 * @param dts timestamp of the i-th frame
615 * @return 0 if OK, AVERROR_xxx on error
617 int ff_rfps_add_frame(AVFormatContext *ic, AVStream *st, int64_t dts);
619 void ff_rfps_calculate(AVFormatContext *ic);
622 * Flags for AVFormatContext.write_uncoded_frame()
624 enum AVWriteUncodedFrameFlags {
627 * Query whether the feature is possible on this stream.
628 * The frame argument is ignored.
630 AV_WRITE_UNCODED_FRAME_QUERY = 0x0001,
635 * Copies the whilelists from one context to the other
637 int ff_copy_whiteblacklists(AVFormatContext *dst, const AVFormatContext *src);
640 * Returned by demuxers to indicate that data was consumed but discarded
641 * (ignored streams or junk data). The framework will re-call the demuxer.
643 #define FFERROR_REDO FFERRTAG('R','E','D','O')
646 * Utility function to open IO stream of output format.
648 * @param s AVFormatContext
649 * @param url URL or file name to open for writing
650 * @options optional options which will be passed to io_open callback
651 * @return >=0 on success, negative AVERROR in case of failure
653 int ff_format_output_open(AVFormatContext *s, const char *url, AVDictionary **options);
656 * A wrapper around AVFormatContext.io_close that should be used
657 * instead of calling the pointer directly.
659 void ff_format_io_close(AVFormatContext *s, AVIOContext **pb);
662 * Utility function to check if the file uses http or https protocol
664 * @param s AVFormatContext
665 * @param filename URL or file name to open for writing
667 int ff_is_http_proto(char *filename);
670 * Parse creation_time in AVFormatContext metadata if exists and warn if the
673 * @param s AVFormatContext
674 * @param timestamp parsed timestamp in microseconds, only set on successful parsing
675 * @param return_seconds set this to get the number of seconds in timestamp instead of microseconds
676 * @return 1 if OK, 0 if the metadata was not present, AVERROR(EINVAL) on parse error
678 int ff_parse_creation_time_metadata(AVFormatContext *s, int64_t *timestamp, int return_seconds);
681 * Standardize creation_time metadata in AVFormatContext to an ISO-8601
684 * @param s AVFormatContext
685 * @return <0 on error
687 int ff_standardize_creation_time(AVFormatContext *s);
689 #define CONTAINS_PAL 2
691 * Reshuffles the lines to use the user specified stride.
693 * @param ppkt input and output packet
694 * @return negative error code or
695 * 0 if no new packet was allocated
696 * non-zero if a new packet was allocated and ppkt has to be freed
697 * CONTAINS_PAL if in addition to a new packet the old contained a palette
699 int ff_reshuffle_raw_rgb(AVFormatContext *s, AVPacket **ppkt, AVCodecParameters *par, int expected_stride);
702 * Retrieves the palette from a packet, either from side data, or
703 * appended to the video data in the packet itself (raw video only).
704 * It is commonly used after a call to ff_reshuffle_raw_rgb().
706 * Use 0 for the ret parameter to check for side data only.
708 * @param pkt pointer to packet before calling ff_reshuffle_raw_rgb()
709 * @param ret return value from ff_reshuffle_raw_rgb(), or 0
710 * @param palette pointer to palette buffer
711 * @return negative error code or
712 * 1 if the packet has a palette, else 0
714 int ff_get_packet_palette(AVFormatContext *s, AVPacket *pkt, int ret, uint32_t *palette);
717 * Finalize buf into extradata and set its size appropriately.
719 int ff_bprint_to_codecpar_extradata(AVCodecParameters *par, struct AVBPrint *buf);
722 * Find the next packet in the interleaving queue for the given stream.
723 * The pkt parameter is filled in with the queued packet, including
724 * references to the data (which the caller is not allowed to keep or
727 * @return 0 if a packet was found, a negative value if no packet was found
729 int ff_interleaved_peek(AVFormatContext *s, int stream,
730 AVPacket *pkt, int add_offset);
733 int ff_lock_avformat(void);
734 int ff_unlock_avformat(void);
737 * Set AVFormatContext url field to the provided pointer. The pointer must
738 * point to a valid string. The existing url field is freed if necessary. Also
739 * set the legacy filename field to the same string which was provided in url.
741 void ff_format_set_url(AVFormatContext *s, char *url);
743 #define FF_PACKETLIST_FLAG_REF_PACKET (1 << 0) /**< Create a new reference for the packet instead of
744 transferring the ownership of the existing one to the
748 * Append an AVPacket to the list.
750 * @param head List head element
751 * @param tail List tail element
752 * @param pkt The packet being appended. The data described in it will
753 * be made reference counted if it isn't already.
754 * @param flags Any combination of FF_PACKETLIST_FLAG_* flags
755 * @return 0 on success, negative AVERROR value on failure. On failure,
756 the list is unchanged
758 int ff_packet_list_put(AVPacketList **head, AVPacketList **tail,
759 AVPacket *pkt, int flags);
762 * Remove the oldest AVPacket in the list and return it.
763 * The behaviour is undefined if the packet list is empty.
765 * @note The pkt will be overwritten completely. The caller owns the
766 * packet and must unref it by itself.
768 * @param head List head element
769 * @param tail List tail element
770 * @param pkt Pointer to an AVPacket struct
771 * @return 0 on success. Success is guaranteed
772 * if the packet list is not empty.
774 int ff_packet_list_get(AVPacketList **head, AVPacketList **tail,
778 * Wipe the list and unref all the packets in it.
780 * @param head List head element
781 * @param tail List tail element
783 void ff_packet_list_free(AVPacketList **head, AVPacketList **tail);
785 void avpriv_register_devices(const AVOutputFormat * const o[], const AVInputFormat * const i[]);
787 #endif /* AVFORMAT_INTERNAL_H */