_ak_mixer_input_map_8h

Wwise SDK 2019.2.15

 /*******************************************************************************

 The content of this file includes portions of the AUDIOKINETIC Wwise Technology

 released in source code form as part of the SDK installer package.

 Commercial License Usage

 Licensees holding valid commercial licenses to the AUDIOKINETIC Wwise Technology

 may use this file in accordance with the end user license agreement provided 

 with the software or, alternatively, in accordance with the terms contained in a

 written agreement between you and Audiokinetic Inc.

 Apache License Usage

 Alternatively, this file may be used under the Apache License, Version 2.0 (the 

 "Apache License"); you may not use this file except in compliance with the 

 Apache License. You may obtain a copy of the Apache License at 

 http://www.apache.org/licenses/LICENSE-2.0.

 Unless required by applicable law or agreed to in writing, software distributed

 under the Apache License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES

 OR CONDITIONS OF ANY KIND, either express or implied. See the Apache License for

 the specific language governing permissions and limitations under the License.

   Version: <VERSION>  Build: <BUILDNUMBER>

   Copyright (c) <COPYRIGHTYEAR> Audiokinetic Inc.

 *******************************************************************************/

 #ifndef _AK_MIXERINPUTMAP_H_

 #define _AK_MIXERINPUTMAP_H_

 #include <AK/SoundEngine/Common/AkTypes.h>

 #include <AK/SoundEngine/Common/IAkPluginMemAlloc.h>

 #include <AK/Tools/Common/AkArray.h>

 #include <AK/SoundEngine/Common/IAkPlugin.h>

 /// Collection class to manage inputs in mixer plugins.

 /// The inputs are identified by their context AK::IAkMixerInputContext. The type of data attached to it is the template argument USER_DATA.

 /// The collection performs allocation/deallocation of user data via AK_PLUGIN_NEW/DELETE().

 /// Usage

 /// 

 /// // Init 

 /// AkMixerInputMap<MyStruct> m_mapInputs;

 /// m_mapInputs.Init( in_pAllocator );  // in_pAllocator passed at plugin init.

 ///

 /// // Add an input.

 /// m_mapInputs.AddInput( in_pInput );  // AK::IAkMixerInputContext * in_pInput passed to OnInputConnected()

 /// 

 /// // Find an input

 /// MyStruct * pInput = m_mapInputs.Exists( in_pInputContext ); // AK::IAkMixerInputContext * in_pInputContext passed to ConsumeInput()

 ///

 /// // Iterate through inputs.

 /// AkMixerInputMap<MyStruct>::Iterator it = m_mapInputs.End();

 /// while ( it != m_mapInputs.End() )

 /// {

 ///     MyStruct * pInput = (*it).pUserData;

 ///     ...

 ///     ++it;

 /// }

 /// Structure of an entry in the AkMixerInputMap map.

 template <class USER_DATA>

 struct AkInputMapSlot

 {

     AK::IAkMixerInputContext *  pContext;

     USER_DATA *                 pUserData;  /// User data. Here we have a buffer. Other relevant info would be the game object position and input parameters of the previous frame.

     AkInputMapSlot() : pContext( NULL ), pUserData( NULL ) {}

     bool operator ==(const AkInputMapSlot& in_Op) const { return ( pContext == in_Op.pContext ); }

 };

 /// Allocator for plugin-friendly arrays.

 /// TODO Replace by a sorted array.

 class AkPluginArrayAllocator

 {

 public:

     AkForceInline AkPluginArrayAllocator() : m_pAllocator( NULL ) {}

     AkForceInline void Init( AK::IAkPluginMemAlloc * in_pAllocator ) { m_pAllocator = in_pAllocator; }

 protected:

     AkForceInline void * Alloc( size_t in_uSize ) { AKASSERT( m_pAllocator || !"Allocator not set. Did you forget to call AkMixerInputMap::Init()?" ); return AK_PLUGIN_ALLOC( m_pAllocator, in_uSize ); }

     AkForceInline void * ReAlloc(void * in_pCurrent, size_t in_uOldSize, size_t in_uNewSize)

     {

         void* pNew = Alloc(in_uNewSize);

         if (pNew && in_pCurrent)

         {

             AKPLATFORM::AkMemCpy(pNew, in_pCurrent, (AkUInt32)in_uOldSize);

             Free(in_pCurrent);

         }

         return pNew;

     }

     AkForceInline void Free( void * in_pAddress ) { AKASSERT( m_pAllocator || !"Allocator not set. Did you forget to call AkMixerInputMap::Init()?" ); AK_PLUGIN_FREE( m_pAllocator, in_pAddress ); }

     AkForceInline AK::IAkPluginMemAlloc * GetAllocator() { return m_pAllocator; }

 private:

     AK::IAkPluginMemAlloc *     m_pAllocator;

 };

 /// AkMixerInputMap: Map of inputs (identified with AK::IAkMixerInputContext *) to user-defined blocks of data.

 template <class USER_DATA>

 class AkMixerInputMap : public AkArray<AkInputMapSlot<USER_DATA>, const AkInputMapSlot<USER_DATA>&, AkPluginArrayAllocator>

 {

 public:

     typedef AkArray<AkInputMapSlot<USER_DATA>, const AkInputMapSlot<USER_DATA>&, AkPluginArrayAllocator> BaseClass;

     /// Returns the user data associated with given input context. Returns NULL if none found.

     USER_DATA * Exists( AK::IAkMixerInputContext * in_pInput )

     {

         typename AkArray<AkInputMapSlot<USER_DATA>, const AkInputMapSlot<USER_DATA>&, AkPluginArrayAllocator>::Iterator it = FindEx( in_pInput );

         return ( it != BaseClass::End() ) ? (*it).pUserData : NULL;

     }

     /// Adds an input with new user data.

     USER_DATA * AddInput( AK::IAkMixerInputContext * in_pInput )

     {

         typename AkArray<AkInputMapSlot<USER_DATA>, const AkInputMapSlot<USER_DATA>&, AkPluginArrayAllocator>::Iterator it = FindEx( in_pInput );

         if ( it != BaseClass::End() )

             return (*it).pUserData;

         else

         {

             AkInputMapSlot<USER_DATA> * pSlot = AkArray<AkInputMapSlot<USER_DATA>, const AkInputMapSlot<USER_DATA>&, AkPluginArrayAllocator>::AddLast();

             if ( pSlot )

             {

                 pSlot->pUserData = AK_PLUGIN_NEW( AkPluginArrayAllocator::GetAllocator(), USER_DATA );

                 if ( pSlot->pUserData )

                 {

                     pSlot->pContext = in_pInput;

                     return pSlot->pUserData;

                 }

                 BaseClass::RemoveLast();

             }

         }

         return NULL;

     }

     /// Removes an input and destroys its associated user data.

     bool RemoveInput( AK::IAkMixerInputContext * in_pInput )

     {

         typename AkArray<AkInputMapSlot<USER_DATA>, const AkInputMapSlot<USER_DATA>&, AkPluginArrayAllocator>::Iterator it = FindEx( in_pInput );

         if ( it != BaseClass::End() )

         {

             AKASSERT( (*it).pUserData );

             AK_PLUGIN_DELETE( AkPluginArrayAllocator::GetAllocator(), (*it).pUserData );

             BaseClass::EraseSwap( it );

             return true;

         }

         return false;

     }

     /// Terminate array.

     void Term()

     {

         if ( BaseClass::m_pItems )

         {

             RemoveAll();

             AkPluginArrayAllocator::Free( BaseClass::m_pItems );

             BaseClass::m_pItems = 0;

             BaseClass::m_ulReserved = 0;

         }

     }

     /// Finds an item in the array.

     typename AkArray<AkInputMapSlot<USER_DATA>, const AkInputMapSlot<USER_DATA>&, AkPluginArrayAllocator>::Iterator FindEx( AK::IAkMixerInputContext * in_pInput ) const

     {

         AkInputMapSlot<USER_DATA> mapSlot;

         mapSlot.pContext = in_pInput;

         return BaseClass::FindEx( mapSlot );

     }

     /// Removes and destroys all items in the array.

     void RemoveAll()

     {

         for ( typename AkArray<AkInputMapSlot<USER_DATA>, const AkInputMapSlot<USER_DATA>&, AkPluginArrayAllocator>::Iterator it = BaseClass::Begin(), itEnd = BaseClass::End(); it != itEnd; ++it )

         {

             AKASSERT( (*it).pUserData );

             AK_PLUGIN_DELETE( AkPluginArrayAllocator::GetAllocator(), (*it).pUserData );

             (*it).~AkInputMapSlot();

         }

         BaseClass::m_uLength = 0;

     }

 };

 #endif // _AK_MIXERINPUTMAP_H_

