tmp
[blender.git] / extern / audaspace / bindings / C / AUD_Sequence.h
1 /*******************************************************************************
2  * Copyright 2009-2016 Jörg Müller
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *   http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  ******************************************************************************/
16
17 #pragma once
18
19 #include "AUD_Device.h"
20
21 #ifdef __cplusplus
22 extern "C" {
23 #endif
24
25 /// Possible animatable properties for Sequence Factories and Entries.
26 typedef enum
27 {
28         AUD_AP_VOLUME,
29         AUD_AP_PANNING,
30         AUD_AP_PITCH,
31         AUD_AP_LOCATION,
32         AUD_AP_ORIENTATION
33 } AUD_AnimateablePropertyType;
34
35 /**
36  * Creates a new sequenced sound scene.
37  * \param fps The FPS of the scene.
38  * \param muted Whether the scene is muted.
39  * \return The new sound scene.
40  */
41 extern AUD_API AUD_Sound* AUD_Sequence_create(float fps, int muted);
42
43 /**
44  * Deletes a sound scene.
45  * \param sequence The sound scene.
46  */
47 extern AUD_API void AUD_Sequence_free(AUD_Sound* sequence);
48
49 /**
50  * Adds a new entry to the scene.
51  * \param sequence The sound scene.
52  * \param sound The sound this entry should play.
53  * \param begin The start time.
54  * \param end The end time or a negative value if determined by the sound.
55  * \param skip How much seconds should be skipped at the beginning.
56  * \return The entry added.
57  */
58 extern AUD_API AUD_SequenceEntry* AUD_Sequence_add(AUD_Sound* sequence, AUD_Sound* sound, float begin, float end, float skip);
59
60 /**
61  * Removes an entry from the scene.
62  * \param sequence The sound scene.
63  * \param entry The entry to remove.
64  */
65 extern AUD_API void AUD_Sequence_remove(AUD_Sound* sequence, AUD_SequenceEntry* entry);
66
67 /**
68  * Writes animation data to a sequence.
69  * \param sequence The sound scene.
70  * \param type The type of animation data.
71  * \param frame The frame this data is for.
72  * \param data The data to write.
73  * \param animated Whether the attribute is animated.
74  */
75 extern AUD_API void AUD_Sequence_setAnimationData(AUD_Sound* sequence, AUD_AnimateablePropertyType type, int frame, float* data, char animated);
76
77 /**
78  * Retrieves the distance model of a sequence.
79  * param sequence The sequence to get the distance model from.
80  * return The distance model of the sequence.
81  */
82 extern AUD_API AUD_DistanceModel AUD_Sequence_getDistanceModel(AUD_Sound* sequence);
83
84 /**
85  * Sets the distance model of a sequence.
86  * param sequence The sequence to set the distance model from.
87  * param value The new distance model to set.
88  */
89 extern AUD_API void AUD_Sequence_setDistanceModel(AUD_Sound* sequence, AUD_DistanceModel value);
90
91 /**
92  * Retrieves the doppler factor of a sequence.
93  * param sequence The sequence to get the doppler factor from.
94  * return The doppler factor of the sequence.
95  */
96 extern AUD_API float AUD_Sequence_getDopplerFactor(AUD_Sound* sequence);
97
98 /**
99  * Sets the doppler factor of a sequence.
100  * param sequence The sequence to set the doppler factor from.
101  * param value The new doppler factor to set.
102  */
103 extern AUD_API void AUD_Sequence_setDopplerFactor(AUD_Sound* sequence, float value);
104
105 /**
106  * Retrieves the fps of a sequence.
107  * param sequence The sequence to get the fps from.
108  * return The fps of the sequence.
109  */
110 extern AUD_API float AUD_Sequence_getFPS(AUD_Sound* sequence);
111
112 /**
113  * Sets the fps of a sequence.
114  * param sequence The sequence to set the fps from.
115  * param value The new fps to set.
116  */
117 extern AUD_API void AUD_Sequence_setFPS(AUD_Sound* sequence, float value);
118
119 /**
120  * Retrieves the muted of a sequence.
121  * param sequence The sequence to get the muted from.
122  * return The muted of the sequence.
123  */
124 extern AUD_API int AUD_Sequence_isMuted(AUD_Sound* sequence);
125
126 /**
127  * Sets the muted of a sequence.
128  * param sequence The sequence to set the muted from.
129  * param value The new muted to set.
130  */
131 extern AUD_API void AUD_Sequence_setMuted(AUD_Sound* sequence, int value);
132
133 /**
134  * Retrieves the specs of a sequence.
135  * param sequence The sequence to get the specs from.
136  * return The specs of the sequence.
137  */
138 extern AUD_API AUD_Specs AUD_Sequence_getSpecs(AUD_Sound* sequence);
139
140 /**
141  * Sets the specs of a sequence.
142  * param sequence The sequence to set the specs from.
143  * param value The new specs to set.
144  */
145 extern AUD_API void AUD_Sequence_setSpecs(AUD_Sound* sequence, AUD_Specs value);
146
147 /**
148  * Retrieves the speed of sound of a sequence.
149  * param sequence The sequence to get the speed of sound from.
150  * return The speed of sound of the sequence.
151  */
152 extern AUD_API float AUD_Sequence_getSpeedOfSound(AUD_Sound* sequence);
153
154 /**
155  * Sets the speed of sound of a sequence.
156  * param sequence The sequence to set the speed of sound from.
157  * param value The new speed of sound to set.
158  */
159 extern AUD_API void AUD_Sequence_setSpeedOfSound(AUD_Sound* sequence, float value);
160
161
162
163 /**
164  * Moves the entry.
165  * \param entry The sequenced entry.
166  * \param begin The new start time.
167  * \param end The new end time or a negative value if unknown.
168  * \param skip How many seconds to skip at the beginning.
169  */
170 extern AUD_API void AUD_SequenceEntry_move(AUD_SequenceEntry* entry, float begin, float end, float skip);
171
172 /**
173  * Writes animation data to a sequenced entry.
174  * \param entry The sequenced entry.
175  * \param type The type of animation data.
176  * \param frame The frame this data is for.
177  * \param data The data to write.
178  * \param animated Whether the attribute is animated.
179  */
180 extern AUD_API void AUD_SequenceEntry_setAnimationData(AUD_SequenceEntry* entry, AUD_AnimateablePropertyType type, int frame, float* data, char animated);
181
182 /**
183  * Retrieves the attenuation of a sequence_entry.
184  * param sequence_entry The sequence_entry to get the attenuation from.
185  * return The attenuation of the sequence_entry.
186  */
187 extern AUD_API float AUD_SequenceEntry_getAttenuation(AUD_SequenceEntry* sequence_entry);
188
189 /**
190  * Sets the attenuation of a sequence_entry.
191  * param sequence_entry The sequence_entry to set the attenuation from.
192  * param value The new attenuation to set.
193  */
194 extern AUD_API void AUD_SequenceEntry_setAttenuation(AUD_SequenceEntry* sequence_entry, float value);
195
196 /**
197  * Retrieves the cone angle inner of a sequence_entry.
198  * param sequence_entry The sequence_entry to get the cone angle inner from.
199  * return The cone angle inner of the sequence_entry.
200  */
201 extern AUD_API float AUD_SequenceEntry_getConeAngleInner(AUD_SequenceEntry* sequence_entry);
202
203 /**
204  * Sets the cone angle inner of a sequence_entry.
205  * param sequence_entry The sequence_entry to set the cone angle inner from.
206  * param value The new cone angle inner to set.
207  */
208 extern AUD_API void AUD_SequenceEntry_setConeAngleInner(AUD_SequenceEntry* sequence_entry, float value);
209
210 /**
211  * Retrieves the cone angle outer of a sequence_entry.
212  * param sequence_entry The sequence_entry to get the cone angle outer from.
213  * return The cone angle outer of the sequence_entry.
214  */
215 extern AUD_API float AUD_SequenceEntry_getConeAngleOuter(AUD_SequenceEntry* sequence_entry);
216
217 /**
218  * Sets the cone angle outer of a sequence_entry.
219  * param sequence_entry The sequence_entry to set the cone angle outer from.
220  * param value The new cone angle outer to set.
221  */
222 extern AUD_API void AUD_SequenceEntry_setConeAngleOuter(AUD_SequenceEntry* sequence_entry, float value);
223
224 /**
225  * Retrieves the cone volume outer of a sequence_entry.
226  * param sequence_entry The sequence_entry to get the cone volume outer from.
227  * return The cone volume outer of the sequence_entry.
228  */
229 extern AUD_API float AUD_SequenceEntry_getConeVolumeOuter(AUD_SequenceEntry* sequence_entry);
230
231 /**
232  * Sets the cone volume outer of a sequence_entry.
233  * param sequence_entry The sequence_entry to set the cone volume outer from.
234  * param value The new cone volume outer to set.
235  */
236 extern AUD_API void AUD_SequenceEntry_setConeVolumeOuter(AUD_SequenceEntry* sequence_entry, float value);
237
238 /**
239  * Retrieves the distance maximum of a sequence_entry.
240  * param sequence_entry The sequence_entry to get the distance maximum from.
241  * return The distance maximum of the sequence_entry.
242  */
243 extern AUD_API float AUD_SequenceEntry_getDistanceMaximum(AUD_SequenceEntry* sequence_entry);
244
245 /**
246  * Sets the distance maximum of a sequence_entry.
247  * param sequence_entry The sequence_entry to set the distance maximum from.
248  * param value The new distance maximum to set.
249  */
250 extern AUD_API void AUD_SequenceEntry_setDistanceMaximum(AUD_SequenceEntry* sequence_entry, float value);
251
252 /**
253  * Retrieves the distance reference of a sequence_entry.
254  * param sequence_entry The sequence_entry to get the distance reference from.
255  * return The distance reference of the sequence_entry.
256  */
257 extern AUD_API float AUD_SequenceEntry_getDistanceReference(AUD_SequenceEntry* sequence_entry);
258
259 /**
260  * Sets the distance reference of a sequence_entry.
261  * param sequence_entry The sequence_entry to set the distance reference from.
262  * param value The new distance reference to set.
263  */
264 extern AUD_API void AUD_SequenceEntry_setDistanceReference(AUD_SequenceEntry* sequence_entry, float value);
265
266 /**
267  * Retrieves the muted of a sequence_entry.
268  * param sequence_entry The sequence_entry to get the muted from.
269  * return The muted of the sequence_entry.
270  */
271 extern AUD_API int AUD_SequenceEntry_isMuted(AUD_SequenceEntry* sequence_entry);
272
273 /**
274  * Sets the muted of a sequence_entry.
275  * param sequence_entry The sequence_entry to set the muted from.
276  * param value The new muted to set.
277  */
278 extern AUD_API void AUD_SequenceEntry_setMuted(AUD_SequenceEntry* sequence_entry, int value);
279
280 /**
281  * Retrieves the relative of a sequence_entry.
282  * param sequence_entry The sequence_entry to get the relative from.
283  * return The relative of the sequence_entry.
284  */
285 extern AUD_API int AUD_SequenceEntry_isRelative(AUD_SequenceEntry* sequence_entry);
286
287 /**
288  * Sets the relative of a sequence_entry.
289  * param sequence_entry The sequence_entry to set the relative from.
290  * param value The new relative to set.
291  */
292 extern AUD_API void AUD_SequenceEntry_setRelative(AUD_SequenceEntry* sequence_entry, int value);
293
294 /**
295  * Retrieves the sound of a sequence_entry.
296  * param sequence_entry The sequence_entry to get the sound from.
297  * return The sound of the sequence_entry.
298  */
299 extern AUD_API AUD_Sound* AUD_SequenceEntry_getSound(AUD_SequenceEntry* sequence_entry);
300
301 /**
302  * Sets the sound of a sequence_entry.
303  * param sequence_entry The sequence_entry to set the sound from.
304  * param value The new sound to set.
305  */
306 extern AUD_API void AUD_SequenceEntry_setSound(AUD_SequenceEntry* sequence_entry, AUD_Sound* value);
307
308 /**
309  * Retrieves the volume maximum of a sequence_entry.
310  * param sequence_entry The sequence_entry to get the volume maximum from.
311  * return The volume maximum of the sequence_entry.
312  */
313 extern AUD_API float AUD_SequenceEntry_getVolumeMaximum(AUD_SequenceEntry* sequence_entry);
314
315 /**
316  * Sets the volume maximum of a sequence_entry.
317  * param sequence_entry The sequence_entry to set the volume maximum from.
318  * param value The new volume maximum to set.
319  */
320 extern AUD_API void AUD_SequenceEntry_setVolumeMaximum(AUD_SequenceEntry* sequence_entry, float value);
321
322 /**
323  * Retrieves the volume minimum of a sequence_entry.
324  * param sequence_entry The sequence_entry to get the volume minimum from.
325  * return The volume minimum of the sequence_entry.
326  */
327 extern AUD_API float AUD_SequenceEntry_getVolumeMinimum(AUD_SequenceEntry* sequence_entry);
328
329 /**
330  * Sets the volume minimum of a sequence_entry.
331  * param sequence_entry The sequence_entry to set the volume minimum from.
332  * param value The new volume minimum to set.
333  */
334 extern AUD_API void AUD_SequenceEntry_setVolumeMinimum(AUD_SequenceEntry* sequence_entry, float value);
335
336 #ifdef __cplusplus
337 }
338 #endif