annotate avio.h @ 4595:af7b24671b7d libavformat

Mark as "internal but installed" the avio.h file. This should prevent its direct inclusion in an external project, which results broken if avformat.h is not included before.
author stefano
date Thu, 26 Feb 2009 22:34:18 +0000
parents ac9bab4919a2
children b34d9614b887
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1306
8bf9be9bb107 Add official LGPL license headers to the files that were missing them.
diego
parents: 1176
diff changeset
1 /*
8bf9be9bb107 Add official LGPL license headers to the files that were missing them.
diego
parents: 1176
diff changeset
2 * copyright (c) 2001 Fabrice Bellard
8bf9be9bb107 Add official LGPL license headers to the files that were missing them.
diego
parents: 1176
diff changeset
3 *
1358
0899bfe4105c Change license headers to say 'FFmpeg' instead of 'this program/this library'
diego
parents: 1306
diff changeset
4 * This file is part of FFmpeg.
0899bfe4105c Change license headers to say 'FFmpeg' instead of 'this program/this library'
diego
parents: 1306
diff changeset
5 *
0899bfe4105c Change license headers to say 'FFmpeg' instead of 'this program/this library'
diego
parents: 1306
diff changeset
6 * FFmpeg is free software; you can redistribute it and/or
1306
8bf9be9bb107 Add official LGPL license headers to the files that were missing them.
diego
parents: 1176
diff changeset
7 * modify it under the terms of the GNU Lesser General Public
8bf9be9bb107 Add official LGPL license headers to the files that were missing them.
diego
parents: 1176
diff changeset
8 * License as published by the Free Software Foundation; either
1358
0899bfe4105c Change license headers to say 'FFmpeg' instead of 'this program/this library'
diego
parents: 1306
diff changeset
9 * version 2.1 of the License, or (at your option) any later version.
1306
8bf9be9bb107 Add official LGPL license headers to the files that were missing them.
diego
parents: 1176
diff changeset
10 *
1358
0899bfe4105c Change license headers to say 'FFmpeg' instead of 'this program/this library'
diego
parents: 1306
diff changeset
11 * FFmpeg is distributed in the hope that it will be useful,
1306
8bf9be9bb107 Add official LGPL license headers to the files that were missing them.
diego
parents: 1176
diff changeset
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
8bf9be9bb107 Add official LGPL license headers to the files that were missing them.
diego
parents: 1176
diff changeset
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
8bf9be9bb107 Add official LGPL license headers to the files that were missing them.
diego
parents: 1176
diff changeset
14 * Lesser General Public License for more details.
8bf9be9bb107 Add official LGPL license headers to the files that were missing them.
diego
parents: 1176
diff changeset
15 *
8bf9be9bb107 Add official LGPL license headers to the files that were missing them.
diego
parents: 1176
diff changeset
16 * You should have received a copy of the GNU Lesser General Public
1358
0899bfe4105c Change license headers to say 'FFmpeg' instead of 'this program/this library'
diego
parents: 1306
diff changeset
17 * License along with FFmpeg; if not, write to the Free Software
1306
8bf9be9bb107 Add official LGPL license headers to the files that were missing them.
diego
parents: 1176
diff changeset
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
8bf9be9bb107 Add official LGPL license headers to the files that were missing them.
diego
parents: 1176
diff changeset
19 */
3852
1b6245500d8c Globally rename the header inclusion guard names.
stefano
parents: 3744
diff changeset
20 #ifndef AVFORMAT_AVIO_H
1b6245500d8c Globally rename the header inclusion guard names.
stefano
parents: 3744
diff changeset
21 #define AVFORMAT_AVIO_H
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
22
4594
ac9bab4919a2 Add a @file notice to avio.h.
stefano
parents: 4524
diff changeset
23 /**
ac9bab4919a2 Add a @file notice to avio.h.
stefano
parents: 4524
diff changeset
24 * @file libavformat/avio.h
ac9bab4919a2 Add a @file notice to avio.h.
stefano
parents: 4524
diff changeset
25 * unbuffered I/O operations
4595
af7b24671b7d Mark as "internal but installed" the avio.h file.
stefano
parents: 4594
diff changeset
26 *
af7b24671b7d Mark as "internal but installed" the avio.h file.
stefano
parents: 4594
diff changeset
27 * @warning This file has to be considered an internal but installed
af7b24671b7d Mark as "internal but installed" the avio.h file.
stefano
parents: 4594
diff changeset
28 * header, so it should not be directly included in your projects.
4594
ac9bab4919a2 Add a @file notice to avio.h.
stefano
parents: 4524
diff changeset
29 */
ac9bab4919a2 Add a @file notice to avio.h.
stefano
parents: 4524
diff changeset
30
2171
a6d6b2b19341 include all prerequisites in header files
mru
parents: 2165
diff changeset
31 #include <stdint.h>
a6d6b2b19341 include all prerequisites in header files
mru
parents: 2165
diff changeset
32
4524
e2abb4e5017c Add missing #includes to fix 'make checkheaders'.
diego
parents: 4499
diff changeset
33 #include "libavutil/common.h"
e2abb4e5017c Add missing #includes to fix 'make checkheaders'.
diego
parents: 4499
diff changeset
34
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
35 /* unbuffered I/O */
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
36
2849
0182bdddc45e Document ByteIOContext and URLContext change rules.
michael
parents: 2840
diff changeset
37 /**
0182bdddc45e Document ByteIOContext and URLContext change rules.
michael
parents: 2840
diff changeset
38 * URL Context.
0182bdddc45e Document ByteIOContext and URLContext change rules.
michael
parents: 2840
diff changeset
39 * New fields can be added to the end with minor version bumps.
2851
979a885a7686 comment typo fixes
diego
parents: 2850
diff changeset
40 * Removal, reordering and changes to existing fields require a major
2849
0182bdddc45e Document ByteIOContext and URLContext change rules.
michael
parents: 2840
diff changeset
41 * version bump.
2851
979a885a7686 comment typo fixes
diego
parents: 2850
diff changeset
42 * sizeof(URLContext) must not be used outside libav*.
2849
0182bdddc45e Document ByteIOContext and URLContext change rules.
michael
parents: 2840
diff changeset
43 */
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
44 struct URLContext {
3136
e38d5357f0d0 Add AVClass to URLContext at next major version bump
superdump
parents: 2853
diff changeset
45 #if LIBAVFORMAT_VERSION_MAJOR >= 53
e38d5357f0d0 Add AVClass to URLContext at next major version bump
superdump
parents: 2853
diff changeset
46 const AVClass *av_class; ///< information for av_log(). Set by url_open().
e38d5357f0d0 Add AVClass to URLContext at next major version bump
superdump
parents: 2853
diff changeset
47 #endif
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
48 struct URLProtocol *prot;
885
da1d5db0ce5c COSMETICS: Remove all trailing whitespace.
diego
parents: 823
diff changeset
49 int flags;
1876
247fdf49ffb8 Convert all the comment sections into Doxygen compatible comments, same for
takis
parents: 1875
diff changeset
50 int is_streamed; /**< true if streamed (no seek possible), default = false */
247fdf49ffb8 Convert all the comment sections into Doxygen compatible comments, same for
takis
parents: 1875
diff changeset
51 int max_packet_size; /**< if non zero, the stream is packetized with this max packet size */
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
52 void *priv_data;
1876
247fdf49ffb8 Convert all the comment sections into Doxygen compatible comments, same for
takis
parents: 1875
diff changeset
53 char *filename; /**< specified filename */
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
54 };
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
55
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
56 typedef struct URLContext URLContext;
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
57
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
58 typedef struct URLPollEntry {
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
59 URLContext *handle;
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
60 int events;
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
61 int revents;
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
62 } URLPollEntry;
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
63
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
64 #define URL_RDONLY 0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
65 #define URL_WRONLY 1
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
66 #define URL_RDWR 2
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
67
177
16c4e43f34e5 added primitive aborting system
bellard
parents: 65
diff changeset
68 typedef int URLInterruptCB(void);
16c4e43f34e5 added primitive aborting system
bellard
parents: 65
diff changeset
69
3744
b140b68a3747 Implement url_open_protocol(), which is basiclly the former url_open()
rbultje
parents: 3198
diff changeset
70 int url_open_protocol (URLContext **puc, struct URLProtocol *up,
b140b68a3747 Implement url_open_protocol(), which is basiclly the former url_open()
rbultje
parents: 3198
diff changeset
71 const char *filename, int flags);
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
72 int url_open(URLContext **h, const char *filename, int flags);
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
73 int url_read(URLContext *h, unsigned char *buf, int size);
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
74 int url_write(URLContext *h, unsigned char *buf, int size);
3973
549a09cf23fe Remove offset_t typedef and use int64_t directly instead.
diego
parents: 3852
diff changeset
75 int64_t url_seek(URLContext *h, int64_t pos, int whence);
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
76 int url_close(URLContext *h);
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
77 int url_exist(const char *filename);
3973
549a09cf23fe Remove offset_t typedef and use int64_t directly instead.
diego
parents: 3852
diff changeset
78 int64_t url_filesize(URLContext *h);
1875
84ed710a9adc Move avio.h's url_get_max_packet_size() comment from source to header file.
takis
parents: 1874
diff changeset
79
1876
247fdf49ffb8 Convert all the comment sections into Doxygen compatible comments, same for
takis
parents: 1875
diff changeset
80 /**
1875
84ed710a9adc Move avio.h's url_get_max_packet_size() comment from source to header file.
takis
parents: 1874
diff changeset
81 * Return the maximum packet size associated to packetized file
2851
979a885a7686 comment typo fixes
diego
parents: 2850
diff changeset
82 * handle. If the file is not packetized (stream like HTTP or file on
1875
84ed710a9adc Move avio.h's url_get_max_packet_size() comment from source to header file.
takis
parents: 1874
diff changeset
83 * disk), then 0 is returned.
84ed710a9adc Move avio.h's url_get_max_packet_size() comment from source to header file.
takis
parents: 1874
diff changeset
84 *
84ed710a9adc Move avio.h's url_get_max_packet_size() comment from source to header file.
takis
parents: 1874
diff changeset
85 * @param h file handle
84ed710a9adc Move avio.h's url_get_max_packet_size() comment from source to header file.
takis
parents: 1874
diff changeset
86 * @return maximum packet size in bytes
84ed710a9adc Move avio.h's url_get_max_packet_size() comment from source to header file.
takis
parents: 1874
diff changeset
87 */
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
88 int url_get_max_packet_size(URLContext *h);
19
81e87c8de3dc added url_get_filename()
bellard
parents: 0
diff changeset
89 void url_get_filename(URLContext *h, char *buf, int buf_size);
81e87c8de3dc added url_get_filename()
bellard
parents: 0
diff changeset
90
1876
247fdf49ffb8 Convert all the comment sections into Doxygen compatible comments, same for
takis
parents: 1875
diff changeset
91 /**
2851
979a885a7686 comment typo fixes
diego
parents: 2850
diff changeset
92 * The callback is called in blocking functions to test regulary if
1876
247fdf49ffb8 Convert all the comment sections into Doxygen compatible comments, same for
takis
parents: 1875
diff changeset
93 * asynchronous interruption is needed. AVERROR(EINTR) is returned
247fdf49ffb8 Convert all the comment sections into Doxygen compatible comments, same for
takis
parents: 1875
diff changeset
94 * in this case by the interrupted function. 'NULL' means no interrupt
2851
979a885a7686 comment typo fixes
diego
parents: 2850
diff changeset
95 * callback is given.
1876
247fdf49ffb8 Convert all the comment sections into Doxygen compatible comments, same for
takis
parents: 1875
diff changeset
96 */
177
16c4e43f34e5 added primitive aborting system
bellard
parents: 65
diff changeset
97 void url_set_interrupt_cb(URLInterruptCB *interrupt_cb);
16c4e43f34e5 added primitive aborting system
bellard
parents: 65
diff changeset
98
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
99 /* not implemented */
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
100 int url_poll(URLPollEntry *poll_table, int n, int timeout);
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
101
2839
b51319dd86e5 Merge recently added and still unused play and pause functions.
michael
parents: 2834
diff changeset
102 /**
b51319dd86e5 Merge recently added and still unused play and pause functions.
michael
parents: 2834
diff changeset
103 * Pause and resume playing - only meaningful if using a network streaming
b51319dd86e5 Merge recently added and still unused play and pause functions.
michael
parents: 2834
diff changeset
104 * protocol (e.g. MMS).
b51319dd86e5 Merge recently added and still unused play and pause functions.
michael
parents: 2834
diff changeset
105 * @param pause 1 for pause, 0 for resume
b51319dd86e5 Merge recently added and still unused play and pause functions.
michael
parents: 2834
diff changeset
106 */
b51319dd86e5 Merge recently added and still unused play and pause functions.
michael
parents: 2834
diff changeset
107 int av_url_read_pause(URLContext *h, int pause);
2851
979a885a7686 comment typo fixes
diego
parents: 2850
diff changeset
108
2778
50e2307414ee Extend URLProtocol with new function pointers and api functions for
andoma
parents: 2771
diff changeset
109 /**
50e2307414ee Extend URLProtocol with new function pointers and api functions for
andoma
parents: 2771
diff changeset
110 * Seek to a given timestamp relative to some component stream.
2851
979a885a7686 comment typo fixes
diego
parents: 2850
diff changeset
111 * Only meaningful if using a network streaming protocol (e.g. MMS.).
2778
50e2307414ee Extend URLProtocol with new function pointers and api functions for
andoma
parents: 2771
diff changeset
112 * @param stream_index The stream index that the timestamp is relative to.
50e2307414ee Extend URLProtocol with new function pointers and api functions for
andoma
parents: 2771
diff changeset
113 * If stream_index is (-1) the timestamp should be in AV_TIME_BASE
50e2307414ee Extend URLProtocol with new function pointers and api functions for
andoma
parents: 2771
diff changeset
114 * units from the beginning of the presentation.
50e2307414ee Extend URLProtocol with new function pointers and api functions for
andoma
parents: 2771
diff changeset
115 * If a stream_index >= 0 is used and the protocol does not support
50e2307414ee Extend URLProtocol with new function pointers and api functions for
andoma
parents: 2771
diff changeset
116 * seeking based on component streams, the call will fail with ENOTSUP.
2852
5f2ec0e202b0 Fix Doxygen function parameter name.
diego
parents: 2851
diff changeset
117 * @param timestamp timestamp in AVStream.time_base units
2778
50e2307414ee Extend URLProtocol with new function pointers and api functions for
andoma
parents: 2771
diff changeset
118 * or if there is no stream specified then in AV_TIME_BASE units.
50e2307414ee Extend URLProtocol with new function pointers and api functions for
andoma
parents: 2771
diff changeset
119 * @param flags Optional combination of AVSEEK_FLAG_BACKWARD, AVSEEK_FLAG_BYTE
50e2307414ee Extend URLProtocol with new function pointers and api functions for
andoma
parents: 2771
diff changeset
120 * and AVSEEK_FLAG_ANY. The protocol may silently ignore
50e2307414ee Extend URLProtocol with new function pointers and api functions for
andoma
parents: 2771
diff changeset
121 * AVSEEK_FLAG_BACKWARD and AVSEEK_FLAG_ANY, but AVSEEK_FLAG_BYTE will
50e2307414ee Extend URLProtocol with new function pointers and api functions for
andoma
parents: 2771
diff changeset
122 * fail with ENOTSUP if used and not supported.
50e2307414ee Extend URLProtocol with new function pointers and api functions for
andoma
parents: 2771
diff changeset
123 * @return >= 0 on success
50e2307414ee Extend URLProtocol with new function pointers and api functions for
andoma
parents: 2771
diff changeset
124 * @see AVInputFormat::read_seek
50e2307414ee Extend URLProtocol with new function pointers and api functions for
andoma
parents: 2771
diff changeset
125 */
4091
626b5bfb5aef whitespace cosmetics
diego
parents: 3973
diff changeset
126 int64_t av_url_read_seek(URLContext *h, int stream_index,
626b5bfb5aef whitespace cosmetics
diego
parents: 3973
diff changeset
127 int64_t timestamp, int flags);
2778
50e2307414ee Extend URLProtocol with new function pointers and api functions for
andoma
parents: 2771
diff changeset
128
1614
72b0e694b2b7 AVSEEK_SIZE doxy
michael
parents: 1612
diff changeset
129 /**
2165
eac986610f47 misc typo fixes
diego
parents: 1876
diff changeset
130 * Passing this as the "whence" parameter to a seek function causes it to
eac986610f47 misc typo fixes
diego
parents: 1876
diff changeset
131 * return the filesize without seeking anywhere. Supporting this is optional.
eac986610f47 misc typo fixes
diego
parents: 1876
diff changeset
132 * If it is not supported then the seek function will return <0.
1614
72b0e694b2b7 AVSEEK_SIZE doxy
michael
parents: 1612
diff changeset
133 */
1612
a6eaa0762191 seekless filesize retrieving support in 7 lines of code, also doesnt break compatibility
michael
parents: 1358
diff changeset
134 #define AVSEEK_SIZE 0x10000
a6eaa0762191 seekless filesize retrieving support in 7 lines of code, also doesnt break compatibility
michael
parents: 1358
diff changeset
135
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
136 typedef struct URLProtocol {
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
137 const char *name;
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
138 int (*url_open)(URLContext *h, const char *filename, int flags);
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
139 int (*url_read)(URLContext *h, unsigned char *buf, int size);
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
140 int (*url_write)(URLContext *h, unsigned char *buf, int size);
3973
549a09cf23fe Remove offset_t typedef and use int64_t directly instead.
diego
parents: 3852
diff changeset
141 int64_t (*url_seek)(URLContext *h, int64_t pos, int whence);
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
142 int (*url_close)(URLContext *h);
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
143 struct URLProtocol *next;
2839
b51319dd86e5 Merge recently added and still unused play and pause functions.
michael
parents: 2834
diff changeset
144 int (*url_read_pause)(URLContext *h, int pause);
4091
626b5bfb5aef whitespace cosmetics
diego
parents: 3973
diff changeset
145 int64_t (*url_read_seek)(URLContext *h, int stream_index,
626b5bfb5aef whitespace cosmetics
diego
parents: 3973
diff changeset
146 int64_t timestamp, int flags);
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
147 } URLProtocol;
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
148
4491
673107cf7fe6 Do not export to the public the first_protocol symbol at the next
stefano
parents: 4490
diff changeset
149 #if LIBAVFORMAT_VERSION_MAJOR < 53
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
150 extern URLProtocol *first_protocol;
4491
673107cf7fe6 Do not export to the public the first_protocol symbol at the next
stefano
parents: 4490
diff changeset
151 #endif
673107cf7fe6 Do not export to the public the first_protocol symbol at the next
stefano
parents: 4490
diff changeset
152
177
16c4e43f34e5 added primitive aborting system
bellard
parents: 65
diff changeset
153 extern URLInterruptCB *url_interrupt_cb;
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
154
4490
59e1aa351b77 Document av_protocol_next().
stefano
parents: 4488
diff changeset
155 /**
59e1aa351b77 Document av_protocol_next().
stefano
parents: 4488
diff changeset
156 * If protocol is NULL, returns the first registered protocol,
4499
dee012239d99 Improve grammar: "X next after Y" -> "next X after Y".
stefano
parents: 4491
diff changeset
157 * if protocol is non-NULL, returns the next registered protocol after protocol,
4490
59e1aa351b77 Document av_protocol_next().
stefano
parents: 4488
diff changeset
158 * or NULL if protocol is the last one.
59e1aa351b77 Document av_protocol_next().
stefano
parents: 4488
diff changeset
159 */
2812
173b5cb7efde av_*_next() API for libavformat
michael
parents: 2783
diff changeset
160 URLProtocol *av_protocol_next(URLProtocol *p);
173b5cb7efde av_*_next() API for libavformat
michael
parents: 2783
diff changeset
161
4488
724c0f6a52dc Rename register_protocol() to av_register_protocol() and deprecate
stefano
parents: 4091
diff changeset
162 #if LIBAVFORMAT_VERSION_MAJOR < 53
724c0f6a52dc Rename register_protocol() to av_register_protocol() and deprecate
stefano
parents: 4091
diff changeset
163 /**
724c0f6a52dc Rename register_protocol() to av_register_protocol() and deprecate
stefano
parents: 4091
diff changeset
164 * @deprecated Use av_register_protocol() instead.
724c0f6a52dc Rename register_protocol() to av_register_protocol() and deprecate
stefano
parents: 4091
diff changeset
165 */
724c0f6a52dc Rename register_protocol() to av_register_protocol() and deprecate
stefano
parents: 4091
diff changeset
166 attribute_deprecated int register_protocol(URLProtocol *protocol);
724c0f6a52dc Rename register_protocol() to av_register_protocol() and deprecate
stefano
parents: 4091
diff changeset
167 #endif
724c0f6a52dc Rename register_protocol() to av_register_protocol() and deprecate
stefano
parents: 4091
diff changeset
168
724c0f6a52dc Rename register_protocol() to av_register_protocol() and deprecate
stefano
parents: 4091
diff changeset
169 int av_register_protocol(URLProtocol *protocol);
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
170
2849
0182bdddc45e Document ByteIOContext and URLContext change rules.
michael
parents: 2840
diff changeset
171 /**
0182bdddc45e Document ByteIOContext and URLContext change rules.
michael
parents: 2840
diff changeset
172 * Bytestream IO Context.
0182bdddc45e Document ByteIOContext and URLContext change rules.
michael
parents: 2840
diff changeset
173 * New fields can be added to the end with minor version bumps.
2851
979a885a7686 comment typo fixes
diego
parents: 2850
diff changeset
174 * Removal, reordering and changes to existing fields require a major
2849
0182bdddc45e Document ByteIOContext and URLContext change rules.
michael
parents: 2840
diff changeset
175 * version bump.
2851
979a885a7686 comment typo fixes
diego
parents: 2850
diff changeset
176 * sizeof(ByteIOContext) must not be used outside libav*.
2849
0182bdddc45e Document ByteIOContext and URLContext change rules.
michael
parents: 2840
diff changeset
177 */
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
178 typedef struct {
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
179 unsigned char *buffer;
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
180 int buffer_size;
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
181 unsigned char *buf_ptr, *buf_end;
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
182 void *opaque;
65
a58a8a53eb46 * UINTX -> uintx_t INTX -> intx_t
kabi
parents: 19
diff changeset
183 int (*read_packet)(void *opaque, uint8_t *buf, int buf_size);
554
e1f17fcfb92c write error handling
michael
parents: 418
diff changeset
184 int (*write_packet)(void *opaque, uint8_t *buf, int buf_size);
3973
549a09cf23fe Remove offset_t typedef and use int64_t directly instead.
diego
parents: 3852
diff changeset
185 int64_t (*seek)(void *opaque, int64_t offset, int whence);
549a09cf23fe Remove offset_t typedef and use int64_t directly instead.
diego
parents: 3852
diff changeset
186 int64_t pos; /**< position in the file of the current buffer */
1876
247fdf49ffb8 Convert all the comment sections into Doxygen compatible comments, same for
takis
parents: 1875
diff changeset
187 int must_flush; /**< true if the next seek should flush */
247fdf49ffb8 Convert all the comment sections into Doxygen compatible comments, same for
takis
parents: 1875
diff changeset
188 int eof_reached; /**< true if eof reached */
247fdf49ffb8 Convert all the comment sections into Doxygen compatible comments, same for
takis
parents: 1875
diff changeset
189 int write_flag; /**< true if open for writing */
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
190 int is_streamed;
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
191 int max_packet_size;
418
41da3366d341 checksuming for nut & nice checksum API for libavformat
michael
parents: 389
diff changeset
192 unsigned long checksum;
41da3366d341 checksuming for nut & nice checksum API for libavformat
michael
parents: 389
diff changeset
193 unsigned char *checksum_ptr;
41da3366d341 checksuming for nut & nice checksum API for libavformat
michael
parents: 389
diff changeset
194 unsigned long (*update_checksum)(unsigned long checksum, const uint8_t *buf, unsigned int size);
554
e1f17fcfb92c write error handling
michael
parents: 418
diff changeset
195 int error; ///< contains the error code or 0 if no error happened
2839
b51319dd86e5 Merge recently added and still unused play and pause functions.
michael
parents: 2834
diff changeset
196 int (*read_pause)(void *opaque, int pause);
4091
626b5bfb5aef whitespace cosmetics
diego
parents: 3973
diff changeset
197 int64_t (*read_seek)(void *opaque, int stream_index,
626b5bfb5aef whitespace cosmetics
diego
parents: 3973
diff changeset
198 int64_t timestamp, int flags);
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
199 } ByteIOContext;
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
200
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
201 int init_put_byte(ByteIOContext *s,
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
202 unsigned char *buffer,
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
203 int buffer_size,
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
204 int write_flag,
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
205 void *opaque,
65
a58a8a53eb46 * UINTX -> uintx_t INTX -> intx_t
kabi
parents: 19
diff changeset
206 int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
554
e1f17fcfb92c write error handling
michael
parents: 418
diff changeset
207 int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
3973
549a09cf23fe Remove offset_t typedef and use int64_t directly instead.
diego
parents: 3852
diff changeset
208 int64_t (*seek)(void *opaque, int64_t offset, int whence));
2853
7ad207078047 Add a av_alloc_put_byte function.
reimar
parents: 2852
diff changeset
209 ByteIOContext *av_alloc_put_byte(
7ad207078047 Add a av_alloc_put_byte function.
reimar
parents: 2852
diff changeset
210 unsigned char *buffer,
7ad207078047 Add a av_alloc_put_byte function.
reimar
parents: 2852
diff changeset
211 int buffer_size,
7ad207078047 Add a av_alloc_put_byte function.
reimar
parents: 2852
diff changeset
212 int write_flag,
7ad207078047 Add a av_alloc_put_byte function.
reimar
parents: 2852
diff changeset
213 void *opaque,
7ad207078047 Add a av_alloc_put_byte function.
reimar
parents: 2852
diff changeset
214 int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
7ad207078047 Add a av_alloc_put_byte function.
reimar
parents: 2852
diff changeset
215 int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
3973
549a09cf23fe Remove offset_t typedef and use int64_t directly instead.
diego
parents: 3852
diff changeset
216 int64_t (*seek)(void *opaque, int64_t offset, int whence));
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
217
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
218 void put_byte(ByteIOContext *s, int b);
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
219 void put_buffer(ByteIOContext *s, const unsigned char *buf, int size);
65
a58a8a53eb46 * UINTX -> uintx_t INTX -> intx_t
kabi
parents: 19
diff changeset
220 void put_le64(ByteIOContext *s, uint64_t val);
a58a8a53eb46 * UINTX -> uintx_t INTX -> intx_t
kabi
parents: 19
diff changeset
221 void put_be64(ByteIOContext *s, uint64_t val);
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
222 void put_le32(ByteIOContext *s, unsigned int val);
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
223 void put_be32(ByteIOContext *s, unsigned int val);
937
a887adfe9dc5 add a Creative VOC (de)muxer
aurel
parents: 885
diff changeset
224 void put_le24(ByteIOContext *s, unsigned int val);
822
2614d3c1f415 kill duplicated get/put_be24()
michael
parents: 778
diff changeset
225 void put_be24(ByteIOContext *s, unsigned int val);
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
226 void put_le16(ByteIOContext *s, unsigned int val);
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
227 void put_be16(ByteIOContext *s, unsigned int val);
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
228 void put_tag(ByteIOContext *s, const char *tag);
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
229
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
230 void put_strz(ByteIOContext *s, const char *buf);
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
231
3168
103f156dd8cc Document a few url_* functions.
michael
parents: 3136
diff changeset
232 /**
103f156dd8cc Document a few url_* functions.
michael
parents: 3136
diff changeset
233 * fseek() equivalent for ByteIOContext.
103f156dd8cc Document a few url_* functions.
michael
parents: 3136
diff changeset
234 * @return new position or AVERROR.
103f156dd8cc Document a few url_* functions.
michael
parents: 3136
diff changeset
235 */
3973
549a09cf23fe Remove offset_t typedef and use int64_t directly instead.
diego
parents: 3852
diff changeset
236 int64_t url_fseek(ByteIOContext *s, int64_t offset, int whence);
3168
103f156dd8cc Document a few url_* functions.
michael
parents: 3136
diff changeset
237
103f156dd8cc Document a few url_* functions.
michael
parents: 3136
diff changeset
238 /**
103f156dd8cc Document a few url_* functions.
michael
parents: 3136
diff changeset
239 * Skip given number of bytes forward.
103f156dd8cc Document a few url_* functions.
michael
parents: 3136
diff changeset
240 * @param offset number of bytes
103f156dd8cc Document a few url_* functions.
michael
parents: 3136
diff changeset
241 */
3973
549a09cf23fe Remove offset_t typedef and use int64_t directly instead.
diego
parents: 3852
diff changeset
242 void url_fskip(ByteIOContext *s, int64_t offset);
3168
103f156dd8cc Document a few url_* functions.
michael
parents: 3136
diff changeset
243
103f156dd8cc Document a few url_* functions.
michael
parents: 3136
diff changeset
244 /**
103f156dd8cc Document a few url_* functions.
michael
parents: 3136
diff changeset
245 * ftell() equivalent for ByteIOContext.
103f156dd8cc Document a few url_* functions.
michael
parents: 3136
diff changeset
246 * @return position or AVERROR.
103f156dd8cc Document a few url_* functions.
michael
parents: 3136
diff changeset
247 */
3973
549a09cf23fe Remove offset_t typedef and use int64_t directly instead.
diego
parents: 3852
diff changeset
248 int64_t url_ftell(ByteIOContext *s);
3168
103f156dd8cc Document a few url_* functions.
michael
parents: 3136
diff changeset
249
103f156dd8cc Document a few url_* functions.
michael
parents: 3136
diff changeset
250 /**
103f156dd8cc Document a few url_* functions.
michael
parents: 3136
diff changeset
251 * Gets the filesize.
103f156dd8cc Document a few url_* functions.
michael
parents: 3136
diff changeset
252 * @return filesize or AVERROR
103f156dd8cc Document a few url_* functions.
michael
parents: 3136
diff changeset
253 */
3973
549a09cf23fe Remove offset_t typedef and use int64_t directly instead.
diego
parents: 3852
diff changeset
254 int64_t url_fsize(ByteIOContext *s);
3168
103f156dd8cc Document a few url_* functions.
michael
parents: 3136
diff changeset
255
103f156dd8cc Document a few url_* functions.
michael
parents: 3136
diff changeset
256 /**
103f156dd8cc Document a few url_* functions.
michael
parents: 3136
diff changeset
257 * feof() equivalent for ByteIOContext.
103f156dd8cc Document a few url_* functions.
michael
parents: 3136
diff changeset
258 * @return non zero if and only if end of file
103f156dd8cc Document a few url_* functions.
michael
parents: 3136
diff changeset
259 */
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
260 int url_feof(ByteIOContext *s);
3168
103f156dd8cc Document a few url_* functions.
michael
parents: 3136
diff changeset
261
554
e1f17fcfb92c write error handling
michael
parents: 418
diff changeset
262 int url_ferror(ByteIOContext *s);
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
263
2839
b51319dd86e5 Merge recently added and still unused play and pause functions.
michael
parents: 2834
diff changeset
264 int av_url_read_fpause(ByteIOContext *h, int pause);
4091
626b5bfb5aef whitespace cosmetics
diego
parents: 3973
diff changeset
265 int64_t av_url_read_fseek(ByteIOContext *h, int stream_index,
626b5bfb5aef whitespace cosmetics
diego
parents: 3973
diff changeset
266 int64_t timestamp, int flags);
2783
1a9db30c1d1c Extend ByteIOContext and add the buffered IO functions:
andoma
parents: 2778
diff changeset
267
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
268 #define URL_EOF (-1)
1876
247fdf49ffb8 Convert all the comment sections into Doxygen compatible comments, same for
takis
parents: 1875
diff changeset
269 /** @note return URL_EOF (-1) if EOF */
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
270 int url_fgetc(ByteIOContext *s);
1874
3328f652d741 Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents: 1787
diff changeset
271
1876
247fdf49ffb8 Convert all the comment sections into Doxygen compatible comments, same for
takis
parents: 1875
diff changeset
272 /** @warning currently size is limited */
206
3a493a2e5bba libavformat/avio.h compilation problem in VisualC++ by (lethean at realtime dot ssu dot ac dot kr)
michaelni
parents: 177
diff changeset
273 #ifdef __GNUC__
265
786e8286ea4a Patch for attribute(printf) by (Michel Bardiaux <mbardiaux at peaktime dot be>)
michaelni
parents: 206
diff changeset
274 int url_fprintf(ByteIOContext *s, const char *fmt, ...) __attribute__ ((__format__ (__printf__, 2, 3)));
206
3a493a2e5bba libavformat/avio.h compilation problem in VisualC++ by (lethean at realtime dot ssu dot ac dot kr)
michaelni
parents: 177
diff changeset
275 #else
3a493a2e5bba libavformat/avio.h compilation problem in VisualC++ by (lethean at realtime dot ssu dot ac dot kr)
michaelni
parents: 177
diff changeset
276 int url_fprintf(ByteIOContext *s, const char *fmt, ...);
3a493a2e5bba libavformat/avio.h compilation problem in VisualC++ by (lethean at realtime dot ssu dot ac dot kr)
michaelni
parents: 177
diff changeset
277 #endif
1874
3328f652d741 Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents: 1787
diff changeset
278
1876
247fdf49ffb8 Convert all the comment sections into Doxygen compatible comments, same for
takis
parents: 1875
diff changeset
279 /** @note unlike fgets, the EOL character is not returned and a whole
4091
626b5bfb5aef whitespace cosmetics
diego
parents: 3973
diff changeset
280 line is parsed. return NULL if first char read was EOF */
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
281 char *url_fgets(ByteIOContext *s, char *buf, int buf_size);
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
282
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
283 void put_flush_packet(ByteIOContext *s);
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
284
3174
e5c7e9eac774 Document get_*_buffer()
michael
parents: 3168
diff changeset
285
e5c7e9eac774 Document get_*_buffer()
michael
parents: 3168
diff changeset
286 /**
e5c7e9eac774 Document get_*_buffer()
michael
parents: 3168
diff changeset
287 * Reads size bytes from ByteIOContext into buf.
e5c7e9eac774 Document get_*_buffer()
michael
parents: 3168
diff changeset
288 * @returns number of bytes read or AVERROR
e5c7e9eac774 Document get_*_buffer()
michael
parents: 3168
diff changeset
289 */
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
290 int get_buffer(ByteIOContext *s, unsigned char *buf, int size);
3174
e5c7e9eac774 Document get_*_buffer()
michael
parents: 3168
diff changeset
291
e5c7e9eac774 Document get_*_buffer()
michael
parents: 3168
diff changeset
292 /**
e5c7e9eac774 Document get_*_buffer()
michael
parents: 3168
diff changeset
293 * Reads size bytes from ByteIOContext into buf.
3198
814a32de9ec7 minor typo fixes
diego
parents: 3176
diff changeset
294 * This reads at most 1 packet. If that is not enough fewer bytes will be
3174
e5c7e9eac774 Document get_*_buffer()
michael
parents: 3168
diff changeset
295 * returned.
e5c7e9eac774 Document get_*_buffer()
michael
parents: 3168
diff changeset
296 * @returns number of bytes read or AVERROR
e5c7e9eac774 Document get_*_buffer()
michael
parents: 3168
diff changeset
297 */
389
e14fcd57ad2f decode latency patch by (Leon van Stuivenberg <l dot vanstuivenberg at chello dot nl>)
michael
parents: 265
diff changeset
298 int get_partial_buffer(ByteIOContext *s, unsigned char *buf, int size);
1874
3328f652d741 Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents: 1787
diff changeset
299
1876
247fdf49ffb8 Convert all the comment sections into Doxygen compatible comments, same for
takis
parents: 1875
diff changeset
300 /** @note return 0 if EOF, so you cannot use it if EOF handling is
4091
626b5bfb5aef whitespace cosmetics
diego
parents: 3973
diff changeset
301 necessary */
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
302 int get_byte(ByteIOContext *s);
937
a887adfe9dc5 add a Creative VOC (de)muxer
aurel
parents: 885
diff changeset
303 unsigned int get_le24(ByteIOContext *s);
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
304 unsigned int get_le32(ByteIOContext *s);
65
a58a8a53eb46 * UINTX -> uintx_t INTX -> intx_t
kabi
parents: 19
diff changeset
305 uint64_t get_le64(ByteIOContext *s);
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
306 unsigned int get_le16(ByteIOContext *s);
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
307
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
308 char *get_strz(ByteIOContext *s, char *buf, int maxlen);
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
309 unsigned int get_be16(ByteIOContext *s);
822
2614d3c1f415 kill duplicated get/put_be24()
michael
parents: 778
diff changeset
310 unsigned int get_be24(ByteIOContext *s);
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
311 unsigned int get_be32(ByteIOContext *s);
65
a58a8a53eb46 * UINTX -> uintx_t INTX -> intx_t
kabi
parents: 19
diff changeset
312 uint64_t get_be64(ByteIOContext *s);
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
313
2700
dfcac0102c34 Add ff_ prefix to get_v()
kostya
parents: 2699
diff changeset
314 uint64_t ff_get_v(ByteIOContext *bc);
2699
49c540731133 Make get_v() available to the other demuxers
kostya
parents: 2683
diff changeset
315
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
316 static inline int url_is_streamed(ByteIOContext *s)
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
317 {
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
318 return s->is_streamed;
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
319 }
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
320
2582
1f9d02d072a7 Documentation fix for url_f(d)open()
benoit
parents: 2542
diff changeset
321 /** @note when opened as read/write, the buffers are only used for
4091
626b5bfb5aef whitespace cosmetics
diego
parents: 3973
diff changeset
322 writing */
2771
d52c718e83f9 Use dynamically allocated ByteIOContext in AVFormatContext
andoma
parents: 2748
diff changeset
323 int url_fdopen(ByteIOContext **s, URLContext *h);
1874
3328f652d741 Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents: 1787
diff changeset
324
1876
247fdf49ffb8 Convert all the comment sections into Doxygen compatible comments, same for
takis
parents: 1875
diff changeset
325 /** @warning must be called before any I/O */
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
326 int url_setbufsize(ByteIOContext *s, int buf_size);
2598
fc7f8ee4700b Add functionality to set the direction of a ByteIOContext buffer.
benoit
parents: 2582
diff changeset
327 /** Reset the buffer for reading or writing.
fc7f8ee4700b Add functionality to set the direction of a ByteIOContext buffer.
benoit
parents: 2582
diff changeset
328 * @note Will drop any data currently in the buffer without transmitting it.
fc7f8ee4700b Add functionality to set the direction of a ByteIOContext buffer.
benoit
parents: 2582
diff changeset
329 * @param flags URL_RDONLY to set up the buffer for reading, or URL_WRONLY
fc7f8ee4700b Add functionality to set the direction of a ByteIOContext buffer.
benoit
parents: 2582
diff changeset
330 * to set up the buffer for writing. */
fc7f8ee4700b Add functionality to set the direction of a ByteIOContext buffer.
benoit
parents: 2582
diff changeset
331 int url_resetbuf(ByteIOContext *s, int flags);
1874
3328f652d741 Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents: 1787
diff changeset
332
1876
247fdf49ffb8 Convert all the comment sections into Doxygen compatible comments, same for
takis
parents: 1875
diff changeset
333 /** @note when opened as read/write, the buffers are only used for
4091
626b5bfb5aef whitespace cosmetics
diego
parents: 3973
diff changeset
334 writing */
2771
d52c718e83f9 Use dynamically allocated ByteIOContext in AVFormatContext
andoma
parents: 2748
diff changeset
335 int url_fopen(ByteIOContext **s, const char *filename, int flags);
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
336 int url_fclose(ByteIOContext *s);
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
337 URLContext *url_fileno(ByteIOContext *s);
1874
3328f652d741 Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents: 1787
diff changeset
338
1876
247fdf49ffb8 Convert all the comment sections into Doxygen compatible comments, same for
takis
parents: 1875
diff changeset
339 /**
1874
3328f652d741 Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents: 1787
diff changeset
340 * Return the maximum packet size associated to packetized buffered file
3328f652d741 Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents: 1787
diff changeset
341 * handle. If the file is not packetized (stream like http or file on
3328f652d741 Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents: 1787
diff changeset
342 * disk), then 0 is returned.
3328f652d741 Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents: 1787
diff changeset
343 *
2747
2291661e6097 Fix Doxygen parameter name
takis
parents: 2700
diff changeset
344 * @param s buffered file handle
1874
3328f652d741 Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents: 1787
diff changeset
345 * @return maximum packet size in bytes
3328f652d741 Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents: 1787
diff changeset
346 */
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
347 int url_fget_max_packet_size(ByteIOContext *s);
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
348
2771
d52c718e83f9 Use dynamically allocated ByteIOContext in AVFormatContext
andoma
parents: 2748
diff changeset
349 int url_open_buf(ByteIOContext **s, uint8_t *buf, int buf_size, int flags);
1874
3328f652d741 Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents: 1787
diff changeset
350
1876
247fdf49ffb8 Convert all the comment sections into Doxygen compatible comments, same for
takis
parents: 1875
diff changeset
351 /** return the written or read size */
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
352 int url_close_buf(ByteIOContext *s);
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
353
1876
247fdf49ffb8 Convert all the comment sections into Doxygen compatible comments, same for
takis
parents: 1875
diff changeset
354 /**
1874
3328f652d741 Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents: 1787
diff changeset
355 * Open a write only memory stream.
3328f652d741 Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents: 1787
diff changeset
356 *
3328f652d741 Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents: 1787
diff changeset
357 * @param s new IO context
3328f652d741 Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents: 1787
diff changeset
358 * @return zero if no error.
3328f652d741 Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents: 1787
diff changeset
359 */
2771
d52c718e83f9 Use dynamically allocated ByteIOContext in AVFormatContext
andoma
parents: 2748
diff changeset
360 int url_open_dyn_buf(ByteIOContext **s);
1874
3328f652d741 Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents: 1787
diff changeset
361
1876
247fdf49ffb8 Convert all the comment sections into Doxygen compatible comments, same for
takis
parents: 1875
diff changeset
362 /**
1874
3328f652d741 Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents: 1787
diff changeset
363 * Open a write only packetized memory stream with a maximum packet
3328f652d741 Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents: 1787
diff changeset
364 * size of 'max_packet_size'. The stream is stored in a memory buffer
3328f652d741 Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents: 1787
diff changeset
365 * with a big endian 4 byte header giving the packet size in bytes.
3328f652d741 Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents: 1787
diff changeset
366 *
3328f652d741 Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents: 1787
diff changeset
367 * @param s new IO context
3328f652d741 Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents: 1787
diff changeset
368 * @param max_packet_size maximum packet size (must be > 0)
3328f652d741 Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents: 1787
diff changeset
369 * @return zero if no error.
3328f652d741 Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents: 1787
diff changeset
370 */
2771
d52c718e83f9 Use dynamically allocated ByteIOContext in AVFormatContext
andoma
parents: 2748
diff changeset
371 int url_open_dyn_packet_buf(ByteIOContext **s, int max_packet_size);
1874
3328f652d741 Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents: 1787
diff changeset
372
1876
247fdf49ffb8 Convert all the comment sections into Doxygen compatible comments, same for
takis
parents: 1875
diff changeset
373 /**
1874
3328f652d741 Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents: 1787
diff changeset
374 * Return the written size and a pointer to the buffer. The buffer
3328f652d741 Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents: 1787
diff changeset
375 * must be freed with av_free().
3328f652d741 Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents: 1787
diff changeset
376 * @param s IO context
2748
fdeb230c8ced Fix Doxygen parameter name
takis
parents: 2747
diff changeset
377 * @param pbuffer pointer to a byte buffer
1874
3328f652d741 Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents: 1787
diff changeset
378 * @return the length of the byte buffer
3328f652d741 Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents: 1787
diff changeset
379 */
65
a58a8a53eb46 * UINTX -> uintx_t INTX -> intx_t
kabi
parents: 19
diff changeset
380 int url_close_dyn_buf(ByteIOContext *s, uint8_t **pbuffer);
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
381
4091
626b5bfb5aef whitespace cosmetics
diego
parents: 3973
diff changeset
382 unsigned long ff_crc04C11DB7_update(unsigned long checksum, const uint8_t *buf,
626b5bfb5aef whitespace cosmetics
diego
parents: 3973
diff changeset
383 unsigned int len);
418
41da3366d341 checksuming for nut & nice checksum API for libavformat
michael
parents: 389
diff changeset
384 unsigned long get_checksum(ByteIOContext *s);
4091
626b5bfb5aef whitespace cosmetics
diego
parents: 3973
diff changeset
385 void init_checksum(ByteIOContext *s,
626b5bfb5aef whitespace cosmetics
diego
parents: 3973
diff changeset
386 unsigned long (*update_checksum)(unsigned long c, const uint8_t *p, unsigned int len),
626b5bfb5aef whitespace cosmetics
diego
parents: 3973
diff changeset
387 unsigned long checksum);
418
41da3366d341 checksuming for nut & nice checksum API for libavformat
michael
parents: 389
diff changeset
388
0
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
389 /* udp.c */
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
390 int udp_set_remote_url(URLContext *h, const char *uri);
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
391 int udp_get_local_port(URLContext *h);
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
392 int udp_get_file_handle(URLContext *h);
05318cf2e886 renamed libav to libavformat
bellard
parents:
diff changeset
393
3852
1b6245500d8c Globally rename the header inclusion guard names.
stefano
parents: 3744
diff changeset
394 #endif /* AVFORMAT_AVIO_H */