]> git.sesse.net Git - ffmpeg/blob - libavformat/internal.h
avformat/utils: move is_intra_only() to header and rename to ff_is_intra_only()
[ffmpeg] / 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 #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
64 struct AVFormatInternal {
65     /**
66      * Number of streams relevant for interleaving.
67      * Muxing only.
68      */
69     int nb_interleaved_streams;
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      */
76     struct AVPacketList *packet_buffer;
77     struct AVPacketList *packet_buffer_end;
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      */
88     struct AVPacketList *raw_packet_buffer;
89     struct AVPacketList *raw_packet_buffer_end;
90     /**
91      * Packets split by the parser get queued here.
92      */
93     struct AVPacketList *parse_queue;
94     struct AVPacketList *parse_queue_end;
95     /**
96      * Remaining size available for raw_packet_buffer, in bytes.
97      */
98 #define RAW_PACKET_BUFFER_SIZE 2500000
99     int raw_packet_buffer_remaining_size;
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      */
111     AVRational offset_timebase;
112
113 #if FF_API_COMPUTE_PKT_FIELDS2
114     int missing_ts_warning;
115 #endif
116
117     int inject_global_side_data;
118
119     int avoid_negative_ts_use_pts;
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      */
129     int initialized;
130
131     /**
132      * Whether or not avformat_init_output fully initialized streams
133      */
134     int streams_initialized;
135
136     /**
137      * ID3v2 tag useful for MP3 demuxing
138      */
139     AVDictionary *id3v2_meta;
140
141     /*
142      * Prefer the codec framerate for avg_frame_rate computation.
143      */
144     int prefer_codec_framerate;
145 };
146
147 struct AVStreamInternal {
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      */
159     AVBSFContext *bsfc;
160
161     /**
162      * Whether or not check_bitstream should still be run on each packet
163      */
164     int bitstream_checked;
165
166     /**
167      * The codec context used by avformat_find_stream_info, the parser, etc.
168      */
169     AVCodecContext *avctx;
170     /**
171      * 1 if avctx has been initialized with the values from the codec parameters
172      */
173     int avctx_inited;
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 {
181         AVBSFContext *bsf;
182         AVPacket     *pkt;
183         int inited;
184     } extract_extradata;
185
186     /**
187      * Whether the internal avctx needs to be updated from codecpar (after a late change to codecpar)
188      */
189     int need_context_update;
190
191     FFFrac *priv_pts;
192 };
193
194 #ifdef __GNUC__
195 #define dynarray_add(tab, nb_ptr, elem)\
196 do {\
197     __typeof__(tab) _tab = (tab);\
198     __typeof__(elem) _elem = (elem);\
199     (void)sizeof(**_tab == _elem); /* check that types are compatible */\
200     av_dynarray_add(_tab, nb_ptr, _elem);\
201 } while(0)
202 #else
203 #define dynarray_add(tab, nb_ptr, elem)\
204 do {\
205     av_dynarray_add((tab), nb_ptr, (elem));\
206 } while(0)
207 #endif
208
209 struct tm *ff_brktimegm(time_t secs, struct tm *tm);
210
211 /**
212  * Automatically create sub-directories
213  *
214  * @param path will create sub-directories by path
215  * @return 0, or < 0 on error
216  */
217 int ff_mkdir_p(const char *path);
218
219 char *ff_data_to_hex(char *buf, const uint8_t *src, int size, int lowercase);
220
221 /**
222  * Parse a string of hexadecimal strings. Any space between the hexadecimal
223  * digits is ignored.
224  *
225  * @param data if non-null, the parsed data is written to this pointer
226  * @param p the string to parse
227  * @return the number of bytes written (or to be written, if data is null)
228  */
229 int ff_hex_to_data(uint8_t *data, const char *p);
230
231 /**
232  * Add packet to an AVFormatContext's packet_buffer list, determining its
233  * interleaved position using compare() function argument.
234  * @return 0 on success, < 0 on error. pkt will always be blank on return.
235  */
236 int ff_interleave_add_packet(AVFormatContext *s, AVPacket *pkt,
237                              int (*compare)(AVFormatContext *, const AVPacket *, const AVPacket *));
238
239 void ff_read_frame_flush(AVFormatContext *s);
240
241 #define NTP_OFFSET 2208988800ULL
242 #define NTP_OFFSET_US (NTP_OFFSET * 1000000ULL)
243
244 /** Get the current time since NTP epoch in microseconds. */
245 uint64_t ff_ntp_time(void);
246
247 /**
248  * Get the NTP time stamp formatted as per the RFC-5905.
249  *
250  * @param ntp_time NTP time in micro seconds (since NTP epoch)
251  * @return the formatted NTP time stamp
252  */
253 uint64_t ff_get_formatted_ntp_time(uint64_t ntp_time_us);
254
255 /**
256  * Append the media-specific SDP fragment for the media stream c
257  * to the buffer buff.
258  *
259  * Note, the buffer needs to be initialized, since it is appended to
260  * existing content.
261  *
262  * @param buff the buffer to append the SDP fragment to
263  * @param size the size of the buff buffer
264  * @param st the AVStream of the media to describe
265  * @param idx the global stream index
266  * @param dest_addr the destination address of the media stream, may be NULL
267  * @param dest_type the destination address type, may be NULL
268  * @param port the destination port of the media stream, 0 if unknown
269  * @param ttl the time to live of the stream, 0 if not multicast
270  * @param fmt the AVFormatContext, which might contain options modifying
271  *            the generated SDP
272  */
273 void ff_sdp_write_media(char *buff, int size, AVStream *st, int idx,
274                         const char *dest_addr, const char *dest_type,
275                         int port, int ttl, AVFormatContext *fmt);
276
277 /**
278  * Write a packet to another muxer than the one the user originally
279  * intended. Useful when chaining muxers, where one muxer internally
280  * writes a received packet to another muxer.
281  *
282  * @param dst the muxer to write the packet to
283  * @param dst_stream the stream index within dst to write the packet to
284  * @param pkt the packet to be written
285  * @param src the muxer the packet originally was intended for
286  * @param interleave 0->use av_write_frame, 1->av_interleaved_write_frame
287  * @return the value av_write_frame returned
288  */
289 int ff_write_chained(AVFormatContext *dst, int dst_stream, AVPacket *pkt,
290                      AVFormatContext *src, int interleave);
291
292 /**
293  * Read a whole line of text from AVIOContext. Stop reading after reaching
294  * either a \\n, a \\0 or EOF. The returned string is always \\0-terminated,
295  * and may be truncated if the buffer is too small.
296  *
297  * @param s the read-only AVIOContext
298  * @param buf buffer to store the read line
299  * @param maxlen size of the buffer
300  * @return the length of the string written in the buffer, not including the
301  *         final \\0
302  */
303 int ff_get_line(AVIOContext *s, char *buf, int maxlen);
304
305 /**
306  * Same as ff_get_line but strip the white-space characters in the text tail
307  *
308  * @param s the read-only AVIOContext
309  * @param buf buffer to store the read line
310  * @param maxlen size of the buffer
311  * @return the length of the string written in the buffer
312  */
313 int ff_get_chomp_line(AVIOContext *s, char *buf, int maxlen);
314
315 /**
316  * Read a whole line of text from AVIOContext to an AVBPrint buffer. Stop
317  * reading after reaching a \\r, a \\n, a \\r\\n, a \\0 or EOF.  The line
318  * ending characters are NOT included in the buffer, but they are skipped on
319  * the input.
320  *
321  * @param s the read-only AVIOContext
322  * @param bp the AVBPrint buffer
323  * @return the length of the read line, not including the line endings,
324  *         negative on error.
325  */
326 int64_t ff_read_line_to_bprint(AVIOContext *s, AVBPrint *bp);
327
328 /**
329  * Read a whole line of text from AVIOContext to an AVBPrint buffer overwriting
330  * its contents. Stop reading after reaching a \\r, a \\n, a \\r\\n, a \\0 or
331  * EOF. The line ending characters are NOT included in the buffer, but they
332  * are skipped on the input.
333  *
334  * @param s the read-only AVIOContext
335  * @param bp the AVBPrint buffer
336  * @return the length of the read line not including the line endings,
337  *         negative on error, or if the buffer becomes truncated.
338  */
339 int64_t ff_read_line_to_bprint_overwrite(AVIOContext *s, AVBPrint *bp);
340
341 #define SPACE_CHARS " \t\r\n"
342
343 /**
344  * Callback function type for ff_parse_key_value.
345  *
346  * @param key a pointer to the key
347  * @param key_len the number of bytes that belong to the key, including the '='
348  *                char
349  * @param dest return the destination pointer for the value in *dest, may
350  *             be null to ignore the value
351  * @param dest_len the length of the *dest buffer
352  */
353 typedef void (*ff_parse_key_val_cb)(void *context, const char *key,
354                                     int key_len, char **dest, int *dest_len);
355 /**
356  * Parse a string with comma-separated key=value pairs. The value strings
357  * may be quoted and may contain escaped characters within quoted strings.
358  *
359  * @param str the string to parse
360  * @param callback_get_buf function that returns where to store the
361  *                         unescaped value string.
362  * @param context the opaque context pointer to pass to callback_get_buf
363  */
364 void ff_parse_key_value(const char *str, ff_parse_key_val_cb callback_get_buf,
365                         void *context);
366
367 /**
368  * Find stream index based on format-specific stream ID
369  * @return stream index, or < 0 on error
370  */
371 int ff_find_stream_index(AVFormatContext *s, int id);
372
373 /**
374  * Internal version of av_index_search_timestamp
375  */
376 int ff_index_search_timestamp(const AVIndexEntry *entries, int nb_entries,
377                               int64_t wanted_timestamp, int flags);
378
379 /**
380  * Internal version of av_add_index_entry
381  */
382 int ff_add_index_entry(AVIndexEntry **index_entries,
383                        int *nb_index_entries,
384                        unsigned int *index_entries_allocated_size,
385                        int64_t pos, int64_t timestamp, int size, int distance, int flags);
386
387 void ff_configure_buffers_for_index(AVFormatContext *s, int64_t time_tolerance);
388
389 /**
390  * Add a new chapter.
391  *
392  * @param s media file handle
393  * @param id unique ID for this chapter
394  * @param start chapter start time in time_base units
395  * @param end chapter end time in time_base units
396  * @param title chapter title
397  *
398  * @return AVChapter or NULL on error
399  */
400 AVChapter *avpriv_new_chapter(AVFormatContext *s, int id, AVRational time_base,
401                               int64_t start, int64_t end, const char *title);
402
403 /**
404  * Ensure the index uses less memory than the maximum specified in
405  * AVFormatContext.max_index_size by discarding entries if it grows
406  * too large.
407  */
408 void ff_reduce_index(AVFormatContext *s, int stream_index);
409
410 enum AVCodecID ff_guess_image2_codec(const char *filename);
411
412 /**
413  * Perform a binary search using av_index_search_timestamp() and
414  * AVInputFormat.read_timestamp().
415  *
416  * @param target_ts target timestamp in the time base of the given stream
417  * @param stream_index stream number
418  */
419 int ff_seek_frame_binary(AVFormatContext *s, int stream_index,
420                          int64_t target_ts, int flags);
421
422 /**
423  * Update cur_dts of all streams based on the given timestamp and AVStream.
424  *
425  * Stream ref_st unchanged, others set cur_dts in their native time base.
426  * Only needed for timestamp wrapping or if (dts not set and pts!=dts).
427  * @param timestamp new dts expressed in time_base of param ref_st
428  * @param ref_st reference stream giving time_base of param timestamp
429  */
430 void ff_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
431
432 int ff_find_last_ts(AVFormatContext *s, int stream_index, int64_t *ts, int64_t *pos,
433                     int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
434
435 /**
436  * Perform a binary search using read_timestamp().
437  *
438  * @param target_ts target timestamp in the time base of the given stream
439  * @param stream_index stream number
440  */
441 int64_t ff_gen_search(AVFormatContext *s, int stream_index,
442                       int64_t target_ts, int64_t pos_min,
443                       int64_t pos_max, int64_t pos_limit,
444                       int64_t ts_min, int64_t ts_max,
445                       int flags, int64_t *ts_ret,
446                       int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
447
448 /**
449  * Set the time base and wrapping info for a given stream. This will be used
450  * to interpret the stream's timestamps. If the new time base is invalid
451  * (numerator or denominator are non-positive), it leaves the stream
452  * unchanged.
453  *
454  * @param s stream
455  * @param pts_wrap_bits number of bits effectively used by the pts
456  *        (used for wrap control)
457  * @param pts_num time base numerator
458  * @param pts_den time base denominator
459  */
460 void avpriv_set_pts_info(AVStream *s, int pts_wrap_bits,
461                          unsigned int pts_num, unsigned int pts_den);
462
463 /**
464  * Add side data to a packet for changing parameters to the given values.
465  * Parameters set to 0 aren't included in the change.
466  */
467 int ff_add_param_change(AVPacket *pkt, int32_t channels,
468                         uint64_t channel_layout, int32_t sample_rate,
469                         int32_t width, int32_t height);
470
471 /**
472  * Set the timebase for each stream from the corresponding codec timebase and
473  * print it.
474  */
475 int ff_framehash_write_header(AVFormatContext *s);
476
477 /**
478  * Read a transport packet from a media file.
479  *
480  * @param s media file handle
481  * @param pkt is filled
482  * @return 0 if OK, AVERROR_xxx on error
483  */
484 int ff_read_packet(AVFormatContext *s, AVPacket *pkt);
485
486 /**
487  * Interleave an AVPacket per dts so it can be muxed.
488  *
489  * @param s   an AVFormatContext for output. pkt resp. out will be added to
490  *            resp. taken from its packet buffer.
491  * @param out the interleaved packet will be output here
492  * @param pkt the input packet; will be blank on return if not NULL
493  * @param flush 1 if no further packets are available as input and all
494  *              remaining packets should be output
495  * @return 1 if a packet was output, 0 if no packet could be output
496  *         (in which case out may be uninitialized), < 0 if an error occurred
497  */
498 int ff_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
499                                  AVPacket *pkt, int flush);
500
501 void ff_free_stream(AVFormatContext *s, AVStream *st);
502
503 /**
504  * Return the frame duration in seconds. Return 0 if not available.
505  */
506 void ff_compute_frame_duration(AVFormatContext *s, int *pnum, int *pden, AVStream *st,
507                                AVCodecParserContext *pc, AVPacket *pkt);
508
509 unsigned int ff_codec_get_tag(const AVCodecTag *tags, enum AVCodecID id);
510
511 enum AVCodecID ff_codec_get_id(const AVCodecTag *tags, unsigned int tag);
512
513 int ff_is_intra_only(enum AVCodecID id);
514
515 /**
516  * Select a PCM codec based on the given parameters.
517  *
518  * @param bps     bits-per-sample
519  * @param flt     floating-point
520  * @param be      big-endian
521  * @param sflags  signed flags. each bit corresponds to one byte of bit depth.
522  *                e.g. the 1st bit indicates if 8-bit should be signed or
523  *                unsigned, the 2nd bit indicates if 16-bit should be signed or
524  *                unsigned, etc... This is useful for formats such as WAVE where
525  *                only 8-bit is unsigned and all other bit depths are signed.
526  * @return        a PCM codec id or AV_CODEC_ID_NONE
527  */
528 enum AVCodecID ff_get_pcm_codec_id(int bps, int flt, int be, int sflags);
529
530 /**
531  * Chooses a timebase for muxing the specified stream.
532  *
533  * The chosen timebase allows sample accurate timestamps based
534  * on the framerate or sample rate for audio streams. It also is
535  * at least as precise as 1/min_precision would be.
536  */
537 AVRational ff_choose_timebase(AVFormatContext *s, AVStream *st, int min_precision);
538
539 /**
540  * Chooses a timebase for muxing the specified stream.
541  */
542 enum AVChromaLocation ff_choose_chroma_location(AVFormatContext *s, AVStream *st);
543
544 /**
545  * Generate standard extradata for AVC-Intra based on width/height and field
546  * order.
547  */
548 int ff_generate_avci_extradata(AVStream *st);
549
550 /**
551  * Add a bitstream filter to a stream.
552  *
553  * @param st output stream to add a filter to
554  * @param name the name of the filter to add
555  * @param args filter-specific argument string
556  * @return  >0 on success;
557  *          AVERROR code on failure
558  */
559 int ff_stream_add_bitstream_filter(AVStream *st, const char *name, const char *args);
560
561 /**
562  * Copy encoding parameters from source to destination stream
563  *
564  * @param dst pointer to destination AVStream
565  * @param src pointer to source AVStream
566  * @return >=0 on success, AVERROR code on error
567  */
568 int ff_stream_encode_params_copy(AVStream *dst, const AVStream *src);
569
570 /**
571  * Wrap avpriv_io_move and log if error happens.
572  *
573  * @param url_src source path
574  * @param url_dst destination path
575  * @return        0 or AVERROR on failure
576  */
577 int ff_rename(const char *url_src, const char *url_dst, void *logctx);
578
579 /**
580  * Allocate extradata with additional AV_INPUT_BUFFER_PADDING_SIZE at end
581  * which is always set to 0.
582  *
583  * Previously allocated extradata in par will be freed.
584  *
585  * @param size size of extradata
586  * @return 0 if OK, AVERROR_xxx on error
587  */
588 int ff_alloc_extradata(AVCodecParameters *par, int size);
589
590 /**
591  * Allocate extradata with additional AV_INPUT_BUFFER_PADDING_SIZE at end
592  * which is always set to 0 and fill it from pb.
593  *
594  * @param size size of extradata
595  * @return >= 0 if OK, AVERROR_xxx on error
596  */
597 int ff_get_extradata(AVFormatContext *s, AVCodecParameters *par, AVIOContext *pb, int size);
598
599 /**
600  * add frame for rfps calculation.
601  *
602  * @param dts timestamp of the i-th frame
603  * @return 0 if OK, AVERROR_xxx on error
604  */
605 int ff_rfps_add_frame(AVFormatContext *ic, AVStream *st, int64_t dts);
606
607 void ff_rfps_calculate(AVFormatContext *ic);
608
609 /**
610  * Flags for AVFormatContext.write_uncoded_frame()
611  */
612 enum AVWriteUncodedFrameFlags {
613
614     /**
615      * Query whether the feature is possible on this stream.
616      * The frame argument is ignored.
617      */
618     AV_WRITE_UNCODED_FRAME_QUERY           = 0x0001,
619
620 };
621
622 /**
623  * Copies the whilelists from one context to the other
624  */
625 int ff_copy_whiteblacklists(AVFormatContext *dst, const AVFormatContext *src);
626
627 /**
628  * Returned by demuxers to indicate that data was consumed but discarded
629  * (ignored streams or junk data). The framework will re-call the demuxer.
630  */
631 #define FFERROR_REDO FFERRTAG('R','E','D','O')
632
633 /**
634  * Utility function to open IO stream of output format.
635  *
636  * @param s AVFormatContext
637  * @param url URL or file name to open for writing
638  * @options optional options which will be passed to io_open callback
639  * @return >=0 on success, negative AVERROR in case of failure
640  */
641 int ff_format_output_open(AVFormatContext *s, const char *url, AVDictionary **options);
642
643 /*
644  * A wrapper around AVFormatContext.io_close that should be used
645  * instead of calling the pointer directly.
646  */
647 void ff_format_io_close(AVFormatContext *s, AVIOContext **pb);
648
649 /**
650  * Utility function to check if the file uses http or https protocol
651  *
652  * @param s AVFormatContext
653  * @param filename URL or file name to open for writing
654  */
655 int ff_is_http_proto(char *filename);
656
657 /**
658  * Parse creation_time in AVFormatContext metadata if exists and warn if the
659  * parsing fails.
660  *
661  * @param s AVFormatContext
662  * @param timestamp parsed timestamp in microseconds, only set on successful parsing
663  * @param return_seconds set this to get the number of seconds in timestamp instead of microseconds
664  * @return 1 if OK, 0 if the metadata was not present, AVERROR(EINVAL) on parse error
665  */
666 int ff_parse_creation_time_metadata(AVFormatContext *s, int64_t *timestamp, int return_seconds);
667
668 /**
669  * Standardize creation_time metadata in AVFormatContext to an ISO-8601
670  * timestamp string.
671  *
672  * @param s AVFormatContext
673  * @return <0 on error
674  */
675 int ff_standardize_creation_time(AVFormatContext *s);
676
677 #define CONTAINS_PAL 2
678 /**
679  * Reshuffles the lines to use the user specified stride.
680  *
681  * @param ppkt input and output packet
682  * @return negative error code or
683  *         0 if no new packet was allocated
684  *         non-zero if a new packet was allocated and ppkt has to be freed
685  *         CONTAINS_PAL if in addition to a new packet the old contained a palette
686  */
687 int ff_reshuffle_raw_rgb(AVFormatContext *s, AVPacket **ppkt, AVCodecParameters *par, int expected_stride);
688
689 /**
690  * Retrieves the palette from a packet, either from side data, or
691  * appended to the video data in the packet itself (raw video only).
692  * It is commonly used after a call to ff_reshuffle_raw_rgb().
693  *
694  * Use 0 for the ret parameter to check for side data only.
695  *
696  * @param pkt pointer to packet before calling ff_reshuffle_raw_rgb()
697  * @param ret return value from ff_reshuffle_raw_rgb(), or 0
698  * @param palette pointer to palette buffer
699  * @return negative error code or
700  *         1 if the packet has a palette, else 0
701  */
702 int ff_get_packet_palette(AVFormatContext *s, AVPacket *pkt, int ret, uint32_t *palette);
703
704 /**
705  * Finalize buf into extradata and set its size appropriately.
706  */
707 int ff_bprint_to_codecpar_extradata(AVCodecParameters *par, struct AVBPrint *buf);
708
709 /**
710  * Find the next packet in the interleaving queue for the given stream.
711  * The pkt parameter is filled in with the queued packet, including
712  * references to the data (which the caller is not allowed to keep or
713  * modify).
714  *
715  * @return 0 if a packet was found, a negative value if no packet was found
716  */
717 int ff_interleaved_peek(AVFormatContext *s, int stream,
718                         AVPacket *pkt, int add_offset);
719
720
721 int ff_lock_avformat(void);
722 int ff_unlock_avformat(void);
723
724 /**
725  * Set AVFormatContext url field to the provided pointer. The pointer must
726  * point to a valid string. The existing url field is freed if necessary. Also
727  * set the legacy filename field to the same string which was provided in url.
728  */
729 void ff_format_set_url(AVFormatContext *s, char *url);
730
731 #define FF_PACKETLIST_FLAG_REF_PACKET (1 << 0) /**< Create a new reference for the packet instead of
732                                                     transferring the ownership of the existing one to the
733                                                     list. */
734
735 /**
736  * Append an AVPacket to the list.
737  *
738  * @param head  List head element
739  * @param tail  List tail element
740  * @param pkt   The packet being appended. The data described in it will
741  *              be made reference counted if it isn't already.
742  * @param flags Any combination of FF_PACKETLIST_FLAG_* flags
743  * @return 0 on success, negative AVERROR value on failure. On failure,
744            the list is unchanged
745  */
746 int ff_packet_list_put(AVPacketList **head, AVPacketList **tail,
747                        AVPacket *pkt, int flags);
748
749 /**
750  * Remove the oldest AVPacket in the list and return it.
751  * The behaviour is undefined if the packet list is empty.
752  *
753  * @note The pkt will be overwritten completely. The caller owns the
754  *       packet and must unref it by itself.
755  *
756  * @param head List head element
757  * @param tail List tail element
758  * @param pkt  Pointer to an AVPacket struct
759  * @return 0 on success. Success is guaranteed
760  *         if the packet list is not empty.
761  */
762 int ff_packet_list_get(AVPacketList **head, AVPacketList **tail,
763                        AVPacket *pkt);
764
765 /**
766  * Wipe the list and unref all the packets in it.
767  *
768  * @param head List head element
769  * @param tail List tail element
770  */
771 void ff_packet_list_free(AVPacketList **head, AVPacketList **tail);
772
773 void avpriv_register_devices(const AVOutputFormat * const o[], const AVInputFormat * const i[]);
774
775 #endif /* AVFORMAT_INTERNAL_H */