/[pcsx2_0.9.7]/trunk/3rdparty/portaudio/src/common/pa_allocation.h
ViewVC logotype

Contents of /trunk/3rdparty/portaudio/src/common/pa_allocation.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 10 - (show annotations) (download)
Mon Sep 6 11:40:06 2010 UTC (9 years, 11 months ago) by william
File MIME type: text/plain
File size: 3964 byte(s)
exported r3113 from ./upstream/trunk
1 #ifndef PA_ALLOCATION_H
2 #define PA_ALLOCATION_H
3 /*
4 * $Id: pa_allocation.h 1339 2008-02-15 07:50:33Z rossb $
5 * Portable Audio I/O Library allocation context header
6 * memory allocation context for tracking allocation groups
7 *
8 * Based on the Open Source API proposed by Ross Bencina
9 * Copyright (c) 1999-2008 Ross Bencina, Phil Burk
10 *
11 * Permission is hereby granted, free of charge, to any person obtaining
12 * a copy of this software and associated documentation files
13 * (the "Software"), to deal in the Software without restriction,
14 * including without limitation the rights to use, copy, modify, merge,
15 * publish, distribute, sublicense, and/or sell copies of the Software,
16 * and to permit persons to whom the Software is furnished to do so,
17 * subject to the following conditions:
18 *
19 * The above copyright notice and this permission notice shall be
20 * included in all copies or substantial portions of the Software.
21 *
22 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
23 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
24 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
25 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
26 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
27 * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
28 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
29 */
30
31 /*
32 * The text above constitutes the entire PortAudio license; however,
33 * the PortAudio community also makes the following non-binding requests:
34 *
35 * Any person wishing to distribute modifications to the Software is
36 * requested to send the modifications to the original developer so that
37 * they can be incorporated into the canonical version. It is also
38 * requested that these non-binding requests be included along with the
39 * license above.
40 */
41
42 /** @file
43 @ingroup common_src
44
45 @brief Allocation Group prototypes. An Allocation Group makes it easy to
46 allocate multiple blocks of memory and free them all at once.
47
48 An allocation group is useful for keeping track of multiple blocks
49 of memory which are allocated at the same time (such as during initialization)
50 and need to be deallocated at the same time. The allocation group maintains
51 a list of allocated blocks, and can free all allocations at once. This
52 can be usefull for cleaning up after a partially initialized object fails.
53
54 The allocation group implementation is built on top of the lower
55 level allocation functions defined in pa_util.h
56 */
57
58
59 #ifdef __cplusplus
60 extern "C"
61 {
62 #endif /* __cplusplus */
63
64
65 typedef struct
66 {
67 long linkCount;
68 struct PaUtilAllocationGroupLink *linkBlocks;
69 struct PaUtilAllocationGroupLink *spareLinks;
70 struct PaUtilAllocationGroupLink *allocations;
71 }PaUtilAllocationGroup;
72
73
74
75 /** Create an allocation group.
76 */
77 PaUtilAllocationGroup* PaUtil_CreateAllocationGroup( void );
78
79 /** Destroy an allocation group, but not the memory allocated through the group.
80 */
81 void PaUtil_DestroyAllocationGroup( PaUtilAllocationGroup* group );
82
83 /** Allocate a block of memory though an allocation group.
84 */
85 void* PaUtil_GroupAllocateMemory( PaUtilAllocationGroup* group, long size );
86
87 /** Free a block of memory that was previously allocated though an allocation
88 group. Calling this function is a relatively time consuming operation.
89 Under normal circumstances clients should call PaUtil_FreeAllAllocations to
90 free all allocated blocks simultaneously.
91 @see PaUtil_FreeAllAllocations
92 */
93 void PaUtil_GroupFreeMemory( PaUtilAllocationGroup* group, void *buffer );
94
95 /** Free all blocks of memory which have been allocated through the allocation
96 group. This function doesn't destroy the group itself.
97 */
98 void PaUtil_FreeAllAllocations( PaUtilAllocationGroup* group );
99
100
101 #ifdef __cplusplus
102 }
103 #endif /* __cplusplus */
104 #endif /* PA_ALLOCATION_H */

  ViewVC Help
Powered by ViewVC 1.1.22