godot/servers/audio/audio_stream.h

224 lines
7.4 KiB
C++
Raw Normal View History

2014-02-10 02:10:30 +01:00
/*************************************************************************/
/* audio_stream.h */
/*************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
2014-02-10 02:10:30 +01:00
/*************************************************************************/
/* Copyright (c) 2007-2021 Juan Linietsky, Ariel Manzur. */
/* Copyright (c) 2014-2021 Godot Engine contributors (cf. AUTHORS.md). */
2014-02-10 02:10:30 +01: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. */
/*************************************************************************/
2014-02-10 02:10:30 +01:00
#ifndef AUDIO_STREAM_H
#define AUDIO_STREAM_H
#include "core/io/image.h"
#include "core/io/resource.h"
#include "servers/audio/audio_filter_sw.h"
2014-02-10 02:10:30 +01:00
#include "servers/audio_server.h"
#include "core/object/gdvirtual.gen.inc"
#include "core/object/script_language.h"
#include "core/variant/native_ptr.h"
2021-06-04 18:03:15 +02:00
class AudioStreamPlayback : public RefCounted {
GDCLASS(AudioStreamPlayback, RefCounted);
2014-02-10 02:10:30 +01:00
protected:
static void _bind_methods();
GDVIRTUAL1(_start, float)
GDVIRTUAL0(_stop)
GDVIRTUAL0RC(bool, _is_playing)
GDVIRTUAL0RC(int, _get_loop_count)
GDVIRTUAL0RC(float, _get_playback_position)
GDVIRTUAL1(_seek, float)
GDVIRTUAL3R(int, _mix, GDNativePtr<AudioFrame>, float, int)
public:
virtual void start(float p_from_pos = 0.0);
virtual void stop();
virtual bool is_playing() const;
2014-02-10 02:10:30 +01:00
virtual int get_loop_count() const; //times it looped
2014-02-10 02:10:30 +01:00
virtual float get_playback_position() const;
virtual void seek(float p_time);
virtual int mix(AudioFrame *p_buffer, float p_rate_scale, int p_frames);
2014-02-10 02:10:30 +01:00
};
class AudioStreamPlaybackResampled : public AudioStreamPlayback {
GDCLASS(AudioStreamPlaybackResampled, AudioStreamPlayback);
enum {
FP_BITS = 16, //fixed point used for resampling
FP_LEN = (1 << FP_BITS),
FP_MASK = FP_LEN - 1,
INTERNAL_BUFFER_LEN = 256,
CUBIC_INTERP_HISTORY = 4
};
AudioFrame internal_buffer[INTERNAL_BUFFER_LEN + CUBIC_INTERP_HISTORY];
unsigned int internal_buffer_end = -1;
uint64_t mix_offset;
protected:
void _begin_resample();
// Returns the number of frames that were mixed.
virtual int _mix_internal(AudioFrame *p_buffer, int p_frames) = 0;
virtual float get_stream_sampling_rate() = 0;
public:
virtual int mix(AudioFrame *p_buffer, float p_rate_scale, int p_frames) override;
AudioStreamPlaybackResampled() { mix_offset = 0; }
};
class AudioStream : public Resource {
GDCLASS(AudioStream, Resource);
OBJ_SAVE_TYPE(AudioStream); // Saves derived classes with common type so they can be interchanged.
2018-01-22 20:35:33 +01:00
protected:
static void _bind_methods();
GDVIRTUAL0RC(Ref<AudioStreamPlayback>, _instance_playback)
GDVIRTUAL0RC(String, _get_stream_name)
GDVIRTUAL0RC(float, _get_length)
GDVIRTUAL0RC(bool, _is_monophonic)
public:
virtual Ref<AudioStreamPlayback> instance_playback();
virtual String get_stream_name() const;
2018-01-22 20:35:33 +01:00
virtual float get_length() const;
virtual bool is_monophonic() const;
};
2014-02-10 02:10:30 +01:00
2018-02-27 08:54:56 +01:00
// Microphone
class AudioStreamPlaybackMicrophone;
class AudioStreamMicrophone : public AudioStream {
GDCLASS(AudioStreamMicrophone, AudioStream);
2018-02-27 08:54:56 +01:00
friend class AudioStreamPlaybackMicrophone;
Set<AudioStreamPlaybackMicrophone *> playbacks;
protected:
static void _bind_methods();
public:
2020-07-10 12:34:39 +02:00
virtual Ref<AudioStreamPlayback> instance_playback() override;
virtual String get_stream_name() const override;
2018-02-27 08:54:56 +01:00
2020-07-10 12:34:39 +02:00
virtual float get_length() const override; //if supported, otherwise return 0
2018-02-27 08:54:56 +01:00
virtual bool is_monophonic() const override;
2018-02-27 08:54:56 +01:00
AudioStreamMicrophone();
};
class AudioStreamPlaybackMicrophone : public AudioStreamPlaybackResampled {
2019-06-26 15:08:25 +02:00
GDCLASS(AudioStreamPlaybackMicrophone, AudioStreamPlaybackResampled);
2018-02-27 08:54:56 +01:00
friend class AudioStreamMicrophone;
bool active;
unsigned int input_ofs;
2018-02-27 08:54:56 +01:00
Ref<AudioStreamMicrophone> microphone;
protected:
virtual int _mix_internal(AudioFrame *p_buffer, int p_frames) override;
2020-07-10 12:34:39 +02:00
virtual float get_stream_sampling_rate() override;
2018-02-27 08:54:56 +01:00
public:
virtual int mix(AudioFrame *p_buffer, float p_rate_scale, int p_frames) override;
2018-02-27 08:54:56 +01:00
2020-07-10 12:34:39 +02:00
virtual void start(float p_from_pos = 0.0) override;
virtual void stop() override;
virtual bool is_playing() const override;
2018-02-27 08:54:56 +01:00
2020-07-10 12:34:39 +02:00
virtual int get_loop_count() const override; //times it looped
2018-02-27 08:54:56 +01:00
2020-07-10 12:34:39 +02:00
virtual float get_playback_position() const override;
virtual void seek(float p_time) override;
2018-02-27 08:54:56 +01:00
~AudioStreamPlaybackMicrophone();
AudioStreamPlaybackMicrophone();
};
//
class AudioStreamPlaybackRandomPitch;
class AudioStreamRandomPitch : public AudioStream {
GDCLASS(AudioStreamRandomPitch, AudioStream);
friend class AudioStreamPlaybackRandomPitch;
Set<AudioStreamPlaybackRandomPitch *> playbacks;
Ref<AudioStream> audio_stream;
float random_pitch;
protected:
static void _bind_methods();
public:
void set_audio_stream(const Ref<AudioStream> &p_audio_stream);
Ref<AudioStream> get_audio_stream() const;
void set_random_pitch(float p_pitch);
float get_random_pitch() const;
2020-07-10 12:34:39 +02:00
virtual Ref<AudioStreamPlayback> instance_playback() override;
virtual String get_stream_name() const override;
2020-07-10 12:34:39 +02:00
virtual float get_length() const override; //if supported, otherwise return 0
virtual bool is_monophonic() const override;
2018-01-22 20:35:33 +01:00
AudioStreamRandomPitch();
};
class AudioStreamPlaybackRandomPitch : public AudioStreamPlayback {
GDCLASS(AudioStreamPlaybackRandomPitch, AudioStreamPlayback);
friend class AudioStreamRandomPitch;
Ref<AudioStreamRandomPitch> random_pitch;
Ref<AudioStreamPlayback> playback;
Ref<AudioStreamPlayback> playing;
float pitch_scale;
public:
2020-07-10 12:34:39 +02:00
virtual void start(float p_from_pos = 0.0) override;
virtual void stop() override;
virtual bool is_playing() const override;
2020-07-10 12:34:39 +02:00
virtual int get_loop_count() const override; //times it looped
2020-07-10 12:34:39 +02:00
virtual float get_playback_position() const override;
virtual void seek(float p_time) override;
virtual int mix(AudioFrame *p_buffer, float p_rate_scale, int p_frames) override;
~AudioStreamPlaybackRandomPitch();
};
2014-02-10 02:10:30 +01:00
#endif // AUDIO_STREAM_H