1/**************************************************************************/
2/* audio_stream_preview.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 AUDIO_STREAM_PREVIEW_H
32#define AUDIO_STREAM_PREVIEW_H
33
34#include "core/os/thread.h"
35#include "core/templates/safe_refcount.h"
36#include "scene/main/node.h"
37#include "servers/audio/audio_stream.h"
38
39class AudioStreamPreview : public RefCounted {
40 GDCLASS(AudioStreamPreview, RefCounted);
41 friend class AudioStream;
42 Vector<uint8_t> preview;
43 float length;
44
45 friend class AudioStreamPreviewGenerator;
46 uint64_t version = 1;
47
48public:
49 uint64_t get_version() const { return version; }
50 float get_length() const;
51 float get_max(float p_time, float p_time_next) const;
52 float get_min(float p_time, float p_time_next) const;
53
54 AudioStreamPreview();
55};
56
57class AudioStreamPreviewGenerator : public Node {
58 GDCLASS(AudioStreamPreviewGenerator, Node);
59
60 static AudioStreamPreviewGenerator *singleton;
61
62 struct Preview {
63 Ref<AudioStreamPreview> preview;
64 Ref<AudioStream> base_stream;
65 Ref<AudioStreamPlayback> playback;
66 SafeFlag generating;
67 ObjectID id;
68 Thread *thread = nullptr;
69
70 // Needed for the bookkeeping of the Map
71 void operator=(const Preview &p_rhs) {
72 preview = p_rhs.preview;
73 base_stream = p_rhs.base_stream;
74 playback = p_rhs.playback;
75 generating.set_to(generating.is_set());
76 id = p_rhs.id;
77 thread = p_rhs.thread;
78 }
79 Preview(const Preview &p_rhs) {
80 preview = p_rhs.preview;
81 base_stream = p_rhs.base_stream;
82 playback = p_rhs.playback;
83 generating.set_to(generating.is_set());
84 id = p_rhs.id;
85 thread = p_rhs.thread;
86 }
87 Preview() {}
88 };
89
90 HashMap<ObjectID, Preview> previews;
91
92 static void _preview_thread(void *p_preview);
93
94 void _update_emit(ObjectID p_id);
95
96protected:
97 void _notification(int p_what);
98 static void _bind_methods();
99
100public:
101 static AudioStreamPreviewGenerator *get_singleton() { return singleton; }
102
103 Ref<AudioStreamPreview> generate_preview(const Ref<AudioStream> &p_stream);
104
105 AudioStreamPreviewGenerator();
106};
107
108#endif // AUDIO_STREAM_PREVIEW_H
109