lavf: deprecate av_read_packet().
[libav.git] / libavformat / internal.h
CommitLineData
f1c80e35
RB
1/*
2 * copyright (c) 2001 Fabrice Bellard
3 *
2912e87a 4 * This file is part of Libav.
f1c80e35 5 *
2912e87a 6 * Libav is free software; you can redistribute it and/or
f1c80e35
RB
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 *
2912e87a 11 * Libav is distributed in the hope that it will be useful,
f1c80e35
RB
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
2912e87a 17 * License along with Libav; if not, write to the Free Software
f1c80e35
RB
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 */
20
98790382
SS
21#ifndef AVFORMAT_INTERNAL_H
22#define AVFORMAT_INTERNAL_H
f1c80e35 23
95137bbb 24#include <stdint.h>
bad40637 25#include "avformat.h"
95137bbb 26
e55ebcc3
MS
27#define MAX_URL_SIZE 4096
28
43b6c3eb
DB
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
80b39e1c
FL
35typedef struct AVCodecTag {
36 enum CodecID id;
37 unsigned int tag;
38} AVCodecTag;
39
b73ad746
AK
40typedef struct CodecMime{
41 char str[32];
42 enum CodecID id;
43} CodecMime;
44
9a2cb05f
SS
45void 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)\
49do {\
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)\
57do {\
58 ff_dynarray_add((intptr_t **)(tab), nb_ptr, (intptr_t)(elem));\
59} while(0)
60#endif
61
167f3b8d 62struct tm *ff_brktimegm(time_t secs, struct tm *tm);
9a2cb05f 63
ddbeb954 64char *ff_data_to_hex(char *buf, const uint8_t *src, int size, int lowercase);
f1c80e35 65
311baee7
MS
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 */
74int ff_hex_to_data(uint8_t *data, const char *p);
75
588af13f 76void ff_program_add_stream_index(AVFormatContext *ac, int progid, unsigned int idx);
bad40637 77
1cc65cec
BC
78/**
79 * Add packet to AVFormatContext->packet_buffer list, determining its
80 * interleaved position using compare() function argument.
1cc65cec
BC
81 */
82void ff_interleave_add_packet(AVFormatContext *s, AVPacket *pkt,
83 int (*compare)(AVFormatContext *, AVPacket *, AVPacket *));
84
972ffe62 85void ff_read_frame_flush(AVFormatContext *s);
e16c73e6 86
2dad0dce
MS
87#define NTP_OFFSET 2208988800ULL
88#define NTP_OFFSET_US (NTP_OFFSET * 1000000ULL)
89
49bd8e4b 90/** Get the current time since NTP epoch in microseconds. */
594a9aeb
MS
91uint64_t ff_ntp_time(void);
92
e4a9e3cc 93/**
49bd8e4b 94 * Assemble a URL string from components. This is the reverse operation
f3bfe388 95 * of av_url_split.
e4a9e3cc
AJ
96 *
97 * Note, this requires networking to be initialized, so the caller must
98 * ensure ff_network_init has been called.
99 *
f3bfe388 100 * @see av_url_split
e4a9e3cc
AJ
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
a955fc5e
MS
106 * @param authorization an optional authorization string, may be null.
107 * An empty string is treated the same as a null string.
e4a9e3cc
AJ
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 */
114int ff_url_join(char *str, int size, const char *proto,
115 const char *authorization, const char *hostname,
9abbe8cc 116 int port, const char *fmt, ...) av_printf_format(7, 8);
e4a9e3cc 117
0341b699 118/**
49bd8e4b 119 * Append the media-specific SDP fragment for the media stream c
0341b699
MS
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 c the AVCodecContext of the media to describe
128 * @param dest_addr the destination address of the media stream, may be NULL
7ad1dc54 129 * @param dest_type the destination address type, may be NULL
0341b699
MS
130 * @param port the destination port of the media stream, 0 if unknown
131 * @param ttl the time to live of the stream, 0 if not multicast
0558e266
MS
132 * @param fmt the AVFormatContext, which might contain options modifying
133 * the generated SDP
0341b699
MS
134 */
135void ff_sdp_write_media(char *buff, int size, AVCodecContext *c,
7ad1dc54 136 const char *dest_addr, const char *dest_type,
0558e266 137 int port, int ttl, AVFormatContext *fmt);
0341b699 138
9a761250
MS
139/**
140 * Write a packet to another muxer than the one the user originally
141 * intended. Useful when chaining muxers, where one muxer internally
142 * writes a received packet to another muxer.
143 *
144 * @param dst the muxer to write the packet to
145 * @param dst_stream the stream index within dst to write the packet to
146 * @param pkt the packet to be written
147 * @param src the muxer the packet originally was intended for
148 * @return the value av_write_frame returned
149 */
150int ff_write_chained(AVFormatContext *dst, int dst_stream, AVPacket *pkt,
151 AVFormatContext *src);
152
603e5c0b
MC
153/**
154 * Get the length in bytes which is needed to store val as v.
155 */
156int ff_get_v_length(uint64_t val);
157
158/**
159 * Put val using a variable number of bytes.
160 */
ae628ec1 161void ff_put_v(AVIOContext *bc, uint64_t val);
603e5c0b 162
b0335fd9 163/**
ae628ec1 164 * Read a whole line of text from AVIOContext. Stop reading after reaching
c81a2b9b 165 * either a \\n, a \\0 or EOF. The returned string is always \\0-terminated,
b0335fd9
AJ
166 * and may be truncated if the buffer is too small.
167 *
ae628ec1 168 * @param s the read-only AVIOContext
b0335fd9
AJ
169 * @param buf buffer to store the read line
170 * @param maxlen size of the buffer
171 * @return the length of the string written in the buffer, not including the
c81a2b9b 172 * final \\0
b0335fd9 173 */
ae628ec1 174int ff_get_line(AVIOContext *s, char *buf, int maxlen);
7c892951 175
1537817e
MS
176#define SPACE_CHARS " \t\r\n"
177
f9c399c4
MS
178/**
179 * Callback function type for ff_parse_key_value.
180 *
181 * @param key a pointer to the key
182 * @param key_len the number of bytes that belong to the key, including the '='
183 * char
184 * @param dest return the destination pointer for the value in *dest, may
185 * be null to ignore the value
186 * @param dest_len the length of the *dest buffer
187 */
188typedef void (*ff_parse_key_val_cb)(void *context, const char *key,
189 int key_len, char **dest, int *dest_len);
190/**
191 * Parse a string with comma-separated key=value pairs. The value strings
192 * may be quoted and may contain escaped characters within quoted strings.
193 *
194 * @param str the string to parse
195 * @param callback_get_buf function that returns where to store the
196 * unescaped value string.
197 * @param context the opaque context pointer to pass to callback_get_buf
198 */
199void ff_parse_key_value(const char *str, ff_parse_key_val_cb callback_get_buf,
200 void *context);
201
141de5a9
PR
202/**
203 * Find stream index based on format-specific stream ID
204 * @return stream index, or < 0 on error
205 */
206int ff_find_stream_index(AVFormatContext *s, int id);
207
e6fb5a4f
PR
208/**
209 * Internal version of av_index_search_timestamp
210 */
211int ff_index_search_timestamp(const AVIndexEntry *entries, int nb_entries,
212 int64_t wanted_timestamp, int flags);
213
214/**
215 * Internal version of av_add_index_entry
216 */
217int ff_add_index_entry(AVIndexEntry **index_entries,
218 int *nb_index_entries,
219 unsigned int *index_entries_allocated_size,
220 int64_t pos, int64_t timestamp, int size, int distance, int flags);
221
19711af5
AK
222/**
223 * Add a new chapter.
224 *
225 * @param s media file handle
226 * @param id unique ID for this chapter
227 * @param start chapter start time in time_base units
228 * @param end chapter end time in time_base units
229 * @param title chapter title
230 *
231 * @return AVChapter or NULL on error
232 */
1fa395e4
AK
233AVChapter *avpriv_new_chapter(AVFormatContext *s, int id, AVRational time_base,
234 int64_t start, int64_t end, const char *title);
19711af5
AK
235
236/**
237 * Ensure the index uses less memory than the maximum specified in
238 * AVFormatContext.max_index_size by discarding entries if it grows
239 * too large.
240 */
241void ff_reduce_index(AVFormatContext *s, int stream_index);
242
f1f60f52
MS
243/*
244 * Convert a relative url into an absolute url, given a base url.
245 *
246 * @param buf the buffer where output absolute url is written
247 * @param size the size of buf
248 * @param base the base url, may be equal to buf.
249 * @param rel the new url, which is interpreted relative to base
250 */
251void ff_make_absolute_url(char *buf, int size, const char *base,
252 const char *rel);
253
a9bf9d8e
AK
254enum CodecID ff_guess_image2_codec(const char *filename);
255
001d668d
AK
256/**
257 * Convert a date string in ISO8601 format to Unix timestamp.
258 */
259int64_t ff_iso8601_to_unix_time(const char *datestr);
260
a2faa951
AK
261/**
262 * Perform a binary search using av_index_search_timestamp() and
263 * AVInputFormat.read_timestamp().
264 *
265 * @param target_ts target timestamp in the time base of the given stream
266 * @param stream_index stream number
267 */
268int ff_seek_frame_binary(AVFormatContext *s, int stream_index,
269 int64_t target_ts, int flags);
270
271/**
272 * Update cur_dts of all streams based on the given timestamp and AVStream.
273 *
274 * Stream ref_st unchanged, others set cur_dts in their native time base.
275 * Only needed for timestamp wrapping or if (dts not set and pts!=dts).
276 * @param timestamp new dts expressed in time_base of param ref_st
277 * @param ref_st reference stream giving time_base of param timestamp
278 */
279void ff_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
280
281/**
282 * Perform a binary search using read_timestamp().
283 *
284 * @param target_ts target timestamp in the time base of the given stream
285 * @param stream_index stream number
286 */
287int64_t ff_gen_search(AVFormatContext *s, int stream_index,
288 int64_t target_ts, int64_t pos_min,
289 int64_t pos_max, int64_t pos_limit,
290 int64_t ts_min, int64_t ts_max,
291 int flags, int64_t *ts_ret,
292 int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
293
c3f9ebf7
AK
294/**
295 * Set the pts for a given stream. If the new values would be invalid
296 * (<= 0), it leaves the AVStream unchanged.
297 *
298 * @param s stream
299 * @param pts_wrap_bits number of bits effectively used by the pts
300 * (used for wrap control, 33 is the value for MPEG)
301 * @param pts_num numerator to convert to seconds (MPEG: 1)
302 * @param pts_den denominator to convert to seconds (MPEG: 90000)
303 */
304void avpriv_set_pts_info(AVStream *s, int pts_wrap_bits,
305 unsigned int pts_num, unsigned int pts_den);
306
3e79c2ad
MS
307/**
308 * Add side data to a packet for changing parameters to the given values.
309 * Parameters set to 0 aren't included in the change.
310 */
311int ff_add_param_change(AVPacket *pkt, int32_t channels,
312 uint64_t channel_layout, int32_t sample_rate,
313 int32_t width, int32_t height);
314
d2afbd9a
AK
315/**
316 * Set the timebase for each stream from the corresponding codec timebase and
317 * print it.
318 */
319int ff_framehash_write_header(AVFormatContext *s);
320
3c90cc2e
AK
321/**
322 * Read a transport packet from a media file.
323 *
324 * @param s media file handle
325 * @param pkt is filled
326 * @return 0 if OK, AVERROR_xxx on error
327 */
328int ff_read_packet(AVFormatContext *s, AVPacket *pkt);
329
98790382 330#endif /* AVFORMAT_INTERNAL_H */