lavf: move ff_codec_get_tag() and ff_codec_get_id() definitions to internal.h
[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
27 #define MAX_URL_SIZE 4096
28
29 #ifdef DEBUG
30 #    define hex_dump_debug(class, buf, size) av_hex_dump_log(class, AV_LOG_DEBUG, buf, size)
31 #else
32 #    define hex_dump_debug(class, buf, size)
33 #endif
34
35 typedef struct AVCodecTag {
36     enum AVCodecID id;
37     unsigned int tag;
38 } AVCodecTag;
39
40 typedef struct CodecMime{
41     char str[32];
42     enum AVCodecID id;
43 } CodecMime;
44
45 void ff_dynarray_add(intptr_t **tab_ptr, int *nb_ptr, intptr_t elem);
46
47 #ifdef __GNUC__
48 #define dynarray_add(tab, nb_ptr, elem)\
49 do {\
50     __typeof__(tab) _tab = (tab);\
51     __typeof__(elem) _elem = (elem);\
52     (void)sizeof(**_tab == _elem); /* check that types are compatible */\
53     ff_dynarray_add((intptr_t **)_tab, nb_ptr, (intptr_t)_elem);\
54 } while(0)
55 #else
56 #define dynarray_add(tab, nb_ptr, elem)\
57 do {\
58     ff_dynarray_add((intptr_t **)(tab), nb_ptr, (intptr_t)(elem));\
59 } while(0)
60 #endif
61
62 struct tm *ff_brktimegm(time_t secs, struct tm *tm);
63
64 char *ff_data_to_hex(char *buf, const uint8_t *src, int size, int lowercase);
65
66 /**
67  * Parse a string of hexadecimal strings. Any space between the hexadecimal
68  * digits is ignored.
69  *
70  * @param data if non-null, the parsed data is written to this pointer
71  * @param p the string to parse
72  * @return the number of bytes written (or to be written, if data is null)
73  */
74 int ff_hex_to_data(uint8_t *data, const char *p);
75
76 void ff_program_add_stream_index(AVFormatContext *ac, int progid, unsigned int idx);
77
78 /**
79  * Add packet to AVFormatContext->packet_buffer list, determining its
80  * interleaved position using compare() function argument.
81  */
82 void ff_interleave_add_packet(AVFormatContext *s, AVPacket *pkt,
83                               int (*compare)(AVFormatContext *, AVPacket *, AVPacket *));
84
85 void ff_read_frame_flush(AVFormatContext *s);
86
87 #define NTP_OFFSET 2208988800ULL
88 #define NTP_OFFSET_US (NTP_OFFSET * 1000000ULL)
89
90 /** Get the current time since NTP epoch in microseconds. */
91 uint64_t ff_ntp_time(void);
92
93 /**
94  * Assemble a URL string from components. This is the reverse operation
95  * of av_url_split.
96  *
97  * Note, this requires networking to be initialized, so the caller must
98  * ensure ff_network_init has been called.
99  *
100  * @see av_url_split
101  *
102  * @param str the buffer to fill with the url
103  * @param size the size of the str buffer
104  * @param proto the protocol identifier, if null, the separator
105  *              after the identifier is left out, too
106  * @param authorization an optional authorization string, may be null.
107  *                      An empty string is treated the same as a null string.
108  * @param hostname the host name string
109  * @param port the port number, left out from the string if negative
110  * @param fmt a generic format string for everything to add after the
111  *            host/port, may be null
112  * @return the number of characters written to the destination buffer
113  */
114 int ff_url_join(char *str, int size, const char *proto,
115                 const char *authorization, const char *hostname,
116                 int port, const char *fmt, ...) av_printf_format(7, 8);
117
118 /**
119  * Append the media-specific SDP fragment for the media stream c
120  * to the buffer buff.
121  *
122  * Note, the buffer needs to be initialized, since it is appended to
123  * existing content.
124  *
125  * @param buff the buffer to append the SDP fragment to
126  * @param size the size of the buff buffer
127  * @param st the AVStream of the media to describe
128  * @param idx the global stream index
129  * @param dest_addr the destination address of the media stream, may be NULL
130  * @param dest_type the destination address type, may be NULL
131  * @param port the destination port of the media stream, 0 if unknown
132  * @param ttl the time to live of the stream, 0 if not multicast
133  * @param fmt the AVFormatContext, which might contain options modifying
134  *            the generated SDP
135  */
136 void ff_sdp_write_media(char *buff, int size, AVStream *st, int idx,
137                         const char *dest_addr, const char *dest_type,
138                         int port, int ttl, AVFormatContext *fmt);
139
140 /**
141  * Write a packet to another muxer than the one the user originally
142  * intended. Useful when chaining muxers, where one muxer internally
143  * writes a received packet to another muxer.
144  *
145  * @param dst the muxer to write the packet to
146  * @param dst_stream the stream index within dst to write the packet to
147  * @param pkt the packet to be written
148  * @param src the muxer the packet originally was intended for
149  * @return the value av_write_frame returned
150  */
151 int ff_write_chained(AVFormatContext *dst, int dst_stream, AVPacket *pkt,
152                      AVFormatContext *src);
153
154 /**
155  * Get the length in bytes which is needed to store val as v.
156  */
157 int ff_get_v_length(uint64_t val);
158
159 /**
160  * Put val using a variable number of bytes.
161  */
162 void ff_put_v(AVIOContext *bc, uint64_t val);
163
164 /**
165  * Read a whole line of text from AVIOContext. Stop reading after reaching
166  * either a \\n, a \\0 or EOF. The returned string is always \\0-terminated,
167  * and may be truncated if the buffer is too small.
168  *
169  * @param s the read-only AVIOContext
170  * @param buf buffer to store the read line
171  * @param maxlen size of the buffer
172  * @return the length of the string written in the buffer, not including the
173  *         final \\0
174  */
175 int ff_get_line(AVIOContext *s, char *buf, int maxlen);
176
177 #define SPACE_CHARS " \t\r\n"
178
179 /**
180  * Callback function type for ff_parse_key_value.
181  *
182  * @param key a pointer to the key
183  * @param key_len the number of bytes that belong to the key, including the '='
184  *                char
185  * @param dest return the destination pointer for the value in *dest, may
186  *             be null to ignore the value
187  * @param dest_len the length of the *dest buffer
188  */
189 typedef void (*ff_parse_key_val_cb)(void *context, const char *key,
190                                     int key_len, char **dest, int *dest_len);
191 /**
192  * Parse a string with comma-separated key=value pairs. The value strings
193  * may be quoted and may contain escaped characters within quoted strings.
194  *
195  * @param str the string to parse
196  * @param callback_get_buf function that returns where to store the
197  *                         unescaped value string.
198  * @param context the opaque context pointer to pass to callback_get_buf
199  */
200 void ff_parse_key_value(const char *str, ff_parse_key_val_cb callback_get_buf,
201                         void *context);
202
203 /**
204  * Find stream index based on format-specific stream ID
205  * @return stream index, or < 0 on error
206  */
207 int ff_find_stream_index(AVFormatContext *s, int id);
208
209 /**
210  * Internal version of av_index_search_timestamp
211  */
212 int ff_index_search_timestamp(const AVIndexEntry *entries, int nb_entries,
213                               int64_t wanted_timestamp, int flags);
214
215 /**
216  * Internal version of av_add_index_entry
217  */
218 int ff_add_index_entry(AVIndexEntry **index_entries,
219                        int *nb_index_entries,
220                        unsigned int *index_entries_allocated_size,
221                        int64_t pos, int64_t timestamp, int size, int distance, int flags);
222
223 /**
224  * Add a new chapter.
225  *
226  * @param s media file handle
227  * @param id unique ID for this chapter
228  * @param start chapter start time in time_base units
229  * @param end chapter end time in time_base units
230  * @param title chapter title
231  *
232  * @return AVChapter or NULL on error
233  */
234 AVChapter *avpriv_new_chapter(AVFormatContext *s, int id, AVRational time_base,
235                               int64_t start, int64_t end, const char *title);
236
237 /**
238  * Ensure the index uses less memory than the maximum specified in
239  * AVFormatContext.max_index_size by discarding entries if it grows
240  * too large.
241  */
242 void ff_reduce_index(AVFormatContext *s, int stream_index);
243
244 /*
245  * Convert a relative url into an absolute url, given a base url.
246  *
247  * @param buf the buffer where output absolute url is written
248  * @param size the size of buf
249  * @param base the base url, may be equal to buf.
250  * @param rel the new url, which is interpreted relative to base
251  */
252 void ff_make_absolute_url(char *buf, int size, const char *base,
253                           const char *rel);
254
255 enum AVCodecID ff_guess_image2_codec(const char *filename);
256
257 /**
258  * Convert a date string in ISO8601 format to Unix timestamp.
259  */
260 int64_t ff_iso8601_to_unix_time(const char *datestr);
261
262 /**
263  * Perform a binary search using av_index_search_timestamp() and
264  * AVInputFormat.read_timestamp().
265  *
266  * @param target_ts target timestamp in the time base of the given stream
267  * @param stream_index stream number
268  */
269 int ff_seek_frame_binary(AVFormatContext *s, int stream_index,
270                          int64_t target_ts, int flags);
271
272 /**
273  * Update cur_dts of all streams based on the given timestamp and AVStream.
274  *
275  * Stream ref_st unchanged, others set cur_dts in their native time base.
276  * Only needed for timestamp wrapping or if (dts not set and pts!=dts).
277  * @param timestamp new dts expressed in time_base of param ref_st
278  * @param ref_st reference stream giving time_base of param timestamp
279  */
280 void ff_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
281
282 /**
283  * Perform a binary search using read_timestamp().
284  *
285  * @param target_ts target timestamp in the time base of the given stream
286  * @param stream_index stream number
287  */
288 int64_t ff_gen_search(AVFormatContext *s, int stream_index,
289                       int64_t target_ts, int64_t pos_min,
290                       int64_t pos_max, int64_t pos_limit,
291                       int64_t ts_min, int64_t ts_max,
292                       int flags, int64_t *ts_ret,
293                       int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
294
295 /**
296  * Set the pts for a given stream. If the new values would be invalid
297  * (<= 0), it leaves the AVStream unchanged.
298  *
299  * @param s stream
300  * @param pts_wrap_bits number of bits effectively used by the pts
301  *        (used for wrap control, 33 is the value for MPEG)
302  * @param pts_num numerator to convert to seconds (MPEG: 1)
303  * @param pts_den denominator to convert to seconds (MPEG: 90000)
304  */
305 void avpriv_set_pts_info(AVStream *s, int pts_wrap_bits,
306                          unsigned int pts_num, unsigned int pts_den);
307
308 /**
309  * Add side data to a packet for changing parameters to the given values.
310  * Parameters set to 0 aren't included in the change.
311  */
312 int ff_add_param_change(AVPacket *pkt, int32_t channels,
313                         uint64_t channel_layout, int32_t sample_rate,
314                         int32_t width, int32_t height);
315
316 /**
317  * Set the timebase for each stream from the corresponding codec timebase and
318  * print it.
319  */
320 int ff_framehash_write_header(AVFormatContext *s);
321
322 /**
323  * Read a transport packet from a media file.
324  *
325  * @param s media file handle
326  * @param pkt is filled
327  * @return 0 if OK, AVERROR_xxx on error
328  */
329 int ff_read_packet(AVFormatContext *s, AVPacket *pkt);
330
331 /**
332  * Interleave a packet per dts in an output media file.
333  *
334  * Packets with pkt->destruct == av_destruct_packet will be freed inside this
335  * function, so they cannot be used after it. Note that calling av_free_packet()
336  * on them is still safe.
337  *
338  * @param s media file handle
339  * @param out the interleaved packet will be output here
340  * @param pkt the input packet
341  * @param flush 1 if no further packets are available as input and all
342  *              remaining packets should be output
343  * @return 1 if a packet was output, 0 if no packet could be output,
344  *         < 0 if an error occurred
345  */
346 int ff_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
347                                  AVPacket *pkt, int flush);
348
349 /**
350  * Return the frame duration in seconds. Return 0 if not available.
351  */
352 void ff_compute_frame_duration(int *pnum, int *pden, AVStream *st,
353                                AVCodecParserContext *pc, AVPacket *pkt);
354
355 int ff_get_audio_frame_size(AVCodecContext *enc, int size, int mux);
356
357 unsigned int ff_codec_get_tag(const AVCodecTag *tags, enum AVCodecID id);
358
359 enum AVCodecID ff_codec_get_id(const AVCodecTag *tags, unsigned int tag);
360
361 #endif /* AVFORMAT_INTERNAL_H */