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