OpenShot Library | libopenshot-audio
0.1.9
|
Writes data to an internal memory buffer, which grows as required. More...
#include <juce_MemoryOutputStream.h>
Public Member Functions | |
MemoryOutputStream (size_t initialSize=256) | |
Creates an empty memory stream, ready to be written into. More... | |
MemoryOutputStream (MemoryBlock &memoryBlockToWriteTo, bool appendToExistingBlockContent) | |
Creates a memory stream for writing into into a pre-existing MemoryBlock object. More... | |
MemoryOutputStream (void *destBuffer, size_t destBufferSize) | |
Creates a MemoryOutputStream that will write into a user-supplied, fixed-size block of memory. More... | |
~MemoryOutputStream () override | |
Destructor. More... | |
const void * | getData () const noexcept |
Returns a pointer to the data that has been written to the stream. More... | |
size_t | getDataSize () const noexcept |
Returns the number of bytes of data that have been written to the stream. More... | |
void | reset () noexcept |
Resets the stream, clearing any data that has been written to it so far. More... | |
void | preallocate (size_t bytesToPreallocate) |
Increases the internal storage capacity to be able to contain at least the specified amount of data without needing to be resized. | |
bool | appendUTF8Char (juce_wchar character) |
Appends the utf-8 bytes for a unicode character. | |
String | toUTF8 () const |
Returns a String created from the (UTF8) data that has been written to the stream. More... | |
String | toString () const |
Attempts to detect the encoding of the data and convert it to a string. More... | |
MemoryBlock | getMemoryBlock () const |
Returns a copy of the stream's data as a memory block. More... | |
void | flush () override |
If the stream is writing to a user-supplied MemoryBlock, this will trim any excess capacity off the block, so that its length matches the amount of actual data that has been written so far. | |
bool | write (const void *, size_t) override |
Writes a block of data to the stream. More... | |
int64 | getPosition () override |
Returns the stream's current position. More... | |
bool | setPosition (int64) override |
Tries to move the stream's output position. More... | |
int64 | writeFromInputStream (InputStream &, int64 maxNumBytesToWrite) override |
Reads data from an input stream and writes it to this stream. More... | |
bool | writeRepeatedByte (uint8 byte, size_t numTimesToRepeat) override |
Writes a byte to the output stream a given number of times. More... | |
![]() | |
virtual | ~OutputStream () |
Destructor. More... | |
virtual bool | writeByte (char byte) |
Writes a single byte to the stream. More... | |
virtual bool | writeBool (bool boolValue) |
Writes a boolean to the stream as a single byte. More... | |
virtual bool | writeShort (short value) |
Writes a 16-bit integer to the stream in a little-endian byte order. More... | |
virtual bool | writeShortBigEndian (short value) |
Writes a 16-bit integer to the stream in a big-endian byte order. More... | |
virtual bool | writeInt (int value) |
Writes a 32-bit integer to the stream in a little-endian byte order. More... | |
virtual bool | writeIntBigEndian (int value) |
Writes a 32-bit integer to the stream in a big-endian byte order. More... | |
virtual bool | writeInt64 (int64 value) |
Writes a 64-bit integer to the stream in a little-endian byte order. More... | |
virtual bool | writeInt64BigEndian (int64 value) |
Writes a 64-bit integer to the stream in a big-endian byte order. More... | |
virtual bool | writeFloat (float value) |
Writes a 32-bit floating point value to the stream in a binary format. More... | |
virtual bool | writeFloatBigEndian (float value) |
Writes a 32-bit floating point value to the stream in a binary format. More... | |
virtual bool | writeDouble (double value) |
Writes a 64-bit floating point value to the stream in a binary format. More... | |
virtual bool | writeDoubleBigEndian (double value) |
Writes a 64-bit floating point value to the stream in a binary format. More... | |
virtual bool | writeCompressedInt (int value) |
Writes a condensed binary encoding of a 32-bit integer. More... | |
virtual bool | writeString (const String &text) |
Stores a string in the stream in a binary format. More... | |
virtual bool | writeText (const String &text, bool asUTF16, bool writeUTF16ByteOrderMark, const char *lineEndings) |
Writes a string of text to the stream. More... | |
void | setNewLineString (const String &newLineString) |
Sets the string to write to the stream when a new line is written. More... | |
const String & | getNewLineString () const noexcept |
Returns the current new-line string that was set by setNewLineString(). More... | |
Writes data to an internal memory buffer, which grows as required.
The data that was written into the stream can then be accessed later as a contiguous block of memory.
Definition at line 39 of file juce_MemoryOutputStream.h.
juce::MemoryOutputStream::MemoryOutputStream | ( | size_t | initialSize = 256 | ) |
Creates an empty memory stream, ready to be written into.
initialSize | the initial amount of capacity to allocate for writing into |
Definition at line 26 of file juce_MemoryOutputStream.cpp.
References juce::MemoryBlock::setSize().
juce::MemoryOutputStream::MemoryOutputStream | ( | MemoryBlock & | memoryBlockToWriteTo, |
bool | appendToExistingBlockContent | ||
) |
Creates a memory stream for writing into into a pre-existing MemoryBlock object.
Note that the destination block will always be larger than the amount of data that has been written to the stream, because the MemoryOutputStream keeps some spare capactity at its end. To trim the block's size down to fit the actual data, call flush(), or delete the MemoryOutputStream.
memoryBlockToWriteTo | the block into which new data will be written. |
appendToExistingBlockContent | if this is true, the contents of the block will be kept, and new data will be appended to it. If false, the block will be cleared before use |
Definition at line 32 of file juce_MemoryOutputStream.cpp.
References juce::MemoryBlock::getSize().
juce::MemoryOutputStream::MemoryOutputStream | ( | void * | destBuffer, |
size_t | destBufferSize | ||
) |
Creates a MemoryOutputStream that will write into a user-supplied, fixed-size block of memory.
When using this mode, the stream will write directly into this memory area until it's full, at which point write operations will fail.
Definition at line 40 of file juce_MemoryOutputStream.cpp.
|
override |
Destructor.
This will free any data that was written to it.
Definition at line 46 of file juce_MemoryOutputStream.cpp.
|
noexcept |
Returns a pointer to the data that has been written to the stream.
Definition at line 148 of file juce_MemoryOutputStream.cpp.
References juce::MemoryBlock::getData(), and juce::MemoryBlock::getSize().
Referenced by juce::XmlDocument::getDocumentElement(), getMemoryBlock(), juce::ValueTreeSynchroniser::sendFullSyncCallback(), juce::GZIPDecompressorInputStream::setPosition(), juce::GZIPCompressorOutputStream::setPosition(), juce::MemoryInputStream::skipNextBytes(), toString(), toUTF8(), and juce::ValueTree::Listener::valueTreeRedirected().
|
inlinenoexcept |
Returns the number of bytes of data that have been written to the stream.
Definition at line 84 of file juce_MemoryOutputStream.h.
Referenced by juce::URL::getChildURL(), juce::XmlDocument::getDocumentElement(), getMemoryBlock(), juce::ValueTreeSynchroniser::sendFullSyncCallback(), juce::GZIPDecompressorInputStream::setPosition(), juce::GZIPCompressorOutputStream::setPosition(), juce::MemoryInputStream::skipNextBytes(), toString(), toUTF8(), juce::ValueTree::Listener::valueTreeRedirected(), and juce::MidiFile::writeTo().
|
noexcept |
Resets the stream, clearing any data that has been written to it so far.
Definition at line 68 of file juce_MemoryOutputStream.cpp.
References juce::MemoryBlock::ensureSize(), juce::MemoryBlock::getData(), and juce::MemoryBlock::getSize().
String juce::MemoryOutputStream::toUTF8 | ( | ) | const |
Returns a String created from the (UTF8) data that has been written to the stream.
Definition at line 189 of file juce_MemoryOutputStream.cpp.
References getData(), and getDataSize().
Referenced by juce::XmlElement::createDocument(), juce::XmlElement::getAllSubText(), juce::XmlDocument::getLastParseError(), juce::var::readFromStream(), juce::InputStream::readNextLine(), juce::InputStream::readString(), and juce::JSON::toString().
String juce::MemoryOutputStream::toString | ( | ) | const |
Attempts to detect the encoding of the data and convert it to a string.
Definition at line 195 of file juce_MemoryOutputStream.cpp.
References juce::String::createStringFromData(), getData(), getDataSize(), and juce::OutputStream::write().
Referenced by juce::JSON::escapeString(), juce::XmlDocument::getDocumentElement(), juce::ChildProcess::readAllProcessOutput(), juce::InputStream::readEntireStreamAsString(), juce::Base64::toBase64(), and juce::PerformanceCounter::~PerformanceCounter().
MemoryBlock juce::MemoryOutputStream::getMemoryBlock | ( | ) | const |
Returns a copy of the stream's data as a memory block.
Definition at line 143 of file juce_MemoryOutputStream.cpp.
References getData(), and getDataSize().
Referenced by juce::Base64::toBase64().
|
overridevirtual |
Writes a block of data to the stream.
When creating a subclass of OutputStream, this is the only write method that needs to be overloaded - the base class has methods for writing other types of data which use this to do the work.
dataToWrite | the target buffer to receive the data. This must not be null. |
numberOfBytes | the number of bytes to write. |
Implements juce::OutputStream.
Definition at line 102 of file juce_MemoryOutputStream.cpp.
Referenced by juce::ChildProcess::readAllProcessOutput(), and juce::MidiFile::writeTo().
|
inlineoverridevirtual |
Returns the stream's current position.
Implements juce::OutputStream.
Definition at line 116 of file juce_MemoryOutputStream.h.
|
overridevirtual |
Tries to move the stream's output position.
Not all streams will be able to seek to a new position - this will return false if it fails to work.
Implements juce::OutputStream.
Definition at line 159 of file juce_MemoryOutputStream.cpp.
|
overridevirtual |
Reads data from an input stream and writes it to this stream.
source | the stream to read from |
maxNumBytesToWrite | the number of bytes to read from the stream (if this is less than zero, it will keep reading until the input is exhausted) |
Reimplemented from juce::OutputStream.
Definition at line 172 of file juce_MemoryOutputStream.cpp.
References juce::InputStream::getPosition(), juce::MemoryBlock::getSize(), juce::InputStream::getTotalLength(), preallocate(), and juce::OutputStream::writeFromInputStream().
Referenced by juce::XmlDocument::getDocumentElement(), juce::var::readFromStream(), and juce::InputStream::readIntoMemoryBlock().
|
overridevirtual |
Writes a byte to the output stream a given number of times.
Reimplemented from juce::OutputStream.
Definition at line 118 of file juce_MemoryOutputStream.cpp.