h264: vdpau: fix crash with unsupported colorspace
[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);
01b0ade6
NG
62
63 /**
64 * Read data from the protocol.
65 * If data is immediately available (even less than size), EOF is
66 * reached or an error occurs (including EINTR), return immediately.
67 * Otherwise:
68 * In non-blocking mode, return AVERROR(EAGAIN) immediately.
69 * In blocking mode, wait for data/EOF/error with a short timeout (0.1s),
70 * and return AVERROR(EAGAIN) on timeout.
71 * Checking interrupt_callback, looping on EINTR and EAGAIN and until
72 * enough data has been read is left to the calling function; see
73 * retry_transfer_wrapper in avio.c.
74 */
5593f031
AK
75 int (*url_read)( URLContext *h, unsigned char *buf, int size);
76 int (*url_write)(URLContext *h, const unsigned char *buf, int size);
77 int64_t (*url_seek)( URLContext *h, int64_t pos, int whence);
78 int (*url_close)(URLContext *h);
79 struct URLProtocol *next;
80 int (*url_read_pause)(URLContext *h, int pause);
81 int64_t (*url_read_seek)(URLContext *h, int stream_index,
82 int64_t timestamp, int flags);
83 int (*url_get_file_handle)(URLContext *h);
32d545e0 84 int (*url_shutdown)(URLContext *h, int flags);
5593f031
AK
85 int priv_data_size;
86 const AVClass *priv_data_class;
87 int flags;
175389c8 88 int (*url_check)(URLContext *h, int mask);
5593f031 89} URLProtocol;
5652bb94
AK
90
91/**
92 * Create a URLContext for accessing to the resource indicated by
93 * url, but do not initiate the connection yet.
94 *
95 * @param puc pointer to the location where, in case of success, the
96 * function puts the pointer to the created URLContext
97 * @param flags flags which control how the resource indicated by url
98 * is to be opened
6f1b7b39
MS
99 * @param int_cb interrupt callback to use for the URLContext, may be
100 * NULL
5652bb94
AK
101 * @return 0 in case of success, a negative value corresponding to an
102 * AVERROR code in case of failure
103 */
6f1b7b39
MS
104int ffurl_alloc(URLContext **puc, const char *filename, int flags,
105 const AVIOInterruptCB *int_cb);
5652bb94 106
62eaaeac
AK
107/**
108 * Connect an URLContext that has been allocated by ffurl_alloc
ddffc2fd
AK
109 *
110 * @param options A dictionary filled with options for nested protocols,
111 * i.e. it will be passed to url_open2() for protocols implementing it.
112 * This parameter will be destroyed and replaced with a dict containing options
113 * that were not found. May be NULL.
62eaaeac 114 */
ddffc2fd 115int ffurl_connect(URLContext *uc, AVDictionary **options);
62eaaeac 116
0589da0a
AK
117/**
118 * Create an URLContext for accessing to the resource indicated by
119 * url, and open it.
120 *
121 * @param puc pointer to the location where, in case of success, the
122 * function puts the pointer to the created URLContext
123 * @param flags flags which control how the resource indicated by url
124 * is to be opened
6f1b7b39
MS
125 * @param int_cb interrupt callback to use for the URLContext, may be
126 * NULL
ddffc2fd
AK
127 * @param options A dictionary filled with protocol-private options. On return
128 * this parameter will be destroyed and replaced with a dict containing options
129 * that were not found. May be NULL.
0589da0a
AK
130 * @return 0 in case of success, a negative value corresponding to an
131 * AVERROR code in case of failure
132 */
6f1b7b39 133int ffurl_open(URLContext **puc, const char *filename, int flags,
ddffc2fd 134 const AVIOInterruptCB *int_cb, AVDictionary **options);
0589da0a 135
bc371aca
AK
136/**
137 * Read up to size bytes from the resource accessed by h, and store
138 * the read bytes in buf.
139 *
140 * @return The number of bytes actually read, or a negative value
141 * corresponding to an AVERROR code in case of error. A value of zero
142 * indicates that it is not possible to read more from the accessed
143 * resource (except if the value of the size argument is also zero).
144 */
145int ffurl_read(URLContext *h, unsigned char *buf, int size);
146
dce37564
AK
147/**
148 * Read as many bytes as possible (up to size), calling the
149 * read function multiple times if necessary.
150 * This makes special short-read handling in applications
151 * unnecessary, if the return value is < size then it is
152 * certain there was either an error or the end of file was reached.
153 */
154int ffurl_read_complete(URLContext *h, unsigned char *buf, int size);
155
925e908b
AK
156/**
157 * Write size bytes from buf to the resource accessed by h.
158 *
159 * @return the number of bytes actually written, or a negative value
160 * corresponding to an AVERROR code in case of failure
161 */
162int ffurl_write(URLContext *h, const unsigned char *buf, int size);
163
58a48c65
AK
164/**
165 * Change the position that will be used by the next read/write
166 * operation on the resource accessed by h.
167 *
168 * @param pos specifies the new position to set
169 * @param whence specifies how pos should be interpreted, it must be
170 * one of SEEK_SET (seek from the beginning), SEEK_CUR (seek from the
171 * current position), SEEK_END (seek from the end), or AVSEEK_SIZE
172 * (return the filesize of the requested resource, pos is ignored).
173 * @return a negative value corresponding to an AVERROR code in case
174 * of failure, or the resulting file position, measured in bytes from
175 * the beginning of the file. You can use this feature together with
176 * SEEK_CUR to read the current file position.
177 */
178int64_t ffurl_seek(URLContext *h, int64_t pos, int whence);
179
e52a9145
AK
180/**
181 * Close the resource accessed by the URLContext h, and free the
182 * memory used by it.
183 *
184 * @return a negative value if an error condition occurred, 0
185 * otherwise
186 */
187int ffurl_close(URLContext *h);
188
32a97d46
AK
189/**
190 * Return the filesize of the resource accessed by h, AVERROR(ENOSYS)
191 * if the operation is not supported by h, or another negative value
192 * corresponding to an AVERROR error code in case of failure.
193 */
194int64_t ffurl_size(URLContext *h);
195
1869ea03
AK
196/**
197 * Return the file descriptor associated with this URL. For RTP, this
198 * will return only the RTP file descriptor, not the RTCP file descriptor.
199 *
200 * @return the file descriptor associated with this URL, or <0 on error.
201 */
202int ffurl_get_file_handle(URLContext *h);
203
8e76a19b 204/**
32d545e0
SP
205 * Signal the URLContext that we are done reading or writing the stream.
206 *
207 * @param h pointer to the resource
208 * @param flags flags which control how the resource indicated by url
209 * is to be shutdown
210 *
211 * @return a negative value if an error condition occurred, 0
212 * otherwise
213 */
214int ffurl_shutdown(URLContext *h, int flags);
215
216/**
8e76a19b
AK
217 * Register the URLProtocol protocol.
218 *
219 * @param size the size of the URLProtocol struct referenced
220 */
221int ffurl_register_protocol(URLProtocol *protocol, int size);
222
c4a090dd
MS
223/**
224 * Check if the user has requested to interrup a blocking function
225 * associated with cb.
226 */
227int ff_check_interrupt(AVIOInterruptCB *cb);
228
163a3113
AK
229/**
230 * Iterate over all available protocols.
231 *
232 * @param prev result of the previous call to this functions or NULL.
233 */
234URLProtocol *ffurl_protocol_next(URLProtocol *prev);
235
d6bbe761
AK
236/* udp.c */
237int ff_udp_set_remote_url(URLContext *h, const char *uri);
238int ff_udp_get_local_port(URLContext *h);
239
153382e1 240#endif /* AVFORMAT_URL_H */