lavf: remove disabled FF_API_OLD_AVIO cruft
[ffmpeg.git] / libavformat / url.h
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"
29 #include "libavformat/version.h"
30
31 #include "libavutil/dict.h"
32 #include "libavutil/log.h"
33
34 #define URL_PROTOCOL_FLAG_NESTED_SCHEME 1 /*< The protocol name can be the first part of a nested protocol scheme */
35 #define URL_PROTOCOL_FLAG_NETWORK       2 /*< The protocol uses network */
36
37 extern int (*url_interrupt_cb)(void);
38
39 extern const AVClass ffurl_context_class;
40
41 typedef 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;
50     AVIOInterruptCB interrupt_callback;
51 } URLContext;
52
53 typedef struct URLProtocol {
54     const char *name;
55     int     (*url_open)( URLContext *h, const char *url, int flags);
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);
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;
74     int (*url_check)(URLContext *h, int mask);
75 } URLProtocol;
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
85  * @param int_cb interrupt callback to use for the URLContext, may be
86  * NULL
87  * @return 0 in case of success, a negative value corresponding to an
88  * AVERROR code in case of failure
89  */
90 int ffurl_alloc(URLContext **puc, const char *filename, int flags,
91                 const AVIOInterruptCB *int_cb);
92
93 /**
94  * Connect an URLContext that has been allocated by ffurl_alloc
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.
100  */
101 int ffurl_connect(URLContext *uc, AVDictionary **options);
102
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
111  * @param int_cb interrupt callback to use for the URLContext, may be
112  * NULL
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.
116  * @return 0 in case of success, a negative value corresponding to an
117  * AVERROR code in case of failure
118  */
119 int ffurl_open(URLContext **puc, const char *filename, int flags,
120                const AVIOInterruptCB *int_cb, AVDictionary **options);
121
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  */
131 int ffurl_read(URLContext *h, unsigned char *buf, int size);
132
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  */
140 int ffurl_read_complete(URLContext *h, unsigned char *buf, int size);
141
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  */
148 int ffurl_write(URLContext *h, const unsigned char *buf, int size);
149
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  */
164 int64_t ffurl_seek(URLContext *h, int64_t pos, int whence);
165
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  */
173 int ffurl_close(URLContext *h);
174
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  */
180 int64_t ffurl_size(URLContext *h);
181
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  */
188 int ffurl_get_file_handle(URLContext *h);
189
190 /**
191  * Register the URLProtocol protocol.
192  *
193  * @param size the size of the URLProtocol struct referenced
194  */
195 int ffurl_register_protocol(URLProtocol *protocol, int size);
196
197 /**
198  * Check if the user has requested to interrup a blocking function
199  * associated with cb.
200  */
201 int ff_check_interrupt(AVIOInterruptCB *cb);
202
203 /**
204  * Iterate over all available protocols.
205  *
206  * @param prev result of the previous call to this functions or NULL.
207  */
208 URLProtocol *ffurl_protocol_next(URLProtocol *prev);
209
210 /* udp.c */
211 int ff_udp_set_remote_url(URLContext *h, const char *uri);
212 int ff_udp_get_local_port(URLContext *h);
213
214 #endif /* AVFORMAT_URL_H */