OpenShot Audio Library | OpenShotAudio 0.3.2
Loading...
Searching...
No Matches
juce::MemoryBlock Class Reference

#include <juce_MemoryBlock.h>

Public Member Functions

 MemoryBlock () noexcept
 
 MemoryBlock (const size_t initialSize, bool initialiseToZero=false)
 
 MemoryBlock (const MemoryBlock &)
 
 MemoryBlock (const void *dataToInitialiseFrom, size_t sizeInBytes)
 
 ~MemoryBlock () noexcept
 
MemoryBlockoperator= (const MemoryBlock &)
 
 MemoryBlock (MemoryBlock &&) noexcept
 
MemoryBlockoperator= (MemoryBlock &&) noexcept
 
bool operator== (const MemoryBlock &other) const noexcept
 
bool operator!= (const MemoryBlock &other) const noexcept
 
bool matches (const void *data, size_t dataSize) const noexcept
 
voidgetData () noexcept
 
const voidgetData () const noexcept
 
template<typename Type >
charoperator[] (const Type offset) noexcept
 
template<typename Type >
const charoperator[] (const Type offset) const noexcept
 
charbegin () noexcept
 
const charbegin () const noexcept
 
charend () noexcept
 
const charend () const noexcept
 
size_t getSize () const noexcept
 
void setSize (const size_t newSize, bool initialiseNewSpaceToZero=false)
 
void ensureSize (const size_t minimumSize, bool initialiseNewSpaceToZero=false)
 
void reset ()
 
void fillWith (uint8 valueToUse) noexcept
 
void append (const void *data, size_t numBytes)
 
void replaceWith (const void *data, size_t numBytes)
 
void insert (const void *dataToInsert, size_t numBytesToInsert, size_t insertPosition)
 
void removeSection (size_t startByte, size_t numBytesToRemove)
 
void copyFrom (const void *srcData, int destinationOffset, size_t numBytes) noexcept
 
void copyTo (void *destData, int sourceOffset, size_t numBytes) const noexcept
 
void swapWith (MemoryBlock &other) noexcept
 
String toString () const
 
void loadFromHexString (StringRef sourceHexString)
 
void setBitRange (size_t bitRangeStart, size_t numBits, int binaryNumberToApply) noexcept
 
int getBitRange (size_t bitRangeStart, size_t numBitsToRead) const noexcept
 
String toBase64Encoding () const
 
bool fromBase64Encoding (StringRef encodedString)
 

Detailed Description

A class to hold a resizable block of raw data.

Definition at line 32 of file juce_MemoryBlock.h.

Constructor & Destructor Documentation

◆ MemoryBlock() [1/5]

juce::MemoryBlock::MemoryBlock ( )
noexcept

Create an uninitialised block with 0 size.

Definition at line 26 of file juce_MemoryBlock.cpp.

◆ MemoryBlock() [2/5]

juce::MemoryBlock::MemoryBlock ( const size_t  initialSize,
bool  initialiseToZero = false 
)

Creates a memory block with a given initial size.

Parameters
initialSizethe size of block to create
initialiseToZerowhether to clear the memory or just leave it uninitialised

Definition at line 28 of file juce_MemoryBlock.cpp.

◆ MemoryBlock() [3/5]

juce::MemoryBlock::MemoryBlock ( const MemoryBlock other)

Creates a copy of another memory block.

Definition at line 41 of file juce_MemoryBlock.cpp.

◆ MemoryBlock() [4/5]

juce::MemoryBlock::MemoryBlock ( const void dataToInitialiseFrom,
size_t  sizeInBytes 
)

Creates a memory block using a copy of a block of data.

Parameters
dataToInitialiseFromsome data to copy into this block
sizeInByteshow much space to use

Definition at line 52 of file juce_MemoryBlock.cpp.

◆ ~MemoryBlock()

juce::MemoryBlock::~MemoryBlock ( )
noexcept

Destructor.

Definition at line 68 of file juce_MemoryBlock.cpp.

◆ MemoryBlock() [5/5]

juce::MemoryBlock::MemoryBlock ( MemoryBlock &&  other)
noexcept

Move constructor

Definition at line 83 of file juce_MemoryBlock.cpp.

Member Function Documentation

◆ append()

void juce::MemoryBlock::append ( const void data,
size_t  numBytes 
)

Adds another block of data to the end of this one. The data pointer must not be null. This block's size will be increased accordingly.

Definition at line 166 of file juce_MemoryBlock.cpp.

◆ begin() [1/2]

const char * juce::MemoryBlock::begin ( ) const
inlinenoexcept

Returns an iterator for the data.

Definition at line 114 of file juce_MemoryBlock.h.

◆ begin() [2/2]

