FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
avio_internal.h
Go to the documentation of this file.
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 #ifndef AVFORMAT_AVIO_INTERNAL_H
21 #define AVFORMAT_AVIO_INTERNAL_H
22 
23 #include "avio.h"
24 #include "url.h"
25 
26 #include "libavutil/log.h"
27 
28 extern const AVClass ff_avio_class;
29 
31  unsigned char *buffer,
32  int buffer_size,
33  int write_flag,
34  void *opaque,
35  int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
36  int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
37  int64_t (*seek)(void *opaque, int64_t offset, int whence));
38 
39 
40 /**
41  * Read size bytes from AVIOContext, returning a pointer.
42  * Note that the data pointed at by the returned pointer is only
43  * valid until the next call that references the same IO context.
44  * @param s IO context
45  * @param buf pointer to buffer into which to assemble the requested
46  * data if it is not available in contiguous addresses in the
47  * underlying buffer
48  * @param size number of bytes requested
49  * @param data address at which to store pointer: this will be a
50  * a direct pointer into the underlying buffer if the requested
51  * number of bytes are available at contiguous addresses, otherwise
52  * will be a copy of buf
53  * @return number of bytes read or AVERROR
54  */
55 int ffio_read_indirect(AVIOContext *s, unsigned char *buf, int size, const unsigned char **data);
56 
57 /**
58  * Read size bytes from AVIOContext into buf.
59  * This reads at most 1 packet. If that is not enough fewer bytes will be
60  * returned.
61  * @return number of bytes read or AVERROR
62  */
63 int ffio_read_partial(AVIOContext *s, unsigned char *buf, int size);
64 
65 void ffio_fill(AVIOContext *s, int b, int count);
66 
68 {
69  avio_wl32(pb, MKTAG(s[0], s[1], s[2], s[3]));
70 }
71 
72 /**
73  * Rewind the AVIOContext using the specified buffer containing the first buf_size bytes of the file.
74  * Used after probing to avoid seeking.
75  * Joins buf and s->buffer, taking any overlap into consideration.
76  * @note s->buffer must overlap with buf or they can't be joined and the function fails
77  *
78  * @param s The read-only AVIOContext to rewind
79  * @param buf The probe buffer containing the first buf_size bytes of the file
80  * @param buf_size The size of buf
81  * @return >= 0 in case of success, a negative value corresponding to an
82  * AVERROR code in case of failure
83  */
84 int ffio_rewind_with_probe_data(AVIOContext *s, unsigned char **buf, int buf_size);
85 
86 uint64_t ffio_read_varlen(AVIOContext *bc);
87 
88 /**
89  * Read size bytes from AVIOContext into buf.
90  * Check that exactly size bytes have been read.
91  * @return number of bytes read or AVERROR
92  */
93 int ffio_read_size(AVIOContext *s, unsigned char *buf, int size);
94 
95 /** @warning must be called before any I/O */
96 int ffio_set_buf_size(AVIOContext *s, int buf_size);
97 
98 /**
99  * Ensures that the requested seekback buffer size will be available
100  *
101  * Will ensure that when reading sequentially up to buf_size, seeking
102  * within the current pos and pos+buf_size is possible.
103  * Once the stream position moves outside this window this guarantee is lost.
104  */
105 int ffio_ensure_seekback(AVIOContext *s, int64_t buf_size);
106 
107 int ffio_limit(AVIOContext *s, int size);
108 
110  unsigned long (*update_checksum)(unsigned long c, const uint8_t *p, unsigned int len),
111  unsigned long checksum);
112 unsigned long ffio_get_checksum(AVIOContext *s);
113 unsigned long ff_crc04C11DB7_update(unsigned long checksum, const uint8_t *buf,
114  unsigned int len);
115 unsigned long ff_crcA001_update(unsigned long checksum, const uint8_t *buf,
116  unsigned int len);
117 
118 /**
119  * Open a write only packetized memory stream with a maximum packet
120  * size of 'max_packet_size'. The stream is stored in a memory buffer
121  * with a big-endian 4 byte header giving the packet size in bytes.
122  *
123  * @param s new IO context
124  * @param max_packet_size maximum packet size (must be > 0)
125  * @return zero if no error.
126  */
127 int ffio_open_dyn_packet_buf(AVIOContext **s, int max_packet_size);
128 
129 /**
130  * Create and initialize a AVIOContext for accessing the
131  * resource referenced by the URLContext h.
132  * @note When the URLContext h has been opened in read+write mode, the
133  * AVIOContext can be used only for writing.
134  *
135  * @param s Used to return the pointer to the created AVIOContext.
136  * In case of failure the pointed to value is set to NULL.
137  * @return >= 0 in case of success, a negative value corresponding to an
138  * AVERROR code in case of failure
139  */
141 
142 /**
143  * Open a write-only fake memory stream. The written data is not stored
144  * anywhere - this is only used for measuring the amount of data
145  * written.
146  *
147  * @param s new IO context
148  * @return zero if no error.
149  */
151 
152 int ffio_open_whitelist(AVIOContext **s, const char *url, int flags,
154  const char *whitelist);
155 
156 /**
157  * Close a null buffer.
158  *
159  * @param s an IO context opened by ffio_open_null_buf
160  * @return the number of bytes written to the null buffer
161  */
163 
164 /**
165  * Free a dynamic buffer.
166  *
167  * @param s a pointer to an IO context opened by avio_open_dyn_buf()
168  */
170 
171 #endif /* AVFORMAT_AVIO_INTERNAL_H */
uint64_t ffio_read_varlen(AVIOContext *bc)
Definition: aviobuf.c:773
const char * s
Definition: avisynth_c.h:631
Bytestream IO Context.
Definition: avio.h:111
Buffered I/O operations.
ptrdiff_t const GLvoid * data
Definition: opengl_enc.c:101
int ffio_close_null_buf(AVIOContext *s)
Close a null buffer.
Definition: aviobuf.c:1226
int ffio_rewind_with_probe_data(AVIOContext *s, unsigned char **buf, int buf_size)
Rewind the AVIOContext using the specified buffer containing the first buf_size bytes of the file...
Definition: aviobuf.c:882
int ffio_read_size(AVIOContext *s, unsigned char *buf, int size)
Read size bytes from AVIOContext into buf.
Definition: aviobuf.c:594
const char * b
Definition: vf_curves.c:109
int ffio_open_whitelist(AVIOContext **s, const char *url, int flags, const AVIOInterruptCB *int_cb, AVDictionary **options, const char *whitelist)
Definition: aviobuf.c:931
int ffio_limit(AVIOContext *s, int size)
Definition: utils.c:189
void avio_wl32(AVIOContext *s, unsigned int val)
Definition: aviobuf.c:324
uint8_t
int ffio_read_indirect(AVIOContext *s, unsigned char *buf, int size, const unsigned char **data)
Read size bytes from AVIOContext, returning a pointer.
Definition: aviobuf.c:602
const AVClass ff_avio_class
Definition: aviobuf.c:64
ptrdiff_t size
Definition: opengl_enc.c:101
static av_always_inline void ffio_wfourcc(AVIOContext *pb, const uint8_t *s)
Definition: avio_internal.h:67
const OptionDef options[]
Definition: ffserver.c:3962
Callback for checking whether to abort blocking functions.
Definition: avio.h:50
const AVIOInterruptCB int_cb
Definition: ffmpeg.c:457
int ffio_set_buf_size(AVIOContext *s, int buf_size)
Definition: aviobuf.c:852
int ffio_read_partial(AVIOContext *s, unsigned char *buf, int size)
Read size bytes from AVIOContext into buf.
Definition: aviobuf.c:614
static const uint8_t offset[127][2]
Definition: vf_spp.c:92
GLsizei count
Definition: opengl_enc.c:109
void ffio_init_checksum(AVIOContext *s, unsigned long(*update_checksum)(unsigned long c, const uint8_t *p, unsigned int len), unsigned long checksum)
Definition: aviobuf.c:524
void ffio_fill(AVIOContext *s, int b, int count)
Definition: aviobuf.c:168
int ffio_open_dyn_packet_buf(AVIOContext **s, int max_packet_size)
Open a write only packetized memory stream with a maximum packet size of 'max_packet_size'.
Definition: aviobuf.c:1161
unsigned long ff_crc04C11DB7_update(unsigned long checksum, const uint8_t *buf, unsigned int len)
Definition: aviobuf.c:504
unsigned long ff_crcA001_update(unsigned long checksum, const uint8_t *buf, unsigned int len)
Definition: aviobuf.c:510
void ffio_free_dyn_buf(AVIOContext **s)
Free a dynamic buffer.
Definition: aviobuf.c:1196
static int read_packet(void *opaque, uint8_t *buf, int buf_size)
Definition: avio_reading.c:42
void * buf
Definition: avisynth_c.h:553
Definition: url.h:39
Describe the class of an AVClass context structure.
Definition: log.h:67
unsigned long ffio_get_checksum(AVIOContext *s)
Definition: aviobuf.c:516
int ffio_open_null_buf(AVIOContext **s)
Open a write-only fake memory stream.
Definition: aviobuf.c:1216
static int flags
Definition: cpu.c:47
int ffio_ensure_seekback(AVIOContext *s, int64_t buf_size)
Ensures that the requested seekback buffer size will be available.
Definition: aviobuf.c:823
int ffio_init_context(AVIOContext *s, unsigned char *buffer, int buffer_size, int write_flag, void *opaque, int(*read_packet)(void *opaque, uint8_t *buf, int buf_size), int(*write_packet)(void *opaque, uint8_t *buf, int buf_size), int64_t(*seek)(void *opaque, int64_t offset, int whence))
Definition: aviobuf.c:76
static double c[64]
int len
int ffio_fdopen(AVIOContext **s, URLContext *h)
Create and initialize a AVIOContext for accessing the resource referenced by the URLContext h...
Definition: aviobuf.c:784
unbuffered private I/O API
#define av_always_inline
Definition: attributes.h:39
#define MKTAG(a, b, c, d)
Definition: common.h:342
static int write_packet(AVFormatContext *s1, AVPacket *pkt)
Definition: v4l2enc.c:86
GLuint buffer
Definition: opengl_enc.c:102