_plugin_info_generator_priv_8h

Wwise SDK 2024.1.0

 /*******************************************************************************
 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.
  
   Copyright (c) 2024 Audiokinetic Inc.
 *******************************************************************************/
 #pragma once
  
 #include "PluginInfoGenerator.h"
  
 #ifdef __cplusplus
  
 namespace AK::Wwise::Plugin::V1
 {
     /**
      * \brief Assign arguments for the FrontendModel service request
      * \param[in,out] io_pluginInfo PluginInfo structure to assign the argument instance to
      * \param[in] in_args Pointer to a global argument structure for HostFrontendModel
      * \sa
      * - AK::Wwise::Plugin::FrontendModel
      */
     inline void AssignFrontendModelArgs(
         AK::Wwise::Plugin::PluginInfo& io_pluginInfo,
         ak_wwise_plugin_host_frontend_model_args_v1* in_args)
     {
         for (size_t i = 0; i < io_pluginInfo.m_arraySize; ++i)
         {
             if (auto& intf = io_pluginInfo.m_interfaces[i];
                 intf.m_interface->m_interface == AK_WWISE_PLUGIN_INTERFACE_TYPE_HOST_FRONTEND_MODEL &&
                 intf.m_interface->m_version == 1)
             {
                 intf.m_instance = in_args;
                 break;
             }
         }
     }
 } // of namespace AK::Wwise::Plugin
  
 /**
  * \brief (C++) Adds a Wwise Authoring frontend plug-in and a Sound Engine plug-in to a plug-in container.
  * 
  * Creates a custom namespace with custom plug-in info, that contains the generated plug-in info structure. Then,
  * statically points it to the next pointer for the container.
  * 
  * This uses the Sound Engine part to retrieve the plug-in information (Company id, Plug-in ID and Plug-in Type). It
  * also adds up the Sound Engine's registration structure, so the host can initialize this part on first instantiation.
  * 
  * This uses the Frontend Model to build and manage the lifetime of the plug-in frontend's widgets.
  *  
  * \param ContainerName Container name.
  * \param WwiseClassName Class name of the plug-in to add to the container.
  * \param AudioEngineRegisteredName Sound Engine's class name.
  * \param TemplateName Frontend Model's template name of the plug-in.
  * 
  */
 #define AK_ADD_FRONTEND_PLUGIN_CLASS_TO_CONTAINER(ContainerName, WwiseClassName, AudioEngineRegisteredName, TemplateName) \
     extern AK::PluginRegistration AudioEngineRegisteredName ## Registration; \
     namespace { namespace AK_PLUGIN_USERGENERATEDPLUGININFO_NAMESPACE_NAME { \
         static struct UserGeneratedPluginInfo : private AK::Wwise::Plugin::PluginInfoGenerator<WwiseClassName> \
         { \
             ak_wwise_plugin_host_frontend_model_args_v1 frontend_args; \
             UserGeneratedPluginInfo() : \
                 PluginInfoGenerator(&AudioEngineRegisteredName ## Registration) \
             { \
                 m_pluginInfo.m_next = GetPluginContainer ## ContainerName()->m_pluginInfos; \
                 frontend_args.templateName = TemplateName; \
                 AK::Wwise::Plugin::V1::AssignFrontendModelArgs(m_pluginInfo, &frontend_args); \
                 GetPluginContainer ## ContainerName()->m_pluginInfos = &m_pluginInfo; \
             } \
         } g_singleton; \
     } }
  
 /**
  * \brief (C++) Adds a Wwise Authoring frontend plug-in to a plug-in container.
  * 
  * Creates a custom namespace with custom plug-in info, that contains the generated plug-in info structure. Then,
  * statically points it to the next pointer for the container.
  * 
  * \param ContainerName Container name.
  * \param WwiseClassName Class name of the plug-in to add to the container.
  * \param CompanyID Plug-in vendor's Company ID, as provided by Audiokinetic.
  * \param PluginID Plug-in ID, as provided by Audiokinetic.
  * \param Type Plug-in type.
  * \param TemplateName Frontend Model's template name of the plug-in.
  * 
  * This uses the Frontend Model to build and manage the lifetime of the plug-in frontend's widgets.
  */
 #define AK_ADD_FRONTEND_PLUGIN_CLASSID_TO_CONTAINER(ContainerName, WwiseClassName, CompanyID, PluginID, Type, TemplateName) \
     namespace { namespace AK_PLUGIN_USERGENERATEDPLUGININFO_NAMESPACE_NAME { \
         static struct UserGeneratedPluginInfo : private AK::Wwise::Plugin::PluginInfoGenerator<WwiseClassName> \
         { \
             const AkUInt32 m_companyID = CompanyID; \
             const AkUInt32 m_pluginID = PluginID; \
             const AkPluginType m_type = Type; \
             ak_wwise_plugin_host_frontend_model_args_v1 frontend_args; \
             UserGeneratedPluginInfo() : \
                 PluginInfoGenerator(&m_companyID, &m_pluginID, &m_type) \
             { \
                 m_pluginInfo.m_next = GetPluginContainer ## ContainerName()->m_pluginInfos; \
                 frontend_args.templateName = TemplateName; \
                 AK::Wwise::Plugin::V1::AssignFrontendModelArgs(m_pluginInfo, &frontend_args); \
                 GetPluginContainer ## ContainerName()->m_pluginInfos = &m_pluginInfo; \
             } \
         } g_singleton; \
     } }
  
 #endif // __cplusplus