svn merge -r39781:39792 https://svn.blender.org/svnroot/bf-blender/trunk/blender...
[blender-staging.git] / source / blender / makesdna / DNA_sound_types.h
1 /*
2  * $Id$ 
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): none yet.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29 #ifndef DNA_SOUND_TYPES_H
30 #define DNA_SOUND_TYPES_H
31 /** \file DNA_sound_types.h
32  *  \ingroup DNA
33  *  \since mar-2001
34  *  \author nzc
35  */
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 struct Ipo;
44 struct PackedFile;
45 struct SpaceLink;
46
47 typedef struct bSound {
48         ID id;
49
50         /**
51          * The path to the sound file.
52          */
53         char name[240];
54
55         /**
56          * The packed file.
57          */
58         struct PackedFile *packedfile;
59
60         /**
61          * The handle for audaspace.
62          */
63         void *handle;
64
65         /**
66          * Deprecated; used for loading pre 2.5 files.
67          */
68         struct PackedFile *newpackedfile;
69         struct Ipo *ipo;
70         float volume;
71         float attenuation;
72         float pitch;
73         float min_gain;
74         float max_gain;
75         float distance;
76         int flags;
77         int pad;
78
79 /**     currently       int type;
80         struct bSound *child_sound;*/
81
82         /**
83          * The audaspace handle for cache.
84          */
85         void *cache;
86
87         /**
88          * Waveform display data.
89          */
90         void *waveform;
91
92         /**
93          * The audaspace handle that should actually be played back.
94          * Should be cache if cache != NULL; otherwise it's handle
95          */
96         void *playback_handle;
97
98 /**     XXX unused currently    // SOUND_TYPE_LIMITER
99         float start, end;*/
100 } bSound;
101
102 /* XXX unused currently
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
110 /* spacesound->flag */
111 #define SND_DRAWFRAMES  1
112 #define SND_CFRA_NUM    2
113
114 #define SOUND_FLAGS_3D                                  (1 << 3) /* deprecated! used for sound actuator loading */
115 #define SOUND_FLAGS_CACHING                             (1 << 4)
116 #define SOUND_FLAGS_MONO                                (1 << 5)
117
118 /* to DNA_sound_types.h*/
119
120 #endif
121