Auto-expanding buffer composed of multiple buffer instances. More...
#include <DynamicMultiBuffer.h>
Public Member Functions | |
| DynamicMultiBuffer (size_t component_size, size_t initial_components=1, size_t max_components=0) | |
| Constructor with buffer configuration. | |
| virtual | ~DynamicMultiBuffer () |
| Destructor - releases all buffer components. | |
| T * | address () override |
| Get pointer to current read position. | |
| int | available () override |
| Get number of elements available to read. | |
| int | availableForWrite () override |
| Get space available for writing. | |
| bool | begin () |
| (Re)sets the read pos to the start | |
| bool | begin (int pos) |
| (Re)sets the read pos to the indicated position | |
| void | clear () |
| same as reset | |
| virtual int | clearArray (int len) |
| Removes the next len entries. | |
| size_t | getComponentCount () |
| Get the number of buffer components. | |
| size_t | getComponentSize () |
| Get the size of each component. | |
| bool | isEmpty () override |
| Check if the buffer is empty. | |
| bool | isFull () override |
| Check if the buffer is full. | |
| virtual float | levelPercent () |
| Returns the level of the buffer in %. | |
| bool | peek (T &result) override |
| Peek at the next value without removing it. | |
| bool | read (T &result) override |
| Read a single value from the buffer. | |
| int | readArray (T data[], int len) override |
| Optimized bulk read operation. | |
| void | reset () override |
| Reset the buffer to empty state. | |
| bool | resize (int new_size) override |
| Resize the buffer. | |
| size_t | size () override |
| Get total capacity of the buffer. | |
| bool | write (T data) override |
| Write a value to the buffer. | |
| int | writeArray (const T data[], int len) override |
| Optimized bulk write operation. | |
| virtual int | writeArrayOverwrite (const T data[], int len) |
| Fills the buffer data and overwrites the oldest data if the buffer is full. | |
Protected Member Functions | |
| bool | addBufferComponent () |
| Add a new buffer component. | |
| bool | isCurrentBufferFull () |
| Check if the current write buffer is full. | |
| size_t | totalCapacity () |
| Calculate total capacity of all buffer components. | |
Protected Attributes | |
| Vector< BufferType< T > * > | buffer_components |
| size_t | component_size_ = 0 |
| size_t | max_components_ = 0 |
| size_t | read_pos = 0 |
| size_t | write_pos = 0 |
Detailed Description
class audio_tools::DynamicMultiBuffer< T, BufferType >
Auto-expanding buffer composed of multiple buffer instances.
DynamicMultiBuffer manages a collection of buffer components, automatically adding new buffers when existing ones become full. This provides dynamically growing storage capacity while maintaining the performance characteristics of the underlying buffer implementation.
Ideal use cases:
- Recording audio of unknown duration
- Processing large audio files without pre-allocating maximum memory
- Audio applications where memory requirements grow unpredictably
- Efficient memory use by allocating only what's needed
- Copyright
- GPLv3
- Template Parameters
-
T Data type to be stored in the buffer BufferType The buffer implementation to use for each component
Constructor & Destructor Documentation
◆ DynamicMultiBuffer()
|
inline |
Constructor with buffer configuration.
- Parameters
-
component_size Size of each individual buffer component (elements) initial_components Number of buffer components to pre-allocate max_components Maximum number of components (0 for unlimited)
◆ ~DynamicMultiBuffer()
|
inlinevirtual |
Destructor - releases all buffer components.
Member Function Documentation
◆ addBufferComponent()
|
inlineprotected |
Add a new buffer component.
Creates and adds a new buffer component if allowed by max_components.
- Returns
- true if component was added, false if max reached or allocation failed
◆ address()
Get pointer to current read position.
Note: This method has limitations since data may span multiple buffer components. It returns the address from the current component.
- Returns
- Pointer to the current read position in memory
Implements BaseBuffer< T >.
◆ available()
|
inlineoverridevirtual |
Get number of elements available to read.
- Returns
- Number of elements that can be read from the buffer
Implements BaseBuffer< T >.
◆ availableForWrite()
|
inlineoverridevirtual |
Get space available for writing.
Returns remaining space in existing components plus potential new components up to max_components limit.
- Returns
- Number of elements that can be written
Implements BaseBuffer< T >.
◆ begin() [1/2]
(Re)sets the read pos to the start
◆ begin() [2/2]
(Re)sets the read pos to the indicated position
◆ clear()
|
inlineinherited |
same as reset
◆ clearArray()
Removes the next len entries.
Reimplemented in SingleBuffer< T >.
◆ getComponentCount()
Get the number of buffer components.
- Returns
- Current number of buffer components
◆ getComponentSize()
Get the size of each component.
- Returns
- Size of each buffer component in elements
◆ isCurrentBufferFull()
|
inlineprotected |
Check if the current write buffer is full.
- Returns
- true if current buffer is full or no buffers exist
◆ isEmpty()
Check if the buffer is empty.
- Returns
- true if no elements are available to read
◆ isFull()
Check if the buffer is full.
Buffer is considered full only if we've reached max components and the last component is full.
- Returns
- true if no more elements can be written
Reimplemented from BaseBuffer< T >.
◆ levelPercent()
◆ peek()
Peek at the next value without removing it.
Returns the next element that would be read without advancing the read position.
- Parameters
-
result Reference where the peeked value will be stored
- Returns
- true if peek was successful, false if buffer is empty
Implements BaseBuffer< T >.
◆ read()
Read a single value from the buffer.
Reads from the current read position, potentially spanning buffer components.
- Parameters
-
result Reference where the read value will be stored
- Returns
- true if read was successful, false if buffer is empty
Implements BaseBuffer< T >.
◆ readArray()
Optimized bulk read operation.
Reads multiple elements, potentially spanning across buffer components.
- Parameters
-
data Buffer where read data will be stored len Number of elements to read
- Returns
- Number of elements actually read
Reimplemented from BaseBuffer< T >.
◆ reset()
Reset the buffer to empty state.
Clears all buffer components but keeps them allocated.
Implements BaseBuffer< T >.
◆ resize()
Resize the buffer.
Changes the number of buffer components to match the requested size.
- Parameters
-
new_size New size in number of elements
- Returns
- true if resize was successful
Reimplemented from BaseBuffer< T >.
◆ size()
Get total capacity of the buffer.
- Returns
- Size of all components combined, in number of elements
Implements BaseBuffer< T >.
◆ totalCapacity()
|
inlineprotected |
Calculate total capacity of all buffer components.
- Returns
- Combined size of all components in elements
◆ write()
Write a value to the buffer.
Adds an element to the buffer at the current write position, automatically expanding capacity by adding a new buffer component if needed.
- Parameters
-
data Value to write
- Returns
- true if write was successful, false if buffer is full (max components reached)
Implements BaseBuffer< T >.
◆ writeArray()
Optimized bulk write operation.
Writes multiple elements, automatically expanding capacity by adding new buffer components as needed.
- Parameters
-
data Array of elements to write len Number of elements to write
- Returns
- Number of elements actually written
Reimplemented from BaseBuffer< T >.
◆ writeArrayOverwrite()
Fills the buffer data and overwrites the oldest data if the buffer is full.
Member Data Documentation
◆ buffer_components
|
protected |
◆ component_size_
◆ max_components_
◆ read_pos
◆ write_pos
The documentation for this class was generated from the following file:
- src/AudioTools/Sandbox/DynamicMultiBuffer.h
