OpenShot Library | libopenshot-audio 0.2.0
|
An input stream that reads from a local file. More...
#include <juce_FileInputStream.h>
Public Member Functions | |
FileInputStream (const File &fileToRead) | |
Creates a FileInputStream to read from the given file. | |
~FileInputStream () override | |
Destructor. | |
const File & | getFile () const noexcept |
Returns the file that this stream is reading from. | |
const Result & | getStatus () const noexcept |
Returns the status of the file stream. | |
bool | failedToOpen () const noexcept |
Returns true if the stream couldn't be opened for some reason. | |
bool | openedOk () const noexcept |
Returns true if the stream opened without problems. | |
int64 | getTotalLength () override |
Returns the total number of bytes available for reading in this stream. | |
int | read (void *, int) override |
Reads some data from the stream into a memory buffer. | |
bool | isExhausted () override |
Returns true if the stream has no more data to read. | |
int64 | getPosition () override |
Returns the offset of the next byte that will be read from the stream. | |
bool | setPosition (int64) override |
Tries to move the current read position of the stream. | |
![]() | |
virtual | ~InputStream ()=default |
Destructor. | |
int64 | getNumBytesRemaining () |
Returns the number of bytes available for reading, or a negative value if the remaining length is not known. | |
virtual char | readByte () |
Reads a byte from the stream. | |
virtual bool | readBool () |
Reads a boolean from the stream. | |
virtual short | readShort () |
Reads two bytes from the stream as a little-endian 16-bit value. | |
virtual short | readShortBigEndian () |
Reads two bytes from the stream as a little-endian 16-bit value. | |
virtual int | readInt () |
Reads four bytes from the stream as a little-endian 32-bit value. | |
virtual int | readIntBigEndian () |
Reads four bytes from the stream as a big-endian 32-bit value. | |
virtual int64 | readInt64 () |
Reads eight bytes from the stream as a little-endian 64-bit value. | |
virtual int64 | readInt64BigEndian () |
Reads eight bytes from the stream as a big-endian 64-bit value. | |
virtual float | readFloat () |
Reads four bytes as a 32-bit floating point value. | |
virtual float | readFloatBigEndian () |
Reads four bytes as a 32-bit floating point value. | |
virtual double | readDouble () |
Reads eight bytes as a 64-bit floating point value. | |
virtual double | readDoubleBigEndian () |
Reads eight bytes as a 64-bit floating point value. | |
virtual int | readCompressedInt () |
Reads an encoded 32-bit number from the stream using a space-saving compressed format. | |
virtual String | readNextLine () |
Reads a UTF-8 string from the stream, up to the next linefeed or carriage return. | |
virtual String | readString () |
Reads a zero-terminated UTF-8 string from the stream. | |
virtual String | readEntireStreamAsString () |
Tries to read the whole stream and turn it into a string. | |
virtual size_t | readIntoMemoryBlock (MemoryBlock &destBlock, ssize_t maxNumBytesToRead=-1) |
Reads from the stream and appends the data to a MemoryBlock. | |
virtual void | skipNextBytes (int64 numBytesToSkip) |
Reads and discards a number of bytes from the stream. | |
An input stream that reads from a local file.
Definition at line 38 of file juce_FileInputStream.h.
Creates a FileInputStream to read from the given file.
After creating a FileInputStream, you should use openedOk() or failedToOpen() to make sure that it's OK before trying to read from it! If it failed, you can call getStatus() to get more error information.
Definition at line 30 of file juce_FileInputStream.cpp.
Returns the file that this stream is reading from.
Definition at line 55 of file juce_FileInputStream.h.
Returns the status of the file stream.
The result will be ok if the file opened successfully. If an error occurs while opening or reading from the file, this will contain an error message.
Definition at line 61 of file juce_FileInputStream.h.
|
inlinenoexcept |
Returns true if the stream couldn't be opened for some reason.
Definition at line 66 of file juce_FileInputStream.h.
|
inlinenoexcept |
Returns true if the stream opened without problems.
Definition at line 71 of file juce_FileInputStream.h.
Referenced by getTotalLength(), read(), and setPosition().
|
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 35 of file juce_FileInputStream.cpp.
References openedOk().
Referenced by isExhausted().
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 43 of file juce_FileInputStream.cpp.
References openedOk().
|
overridevirtual |
Returns true if the stream has no more data to read.
Implements juce::InputStream.
Definition at line 58 of file juce_FileInputStream.cpp.
References getTotalLength().
|
overridevirtual |
Returns the offset of the next byte that will be read from the stream.
Implements juce::InputStream.
Definition at line 63 of file juce_FileInputStream.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 68 of file juce_FileInputStream.cpp.
References openedOk().