libavformat: Use AVFormatContext.probesize in init_input
[libav.git] / libavformat / url.h
CommitLineData
5652bb94
AK
1/*
2 *
3 * This file is part of Libav.
4 *
5 * Libav is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2.1 of the License, or (at your option) any later version.
9 *
10 * Libav is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
14 *
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with Libav; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18 */
19
20/**
21 * @file
22 * unbuffered private I/O API
23 */
24
25#ifndef AVFORMAT_URL_H
26#define AVFORMAT_URL_H
27
28#include "avio.h"
b8404847
AK
29#include "libavformat/version.h"
30
ddffc2fd 31#include "libavutil/dict.h"
1dee0aca 32#include "libavutil/log.h"
ddffc2fd 33
b8404847 34#define URL_PROTOCOL_FLAG_NESTED_SCHEME 1 /*< The protocol name can be the first part of a nested protocol scheme */
32b83aee 35#define URL_PROTOCOL_FLAG_NETWORK 2 /*< The protocol uses network */
5cec8971 36
026e1757 37extern int (*url_interrupt_cb)(void);
c486dade 38
1dee0aca
MS
39extern const AVClass ffurl_context_class;
40
c486dade
AK
41typedef struct URLContext {
42 const AVClass *av_class; /**< information for av_log(). Set by url_open(). */
43 struct URLProtocol *prot;
44 void *priv_data;
45 char *filename; /**< specified URL */
46 int flags;
47 int max_packet_size; /**< if non zero, the stream is packetized with this max packet size */
48 int is_streamed; /**< true if streamed (no seek possible), default = false */
49 int is_connected;
6aa0b98f 50 AVIOInterruptCB interrupt_callback;
c486dade 51} URLContext;
5593f031
AK
52
53typedef struct URLProtocol {
54 const char *name;
55 int (*url_open)( URLContext *h, const char *url, int flags);
ddffc2fd
AK
56 /**
57 * This callback is to be used by protocols which open further nested
58 * protocols. options are then to be passed to ffurl_open()/ffurl_connect()
59 * for those nested protocols.
60 */
61 int (*url_open2)(URLContext *h, const char *url, int flags, AVDictionary **options);
5593f031
AK
62 int (*url_read)( URLContext *h, unsigned char *buf, int size);
63 int (*url_write)(URLContext *h, const unsigned char *buf, int size);
64 int64_t (*url_seek)( URLContext *h, int64_t pos, int whence);
65 int (*url_close)(URLContext *h);
66 struct URLProtocol *next;
67 int (*url_read_pause)(URLContext *h, int pause);
68 int64_t (*url_read_seek)(URLContext *h, int stream_index,
69 int64_t timestamp, int flags);
70 int (*url_get_file_handle)(URLContext *h);
71 int priv_data_size;
72 const AVClass *priv_data_class;
73 int flags;
175389c8 74 int (*url_check)(URLContext *h, int mask);
5593f031 75} URLProtocol;
5652bb94
AK
76
77/**
78 * Create a URLContext for accessing to the resource indicated by
79 * url, but do not initiate the connection yet.
80 *
81 * @param puc pointer to the location where, in case of success, the
82 * function puts the pointer to the created URLContext
83 * @param flags flags which control how the resource indicated by url
84 * is to be opened
6f1b7b39
MS
85 * @param int_cb interrupt callback to use for the URLContext, may be
86 * NULL
5652bb94
AK
87 * @return 0 in case of success, a negative value corresponding to an
88 * AVERROR code in case of failure
89 */
6f1b7b39
MS
90int ffurl_alloc(URLContext **puc, const char *filename, int flags,
91 const AVIOInterruptCB *int_cb);
5652bb94 92
62eaaeac
AK
93/**
94 * Connect an URLContext that has been allocated by ffurl_alloc
ddffc2fd
AK
95 *
96 * @param options A dictionary filled with options for nested protocols,
97 * i.e. it will be passed to url_open2() for protocols implementing it.
98 * This parameter will be destroyed and replaced with a dict containing options
99 * that were not found. May be NULL.
62eaaeac 100 */
ddffc2fd 101int ffurl_connect(URLContext *uc, AVDictionary **options);
62eaaeac 102
0589da0a
AK
103/**
104 * Create an URLContext for accessing to the resource indicated by
105 * url, and open it.
106 *
107 * @param puc pointer to the location where, in case of success, the
108 * function puts the pointer to the created URLContext
109 * @param flags flags which control how the resource indicated by url
110 * is to be opened
6f1b7b39
MS
111 * @param int_cb interrupt callback to use for the URLContext, may be
112 * NULL
ddffc2fd
AK
113 * @param options A dictionary filled with protocol-private options. On return
114 * this parameter will be destroyed and replaced with a dict containing options
115 * that were not found. May be NULL.
0589da0a
AK
116 * @return 0 in case of success, a negative value corresponding to an
117 * AVERROR code in case of failure
118 */
6f1b7b39 119int ffurl_open(URLContext **puc, const char *filename, int flags,
ddffc2fd 120 const AVIOInterruptCB *int_cb, AVDictionary **options);
0589da0a 121
bc371aca
AK
122/**
123 * Read up to size bytes from the resource accessed by h, and store
124 * the read bytes in buf.
125 *
126 * @return The number of bytes actually read, or a negative value
127 * corresponding to an AVERROR code in case of error. A value of zero
128 * indicates that it is not possible to read more from the accessed
129 * resource (except if the value of the size argument is also zero).
130 */
131int ffurl_read(URLContext *h, unsigned char *buf, int size);
132
dce37564
AK
133/**
134 * Read as many bytes as possible (up to size), calling the
135 * read function multiple times if necessary.
136 * This makes special short-read handling in applications
137 * unnecessary, if the return value is < size then it is
138 * certain there was either an error or the end of file was reached.
139 */
140int ffurl_read_complete(URLContext *h, unsigned char *buf, int size);
141
925e908b
AK
142/**
143 * Write size bytes from buf to the resource accessed by h.
144 *
145 * @return the number of bytes actually written, or a negative value
146 * corresponding to an AVERROR code in case of failure
147 */
148int ffurl_write(URLContext *h, const unsigned char *buf, int size);
149
58a48c65
AK
150/**
151 * Change the position that will be used by the next read/write
152 * operation on the resource accessed by h.
153 *
154 * @param pos specifies the new position to set
155 * @param whence specifies how pos should be interpreted, it must be
156 * one of SEEK_SET (seek from the beginning), SEEK_CUR (seek from the
157 * current position), SEEK_END (seek from the end), or AVSEEK_SIZE
158 * (return the filesize of the requested resource, pos is ignored).
159 * @return a negative value corresponding to an AVERROR code in case
160 * of failure, or the resulting file position, measured in bytes from
161 * the beginning of the file. You can use this feature together with
162 * SEEK_CUR to read the current file position.
163 */
164int64_t ffurl_seek(URLContext *h, int64_t pos, int whence);
165
e52a9145
AK
166/**
167 * Close the resource accessed by the URLContext h, and free the
168 * memory used by it.
169 *
170 * @return a negative value if an error condition occurred, 0
171 * otherwise
172 */
173int ffurl_close(URLContext *h);
174
32a97d46
AK
175/**
176 * Return the filesize of the resource accessed by h, AVERROR(ENOSYS)
177 * if the operation is not supported by h, or another negative value
178 * corresponding to an AVERROR error code in case of failure.
179 */
180int64_t ffurl_size(URLContext *h);
181
1869ea03
AK
182/**
183 * Return the file descriptor associated with this URL. For RTP, this
184 * will return only the RTP file descriptor, not the RTCP file descriptor.
185 *
186 * @return the file descriptor associated with this URL, or <0 on error.
187 */
188int ffurl_get_file_handle(URLContext *h);
189
8e76a19b
AK
190/**
191 * Register the URLProtocol protocol.
192 *
193 * @param size the size of the URLProtocol struct referenced
194 */
195int ffurl_register_protocol(URLProtocol *protocol, int size);
196
c4a090dd
MS
197/**
198 * Check if the user has requested to interrup a blocking function
199 * associated with cb.
200 */
201int ff_check_interrupt(AVIOInterruptCB *cb);
202
163a3113
AK
203/**
204 * Iterate over all available protocols.
205 *
206 * @param prev result of the previous call to this functions or NULL.
207 */
208URLProtocol *ffurl_protocol_next(URLProtocol *prev);
209
d6bbe761
AK
210/* udp.c */
211int ff_udp_set_remote_url(URLContext *h, const char *uri);
212int ff_udp_get_local_port(URLContext *h);
213
153382e1 214#endif /* AVFORMAT_URL_H */