버전

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

이 페이지가 도움이 되었나요?

지원이 필요하신가요?

질문이 있으신가요? 문제를 겪고 계신가요? 더 많은 정보가 필요하신가요? 저희에게 문의해주시면 도와드리겠습니다!

지원 페이지를 방문해 주세요

작업하는 프로젝트에 대해 알려주세요. 언제든지 도와드릴 준비가 되어 있습니다.

프로젝트를 등록하세요. 아무런 조건이나 의무 사항 없이 빠른 시작을 도와드리겠습니다.

Wwise를 시작해 보세요