- further work on theme colors:
[blender.git] / source / blender / makesdna / DNA_sound_types.h
1 /**
2  * blenlib/DNA_sound_types.h (mar-2001 nzc)
3  *      
4  * $Id$ 
5  *
6  * ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or (at your option) any later version. The Blender
12  * Foundation also sells licenses for use in proprietary software under
13  * the Blender License.  See http://www.blender.org/BL/ for information
14  * about this.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, write to the Free Software Foundation,
23  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
24  *
25  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
26  * All rights reserved.
27  *
28  * The Original Code is: all of this file.
29  *
30  * Contributor(s): none yet.
31  *
32  * ***** END GPL/BL DUAL LICENSE BLOCK *****
33  */
34 #ifndef DNA_SOUND_TYPES_H
35 #define DNA_SOUND_TYPES_H
36
37 #include "DNA_listBase.h"
38 #include "DNA_ID.h"
39
40 /* stupid... could easily be solved */
41 #include "DNA_view2d_types.h"
42
43 /* extern int noaudio; * defined in sound.c . also not very nice */
44 /*  extern ListBase *samples; don't do this in DNA, but in BKE_... instead */
45
46 struct bSample;
47 struct Ipo;
48 struct PackedFile;
49 struct SpaceLink;
50
51 /* should not be here! */
52 #
53 #
54 typedef struct bSample {
55         ID id;
56         void *data;
57         void *snd_sample;
58         short type, bits;
59         short channels;
60         int len, rate;
61 //      int buffer;
62         int alindex;
63         char fakedata[16];
64         int flags;
65         char name[160];
66         struct PackedFile * packedfile;
67         short us;
68 } bSample;
69
70
71
72 typedef struct bSound {
73         ID id;
74         char name[160];
75         struct bSample *sample;
76         void *stream;
77         struct PackedFile *packedfile;
78         struct PackedFile *newpackedfile;
79         void *snd_sound;
80         struct Ipo *ipo;
81         float volume, panning;
82         /**
83          * Sets the rollofffactor. The  rollofffactor is a per-Source parameter
84          * the application can use to increase or decrease      the range of a source
85          * by decreasing or increasing the attenuation, respectively. The default
86          * value is 1. The implementation is free to optimize for a rollofffactor
87          * value of 0, which indicates that the application does not wish any
88          * distance attenuation on the respective Source.
89          */
90         float attenuation;
91         float pitch;
92         /**
93          * min_gain indicates the minimal gain which is always guaranteed for this sound
94          */
95         float min_gain;
96         /**
97          * max_gain indicates the maximal gain which is always guaranteed for this sound
98          */
99         float max_gain;
100         /**
101          * Sets the referencedistance at which the listener will experience gain.
102          */
103         float distance;
104         int flags;
105         int streamlen;
106 //      unsigned int loopstart;
107 //      unsigned int loopend;
108         char channels;
109         char highprio;
110         char pad[10];
111 } bSound;
112
113 typedef struct bSoundListener {
114         ID id;
115         /**
116          * Overall gain
117          */
118         float gain;
119         /**
120          * Sets a scaling to exaggerate or deemphasize the Doppler (pitch) shift
121          * resulting from the calculation.
122          */
123         float dopplerfactor;
124         /**
125          * Sets the value of the propagation speed relative to which the source
126          * velocities are interpreted.
127          */
128         float dopplervelocity;
129         short numsoundsblender;
130         short numsoundsgameengine;
131         
132 } bSoundListener;
133
134 /* spacesound->flag */
135 #define SND_DRAWFRAMES  1
136 #define SND_CFRA_NUM    2
137
138 typedef struct SpaceSound {
139         struct SpaceLink *next, *prev;
140         int spacetype, pad;
141         struct ScrArea *area;
142         
143         View2D v2d;
144         
145         bSound *sound;
146         short mode, sndnr;
147         short xof, yof;
148         short flag, lock;
149         int pad2;
150 } SpaceSound;
151
152
153 enum SAMPLE_FileTypes {
154         SAMPLE_INVALID = -1,            // must be negative
155         SAMPLE_UNKNOWN = 0,
156         SAMPLE_RAW,
157         SAMPLE_WAV,
158         SAMPLE_MP2,
159         SAMPLE_MP3,
160         SAMPLE_OGG_VORBIS,
161         SAMPLE_WMA,
162         SAMPLE_ASF,
163         SAMPLE_AIFF
164 };
165
166
167 #define SOUND_CHANNELS_STEREO   0
168 #define SOUND_CHANNELS_LEFT             1
169 #define SOUND_CHANNELS_RIGHT    2
170
171 enum SOUND_FLAGS_BITS {
172         SOUND_FLAGS_LOOP_BIT = 0,
173         SOUND_FLAGS_FIXED_VOLUME_BIT,
174         SOUND_FLAGS_FIXED_PANNING_BIT,
175         SOUND_FLAGS_3D_BIT,
176         SOUND_FLAGS_BIDIRECTIONAL_LOOP_BIT,
177         SOUND_FLAGS_PRIORITY_BIT,
178         SOUND_FLAGS_SEQUENCE_BIT
179 };
180
181 #define SOUND_FLAGS_LOOP                        (1 << SOUND_FLAGS_LOOP_BIT)
182 #define SOUND_FLAGS_FIXED_VOLUME        (1 << SOUND_FLAGS_FIXED_VOLUME_BIT)
183 #define SOUND_FLAGS_FIXED_PANNING       (1 << SOUND_FLAGS_FIXED_PANNING_BIT)
184 #define SOUND_FLAGS_3D                          (1 << SOUND_FLAGS_3D_BIT)
185 #define SOUND_FLAGS_BIDIRECTIONAL_LOOP (1 << SOUND_FLAGS_BIDIRECTIONAL_LOOP_BIT)
186 #define SOUND_FLAGS_PRIORITY            (1 << SOUND_FLAGS_PRIORITY_BIT)
187 #define SOUND_FLAGS_SEQUENCE            (1 << SOUND_FLAGS_SEQUENCE_BIT)
188
189 enum SAMPLE_FLAGS_BITS {
190         SAMPLE_NEEDS_SAVE_BIT = 0
191 };
192
193 #define SAMPLE_NEEDS_SAVE               (1 << SAMPLE_NEEDS_SAVE_BIT)
194
195 /* to DNA_sound_types.h*/
196
197 #endif
198