OpenShot Audio Library | OpenShotAudio 0.3.2
|
#include <juce_BufferedInputStream.h>
Wraps another input stream, and reads from it using an intermediate buffer
If you're using an input stream such as a file input stream, and making lots of small read accesses to it, it's probably sensible to wrap it in one of these, so that the source stream gets accessed in larger chunk sizes, meaning less work for the underlying stream.
Definition at line 36 of file juce_BufferedInputStream.h.
juce::BufferedInputStream::BufferedInputStream | ( | InputStream * | sourceStream, |
int | bufferSize, | ||
bool | deleteSourceWhenDestroyed | ||
) |
Creates a BufferedInputStream from an input source.
sourceStream | the source stream to read from |
bufferSize | the size of reservoir to use to buffer the source |
deleteSourceWhenDestroyed | whether the sourceStream that is passed in should be deleted by this object when it is itself deleted. |
Definition at line 41 of file juce_BufferedInputStream.cpp.
juce::BufferedInputStream::BufferedInputStream | ( | InputStream & | sourceStream, |
int | bufferSize | ||
) |
Creates a BufferedInputStream from an input source.
sourceStream | the source stream to read from - the source stream must not be deleted until this object has been destroyed. |
bufferSize | the size of reservoir to use to buffer the source |
Definition at line 50 of file juce_BufferedInputStream.cpp.
|
override |
Destructor.
This may also delete the source stream, if that option was chosen when the buffered stream was created.
Definition at line 55 of file juce_BufferedInputStream.cpp.
|
overridevirtual |
Returns the offset of the next byte that will be read from the stream.
Implements juce::InputStream.
Definition at line 73 of file juce_BufferedInputStream.cpp.
|
overridevirtual |
Returns the total number of bytes available for reading in this stream.
Note that this is the number of bytes available from the start of the stream, not from the current position.
If the size of the stream isn't actually known, this will return -1.
Implements juce::InputStream.
Definition at line 68 of file juce_BufferedInputStream.cpp.
|
overridevirtual |
Returns true if the stream has no more data to read.
Implements juce::InputStream.
Definition at line 84 of file juce_BufferedInputStream.cpp.
Referenced by read().
char juce::BufferedInputStream::peekByte | ( | ) |
Returns the next byte that would be read by a call to readByte()
Definition at line 60 of file juce_BufferedInputStream.cpp.
Reads some data from the stream into a memory buffer.
This is the only read method that subclasses actually need to implement, as the InputStream base class implements the other read methods in terms of this one (although it's often more efficient for subclasses to implement them directly).
destBuffer | the destination buffer for the data. This must not be null. |
maxBytesToRead | the maximum number of bytes to read - make sure the memory block passed in is big enough to contain this many bytes. This value must not be negative. |
Implements juce::InputStream.
Definition at line 136 of file juce_BufferedInputStream.cpp.
|
overridevirtual |
Reads a zero-terminated UTF-8 string from the stream.
This will read characters from the stream until it hits a null character or end-of-stream.
Reimplemented from juce::InputStream.
Definition at line 178 of file juce_BufferedInputStream.cpp.
|
overridevirtual |
Tries to move the current read position of the stream.
The position is an absolute number of bytes from the stream's start.
Some streams might not be able to do this, in which case they should do nothing and return false. Others might be able to manage it by resetting themselves and skipping to the correct position, although this is obviously a bit slow.
Implements juce::InputStream.
Definition at line 78 of file juce_BufferedInputStream.cpp.