godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/servers/audio_server.h

288 lines
10 KiB
C++
Raw Normal View History

GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
/*************************************************************************/
/* audio_server.h */
/*************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* http://www.godotengine.org */
/*************************************************************************/
Welcome in 2017, dear changelog reader! That year should bring the long-awaited OpenGL ES 3.0 compatible renderer with state-of-the-art rendering techniques tuned to work as low as middle end handheld devices - without compromising with the possibilities given for higher end desktop games of course. Great times ahead for the Godot community and the gamers that will play our games! (cherry picked from commit c7bc44d5ad9aae4902280012f7654e2318cd910e)
2017-01-01 21:01:57 +00:00
/* Copyright (c) 2007-2017 Juan Linietsky, Ariel Manzur. */
Add "Godot Engine contributors" copyright line
2017-04-07 22:45:00 +00:00
/* Copyright (c) 2014-2017 Godot Engine contributors (cf. AUTHORS.md) */
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
/* */
/* 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_SERVER_H
#define AUDIO_SERVER_H
#include "object.h"
Bring that Whole New World to the Old Continent too Applies the clang-format style to the 2.1 branch as done for master in 5dbf1809c6e3e905b94b8764e99491e608122261.
2017-03-18 23:36:26 +00:00
#include "variant.h"
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
class AudioMixer {
protected:
void audio_mixer_chunk_call(int p_frames);
Bring that Whole New World to the Old Continent too Applies the clang-format style to the 2.1 branch as done for master in 5dbf1809c6e3e905b94b8764e99491e608122261.
2017-03-18 23:36:26 +00:00
public:
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
enum {
Bring that Whole New World to the Old Continent too Applies the clang-format style to the 2.1 branch as done for master in 5dbf1809c6e3e905b94b8764e99491e608122261.
2017-03-18 23:36:26 +00:00
INVALID_CHANNEL = 0xFFFFFFFF
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
};
typedef uint32_t ChannelID;
/* CHANNEL API */
enum FilterType {
FILTER_NONE,
FILTER_LOWPASS,
FILTER_BANDPASS,
FILTER_HIPASS,
FILTER_NOTCH,
FILTER_PEAK,
FILTER_BANDLIMIT, ///< cutoff is LP resonace is HP
FILTER_LOW_SHELF,
FILTER_HIGH_SHELF
};
enum ReverbRoomType {
REVERB_SMALL,
REVERB_MEDIUM,
REVERB_LARGE,
Fix some warnings
2016-07-25 13:31:57 +00:00
REVERB_HALL,
MAX_REVERBS
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
};
Bring that Whole New World to the Old Continent too Applies the clang-format style to the 2.1 branch as done for master in 5dbf1809c6e3e905b94b8764e99491e608122261.
2017-03-18 23:36:26 +00:00
virtual ChannelID channel_alloc(RID p_sample) = 0;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Bring that Whole New World to the Old Continent too Applies the clang-format style to the 2.1 branch as done for master in 5dbf1809c6e3e905b94b8764e99491e608122261.
2017-03-18 23:36:26 +00:00
virtual void channel_set_volume(ChannelID p_channel, float p_gain) = 0;
virtual void channel_set_pan(ChannelID p_channel, float p_pan, float p_depth = 0, float height = 0) = 0; //pan and depth go from -1 to 1
virtual void channel_set_filter(ChannelID p_channel, FilterType p_type, float p_cutoff, float p_resonance, float p_gain = 1.0) = 0;
virtual void channel_set_chorus(ChannelID p_channel, float p_chorus) = 0;
virtual void channel_set_reverb(ChannelID p_channel, ReverbRoomType p_room_type, float p_reverb) = 0;
virtual void channel_set_mix_rate(ChannelID p_channel, int p_mix_rate) = 0;
virtual void channel_set_positional(ChannelID p_channel, bool p_positional) = 0;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Bring that Whole New World to the Old Continent too Applies the clang-format style to the 2.1 branch as done for master in 5dbf1809c6e3e905b94b8764e99491e608122261.
2017-03-18 23:36:26 +00:00
virtual float channel_get_volume(ChannelID p_channel) const = 0;
virtual float channel_get_pan(ChannelID p_channel) const = 0; //pan and depth go from -1 to 1
virtual float channel_get_pan_depth(ChannelID p_channel) const = 0; //pan and depth go from -1 to 1
virtual float channel_get_pan_height(ChannelID p_channel) const = 0; //pan and depth go from -1 to 1
virtual FilterType channel_get_filter_type(ChannelID p_channel) const = 0;
virtual float channel_get_filter_cutoff(ChannelID p_channel) const = 0;
virtual float channel_get_filter_resonance(ChannelID p_channel) const = 0;
virtual float channel_get_filter_gain(ChannelID p_channel) const = 0;
virtual float channel_get_chorus(ChannelID p_channel) const = 0;
virtual ReverbRoomType channel_get_reverb_type(ChannelID p_channel) const = 0;
virtual float channel_get_reverb(ChannelID p_channel) const = 0;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Bring that Whole New World to the Old Continent too Applies the clang-format style to the 2.1 branch as done for master in 5dbf1809c6e3e905b94b8764e99491e608122261.
2017-03-18 23:36:26 +00:00
virtual int channel_get_mix_rate(ChannelID p_channel) const = 0;
virtual bool channel_is_positional(ChannelID p_channel) const = 0;
virtual bool channel_is_valid(ChannelID p_channel) const = 0;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Bring that Whole New World to the Old Continent too Applies the clang-format style to the 2.1 branch as done for master in 5dbf1809c6e3e905b94b8764e99491e608122261.
2017-03-18 23:36:26 +00:00
virtual void channel_free(ChannelID p_channel) = 0;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Bring that Whole New World to the Old Continent too Applies the clang-format style to the 2.1 branch as done for master in 5dbf1809c6e3e905b94b8764e99491e608122261.
2017-03-18 23:36:26 +00:00
virtual void set_mixer_volume(float p_volume) = 0;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
virtual ~AudioMixer() {}
};
class AudioServer : public Object {
Bring that Whole New World to the Old Continent too Applies the clang-format style to the 2.1 branch as done for master in 5dbf1809c6e3e905b94b8764e99491e608122261.
2017-03-18 23:36:26 +00:00
OBJ_TYPE(AudioServer, Object);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
static AudioServer *singleton;
Bring that Whole New World to the Old Continent too Applies the clang-format style to the 2.1 branch as done for master in 5dbf1809c6e3e905b94b8764e99491e608122261.
2017-03-18 23:36:26 +00:00
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
protected:
Bring that Whole New World to the Old Continent too Applies the clang-format style to the 2.1 branch as done for master in 5dbf1809c6e3e905b94b8764e99491e608122261.
2017-03-18 23:36:26 +00:00
friend class AudioStream;
friend class EventStream;
friend class AudioMixer;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Bring that Whole New World to the Old Continent too Applies the clang-format style to the 2.1 branch as done for master in 5dbf1809c6e3e905b94b8764e99491e608122261.
2017-03-18 23:36:26 +00:00
virtual AudioMixer *get_mixer() = 0;
virtual void audio_mixer_chunk_callback(int p_frames) = 0;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
static void _bind_methods();
Bring that Whole New World to the Old Continent too Applies the clang-format style to the 2.1 branch as done for master in 5dbf1809c6e3e905b94b8764e99491e608122261.
2017-03-18 23:36:26 +00:00
public:
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
class EventStream {
protected:
AudioMixer *get_mixer() const;
Bring that Whole New World to the Old Continent too Applies the clang-format style to the 2.1 branch as done for master in 5dbf1809c6e3e905b94b8764e99491e608122261.
2017-03-18 23:36:26 +00:00
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
public:
Bring that Whole New World to the Old Continent too Applies the clang-format style to the 2.1 branch as done for master in 5dbf1809c6e3e905b94b8764e99491e608122261.
2017-03-18 23:36:26 +00:00
virtual void update(uint64_t p_usec) = 0;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
virtual ~EventStream() {}
};
class AudioStream {
public:
Bring that Whole New World to the Old Continent too Applies the clang-format style to the 2.1 branch as done for master in 5dbf1809c6e3e905b94b8764e99491e608122261.
2017-03-18 23:36:26 +00:00
virtual int get_channel_count() const = 0;
virtual void set_mix_rate(int p_rate) = 0; //notify the stream of the mix rate
virtual bool mix(int32_t *p_buffer, int p_frames) = 0;
virtual void update() = 0;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
virtual bool can_update_mt() const { return true; }
virtual ~AudioStream() {}
};
enum SampleFormat {
SAMPLE_FORMAT_PCM8,
SAMPLE_FORMAT_PCM16,
SAMPLE_FORMAT_IMA_ADPCM
};
enum SampleLoopFormat {
SAMPLE_LOOP_NONE,
SAMPLE_LOOP_FORWARD,
SAMPLE_LOOP_PING_PONG // not supported in every platform
};
/* SAMPLE API */
Bring that Whole New World to the Old Continent too Applies the clang-format style to the 2.1 branch as done for master in 5dbf1809c6e3e905b94b8764e99491e608122261.
2017-03-18 23:36:26 +00:00
virtual RID sample_create(SampleFormat p_format, bool p_stereo, int p_length) = 0;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Bring that Whole New World to the Old Continent too Applies the clang-format style to the 2.1 branch as done for master in 5dbf1809c6e3e905b94b8764e99491e608122261.
2017-03-18 23:36:26 +00:00
virtual void sample_set_description(RID p_sample, const String &p_description) = 0;
virtual String sample_get_description(RID p_sample) const = 0;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Bring that Whole New World to the Old Continent too Applies the clang-format style to the 2.1 branch as done for master in 5dbf1809c6e3e905b94b8764e99491e608122261.
2017-03-18 23:36:26 +00:00
virtual SampleFormat sample_get_format(RID p_sample) const = 0;
virtual bool sample_is_stereo(RID p_sample) const = 0;
virtual int sample_get_length(RID p_sample) const = 0;
virtual const void *sample_get_data_ptr(RID p_sample) const = 0;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Bring that Whole New World to the Old Continent too Applies the clang-format style to the 2.1 branch as done for master in 5dbf1809c6e3e905b94b8764e99491e608122261.
2017-03-18 23:36:26 +00:00
virtual void sample_set_signed_data(RID p_sample, const DVector<float> &p_buffer);
virtual void sample_set_data(RID p_sample, const DVector<uint8_t> &p_buffer) = 0;
virtual DVector<uint8_t> sample_get_data(RID p_sample) const = 0;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Bring that Whole New World to the Old Continent too Applies the clang-format style to the 2.1 branch as done for master in 5dbf1809c6e3e905b94b8764e99491e608122261.
2017-03-18 23:36:26 +00:00
virtual void sample_set_mix_rate(RID p_sample, int p_rate) = 0;
virtual int sample_get_mix_rate(RID p_sample) const = 0;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Bring that Whole New World to the Old Continent too Applies the clang-format style to the 2.1 branch as done for master in 5dbf1809c6e3e905b94b8764e99491e608122261.
2017-03-18 23:36:26 +00:00
virtual void sample_set_loop_format(RID p_sample, SampleLoopFormat p_format) = 0;
virtual SampleLoopFormat sample_get_loop_format(RID p_sample) const = 0;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Bring that Whole New World to the Old Continent too Applies the clang-format style to the 2.1 branch as done for master in 5dbf1809c6e3e905b94b8764e99491e608122261.
2017-03-18 23:36:26 +00:00
virtual void sample_set_loop_begin(RID p_sample, int p_pos) = 0;
virtual int sample_get_loop_begin(RID p_sample) const = 0;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Bring that Whole New World to the Old Continent too Applies the clang-format style to the 2.1 branch as done for master in 5dbf1809c6e3e905b94b8764e99491e608122261.
2017-03-18 23:36:26 +00:00
virtual void sample_set_loop_end(RID p_sample, int p_pos) = 0;
virtual int sample_get_loop_end(RID p_sample) const = 0;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
/* VOICE API */
enum FilterType {
FILTER_NONE,
FILTER_LOWPASS,
FILTER_BANDPASS,
FILTER_HIPASS,
FILTER_NOTCH,
FILTER_PEAK,
FILTER_BANDLIMIT, ///< cutoff is LP resonace is HP
FILTER_LOW_SHELF,
FILTER_HIGH_SHELF
};
enum ReverbRoomType {
REVERB_SMALL,
REVERB_MEDIUM,
REVERB_LARGE,
REVERB_HALL
};
Bring that Whole New World to the Old Continent too Applies the clang-format style to the 2.1 branch as done for master in 5dbf1809c6e3e905b94b8764e99491e608122261.
2017-03-18 23:36:26 +00:00
virtual RID voice_create() = 0;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Bring that Whole New World to the Old Continent too Applies the clang-format style to the 2.1 branch as done for master in 5dbf1809c6e3e905b94b8764e99491e608122261.
2017-03-18 23:36:26 +00:00
virtual void voice_play(RID p_voice, RID p_sample) = 0;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Bring that Whole New World to the Old Continent too Applies the clang-format style to the 2.1 branch as done for master in 5dbf1809c6e3e905b94b8764e99491e608122261.
2017-03-18 23:36:26 +00:00
virtual void voice_set_volume(RID p_voice, float p_volume) = 0;
virtual void voice_set_pan(RID p_voice, float p_pan, float p_depth = 0, float height = 0) = 0; //pan and depth go from -1 to 1
virtual void voice_set_filter(RID p_voice, FilterType p_type, float p_cutoff, float p_resonance, float p_gain = 0) = 0;
virtual void voice_set_chorus(RID p_voice, float p_chorus) = 0;
virtual void voice_set_reverb(RID p_voice, ReverbRoomType p_room_type, float p_reverb) = 0;
virtual void voice_set_mix_rate(RID p_voice, int p_mix_rate) = 0;
virtual void voice_set_positional(RID p_voice, bool p_positional) = 0;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Bring that Whole New World to the Old Continent too Applies the clang-format style to the 2.1 branch as done for master in 5dbf1809c6e3e905b94b8764e99491e608122261.
2017-03-18 23:36:26 +00:00
virtual float voice_get_volume(RID p_voice) const = 0;
virtual float voice_get_pan(RID p_voice) const = 0; //pan and depth go from -1 to 1
virtual float voice_get_pan_depth(RID p_voice) const = 0; //pan and depth go from -1 to 1
virtual float voice_get_pan_height(RID p_voice) const = 0; //pan and depth go from -1 to 1
virtual FilterType voice_get_filter_type(RID p_voice) const = 0;
virtual float voice_get_filter_cutoff(RID p_voice) const = 0;
virtual float voice_get_filter_resonance(RID p_voice) const = 0;
virtual float voice_get_chorus(RID p_voice) const = 0;
virtual ReverbRoomType voice_get_reverb_type(RID p_voice) const = 0;
virtual float voice_get_reverb(RID p_voice) const = 0;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Bring that Whole New World to the Old Continent too Applies the clang-format style to the 2.1 branch as done for master in 5dbf1809c6e3e905b94b8764e99491e608122261.
2017-03-18 23:36:26 +00:00
virtual int voice_get_mix_rate(RID p_voice) const = 0;
virtual bool voice_is_positional(RID p_voice) const = 0;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Bring that Whole New World to the Old Continent too Applies the clang-format style to the 2.1 branch as done for master in 5dbf1809c6e3e905b94b8764e99491e608122261.
2017-03-18 23:36:26 +00:00
virtual void voice_stop(RID p_voice) = 0;
virtual bool voice_is_active(RID p_voice) const = 0;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
/* STREAM API */
Bring that Whole New World to the Old Continent too Applies the clang-format style to the 2.1 branch as done for master in 5dbf1809c6e3e905b94b8764e99491e608122261.
2017-03-18 23:36:26 +00:00
virtual RID audio_stream_create(AudioStream *p_stream) = 0;
virtual RID event_stream_create(EventStream *p_stream) = 0;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Bring that Whole New World to the Old Continent too Applies the clang-format style to the 2.1 branch as done for master in 5dbf1809c6e3e905b94b8764e99491e608122261.
2017-03-18 23:36:26 +00:00
virtual void stream_set_active(RID p_stream, bool p_active) = 0;
virtual bool stream_is_active(RID p_stream) const = 0;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Bring that Whole New World to the Old Continent too Applies the clang-format style to the 2.1 branch as done for master in 5dbf1809c6e3e905b94b8764e99491e608122261.
2017-03-18 23:36:26 +00:00
virtual void stream_set_volume_scale(RID p_stream, float p_scale) = 0;
virtual float stream_set_volume_scale(RID p_stream) const = 0;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
/* Audio Physics API */
Bring that Whole New World to the Old Continent too Applies the clang-format style to the 2.1 branch as done for master in 5dbf1809c6e3e905b94b8764e99491e608122261.
2017-03-18 23:36:26 +00:00
virtual void free(RID p_id) = 0;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Bring that Whole New World to the Old Continent too Applies the clang-format style to the 2.1 branch as done for master in 5dbf1809c6e3e905b94b8764e99491e608122261.
2017-03-18 23:36:26 +00:00
virtual void init() = 0;
virtual void finish() = 0;
virtual void update() = 0;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
/* MISC config */
Bring that Whole New World to the Old Continent too Applies the clang-format style to the 2.1 branch as done for master in 5dbf1809c6e3e905b94b8764e99491e608122261.
2017-03-18 23:36:26 +00:00
virtual void lock() = 0;
virtual void unlock() = 0;
virtual int get_default_channel_count() const = 0;
virtual int get_default_mix_rate() const = 0;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Bring that Whole New World to the Old Continent too Applies the clang-format style to the 2.1 branch as done for master in 5dbf1809c6e3e905b94b8764e99491e608122261.
2017-03-18 23:36:26 +00:00
virtual void set_stream_global_volume_scale(float p_volume) = 0;
virtual void set_fx_global_volume_scale(float p_volume) = 0;
virtual void set_event_voice_global_volume_scale(float p_volume) = 0;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Bring that Whole New World to the Old Continent too Applies the clang-format style to the 2.1 branch as done for master in 5dbf1809c6e3e905b94b8764e99491e608122261.
2017-03-18 23:36:26 +00:00
virtual float get_stream_global_volume_scale() const = 0;
virtual float get_fx_global_volume_scale() const = 0;
virtual float get_event_voice_global_volume_scale() const = 0;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Bring that Whole New World to the Old Continent too Applies the clang-format style to the 2.1 branch as done for master in 5dbf1809c6e3e905b94b8764e99491e608122261.
2017-03-18 23:36:26 +00:00
virtual uint32_t read_output_peak() const = 0;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
static AudioServer *get_singleton();
Bring that Whole New World to the Old Continent too Applies the clang-format style to the 2.1 branch as done for master in 5dbf1809c6e3e905b94b8764e99491e608122261.
2017-03-18 23:36:26 +00:00
virtual double get_mix_time() const = 0; //useful for video -> audio sync
virtual double get_output_delay() const = 0;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
AudioServer();
virtual ~AudioServer();
};
Bring that Whole New World to the Old Continent too Applies the clang-format style to the 2.1 branch as done for master in 5dbf1809c6e3e905b94b8764e99491e608122261.
2017-03-18 23:36:26 +00:00
VARIANT_ENUM_CAST(AudioServer::SampleFormat);
VARIANT_ENUM_CAST(AudioServer::SampleLoopFormat);
VARIANT_ENUM_CAST(AudioServer::FilterType);
VARIANT_ENUM_CAST(AudioServer::ReverbRoomType);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
typedef AudioServer AS;
#endif // AUDIO_SERVER_H