mirror of
https://github.com/cjcliffe/CubicSDR.git
synced 2024-11-15 16:41:54 -05:00
105 lines
3.8 KiB
C
105 lines
3.8 KiB
C
#ifndef PA_ALLOCATION_H
|
|
#define PA_ALLOCATION_H
|
|
/*
|
|
* $Id: pa_allocation.h 1339 2008-02-15 07:50:33Z rossb $
|
|
* Portable Audio I/O Library allocation context header
|
|
* memory allocation context for tracking allocation groups
|
|
*
|
|
* Based on the Open Source API proposed by Ross Bencina
|
|
* Copyright (c) 1999-2008 Ross Bencina, Phil Burk
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining
|
|
* a copy of this software and associated documentation files
|
|
* (the "Software"), to deal in the Software without restriction,
|
|
* including without limitation the rights to use, copy, modify, merge,
|
|
* publish, distribute, sublicense, and/or sell copies of the Software,
|
|
* and to permit persons to whom the Software is furnished to do so,
|
|
* subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be
|
|
* included in all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
|
* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
|
|
* ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
|
|
* CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
|
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
*/
|
|
|
|
/*
|
|
* The text above constitutes the entire PortAudio license; however,
|
|
* the PortAudio community also makes the following non-binding requests:
|
|
*
|
|
* Any person wishing to distribute modifications to the Software is
|
|
* requested to send the modifications to the original developer so that
|
|
* they can be incorporated into the canonical version. It is also
|
|
* requested that these non-binding requests be included along with the
|
|
* license above.
|
|
*/
|
|
|
|
/** @file
|
|
@ingroup common_src
|
|
|
|
@brief Allocation Group prototypes. An Allocation Group makes it easy to
|
|
allocate multiple blocks of memory and free them all at once.
|
|
|
|
An allocation group is useful for keeping track of multiple blocks
|
|
of memory which are allocated at the same time (such as during initialization)
|
|
and need to be deallocated at the same time. The allocation group maintains
|
|
a list of allocated blocks, and can free all allocations at once. This
|
|
can be usefull for cleaning up after a partially initialized object fails.
|
|
|
|
The allocation group implementation is built on top of the lower
|
|
level allocation functions defined in pa_util.h
|
|
*/
|
|
|
|
|
|
#ifdef __cplusplus
|
|
extern "C"
|
|
{
|
|
#endif /* __cplusplus */
|
|
|
|
|
|
typedef struct
|
|
{
|
|
long linkCount;
|
|
struct PaUtilAllocationGroupLink *linkBlocks;
|
|
struct PaUtilAllocationGroupLink *spareLinks;
|
|
struct PaUtilAllocationGroupLink *allocations;
|
|
}PaUtilAllocationGroup;
|
|
|
|
|
|
|
|
/** Create an allocation group.
|
|
*/
|
|
PaUtilAllocationGroup* PaUtil_CreateAllocationGroup( void );
|
|
|
|
/** Destroy an allocation group, but not the memory allocated through the group.
|
|
*/
|
|
void PaUtil_DestroyAllocationGroup( PaUtilAllocationGroup* group );
|
|
|
|
/** Allocate a block of memory though an allocation group.
|
|
*/
|
|
void* PaUtil_GroupAllocateMemory( PaUtilAllocationGroup* group, long size );
|
|
|
|
/** Free a block of memory that was previously allocated though an allocation
|
|
group. Calling this function is a relatively time consuming operation.
|
|
Under normal circumstances clients should call PaUtil_FreeAllAllocations to
|
|
free all allocated blocks simultaneously.
|
|
@see PaUtil_FreeAllAllocations
|
|
*/
|
|
void PaUtil_GroupFreeMemory( PaUtilAllocationGroup* group, void *buffer );
|
|
|
|
/** Free all blocks of memory which have been allocated through the allocation
|
|
group. This function doesn't destroy the group itself.
|
|
*/
|
|
void PaUtil_FreeAllAllocations( PaUtilAllocationGroup* group );
|
|
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif /* __cplusplus */
|
|
#endif /* PA_ALLOCATION_H */
|