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