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