2023-01-10 15:26:54 +01:00
|
|
|
/**************************************************************************/
|
|
|
|
/* audio_stream_ogg_vorbis.h */
|
|
|
|
/**************************************************************************/
|
|
|
|
/* This file is part of: */
|
|
|
|
/* GODOT ENGINE */
|
|
|
|
/* https://godotengine.org */
|
|
|
|
/**************************************************************************/
|
|
|
|
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
|
|
|
|
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
|
|
|
|
/* */
|
|
|
|
/* 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. */
|
|
|
|
/**************************************************************************/
|
2018-01-05 00:50:27 +01:00
|
|
|
|
2022-07-25 12:33:41 +02:00
|
|
|
#ifndef AUDIO_STREAM_OGG_VORBIS_H
|
|
|
|
#define AUDIO_STREAM_OGG_VORBIS_H
|
2017-01-21 23:00:25 +01:00
|
|
|
|
2018-09-11 18:13:45 +02:00
|
|
|
#include "core/io/resource_loader.h"
|
2017-03-05 16:44:50 +01:00
|
|
|
#include "servers/audio/audio_stream.h"
|
2017-01-21 23:00:25 +01:00
|
|
|
|
Fix warning about functions defined but not used [-Wunused-function]
Fixes the following GCC 5 warnings:
```
core/io/zip_io.h:128:26: warning: 'zlib_filefunc_def zipio_create_io_from_file(FileAccess**)' defined but not used [-Wunused-function]
core/script_debugger_remote.cpp:110:17: warning: 'ObjectID safe_get_instance_id(const Variant&)' defined but not used [-Wunused-function]
drivers/unix/socket_helpers.h:103:12: warning: 'int _socket_create(IP::Type&, int, int)' defined but not used [-Wunused-function]
drivers/unix/socket_helpers.h:45:15: warning: 'size_t _set_sockaddr(sockaddr_storage*, const IP_Address&, int, IP::Type)' defined but not used [-Wunused-function]
drivers/unix/socket_helpers.h:76:15: warning: 'size_t _set_listen_sockaddr(sockaddr_storage*, int, IP::Type, IP_Address)' defined but not used [-Wunused-function]
editor/editor_fonts.cpp:40:24: warning: 'Ref<BitmapFont> make_font(int, int, int, int, const int*, const Ref<Texture>&)' defined but not used [-Wunused-function]
editor/editor_themes.cpp:85:26: warning: 'Ref<StyleBoxFlat> change_border_color(Ref<StyleBoxFlat>, Color)' defined but not used [-Wunused-function]
editor/import/editor_import_collada.cpp:493:13: warning: 'void _generate_normals(const PoolVector<int>&, const PoolVector<Vector3>&, PoolVector<Vector3>&)' defined but not used [-Wunused-function]
editor/import/editor_import_collada.cpp:524:13: warning: 'void _generate_tangents_and_binormals(const PoolVector<int>&, const PoolVector<Vector3>&, const PoolVector<Vector3>&, const PoolVector<Vector3>&, PoolVector<float>&)' defined but not used [-Wunused-function]
editor/pvrtc_compress.cpp:118:13: warning: 'void _compress_etc(Image*)' defined but not used [-Wunused-function]
modules/etc/image_etc.cpp:89:13: warning: 'void _decompress_etc1(Image*)' defined but not used [-Wunused-function]
modules/etc/image_etc.cpp:93:13: warning: 'void _decompress_etc2(Image*)' defined but not used [-Wunused-function]
modules/gdscript/editor/gdscript_highlighter.cpp:46:13: warning: 'bool _is_whitespace(CharType)' defined but not used [-Wunused-function]
scene/2d/cpu_particles_2d.cpp:510:14: warning: 'float rand_from_seed_m1_p1(uint32_t&)' defined but not used [-Wunused-function]
scene/3d/cpu_particles.cpp:474:14: warning: 'float rand_from_seed_m1_p1(uint32_t&)' defined but not used [-Wunused-function]
scene/resources/default_theme/default_theme.cpp:123:20: warning: 'Ref<Shader> make_shader(const char*, const char*, const char*)' defined but not used [-Wunused-function]
scene/resources/default_theme/default_theme.cpp:130:24: warning: 'Ref<BitmapFont> make_font(int, int, int, int, const int*, const Ref<Texture>&)' defined but not used [-Wunused-function]
```
Had to split `core/io/zip_io.h` into header and .cpp file without 'static' keyword.
Not fixed yet (static definition in header used in some files but not all):
```
modules/websocket/lws_helper.h:111:13: warning: 'void _lws_make_protocols(void*, int (*)(lws*, lws_callback_reasons, void*, void*, size_t), PoolVector<String>, _LWSRef**)' defined but not used [-Wunused-function]
```
Also fixed a couple other warnings missed in previous commits.
2018-09-28 21:57:30 +02:00
|
|
|
#include "thirdparty/misc/stb_vorbis.h"
|
2017-01-21 23:00:25 +01:00
|
|
|
|
|
|
|
class AudioStreamOGGVorbis;
|
|
|
|
|
|
|
|
class AudioStreamPlaybackOGGVorbis : public AudioStreamPlaybackResampled {
|
2019-03-19 19:35:57 +01:00
|
|
|
GDCLASS(AudioStreamPlaybackOGGVorbis, AudioStreamPlaybackResampled);
|
2017-01-21 23:00:25 +01:00
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
stb_vorbis *ogg_stream;
|
2017-01-21 23:00:25 +01:00
|
|
|
stb_vorbis_alloc ogg_alloc;
|
|
|
|
uint32_t frames_mixed;
|
|
|
|
bool active;
|
|
|
|
int loops;
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
friend class AudioStreamOGGVorbis;
|
2017-01-21 23:00:25 +01:00
|
|
|
|
|
|
|
Ref<AudioStreamOGGVorbis> vorbis_stream;
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
protected:
|
|
|
|
virtual void _mix_internal(AudioFrame *p_buffer, int p_frames);
|
2017-01-21 23:00:25 +01:00
|
|
|
virtual float get_stream_sampling_rate();
|
|
|
|
|
|
|
|
public:
|
2017-03-05 16:44:50 +01:00
|
|
|
virtual void start(float p_from_pos = 0.0);
|
2017-01-21 23:00:25 +01:00
|
|
|
virtual void stop();
|
|
|
|
virtual bool is_playing() const;
|
|
|
|
|
|
|
|
virtual int get_loop_count() const; //times it looped
|
|
|
|
|
2017-09-21 05:31:36 +02:00
|
|
|
virtual float get_playback_position() const;
|
|
|
|
virtual void seek(float p_time);
|
2017-01-21 23:00:25 +01:00
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
AudioStreamPlaybackOGGVorbis() {}
|
2017-01-21 23:00:25 +01:00
|
|
|
~AudioStreamPlaybackOGGVorbis();
|
|
|
|
};
|
|
|
|
|
|
|
|
class AudioStreamOGGVorbis : public AudioStream {
|
2019-03-19 19:35:57 +01:00
|
|
|
GDCLASS(AudioStreamOGGVorbis, AudioStream);
|
2020-01-26 11:24:14 +01:00
|
|
|
OBJ_SAVE_TYPE(AudioStream); // Saves derived classes with common type so they can be interchanged.
|
2017-06-16 00:44:11 +02:00
|
|
|
RES_BASE_EXTENSION("oggstr");
|
2017-01-21 23:00:25 +01:00
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
friend class AudioStreamPlaybackOGGVorbis;
|
2017-01-21 23:00:25 +01:00
|
|
|
|
|
|
|
void *data;
|
|
|
|
uint32_t data_len;
|
|
|
|
|
|
|
|
int decode_mem_size;
|
|
|
|
float sample_rate;
|
|
|
|
int channels;
|
|
|
|
float length;
|
2017-02-03 12:55:29 +01:00
|
|
|
bool loop;
|
2017-11-20 14:11:08 +01:00
|
|
|
float loop_offset;
|
2017-12-31 17:47:37 +01:00
|
|
|
void clear_data();
|
2017-01-21 23:00:25 +01:00
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
protected:
|
2017-02-03 12:55:29 +01:00
|
|
|
static void _bind_methods();
|
2017-01-21 23:00:25 +01:00
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
public:
|
2017-02-03 12:55:29 +01:00
|
|
|
void set_loop(bool p_enable);
|
|
|
|
bool has_loop() const;
|
2017-01-21 23:00:25 +01:00
|
|
|
|
2017-11-20 14:11:08 +01:00
|
|
|
void set_loop_offset(float p_seconds);
|
|
|
|
float get_loop_offset() const;
|
2017-08-22 16:47:24 +02:00
|
|
|
|
2017-01-21 23:00:25 +01:00
|
|
|
virtual Ref<AudioStreamPlayback> instance_playback();
|
|
|
|
virtual String get_stream_name() const;
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
void set_data(const PoolVector<uint8_t> &p_data);
|
2017-02-03 12:55:29 +01:00
|
|
|
PoolVector<uint8_t> get_data() const;
|
2017-01-21 23:00:25 +01:00
|
|
|
|
2018-01-22 20:35:33 +01:00
|
|
|
virtual float get_length() const; //if supported, otherwise return 0
|
|
|
|
|
2017-01-21 23:00:25 +01:00
|
|
|
AudioStreamOGGVorbis();
|
2017-12-31 17:47:37 +01:00
|
|
|
virtual ~AudioStreamOGGVorbis();
|
2017-01-21 23:00:25 +01:00
|
|
|
};
|
|
|
|
|
2022-07-25 12:33:41 +02:00
|
|
|
#endif // AUDIO_STREAM_OGG_VORBIS_H
|