diff options
Diffstat (limited to 'Source/Sound/soundtrack.h')
| -rw-r--r-- | Source/Sound/soundtrack.h | 350 |
1 files changed, 350 insertions, 0 deletions
diff --git a/Source/Sound/soundtrack.h b/Source/Sound/soundtrack.h new file mode 100644 index 00000000..7a8f2c33 --- /dev/null +++ b/Source/Sound/soundtrack.h @@ -0,0 +1,350 @@ +//----------------------------------------------------------------------------- +// Name: soundtrack.h +// Developer: Wolfire Games LLC +// Description: +// License: Read below +//----------------------------------------------------------------------------- +// +// Copyright 2022 Wolfire Games LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +//----------------------------------------------------------------------------- +#pragma once + +#include <Sound/al_audio.h> +#include <Sound/Loader/base_loader.h> +#include <Sound/high_res_buffer_segment.h> +#include <Sound/AudioFilters/transition_mixer.h> +#include <Sound/AudioFilters/limiter_audio_filter.h> + +#include <XML/Parsers/musicxmlparser.h> +#include <Sound/buffer_segment.h> + +#include <Internal/filesystem.h> +#include <Internal/referencecounter.h> + +#include <map> +#include <set> +#include <deque> + +class Soundtrack; + +extern bool g_sound_enable_layered_soundtrack_limiter; + +class PlayedInterface +{ +public: + PlayedInterface( Soundtrack* _owner ); + virtual ~PlayedInterface() {}; + virtual void update( HighResBufferSegment* buffer ) = 0; + + virtual int64_t GetPCMPos() = 0; + virtual void SetPCMPos( int64_t pos ) = 0; + virtual int64_t GetPCMCount() = 0; + + virtual int SampleRate() = 0; + virtual int Channels() = 0; + +protected: + Soundtrack* owner; +}; + +class PlayedSongInterface : public PlayedInterface +{ +public: + PlayedSongInterface( Soundtrack* _owner ); + PlayedSongInterface( Soundtrack* _owner, const MusicXMLParser::Song& song); + virtual ~PlayedSongInterface() {}; + + virtual void Rewind() = 0; + virtual bool IsAtEnd() = 0; + + virtual void SetGain(float v) = 0; + virtual float GetGain() = 0; + + const std::string GetSongName() const; + const std::string GetSongType() const; + const MusicXMLParser::Song& GetSong() const; + +protected: + MusicXMLParser::Song song; +}; + +typedef ReferenceCounter<PlayedSongInterface> rc_PlayedSongInterface; + +class Soundtrack : public audioStreamer +{ +private: + + class PlayedSegment : public PlayedInterface + { + public: + PlayedSegment( Soundtrack* _owner ); + PlayedSegment( Soundtrack* _owner, const MusicXMLParser::Segment& segment, bool overlapped_transition ); + virtual ~PlayedSegment() {}; + void update( HighResBufferSegment* buffer ); + const MusicXMLParser::Segment& GetSegment(); + bool IsAtEnd(); + void Rewind(); + + int64_t GetPCMPos(); + void SetPCMPos( int64_t pos ); + int64_t GetPCMCount(); + + int SampleRate(); + int Channels(); + + const std::string GetSegmentName() const; + private: + rc_baseLoader data; + MusicXMLParser::Segment segment; + public: + bool overlapped_transition; + bool started; + }; + + class PlayedSegmentedSong : public PlayedSongInterface + { + public: + PlayedSegmentedSong( Soundtrack* _owner, const MusicXMLParser::Song& _song ); + virtual ~PlayedSegmentedSong( ); + void update( HighResBufferSegment* buffer ); + bool QueueSegment( const MusicXMLParser::Segment& nextSeg ); + bool TransitionIntoSegment( const MusicXMLParser::Segment& newSeg ); + bool SetSegment( const MusicXMLParser::Segment& nextSeg ); + + bool IsAtEnd(); + void Rewind(); + int SampleRate(); + int Channels(); + + void SetGain(float v); + float GetGain(); + + const std::string GetSegmentName() const; + + void SetPCMPos( int64_t c ); + int64_t GetPCMPos(); + int64_t GetPCMCount(); + + friend bool operator==( const Soundtrack::PlayedSegmentedSong &lhs, const Soundtrack::PlayedSegmentedSong &rhs ); + private: + PlayedSegment currentSegment; + + std::deque<PlayedSegment> segmentQueue; + + TransitionMixer mixer; + }; + + class PlayedSingleSong : public PlayedSongInterface + { + public: + PlayedSingleSong( Soundtrack* _owner ); + PlayedSingleSong( Soundtrack* _owner, const MusicXMLParser::Song& song ); + virtual ~PlayedSingleSong() {}; + void update( HighResBufferSegment* buffer ); + bool IsAtEnd(); + void Rewind(); + + int64_t GetPCMPos(); + void SetPCMPos( int64_t pos ); + int64_t GetPCMCount(); + + void SetGain(float v); + float GetGain(); + + int SampleRate(); + int Channels(); + private: + rc_baseLoader data; + public: + bool started; + + int current_volume_step; + float volume_change_per_second; + + float target_gain; + float from_gain; + float current_gain; + }; + + class PlayedLayeredSong : public PlayedSongInterface + { + public: + PlayedLayeredSong( Soundtrack* _owner ); + PlayedLayeredSong( Soundtrack* _owner, const MusicXMLParser::Song& song ); + virtual ~PlayedLayeredSong(); + void update( HighResBufferSegment* buffer ); + bool IsAtEnd(); + void Rewind(); + + int64_t GetPCMPos(); + void SetPCMPos( int64_t pos ); + int64_t GetPCMCount(); + + void SetGain(float v); + float GetGain(); + + int SampleRate(); + int Channels(); + + //Specialized + bool SetLayerGain(const std::string& name, float gain); + float GetLayerGain(const std::string& name); + std::vector<std::string> GetLayerNames() const; + const std::map<std::string,float> GetLayerGains(); + private: + std::vector<rc_PlayedSongInterface> subsongs; + + int64_t pcm_count; + int64_t pcm_pos; + int sample_rate; + int channels; + bool started; + }; + + class TransitionPlayer : public PlayedInterface + { + public: + TransitionPlayer(Soundtrack* _owner); + virtual ~TransitionPlayer(); + + void update( HighResBufferSegment* buffer ); + void SetTransitionPeriod( float sec ); + + bool TransitionToSong( const MusicXMLParser::Song& nextSong ); + bool SetSong( const MusicXMLParser::Song& nextSong ); + + bool QueueSegment( const std::string& segment_name ); + bool TransitionIntoSegment( const std::string& segment_name ); + bool SetSegment( const std::string& segment_name ); + const std::string GetSegmentName( ) const; + + bool SetLayerGain( const std::string& layer, float gain ); + float GetLayerGain( const std::string& layer ); + std::vector<std::string> GetLayerNames() const; + const std::map<std::string,float> GetLayerGains(); + + void SetPCMPos( int64_t c ); + int64_t GetPCMPos(); + int64_t GetPCMCount(); + + virtual int SampleRate(); + virtual int Channels(); + + const std::string GetSongName() const; + const std::string GetSongType() const; + + const std::string GetNextSongName() const; + const std::string GetNextSongType() const; + + private: + std::map<std::string, int64_t> stored_pcm_pos; + bool playing; + TransitionMixer mixer; + + rc_PlayedSongInterface currentSong; + + std::deque<rc_PlayedSongInterface> songQueue; + }; + + friend bool operator==( const Soundtrack::PlayedSegmentedSong &lhs, const Soundtrack::PlayedSegmentedSong &rhs ); + friend bool operator!=( const Soundtrack::PlayedSegmentedSong &lhs, const Soundtrack::PlayedSegmentedSong &rhs ); + + std::map<std::string,MusicXMLParser::Music> music; + + LimiterAudioFilter limiter; + TransitionPlayer transitionPlayer; + + int current_volume_step; + float volume_change_per_second; + + float volume_start; + float volume_target; + + void PostProcessVolume(HighResBufferSegment* buffer); +public: + + void Dispose(); + + //Audiostreamer API + /// Request to fill a buffer with data + virtual void update(rc_alAudioBuffer buffer); + + /// Return the number of buffers this streaming class requires (usually 2) + virtual unsigned long required_buffers(); + + /// Stop the current stream (reset to empty) + virtual void Stop(); + + //AudioEmitter API + // + /// Set to false to allow the emitter to time out (useful only on non-looping sounds) + virtual bool KeepPlaying(); + /// if true is returned, this will be a relative-to-listener sound + virtual bool GetPosition(vec3 &p); + virtual void GetDirection(vec3 &p); + virtual const vec3& GetVelocity(); + virtual const vec3 GetPosition(); + virtual const vec3 GetOcclusionPosition(); + + /// Indicate the priority of this effect to make room for newer/higher priority effects + virtual unsigned char GetPriority(); + + virtual void SetVolume(float vol); + + virtual bool IsTransient(); + +public: //Control API + Soundtrack( float volume ); + + virtual ~Soundtrack(); + + void AddMusic( const Path& file ); + void RemoveMusic( const Path& file ); + + //Set what segment to play after current is finished + bool QueueSegment( const std::string& name ); + bool TransitionIntoSegment( const std::string& name ); + //Abruptly change segment + bool SetSegment( const std::string& name ); + + const std::string GetSegment( ) const; + const std::map<std::string,float> GetLayerGains(); + + const std::vector<std::string> GetLayerNames() const; + const std::string GetSongName() const; + const std::string GetSongType() const; + const std::string GetNextSongName() const; + const std::string GetNextSongType() const; + const MusicXMLParser::Song GetSong(const std::string& name); + + //Make a soft transition to a different song. + bool TransitionToSong( const std::string& name ); + //Abruptly change song. + bool SetSong( const std::string& name ); + + void SetLayerGain(const std::string& layer, float v); +}; + + +inline bool operator==( const Soundtrack::PlayedSegmentedSong &lhs, const Soundtrack::PlayedSegmentedSong &rhs ) +{ + return lhs.song == rhs.song; +} + +inline bool operator!=( const Soundtrack::PlayedSegmentedSong &lhs, const Soundtrack::PlayedSegmentedSong &rhs ) +{ + return !(lhs == rhs); +} |