godotengine · reduz · Sep 10, 2021 · Sep 10, 2021
@@ -73,7 +73,6 @@ doc_classes/*                       @godotengine/documentation
 /modules/minimp3/                   @godotengine/audio
 /modules/ogg/                       @godotengine/audio
 /modules/opus/                      @godotengine/audio
-/modules/stb_vorbis/                @godotengine/audio
 /modules/theora/                    @godotengine/audio
 /modules/vorbis/                    @godotengine/audio
 /modules/webm/                      @godotengine/audio

@@ -367,7 +367,6 @@ Copyright: 2016-2020, Aras Pranckevicius
 License: public-domain or Unlicense or Expat
 
 Files: ./thirdparty/misc/stb_rect_pack.h
- ./thirdparty/misc/stb_vorbis.c
 Comment: stb libraries
 Copyright: Sean Barrett
 License: public-domain or Unlicense or Expat

@@ -92,7 +92,7 @@ class Vector {
 
 	void append_array(Vector<T> p_other);
 
-	bool has(const T &p_val) {
+	bool has(const T &p_val) const {
 		return find(p_val, 0) != -1;
 	}
 

@@ -270,7 +270,7 @@
 				Converts UTF-8 encoded array to [String]. Slower than [method get_string_from_ascii] but supports UTF-8 encoded data. Use this function if you are unsure about the source of the data. For user input this function should always be preferred. Returns empty string if source array is not valid UTF-8 string.
 			</description>
 		</method>
-		<method name="has">
+		<method name="has" qualifiers="const">
 			<return type="bool" />
 			<argument index="0" name="value" type="int" />
 			<description>

@@ -56,7 +56,7 @@
 				Assigns the given value to all elements in the array. This can typically be used together with [method resize] to create an array with a given size and initialized elements.
 			</description>
 		</method>
-		<method name="has">
+		<method name="has" qualifiers="const">
 			<return type="bool" />
 			<argument index="0" name="value" type="Color" />
 			<description>

@@ -57,7 +57,7 @@
 				Assigns the given value to all elements in the array. This can typically be used together with [method resize] to create an array with a given size and initialized elements.
 			</description>
 		</method>
-		<method name="has">
+		<method name="has" qualifiers="const">
 			<return type="bool" />
 			<argument index="0" name="value" type="float" />
 			<description>

@@ -57,7 +57,7 @@
 				Assigns the given value to all elements in the array. This can typically be used together with [method resize] to create an array with a given size and initialized elements.
 			</description>
 		</method>
-		<method name="has">
+		<method name="has" qualifiers="const">
 			<return type="bool" />
 			<argument index="0" name="value" type="float" />
 			<description>

@@ -57,7 +57,7 @@
 				Assigns the given value to all elements in the array. This can typically be used together with [method resize] to create an array with a given size and initialized elements.
 			</description>
 		</method>
-		<method name="has">
+		<method name="has" qualifiers="const">
 			<return type="bool" />
 			<argument index="0" name="value" type="int" />
 			<description>

@@ -57,7 +57,7 @@
 				Assigns the given value to all elements in the array. This can typically be used together with [method resize] to create an array with a given size and initialized elements.
 			</description>
 		</method>
-		<method name="has">
+		<method name="has" qualifiers="const">
 			<return type="bool" />
 			<argument index="0" name="value" type="int" />
 			<description>

@@ -57,7 +57,7 @@
 				Assigns the given value to all elements in the array. This can typically be used together with [method resize] to create an array with a given size and initialized elements.
 			</description>
 		</method>
-		<method name="has">
+		<method name="has" qualifiers="const">
 			<return type="bool" />
 			<argument index="0" name="value" type="String" />
 			<description>

@@ -57,7 +57,7 @@
 				Assigns the given value to all elements in the array. This can typically be used together with [method resize] to create an array with a given size and initialized elements.
 			</description>
 		</method>
-		<method name="has">
+		<method name="has" qualifiers="const">
 			<return type="bool" />
 			<argument index="0" name="value" type="Vector2" />
 			<description>

@@ -56,7 +56,7 @@
 				Assigns the given value to all elements in the array. This can typically be used together with [method resize] to create an array with a given size and initialized elements.
 			</description>
 		</method>
-		<method name="has">
+		<method name="has" qualifiers="const">
 			<return type="bool" />
 			<argument index="0" name="value" type="Vector3" />
 			<description>

diff --git a/editor/editor_file_system.cpp b/editor/editor_file_system.cpp
@@ -444,6 +444,10 @@ bool EditorFileSystem::_test_for_reimport(const String &p_path, bool p_only_impo
 
 	Ref<ResourceImporter> importer = ResourceFormatImporter::get_singleton()->get_importer_by_name(importer_name);
 
+	if (importer.is_null()) {
+		return true; // the importer has possibly changed, try to reimport.
+	}
+
 	if (importer->get_format_version() > version) {
 		return true; // version changed, reimport
 	}

@@ -4,3 +4,14 @@ def can_build(env, platform):
 
 def configure(env):
     pass
+
+
+def get_doc_classes():
+    return [
+        "OGGPacketSequence",
+        "OGGPacketSequencePlayback",
+    ]
+
+
+def get_doc_path():
+    return "doc_classes"
@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="OGGPacketSequence" inherits="Resource" version="4.0">
+	<brief_description>
+		A sequence of OGG packets.
+	</brief_description>
+	<description>
+		A sequence of OGG packets.
+	</description>
+	<tutorials>
+	</tutorials>
+	<methods>
+		<method name="get_length" qualifiers="const">
+			<return type="float" />
+			<description>
+				The length of this stream, in seconds.
+			</description>
+		</method>
+	</methods>
+	<members>
+		<member name="granule_positions" type="Array" setter="set_packet_granule_positions" getter="get_packet_granule_positions" default="[]">
+			Contains the granule positions for each page in this packet sequence.
+		</member>
+		<member name="packet_data" type="Array" setter="set_packet_data" getter="get_packet_data" default="[]">
+			Contains the raw packets that make up this OGGPacketSequence.
+		</member>
+		<member name="sampling_rate" type="float" setter="set_sampling_rate" getter="get_sampling_rate" default="0.0">
+			Holds sample rate information about this sequence. Must be set by another class that actually understands the codec.
+		</member>
+	</members>
+	<constants>
+	</constants>
+</class>
@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="OGGPacketSequencePlayback" inherits="RefCounted" version="4.0">
+	<brief_description>
+	</brief_description>
+	<description>
+	</description>
+	<tutorials>
+	</tutorials>
+	<methods>
+	</methods>
+	<constants>
+	</constants>
+</class>
@@ -0,0 +1,220 @@
+/*************************************************************************/
+/*  ogg_packet_sequence.cpp                                              */
+/*************************************************************************/
+/*                       This file is part of:                           */
+/*                           GODOT ENGINE                                */
+/*                      https://godotengine.org                          */
+/*************************************************************************/
+/* Copyright (c) 2007-2021 Juan Linietsky, Ariel Manzur.                 */
+/* Copyright (c) 2014-2021 Godot Engine contributors (cf. AUTHORS.md).   */
+/*                                                                       */
+/* 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 "ogg_packet_sequence.h"
+#include "core/variant/typed_array.h"
+
+void OGGPacketSequence::push_page(int64_t p_granule_pos, const Vector<PackedByteArray> &p_data) {
+	Vector<PackedByteArray> data_stored;
+	for (int i = 0; i < p_data.size(); i++) {
+		data_stored.push_back(p_data[i]);
+	}
+	page_granule_positions.push_back(p_granule_pos);
+	page_data.push_back(data_stored);
+	data_version++;
+}
+
+void OGGPacketSequence::set_packet_data(const Array &p_data) {
+	data_version++; // Update the data version so old playbacks know that they can't rely on us anymore.
+	page_data.clear();
+	for (int page_idx = 0; page_idx < p_data.size(); page_idx++) {
+		// Push a new page. We cleared the vector so this will be at index `page_idx`.
+		page_data.push_back(Vector<PackedByteArray>());
+		TypedArray<PackedByteArray> this_page_data = p_data[page_idx];
+		for (int packet = 0; packet < this_page_data.size(); packet++) {
+			page_data.write[page_idx].push_back(this_page_data[packet]);
+		}
+	}
+}
+
+Array OGGPacketSequence::get_packet_data() const {
+	Array ret;
+	for (const Vector<PackedByteArray> &page : page_data) {
+		Array page_variant;
+		for (const PackedByteArray &packet : page) {
+			page_variant.push_back(packet);
+		}
+		ret.push_back(page_variant);
+	}
+	return ret;
+}
+
+void OGGPacketSequence::set_packet_granule_positions(const Array &p_granule_positions) {
+	data_version++; // Update the data version so old playbacks know that they can't rely on us anymore.
+	page_granule_positions.clear();
+	for (int page_idx = 0; page_idx < p_granule_positions.size(); page_idx++) {
+		int64_t granule_pos = p_granule_positions[page_idx];
+		page_granule_positions.push_back(granule_pos);
+	}
+}
+
+Array OGGPacketSequence::get_packet_granule_positions() const {
+	Array ret;
+	for (int64_t granule_pos : page_granule_positions) {
+		ret.push_back(granule_pos);
+	}
+	return ret;
+}
+
+void OGGPacketSequence::set_sampling_rate(float p_sampling_rate) {
+	sampling_rate = p_sampling_rate;
+}
+
+float OGGPacketSequence::get_sampling_rate() const {
+	return sampling_rate;
+}
+
+int64_t OGGPacketSequence::get_final_granule_pos() const {
+	if (!page_granule_positions.is_empty()) {
+		return page_granule_positions[page_granule_positions.size() - 1];
+	}
+	return -1;
+}
+
+float OGGPacketSequence::get_length() const {
+	int64_t granule_pos = get_final_granule_pos();
+	if (granule_pos < 0) {
+		return 0;
+	}
+	return granule_pos / sampling_rate;
+}
+
+Ref<OGGPacketSequencePlayback> OGGPacketSequence::instance_playback() {
+	Ref<OGGPacketSequencePlayback> playback;
+	playback.instantiate();
+	playback->ogg_packet_sequence = Ref<OGGPacketSequence>(this);
+	playback->data_version = data_version;
+
+	return playback;
+}
+
+void OGGPacketSequence::_bind_methods() {
+	ClassDB::bind_method(D_METHOD("set_packet_data", "packet_data"), &OGGPacketSequence::set_packet_data);
+	ClassDB::bind_method(D_METHOD("get_packet_data"), &OGGPacketSequence::get_packet_data);
+
+	ClassDB::bind_method(D_METHOD("set_packet_granule_positions", "granule_positions"), &OGGPacketSequence::set_packet_granule_positions);
+	ClassDB::bind_method(D_METHOD("get_packet_granule_positions"), &OGGPacketSequence::get_packet_granule_positions);
+
+	ClassDB::bind_method(D_METHOD("set_sampling_rate", "sampling_rate"), &OGGPacketSequence::set_sampling_rate);
+	ClassDB::bind_method(D_METHOD("get_sampling_rate"), &OGGPacketSequence::get_sampling_rate);
+
+	ClassDB::bind_method(D_METHOD("get_length"), &OGGPacketSequence::get_length);
+
+	ADD_PROPERTY(PropertyInfo(Variant::ARRAY, "packet_data", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NOEDITOR), "set_packet_data", "get_packet_data");
+	ADD_PROPERTY(PropertyInfo(Variant::ARRAY, "granule_positions", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NOEDITOR), "set_packet_granule_positions", "get_packet_granule_positions");
+	ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "sampling_rate", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NOEDITOR), "set_sampling_rate", "get_sampling_rate");
+}
+
+bool OGGPacketSequencePlayback::next_ogg_packet(ogg_packet **p_packet) const {
+	ERR_FAIL_COND_V(data_version != ogg_packet_sequence->data_version, false);
+	ERR_FAIL_COND_V(ogg_packet_sequence->page_data.is_empty(), false);
+	ERR_FAIL_COND_V(ogg_packet_sequence->page_granule_positions.is_empty(), false);
+	// Move on to the next page if need be. This happens first to help simplify seek logic.
+	while (packet_cursor >= ogg_packet_sequence->page_data[page_cursor].size()) {
+		packet_cursor = 0;
+		page_cursor++;
+		if (page_cursor >= ogg_packet_sequence->page_data.size()) {
+			return false;
+		}
+	}
+
+	ERR_FAIL_COND_V(page_cursor >= ogg_packet_sequence->page_data.size(), false);
+
+	packet->b_o_s = page_cursor == 0 && packet_cursor == 0;
+	packet->e_o_s = page_cursor == ogg_packet_sequence->page_data.size() - 1 && packet_cursor == ogg_packet_sequence->page_data[page_cursor].size() - 1;
+	packet->granulepos = packet_cursor == ogg_packet_sequence->page_data[page_cursor].size() - 1 ? ogg_packet_sequence->page_granule_positions[page_cursor] : -1;
+	packet->packetno = packetno++;
+	packet->bytes = ogg_packet_sequence->page_data[page_cursor][packet_cursor].size();
+	packet->packet = (unsigned char *)(ogg_packet_sequence->page_data[page_cursor][packet_cursor].ptr());
+
+	*p_packet = packet;
+
+	packet_cursor++;
+
+	return true;
+}
+
+uint32_t OGGPacketSequencePlayback::seek_page_internal(int64_t granule, uint32_t after_page_inclusive, uint32_t before_page_inclusive) {
+	if (before_page_inclusive == after_page_inclusive) {
+		return before_page_inclusive;
+	}
+	uint32_t actual_middle_page = after_page_inclusive + (before_page_inclusive - after_page_inclusive) / 2;
+	// Complicating the bisection search algorithm, the middle page might not have a packet that ends on it,
+	// which means it might not have a correct granule position. Find a nearby page that does have a packet ending on it.
+	uint32_t bisection_page = -1;
+	for (uint32_t test_page = actual_middle_page; test_page <= before_page_inclusive; test_page++) {
+		if (ogg_packet_sequence->page_data[test_page].size() > 0) {
+			bisection_page = test_page;
+			break;
+		}
+	}
+	// Check if we have to go backwards.
+	if (bisection_page == (unsigned int)-1) {
+		for (uint32_t test_page = actual_middle_page; test_page >= after_page_inclusive; test_page--) {
+			if (ogg_packet_sequence->page_data[test_page].size() > 0) {
+				bisection_page = test_page;
+				break;
+			}
+		}
+	}
+	if (bisection_page == (unsigned int)-1) {
+		return -1;
+	}
+
+	int64_t bisection_granule_pos = ogg_packet_sequence->page_granule_positions[bisection_page];
+	if (granule > bisection_granule_pos) {
+		return seek_page_internal(granule, bisection_page + 1, before_page_inclusive);
+	} else {
+		return seek_page_internal(granule, after_page_inclusive, bisection_page);
+	}
+}
+
+bool OGGPacketSequencePlayback::seek_page(int64_t p_granule_pos) {
+	int correct_page = seek_page_internal(p_granule_pos, 0, ogg_packet_sequence->page_data.size() - 1);
+	if (correct_page == -1) {
+		return false;
+	}
+
+	packet_cursor = 0;
+	page_cursor = correct_page;
+
+	// Don't pretend subsequent packets are contiguous with previous ones.
+	packetno = 0;
+
+	return true;
+}
+
+OGGPacketSequencePlayback::OGGPacketSequencePlayback() {
+	packet = new ogg_packet();
+}
+
+OGGPacketSequencePlayback::~OGGPacketSequencePlayback() {
+	delete packet;
+}