d6176db271
ResourceFormatLoader and ResourceFormatSaver are meant to be overridden to add support for different formats in ResourceLoader and ResourceSaver. Those should be exposed as they can be overridden in plugins. On the other hand, all predefined subclasses of those two base classes are only meant to register support for new file and resource types, but should not and cannot be used directly from script, so they should not be exposed. Also unexposed ResourceImporterOGGVorbis (and thus its base class ResourceImporter) which are editor-only.
137 lines
4.7 KiB
C++
137 lines
4.7 KiB
C++
/*************************************************************************/
|
|
/* audio_stream_ogg_vorbis.h */
|
|
/*************************************************************************/
|
|
/* This file is part of: */
|
|
/* GODOT ENGINE */
|
|
/* https://godotengine.org */
|
|
/*************************************************************************/
|
|
/* Copyright (c) 2007-2019 Juan Linietsky, Ariel Manzur. */
|
|
/* Copyright (c) 2014-2019 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 AUDIO_STREAM_OGG_VORBIS_H
|
|
#define AUDIO_STREAM_OGG_VORBIS_H
|
|
|
|
#include "core/io/resource_loader.h"
|
|
#include "core/os/file_access.h"
|
|
#include "core/os/thread_safe.h"
|
|
#include "scene/resources/audio_stream.h"
|
|
|
|
#include <vorbis/vorbisfile.h>
|
|
|
|
class AudioStreamPlaybackOGGVorbis : public AudioStreamPlayback {
|
|
|
|
GDCLASS(AudioStreamPlaybackOGGVorbis, AudioStreamPlayback);
|
|
|
|
enum {
|
|
MIN_MIX = 1024
|
|
};
|
|
|
|
FileAccess *f;
|
|
|
|
ov_callbacks _ov_callbacks;
|
|
float length;
|
|
static size_t _ov_read_func(void *p_dst, size_t p_data, size_t p_count, void *_f);
|
|
static int _ov_seek_func(void *_f, ogg_int64_t offs, int whence);
|
|
static int _ov_close_func(void *_f);
|
|
static long _ov_tell_func(void *_f);
|
|
|
|
String file;
|
|
int64_t frames_mixed;
|
|
|
|
bool stream_loaded;
|
|
volatile bool playing;
|
|
OggVorbis_File vf;
|
|
int stream_channels;
|
|
int stream_srate;
|
|
int current_section;
|
|
|
|
bool paused;
|
|
bool loops;
|
|
int repeats;
|
|
|
|
Error _load_stream();
|
|
void _clear_stream();
|
|
void _close_file();
|
|
|
|
bool stream_valid;
|
|
float loop_restart_time;
|
|
|
|
public:
|
|
Error set_file(const String &p_file);
|
|
|
|
virtual void play(float p_from = 0);
|
|
virtual void stop();
|
|
virtual bool is_playing() const;
|
|
|
|
virtual void set_loop_restart_time(float p_time) { loop_restart_time = p_time; }
|
|
|
|
virtual void set_paused(bool p_paused);
|
|
virtual bool is_paused() const;
|
|
|
|
virtual void set_loop(bool p_enable);
|
|
virtual bool has_loop() const;
|
|
|
|
virtual float get_length() const;
|
|
|
|
virtual String get_stream_name() const;
|
|
|
|
virtual int get_loop_count() const;
|
|
|
|
virtual float get_playback_position() const;
|
|
virtual void seek(float p_time);
|
|
|
|
virtual int get_channels() const { return stream_channels; }
|
|
virtual int get_mix_rate() const { return stream_srate; }
|
|
|
|
virtual int get_minimum_buffer_size() const { return 0; }
|
|
virtual int mix(int16_t *p_buffer, int p_frames);
|
|
|
|
AudioStreamPlaybackOGGVorbis();
|
|
~AudioStreamPlaybackOGGVorbis();
|
|
};
|
|
|
|
class AudioStreamOGGVorbis : public AudioStream {
|
|
|
|
GDCLASS(AudioStreamOGGVorbis, AudioStream);
|
|
|
|
String file;
|
|
|
|
public:
|
|
Ref<AudioStreamPlayback> instance_playback() {
|
|
Ref<AudioStreamPlaybackOGGVorbis> pb = memnew(AudioStreamPlaybackOGGVorbis);
|
|
pb->set_file(file);
|
|
return pb;
|
|
}
|
|
|
|
void set_file(const String &p_file) { file = p_file; }
|
|
};
|
|
|
|
class ResourceFormatLoaderAudioStreamOGGVorbis : public ResourceFormatLoader {
|
|
public:
|
|
virtual RES load(const String &p_path, const String &p_original_path = "", Error *r_error = NULL);
|
|
virtual void get_recognized_extensions(List<String> *p_extensions) const;
|
|
virtual bool handles_type(const String &p_type) const;
|
|
virtual String get_resource_type(const String &p_path) const;
|
|
};
|
|
|
|
#endif // AUDIO_STREAM_OGG_H
|