style cleanup: comment blocks
[blender-staging.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_listBase.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 struct SpaceLink;
45
46 typedef struct bSound {
47         ID id;
48
49         /**
50          * The path to the sound file.
51          */
52         char name[1024];  /* 1024 = FILE_MAX */
53
54         /**
55          * The packed file.
56          */
57         struct PackedFile *packedfile;
58
59         /**
60          * The handle for audaspace.
61          */
62         void *handle;
63
64         /**
65          * Deprecated; used for loading pre 2.5 files.
66          */
67         struct PackedFile *newpackedfile;
68         struct Ipo *ipo;
69         float volume;
70         float attenuation;
71         float pitch;
72         float min_gain;
73         float max_gain;
74         float distance;
75         int flags;
76         int pad;
77
78 //      currently       int type;
79 //      struct bSound *child_sound;*/
80
81         /**
82          * The audaspace handle for cache.
83          */
84         void *cache;
85
86         /**
87          * Waveform display data.
88          */
89         void *waveform;
90
91         /**
92          * The audaspace handle that should actually be played back.
93          * Should be cache if cache != NULL; otherwise it's handle
94          */
95         void *playback_handle;
96
97 //      XXX unused currently    // SOUND_TYPE_LIMITER
98 //      float start, end;*/
99 } bSound;
100
101 /* XXX unused currently */
102 #if 0
103 typedef enum eSound_Type {
104         SOUND_TYPE_INVALID = -1,
105         SOUND_TYPE_FILE = 0,
106         SOUND_TYPE_BUFFER,
107         SOUND_TYPE_LIMITER
108 } eSound_Type;
109 #endif
110
111 /* spacesound->flag */
112 #define SND_DRAWFRAMES  1
113 #define SND_CFRA_NUM    2
114
115 #define SOUND_FLAGS_3D                                  (1 << 3) /* deprecated! used for sound actuator loading */
116 #define SOUND_FLAGS_CACHING                             (1 << 4)
117 #define SOUND_FLAGS_MONO                                (1 << 5)
118
119 /* to DNA_sound_types.h*/
120
121 #endif
122