52cd29b9b79b5f2c2be9db6ede6950afada49561
[ffmpeg.git] / libavformat / internal.h
1 /*
2  * copyright (c) 2001 Fabrice Bellard
3  *
4  * This file is part of Libav.
5  *
6  * Libav 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  * Libav 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 Libav; 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 #ifdef DEBUG
31 #    define hex_dump_debug(class, buf, size) av_hex_dump_log(class, AV_LOG_DEBUG, buf, size)
32 #else
33 #    define hex_dump_debug(class, buf, size)
34 #endif
35
36 typedef struct AVCodecTag {
37     enum AVCodecID id;
38     unsigned int tag;
39 } AVCodecTag;
40
41 typedef struct CodecMime{
42     char str[32];
43     enum AVCodecID id;
44 } CodecMime;
45
46 struct AVFormatInternal {
47     /**
48      * Number of streams relevant for interleaving.
49      * Muxing only.
50      */
51     int nb_interleaved_streams;
52
53     /**
54      * This buffer is only needed when packets were already buffered but
55      * not decoded, for example to get the codec parameters in MPEG
56      * streams.
57      */
58     struct AVPacketList *packet_buffer;
59     struct AVPacketList *packet_buffer_end;
60
61     /* av_seek_frame() support */
62     int64_t data_offset; /**< offset of the first packet */
63
64     /**
65      * Raw packets from the demuxer, prior to parsing and decoding.
66      * This buffer is used for buffering packets until the codec can
67      * be identified, as parsing cannot be done without knowing the
68      * codec.
69      */
70     struct AVPacketList *raw_packet_buffer;
71     struct AVPacketList *raw_packet_buffer_end;
72     /**
73      * Packets split by the parser get queued here.
74      */
75     struct AVPacketList *parse_queue;
76     struct AVPacketList *parse_queue_end;
77     /**
78      * Remaining size available for raw_packet_buffer, in bytes.
79      */
80 #define RAW_PACKET_BUFFER_SIZE 2500000
81     int raw_packet_buffer_remaining_size;
82
83     /**
84      * Offset to remap timestamps to be non-negative.
85      * Expressed in timebase units.
86      */
87     int64_t offset;
88
89     /**
90      * Timebase for the timestamp offset.
91      */
92     AVRational offset_timebase;
93
94 #if FF_API_COMPUTE_PKT_FIELDS2
95     int missing_ts_warning;
96 #endif
97 };
98
99 struct AVStreamInternal {
100     /**
101      * Set to 1 if the codec allows reordering, so pts can be different
102      * from dts.
103      */
104     int reorder;
105     /**
106      * The codec context used by avformat_find_stream_info, the parser, etc.
107      */
108     AVCodecContext *avctx;
109     /**
110      * 1 if avctx has been initialized with the values from the codec parameters
111      */
112     int avctx_inited;
113
114     enum AVCodecID orig_codec_id;
115
116     /* the context for extracting extradata in find_stream_info()
117      * inited=1/bsf=NULL signals that extracting is not possible (codec not
118      * supported) */
119     struct {
120         AVBSFContext *bsf;
121         AVPacket     *pkt;
122         int inited;
123     } extract_extradata;
124
125 #if FF_API_LAVF_AVCTX
126     // whether the deprecated stream codec context needs
127     // to be filled from the codec parameters
128     int need_codec_update;
129 #endif
130 };
131
132 void ff_dynarray_add(intptr_t **tab_ptr, int *nb_ptr, intptr_t elem);
133
134 #ifdef __GNUC__
135 #define dynarray_add(tab, nb_ptr, elem)\
136 do {\
137     __typeof__(tab) _tab = (tab);\
138     __typeof__(elem) _elem = (elem);\
139     (void)sizeof(**_tab == _elem); /* check that types are compatible */\
140     ff_dynarray_add((intptr_t **)_tab, nb_ptr, (intptr_t)_elem);\
141 } while(0)
142 #else
143 #define dynarray_add(tab, nb_ptr, elem)\
144 do {\
145     ff_dynarray_add((intptr_t **)(tab), nb_ptr, (intptr_t)(elem));\
146 } while(0)
147 #endif
148
149 struct tm *ff_brktimegm(time_t secs, struct tm *tm);
150
151 char *ff_data_to_hex(char *buf, const uint8_t *src, int size, int lowercase);
152
153 /**
154  * Parse a string of hexadecimal strings. Any space between the hexadecimal
155  * digits is ignored.
156  *
157  * @param data if non-null, the parsed data is written to this pointer
158  * @param p the string to parse
159  * @return the number of bytes written (or to be written, if data is null)
160  */
161 int ff_hex_to_data(uint8_t *data, const char *p);
162
163 void ff_program_add_stream_index(AVFormatContext *ac, int progid, unsigned int idx);
164
165 /**
166  * Add packet to AVFormatContext->packet_buffer list, determining its
167  * interleaved position using compare() function argument.
168  */
169 int ff_interleave_add_packet(AVFormatContext *s, AVPacket *pkt,
170                              int (*compare)(AVFormatContext *, AVPacket *, AVPacket *));
171
172 void ff_read_frame_flush(AVFormatContext *s);
173
174 #define NTP_OFFSET 2208988800ULL
175 #define NTP_OFFSET_US (NTP_OFFSET * 1000000ULL)
176
177 /** Get the current time since NTP epoch in microseconds. */
178 uint64_t ff_ntp_time(void);
179
180 /**
181  * Append the media-specific SDP fragment for the media stream c
182  * to the buffer buff.
183  *
184  * Note, the buffer needs to be initialized, since it is appended to
185  * existing content.
186  *
187  * @param buff the buffer to append the SDP fragment to
188  * @param size the size of the buff buffer
189  * @param st the AVStream of the media to describe
190  * @param idx the global stream index
191  * @param dest_addr the destination address of the media stream, may be NULL
192  * @param dest_type the destination address type, may be NULL
193  * @param port the destination port of the media stream, 0 if unknown
194  * @param ttl the time to live of the stream, 0 if not multicast
195  * @param fmt the AVFormatContext, which might contain options modifying
196  *            the generated SDP
197  */
198 void ff_sdp_write_media(char *buff, int size, AVStream *st, int idx,
199                         const char *dest_addr, const char *dest_type,
200                         int port, int ttl, AVFormatContext *fmt);
201
202 /**
203  * Write a packet to another muxer than the one the user originally
204  * intended. Useful when chaining muxers, where one muxer internally
205  * writes a received packet to another muxer.
206  *
207  * @param dst the muxer to write the packet to
208  * @param dst_stream the stream index within dst to write the packet to
209  * @param pkt the packet to be written
210  * @param src the muxer the packet originally was intended for
211  * @return the value av_write_frame returned
212  */
213 int ff_write_chained(AVFormatContext *dst, int dst_stream, AVPacket *pkt,
214                      AVFormatContext *src);
215
216 /**
217  * Get the length in bytes which is needed to store val as v.
218  */
219 int ff_get_v_length(uint64_t val);
220
221 /**
222  * Put val using a variable number of bytes.
223  */
224 void ff_put_v(AVIOContext *bc, uint64_t val);
225
226 /**
227  * Read a whole line of text from AVIOContext. Stop reading after reaching
228  * either a \\n, a \\0 or EOF. The returned string is always \\0-terminated,
229  * and may be truncated if the buffer is too small.
230  *
231  * @param s the read-only AVIOContext
232  * @param buf buffer to store the read line
233  * @param maxlen size of the buffer
234  * @return the length of the string written in the buffer, not including the
235  *         final \\0
236  */
237 int ff_get_line(AVIOContext *s, char *buf, int maxlen);
238
239 #define SPACE_CHARS " \t\r\n"
240
241 /**
242  * Callback function type for ff_parse_key_value.
243  *
244  * @param key a pointer to the key
245  * @param key_len the number of bytes that belong to the key, including the '='
246  *                char
247  * @param dest return the destination pointer for the value in *dest, may
248  *             be null to ignore the value
249  * @param dest_len the length of the *dest buffer
250  */
251 typedef void (*ff_parse_key_val_cb)(void *context, const char *key,
252                                     int key_len, char **dest, int *dest_len);
253 /**
254  * Parse a string with comma-separated key=value pairs. The value strings
255  * may be quoted and may contain escaped characters within quoted strings.
256  *
257  * @param str the string to parse
258  * @param callback_get_buf function that returns where to store the
259  *                         unescaped value string.
260  * @param context the opaque context pointer to pass to callback_get_buf
261  */
262 void ff_parse_key_value(const char *str, ff_parse_key_val_cb callback_get_buf,
263                         void *context);
264
265 /**
266  * Find stream index based on format-specific stream ID
267  * @return stream index, or < 0 on error
268  */
269 int ff_find_stream_index(AVFormatContext *s, int id);
270
271 /**
272  * Internal version of av_index_search_timestamp
273  */
274 int ff_index_search_timestamp(const AVIndexEntry *entries, int nb_entries,
275                               int64_t wanted_timestamp, int flags);
276
277 /**
278  * Internal version of av_add_index_entry
279  */
280 int ff_add_index_entry(AVIndexEntry **index_entries,
281                        int *nb_index_entries,
282                        unsigned int *index_entries_allocated_size,
283                        int64_t pos, int64_t timestamp, int size, int distance, int flags);
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 /**
334  * Perform a binary search using read_timestamp().
335  *
336  * @param target_ts target timestamp in the time base of the given stream
337  * @param stream_index stream number
338  */
339 int64_t ff_gen_search(AVFormatContext *s, int stream_index,
340                       int64_t target_ts, int64_t pos_min,
341                       int64_t pos_max, int64_t pos_limit,
342                       int64_t ts_min, int64_t ts_max,
343                       int flags, int64_t *ts_ret,
344                       int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
345
346 /**
347  * Set the time base and wrapping info for a given stream. This will be used
348  * to interpret the stream's timestamps. If the new time base is invalid
349  * (numerator or denominator are non-positive), it leaves the stream
350  * unchanged.
351  *
352  * @param s stream
353  * @param pts_wrap_bits number of bits effectively used by the pts
354  *        (used for wrap control)
355  * @param pts_num time base numerator
356  * @param pts_den time base denominator
357  */
358 void avpriv_set_pts_info(AVStream *s, int pts_wrap_bits,
359                          unsigned int pts_num, unsigned int pts_den);
360
361 /**
362  * Add side data to a packet for changing parameters to the given values.
363  * Parameters set to 0 aren't included in the change.
364  */
365 int ff_add_param_change(AVPacket *pkt, int32_t channels,
366                         uint64_t channel_layout, int32_t sample_rate,
367                         int32_t width, int32_t height);
368
369 /**
370  * Set the timebase for each stream from the corresponding codec timebase and
371  * print it.
372  */
373 int ff_framehash_write_header(AVFormatContext *s);
374
375 /**
376  * Read a transport packet from a media file.
377  *
378  * @param s media file handle
379  * @param pkt is filled
380  * @return 0 if OK, AVERROR_xxx on error
381  */
382 int ff_read_packet(AVFormatContext *s, AVPacket *pkt);
383
384 /**
385  * Interleave a packet per dts in an output media file.
386  *
387  * Packets with pkt->destruct == av_destruct_packet will be freed inside this
388  * function, so they cannot be used after it. Note that calling av_packet_unref()
389  * on them is still safe.
390  *
391  * @param s media file handle
392  * @param out the interleaved packet will be output here
393  * @param pkt the input packet
394  * @param flush 1 if no further packets are available as input and all
395  *              remaining packets should be output
396  * @return 1 if a packet was output, 0 if no packet could be output,
397  *         < 0 if an error occurred
398  */
399 int ff_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
400                                  AVPacket *pkt, int flush);
401
402 /**
403  * Return the frame duration in seconds. Return 0 if not available.
404  */
405 void ff_compute_frame_duration(AVFormatContext *s, int *pnum, int *pden, AVStream *st,
406                                AVCodecParserContext *pc, AVPacket *pkt);
407
408 unsigned int ff_codec_get_tag(const AVCodecTag *tags, enum AVCodecID id);
409
410 enum AVCodecID ff_codec_get_id(const AVCodecTag *tags, unsigned int tag);
411
412 /**
413  * Select a PCM codec based on the given parameters.
414  *
415  * @param bps     bits-per-sample
416  * @param flt     floating-point
417  * @param be      big-endian
418  * @param sflags  signed flags. each bit corresponds to one byte of bit depth.
419  *                e.g. the 1st bit indicates if 8-bit should be signed or
420  *                unsigned, the 2nd bit indicates if 16-bit should be signed or
421  *                unsigned, etc... This is useful for formats such as WAVE where
422  *                only 8-bit is unsigned and all other bit depths are signed.
423  * @return        a PCM codec id or AV_CODEC_ID_NONE
424  */
425 enum AVCodecID ff_get_pcm_codec_id(int bps, int flt, int be, int sflags);
426
427 /**
428  * Generate standard extradata for AVC-Intra based on width/height and field
429  * order.
430  */
431 int ff_generate_avci_extradata(AVStream *st);
432
433 /**
434  * Wrap errno on rename() error.
435  *
436  * @param oldpath source path
437  * @param newpath destination path
438  * @return        0 or AVERROR on failure
439  */
440 static inline int ff_rename(const char *oldpath, const char *newpath)
441 {
442     if (rename(oldpath, newpath) == -1)
443         return AVERROR(errno);
444     return 0;
445 }
446
447 /**
448  * A wrapper around AVFormatContext.io_close that should be used
449  * instead of calling the pointer directly.
450  */
451 void ff_format_io_close(AVFormatContext *s, AVIOContext **pb);
452
453 /**
454  * Find the next packet in the interleaving queue for the given stream.
455  * The pkt parameter is filled in with the queued packet, including
456  * references to the data (which the caller is not allowed to keep or
457  * modify).
458  *
459  * @return 0 if a packet was found, a negative value if no packet was found
460  */
461 int ff_interleaved_peek(AVFormatContext *s, int stream,
462                         AVPacket *pkt, int add_offset);
463
464 #endif /* AVFORMAT_INTERNAL_H */