Merge remote-tracking branch 'qatar/master'
[ffmpeg.git] / libavformat / url.h
1 /*
2  *
3  * This file is part of FFmpeg.
4  *
5  * FFmpeg 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  * FFmpeg 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 FFmpeg; 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 #if !FF_API_OLD_AVIO
35 #define URL_PROTOCOL_FLAG_NESTED_SCHEME 1 /*< The protocol name can be the first part of a nested protocol scheme */
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 #endif
77
78 /**
79  * Create a URLContext for accessing to the resource indicated by
80  * url, but do not initiate the connection yet.
81  *
82  * @param puc pointer to the location where, in case of success, the
83  * function puts the pointer to the created URLContext
84  * @param flags flags which control how the resource indicated by url
85  * is to be opened
86  * @param int_cb interrupt callback to use for the URLContext, may be
87  * NULL
88  * @return 0 in case of success, a negative value corresponding to an
89  * AVERROR code in case of failure
90  */
91 int ffurl_alloc(URLContext **puc, const char *filename, int flags,
92                 const AVIOInterruptCB *int_cb);
93
94 /**
95  * Connect an URLContext that has been allocated by ffurl_alloc
96  *
97  * @param options  A dictionary filled with options for nested protocols,
98  * i.e. it will be passed to url_open2() for protocols implementing it.
99  * This parameter will be destroyed and replaced with a dict containing options
100  * that were not found. May be NULL.
101  */
102 int ffurl_connect(URLContext *uc, AVDictionary **options);
103
104 /**
105  * Create an URLContext for accessing to the resource indicated by
106  * url, and open it.
107  *
108  * @param puc pointer to the location where, in case of success, the
109  * function puts the pointer to the created URLContext
110  * @param flags flags which control how the resource indicated by url
111  * is to be opened
112  * @param int_cb interrupt callback to use for the URLContext, may be
113  * NULL
114  * @param options  A dictionary filled with protocol-private options. On return
115  * this parameter will be destroyed and replaced with a dict containing options
116  * that were not found. May be NULL.
117  * @return 0 in case of success, a negative value corresponding to an
118  * AVERROR code in case of failure
119  */
120 int ffurl_open(URLContext **puc, const char *filename, int flags,
121                const AVIOInterruptCB *int_cb, AVDictionary **options);
122
123 /**
124  * Read up to size bytes from the resource accessed by h, and store
125  * the read bytes in buf.
126  *
127  * @return The number of bytes actually read, or a negative value
128  * corresponding to an AVERROR code in case of error. A value of zero
129  * indicates that it is not possible to read more from the accessed
130  * resource (except if the value of the size argument is also zero).
131  */
132 int ffurl_read(URLContext *h, unsigned char *buf, int size);
133
134 /**
135  * Read as many bytes as possible (up to size), calling the
136  * read function multiple times if necessary.
137  * This makes special short-read handling in applications
138  * unnecessary, if the return value is < size then it is
139  * certain there was either an error or the end of file was reached.
140  */
141 int ffurl_read_complete(URLContext *h, unsigned char *buf, int size);
142
143 /**
144  * Write size bytes from buf to the resource accessed by h.
145  *
146  * @return the number of bytes actually written, or a negative value
147  * corresponding to an AVERROR code in case of failure
148  */
149 int ffurl_write(URLContext *h, const unsigned char *buf, int size);
150
151 /**
152  * Change the position that will be used by the next read/write
153  * operation on the resource accessed by h.
154  *
155  * @param pos specifies the new position to set
156  * @param whence specifies how pos should be interpreted, it must be
157  * one of SEEK_SET (seek from the beginning), SEEK_CUR (seek from the
158  * current position), SEEK_END (seek from the end), or AVSEEK_SIZE
159  * (return the filesize of the requested resource, pos is ignored).
160  * @return a negative value corresponding to an AVERROR code in case
161  * of failure, or the resulting file position, measured in bytes from
162  * the beginning of the file. You can use this feature together with
163  * SEEK_CUR to read the current file position.
164  */
165 int64_t ffurl_seek(URLContext *h, int64_t pos, int whence);
166
167 /**
168  * Close the resource accessed by the URLContext h, and free the
169  * memory used by it.
170  *
171  * @return a negative value if an error condition occurred, 0
172  * otherwise
173  */
174 int ffurl_close(URLContext *h);
175
176 /**
177  * Return the filesize of the resource accessed by h, AVERROR(ENOSYS)
178  * if the operation is not supported by h, or another negative value
179  * corresponding to an AVERROR error code in case of failure.
180  */
181 int64_t ffurl_size(URLContext *h);
182
183 /**
184  * Return the file descriptor associated with this URL. For RTP, this
185  * will return only the RTP file descriptor, not the RTCP file descriptor.
186  *
187  * @return the file descriptor associated with this URL, or <0 on error.
188  */
189 int ffurl_get_file_handle(URLContext *h);
190
191 /**
192  * Register the URLProtocol protocol.
193  *
194  * @param size the size of the URLProtocol struct referenced
195  */
196 int ffurl_register_protocol(URLProtocol *protocol, int size);
197
198 /**
199  * Check if the user has requested to interrup a blocking function
200  * associated with cb.
201  */
202 int ff_check_interrupt(AVIOInterruptCB *cb);
203
204 /**
205  * Iterate over all available protocols.
206  *
207  * @param prev result of the previous call to this functions or NULL.
208  */
209 URLProtocol *ffurl_protocol_next(URLProtocol *prev);
210
211 /* udp.c */
212 int ff_udp_set_remote_url(URLContext *h, const char *uri);
213 int ff_udp_get_local_port(URLContext *h);
214
215 #endif /* AVFORMAT_URL_H */