Table of Contents

Wwise SDK 2021.1.2
AkCommonDefs.h
Go to the documentation of this file.
1 /*******************************************************************************
2 The content of this file includes portions of the AUDIOKINETIC Wwise Technology
3 released in source code form as part of the SDK installer package.
4 
5 Commercial License Usage
6 
7 Licensees holding valid commercial licenses to the AUDIOKINETIC Wwise Technology
8 may use this file in accordance with the end user license agreement provided
9 with the software or, alternatively, in accordance with the terms contained in a
10 written agreement between you and Audiokinetic Inc.
11 
12 Apache License Usage
13 
14 Alternatively, this file may be used under the Apache License, Version 2.0 (the
15 "Apache License"); you may not use this file except in compliance with the
16 Apache License. You may obtain a copy of the Apache License at
17 http://www.apache.org/licenses/LICENSE-2.0.
18 
19 Unless required by applicable law or agreed to in writing, software distributed
20 under the Apache License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES
21 OR CONDITIONS OF ANY KIND, either express or implied. See the Apache License for
22 the specific language governing permissions and limitations under the License.
23 
24  Version: v2021.1.2 Build: 7629
25  Copyright (c) 2006-2021 Audiokinetic Inc.
26 *******************************************************************************/
27 
28 // AkCommonDefs.h
29 
30 /// \file
31 /// AudioLib common defines, enums, and structs.
32 
33 
34 #ifndef _AK_COMMON_DEFS_H_
35 #define _AK_COMMON_DEFS_H_
36 
40 #include <AK/Tools/Common/AkArray.h>
42 
43 //-----------------------------------------------------------------------------
44 // AUDIO DATA FORMAT
45 //-----------------------------------------------------------------------------
46 
47 // Audio data format.
48 // ------------------------------------------------
49 
50 const AkDataTypeID AK_INT = 0; ///< Integer data type (uchar, short, and so on)
51 const AkDataTypeID AK_FLOAT = 1; ///< Float data type
52 
53 const AkDataInterleaveID AK_INTERLEAVED = 0; ///< Interleaved data
54 const AkDataInterleaveID AK_NONINTERLEAVED = 1; ///< Non-interleaved data
55 
56 // Native format currently the same on all supported platforms, may become platform specific in the future
57 const AkUInt32 AK_LE_NATIVE_BITSPERSAMPLE = 32; ///< Native number of bits per sample.
58 const AkUInt32 AK_LE_NATIVE_SAMPLETYPE = AK_FLOAT; ///< Native data type.
59 const AkUInt32 AK_LE_NATIVE_INTERLEAVE = AK_NONINTERLEAVED; ///< Native interleaved setting.
60 
61 /// Defines the parameters of an audio buffer format.
63 {
64  AkUInt32 uSampleRate; ///< Number of samples per second
65 
66  AkChannelConfig channelConfig; ///< Channel configuration.
67 
68  AkUInt32 uBitsPerSample :6; ///< Number of bits per sample.
69  AkUInt32 uBlockAlign :10;///< Number of bytes per sample frame. (For example a 5.1 PCM 16bit should have a uBlockAlign equal to 6(5.1 channels)*2(16 bits per sample) = 12.
70  AkUInt32 uTypeID :2; ///< Data type ID (AkDataTypeID).
71  AkUInt32 uInterleaveID :1; ///< Interleave ID (AkDataInterleaveID).
72 
73  /// Get the number of channels.
74  /// \return The number of channels
76  {
78  }
79 
80  /// Query if LFE channel is present.
81  /// \return True when LFE channel is present
82  AkForceInline bool HasLFE() const
83  {
84  return channelConfig.HasLFE();
85  }
86 
87  /// Query if center channel is present.
88  /// Note that mono configurations have one channel which is arbitrary set to AK_SPEAKER_FRONT_CENTER,
89  /// so HasCenter() returns true for mono signals.
90  /// \return True when center channel is present and configuration has more than 2 channels.
91  AkForceInline bool HasCenter() const
92  {
93  return channelConfig.HasCenter();
94  }
95 
96  /// Get the number of bits per sample.
97  /// \return The number of bits per sample
99  {
100  return uBitsPerSample;
101  }
102 
103  /// Get the block alignment.
104  /// \return The block alignment
106  {
107  return uBlockAlign;
108  }
109 
110  /// Get the data sample format (Float or Integer).
111  /// \return The data sample format
113  {
114  return uTypeID;
115  }
116 
117  /// Get the interleaved type.
118  /// \return The interleaved type
120  {
121  return uInterleaveID;
122  }
123 
124  /// Set all parameters of the audio format structure.
125  /// Channels are specified by channel mask (standard configs).
126  void SetAll(
127  AkUInt32 in_uSampleRate, ///< Number of samples per second
128  AkChannelConfig in_channelConfig, ///< Channel configuration
129  AkUInt32 in_uBitsPerSample, ///< Number of bits per sample
130  AkUInt32 in_uBlockAlign, ///< Block alignment
131  AkUInt32 in_uTypeID, ///< Data sample format (Float or Integer)
132  AkUInt32 in_uInterleaveID ///< Interleaved type
133  )
134  {
135  uSampleRate = in_uSampleRate;
136  channelConfig = in_channelConfig;
137  uBitsPerSample = in_uBitsPerSample;
138  uBlockAlign = in_uBlockAlign;
139  uTypeID = in_uTypeID;
140  uInterleaveID = in_uInterleaveID;
141  }
142 
143  AkForceInline bool operator==(const AkAudioFormat & in_other) const
144  {
145  return uSampleRate == in_other.uSampleRate
146  && channelConfig == in_other.channelConfig
147  && uBitsPerSample == in_other.uBitsPerSample
148  && uBlockAlign == in_other.uBlockAlign
149  && uTypeID == in_other.uTypeID
150  && uInterleaveID == in_other.uInterleaveID;
151  }
152 
153  AkForceInline bool operator!=(const AkAudioFormat & in_other) const
154  {
155  return uSampleRate != in_other.uSampleRate
156  || channelConfig != in_other.channelConfig
157  || uBitsPerSample != in_other.uBitsPerSample
158  || uBlockAlign != in_other.uBlockAlign
159  || uTypeID != in_other.uTypeID
160  || uInterleaveID != in_other.uInterleaveID;
161  }
162 };
163 
164 typedef AkUInt8(*AkChannelMappingFunc)(const AkChannelConfig &config, AkUInt8 idx);
165 
167 {
168  SourceChannelOrdering_Standard = 0, // SMPTE L-R-C-LFE-RL-RR-RC-SL-SR-HL-HR-HC-HRL-HRR-HRC-T
169  // or ACN ordering + SN3D norm
170 
171  SourceChannelOrdering_Film, // L/C/R/Ls/Rs/Lfe
173 };
174 
175 #define AK_MAKE_CHANNELCONFIGOVERRIDE(_config,_order) ((AkInt64)_config.Serialize()|((AkInt64)_order<<32))
176 #define AK_GET_CHANNELCONFIGOVERRIDE_CONFIG(_over) (_over&UINT_MAX)
177 #define AK_GET_CHANNELCONFIGOVERRIDE_ORDERING(_over) ((AkSourceChannelOrdering)(_over>>32))
178 
179 // Build a 32 bit class identifier based on the Plug-in type,
180 // CompanyID and PluginID.
181 //
182 // Parameters:
183 // - in_pluginType: A value from enum AkPluginType (4 bits)
184 // - in_companyID: CompanyID as defined in the Plug-in's XML file (12 bits)
185 // * 0-63: Reserved for Audiokinetic
186 // * 64-255: Reserved for clients' in-house Plug-ins
187 // * 256-4095: Assigned by Audiokinetic to third-party plug-in developers
188 // - in_pluginID: PluginID as defined in the Plug-in's XML file (16 bits)
189 // * 0-32767: Set freely by the Plug-in developer
190 #define AKMAKECLASSID( in_pluginType, in_companyID, in_pluginID ) \
191  ( (in_pluginType) + ( (in_companyID) << 4 ) + ( (in_pluginID) << ( 4 + 12 ) ) )
192 
193 #define AKGETPLUGINTYPEFROMCLASSID( in_classID ) ( (in_classID) & AkPluginTypeMask )
194 #define AKGETCOMPANYIDFROMCLASSID( in_classID ) ( ( (in_classID) & 0x0000FFF0 ) >> 4 )
195 #define AKGETPLUGINIDFROMCLASSID( in_classID ) ( ( (in_classID) & 0xFFFF0000 ) >> ( 4 + 12 ) )
196 
197 #define CODECID_FROM_PLUGINID AKGETPLUGINIDFROMCLASSID
198 
199 
200 namespace AK
201 {
202  /// Interface to retrieve metering information about a buffer.
203  class IAkMetering
204  {
205  protected:
206  /// Virtual destructor on interface to avoid warnings.
207  virtual ~IAkMetering(){}
208 
209  public:
210 
211  /// Get peak of each channel in this frame.
212  /// Depending on when this function is called, you may get metering data computed in the previous frame only. In order to force recomputing of
213  /// meter values, pass in_bForceCompute=true.
214  /// \return Vector of linear peak levels, corresponding to each channel. NULL if AK_EnableBusMeter_Peak is not set (see IAkMixerPluginContext::SetMeteringFlags() or AK::SoundEngine::RegisterBusMeteringCallback()).
216 
217  /// Get true peak of each channel (as defined by ITU-R BS.1770) in this frame.
218  /// Depending on when this function is called, you may get metering data computed in the previous frame only.
219  /// \return Vector of linear true peak levels, corresponding to each channel. NULL if AK_EnableBusMeter_TruePeak is not set (see IAkMixerPluginContext::SetMeteringFlags() or AK::SoundEngine::RegisterBusMeteringCallback()).
221 
222  /// Get the RMS value of each channel in this frame.
223  /// Depending on when this function is called, you may get metering data computed in the previous frame only. In order to force recomputing of
224  /// meter values, pass in_bForceCompute=true.
225  /// \return Vector of linear rms levels, corresponding to each channel. NULL if AK_EnableBusMeter_RMS is not set (see IAkMixerPluginContext::SetMeteringFlags() or AK::SoundEngine::RegisterBusMeteringCallback()).
227 
228  /// Get the mean k-weighted power value in this frame, used to compute loudness (as defined by ITU-R BS.1770).
229  /// Depending on when this function is called, you may get metering data computed in the previous frame only.
230  /// \return Total linear k-weighted power of all channels. 0 if AK_EnableBusMeter_KPower is not set (see IAkMixerPluginContext::SetMeteringFlags() or AK::SoundEngine::RegisterBusMeteringCallback()).
232  };
233 }
234 
235 // 3D Audio Object.
236 // ------------------------------------------------
237 
238 /// Default listener transform.
239 #define AK_DEFAULT_LISTENER_POSITION_X (0.0f) // at coordinate system's origin
240 #define AK_DEFAULT_LISTENER_POSITION_Y (0.0f)
241 #define AK_DEFAULT_LISTENER_POSITION_Z (0.0f)
242 #define AK_DEFAULT_LISTENER_FRONT_X (0.0f) // looking toward Z,
243 #define AK_DEFAULT_LISTENER_FRONT_Y (0.0f)
244 #define AK_DEFAULT_LISTENER_FRONT_Z (1.0f)
245 #define AK_DEFAULT_TOP_X (0.0f) // top towards Y
246 #define AK_DEFAULT_TOP_Y (1.0f)
247 #define AK_DEFAULT_TOP_Z (0.0f)
248 
249 
250 /// 3D data needed for 3D spatialization.
251 /// Undergoes transformations based on emitter-listener placement.
252 struct Ak3dData
253 {
255  : spread(1.f)
256  , focus(1.f)
257  , uEmitterChannelMask(0xffff)
258  {
260  }
261 
262  AkTransform xform; ///< Object position / orientation.
263  AkReal32 spread; ///< Spread [0,1]
264  AkReal32 focus; ///< Focus [0,1]
265  AkChannelMask uEmitterChannelMask; ///< Emitter channel mask. With 3D spatialization, zeroed channels should be dropped.
266 };
267 
268 /// Positioning data inherited from sound structures and mix busses.
270 {
272  : center(1.f)
273  , panLR(0.f)
274  , panBF(0.f)
275  , panDU(0.f)
276  , panSpatMix(1.f)
279  , enableHeightSpread(true)
280  {}
281 
282  AkReal32 center; ///< Center percentage [0,1]
283  AkReal32 panLR; ///< Pan left-right [-1,1]
284  AkReal32 panBF; ///< Pan back-front [-1,1]
285  AkReal32 panDU; ///< Pan down-up [-1,1]
286  AkReal32 panSpatMix; ///< Panning vs 3D spatialization mix ([0,1], 1 being 100% spatialized).
287  Ak3DSpatializationMode spatMode; ///< 3D spatialization mode.
288  AkSpeakerPanningType panType; ///< Speaker panning type.
289  bool enableHeightSpread; ///< When true, audio objects 3D spatialized onto a planar channel configuration will be given a minimum spread value based on their elevation angle, equal to sin(elevation)**2.
290 };
291 
292 /// Positioning data of 3D audio objects.
294 {
295  Ak3dData threeD; ///< 3D data used for 3D spatialization.
296  AkBehavioralPositioningData behavioral; ///< Positioning data inherited from sound structures and mix busses.
297 };
298 
299 // Forward defines
300 namespace AK
301 {
302  class IAkPluginParam;
303 }
304 
305 /// An audio object refers to an audio signal with some attached metadata going through the sound engine pipeline.
306 /// The AkAudioObject struct encapsulates the metadata part. The signal itself is contained in a separate AkAudioBuffer instance.
308 {
309  /// Constructor
312  ,cumulativeGain(1.f, 1.f)
314  {}
315 
316  /// Destructor
318  {
320  objectName.Term();
321  }
322 
323  AkAudioObjectID key; ///< Unique ID, local to a given bus.
324 
325  AkPositioningData positioning; ///< Positioning data for deferred 3D rendering.
326  AkRamp cumulativeGain; ///< Cumulative ramping gain to apply when mixing down to speaker bed or final endpoint
327 
328  /// Custom object metadata.
330  {
331  AkPluginID pluginID; ///< Full plugin ID (including company ID and plugin type. See AKMAKECLASSID macro.
332  AK::IAkPluginParam* pParam; ///< Custom, pluggable medata.
333  AkUniqueID contextID; ///< (Profiling) ID of the sound or bus from which the custom metadata was fetched.
334  };
336  ArrayCustomMetadata arCustomMetadata; ///< Array of custom metadata, gathered from visited objects.
337 
338  AkPipelineID instigatorID; ///< Profiling ID of the node from which the object stems (typically the voice, instance of an actor-mixer).
339 
340  typedef AkString<AkPluginArrayAllocator, char> String; ///< String type for use in 3D audio objects.
341  String objectName; ///< Name string of the object, to appear in the object profiler. This is normally used by out-of-place object processors for naming their output objects. Built-in sound engine structures don't use it.
342 
343  /// Copy object metadata (everything but the key) from another object.
345  const AkAudioObject& in_src ///< Object from which metadata is copied.
346  )
347  {
348  positioning = in_src.positioning;
351  instigatorID = in_src.instigatorID;
352  objectName = in_src.objectName; // AkString performs a shallow copy when it can, like here.
353  }
354 
355  /// Transfer function for transfer move policies.
356  void Transfer(
357  AkAudioObject& in_from ///< Object from which data is transferred.
358  )
359  {
360  key = in_from.key;
361  positioning = in_from.positioning;
362  cumulativeGain = in_from.cumulativeGain;
364  instigatorID = in_from.instigatorID;
365  objectName.Transfer(in_from.objectName);
366  }
367 
368  /// Object processors may give an explicit name to objects.
369  /// \return AK_Success if the string was allocated successfully, AK_InsufficientMemory otherwise.
371  AK::IAkPluginMemAlloc* in_pAllocator, ///< Memory allocator.
372  const char* in_szName ///< Null-terminated string to allocate and store on this object.
373  )
374  {
375  objectName.Init(in_pAllocator);
376  objectName = in_szName;
377  return objectName.AllocCopy();
378  }
379 
380  /// Reset object state in preparation for next frame.
381  void ResetState()
382  {
383  arCustomMetadata.Term(); // Reset custom metadata in preparation for next frame.
384  objectName.ClearReference(); // Clear reference to string in preparation for next frame.
385  }
386 };
387 
388 /// Structure containing information about system-level support for 3D audio.
389 /// "3D Audio" refers to a system's ability to position sound sources in a virtual 3D space, pan them accordingly on a range of physical speakers, and produce a binaural mix where appropriate.
390 /// We prefer "3D Audio" to "Spatial" to avoid ambiguity with spatial audio, which typically involves sound propagation and environment effects.
392 {
393  AkChannelConfig channelConfig; /// Channel configuration of the main mix.
394  AkUInt32 uMaxSystemAudioObjects; /// Maximum number of System Audio Objects that can be active concurrently. A value of zero indicates the system does not support this feature.
395  AkUInt32 uAvailableSystemAudioObjects; /// How many System Audio Objects can currently be sent to the sink. This value can change at runtime depending on what is playing. Can never be higher than uMaxSystemAudioObjects.
396  bool bPassthrough; /// Separate pass-through mix is supported.
397  bool bMultiChannelObjects; /// Can handle multi-channel objects
398 };
399 
400 /// Enum of the possible object destinations when reaching a 3D audio-capable sink
402 {
403  eDefault = 0, // The destination will be chosen based on the audio object's metadata and channel configuration
404  eMainMix = 1, // The audio object will be mixed to the sink's main mix
405  ePassthrough = 2, // The audio object will be mixed to the sink's passthrough mix
406  eSystemAudioObject = 3 // The audio object will not be mixed; it will be sent separately to the system's 3D audio endpoint
407 };
408 
409 // Audio buffer.
410 // ------------------------------------------------
411 
412 /// Native sample type.
413 /// \remarks Sample values produced by insert effects must use this type.
414 /// \remarks Source plug-ins can produce samples of other types (specified through
415 /// according fields of AkAudioFormat, at initial handshaking), but these will be
416 /// format converted internally into the native format.
417 /// \sa
418 /// - \ref iaksourceeffect_init
419 /// - \ref iakmonadiceffect_init
420 typedef AkReal32 AkSampleType; ///< Audio sample data type (32 bit floating point)
421 
422 /// Audio buffer structure including the address of an audio buffer, the number of valid frames inside,
423 /// and the maximum number of frames the audio buffer can hold.
424 /// \sa
425 /// - \ref fx_audiobuffer_struct
427 {
428 public:
429 
430  /// Constructor.
432  {
433  Clear();
434  }
435 
436  /// Clear data pointer.
438  {
439  pData = NULL;
440  uValidFrames = 0;
441  }
442 
443  /// Clear members.
445  {
446  ClearData();
447  uMaxFrames = 0;
449  }
450 
451  /// \name Channel queries.
452  //@{
453  /// Get the number of channels.
455  {
457  }
458 
459  /// Returns true if there is an LFE channel present.
460  AkForceInline bool HasLFE() const
461  {
462  return channelConfig.HasLFE();
463  }
464 
466 
467  //@}
468 
469  /// \name Interleaved interface
470  //@{
471  /// Get address of data: to be used with interleaved buffers only.
472  /// \remarks Only source plugins can output interleaved data. This is determined at
473  /// initial handshaking.
474  /// \sa
475  /// - \ref fx_audiobuffer_struct
477  {
478  return pData;
479  }
480 
481  /// Attach interleaved data. Allocation is performed outside.
482  inline void AttachInterleavedData( void * in_pData, AkUInt16 in_uMaxFrames, AkUInt16 in_uValidFrames )
483  {
484  pData = in_pData;
485  uMaxFrames = in_uMaxFrames;
486  uValidFrames = in_uValidFrames;
488  }
489  /// Attach interleaved data with a new channel config. Allocation is performed outside.
490  inline void AttachInterleavedData( void * in_pData, AkUInt16 in_uMaxFrames, AkUInt16 in_uValidFrames, AkChannelConfig in_channelConfig )
491  {
492  pData = in_pData;
493  uMaxFrames = in_uMaxFrames;
494  uValidFrames = in_uValidFrames;
495  channelConfig = in_channelConfig;
496  }
497  //@}
498 
499  /// \name Deinterleaved interface
500  //@{
501 
502  /// Check if buffer has samples attached to it.
503  AkForceInline bool HasData() const
504  {
505  return ( NULL != pData );
506  }
507 
508  /// Convert a channel, identified by a single channel bit, to a buffer index used in GetChannel() below, for a given channel config.
509  /// Standard indexing follows channel bit order (see AkSpeakerConfig.h). Pipeline/buffer indexing is the same but the LFE is moved to the end.
511  AkChannelConfig in_channelConfig, ///< Channel configuration.
512  AkUInt32 in_uChannelIdx ///< Channel index in standard ordering to be converted to pipeline ordering.
513  )
514  {
515  if ( in_channelConfig.HasLFE() )
516  {
517  AKASSERT( in_channelConfig.eConfigType == AK_ChannelConfigType_Standard ); // in_channelConfig.HasLFE() would not have returned true otherwise.
518  AKASSERT( AK::GetNumNonZeroBits( in_channelConfig.uChannelMask ) );
519  AkUInt32 uIdxLFE = AK::GetNumNonZeroBits( ( AK_SPEAKER_LOW_FREQUENCY - 1 ) & in_channelConfig.uChannelMask );
520  if ( in_uChannelIdx == uIdxLFE )
521  return in_channelConfig.uNumChannels - 1;
522  else if ( in_uChannelIdx > uIdxLFE )
523  return in_uChannelIdx - 1;
524  }
525 
526  return in_uChannelIdx;
527  }
528 
529  /// Get the buffer of the ith channel.
530  /// Access to channel data is most optimal through this method. Use whenever the
531  /// speaker configuration is known, or when an operation must be made independently
532  /// for each channel.
533  /// \remarks When using a standard configuration, use ChannelMaskToBufferIndex() to convert channel bits to buffer indices.
534  /// \return Address of the buffer of the ith channel.
535  /// \sa
536  /// - \ref fx_audiobuffer_struct
537  /// - \ref fx_audiobuffer_struct_channels
539  AkUInt32 in_uIndex ///< Channel index [0,NumChannels()-1]
540  )
541  {
542  AKASSERT( in_uIndex < NumChannels() );
543  return (AkSampleType*)((AkUInt8*)(pData) + ( in_uIndex * sizeof(AkSampleType) * MaxFrames() ));
544  }
545 
546  /// Get the buffer of the LFE.
547  /// \return Address of the buffer of the LFE. Null if there is no LFE channel.
548  /// \sa
549  /// - \ref fx_audiobuffer_struct_channels
550  inline AkSampleType * GetLFE()
551  {
553  return GetChannel( NumChannels()-1 );
554 
555  return (AkSampleType*)0;
556  }
557 
558  /// Can be used to transform an incomplete into a complete buffer with valid data.
559  /// The invalid frames are made valid (zeroed out) for all channels and the validFrames count will be made equal to uMaxFrames.
561  {
562  AKASSERT(pData != nullptr || MaxFrames() == 0);
563  // The following members MUST be copied locally due to multi-core calls to this function.
564  const AkUInt32 uNumChannels = NumChannels();
565  const AkUInt32 uNumCurrentFrames = AkMin(uValidFrames, MaxFrames());
566  const AkUInt32 uNumZeroFrames = MaxFrames() - uNumCurrentFrames;
567  if ( uNumZeroFrames )
568  {
569  AKASSERT(pData != nullptr);
570  for ( AkUInt32 i = 0; i < uNumChannels; ++i )
571  {
572  AKPLATFORM::AkMemSet( GetChannel(i) + uNumCurrentFrames, 0, uNumZeroFrames * sizeof(AkSampleType) );
573  }
575  }
576  }
577 
578  /// Attach deinterleaved data where channels are contiguous in memory. Allocation is performed outside.
579  AkForceInline void AttachContiguousDeinterleavedData( void * in_pData, AkUInt16 in_uMaxFrames, AkUInt16 in_uValidFrames, AkChannelConfig in_channelConfig )
580  {
581  AttachInterleavedData( in_pData, in_uMaxFrames, in_uValidFrames, in_channelConfig );
582  }
583  /// Detach deinterleaved data where channels are contiguous in memory. The address of the buffer is returned and fields are cleared.
585  {
586  uMaxFrames = 0;
587  uValidFrames = 0;
589  void * pDataOld = pData;
590  pData = NULL;
591  return pDataOld;
592  }
593 
595 
596  //@}
597 
598  void RelocateMedia( AkUInt8* in_pNewMedia, AkUInt8* in_pOldMedia )
599  {
600  AkUIntPtr uMemoryOffset = (AkUIntPtr)in_pNewMedia - (AkUIntPtr)in_pOldMedia;
601  pData = (void*) (((AkUIntPtr)pData) + uMemoryOffset);
602  }
603 
604  /// Access to the number of sample frames the buffer can hold.
605  /// \return Number of sample frames the buffer can hold.
607 
608 protected:
609  void * pData; ///< Start of the audio buffer.
610  AkChannelConfig channelConfig; ///< Channel config.
611 
612 public:
613  AKRESULT eState; ///< Execution status
614 
615 protected:
616  AkUInt16 uMaxFrames; ///< Number of sample frames the buffer can hold. Access through AkAudioBuffer::MaxFrames().
617 
618 public:
619  AkUInt16 uValidFrames; ///< Number of valid sample frames in the audio buffer
620 };
621 
622 /// A collection of audio objects. Encapsulates the audio data and metadata of each audio object in separate arrays.
624 {
625  AkAudioObjects(AkUInt32 in_uNumObjects = 0, AkAudioBuffer** in_ppObjectBuffers = nullptr, AkAudioObject** in_ppObjects = nullptr)
626  : uNumObjects(in_uNumObjects)
627  , ppObjectBuffers(in_ppObjectBuffers)
628  , ppObjects(in_ppObjects)
629  {}
630 
631  AkUInt32 uNumObjects; ///< Number of audio objects.
632  AkAudioBuffer** ppObjectBuffers; ///< Array of pointers to audio object buffers.
633  AkAudioObject** ppObjects; ///< Array of pointers to audio objects.
634 };
635 
636 #endif // _AK_COMMON_DEFS_H_
void Transfer(AkAudioObject &in_from)
Transfer function for transfer move policies.
Definition: AkCommonDefs.h:356
AkString< AkPluginArrayAllocator, char > String
String type for use in 3D audio objects.
Definition: AkCommonDefs.h:340
AkForceInline bool HasLFE() const
Returns true if there is an LFE channel present.
Definition: AkCommonDefs.h:460
bool enableHeightSpread
When true, audio objects 3D spatialized onto a planar channel configuration will be given a minimum s...
Definition: AkCommonDefs.h:289
#define AkMin(x1, x2)
Definition: AkPlatformFuncs.h:94
AkUInt8 AkDataInterleaveID
Data interleaved state ID.
Definition: AkTypes.h:75
AkSpeakerPanningType
Speaker panning type: type of panning logic when object is not 3D spatialized (i.e....
Definition: AkTypes.h:768
AkUInt32 uAvailableSystemAudioObjects
Maximum number of System Audio Objects that can be active concurrently. A value of zero indicates the...
Definition: AkCommonDefs.h:395
AkSampleType * GetChannel(AkUInt32 in_uIndex)
Definition: AkCommonDefs.h:538
#define AK_DEFAULT_TOP_Z
Definition: AkCommonDefs.h:247
#define AkForceInline
Force inlining.
Definition: AkTypes.h:61
Interface to retrieve metering information about a buffer.
Definition: AkCommonDefs.h:204
Audiokinetic namespace.
AkForceInline bool HasData() const
Check if buffer has samples attached to it.
Definition: AkCommonDefs.h:503
AkAudioObject()
Constructor.
Definition: AkCommonDefs.h:310
AkForceInline bool HasCenter() const
Definition: AkSpeakerConfig.h:665
AkPositioningData positioning
Positioning data for deferred 3D rendering.
Definition: AkCommonDefs.h:325
@ SourceChannelOrdering_FuMa
Definition: AkCommonDefs.h:172
AkReal32 center
Center percentage [0,1].
Definition: AkCommonDefs.h:282
AkRamp cumulativeGain
Cumulative ramping gain to apply when mixing down to speaker bed or final endpoint.
Definition: AkCommonDefs.h:326
Ak3dData()
Definition: AkCommonDefs.h:254
AkForceInline AkChannelConfig GetChannelConfig() const
Definition: AkCommonDefs.h:465
void Transfer(AkString< TAlloc, T_CHAR > &in_from)
Definition: AkString.h:109
AkUInt64 AkAudioObjectID
Audio Object ID.
Definition: AkTypes.h:92
AKRESULT Copy(const AkArray< T, ARG_T, TAlloc, TGrowBy, TMovePolicy > &in_rSource)
Definition: AkArray.h:708
@ SourceChannelOrdering_Standard
Definition: AkCommonDefs.h:168
AkReal32 panSpatMix
Panning vs 3D spatialization mix ([0,1], 1 being 100% spatialized).
Definition: AkCommonDefs.h:286
bool bMultiChannelObjects
Separate pass-through mix is supported.
Definition: AkCommonDefs.h:397
AkUInt32 AkPipelineID
Unique node (bus, voice) identifier for profiling.
Definition: AkTypes.h:90
AkAudioBuffer()
Constructor.
Definition: AkCommonDefs.h:431
AkUInt32 uMaxSystemAudioObjects
Channel configuration of the main mix.
Definition: AkCommonDefs.h:394
@ AK_SpatializationMode_None
No spatialization.
Definition: AkTypes.h:794
AkUInt32 uNumChannels
Number of channels.
Definition: AkSpeakerConfig.h:498
AkAudioObjectID key
Unique ID, local to a given bus.
Definition: AkCommonDefs.h:323
virtual AkReal32 GetKWeightedPower()=0
AkForceInline void * DetachContiguousDeinterleavedData()
Detach deinterleaved data where channels are contiguous in memory. The address of the buffer is retur...
Definition: AkCommonDefs.h:584
AkForceInline AkUInt32 NumChannels() const
Get the number of channels.
Definition: AkCommonDefs.h:454
AkForceInline void Clear()
Clear members.
Definition: AkCommonDefs.h:444
#define AK_DEFAULT_LISTENER_FRONT_Y
Definition: AkCommonDefs.h:243
AKRESULT
Standard function call result.
Definition: AkTypes.h:127
AkUInt32 uChannelMask
Channel mask (configuration).
Definition: AkSpeakerConfig.h:500
static AkUInt32 StandardToPipelineIndex(AkChannelConfig in_channelConfig, AkUInt32 in_uChannelIdx)
Definition: AkCommonDefs.h:510
@ AK_ChannelConfigType_Standard
Channels must be identified with standard defines in AkSpeakerConfigs.
Definition: AkSpeakerConfig.h:465
AkForceInline bool HasCenter() const
Definition: AkCommonDefs.h:91
void Set(const AkVector &in_position, const AkVector &in_orientationFront, const AkVector &in_orientationTop)
Set position and orientation. Orientation front and top should be orthogonal and normalized.
Definition: AkTypes.h:359
static const AkAudioObjectID AK_INVALID_AUDIO_OBJECT_ID
Invalid audio object ID.
Definition: AkTypes.h:111
AkUInt32 AkChannelMask
Channel mask (similar to WAVE_FORMAT_EXTENSIBLE). Bit values are defined in AkSpeakerConfig....
Definition: AkTypes.h:85
AkChannelConfig channelConfig
Channel configuration.
Definition: AkCommonDefs.h:66
#define AK_DEFAULT_LISTENER_POSITION_Z
Definition: AkCommonDefs.h:241
@ SourceChannelOrdering_Film
Definition: AkCommonDefs.h:171
void RelocateMedia(AkUInt8 *in_pNewMedia, AkUInt8 *in_pOldMedia)
Definition: AkCommonDefs.h:598
AkUInt32 uBitsPerSample
Number of bits per sample.
Definition: AkCommonDefs.h:68
#define AK_DEFAULT_LISTENER_POSITION_Y
Definition: AkCommonDefs.h:240
void CopyContents(const AkAudioObject &in_src)
Copy object metadata (everything but the key) from another object.
Definition: AkCommonDefs.h:344
Positioning data inherited from sound structures and mix busses.
Definition: AkCommonDefs.h:270
AkUInt32 uTypeID
Data type ID (AkDataTypeID).
Definition: AkCommonDefs.h:70
#define AK_DEFAULT_TOP_X
Definition: AkCommonDefs.h:245
#define NULL
Definition: AkTypes.h:47
AKRESULT eState
Execution status.
Definition: AkCommonDefs.h:613
AkReal32 panDU
Pan down-up [-1,1].
Definition: AkCommonDefs.h:285
AkUInt16 uValidFrames
Number of valid sample frames in the audio buffer.
Definition: AkCommonDefs.h:619
AKRESULT SetName(AK::IAkPluginMemAlloc *in_pAllocator, const char *in_szName)
Definition: AkCommonDefs.h:370
#define AK_DEFAULT_TOP_Y
Definition: AkCommonDefs.h:246
AkForceInline void Init(AK::IAkPluginMemAlloc *in_pAllocator)
void * pData
Start of the audio buffer.
Definition: AkCommonDefs.h:609
AkAudioObjectDestination
Enum of the possible object destinations when reaching a 3D audio-capable sink.
Definition: AkCommonDefs.h:402
AkChannelConfig channelConfig
Channel config.
Definition: AkCommonDefs.h:610
virtual AK::SpeakerVolumes::ConstVectorPtr GetTruePeak()=0
AkUInt32 AkUniqueID
Unique 32-bit ID.
Definition: AkTypes.h:57
AkAudioBuffer ** ppObjectBuffers
Array of pointers to audio object buffers.
Definition: AkCommonDefs.h:632
#define AK_DEFAULT_LISTENER_POSITION_X
Default listener transform.
Definition: AkCommonDefs.h:239
const AkDataTypeID AK_FLOAT
Float data type.
Definition: AkCommonDefs.h:51
AkUInt32 AkPluginID
Source or effect plug-in ID.
Definition: AkTypes.h:68
AkUInt16 AkDataTypeID
Data sample type ID.
Definition: AkTypes.h:74
void ResetState()
Reset object state in preparation for next frame.
Definition: AkCommonDefs.h:381
#define AKASSERT(Condition)
Definition: AkAssert.h:76
AkUInt32 uNumObjects
Number of audio objects.
Definition: AkCommonDefs.h:631
AkSpeakerPanningType panType
Speaker panning type.
Definition: AkCommonDefs.h:288
ArrayCustomMetadata arCustomMetadata
Array of custom metadata, gathered from visited objects.
Definition: AkCommonDefs.h:336
static const AkPipelineID AK_INVALID_PIPELINE_ID
Invalid pipeline ID (for profiling)
Definition: AkTypes.h:110
const AkUInt32 AK_LE_NATIVE_BITSPERSAMPLE
Native number of bits per sample.
Definition: AkCommonDefs.h:57
bool bPassthrough
How many System Audio Objects can currently be sent to the sink. This value can change at runtime dep...
Definition: AkCommonDefs.h:396
Volume ramp specified by end points "previous" and "next".
Definition: AkTypes.h:619
AkUInt16 uMaxFrames
Number of sample frames the buffer can hold. Access through AkAudioBuffer::MaxFrames().
Definition: AkCommonDefs.h:616
AkPluginID pluginID
Full plugin ID (including company ID and plugin type. See AKMAKECLASSID macro.
Definition: AkCommonDefs.h:331
uint8_t AkUInt8
Unsigned 8-bit integer.
Definition: AkTypes.h:75
AkBehavioralPositioningData behavioral
Positioning data inherited from sound structures and mix busses.
Definition: AkCommonDefs.h:296
uint16_t AkUInt16
Unsigned 16-bit integer.
Definition: AkTypes.h:76
AkForceInline void Clear()
Clear the channel config. Becomes "invalid" (IsValid() returns false).
Definition: AkSpeakerConfig.h:524
AkReal32 AkSampleType
Audio sample data type (32 bit floating point)
Definition: AkCommonDefs.h:420
AK::IAkPluginParam * pParam
Custom, pluggable medata.
Definition: AkCommonDefs.h:332
void ClearReference()
Definition: AkString.h:50
const AkUInt32 AK_LE_NATIVE_SAMPLETYPE
Native data type.
Definition: AkCommonDefs.h:58
#define AK_DEFAULT_LISTENER_FRONT_X
Definition: AkCommonDefs.h:242
AkForceInline void AkMemSet(void *pDest, AkInt32 iVal, AkUInt32 uSize)
Platform Independent Helper.
Definition: AkPlatformFuncs.h:401
void Transfer(AkArray< T, ARG_T, TAlloc, TGrowBy, TMovePolicy > &in_rSource)
Definition: AkArray.h:695
AkPipelineID instigatorID
Profiling ID of the node from which the object stems (typically the voice, instance of an actor-mixer...
Definition: AkCommonDefs.h:338
Ak3DSpatializationMode
3D spatialization mode.
Definition: AkTypes.h:793
AkArray< CustomMetadata, const CustomMetadata &, AkPluginArrayAllocator > ArrayCustomMetadata
Array type for carrying custom metadata.
Definition: AkCommonDefs.h:335
Ak3dData threeD
3D data used for 3D spatialization.
Definition: AkCommonDefs.h:295
AkForceInline AkUInt32 GetNumNonZeroBits(AkUInt32 in_uWord)
Definition: AkPlatformFuncs.h:123
AkForceInline AkUInt32 GetBitsPerSample() const
Definition: AkCommonDefs.h:98
@ AK_DataNeeded
The consumer needs more.
Definition: AkTypes.h:153
Positioning data of 3D audio objects.
Definition: AkCommonDefs.h:294
A collection of audio objects. Encapsulates the audio data and metadata of each audio object in separ...
Definition: AkCommonDefs.h:624
uint64_t AkUIntPtr
Definition: AkTypes.h:82
AkUInt32 uBlockAlign
Number of bytes per sample frame. (For example a 5.1 PCM 16bit should have a uBlockAlign equal to 6(5...
Definition: AkCommonDefs.h:69
AkChannelConfig channelConfig
Definition: AkCommonDefs.h:393
AkForceInline AkUInt32 GetInterleaveID() const
Definition: AkCommonDefs.h:119
#define AK_DEFAULT_LISTENER_FRONT_Z
Definition: AkCommonDefs.h:244
AkForceInline bool operator!=(const AkAudioFormat &in_other) const
Definition: AkCommonDefs.h:153
void ZeroPadToMaxFrames()
Definition: AkCommonDefs.h:560
AkForceInline bool HasLFE() const
Definition: AkCommonDefs.h:82
float AkReal32
32-bit floating point
Definition: AkTypes.h:95
AkForceInline AkUInt32 GetBlockAlign() const
Definition: AkCommonDefs.h:105
AKRESULT AllocCopy()
Definition: AkString.h:85
AkChannelMask uEmitterChannelMask
Emitter channel mask. With 3D spatialization, zeroed channels should be dropped.
Definition: AkCommonDefs.h:265
AkUInt8(* AkChannelMappingFunc)(const AkChannelConfig &config, AkUInt8 idx)
Definition: AkCommonDefs.h:164
AkUInt32 eConfigType
Channel config type (AkChannelConfigType).
Definition: AkSpeakerConfig.h:499
AkReal32 panLR
Pan left-right [-1,1].
Definition: AkCommonDefs.h:283
AkForceInline void AttachContiguousDeinterleavedData(void *in_pData, AkUInt16 in_uMaxFrames, AkUInt16 in_uValidFrames, AkChannelConfig in_channelConfig)
Attach deinterleaved data where channels are contiguous in memory. Allocation is performed outside.
Definition: AkCommonDefs.h:579
void Term()
Term the array. Must be called before destroying the object.
Definition: AkArray.h:440
AkReal32 spread
Spread [0,1].
Definition: AkCommonDefs.h:263
AkForceInline bool HasLFE() const
Definition: AkSpeakerConfig.h:656
~AkAudioObject()
Destructor.
Definition: AkCommonDefs.h:317
AkForceInline bool operator==(const AkAudioFormat &in_other) const
Definition: AkCommonDefs.h:143
AkSampleType * GetLFE()
Definition: AkCommonDefs.h:550
AkForceInline void * GetInterleavedData()
Definition: AkCommonDefs.h:476
virtual AK::SpeakerVolumes::ConstVectorPtr GetPeak()=0
String objectName
Name string of the object, to appear in the object profiler. This is normally used by out-of-place ob...
Definition: AkCommonDefs.h:341
Custom object metadata.
Definition: AkCommonDefs.h:330
AkForceInline AkUInt32 GetNumChannels() const
Definition: AkCommonDefs.h:75
void Term()
Definition: AkString.h:40
#define AK_SPEAKER_LOW_FREQUENCY
Low-frequency speaker bit mask.
Definition: AkSpeakerConfig.h:37
uint32_t AkUInt32
Unsigned 32-bit integer.
Definition: AkTypes.h:77
@ AK_DirectSpeakerAssignment
No panning: route to matching channels between input and output.
Definition: AkTypes.h:769
const AkDataTypeID AK_INT
Integer data type (uchar, short, and so on)
Definition: AkCommonDefs.h:50
Defines the parameters of an audio buffer format.
Definition: AkCommonDefs.h:63
AkUInt32 uInterleaveID
Interleave ID (AkDataInterleaveID).
Definition: AkCommonDefs.h:71
AkUniqueID contextID
(Profiling) ID of the sound or bus from which the custom metadata was fetched.
Definition: AkCommonDefs.h:333
virtual ~IAkMetering()
Virtual destructor on interface to avoid warnings.
Definition: AkCommonDefs.h:207
bool CheckValidSamples()
Position and orientation of game objects.
Definition: AkTypes.h:330
AkForceInline AkUInt32 GetTypeID() const
Definition: AkCommonDefs.h:112
AkForceInline bool IsValid() const
Returns true if valid, false otherwise (as when it is constructed, or invalidated using Clear()).
Definition: AkSpeakerConfig.h:591
AkReal32 focus
Focus [0,1].
Definition: AkCommonDefs.h:264
AkTransform xform
Object position / orientation.
Definition: AkCommonDefs.h:262
AkForceInline void ClearData()
Clear data pointer.
Definition: AkCommonDefs.h:437
void AttachInterleavedData(void *in_pData, AkUInt16 in_uMaxFrames, AkUInt16 in_uValidFrames)
Attach interleaved data. Allocation is performed outside.
Definition: AkCommonDefs.h:482
AkAudioObjects(AkUInt32 in_uNumObjects=0, AkAudioBuffer **in_ppObjectBuffers=nullptr, AkAudioObject **in_ppObjects=nullptr)
Definition: AkCommonDefs.h:625
AkAudioObject ** ppObjects
Array of pointers to audio objects.
Definition: AkCommonDefs.h:633
AkUInt32 uSampleRate
Number of samples per second.
Definition: AkCommonDefs.h:64
const AkReal32 * ConstVectorPtr
Constant volume vector. Access each element with the standard bracket [] operator.
Definition: AkSpeakerVolumes.h:51
const AkDataInterleaveID AK_NONINTERLEAVED
Non-interleaved data.
Definition: AkCommonDefs.h:54
Ak3DSpatializationMode spatMode
3D spatialization mode.
Definition: AkCommonDefs.h:287
virtual AK::SpeakerVolumes::ConstVectorPtr GetRMS()=0
AkReal32 panBF
Pan back-front [-1,1].
Definition: AkCommonDefs.h:284
const AkDataInterleaveID AK_INTERLEAVED
Interleaved data.
Definition: AkCommonDefs.h:53
AkSourceChannelOrdering
Definition: AkCommonDefs.h:167
void AttachInterleavedData(void *in_pData, AkUInt16 in_uMaxFrames, AkUInt16 in_uValidFrames, AkChannelConfig in_channelConfig)
Attach interleaved data with a new channel config. Allocation is performed outside.
Definition: AkCommonDefs.h:490
void SetAll(AkUInt32 in_uSampleRate, AkChannelConfig in_channelConfig, AkUInt32 in_uBitsPerSample, AkUInt32 in_uBlockAlign, AkUInt32 in_uTypeID, AkUInt32 in_uInterleaveID)
Definition: AkCommonDefs.h:126
const AkUInt32 AK_LE_NATIVE_INTERLEAVE
Native interleaved setting.
Definition: AkCommonDefs.h:59
AkForceInline AkUInt16 MaxFrames() const
Definition: AkCommonDefs.h:606