Comments
[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 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         /* unused currently
79         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 #if 0
104 typedef enum eSound_Type {
105         SOUND_TYPE_INVALID = -1,
106         SOUND_TYPE_FILE = 0,
107         SOUND_TYPE_BUFFER = 1,
108         SOUND_TYPE_LIMITER = 2
109 } eSound_Type;
110 #endif
111
112 /* spacesound->flag */
113 enum {
114         SND_DRAWFRAMES  = 1,
115         SND_CFRA_NUM    = 2,
116 };
117
118 enum {
119         SOUND_FLAGS_3D          = (1 << 3),  /* deprecated! used for sound actuator loading */
120         SOUND_FLAGS_CACHING     = (1 << 4),
121         SOUND_FLAGS_MONO        = (1 << 5),
122 };
123
124 #if (DNA_DEPRECATED_GCC_POISON == 1)
125 #pragma GCC poison SOUND_FLAGS_3D
126 #endif
127
128 /* to DNA_sound_types.h*/
129
130 #endif