1/**************************************************************************/
2/* ogg_packet_sequence.h */
3/**************************************************************************/
4/* This file is part of: */
5/* GODOT ENGINE */
6/* https://godotengine.org */
7/**************************************************************************/
8/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
9/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
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
31#ifndef OGG_PACKET_SEQUENCE_H
32#define OGG_PACKET_SEQUENCE_H
33
34#include "core/io/resource.h"
35#include "core/variant/typed_array.h"
36#include "core/variant/variant.h"
37
38#include <ogg/ogg.h>
39
40class OggPacketSequencePlayback;
41
42class OggPacketSequence : public Resource {
43 GDCLASS(OggPacketSequence, Resource);
44
45 friend class OggPacketSequencePlayback;
46
47 // List of pages, each of which is a list of packets on that page. The innermost PackedByteArrays contain complete ogg packets.
48 Vector<Vector<PackedByteArray>> page_data;
49
50 // List of the granule position for each page.
51 Vector<uint64_t> page_granule_positions;
52
53 // The page after the current last page. Similar semantics to an end() iterator.
54 int64_t end_page = 0;
55
56 uint64_t data_version = 0;
57
58 float sampling_rate = 0;
59 float length = 0;
60
61protected:
62 static void _bind_methods();
63
64public:
65 // Pushes information about all the pages that ended on this page.
66 // This should be called for each page, even for pages that no packets ended on.
67 void push_page(int64_t p_granule_pos, const Vector<PackedByteArray> &p_data);
68
69 void set_packet_data(const TypedArray<Array> &p_data);
70 TypedArray<Array> get_packet_data() const;
71
72 void set_packet_granule_positions(const PackedInt64Array &p_granule_positions);
73 PackedInt64Array get_packet_granule_positions() const;
74
75 // Sets a sampling rate associated with this object. OggPacketSequence doesn't understand codecs,
76 // so this value is naively stored as a convenience.
77 void set_sampling_rate(float p_sampling_rate);
78
79 // Returns a sampling rate previously set by set_sampling_rate().
80 float get_sampling_rate() const;
81
82 // Returns a length previously set by set_length().
83 float get_length() const;
84
85 // Returns the granule position of the last page in this sequence.
86 int64_t get_final_granule_pos() const;
87
88 Ref<OggPacketSequencePlayback> instantiate_playback();
89
90 OggPacketSequence() {}
91 virtual ~OggPacketSequence() {}
92};
93
94class OggPacketSequencePlayback : public RefCounted {
95 GDCLASS(OggPacketSequencePlayback, RefCounted);
96
97 friend class OggPacketSequence;
98
99 Ref<OggPacketSequence> ogg_packet_sequence;
100
101 mutable int64_t page_cursor = 0;
102 mutable int32_t packet_cursor = 0;
103
104 mutable ogg_packet *packet;
105
106 uint64_t data_version = 0;
107
108 mutable int64_t packetno = 0;
109
110 // Recursive bisection search for the correct page.
111 uint32_t seek_page_internal(int64_t granule, uint32_t after_page_inclusive, uint32_t before_page_inclusive);
112
113public:
114 // Calling functions must not modify this packet.
115 // Returns true on success, false on error or if there is no next packet.
116 bool next_ogg_packet(ogg_packet **p_packet) const;
117
118 // Seeks to the page such that the previous page has a granule position less than or equal to this value,
119 // and the current page has a granule position greater than this value.
120 // Returns true on success, false on failure.
121 bool seek_page(int64_t p_granule_pos);
122
123 OggPacketSequencePlayback();
124 virtual ~OggPacketSequencePlayback();
125};
126
127#endif // OGG_PACKET_SEQUENCE_H
128