819b49da8e92e4dd3b2e4590c0f68631b401fe31
[blender-staging.git] / source / blender / blenkernel / BKE_sound.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 #ifndef __BKE_SOUND_H__
28 #define __BKE_SOUND_H__
29
30 /** \file BKE_sound.h
31  *  \ingroup bke
32  *  \since March 2001
33  *  \author nzc
34  */
35
36 #define SOUND_WAVE_SAMPLES_PER_SECOND 250
37
38 struct bSound;
39 struct Main;
40 struct Sequence;
41
42 typedef struct SoundWaveform {
43         int length;
44         float *data;
45 } SoundWaveform;
46
47 void BKE_sound_init_once(void);
48 void BKE_sound_exit_once(void);
49
50 void BKE_sound_init(struct Main *main);
51
52 void BKE_sound_init_main(struct Main *bmain);
53
54 void BKE_sound_exit(void);
55
56 void BKE_sound_force_device(int device);
57 int BKE_sound_define_from_str(const char *str);
58
59 struct bSound *BKE_sound_new_file(struct Main *main, const char *filename);
60
61 // XXX unused currently
62 #if 0
63 struct bSound *BKE_sound_new_buffer(struct Main *bmain, struct bSound *source);
64
65 struct bSound *BKE_sound_new_limiter(struct Main *bmain, struct bSound *source, float start, float end);
66 #endif
67
68 void BKE_sound_delete(struct Main *bmain, struct bSound *sound);
69
70 void BKE_sound_cache(struct bSound *sound);
71
72 void BKE_sound_delete_cache(struct bSound *sound);
73
74 void BKE_sound_load(struct Main *main, struct bSound *sound);
75
76 void BKE_sound_free(struct bSound *sound);
77
78 #ifdef __AUD_C_API_H__
79 AUD_Device *BKE_sound_mixdown(struct Scene *scene, AUD_DeviceSpecs specs, int start, float volume);
80 #endif
81
82 void BKE_sound_create_scene(struct Scene *scene);
83
84 void BKE_sound_destroy_scene(struct Scene *scene);
85
86 void BKE_sound_mute_scene(struct Scene *scene, int muted);
87
88 void BKE_sound_update_fps(struct Scene *scene);
89
90 void BKE_sound_update_scene_listener(struct Scene *scene);
91
92 void *BKE_sound_scene_add_scene_sound(struct Scene *scene, struct Sequence *sequence, int startframe, int endframe, int frameskip);
93 void *BKE_sound_scene_add_scene_sound_defaults(struct Scene *scene, struct Sequence *sequence);
94
95 void *BKE_sound_add_scene_sound(struct Scene *scene, struct Sequence *sequence, int startframe, int endframe, int frameskip);
96 void *BKE_sound_add_scene_sound_defaults(struct Scene *scene, struct Sequence *sequence);
97
98 void BKE_sound_remove_scene_sound(struct Scene *scene, void *handle);
99
100 void BKE_sound_mute_scene_sound(void *handle, char mute);
101
102 void BKE_sound_move_scene_sound(struct Scene *scene, void *handle, int startframe, int endframe, int frameskip);
103 void BKE_sound_move_scene_sound_defaults(struct Scene *scene, struct Sequence *sequence);
104
105 void BKE_sound_update_scene_sound(void *handle, struct bSound *sound);
106
107 void BKE_sound_set_cfra(int cfra);
108
109 void BKE_sound_set_scene_volume(struct Scene *scene, float volume);
110
111 void BKE_sound_set_scene_sound_volume(void *handle, float volume, char animated);
112
113 void BKE_sound_set_scene_sound_pitch(void *handle, float pitch, char animated);
114
115 void BKE_sound_set_scene_sound_pan(void *handle, float pan, char animated);
116
117 void BKE_sound_update_sequencer(struct Main *main, struct bSound *sound);
118
119 void BKE_sound_play_scene(struct Scene *scene);
120
121 void BKE_sound_stop_scene(struct Scene *scene);
122
123 void BKE_sound_seek_scene(struct Main *bmain, struct Scene *scene);
124
125 float BKE_sound_sync_scene(struct Scene *scene);
126
127 int BKE_sound_scene_playing(struct Scene *scene);
128
129 void BKE_sound_free_waveform(struct bSound *sound);
130
131 void BKE_sound_read_waveform(struct bSound *sound, short *stop);
132
133 void BKE_sound_update_scene(struct Main *bmain, struct Scene *scene);
134
135 void *BKE_sound_get_factory(void *sound);
136
137 float BKE_sound_get_length(struct bSound *sound);
138
139 bool BKE_sound_is_jack_supported(void);
140
141 #endif  /* __BKE_SOUND_H__ */