Version
menu_open
link
Wwise SDK 2022.1.11
IAkPlugin.h
Go to the documentation of this file.
1 /*******************************************************************************
2 The content of this file includes portions of the AUDIOKINETIC Wwise Technology
3 released in source code form as part of the SDK installer package.
4 
5 Commercial License Usage
6 
7 Licensees holding valid commercial licenses to the AUDIOKINETIC Wwise Technology
8 may use this file in accordance with the end user license agreement provided
9 with the software or, alternatively, in accordance with the terms contained in a
10 written agreement between you and Audiokinetic Inc.
11 
12 Apache License Usage
13 
14 Alternatively, this file may be used under the Apache License, Version 2.0 (the
15 "Apache License"); you may not use this file except in compliance with the
16 Apache License. You may obtain a copy of the Apache License at
17 http://www.apache.org/licenses/LICENSE-2.0.
18 
19 Unless required by applicable law or agreed to in writing, software distributed
20 under the Apache License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES
21 OR CONDITIONS OF ANY KIND, either express or implied. See the Apache License for
22 the specific language governing permissions and limitations under the License.
23 
24  Copyright (c) 2024 Audiokinetic Inc.
25 *******************************************************************************/
26 
27 /// \file
28 /// Software source plug-in and effect plug-in interfaces.
29 
30 #ifndef _IAK_PLUGIN_H_
31 #define _IAK_PLUGIN_H_
32 
37 #include <AK/Tools/Common/AkLock.h>
40 #include <AK/Tools/Common/AkRng.h>
46 #include <AK/AkWwiseSDKVersion.h>
47 
48 #include <math.h>
49 
50 #if defined AK_CPU_X86 || defined AK_CPU_X86_64 || defined (AK_CPU_WASM)
51 #include <xmmintrin.h>
52 #endif
53 
54 /// Plug-in information structure.
55 /// \remarks The bIsInPlace field is only relevant for effect plug-ins.
56 /// \sa
57 /// - \ref iakeffect_geteffectinfo
59 {
60  /// Constructor for default values
63  , uBuildVersion( 0 )
64  , bIsInPlace(true)
65  , bCanChangeRate(false)
66  , bReserved(false)
67  , bCanProcessObjects(false)
68  , bIsDeviceEffect(false)
69  , bCanRunOnObjectConfig(true)
70  , bUsesGainAttribute(false)
71  {}
72 
73  AkPluginType eType; ///< Plug-in type
74  AkUInt32 uBuildVersion; ///< Plug-in build version, must match the AK_WWISESDK_VERSION_COMBINED macro from AkWwiseSDKVersion.h. Prevents usage of plugins compiled for other versions, avoiding crashes or data issues.
75  bool bIsInPlace; ///< Buffer usage (in-place or not). If true, and the plug-in is an insert effect, it should implement IAkInPlaceEffectPlugin, otherwise it should implement IAkOutOfPlaceEffectPlugin. If it is an object processor (see CanProcessObjects, below), it should implement IAkInPlaceObjectPlugin or IAkOutOfPlaceObjectPlugin respectively.
76  bool bCanChangeRate; ///< True for effects whose sample throughput is different between input and output. Effects that can change rate need to be out-of-place (!bIsInPlace), and cannot exist on busses.
77  bool bReserved; ///< Legacy bIsAsynchronous plug-in flag, now unused. Preserved for plug-in backward compatibility. bReserved should be false for all plug-in.
78  bool bCanProcessObjects; ///< Plug-in can process audio objects. They must implement IAkInPlaceObjectPlugin or IAkOutOfPlaceObjectPlugin, depending on if they work in-place or out-of-place. Out-of-place object processors only work on busses.
79  bool bIsDeviceEffect; ///< Plug-in can process final mixes and objects right before sending them to the audio device for output. Plug-ins that process the main mix, passthrough mix and objects directly at the end of the pipeline must implement IAkAudioDeviceEffectPlugin. Audio device effect plug-ins must be in place (bIsInPlace = true) and must be able to process objects (bCanProcessObjects = true).
80  bool bCanRunOnObjectConfig; ///< Plug-in can run on bus with Audio Object configuration. Effect plug-ins are instantiated once per Audio Objects on those busses. While this may be fine for effects such as EQs, it is an user error for effects such as reverbs, or for any effect that is non-linear. Effects that return false will fail to initialize when created on busses with Audio Object Configuration.
81  bool bUsesGainAttribute; ///< Plug-in knows how to process objects separately from the cumulativeGain of the object (or the processing of the object's audio is independent of the overall object gain). bCanProcessObjects must also be true, as this relies on Object Metadata.
82 };
83 
84 //Forward declarations.
85 namespace AK
86 {
87  class PluginRegistration;
88 }
90 
91 struct AkAcousticTexture;
92 
93 namespace AK
94 {
95  class IAkStreamMgr;
96  class IAkGlobalPluginContext;
97 
98  /// Game object information available to plugins.
100  {
101  protected:
102  /// Virtual destructor on interface to avoid warnings.
104 
105  public:
106 
107  /// Get the ID of the game object.
108  virtual AkGameObjectID GetGameObjectID() const = 0;
109 
110  /// Retrieve the number of emitter-listener pairs (rays) of the game object.
111  /// A game object may have more than one position, and be listened to more than one listener.
112  /// The returned value is the product of these two numbers. Use the returned value as a higher
113  /// bound for the index of GetEmitterListenerPair().
114  /// Note that rays whose listener is irrelevant to the current context are ignored. For example,
115  /// if the calling plug-in exists on a bus, only listeners that are routed to the end point's
116  /// device are considered.
117  /// \sa
118  /// - AK::SoundEngine::SetPosition()
119  /// - AK::SoundEngine::SetMultiplePositions()
120  /// - AK::SoundEngine::SetListeners()
121  /// - AK::IAkGameObjectPluginInfo::GetEmitterListenerPair()
123 
124  /// Retrieve the emitter-listener pair (ray) of the game object at index in_uIndex.
125  /// Call GetNumEmitterListenerPairs() prior to this function to get the total number of
126  /// emitter-listener pairs of the game object.
127  /// The emitter-listener pair is expressed as the game object's position relative to the
128  /// listener, in spherical coordinates.
129  /// \note
130  /// - The distance takes game object and listener scaling factors into account.
131  /// - Returned distance and angles are those of the game object, and do not necessarily correspond
132  /// to any sound's positioning data.
133  /// \return AK_Fail if the index is invalid, AK_Success otherwise.
134  /// \sa
135  /// - AK::SoundEngine::SetScalingFactor()
136  /// - AK::IAkGameObjectPluginInfo::GetNumEmitterListenerPairs()
138  AkUInt32 in_uIndex, ///< Index of the pair, [0, GetNumEmitterListenerPairs()[
139  AkEmitterListenerPair & out_emitterListenerPair ///< Returned relative source position in spherical coordinates.
140  ) const = 0;
141 
142  /// Get the number of positions of the game object. Use this value to determine the indices to be
143  /// passed to GetGameObjectPosition().
144  /// \sa
145  /// - AK::SoundEngine::SetPosition()
146  /// - AK::SoundEngine::SetMultiplePositions()
147  /// - AK::IAkGameObjectPluginInfo::GetGameObjectPosition();
148  virtual AkUInt32 GetNumGameObjectPositions() const = 0;
149 
150  /// Get the raw position of the game object at index in_uIndex.
151  /// Use GetNumGameObjectPositions() prior to this function to get the total number of positions
152  /// of that game object.
153  /// \return AK_Fail if the index is out of bounds, AK_Success otherwise.
154  /// \sa
155  /// - AK::SoundEngine::SetPosition()
156  /// - AK::SoundEngine::SetMultiplePositions()
157  /// - AK::IAkGameObjectPluginInfo::GetNumGameObjectPositions()
159  AkUInt32 in_uIndex, ///< Index of the position, [0, GetNumGameObjectPositions()[
160  AkSoundPosition & out_position ///< Returned raw position info.
161  ) const = 0;
162 
163  /// Get the multi-position type assigned to the game object.
164  /// \return MultiPositionType_MultiSources when the effect is instantiated on a bus.
165  /// \sa
166  /// - AK::SoundEngine::SetPosition()
167  /// - AK::SoundEngine::SetMultiplePositions()
169 
170  /// Get the distance scaling factor of the associated game object.
171  /// \sa
172  /// - AK::SoundEngine::SetScalingFactor()
173  virtual AkReal32 GetGameObjectScaling() const = 0;
174 
175  /// Get the game object IDs of listener game objects that are listening to the emitter game object.
176  /// Note that only listeners relevant to the current context are considered. For example,
177  /// if the calling plug-in exists on a bus, only listeners that are routed to the end point's
178  /// device are added to the returned array.
179  /// \return True if the call succeeded, false if all the listeners could not fit into the array,
180  /// \sa
181  /// - AK::SoundEngine::SetListeners()
182  virtual bool GetListeners(
183  AkGameObjectID* out_aListenerIDs, ///< Array of listener IDs to fill, or NULL to query the size needed.
184  AkUInt32& io_uSize ///< In: max size of the array, out: number of valid elements returned in out_aListenerIDs.
185  ) const = 0;
186 
187  /// Get information about a listener. Use GetListeners() prior to this function
188  /// in order to know which listeners are listening to the associated game object.
189  /// \return AK_Fail if the listener ID is invalid. AK_Success otherwise.
190  /// \sa
191  /// - AK::SoundEngine::SetListeners()
192  /// - AK::IAkGameObjectPluginInfo::GetListeners()
194  AkGameObjectID in_uListener, ///< Bit field identifying the listener for which you desire information.
195  AkListener & out_listener ///< Returned listener info.
196  ) const = 0;
197 
198  /// Get the position of a distance probe associated with the given listener.
199  /// Use GetListeners() prior to this function
200  /// in order to know which listeners are listening to the associated game object.
201  /// Returns AK_Success if a distance probe is associated with the specified listener.
202  /// If no distance probe game object is associated with the specified listener,
203  /// or the listener is not valid, AK_Fail is returned.
204  /// - AK::SoundEngine::SetDistanceProbe()
205  /// - AK::SoundEngine::SetListeners()
206  /// - AK::IAkGameObjectPluginInfo::GetListeners()
208  AkGameObjectID in_uListener, ///< Listener Game Object
209  AkWorldTransform& out_position ///< Returned raw position info.
210  ) const = 0;
211  };
212 
213  /// Voice-specific information available to plug-ins.
215  {
216  protected:
217  /// Virtual destructor on interface to avoid warnings.
219 
220  public:
221 
222  /// Retrieve the Playing ID of the event corresponding to this voice (if applicable).
223  virtual AkPlayingID GetPlayingID() const = 0;
224 
225  /// Get priority value associated to this voice. When priority voice is modified by distance, the minimum distance among emitter-listener pairs is used.
226  /// \return The priority between AK_MIN_PRIORITY and AK_MAX_PRIORITY inclusively.
227  virtual AkPriority GetPriority() const = 0;
228 
229  /// Get priority value associated to this voice, for a specified distance, which may differ from the minimum distance that is used by default.
230  /// \return The priority between AK_MIN_PRIORITY and AK_MAX_PRIORITY inclusively.
232  AkReal32 in_fDistance ///< Distance.
233  ) const = 0;
234  };
235 
236  /// Interface to retrieve contextual information available to all types of plugins.
238  {
239  protected:
240  /// Virtual destructor on interface to avoid warnings.
242 
243  public:
244 
245  /// \return The global sound engine context.
246  /// \sa IAkGlobalPluginContext
247  virtual IAkGlobalPluginContext* GlobalContext() const = 0;
248 
249  /// Obtain the interface to access the game object on which the plugin is instantiated.
250  /// \return The interface to GameObject info, nullptr if undefined.
252 
253  /// Identify the output device into which the data processed by this plugin will end up.
254  /// Applicable to plug-ins instantiated as bus effects and to sink plugins.
255  /// Plug-ins instantiated in the Actor-Mixer hierarchy (i.e. on voices) return AK_NotCompatible.
256  /// \sa integrating_secondary_outputs
257  /// \return The device type and unique identifier. AK_Success if successful, AK_NotCompatible otherwise.
259  AkUInt32 & out_uOutputID, ///< Device identifier, when multiple devices of the same type are possible.
260  AkPluginID & out_uDevicePlugin ///< Device plugin ID.
261  ) const = 0;
262 
263  /// Return the pointer and size of the plug-in media corresponding to the specified index.
264  /// The pointer returned will be NULL if the plug-in media is either not loaded or inexistant.
265  /// When this function is called and returns a valid data pointer, the data can only be used by this
266  /// instance of the plugin and is guaranteed to be valid only during the plug-in lifespan.
267  virtual void GetPluginMedia(
268  AkUInt32 in_dataIndex, ///< Index of the plug-in media to be returned.
269  AkUInt8* &out_rpData, ///< Pointer to the data
270  AkUInt32 &out_rDataSize ///< size of the data returned in bytes.
271  ) = 0;
272 
273  /// Return the pointer and size of the game data corresponding to the specified index, sent by the game using AK::SoundEngine::SendPluginCustomGameData().
274  /// The pointer returned will be NULL if the game data is inexistent.
275  /// When this function is called and returns a valid data pointer, the data can only be used by this
276  /// instance of the plugin and is guaranteed to be valid only during the frame.
277  virtual void GetPluginCustomGameData(
278  void* &out_rpData, ///< Pointer to the data
279  AkUInt32 &out_rDataSize ///< size of the data returned in bytes.
280  ) = 0;
281 
282  /// Post a custom blob of data to the UI counterpart of this plug-in.
283  /// Data is sent asynchronously through the profiling system.
284  /// Notes:
285  /// - You may call CanPostMonitorData() to determine if your plug-in can send data to the UI.
286  /// - Data is copied into the communication buffer within this method,
287  /// so you may discard it afterwards.
288  /// - Sending data to the UI is only possible in Debug and Profile. Thus, you should
289  /// enclose your calls to package and send that data within !AK_OPTIMIZED preprocessor flag.
290  /// \return AK_Success if the plug-in exists on a bus, AK_Fail otherwise.
292  void * in_pData, ///< Blob of data.
293  AkUInt32 in_uDataSize ///< Size of data.
294  ) = 0;
295 
296  /// Query the context to know if it is possible to send data to the UI counterpart of this plug-in.
297  /// \return True if the authoring tool is connected and monitoring the game, false otherwise.
298  /// \sa PostMonitorData()
299  virtual bool CanPostMonitorData() = 0;
300 
301  /// Post a monitoring message or error string. This will be displayed in the Wwise capture
302  /// log.
303  /// \return AK_Success if successful, AK_Fail if there was a problem posting the message.
304  /// In optimized mode, this function returns AK_NotCompatible.
305  /// \remark This function is provided as a tracking tool only. It does nothing if it is
306  /// called in the optimized/release configuration and return AK_NotCompatible.
308  const char* in_pszError, ///< Message or error string to be displayed
309  AK::Monitor::ErrorLevel in_eErrorLevel ///< Specifies whether it should be displayed as a message or an error
310  ) = 0;
311 
312  /// Get the cumulative gain of all mixing stages, from the host audio node down to the device end point.
313  /// Returns 1.f when the node is an actor-mixer (voice), because a voice may be routed to several mix chains.
314  /// \return The cumulative downstream gain.
316 
317  /// Return the channel configuration of the parent node that this plug-in will mix into. GetParentChannelConfig() may be used to set the output configuration of an
318  /// out-of-place effect to avoid additional up/down mixing stages. Please note however that it is possible for out-of-place effects later in the chain to change
319  /// this configuration.
320  /// Returns not out_channelConfig.IsValid() when the node is an actor-mixer (voice), because a voice may be routed to several mix chains.
321  /// \return AK_Success if the channel config of the primary, direct parent bus could be determined, AK_Fail otherwise.
323  AkChannelConfig& out_channelConfig ///< Channel configuration of parent node (downstream bus).
324  ) const = 0;
325 
326  /// Return an interface to query processor specific features.
328 
329  /// Get internal ID of hosting sound structure (actor-mixer of bus).
330  /// In the case of a voice, the ID is internal but corresponds to what you would get from the duration
331  /// callback (see AkDurationCallbackInfo::audioNodeID). In the case of a bus, it can be matched with the bus name converted
332  /// to a unique ID using AK::SoundEngine::GetIDFromString().
333  /// In the case if an audio device (sink), it is AK_INVALID_UNIQUE_ID.
334  /// \return ID of input.
335  /// \sa
336  /// - AkDurationCallbackInfo
337  /// - AK::SoundEngine::PostEvent()
338  /// - AK::SoundEngine::GetIDFromString()
339  virtual AkUniqueID GetAudioNodeID() const = 0;
340 
341  /// Get the expected input of the audio device (sink) at the end of the bus pipeline from the caller's perspective.
342  /// When called from a bus, the bus hierarchy is traversed upward until the master bus is reached. The audio device connected to this master bus is the sink consulted.
343  /// When called from a source, the source's output bus is the starting point of the traversal.
344  /// When called from a sink, that sink is consulted.
345  /// \return AK_Success if the bus hierarchy traversal was successful and a sink was found, AK_Fail otherwise.
347  AkChannelConfig& out_sinkConfig, // The channel config of the sink; if set to "Objects", then the sink is in 3D audio mode. Any other config means 3D audio is not active.
348  Ak3DAudioSinkCapabilities& out_3dAudioCaps // When out_sinkConfig is set to Objects, inspect this struct to learn which 3D audio features are supported by the sink
349  ) const = 0;
350  };
351 
352  /// Interface to retrieve contextual information for an effect plug-in.
353  /// \sa
354  /// - \ref iakmonadiceffect_init
356  {
357  protected:
358  /// Virtual destructor on interface to avoid warnings.
360 
361  public:
362 
363  /// Determine whether the effect is to be used in Send Mode or not.
364  /// Effects used in auxiliary busses are always used in Send Mode.
365  /// \return True if the effect is in Send Mode, False otherwise
366  virtual bool IsSendModeEffect() const = 0;
367 
368  /// Obtain the interface to access the voice in which the plugin is inserted.
369  /// \return The interface to voice info. NULL if the plugin is instantiated on a bus.
371 
372  /// Obtain the interface to access services available on busses.
373  /// \return The interface to mixing context if the plugin is instantiated on a bus. NULL if it is instantiated on a voice.
375 
376  /// \name For object processors:
377  /// Output object management.
378  //@{
379 
380  /// Create new objects on the output side. Only out-of-place object processors (plugins implementing AK::IAkOutOfPlaceObjectPlugin) may create output objects.
381  /// If successful, the newly constructed objects will be available in out_ppBuffer/out_ppObjects.
382  /// To obtain all the output objects in a single array after having created objects using this function, use GetOutputObjects, or wait for the next call to AK::IAkOutOfPlaceObjectPlugin::Execute
383  /// where output objects are passed via the in_pObjectBuffersOut/in_pObjectsOut arguments.
384  /// Object processors inform the host that an output object may be disposed of by setting its state to AK_NoMoreData from within AK::IAkOutOfPlaceObjectPlugin::Execute.
385  /// \aknote You should never store the pointers returned by out_ppBuffer/out_ppObjects, as the location of pointed objects may change at each frame, or after subsequent calls to CreateOutputObjects.\endaknote
386  /// \return AK_Success if all objects were created successfully, AK_Fail otherwise.
387  /// The optional arguments out_ppBuffer and out_ppObjects may be used to obtain the output objects newly created.
388  /// \sa
389  /// - GetOutputObjects
390  /// - AK::IAkOutOfPlaceObjectPlugin::Execute
392  AkChannelConfig in_channelConfig, ///< Desired channel configuration for all new objects.
393  AkAudioObjects& io_objects ///< AkAudioObjects::uNumObjects, the number of objects to create.
394  ///< AkAudioObjects::ppObjectBuffers, Returned array of pointers to the object buffers newly created, allocated by the caller. Pass nullptr if they're not needed.
395  ///< AkAudioObjects::ppObjects, Returned array of pointers to the objects newly created, allocated by the caller. Pass nullptr if they're not needed.
396  ) = 0;
397 
398  /// Access the output objects. This function is helpful when CreateOutputObjects is called from within AK::IAkOutOfPlaceObjectPlugin::Execute.
399  /// You need to allocate the array of pointers. You may prealably obtain the number of objects by calling this function with io_numObjects = 0.
400  /// \aknote You should never store the pointers returned by GetOutputObjects, as the location of pointed objects may change at each frame, or after calls to CreateOutputObjects.\endaknote
401  virtual void GetOutputObjects(
402  AkAudioObjects& io_objects ///< AkAudioObjects::uNumObjects, The number of objects. If 0 is passed, io_objects::numObjects returns with the total number of objects.
403  ///< AkAudioObjects::ppObjectBuffers, Returned array of pointers to object buffers, allocated by the caller. The number of objects is the smallest between io_numObjects and the total number of objects.
404  ///< AkAudioObjects::ppObjects, Returned array of pointers to objects, allocated by the caller. The number of objects is the smallest between io_numObjects and the total number of objects.
405  ) = 0;
406 
407  //@}
408  };
409 
410  /// Interface to retrieve contextual information for a source plug-in.
411  /// \sa
412  /// - \ref iaksourceeffect_init
414  {
415  protected:
416  /// Virtual destructor on interface to avoid warnings.
418 
419  public:
420 
421  /// Retrieve the number of loops the source should produce.
422  /// \return The number of loop iterations the source should produce (0 if infinite looping)
423  virtual AkUInt16 GetNumLoops() const = 0;
424 
425  /// Obtain the interface to access the voice in which the plugin is inserted.
426  /// \return The interface to voice info.
428 
429  /// Obtain the MIDI event info associated to the source.
430  /// \return The MIDI event info.
431  ///
432  virtual AkMIDIEvent GetMidiEvent() const = 0;
433 
434  /// Retrieve Cookie information for a Source Plugin
435  /// \return the void pointer of the Cookie passed to the PostEvent
436  virtual void* GetCookie() const = 0;
437 
438  };
439 
440  /// Interface to retrieve contextual information for a mixer.
442  {
443  protected:
444  /// Virtual destructor on interface to avoid warnings.
446 
447  public:
448 
449  /// DEPRECATED.
450  /// Get the type of the bus on which the mixer plugin is instantiated.
451  /// AkBusHierachyFlags is a bit field, indicating whether the bus is the master (top-level) bus or not,
452  /// and whether it is in the primary or secondary mixing graph.
453  /// \return The bus type.
454  virtual AkUInt32 GetBusType() = 0;
455 
456  /// Get speaker angles of the specified device.
457  /// The speaker angles are expressed as an array of loudspeaker pairs, in degrees, relative to azimuth ]0,180].
458  /// Supported loudspeaker setups are always symmetric; the center speaker is always in the middle and thus not specified by angles.
459  /// Angles must be set in ascending order.
460  /// You may call this function with io_pfSpeakerAngles set to NULL to get the expected number of angle values in io_uNumAngles,
461  /// in order to allocate your array correctly. You may also obtain this number by calling
462  /// AK::GetNumberOfAnglesForConfig( AK_SPEAKER_SETUP_DEFAULT_PLANE ).
463  /// If io_pfSpeakerAngles is not NULL, the array is filled with up to io_uNumAngles.
464  /// Typical usage:
465  /// - AkUInt32 uNumAngles;
466  /// - GetSpeakerAngles( NULL, uNumAngles );
467  /// - AkReal32 * pfSpeakerAngles = AkAlloca( uNumAngles * sizeof(AkReal32) );
468  /// - GetSpeakerAngles( pfSpeakerAngles, uNumAngles );
469  /// \warning Call this function only after the sound engine has been properly initialized.
470  /// \return AK_Success if the end point device is properly initialized, AK_Fail otherwise.
471  /// \sa AK::SoundEngine::GetSpeakerAngles()
473  AkReal32 * io_pfSpeakerAngles, ///< Returned array of loudspeaker pair angles, in degrees relative to azimuth [0,180]. Pass NULL to get the required size of the array.
474  AkUInt32 & io_uNumAngles, ///< Returned number of angles in io_pfSpeakerAngles, which is the minimum between the value that you pass in, and the number of angles corresponding to the output configuration, or just the latter if io_pfSpeakerAngles is NULL.
475  AkReal32 & out_fHeightAngle ///< Elevation of the height layer, in degrees relative to the plane.
476  ) = 0;
477 
478  /// \name Services.
479  //@{
480 
481  /// Compute a direct speaker assignment volume matrix with proper downmixing rules between two channel configurations.
482  /// You may use the returned volume matrix with IAkGlobalPluginContext::MixNinNChannels.
483  /// \aknote ComputePositioning is more general than this one, as it can also compute speaker gains for non-3D spatialization, and should be favored.\endaknote
484  /// \return AK_Success if successful, AK_Fail otherwise.
485  /// \sa IAkGlobalPluginContext
487  AkChannelConfig in_inputConfig, ///< Channel configuration of the input.
488  AkChannelConfig in_outputConfig, ///< Channel configuration of the mixer output.
489  AkReal32 in_fCenterPerc, ///< Center percentage. Only applies to mono inputs with standard output configurations that have a center channel.
490  AK::SpeakerVolumes::MatrixPtr out_mxVolumes ///< Returned volumes matrix. Must be preallocated using AK::SpeakerVolumes::Matrix::GetRequiredSize() (see AK::SpeakerVolumes::Matrix services).
491  ) = 0;
492 
493  /// Compute a volume matrix given the position of the panner (Wwise 2D panner).
494  /// You may use the returned volume matrix with IAkGlobalPluginContext::MixNinNChannels.
495  /// \aknote ComputePositioning is more general than this one, as it can also compute speaker gains for 3D spatialization, and should be favored.\endaknote
496  /// \return AK_Success if successful, AK_Fail otherwise.
497  /// \sa IAkGlobalPluginContext
499  AkSpeakerPanningType in_ePannerType, ///< Panner type
500  const AkVector & in_position, ///< x,y,z panner position [-1,1]. Note that z has no effect at the moment.
501  AkReal32 in_fCenterPct, ///< Center percentage.
502  AkChannelConfig in_inputConfig, ///< Channel configuration of the input.
503  AkChannelConfig in_outputConfig, ///< Channel configuration of the mixer output.
504  AK::SpeakerVolumes::MatrixPtr out_mxVolumes ///< Returned volumes matrix. Must be preallocated using AK::SpeakerVolumes::Matrix::GetRequiredSize() (see AK::SpeakerVolumes::Matrix services).
505  ) = 0;
506 
507  /// Compute panning gains on the plane given an incidence angle and channel configuration.
508  /// You may use the returned volume matrix with IAkGlobalPluginContext::MixNinNChannels.
509  /// \aknote ComputePositioning is more general than this one, as it can also compute speaker gains for non-3D spatialization, and should be favored.\endaknote
510  /// \return AK_Success if successful, AK_Fail otherwise.
511  /// \sa IAkGlobalPluginContext
513  AkReal32 in_fAngle, ///< Incident angle, in radians [-pi,pi], where 0 is the azimuth (positive values are clockwise)
514  AkChannelConfig in_outputConfig, ///< Desired output configuration.
515  AkReal32 in_fCenterPerc, ///< Center percentage. Only applies to mono inputs to outputs that have no center.
516  AK::SpeakerVolumes::VectorPtr out_vVolumes ///< Returned volumes (see AK::SpeakerVolumes::Vector services). Must be allocated prior to calling this function with the size returned by AK::SpeakerVolumes::Vector::GetRequiredSize() for the desired configuration.
517  ) = 0;
518 
519  /// Initialize spherical VBAP
520  /// \return AK_Success if successful, AK_Fail otherwise.
522  AK::IAkPluginMemAlloc* in_pAllocator, ///< Memory allocator
523  const AkSphericalCoord* in_SphericalPositions, ///< Array of points in spherical coordinate, representign the virtual position of each channels.
524  const AkUInt32 in_NbPoints, ///< Number of points in the position array
525  void *& out_pPannerData ///< Contains data relevant to the 3D panner that shoud be re-used accross plugin instances.
526  ) = 0;
527 
528  /// Compute panning gains on the plane given an incidence angle and channel configuration.
529  /// \aknote ComputePositioning is more general than this one, as it handles spread and focus, and can also compute speaker gains for non-3D spatialization, and should be favored.\endaknote
530  /// \return AK_Success if successful, AK_Fail otherwise.
532  void* in_pPannerData, ///< Contains data relevant to the 3D panner that shoud be re-used accross plugin instances.
533  AkReal32 in_fAzimuth, ///< Incident angle, in radians [-pi,pi], where 0 is the azimuth (positive values are clockwise)
534  AkReal32 in_fElevation, ///< Incident angle, in radians [0,pi], where 0 is the elevation (positive values are clockwise)
535  AkUInt32 in_uNumChannels, ///< Number of output channels.
536  AK::SpeakerVolumes::VectorPtr out_vVolumes ///< Returned volumes (see AK::SpeakerVolumes::Vector services). Must be allocated prior to calling this function with the size returned by AK::SpeakerVolumes::Vector::GetRequiredSize() for the desired configuration.
537  ) = 0;
538 
539  /// Clear panner data obtained from InitSphericalVBAP().
540  /// \return AK_Success if successful, AK_Fail otherwise.
542  AK::IAkPluginMemAlloc* in_pAllocator, ///< Memory allocator
543  void* in_pPannerData ///< Contains data relevant to the 3D panner that shoud be re-used accross plugin instances.
544  ) = 0;
545 
546  /// Compute standard 3D positioning.
547  /// You may use the returned volume matrix with IAkGlobalPluginContext::MixNinNChannels.
548  /// \aknote The cartesian counterpart of Compute3DPositioning, that uses emitter and listener transforms, should be used instead of this function.
549  /// It is more complete and more efficient. \endaknote
550  /// \aknote ComputePositioning is more general than this one, as it can also compute speaker gains for non-3D spatialization, and should be favored.\endaknote
551  /// \return AK_Success if successful, AK_Fail otherwise.
552  /// \sa IAkGlobalPluginContext
554  AkReal32 in_fAngle, ///< Incident angle, in radians [-pi,pi], where 0 is the azimuth (positive values are clockwise).
555  AkReal32 in_fElevation, ///< Incident elevation angle, in radians [-pi/2,pi/2], where 0 is the horizon (positive values are above the horizon).
556  AkReal32 in_fSpread, ///< Spread ([0,1]).
557  AkReal32 in_fFocus, ///< Focus ([0,1]).
558  AkChannelConfig in_inputConfig, ///< Channel configuration of the input.
559  AkChannelMask in_uInputChanSel, ///< Mask of input channels selected for panning (excluded input channels don't contribute to the output).
560  AkChannelConfig in_outputConfig, ///< Desired output configuration.
561  AkReal32 in_fCenterPerc, ///< Center percentage. Only applies to mono inputs to outputs that have a center.
562  AK::SpeakerVolumes::MatrixPtr out_mxVolumes ///< Returned volumes matrix. Must be preallocated using AK::SpeakerVolumes::Matrix::GetRequiredSize() (see AK::SpeakerVolumes::Matrix services).
563  ) = 0;
564 
565  /// Compute standard 3D positioning.
566  /// You may use the returned volume matrix with IAkGlobalPluginContext::MixNinNChannels.
567  /// \aknote This function is more complete and more efficient than the Compute3DPositioning service that uses spherical coordinates, and should be favored.\endaknote
568  /// \aknote ComputePositioning is more general than this one, as it can also compute speaker gains for non-3D spatialization, and should be favored.\endaknote
569  /// \return AK_Success if successful, AK_Fail otherwise.
570  /// \sa IAkGlobalPluginContext
572  const AkWorldTransform & in_emitter, ///< Emitter transform.
573  const AkWorldTransform & in_listener, ///< Listener transform.
574  AkReal32 in_fCenterPerc, ///< Center percentage. Only applies to mono inputs to outputs that have a center.
575  AkReal32 in_fSpread, ///< Spread ([0,1]).
576  AkReal32 in_fFocus, ///< Focus ([0,1]).
577  AkChannelConfig in_inputConfig, ///< Channel configuration of the input.
578  AkChannelMask in_uInputChanSel, ///< Mask of input channels selected for panning (excluded input channels don't contribute to the output).
579  AkChannelConfig in_outputConfig, ///< Desired output configuration.
580  AK::SpeakerVolumes::MatrixPtr out_mxVolumes ///< Returned volumes matrix. Must be preallocated using AK::SpeakerVolumes::Matrix::GetRequiredSize() (see AK::SpeakerVolumes::Matrix services).
581  ) = 0;
582 
583  /// Compute the speaker volume matrix of built-in positioning in Wwise from given positioning data and input and output channel configurations.
584  /// You may use the returned volume matrix with IAkGlobalPluginContext::MixNinNChannels.
585  /// Any known (non-anonymous) combination of configurations will work. For example, ambisonics will be decoded or encoded if needed.
586  /// \aknote The function will fail if the input or output configuration is object-based, as the speaker volume matrix would be undefined.\endaknote
587  /// All panning or spatialization types are honored.
588  /// 3D Spatialization is performed relative to the default listener position (0,0,0) and orientation, where the front vector is (0,0,1) and the top vector is (0,1,0), left handed.
589  /// \return AK_Success if succeeded, AK_InvalidParameter if the input or output configuration is object-based, or AK_Fail if the channel configurations are unknown or unhandled.
590  /// \sa IAkGlobalPluginContext
592  const AkPositioningData& in_posData, ///< Positioning data. The field "threeD" is ignored if in_posData.behavioral.spatMode is AK_SpatializationMode_None.
593  AkChannelConfig in_inputConfig, ///< Channel configuration of the input.
594  AkChannelConfig in_outputConfig, ///< Channel configuration of the output.
595  AK::SpeakerVolumes::MatrixPtr out_mxVolumes ///< Returned volumes matrix. Must be preallocated using AK::SpeakerVolumes::Matrix::GetRequiredSize() (see AK::SpeakerVolumes::Matrix services).
596  ) = 0;
597 
598 
599  //@}
600 
601  /// \name Metering.
602  //@{
603 
604  /// Set flags for controlling computation of metering values on the mix buffer.
605  /// Pass AK_NoMetering to disable metering.
606  /// \sa
607  /// - AK::AkMetering
608  virtual void EnableMetering( AkMeteringFlags in_eFlags ) = 0;
609 
610  //@}
611  };
612 
613  /// Parameter node interface, managing access to an enclosed parameter structure.
614  /// \aknote The implementer of this interface should also expose a static creation function
615  /// that will return a new parameter node instance when required (see \ref se_plugins_overview). \endaknote
616  /// \sa
617  /// - \ref shared_parameter_interface
619  {
620  protected:
621  /// Virtual destructor on interface to avoid warnings.
622  virtual ~IAkPluginParam(){}
623 
624  public:
625  /// Create a duplicate of the parameter node instance in its current state.
626  /// \aknote The allocation of the new parameter node should be done through the AK_PLUGIN_NEW() macro. \endaknote
627  /// \return Pointer to a duplicated plug-in parameter node interface
628  /// \sa
629  /// - \ref iakeffectparam_clone
631  IAkPluginMemAlloc * in_pAllocator ///< Interface to memory allocator to be used
632  ) = 0;
633 
634  /// Initialize the plug-in parameter node interface.
635  /// Initializes the internal parameter structure to default values or with the provided parameter
636  /// block if it is valid. \endaknote
637  /// \aknote If the provided parameter block is valid, use SetParamsBlock() to set all parameters at once. \endaknote
638  /// \return Possible return values are: AK_Success, AK_Fail, AK_InvalidParameter
639  /// \sa
640  /// - \ref iakeffectparam_init
641  virtual AKRESULT Init(
642  IAkPluginMemAlloc * in_pAllocator, ///< Interface to the memory allocator to be used
643  const void * in_pParamsBlock, ///< Pointer to a parameter structure block
644  AkUInt32 in_uBlockSize ///< Size of the parameter structure block
645  ) = 0;
646 
647  /// Called by the sound engine when a parameter node is terminated.
648  /// \aknote The self-destruction of the parameter node must be done using the AK_PLUGIN_DELETE() macro. \endaknote
649  /// \return AK_Success if successful, AK_Fail otherwise
650  /// \sa
651  /// - \ref iakeffectparam_term
652  virtual AKRESULT Term(
653  IAkPluginMemAlloc * in_pAllocator ///< Interface to memory allocator to be used
654  ) = 0;
655 
656  /// Set all plug-in parameters at once using a parameter block.
657  /// \return AK_Success if successful, AK_InvalidParameter otherwise
658  /// \sa
659  /// - \ref iakeffectparam_setparamsblock
661  const void *in_pParamsBlock, ///< Pointer to a parameter structure block
662  AkUInt32 in_uBlockSize ///< Size of the parameter structure block
663  ) = 0;
664 
665  /// Update a single parameter at a time and perform the necessary actions on the parameter changes.
666  /// \aknote The parameter ID corresponds to the AudioEnginePropertyID in the plug-in XML description file. \endaknote
667  /// \return AK_Success if successful, AK_InvalidParameter otherwise
668  /// \sa
669  /// - \ref iakeffectparam_setparam
671  AkPluginParamID in_paramID, ///< ID number of the parameter to set
672  const void * in_pValue, ///< Pointer to the value of the parameter to set
673  AkUInt32 in_uParamSize ///< Size of the value of the parameter to set
674  ) = 0;
675 
676  /// Use this constant with AK::Wwise::IPluginPropertySet::NotifyInternalDataChanged,
677  /// AK::Wwise::IAudioPlugin::GetPluginData and IAkPluginParam::SetParam. This tells
678  /// that the whole plugin data needs to be saved/transferred.
679  ///\sa
680  /// - AK::Wwise::IPluginPropertySet::NotifyInternalDataChanged
681  /// - AK::Wwise::IAudioPlugin::GetPluginData
682  /// - AK::IAkPluginParam::SetParam
683  static const AkPluginParamID ALL_PLUGIN_DATA_ID = 0x7FFF;
684  };
685 
686  /// Wwise sound engine plug-in interface. Shared functionality across different plug-in types.
687  /// \aknote The implementer of this interface should also expose a static creation function
688  /// that will return a new plug-in instance when required (see \ref soundengine_plugins). \endaknote
689  class IAkPlugin
690  {
691  protected:
692  /// Virtual destructor on interface to avoid warnings.
693  virtual ~IAkPlugin(){}
694 
695  public:
696  /// Release the resources upon termination of the plug-in.
697  /// \return AK_Success if successful, AK_Fail otherwise
698  /// \aknote The self-destruction of the plug-in must be done using AK_PLUGIN_DELETE() macro. \endaknote
699  /// \sa
700  /// - \ref iakeffect_term
701  virtual AKRESULT Term(
702  IAkPluginMemAlloc * in_pAllocator ///< Interface to memory allocator to be used by the plug-in
703  ) = 0;
704 
705  /// The reset action should perform any actions required to reinitialize the state of the plug-in
706  /// to its original state (e.g. after Init() or on effect bypass).
707  /// \return AK_Success if successful, AK_Fail otherwise.
708  /// \sa
709  /// - \ref iakeffect_reset
710  virtual AKRESULT Reset() = 0;
711 
712  /// Plug-in information query mechanism used when the sound engine requires information
713  /// about the plug-in to determine its behavior.
714  /// \warning This function can be called before Init. Implementation of this function should not rely on internal state initialized in Init.
715  /// \return AK_Success if successful.
716  /// \sa
717  /// - \ref iakeffect_geteffectinfo
719  AkPluginInfo & out_rPluginInfo ///< Reference to the plug-in information structure to be retrieved
720  ) = 0;
721 
722  /// Some plug-ins are accessing Media from the Wwise sound bank system.
723  /// If the IAkPlugin object is not using media, this function will not be used and should simply return false.
724  /// If the IAkPlugin object is using media, the RelocateMedia feature can be optionally implemented.
725  /// To implement correctly the feature, the plugin must be able to "Hot swap" from a memory location to another one in a single blocking call (AK::IAkPlugin::RelocateMedia)
726  ///
727  /// \sa
728  /// - AK::IAkPlugin::RelocateMedia
729  virtual bool SupportMediaRelocation() const
730  {
731  return false;
732  }
733 
734  /// Some plug-ins are accessing Media from the Wwise sound bank system.
735  /// If the IAkPlugin object is not using media, this function will not be used.
736  /// If the IAkPlugin object is using media, the RelocateMedia feature can be optionally implemented.
737  /// When this function is being called, the IAkPlugin object must make the required changes to remove all
738  /// referenced from the old memory pointer (previously obtained by GetPluginMedia() (and offsets to) to not access anymore the content of the old memory data and start using the newly provided pointer instead.
739  /// The change must be done within the function RelocateMedia().
740  /// After this call, the memory space in in_pOldInMemoryData will be invalidated and cannot be used safely anymore.
741  ///
742  /// This function will not be called if SupportMediaRelocation returned false.
743  ///
744  /// \sa
745  /// - AK::IAkPlugin::SupportMediaRelocation
747  AkUInt8* /*in_pNewMedia*/,
748  AkUInt8* /*in_pOldMedia*/
749  )
750  {
751  return AK_NotImplemented;
752  }
753 
754  };
755 
756  /// Software effect plug-in interface (see \ref soundengine_plugins_effects).
757  class IAkEffectPlugin : public IAkPlugin
758  {
759  protected:
760  /// Virtual destructor on interface to avoid warnings.
761  virtual ~IAkEffectPlugin(){}
762 
763  public:
764  /// Software effect plug-in initialization. Prepares the effect for data processing, allocates memory and sets up the initial conditions.
765  /// \aknote Memory allocation should be done through appropriate macros (see \ref fx_memory_alloc). \endaknote
766  /// \sa
767  /// - \ref iakmonadiceffect_init
768  virtual AKRESULT Init(
769  IAkPluginMemAlloc * in_pAllocator, ///< Interface to memory allocator to be used by the effect
770  IAkEffectPluginContext * in_pEffectPluginContext, ///< Interface to effect plug-in's context
771  IAkPluginParam * in_pParams, ///< Interface to plug-in parameters
772  AkAudioFormat & io_rFormat ///< Audio data format of the input/output signal. Only an out-of-place plugin is allowed to change the channel configuration. Object processors always receive a channel configuration with type "object". They may however change it to any other kind, in which case the host bus will automatically create an output object with the desired channel configuration.
773  ) = 0;
774  };
775 
776  /// Software effect plug-in interface for in-place processing (see \ref soundengine_plugins_effects).
778  {
779  public:
780  /// Software effect plug-in DSP execution for in-place processing.
781  /// \aknote The effect should process all the input data (uValidFrames) as long as AK_DataReady is passed in the eState field.
782  /// When the input is finished (AK_NoMoreData), the effect can output more sample than uValidFrames up to MaxFrames() if desired.
783  /// All sample frames beyond uValidFrames are not initialized and it is the responsibility of the effect to do so when outputting an effect tail.
784  /// The effect must notify the pipeline by updating uValidFrames if more frames are produced during the effect tail.
785  /// \aknote The effect will stop being called by the pipeline when AK_NoMoreData is returned in the the eState field of the AkAudioBuffer structure.
786  /// See \ref iakmonadiceffect_execute_general.
787  virtual void Execute(
788  AkAudioBuffer * io_pBuffer ///< In/Out audio buffer data structure (in-place processing)
789  ) = 0;
790 
791  /// Skips execution of some frames, when the voice is virtual playing from elapsed time.
792  /// This can be used to simulate processing that would have taken place (e.g. update internal state).
793  /// Return AK_DataReady or AK_NoMoreData, depending if there would be audio output or not at that point.
795  AkUInt32 in_uFrames ///< Number of frames the audio processing should advance.
796  ) = 0;
797  };
798 
799 
800  /// Software effect plug-in interface for out-of-place processing (see \ref soundengine_plugins_effects).
802  {
803  public:
804  /// Software effect plug-in for out-of-place processing.
805  /// \aknote An input buffer is provided and will be passed back to Execute() (with an advancing offset based on uValidFrames consumption by the plug-in).
806  /// The output buffer should be filled entirely by the effect (at which point it can report AK_DataReady) except on last execution where AK_NoMoreData should be used.
807  /// AK_DataNeeded should be used when more input data is necessary to continue processing.
808  /// \aknote Only the output buffer eState field is looked at by the pipeline to determine the effect state.
809  /// See \ref iakmonadiceffect_execute_outofplace.
810  virtual void Execute(
811  AkAudioBuffer * in_pBuffer, ///< Input audio buffer data structure
812  AkUInt32 in_uInOffset, ///< Offset position into input buffer data
813  AkAudioBuffer * out_pBuffer ///< Output audio buffer data structure
814  ) = 0;
815 
816  /// Skips execution of some frames, when the voice is virtual playing from elapsed time.
817  /// This can be used to simulate processing that would have taken place (e.g. update internal state).
818  /// Return AK_DataReady or AK_NoMoreData, depending if there would be audio output or not at that point.
820  AkUInt32 &io_uFrames ///< Number of frames the audio processing should advance. The output value should be the number of frames that would be consumed to output the number of frames this parameter has at the input of the function.
821  ) = 0;
822  };
823 
824  /// In-place Object Processor plug-in interface. Implement this interface when your plugin returns both AkPluginInfo::bCanProcessObjects
825  /// and AkPluginInfo::bIsInPlace set to true.
826  /// In-place object processors just modify objects' audio or metadata, but do not destroy objects create additional output objects.
827  /// An object processor may be initialized with an Object configuration, or any channel configuration, depending on the configuration of its input.
828  /// It is not allowed to change the channel configuration in Init.
830  {
831  public:
832 
833  /// In-place object processor plug-in DSP execution.
834  /// \aknote The effect should process all the input data (uValidFrames) of each input object in in_pObjectsIn as long as AK_DataReady is passed in their corresponding eState field.
835  /// When an input object is finished (eState is AK_NoMoreData), the effect can output more samples than uValidFrames, up to MaxFrames() if desired.
836  /// The effect must notify the pipeline by updating uValidFrames of a given object if more frames are produced, and by setting its eState to AK_DataReady as long as more samples will be produced.\endaknote.
837  /// \sa AK::IAkEffectPlugin::Init.
838  virtual void Execute(
839  const AkAudioObjects& io_objects ///< Input/Output objects and object buffers.
840  ) = 0;
841  };
842 
843  /// Out-of-place Object Processor plug-in interface. Implement this interface when your plugin returns AkPluginInfo::bCanProcessObjects set to true
844  /// and AkPluginInfo::bIsInPlace set to false.
845  /// With out-of-place object processors, the set of output objects is different than that of the input objects. Out-of-place object processors typically create
846  /// their own output objects using IAkEffectPluginContext::CreateObject. Alternatively, an output object is created by the host bus if the channel configuration
847  /// returned from Init is not of type AK_ChannelConfigType_Objects.
848  /// Only out-of-place object processors may create output objects or change the output channel configuration.
850  {
851  public:
852 
853  /// Out-of-place object processor plug-in DSP execution.
854  /// \aknote When running out-of-place, the effect must only update uValidFrames and eState fields of output objects.
855  /// When the object processor sets an output object's eState field to AK_NoMoreData, the host will garbage collect them afterwards. \endaknote
856  /// \akwarning If an out-of-place object processor calls AK::IAkEffectPluginContext::CreateOutputObjects from within Execute, it must not access the output objects passed in out_objects, as the pointed objects may have moved elsewhere in memory.
857  /// In that case it must use AK::IAkEffectPluginContext::GetOutputObjects. Arguments in_pObjectBuffersOut and in_pObjectsOut can only be safely used if the plugin creates objects during Init, either via
858  /// AK::IAkEffectPluginContext::CreateOutputObjects, or by setting the channelConfig field of io_rFormat to a normal channel configuration (i.e. whose eConfigType is not AK_ChannelConfigType_Objects). \endakwarning
859  /// \sa AK::IAkEffectPlugin::Init.
860  virtual void Execute(
861  const AkAudioObjects& in_objects, ///< Input objects and object audio buffers.
862  const AkAudioObjects& out_objects ///< Output objects and object audio buffers.
863  ) = 0;
864  };
865 
867  {
868  public:
869  /// Compute the speaker volume matrix of built-in positioning in Wwise from given positioning data and input and output channel configurations.
870  /// Any known (non-anonymous) combination of configurations will work. For example, ambisonics will be decoded or encoded if needed.
871  /// \aknote The function will fail if the input or output configuration is object-based, as the speaker volume matrix would be undefined.\endaknote
872  /// All panning or spatialization types are honored.
873  /// 3D Spatialization is performed relative to the default listener position (0,0,0) and orientation, where the front vector is (0,0,1) and the top vector is (0,1,0), left handed.
874  /// \return AK_Success if succeeded, AK_InvalidParameter if the input or output configuration is object-based, or AK_Fail if the channel configurations are unknown or unhandled.
876  const AkPositioningData& in_posData, ///< Positioning data. The field "threeD" is ignored if in_posData.behavioral.spatMode is AK_SpatializationMode_None.
877  AkChannelConfig in_inputConfig, ///< Channel configuration of the input.
878  AkChannelConfig in_outputConfig, ///< Channel configuration of the output.
879  AK::SpeakerVolumes::MatrixPtr out_mxVolumes ///< Returned volumes matrix. Must be preallocated using AK::SpeakerVolumes::Matrix::GetRequiredSize() (see AK::SpeakerVolumes::Matrix services).
880  ) = 0;
881  };
882 
883  /// Audio device effect plug-in interface. Implement this interface for in-place effects that must be applied at the very end of the pipeline.
884  /// Audio device effects are applied right before sending audio buffers (main mix, passthrough and objects) to the audio device output through IAkSinkPlugin/IAk3DAudioSinkPlugin.
885  /// The format of the audio buffers passed to the effect matches the format requested by the sink plug-in. This means that audio device effects must be in-place; they cannot change io_rFormat in Init().
887  {
888  protected:
889  /// Virtual destructor on interface to avoid warnings.
891 
892  public:
893  /// Audio device effect plug-in initialization. Prepares the effect for data processing, allocates memory and sets up the initial conditions.
894  /// \aknote Memory allocation should be done through appropriate macros (see \ref fx_memory_alloc). \endaknote
895  virtual AKRESULT Init(
896  IAkPluginMemAlloc* in_pAllocator, ///< Interface to memory allocator to be used by the effect
897  IAkAudioDeviceEffectPluginContext* in_pEffectPluginContext, ///< Interface to audio effect's plug-in context
898  IAkPluginParam* in_pParams, ///< Interface to plug-in parameters
899  const AkAudioFormat& in_rFormat, ///< Audio data format of the input/output signal. Matches the channel configuration of the audio device sink plug-in. If format is object-based (AkChannelConfig::eConfigType is Ak_ChannelConfigType_Objects), the plug-in should verify Ak3DAudioSinkCapabilities to determine which inputs it can expect in Execute (main mix, passthrough, objects).
900  const Ak3DAudioSinkCapabilities& in_3dCapabilities ///< 3D capabilities of the output device sink plug-in. If io_rFormat is not object-based, this can be ignored and only the main mix will be submitted to Execute().
901  ) = 0;
902 
903  virtual void Execute(
904  AkAudioBuffer* io_pMainMix, ///< Audio buffer data structure for the main mix (binauralized or not, depending on if binauralization is supported and enabled).
905  AkAudioBuffer* io_pPassthroughMix, ///< The stereo mix to send out to the system in passthrough fashion (no binauralization). NULL if the channel configuration of the device is not object-based or does not have a passthrough.
906  const AkAudioObjects& io_objects, ///< 3D Audio objects and object audio buffers to be consumed. The audio buffers are in the native format of the sound engine (typically float, deinterleaved), as specified by io_rFormat passed to Init(). It is up to the plugin to transform it into a format that is compatible with its output.
907  AkRamp& io_gain ///< Volume gain to apply to all inputs. If the effect applies the gain, it must reset the gain to 1.0f so that it's not applied a second time in the sink plug-in.
908  ) = 0;
909  };
910 
911  /// Interface to retrieve information about an input of a mixer.
912  /// DEPRECATED.
914  {
915  protected:
916  /// Virtual destructor on interface to avoid warnings.
918 
919  public:
920 
921  /// Obtain the parameter blob for the mixer plugin that were attached to this input.
922  /// \return The parameter blob, which can be safely cast into the plugin's implementation.
923  /// If all parameters are default value, NULL is returned. It is up to the plugin's implementation to know
924  /// what the default values are.
926  AkPluginID in_attachmentPluginID ///< Full plugin ID of the attachment plug-in, including company ID and plug-in type. See AKMAKECLASSID macro. Attachment plug-ins' type is always AkPluginTypeEffect.
927  ) = 0;
928 
929  /// Obtain the interface to access the voice info of this input.
930  /// \return The interface to voice info. NULL when the input is not a voice but the output of another bus instead.
932 
933  /// Obtain the interface to access the game object on which the plugin is instantiated.
934  /// \return The interface to GameObject info.
936 
937  /// Query the nature of the connection between this input and the mixer.
938  /// \return The connection type (direct/dry, user-defined auxiliary send, game-defined auxiliary send). Bus inputs are always "direct".
940 
941  /// Use this method to retrieve user data to this context. It is always initialized to NULL until you decide to set it otherwise.
942  /// \return Attached user data.
943  /// \sa SetUserData()
944  virtual void* GetUserData() = 0;
945 
946  /// Use this method to attach user data to this context. It is always initialized to NULL until you decide to set it otherwise.
947  /// \sa GetUserData()
948  virtual void SetUserData(void* in_pUserData) = 0;
949 
950  /// \name Default positioning information.
951  /// \akwarning
952  /// The methods of this group are deprecated.
953  /// \endakwarning
954  //@{
955 
956  /// Retrieve center percentage of this input.
957  /// \return Center percentage, between 0 and 1.
958  virtual AkReal32 GetCenterPerc() = 0;
959 
960  /// Retrieve the speaker panning type: type of panning logic when object is not 3D spatialized.
961  /// Note that the returned value is only relevant when the object is not 3D spatialized,
962  /// that is Get3DSpatializationMode returns AK_SpatializationMode_None.
963  /// \sa
964  /// - Get3DSpatializationMode()
966 
967  /// Speaker panning:
968  /// Retrieve the panner position (each vector component is between -1 and 1) of this input.
969  /// Note that the returned value is only relevant when the object is not 3D spatialized,
970  /// (Get3DSpatializationMode returns AK_SpatializationMode_None), and if speaker panning is not direct assignment
971  /// (GetSpeakerPanningType does not return AK_DirectSpeakerAssignment).
972  /// \sa
973  /// - GetSpeakerPanningType()
974  /// - Get3DSpatializationMode()
975  virtual void GetPannerPosition(
976  AkVector & out_position ///< Returned sound position.
977  ) = 0;
978 
979  /// Get the value of this input's Listener Relative Routing option, that is, if the emitter-listener relative
980  /// association is calculated at this node. Listener Relative Routing needs to be calculated in order for a node
981  /// to be spatialized or attenuated with respect to in-game emitter and listener positions. Otherwise it can only
982  /// be panned.
983  /// \sa
984  /// - Get3DSpatializationMode()
985  /// - Get3DPositionType()
986  /// - GetNum3DPositions()
987  virtual bool HasListenerRelativeRouting() = 0;
988 
989  /// Get whether the emitter position is defined by the game alone (AK_3DPositionType_Emitter), or if it is further automated
990  /// (AK_3DPositionType_EmitterWithAutomation, AK_3DPositionType_ListenerWithAutomation).
991  /// The resulting 3D position(s) may be obtained by Get3DPosition(), and used for 3D spatialization or attenuation.
992  /// \sa
993  /// - Get3DPosition()
994  /// - GetNum3DPositions()
995  /// - HasListenerRelativeRouting()
997 
998  /// 3D spatialization:
999  /// Retrieve the number of emitter-listener pairs (rays) of this input.
1000  /// Note that the returned value is always 0 unless the input has listener relative routing (see HasListenerRelativeRouting()).
1001  /// Use this function with Get3DPosition().
1002  /// \sa
1003  /// - Get3DPosition()
1004  /// - HasListenerRelativeRouting()
1006 
1007  /// 3D spatialization:
1008  /// Retrieve the spherical coordinates of the desired emitter-listener pair (ray) corresponding to this
1009  /// input, as automated by the engine. Applicable only when the input has listener relative routing (see HasListenerRelativeRouting()).
1010  /// Returned rays are those that result from engine automation, if applicable.
1011  /// \return AK_Success if the pair index is valid, AK_Fail otherwise.
1012  /// \sa
1013  /// - HasListenerRelativeRouting()
1014  /// - GetNum3DPositions()
1016  AkUInt32 in_uIndex, ///< Index of the pair, [0, GetNum3DPositions()[
1017  AkEmitterListenerPair & out_soundPosition ///< Returned sound position, in spherical coordinates.
1018  ) = 0;
1019 
1020  /// 3D spatialization:
1021  /// Evaluate spread value at the distance of the desired emitter-listener pair for this input.
1022  /// Applicable only when the input has listener relative routing (see HasListenerRelativeRouting()).
1023  /// \return The spread value, between 0 and 1. 0 if the pair index is invalid.
1024  /// \sa
1025  /// - HasListenerRelativeRouting()
1026  /// - GetNum3DPositions()
1027  /// - Get3DPosition()
1029  AkUInt32 in_uIndex ///< Index of the pair, [0, GetNum3DPositions()[
1030  ) = 0;
1031 
1032  /// 3D spatialization:
1033  /// Evaluate focus value at the distance of the desired emitter-listener pair for this input.
1034  /// Applicable only when the input has listener relative routing (see HasListenerRelativeRouting()).
1035  /// \return The focus value, between 0 and 1. 0 if the pair index is invalid.
1036  /// \sa
1037  /// - HasListenerRelativeRouting()
1038  /// - GetNum3DPositions()
1039  /// - Get3DPosition()
1041  AkUInt32 in_uIndex ///< Index of the pair, [0, GetNum3DPositions()[
1042  ) = 0;
1043 
1044  /// Get the max distance as defined in the attenuation editor.
1045  /// Applicable only when the input has listener relative routing (see HasListenerRelativeRouting()).
1046  /// \return True if this input has attenuation, false otherwise.
1048  AkReal32 & out_fMaxAttenuationDistance ///< Returned max distance.
1049  ) = 0;
1050 
1051  /// Get next volumes as computed by the sound engine for this input.
1052  /// You may use the returned volume matrices with IAkGlobalPluginContext::MixNinNChannels.
1053  /// \sa IAkGlobalPluginContext
1055  AK::SpeakerVolumes::MatrixPtr out_mxPrevVolumes, ///< Returned in/out channel volume distribution corresponding to the beginning of the buffer. Must be preallocated (see AK::SpeakerVolumes::Matrix services).
1056  AK::SpeakerVolumes::MatrixPtr out_mxNextVolumes ///< Returned in/out channel volume distribution corresponding to the end of the buffer. Must be preallocated (see AK::SpeakerVolumes::Matrix services).
1057  ) = 0;
1058 
1059  /// Query the 3D spatialization mode used by this input.
1060  /// Applicable only when the input has listener relative routing (see HasListenerRelativeRouting()).
1061  /// \return The 3D spatialization mode (see Ak3DSpatializationMode). AK_SpatializationMode_None if not set, or if the input is not a node where the game object is evaluated against its listener.
1062  /// \sa
1063  /// - HasListenerRelativeRouting()
1065 
1066  //@}
1067  };
1068 
1069  /// Interface to retrieve contextual information for a sink plugin.
1070  /// \sa
1071  /// - AK::IAkSinkPlugin
1073  {
1074  protected:
1075  /// Virtual destructor on interface to avoid warnings.
1077 
1078  public:
1079 
1080  /// Query if the sink plugin is instantiated on the main output device (primary tree).
1081  /// \return True if the sink plugin is instantiated on the main output device (primary tree), false otherwise.
1082  /// \sa
1083  /// - AK::IAkSinkPlugin::IsDataNeeded()
1084  /// - AK::IAkSinkPlugin::Consume()
1085  virtual bool IsPrimary() = 0;
1086 
1087  /// Sink plugins may need to call this function to notify the audio thread that it should wake up
1088  /// in order to potentially process an audio frame. Note that the audio thread may wake up for other
1089  /// reasons, for example following calls to AK::SoundEngine::RenderAudio().
1090  /// Once the audio thread is awaken, it will ask the sink plugin how many audio frames need to be
1091  /// processed and presented to the plugin. This is done through AK::IAkSinkPlugin::IsDataNeeded()
1092  /// and AK::IAkSinkPlugin::Consume() respectively.
1093  /// Note that only the sink plugin that is instantiated on the main output device (primary tree) may control
1094  /// the audio thread synchronization.
1095  /// \return AK_Success if the calling plugin is instantiated on the main output device (primary tree),
1096  /// AK_Fail otherwise.
1097  /// \sa
1098  /// - AK::IAkSinkPluginContext::IsPrimary()
1099  /// - AK::IAkSinkPlugin::IsDataNeeded()
1100  /// - AK::IAkSinkPlugin::Consume()
1102 
1103  /// Query engine's user-defined sink queue depth (AkPlatformInitSettings::uNumRefillsInVoice).
1104  /// \return The engine's AkPlatformInitSettings::uNumRefillsInVoice value on platforms for which it exists, 0 otherwise.
1106 
1107  /// Compute the speaker volume matrix of built-in positioning in Wwise from given positioning data and input and output channel configurations.
1108  /// Any known (non-anonymous) combination of configurations will work. For example, ambisonics will be decoded or encoded if needed.
1109  /// \aknote The function will fail if the input or output configuration is object-based, as the speaker volume matrix would be undefined.\endaknote
1110  /// All panning or spatialization types are honored.
1111  /// 3D Spatialization is performed relative to the default listener position (0,0,0) and orientation, where the front vector is (0,0,1) and the top vector is (0,1,0), left handed.
1112  /// \return AK_Success if succeeded, AK_InvalidParameter if the input or output configuration is object-based, or AK_Fail if the channel configurations are unknown or unhandled.
1114  const AkPositioningData& in_posData, ///< Positioning data. The field "threeD" is ignored if in_posData.behavioral.spatMode is AK_SpatializationMode_None.
1115  AkChannelConfig in_inputConfig, ///< Channel configuration of the input.
1116  AkChannelConfig in_outputConfig, ///< Channel configuration of the output.
1117  AK::SpeakerVolumes::MatrixPtr out_mxVolumes ///< Returned volumes matrix. Must be preallocated using AK::SpeakerVolumes::Matrix::GetRequiredSize() (see AK::SpeakerVolumes::Matrix services).
1118  ) = 0;
1119  };
1120 
1122  {
1125  };
1126 
1127  /// Software interface for sink (audio endpoint) plugins.
1128  /// This interface should not be implemented directly,
1129  /// Plug-ins should either implement:
1130  /// - IAkSinkPlugin: for audio endpoint that do not support 3D audio, or
1131  /// - IAk3DAudioSinkPlugin: for audio endpoints that support 3D audio features.
1133  {
1134  public:
1135  /// Initialization of the sink plugin.
1136  ///
1137  /// This method prepares the audio device plug-in for data processing, allocates memory, and sets up initial conditions.
1138  /// The plug-in is passed in a pointer to a memory allocator interface (AK::IAkPluginMemAlloc).You should perform all dynamic memory allocation through this interface using the provided memory allocation macros(refer to \ref fx_memory_alloc).For the most common memory allocation needs, namely allocation at initialization and release at termination, the plug-in does not need to retain a pointer to the allocator.It will also be provided to the plug-in on termination.
1139  /// The AK::IAkSinkPluginContext interface allows to retrieve information related to the context in which the audio device plug-in is operated.
1140  /// The plug-in also receives a pointer to its associated parameter node interface (AK::IAkPluginParam).Most plug-ins will want to keep a reference to the associated parameter node to be able to retrieve parameters at runtime. Refer to \ref iakeffectparam_communication for more details.
1141  /// All of these interfaces will remain valid throughout the plug-in's lifespan so it is safe to keep an internal reference to them when necessary.
1142  /// Plug-ins also receive the output audio format(which stays the same during the lifespan of the plug-in) to be able to allocate memory and setup processing for a given channel configuration.
1143  /// Note that the channel configuration is suggestive and may even be specified as not AkChannelConfig::IsValid().The plugin is free to determine the true channel configuration(this is an io parameter).
1144  ///
1145  /// \return AK_Success if successful.
1146  /// \return AK_NotCompatible if the system doesn't support this sink type. Return this if you want to fall back to the default sinks. This sink will never be requested again. Do not return this code if the device is simply unplugged.
1147  /// \return AK_DeviceNotCompatible if the requested output device doesn't support this sink type. Return this if you want to fall back to the dummy audio sink, which will result in no audio for the associated bus hierarchy. This sink will never be requested again.
1148  /// All other return codes will be treated as temporary failures conditions and the sink will be requested again later.
1149 
1150  virtual AKRESULT Init(
1151  IAkPluginMemAlloc * in_pAllocator, ///< Interface to memory allocator to be used by the effect.
1152  IAkSinkPluginContext * in_pSinkPluginContext, ///< Interface to sink plug-in's context.
1153  IAkPluginParam * in_pParams, ///< Interface to plug-in parameters.
1154  AkAudioFormat & io_rFormat ///< Audio data format of the input signal. Note that the channel configuration is suggestive and may even be specified as not AkChannelConfig::IsValid(). The plugin is free to determine the true channel configuration.
1155  ) = 0;
1156 
1157  /// Obtain the number of audio frames that should be processed by the sound engine and presented
1158  /// to this plugin via AK::IAkSinkPlugin::Consume(). The size of a frame is determined by the sound engine and
1159  /// obtainable via AK::IAkPluginContextBase::GetMaxBufferLength().
1160  /// \return AK_Success if successful, AK_Fail if there was a critical error.
1161  /// \sa
1162  /// - AK::IAkSinkPlugin::Consume()
1163  /// - AK::IAkSinkPluginContext::SignalAudioThread()
1165  AkUInt32& out_uNumFramesNeeded ///< Returned number of audio frames needed.
1166  ) = 0;
1167 
1168  /// Called at the end of the audio frame. If no Consume calls were made prior to OnFrameEnd, this means no audio was sent to the device. Assume silence.
1169  /// \sa
1170  /// - AK::IAkSinkPlugin::Consume()
1171  virtual void OnFrameEnd() = 0;
1172 
1173  /// Ask the plug-in whether starvation occurred.
1174  /// \return True if starvation occurred, false otherwise.
1175  virtual bool IsStarved() = 0;
1176 
1177  /// Reset the "starvation" flag after IsStarved() returned true.
1178  virtual void ResetStarved() = 0;
1179 
1181  };
1182 
1183  /// Software interface for sink (audio endpoint) plugins.
1185  {
1186  protected:
1187  /// Virtual destructor on interface to avoid warnings.
1188  virtual ~IAkSinkPlugin() {}
1189 
1190  public:
1191  /// Present an audio buffer to the sink. The audio buffer is in the native format of the sound engine
1192  /// (typically float, deinterleaved), as specified by io_rFormat passed to Init(). It is up to the
1193  /// plugin to transform it into a format that is compatible with its output.
1194  /// Note that Consume() is not called if the output for this frame consists of silence. Plugins should
1195  /// detect this in OnFrameEnd().
1196  /// \sa
1197  /// - AK::IAkSinkPlugin::IsDataNeeded()
1198  /// - AK::IAkSinkPlugin::OnFrameEnd()
1199  virtual void Consume(
1200  AkAudioBuffer * in_pInputBuffer, ///< Input audio buffer data structure. Plugins should avoid processing data in-place.
1201  AkRamp in_gain ///< Volume gain to apply to this input (prev corresponds to the beginning, next corresponds to the end of the buffer).
1202  ) = 0;
1203 
1204  virtual AkSinkPluginType GetSinkPluginType() const override final { return AkSinkPluginType_Sink; }
1205  };
1206 
1207  /// Software plug-in interface for sink (audio end point) which supports 3D audio features.
1209  {
1210  protected:
1211  /// Virtual destructor on interface to avoid warnings.
1213 
1214  public:
1215  /// Returns the capabilities of the sink's 3D audio system
1217  Ak3DAudioSinkCapabilities& out_rCapabilities ///< Capabilities of the 3D Audio system
1218  ) = 0;
1219 
1220  /// Same as AK::IAkSinkPlugin::Consume(), but receives 3 inputs: the main mix,the stereo passthrough and 3d audio objects.
1221  /// \sa
1222  /// - AK::IAkSinkPlugin::Consume()
1223  /// - AK::IAkSinkPlugin::IsDataNeeded()
1224  /// - AK::IAkSinkPlugin::OnFrameEnd()
1225  virtual void Consume(
1226  AkAudioBuffer* in_pMainMix, ///< Audio buffer data structure for the main mix (binauralized or not, depending on if binauralization is supported and enabled).
1227  AkAudioBuffer* in_pPassthroughMix, ///< The stereo mix to send out to the system in passthrough fashion (no binauralization). NULL if the channel configuration of the device is not object-based or does not have a passthrough.
1228  const AkAudioObjects& in_objects, ///< 3D Audio objects and object audio buffers to be consumed. The audio buffers are in the native format of the sound engine (typically float, deinterleaved), as specified by io_rFormat passed to Init(). It is up to the plugin to transform it into a format that is compatible with its output.
1229  AkRamp in_gain ///< Volume gain to apply to all inputs.
1230  ) = 0;
1231 
1232  virtual AkSinkPluginType GetSinkPluginType() const override final { return AkSinkPluginType_3DAudioSink; }
1233  };
1234 
1235  /// Wwise sound engine source plug-in interface (see \ref soundengine_plugins_source).
1237  {
1238  protected:
1239  /// Virtual destructor on interface to avoid warnings.
1240  virtual ~IAkSourcePlugin(){}
1241 
1242  public:
1243  /// Source plug-in initialization. Gets the plug-in ready for data processing, allocates memory and sets up the initial conditions.
1244  /// \aknote Memory allocation should be done through the appropriate macros (see \ref fx_memory_alloc). \endaknote
1245  /// \sa
1246  /// - \ref iaksourceeffect_init
1247  virtual AKRESULT Init(
1248  IAkPluginMemAlloc * in_pAllocator, ///< Interface to the memory allocator to be used by the plug-in
1249  IAkSourcePluginContext * in_pSourcePluginContext, ///< Interface to the source plug-in's context
1250  IAkPluginParam * in_pParams, ///< Interface to the plug-in parameters
1251  AkAudioFormat & io_rFormat ///< Audio format of the output data to be produced by the plug-in (mono native by default)
1252  ) = 0;
1253 
1254  /// This method is called to determine the approximate duration of the source.
1255  /// \return The duration of the source, in milliseconds.
1256  /// \sa
1257  /// - \ref iaksourceeffect_getduration
1258  virtual AkReal32 GetDuration() const = 0;
1259 
1260  /// This method is called to determine the estimated envelope of the source.
1261  /// \return The estimated envelope of the data that will be generated in the next call to
1262  /// Execute(). The envelope value should be normalized to the highest peak of the entire
1263  /// duration of the source. Expected range is [0,1]. If envelope and peak value cannot be
1264  /// predicted, the source should return 1 (no envelope).
1265  /// \sa
1266  /// - \ref iaksourceeffect_getenvelope
1267  virtual AkReal32 GetEnvelope() const
1268  {
1269  return 1.f;
1270  }
1271 
1272  /// This method is called to tell the source to stop looping.
1273  /// This will typically be called when an action of type "break" will be triggered on the playing source.
1274  /// Break (or StopLooping) means: terminate gracefully... if possible. In most situations it finishes the current loop and plays the sound release if there is one.
1275  ///
1276  /// \return
1277  /// - \c AK_Success if the source ignores the break command and plays normally till the end or if the source support to stop looping and terminates gracefully.
1278  /// - \c AK_Fail if the source cannot simply stop looping, in this situation, the break command will end up stopping this source.
1279  /// \sa
1280  /// - \ref iaksourceeffect_stoplooping
1281  virtual AKRESULT StopLooping(){ return AK_Success; }
1282 
1283  /// This method is called to tell the source to seek to an arbitrary sample.
1284  /// This will typically be called when the game calls AK::SoundEngine::SeekOnEvent() where the event plays
1285  /// a sound that wraps this source plug-in.
1286  /// If the plug-in does not handle seeks, it should return AK_Success. If it returns AK_Fail, it will
1287  /// be terminated by the sound engine.
1288  ///
1289  /// \return
1290  /// - \c AK_Success if the source handles or ignores seek command.
1291  /// - \c AK_Fail if the source considers that seeking requests should provoke termination, for example, if
1292  /// the desired position is greater than the prescribed source duration.
1293  /// \sa
1294  /// - AK::SoundEngine::SeekOnEvent()
1295  virtual AKRESULT Seek(
1296  AkUInt32 /* in_uPosition */ ///< Position to seek to, in samples, at the rate specified in AkAudioFormat (see AK::IAkSourcePlugin::Init()).
1297  ) { return AK_Success; }
1298 
1299  /// Skips execution when the voice is virtual playing from elapsed time to simulate processing that would have taken place (e.g. update internal state) while
1300  /// avoiding most of the CPU hit of plug-in execution.
1301  /// Given the number of frames requested adjust the number of frames that would have been produced by a call to Execute() in the io_uFrames parameter and return and
1302  /// return AK_DataReady or AK_NoMoreData, depending if there would be audio output or not at that point.
1303  /// Returning AK_NotImplemented will trigger a normal execution of the voice (as if it was not virtual) thus not enabling the CPU savings of a proper from elapsed time behavior.
1304  /// Note that returning AK_NotImplemeted for a source plug-ins that support asynchronous processing will produce a 'resume' virtual voice behavior instead.
1306  AkUInt32 & /*io_uFrames */ ///< (Input) Number of frames that the audio buffer processing can advance (equivalent to MaxFrames()). The output value should be the number of frames that would be produced this execution.
1307  ) { return AK_NotImplemented; }
1308 
1309  /// Software effect plug-in DSP execution.
1310  /// \aknote The effect can output as much as wanted up to MaxFrames(). All sample frames passed uValidFrames at input time are
1311  /// not initialized and it is the responsibility of the effect to do so. When modifying the number of valid frames within execution
1312  /// (e.g. to flush delay lines) the effect should notify the pipeline by updating uValidFrames accordingly.
1313  /// \aknote The effect will stop being called by the pipeline when AK_NoMoreData is returned in the the eState field of the AkAudioBuffer structure.
1314  virtual void Execute(
1315  AkAudioBuffer * io_pBuffer ///< In/Out audio buffer data structure (in-place processing)
1316  ) = 0;
1317  };
1318 
1319 
1320  /// This function can be useful to convert from normalized floating point audio samples to HW-pipeline format samples.
1321  #define AK_FLOAT_TO_SAMPLETYPE( __in__ ) (__in__)
1322  /// This function can be useful to convert from normalized floating point audio samples to HW-pipeline format samples when the input is not not to exceed (-1,1) range.
1323  #define AK_FLOAT_TO_SAMPLETYPE_NOCLIP( __in__ ) (__in__)
1324  /// This function can be useful to convert from HW-pipeline format samples to normalized floating point audio samples.
1325  #define AK_SAMPLETYPE_TO_FLOAT( __in__ ) (__in__)
1326 
1327  #define AK_DBTOLIN( __db__ ) (powf(10.f,(__db__) * 0.05f))
1328 }
1329 
1330 /// Registered plugin creation function prototype.
1332 /// Registered plugin parameter node creation function prototype.
1334 /// Registered plugin device enumeration function prototype, used for providing lists of devices by plug-ins.
1336  AkUInt32& io_maxNumDevices, ///< In: The length of the out_deviceDescriptions array, or zero is out_deviceDescriptions is null. Out: If out_deviceDescriptions is not-null, this should be set to the number of entries in out_deviceDescriptions that was populated (and should be less-than-or-equal to the initial value). If out_deviceDescriptions is null, this should be set to the maximum number of devices that may be returned by this callback.
1337  AkDeviceDescription* out_deviceDescriptions ///< The output array of device descriptions. If this is not-null, there will be a number of entries equal to the input value of io_maxNumDevices.
1338  );
1339 
1340 struct AkPlatformInitSettings;
1341 struct AkInitSettings;
1342 
1343 namespace AK
1344 {
1346  {
1352  };
1353 
1354  /// Common interface for plug-in services accessed through the global plug-in context
1356  {
1357  protected:
1358  virtual ~IAkPluginService() {}
1359  };
1360 
1361  /// Global plug-in context used for plug-in registration/initialization.
1362  /// Games query this interface from the sound engine, via AK::SoundEngine::GetGlobalPluginContext. Plug-ins query it via IAkPluginContextBase::GlobalContext.
1364  {
1365  protected:
1366  /// Virtual destructor on interface to avoid warnings.
1368 
1369  public:
1370 
1371  /// Retrieve the streaming manager access interface.
1372  virtual IAkStreamMgr * GetStreamMgr() const = 0;
1373 
1374  /// Retrieve the maximum number of frames that Execute() will be called with for this effect.
1375  /// Can be used by the effect to make memory allocation at initialization based on this worst case scenario.
1376  /// \return Maximum number of frames.
1377  virtual AkUInt16 GetMaxBufferLength() const = 0;
1378 
1379  /// Query whether sound engine is in real-time or offline (faster than real-time) mode.
1380  /// \return true when sound engine is in offline mode, false otherwise.
1381  virtual bool IsRenderingOffline() const = 0;
1382 
1383  /// Retrieve the core sample rate of the engine. This sample rate applies to all effects except source plugins, which declare their own sample rate.
1384  /// \return Core sample rate.
1385  virtual AkUInt32 GetSampleRate() const = 0;
1386 
1387  /// Post a monitoring message or error string. This will be displayed in the Wwise capture
1388  /// log.
1389  /// \return AK_Success if successful, AK_Fail if there was a problem posting the message.
1390  /// In optimized mode, this function returns AK_NotCompatible.
1391  /// \remark This function is provided as a tracking tool only. It does nothing if it is
1392  /// called in the optimized/release configuration and return AK_NotCompatible.
1394  const char* in_pszError, ///< Message or error string to be displayed
1395  AK::Monitor::ErrorLevel in_eErrorLevel ///< Specifies whether it should be displayed as a message or an error
1396  ) = 0;
1397 
1398  /// Register a plug-in with the sound engine and set the callback functions to create the
1399  /// plug-in and its parameter node.
1400  /// \sa
1401  /// - \ref register_effects
1402  /// - \ref plugin_xml
1403  /// \return AK_Success if successful, AK_InvalidParameter if invalid parameters were provided or Ak_Fail otherwise. Possible reasons for an AK_Fail result are:
1404  /// - Insufficient memory to register the plug-in
1405  /// - Plug-in ID already registered
1406  /// \remarks
1407  /// Codecs and plug-ins must be registered before loading banks that use them.\n
1408  /// Loading a bank referencing an unregistered plug-in or codec will result in a load bank success,
1409  /// but the plug-ins will not be used. More specifically, playing a sound that uses an unregistered effect plug-in
1410  /// will result in audio playback without applying the said effect. If an unregistered source plug-in is used by an event's audio objects,
1411  /// posting the event will fail.
1413  AkPluginType in_eType, ///< Plug-in type (for example, source or effect)
1414  AkUInt32 in_ulCompanyID, ///< Company identifier (as declared in the plug-in description XML file)
1415  AkUInt32 in_ulPluginID, ///< Plug-in identifier (as declared in the plug-in description XML file)
1416  AkCreatePluginCallback in_pCreateFunc, ///< Pointer to the plug-in's creation function
1417  AkCreateParamCallback in_pCreateParamFunc ///< Pointer to the plug-in's parameter node creation function
1418  ) = 0;
1419 
1420  /// Register a codec type with the sound engine and set the callback functions to create the
1421  /// codec's file source and bank source nodes.
1422  /// \sa
1423  /// - \ref register_effects
1424  /// \return AK_Success if successful, AK_InvalidParameter if invalid parameters were provided, or Ak_Fail otherwise. Possible reasons for an AK_Fail result are:
1425  /// - Insufficient memory to register the codec
1426  /// - Codec ID already registered
1427  /// \remarks
1428  /// Codecs and plug-ins must be registered before loading banks that use them.\n
1429  /// Loading a bank referencing an unregistered plug-in or codec will result in a load bank success,
1430  /// but the plug-ins will not be used. More specifically, playing a sound that uses an unregistered effect plug-in
1431  /// will result in audio playback without applying the said effect. If an unregistered source plug-in is used by an event's audio objects,
1432  /// posting the event will fail.
1434  AkUInt32 in_ulCompanyID, ///< Company identifier (as declared in XML)
1435  AkUInt32 in_ulPluginID, ///< Plugin identifier (as declared in XML)
1436  AkCreateFileSourceCallback in_pFileCreateFunc, ///< Factory for streaming sources.
1437  AkCreateBankSourceCallback in_pBankCreateFunc ///< Factory for in-memory sources.
1438  ) = 0;
1439 
1440  /// Register a global callback function. This function will be called from the audio rendering thread, at the
1441  /// location specified by in_eLocation. This function will also be called from the thread calling
1442  /// AK::SoundEngine::Term with in_eLocation set to AkGlobalCallbackLocation_Term.
1443  /// For example, in order to be called at every audio rendering pass, and once during teardown for releasing resources, you would call
1444  /// RegisterGlobalCallback(AkPluginTypeEffect, MY_COMPANY_ID , MY_PLUGIN_ID, myCallback, AkGlobalCallbackLocation_BeginRender | AkGlobalCallbackLocation_Term, myCookie);
1445  /// \remarks
1446  /// A valid (not AkPluginTypeNone) Plugin Type, Company ID and valid (non-zero) Plug-in ID of the plug-in registering the callback must be provided to this function.
1447  /// The timing of the callback function will contribute to the timing of the plug-in registered (Total Plug-in CPU and Advanced Profiler Plug-in tab).
1448  /// Timers will be registered to callbacks at all locations except for \c AkGlobalCallbackLocation::AkGlobalCallbackLocation_Register and \c AkGlobalCallbackLocation::AkGlobalCallbackLocation_Term.
1449  /// It is only legal to call this function from inside the plug-in registration callback, exclusively when receiving \c AkGlobalCallbackLocation::AkGlobalCallbackLocation_Register.
1450  /// This function should not be called from inside the plug-in instance (e.g. in Init, Execute, etc.) to prevent deadlocks when processing plug-ins in parallel.
1451  /// It is illegal to call this function while already inside of a registered global callback.
1452  /// This function might stall for several milliseconds before returning.
1453  /// \sa
1454  /// - \ref fx_global_hooks
1455  /// - AK::IAkGlobalPluginContext::UnregisterGlobalCallback()
1456  /// - AkGlobalCallbackFunc
1457  /// - AkGlobalCallbackLocation
1459  AkPluginType in_eType, ///< A valid Plug-in type (for example, source or effect).
1460  AkUInt32 in_ulCompanyID, ///< Company identifier (as declared in the plug-in description XML file).
1461  AkUInt32 in_ulPluginID, ///< Plug-in identifier (as declared in the plug-in description XML file).
1462  AkGlobalCallbackFunc in_pCallback, ///< Function to register as a global callback.
1463  AkUInt32 in_eLocation = AkGlobalCallbackLocation_BeginRender, ///< Callback location defined in AkGlobalCallbackLocation. Bitwise OR multiple locations if needed.
1464  void * in_pCookie = NULL ///< User cookie.
1465  ) = 0;
1466 
1467  /// Unregister a global callback function, previously registered using RegisterGlobalCallback.
1468  /// \remarks
1469  /// It is only legal to call this function from inside the plug-in registration global callback, exclusively when receiving \c AkGlobalCallbackLocation::AkGlobalCallbackLocation_Term.
1470  /// This function should not be called from inside the plug-in instance (e.g. in Init, Execute, etc.) to prevent deadlocks when processing plug-ins in parallel.
1471  /// It is illegal to call this function while already inside of a registered global callback.
1472  /// This function might stall for several milliseconds before returning.
1473  /// \sa
1474  /// - \ref fx_global_hooks
1475  /// - AK::IAkGlobalPluginContext::RegisterGlobalCallback()
1476  /// - AkGlobalCallbackFunc
1477  /// - AkGlobalCallbackLocation
1479  AkGlobalCallbackFunc in_pCallback, ///< Function to unregister as a global callback.
1480  AkUInt32 in_eLocation = AkGlobalCallbackLocation_BeginRender ///< Must match in_eLocation as passed to RegisterGlobalCallback for this callback.
1481  ) = 0;
1482 
1483  /// Get the default allocator for plugins. This is useful for performing global initialization tasks shared across multiple plugin instances.
1485 
1486  /// \sa SetRTPCValue
1488  AkRtpcID in_rtpcID, ///< ID of the game parameter
1489  AkRtpcValue in_value, ///< Value to set
1490  AkGameObjectID in_gameObjectID = AK_INVALID_GAME_OBJECT,///< Associated game object ID
1491  AkTimeMs in_uValueChangeDuration = 0, ///< Duration during which the game parameter is interpolated towards in_value
1492  AkCurveInterpolation in_eFadeCurve = AkCurveInterpolation_Linear, ///< Curve type to be used for the game parameter interpolation
1493  bool in_bBypassInternalValueInterpolation = false ///< True if you want to bypass the internal "slew rate" or "over time filtering" specified by the sound designer. This is meant to be used when for example loading a level and you dont want the values to interpolate.
1494  ) = 0;
1495 
1496  /// Send custom game data to a plugin that resides on a bus (insert effect or mixer plugin).
1497  /// Data will be copied and stored into a separate list.
1498  /// Previous entry is deleted when a new one is sent.
1499  /// Set the data pointer to NULL to clear item from the list.
1500  /// This means that you cannot send different data to various instances of the plugin on a same bus.\endaknote
1501  /// \return AK_Success if data was sent successfully.
1503  AkUniqueID in_busID, ///< Bus ID
1504  AkGameObjectID in_busObjectID, ///< Bus Object ID
1505  AkPluginType in_eType, ///< Plug-in type (for example, source or effect)
1506  AkUInt32 in_uCompanyID, ///< Company identifier (as declared in the plug-in description XML file)
1507  AkUInt32 in_uPluginID, ///< Plug-in identifier (as declared in the plug-in description XML file)
1508  const void* in_pData, ///< The data blob
1509  AkUInt32 in_uSizeInBytes ///< Size of data
1510  ) = 0;
1511 
1512  /// Computes gain vector for encoding a source with angles in_fAzimuth and in_fElevation to full-sphere ambisonics with order in_uOrder.
1513  /// Ambisonic channels are ordered by ACN and use the SN3D convention.
1515  AkReal32 in_fAzimuth, ///< Incident angle, in radians [-pi,pi], where 0 is the front (positive values are clockwise).
1516  AkReal32 in_fElevation, ///< Incident angle, in radians [-pi/2,pi/2], where 0 is the azimuthal plane.
1517  AkChannelConfig in_cfgAmbisonics, ///< Determines number of gains in vector out_vVolumes.
1518  AK::SpeakerVolumes::VectorPtr out_vVolumes ///< Returned volumes (see AK::SpeakerVolumes::Vector services). Must be allocated prior to calling this function with the size returned by AK::SpeakerVolumes::Vector::GetRequiredSize() for the desired number of channels.
1519  ) = 0;
1520 
1521  /// Computes gain matrix for decoding an SN3D-normalized ACN-ordered ambisonic signal of order sqrt(in_cfgAmbisonics.uNumChannels)-1, with max-RE weighting function, on a (regularly) sampled sphere whose samples in_samples are
1522  /// expressed in left-handed cartesian coordinates, with unitary norm.
1523  /// This decoding technique is optimal for regular sampling.
1524  /// The returned matrix has in_cfgAmbisonics.uNumChannels inputs (rows) and in_uNumSamples outputs (columns), and is normalized by the number of samples.
1525  /// You may use the returned volume matrix with IAkPluginServiceMixer::MixNinNChannels.
1526  /// Supported ambisonic configurations are full-sphere 1st to 5th order.
1527  /// \return
1528  /// - \c AK_InvalidParameter if in_cfgAmbisonics is not an ambisonic configuration.
1529  /// - \c AK_InvalidParameter if in_cfgAmbisonics does not have enough channel for a valid ambisonic configuration of the specified order.
1530  /// - \c AK_InvalidParameter if in_samples contains non-normalized vectors (not unity length).
1531  /// - \c AK_Success otherwise.
1533  const AkVector in_samples[], ///< Array of vector samples expressed in left-handed cartesian coordinates, where (1,0,0) points towards the right and (0,1,0) points towards the top. Vectors must be normalized.
1534  AkUInt32 in_uNumSamples, ///< Number of points in in_samples.
1535  AkChannelConfig in_cfgAmbisonics, ///< Ambisonic configuration. Supported configurations are 1st to 5th order. Determines number of rows (input channels) in matrix out_mxVolume.
1536  AK::SpeakerVolumes::MatrixPtr out_mxVolume ///< Returned volume matrix of in_cfgAmbisonics.uNumChannels rows x in_uNumSamples colums. Must be allocated prior to calling this function with the size returned by AK::SpeakerVolumes::Matrix::GetRequiredSize() for the desired number of channels.
1537  ) = 0;
1538 
1539  /// Return an acoustic texture.
1540  /// \return The pointer to an acoustic texture if successful, NULL otherwise.
1542  AkAcousticTextureID in_AcousticTextureID ///< Acoustic Texture's ID
1543  ) = 0;
1544 
1545  /// Given an emitter-listener pair, compute the azimuth and elevation angles of the emitter relative to the listener.
1546  /// \return AK_Success if the listener referenced in the emitter-listener pair was found; azimuth and elevation.
1548  const AkEmitterListenerPair & in_pair, ///< Emitter-listener pair for which to compute azimuth and elevation angles.
1549  AkReal32 & out_fAzimuth, ///< Returned azimuthal angle, in radians.
1550  AkReal32 & out_fElevation ///< Returned elevation angle, in radians.
1551  ) const = 0;
1552 
1553  /// Get the platform init settings that the wwise sound engine has been initialized with.
1554  /// This function returns a null pointer if called with an instance of RenderFXGlobalContext.
1556 
1557  /// Get the init settings that the wwise sound engine has been initialized with
1558  /// This function returns a null pointer if called with an instance of RenderFXGlobalContext.
1559  virtual const AkInitSettings* GetInitSettings() const = 0;
1560 
1561  /// Gets the configured audio settings.
1562  /// Call this function to get the configured audio settings.
1563  ///
1564  /// \warning This function is not thread-safe.
1565  /// \warning Call this function only after the sound engine has been properly initialized.
1567  AkAudioSettings & out_audioSettings ///< Returned audio settings
1568  ) const = 0;
1569 
1570  /// Universal converter from string to ID for the sound engine.
1571  /// Calls AK::SoundEngine::GetIDFromString.
1572  /// \sa
1573  /// - <tt>AK::SoundEngine::GetIDFromString</tt>
1574  virtual AkUInt32 GetIDFromString(const char* in_pszString) const = 0;
1575 
1576  /// Synchronously posts an Event to the sound engine (by event ID).
1577  /// The callback function can be used to be noticed when markers are reached or when the event is finished.
1578  /// An array of wave file sources can be provided to resolve External Sources triggered by the event.
1579  /// \return The playing ID of the event launched, or AK_INVALID_PLAYING_ID if posting the event failed
1580  /// \remarks
1581  /// This function executes the actions contained in the event without going through the message queue.
1582  /// In order to do so it acquires the global Wwise sound engine lock. It should therefore only be called from one of the
1583  /// global engine hooks (see AK::IAkGlobalPluginContext::RegisterGlobalCallback).
1584  /// Use AK::IAkGlobalPluginContext::GetIDFromString() if you use event names (strings).
1585  /// \sa
1586  /// - <tt>AK::SoundEngine::PostEvent</tt>
1587  /// - <tt>AK::IAkGlobalPluginContext::RegisterGlobalCallback</tt>
1588  /// - <tt>AK::IAkGlobalPluginContext::GetIDFromString</tt>
1590  AkUniqueID in_eventID, ///< Unique ID of the event
1591  AkGameObjectID in_gameObjectID, ///< Associated game object ID
1592  AkUInt32 in_uFlags = 0, ///< Bitmask: see \ref AkCallbackType
1593  AkCallbackFunc in_pfnCallback = NULL, ///< Callback function
1594  void * in_pCookie = NULL, ///< Callback cookie that will be sent to the callback function along with additional information
1595  AkUInt32 in_cExternals = 0, ///< Optional count of external source structures
1596  AkExternalSourceInfo *in_pExternalSources = NULL,///< Optional array of external source resolution information
1597  AkPlayingID in_PlayingID = AK_INVALID_PLAYING_ID///< Optional (advanced users only) Specify the playing ID to target with the event. Will Cause active actions in this event to target an existing Playing ID. Let it be AK_INVALID_PLAYING_ID or do not specify any for normal playback.
1598  ) = 0;
1599 
1600  /// Executes a number of MIDI Events on all nodes that are referenced in the specified Event in an Action of type Play.
1601  /// Each MIDI event will be posted in AkMIDIPost::uOffset samples from the start of the current frame. The duration of
1602  /// a sample can be determined from the sound engine's audio settings, via a call to AK::IAkGlobalPluginContext::GetAudioSettings.
1603  /// \remarks
1604  /// This function executes the MIDI Events without going through the message queue.
1605  /// In order to do so it acquires the global Wwise sound engine lock. It should therefore only be called from one of the
1606  /// global engine hooks (see AK::IAkGlobalPluginContext::RegisterGlobalCallback).
1607  /// Use AK::IAkGlobalPluginContext::GetIDFromString() if you use event names (strings).
1608  /// \sa
1609  /// - <tt>AK::SoundEngine::PostMIDIOnEvent</tt>
1610  /// - <tt>AK::IAkGlobalPluginContext::GetAudioSettings</tt>
1611  /// - <tt>AK::IAkGlobalPluginContext::StopMIDIOnEventSync</tt>
1612  /// - <tt>AK::IAkGlobalPluginContext::RegisterGlobalCallback</tt>
1613  /// - <tt>AK::IAkGlobalPluginContext::GetIDFromString</tt>
1615  AkUniqueID in_eventID, ///< Unique ID of the Event
1616  AkGameObjectID in_gameObjectID, ///< Associated game object ID
1617  AkMIDIPost* in_pPosts, ///< MIDI Events to post
1618  AkUInt16 in_uNumPosts, ///< Number of MIDI Events to post
1619  bool in_bAbsoluteOffsets = false, ///< Whether AkMIDIPost::uOffset values are relative to current frame or absolute
1620  AkUInt32 in_uFlags = 0, ///< Bitmask: see \ref AkCallbackType
1621  AkCallbackFunc in_pfnCallback = NULL, ///< Callback function
1622  void * in_pCookie = NULL, ///< Callback cookie that will be sent to the callback function along with additional information
1623  AkPlayingID in_playingID = AK_INVALID_PLAYING_ID ///< Target playing ID
1624  ) = 0;
1625 
1626  /// Stops MIDI notes on all nodes that are referenced in the specified event in an action of type play,
1627  /// with the specified Game Object. Invalid parameters are interpreted as wildcards. For example, calling
1628  /// this function with in_eventID set to AK_INVALID_UNIQUE_ID will stop all MIDI notes for Game Object
1629  /// in_gameObjectID.
1630  /// \remarks
1631  /// This function stops the MIDI notes without going through the message queue.
1632  /// In order to do so it acquires the global Wwise sound engine lock. It should therefore only be called from one of the
1633  /// global engine hooks (see AK::IAkGlobalPluginContext::RegisterGlobalCallback).
1634  /// Use AK::IAkGlobalPluginContext::GetIDFromString() if you use event names (strings).
1635  /// \sa
1636  /// - <tt>AK::IAkGlobalPluginContext::PostMIDIOnEvent</tt>
1637  /// - <tt>AK::IAkGlobalPluginContext::GetIDFromString</tt>
1639  AkUniqueID in_eventID = AK_INVALID_UNIQUE_ID, ///< Unique ID of the Event
1640  AkGameObjectID in_gameObjectID = AK_INVALID_GAME_OBJECT, ///< Associated game object ID
1641  AkPlayingID in_playingID = AK_INVALID_PLAYING_ID ///< Target playing ID
1642  ) = 0;
1643 
1644  /// \return The gateway to platform-specific functionality
1645  /// \sa IAkPlatformContext
1647 
1648  /// Retrieves a plug-in service to provide specific "helper" functionality. Note that each service should provide
1649  /// macros that handle the casting to the appropriate service, and are recommended instead of calling this directly.
1650  /// Note that all plug-in service are statically allocated, and any references to them can be cached without lifetime checks.
1652  AkPluginServiceType in_pluginService ///< Enum value for the specific plug-in service to fetch
1653  ) const = 0;
1654 
1655  /// Obtains the current audio output buffer tick. This corresponds to the number of buffers produced by
1656  /// the sound engine since initialization.
1657  /// \return Tick count.
1658  virtual AkUInt32 GetBufferTick() const = 0;
1659  };
1660 
1661  /// Interface for the "Mixer" plug-in service, to handle mixing together of signals, or applying simple transforms
1663  {
1664  protected:
1666  public:
1667  /// N to N channels mix
1668  virtual void MixNinNChannels(
1669  AkAudioBuffer* in_pInputBuffer, ///< Input multichannel buffer.
1670  AkAudioBuffer* in_pMixBuffer, ///< Multichannel buffer with which the input buffer is mixed.
1671  AkReal32 in_fPrevGain, ///< Gain, corresponding to the beginning of the buffer, to apply uniformly to each mixed channel.
1672  AkReal32 in_fNextGain, ///< Gain, corresponding to the end of the buffer, to apply uniformly to each mixed channel.
1673  AK::SpeakerVolumes::ConstMatrixPtr in_mxPrevVolumes,///< In/out channel volume distribution corresponding to the beginning of the buffer (see AK::SpeakerVolumes::Matrix services).
1674  AK::SpeakerVolumes::ConstMatrixPtr in_mxNextVolumes ///< In/out channel volume distribution corresponding to the end of the buffer (see AK::SpeakerVolumes::Matrix services).
1675  ) = 0;
1676 
1677  /// 1 to N channels mix
1678  virtual void Mix1inNChannels(
1679  AkReal32* AK_RESTRICT in_pInChannel, ///< Input channel buffer.
1680  AkAudioBuffer* in_pMixBuffer, ///< Multichannel buffer with which the input buffer is mixed.
1681  AkReal32 in_fPrevGain, ///< Gain, corresponding to the beginning of the input channel.
1682  AkReal32 in_fNextGain, ///< Gain, corresponding to the end of the input channel.
1683  AK::SpeakerVolumes::ConstVectorPtr in_vPrevVolumes, ///< Output channel volume distribution corresponding to the beginning of the buffer (see AK::SpeakerVolumes::Vector services).
1684  AK::SpeakerVolumes::ConstVectorPtr in_vNextVolumes ///< Output channel volume distribution corresponding to the end of the buffer (see AK::SpeakerVolumes::Vector services).
1685  ) = 0;
1686 
1687  /// Single channel mix
1688  virtual void MixChannel(
1689  AkReal32* AK_RESTRICT in_pInBuffer, ///< Input channel buffer.
1690  AkReal32* AK_RESTRICT in_pOutBuffer, ///< Output channel buffer.
1691  AkReal32 in_fPrevGain, ///< Gain, corresponding to the beginning of the input channel.
1692  AkReal32 in_fNextGain, ///< Gain, corresponding to the end of the input channel.
1693  AkUInt16 in_uNumFrames ///< Number of frames to mix.
1694  ) = 0;
1695 
1696  /// Given non-interleaved audio in the provided in_pInputBuffer, will apply a ramping gain over the number
1697  /// of frames specified, and store the result in in_pOutputBuffer. Channel data from in_pInputBuffer will also be
1698  /// interleaved in in_pOutputBuffer's results, and optionally converted from 32-bit floats to 16-bit integers.
1700  AkAudioBuffer* in_pInputBuffer, ///< Input audioBuffer data
1701  AkAudioBuffer* in_pOutputBuffer, ///< Output audioBuffer data
1702  AkRamp in_gain, ///< Ramping gain to apply over duration of buffer
1703  bool in_convertToInt16 ///< Whether the input data should be converted to int16
1704  ) const = 0;
1705 
1706  /// Given non-interleaved audio in the provided in_pInputBuffer, will apply a ramping gain over the number
1707  /// of frames specified, and store the result in in_pOutputBuffer. Audio data in in_pOutputBuffer will have
1708  /// the same layout as in_pInputBuffer, and optionally converted from 32-bit floats to 16-bit integers.
1709  virtual void ApplyGain(
1710  AkAudioBuffer* in_pInputBuffer, ///< Input audioBuffer data
1711  AkAudioBuffer* in_pOutputBuffer, ///< Output audioBuffer data
1712  AkRamp in_gain, ///< Ramping gain to apply over duration of buffer
1713  bool in_convertToInt16 ///< Whether the input data should be converted to int16
1714  ) const = 0;
1715  };
1716 
1717  /// Interface for the services related to generating pseudorandom numbers
1718  /// \sa
1719  /// - <tt>AK::SoundEngine::SetRandomSeed()</tt>
1720  /// - <tt>CAkRng</tt>
1722  {
1723  protected:
1725  public:
1726  /// Advances and returns a PRNG seed that a plug-in may use in its own RNG for DSP processing
1727  /// This is the same seed used for the internal sound engine randomization.
1728  virtual AkUInt64 RandomSeed() const = 0;
1729 
1730  /// Advances the internal PRNG seed, and returns a random number generator suitable for DSP processing
1731  virtual CAkRng CreateRNG() const = 0;
1732  };
1733 
1734  /// Interface for the services related to extracting attenuation curves from audio objects and using them.
1736  {
1737  protected:
1739  public:
1740 
1741  /// Obtain the unique ID of the Attenuation curves attached to the provided audio object.
1742  /// \return The unique ID of the Attenuation curves (Shareset or Custom). AK_INVALID_UNIQUE_ID if not the audio object does not have Attenuation curves.
1744  const AkAudioObject& in_object ///< Audio object from which to get the attenuation ID.
1745  ) const = 0;
1746 
1747  /// Extract the curve of a given type from the set of Attenuation curves attached to the given audio object.
1748  /// The curve's data is copied into an opaque data structure, pointed to by out_curve.
1749  /// The curve's data remain until the client of this service calls AK::IAkPluginServiceAttenuationCurve::Delete.
1750  /// \return true if the copy succeeded, or if the requested curve was not initialized.
1751  virtual bool ExtractCurves(
1752  IAkPluginMemAlloc* in_pAllocator, ///< Memory allocator.
1753  const AkAudioObject & in_object, ///< The audio object from which to extract the curve.
1754  AkUInt32 in_curveTypesMask, ///< The set of curves, identified with a mask of bits offset by AkAttenuationCurveType values, to extract from the set of Attenuation curves. For example, set to (1 << AttenuationCurveID_VolumeDry | 1 << AttenuationCurveID_Spread) to obtain the distance-driven dry volume and spread curves.
1755  void* out_curves[] ///< The returned addresses of the requested curve data. Pass in an array of void* with length corresponding to the number of desired curves. For each curve, if it exists, a blob of data is allocated by the function and the address is returned in the corresponding item of the out_curves. The item is set to nullptr if the curve does not exist.
1756  ) const = 0;
1757 
1758  /// Free memory of curve obtained with AK::IAkPluginServiceAttenuationCurve::ExtractCurves.
1759  virtual void Delete(
1760  IAkPluginMemAlloc* in_pAllocator, ///< Memory allocator.
1761  void*& io_attenuationCurve ///< Curve to delete.
1762  ) = 0;
1763 
1764  /// Evaluate the value of a curve at given x coordinate.
1766  void*& io_attenuationCurve, ///< Curve to evaluate.
1767  AkReal32 x ///< Value on the abscissa.
1768  ) = 0;
1769 
1770  /// Some curves are serialized in the log domain. Use this function to convert all the points to linear at once.
1771  virtual void Linearize(void*& io_attenuationCurve) = 0;
1772 
1773  /// Get the ith point of the curve.
1774  virtual const AkRTPCGraphPoint& GetPoint(
1775  const void* in_attenuationCurve, ///< Curve.
1776  AkUInt32 i ///< Point index. Must be between 0 and AK::IAkPluginServiceAttenuationCurve::GetNumPoints-1 inclusively.
1777  ) const = 0;
1778 
1779  /// Get the number of points on a curve.
1781  const void* in_attenuationCurve ///< Curve.
1782  ) const = 0;
1783  };
1784 
1785  /// Interface for the audio object priority service, to retrieve and update playback priority on audio objects.
1786  /// Playback priority of the audio object may be used by the audio endpoint when there are more audio objects than the available hardware objects
1787  /// to determine which audio objects should be mixed as hardware objects in priority and which can be mixed to a lower resolution 3D bed.
1788  /// \sa
1789  /// - <a href="https://www.audiokinetic.com/library/edge/?source=Help&id=defining_playback_priority" target="_blank">Defining Playback Priority</a>
1790  /// - <tt>AkAudioObject</tt>
1791  /// - <tt>AkPriority</tt>
1793  {
1794  protected:
1796  public:
1797  /// Populates <tt>out_pPriorities</tt> with playback priorities for objects in <tt>in_ppObjects</tt>.
1798  virtual void GetPriorities(
1799  AkAudioObject** in_ppObjects, ///< Array of pointers to audio objects to extract priorites from.
1800  AkUInt32 in_uNumObjects, ///< The number of audio objects in <tt>in_ppObjects</tt>. Must correspond to the number of priorites in <tt>out_pPriorities</tt>.
1801  AkPriority* out_pPriorities ///< Priorities to fill from <tt>in_ppObjects</tt>. Must be large enough to contain <tt>in_uNumObjects</tt> priorities.
1802  ) = 0;
1803 
1804  /// Sets the playback priority of each of the <tt>in_uNumObjects</tt> audio objects in <tt>io_ppObjects</tt> from <tt>in_pPriorities</tt>.
1805  virtual void SetPriorities(
1806  AkAudioObject** io_ppObjects, ///< Array of pointers to audio objects for which to update the playback priority.
1807  AkUInt32 in_uNumObjects, ///< The number of audio objects in <tt>in_ppObjects</tt>. Must correspond to the number of priorites in <tt>in_pPriorities</tt>.
1808  AkPriority* in_pPriorities ///< Array of priorities to set on <tt>in_ppObjects</tt>. Must contain <tt>in_uNumObjects</tt> priorities.
1809  ) = 0;
1810  };
1811 
1812  #define AK_GET_PLUGIN_SERVICE_MIXER(plugin_ctx) static_cast<AK::IAkPluginServiceMixer*>(plugin_ctx->GetPluginService(AK::PluginServiceType_Mixer))
1813  #define AK_GET_PLUGIN_SERVICE_RNG(plugin_ctx) static_cast<AK::IAkPluginServiceRNG*>(plugin_ctx->GetPluginService(AK::PluginServiceType_RNG))
1814  #define AK_GET_PLUGIN_SERVICE_AUDIO_OBJECT_ATTENUATION(plugin_ctx) static_cast<AK::IAkPluginServiceAudioObjectAttenuation*>(plugin_ctx->GetPluginService(AK::PluginServiceType_AudioObjectAttenuation))
1815  #define AK_GET_PLUGIN_SERVICE_AUDIO_OBJECT_PRIORITY(plugin_ctx) static_cast<AK::IAkPluginServiceAudioObjectPriority*>(plugin_ctx->GetPluginService(AK::PluginServiceType_AudioObjectPriority))
1816 
1817  /// This class takes care of the registration of plug-ins in the Wwise engine. Plug-in developers must provide one instance of this class for each plug-in.
1818  /// \sa
1819  /// - \ref soundengine_plugins
1821  {
1822  public:
1824  AkUInt32 in_ulCompanyID, ///< Plugin company ID.
1825  AkUInt32 in_ulPluginID ///< Plugin ID.
1826  )
1827  {
1828  // Placeholder used for plug-in extensions (plug-ins that modify the behavior of an existing plug-in without registering a new ID)
1829  }
1830 
1832  AkPluginType in_eType, ///< Plugin type.
1833  AkUInt32 in_ulCompanyID, ///< Plugin company ID.
1834  AkUInt32 in_ulPluginID, ///< Plugin ID.
1835  AkCreatePluginCallback in_pCreateFunc, ///< Plugin object factory.
1836  AkCreateParamCallback in_pCreateParamFunc, ///< Plugin parameter object factory.
1837  AkGlobalCallbackFunc in_pRegisterCallback = NULL, ///< Optional callback function called after successful plugin registration, with argument AkGlobalCallbackLocation_Register.
1838  void * in_pRegisterCallbackCookie = NULL ///< Optional cookie passed to register callback function above.
1839  )
1841  , m_eType(in_eType)
1842  , m_ulCompanyID(in_ulCompanyID)
1843  , m_ulPluginID(in_ulPluginID)
1844  , m_pCreateFunc(in_pCreateFunc)
1845  , m_pCreateParamFunc(in_pCreateParamFunc)
1846  , m_pFileCreateFunc(NULL) // Legacy
1847  , m_pBankCreateFunc(NULL) // Legacy
1848  , m_pRegisterCallback(in_pRegisterCallback)
1849  , m_pRegisterCallbackCookie(in_pRegisterCallbackCookie)
1851  , m_CodecDescriptor{ nullptr, nullptr, nullptr, nullptr }
1852  {
1853  g_pAKPluginList = this;
1854  }
1855 
1857  AkPluginType in_eType, ///< Plugin type.
1858  AkUInt32 in_ulCompanyID, ///< Plugin company ID.
1859  AkUInt32 in_ulPluginID, ///< Plugin ID.
1860  AkCreatePluginCallback in_pCreateFunc, ///< Plugin object factory.
1861  AkCreateParamCallback in_pCreateParamFunc, ///< Plugin parameter object factory.
1862  AkGetDeviceListCallback in_pGetDeviceListFunc, ///< Plugin parameter object factory.
1863  AkGlobalCallbackFunc in_pRegisterCallback = NULL, ///< Optional callback function called after successful plugin registration, with argument AkGlobalCallbackLocation_Register.
1864  void * in_pRegisterCallbackCookie = NULL ///< Optional cookie passed to register callback function above.
1865  )
1867  , m_eType(in_eType)
1868  , m_ulCompanyID(in_ulCompanyID)
1869  , m_ulPluginID(in_ulPluginID)
1870  , m_pCreateFunc(in_pCreateFunc)
1871  , m_pCreateParamFunc(in_pCreateParamFunc)
1872  , m_pFileCreateFunc(NULL) // Legacy
1873  , m_pBankCreateFunc(NULL) // Legacy
1874  , m_pRegisterCallback(in_pRegisterCallback)
1875  , m_pRegisterCallbackCookie(in_pRegisterCallbackCookie)
1876  , m_pGetDeviceListFunc(in_pGetDeviceListFunc)
1877  , m_CodecDescriptor{ nullptr, nullptr, nullptr, nullptr }
1878  {
1879  g_pAKPluginList = this;
1880  }
1881 
1883  AkUInt32 in_ulCompanyID, ///< Plugin company ID.
1884  AkUInt32 in_ulPluginID, ///< Plugin ID.
1885  AkCreateFileSourceCallback in_pCreateFile, ///< Streamed source factory.
1886  AkCreateBankSourceCallback in_pCreateBank) ///< In-memory source factory.
1889  , m_ulCompanyID(in_ulCompanyID)
1890  , m_ulPluginID(in_ulPluginID)
1891  , m_pCreateFunc(NULL)
1893  , m_pFileCreateFunc(in_pCreateFile) // Legacy
1894  , m_pBankCreateFunc(in_pCreateBank) // Legacy
1898  , m_CodecDescriptor{ in_pCreateFile, in_pCreateBank, nullptr, nullptr }
1899  {
1900  g_pAKPluginList = this;
1901  }
1902 
1904  AkUInt32 in_ulCompanyID, ///< Plugin company ID.
1905  AkUInt32 in_ulPluginID, ///< Plugin ID.
1906  const AkCodecDescriptor &in_Descriptor) ///< Codec descriptor.
1909  , m_ulCompanyID(in_ulCompanyID)
1910  , m_ulPluginID(in_ulPluginID)
1911  , m_pCreateFunc(NULL)
1913  , m_pFileCreateFunc(in_Descriptor.pFileSrcCreateFunc) // Legacy
1914  , m_pBankCreateFunc(in_Descriptor.pBankSrcCreateFunc) // Legacy
1918  , m_CodecDescriptor(in_Descriptor)
1919  {
1920  g_pAKPluginList = this;
1921  }
1922 
1929  AkCreateFileSourceCallback m_pFileCreateFunc; ///< LEGACY: Kept for compatibility with 2019.1. Unused in 2019.2 and up.
1930  AkCreateBankSourceCallback m_pBankCreateFunc; ///< LEGACY: Kept for compatibility with 2019.1. Unused in 2019.2 and up.
1933 
1934  // 2019.2 added parameters
1937  };
1938 }
1939 
1940 #define AK_IMPLEMENT_PLUGIN_FACTORY(_pluginName_, _plugintype_, _companyid_, _pluginid_) \
1941  AK::IAkPlugin* Create##_pluginName_(AK::IAkPluginMemAlloc * in_pAllocator); \
1942  AK::IAkPluginParam * Create##_pluginName_##Params(AK::IAkPluginMemAlloc * in_pAllocator); \
1943  AK_ATTR_USED AK::PluginRegistration _pluginName_##Registration(_plugintype_, _companyid_, _pluginid_, Create##_pluginName_, Create##_pluginName_##Params);
1944 
1945 #define AK_STATIC_LINK_PLUGIN(_pluginName_) \
1946  extern AK::PluginRegistration _pluginName_##Registration; \
1947  void *_pluginName_##_linkonceonly = (void*)&_pluginName_##Registration;
1948 
1949 #define DEFINE_PLUGIN_REGISTER_HOOK AK_DLLEXPORT AK::PluginRegistration * g_pAKPluginList = NULL;
1950 
1951 #define AK_GET_SINK_TYPE_FROM_DEVICE_KEY(_key) ((AkUInt32)(_key & 0xffffffff))
1952 #define AK_GET_DEVICE_ID_FROM_DEVICE_KEY(_key) ((AkUInt32)(_key >> 32))
1953 
1954 #endif // _IAK_PLUGIN_H_
virtual AkUInt16 GetNumRefillsInVoice()=0
Interface to retrieve contextual information for a mixer.
Definition: IAkPlugin.h:442
virtual AKRESULT RegisterPlugin(AkPluginType in_eType, AkUInt32 in_ulCompanyID, AkUInt32 in_ulPluginID, AkCreatePluginCallback in_pCreateFunc, AkCreateParamCallback in_pCreateParamFunc)=0
AkCreateFileSourceCallback m_pFileCreateFunc
LEGACY: Kept for compatibility with 2019.1. Unused in 2019.2 and up.
Definition: IAkPlugin.h:1929
virtual AKRESULT Init(IAkPluginMemAlloc *in_pAllocator, IAkSinkPluginContext *in_pSinkPluginContext, IAkPluginParam *in_pParams, AkAudioFormat &io_rFormat)=0
virtual void Consume(AkAudioBuffer *in_pMainMix, AkAudioBuffer *in_pPassthroughMix, const AkAudioObjects &in_objects, AkRamp in_gain)=0
virtual AKRESULT SetRTPCValue(AkRtpcID in_rtpcID, AkRtpcValue in_value, AkGameObjectID in_gameObjectID=AK_INVALID_GAME_OBJECT, AkTimeMs in_uValueChangeDuration=0, AkCurveInterpolation in_eFadeCurve=AkCurveInterpolation_Linear, bool in_bBypassInternalValueInterpolation=false)=0
virtual AkUInt64 RandomSeed() const =0
uint16_t AkUInt16
Unsigned 16-bit integer.
Software plug-in interface for sink (audio end point) which supports 3D audio features.
Definition: IAkPlugin.h:1209
virtual AkUniqueID GetAudioNodeID() const =0
AkInt32 AkTimeMs
Time in ms.
Definition: AkTypes.h:124
Audiokinetic namespace.
virtual ~IAkPluginParam()
Virtual destructor on interface to avoid warnings.
Definition: IAkPlugin.h:622
virtual AKRESULT TimeSkip(AkUInt32 in_uFrames)=0
virtual void * GetCookie() const =0
virtual AkPriority ComputePriorityWithDistance(AkReal32 in_fDistance) const =0
bool bIsDeviceEffect
Plug-in can process final mixes and objects right before sending them to the audio device for output....
Definition: IAkPlugin.h:79
AkPluginServiceType
Definition: IAkPlugin.h:1346
virtual bool IsStarved()=0
virtual IAkGlobalPluginContext * GlobalContext() const =0
virtual const AkRTPCGraphPoint & GetPoint(const void *in_attenuationCurve, AkUInt32 i) const =0
Get the ith point of the curve.
AK_DLLEXPORT AK::PluginRegistration * g_pAKPluginList
Definition: IAkPlugin.h:89
virtual ~IAkGlobalPluginContext()
Virtual destructor on interface to avoid warnings.
Definition: IAkPlugin.h:1367
virtual AKRESULT Term(IAkPluginMemAlloc *in_pAllocator)=0
Software effect plug-in interface (see Creating Sound Engine Effect Plug-ins).
Definition: IAkPlugin.h:758
virtual AKRESULT GetDistanceProbe(AkGameObjectID in_uListener, AkWorldTransform &out_position) const =0
virtual CAkRng CreateRNG() const =0
Advances the internal PRNG seed, and returns a random number generator suitable for DSP processing.
virtual AKRESULT PostMonitorData(void *in_pData, AkUInt32 in_uDataSize)=0
virtual AKRESULT Init(IAkPluginMemAlloc *in_pAllocator, IAkEffectPluginContext *in_pEffectPluginContext, IAkPluginParam *in_pParams, AkAudioFormat &io_rFormat)=0
virtual void SetPriorities(AkAudioObject **io_ppObjects, AkUInt32 in_uNumObjects, AkPriority *in_pPriorities)=0
Sets the playback priority of each of the in_uNumObjects audio objects in io_ppObjects from in_pPrior...
#define AK_DLLEXPORT
Wwise sound engine source plug-in interface (see Creating Sound Engine Source Plug-ins).
Definition: IAkPlugin.h:1237
virtual AkReal32 GetSpread(AkUInt32 in_uIndex)=0
virtual AkUInt16 GetNumLoops() const =0
IAkSoftwareCodec *(* AkCreateFileSourceCallback)(void *in_pCtx)
Registered file source creation function prototype.
Definition: AkTypes.h:1098
virtual void EnableMetering(AkMeteringFlags in_eFlags)=0
AkUInt32 AkRtpcID
Real time parameter control ID.
Definition: AkTypes.h:141
virtual AKRESULT IsDataNeeded(AkUInt32 &out_uNumFramesNeeded)=0
virtual ~IAkSinkPluginContext()
Virtual destructor on interface to avoid warnings.
Definition: IAkPlugin.h:1076
virtual IAkMixerPluginContext * GetMixerCtx()=0
virtual bool SupportMediaRelocation() const
Definition: IAkPlugin.h:729
AkCreateParamCallback m_pCreateParamFunc
Definition: IAkPlugin.h:1928
virtual AKRESULT SetParam(AkPluginParamID in_paramID, const void *in_pValue, AkUInt32 in_uParamSize)=0
virtual AKRESULT StopMIDIOnEventSync(AkUniqueID in_eventID=AK_INVALID_UNIQUE_ID, AkGameObjectID in_gameObjectID=AK_INVALID_GAME_OBJECT, AkPlayingID in_playingID=AK_INVALID_PLAYING_ID)=0
virtual void MixNinNChannels(AkAudioBuffer *in_pInputBuffer, AkAudioBuffer *in_pMixBuffer, AkReal32 in_fPrevGain, AkReal32 in_fNextGain, AK::SpeakerVolumes::ConstMatrixPtr in_mxPrevVolumes, AK::SpeakerVolumes::ConstMatrixPtr in_mxNextVolumes)=0
N to N channels mix.
AkUInt64 AkGameObjectID
Game object ID.
Definition: AkTypes.h:128
bool bCanRunOnObjectConfig
Plug-in can run on bus with Audio Object configuration. Effect plug-ins are instantiated once per Aud...
Definition: IAkPlugin.h:80
virtual AkUInt32 GetSampleRate() const =0
virtual void GetPannerPosition(AkVector &out_position)=0
virtual AKRESULT SendPluginCustomGameData(AkUniqueID in_busID, AkGameObjectID in_busObjectID, AkPluginType in_eType, AkUInt32 in_uCompanyID, AkUInt32 in_uPluginID, const void *in_pData, AkUInt32 in_uSizeInBytes)=0
bool bUsesGainAttribute
Plug-in knows how to process objects separately from the cumulativeGain of the object (or the process...
Definition: IAkPlugin.h:81
AKRESULT
Standard function call result.
Definition: AkTypes.h:199
AKRESULT(* AkGetDeviceListCallback)(AkUInt32 &io_maxNumDevices, AkDeviceDescription *out_deviceDescriptions)
Registered plugin device enumeration function prototype, used for providing lists of devices by plug-...
Definition: IAkPlugin.h:1335
virtual IAkVoicePluginInfo * GetVoiceInfo()=0
void(* AkGlobalCallbackFunc)(AK::IAkGlobalPluginContext *in_pContext, AkGlobalCallbackLocation in_eLocation, void *in_pCookie)
Definition: AkCallback.h:368
AkMeteringFlags
Metering flags. Used for specifying bus metering, through AK::SoundEngine::RegisterBusVolumeCallback(...
Definition: AkTypes.h:1207
virtual AkUniqueID GetAttenuationID(const AkAudioObject &in_object) const =0
bool bIsInPlace
Buffer usage (in-place or not). If true, and the plug-in is an insert effect, it should implement IAk...
Definition: IAkPlugin.h:75
virtual AkUInt32 GetIDFromString(const char *in_pszString) const =0
AkSinkPluginType
Definition: IAkPlugin.h:1122
virtual AKRESULT ComputeWeightedAmbisonicsDecodingFromSampledSphere(const AkVector in_samples[], AkUInt32 in_uNumSamples, AkChannelConfig in_cfgAmbisonics, AK::SpeakerVolumes::MatrixPtr out_mxVolume)=0
AkCreatePluginCallback m_pCreateFunc
Definition: IAkPlugin.h:1927
Common interface for plug-in services accessed through the global plug-in context.
Definition: IAkPlugin.h:1356
virtual ~IAkAudioDeviceEffectPlugin()
Virtual destructor on interface to avoid warnings.
Definition: IAkPlugin.h:890
Definition: AkRng.h:35
Interface for the "Mixer" plug-in service, to handle mixing together of signals, or applying simple t...
Definition: IAkPlugin.h:1663
virtual ~IAk3DAudioSinkPlugin()
Virtual destructor on interface to avoid warnings.
Definition: IAkPlugin.h:1212
virtual AkPriority GetPriority() const =0
virtual ~IAkGameObjectPluginInfo()
Virtual destructor on interface to avoid warnings.
Definition: IAkPlugin.h:103
virtual ~IAkPluginContextBase()
Virtual destructor on interface to avoid warnings.
Definition: IAkPlugin.h:241
AkUInt32 AkChannelMask
Channel mask (similar to WAVE_FORMAT_EXTENSIBLE). Bit values are defined in AkSpeakerConfig....
Definition: AkTypes.h:149
PluginRegistration(AkUInt32 in_ulCompanyID, AkUInt32 in_ulPluginID, AkCreateFileSourceCallback in_pCreateFile, AkCreateBankSourceCallback in_pCreateBank)
Definition: IAkPlugin.h:1882
virtual void MixChannel(AkReal32 *AK_RESTRICT in_pInBuffer, AkReal32 *AK_RESTRICT in_pOutBuffer, AkReal32 in_fPrevGain, AkReal32 in_fNextGain, AkUInt16 in_uNumFrames)=0
Single channel mix.
virtual AKRESULT ComputePlanarVBAPGains(AkReal32 in_fAngle, AkChannelConfig in_outputConfig, AkReal32 in_fCenterPerc, AK::SpeakerVolumes::VectorPtr out_vVolumes)=0
virtual bool ExtractCurves(IAkPluginMemAlloc *in_pAllocator, const AkAudioObject &in_object, AkUInt32 in_curveTypesMask, void *out_curves[]) const =0
uint8_t AkUInt8
Unsigned 8-bit integer.
virtual void GetPluginMedia(AkUInt32 in_dataIndex, AkUInt8 *&out_rpData, AkUInt32 &out_rDataSize)=0
virtual void GetSpatializedVolumes(AK::SpeakerVolumes::MatrixPtr out_mxPrevVolumes, AK::SpeakerVolumes::MatrixPtr out_mxNextVolumes)=0
virtual void Execute(AkAudioBuffer *io_pBuffer)=0
PluginRegistration(AkPluginType in_eType, AkUInt32 in_ulCompanyID, AkUInt32 in_ulPluginID, AkCreatePluginCallback in_pCreateFunc, AkCreateParamCallback in_pCreateParamFunc, AkGlobalCallbackFunc in_pRegisterCallback=NULL, void *in_pRegisterCallbackCookie=NULL)
Definition: IAkPlugin.h:1831
virtual IAkProcessorFeatures * GetProcessorFeatures()=0
Return an interface to query processor specific features.
virtual void GetOutputObjects(AkAudioObjects &io_objects)=0
#define NULL
Definition: AkTypes.h:46
float AkReal32
32-bit floating point
PluginRegistration(AkPluginType in_eType, AkUInt32 in_ulCompanyID, AkUInt32 in_ulPluginID, AkCreatePluginCallback in_pCreateFunc, AkCreateParamCallback in_pCreateParamFunc, AkGetDeviceListCallback in_pGetDeviceListFunc, AkGlobalCallbackFunc in_pRegisterCallback=NULL, void *in_pRegisterCallbackCookie=NULL)
Definition: IAkPlugin.h:1856
virtual ~IAkMixerInputContext()
Virtual destructor on interface to avoid warnings.
Definition: IAkPlugin.h:917
@ PluginServiceType_AudioObjectAttenuation
Definition: IAkPlugin.h:1349
@ AK_Success
The operation was successful.
Definition: AkTypes.h:201
virtual AkUInt16 GetMaxBufferLength() const =0
@ AkSinkPluginType_Sink
Definition: IAkPlugin.h:1123
bool bCanChangeRate
True for effects whose sample throughput is different between input and output. Effects that can chan...
Definition: IAkPlugin.h:76
virtual void Mix1inNChannels(AkReal32 *AK_RESTRICT in_pInChannel, AkAudioBuffer *in_pMixBuffer, AkReal32 in_fPrevGain, AkReal32 in_fNextGain, AK::SpeakerVolumes::ConstVectorPtr in_vPrevVolumes, AK::SpeakerVolumes::ConstVectorPtr in_vNextVolumes)=0
1 to N channels mix
Position and orientation of game objects in the world (i.e. supports 64-bit-precision position)
Definition: AkTypes.h:474
Emitter-listener pair: Positioning data pertaining to a single pair of emitter and listener.
Definition: AkTypes.h:797
PluginRegistration(AkUInt32 in_ulCompanyID, AkUInt32 in_ulPluginID)
Definition: IAkPlugin.h:1823
virtual bool HasListenerRelativeRouting()=0
AkPluginInfo()
Constructor for default values.
Definition: IAkPlugin.h:61
virtual void Delete(IAkPluginMemAlloc *in_pAllocator, void *&io_attenuationCurve)=0
Free memory of curve obtained with AK::IAkPluginServiceAttenuationCurve::ExtractCurves.
virtual IAkGameObjectPluginInfo * GetGameObjectInfo()=0
virtual bool GetMaxAttenuationDistance(AkReal32 &out_fMaxAttenuationDistance)=0
virtual AKRESULT GetGameObjectPosition(AkUInt32 in_uIndex, AkSoundPosition &out_position) const =0
virtual AKRESULT GetPluginInfo(AkPluginInfo &out_rPluginInfo)=0
Software interface for sink (audio endpoint) plugins.
Definition: IAkPlugin.h:1185
virtual void SetUserData(void *in_pUserData)=0
virtual bool IsSendModeEffect() const =0
virtual IAkVoicePluginInfo * GetVoiceInfo()=0
virtual void OnFrameEnd()=0
virtual AKRESULT PostMonitorMessage(const char *in_pszError, AK::Monitor::ErrorLevel in_eErrorLevel)=0
Software effect plug-in interface for out-of-place processing (see Creating Sound Engine Effect Plug-...
Definition: IAkPlugin.h:802
AkReal32 * VectorPtr
Volume vector. Access each element with the standard bracket [] operator.
virtual ~IAkMixerPluginContext()
Virtual destructor on interface to avoid warnings.
Definition: IAkPlugin.h:445
virtual AkSinkPluginType GetSinkPluginType() const override final
Definition: IAkPlugin.h:1232
virtual void GetPriorities(AkAudioObject **in_ppObjects, AkUInt32 in_uNumObjects, AkPriority *out_pPriorities)=0
Populates out_pPriorities with playback priorities for objects in in_ppObjects.
@ PluginServiceType_MAX
Definition: IAkPlugin.h:1351
virtual Ak3DSpatializationMode Get3DSpatializationMode()=0
virtual AkPlayingID GetPlayingID() const =0
Retrieve the Playing ID of the event corresponding to this voice (if applicable).
Interface for the services related to extracting attenuation curves from audio objects and using them...
Definition: IAkPlugin.h:1736
AkUInt32 AkUniqueID
Unique 32-bit ID.
Definition: AkTypes.h:120
virtual AkReal32 GetFocus(AkUInt32 in_uIndex)=0
Configured audio settings.
Definition: AkTypes.h:285
Ak3DSpatializationMode
3D spatialization mode.
Definition: AkTypes.h:1189
virtual AKRESULT SignalAudioThread()=0
@ PluginServiceType_RNG
Definition: IAkPlugin.h:1348
AkUInt32 AkPluginID
Source or effect plug-in ID.
Definition: AkTypes.h:131
virtual AkReal32 GetEnvelope() const
Definition: IAkPlugin.h:1267
virtual void Execute(const AkAudioObjects &io_objects)=0
virtual AKRESULT Init(IAkPluginMemAlloc *in_pAllocator, const void *in_pParamsBlock, AkUInt32 in_uBlockSize)=0
AkCodecDescriptor m_CodecDescriptor
Definition: IAkPlugin.h:1936
virtual bool CanPostMonitorData()=0
AkUInt32 AkAcousticTextureID
Acoustic Texture ID.
Definition: AkTypes.h:151
virtual AkSpeakerPanningType GetSpeakerPanningType()=0
virtual void Execute(AkAudioBuffer *in_pBuffer, AkUInt32 in_uInOffset, AkAudioBuffer *out_pBuffer)=0
virtual AkMIDIEvent GetMidiEvent() const =0
virtual AKRESULT GetSinkChannelConfig(AkChannelConfig &out_sinkConfig, Ak3DAudioSinkCapabilities &out_3dAudioCaps) const =0
virtual AkUInt32 GetNum3DPositions()=0
AkPluginType eType
Plug-in type.
Definition: IAkPlugin.h:73
virtual ~IAkVoicePluginInfo()
Virtual destructor on interface to avoid warnings.
Definition: IAkPlugin.h:218
Spherical coordinates.
Definition: AkTypes.h:791
virtual void Consume(AkAudioBuffer *in_pInputBuffer, AkRamp in_gain)=0
virtual AkUInt32 GetBusType()=0
virtual AkConnectionType GetConnectionType()=0
virtual AKRESULT ComputeSphericalVBAPGains(void *in_pPannerData, AkReal32 in_fAzimuth, AkReal32 in_fElevation, AkUInt32 in_uNumChannels, AK::SpeakerVolumes::VectorPtr out_vVolumes)=0
virtual AKRESULT InitSphericalVBAP(AK::IAkPluginMemAlloc *in_pAllocator, const AkSphericalCoord *in_SphericalPositions, const AkUInt32 in_NbPoints, void *&out_pPannerData)=0
const AkReal32 * ConstMatrixPtr
Constant volume matrix. Access each input channel vector with AK::SpeakerVolumes::Matrix::GetChannel(...
virtual IAkPluginParam * Clone(IAkPluginMemAlloc *in_pAllocator)=0
AkGetDeviceListCallback m_pGetDeviceListFunc
Definition: IAkPlugin.h:1935
Volume ramp specified by end points "previous" and "next".
Definition: AkTypes.h:933
AkInt8 AkPriority
Priority.
Definition: AkTypes.h:135
Voice-specific information available to plug-ins.
Definition: IAkPlugin.h:215
virtual AkSinkPluginType GetSinkPluginType() const =0
virtual const AkAcousticTexture * GetAcousticTexture(AkAcousticTextureID in_AcousticTextureID)=0
void(* AkCallbackFunc)(AkCallbackType in_eType, AkCallbackInfo *in_pCallbackInfo)
Definition: AkCallback.h:266
virtual AKRESULT ComputeSphericalCoordinates(const AkEmitterListenerPair &in_pair, AkReal32 &out_fAzimuth, AkReal32 &out_fElevation) const =0
@ PluginServiceType_AudioObjectPriority
Definition: IAkPlugin.h:1350
virtual AKRESULT GetOutputID(AkUInt32 &out_uOutputID, AkPluginID &out_uDevicePlugin) const =0
virtual AKRESULT Term(IAkPluginMemAlloc *in_pAllocator)=0
virtual AKRESULT TimeSkip(AkUInt32 &)
Definition: IAkPlugin.h:1305
PluginRegistration(AkUInt32 in_ulCompanyID, AkUInt32 in_ulPluginID, const AkCodecDescriptor &in_Descriptor)
Definition: IAkPlugin.h:1903
virtual void Execute(AkAudioBuffer *io_pBuffer)=0
void * m_pRegisterCallbackCookie
Definition: IAkPlugin.h:1932
AkCurveInterpolation
Curve interpolation types.
Definition: AkTypes.h:900
virtual ~IAkSourcePluginContext()
Virtual destructor on interface to avoid warnings.
Definition: IAkPlugin.h:417
#define AK_CALLBACK(_type, _name)
virtual void * GetUserData()=0
virtual bool GetListeners(AkGameObjectID *out_aListenerIDs, AkUInt32 &io_uSize) const =0
virtual ~IAkPluginServiceRNG()
Definition: IAkPlugin.h:1724
virtual bool IsRenderingOffline() const =0
virtual AKRESULT Compute3DPositioning(AkReal32 in_fAngle, AkReal32 in_fElevation, AkReal32 in_fSpread, AkReal32 in_fFocus, AkChannelConfig in_inputConfig, AkChannelMask in_uInputChanSel, AkChannelConfig in_outputConfig, AkReal32 in_fCenterPerc, AK::SpeakerVolumes::MatrixPtr out_mxVolumes)=0
@ AK_NotImplemented
This feature is not implemented.
Definition: AkTypes.h:200
virtual ~IAkPluginService()
Definition: IAkPlugin.h:1358
virtual AKRESULT GetParentChannelConfig(AkChannelConfig &out_channelConfig) const =0
virtual IAkPluginService * GetPluginService(AkPluginServiceType in_pluginService) const =0
virtual AKRESULT SetParamsBlock(const void *in_pParamsBlock, AkUInt32 in_uBlockSize)=0
Software effect plug-in interface for in-place processing (see Creating Sound Engine Effect Plug-ins)...
Definition: IAkPlugin.h:778
virtual void Execute(const AkAudioObjects &in_objects, const AkAudioObjects &out_objects)=0
static const AkUniqueID AK_INVALID_UNIQUE_ID
Invalid unique 32-bit ID.
Definition: AkTypes.h:163
virtual AKRESULT Init(IAkPluginMemAlloc *in_pAllocator, IAkAudioDeviceEffectPluginContext *in_pEffectPluginContext, IAkPluginParam *in_pParams, const AkAudioFormat &in_rFormat, const Ak3DAudioSinkCapabilities &in_3dCapabilities)=0
AkPluginType
Definition: AkTypes.h:1221
virtual AkReal32 GetGameObjectScaling() const =0
virtual void ResetStarved()=0
Reset the "starvation" flag after IsStarved() returned true.
virtual AKRESULT RelocateMedia(AkUInt8 *, AkUInt8 *)
Definition: IAkPlugin.h:746
@ AkCurveInterpolation_Linear
Linear (Default)
Definition: AkTypes.h:907
@ PluginServiceType_Mixer
Definition: IAkPlugin.h:1347
virtual IAkVoicePluginInfo * GetVoiceInfo()=0
static const AkPlayingID AK_INVALID_PLAYING_ID
Invalid playing ID.
Definition: AkTypes.h:165
virtual AKRESULT ComputeSpeakerVolumesDirect(AkChannelConfig in_inputConfig, AkChannelConfig in_outputConfig, AkReal32 in_fCenterPerc, AK::SpeakerVolumes::MatrixPtr out_mxVolumes)=0
virtual AkReal32 GetDownstreamGain()=0
virtual AkReal32 Evaluate(void *&io_attenuationCurve, AkReal32 x)=0
Evaluate the value of a curve at given x coordinate.
bool bReserved
Legacy bIsAsynchronous plug-in flag, now unused. Preserved for plug-in backward compatibility....
Definition: IAkPlugin.h:77
Positioning data of 3D audio objects.
Definition: AkCommonDefs.h:288
A collection of audio objects. Encapsulates the audio data and metadata of each audio object in separ...
Definition: AkCommonDefs.h:651
uint64_t AkUInt64
Unsigned 64-bit integer.
virtual AKRESULT TimeSkip(AkUInt32 &io_uFrames)=0
virtual IAkGameObjectPluginInfo * GetGameObjectInfo()=0
virtual AKRESULT ComputePositioning(const AkPositioningData &in_posData, AkChannelConfig in_inputConfig, AkChannelConfig in_outputConfig, AK::SpeakerVolumes::MatrixPtr out_mxVolumes)=0
virtual AKRESULT UnregisterGlobalCallback(AkGlobalCallbackFunc in_pCallback, AkUInt32 in_eLocation=AkGlobalCallbackLocation_BeginRender)=0
virtual void ApplyGain(AkAudioBuffer *in_pInputBuffer, AkAudioBuffer *in_pOutputBuffer, AkRamp in_gain, bool in_convertToInt16) const =0
AkUInt32 uBuildVersion
Plug-in build version, must match the AK_WWISESDK_VERSION_COMBINED macro from AkWwiseSDKVersion....
Definition: IAkPlugin.h:74
AkReal32 * MatrixPtr
Volume matrix. Access each input channel vector with AK::SpeakerVolumes::Matrix::GetChannel().
virtual AKRESULT Reset()=0
AK::IAkPluginParam *(* AkCreateParamCallback)(AK::IAkPluginMemAlloc *in_pAllocator)
Registered plugin parameter node creation function prototype.
Definition: IAkPlugin.h:1333
virtual void Get3DAudioCapabilities(Ak3DAudioSinkCapabilities &out_rCapabilities)=0
Returns the capabilities of the sink's 3D audio system.
virtual ~IAkEffectPlugin()
Virtual destructor on interface to avoid warnings.
Definition: IAkPlugin.h:761
virtual ~IAkSinkPlugin()
Virtual destructor on interface to avoid warnings.
Definition: IAkPlugin.h:1188
virtual AKRESULT GetAudioSettings(AkAudioSettings &out_audioSettings) const =0
virtual IAkPlatformContext * GetPlatformContext() const =0
virtual AKRESULT StopLooping()
Definition: IAkPlugin.h:1281
virtual AkReal32 GetCenterPerc()=0
PluginRegistration * pNext
Definition: IAkPlugin.h:1923
static const AkGameObjectID AK_INVALID_GAME_OBJECT
Invalid game object (may also mean all game objects)
Definition: AkTypes.h:162
virtual AkPlayingID PostEventSync(AkUniqueID in_eventID, AkGameObjectID in_gameObjectID, AkUInt32 in_uFlags=0, AkCallbackFunc in_pfnCallback=NULL, void *in_pCookie=NULL, AkUInt32 in_cExternals=0, AkExternalSourceInfo *in_pExternalSources=NULL, AkPlayingID in_PlayingID=AK_INVALID_PLAYING_ID)=0
virtual AKRESULT ComputePositioning(const AkPositioningData &in_posData, AkChannelConfig in_inputConfig, AkChannelConfig in_outputConfig, AK::SpeakerVolumes::MatrixPtr out_mxVolumes)=0
virtual void ApplyGainAndInterleave(AkAudioBuffer *in_pInputBuffer, AkAudioBuffer *in_pOutputBuffer, AkRamp in_gain, bool in_convertToInt16) const =0
virtual AKRESULT Get3DPosition(AkUInt32 in_uIndex, AkEmitterListenerPair &out_soundPosition)=0
virtual ~IAkSourcePlugin()
Virtual destructor on interface to avoid warnings.
Definition: IAkPlugin.h:1240
virtual AkSinkPluginType GetSinkPluginType() const override final
Definition: IAkPlugin.h:1204
Type for a point in an RTPC or Attenuation curve.
Definition: AkTypes.h:951
uint32_t AkUInt32
Unsigned 32-bit integer.
AkInt16 AkPluginParamID
Source or effect plug-in parameter ID.
Definition: AkTypes.h:134
virtual ~IAkPlugin()
Virtual destructor on interface to avoid warnings.
Definition: IAkPlugin.h:693
virtual IAkPluginParam * GetInputParam(AkPluginID in_attachmentPluginID)=0
AkSpeakerPanningType
Speaker panning type: type of panning logic when object is not 3D spatialized (i.e....
Definition: AkTypes.h:1155
@ AkPluginTypeNone
Unknown/invalid plug-in type.
Definition: AkTypes.h:1222
virtual AKRESULT GetEmitterListenerPair(AkUInt32 in_uIndex, AkEmitterListenerPair &out_emitterListenerPair) const =0
Definition: AkMidiTypes.h:237
Game object information available to plugins.
Definition: IAkPlugin.h:100
virtual AK::IAkPluginMemAlloc * GetAllocator()=0
Get the default allocator for plugins. This is useful for performing global initialization tasks shar...
virtual AKRESULT Compute3DPositioning(const AkWorldTransform &in_emitter, const AkWorldTransform &in_listener, AkReal32 in_fCenterPerc, AkReal32 in_fSpread, AkReal32 in_fFocus, AkChannelConfig in_inputConfig, AkChannelMask in_uInputChanSel, AkChannelConfig in_outputConfig, AK::SpeakerVolumes::MatrixPtr out_mxVolumes)=0
virtual AKRESULT CreateOutputObjects(AkChannelConfig in_channelConfig, AkAudioObjects &io_objects)=0
virtual AKRESULT Init(IAkPluginMemAlloc *in_pAllocator, IAkSourcePluginContext *in_pSourcePluginContext, IAkPluginParam *in_pParams, AkAudioFormat &io_rFormat)=0
3D vector for some operations in 3D space. Typically intended only for localized calculations due to ...
Definition: AkTypes.h:425
@ AkPluginTypeCodec
Compressor/decompressor plug-in (allows support for custom audio file types).
Definition: AkTypes.h:1223
virtual AKRESULT Seek(AkUInt32)
Definition: IAkPlugin.h:1295
virtual ~IAkEffectPluginContext()
Virtual destructor on interface to avoid warnings.
Definition: IAkPlugin.h:359
virtual AkGameObjectID GetGameObjectID() const =0
Get the ID of the game object.
AkReal32 AkRtpcValue
Real time parameter control value.
Definition: AkTypes.h:142
@ AkSinkPluginType_3DAudioSink
Definition: IAkPlugin.h:1124
virtual const AkPlatformInitSettings * GetPlatformInitSettings() const =0
AkGlobalCallbackFunc m_pRegisterCallback
Definition: IAkPlugin.h:1931
virtual bool IsPrimary()=0
virtual AKRESULT ComputeSpeakerVolumesPanner(AkSpeakerPanningType in_ePannerType, const AkVector &in_position, AkReal32 in_fCenterPct, AkChannelConfig in_inputConfig, AkChannelConfig in_outputConfig, AK::SpeakerVolumes::MatrixPtr out_mxVolumes)=0
Listener information.
Definition: AkTypes.h:886
virtual AkUInt32 GetBufferTick() const =0
virtual const AkInitSettings * GetInitSettings() const =0
virtual AKRESULT PostMonitorMessage(const char *in_pszError, AK::Monitor::ErrorLevel in_eErrorLevel)=0
virtual SoundEngine::MultiPositionType GetGameObjectMultiPositionType() const =0
bool bCanProcessObjects
Plug-in can process audio objects. They must implement IAkInPlaceObjectPlugin or IAkOutOfPlaceObjectP...
Definition: IAkPlugin.h:78
virtual AkUInt32 GetNumPoints(const void *in_attenuationCurve) const =0
Get the number of points on a curve.
virtual void Execute(AkAudioBuffer *io_pMainMix, AkAudioBuffer *io_pPassthroughMix, const AkAudioObjects &io_objects, AkRamp &io_gain)=0
static const AkPluginParamID ALL_PLUGIN_DATA_ID
Definition: IAkPlugin.h:683
virtual AkPlayingID PostMIDIOnEventSync(AkUniqueID in_eventID, AkGameObjectID in_gameObjectID, AkMIDIPost *in_pPosts, AkUInt16 in_uNumPosts, bool in_bAbsoluteOffsets=false, AkUInt32 in_uFlags=0, AkCallbackFunc in_pfnCallback=NULL, void *in_pCookie=NULL, AkPlayingID in_playingID=AK_INVALID_PLAYING_ID)=0
AkPluginType m_eType
Definition: IAkPlugin.h:1924
ErrorLevel
ErrorLevel.
virtual AKRESULT TermSphericalVBAP(AK::IAkPluginMemAlloc *in_pAllocator, void *in_pPannerData)=0
virtual AkUInt32 GetNumEmitterListenerPairs() const =0
virtual ~IAkPluginServiceMixer()
Definition: IAkPlugin.h:1665
AK::IAkPlugin *(* AkCreatePluginCallback)(AK::IAkPluginMemAlloc *in_pAllocator)
Registered plugin creation function prototype.
Definition: IAkPlugin.h:1331
Defines the parameters of an audio buffer format.
Definition: AkCommonDefs.h:62
IAkSoftwareCodec *(* AkCreateBankSourceCallback)(void *in_pCtx)
Registered bank source node creation function prototype.
Definition: AkTypes.h:1100
Ak3DPositionType
3D position type: defines what acts as the emitter position for computing spatialization against the ...
Definition: AkTypes.h:1164
virtual Ak3DPositionType Get3DPositionType()=0
AkConnectionType
Nature of the connection binding an input to a bus.
Definition: AkTypes.h:381
virtual AKRESULT RegisterCodec(AkUInt32 in_ulCompanyID, AkUInt32 in_ulPluginID, AkCreateFileSourceCallback in_pFileCreateFunc, AkCreateBankSourceCallback in_pBankCreateFunc)=0
virtual void ComputeAmbisonicsEncoding(AkReal32 in_fAzimuth, AkReal32 in_fElevation, AkChannelConfig in_cfgAmbisonics, AK::SpeakerVolumes::VectorPtr out_vVolumes)=0
AkUInt32 AkPlayingID
Playing ID.
Definition: AkTypes.h:123
virtual AkReal32 GetDuration() const =0
virtual AKRESULT GetSpeakerAngles(AkReal32 *io_pfSpeakerAngles, AkUInt32 &io_uNumAngles, AkReal32 &out_fHeightAngle)=0
virtual void Linearize(void *&io_attenuationCurve)=0
Some curves are serialized in the log domain. Use this function to convert all the points to linear a...
@ AkGlobalCallbackLocation_BeginRender
Start of frame rendering, after having processed game messages.
Definition: AkCallback.h:342
#define AK_RESTRICT
Refers to the __restrict compilation flag available on some platforms.
Definition: AkTypes.h:45
const AkReal32 * ConstVectorPtr
Constant volume vector. Access each element with the standard bracket [] operator.
virtual AKRESULT RegisterGlobalCallback(AkPluginType in_eType, AkUInt32 in_ulCompanyID, AkUInt32 in_ulPluginID, AkGlobalCallbackFunc in_pCallback, AkUInt32 in_eLocation=AkGlobalCallbackLocation_BeginRender, void *in_pCookie=NULL)=0
virtual void GetPluginCustomGameData(void *&out_rpData, AkUInt32 &out_rDataSize)=0
Interface to retrieve contextual information available to all types of plugins.
Definition: IAkPlugin.h:238
virtual AKRESULT ComputePositioning(const AkPositioningData &in_posData, AkChannelConfig in_inputConfig, AkChannelConfig in_outputConfig, AK::SpeakerVolumes::MatrixPtr out_mxVolumes)=0
AkCreateBankSourceCallback m_pBankCreateFunc
LEGACY: Kept for compatibility with 2019.1. Unused in 2019.2 and up.
Definition: IAkPlugin.h:1930
virtual AKRESULT GetListenerData(AkGameObjectID in_uListener, AkListener &out_listener) const =0
virtual AkUInt32 GetNumGameObjectPositions() const =0
virtual IAkStreamMgr * GetStreamMgr() const =0
Retrieve the streaming manager access interface.

Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Tell us about your project. We're here to help.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise