bp/FrameLib
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Added brief descriptions for private structures

Browse Source
This commit is contained in:
Alex Harker
2018-06-18 22:15:42 +01:00
parent 3f32ea04aa
commit 7835542af3
20 changed files with 334 additions and 253 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Documentation/Developer Documentation/html/_frame_lib___context_8h_source.html
+3 -3
View File
File diff suppressed because one or more lines are too long
Documentation/Developer Documentation/html/_frame_lib___d_s_p_8h.html
+1 -1
View File
@@ -104,7 +104,7 @@ Classes</h2></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">an abstract class containing the core of the DSP processing system, which handles single-stream scheduling. <a href="class_frame_lib___d_s_p.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_frame_lib___d_s_p_1_1_scheduler_info.html">FrameLib_DSP::SchedulerInfo</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">an struct for returning scheduling info from the schedule() method. <a href="struct_frame_lib___d_s_p_1_1_scheduler_info.html#details">More...</a><br /></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">a struct for returning scheduling info from the schedule() method. <a href="struct_frame_lib___d_s_p_1_1_scheduler_info.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_frame_lib___processor.html">FrameLib_Processor</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">a convenience class for creating processor <a class="el" href="class_frame_lib___d_s_p.html" title="an abstract class containing the core of the DSP processing system, which handles single-stream sched...">FrameLib_DSP</a> classes that do not handle audio. <a href="class_frame_lib___processor.html#details">More...</a><br /></td></tr>
Documentation/Developer Documentation/html/_frame_lib___d_s_p_8h_source.html
+55 -55
View File
File diff suppressed because one or more lines are too long
Documentation/Developer Documentation/html/_frame_lib___global_8h_source.html
+1 -1
View File
@@ -97,7 +97,7 @@ $(document).ready(function(){initNavTree('_frame_lib___global_8h_source.html',''
<div class="ttc" id="_frame_lib___memory_8h_html"><div class="ttname"><a href="_frame_lib___memory_8h.html">FrameLib_Memory.h</a></div></div>
<div class="ttc" id="class_frame_lib___processing_queue_html"><div class="ttname"><a href="class_frame_lib___processing_queue.html">FrameLib_ProcessingQueue</a></div><div class="ttdoc">a minimal processing queue that is used to non-recursively process FrameLIB_DSP objects in a network...</div><div class="ttdef"><b>Definition:</b> FrameLib_ProcessingQueue.h:30</div></div>
<div class="ttc" id="class_frame_lib___global_allocator_html"><div class="ttname"><a href="class_frame_lib___global_allocator.html">FrameLib_GlobalAllocator</a></div><div class="ttdoc">a global threadsafe memory allocator suitable for realtime usage. </div><div class="ttdef"><b>Definition:</b> FrameLib_Memory.h:31</div></div>
<div class="ttc" id="class_frame_lib___local_allocator_html"><div class="ttname"><a href="class_frame_lib___local_allocator.html">FrameLib_LocalAllocator</a></div><div class="ttdoc">a memory allocator suitable for usage in a given FrameLib context. </div><div class="ttdef"><b>Definition:</b> FrameLib_Memory.h:229</div></div>
<div class="ttc" id="class_frame_lib___local_allocator_html"><div class="ttname"><a href="class_frame_lib___local_allocator.html">FrameLib_LocalAllocator</a></div><div class="ttdoc">a memory allocator suitable for usage in a given FrameLib context. </div><div class="ttdef"><b>Definition:</b> FrameLib_Memory.h:245</div></div>
<div class="ttc" id="struct_frame_lib___error_reporter_1_1_host_notifier_html"><div class="ttname"><a href="struct_frame_lib___error_reporter_1_1_host_notifier.html">FrameLib_ErrorReporter::HostNotifier</a></div><div class="ttdoc">a virtual struct used to supply a method for notifying the host of errors. </div><div class="ttdef"><b>Definition:</b> FrameLib_Errors.h:47</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
Documentation/Developer Documentation/html/_frame_lib___memory_8h_source.html
+27 -27
View File
File diff suppressed because one or more lines are too long
Documentation/Developer Documentation/html/_frame_lib___multistream_8h_source.html
+19 -19
View File
File diff suppressed because one or more lines are too long
Documentation/Developer Documentation/html/_frame_lib___object_8h_source.html
+3 -3
View File
@@ -109,7 +109,7 @@ $(document).ready(function(){initNavTree('_frame_lib___object_8h_source.html',''
<div class="ttc" id="class_frame_lib___object_html_ab42be79621db7363ca4a34f63704d04f"><div class="ttname"><a href="class_frame_lib___object.html#ab42be79621db7363ca4a34f63704d04f">FrameLib_Object::dealloc</a></div><div class="ttdeci">void dealloc(U *&amp;ptr)</div><div class="ttdef"><b>Definition:</b> FrameLib_Object.h:400</div></div>
<div class="ttc" id="_frame_lib___types_8h_html_a2a427ca8c6f961bac8e41f6edecf0722aa60bde05fabf20fadbc9383756c0eb79"><div class="ttname"><a href="_frame_lib___types_8h.html#a2a427ca8c6f961bac8e41f6edecf0722aa60bde05fabf20fadbc9383756c0eb79">kConnectWrongContext</a></div><div class="ttdef"><b>Definition:</b> FrameLib_Types.h:56</div></div>
<div class="ttc" id="_frame_lib___types_8h_html_a2a427ca8c6f961bac8e41f6edecf0722ac2d587c92eaceb7c3a66b6f0f59e68fd"><div class="ttname"><a href="_frame_lib___types_8h.html#a2a427ca8c6f961bac8e41f6edecf0722ac2d587c92eaceb7c3a66b6f0f59e68fd">kConnectAliased</a></div><div class="ttdef"><b>Definition:</b> FrameLib_Types.h:56</div></div>
<div class="ttc" id="class_frame_lib___context_html_a5282f95b5825866bc4bb2aad500ccfa3"><div class="ttname"><a href="class_frame_lib___context.html#a5282f95b5825866bc4bb2aad500ccfa3">FrameLib_Context::Allocator</a></div><div class="ttdeci">ManagedPointer&lt; FrameLib_LocalAllocator, &amp;Global::getAllocator, &amp;Global::releaseAllocator &gt; Allocator</div><div class="ttdef"><b>Definition:</b> FrameLib_Context.h:95</div></div>
<div class="ttc" id="class_frame_lib___context_html_a5282f95b5825866bc4bb2aad500ccfa3"><div class="ttname"><a href="class_frame_lib___context.html#a5282f95b5825866bc4bb2aad500ccfa3">FrameLib_Context::Allocator</a></div><div class="ttdeci">ManagedPointer&lt; FrameLib_LocalAllocator, &amp;Global::getAllocator, &amp;Global::releaseAllocator &gt; Allocator</div><div class="ttdef"><b>Definition:</b> FrameLib_Context.h:103</div></div>
<div class="ttc" id="class_frame_lib___object_html_a316d15b17757ddfef4341d0f8afe443e"><div class="ttname"><a href="class_frame_lib___object.html#a316d15b17757ddfef4341d0f8afe443e">FrameLib_Object::registerStorage</a></div><div class="ttdeci">FrameLib_LocalAllocator::Storage * registerStorage(const char *name)</div><div class="ttdef"><b>Definition:</b> FrameLib_Object.h:408</div></div>
<div class="ttc" id="class_frame_lib___object_html_a59e6e7dba2d18444be6d5fbee15c73f2"><div class="ttname"><a href="class_frame_lib___object.html#a59e6e7dba2d18444be6d5fbee15c73f2">FrameLib_Object::getNumAudioChans</a></div><div class="ttdeci">unsigned long getNumAudioChans() const</div><div class="ttdef"><b>Definition:</b> FrameLib_Object.h:220</div></div>
<div class="ttc" id="struct_frame_lib___proxy_html"><div class="ttname"><a href="struct_frame_lib___proxy.html">FrameLib_Proxy</a></div><div class="ttdoc">a virtual struct allowing for extensible communication to/from the host environment. </div><div class="ttdef"><b>Definition:</b> FrameLib_Types.h:69</div></div>
@@ -122,7 +122,7 @@ $(document).ready(function(){initNavTree('_frame_lib___object_8h_source.html',''
<div class="ttc" id="class_frame_lib___object_html_a7babe2dd654fbd0c8c05eb7f7ea31550"><div class="ttname"><a href="class_frame_lib___object.html#a7babe2dd654fbd0c8c05eb7f7ea31550">FrameLib_Object::formatInfo</a></div><div class="ttdeci">static std::string formatInfo(const char *verboseStr, const char *briefStr, const char *replaceStr, bool verbose)</div><div class="ttdef"><b>Definition:</b> FrameLib_Object.h:449</div></div>
<div class="ttc" id="class_frame_lib___object_html_a8d96d1f55054e583a99891ad65f84a3a"><div class="ttname"><a href="class_frame_lib___object.html#a8d96d1f55054e583a99891ad65f84a3a">FrameLib_Object::getType</a></div><div class="ttdeci">ObjectType getType() const</div><div class="ttdef"><b>Definition:</b> FrameLib_Object.h:204</div></div>
<div class="ttc" id="class_frame_lib___queueable_1_1_queue_html_a5eb25b5751d5cc25331aa5e1b4fcb6ae"><div class="ttname"><a href="class_frame_lib___queueable_1_1_queue.html#a5eb25b5751d5cc25331aa5e1b4fcb6ae">FrameLib_Queueable::Queue::Queue</a></div><div class="ttdeci">Queue()</div><div class="ttdef"><b>Definition:</b> FrameLib_Object.h:52</div></div>
<div class="ttc" id="class_frame_lib___local_allocator_1_1_storage_html_ac1a8a26c698837c22b87b76999041bf2"><div class="ttname"><a href="class_frame_lib___local_allocator_1_1_storage.html#ac1a8a26c698837c22b87b76999041bf2">FrameLib_LocalAllocator::Storage::getName</a></div><div class="ttdeci">const char * getName() const</div><div class="ttdef"><b>Definition:</b> FrameLib_Memory.h:306</div></div>
<div class="ttc" id="class_frame_lib___local_allocator_1_1_storage_html_ac1a8a26c698837c22b87b76999041bf2"><div class="ttname"><a href="class_frame_lib___local_allocator_1_1_storage.html#ac1a8a26c698837c22b87b76999041bf2">FrameLib_LocalAllocator::Storage::getName</a></div><div class="ttdeci">const char * getName() const</div><div class="ttdef"><b>Definition:</b> FrameLib_Memory.h:328</div></div>
<div class="ttc" id="class_frame_lib___object_html"><div class="ttname"><a href="class_frame_lib___object.html">FrameLib_Object</a></div><div class="ttdoc">an abstract template class providing an interface for FrameLib objects and implementing connectivity ...</div><div class="ttdef"><b>Definition:</b> FrameLib_Object.h:128</div></div>
<div class="ttc" id="class_frame_lib___object_html_a4fa6add369fd21ddc5250efd740d0285"><div class="ttname"><a href="class_frame_lib___object.html#a4fa6add369fd21ddc5250efd740d0285">FrameLib_Object::clearConnections</a></div><div class="ttdeci">void clearConnections()</div><div class="ttdef"><b>Definition:</b> FrameLib_Object.h:285</div></div>
<div class="ttc" id="class_frame_lib___object_html_a7c57bdfc3fa9a9bb34b607ffa240d47e"><div class="ttname"><a href="class_frame_lib___object.html#a7c57bdfc3fa9a9bb34b607ffa240d47e">FrameLib_Object::parameterInputInfo</a></div><div class="ttdeci">static std::string parameterInputInfo(bool verbose)</div><div class="ttdef"><b>Definition:</b> FrameLib_Object.h:454</div></div>
@@ -169,7 +169,7 @@ $(document).ready(function(){initNavTree('_frame_lib___object_8h_source.html',''
<div class="ttc" id="_frame_lib___types_8h_html_ad495a9f61af7fff07d7e97979d1ab854"><div class="ttname"><a href="_frame_lib___types_8h.html#ad495a9f61af7fff07d7e97979d1ab854">FrameType</a></div><div class="ttdeci">FrameType</div><div class="ttdef"><b>Definition:</b> FrameLib_Types.h:54</div></div>
<div class="ttc" id="class_frame_lib___object_html_a2cb965a15f4634a5fdddc2b009005211"><div class="ttname"><a href="class_frame_lib___object.html#a2cb965a15f4634a5fdddc2b009005211">FrameLib_Object::formatInfo</a></div><div class="ttdeci">static const char * formatInfo(const char *verboseStr, const char *briefStr, bool verbose)</div><div class="ttdef"><b>Definition:</b> FrameLib_Object.h:418</div></div>
<div class="ttc" id="struct_frame_lib___object_1_1_connection_html_adcdad42d336b5d8861c63a6389fa4695"><div class="ttname"><a href="struct_frame_lib___object_1_1_connection.html#adcdad42d336b5d8861c63a6389fa4695">FrameLib_Object::Connection::Connection</a></div><div class="ttdeci">Connection(T *object, unsigned long index)</div><div class="ttdef"><b>Definition:</b> FrameLib_Object.h:146</div></div>
<div class="ttc" id="class_frame_lib___local_allocator_1_1_storage_html"><div class="ttname"><a href="class_frame_lib___local_allocator_1_1_storage.html">FrameLib_LocalAllocator::Storage</a></div><div class="ttdoc">named storage local to a specific context. </div><div class="ttdef"><b>Definition:</b> FrameLib_Memory.h:256</div></div>
<div class="ttc" id="class_frame_lib___local_allocator_1_1_storage_html"><div class="ttname"><a href="class_frame_lib___local_allocator_1_1_storage.html">FrameLib_LocalAllocator::Storage</a></div><div class="ttdoc">named storage local to a specific context. </div><div class="ttdef"><b>Definition:</b> FrameLib_Memory.h:278</div></div>
<div class="ttc" id="class_frame_lib___object_html_a87d56a68ea04f515206adb616b233048"><div class="ttname"><a href="class_frame_lib___object.html#a87d56a68ea04f515206adb616b233048">FrameLib_Object::getConnection</a></div><div class="ttdeci">Connection getConnection(unsigned long inIdx) const</div><div class="ttdef"><b>Definition:</b> FrameLib_Object.h:335</div></div>
<div class="ttc" id="_frame_lib___types_8h_html_a842c5e2e69277690b064bf363c017980a618a746f8c3d171ae0a7c2d9ced0c21c"><div class="ttname"><a href="_frame_lib___types_8h.html#a842c5e2e69277690b064bf363c017980a618a746f8c3d171ae0a7c2d9ced0c21c">kScheduler</a></div><div class="ttdef"><b>Definition:</b> FrameLib_Types.h:53</div></div>
<div class="ttc" id="class_frame_lib___queueable_1_1_queue_html_a3fb4a73a39929ac3defbb98e3efdd363"><div class="ttname"><a href="class_frame_lib___queueable_1_1_queue.html#a3fb4a73a39929ac3defbb98e3efdd363">FrameLib_Queueable::Queue::start</a></div><div class="ttdeci">void start(Method method)</div><div class="ttdef"><b>Definition:</b> FrameLib_Object.h:83</div></div>
Documentation/Developer Documentation/html/_frame_lib___parameters_8h_source.html
+98 -98
View File
File diff suppressed because one or more lines are too long
Documentation/Developer Documentation/html/_frame_lib___processing_queue_8h_source.html
+4 -4
View File
File diff suppressed because one or more lines are too long
Documentation/Developer Documentation/html/class_frame_lib___d_s_p.html
+1 -1
View File
@@ -118,7 +118,7 @@ Inheritance diagram for FrameLib_DSP:</div>
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_frame_lib___d_s_p_1_1_scheduler_info.html">SchedulerInfo</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">an struct for returning scheduling info from the schedule() method. <a href="struct_frame_lib___d_s_p_1_1_scheduler_info.html#details">More...</a><br /></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">a struct for returning scheduling info from the schedule() method. <a href="struct_frame_lib___d_s_p_1_1_scheduler_info.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Documentation/Developer Documentation/html/struct_frame_lib___d_s_p_1_1_scheduler_info.html
+2 -2
View File
@@ -90,7 +90,7 @@ $(document).ready(function(){initNavTree('struct_frame_lib___d_s_p_1_1_scheduler
</div><!--header-->
<div class="contents">
<p>an struct for returning scheduling info from the schedule() method.
<p>a struct for returning scheduling info from the schedule() method.
<a href="struct_frame_lib___d_s_p_1_1_scheduler_info.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_frame_lib___d_s_p_8h_source.html">FrameLib_DSP.h</a>&gt;</code></p>
@@ -112,7 +112,7 @@ Public Attributes</h2></td></tr>
<tr class="separator:aee41d636cde5b117b4ce8610905d668d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>an struct for returning scheduling info from the schedule() method. </p>
<div class="textblock"><p>a struct for returning scheduling info from the schedule() method. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a5939a752d4ea50eea67c019805254a82"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5939a752d4ea50eea67c019805254a82">&#9670;&nbsp;</a></span>SchedulerInfo() <span class="overload">[1/2]</span></h2>
Documentation/Developer Documentation/latex/_frame_lib___d_s_p_8h.tex
+1 -1
View File
@@ -14,7 +14,7 @@
class \hyperlink{class_frame_lib___d_s_p}{Frame\+Lib\+\_\+\+D\+SP}
\begin{DoxyCompactList}\small\item\em an abstract class containing the core of the D\+SP processing system, which handles single-\/stream scheduling. \end{DoxyCompactList}\item
struct \hyperlink{struct_frame_lib___d_s_p_1_1_scheduler_info}{Frame\+Lib\+\_\+\+D\+S\+P\+::\+Scheduler\+Info}
\begin{DoxyCompactList}\small\item\em an struct for returning scheduling info from the schedule() method. \end{DoxyCompactList}\item
\begin{DoxyCompactList}\small\item\em a struct for returning scheduling info from the schedule() method. \end{DoxyCompactList}\item
class \hyperlink{class_frame_lib___processor}{Frame\+Lib\+\_\+\+Processor}
\begin{DoxyCompactList}\small\item\em a convenience class for creating processor \hyperlink{class_frame_lib___d_s_p}{Frame\+Lib\+\_\+\+D\+SP} classes that do not handle audio. \end{DoxyCompactList}\item
class \hyperlink{class_frame_lib___audio_input}{Frame\+Lib\+\_\+\+Audio\+Input}
Documentation/Developer Documentation/latex/class_frame_lib___d_s_p.tex
+1 -1
View File
@@ -19,7 +19,7 @@ Inheritance diagram for Frame\+Lib\+\_\+\+D\+SP\+:\begin{figure}[H]
\begin{DoxyCompactItemize}
\item
struct \hyperlink{struct_frame_lib___d_s_p_1_1_scheduler_info}{Scheduler\+Info}
\begin{DoxyCompactList}\small\item\em an struct for returning scheduling info from the schedule() method. \end{DoxyCompactList}\end{DoxyCompactItemize}
\begin{DoxyCompactList}\small\item\em a struct for returning scheduling info from the schedule() method. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item
Documentation/Developer Documentation/latex/struct_frame_lib___d_s_p_1_1_scheduler_info.tex
+2 -2
View File
@@ -2,7 +2,7 @@
\label{struct_frame_lib___d_s_p_1_1_scheduler_info}\index{Frame\+Lib\+\_\+\+D\+S\+P\+::\+Scheduler\+Info@{Frame\+Lib\+\_\+\+D\+S\+P\+::\+Scheduler\+Info}}
an struct for returning scheduling info from the schedule() method.
a struct for returning scheduling info from the schedule() method.
@@ -28,7 +28,7 @@ bool \hyperlink{struct_frame_lib___d_s_p_1_1_scheduler_info_aee41d636cde5b117b4c
\subsection{Detailed Description}
an struct for returning scheduling info from the schedule() method.
a struct for returning scheduling info from the schedule() method.
\subsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{struct_frame_lib___d_s_p_1_1_scheduler_info_a5939a752d4ea50eea67c019805254a82}\label{struct_frame_lib___d_s_p_1_1_scheduler_info_a5939a752d4ea50eea67c019805254a82}}
FrameLib_Framework/FrameLib_Context.h
+9 -1
View File
@@ -34,7 +34,15 @@ class FrameLib_Context
return !(a == b);
}
// Non-copyable template class for retaining reference counted pointers using RAII
/**
\class ManagedPointer
\brief a managed pointer for a context-related result.
This is a non-copyable class that uses RAII to update the reference counted pointer in FrameLib_Global
*/
template <class T, T *(Global::*getMethod)(void *), void(Global::*releaseMethod)(void *)>
class ManagedPointer
FrameLib_Framework/FrameLib_DSP.h
+16 -1
View File
@@ -36,7 +36,7 @@ protected:
\struct SchedulerInfo
\brief an struct for returning scheduling info from the schedule() method.
\brief a struct for returning scheduling info from the schedule() method.
*/
@@ -55,6 +55,14 @@ protected:
private:
/**
\struct Input
\brief a struct that represents an input, its options, connections and any fixed input.
*/
struct Input
{
Input() : mObject(nullptr), mIndex(0), mSize(0), mFixedInput(nullptr), mType(kFrameNormal), mUpdate(false), mParameters(false), mTrigger(true), mSwitchable(false) {}
@@ -81,6 +89,13 @@ private:
bool mSwitchable;
};
/**
\struct Output
\brief a struct that represents an output frame.
*/
struct Output
{
Output() : mMemory(nullptr), mType(kFrameNormal), mCurrentType(kFrameNormal), mRequestedType(kFrameNormal), mCurrentSize(0), mRequestedSize(0), mPointerOffset(0) {}
FrameLib_Framework/FrameLib_Memory.h
+38 -16
View File
@@ -33,13 +33,23 @@ class FrameLib_GlobalAllocator
private:
// The Core Allocator (has no threadsafety)
/**
\class CoreAllocator
\brief the underlying single-threaded allocator.
*/
class CoreAllocator
{
// ************************************************************************************** //
// Memory Pools
/**
\struct Pool
\brief a memory pool from system memory.
*/
struct Pool
{
@@ -55,9 +65,13 @@ private:
void *mMem;
};
// ************************************************************************************** //
// Thread for Allocating System Memory
/**
\class NewThread
\brief a thread for allocating new memory pools from system memory.
*/
class NewThread final : public FrameLib_DelegateThread
{
@@ -73,10 +87,14 @@ private:
CoreAllocator *mAllocator;
};
// ************************************************************************************** //
// Thread for Freeing System Memory
/**
\class FreeThread
\brief a thread for freeing memory pools back to system memory.
*/
class FreeThread final : public FrameLib_TriggerableThread
{
@@ -90,9 +108,7 @@ private:
CoreAllocator *mAllocator;
};
// ************************************************************************************** //
public:
CoreAllocator(FrameLib_ErrorReporter& errorReporter);
@@ -228,10 +244,16 @@ private:
class FrameLib_LocalAllocator
{
// Local Blocks (free memory in double linked list (using internal pointers))
static const int numLocalFreeBlocks = 16;
/**
\struct FreeBlock
\brief a memory block that can be addressed as part of double-linked list.
*/
struct FreeBlock
{
FreeBlock() : mMemory(nullptr), mSize(0), mPrev(nullptr), mNext(nullptr) {}
FrameLib_Framework/FrameLib_Multistream.h
+2 -1
View File
@@ -120,7 +120,8 @@ private:
*/
template <class T> class FrameLib_Expand final : public FrameLib_Multistream
template <class T>
class FrameLib_Expand final : public FrameLib_Multistream
{
public:
FrameLib_Framework/FrameLib_Parameters.h
+43 -16
View File
@@ -67,6 +67,14 @@ public:
class Iterator
{
/**
\struct Entry
\brief data for a single entry in a Serial.
*/
struct Entry
{
DataType mType;
@@ -285,11 +293,15 @@ public:
std::vector<std::string> mInfoStrings;
};
// ************************************************************************************** //
private:
// Abstract Parameter Class
/**
\class Parameter
\brief an abstract class representing a parameter.
*/
class Parameter
{
@@ -367,9 +379,13 @@ private:
long mArgumentIdx;
};
// ************************************************************************************** //
// Enum Parameter Class
/**
\class Parameter
\brief an enumerated parameter class.
*/
class Enum final : public Parameter
{
@@ -402,9 +418,13 @@ private:
unsigned long mValue;
};
// ************************************************************************************** //
// Value Parameter Class
/**
\class Value
\brief a numeric parameter class storing a single value as a double.
*/
class Value final : public Parameter
{
@@ -432,9 +452,13 @@ private:
double mValue;
};
// ************************************************************************************** //
// String Parameter Class
/**
\class String
\brief a string parameter class.
*/
class String final : public Parameter
{
@@ -461,7 +485,13 @@ private:
char mCString[maxLen + 1];
};
// ************************************************************************************** //
/**
\class Array
\brief a numeric parameter class storing an array of values.
*/
// Array Parameter Class
@@ -495,8 +525,6 @@ private:
const bool mVariableSize;
};
// ************************************************************************************** //
public:
// Constructor
@@ -509,7 +537,6 @@ public:
FrameLib_Parameters(const FrameLib_Parameters&) = delete;
FrameLib_Parameters& operator=(const FrameLib_Parameters&) = delete;
// Enable/Disable Error Reporting (enabled by default)
void setErrorReportingEnabled(bool enable) { mReportErrors = enable; }
FrameLib_Framework/FrameLib_ProcessingQueue.h
+8
View File
@@ -29,6 +29,14 @@ class FrameLib_DSP;
class FrameLib_ProcessingQueue
{
/**
\class IntervalSecondsClock
\brief a clock for measuring time intervals in seconds.
*/
class IntervalSecondsClock
{