From e81e0d9fcc06ebdfb4703cf6e78ebdf986980e30 Mon Sep 17 00:00:00 2001 From: Akosmo Date: Fri, 12 Jun 2026 10:04:48 -0300 Subject: [PATCH] Deprecate _get_stream_name --- doc/classes/AudioStream.xml | 4 ++-- .../audio_stream_interactive.cpp | 4 ---- .../audio_stream_interactive.h | 1 - .../audio_stream_playlist.cpp | 4 ---- .../interactive_music/audio_stream_playlist.h | 1 - .../audio_stream_synchronized.cpp | 4 ---- .../audio_stream_synchronized.h | 1 - modules/mp3/audio_stream_mp3.cpp | 4 ---- modules/mp3/audio_stream_mp3.h | 1 - modules/vorbis/audio_stream_ogg_vorbis.cpp | 4 ---- modules/vorbis/audio_stream_ogg_vorbis.h | 1 - scene/resources/audio_stream_polyphonic.cpp | 4 ---- scene/resources/audio_stream_polyphonic.h | 1 - scene/resources/audio_stream_wav.cpp | 4 ---- scene/resources/audio_stream_wav.h | 1 - servers/audio/audio_stream.cpp | 18 ++---------------- servers/audio/audio_stream.h | 5 ++--- .../audio/effects/audio_stream_generator.cpp | 4 ---- servers/audio/effects/audio_stream_generator.h | 1 - tests/scene/test_audio_stream_wav.cpp | 1 - 20 files changed, 6 insertions(+), 62 deletions(-) diff --git a/doc/classes/AudioStream.xml b/doc/classes/AudioStream.xml index 8d0da01a8d..36caedb676 100644 --- a/doc/classes/AudioStream.xml +++ b/doc/classes/AudioStream.xml @@ -45,10 +45,10 @@ Return the controllable parameters of this stream. This array contains dictionaries with a property info description format (see [method Object.get_property_list]). Additionally, the default value for this parameter must be added tho each dictionary in "default_value" field. - + - Override this method to customize the name assigned to this audio stream. Unused by the engine. + Override this method to customize the name assigned to this audio stream. diff --git a/modules/interactive_music/audio_stream_interactive.cpp b/modules/interactive_music/audio_stream_interactive.cpp index fb6a8a1106..6bfdcd8160 100644 --- a/modules/interactive_music/audio_stream_interactive.cpp +++ b/modules/interactive_music/audio_stream_interactive.cpp @@ -44,10 +44,6 @@ Ref AudioStreamInteractive::instantiate_playback() { return playback_transitioner; } -String AudioStreamInteractive::get_stream_name() const { - return "Transitioner"; -} - void AudioStreamInteractive::set_clip_count(int p_count) { ERR_FAIL_COND(p_count < 0 || p_count > MAX_CLIPS); diff --git a/modules/interactive_music/audio_stream_interactive.h b/modules/interactive_music/audio_stream_interactive.h index 922cf88874..2a8ae729ad 100644 --- a/modules/interactive_music/audio_stream_interactive.h +++ b/modules/interactive_music/audio_stream_interactive.h @@ -180,7 +180,6 @@ public: PackedInt32Array get_transition_list() const; virtual Ref instantiate_playback() override; - virtual String get_stream_name() const override; virtual double get_length() const override { return 0; } virtual bool is_meta_stream() const override { return true; } diff --git a/modules/interactive_music/audio_stream_playlist.cpp b/modules/interactive_music/audio_stream_playlist.cpp index 02e3a3d9db..4c324ebec0 100644 --- a/modules/interactive_music/audio_stream_playlist.cpp +++ b/modules/interactive_music/audio_stream_playlist.cpp @@ -42,10 +42,6 @@ Ref AudioStreamPlaylist::instantiate_playback() { return playback_playlist; } -String AudioStreamPlaylist::get_stream_name() const { - return "Playlist"; -} - void AudioStreamPlaylist::set_list_stream(int p_stream_index, Ref p_stream) { ERR_FAIL_COND(p_stream == this); ERR_FAIL_INDEX(p_stream_index, MAX_STREAMS); diff --git a/modules/interactive_music/audio_stream_playlist.h b/modules/interactive_music/audio_stream_playlist.h index 9bd9d95fff..6c87717b6b 100644 --- a/modules/interactive_music/audio_stream_playlist.h +++ b/modules/interactive_music/audio_stream_playlist.h @@ -67,7 +67,6 @@ public: Ref get_list_stream(int p_stream_index) const; virtual Ref instantiate_playback() override; - virtual String get_stream_name() const override; virtual double get_length() const override; virtual bool is_meta_stream() const override { return true; } diff --git a/modules/interactive_music/audio_stream_synchronized.cpp b/modules/interactive_music/audio_stream_synchronized.cpp index e3c7d14a72..827dbf3a81 100644 --- a/modules/interactive_music/audio_stream_synchronized.cpp +++ b/modules/interactive_music/audio_stream_synchronized.cpp @@ -45,10 +45,6 @@ Ref AudioStreamSynchronized::instantiate_playback() { return playback_playlist; } -String AudioStreamSynchronized::get_stream_name() const { - return "Synchronized"; -} - void AudioStreamSynchronized::set_sync_stream(int p_stream_index, Ref p_stream) { ERR_FAIL_COND(p_stream == this); ERR_FAIL_INDEX(p_stream_index, MAX_STREAMS); diff --git a/modules/interactive_music/audio_stream_synchronized.h b/modules/interactive_music/audio_stream_synchronized.h index 964a5ebb7b..be896f930c 100644 --- a/modules/interactive_music/audio_stream_synchronized.h +++ b/modules/interactive_music/audio_stream_synchronized.h @@ -63,7 +63,6 @@ public: float get_sync_stream_volume(int p_stream_index) const; virtual Ref instantiate_playback() override; - virtual String get_stream_name() const override; virtual double get_length() const override; virtual bool is_meta_stream() const override { return true; } diff --git a/modules/mp3/audio_stream_mp3.cpp b/modules/mp3/audio_stream_mp3.cpp index 84303dfa8f..2f36e1daeb 100644 --- a/modules/mp3/audio_stream_mp3.cpp +++ b/modules/mp3/audio_stream_mp3.cpp @@ -211,10 +211,6 @@ Ref AudioStreamMP3::instantiate_playback() { return mp3s; } -String AudioStreamMP3::get_stream_name() const { - return ""; //return stream_name; -} - void AudioStreamMP3::clear_data() { data.clear(); } diff --git a/modules/mp3/audio_stream_mp3.h b/modules/mp3/audio_stream_mp3.h index 15f3a475f5..7774f5dcd7 100644 --- a/modules/mp3/audio_stream_mp3.h +++ b/modules/mp3/audio_stream_mp3.h @@ -131,7 +131,6 @@ public: virtual int get_bar_beats() const override; virtual Ref instantiate_playback() override; - virtual String get_stream_name() const override; void set_data(const Vector &p_data); Vector get_data() const; diff --git a/modules/vorbis/audio_stream_ogg_vorbis.cpp b/modules/vorbis/audio_stream_ogg_vorbis.cpp index 5355484c4b..eb74cdcc84 100644 --- a/modules/vorbis/audio_stream_ogg_vorbis.cpp +++ b/modules/vorbis/audio_stream_ogg_vorbis.cpp @@ -428,10 +428,6 @@ Ref AudioStreamOggVorbis::instantiate_playback() { return nullptr; } -String AudioStreamOggVorbis::get_stream_name() const { - return ""; //return stream_name; -} - void AudioStreamOggVorbis::maybe_update_info() { ERR_FAIL_COND(packet_sequence.is_null()); diff --git a/modules/vorbis/audio_stream_ogg_vorbis.h b/modules/vorbis/audio_stream_ogg_vorbis.h index e14df33490..8d05892e70 100644 --- a/modules/vorbis/audio_stream_ogg_vorbis.h +++ b/modules/vorbis/audio_stream_ogg_vorbis.h @@ -161,7 +161,6 @@ public: virtual Dictionary get_tags() const override; virtual Ref instantiate_playback() override; - virtual String get_stream_name() const override; void set_packet_sequence(Ref p_packet_sequence); Ref get_packet_sequence() const; diff --git a/scene/resources/audio_stream_polyphonic.cpp b/scene/resources/audio_stream_polyphonic.cpp index 6d67b08e49..e0916de21a 100644 --- a/scene/resources/audio_stream_polyphonic.cpp +++ b/scene/resources/audio_stream_polyphonic.cpp @@ -44,10 +44,6 @@ Ref AudioStreamPolyphonic::instantiate_playback() { return playback; } -String AudioStreamPolyphonic::get_stream_name() const { - return "AudioStreamPolyphonic"; -} - bool AudioStreamPolyphonic::is_monophonic() const { return true; // This avoids stream players to instantiate more than one of these. } diff --git a/scene/resources/audio_stream_polyphonic.h b/scene/resources/audio_stream_polyphonic.h index f720cb406b..bff9c20b33 100644 --- a/scene/resources/audio_stream_polyphonic.h +++ b/scene/resources/audio_stream_polyphonic.h @@ -45,7 +45,6 @@ class AudioStreamPolyphonic : public AudioStream { public: virtual Ref instantiate_playback() override; - virtual String get_stream_name() const override; virtual bool is_monophonic() const override; void set_polyphony(int p_voices); diff --git a/scene/resources/audio_stream_wav.cpp b/scene/resources/audio_stream_wav.cpp index 3cad3033a1..1be121e596 100644 --- a/scene/resources/audio_stream_wav.cpp +++ b/scene/resources/audio_stream_wav.cpp @@ -625,10 +625,6 @@ Ref AudioStreamWAV::instantiate_playback() { return sample; } -String AudioStreamWAV::get_stream_name() const { - return ""; -} - Ref AudioStreamWAV::generate_sample() const { Ref sample; sample.instantiate(); diff --git a/scene/resources/audio_stream_wav.h b/scene/resources/audio_stream_wav.h index 6c930f44d5..8eb13b5461 100644 --- a/scene/resources/audio_stream_wav.h +++ b/scene/resources/audio_stream_wav.h @@ -164,7 +164,6 @@ public: Error save_to_wav(const String &p_path); virtual Ref instantiate_playback() override; - virtual String get_stream_name() const override; virtual bool can_be_sampled() const override { return true; diff --git a/servers/audio/audio_stream.cpp b/servers/audio/audio_stream.cpp index 6ea294b46f..3e2566e77b 100644 --- a/servers/audio/audio_stream.cpp +++ b/servers/audio/audio_stream.cpp @@ -244,11 +244,6 @@ Ref AudioStream::instantiate_playback() { GDVIRTUAL_CALL(_instantiate_playback, ret); return ret; } -String AudioStream::get_stream_name() const { - String ret; - GDVIRTUAL_CALL(_get_stream_name, ret); - return ret; -} double AudioStream::get_length() const { double ret = 0; @@ -340,7 +335,9 @@ void AudioStream::_bind_methods() { ClassDB::bind_method(D_METHOD("is_meta_stream"), &AudioStream::is_meta_stream); GDVIRTUAL_BIND(_instantiate_playback); +#ifndef DISABLE_DEPRECATED GDVIRTUAL_BIND(_get_stream_name); +#endif GDVIRTUAL_BIND(_get_length); GDVIRTUAL_BIND(_is_monophonic); GDVIRTUAL_BIND(_get_bpm) @@ -367,13 +364,6 @@ Ref AudioStreamMicrophone::instantiate_playback() { return playback; } -String AudioStreamMicrophone::get_stream_name() const { - //if (audio_stream.is_valid()) { - //return "Random: " + audio_stream->get_name(); - //} - return "Microphone"; -} - double AudioStreamMicrophone::get_length() const { return 0; } @@ -720,10 +710,6 @@ Ref AudioStreamRandomizer::instantiate_playback() { } } -String AudioStreamRandomizer::get_stream_name() const { - return "Randomizer"; -} - double AudioStreamRandomizer::get_length() const { if (!last_playback.is_valid()) { return 0; diff --git a/servers/audio/audio_stream.h b/servers/audio/audio_stream.h index 502f600513..d9ec96fefa 100644 --- a/servers/audio/audio_stream.h +++ b/servers/audio/audio_stream.h @@ -170,7 +170,9 @@ 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) @@ -182,7 +184,6 @@ protected: public: virtual Ref instantiate_playback(); - virtual String get_stream_name() const; virtual double get_bpm() const; virtual bool has_loop() const; @@ -227,7 +228,6 @@ class AudioStreamMicrophone : public AudioStream { public: virtual Ref instantiate_playback() override; - virtual String get_stream_name() const override; virtual double get_length() const override; //if supported, otherwise return 0 @@ -337,7 +337,6 @@ public: PlaybackMode get_playback_mode() const; virtual Ref instantiate_playback() override; - virtual String get_stream_name() const override; virtual double get_length() const override; //if supported, otherwise return 0 virtual bool is_monophonic() const override; diff --git a/servers/audio/effects/audio_stream_generator.cpp b/servers/audio/effects/audio_stream_generator.cpp index 709fd2727c..299495baa3 100644 --- a/servers/audio/effects/audio_stream_generator.cpp +++ b/servers/audio/effects/audio_stream_generator.cpp @@ -78,10 +78,6 @@ Ref AudioStreamGenerator::instantiate_playback() { return playback; } -String AudioStreamGenerator::get_stream_name() const { - return "UserFeed"; -} - double AudioStreamGenerator::get_length() const { return 0; } diff --git a/servers/audio/effects/audio_stream_generator.h b/servers/audio/effects/audio_stream_generator.h index 01d9f000f3..724e518bd4 100644 --- a/servers/audio/effects/audio_stream_generator.h +++ b/servers/audio/effects/audio_stream_generator.h @@ -65,7 +65,6 @@ public: float get_buffer_length() const; virtual Ref instantiate_playback() override; - virtual String get_stream_name() const override; virtual double get_length() const override; virtual bool is_monophonic() const override; diff --git a/tests/scene/test_audio_stream_wav.cpp b/tests/scene/test_audio_stream_wav.cpp index 287082e99b..03ac7c27f4 100644 --- a/tests/scene/test_audio_stream_wav.cpp +++ b/tests/scene/test_audio_stream_wav.cpp @@ -203,7 +203,6 @@ TEST_CASE("[Audio][AudioStreamWAV] Default values") { CHECK(stream->get_length() == 0); CHECK(stream->is_monophonic() == false); CHECK(stream->get_data() == Vector{}); - CHECK(stream->get_stream_name() == ""); } TEST_CASE("[Audio][AudioStreamWAV] Save empty file") {