resource_importer_ogg_vorbis.cpp 9.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233
  1. /*************************************************************************/
  2. /* resource_importer_ogg_vorbis.cpp */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /*************************************************************************/
  30. #include "resource_importer_ogg_vorbis.h"
  31. #include "core/io/file_access.h"
  32. #include "core/io/resource_saver.h"
  33. #include "scene/resources/texture.h"
  34. #include "thirdparty/libogg/ogg/ogg.h"
  35. #include "thirdparty/libvorbis/vorbis/codec.h"
  36. #ifdef TOOLS_ENABLED
  37. #include "editor/import/audio_stream_import_settings.h"
  38. #endif
  39. String ResourceImporterOggVorbis::get_importer_name() const {
  40. return "oggvorbisstr";
  41. }
  42. String ResourceImporterOggVorbis::get_visible_name() const {
  43. return "oggvorbisstr";
  44. }
  45. void ResourceImporterOggVorbis::get_recognized_extensions(List<String> *p_extensions) const {
  46. p_extensions->push_back("ogg");
  47. }
  48. String ResourceImporterOggVorbis::get_save_extension() const {
  49. return "oggvorbisstr";
  50. }
  51. String ResourceImporterOggVorbis::get_resource_type() const {
  52. return "AudioStreamOggVorbis";
  53. }
  54. bool ResourceImporterOggVorbis::get_option_visibility(const String &p_path, const String &p_option, const HashMap<StringName, Variant> &p_options) const {
  55. return true;
  56. }
  57. int ResourceImporterOggVorbis::get_preset_count() const {
  58. return 0;
  59. }
  60. String ResourceImporterOggVorbis::get_preset_name(int p_idx) const {
  61. return String();
  62. }
  63. void ResourceImporterOggVorbis::get_import_options(const String &p_path, List<ImportOption> *r_options, int p_preset) const {
  64. r_options->push_back(ImportOption(PropertyInfo(Variant::BOOL, "loop"), true));
  65. r_options->push_back(ImportOption(PropertyInfo(Variant::FLOAT, "loop_offset"), 0));
  66. r_options->push_back(ImportOption(PropertyInfo(Variant::FLOAT, "bpm", PROPERTY_HINT_RANGE, "0,400,0.01,or_greater"), 0));
  67. r_options->push_back(ImportOption(PropertyInfo(Variant::INT, "beat_count", PROPERTY_HINT_RANGE, "0,512,or_greater"), 0));
  68. r_options->push_back(ImportOption(PropertyInfo(Variant::INT, "bar_beats", PROPERTY_HINT_RANGE, "2,32,or_greater"), 4));
  69. }
  70. Ref<AudioStreamOggVorbis> ResourceImporterOggVorbis::import_ogg_vorbis(const String &p_path) {
  71. Ref<FileAccess> f = FileAccess::open(p_path, FileAccess::READ);
  72. ERR_FAIL_COND_V_MSG(f.is_null(), Ref<AudioStreamOggVorbis>(), "Cannot open file '" + p_path + "'.");
  73. uint64_t len = f->get_length();
  74. Vector<uint8_t> file_data;
  75. file_data.resize(len);
  76. uint8_t *w = file_data.ptrw();
  77. f->get_buffer(w, len);
  78. Ref<AudioStreamOggVorbis> ogg_vorbis_stream;
  79. ogg_vorbis_stream.instantiate();
  80. Ref<OggPacketSequence> ogg_packet_sequence;
  81. ogg_packet_sequence.instantiate();
  82. ogg_stream_state stream_state;
  83. ogg_sync_state sync_state;
  84. ogg_page page;
  85. ogg_packet packet;
  86. bool initialized_stream = false;
  87. ogg_sync_init(&sync_state);
  88. int err;
  89. size_t cursor = 0;
  90. size_t packet_count = 0;
  91. bool done = false;
  92. while (!done) {
  93. ERR_FAIL_COND_V_MSG((err = ogg_sync_check(&sync_state)), Ref<AudioStreamOggVorbis>(), "Ogg sync error " + itos(err));
  94. while (ogg_sync_pageout(&sync_state, &page) != 1) {
  95. if (cursor >= len) {
  96. done = true;
  97. break;
  98. }
  99. ERR_FAIL_COND_V_MSG((err = ogg_sync_check(&sync_state)), Ref<AudioStreamOggVorbis>(), "Ogg sync error " + itos(err));
  100. char *sync_buf = ogg_sync_buffer(&sync_state, OGG_SYNC_BUFFER_SIZE);
  101. ERR_FAIL_COND_V_MSG((err = ogg_sync_check(&sync_state)), Ref<AudioStreamOggVorbis>(), "Ogg sync error " + itos(err));
  102. ERR_FAIL_COND_V(cursor > len, Ref<AudioStreamOggVorbis>());
  103. size_t copy_size = len - cursor;
  104. if (copy_size > OGG_SYNC_BUFFER_SIZE) {
  105. copy_size = OGG_SYNC_BUFFER_SIZE;
  106. }
  107. memcpy(sync_buf, &file_data[cursor], copy_size);
  108. ogg_sync_wrote(&sync_state, copy_size);
  109. cursor += copy_size;
  110. ERR_FAIL_COND_V_MSG((err = ogg_sync_check(&sync_state)), Ref<AudioStreamOggVorbis>(), "Ogg sync error " + itos(err));
  111. }
  112. if (done) {
  113. break;
  114. }
  115. ERR_FAIL_COND_V_MSG((err = ogg_sync_check(&sync_state)), Ref<AudioStreamOggVorbis>(), "Ogg sync error " + itos(err));
  116. // Have a page now.
  117. if (!initialized_stream) {
  118. if (ogg_stream_init(&stream_state, ogg_page_serialno(&page))) {
  119. ERR_FAIL_V_MSG(Ref<AudioStreamOggVorbis>(), "Failed allocating memory for Ogg Vorbis stream.");
  120. }
  121. initialized_stream = true;
  122. }
  123. ogg_stream_pagein(&stream_state, &page);
  124. ERR_FAIL_COND_V_MSG((err = ogg_stream_check(&stream_state)), Ref<AudioStreamOggVorbis>(), "Ogg stream error " + itos(err));
  125. int desync_iters = 0;
  126. Vector<Vector<uint8_t>> packet_data;
  127. int64_t granule_pos = 0;
  128. while (true) {
  129. err = ogg_stream_packetout(&stream_state, &packet);
  130. if (err == -1) {
  131. // According to the docs this is usually recoverable, but don't sit here spinning forever.
  132. desync_iters++;
  133. ERR_FAIL_COND_V_MSG(desync_iters > 100, Ref<AudioStreamOggVorbis>(), "Packet sync issue during Ogg import");
  134. continue;
  135. } else if (err == 0) {
  136. // Not enough data to fully reconstruct a packet. Go on to the next page.
  137. break;
  138. }
  139. if (packet_count == 0 && vorbis_synthesis_idheader(&packet) == 0) {
  140. print_verbose("Found a non-vorbis-header packet in a header position");
  141. // Clearly this logical stream is not a vorbis stream, so destroy it and try again with the next page.
  142. if (initialized_stream) {
  143. ogg_stream_clear(&stream_state);
  144. initialized_stream = false;
  145. }
  146. break;
  147. }
  148. granule_pos = packet.granulepos;
  149. PackedByteArray data;
  150. data.resize(packet.bytes);
  151. memcpy(data.ptrw(), packet.packet, packet.bytes);
  152. packet_data.push_back(data);
  153. packet_count++;
  154. }
  155. if (initialized_stream) {
  156. ogg_packet_sequence->push_page(granule_pos, packet_data);
  157. }
  158. }
  159. if (initialized_stream) {
  160. ogg_stream_clear(&stream_state);
  161. }
  162. ogg_sync_clear(&sync_state);
  163. if (ogg_packet_sequence->get_packet_granule_positions().is_empty()) {
  164. ERR_FAIL_V_MSG(Ref<AudioStreamOggVorbis>(), "Ogg Vorbis decoding failed. Check that your data is a valid Ogg Vorbis audio stream.");
  165. }
  166. ogg_vorbis_stream->set_packet_sequence(ogg_packet_sequence);
  167. return ogg_vorbis_stream;
  168. }
  169. #ifdef TOOLS_ENABLED
  170. bool ResourceImporterOggVorbis::has_advanced_options() const {
  171. return true;
  172. }
  173. void ResourceImporterOggVorbis::show_advanced_options(const String &p_path) {
  174. Ref<AudioStreamOggVorbis> ogg_stream = import_ogg_vorbis(p_path);
  175. if (ogg_stream.is_valid()) {
  176. AudioStreamImportSettings::get_singleton()->edit(p_path, "oggvorbisstr", ogg_stream);
  177. }
  178. }
  179. #endif
  180. Error ResourceImporterOggVorbis::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) {
  181. bool loop = p_options["loop"];
  182. float loop_offset = p_options["loop_offset"];
  183. double bpm = p_options["bpm"];
  184. int beat_count = p_options["beat_count"];
  185. int bar_beats = p_options["bar_beats"];
  186. Ref<AudioStreamOggVorbis> ogg_vorbis_stream = import_ogg_vorbis(p_source_file);
  187. if (ogg_vorbis_stream.is_null()) {
  188. return ERR_CANT_OPEN;
  189. }
  190. ogg_vorbis_stream->set_loop(loop);
  191. ogg_vorbis_stream->set_loop_offset(loop_offset);
  192. ogg_vorbis_stream->set_bpm(bpm);
  193. ogg_vorbis_stream->set_beat_count(beat_count);
  194. ogg_vorbis_stream->set_bar_beats(bar_beats);
  195. return ResourceSaver::save(p_save_path + ".oggvorbisstr", ogg_vorbis_stream);
  196. }
  197. ResourceImporterOggVorbis::ResourceImporterOggVorbis() {
  198. }