Merge branch 'blender2.7'
[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
45 typedef struct bSound {
46         ID id;
47
48         /**
49          * The path to the sound file.
50          */
51         /** 1024 = FILE_MAX. */
52         char name[1024];
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
70         float volume;
71         float attenuation;
72         float pitch;
73         float min_gain;
74         float max_gain;
75         float distance;
76         short flags;
77         /** Runtime only, always reset in readfile. */
78         short tags;
79         int pad;
80
81         /* unused currently
82         int type;
83         struct bSound *child_sound; */
84
85         /**
86          * The audaspace handle for cache.
87          */
88         void *cache;
89
90         /**
91          * Waveform display data.
92          */
93         void *waveform;
94
95         /**
96          * The audaspace handle that should actually be played back.
97          * Should be cache if cache != NULL; otherwise it's handle
98          */
99         void *playback_handle;
100
101         /** Spinlock for asynchronous loading of sounds. */
102         void *spinlock;
103         /* XXX unused currently (SOUND_TYPE_LIMITER) */
104         /* float start, end; */
105 } bSound;
106
107 /* XXX unused currently */
108 #if 0
109 typedef enum eSound_Type {
110         SOUND_TYPE_INVALID = -1,
111         SOUND_TYPE_FILE = 0,
112         SOUND_TYPE_BUFFER = 1,
113         SOUND_TYPE_LIMITER = 2,
114 } eSound_Type;
115 #endif
116
117 /* spacesound->flag */
118 enum {
119         SND_DRAWFRAMES  = 1,
120         SND_CFRA_NUM    = 2,
121 };
122
123 /* bSound->flags */
124 enum {
125 #ifdef DNA_DEPRECATED
126         /* deprecated! used for sound actuator loading */
127         SOUND_FLAGS_3D                   = (1 << 3),
128 #endif
129         SOUND_FLAGS_CACHING              = (1 << 4),
130         SOUND_FLAGS_MONO                 = (1 << 5),
131 };
132
133 /* bSound->tags */
134 enum {
135         /* Do not free/reset waveform on sound load, only used by undo code. */
136         SOUND_TAGS_WAVEFORM_NO_RELOAD    = 1 << 0,
137         SOUND_TAGS_WAVEFORM_LOADING     = (1 << 6),
138 };
139
140 /* to DNA_sound_types.h*/
141
142 #endif