1 /*************************************************************************/ 2 /* sample_player_2d.h */ 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 #ifndef SAMPLE_PLAYER_2D_H 31 #define SAMPLE_PLAYER_2D_H 32 33 #include "scene/2d/sound_player_2d.h" 34 #include "scene/resources/sample_library.h" 35 36 class SamplePlayer2D : public SoundPlayer2D { 37 38 OBJ_TYPE(SamplePlayer2D, SoundPlayer2D); 39 40 public: 41 enum { 42 43 INVALID_VOICE = SpatialSoundServer::SOURCE_INVALID_VOICE, 44 NEXT_VOICE = SpatialSoundServer::SOURCE_NEXT_VOICE 45 }; 46 47 typedef int VoiceID; 48 49 private: 50 Ref<SampleLibrary> library; 51 int polyphony; 52 String played_back; 53 float random_pitch_scale; 54 55 protected: 56 bool _set(const StringName &p_name, const Variant &p_value); 57 bool _get(const StringName &p_name, Variant &r_ret) const; 58 void _get_property_list(List<PropertyInfo> *p_list) const; 59 60 void _notification(int p_what); 61 62 static void _bind_methods(); 63 64 public: 65 void set_sample_library(const Ref<SampleLibrary> &p_library); 66 Ref<SampleLibrary> get_sample_library() const; 67 68 void set_polyphony(int p_voice_count); 69 int get_polyphony() const; 70 71 VoiceID play(const String &p_sample, int p_voice = NEXT_VOICE); 72 //voices 73 void voice_set_pitch_scale(VoiceID p_voice, float p_pitch_scale); 74 void voice_set_volume_scale_db(VoiceID p_voice, float p_volume_db); 75 76 bool is_voice_active(VoiceID p_voice) const; 77 void stop_voice(VoiceID p_voice); 78 void stop_all(); 79 80 void set_random_pitch_scale(float p_scale); 81 float get_random_pitch_scale() const; 82 83 String get_configuration_warning() const; 84 85 SamplePlayer2D(); 86 ~SamplePlayer2D(); 87 }; 88 89 #endif // SAMPLE_PLAYER_2D_H 90