← Back to branch summary

~ubuntu-branches/ubuntu/gutsy/audacity/gutsy-security

« back to all changes in this revision

Viewing changes to lib-src/portaudio-v19/pa_common/pa_allocation.h

  • Committer: Bazaar Package Importer
  • Author(s): Free Ekanayaka
  • Date: 2007-05-17 02:36:41 UTC
  • mfrom: (1.2.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20070517023641-5yjqt9434cbcb6ph
Tags: 1.3.2-4
* debian/patches:
   - desktop_file.patch: fixed broken Category entry
* debian/audacity.mime:
   - added entry for application/x-audacity-project

Show diffs side-by-side

added added

removed removed

Lines of Context:
lib-src/portaudio-v19/pa_common/pa_allocation.h
1
 
#ifndef PA_ALLOCATION_H
2
 
#define PA_ALLOCATION_H
3
 
/*
4
 
 * $Id: pa_allocation.h,v 1.1.2.2 2006/04/08 16:12:25 richardash1981 Exp $
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-2002 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
 
 * Any person wishing to distribute modifications to the Software is
23
 
 * requested to send the modifications to the original developer so that
24
 
 * they can be incorporated into the canonical version.
25
 
 *
26
 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
27
 
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
28
 
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
29
 
 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
30
 
 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
31
 
 * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
32
 
 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
33
 
 */
34
 
 
35
 
/** @file
36
 
 @brief Allocation Group prototypes. An Allocation Group makes it easy to
37
 
 allocate multiple blocks of memory and free them all simultanously.
38
 
 
39
 
 An allocation group is useful for keeping track of multiple blocks
40
 
 of memory which are allocated at the same time (such as during initialization)
41
 
 and need to be deallocated at the same time. The allocation group maintains
42
 
 a list of allocated blocks, and can deallocate them all simultaneously which
43
 
 can be usefull for cleaning up after a partially initialized object fails.
44
 
 
45
 
 The allocation group implementation is built on top of the lower
46
 
 level allocation functions defined in pa_util.h
47
 
*/
48
 
 
49
 
 
50
 
#ifdef __cplusplus
51
 
extern "C"
52
 
{
53
 
#endif /* __cplusplus */
54
 
 
55
 
 
56
 
typedef struct
57
 
{
58
 
    long linkCount;
59
 
    struct PaUtilAllocationGroupLink *linkBlocks;
60
 
    struct PaUtilAllocationGroupLink *spareLinks;
61
 
    struct PaUtilAllocationGroupLink *allocations;
62
 
}PaUtilAllocationGroup;
63
 
 
64
 
 
65
 
 
66
 
/** Create an allocation group.
67
 
*/
68
 
PaUtilAllocationGroup* PaUtil_CreateAllocationGroup( void );
69
 
 
70
 
/** Destroy an allocation group, but not the memory allocated through the group.
71
 
*/
72
 
void PaUtil_DestroyAllocationGroup( PaUtilAllocationGroup* group );
73
 
 
74
 
/** Allocate a block of memory though an allocation group.
75
 
*/
76
 
void* PaUtil_GroupAllocateMemory( PaUtilAllocationGroup* group, long size );
77
 
 
78
 
/** Free a block of memory that was previously allocated though an allocation
79
 
 group. Calling this function is a relatively time consuming operation.
80
 
 Under normal circumstances clients should call PaUtil_FreeAllAllocations to
81
 
 free all allocated blocks simultaneously.
82
 
 @see PaUtil_FreeAllAllocations
83
 
*/
84
 
void PaUtil_GroupFreeMemory( PaUtilAllocationGroup* group, void *buffer );
85
 
 
86
 
/** Free all blocks of memory which have been allocated through the allocation
87
 
 group. This function doesn't destroy the group itself.
88
 
*/
89
 
void PaUtil_FreeAllAllocations( PaUtilAllocationGroup* group );
90
 
 
91
 
 
92
 
#ifdef __cplusplus
93
 
}
94
 
#endif /* __cplusplus */
95
 
#endif /* PA_ALLOCATION_H */