f08ad90038034557eda4a6eec1ad0480cc0e1db0
[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
95 void ff_dynarray_add(intptr_t **tab_ptr, int *nb_ptr, intptr_t elem);
96
97 #ifdef __GNUC__
98 #define dynarray_add(tab, nb_ptr, elem)\
99 do {\
100     __typeof__(tab) _tab = (tab);\
101     __typeof__(elem) _elem = (elem);\
102     (void)sizeof(**_tab == _elem); /* check that types are compatible */\
103     ff_dynarray_add((intptr_t **)_tab, nb_ptr, (intptr_t)_elem);\
104 } while(0)
105 #else
106 #define dynarray_add(tab, nb_ptr, elem)\
107 do {\
108     ff_dynarray_add((intptr_t **)(tab), nb_ptr, (intptr_t)(elem));\
109 } while(0)
110 #endif
111
112 struct tm *ff_brktimegm(time_t secs, struct tm *tm);
113
114 char *ff_data_to_hex(char *buf, const uint8_t *src, int size, int lowercase);
115
116 /**
117  * Parse a string of hexadecimal strings. Any space between the hexadecimal
118  * digits is ignored.
119  *
120  * @param data if non-null, the parsed data is written to this pointer
121  * @param p the string to parse
122  * @return the number of bytes written (or to be written, if data is null)
123  */
124 int ff_hex_to_data(uint8_t *data, const char *p);
125
126 void ff_program_add_stream_index(AVFormatContext *ac, int progid, unsigned int idx);
127
128 /**
129  * Add packet to AVFormatContext->packet_buffer list, determining its
130  * interleaved position using compare() function argument.
131  */
132 int ff_interleave_add_packet(AVFormatContext *s, AVPacket *pkt,
133                              int (*compare)(AVFormatContext *, AVPacket *, AVPacket *));
134
135 void ff_read_frame_flush(AVFormatContext *s);
136
137 #define NTP_OFFSET 2208988800ULL
138 #define NTP_OFFSET_US (NTP_OFFSET * 1000000ULL)
139
140 /** Get the current time since NTP epoch in microseconds. */
141 uint64_t ff_ntp_time(void);
142
143 /**
144  * Append the media-specific SDP fragment for the media stream c
145  * to the buffer buff.
146  *
147  * Note, the buffer needs to be initialized, since it is appended to
148  * existing content.
149  *
150  * @param buff the buffer to append the SDP fragment to
151  * @param size the size of the buff buffer
152  * @param st the AVStream of the media to describe
153  * @param idx the global stream index
154  * @param dest_addr the destination address of the media stream, may be NULL
155  * @param dest_type the destination address type, may be NULL
156  * @param port the destination port of the media stream, 0 if unknown
157  * @param ttl the time to live of the stream, 0 if not multicast
158  * @param fmt the AVFormatContext, which might contain options modifying
159  *            the generated SDP
160  */
161 void ff_sdp_write_media(char *buff, int size, AVStream *st, int idx,
162                         const char *dest_addr, const char *dest_type,
163                         int port, int ttl, AVFormatContext *fmt);
164
165 /**
166  * Write a packet to another muxer than the one the user originally
167  * intended. Useful when chaining muxers, where one muxer internally
168  * writes a received packet to another muxer.
169  *
170  * @param dst the muxer to write the packet to
171  * @param dst_stream the stream index within dst to write the packet to
172  * @param pkt the packet to be written
173  * @param src the muxer the packet originally was intended for
174  * @return the value av_write_frame returned
175  */
176 int ff_write_chained(AVFormatContext *dst, int dst_stream, AVPacket *pkt,
177                      AVFormatContext *src);
178
179 /**
180  * Get the length in bytes which is needed to store val as v.
181  */
182 int ff_get_v_length(uint64_t val);
183
184 /**
185  * Put val using a variable number of bytes.
186  */
187 void ff_put_v(AVIOContext *bc, uint64_t val);
188
189 /**
190  * Read a whole line of text from AVIOContext. Stop reading after reaching
191  * either a \\n, a \\0 or EOF. The returned string is always \\0-terminated,
192  * and may be truncated if the buffer is too small.
193  *
194  * @param s the read-only AVIOContext
195  * @param buf buffer to store the read line
196  * @param maxlen size of the buffer
197  * @return the length of the string written in the buffer, not including the
198  *         final \\0
199  */
200 int ff_get_line(AVIOContext *s, char *buf, int maxlen);
201
202 #define SPACE_CHARS " \t\r\n"
203
204 /**
205  * Callback function type for ff_parse_key_value.
206  *
207  * @param key a pointer to the key
208  * @param key_len the number of bytes that belong to the key, including the '='
209  *                char
210  * @param dest return the destination pointer for the value in *dest, may
211  *             be null to ignore the value
212  * @param dest_len the length of the *dest buffer
213  */
214 typedef void (*ff_parse_key_val_cb)(void *context, const char *key,
215                                     int key_len, char **dest, int *dest_len);
216 /**
217  * Parse a string with comma-separated key=value pairs. The value strings
218  * may be quoted and may contain escaped characters within quoted strings.
219  *
220  * @param str the string to parse
221  * @param callback_get_buf function that returns where to store the
222  *                         unescaped value string.
223  * @param context the opaque context pointer to pass to callback_get_buf
224  */
225 void ff_parse_key_value(const char *str, ff_parse_key_val_cb callback_get_buf,
226                         void *context);
227
228 /**
229  * Find stream index based on format-specific stream ID
230  * @return stream index, or < 0 on error
231  */
232 int ff_find_stream_index(AVFormatContext *s, int id);
233
234 /**
235  * Internal version of av_index_search_timestamp
236  */
237 int ff_index_search_timestamp(const AVIndexEntry *entries, int nb_entries,
238                               int64_t wanted_timestamp, int flags);
239
240 /**
241  * Internal version of av_add_index_entry
242  */
243 int ff_add_index_entry(AVIndexEntry **index_entries,
244                        int *nb_index_entries,
245                        unsigned int *index_entries_allocated_size,
246                        int64_t pos, int64_t timestamp, int size, int distance, int flags);
247
248 /**
249  * Add a new chapter.
250  *
251  * @param s media file handle
252  * @param id unique ID for this chapter
253  * @param start chapter start time in time_base units
254  * @param end chapter end time in time_base units
255  * @param title chapter title
256  *
257  * @return AVChapter or NULL on error
258  */
259 AVChapter *avpriv_new_chapter(AVFormatContext *s, int id, AVRational time_base,
260                               int64_t start, int64_t end, const char *title);
261
262 /**
263  * Ensure the index uses less memory than the maximum specified in
264  * AVFormatContext.max_index_size by discarding entries if it grows
265  * too large.
266  */
267 void ff_reduce_index(AVFormatContext *s, int stream_index);
268
269 enum AVCodecID ff_guess_image2_codec(const char *filename);
270
271 /**
272  * Convert a date string in ISO8601 format to Unix timestamp.
273  */
274 int64_t ff_iso8601_to_unix_time(const char *datestr);
275
276 /**
277  * Perform a binary search using av_index_search_timestamp() and
278  * AVInputFormat.read_timestamp().
279  *
280  * @param target_ts target timestamp in the time base of the given stream
281  * @param stream_index stream number
282  */
283 int ff_seek_frame_binary(AVFormatContext *s, int stream_index,
284                          int64_t target_ts, int flags);
285
286 /**
287  * Update cur_dts of all streams based on the given timestamp and AVStream.
288  *
289  * Stream ref_st unchanged, others set cur_dts in their native time base.
290  * Only needed for timestamp wrapping or if (dts not set and pts!=dts).
291  * @param timestamp new dts expressed in time_base of param ref_st
292  * @param ref_st reference stream giving time_base of param timestamp
293  */
294 void ff_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
295
296 /**
297  * Perform a binary search using read_timestamp().
298  *
299  * @param target_ts target timestamp in the time base of the given stream
300  * @param stream_index stream number
301  */
302 int64_t ff_gen_search(AVFormatContext *s, int stream_index,
303                       int64_t target_ts, int64_t pos_min,
304                       int64_t pos_max, int64_t pos_limit,
305                       int64_t ts_min, int64_t ts_max,
306                       int flags, int64_t *ts_ret,
307                       int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
308
309 /**
310  * Set the time base and wrapping info for a given stream. This will be used
311  * to interpret the stream's timestamps. If the new time base is invalid
312  * (numerator or denominator are non-positive), it leaves the stream
313  * unchanged.
314  *
315  * @param s stream
316  * @param pts_wrap_bits number of bits effectively used by the pts
317  *        (used for wrap control)
318  * @param pts_num time base numerator
319  * @param pts_den time base denominator
320  */
321 void avpriv_set_pts_info(AVStream *s, int pts_wrap_bits,
322                          unsigned int pts_num, unsigned int pts_den);
323
324 /**
325  * Add side data to a packet for changing parameters to the given values.
326  * Parameters set to 0 aren't included in the change.
327  */
328 int ff_add_param_change(AVPacket *pkt, int32_t channels,
329                         uint64_t channel_layout, int32_t sample_rate,
330                         int32_t width, int32_t height);
331
332 /**
333  * Set the timebase for each stream from the corresponding codec timebase and
334  * print it.
335  */
336 int ff_framehash_write_header(AVFormatContext *s);
337
338 /**
339  * Read a transport packet from a media file.
340  *
341  * @param s media file handle
342  * @param pkt is filled
343  * @return 0 if OK, AVERROR_xxx on error
344  */
345 int ff_read_packet(AVFormatContext *s, AVPacket *pkt);
346
347 /**
348  * Interleave a packet per dts in an output media file.
349  *
350  * Packets with pkt->destruct == av_destruct_packet will be freed inside this
351  * function, so they cannot be used after it. Note that calling av_free_packet()
352  * on them is still safe.
353  *
354  * @param s media file handle
355  * @param out the interleaved packet will be output here
356  * @param pkt the input packet
357  * @param flush 1 if no further packets are available as input and all
358  *              remaining packets should be output
359  * @return 1 if a packet was output, 0 if no packet could be output,
360  *         < 0 if an error occurred
361  */
362 int ff_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
363                                  AVPacket *pkt, int flush);
364
365 /**
366  * Return the frame duration in seconds. Return 0 if not available.
367  */
368 void ff_compute_frame_duration(AVFormatContext *s, int *pnum, int *pden, AVStream *st,
369                                AVCodecParserContext *pc, AVPacket *pkt);
370
371 unsigned int ff_codec_get_tag(const AVCodecTag *tags, enum AVCodecID id);
372
373 enum AVCodecID ff_codec_get_id(const AVCodecTag *tags, unsigned int tag);
374
375 /**
376  * Select a PCM codec based on the given parameters.
377  *
378  * @param bps     bits-per-sample
379  * @param flt     floating-point
380  * @param be      big-endian
381  * @param sflags  signed flags. each bit corresponds to one byte of bit depth.
382  *                e.g. the 1st bit indicates if 8-bit should be signed or
383  *                unsigned, the 2nd bit indicates if 16-bit should be signed or
384  *                unsigned, etc... This is useful for formats such as WAVE where
385  *                only 8-bit is unsigned and all other bit depths are signed.
386  * @return        a PCM codec id or AV_CODEC_ID_NONE
387  */
388 enum AVCodecID ff_get_pcm_codec_id(int bps, int flt, int be, int sflags);
389
390 /**
391  * Generate standard extradata for AVC-Intra based on width/height and field
392  * order.
393  */
394 int ff_generate_avci_extradata(AVStream *st);
395
396 /**
397  * Wrap errno on rename() error.
398  *
399  * @param oldpath source path
400  * @param newpath destination path
401  * @return        0 or AVERROR on failure
402  */
403 static inline int ff_rename(const char *oldpath, const char *newpath)
404 {
405     if (rename(oldpath, newpath) == -1)
406         return AVERROR(errno);
407     return 0;
408 }
409
410 /**
411  * Add new side data to a stream. If a side data of this type already exists, it
412  * is replaced.
413  */
414 uint8_t *ff_stream_new_side_data(AVStream *st, enum AVPacketSideDataType type,
415                                  int size);
416
417 #endif /* AVFORMAT_INTERNAL_H */