Cleanup: commas at the end of enums
[blender.git] / source / blender / makesdna / DNA_sound_types.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27 /** \file DNA_sound_types.h
28  *  \ingroup DNA
29  *  \since mar-2001
30  *  \author nzc
31  */
32
33 #ifndef __DNA_SOUND_TYPES_H__
34 #define __DNA_SOUND_TYPES_H__
35
36 #include "DNA_defs.h"
37 #include "DNA_ID.h"
38
39 /* stupid... could easily be solved */
40 #include "DNA_view2d_types.h"
41
42 struct Ipo;
43 struct PackedFile;
44
45 typedef struct bSound {
46         ID id;
47
48         /**
49          * The path to the sound file.
50          */
51         char name[1024];  /* 1024 = FILE_MAX */
52
53         /**
54          * The packed file.
55          */
56         struct PackedFile *packedfile;
57
58         /**
59          * The handle for audaspace.
60          */
61         void *handle;
62
63         /**
64          * Deprecated; used for loading pre 2.5 files.
65          */
66         struct PackedFile *newpackedfile;
67         struct Ipo *ipo;
68
69         float volume;
70         float attenuation;
71         float pitch;
72         float min_gain;
73         float max_gain;
74         float distance;
75         short flags;
76         short tags;  /* Runtime only, always reset in readfile. */
77         int pad;
78
79         /* unused currently
80         int type;
81         struct bSound *child_sound; */
82
83         /**
84          * The audaspace handle for cache.
85          */
86         void *cache;
87
88         /**
89          * Waveform display data.
90          */
91         void *waveform;
92
93         /**
94          * The audaspace handle that should actually be played back.
95          * Should be cache if cache != NULL; otherwise it's handle
96          */
97         void *playback_handle;
98
99         /* spinlock for asynchronous loading of sounds */
100         void *spinlock;
101         /* XXX unused currently (SOUND_TYPE_LIMITER) */
102         /* float start, end; */
103 } bSound;
104
105 /* XXX unused currently */
106 #if 0
107 typedef enum eSound_Type {
108         SOUND_TYPE_INVALID = -1,
109         SOUND_TYPE_FILE = 0,
110         SOUND_TYPE_BUFFER = 1,
111         SOUND_TYPE_LIMITER = 2,
112 } eSound_Type;
113 #endif
114
115 /* spacesound->flag */
116 enum {
117         SND_DRAWFRAMES  = 1,
118         SND_CFRA_NUM    = 2,
119 };
120
121 /* bSound->flags */
122 enum {
123 #ifdef DNA_DEPRECATED
124         SOUND_FLAGS_3D                   = (1 << 3),  /* deprecated! used for sound actuator loading */
125 #endif
126         SOUND_FLAGS_CACHING              = (1 << 4),
127         SOUND_FLAGS_MONO                 = (1 << 5),
128 };
129
130 /* bSound->tags */
131 enum {
132         SOUND_TAGS_WAVEFORM_NO_RELOAD    = 1 << 0,  /* Do not free/reset waveform on sound load, only used by undo code. */
133         SOUND_TAGS_WAVEFORM_LOADING     = (1 << 6),
134 };
135
136 /* to DNA_sound_types.h*/
137
138 #endif