char * juce::MemoryBlock::begin ( )
inlinenoexcept

Returns an iterator for the data.

Definition at line 111 of file juce_MemoryBlock.h.

◆ copyFrom()

void juce::MemoryBlock::copyFrom ( const void srcData,
int  destinationOffset,
size_t  numBytes 
)
noexcept

Copies data into this MemoryBlock from a memory address.

Parameters
srcDatathe memory location of the data to copy into this block
destinationOffsetthe offset in this block at which the data being copied should begin
numByteshow much to copy in (if this goes beyond the size of the memory block, it will be clipped so not to do anything nasty)

Definition at line 221 of file juce_MemoryBlock.cpp.

◆ copyTo()

void juce::MemoryBlock::copyTo ( void destData,
int  sourceOffset,
size_t  numBytes 
) const
noexcept

Copies data from this MemoryBlock to a memory address.

Parameters
destDatathe memory location to write to
sourceOffsetthe offset within this block from which the copied data will be read
numByteshow much to copy (if this extends beyond the limits of the memory block, zeros will be used for that portion of the data)

Definition at line 239 of file juce_MemoryBlock.cpp.

◆ end() [1/2]

const char * juce::MemoryBlock::end ( ) const
inlinenoexcept

Returns an end-iterator for the data.

Definition at line 120 of file juce_MemoryBlock.h.

◆ end() [2/2]

char * juce::MemoryBlock::end ( )
inlinenoexcept

Returns an end-iterator for the data.

Definition at line 117 of file juce_MemoryBlock.h.

◆ ensureSize()

void juce::MemoryBlock::ensureSize ( const size_t  minimumSize,
bool  initialiseNewSpaceToZero = false 
)

Increases the block's size only if it's smaller than a given size.

Parameters
minimumSizeif the block is already bigger than this size, no action will be taken; otherwise it will be increased to this size
initialiseNewSpaceToZeroif the block gets enlarged, this determines whether to clear the new section or just leave it uninitialised
See also
setSize

Definition at line 148 of file juce_MemoryBlock.cpp.

Referenced by loadFromHexString(), and juce::MemoryOutputStream::preallocate().

◆ fillWith()

void juce::MemoryBlock::fillWith ( uint8  valueToUse)
noexcept

Fills the entire memory block with a repeated byte value. This is handy for clearing a block of memory to zero.

Definition at line 161 of file juce_MemoryBlock.cpp.

◆ fromBase64Encoding()

bool juce::MemoryBlock::fromBase64Encoding ( StringRef  encodedString)

Takes a string created by MemoryBlock::toBase64Encoding() and extracts the original data.

The string passed in must have been created by to64BitEncoding(), and this block will be resized to recreate the original data block.

Note that these methods use a JUCE-specific (i.e. not standard!) 64-bit encoding system. You may prefer to use the Base64::convertFromBase64() method if you want to use the standard base-64 encoding.

See also
toBase64Encoding, Base64::convertFromBase64

Definition at line 379 of file juce_MemoryBlock.cpp.

◆ getBitRange()

int juce::MemoryBlock::getBitRange ( size_t  bitRangeStart,
size_t  numBitsToRead 
) const
noexcept

Reads a number of bits from the memory block, treating it as one long binary sequence

Definition at line 268 of file juce_MemoryBlock.cpp.

Referenced by toBase64Encoding().

◆ getData() [1/2]

const void * juce::MemoryBlock::getData ( ) const
inlinenoexcept

Returns a void pointer to the data.

Note that the pointer returned will probably become invalid when the block is resized.

Definition at line 98 of file juce_MemoryBlock.h.

◆ getData() [2/2]

void * juce::MemoryBlock::getData ( )
inlinenoexcept

◆ getSize()

size_t juce::MemoryBlock::getSize ( ) const
inlinenoexcept

◆ insert()

void juce::MemoryBlock::insert ( const void dataToInsert,
size_t  numBytesToInsert,
size_t  insertPosition 
)

Inserts some data into the block. The dataToInsert pointer must not be null. This block's size will be increased accordingly. If the insert position lies outside the valid range of the block, it will be clipped to within the range before being used.

Definition at line 187 of file juce_MemoryBlock.cpp.

◆ loadFromHexString()

void juce::MemoryBlock::loadFromHexString ( StringRef  sourceHexString)

Parses a string of hexadecimal numbers and writes this data into the memory block.

The block will be resized to the number of valid bytes read from the string. Non-hex characters in the string will be ignored.

See also
String::toHexString()

Definition at line 316 of file juce_MemoryBlock.cpp.

◆ matches()

bool juce::MemoryBlock::matches ( const void data,
size_t  dataSize 
) const
noexcept

Returns true if the data in this MemoryBlock matches the raw bytes passed-in.

