Merge commit '8de1ee9f725aa3c550f425bd3120bcd95d5b2ea8'
[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 #include "avformat.h"
26 #include "os_support.h"
27
28 #define MAX_URL_SIZE 4096
29
30 /** size of probe buffer, for guessing file type from file contents */
31 #define PROBE_BUF_MIN 2048
32 #define PROBE_BUF_MAX (1 << 20)
33
34 #define MAX_PROBE_PACKETS 2500
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 struct AVStreamInternal {
123     /**
124      * Set to 1 if the codec allows reordering, so pts can be different
125      * from dts.
126      */
127     int reorder;
128 };
129
130 #ifdef __GNUC__
131 #define dynarray_add(tab, nb_ptr, elem)\
132 do {\
133     __typeof__(tab) _tab = (tab);\
134     __typeof__(elem) _elem = (elem);\
135     (void)sizeof(**_tab == _elem); /* check that types are compatible */\
136     av_dynarray_add(_tab, nb_ptr, _elem);\
137 } while(0)
138 #else
139 #define dynarray_add(tab, nb_ptr, elem)\
140 do {\
141     av_dynarray_add((tab), nb_ptr, (elem));\
142 } while(0)
143 #endif
144
145 struct tm *ff_brktimegm(time_t secs, struct tm *tm);
146
147 char *ff_data_to_hex(char *buf, const uint8_t *src, int size, int lowercase);
148
149 /**
150  * Parse a string of hexadecimal strings. Any space between the hexadecimal
151  * digits is ignored.
152  *
153  * @param data if non-null, the parsed data is written to this pointer
154  * @param p the string to parse
155  * @return the number of bytes written (or to be written, if data is null)
156  */
157 int ff_hex_to_data(uint8_t *data, const char *p);
158
159 void ff_program_add_stream_index(AVFormatContext *ac, int progid, unsigned int idx);
160
161 /**
162  * Add packet to AVFormatContext->packet_buffer list, determining its
163  * interleaved position using compare() function argument.
164  * @return 0, or < 0 on error
165  */
166 int ff_interleave_add_packet(AVFormatContext *s, AVPacket *pkt,
167                              int (*compare)(AVFormatContext *, AVPacket *, AVPacket *));
168
169 void ff_read_frame_flush(AVFormatContext *s);
170
171 #define NTP_OFFSET 2208988800ULL
172 #define NTP_OFFSET_US (NTP_OFFSET * 1000000ULL)
173
174 /** Get the current time since NTP epoch in microseconds. */
175 uint64_t ff_ntp_time(void);
176
177 /**
178  * Append the media-specific SDP fragment for the media stream c
179  * to the buffer buff.
180  *
181  * Note, the buffer needs to be initialized, since it is appended to
182  * existing content.
183  *
184  * @param buff the buffer to append the SDP fragment to
185  * @param size the size of the buff buffer
186  * @param st the AVStream of the media to describe
187  * @param idx the global stream index
188  * @param dest_addr the destination address of the media stream, may be NULL
189  * @param dest_type the destination address type, may be NULL
190  * @param port the destination port of the media stream, 0 if unknown
191  * @param ttl the time to live of the stream, 0 if not multicast
192  * @param fmt the AVFormatContext, which might contain options modifying
193  *            the generated SDP
194  */
195 void ff_sdp_write_media(char *buff, int size, AVStream *st, int idx,
196                         const char *dest_addr, const char *dest_type,
197                         int port, int ttl, AVFormatContext *fmt);
198
199 /**
200  * Write a packet to another muxer than the one the user originally
201  * intended. Useful when chaining muxers, where one muxer internally
202  * writes a received packet to another muxer.
203  *
204  * @param dst the muxer to write the packet to
205  * @param dst_stream the stream index within dst to write the packet to
206  * @param pkt the packet to be written
207  * @param src the muxer the packet originally was intended for
208  * @param interleave 0->use av_write_frame, 1->av_interleaved_write_frame
209  * @return the value av_write_frame returned
210  */
211 int ff_write_chained(AVFormatContext *dst, int dst_stream, AVPacket *pkt,
212                      AVFormatContext *src, int interleave);
213
214 /**
215  * Get the length in bytes which is needed to store val as v.
216  */
217 int ff_get_v_length(uint64_t val);
218
219 /**
220  * Put val using a variable number of bytes.
221  */
222 void ff_put_v(AVIOContext *bc, uint64_t val);
223
224 /**
225  * Read a whole line of text from AVIOContext. Stop reading after reaching
226  * either a \\n, a \\0 or EOF. The returned string is always \\0-terminated,
227  * and may be truncated if the buffer is too small.
228  *
229  * @param s the read-only AVIOContext
230  * @param buf buffer to store the read line
231  * @param maxlen size of the buffer
232  * @return the length of the string written in the buffer, not including the
233  *         final \\0
234  */
235 int ff_get_line(AVIOContext *s, char *buf, int maxlen);
236
237 #define SPACE_CHARS " \t\r\n"
238
239 /**
240  * Callback function type for ff_parse_key_value.
241  *
242  * @param key a pointer to the key
243  * @param key_len the number of bytes that belong to the key, including the '='
244  *                char
245  * @param dest return the destination pointer for the value in *dest, may
246  *             be null to ignore the value
247  * @param dest_len the length of the *dest buffer
248  */
249 typedef void (*ff_parse_key_val_cb)(void *context, const char *key,
250                                     int key_len, char **dest, int *dest_len);
251 /**
252  * Parse a string with comma-separated key=value pairs. The value strings
253  * may be quoted and may contain escaped characters within quoted strings.
254  *
255  * @param str the string to parse
256  * @param callback_get_buf function that returns where to store the
257  *                         unescaped value string.
258  * @param context the opaque context pointer to pass to callback_get_buf
259  */
260 void ff_parse_key_value(const char *str, ff_parse_key_val_cb callback_get_buf,
261                         void *context);
262
263 /**
264  * Find stream index based on format-specific stream ID
265  * @return stream index, or < 0 on error
266  */
267 int ff_find_stream_index(AVFormatContext *s, int id);
268
269 /**
270  * Internal version of av_index_search_timestamp
271  */
272 int ff_index_search_timestamp(const AVIndexEntry *entries, int nb_entries,
273                               int64_t wanted_timestamp, int flags);
274
275 /**
276  * Internal version of av_add_index_entry
277  */
278 int ff_add_index_entry(AVIndexEntry **index_entries,
279                        int *nb_index_entries,
280                        unsigned int *index_entries_allocated_size,
281                        int64_t pos, int64_t timestamp, int size, int distance, int flags);
282
283 void ff_configure_buffers_for_index(AVFormatContext *s, int64_t time_tolerance);
284
285 /**
286  * Add a new chapter.
287  *
288  * @param s media file handle
289  * @param id unique ID for this chapter
290  * @param start chapter start time in time_base units
291  * @param end chapter end time in time_base units
292  * @param title chapter title
293  *
294  * @return AVChapter or NULL on error
295  */
296 AVChapter *avpriv_new_chapter(AVFormatContext *s, int id, AVRational time_base,
297                               int64_t start, int64_t end, const char *title);
298
299 /**
300  * Ensure the index uses less memory than the maximum specified in
301  * AVFormatContext.max_index_size by discarding entries if it grows
302  * too large.
303  */
304 void ff_reduce_index(AVFormatContext *s, int stream_index);
305
306 enum AVCodecID ff_guess_image2_codec(const char *filename);
307
308 /**
309  * Convert a date string in ISO8601 format to Unix timestamp.
310  */
311 int64_t ff_iso8601_to_unix_time(const char *datestr);
312
313 /**
314  * Perform a binary search using av_index_search_timestamp() and
315  * AVInputFormat.read_timestamp().
316  *
317  * @param target_ts target timestamp in the time base of the given stream
318  * @param stream_index stream number
319  */
320 int ff_seek_frame_binary(AVFormatContext *s, int stream_index,
321                          int64_t target_ts, int flags);
322
323 /**
324  * Update cur_dts of all streams based on the given timestamp and AVStream.
325  *
326  * Stream ref_st unchanged, others set cur_dts in their native time base.
327  * Only needed for timestamp wrapping or if (dts not set and pts!=dts).
328  * @param timestamp new dts expressed in time_base of param ref_st
329  * @param ref_st reference stream giving time_base of param timestamp
330  */
331 void ff_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
332
333 int ff_find_last_ts(AVFormatContext *s, int stream_index, int64_t *ts, int64_t *pos,
334                     int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
335
336 /**
337  * Perform a binary search using read_timestamp().
338  *
339  * @param target_ts target timestamp in the time base of the given stream
340  * @param stream_index stream number
341  */
342 int64_t ff_gen_search(AVFormatContext *s, int stream_index,
343                       int64_t target_ts, int64_t pos_min,
344                       int64_t pos_max, int64_t pos_limit,
345                       int64_t ts_min, int64_t ts_max,
346                       int flags, int64_t *ts_ret,
347                       int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
348
349 /**
350  * Set the time base and wrapping info for a given stream. This will be used
351  * to interpret the stream's timestamps. If the new time base is invalid
352  * (numerator or denominator are non-positive), it leaves the stream
353  * unchanged.
354  *
355  * @param s stream
356  * @param pts_wrap_bits number of bits effectively used by the pts
357  *        (used for wrap control)
358  * @param pts_num time base numerator
359  * @param pts_den time base denominator
360  */
361 void avpriv_set_pts_info(AVStream *s, int pts_wrap_bits,
362                          unsigned int pts_num, unsigned int pts_den);
363
364 /**
365  * Add side data to a packet for changing parameters to the given values.
366  * Parameters set to 0 aren't included in the change.
367  */
368 int ff_add_param_change(AVPacket *pkt, int32_t channels,
369                         uint64_t channel_layout, int32_t sample_rate,
370                         int32_t width, int32_t height);
371
372 /**
373  * Set the timebase for each stream from the corresponding codec timebase and
374  * print it.
375  */
376 int ff_framehash_write_header(AVFormatContext *s);
377
378 /**
379  * Read a transport packet from a media file.
380  *
381  * @param s media file handle
382  * @param pkt is filled
383  * @return 0 if OK, AVERROR_xxx on error
384  */
385 int ff_read_packet(AVFormatContext *s, AVPacket *pkt);
386
387 /**
388  * Interleave a packet per dts in an output media file.
389  *
390  * Packets with pkt->destruct == av_destruct_packet will be freed inside this
391  * function, so they cannot be used after it. Note that calling av_packet_unref()
392  * on them is still safe.
393  *
394  * @param s media file handle
395  * @param out the interleaved packet will be output here
396  * @param pkt the input packet
397  * @param flush 1 if no further packets are available as input and all
398  *              remaining packets should be output
399  * @return 1 if a packet was output, 0 if no packet could be output,
400  *         < 0 if an error occurred
401  */
402 int ff_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
403                                  AVPacket *pkt, int flush);
404
405 void ff_free_stream(AVFormatContext *s, AVStream *st);
406
407 /**
408  * Return the frame duration in seconds. Return 0 if not available.
409  */
410 void ff_compute_frame_duration(AVFormatContext *s, int *pnum, int *pden, AVStream *st,
411                                AVCodecParserContext *pc, AVPacket *pkt);
412
413 unsigned int ff_codec_get_tag(const AVCodecTag *tags, enum AVCodecID id);
414
415 enum AVCodecID ff_codec_get_id(const AVCodecTag *tags, unsigned int tag);
416
417 /**
418  * Select a PCM codec based on the given parameters.
419  *
420  * @param bps     bits-per-sample
421  * @param flt     floating-point
422  * @param be      big-endian
423  * @param sflags  signed flags. each bit corresponds to one byte of bit depth.
424  *                e.g. the 1st bit indicates if 8-bit should be signed or
425  *                unsigned, the 2nd bit indicates if 16-bit should be signed or
426  *                unsigned, etc... This is useful for formats such as WAVE where
427  *                only 8-bit is unsigned and all other bit depths are signed.
428  * @return        a PCM codec id or AV_CODEC_ID_NONE
429  */
430 enum AVCodecID ff_get_pcm_codec_id(int bps, int flt, int be, int sflags);
431
432 /**
433  * Chooses a timebase for muxing the specified stream.
434  *
435  * The chosen timebase allows sample accurate timestamps based
436  * on the framerate or sample rate for audio streams. It also is
437  * at least as precise as 1/min_precision would be.
438  */
439 AVRational ff_choose_timebase(AVFormatContext *s, AVStream *st, int min_precision);
440
441 /**
442  * Chooses a timebase for muxing the specified stream.
443  */
444 enum AVChromaLocation ff_choose_chroma_location(AVFormatContext *s, AVStream *st);
445
446 /**
447  * Generate standard extradata for AVC-Intra based on width/height and field
448  * order.
449  */
450 int ff_generate_avci_extradata(AVStream *st);
451
452 /**
453  * Wrap errno on rename() error.
454  *
455  * @param oldpath source path
456  * @param newpath destination path
457  * @return        0 or AVERROR on failure
458  */
459 static inline int ff_rename(const char *oldpath, const char *newpath, void *logctx)
460 {
461     int ret = 0;
462     if (rename(oldpath, newpath) == -1) {
463         ret = AVERROR(errno);
464         if (logctx)
465             av_log(logctx, AV_LOG_ERROR, "failed to rename file %s to %s\n", oldpath, newpath);
466     }
467     return ret;
468 }
469
470 /**
471  * Add new side data to a stream. If a side data of this type already exists, it
472  * is replaced.
473  */
474 uint8_t *ff_stream_new_side_data(AVStream *st, enum AVPacketSideDataType type,
475                                  int size);
476
477 /**
478  * Allocate extradata with additional AV_INPUT_BUFFER_PADDING_SIZE at end
479  * which is always set to 0.
480  *
481  * @param size size of extradata
482  * @return 0 if OK, AVERROR_xxx on error
483  */
484 int ff_alloc_extradata(AVCodecContext *avctx, int size);
485
486 /**
487  * Allocate extradata with additional AV_INPUT_BUFFER_PADDING_SIZE at end
488  * which is always set to 0 and fill it from pb.
489  *
490  * @param size size of extradata
491  * @return >= 0 if OK, AVERROR_xxx on error
492  */
493 int ff_get_extradata(AVCodecContext *avctx, AVIOContext *pb, int size);
494
495 /**
496  * add frame for rfps calculation.
497  *
498  * @param dts timestamp of the i-th frame
499  * @return 0 if OK, AVERROR_xxx on error
500  */
501 int ff_rfps_add_frame(AVFormatContext *ic, AVStream *st, int64_t dts);
502
503 void ff_rfps_calculate(AVFormatContext *ic);
504
505 /**
506  * Flags for AVFormatContext.write_uncoded_frame()
507  */
508 enum AVWriteUncodedFrameFlags {
509
510     /**
511      * Query whether the feature is possible on this stream.
512      * The frame argument is ignored.
513      */
514     AV_WRITE_UNCODED_FRAME_QUERY           = 0x0001,
515
516 };
517
518 /**
519  * Copies the whilelists from one context to the other
520  */
521 int ff_copy_whitelists(AVFormatContext *dst, AVFormatContext *src);
522
523 int ffio_open2_wrapper(struct AVFormatContext *s, AVIOContext **pb, const char *url, int flags,
524                        const AVIOInterruptCB *int_cb, AVDictionary **options);
525
526 #endif /* AVFORMAT_INTERNAL_H */