AK_PLUGIN_DELETE

AkForceInline void AK_PLUGIN_DELETE(AK::IAkPluginMemAlloc *in_pAllocator, T *in_pObject)

Definition: IAkPluginMemAlloc.h:162

AkPluginArrayAllocator::Alloc

AkForceInline void * Alloc(size_t in_uSize)

Definition: AkMixerInputMap.h:80

AkPluginArrayAllocator::GetAllocator

AkForceInline AK::IAkPluginMemAlloc * GetAllocator()

Definition: AkMixerInputMap.h:93

AK::IAkMixerInputContext

Interface to retrieve information about an input of a mixer.

Definition: IAkPlugin.h:758

AkMixerInputMap::RemoveInput

bool RemoveInput(AK::IAkMixerInputContext *in_pInput)

Removes an input and destroys its associated user data.

Definition: AkMixerInputMap.h:136

AK_PLUGIN_NEW

#define AK_PLUGIN_NEW(_allocator, _what)

Definition: IAkPluginMemAlloc.h:133

AkArray

Specific implementation of array.

Definition: AkArray.h:202

NULL

#define NULL

Definition: AkTypes.h:49

AkPluginArrayAllocator::ReAlloc

AkForceInline void * ReAlloc(void *in_pCurrent, size_t in_uOldSize, size_t in_uNewSize)

