rename av_read_frame_flush to ff_read_frame_flush
[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 char *ff_data_to_hex(char *buf, const uint8_t *src, int size);
28
29 void ff_program_add_stream_index(AVFormatContext *ac, int progid, unsigned int idx);
30
31 /**
32  * Add packet to AVFormatContext->packet_buffer list, determining its
33  * interleaved position using compare() function argument.
34  */
35 void ff_interleave_add_packet(AVFormatContext *s, AVPacket *pkt,
36                               int (*compare)(AVFormatContext *, AVPacket *, AVPacket *));
37
38 void ff_read_frame_flush(AVFormatContext *s);
39
40 #define NTP_OFFSET 2208988800ULL
41 #define NTP_OFFSET_US (NTP_OFFSET * 1000000ULL)
42
43 /** Gets the current time since NTP epoch in microseconds. */
44 uint64_t ff_ntp_time(void);
45
46 /**
47  * Probes a bytestream to determine the input format. Each time a probe returns
48  * with a score that is too low, the probe buffer size is increased and another
49  * attempt is made. When the maximum probe size is reached, the input format
50  * with the highest score is returned.
51  *
52  * @param pb the bytestream to probe, it may be closed and opened again
53  * @param fmt the input format is put here
54  * @param filename the filename of the stream
55  * @param logctx the log context
56  * @param offset the offset within the bytestream to probe from
57  * @param max_probe_size the maximum probe buffer size (zero for default)
58  * @return 0 in case of success, a negative value corresponding to an
59  * AVERROR code otherwise
60  */
61 int ff_probe_input_buffer(ByteIOContext **pb, AVInputFormat **fmt,
62                           const char *filename, void *logctx,
63                           unsigned int offset, unsigned int max_probe_size);
64
65 /**
66  * Splits a URL string into components. To reassemble components back into
67  * a URL, use ff_url_join instead of using snprintf directly.
68  *
69  * The pointers to buffers for storing individual components may be null,
70  * in order to ignore that component. Buffers for components not found are
71  * set to empty strings. If the port isn't found, it is set to a negative
72  * value.
73  *
74  * @see ff_url_join
75  *
76  * @param proto the buffer for the protocol
77  * @param proto_size the size of the proto buffer
78  * @param authorization the buffer for the authorization
79  * @param authorization_size the size of the authorization buffer
80  * @param hostname the buffer for the host name
81  * @param hostname_size the size of the hostname buffer
82  * @param port_ptr a pointer to store the port number in
83  * @param path the buffer for the path
84  * @param path_size the size of the path buffer
85  * @param url the URL to split
86  */
87 void ff_url_split(char *proto, int proto_size,
88                   char *authorization, int authorization_size,
89                   char *hostname, int hostname_size,
90                   int *port_ptr,
91                   char *path, int path_size,
92                   const char *url);
93
94 /**
95  * Assembles a URL string from components. This is the reverse operation
96  * of ff_url_split.
97  *
98  * Note, this requires networking to be initialized, so the caller must
99  * ensure ff_network_init has been called.
100  *
101  * @see ff_url_split
102  *
103  * @param str the buffer to fill with the url
104  * @param size the size of the str buffer
105  * @param proto the protocol identifier, if null, the separator
106  *              after the identifier is left out, too
107  * @param authorization an optional authorization string, may be null
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, ...);
117
118 #endif /* AVFORMAT_INTERNAL_H */