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