2018-01-05 00:50:27 +01:00
|
|
|
/**************************************************************************/
|
2017-06-19 02:07:32 +02:00
|
|
|
/* audio_stream_player_2d.h */
|
2018-01-05 00:50:27 +01:00
|
|
|
/**************************************************************************/
|
2017-06-19 02:07:32 +02:00
|
|
|
/* This file is part of: */
|
2018-01-05 00:50:27 +01:00
|
|
|
/* GODOT ENGINE */
|
|
|
|
/* https://godotengine.org */
|
|
|
|
/**************************************************************************/
|
2017-06-19 02:07:32 +02:00
|
|
|
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
|
|
|
|
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
|
2018-01-05 00:50:27 +01:00
|
|
|
/* */
|
2017-06-19 02:07:32 +02:00
|
|
|
/* 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: */
|
2018-01-05 00:50:27 +01:00
|
|
|
/* */
|
2017-06-19 02:07:32 +02:00
|
|
|
/* The above copyright notice and this permission notice shall be */
|
|
|
|
/* included in all copies or substantial portions of the Software. */
|
2018-01-05 00:50:27 +01:00
|
|
|
/* */
|
2017-06-19 02:07:32 +02:00
|
|
|
/* 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. */
|
2018-01-05 00:50:27 +01:00
|
|
|
/**************************************************************************/
|
|
|
|
|
2017-06-19 02:07:32 +02:00
|
|
|
#ifndef AUDIO_STREAM_PLAYER_2D_H
|
|
|
|
#define AUDIO_STREAM_PLAYER_2D_H
|
|
|
|
|
|
|
|
#include "scene/2d/node_2d.h"
|
2023-08-07 17:33:07 +02:00
|
|
|
#include "scene/scene_string_names.h"
|
2017-06-19 02:07:32 +02:00
|
|
|
#include "servers/audio/audio_stream.h"
|
|
|
|
#include "servers/audio_server.h"
|
|
|
|
|
|
|
|
class AudioStreamPlayer2D : public Node2D {
|
2019-03-19 19:35:57 +01:00
|
|
|
GDCLASS(AudioStreamPlayer2D, Node2D);
|
2017-06-19 02:07:32 +02:00
|
|
|
|
|
|
|
private:
|
|
|
|
enum {
|
|
|
|
MAX_OUTPUTS = 8,
|
|
|
|
MAX_INTERSECT_AREAS = 32
|
|
|
|
|
|
|
|
};
|
|
|
|
|
|
|
|
struct Output {
|
|
|
|
AudioFrame vol;
|
2021-02-07 22:29:31 +01:00
|
|
|
int bus_index = 0;
|
|
|
|
Viewport *viewport = nullptr; //pointer only used for reference to previous mix
|
2017-06-19 02:07:32 +02:00
|
|
|
};
|
|
|
|
|
2021-08-28 06:51:03 +02:00
|
|
|
Vector<Ref<AudioStreamPlayback>> stream_playbacks;
|
2017-06-19 02:07:32 +02:00
|
|
|
Ref<AudioStream> stream;
|
|
|
|
|
2021-08-28 06:51:03 +02:00
|
|
|
SafeFlag active{ false };
|
2021-02-10 19:22:13 +01:00
|
|
|
SafeNumeric<float> setplay{ -1.0 };
|
2023-01-27 19:25:49 +01:00
|
|
|
Ref<AudioStreamPlayback> setplayback;
|
2017-06-19 02:07:32 +02:00
|
|
|
|
2021-08-27 19:28:23 +02:00
|
|
|
Vector<AudioFrame> volume_vector;
|
|
|
|
|
|
|
|
uint64_t last_mix_count = -1;
|
2023-04-06 03:29:09 +02:00
|
|
|
bool force_update_panning = false;
|
2021-08-27 19:28:23 +02:00
|
|
|
|
2021-02-07 22:29:31 +01:00
|
|
|
float volume_db = 0.0;
|
|
|
|
float pitch_scale = 1.0;
|
|
|
|
bool autoplay = false;
|
2023-08-07 17:33:07 +02:00
|
|
|
StringName default_bus = SceneStringNames::get_singleton()->Master;
|
2021-08-28 06:51:03 +02:00
|
|
|
int max_polyphony = 1;
|
2017-06-19 02:07:32 +02:00
|
|
|
|
|
|
|
void _set_playing(bool p_enable);
|
|
|
|
bool _is_active() const;
|
|
|
|
|
2021-08-27 19:28:23 +02:00
|
|
|
StringName _get_actual_bus();
|
|
|
|
void _update_panning();
|
2023-09-14 12:39:23 +02:00
|
|
|
|
|
|
|
void _on_bus_layout_changed();
|
|
|
|
void _on_bus_renamed(int p_bus_index, const StringName &p_old_name, const StringName &p_new_name);
|
2017-06-19 02:07:32 +02:00
|
|
|
|
2023-04-06 03:29:09 +02:00
|
|
|
static void _listener_changed_cb(void *self) { reinterpret_cast<AudioStreamPlayer2D *>(self)->force_update_panning = true; }
|
2021-08-27 19:28:23 +02:00
|
|
|
|
2021-02-07 22:29:31 +01:00
|
|
|
uint32_t area_mask = 1;
|
2017-06-19 02:07:32 +02:00
|
|
|
|
2021-02-07 22:29:31 +01:00
|
|
|
float max_distance = 2000.0;
|
|
|
|
float attenuation = 1.0;
|
2017-06-19 02:07:32 +02:00
|
|
|
|
2022-03-06 17:53:56 +01:00
|
|
|
float panning_strength = 1.0f;
|
2022-08-07 22:45:05 +02:00
|
|
|
float cached_global_panning_strength = 0.5f;
|
2022-03-06 17:53:56 +01:00
|
|
|
|
2023-12-23 17:30:32 +01:00
|
|
|
struct ParameterData {
|
|
|
|
StringName path;
|
|
|
|
Variant value;
|
|
|
|
};
|
|
|
|
|
|
|
|
HashMap<StringName, ParameterData> playback_parameters;
|
|
|
|
void _update_stream_parameters();
|
|
|
|
|
2017-06-19 02:07:32 +02:00
|
|
|
protected:
|
2022-08-12 22:57:11 +02:00
|
|
|
void _validate_property(PropertyInfo &p_property) const;
|
2017-06-19 02:07:32 +02:00
|
|
|
void _notification(int p_what);
|
|
|
|
static void _bind_methods();
|
|
|
|
|
2023-12-23 17:30:32 +01:00
|
|
|
bool _set(const StringName &p_name, const Variant &p_value);
|
|
|
|
bool _get(const StringName &p_name, Variant &r_ret) const;
|
|
|
|
void _get_property_list(List<PropertyInfo> *p_list) const;
|
|
|
|
|
2017-06-19 02:07:32 +02:00
|
|
|
public:
|
|
|
|
void set_stream(Ref<AudioStream> p_stream);
|
|
|
|
Ref<AudioStream> get_stream() const;
|
|
|
|
|
|
|
|
void set_volume_db(float p_volume);
|
|
|
|
float get_volume_db() const;
|
|
|
|
|
2018-01-01 22:23:16 +01:00
|
|
|
void set_pitch_scale(float p_pitch_scale);
|
|
|
|
float get_pitch_scale() const;
|
|
|
|
|
2017-06-19 02:07:32 +02:00
|
|
|
void play(float p_from_pos = 0.0);
|
|
|
|
void seek(float p_seconds);
|
|
|
|
void stop();
|
|
|
|
bool is_playing() const;
|
2017-09-21 05:31:36 +02:00
|
|
|
float get_playback_position();
|
2017-06-19 02:07:32 +02:00
|
|
|
|
|
|
|
void set_bus(const StringName &p_bus);
|
|
|
|
StringName get_bus() const;
|
|
|
|
|
|
|
|
void set_autoplay(bool p_enable);
|
|
|
|
bool is_autoplay_enabled();
|
|
|
|
|
|
|
|
void set_max_distance(float p_pixels);
|
|
|
|
float get_max_distance() const;
|
|
|
|
|
|
|
|
void set_attenuation(float p_curve);
|
|
|
|
float get_attenuation() const;
|
|
|
|
|
|
|
|
void set_area_mask(uint32_t p_mask);
|
|
|
|
uint32_t get_area_mask() const;
|
|
|
|
|
2018-05-27 20:29:10 +02:00
|
|
|
void set_stream_paused(bool p_pause);
|
|
|
|
bool get_stream_paused() const;
|
|
|
|
|
2021-08-28 06:51:03 +02:00
|
|
|
void set_max_polyphony(int p_max_polyphony);
|
|
|
|
int get_max_polyphony() const;
|
|
|
|
|
2022-03-06 17:53:56 +01:00
|
|
|
void set_panning_strength(float p_panning_strength);
|
|
|
|
float get_panning_strength() const;
|
|
|
|
|
2023-01-27 19:25:49 +01:00
|
|
|
bool has_stream_playback();
|
2019-04-10 17:57:03 +02:00
|
|
|
Ref<AudioStreamPlayback> get_stream_playback();
|
|
|
|
|
2017-06-19 02:07:32 +02:00
|
|
|
AudioStreamPlayer2D();
|
|
|
|
~AudioStreamPlayer2D();
|
|
|
|
};
|
|
|
|
|
2022-07-23 23:41:51 +02:00
|
|
|
#endif // AUDIO_STREAM_PLAYER_2D_H
|