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