Andrew/redot-engine
1
0
Fork 0
mirror of https://github.com/Redot-Engine/redot-engine.git synced 2025-12-06 07:17:42 -05:00
Code Issues Packages Projects Releases Wiki Activity

Add metadata tags to WAV and OGG audio streams

Browse Source
This commit is contained in:
Capry
2024-11-21 18:32:47 +01:00
parent 2cde9292c3
commit 20c0a0b489
9 changed files with 153 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
modules/vorbis/audio_stream_ogg_vorbis.cpp
View File

@@ -456,6 +456,23 @@ void AudioStreamOggVorbis::maybe_update_info() {
ERR_FAIL_COND_MSG(err != 0, "Error parsing header packet " + itos(i) + ": " + itos(err));
}
Dictionary dictionary;
for (int i = 0; i < comment.comments; i++) {
String c = String::utf8(comment.user_comments[i]);
int equals = c.find_char('=');
if (equals == -1) {
WARN_PRINT("Invalid comment in Ogg Vorbis file.");
continue;
}
String tag = c.substr(0, equals);
String tag_value = c.substr(equals + 1);
dictionary[tag.to_lower()] = tag_value;
}
tags = dictionary;
packet_sequence->set_sampling_rate(info.rate);
vorbis_comment_clear(&comment);
@@ -524,6 +541,14 @@ int AudioStreamOggVorbis::get_bar_beats() const {
return bar_beats;
}
void AudioStreamOggVorbis::set_tags(const Dictionary &p_tags) {
tags = p_tags;
}
Dictionary AudioStreamOggVorbis::get_tags() const {
return tags;
}
bool AudioStreamOggVorbis::is_monophonic() const {
return false;
}
@@ -692,10 +717,14 @@ void AudioStreamOggVorbis::_bind_methods() {
ClassDB::bind_method(D_METHOD("set_bar_beats", "count"), &AudioStreamOggVorbis::set_bar_beats);
ClassDB::bind_method(D_METHOD("get_bar_beats"), &AudioStreamOggVorbis::get_bar_beats);
ClassDB::bind_method(D_METHOD("set_tags", "tags"), &AudioStreamOggVorbis::set_tags);
ClassDB::bind_method(D_METHOD("get_tags"), &AudioStreamOggVorbis::get_tags);
ADD_PROPERTY(PropertyInfo(Variant::OBJECT, "packet_sequence", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NO_EDITOR), "set_packet_sequence", "get_packet_sequence");
ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "bpm", PROPERTY_HINT_RANGE, "0,400,0.01,or_greater"), "set_bpm", "get_bpm");
ADD_PROPERTY(PropertyInfo(Variant::INT, "beat_count", PROPERTY_HINT_RANGE, "0,512,1,or_greater"), "set_beat_count", "get_beat_count");
ADD_PROPERTY(PropertyInfo(Variant::INT, "bar_beats", PROPERTY_HINT_RANGE, "2,32,1,or_greater"), "set_bar_beats", "get_bar_beats");
ADD_PROPERTY(PropertyInfo(Variant::DICTIONARY, "tags", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NO_EDITOR), "set_tags", "get_tags");
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "loop"), "set_loop", "has_loop");
ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "loop_offset"), "set_loop_offset", "get_loop_offset");
}

4
modules/vorbis/audio_stream_ogg_vorbis.h
View File

@@ -133,6 +133,7 @@ class AudioStreamOggVorbis : public AudioStream {
double bpm = 0;
int beat_count = 0;
int bar_beats = 4;
Dictionary tags;
protected:
static void _bind_methods();
@@ -156,6 +157,9 @@ public:
void set_bar_beats(int p_bar_beats);
virtual int get_bar_beats() const override;
void set_tags(const Dictionary &p_tags);
virtual Dictionary get_tags() const override;
virtual Ref<AudioStreamPlayback> instantiate_playback() override;
virtual String get_stream_name() const override;

5
modules/vorbis/doc_classes/AudioStreamOggVorbis.xml
View File

@@ -41,5 +41,10 @@
<member name="packet_sequence" type="OggPacketSequence" setter="set_packet_sequence" getter="get_packet_sequence">
Contains the raw Ogg data for this stream.
</member>
<member name="tags" type="Dictionary" setter="set_tags" getter="get_tags" default="{}">
Contains user-defined tags if found in the Ogg Vorbis data.
Commonly used tags include [code]title[/code], [code]artist[/code], [code]album[/code], [code]tracknumber[/code], and [code]date[/code] ([code]date[/code] does not have a standard date format).
[b]Note:[/b] No tag is [i]guaranteed[/i] to be present in every file, so make sure to account for the keys not always existing.
</member>
</members>
</class>