FFmpeg
internal.h
Go to the documentation of this file.
1 /*
2  * copyright (c) 2001 Fabrice Bellard
3  *
4  * This file is part of FFmpeg.
5  *
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.
10  *
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.
15  *
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
19  */
20 
21 #ifndef AVFORMAT_INTERNAL_H
22 #define AVFORMAT_INTERNAL_H
23 
24 #include <stdint.h>
25 
26 #include "libavutil/bprint.h"
27 #include "avformat.h"
28 #include "os_support.h"
29 
30 #define MAX_URL_SIZE 4096
31 
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)
35 
36 #ifdef DEBUG
37 # define hex_dump_debug(class, buf, size) av_hex_dump_log(class, AV_LOG_DEBUG, buf, size)
38 #else
39 # define hex_dump_debug(class, buf, size) do { if (0) av_hex_dump_log(class, AV_LOG_DEBUG, buf, size); } while(0)
40 #endif
41 
42 typedef struct AVCodecTag {
43  enum AVCodecID id;
44  unsigned int tag;
45 } AVCodecTag;
46 
47 typedef struct CodecMime{
48  char str[32];
49  enum AVCodecID id;
50 } CodecMime;
51 
52 /*************************************************/
53 /* fractional numbers for exact pts handling */
54 
55 /**
56  * The exact value of the fractional number is: 'val + num / den'.
57  * num is assumed to be 0 <= num < den.
58  */
59 typedef struct FFFrac {
60  int64_t val, num, den;
61 } FFFrac;
62 
63 
65  /**
66  * Number of streams relevant for interleaving.
67  * Muxing only.
68  */
70 
71  /**
72  * This buffer is only needed when packets were already buffered but
73  * not decoded, for example to get the codec parameters in MPEG
74  * streams.
75  */
78 
79  /* av_seek_frame() support */
80  int64_t data_offset; /**< offset of the first packet */
81 
82  /**
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
86  * codec.
87  */
90  /**
91  * Packets split by the parser get queued here.
92  */
95  /**
96  * The generic code uses this as a temporary packet
97  * to parse packets; it may also be used for other means
98  * for short periods that are guaranteed not to overlap
99  * with calls to av_read_frame() (or ff_read_packet())
100  * or with each other.
101  * It may be used by demuxers as a replacement for
102  * stack packets (unless they call one of the aforementioned
103  * functions with their own AVFormatContext).
104  * Every user has to ensure that this packet is blank
105  * after using it.
106  */
108 
109  /**
110  * Used to hold temporary packets.
111  */
113  /**
114  * Remaining size available for raw_packet_buffer, in bytes.
115  */
116 #define RAW_PACKET_BUFFER_SIZE 2500000
118 
119  /**
120  * Offset to remap timestamps to be non-negative.
121  * Expressed in timebase units.
122  * @see AVStream.mux_ts_offset
123  */
124  int64_t offset;
125 
126  /**
127  * Timebase for the timestamp offset.
128  */
130 
131 #if FF_API_COMPUTE_PKT_FIELDS2
132  int missing_ts_warning;
133 #endif
134 
136 
138 
139  /**
140  * Timestamp of the end of the shortest stream.
141  */
142  int64_t shortest_end;
143 
144  /**
145  * Whether or not avformat_init_output has already been called
146  */
148 
149  /**
150  * Whether or not avformat_init_output fully initialized streams
151  */
153 
154  /**
155  * ID3v2 tag useful for MP3 demuxing
156  */
158 
159  /*
160  * Prefer the codec framerate for avg_frame_rate computation.
161  */
163 
164  /**
165  * Set if chapter ids are strictly monotonic.
166  */
168 };
169 
171  /**
172  * Set to 1 if the codec allows reordering, so pts can be different
173  * from dts.
174  */
175  int reorder;
176 
177  /**
178  * bitstream filter to run on stream
179  * - encoding: Set by muxer using ff_stream_add_bitstream_filter
180  * - decoding: unused
181  */
183 
184  /**
185  * Whether or not check_bitstream should still be run on each packet
186  */
188 
189  /**
190  * The codec context used by avformat_find_stream_info, the parser, etc.
191  */
193  /**
194  * 1 if avctx has been initialized with the values from the codec parameters
195  */
197 
198  enum AVCodecID orig_codec_id;
199 
200  /* the context for extracting extradata in find_stream_info()
201  * inited=1/bsf=NULL signals that extracting is not possible (codec not
202  * supported) */
203  struct {
205  int inited;
207 
208  /**
209  * Whether the internal avctx needs to be updated from codecpar (after a late change to codecpar)
210  */
212 
214 
216 
217 #define MAX_STD_TIMEBASES (30*12+30+3+6)
218  /**
219  * Stream information used internally by avformat_find_stream_info()
220  */
221  struct {
222  int64_t last_dts;
223  int64_t duration_gcd;
226  double (*duration_error)[2][MAX_STD_TIMEBASES];
230 
231  /**
232  * 0 -> decoder has not been searched for yet.
233  * >0 -> decoder found
234  * <0 -> decoder with codec_id == -found_decoder has not been found
235  */
237 
238  int64_t last_duration;
239 
240  /**
241  * Those are used for average framerate estimation.
242  */
243  int64_t fps_first_dts;
245  int64_t fps_last_dts;
247 
248  } *info;
249 
250  AVIndexEntry *index_entries; /**< Only used if the format does not
251  support seeking natively. */
254 
257 
258  /**
259  * stream probing state
260  * -1 -> probing finished
261  * 0 -> no probing requested
262  * rest -> perform probing with request_probe being the minimum score to accept.
263  */
265  /**
266  * Indicates that everything up to the next keyframe
267  * should be discarded.
268  */
270 
271  /**
272  * Number of samples to skip at the start of the frame decoded from the next packet.
273  */
275 
276  /**
277  * If not 0, the number of samples that should be skipped from the start of
278  * the stream (the samples are removed from packets with pts==0, which also
279  * assumes negative timestamps do not happen).
280  * Intended for use with formats such as mp3 with ad-hoc gapless audio
281  * support.
282  */
284 
285  /**
286  * If not 0, the first audio sample that should be discarded from the stream.
287  * This is broken by design (needs global sample count), but can't be
288  * avoided for broken by design formats such as mp3 with ad-hoc gapless
289  * audio support.
290  */
292 
293  /**
294  * The sample after last sample that is intended to be discarded after
295  * first_discard_sample. Works on frame boundaries only. Used to prevent
296  * early EOF if the gapless info is broken (considered concatenated mp3s).
297  */
299 
300  /**
301  * Number of internally decoded frames, used internally in libavformat, do not access
302  * its lifetime differs from info which is why it is not in that structure.
303  */
305 
306  /**
307  * Timestamp offset added to timestamps before muxing
308  */
309  int64_t mux_ts_offset;
310 
311  /**
312  * Internal data to check for wrapping of the time stamp
313  */
315 
316  /**
317  * Options for behavior, when a wrap is detected.
318  *
319  * Defined by AV_PTS_WRAP_ values.
320  *
321  * If correction is enabled, there are two possibilities:
322  * If the first time stamp is near the wrap point, the wrap offset
323  * will be subtracted, which will create negative time stamps.
324  * Otherwise the offset will be added.
325  */
327 
328  /**
329  * Internal data to prevent doing update_initial_durations() twice
330  */
332 
333 #define MAX_REORDER_DELAY 16
334 
335  /**
336  * Internal data to generate dts from pts
337  */
338  int64_t pts_reorder_error[MAX_REORDER_DELAY+1];
339  uint8_t pts_reorder_error_count[MAX_REORDER_DELAY+1];
340 
341  int64_t pts_buffer[MAX_REORDER_DELAY+1];
342 
343  /**
344  * Internal data to analyze DTS and detect faulty mpeg streams
345  */
349 
350  /**
351  * Internal data to inject global side data
352  */
354 
355  /**
356  * display aspect ratio (0 if unknown)
357  * - encoding: unused
358  * - decoding: Set by libavformat to calculate sample_aspect_ratio internally
359  */
361 
363 
364  /**
365  * last packet in packet_buffer for this stream when muxing.
366  */
368 };
369 
370 #ifdef __GNUC__
371 #define dynarray_add(tab, nb_ptr, elem)\
372 do {\
373  __typeof__(tab) _tab = (tab);\
374  __typeof__(elem) _elem = (elem);\
375  (void)sizeof(**_tab == _elem); /* check that types are compatible */\
376  av_dynarray_add(_tab, nb_ptr, _elem);\
377 } while(0)
378 #else
379 #define dynarray_add(tab, nb_ptr, elem)\
380 do {\
381  av_dynarray_add((tab), nb_ptr, (elem));\
382 } while(0)
383 #endif
384 
385 /**
386  * Automatically create sub-directories
387  *
388  * @param path will create sub-directories by path
389  * @return 0, or < 0 on error
390  */
391 int ff_mkdir_p(const char *path);
392 
393 char *ff_data_to_hex(char *buf, const uint8_t *src, int size, int lowercase);
394 
395 /**
396  * Parse a string of hexadecimal strings. Any space between the hexadecimal
397  * digits is ignored.
398  *
399  * @param data if non-null, the parsed data is written to this pointer
400  * @param p the string to parse
401  * @return the number of bytes written (or to be written, if data is null)
402  */
403 int ff_hex_to_data(uint8_t *data, const char *p);
404 
405 /**
406  * Add packet to an AVFormatContext's packet_buffer list, determining its
407  * interleaved position using compare() function argument.
408  * @return 0 on success, < 0 on error. pkt will always be blank on return.
409  */
411  int (*compare)(AVFormatContext *, const AVPacket *, const AVPacket *));
412 
414 
415 #define NTP_OFFSET 2208988800ULL
416 #define NTP_OFFSET_US (NTP_OFFSET * 1000000ULL)
417 
418 /** Get the current time since NTP epoch in microseconds. */
419 uint64_t ff_ntp_time(void);
420 
421 /**
422  * Get the NTP time stamp formatted as per the RFC-5905.
423  *
424  * @param ntp_time NTP time in micro seconds (since NTP epoch)
425  * @return the formatted NTP time stamp
426  */
427 uint64_t ff_get_formatted_ntp_time(uint64_t ntp_time_us);
428 
429 /**
430  * Parse the NTP time in micro seconds (since NTP epoch).
431  *
432  * @param ntp_ts NTP time stamp formatted as per the RFC-5905.
433  * @return the time in micro seconds (since NTP epoch)
434  */
435 uint64_t ff_parse_ntp_time(uint64_t ntp_ts);
436 
437 /**
438  * Append the media-specific SDP fragment for the media stream c
439  * to the buffer buff.
440  *
441  * Note, the buffer needs to be initialized, since it is appended to
442  * existing content.
443  *
444  * @param buff the buffer to append the SDP fragment to
445  * @param size the size of the buff buffer
446  * @param st the AVStream of the media to describe
447  * @param idx the global stream index
448  * @param dest_addr the destination address of the media stream, may be NULL
449  * @param dest_type the destination address type, may be NULL
450  * @param port the destination port of the media stream, 0 if unknown
451  * @param ttl the time to live of the stream, 0 if not multicast
452  * @param fmt the AVFormatContext, which might contain options modifying
453  * the generated SDP
454  */
455 void ff_sdp_write_media(char *buff, int size, AVStream *st, int idx,
456  const char *dest_addr, const char *dest_type,
457  int port, int ttl, AVFormatContext *fmt);
458 
459 /**
460  * Write a packet to another muxer than the one the user originally
461  * intended. Useful when chaining muxers, where one muxer internally
462  * writes a received packet to another muxer.
463  *
464  * @param dst the muxer to write the packet to
465  * @param dst_stream the stream index within dst to write the packet to
466  * @param pkt the packet to be written
467  * @param src the muxer the packet originally was intended for
468  * @param interleave 0->use av_write_frame, 1->av_interleaved_write_frame
469  * @return the value av_write_frame returned
470  */
471 int ff_write_chained(AVFormatContext *dst, int dst_stream, AVPacket *pkt,
473 
474 /**
475  * Read a whole line of text from AVIOContext. Stop reading after reaching
476  * either a \\n, a \\0 or EOF. The returned string is always \\0-terminated,
477  * and may be truncated if the buffer is too small.
478  *
479  * @param s the read-only AVIOContext
480  * @param buf buffer to store the read line
481  * @param maxlen size of the buffer
482  * @return the length of the string written in the buffer, not including the
483  * final \\0
484  */
485 int ff_get_line(AVIOContext *s, char *buf, int maxlen);
486 
487 /**
488  * Same as ff_get_line but strip the white-space characters in the text tail
489  *
490  * @param s the read-only AVIOContext
491  * @param buf buffer to store the read line
492  * @param maxlen size of the buffer
493  * @return the length of the string written in the buffer
494  */
495 int ff_get_chomp_line(AVIOContext *s, char *buf, int maxlen);
496 
497 /**
498  * Read a whole line of text from AVIOContext to an AVBPrint buffer. Stop
499  * reading after reaching a \\r, a \\n, a \\r\\n, a \\0 or EOF. The line
500  * ending characters are NOT included in the buffer, but they are skipped on
501  * the input.
502  *
503  * @param s the read-only AVIOContext
504  * @param bp the AVBPrint buffer
505  * @return the length of the read line, not including the line endings,
506  * negative on error.
507  */
508 int64_t ff_read_line_to_bprint(AVIOContext *s, AVBPrint *bp);
509 
510 /**
511  * Read a whole line of text from AVIOContext to an AVBPrint buffer overwriting
512  * its contents. Stop reading after reaching a \\r, a \\n, a \\r\\n, a \\0 or
513  * EOF. The line ending characters are NOT included in the buffer, but they
514  * are skipped on the input.
515  *
516  * @param s the read-only AVIOContext
517  * @param bp the AVBPrint buffer
518  * @return the length of the read line not including the line endings,
519  * negative on error, or if the buffer becomes truncated.
520  */
521 int64_t ff_read_line_to_bprint_overwrite(AVIOContext *s, AVBPrint *bp);
522 
523 #define SPACE_CHARS " \t\r\n"
524 
525 /**
526  * Callback function type for ff_parse_key_value.
527  *
528  * @param key a pointer to the key
529  * @param key_len the number of bytes that belong to the key, including the '='
530  * char
531  * @param dest return the destination pointer for the value in *dest, may
532  * be null to ignore the value
533  * @param dest_len the length of the *dest buffer
534  */
535 typedef void (*ff_parse_key_val_cb)(void *context, const char *key,
536  int key_len, char **dest, int *dest_len);
537 /**
538  * Parse a string with comma-separated key=value pairs. The value strings
539  * may be quoted and may contain escaped characters within quoted strings.
540  *
541  * @param str the string to parse
542  * @param callback_get_buf function that returns where to store the
543  * unescaped value string.
544  * @param context the opaque context pointer to pass to callback_get_buf
545  */
546 void ff_parse_key_value(const char *str, ff_parse_key_val_cb callback_get_buf,
547  void *context);
548 
549 /**
550  * Find stream index based on format-specific stream ID
551  * @return stream index, or < 0 on error
552  */
553 int ff_find_stream_index(AVFormatContext *s, int id);
554 
555 /**
556  * Internal version of av_index_search_timestamp
557  */
558 int ff_index_search_timestamp(const AVIndexEntry *entries, int nb_entries,
559  int64_t wanted_timestamp, int flags);
560 
561 /**
562  * Internal version of av_add_index_entry
563  */
564 int ff_add_index_entry(AVIndexEntry **index_entries,
565  int *nb_index_entries,
566  unsigned int *index_entries_allocated_size,
567  int64_t pos, int64_t timestamp, int size, int distance, int flags);
568 
569 void ff_configure_buffers_for_index(AVFormatContext *s, int64_t time_tolerance);
570 
571 /**
572  * Add a new chapter.
573  *
574  * @param s media file handle
575  * @param id unique ID for this chapter
576  * @param start chapter start time in time_base units
577  * @param end chapter end time in time_base units
578  * @param title chapter title
579  *
580  * @return AVChapter or NULL on error
581  */
582 #if FF_API_CHAPTER_ID_INT
584 #else
585 AVChapter *avpriv_new_chapter(AVFormatContext *s, int64_t id, AVRational time_base,
586 #endif
587  int64_t start, int64_t end, const char *title);
588 
589 /**
590  * Ensure the index uses less memory than the maximum specified in
591  * AVFormatContext.max_index_size by discarding entries if it grows
592  * too large.
593  */
594 void ff_reduce_index(AVFormatContext *s, int stream_index);
595 
596 enum AVCodecID ff_guess_image2_codec(const char *filename);
597 
598 /**
599  * Perform a binary search using av_index_search_timestamp() and
600  * AVInputFormat.read_timestamp().
601  *
602  * @param target_ts target timestamp in the time base of the given stream
603  * @param stream_index stream number
604  */
605 int ff_seek_frame_binary(AVFormatContext *s, int stream_index,
606  int64_t target_ts, int flags);
607 
608 /**
609  * Update cur_dts of all streams based on the given timestamp and AVStream.
610  *
611  * Stream ref_st unchanged, others set cur_dts in their native time base.
612  * Only needed for timestamp wrapping or if (dts not set and pts!=dts).
613  * @param timestamp new dts expressed in time_base of param ref_st
614  * @param ref_st reference stream giving time_base of param timestamp
615  */
616 void ff_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
617 
618 int ff_find_last_ts(AVFormatContext *s, int stream_index, int64_t *ts, int64_t *pos,
619  int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
620 
621 /**
622  * Perform a binary search using read_timestamp().
623  *
624  * @param target_ts target timestamp in the time base of the given stream
625  * @param stream_index stream number
626  */
627 int64_t ff_gen_search(AVFormatContext *s, int stream_index,
628  int64_t target_ts, int64_t pos_min,
629  int64_t pos_max, int64_t pos_limit,
630  int64_t ts_min, int64_t ts_max,
631  int flags, int64_t *ts_ret,
632  int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
633 
634 /**
635  * Set the time base and wrapping info for a given stream. This will be used
636  * to interpret the stream's timestamps. If the new time base is invalid
637  * (numerator or denominator are non-positive), it leaves the stream
638  * unchanged.
639  *
640  * @param s stream
641  * @param pts_wrap_bits number of bits effectively used by the pts
642  * (used for wrap control)
643  * @param pts_num time base numerator
644  * @param pts_den time base denominator
645  */
646 void avpriv_set_pts_info(AVStream *s, int pts_wrap_bits,
647  unsigned int pts_num, unsigned int pts_den);
648 
649 /**
650  * Add side data to a packet for changing parameters to the given values.
651  * Parameters set to 0 aren't included in the change.
652  */
654  uint64_t channel_layout, int32_t sample_rate,
656 
657 /**
658  * Set the timebase for each stream from the corresponding codec timebase and
659  * print it.
660  */
662 
663 /**
664  * Read a transport packet from a media file.
665  *
666  * @param s media file handle
667  * @param pkt is filled
668  * @return 0 if OK, AVERROR_xxx on error
669  */
671 
672 /**
673  * Add an attached pic to an AVStream.
674  *
675  * @param st if set, the stream to add the attached pic to;
676  * if unset, a new stream will be added to s.
677  * @param pb AVIOContext to read data from if buf is unset.
678  * @param buf if set, it contains the data and size information to be used
679  * for the attached pic; if unset, data is read from pb.
680  * @param size the size of the data to read if buf is unset.
681  *
682  * @return 0 on success, < 0 on error. On error, this function removes
683  * the stream it has added (if any).
684  */
686  AVBufferRef **buf, int size);
687 
688 /**
689  * Interleave an AVPacket per dts so it can be muxed.
690  *
691  * @param s an AVFormatContext for output. pkt resp. out will be added to
692  * resp. taken from its packet buffer.
693  * @param out the interleaved packet will be output here
694  * @param pkt the input packet; will be blank on return if not NULL
695  * @param flush 1 if no further packets are available as input and all
696  * remaining packets should be output
697  * @return 1 if a packet was output, 0 if no packet could be output
698  * (in which case out may be uninitialized), < 0 if an error occurred
699  */
701  AVPacket *pkt, int flush);
702 
704 
705 /**
706  * Return the frame duration in seconds. Return 0 if not available.
707  */
708 void ff_compute_frame_duration(AVFormatContext *s, int *pnum, int *pden, AVStream *st,
709  AVCodecParserContext *pc, AVPacket *pkt);
710 
711 unsigned int ff_codec_get_tag(const AVCodecTag *tags, enum AVCodecID id);
712 
713 enum AVCodecID ff_codec_get_id(const AVCodecTag *tags, unsigned int tag);
714 
715 int ff_is_intra_only(enum AVCodecID id);
716 
717 /**
718  * Select a PCM codec based on the given parameters.
719  *
720  * @param bps bits-per-sample
721  * @param flt floating-point
722  * @param be big-endian
723  * @param sflags signed flags. each bit corresponds to one byte of bit depth.
724  * e.g. the 1st bit indicates if 8-bit should be signed or
725  * unsigned, the 2nd bit indicates if 16-bit should be signed or
726  * unsigned, etc... This is useful for formats such as WAVE where
727  * only 8-bit is unsigned and all other bit depths are signed.
728  * @return a PCM codec id or AV_CODEC_ID_NONE
729  */
730 enum AVCodecID ff_get_pcm_codec_id(int bps, int flt, int be, int sflags);
731 
732 /**
733  * Chooses a timebase for muxing the specified stream.
734  *
735  * The chosen timebase allows sample accurate timestamps based
736  * on the framerate or sample rate for audio streams. It also is
737  * at least as precise as 1/min_precision would be.
738  */
739 AVRational ff_choose_timebase(AVFormatContext *s, AVStream *st, int min_precision);
740 
741 /**
742  * Chooses a timebase for muxing the specified stream.
743  */
745 
746 /**
747  * Generate standard extradata for AVC-Intra based on width/height and field
748  * order.
749  */
751 
752 /**
753  * Add a bitstream filter to a stream.
754  *
755  * @param st output stream to add a filter to
756  * @param name the name of the filter to add
757  * @param args filter-specific argument string
758  * @return >0 on success;
759  * AVERROR code on failure
760  */
761 int ff_stream_add_bitstream_filter(AVStream *st, const char *name, const char *args);
762 
763 /**
764  * Copy encoding parameters from source to destination stream
765  *
766  * @param dst pointer to destination AVStream
767  * @param src pointer to source AVStream
768  * @return >=0 on success, AVERROR code on error
769  */
771 
772 /**
773  * Wrap avpriv_io_move and log if error happens.
774  *
775  * @param url_src source path
776  * @param url_dst destination path
777  * @return 0 or AVERROR on failure
778  */
779 int ff_rename(const char *url_src, const char *url_dst, void *logctx);
780 
781 /**
782  * Allocate extradata with additional AV_INPUT_BUFFER_PADDING_SIZE at end
783  * which is always set to 0.
784  *
785  * Previously allocated extradata in par will be freed.
786  *
787  * @param size size of extradata
788  * @return 0 if OK, AVERROR_xxx on error
789  */
791 
792 /**
793  * Allocate extradata with additional AV_INPUT_BUFFER_PADDING_SIZE at end
794  * which is always set to 0 and fill it from pb.
795  *
796  * @param size size of extradata
797  * @return >= 0 if OK, AVERROR_xxx on error
798  */
800 
801 /**
802  * add frame for rfps calculation.
803  *
804  * @param dts timestamp of the i-th frame
805  * @return 0 if OK, AVERROR_xxx on error
806  */
807 int ff_rfps_add_frame(AVFormatContext *ic, AVStream *st, int64_t dts);
808 
810 
811 /**
812  * Flags for AVFormatContext.write_uncoded_frame()
813  */
815 
816  /**
817  * Query whether the feature is possible on this stream.
818  * The frame argument is ignored.
819  */
821 
822 };
823 
824 /**
825  * Copies the whilelists from one context to the other
826  */
828 
829 /**
830  * Returned by demuxers to indicate that data was consumed but discarded
831  * (ignored streams or junk data). The framework will re-call the demuxer.
832  */
833 #define FFERROR_REDO FFERRTAG('R','E','D','O')
834 
835 /**
836  * Utility function to open IO stream of output format.
837  *
838  * @param s AVFormatContext
839  * @param url URL or file name to open for writing
840  * @options optional options which will be passed to io_open callback
841  * @return >=0 on success, negative AVERROR in case of failure
842  */
843 int ff_format_output_open(AVFormatContext *s, const char *url, AVDictionary **options);
844 
845 /*
846  * A wrapper around AVFormatContext.io_close that should be used
847  * instead of calling the pointer directly.
848  */
850 
851 /**
852  * Utility function to check if the file uses http or https protocol
853  *
854  * @param s AVFormatContext
855  * @param filename URL or file name to open for writing
856  */
857 int ff_is_http_proto(char *filename);
858 
859 /**
860  * Parse creation_time in AVFormatContext metadata if exists and warn if the
861  * parsing fails.
862  *
863  * @param s AVFormatContext
864  * @param timestamp parsed timestamp in microseconds, only set on successful parsing
865  * @param return_seconds set this to get the number of seconds in timestamp instead of microseconds
866  * @return 1 if OK, 0 if the metadata was not present, AVERROR(EINVAL) on parse error
867  */
868 int ff_parse_creation_time_metadata(AVFormatContext *s, int64_t *timestamp, int return_seconds);
869 
870 /**
871  * Standardize creation_time metadata in AVFormatContext to an ISO-8601
872  * timestamp string.
873  *
874  * @param s AVFormatContext
875  * @return <0 on error
876  */
878 
879 #define CONTAINS_PAL 2
880 /**
881  * Reshuffles the lines to use the user specified stride.
882  *
883  * @param ppkt input and output packet
884  * @return negative error code or
885  * 0 if no new packet was allocated
886  * non-zero if a new packet was allocated and ppkt has to be freed
887  * CONTAINS_PAL if in addition to a new packet the old contained a palette
888  */
889 int ff_reshuffle_raw_rgb(AVFormatContext *s, AVPacket **ppkt, AVCodecParameters *par, int expected_stride);
890 
891 /**
892  * Retrieves the palette from a packet, either from side data, or
893  * appended to the video data in the packet itself (raw video only).
894  * It is commonly used after a call to ff_reshuffle_raw_rgb().
895  *
896  * Use 0 for the ret parameter to check for side data only.
897  *
898  * @param pkt pointer to packet before calling ff_reshuffle_raw_rgb()
899  * @param ret return value from ff_reshuffle_raw_rgb(), or 0
900  * @param palette pointer to palette buffer
901  * @return negative error code or
902  * 1 if the packet has a palette, else 0
903  */
904 int ff_get_packet_palette(AVFormatContext *s, AVPacket *pkt, int ret, uint32_t *palette);
905 
906 /**
907  * Finalize buf into extradata and set its size appropriately.
908  */
909 int ff_bprint_to_codecpar_extradata(AVCodecParameters *par, struct AVBPrint *buf);
910 
911 /**
912  * Find the next packet in the interleaving queue for the given stream.
913  *
914  * @return a pointer to a packet if one was found, NULL otherwise.
915  */
916 const AVPacket *ff_interleaved_peek(AVFormatContext *s, int stream);
917 
918 int ff_get_muxer_ts_offset(AVFormatContext *s, int stream_index, int64_t *offset);
919 
920 int ff_lock_avformat(void);
921 int ff_unlock_avformat(void);
922 
923 /**
924  * Set AVFormatContext url field to the provided pointer. The pointer must
925  * point to a valid string. The existing url field is freed if necessary. Also
926  * set the legacy filename field to the same string which was provided in url.
927  */
928 void ff_format_set_url(AVFormatContext *s, char *url);
929 
930 void avpriv_register_devices(const AVOutputFormat * const o[], const AVInputFormat * const i[]);
931 
932 #endif /* AVFORMAT_INTERNAL_H */
int ff_framehash_write_header(AVFormatContext *s)
Set the timebase for each stream from the corresponding codec timebase and print it.
Definition: framehash.c:23
static float compare(const AVFrame *haystack, const AVFrame *obj, int offx, int offy)
Definition: vf_find_rect.c:106
uint8_t dts_ordered
Definition: internal.h:347
AVDictionary * id3v2_meta
ID3v2 tag useful for MP3 demuxing.
Definition: internal.h:157
AVBSFContext * bsfc
bitstream filter to run on stream
Definition: internal.h:182
Bytestream IO Context.
Definition: avio.h:161
enum AVCodecID id
Definition: internal.h:43
int ff_rename(const char *url_src, const char *url_dst, void *logctx)
Wrap avpriv_io_move and log if error happens.
Definition: avio.c:665
int bitstream_checked
Whether or not check_bitstream should still be run on each packet.
Definition: internal.h:187
ptrdiff_t const GLvoid * data
Definition: opengl_enc.c:100
FFFrac * priv_pts
Definition: internal.h:215
static void flush(AVCodecContext *avctx)
int64_t last_dts_for_order_check
Internal data to analyze DTS and detect faulty mpeg streams.
Definition: internal.h:346
enum AVCodecID ff_codec_get_id(const AVCodecTag *tags, unsigned int tag)
Definition: utils.c:3185
int reorder
Set to 1 if the codec allows reordering, so pts can be different from dts.
Definition: internal.h:175
AVPacket * pkt
Used to hold temporary packets.
Definition: internal.h:112
void avpriv_set_pts_info(AVStream *s, int pts_wrap_bits, unsigned int pts_num, unsigned int pts_den)
Set the time base and wrapping info for a given stream.
Definition: utils.c:4999
int ff_copy_whiteblacklists(AVFormatContext *dst, const AVFormatContext *src)
Copies the whilelists from one context to the other.
Definition: utils.c:160
static int extract_extradata(AVFormatContext *s, AVStream *st, const AVPacket *pkt)
Definition: utils.c:3586
int64_t data_offset
offset of the first packet
Definition: internal.h:80
int ff_write_chained(AVFormatContext *dst, int dst_stream, AVPacket *pkt, AVFormatContext *src, int interleave)
Write a packet to another muxer than the one the user originally intended.
Definition: mux.c:1328
int ff_mkdir_p(const char *path)
Automatically create sub-directories.
Definition: utils.c:4916
struct PacketList * packet_buffer
This buffer is only needed when packets were already buffered but not decoded, for example to get the...
Definition: internal.h:76
The bitstream filter state.
Definition: bsf.h:49
int prefer_codec_framerate
Definition: internal.h:162
#define MAX_REORDER_DELAY
Definition: internal.h:333
int64_t offset
Offset to remap timestamps to be non-negative.
Definition: internal.h:124
int skip_samples
Number of samples to skip at the start of the frame decoded from the next packet. ...
Definition: internal.h:274
const AVPacket * ff_interleaved_peek(AVFormatContext *s, int stream)
Find the next packet in the interleaving queue for the given stream.
Definition: mux.c:1066
unsigned int ff_codec_get_tag(const AVCodecTag *tags, enum AVCodecID id)
Definition: utils.c:3175
const char * key
int avoid_negative_ts_use_pts
Definition: internal.h:137
int ff_index_search_timestamp(const AVIndexEntry *entries, int nb_entries, int64_t wanted_timestamp, int flags)
Internal version of av_index_search_timestamp.
Definition: utils.c:2053
AVPacket * pkt
Definition: movenc.c:59
int ff_is_http_proto(char *filename)
Utility function to check if the file uses http or https protocol.
Definition: utils.c:5753
int64_t interleaver_chunk_size
Definition: internal.h:255
This struct describes the properties of an encoded stream.
Definition: codec_par.h:52
Format I/O context.
Definition: avformat.h:1247
void ff_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp)
Update cur_dts of all streams based on the given timestamp and AVStream.
Definition: utils.c:1958
static void interleave(uint8_t *dst, uint8_t *src, int w, int h, int dst_linesize, int src_linesize, enum FilterMode mode, int swap)
Definition: vf_il.c:114
void ff_read_frame_flush(AVFormatContext *s)
Flush the frame reader.
Definition: utils.c:1923
void ff_reduce_index(AVFormatContext *s, int stream_index)
Ensure the index uses less memory than the maximum specified in AVFormatContext.max_index_size by dis...
Definition: utils.c:1972
uint8_t
miscellaneous OS support macros and functions.
Query whether the feature is possible on this stream.
Definition: internal.h:820
it s the only field you need to keep assuming you have a context There is some magic you don t need to care about around this just let it vf offset
int64_t last_duration
Definition: internal.h:238
it s the only field you need to keep assuming you have a context There is some magic you don t need to care about around this just let it vf default minimum maximum flags name is the option keep it simple and lowercase description are in lowercase
The exact value of the fractional number is: &#39;val + num / den&#39;.
Definition: internal.h:59
void ff_format_io_close(AVFormatContext *s, AVIOContext **pb)
Definition: utils.c:5746
int64_t duration_gcd
Definition: internal.h:223
int64_t mux_ts_offset
Timestamp offset added to timestamps before muxing.
Definition: internal.h:309
void ff_compute_frame_duration(AVFormatContext *s, int *pnum, int *pden, AVStream *st, AVCodecParserContext *pc, AVPacket *pkt)
Return the frame duration in seconds.
Definition: utils.c:978
#define height
int ff_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out, AVPacket *pkt, int flush)
Interleave an AVPacket per dts so it can be muxed.
Definition: mux.c:932
int ff_format_output_open(AVFormatContext *s, const char *url, AVDictionary **options)
Utility function to open IO stream of output format.
Definition: utils.c:5736
void ff_configure_buffers_for_index(AVFormatContext *s, int64_t time_tolerance)
Definition: utils.c:2096
int ff_stream_encode_params_copy(AVStream *dst, const AVStream *src)
Copy encoding parameters from source to destination stream.
Definition: utils.c:4361
int ff_add_attached_pic(AVFormatContext *s, AVStream *st, AVIOContext *pb, AVBufferRef **buf, int size)
Add an attached pic to an AVStream.
Definition: utils.c:477
int frame_delay_evidence
Definition: internal.h:229
int inject_global_side_data
Internal data to inject global side data.
Definition: internal.h:353
int skip_to_keyframe
Indicates that everything up to the next keyframe should be discarded.
Definition: internal.h:269
ptrdiff_t size
Definition: opengl_enc.c:100
channels
Definition: aptx.h:33
int raw_packet_buffer_remaining_size
Definition: internal.h:117
void ff_rfps_calculate(AVFormatContext *ic)
Definition: utils.c:3462
uint64_t ff_ntp_time(void)
Get the current time since NTP epoch in microseconds.
Definition: utils.c:4754
#define src
Definition: vp8dsp.c:255
int avctx_inited
1 if avctx has been initialized with the values from the codec parameters
Definition: internal.h:196
int ff_parse_creation_time_metadata(AVFormatContext *s, int64_t *timestamp, int return_seconds)
Parse creation_time in AVFormatContext metadata if exists and warn if the parsing fails...
Definition: utils.c:5758
AVCodecID
Identify the syntax and semantics of the bitstream.
Definition: codec_id.h:46
uint64_t ff_parse_ntp_time(uint64_t ntp_ts)
Parse the NTP time in micro seconds (since NTP epoch).
Definition: utils.c:4781
unsigned int pos
Definition: spdifenc.c:412
int pts_wrap_behavior
Options for behavior, when a wrap is detected.
Definition: internal.h:326
AVPacket * parse_pkt
The generic code uses this as a temporary packet to parse packets; it may also be used for other mean...
Definition: internal.h:107
int request_probe
stream probing state -1 -> probing finished 0 -> no probing requested rest -> perform probing with re...
Definition: internal.h:264
int ff_add_param_change(AVPacket *pkt, int32_t channels, uint64_t channel_layout, int32_t sample_rate, int32_t width, int32_t height)
Add side data to a packet for changing parameters to the given values.
Definition: utils.c:5131
int ff_is_intra_only(enum AVCodecID id)
Definition: utils.c:1041
int ff_standardize_creation_time(AVFormatContext *s)
Standardize creation_time metadata in AVFormatContext to an ISO-8601 timestamp string.
Definition: utils.c:5775
int64_t val
Definition: internal.h:60
int update_initial_durations_done
Internal data to prevent doing update_initial_durations() twice.
Definition: internal.h:331
void avpriv_register_devices(const AVOutputFormat *const o[], const AVInputFormat *const i[])
Definition: allformats.c:668
static float distance(float x, float y, int band)
int streams_initialized
Whether or not avformat_init_output fully initialized streams.
Definition: internal.h:152
AVIndexEntry * index_entries
Only used if the format does not support seeking natively.
Definition: internal.h:250
int ff_generate_avci_extradata(AVStream *st)
Generate standard extradata for AVC-Intra based on width/height and field order.
Definition: utils.c:5424
MIPS optimizations info
Definition: mips.txt:2
int nb_decoded_frames
Number of internally decoded frames, used internally in libavformat, do not access its lifetime diffe...
Definition: internal.h:304
int ff_find_stream_index(AVFormatContext *s, int id)
Find stream index based on format-specific stream ID.
Definition: utils.c:5083
AVRational display_aspect_ratio
display aspect ratio (0 if unknown)
Definition: internal.h:360
int ff_alloc_extradata(AVCodecParameters *par, int size)
Allocate extradata with additional AV_INPUT_BUFFER_PADDING_SIZE at end which is always set to 0...
Definition: utils.c:3368
struct PacketList * last_in_packet_buffer
last packet in packet_buffer for this stream when muxing.
Definition: internal.h:367
int64_t shortest_end
Timestamp of the end of the shortest stream.
Definition: internal.h:142
int64_t codec_info_duration
Definition: internal.h:227
void ff_free_stream(AVFormatContext *s, AVStream *st)
Definition: utils.c:4472
void(* ff_parse_key_val_cb)(void *context, const char *key, int key_len, char **dest, int *dest_len)
Callback function type for ff_parse_key_value.
Definition: internal.h:535
int64_t codec_info_duration_fields
Definition: internal.h:228
AVChapter * avpriv_new_chapter(AVFormatContext *s, int64_t id, AVRational time_base, int64_t start, int64_t end, const char *title)
Add a new chapter.
Definition: utils.c:4686
#define width
typedef void(APIENTRY *FF_PFNGLACTIVETEXTUREPROC)(GLenum texture)
int ff_unlock_avformat(void)
Definition: utils.c:84
int ff_get_packet_palette(AVFormatContext *s, AVPacket *pkt, int ret, uint32_t *palette)
Retrieves the palette from a packet, either from side data, or appended to the video data in the pack...
Definition: utils.c:5784
int32_t
#define s(width, name)
Definition: cbs_vp9.c:257
void ff_format_set_url(AVFormatContext *s, char *url)
Set AVFormatContext url field to the provided pointer.
Definition: utils.c:5913
struct PacketList * raw_packet_buffer
Raw packets from the demuxer, prior to parsing and decoding.
Definition: internal.h:88
int64_t fps_first_dts
Those are used for average framerate estimation.
Definition: internal.h:243
int ff_read_packet(AVFormatContext *s, AVPacket *pkt)
Read a transport packet from a media file.
Definition: utils.c:846
struct PacketList * parse_queue
Packets split by the parser get queued here.
Definition: internal.h:93
Stream structure.
Definition: avformat.h:884
uint64_t ff_get_formatted_ntp_time(uint64_t ntp_time_us)
Get the NTP time stamp formatted as per the RFC-5905.
Definition: utils.c:4759
int ff_rfps_add_frame(AVFormatContext *ic, AVStream *st, int64_t dts)
add frame for rfps calculation.
Definition: utils.c:3402
sample_rate
int ff_add_index_entry(AVIndexEntry **index_entries, int *nb_index_entries, unsigned int *index_entries_allocated_size, int64_t pos, int64_t timestamp, int size, int distance, int flags)
Internal version of av_add_index_entry.
Definition: utils.c:1985
enum AVCodecID ff_guess_image2_codec(const char *filename)
Definition: img2.c:106
uint8_t dts_misordered
Definition: internal.h:348
int64_t last_discard_sample
The sample after last sample that is intended to be discarded after first_discard_sample.
Definition: internal.h:298
int found_decoder
0 -> decoder has not been searched for yet.
Definition: internal.h:236
int64_t start_skip_samples
If not 0, the number of samples that should be skipped from the start of the stream (the samples are ...
Definition: internal.h:283
int64_t first_discard_sample
If not 0, the first audio sample that should be discarded from the stream.
Definition: internal.h:291
main external API structure.
Definition: avcodec.h:536
int64_t pts_wrap_reference
Internal data to check for wrapping of the time stamp.
Definition: internal.h:314
it s the only field you need to keep assuming you have a context There is some magic you don t need to care about around this just let it be(in the first position) for now.Options-------Then comes the options array.This is what will define the user accessible options.For example
int ff_get_chomp_line(AVIOContext *s, char *buf, int maxlen)
Same as ff_get_line but strip the white-space characters in the text tail.
Definition: aviobuf.c:806
AVRational ff_choose_timebase(AVFormatContext *s, AVStream *st, int min_precision)
Chooses a timebase for muxing the specified stream.
Definition: mux.c:90
#define MAX_STD_TIMEBASES
Definition: internal.h:217
int fps_first_dts_idx
Definition: internal.h:244
int nb_interleaved_streams
Number of streams relevant for interleaving.
Definition: internal.h:69
int64_t ff_gen_search(AVFormatContext *s, int stream_index, int64_t target_ts, int64_t pos_min, int64_t pos_max, int64_t pos_limit, int64_t ts_min, int64_t ts_max, int flags, int64_t *ts_ret, int64_t(*read_timestamp)(struct AVFormatContext *, int, int64_t *, int64_t))
Perform a binary search using read_timestamp().
Definition: utils.c:2309
int initialized
Whether or not avformat_init_output has already been called.
Definition: internal.h:147
enum AVCodecID ff_get_pcm_codec_id(int bps, int flt, int be, int sflags)
Select a PCM codec based on the given parameters.
Definition: utils.c:3197
Rational number (pair of numerator and denominator).
Definition: rational.h:58
int64_t rfps_duration_sum
Definition: internal.h:225
int ff_bprint_to_codecpar_extradata(AVCodecParameters *par, struct AVBPrint *buf)
Finalize buf into extradata and set its size appropriately.
Definition: utils.c:5809
int need_context_update
Whether the internal avctx needs to be updated from codecpar (after a late change to codecpar) ...
Definition: internal.h:211
int fps_last_dts_idx
Definition: internal.h:246
int inject_global_side_data
Definition: internal.h:135
int64_t fps_last_dts
Definition: internal.h:245
This structure contains the data a format has to probe a file.
Definition: avformat.h:441
int ff_hex_to_data(uint8_t *data, const char *p)
Parse a string of hexadecimal strings.
Definition: utils.c:4971
unsigned int index_entries_allocated_size
Definition: internal.h:253
struct PacketList * packet_buffer_end
Definition: internal.h:77
int ff_find_last_ts(AVFormatContext *s, int stream_index, int64_t *ts, int64_t *pos, int64_t(*read_timestamp)(struct AVFormatContext *, int, int64_t *, int64_t))
Definition: utils.c:2271
int nb_index_entries
Definition: internal.h:252
#define flags(name, subs,...)
Definition: cbs_av1.c:561
void ff_parse_key_value(const char *str, ff_parse_key_val_cb callback_get_buf, void *context)
Parse a string with comma-separated key=value pairs.
Definition: utils.c:5029
enum AVChromaLocation ff_choose_chroma_location(AVFormatContext *s, AVStream *st)
Chooses a timebase for muxing the specified stream.
Definition: mux.c:106
unsigned int tag
Definition: internal.h:44
AVRational offset_timebase
Timebase for the timestamp offset.
Definition: internal.h:129
A reference to a data buffer.
Definition: buffer.h:84
Main libavformat public API header.
const OptionDef options[]
Definition: ffmpeg_opt.c:3427
void ff_sdp_write_media(char *buff, int size, AVStream *st, int idx, const char *dest_addr, const char *dest_type, int port, int ttl, AVFormatContext *fmt)
Append the media-specific SDP fragment for the media stream c to the buffer buff. ...
Definition: sdp.c:851
int ff_get_extradata(AVFormatContext *s, AVCodecParameters *par, AVIOContext *pb, int size)
Allocate extradata with additional AV_INPUT_BUFFER_PADDING_SIZE at end which is always set to 0 and f...
Definition: utils.c:3386
int64_t interleaver_chunk_duration
Definition: internal.h:256
unsigned bps
Definition: movenc.c:1601
AVWriteUncodedFrameFlags
Flags for AVFormatContext.write_uncoded_frame()
Definition: internal.h:814
int64_t last_dts
Definition: internal.h:222
int ff_stream_add_bitstream_filter(AVStream *st, const char *name, const char *args)
Add a bitstream filter to a stream.
Definition: utils.c:5630
int ff_reshuffle_raw_rgb(AVFormatContext *s, AVPacket **ppkt, AVCodecParameters *par, int expected_stride)
Reshuffles the lines to use the user specified stride.
Definition: rawutils.c:25
struct PacketList * parse_queue_end
Definition: internal.h:94
int64_t ff_read_line_to_bprint_overwrite(AVIOContext *s, AVBPrint *bp)
Read a whole line of text from AVIOContext to an AVBPrint buffer overwriting its contents.
Definition: aviobuf.c:845
AVProbeData probe_data
Definition: internal.h:362
AVCodecContext * avctx
The codec context used by avformat_find_stream_info, the parser, etc.
Definition: internal.h:192
int ff_lock_avformat(void)
Definition: utils.c:79
int chapter_ids_monotonic
Set if chapter ids are strictly monotonic.
Definition: internal.h:167
FILE * out
Definition: movenc.c:54
AVChromaLocation
Location of chroma samples.
Definition: pixfmt.h:605
int64_t ff_read_line_to_bprint(AVIOContext *s, AVBPrint *bp)
Read a whole line of text from AVIOContext to an AVBPrint buffer.
Definition: aviobuf.c:814
int ff_get_line(AVIOContext *s, char *buf, int maxlen)
Read a whole line of text from AVIOContext.
Definition: aviobuf.c:789
AVBSFContext * bsf
Definition: internal.h:204
it s the only field you need to keep assuming you have a context There is some magic you don t need to care about around this just let it vf default minimum maximum flags name is the option keep it simple and lowercase description are in without and describe what they for example set the foo of the bar offset is the offset of the field in your local context
char * ff_data_to_hex(char *buf, const uint8_t *src, int size, int lowercase)
Definition: utils.c:4950
This structure stores compressed data.
Definition: packet.h:346
int ff_get_muxer_ts_offset(AVFormatContext *s, int stream_index, int64_t *offset)
Definition: mux.c:1050
int i
Definition: input.c:407
int ff_interleave_add_packet(AVFormatContext *s, AVPacket *pkt, int(*compare)(AVFormatContext *, const AVPacket *, const AVPacket *))
Add packet to an AVFormatContext&#39;s packet_buffer list, determining its interleaved position using com...
Definition: mux.c:830
int ff_seek_frame_binary(AVFormatContext *s, int stream_index, int64_t target_ts, int flags)
Perform a binary search using av_index_search_timestamp() and AVInputFormat.read_timestamp().
Definition: utils.c:2203
struct PacketList * raw_packet_buffer_end
Definition: internal.h:89
const char * name
Definition: opengl_enc.c:102