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
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
46
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 */
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 */
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 */
96
97 /**
98 * Used to hold temporary packets.
99 */
101 /**
102 * Remaining size available for raw_packet_buffer, in bytes.
103 */
104 #define RAW_PACKET_BUFFER_SIZE 2500000
106
107 /**
108 * Offset to remap timestamps to be non-negative.
109 * Expressed in timebase units.
110 * @see AVStream.mux_ts_offset
111 */
113
114 /**
115 * Timebase for the timestamp offset.
116 */
118
119 #if FF_API_COMPUTE_PKT_FIELDS2
120 int missing_ts_warning;
121 #endif
122
124
126
127 /**
128 * Timestamp of the end of the shortest stream.
129 */
131
132 /**
133 * Whether or not avformat_init_output has already been called
134 */
136
137 /**
138 * Whether or not avformat_init_output fully initialized streams
139 */
141
142 /**
143 * ID3v2 tag useful for MP3 demuxing
144 */
146
147 /*
148 * Prefer the codec framerate for avg_frame_rate computation.
149 */
151
152 /**
153 * Set if chapter ids are strictly monotonic.
154 */
156 };
157
159 /**
160 * Set to 1 if the codec allows reordering, so pts can be different
161 * from dts.
162 */
164
165 /**
166 * bitstream filter to run on stream
167 * - encoding: Set by muxer using ff_stream_add_bitstream_filter
168 * - decoding: unused
169 */
171
172 /**
173 * Whether or not check_bitstream should still be run on each packet
174 */
176
177 /**
178 * The codec context used by avformat_find_stream_info, the parser, etc.
179 */
181 /**
182 * 1 if avctx has been initialized with the values from the codec parameters
183 */
185
187
188 /* the context for extracting extradata in find_stream_info()
189 * inited=1/bsf=NULL signals that extracting is not possible (codec not
190 * supported) */
191 struct {
196
197 /**
198 * Whether the internal avctx needs to be updated from codecpar (after a late change to codecpar)
199 */
201
203
205
206 #define MAX_STD_TIMEBASES (30*12+30+3+6)
207 /**
208 * Stream information used internally by avformat_find_stream_info()
209 */
210 struct {
219
220 /**
221 * 0 -> decoder has not been searched for yet.
222 * >0 -> decoder found
223 * <0 -> decoder with codec_id == -found_decoder has not been found
224 */
226
228
229 /**
230 * Those are used for average framerate estimation.
231 */
236
238
241
242 /**
243 * stream probing state
244 * -1 -> probing finished
245 * 0 -> no probing requested
246 * rest -> perform probing with request_probe being the minimum score to accept.
247 */
249 /**
250 * Indicates that everything up to the next keyframe
251 * should be discarded.
252 */
254
255 /**
256 * Number of samples to skip at the start of the frame decoded from the next packet.
257 */
259
260 /**
261 * If not 0, the number of samples that should be skipped from the start of
262 * the stream (the samples are removed from packets with pts==0, which also
263 * assumes negative timestamps do not happen).
264 * Intended for use with formats such as mp3 with ad-hoc gapless audio
265 * support.
266 */
268
269 /**
270 * If not 0, the first audio sample that should be discarded from the stream.
271 * This is broken by design (needs global sample count), but can't be
272 * avoided for broken by design formats such as mp3 with ad-hoc gapless
273 * audio support.
274 */
276
277 /**
278 * The sample after last sample that is intended to be discarded after
279 * first_discard_sample. Works on frame boundaries only. Used to prevent
280 * early EOF if the gapless info is broken (considered concatenated mp3s).
281 */
283
284 /**
285 * Number of internally decoded frames, used internally in libavformat, do not access
286 * its lifetime differs from info which is why it is not in that structure.
287 */
289
290 /**
291 * Timestamp offset added to timestamps before muxing
292 */
294
295 /**
296 * Internal data to check for wrapping of the time stamp
297 */
299
300 /**
301 * Options for behavior, when a wrap is detected.
302 *
303 * Defined by AV_PTS_WRAP_ values.
304 *
305 * If correction is enabled, there are two possibilities:
306 * If the first time stamp is near the wrap point, the wrap offset
307 * will be subtracted, which will create negative time stamps.
308 * Otherwise the offset will be added.
309 */
311
312 /**
313 * Internal data to prevent doing update_initial_durations() twice
314 */
316
317 #define MAX_REORDER_DELAY 16
318
319 /**
320 * Internal data to generate dts from pts
321 */
324
326
327 /**
328 * Internal data to analyze DTS and detect faulty mpeg streams
329 */
333
334 /**
335 * Internal data to inject global side data
336 */
338
339 /**
340 * display aspect ratio (0 if unknown)
341 * - encoding: unused
342 * - decoding: Set by libavformat to calculate sample_aspect_ratio internally
343 */
345
347
348 /**
349 * last packet in packet_buffer for this stream when muxing.
350 */
352 };
353
354 #ifdef __GNUC__
355 #define dynarray_add(tab, nb_ptr, elem)\
356 do {\
357 __typeof__(tab) _tab = (tab);\
358 __typeof__(elem) _elem = (elem);\
359 (void)sizeof(**_tab == _elem); /* check that types are compatible */\
360 av_dynarray_add(_tab, nb_ptr, _elem);\
361 } while(0)
362 #else
363 #define dynarray_add(tab, nb_ptr, elem)\
364 do {\
365 av_dynarray_add((tab), nb_ptr, (elem));\
366 } while(0)
367 #endif
368
369 /**
370 * Automatically create sub-directories
371 *
372 * @param path will create sub-directories by path
373 * @return 0, or < 0 on error
374 */
376
378
379 /**
380 * Parse a string of hexadecimal strings. Any space between the hexadecimal
381 * digits is ignored.
382 *
383 * @param data if non-null, the parsed data is written to this pointer
384 * @param p the string to parse
385 * @return the number of bytes written (or to be written, if data is null)
386 */
388
389 /**
390 * Add packet to an AVFormatContext's packet_buffer list, determining its
391 * interleaved position using compare() function argument.
392 * @return 0 on success, < 0 on error. pkt will always be blank on return.
393 */
396
398
399 #define NTP_OFFSET 2208988800ULL
400 #define NTP_OFFSET_US (NTP_OFFSET * 1000000ULL)
401
402 /** Get the current time since NTP epoch in microseconds. */
404
405 /**
406 * Get the NTP time stamp formatted as per the RFC-5905.
407 *
408 * @param ntp_time NTP time in micro seconds (since NTP epoch)
409 * @return the formatted NTP time stamp
410 */
412
413 /**
414 * Append the media-specific SDP fragment for the media stream c
415 * to the buffer buff.
416 *
417 * Note, the buffer needs to be initialized, since it is appended to
418 * existing content.
419 *
420 * @param buff the buffer to append the SDP fragment to
421 * @param size the size of the buff buffer
422 * @param st the AVStream of the media to describe
423 * @param idx the global stream index
424 * @param dest_addr the destination address of the media stream, may be NULL
425 * @param dest_type the destination address type, may be NULL
426 * @param port the destination port of the media stream, 0 if unknown
427 * @param ttl the time to live of the stream, 0 if not multicast
428 * @param fmt the AVFormatContext, which might contain options modifying
429 * the generated SDP
430 */
432 const char *dest_addr, const char *dest_type,
434
435 /**
436 * Write a packet to another muxer than the one the user originally
437 * intended. Useful when chaining muxers, where one muxer internally
438 * writes a received packet to another muxer.
439 *
440 * @param dst the muxer to write the packet to
441 * @param dst_stream the stream index within dst to write the packet to
442 * @param pkt the packet to be written
443 * @param src the muxer the packet originally was intended for
444 * @param interleave 0->use av_write_frame, 1->av_interleaved_write_frame
445 * @return the value av_write_frame returned
446 */
449
450 /**
451 * Read a whole line of text from AVIOContext. Stop reading after reaching
452 * either a \\n, a \0円 or EOF. The returned string is always \0円-terminated,
453 * and may be truncated if the buffer is too small.
454 *
455 * @param s the read-only AVIOContext
456 * @param buf buffer to store the read line
457 * @param maxlen size of the buffer
458 * @return the length of the string written in the buffer, not including the
459 * final \0円
460 */
462
463 /**
464 * Same as ff_get_line but strip the white-space characters in the text tail
465 *
466 * @param s the read-only AVIOContext
467 * @param buf buffer to store the read line
468 * @param maxlen size of the buffer
469 * @return the length of the string written in the buffer
470 */
472
473 /**
474 * Read a whole line of text from AVIOContext to an AVBPrint buffer. Stop
475 * reading after reaching a \\r, a \\n, a \\r\\n, a \0円 or EOF. The line
476 * ending characters are NOT included in the buffer, but they are skipped on
477 * the input.
478 *
479 * @param s the read-only AVIOContext
480 * @param bp the AVBPrint buffer
481 * @return the length of the read line, not including the line endings,
482 * negative on error.
483 */
485
486 /**
487 * Read a whole line of text from AVIOContext to an AVBPrint buffer overwriting
488 * its contents. Stop reading after reaching a \\r, a \\n, a \\r\\n, a \0円 or
489 * EOF. The line ending characters are NOT included in the buffer, but they
490 * are skipped on the input.
491 *
492 * @param s the read-only AVIOContext
493 * @param bp the AVBPrint buffer
494 * @return the length of the read line not including the line endings,
495 * negative on error, or if the buffer becomes truncated.
496 */
498
499 #define SPACE_CHARS " \t\r\n"
500
501 /**
502 * Callback function type for ff_parse_key_value.
503 *
504 * @param key a pointer to the key
505 * @param key_len the number of bytes that belong to the key, including the '='
506 * char
507 * @param dest return the destination pointer for the value in *dest, may
508 * be null to ignore the value
509 * @param dest_len the length of the *dest buffer
510 */
512 int key_len, char **dest, int *dest_len);
513 /**
514 * Parse a string with comma-separated key=value pairs. The value strings
515 * may be quoted and may contain escaped characters within quoted strings.
516 *
517 * @param str the string to parse
518 * @param callback_get_buf function that returns where to store the
519 * unescaped value string.
520 * @param context the opaque context pointer to pass to callback_get_buf
521 */
524
525 /**
526 * Find stream index based on format-specific stream ID
527 * @return stream index, or < 0 on error
528 */
530
531 /**
532 * Internal version of av_index_search_timestamp
533 */
535 int64_t wanted_timestamp,
int flags);
536
537 /**
538 * Internal version of av_add_index_entry
539 */
541 int *nb_index_entries,
542 unsigned int *index_entries_allocated_size,
544
546
547 /**
548 * Add a new chapter.
549 *
550 * @param s media file handle
551 * @param id unique ID for this chapter
552 * @param start chapter start time in time_base units
553 * @param end chapter end time in time_base units
554 * @param title chapter title
555 *
556 * @return AVChapter or NULL on error
557 */
558 #if FF_API_CHAPTER_ID_INT
560 #else
562 #endif
563 int64_t start, int64_t end, const char *title);
564
565 /**
566 * Ensure the index uses less memory than the maximum specified in
567 * AVFormatContext.max_index_size by discarding entries if it grows
568 * too large.
569 */
571
573
574 /**
575 * Perform a binary search using av_index_search_timestamp() and
576 * AVInputFormat.read_timestamp().
577 *
578 * @param target_ts target timestamp in the time base of the given stream
579 * @param stream_index stream number
580 */
582 int64_t target_ts,
int flags);
583
584 /**
585 * Update cur_dts of all streams based on the given timestamp and AVStream.
586 *
587 * Stream ref_st unchanged, others set cur_dts in their native time base.
588 * Only needed for timestamp wrapping or if (dts not set and pts!=dts).
589 * @param timestamp new dts expressed in time_base of param ref_st
590 * @param ref_st reference stream giving time_base of param timestamp
591 */
593
595 int64_t (*read_timestamp)(
struct AVFormatContext *,
int , int64_t *, int64_t ));
596
597 /**
598 * Perform a binary search using read_timestamp().
599 *
600 * @param target_ts target timestamp in the time base of the given stream
601 * @param stream_index stream number
602 */
604 int64_t target_ts, int64_t pos_min,
605 int64_t pos_max, int64_t pos_limit,
606 int64_t ts_min, int64_t ts_max,
607 int flags, int64_t *ts_ret,
608 int64_t (*read_timestamp)(
struct AVFormatContext *,
int , int64_t *, int64_t ));
609
610 /**
611 * Set the time base and wrapping info for a given stream. This will be used
612 * to interpret the stream's timestamps. If the new time base is invalid
613 * (numerator or denominator are non-positive), it leaves the stream
614 * unchanged.
615 *
616 * @param s stream
617 * @param pts_wrap_bits number of bits effectively used by the pts
618 * (used for wrap control)
619 * @param pts_num time base numerator
620 * @param pts_den time base denominator
621 */
623 unsigned int pts_num, unsigned int pts_den);
624
625 /**
626 * Add side data to a packet for changing parameters to the given values.
627 * Parameters set to 0 aren't included in the change.
628 */
632
633 /**
634 * Set the timebase for each stream from the corresponding codec timebase and
635 * print it.
636 */
638
639 /**
640 * Read a transport packet from a media file.
641 *
642 * @param s media file handle
643 * @param pkt is filled
644 * @return 0 if OK, AVERROR_xxx on error
645 */
647
648 /**
649 * Interleave an AVPacket per dts so it can be muxed.
650 *
651 * @param s an AVFormatContext for output. pkt resp. out will be added to
652 * resp. taken from its packet buffer.
653 * @param out the interleaved packet will be output here
654 * @param pkt the input packet; will be blank on return if not NULL
655 * @param flush 1 if no further packets are available as input and all
656 * remaining packets should be output
657 * @return 1 if a packet was output, 0 if no packet could be output
658 * (in which case out may be uninitialized), < 0 if an error occurred
659 */
662
664
665 /**
666 * Return the frame duration in seconds. Return 0 if not available.
667 */
670
672
674
676
677 /**
678 * Select a PCM codec based on the given parameters.
679 *
680 * @param bps bits-per-sample
681 * @param flt floating-point
682 * @param be big-endian
683 * @param sflags signed flags. each bit corresponds to one byte of bit depth.
684 * e.g. the 1st bit indicates if 8-bit should be signed or
685 * unsigned, the 2nd bit indicates if 16-bit should be signed or
686 * unsigned, etc... This is useful for formats such as WAVE where
687 * only 8-bit is unsigned and all other bit depths are signed.
688 * @return a PCM codec id or AV_CODEC_ID_NONE
689 */
691
692 /**
693 * Chooses a timebase for muxing the specified stream.
694 *
695 * The chosen timebase allows sample accurate timestamps based
696 * on the framerate or sample rate for audio streams. It also is
697 * at least as precise as 1/min_precision would be.
698 */
700
701 /**
702 * Chooses a timebase for muxing the specified stream.
703 */
705
706 /**
707 * Generate standard extradata for AVC-Intra based on width/height and field
708 * order.
709 */
711
712 /**
713 * Add a bitstream filter to a stream.
714 *
715 * @param st output stream to add a filter to
716 * @param name the name of the filter to add
717 * @param args filter-specific argument string
718 * @return >0 on success;
719 * AVERROR code on failure
720 */
722
723 /**
724 * Copy encoding parameters from source to destination stream
725 *
726 * @param dst pointer to destination AVStream
727 * @param src pointer to source AVStream
728 * @return >=0 on success, AVERROR code on error
729 */
731
732 /**
733 * Wrap avpriv_io_move and log if error happens.
734 *
735 * @param url_src source path
736 * @param url_dst destination path
737 * @return 0 or AVERROR on failure
738 */
739 int ff_rename(
const char *url_src,
const char *url_dst,
void *logctx);
740
741 /**
742 * Allocate extradata with additional AV_INPUT_BUFFER_PADDING_SIZE at end
743 * which is always set to 0.
744 *
745 * Previously allocated extradata in par will be freed.
746 *
747 * @param size size of extradata
748 * @return 0 if OK, AVERROR_xxx on error
749 */
751
752 /**
753 * Allocate extradata with additional AV_INPUT_BUFFER_PADDING_SIZE at end
754 * which is always set to 0 and fill it from pb.
755 *
756 * @param size size of extradata
757 * @return >= 0 if OK, AVERROR_xxx on error
758 */
760
761 /**
762 * add frame for rfps calculation.
763 *
764 * @param dts timestamp of the i-th frame
765 * @return 0 if OK, AVERROR_xxx on error
766 */
768
770
771 /**
772 * Flags for AVFormatContext.write_uncoded_frame()
773 */
775
776 /**
777 * Query whether the feature is possible on this stream.
778 * The frame argument is ignored.
779 */
781
782 };
783
784 /**
785 * Copies the whilelists from one context to the other
786 */
788
789 /**
790 * Returned by demuxers to indicate that data was consumed but discarded
791 * (ignored streams or junk data). The framework will re-call the demuxer.
792 */
793 #define FFERROR_REDO FFERRTAG('R','E','D','O')
794
795 /**
796 * Utility function to open IO stream of output format.
797 *
798 * @param s AVFormatContext
799 * @param url URL or file name to open for writing
800 * @options optional options which will be passed to io_open callback
801 * @return >=0 on success, negative AVERROR in case of failure
802 */
804
805 /*
806 * A wrapper around AVFormatContext.io_close that should be used
807 * instead of calling the pointer directly.
808 */
810
811 /**
812 * Utility function to check if the file uses http or https protocol
813 *
814 * @param s AVFormatContext
815 * @param filename URL or file name to open for writing
816 */
818
819 /**
820 * Parse creation_time in AVFormatContext metadata if exists and warn if the
821 * parsing fails.
822 *
823 * @param s AVFormatContext
824 * @param timestamp parsed timestamp in microseconds, only set on successful parsing
825 * @param return_seconds set this to get the number of seconds in timestamp instead of microseconds
826 * @return 1 if OK, 0 if the metadata was not present, AVERROR(EINVAL) on parse error
827 */
829
830 /**
831 * Standardize creation_time metadata in AVFormatContext to an ISO-8601
832 * timestamp string.
833 *
834 * @param s AVFormatContext
835 * @return <0 on error
836 */
838
839 #define CONTAINS_PAL 2
840 /**
841 * Reshuffles the lines to use the user specified stride.
842 *
843 * @param ppkt input and output packet
844 * @return negative error code or
845 * 0 if no new packet was allocated
846 * non-zero if a new packet was allocated and ppkt has to be freed
847 * CONTAINS_PAL if in addition to a new packet the old contained a palette
848 */
850
851 /**
852 * Retrieves the palette from a packet, either from side data, or
853 * appended to the video data in the packet itself (raw video only).
854 * It is commonly used after a call to ff_reshuffle_raw_rgb().
855 *
856 * Use 0 for the ret parameter to check for side data only.
857 *
858 * @param pkt pointer to packet before calling ff_reshuffle_raw_rgb()
859 * @param ret return value from ff_reshuffle_raw_rgb(), or 0
860 * @param palette pointer to palette buffer
861 * @return negative error code or
862 * 1 if the packet has a palette, else 0
863 */
865
866 /**
867 * Finalize buf into extradata and set its size appropriately.
868 */
870
871 /**
872 * Find the next packet in the interleaving queue for the given stream.
873 *
874 * @return a pointer to a packet if one was found, NULL otherwise.
875 */
877
879
882
883 /**
884 * Set AVFormatContext url field to the provided pointer. The pointer must
885 * point to a valid string. The existing url field is freed if necessary. Also
886 * set the legacy filename field to the same string which was provided in url.
887 */
889
891
892 #endif /* AVFORMAT_INTERNAL_H */