Stowage/godot
2
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2025-12-08 06:09:55 +00:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #99504 from LunaCapra/audio-metadata

Browse source 
Add metadata tags to WAV and OGG audio streams
This commit is contained in:
Rémi Verschelde 2025-06-05 13:10:12 +02:00
commit 8131883b16
No known key found for this signature in database
GPG key ID: C3336907360768E1
9 changed files with 153 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

83
scene/resources/audio_stream_wav.cpp
View file

@ -477,6 +477,18 @@ bool AudioStreamWAV::is_stereo() const {
return stereo;
}
void AudioStreamWAV::set_tags(const Dictionary &p_tags) {
tags = p_tags;
}
Dictionary AudioStreamWAV::get_tags() const {
return tags;
}
HashMap<String, String>::ConstIterator AudioStreamWAV::remap_tag_id(const String &p_tag_id) {
return tag_id_remaps.find(p_tag_id);
}
double AudioStreamWAV::get_length() const {
int len = data_bytes;
switch (format) {
@ -703,6 +715,8 @@ Ref<AudioStreamWAV> AudioStreamWAV::load_from_buffer(const Vector<uint8_t> &p_st
Vector<float> data;
HashMap<String, String> tag_map;
while (!file->eof_reached()) {
/* chunk */
char chunk_id[4];
@ -858,6 +872,40 @@ Ref<AudioStreamWAV> AudioStreamWAV::load_from_buffer(const Vector<uint8_t> &p_st
loop_end = file->get_32();
}
}
if (chunk_id[0] == 'L' && chunk_id[1] == 'I' && chunk_id[2] == 'S' && chunk_id[3] == 'T') {
// RIFF 'LIST' chunk.
// See https://www.recordingblogs.com/wiki/list-chunk-of-a-wave-file
char list_id[4];
file->get_buffer((uint8_t *)&list_id, 4);
if (list_id[0] == 'I' && list_id[1] == 'N' && list_id[2] == 'F' && list_id[3] == 'O') {
// 'INFO' list type.
// The size of an entry can be arbitrary.
uint32_t end_of_chunk = file_pos + chunksize - 4;
while (file->get_position() < end_of_chunk) {
char info_id[4];
file->get_buffer((uint8_t *)&info_id, 4);
uint32_t text_size = file->get_32();
Vector<char> text;
text.resize(text_size);
file->get_buffer((uint8_t *)&text[0], text_size);
// The data is always an ASCII string. ASCII is a subset of UTF-8.
String tag;
tag.append_utf8(&info_id[0], 4);
String tag_value;
tag_value.append_utf8(&text[0], text_size);
tag_map[tag] = tag_value;
}
}
}
// Move to the start of the next chunk. Note that RIFF requires a padding byte for odd
// chunk sizes.
file->seek(file_pos + chunksize + (chunksize & 1));
@ -1097,6 +1145,18 @@ Ref<AudioStreamWAV> AudioStreamWAV::load_from_buffer(const Vector<uint8_t> &p_st
sample->set_loop_begin(loop_begin);
sample->set_loop_end(loop_end);
sample->set_stereo(format_channels == 2);
Dictionary tag_dictionary;
for (const KeyValue<String, String> &E : tag_map) {
HashMap<String, String>::ConstIterator remap = sample->remap_tag_id(E.key);
if (remap) {
tag_map.replace_key(E.key, remap->value);
}
tag_dictionary[E.key] = E.value;
}
sample->set_tags(tag_dictionary);
return sample;
}
@ -1131,6 +1191,9 @@ void AudioStreamWAV::_bind_methods() {
ClassDB::bind_method(D_METHOD("set_stereo", "stereo"), &AudioStreamWAV::set_stereo);
ClassDB::bind_method(D_METHOD("is_stereo"), &AudioStreamWAV::is_stereo);
ClassDB::bind_method(D_METHOD("set_tags", "tags"), &AudioStreamWAV::set_tags);
ClassDB::bind_method(D_METHOD("get_tags"), &AudioStreamWAV::get_tags);
ClassDB::bind_method(D_METHOD("save_to_wav", "path"), &AudioStreamWAV::save_to_wav);
ADD_PROPERTY(PropertyInfo(Variant::PACKED_BYTE_ARRAY, "data", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NO_EDITOR), "set_data", "get_data");
@ -1140,6 +1203,7 @@ void AudioStreamWAV::_bind_methods() {
ADD_PROPERTY(PropertyInfo(Variant::INT, "loop_end"), "set_loop_end", "get_loop_end");
ADD_PROPERTY(PropertyInfo(Variant::INT, "mix_rate"), "set_mix_rate", "get_mix_rate");
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "stereo"), "set_stereo", "is_stereo");
ADD_PROPERTY(PropertyInfo(Variant::DICTIONARY, "tags", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NO_EDITOR), "set_tags", "get_tags");
BIND_ENUM_CONSTANT(FORMAT_8_BITS);
BIND_ENUM_CONSTANT(FORMAT_16_BITS);
@ -1151,3 +1215,22 @@ void AudioStreamWAV::_bind_methods() {
BIND_ENUM_CONSTANT(LOOP_PINGPONG);
BIND_ENUM_CONSTANT(LOOP_BACKWARD);
}
AudioStreamWAV::AudioStreamWAV() {
// Used to make the metadata tags more unified across different AudioStreams.
// See https://www.recordingblogs.com/wiki/list-chunk-of-a-wave-file
tag_id_remaps["IARL"] = "location";
tag_id_remaps["IART"] = "artist";
tag_id_remaps["ICMS"] = "organization";
tag_id_remaps["ICMT"] = "comments";
tag_id_remaps["ICOP"] = "copyright";
tag_id_remaps["ICRD"] = "date";
tag_id_remaps["IGNR"] = "genre";
tag_id_remaps["IKEY"] = "keywords";
tag_id_remaps["IMED"] = "medium";
tag_id_remaps["INAM"] = "title";
tag_id_remaps["IPRD"] = "album";
tag_id_remaps["ISBJ"] = "description";
tag_id_remaps["ISFT"] = "software";
tag_id_remaps["ITRK"] = "tracknumber";
}