1 /*************************************************************************/
2 /* stream_player.cpp */
3 /*************************************************************************/
4 /* This file is part of: */
5 /* GODOT ENGINE */
6 /* https://godotengine.org */
7 /*************************************************************************/
8 /* Copyright (c) 2007-2019 Juan Linietsky, Ariel Manzur. */
9 /* Copyright (c) 2014-2019 Godot Engine contributors (cf. AUTHORS.md) */
10 /* */
11 /* Permission is hereby granted, free of charge, to any person obtaining */
12 /* a copy of this software and associated documentation files (the */
13 /* "Software"), to deal in the Software without restriction, including */
14 /* without limitation the rights to use, copy, modify, merge, publish, */
15 /* distribute, sublicense, and/or sell copies of the Software, and to */
16 /* permit persons to whom the Software is furnished to do so, subject to */
17 /* the following conditions: */
18 /* */
19 /* The above copyright notice and this permission notice shall be */
20 /* included in all copies or substantial portions of the Software. */
21 /* */
22 /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
23 /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
24 /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
25 /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
26 /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
27 /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
28 /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
29 /*************************************************************************/
30 #include "stream_player.h"
31
get_channel_count() const32 int StreamPlayer::InternalStream::get_channel_count() const {
33
34 return player->sp_get_channel_count();
35 }
set_mix_rate(int p_rate)36 void StreamPlayer::InternalStream::set_mix_rate(int p_rate) {
37
38 return player->sp_set_mix_rate(p_rate);
39 }
mix(int32_t * p_buffer,int p_frames)40 bool StreamPlayer::InternalStream::mix(int32_t *p_buffer, int p_frames) {
41
42 return player->sp_mix(p_buffer, p_frames);
43 }
update()44 void StreamPlayer::InternalStream::update() {
45
46 player->sp_update();
47 }
48
sp_get_channel_count() const49 int StreamPlayer::sp_get_channel_count() const {
50
51 return playback->get_channels();
52 }
53
sp_set_mix_rate(int p_rate)54 void StreamPlayer::sp_set_mix_rate(int p_rate) {
55
56 server_mix_rate = p_rate;
57 }
58
sp_mix(int32_t * p_buffer,int p_frames)59 bool StreamPlayer::sp_mix(int32_t *p_buffer, int p_frames) {
60
61 if (resampler.is_ready() && !paused) {
62 return resampler.mix(p_buffer, p_frames);
63 }
64
65 return false;
66 }
67
sp_update()68 void StreamPlayer::sp_update() {
69
70 //_THREAD_SAFE_METHOD_
71 if (!paused && resampler.is_ready() && playback.is_valid()) {
72
73 if (!playback->is_playing()) {
74 //stream depleted data, but there's still audio in the ringbuffer
75 //check that all this audio has been flushed before stopping the stream
76 int to_mix = resampler.get_total() - resampler.get_todo();
77 if (to_mix == 0) {
78 if (!stop_request) {
79 stop_request = true;
80 call_deferred("_do_stop");
81 }
82 return;
83 }
84
85 return;
86 }
87
88 int todo = resampler.get_todo();
89 int wrote = playback->mix(resampler.get_write_buffer(), todo);
90 resampler.write(wrote);
91 }
92 }
93
_do_stop()94 void StreamPlayer::_do_stop() {
95 stop();
96 emit_signal("finished");
97 }
98
_notification(int p_what)99 void StreamPlayer::_notification(int p_what) {
100
101 switch (p_what) {
102
103 case NOTIFICATION_ENTER_TREE: {
104
105 //set_idle_process(false); //don't annoy
106 if (stream.is_valid() && !get_tree()->is_editor_hint()) {
107 if (resume_pos >= 0) {
108 play(resume_pos);
109 resume_pos = -1;
110 } else if (autoplay) {
111 play();
112 autoplay = false; //this line fix autoplay issues
113 }
114 }
115
116 } break;
117 case NOTIFICATION_EXIT_TREE: {
118
119 if (is_playing()) {
120 resume_pos = get_pos();
121 }
122 stop(); //wathever it may be doing, stop
123 } break;
124 }
125 }
126
set_stream(const Ref<AudioStream> & p_stream)127 void StreamPlayer::set_stream(const Ref<AudioStream> &p_stream) {
128
129 stop();
130
131 stream = p_stream;
132
133 if (!stream.is_null()) {
134 playback = stream->instance_playback();
135 playback->set_loop(loops);
136 playback->set_loop_restart_time(loop_point);
137 AudioServer::get_singleton()->lock();
138 resampler.setup(playback->get_channels(), playback->get_mix_rate(), server_mix_rate, buffering_ms, playback->get_minimum_buffer_size());
139 AudioServer::get_singleton()->unlock();
140 } else {
141 AudioServer::get_singleton()->lock();
142 resampler.clear();
143 playback.unref();
144 AudioServer::get_singleton()->unlock();
145 }
146 }
147
get_stream() const148 Ref<AudioStream> StreamPlayer::get_stream() const {
149
150 return stream;
151 }
152
play(float p_from_offset)153 void StreamPlayer::play(float p_from_offset) {
154
155 ERR_FAIL_COND(!is_inside_tree());
156 if (playback.is_null())
157 return;
158 //if (is_playing())
159 stop();
160
161 //_THREAD_SAFE_METHOD_
162 playback->play(p_from_offset);
163 //feed the ringbuffer as long as no update callback is going on
164 sp_update();
165 AudioServer::get_singleton()->stream_set_active(stream_rid, true);
166 AudioServer::get_singleton()->stream_set_volume_scale(stream_rid, volume);
167 // if (stream->get_update_mode()!=AudioStream::UPDATE_NONE)
168 // set_idle_process(true);
169 }
170
stop()171 void StreamPlayer::stop() {
172
173 if (!is_inside_tree())
174 return;
175 if (playback.is_null())
176 return;
177
178 //_THREAD_SAFE_METHOD_
179 AudioServer::get_singleton()->stream_set_active(stream_rid, false);
180 stop_request = false;
181 playback->stop();
182 resampler.flush();
183
184 //set_idle_process(false);
185 }
186
is_playing() const187 bool StreamPlayer::is_playing() const {
188
189 if (playback.is_null())
190 return false;
191
192 return playback->is_playing() || resampler.has_data();
193 }
194
set_loop(bool p_enable)195 void StreamPlayer::set_loop(bool p_enable) {
196
197 loops = p_enable;
198 if (playback.is_null())
199 return;
200 playback->set_loop(loops);
201 }
has_loop() const202 bool StreamPlayer::has_loop() const {
203
204 return loops;
205 }
206
set_volume(float p_vol)207 void StreamPlayer::set_volume(float p_vol) {
208
209 volume = p_vol;
210 if (stream_rid.is_valid())
211 AudioServer::get_singleton()->stream_set_volume_scale(stream_rid, volume);
212 }
213
get_volume() const214 float StreamPlayer::get_volume() const {
215
216 return volume;
217 }
218
set_loop_restart_time(float p_secs)219 void StreamPlayer::set_loop_restart_time(float p_secs) {
220
221 loop_point = p_secs;
222 if (playback.is_valid())
223 playback->set_loop_restart_time(p_secs);
224 }
225
get_loop_restart_time() const226 float StreamPlayer::get_loop_restart_time() const {
227
228 return loop_point;
229 }
230
set_volume_db(float p_db)231 void StreamPlayer::set_volume_db(float p_db) {
232
233 if (p_db < -79)
234 set_volume(0);
235 else
236 set_volume(Math::db2linear(p_db));
237 }
238
get_volume_db() const239 float StreamPlayer::get_volume_db() const {
240
241 if (volume == 0)
242 return -80;
243 else
244 return Math::linear2db(volume);
245 }
246
get_stream_name() const247 String StreamPlayer::get_stream_name() const {
248
249 if (stream.is_null())
250 return "<No Stream>";
251 return stream->get_name();
252 }
253
get_loop_count() const254 int StreamPlayer::get_loop_count() const {
255
256 if (playback.is_null())
257 return 0;
258 return playback->get_loop_count();
259 }
260
get_pos() const261 float StreamPlayer::get_pos() const {
262
263 if (playback.is_null())
264 return 0;
265 return playback->get_pos();
266 }
267
get_length() const268 float StreamPlayer::get_length() const {
269
270 if (playback.is_null())
271 return 0;
272 return playback->get_length();
273 }
seek_pos(float p_time)274 void StreamPlayer::seek_pos(float p_time) {
275
276 if (playback.is_null())
277 return;
278 //works better...
279 stop();
280 playback->play(p_time);
281 }
282
set_autoplay(bool p_enable)283 void StreamPlayer::set_autoplay(bool p_enable) {
284
285 autoplay = p_enable;
286 }
287
has_autoplay() const288 bool StreamPlayer::has_autoplay() const {
289
290 return autoplay;
291 }
292
set_paused(bool p_paused)293 void StreamPlayer::set_paused(bool p_paused) {
294
295 paused = p_paused;
296 //if (stream.is_valid())
297 // stream->set_paused(p_paused);
298 }
299
is_paused() const300 bool StreamPlayer::is_paused() const {
301
302 return paused;
303 }
304
_set_play(bool p_play)305 void StreamPlayer::_set_play(bool p_play) {
306
307 _play = p_play;
308 if (is_inside_tree()) {
309 if (_play)
310 play();
311 else
312 stop();
313 }
314 }
315
_get_play() const316 bool StreamPlayer::_get_play() const {
317
318 return _play;
319 }
320
set_buffering_msec(int p_msec)321 void StreamPlayer::set_buffering_msec(int p_msec) {
322
323 buffering_ms = p_msec;
324 }
325
get_buffering_msec() const326 int StreamPlayer::get_buffering_msec() const {
327
328 return buffering_ms;
329 }
330
_bind_methods()331 void StreamPlayer::_bind_methods() {
332
333 ObjectTypeDB::bind_method(_MD("set_stream", "stream:AudioStream"), &StreamPlayer::set_stream);
334 ObjectTypeDB::bind_method(_MD("get_stream:AudioStream"), &StreamPlayer::get_stream);
335
336 ObjectTypeDB::bind_method(_MD("play", "offset"), &StreamPlayer::play, DEFVAL(0));
337 ObjectTypeDB::bind_method(_MD("stop"), &StreamPlayer::stop);
338
339 ObjectTypeDB::bind_method(_MD("is_playing"), &StreamPlayer::is_playing);
340
341 ObjectTypeDB::bind_method(_MD("set_paused", "paused"), &StreamPlayer::set_paused);
342 ObjectTypeDB::bind_method(_MD("is_paused"), &StreamPlayer::is_paused);
343
344 ObjectTypeDB::bind_method(_MD("set_loop", "enabled"), &StreamPlayer::set_loop);
345 ObjectTypeDB::bind_method(_MD("has_loop"), &StreamPlayer::has_loop);
346
347 ObjectTypeDB::bind_method(_MD("set_volume", "volume"), &StreamPlayer::set_volume);
348 ObjectTypeDB::bind_method(_MD("get_volume"), &StreamPlayer::get_volume);
349
350 ObjectTypeDB::bind_method(_MD("set_volume_db", "db"), &StreamPlayer::set_volume_db);
351 ObjectTypeDB::bind_method(_MD("get_volume_db"), &StreamPlayer::get_volume_db);
352
353 ObjectTypeDB::bind_method(_MD("set_buffering_msec", "msec"), &StreamPlayer::set_buffering_msec);
354 ObjectTypeDB::bind_method(_MD("get_buffering_msec"), &StreamPlayer::get_buffering_msec);
355
356 ObjectTypeDB::bind_method(_MD("set_loop_restart_time", "secs"), &StreamPlayer::set_loop_restart_time);
357 ObjectTypeDB::bind_method(_MD("get_loop_restart_time"), &StreamPlayer::get_loop_restart_time);
358
359 ObjectTypeDB::bind_method(_MD("get_stream_name"), &StreamPlayer::get_stream_name);
360 ObjectTypeDB::bind_method(_MD("get_loop_count"), &StreamPlayer::get_loop_count);
361
362 ObjectTypeDB::bind_method(_MD("get_pos"), &StreamPlayer::get_pos);
363 ObjectTypeDB::bind_method(_MD("seek_pos", "time"), &StreamPlayer::seek_pos);
364
365 ObjectTypeDB::bind_method(_MD("set_autoplay", "enabled"), &StreamPlayer::set_autoplay);
366 ObjectTypeDB::bind_method(_MD("has_autoplay"), &StreamPlayer::has_autoplay);
367
368 ObjectTypeDB::bind_method(_MD("get_length"), &StreamPlayer::get_length);
369
370 ObjectTypeDB::bind_method(_MD("_set_play", "play"), &StreamPlayer::_set_play);
371 ObjectTypeDB::bind_method(_MD("_get_play"), &StreamPlayer::_get_play);
372 ObjectTypeDB::bind_method(_MD("_do_stop"), &StreamPlayer::_do_stop);
373
374 ADD_PROPERTY(PropertyInfo(Variant::OBJECT, "stream/stream", PROPERTY_HINT_RESOURCE_TYPE, "AudioStream"), _SCS("set_stream"), _SCS("get_stream"));
375 ADD_PROPERTY(PropertyInfo(Variant::BOOL, "stream/play"), _SCS("_set_play"), _SCS("_get_play"));
376 ADD_PROPERTY(PropertyInfo(Variant::BOOL, "stream/loop"), _SCS("set_loop"), _SCS("has_loop"));
377 ADD_PROPERTY(PropertyInfo(Variant::REAL, "stream/volume_db", PROPERTY_HINT_RANGE, "-80,24,0.01"), _SCS("set_volume_db"), _SCS("get_volume_db"));
378 ADD_PROPERTY(PropertyInfo(Variant::BOOL, "stream/autoplay"), _SCS("set_autoplay"), _SCS("has_autoplay"));
379 ADD_PROPERTY(PropertyInfo(Variant::BOOL, "stream/paused"), _SCS("set_paused"), _SCS("is_paused"));
380 ADD_PROPERTY(PropertyInfo(Variant::REAL, "stream/loop_restart_time"), _SCS("set_loop_restart_time"), _SCS("get_loop_restart_time"));
381 ADD_PROPERTY(PropertyInfo(Variant::INT, "stream/buffering_ms"), _SCS("set_buffering_msec"), _SCS("get_buffering_msec"));
382
383 ADD_SIGNAL(MethodInfo("finished"));
384 }
385
StreamPlayer()386 StreamPlayer::StreamPlayer() {
387
388 volume = 1;
389 loops = false;
390 paused = false;
391 autoplay = false;
392 _play = false;
393 server_mix_rate = 1;
394 internal_stream.player = this;
395 stream_rid = AudioServer::get_singleton()->audio_stream_create(&internal_stream);
396 buffering_ms = 500;
397 loop_point = 0;
398 stop_request = false;
399 resume_pos = -1;
400 }
401
~StreamPlayer()402 StreamPlayer::~StreamPlayer() {
403 AudioServer::get_singleton()->free(stream_rid);
404 resampler.clear();
405 }
406