arduino-audio-tools
Public Member Functions | List of all members
dsp_memory_manager Class Reference

Memory manager which uses psram when it is available. More...

#include <AudioFaustDSP.h>

Public Member Functions

virtual void * allocate (size_t size)
 
virtual bool begin (size_t count)
 
virtual void destroy (void *ptr)
 
virtual void end ()
 
virtual void info (size_t size, size_t reads, size_t writes)
 

Detailed Description

Memory manager which uses psram when it is available.

Member Function Documentation

◆ allocate()

virtual void* allocate ( size_t  size)
inlinevirtual

Allocate a memory zone.

Parameters
size- the memory zone size in bytes

◆ begin()

virtual bool begin ( size_t  count)
inlinevirtual

Inform the Memory Manager with the number of expected memory zones.

Parameters
count- the number of memory zones

◆ destroy()

virtual void destroy ( void *  ptr)
inlinevirtual

Destroy a memory zone.

Parameters
ptr- the memory zone pointer to be deallocated

◆ end()

virtual void end ( )
inlinevirtual

Inform the Memory Manager that all memory zones have been described, to possibly start a 'compute the best allocation strategy' step.

◆ info()

virtual void info ( size_t  size,
size_t  reads,
size_t  writes 
)
inlinevirtual

Give the Memory Manager information on a given memory zone.

Parameters
size- the size in bytes of the memory zone
reads- the number of Read access to the zone used to compute one frame
writes- the number of Write access to the zone used to compute one frame

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