-setaudio argument to force an audio device.
[blender-staging.git] / source / blender / blenkernel / BKE_sound.h
1 /**
2  * sound.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 BKE_SOUND_H
32 #define BKE_SOUND_H
33
34 struct PackedFile;
35 struct bSound;
36 struct bContext;
37 struct ListBase;
38 struct Main;
39
40 void sound_init();
41
42 void sound_exit();
43
44 void sound_force_device(int device);
45 int sound_define_from_str(char *str);
46
47 struct bSound* sound_new_file(struct Main *main, char* filename);
48
49 // XXX unused currently
50 #if 0
51 struct bSound* sound_new_buffer(struct bContext *C, struct bSound *source);
52
53 struct bSound* sound_new_limiter(struct bContext *C, struct bSound *source, float start, float end);
54 #endif
55
56 void sound_delete(struct bContext *C, struct bSound* sound);
57
58 void sound_cache(struct bSound* sound, int ignore);
59
60 void sound_delete_cache(struct bSound* sound);
61
62 void sound_load(struct Main *main, struct bSound* sound);
63
64 void sound_free(struct bSound* sound);
65
66 void sound_unlink(struct bContext *C, struct bSound* sound);
67
68 struct SoundHandle* sound_new_handle(struct Scene *scene, struct bSound* sound, int startframe, int endframe, int frameskip);
69
70 void sound_delete_handle(struct Scene *scene, struct SoundHandle *handle);
71
72 void sound_update_playing(struct bContext *C);
73
74 void sound_scrub(struct bContext *C);
75
76 #ifdef AUD_CAPI
77 AUD_Device* sound_mixdown(struct Scene *scene, AUD_DeviceSpecs specs, int start, int end, float volume);
78 #endif
79
80 void sound_stop_all(struct bContext *C);
81
82 #endif