/*
  Copyright (c) 2013 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 adiener@sacredsoftware.net
*/

#ifndef __PCMAudio_H__
#define __PCMAudio_H__

#include "stemobject/StemObject.h"
#include <stdbool.h>
#include <stdint.h>
#include <stdlib.h>

typedef struct PCMAudio PCMAudio;
#define PCMAudio_superclass StemObject

typedef uint64_t AudioFrameIndex;
#define AUDIOFRAMEINDEX_MAX UINT64_MAX

#define PCMAudio_ivars \
	StemObject_ivars \
	\
	unsigned int bytesPerSample; \
	unsigned int channelCount; \
	unsigned int sampleRate; \
	AudioFrameIndex frameCount; \
	void * samples;

#define PCMAudio_vtable(self_type) \
	StemObject_vtable(self_type)

stemobject_declare(PCMAudio)

// If copySamples is false, PCMAudio takes ownership of the samples pointer and the caller must not free it.
// If copySamples is true, the caller retains ownership of the samples pointer and must free it.
PCMAudio * PCMAudio_create(unsigned int bytesPerSample,
                           unsigned int channelCount,
                           unsigned int sampleRate,
                           AudioFrameIndex frameCount,
                           void * samples,
                           bool copySamples);
bool PCMAudio_init(PCMAudio * self,
                   unsigned int bytesPerSample,
                   unsigned int channelCount,
                   unsigned int sampleRate,
                   AudioFrameIndex frameCount,
                   void * samples,
                   bool copySamples);
PCMAudio * PCMAudio_copy(PCMAudio * self);
void PCMAudio_initCopy(PCMAudio * self, PCMAudio * original);
bool PCMAudio_isEqual(PCMAudio * self, PCMAudio * compare);
void PCMAudio_dispose(PCMAudio * self);

#endif