Definition: AkMixerInputMap.h:81

AkMixerInputMap::Exists

USER_DATA * Exists(AK::IAkMixerInputContext *in_pInput)

Returns the user data associated with given input context. Returns NULL if none found.

Definition: AkMixerInputMap.h:106

AkMixerInputMap::AddInput

USER_DATA * AddInput(AK::IAkMixerInputContext *in_pInput)

Adds an input with new user data.

Definition: AkMixerInputMap.h:113

AkPluginArrayAllocator::Init

AkForceInline void Init(AK::IAkPluginMemAlloc *in_pAllocator)

Definition: AkMixerInputMap.h:78

AK::IAkPluginMemAlloc

Definition: IAkPluginMemAlloc.h:48

AkArray< AkInputMapSlot< USER_DATA >, const AkInputMapSlot< USER_DATA > &, AkPluginArrayAllocator >::RemoveLast

void RemoveLast()

Removes the last item from the array.

Definition: AkArray.h:511

AkMixerInputMap::Term

void Term()

Terminate array.

Definition: AkMixerInputMap.h:150

AkInputMapSlot::pContext

AK::IAkMixerInputContext * pContext

Definition: AkMixerInputMap.h:65

AK_PLUGIN_FREE

#define AK_PLUGIN_FREE(_allocator, _pvmem)

Definition: IAkPluginMemAlloc.h:177

AkMixerInputMap::FindEx

AkArray< AkInputMapSlot< USER_DATA >, const AkInputMapSlot< USER_DATA > &, AkPluginArrayAllocator >::Iterator FindEx(AK::IAkMixerInputContext *in_pInput) const

Finds an item in the array.

Definition: AkMixerInputMap.h:162

AKPLATFORM::AkMemCpy

AkForceInline void AkMemCpy(void *pDest, const void *pSrc, AkUInt32 uSize)

Platform Independent Helper.

Definition: AkPlatformFuncs.h:333

AkInputMapSlot

Structure of an entry in the AkMixerInputMap map.

Definition: AkMixerInputMap.h:64

AKASSERT

#define AKASSERT(Condition)

Definition: AkAssert.h:76