/*
  Copyright (c) 2024 Alex Diener
  
  This software is provided 'as-is', without any express or implied
  warranty. In no event will the authors be held liable for any damages
  arising from the use of this software.
  
  Permission is granted to anyone to use this software for any purpose,
  including commercial applications, and to alter it and redistribute it
  freely, subject to the following restrictions:
  
  1. The origin of this software must not be misrepresented; you must not
     claim that you wrote the original software. If you use this software
     in a product, an acknowledgment in the product documentation would be
     appreciated but is not required.
  2. Altered source versions must be plainly marked as such, and must not be
     misrepresented as being the original software.
  3. This notice may not be removed or altered from any source distribution.
  
  Alex Diener alex@ludobloom.com
*/

#ifndef __AudioSequenceStream_H__
#define __AudioSequenceStream_H__

typedef struct AudioSequenceStream AudioSequenceStream;
#define AudioSequenceStream_superclass LoopRampAudioStream

#include "audioplayer/LoopRampAudioStream.h"
#include "audiosynth/AudioSequence.h"
#include "audiosynth/AudioSequenceItemCache.h"

#define AudioSequenceStream_ivars \
	LoopRampAudioStream_ivars \
	\
	unsigned int voiceCount; \
	struct AudioSequenceStream_voice * voices;

#define AudioSequenceStream_vtable(self_type) \
	LoopRampAudioStream_vtable(self_type)

stemobject_declare(AudioSequenceStream)

// audioSequence and itemCache must already be fully initialized, and must continue to exist without
// being modified for the entire lifetime of this AudioSequenceStream
AudioSequenceStream * AudioSequenceStream_create(AudioSequence * audioSequence, AudioSequenceItemCache * itemCache, AudioFrameIndex startFrameIndex, AudioFrameIndex loopFrameCount, unsigned int bytesPerSample, unsigned int channelCount, unsigned int sampleRate);
bool AudioSequenceStream_init(AudioSequenceStream * self, AudioSequence * audioSequence, AudioSequenceItemCache * itemCache, AudioFrameIndex startFrameIndex, AudioFrameIndex loopFrameCount, unsigned int bytesPerSample, unsigned int channelCount, unsigned int sampleRate);
void AudioSequenceStream_dispose(AudioSequenceStream * self);
void AudioSequenceStream_seek(AudioSequenceStream * self, AudioFrameIndex offset, int whence);
void AudioSequenceStream_writeAudioFrames(AudioSequenceStream * self, void * outBuffer, AudioFrameIndex frameCount, AudioFrameIndex * ioOutFrameIndex, float rampStartVolume, float rampEndVolume, AudioFrameIndex rampFrameCountTotal);

#endif