openshot-audio  0.1.7
Public Member Functions | List of all members
MemoryInputStream Class Reference

#include <juce_MemoryInputStream.h>

Inheritance diagram for MemoryInputStream:
InputStream

Public Member Functions

 MemoryInputStream (const void *sourceData, size_t sourceDataSize, bool keepInternalCopyOfData)
 
 MemoryInputStream (const MemoryBlock &data, bool keepInternalCopyOfData)
 
 ~MemoryInputStream ()
 
const void * getData () const noexcept
 
size_t getDataSize () const noexcept
 
int64 getPosition () override
 
bool setPosition (int64 pos) override
 
int64 getTotalLength () override
 
bool isExhausted () override
 
int read (void *destBuffer, int maxBytesToRead) override
 
- Public Member Functions inherited from InputStream
virtual ~InputStream ()
 
int64 getNumBytesRemaining ()
 
virtual char readByte ()
 
virtual bool readBool ()
 
virtual short readShort ()
 
virtual short readShortBigEndian ()
 
virtual int readInt ()
 
virtual int readIntBigEndian ()
 
virtual int64 readInt64 ()
 
virtual int64 readInt64BigEndian ()
 
virtual float readFloat ()
 
virtual float readFloatBigEndian ()
 
virtual double readDouble ()
 
virtual double readDoubleBigEndian ()
 
virtual int readCompressedInt ()
 
virtual String readNextLine ()
 
virtual String readString ()
 
virtual String readEntireStreamAsString ()
 
virtual size_t readIntoMemoryBlock (MemoryBlock &destBlock, ssize_t maxNumBytesToRead=-1)
 
virtual void skipNextBytes (int64 numBytesToSkip)
 

Additional Inherited Members

- Protected Member Functions inherited from InputStream
 InputStream () noexcept
 

Detailed Description

Allows a block of data to be accessed as a stream.

This can either be used to refer to a shared block of memory, or can make its own internal copy of the data when the MemoryInputStream is created.

Constructor & Destructor Documentation

◆ MemoryInputStream() [1/2]

MemoryInputStream::MemoryInputStream ( const void *  sourceData,
size_t  sourceDataSize,
bool  keepInternalCopyOfData 
)

Creates a MemoryInputStream.

Parameters
sourceDatathe block of data to use as the stream's source
sourceDataSizethe number of bytes in the source data block
keepInternalCopyOfDataif false, the stream will just keep a pointer to the source data, so this data shouldn't be changed for the lifetime of the stream; if this parameter is true, the stream will make its own copy of the data and use that.

◆ MemoryInputStream() [2/2]

MemoryInputStream::MemoryInputStream ( const MemoryBlock data,
bool  keepInternalCopyOfData 
)

Creates a MemoryInputStream.

Parameters
dataa block of data to use as the stream's source
keepInternalCopyOfDataif false, the stream will just keep a reference to the source data, so this data shouldn't be changed for the lifetime of the stream; if this parameter is true, the stream will make its own copy of the data and use that.

◆ ~MemoryInputStream()

MemoryInputStream::~MemoryInputStream ( )

Destructor.

Member Function Documentation

◆ getData()

const void* MemoryInputStream::getData ( ) const
inlinenoexcept

Returns a pointer to the source data block from which this stream is reading.

◆ getDataSize()

size_t MemoryInputStream::getDataSize ( ) const
inlinenoexcept

Returns the number of bytes of source data in the block from which this stream is reading.

◆ getPosition()

int64 MemoryInputStream::getPosition ( )
overridevirtual

Returns the offset of the next byte that will be read from the stream.

See also
setPosition

Implements InputStream.

◆ getTotalLength()

int64 MemoryInputStream::getTotalLength ( )
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.

See also
getNumBytesRemaining

Implements InputStream.

◆ isExhausted()

bool MemoryInputStream::isExhausted ( )
overridevirtual

Returns true if the stream has no more data to read.

Implements InputStream.

◆ read()

int MemoryInputStream::read ( void *  destBuffer,
int  maxBytesToRead 
)
overridevirtual

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).

Parameters
destBufferthe destination buffer for the data. This must not be null.
maxBytesToReadthe 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.
Returns
the actual number of bytes that were read, which may be less than maxBytesToRead if the stream is exhausted before it gets that far

Implements InputStream.

◆ setPosition()

bool MemoryInputStream::setPosition ( int64  newPosition)
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.

Returns
true if the stream manages to reposition itself correctly
See also
getPosition

Implements InputStream.


The documentation for this class was generated from the following files: