crown-engine/engine/resource/SoundResource.h

/*
Copyright (c) 2013 Daniele Bartolini, Michele Rossi
Copyright (c) 2012 Daniele Bartolini, Simone Boscaratto

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.
*/

#pragma once

#include "Types.h"
#include "Resource.h"
#include "Bundle.h"
#include "Allocator.h"
#include "File.h"
#include "Device.h"
#include "SoundRenderer.h"

namespace crown
{

//-----------------------------------------------------------------------------
struct SoundType
{
	enum Enum
	{
		WAV = 0,
		OGG = 1
	};
};

const uint32_t SOUND_VERSION = 1;

//-----------------------------------------------------------------------------
struct SoundHeader
{
	SoundBufferId	sb;
	uint32_t		version;	// Sound file version
	uint32_t		size;
	uint32_t		sample_rate;
	uint32_t		avg_bytes_ps;
	uint32_t		channels;
	uint16_t		block_size;
	uint16_t 		bits_ps;
	uint8_t			sound_type;
};

struct SoundResource
{
public:

	//-----------------------------------------------------------------------------
	static void* load(Allocator& allocator, Bundle& bundle, ResourceId id)
	{
		File* file = bundle.open(id);
		const size_t file_size = file->size();

		void* res = allocator.allocate(file_size);
		file->read(res, file_size);

		bundle.close(file);

		return res;
	}

	//-----------------------------------------------------------------------------
	static void online(void* resource)
	{
		CE_ASSERT_NOT_NULL(resource);

		SoundResource* sr = (SoundResource*)resource;
		SoundHeader* h = (SoundHeader*) sr;

		h->sb = device()->sound_renderer()->create_sound_buffer((void*)sr->data(), sr->size(), sr->sample_rate(), sr->channels(), sr->bits_ps());
	}

	//-----------------------------------------------------------------------------
	static void unload(Allocator& allocator, void* resource)
	{
		CE_ASSERT_NOT_NULL(resource);
		allocator.deallocate(resource);
	}

	//-----------------------------------------------------------------------------
	static void offline(void* resource)
	{
		CE_ASSERT_NOT_NULL(resource);

		SoundHeader* s = (SoundHeader*) resource;
		device()->sound_renderer()->destroy_sound_buffer(s->sb);
	}

public:

	uint32_t size() const 
	{
		return ((SoundHeader*) this)->size;
	}

	uint32_t sample_rate() const
	{
		return ((SoundHeader*) this)->sample_rate;
	}

	uint32_t avg_bytes_ps() const
	{
		return ((SoundHeader*) this)->avg_bytes_ps;
	}

	uint32_t channels() const
	{
		return ((SoundHeader*) this)->channels;
	}

	uint16_t block_size() const
	{
		return ((SoundHeader*) this)->block_size;
	}

	uint16_t bits_ps() const
	{
		return ((SoundHeader*) this)->bits_ps;
	}

	uint8_t sound_type() const
	{
		return ((SoundHeader*) this)->sound_type;
	}

	const char* data() const
	{
		return ((char*) this) + sizeof(SoundHeader);
	}

	SoundBufferId sound_buffer() const
	{
		return ((SoundHeader*) this)->sb;
	}

private:

	// Disable construction
	SoundResource();
};

} // namespace crown