mirror of
https://github.com/godotengine/godot
synced 2024-09-05 14:18:29 +00:00
![Juan Linietsky](/assets/img/avatar_default.png)
* From Godot 4.0 onwards, proper music looping is supported which requires setting the BPM and then the loop point in beats. * As such, importing with loop by default does not serve much of a purpose. Its annoying to disable for SFX or clips that do not loop and it also requires manual intervention to loop music. * This way, it should work out of the box for any sound effect or non looping audio clip, and manual work is required anyway for looping music.
136 lines
5.4 KiB
C++
136 lines
5.4 KiB
C++
/**************************************************************************/
|
|
/* resource_importer_mp3.cpp */
|
|
/**************************************************************************/
|
|
/* 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. */
|
|
/**************************************************************************/
|
|
|
|
#include "resource_importer_mp3.h"
|
|
|
|
#include "core/io/file_access.h"
|
|
#include "core/io/resource_saver.h"
|
|
#include "scene/resources/texture.h"
|
|
|
|
#ifdef TOOLS_ENABLED
|
|
#include "editor/import/audio_stream_import_settings.h"
|
|
#endif
|
|
|
|
String ResourceImporterMP3::get_importer_name() const {
|
|
return "mp3";
|
|
}
|
|
|
|
String ResourceImporterMP3::get_visible_name() const {
|
|
return "MP3";
|
|
}
|
|
|
|
void ResourceImporterMP3::get_recognized_extensions(List<String> *p_extensions) const {
|
|
p_extensions->push_back("mp3");
|
|
}
|
|
|
|
String ResourceImporterMP3::get_save_extension() const {
|
|
return "mp3str";
|
|
}
|
|
|
|
String ResourceImporterMP3::get_resource_type() const {
|
|
return "AudioStreamMP3";
|
|
}
|
|
|
|
bool ResourceImporterMP3::get_option_visibility(const String &p_path, const String &p_option, const HashMap<StringName, Variant> &p_options) const {
|
|
return true;
|
|
}
|
|
|
|
int ResourceImporterMP3::get_preset_count() const {
|
|
return 0;
|
|
}
|
|
|
|
String ResourceImporterMP3::get_preset_name(int p_idx) const {
|
|
return String();
|
|
}
|
|
|
|
void ResourceImporterMP3::get_import_options(const String &p_path, List<ImportOption> *r_options, int p_preset) const {
|
|
r_options->push_back(ImportOption(PropertyInfo(Variant::BOOL, "loop"), false));
|
|
r_options->push_back(ImportOption(PropertyInfo(Variant::FLOAT, "loop_offset"), 0));
|
|
r_options->push_back(ImportOption(PropertyInfo(Variant::FLOAT, "bpm", PROPERTY_HINT_RANGE, "0,400,0.01,or_greater"), 0));
|
|
r_options->push_back(ImportOption(PropertyInfo(Variant::INT, "beat_count", PROPERTY_HINT_RANGE, "0,512,or_greater"), 0));
|
|
r_options->push_back(ImportOption(PropertyInfo(Variant::INT, "bar_beats", PROPERTY_HINT_RANGE, "2,32,or_greater"), 4));
|
|
}
|
|
|
|
#ifdef TOOLS_ENABLED
|
|
bool ResourceImporterMP3::has_advanced_options() const {
|
|
return true;
|
|
}
|
|
void ResourceImporterMP3::show_advanced_options(const String &p_path) {
|
|
Ref<AudioStreamMP3> mp3_stream = import_mp3(p_path);
|
|
if (mp3_stream.is_valid()) {
|
|
AudioStreamImportSettings::get_singleton()->edit(p_path, "mp3", mp3_stream);
|
|
}
|
|
}
|
|
#endif
|
|
|
|
Ref<AudioStreamMP3> ResourceImporterMP3::import_mp3(const String &p_path) {
|
|
Ref<FileAccess> f = FileAccess::open(p_path, FileAccess::READ);
|
|
ERR_FAIL_COND_V(f.is_null(), Ref<AudioStreamMP3>());
|
|
|
|
uint64_t len = f->get_length();
|
|
|
|
Vector<uint8_t> data;
|
|
data.resize(len);
|
|
uint8_t *w = data.ptrw();
|
|
|
|
f->get_buffer(w, len);
|
|
|
|
Ref<AudioStreamMP3> mp3_stream;
|
|
mp3_stream.instantiate();
|
|
|
|
mp3_stream->set_data(data);
|
|
ERR_FAIL_COND_V(!mp3_stream->get_data().size(), Ref<AudioStreamMP3>());
|
|
|
|
return mp3_stream;
|
|
}
|
|
|
|
Error ResourceImporterMP3::import(const String &p_source_file, const String &p_save_path, const HashMap<StringName, Variant> &p_options, List<String> *r_platform_variants, List<String> *r_gen_files, Variant *r_metadata) {
|
|
bool loop = p_options["loop"];
|
|
float loop_offset = p_options["loop_offset"];
|
|
double bpm = p_options["bpm"];
|
|
float beat_count = p_options["beat_count"];
|
|
float bar_beats = p_options["bar_beats"];
|
|
|
|
Ref<AudioStreamMP3> mp3_stream = import_mp3(p_source_file);
|
|
if (mp3_stream.is_null()) {
|
|
return ERR_CANT_OPEN;
|
|
}
|
|
mp3_stream->set_loop(loop);
|
|
mp3_stream->set_loop_offset(loop_offset);
|
|
mp3_stream->set_bpm(bpm);
|
|
mp3_stream->set_beat_count(beat_count);
|
|
mp3_stream->set_bar_beats(bar_beats);
|
|
|
|
return ResourceSaver::save(mp3_stream, p_save_path + ".mp3str");
|
|
}
|
|
|
|
ResourceImporterMP3::ResourceImporterMP3() {
|
|
}
|