3D Audio GSoC:
[blender.git] / source / blender / blenkernel / BKE_sound.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 BKE_SOUND_H
30 #define BKE_SOUND_H
31
32 /** \file BKE_sound.h
33  *  \ingroup bke
34  *  \since March 2001
35  *  \author nzc
36  */
37
38 struct PackedFile;
39 struct bSound;
40 struct bContext;
41 struct ListBase;
42 struct Main;
43 struct Sequence;
44
45 void sound_init_once(void);
46
47 void sound_init(struct Main *main);
48
49 void sound_exit(void);
50
51 void sound_force_device(int device);
52 int sound_define_from_str(const char *str);
53
54 struct bSound* sound_new_file(struct Main *main, const char *filename);
55
56 // XXX unused currently
57 #if 0
58 struct bSound* sound_new_buffer(struct bContext *C, struct bSound *source);
59
60 struct bSound* sound_new_limiter(struct bContext *C, struct bSound *source, float start, float end);
61 #endif
62
63 void sound_delete(struct bContext *C, struct bSound* sound);
64
65 void sound_cache(struct bSound* sound, int ignore);
66
67 void sound_cache_notifying(struct Main* main, struct bSound* sound, int ignore);
68
69 void sound_delete_cache(struct bSound* sound);
70
71 void sound_load(struct Main *main, struct bSound* sound);
72
73 void sound_free(struct bSound* sound);
74
75 #ifdef AUD_CAPI
76 AUD_Device* sound_mixdown(struct Scene *scene, AUD_DeviceSpecs specs, int start, float volume);
77 #endif
78
79 void sound_create_scene(struct Scene *scene);
80
81 void sound_destroy_scene(struct Scene *scene);
82
83 void sound_mute_scene(struct Scene *scene, int muted);
84
85 void sound_update_fps(struct Scene *scene);
86
87 void* sound_scene_add_scene_sound(struct Scene *scene, struct Sequence* sequence, int startframe, int endframe, int frameskip);
88
89 void* sound_add_scene_sound(struct Scene *scene, struct Sequence* sequence, int startframe, int endframe, int frameskip);
90
91 void sound_remove_scene_sound(struct Scene *scene, void* handle);
92
93 void sound_mute_scene_sound(struct Scene *scene, void* handle, char mute);
94
95 void sound_move_scene_sound(struct Scene *scene, void* handle, int startframe, int endframe, int frameskip);
96
97 void sound_update_scene_sound(void* handle, struct bSound* sound);
98
99 void sound_update_sequencer(struct Main* main, struct bSound* sound);
100
101 void sound_play_scene(struct Scene *scene);
102
103 void sound_stop_scene(struct Scene *scene);
104
105 void sound_seek_scene(struct bContext *C);
106
107 float sound_sync_scene(struct Scene *scene);
108
109 int sound_scene_playing(struct Scene *scene);
110
111 int sound_read_sound_buffer(struct bSound* sound, float* buffer, int length, float start, float end);
112
113 int sound_get_channels(struct bSound* sound);
114
115 void* sound_get_factory(void* sound);
116
117 #endif