noahbackus/godot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 2 Wiki Activity

Replace stb_vorbis with libogg+libvorbis

Browse Source
This commit is contained in:
Ellen Poe
2021-09-09 18:54:18 -07:00
parent 0d5e13cd80
commit f5d9c7b487
36 changed files with 1046 additions and 6041 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
modules/ogg/config.py
View File

@@ -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"

32
modules/ogg/doc_classes/OGGPacketSequence.xml Normal file
View File

@@ -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>

13
modules/ogg/doc_classes/OGGPacketSequencePlayback.xml Normal file
View File

@@ -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>

220
modules/ogg/ogg_packet_sequence.cpp Normal file
View File

@@ -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;
}

128
modules/ogg/ogg_packet_sequence.h Normal file
View File

@@ -0,0 +1,128 @@
/*************************************************************************/
/* ogg_packet_sequence.h */
/*************************************************************************/
/* 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. */
/*************************************************************************/
#ifndef OGG_PACKET_SEQUENCE_H
#define OGG_PACKET_SEQUENCE_H
#include "core/io/resource.h"
#include "core/object/gdvirtual.gen.inc"
#include "core/variant/native_ptr.h"
#include "core/variant/typed_array.h"
#include "core/variant/variant.h"
#include "thirdparty/libogg/ogg/ogg.h"
class OGGPacketSequencePlayback;
class OGGPacketSequence : public Resource {
GDCLASS(OGGPacketSequence, Resource);
friend class OGGPacketSequencePlayback;
// List of pages, each of which is a list of packets on that page. The innermost PackedByteArrays contain complete ogg packets.
Vector<Vector<PackedByteArray>> page_data;
// List of the granule position for each page.
Vector<uint64_t> page_granule_positions;
// The page after the current last page. Similar semantics to an end() iterator.
int64_t end_page = 0;
uint64_t data_version = 0;
float sampling_rate = 0;
float length = 0;
protected:
static void _bind_methods();
public:
// Pushes information about all the pages that ended on this page.
// This should be called for each page, even for pages that no packets ended on.
void push_page(int64_t p_granule_pos, const Vector<PackedByteArray> &p_data);
void set_packet_data(const Array &p_data);
Array get_packet_data() const;
void set_packet_granule_positions(const Array &p_granule_positions);
Array get_packet_granule_positions() const;
// Sets a sampling rate associated with this object. OGGPacketSequence doesn't understand codecs,
// so this value is naively stored as a convenience.
void set_sampling_rate(float p_sampling_rate);
// Returns a sampling rate previously set by set_sampling_rate().
float get_sampling_rate() const;
// Returns a length previously set by set_length().
float get_length() const;
// Returns the granule position of the last page in this sequence.
int64_t get_final_granule_pos() const;
Ref<OGGPacketSequencePlayback> instance_playback();
OGGPacketSequence() {}
virtual ~OGGPacketSequence() {}
};
class OGGPacketSequencePlayback : public RefCounted {
GDCLASS(OGGPacketSequencePlayback, RefCounted);
friend class OGGPacketSequence;
Ref<OGGPacketSequence> ogg_packet_sequence;
mutable int64_t page_cursor = 0;
mutable int32_t packet_cursor = 0;
mutable ogg_packet *packet;
uint64_t data_version;
mutable int64_t packetno = 0;
// Recursive bisection search for the correct page.
uint32_t seek_page_internal(int64_t granule, uint32_t after_page_inclusive, uint32_t before_page_inclusive);
public:
// Calling functions must not modify this packet.
// Returns true on success, false on error or if there is no next packet.
bool next_ogg_packet(ogg_packet **p_packet) const;
// Seeks to the page such that the previous page has a granule position less than or equal to this value,
// and the current page has a granule position greater than this value.
// Returns true on success, false on failure.
bool seek_page(int64_t p_granule_pos);
OGGPacketSequencePlayback();
virtual ~OGGPacketSequencePlayback();
};
#endif // OGG_PACKET_SEQUENCE_H

7
modules/ogg/register_types.cpp
View File

@@ -30,8 +30,11 @@
#include "register_types.h"
// Dummy module as libogg is needed by other modules (vorbis, theora, opus, ...)
#include "ogg_packet_sequence.h"
void register_ogg_types() {}
void register_ogg_types() {
GDREGISTER_CLASS(OGGPacketSequence);
GDREGISTER_CLASS(OGGPacketSequencePlayback);
}
void unregister_ogg_types() {}