mirror of
https://github.com/godotengine/godot
synced 2024-07-08 19:05:48 +00:00
43b78cd2ad
This PR adds 3 types of audio streams used for interactive music support. * AudioStreamInteractive: Allows setting several sub-streams and transition between them with many options. * AudioStreamPlaylist: Allows sequential or shuffled playback of a list of streams. * AudioStreamSynchronized: Allows synchronous playback of several streams, the volume of each can be controlled. Theese three stream types can be combined to create complex, layered interactive music and transitions between them, similar to software such as WWise.
120 lines
4.6 KiB
C++
120 lines
4.6 KiB
C++
/**************************************************************************/
|
|
/* audio_stream_synchronized.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. */
|
|
/**************************************************************************/
|
|
|
|
#ifndef AUDIO_STREAM_SYNCHRONIZED_H
|
|
#define AUDIO_STREAM_SYNCHRONIZED_H
|
|
|
|
#include "servers/audio/audio_stream.h"
|
|
|
|
class AudioStreamPlaybackSynchronized;
|
|
|
|
class AudioStreamSynchronized : public AudioStream {
|
|
GDCLASS(AudioStreamSynchronized, AudioStream)
|
|
OBJ_SAVE_TYPE(AudioStream)
|
|
|
|
private:
|
|
friend class AudioStreamPlaybackSynchronized;
|
|
|
|
enum {
|
|
MAX_STREAMS = 32
|
|
};
|
|
|
|
int stream_count = 0;
|
|
Ref<AudioStream> audio_streams[MAX_STREAMS];
|
|
float audio_stream_volume_db[MAX_STREAMS] = {};
|
|
HashSet<AudioStreamPlaybackSynchronized *> playbacks;
|
|
|
|
public:
|
|
virtual double get_bpm() const override;
|
|
virtual int get_beat_count() const override;
|
|
virtual bool has_loop() const override;
|
|
void set_stream_count(int p_count);
|
|
int get_stream_count() const;
|
|
void set_sync_stream(int p_stream_index, Ref<AudioStream> p_stream);
|
|
Ref<AudioStream> get_sync_stream(int p_stream_index) const;
|
|
void set_sync_stream_volume(int p_stream_index, float p_db);
|
|
float get_sync_stream_volume(int p_stream_index) const;
|
|
|
|
virtual Ref<AudioStreamPlayback> instantiate_playback() override;
|
|
virtual String get_stream_name() const override;
|
|
virtual double get_length() const override;
|
|
AudioStreamSynchronized();
|
|
|
|
protected:
|
|
static void _bind_methods();
|
|
void _validate_property(PropertyInfo &property) const;
|
|
};
|
|
|
|
///////////////////////////////////////
|
|
|
|
class AudioStreamPlaybackSynchronized : public AudioStreamPlayback {
|
|
GDCLASS(AudioStreamPlaybackSynchronized, AudioStreamPlayback)
|
|
friend class AudioStreamSynchronized;
|
|
|
|
private:
|
|
enum {
|
|
MIX_BUFFER_SIZE = 128
|
|
};
|
|
AudioFrame mix_buffer[MIX_BUFFER_SIZE];
|
|
|
|
Ref<AudioStreamSynchronized> stream;
|
|
Ref<AudioStreamPlayback> playback[AudioStreamSynchronized::MAX_STREAMS];
|
|
|
|
int play_order[AudioStreamSynchronized::MAX_STREAMS];
|
|
|
|
double stream_todo = 0.0;
|
|
int fade_index = -1;
|
|
double fade_volume = 1.0;
|
|
int play_index = 0;
|
|
double offset = 0.0;
|
|
|
|
int loop_count = 0;
|
|
|
|
bool active = false;
|
|
|
|
void _update_playback_instances();
|
|
|
|
public:
|
|
virtual void start(double p_from_pos = 0.0) override;
|
|
virtual void stop() override;
|
|
virtual bool is_playing() const override;
|
|
virtual int get_loop_count() const override; // times it looped
|
|
virtual double get_playback_position() const override;
|
|
virtual void seek(double p_time) override;
|
|
virtual int mix(AudioFrame *p_buffer, float p_rate_scale, int p_frames) override;
|
|
|
|
virtual void tag_used_streams() override;
|
|
|
|
AudioStreamPlaybackSynchronized();
|
|
~AudioStreamPlaybackSynchronized();
|
|
};
|
|
|
|
#endif // AUDIO_STREAM_SYNCHRONIZED_H
|