Files
o3de/Gems/AudioSystem/Code/Include/Engine/AudioAllocators.h
T
Eric Phister 0a68f23ee0 Allocators for audio system file cache (#1485)
* Reinstates an allocator for FileCacheManager

Replaces the allocator that was removed during redcode that is used for
loading banks.  Default schema for now to get things working again.

* Update path functions to AZ::IO::Path

Removes old PathUtil functions in favor of AZ::IO::Path apis.

* Update the audio allocator classes

Cleans up the audio allocator classes a bit.

* Addresses PR feedback

Updates some code to handle nullptr a bit better, and improve log
messages.

* Updates to audio CVars and address feedback

Per feedback, converted more of the audio cvars to AZ_CVAR, but not all
of them could be converted at this time.  Moved audio allocator
initialization to system component ctor/dtor to give RAII.  Updated
location of a PAL file.

* Updates the copyright of the file added in this PR

Merged copyright changes, so need to update new files.
2021-06-23 16:57:48 -05:00

90 lines
2.9 KiB
C++

/*
* Copyright (c) Contributors to the Open 3D Engine Project
*
* SPDX-License-Identifier: Apache-2.0 OR MIT
*
*/
#pragma once
#include <AzCore/Debug/Trace.h>
#include <AzCore/Memory/SystemAllocator.h>
#define AUDIO_MEMORY_ALIGNMENT AZCORE_GLOBAL_NEW_ALIGNMENT
namespace Audio
{
///////////////////////////////////////////////////////////////////////////////////////////////
class AudioSystemAllocator final
: public AZ::SystemAllocator
{
public:
AZ_TYPE_INFO(AudioSystemAllocator, "{AE15F55D-BD65-4666-B18B-9ED81999A85B}");
///////////////////////////////////////////////////////////////////////////////////////////
// IAllocator
const char* GetName() const override
{
return "AudioSystemAllocator";
}
const char* GetDescription() const override
{
return "Generic allocator for use in the Audio System module";
}
///////////////////////////////////////////////////////////////////////////////////////////
};
using AudioSystemStdAllocator = AZ::AZStdAlloc<AZ::SystemAllocator>;
///////////////////////////////////////////////////////////////////////////////////////////////
class AudioImplAllocator final
: public AZ::SystemAllocator
{
public:
AZ_TYPE_INFO(AudioImplAllocator, "{197D999F-3093-4F9D-A9A0-BA9E2AAA11DC}");
///////////////////////////////////////////////////////////////////////////////////////////
// IAllocator
const char* GetName() const override
{
return "AudioImplAllocator";
}
const char* GetDescription() const override
{
return "Generic allocator for use in the Audio Engine Implementation module";
}
///////////////////////////////////////////////////////////////////////////////////////////
};
using AudioImplStdAllocator = AZ::AZStdAlloc<AZ::SystemAllocator>;
///////////////////////////////////////////////////////////////////////////////////////////////
class AudioBankAllocator final
: public AZ::SystemAllocator
{
public:
AZ_TYPE_INFO(AudioBankAllocator, "{19E89718-400F-42F9-92C3-E7F0DC1CCC1F}");
///////////////////////////////////////////////////////////////////////////////////////////
// IAllocator
const char* GetName() const override
{
return "AudioBankAllocator";
}
const char* GetDescription() const override
{
return "Generic allocator for use by the Audio File Cache Manager for sound banks";
}
///////////////////////////////////////////////////////////////////////////////////////////
};
} // namespace Audio
#define AUDIO_SYSTEM_CLASS_ALLOCATOR(type) AZ_CLASS_ALLOCATOR(type, Audio::AudioSystemAllocator, 0)
#define AUDIO_IMPL_CLASS_ALLOCATOR(type) AZ_CLASS_ALLOCATOR(type, Audio::AudioImplAllocator, 0)