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