/**************************************************************************/ /* audio_stream.h */ /**************************************************************************/ /* This file is part of: */ /* GODOT ENGINE */ /* https://godotengine.org */ /**************************************************************************/ /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */ /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */ /* */ /* Permission is hereby granted, free of charge, to any person obtaining */ /* a copy of this software and associated documentation files (the */ /* "Software"), to deal in the Software without restriction, including */ /* without limitation the rights to use, copy, modify, merge, publish, */ /* distribute, sublicense, and/or sell copies of the Software, and to */ /* permit persons to whom the Software is furnished to do so, subject to */ /* the following conditions: */ /* */ /* The above copyright notice and this permission notice shall be */ /* included in all copies or substantial portions of the Software. */ /* */ /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */ /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */ /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */ /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */ /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */ /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */ /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ /**************************************************************************/ #pragma once #include "core/io/resource.h" #include "core/object/gdvirtual.gen.h" #include "core/variant/native_ptr.h" #include "core/variant/typed_array.h" #include "servers/audio/audio_frame.h" class AudioStream; class AudioStreamPlayback; class AudioSamplePlayback : public RefCounted { GDCLASS(AudioSamplePlayback, RefCounted); public: Ref stream; Ref stream_playback; float offset = 0.0f; float pitch_scale = 1.0; Vector volume_vector; StringName bus; }; class AudioSample : public RefCounted { GDCLASS(AudioSample, RefCounted) public: enum LoopMode { LOOP_DISABLED, LOOP_FORWARD, LOOP_PINGPONG, LOOP_BACKWARD, }; Ref stream; Vector data; int num_channels = 1; int sample_rate = 44100; LoopMode loop_mode = LOOP_DISABLED; int loop_begin = 0; int loop_end = 0; }; /////////// class AudioStreamPlayback : public RefCounted { GDCLASS(AudioStreamPlayback, RefCounted); protected: static void _bind_methods(); PackedVector2Array _mix_audio_bind(float p_rate_scale, int p_frames); GDVIRTUAL1_REQUIRED(_start, double) GDVIRTUAL0_REQUIRED(_stop) GDVIRTUAL0RC_REQUIRED(bool, _is_playing) GDVIRTUAL0RC(int, _get_loop_count) GDVIRTUAL0RC_REQUIRED(double, _get_playback_position) GDVIRTUAL1(_seek, double) GDVIRTUAL3R_REQUIRED(int, _mix, GDExtensionPtr, float, int) GDVIRTUAL0(_tag_used_streams) GDVIRTUAL2(_set_parameter, const StringName &, const Variant &) GDVIRTUAL1RC(Variant, _get_parameter, const StringName &) public: virtual void start(double p_from_pos = 0.0); virtual void stop(); virtual bool is_playing() const; virtual int get_loop_count() const; //times it looped virtual double get_playback_position() const; virtual void seek(double p_time); virtual void tag_used_streams(); virtual void set_parameter(const StringName &p_name, const Variant &p_value); virtual Variant get_parameter(const StringName &p_name) const; virtual int mix(AudioFrame *p_buffer, float p_rate_scale, int p_frames); virtual void set_is_sample(bool p_is_sample) {} virtual bool get_is_sample() const { return false; } virtual Ref get_sample_playback() const; virtual void set_sample_playback(const Ref &p_playback) {} AudioStreamPlayback(); ~AudioStreamPlayback(); Vector mix_audio(float p_rate_scale, int p_frames); void start_playback(double p_from_pos = 0.0); void stop_playback(); void seek_playback(double p_time); }; class AudioStreamPlaybackResampled : public AudioStreamPlayback { GDCLASS(AudioStreamPlaybackResampled, AudioStreamPlayback); enum { FP_BITS = 16, //fixed point used for resampling FP_LEN = (1 << FP_BITS), FP_MASK = FP_LEN - 1, INTERNAL_BUFFER_LEN = 128, // 128 warrants 3ms positional jitter at much at 44100hz CUBIC_INTERP_HISTORY = 4 }; AudioFrame internal_buffer[INTERNAL_BUFFER_LEN + CUBIC_INTERP_HISTORY]; unsigned int internal_buffer_end = -1; uint64_t mix_offset = 0; protected: void begin_resample(); // Returns the number of frames that were mixed. virtual int _mix_internal(AudioFrame *p_buffer, int p_frames); virtual float get_stream_sampling_rate(); GDVIRTUAL2R_REQUIRED(int, _mix_resampled, GDExtensionPtr, int) GDVIRTUAL0RC_REQUIRED(float, _get_stream_sampling_rate) static void _bind_methods(); public: virtual int mix(AudioFrame *p_buffer, float p_rate_scale, int p_frames) override; AudioStreamPlaybackResampled() { mix_offset = 0; } }; class AudioStream : public Resource { GDCLASS(AudioStream, Resource); OBJ_SAVE_TYPE(AudioStream); // Saves derived classes with common type so they can be interchanged. enum { MAX_TAGGED_OFFSETS = 8 }; uint64_t tagged_frame = 0; uint64_t offset_count = 0; float tagged_offsets[MAX_TAGGED_OFFSETS]; protected: static void _bind_methods(); GDVIRTUAL0RC_REQUIRED(Ref, _instantiate_playback) #ifndef DISABLE_DEPRECATED GDVIRTUAL0RC(String, _get_stream_name) #endif GDVIRTUAL0RC(double, _get_length) GDVIRTUAL0RC(bool, _is_monophonic) GDVIRTUAL0RC(double, _get_bpm) GDVIRTUAL0RC(bool, _has_loop) GDVIRTUAL0RC(int, _get_bar_beats) GDVIRTUAL0RC(int, _get_beat_count) GDVIRTUAL0RC(Dictionary, _get_tags); GDVIRTUAL0RC(TypedArray, _get_parameter_list) public: virtual Ref instantiate_playback(); virtual double get_bpm() const; virtual bool has_loop() const; virtual int get_bar_beats() const; virtual int get_beat_count() const; virtual Dictionary get_tags() const; virtual double get_length() const; virtual bool is_monophonic() const; void tag_used(float p_offset); uint64_t get_tagged_frame() const; uint32_t get_tagged_frame_count() const; float get_tagged_frame_offset(int p_index) const; struct Parameter { PropertyInfo property; Variant default_value; Parameter(const PropertyInfo &p_info = PropertyInfo(), const Variant &p_default_value = Variant()) { property = p_info; default_value = p_default_value; } }; virtual void get_parameter_list(List *r_parameters); virtual bool can_be_sampled() const { return false; } virtual Ref generate_sample() const; virtual bool is_meta_stream() const { return false; } };