Definition at line 107 of file juce_MemoryBlock.cpp.

◆ operator!=()

bool juce::MemoryBlock::operator!= ( const MemoryBlock other) const
noexcept

Compares two memory blocks.

Returns
true if the two blocks are different sizes or have different contents.

Definition at line 102 of file juce_MemoryBlock.cpp.

◆ operator=() [1/2]

MemoryBlock & juce::MemoryBlock::operator= ( const MemoryBlock other)

Copies another memory block onto this one. This block will be resized and copied to exactly match the other one.

Definition at line 72 of file juce_MemoryBlock.cpp.

◆ operator=() [2/2]

MemoryBlock & juce::MemoryBlock::operator= ( MemoryBlock &&  other)
noexcept

Move assignment operator

Definition at line 89 of file juce_MemoryBlock.cpp.

◆ operator==()

bool juce::MemoryBlock::operator== ( const MemoryBlock other) const
noexcept

Compares two memory blocks.

Returns
true only if the two blocks are the same size and have identical contents.

Definition at line 97 of file juce_MemoryBlock.cpp.

◆ operator[]() [1/2]

template<typename Type >
const char & juce::MemoryBlock::operator[] ( const Type  offset) const
inlinenoexcept

Returns a byte from the memory block.

Definition at line 108 of file juce_MemoryBlock.h.

◆ operator[]() [2/2]

template<typename Type >
char & juce::MemoryBlock::operator[] ( const Type  offset)
inlinenoexcept

Returns a byte from the memory block. This returns a reference, so you can also use it to set a byte.

Definition at line 104 of file juce_MemoryBlock.h.

◆ removeSection()

void juce::MemoryBlock::removeSection ( size_t  startByte,
size_t  numBytesToRemove 
)

Chops out a section of the block.

This will remove a section of the memory block and close the gap around it, shifting any subsequent data downwards and reducing the size of the block.

If the range specified goes beyond the size of the block, it will be clipped.

Definition at line 205 of file juce_MemoryBlock.cpp.

◆ replaceWith()

void juce::MemoryBlock::replaceWith ( const void data,
size_t  numBytes 
)

Resizes this block to the given size and fills its contents from the supplied buffer. The data pointer must not be null.

Definition at line 177 of file juce_MemoryBlock.cpp.

◆ reset()

void juce::MemoryBlock::reset ( )

Frees all the blocks data, setting its size to 0.

Definition at line 142 of file juce_MemoryBlock.cpp.

Referenced by setSize().

◆ setBitRange()

void juce::MemoryBlock::setBitRange ( size_t  bitRangeStart,
size_t  numBits,
int  binaryNumberToApply 
)
noexcept

Sets a number of bits in the memory block, treating it as a long binary sequence.

Definition at line 292 of file juce_MemoryBlock.cpp.

Referenced by fromBase64Encoding().

◆ setSize()

void juce::MemoryBlock::setSize ( const size_t  newSize,
bool  initialiseNewSpaceToZero = false 
)

Resizes the memory block.

Any data that is present in both the old and new sizes will be retained. When enlarging the block, the new space that is allocated at the end can either be cleared, or left uninitialised.

Parameters
newSizethe new desired size for the block
initialiseNewSpaceToZeroif the block gets enlarged, this determines whether to clear the new section or just leave it uninitialised
See also
ensureSize

Definition at line 115 of file juce_MemoryBlock.cpp.

Referenced by append(), ensureSize(), fromBase64Encoding(), insert(), loadFromHexString(), juce::MemoryOutputStream::MemoryOutputStream(), operator=(), removeSection(), and replaceWith().

◆ swapWith()

void juce::MemoryBlock::swapWith ( MemoryBlock other)
noexcept

Exchanges the contents of this and another memory block. No actual copying is required for this, so it's very fast.

Definition at line 154 of file juce_MemoryBlock.cpp.

◆ toBase64Encoding()

String juce::MemoryBlock::toBase64Encoding ( ) const

Returns a string of characters in a JUCE-specific text encoding that represents the binary contents of this block.

This uses a JUCE-specific (i.e. not standard!) 64-bit encoding system to convert binary data into a string of ASCII characters for purposes like storage in XML. Note that this proprietary format is mainly kept here for backwards-compatibility, and you may prefer to use the Base64::toBase64() method if you want to use the standard base-64 encoding.

See also
fromBase64Encoding, Base64::toBase64, Base64::convertToBase64

Definition at line 353 of file juce_MemoryBlock.cpp.

◆ toString()

String juce::MemoryBlock::toString ( ) const

Attempts to parse the contents of the block as a zero-terminated UTF8 string.

Definition at line 262 of file juce_MemoryBlock.cpp.


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