647ad65fb234f3032a292057257a266ac28309be
[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 #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 #define MAX_PROBE_PACKETS 2500
37
38 #ifdef DEBUG
39 #    define hex_dump_debug(class, buf, size) av_hex_dump_log(class, AV_LOG_DEBUG, buf, size)
40 #else
41 #    define hex_dump_debug(class, buf, size) do { if (0) av_hex_dump_log(class, AV_LOG_DEBUG, buf, size); } while(0)
42 #endif
43
44 typedef struct AVCodecTag {
45     enum AVCodecID id;
46     unsigned int tag;
47 } AVCodecTag;
48
49 typedef struct CodecMime{
50     char str[32];
51     enum AVCodecID id;
52 } CodecMime;
53
54 /*************************************************/
55 /* fractional numbers for exact pts handling */
56
57 /**
58  * The exact value of the fractional number is: 'val + num / den'.
59  * num is assumed to be 0 <= num < den.
60  */
61 typedef struct FFFrac {
62     int64_t val, num, den;
63 } FFFrac;
64
65
66 struct AVFormatInternal {
67     /**
68      * Number of streams relevant for interleaving.
69      * Muxing only.
70      */
71     int nb_interleaved_streams;
72
73     /**
74      * This buffer is only needed when packets were already buffered but
75      * not decoded, for example to get the codec parameters in MPEG
76      * streams.
77      */
78     struct AVPacketList *packet_buffer;
79     struct AVPacketList *packet_buffer_end;
80
81     /* av_seek_frame() support */
82     int64_t data_offset; /**< offset of the first packet */
83
84     /**
85      * Raw packets from the demuxer, prior to parsing and decoding.
86      * This buffer is used for buffering packets until the codec can
87      * be identified, as parsing cannot be done without knowing the
88      * codec.
89      */
90     struct AVPacketList *raw_packet_buffer;
91     struct AVPacketList *raw_packet_buffer_end;
92     /**
93      * Packets split by the parser get queued here.
94      */
95     struct AVPacketList *parse_queue;
96     struct AVPacketList *parse_queue_end;
97     /**
98      * Remaining size available for raw_packet_buffer, in bytes.
99      */
100 #define RAW_PACKET_BUFFER_SIZE 2500000
101     int raw_packet_buffer_remaining_size;
102
103     /**
104      * Offset to remap timestamps to be non-negative.
105      * Expressed in timebase units.
106      * @see AVStream.mux_ts_offset
107      */
108     int64_t offset;
109
110     /**
111      * Timebase for the timestamp offset.
112      */
113     AVRational offset_timebase;
114
115 #if FF_API_COMPUTE_PKT_FIELDS2
116     int missing_ts_warning;
117 #endif
118
119     int inject_global_side_data;
120
121     int avoid_negative_ts_use_pts;
122
123     /**
124      * Whether or not a header has already been written
125      */
126     int header_written;
127     int write_header_ret;
128 };
129
130 struct AVStreamInternal {
131     /**
132      * Set to 1 if the codec allows reordering, so pts can be different
133      * from dts.
134      */
135     int reorder;
136
137     /**
138      * bitstream filters to run on stream
139      * - encoding: Set by muxer using ff_stream_add_bitstream_filter
140      * - decoding: unused
141      */
142     AVBSFContext **bsfcs;
143     int nb_bsfcs;
144
145     /**
146      * Whether or not check_bitstream should still be run on each packet
147      */
148     int bitstream_checked;
149
150     /**
151      * The codec context used by avformat_find_stream_info, the parser, etc.
152      */
153     AVCodecContext *avctx;
154     /**
155      * 1 if avctx has been initialized with the values from the codec parameters
156      */
157     int avctx_inited;
158
159     enum AVCodecID orig_codec_id;
160
161     /**
162      * Whether the internal avctx needs to be updated from codecpar (after a late change to codecpar)
163      */
164     int need_context_update;
165 };
166
167 #ifdef __GNUC__
168 #define dynarray_add(tab, nb_ptr, elem)\
169 do {\
170     __typeof__(tab) _tab = (tab);\
171     __typeof__(elem) _elem = (elem);\
172     (void)sizeof(**_tab == _elem); /* check that types are compatible */\
173     av_dynarray_add(_tab, nb_ptr, _elem);\
174 } while(0)
175 #else
176 #define dynarray_add(tab, nb_ptr, elem)\
177 do {\
178     av_dynarray_add((tab), nb_ptr, (elem));\
179 } while(0)
180 #endif
181
182 struct tm *ff_brktimegm(time_t secs, struct tm *tm);
183
184 char *ff_data_to_hex(char *buf, const uint8_t *src, int size, int lowercase);
185
186 /**
187  * Parse a string of hexadecimal strings. Any space between the hexadecimal
188  * digits is ignored.
189  *
190  * @param data if non-null, the parsed data is written to this pointer
191  * @param p the string to parse
192  * @return the number of bytes written (or to be written, if data is null)
193  */
194 int ff_hex_to_data(uint8_t *data, const char *p);
195
196 /**
197  * Add packet to AVFormatContext->packet_buffer list, determining its
198  * interleaved position using compare() function argument.
199  * @return 0, or < 0 on error
200  */
201 int ff_interleave_add_packet(AVFormatContext *s, AVPacket *pkt,
202                              int (*compare)(AVFormatContext *, AVPacket *, AVPacket *));
203
204 void ff_read_frame_flush(AVFormatContext *s);
205
206 #define NTP_OFFSET 2208988800ULL
207 #define NTP_OFFSET_US (NTP_OFFSET * 1000000ULL)
208
209 /** Get the current time since NTP epoch in microseconds. */
210 uint64_t ff_ntp_time(void);
211
212 /**
213  * Append the media-specific SDP fragment for the media stream c
214  * to the buffer buff.
215  *
216  * Note, the buffer needs to be initialized, since it is appended to
217  * existing content.
218  *
219  * @param buff the buffer to append the SDP fragment to
220  * @param size the size of the buff buffer
221  * @param st the AVStream of the media to describe
222  * @param idx the global stream index
223  * @param dest_addr the destination address of the media stream, may be NULL
224  * @param dest_type the destination address type, may be NULL
225  * @param port the destination port of the media stream, 0 if unknown
226  * @param ttl the time to live of the stream, 0 if not multicast
227  * @param fmt the AVFormatContext, which might contain options modifying
228  *            the generated SDP
229  */
230 void ff_sdp_write_media(char *buff, int size, AVStream *st, int idx,
231                         const char *dest_addr, const char *dest_type,
232                         int port, int ttl, AVFormatContext *fmt);
233
234 /**
235  * Write a packet to another muxer than the one the user originally
236  * intended. Useful when chaining muxers, where one muxer internally
237  * writes a received packet to another muxer.
238  *
239  * @param dst the muxer to write the packet to
240  * @param dst_stream the stream index within dst to write the packet to
241  * @param pkt the packet to be written
242  * @param src the muxer the packet originally was intended for
243  * @param interleave 0->use av_write_frame, 1->av_interleaved_write_frame
244  * @return the value av_write_frame returned
245  */
246 int ff_write_chained(AVFormatContext *dst, int dst_stream, AVPacket *pkt,
247                      AVFormatContext *src, int interleave);
248
249 /**
250  * Get the length in bytes which is needed to store val as v.
251  */
252 int ff_get_v_length(uint64_t val);
253
254 /**
255  * Put val using a variable number of bytes.
256  */
257 void ff_put_v(AVIOContext *bc, uint64_t val);
258
259 /**
260  * Read a whole line of text from AVIOContext. Stop reading after reaching
261  * either a \\n, a \\0 or EOF. The returned string is always \\0-terminated,
262  * and may be truncated if the buffer is too small.
263  *
264  * @param s the read-only AVIOContext
265  * @param buf buffer to store the read line
266  * @param maxlen size of the buffer
267  * @return the length of the string written in the buffer, not including the
268  *         final \\0
269  */
270 int ff_get_line(AVIOContext *s, char *buf, int maxlen);
271
272 #define SPACE_CHARS " \t\r\n"
273
274 /**
275  * Callback function type for ff_parse_key_value.
276  *
277  * @param key a pointer to the key
278  * @param key_len the number of bytes that belong to the key, including the '='
279  *                char
280  * @param dest return the destination pointer for the value in *dest, may
281  *             be null to ignore the value
282  * @param dest_len the length of the *dest buffer
283  */
284 typedef void (*ff_parse_key_val_cb)(void *context, const char *key,
285                                     int key_len, char **dest, int *dest_len);
286 /**
287  * Parse a string with comma-separated key=value pairs. The value strings
288  * may be quoted and may contain escaped characters within quoted strings.
289  *
290  * @param str the string to parse
291  * @param callback_get_buf function that returns where to store the
292  *                         unescaped value string.
293  * @param context the opaque context pointer to pass to callback_get_buf
294  */
295 void ff_parse_key_value(const char *str, ff_parse_key_val_cb callback_get_buf,
296                         void *context);
297
298 /**
299  * Find stream index based on format-specific stream ID
300  * @return stream index, or < 0 on error
301  */
302 int ff_find_stream_index(AVFormatContext *s, int id);
303
304 /**
305  * Internal version of av_index_search_timestamp
306  */
307 int ff_index_search_timestamp(const AVIndexEntry *entries, int nb_entries,
308                               int64_t wanted_timestamp, int flags);
309
310 /**
311  * Internal version of av_add_index_entry
312  */
313 int ff_add_index_entry(AVIndexEntry **index_entries,
314                        int *nb_index_entries,
315                        unsigned int *index_entries_allocated_size,
316                        int64_t pos, int64_t timestamp, int size, int distance, int flags);
317
318 void ff_configure_buffers_for_index(AVFormatContext *s, int64_t time_tolerance);
319
320 /**
321  * Add a new chapter.
322  *
323  * @param s media file handle
324  * @param id unique ID for this chapter
325  * @param start chapter start time in time_base units
326  * @param end chapter end time in time_base units
327  * @param title chapter title
328  *
329  * @return AVChapter or NULL on error
330  */
331 AVChapter *avpriv_new_chapter(AVFormatContext *s, int id, AVRational time_base,
332                               int64_t start, int64_t end, const char *title);
333
334 /**
335  * Ensure the index uses less memory than the maximum specified in
336  * AVFormatContext.max_index_size by discarding entries if it grows
337  * too large.
338  */
339 void ff_reduce_index(AVFormatContext *s, int stream_index);
340
341 enum AVCodecID ff_guess_image2_codec(const char *filename);
342
343 /**
344  * Perform a binary search using av_index_search_timestamp() and
345  * AVInputFormat.read_timestamp().
346  *
347  * @param target_ts target timestamp in the time base of the given stream
348  * @param stream_index stream number
349  */
350 int ff_seek_frame_binary(AVFormatContext *s, int stream_index,
351                          int64_t target_ts, int flags);
352
353 /**
354  * Update cur_dts of all streams based on the given timestamp and AVStream.
355  *
356  * Stream ref_st unchanged, others set cur_dts in their native time base.
357  * Only needed for timestamp wrapping or if (dts not set and pts!=dts).
358  * @param timestamp new dts expressed in time_base of param ref_st
359  * @param ref_st reference stream giving time_base of param timestamp
360  */
361 void ff_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
362
363 int ff_find_last_ts(AVFormatContext *s, int stream_index, int64_t *ts, int64_t *pos,
364                     int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
365
366 /**
367  * Perform a binary search using read_timestamp().
368  *
369  * @param target_ts target timestamp in the time base of the given stream
370  * @param stream_index stream number
371  */
372 int64_t ff_gen_search(AVFormatContext *s, int stream_index,
373                       int64_t target_ts, int64_t pos_min,
374                       int64_t pos_max, int64_t pos_limit,
375                       int64_t ts_min, int64_t ts_max,
376                       int flags, int64_t *ts_ret,
377                       int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
378
379 /**
380  * Set the time base and wrapping info for a given stream. This will be used
381  * to interpret the stream's timestamps. If the new time base is invalid
382  * (numerator or denominator are non-positive), it leaves the stream
383  * unchanged.
384  *
385  * @param s stream
386  * @param pts_wrap_bits number of bits effectively used by the pts
387  *        (used for wrap control)
388  * @param pts_num time base numerator
389  * @param pts_den time base denominator
390  */
391 void avpriv_set_pts_info(AVStream *s, int pts_wrap_bits,
392                          unsigned int pts_num, unsigned int pts_den);
393
394 /**
395  * Add side data to a packet for changing parameters to the given values.
396  * Parameters set to 0 aren't included in the change.
397  */
398 int ff_add_param_change(AVPacket *pkt, int32_t channels,
399                         uint64_t channel_layout, int32_t sample_rate,
400                         int32_t width, int32_t height);
401
402 /**
403  * Set the timebase for each stream from the corresponding codec timebase and
404  * print it.
405  */
406 int ff_framehash_write_header(AVFormatContext *s);
407
408 /**
409  * Read a transport packet from a media file.
410  *
411  * @param s media file handle
412  * @param pkt is filled
413  * @return 0 if OK, AVERROR_xxx on error
414  */
415 int ff_read_packet(AVFormatContext *s, AVPacket *pkt);
416
417 /**
418  * Interleave a packet per dts in an output media file.
419  *
420  * Packets with pkt->destruct == av_destruct_packet will be freed inside this
421  * function, so they cannot be used after it. Note that calling av_packet_unref()
422  * on them is still safe.
423  *
424  * @param s media file handle
425  * @param out the interleaved packet will be output here
426  * @param pkt the input packet
427  * @param flush 1 if no further packets are available as input and all
428  *              remaining packets should be output
429  * @return 1 if a packet was output, 0 if no packet could be output,
430  *         < 0 if an error occurred
431  */
432 int ff_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
433                                  AVPacket *pkt, int flush);
434
435 void ff_free_stream(AVFormatContext *s, AVStream *st);
436
437 /**
438  * Return the frame duration in seconds. Return 0 if not available.
439  */
440 void ff_compute_frame_duration(AVFormatContext *s, int *pnum, int *pden, AVStream *st,
441                                AVCodecParserContext *pc, AVPacket *pkt);
442
443 unsigned int ff_codec_get_tag(const AVCodecTag *tags, enum AVCodecID id);
444
445 enum AVCodecID ff_codec_get_id(const AVCodecTag *tags, unsigned int tag);
446
447 /**
448  * Select a PCM codec based on the given parameters.
449  *
450  * @param bps     bits-per-sample
451  * @param flt     floating-point
452  * @param be      big-endian
453  * @param sflags  signed flags. each bit corresponds to one byte of bit depth.
454  *                e.g. the 1st bit indicates if 8-bit should be signed or
455  *                unsigned, the 2nd bit indicates if 16-bit should be signed or
456  *                unsigned, etc... This is useful for formats such as WAVE where
457  *                only 8-bit is unsigned and all other bit depths are signed.
458  * @return        a PCM codec id or AV_CODEC_ID_NONE
459  */
460 enum AVCodecID ff_get_pcm_codec_id(int bps, int flt, int be, int sflags);
461
462 /**
463  * Chooses a timebase for muxing the specified stream.
464  *
465  * The chosen timebase allows sample accurate timestamps based
466  * on the framerate or sample rate for audio streams. It also is
467  * at least as precise as 1/min_precision would be.
468  */
469 AVRational ff_choose_timebase(AVFormatContext *s, AVStream *st, int min_precision);
470
471 /**
472  * Chooses a timebase for muxing the specified stream.
473  */
474 enum AVChromaLocation ff_choose_chroma_location(AVFormatContext *s, AVStream *st);
475
476 /**
477  * Generate standard extradata for AVC-Intra based on width/height and field
478  * order.
479  */
480 int ff_generate_avci_extradata(AVStream *st);
481
482 /**
483  * Add a bitstream filter to a stream.
484  *
485  * @param st output stream to add a filter to
486  * @param name the name of the filter to add
487  * @param args filter-specific argument string
488  * @return  >0 on success;
489  *          AVERROR code on failure
490  */
491 int ff_stream_add_bitstream_filter(AVStream *st, const char *name, const char *args);
492
493 /**
494  * Wrap errno on rename() error.
495  *
496  * @param oldpath source path
497  * @param newpath destination path
498  * @return        0 or AVERROR on failure
499  */
500 static inline int ff_rename(const char *oldpath, const char *newpath, void *logctx)
501 {
502     int ret = 0;
503     if (rename(oldpath, newpath) == -1) {
504         ret = AVERROR(errno);
505         if (logctx)
506             av_log(logctx, AV_LOG_ERROR, "failed to rename file %s to %s\n", oldpath, newpath);
507     }
508     return ret;
509 }
510
511 /**
512  * Allocate extradata with additional AV_INPUT_BUFFER_PADDING_SIZE at end
513  * which is always set to 0.
514  *
515  * @param size size of extradata
516  * @return 0 if OK, AVERROR_xxx on error
517  */
518 int ff_alloc_extradata(AVCodecParameters *par, int size);
519
520 /**
521  * Allocate extradata with additional AV_INPUT_BUFFER_PADDING_SIZE at end
522  * which is always set to 0 and fill it from pb.
523  *
524  * @param size size of extradata
525  * @return >= 0 if OK, AVERROR_xxx on error
526  */
527 int ff_get_extradata(AVFormatContext *s, AVCodecParameters *par, AVIOContext *pb, int size);
528
529 /**
530  * add frame for rfps calculation.
531  *
532  * @param dts timestamp of the i-th frame
533  * @return 0 if OK, AVERROR_xxx on error
534  */
535 int ff_rfps_add_frame(AVFormatContext *ic, AVStream *st, int64_t dts);
536
537 void ff_rfps_calculate(AVFormatContext *ic);
538
539 /**
540  * Flags for AVFormatContext.write_uncoded_frame()
541  */
542 enum AVWriteUncodedFrameFlags {
543
544     /**
545      * Query whether the feature is possible on this stream.
546      * The frame argument is ignored.
547      */
548     AV_WRITE_UNCODED_FRAME_QUERY           = 0x0001,
549
550 };
551
552 /**
553  * Copies the whilelists from one context to the other
554  */
555 int ff_copy_whiteblacklists(AVFormatContext *dst, AVFormatContext *src);
556
557 int ffio_open2_wrapper(struct AVFormatContext *s, AVIOContext **pb, const char *url, int flags,
558                        const AVIOInterruptCB *int_cb, AVDictionary **options);
559
560 /**
561  * Returned by demuxers to indicate that data was consumed but discarded
562  * (ignored streams or junk data). The framework will re-call the demuxer.
563  */
564 #define FFERROR_REDO FFERRTAG('R','E','D','O')
565
566 /*
567  * A wrapper around AVFormatContext.io_close that should be used
568  * instead of calling the pointer directly.
569  */
570 void ff_format_io_close(AVFormatContext *s, AVIOContext **pb);
571
572 /**
573  * Parse creation_time in AVFormatContext metadata if exists and warn if the
574  * parsing fails.
575  *
576  * @param s AVFormatContext
577  * @param timestamp parsed timestamp in microseconds, only set on successful parsing
578  * @param return_seconds set this to get the number of seconds in timestamp instead of microseconds
579  * @return 1 if OK, 0 if the metadata was not present, AVERROR(EINVAL) on parse error
580  */
581 int ff_parse_creation_time_metadata(AVFormatContext *s, int64_t *timestamp, int return_seconds);
582
583 /**
584  * Standardize creation_time metadata in AVFormatContext to an ISO-8601
585  * timestamp string.
586  *
587  * @param s AVFormatContext
588  * @return <0 on error
589  */
590 int ff_standardize_creation_time(AVFormatContext *s);
591
592 #define CONTAINS_PAL 2
593 /**
594  * Reshuffles the lines to use the user specified stride.
595  *
596  * @param ppkt input and output packet
597  * @return negative error code or
598  *         0 if no new packet was allocated
599  *         non-zero if a new packet was allocated and ppkt has to be freed
600  *         CONTAINS_PAL if in addition to a new packet the old contained a palette
601  */
602 int ff_reshuffle_raw_rgb(AVFormatContext *s, AVPacket **ppkt, AVCodecParameters *par, int expected_stride);
603
604 /**
605  * Retrieves the palette from a packet, either from side data, or
606  * appended to the video data in the packet itself (raw video only).
607  * It is commonly used after a call to ff_reshuffle_raw_rgb().
608  *
609  * Use 0 for the ret parameter to check for side data only.
610  *
611  * @param pkt pointer to packet before calling ff_reshuffle_raw_rgb()
612  * @param ret return value from ff_reshuffle_raw_rgb(), or 0
613  * @param palette pointer to palette buffer
614  * @return negative error code or
615  *         1 if the packet has a palette, else 0
616  */
617 int ff_get_packet_palette(AVFormatContext *s, AVPacket *pkt, int ret, uint32_t *palette);
618
619 /**
620  * Finalize buf into extradata and set its size appropriately.
621  */
622 int ff_bprint_to_codecpar_extradata(AVCodecParameters *par, struct AVBPrint *buf);
623
624 /**
625  * Find the next packet in the interleaving queue for the given stream.
626  * The packet is not removed from the interleaving queue, but only
627  * a pointer to it is returned.
628  *
629  * @param ts_offset the ts difference between packet in the que and the muxer.
630  *
631  * @return a pointer to the next packet, or NULL if no packet is queued
632  *         for this stream.
633  */
634 const AVPacket *ff_interleaved_peek(AVFormatContext *s, int stream, int64_t *ts_offset);
635
636 #endif /* AVFORMAT_INTERNAL_H */