Version
menu_open
link
Wwise SDK 2023.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  Copyright (c) 2024 Audiokinetic Inc.
25 *******************************************************************************/
26 
27 // AkCommonDefs.h
28 
29 /// \file
30 /// AudioLib common defines, enums, and structs.
31 
32 
33 #ifndef _AK_COMMON_DEFS_H_
34 #define _AK_COMMON_DEFS_H_
35 
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  /// Struct containing metering information about a buffer. Depending on when this struct is generated, you may get metering data computed in the previous frame only.
203  struct AkMetering
204  {
205  /// Peak of each channel in this frame.
206  /// Vector of linear peak levels, corresponding to each channel. NULL if AK_EnableBusMeter_Peak is not set (see IAkMixerPluginContext::SetMeteringFlags() or AK::SoundEngine::RegisterBusMeteringCallback()).
208 
209  /// True peak of each channel (as defined by ITU-R BS.1770) in this frame.
210  /// 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()).
212 
213  /// RMS value of each channel in this frame.
214  /// Vector of linear rms levels, corresponding to each channel. NULL if AK_EnableBusMeter_RMS is not set (see IAkMixerPluginContext::SetMeteringFlags() or AK::SoundEngine::RegisterBusMeteringCallback()).
216 
217  /// Mean k-weighted power value in this frame, used to compute loudness (as defined by ITU-R BS.1770).
218  /// Total linear k-weighted power of all channels. 0 if AK_EnableBusMeter_KPower is not set (see IAkMixerPluginContext::SetMeteringFlags() or AK::SoundEngine::RegisterBusMeteringCallback()).
220  };
221 
222  static inline bool IsBankCodecID(AkUInt32 in_codecID)
223  {
224  return in_codecID == AKCODECID_BANK ||
225  in_codecID == AKCODECID_BANK_EVENT ||
226  in_codecID == AKCODECID_BANK_BUS;
227  }
228 }
229 
230 // 3D Audio Object.
231 // ------------------------------------------------
232 
233 /// Default listener transform.
234 #define AK_DEFAULT_LISTENER_POSITION_X (0.0f) // at coordinate system's origin
235 #define AK_DEFAULT_LISTENER_POSITION_Y (0.0f)
236 #define AK_DEFAULT_LISTENER_POSITION_Z (0.0f)
237 #define AK_DEFAULT_LISTENER_FRONT_X (0.0f) // looking toward Z,
238 #define AK_DEFAULT_LISTENER_FRONT_Y (0.0f)
239 #define AK_DEFAULT_LISTENER_FRONT_Z (1.0f)
240 #define AK_DEFAULT_TOP_X (0.0f) // top towards Y
241 #define AK_DEFAULT_TOP_Y (1.0f)
242 #define AK_DEFAULT_TOP_Z (0.0f)
243 
244 
245 /// 3D data needed for 3D spatialization.
246 /// Undergoes transformations based on emitter-listener placement.
247 struct Ak3dData
248 {
250  : spread(1.f)
251  , focus(1.f)
252  , uEmitterChannelMask(0xffffffff)
253  {
255  }
256 
257  AkTransform xform; ///< Object position / orientation.
258  AkReal32 spread; ///< Spread [0,1]
259  AkReal32 focus; ///< Focus [0,1]
260  AkChannelMask uEmitterChannelMask; ///< Emitter channel mask. With 3D spatialization, zeroed channels should be dropped.
261 };
262 
263 /// Positioning data inherited from sound structures and mix busses.
265 {
267  : center(1.f)
268  , panLR(0.f)
269  , panBF(0.f)
270  , panDU(0.f)
271  , panSpatMix(1.f)
274  , enableHeightSpread(true)
275  {}
276 
277  AkReal32 center; ///< Center percentage [0,1]
278  AkReal32 panLR; ///< Pan left-right [-1,1]
279  AkReal32 panBF; ///< Pan back-front [-1,1]
280  AkReal32 panDU; ///< Pan down-up [-1,1]
281  AkReal32 panSpatMix; ///< Panning vs 3D spatialization mix ([0,1], 1 being 100% spatialized).
282  Ak3DSpatializationMode spatMode; ///< 3D spatialization mode.
283  AkSpeakerPanningType panType; ///< Speaker panning type.
284  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.
285 };
286 
287 /// Positioning data of 3D audio objects.
289 {
290  Ak3dData threeD; ///< 3D data used for 3D spatialization.
291  AkBehavioralPositioningData behavioral; ///< Positioning data inherited from sound structures and mix busses.
292 };
293 
294 // Forward defines
295 namespace AK
296 {
297  class IAkPluginParam;
298 }
299 
300 /// An audio object refers to an audio signal with some attached metadata going through the sound engine pipeline.
301 /// The AkAudioObject struct encapsulates the metadata part. The signal itself is contained in a separate AkAudioBuffer instance.
303 {
304  /// Constructor
307  ,cumulativeGain(1.f, 1.f)
310  {}
311 
312  /// Destructor
314  {
316  objectName.Term();
317  }
318 
319  static const AkUInt64 kObjectKeyNumBits = 56;
320  static const AkUInt64 kObjectKeyMask = (((AkUInt64)1 << kObjectKeyNumBits) - 1);
321 
322  AkAudioObjectID key; ///< Unique ID, local to a given bus. Only the lower 56 of 64 bits are used for the object itself. The highest 8 bits are available for channel indexing.
323 
324  AkPositioningData positioning; ///< Positioning data for deferred 3D rendering.
325  AkRamp cumulativeGain; ///< Cumulative ramping gain to apply when mixing down to speaker bed or final endpoint
326  AkPipelineID instigatorID; ///< Profiling ID of the node from which the object stems (typically the voice, instance of an actor-mixer).
327  AkPriority priority; ///< Audio object playback priority. Object with a higher priority will be rendered using the hardware's object functionality on platforms that supports it, whereas objects with a lower priority will be downmixed to a lower resolution 3D bed. Audio object priorities should be retrieved, or set through IAkPluginServiceAudioObjectPriority to retain compatibility with future Wwise releases.
328 
329  /// Custom object metadata.
331  {
332  AkPluginID pluginID; ///< Full plugin ID, including company ID and plugin type. See AKMAKECLASSID macro.
333  AkUniqueID contextID; ///< (Profiling) ID of the sound or bus from which the custom metadata was fetched.
334  AK::IAkPluginParam* pParam; ///< Custom, pluggable medata. Note: any custom metadata is expected to exist for only the current sound engine render tick, and persistent references to it should not be stored.
335  };
336 
337  /// Array type for carrying custom metadata.
338  class ArrayCustomMetadata : public AkArray<CustomMetadata, const CustomMetadata&, AkPluginArrayAllocator>
339  {
340  public:
342 
343  ArrayType::Iterator FindByPluginID(AkPluginID pluginID) const
344  {
345  for (auto it = Begin(); it != End(); ++it)
346  {
347  if ((*it).pluginID == pluginID)
348  return it;
349  }
350  return End();
351  }
352  };
353 
354  ArrayCustomMetadata arCustomMetadata; ///< Array of custom metadata, gathered from visited objects. Note: any custom metadata is expected to exist for only the current sound engine render tick, and persistent references to it should not be stored.
355 
356  typedef AkString<AkPluginArrayAllocator, char> String; ///< String type for use in 3D audio objects.
357  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.
358 
359  /// Copies object metadata (everything but the key) from another object.
361  const AkAudioObject& in_src ///< Object from which metadata is copied.
362  )
363  {
364  positioning = in_src.positioning;
366  instigatorID = in_src.instigatorID;
367  priority = in_src.priority;
369  objectName = in_src.objectName; // AkString performs a shallow copy when it can, like here.
370  }
371 
372  /// Moves object metadata (everything but the key) from another object.
374  AkAudioObject& in_src ///< Object from which metadata is moved.
375  )
376  {
377  positioning = in_src.positioning;
379  instigatorID = in_src.instigatorID;
380  priority = in_src.priority;
383  }
384 
385  void SetCustomMetadata(CustomMetadata* in_aCustomMetadata, AkUInt32 in_uLength)
386  {
387  if (arCustomMetadata.Resize(in_uLength))
388  {
389  for (int i = 0; i < (int)in_uLength; ++i)
390  {
391  arCustomMetadata[i] = in_aCustomMetadata[i];
392  }
393  }
394  }
395 
396  /// Transfer function for transfer move policies.
397  void Transfer(
398  AkAudioObject& in_from ///< Object from which data is transferred.
399  )
400  {
401  key = in_from.key;
402  TransferContents(in_from);
403  }
404 
405  /// Object processors may give an explicit name to objects.
406  /// \return AK_Success if the string was allocated successfully, AK_InsufficientMemory otherwise.
408  AK::IAkPluginMemAlloc* in_pAllocator, ///< Memory allocator.
409  const char* in_szName ///< Null-terminated string to allocate and store on this object.
410  )
411  {
412  objectName.Init(in_pAllocator);
413  objectName = in_szName;
414  return objectName.AllocCopy();
415  }
416 
417  /// Reset object state in preparation for next frame.
418  void ResetState()
419  {
420  arCustomMetadata.Term(); // Reset custom metadata in preparation for next frame.
421  objectName.ClearReference(); // Clear reference to string in preparation for next frame.
422  }
423 };
424 
425 /// Structure containing information about system-level support for 3D audio.
426 /// "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.
427 /// We prefer "3D Audio" to "Spatial" to avoid ambiguity with spatial audio, which typically involves sound propagation and environment effects.
429 {
430  AkChannelConfig channelConfig; ///< Channel configuration of the main mix.
431  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.
432  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.
433  bool bPassthrough; ///< Separate pass-through mix is supported.
434  bool bMultiChannelObjects; ///< Can handle multi-channel objects
435 };
436 
437 /// Enum of the possible object destinations when reaching a 3D audio-capable sink
439 {
440  eDefault = 0, // The destination will be chosen based on the audio object's metadata and channel configuration
441  eMainMix = 1, // The audio object will be mixed to the sink's main mix
442  ePassthrough = 2, // The audio object will be mixed to the sink's passthrough mix
443  eSystemAudioObject = 3 // The audio object will not be mixed; it will be sent separately to the system's 3D audio endpoint
444 };
445 
446 // Audio buffer.
447 // ------------------------------------------------
448 
449 /// Native sample type.
450 /// \remarks Sample values produced by insert effects must use this type.
451 /// \remarks Source plug-ins can produce samples of other types (specified through
452 /// according fields of AkAudioFormat, at initial handshaking), but these will be
453 /// format converted internally into the native format.
454 /// \sa
455 /// - \ref iaksourceeffect_init
456 /// - \ref iakmonadiceffect_init
457 typedef AkReal32 AkSampleType; ///< Audio sample data type (32 bit floating point)
458 
459 /// Audio buffer structure including the address of an audio buffer, the number of valid frames inside,
460 /// and the maximum number of frames the audio buffer can hold.
461 /// \sa
462 /// - \ref fx_audiobuffer_struct
464 {
465 public:
466 
467  /// Constructor.
469  {
470  Clear();
471  }
472 
473  /// Clear data pointer.
475  {
476  pData = NULL;
477  uValidFrames = 0;
478  }
479 
480  /// Clear members.
482  {
483  ClearData();
484  uMaxFrames = 0;
486  }
487 
488  /// \name Channel queries.
489  //@{
490  /// Get the number of channels.
492  {
494  }
495 
496  /// Returns true if there is an LFE channel present.
497  AkForceInline bool HasLFE() const
498  {
499  return channelConfig.HasLFE();
500  }
501 
503 
504  //@}
505 
506  /// \name Interleaved interface
507  //@{
508  /// Get address of data: to be used with interleaved buffers only.
509  /// \remarks Only source plugins can output interleaved data. This is determined at
510  /// initial handshaking.
511  /// \sa
512  /// - \ref fx_audiobuffer_struct
514  {
515  return pData;
516  }
517 
518  /// Attach interleaved data. Allocation is performed outside.
519  inline void AttachInterleavedData( void * in_pData, AkUInt16 in_uMaxFrames, AkUInt16 in_uValidFrames )
520  {
521  pData = in_pData;
522  uMaxFrames = in_uMaxFrames;
523  uValidFrames = in_uValidFrames;
525  }
526  /// Attach interleaved data with a new channel config. Allocation is performed outside.
527  inline void AttachInterleavedData( void * in_pData, AkUInt16 in_uMaxFrames, AkUInt16 in_uValidFrames, AkChannelConfig in_channelConfig )
528  {
529  pData = in_pData;
530  uMaxFrames = in_uMaxFrames;
531  uValidFrames = in_uValidFrames;
532  channelConfig = in_channelConfig;
533  }
534  //@}
535 
536  /// \name Deinterleaved interface
537  //@{
538 
539  /// Check if buffer has samples attached to it.
540  AkForceInline bool HasData() const
541  {
542  return ( NULL != pData );
543  }
544 
545  /// Convert a channel, identified by a single channel bit, to a buffer index used in GetChannel() below, for a given channel config.
546  /// Standard indexing follows channel bit order (see AkSpeakerConfig.h). Pipeline/buffer indexing is the same but the LFE is moved to the end.
548  AkChannelConfig in_channelConfig, ///< Channel configuration.
549  AkUInt32 in_uChannelIdx ///< Channel index in standard ordering to be converted to pipeline ordering.
550  )
551  {
552  if ( in_channelConfig.HasLFE() )
553  {
554  AKASSERT( in_channelConfig.eConfigType == AK_ChannelConfigType_Standard ); // in_channelConfig.HasLFE() would not have returned true otherwise.
555  AKASSERT( AK::GetNumNonZeroBits( in_channelConfig.uChannelMask ) );
556  AkUInt32 uIdxLFE = AK::GetNumNonZeroBits( ( AK_SPEAKER_LOW_FREQUENCY - 1 ) & in_channelConfig.uChannelMask );
557  if ( in_uChannelIdx == uIdxLFE )
558  return in_channelConfig.uNumChannels - 1;
559  else if ( in_uChannelIdx > uIdxLFE )
560  return in_uChannelIdx - 1;
561  }
562 
563  return in_uChannelIdx;
564  }
565 
566  /// Get the buffer of the ith channel.
567  /// Access to channel data is most optimal through this method. Use whenever the
568  /// speaker configuration is known, or when an operation must be made independently
569  /// for each channel.
570  /// \remarks When using a standard configuration, use ChannelMaskToBufferIndex() to convert channel bits to buffer indices.
571  /// \return Address of the buffer of the ith channel.
572  /// \sa
573  /// - \ref fx_audiobuffer_struct
574  /// - \ref fx_audiobuffer_struct_channels
576  AkUInt32 in_uIndex ///< Channel index [0,NumChannels()-1]
577  )
578  {
579  AKASSERT( in_uIndex < NumChannels() );
580  return (AkSampleType*)((AkUInt8*)(pData) + ( in_uIndex * sizeof(AkSampleType) * MaxFrames() ));
581  }
582 
583  /// Get the buffer of the LFE.
584  /// \return Address of the buffer of the LFE. Null if there is no LFE channel.
585  /// \sa
586  /// - \ref fx_audiobuffer_struct_channels
587  inline AkSampleType * GetLFE()
588  {
590  return GetChannel( NumChannels()-1 );
591 
592  return (AkSampleType*)0;
593  }
594 
595  /// Can be used to transform an incomplete into a complete buffer with valid data.
596  /// The invalid frames are made valid (zeroed out) for all channels and the validFrames count will be made equal to uMaxFrames.
598  {
599  AKASSERT(pData != nullptr || MaxFrames() == 0);
600  // The following members MUST be copied locally due to multi-core calls to this function.
601  const AkUInt32 uNumChannels = NumChannels();
602  const AkUInt32 uNumCurrentFrames = AkMin(uValidFrames, MaxFrames());
603  const AkUInt32 uNumZeroFrames = MaxFrames() - uNumCurrentFrames;
604  if ( uNumZeroFrames )
605  {
606  AKASSERT(pData != nullptr);
607  for ( AkUInt32 i = 0; i < uNumChannels; ++i )
608  {
609  AKPLATFORM::AkMemSet( GetChannel(i) + uNumCurrentFrames, 0, uNumZeroFrames * sizeof(AkSampleType) );
610  }
612  }
613  }
614 
615  /// Attach deinterleaved data where channels are contiguous in memory. Allocation is performed outside.
616  AkForceInline void AttachContiguousDeinterleavedData( void * in_pData, AkUInt16 in_uMaxFrames, AkUInt16 in_uValidFrames, AkChannelConfig in_channelConfig )
617  {
618  AttachInterleavedData( in_pData, in_uMaxFrames, in_uValidFrames, in_channelConfig );
619  }
620  /// Detach deinterleaved data where channels are contiguous in memory. The address of the buffer is returned and fields are cleared.
622  {
623  uMaxFrames = 0;
624  uValidFrames = 0;
626  void * pDataOld = pData;
627  pData = NULL;
628  return pDataOld;
629  }
630 
632 
633  //@}
634 
635  void RelocateMedia( AkUInt8* in_pNewMedia, AkUInt8* in_pOldMedia )
636  {
637  AkUIntPtr uMemoryOffset = (AkUIntPtr)in_pNewMedia - (AkUIntPtr)in_pOldMedia;
638  pData = (void*) (((AkUIntPtr)pData) + uMemoryOffset);
639  }
640 
641  /// Access to the number of sample frames the buffer can hold.
642  /// \return Number of sample frames the buffer can hold.
644 
645 protected:
646  void * pData; ///< Start of the audio buffer.
647  AkChannelConfig channelConfig; ///< Channel config.
648 
649 public:
650  AKRESULT eState; ///< Execution status
651 
652 protected:
653  AkUInt16 uMaxFrames; ///< Number of sample frames the buffer can hold. Access through AkAudioBuffer::MaxFrames().
654 
655 public:
656  AkUInt16 uValidFrames; ///< Number of valid sample frames in the audio buffer
657 };
658 
659 /// A collection of audio objects. Encapsulates the audio data and metadata of each audio object in separate arrays.
661 {
662  AkAudioObjects(AkUInt32 in_uNumObjects = 0, AkAudioBuffer** in_ppObjectBuffers = nullptr, AkAudioObject** in_ppObjects = nullptr)
663  : uNumObjects(in_uNumObjects)
664  , ppObjectBuffers(in_ppObjectBuffers)
665  , ppObjects(in_ppObjects)
666  {}
667 
668  AkUInt32 uNumObjects; ///< Number of audio objects.
669  AkAudioBuffer** ppObjectBuffers; ///< Array of pointers to audio object buffers.
670  AkAudioObject** ppObjects; ///< Array of pointers to audio objects.
671 };
672 
673 #endif // _AK_COMMON_DEFS_H_
void Transfer(AkAudioObject &in_from)
Transfer function for transfer move policies.
Definition: AkCommonDefs.h:397
AkString< AkPluginArrayAllocator, char > String
String type for use in 3D audio objects.
Definition: AkCommonDefs.h:356
AkForceInline bool HasLFE() const
Returns true if there is an LFE channel present.
Definition: AkCommonDefs.h:497
bool enableHeightSpread
When true, audio objects 3D spatialized onto a planar channel configuration will be given a minimum s...
Definition: AkCommonDefs.h:284
#define AkMin(x1, x2)
AkUInt8 AkDataInterleaveID
Data interleaved state ID.
Definition: AkTypes.h:152
@ AK_DirectSpeakerAssignment
No panning: route to matching channels between input and output.
Definition: AkTypes.h:1184
AkUInt32 uAvailableSystemAudioObjects
How many System Audio Objects can currently be sent to the sink. This value can change at runtime dep...
Definition: AkCommonDefs.h:432
AkSampleType * GetChannel(AkUInt32 in_uIndex)
Definition: AkCommonDefs.h:575
#define AK_DEFAULT_TOP_Z
Definition: AkCommonDefs.h:242
uint16_t AkUInt16
Unsigned 16-bit integer.
Audiokinetic namespace.
AkForceInline bool HasData() const
Check if buffer has samples attached to it.
Definition: AkCommonDefs.h:540
AkAudioObject()
Constructor.
Definition: AkCommonDefs.h:305
static const AkUInt64 kObjectKeyNumBits
Definition: AkCommonDefs.h:319
AkForceInline bool HasCenter() const
AkPositioningData positioning
Positioning data for deferred 3D rendering.
Definition: AkCommonDefs.h:324
@ SourceChannelOrdering_FuMa
Definition: AkCommonDefs.h:172
AkReal32 center
Center percentage [0,1].
Definition: AkCommonDefs.h:277
AkRamp cumulativeGain
Cumulative ramping gain to apply when mixing down to speaker bed or final endpoint.
Definition: AkCommonDefs.h:325
AkForceInline AkChannelConfig GetChannelConfig() const
Definition: AkCommonDefs.h:502
void Transfer(AkString< TAlloc, T_CHAR > &in_from)
Definition: AkString.h:108
AkUInt64 AkAudioObjectID
Audio Object ID.
Definition: AkTypes.h:170
AKRESULT Copy(const AkArray< T, ARG_T, TAlloc, TGrowBy, TMovePolicy > &in_rSource)
Definition: AkArray.h:865
@ SourceChannelOrdering_Standard
Definition: AkCommonDefs.h:168
AkReal32 panSpatMix
Panning vs 3D spatialization mix ([0,1], 1 being 100% spatialized).
Definition: AkCommonDefs.h:281
bool bMultiChannelObjects
Can handle multi-channel objects.
Definition: AkCommonDefs.h:434
AkUInt32 AkPipelineID
Unique node (bus, voice) identifier for profiling.
Definition: AkTypes.h:168
AkAudioBuffer()
Constructor.
Definition: AkCommonDefs.h:468
AkUInt32 uMaxSystemAudioObjects
Maximum number of System Audio Objects that can be active concurrently. A value of zero indicates the...
Definition: AkCommonDefs.h:431
AkUInt32 uNumChannels
Number of channels.
static const AkUInt64 kObjectKeyMask
Definition: AkCommonDefs.h:320
AkAudioObjectID key
Unique ID, local to a given bus. Only the lower 56 of 64 bits are used for the object itself....
Definition: AkCommonDefs.h:322
AkForceInline void * DetachContiguousDeinterleavedData()
Detach deinterleaved data where channels are contiguous in memory. The address of the buffer is retur...
Definition: AkCommonDefs.h:621
AkForceInline AkUInt32 NumChannels() const
Get the number of channels.
Definition: AkCommonDefs.h:491
AkForceInline void Clear()
Clear members.
Definition: AkCommonDefs.h:481
#define AK_DEFAULT_LISTENER_FRONT_Y
Definition: AkCommonDefs.h:238
AKRESULT
Standard function call result.
Definition: AkTypes.h:213
AkUInt32 uChannelMask
Channel mask (configuration).
static AkUInt32 StandardToPipelineIndex(AkChannelConfig in_channelConfig, AkUInt32 in_uChannelIdx)
Definition: AkCommonDefs.h:547
@ AK_ChannelConfigType_Standard
Channels must be identified with standard defines in AkSpeakerConfigs.
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:642
static const AkAudioObjectID AK_INVALID_AUDIO_OBJECT_ID
Invalid audio object ID.
Definition: AkTypes.h:191
AkUInt32 AkChannelMask
Channel mask (similar to WAVE_FORMAT_EXTENSIBLE). Bit values are defined in AkSpeakerConfig....
Definition: AkTypes.h:163
AkChannelConfig channelConfig
Channel configuration.
Definition: AkCommonDefs.h:66
#define AK_DEFAULT_LISTENER_POSITION_Z
Definition: AkCommonDefs.h:236
@ SourceChannelOrdering_Film
Definition: AkCommonDefs.h:171
void RelocateMedia(AkUInt8 *in_pNewMedia, AkUInt8 *in_pOldMedia)
Definition: AkCommonDefs.h:635
uint8_t AkUInt8
Unsigned 8-bit integer.
AkUInt32 uBitsPerSample
Number of bits per sample.
Definition: AkCommonDefs.h:68
#define AK_DEFAULT_LISTENER_POSITION_Y
Definition: AkCommonDefs.h:235
void CopyContents(const AkAudioObject &in_src)
Copies object metadata (everything but the key) from another object.
Definition: AkCommonDefs.h:360
Positioning data inherited from sound structures and mix busses.
Definition: AkCommonDefs.h:265
AkUInt32 uTypeID
Data type ID (AkDataTypeID).
Definition: AkCommonDefs.h:70
#define AK_DEFAULT_TOP_X
Definition: AkCommonDefs.h:240
Specific implementation of array.
Definition: AkArray.h:258
AK::SpeakerVolumes::VectorPtr rms
Definition: AkCommonDefs.h:215
#define NULL
Definition: AkTypes.h:46
float AkReal32
32-bit floating point
void TransferContents(AkAudioObject &in_src)
Moves object metadata (everything but the key) from another object.
Definition: AkCommonDefs.h:373
AKRESULT eState
Execution status.
Definition: AkCommonDefs.h:650
AK::SpeakerVolumes::VectorPtr truePeak
Definition: AkCommonDefs.h:211
AkReal32 panDU
Pan down-up [-1,1].
Definition: AkCommonDefs.h:280
AkUInt16 uValidFrames
Number of valid sample frames in the audio buffer.
Definition: AkCommonDefs.h:656
uintptr_t AkUIntPtr
Integer (unsigned) type for pointers.
static const AkPriority AK_DEFAULT_PRIORITY
Default sound / I/O priority.
Definition: AkTypes.h:194
AKRESULT SetName(AK::IAkPluginMemAlloc *in_pAllocator, const char *in_szName)
Definition: AkCommonDefs.h:407
#define AK_DEFAULT_TOP_Y
Definition: AkCommonDefs.h:241
AkForceInline void Init(AK::IAkPluginMemAlloc *in_pAllocator)
AkReal32 * VectorPtr
Volume vector. Access each element with the standard bracket [] operator.
void * pData
Start of the audio buffer.
Definition: AkCommonDefs.h:646
AkAudioObjectDestination
Enum of the possible object destinations when reaching a 3D audio-capable sink.
Definition: AkCommonDefs.h:439
AkChannelConfig channelConfig
Channel config.
Definition: AkCommonDefs.h:647
AkUInt32 AkUniqueID
Unique 32-bit ID.
Definition: AkTypes.h:134
bool Resize(AkUInt32 in_uiSize)
Resize the array to the specified size.
Definition: AkArray.h:822
AkAudioBuffer ** ppObjectBuffers
Array of pointers to audio object buffers.
Definition: AkCommonDefs.h:669
Ak3DSpatializationMode
3D spatialization mode.
Definition: AkTypes.h:1217
AkReal32 fMeanPowerK
Definition: AkCommonDefs.h:219
#define AK_DEFAULT_LISTENER_POSITION_X
Default listener transform.
Definition: AkCommonDefs.h:234
const AkDataTypeID AK_FLOAT
Float data type.
Definition: AkCommonDefs.h:51
AkUInt32 AkPluginID
Source or effect plug-in ID.
Definition: AkTypes.h:145
AkUInt16 AkDataTypeID
Data sample type ID.
Definition: AkTypes.h:151
void ResetState()
Reset object state in preparation for next frame.
Definition: AkCommonDefs.h:418
#define AKASSERT(Condition)
Definition: AkAssert.h:67
AkUInt32 uNumObjects
Number of audio objects.
Definition: AkCommonDefs.h:668
AkSpeakerPanningType panType
Speaker panning type.
Definition: AkCommonDefs.h:283
ArrayCustomMetadata arCustomMetadata
Array of custom metadata, gathered from visited objects. Note: any custom metadata is expected to exi...
Definition: AkCommonDefs.h:354
#define AKCODECID_BANK_BUS
Bank encoding for bus banks. These banks are contained in the /bus sub-folder.
Definition: AkTypes.h:1096
static const AkPipelineID AK_INVALID_PIPELINE_ID
Invalid pipeline ID (for profiling)
Definition: AkTypes.h:190
const AkUInt32 AK_LE_NATIVE_BITSPERSAMPLE
Native number of bits per sample.
Definition: AkCommonDefs.h:57
bool bPassthrough
Separate pass-through mix is supported.
Definition: AkCommonDefs.h:433
Volume ramp specified by end points "previous" and "next".
Definition: AkTypes.h:957
AkUInt16 uMaxFrames
Number of sample frames the buffer can hold. Access through AkAudioBuffer::MaxFrames().
Definition: AkCommonDefs.h:653
Iterator End() const
Returns the iterator to the end of the array.
Definition: AkArray.h:352
AkPluginID pluginID
Full plugin ID, including company ID and plugin type. See AKMAKECLASSID macro.
Definition: AkCommonDefs.h:332
AkInt8 AkPriority
Priority.
Definition: AkTypes.h:149
AkBehavioralPositioningData behavioral
Positioning data inherited from sound structures and mix busses.
Definition: AkCommonDefs.h:291
ArrayType::Iterator FindByPluginID(AkPluginID pluginID) const
Definition: AkCommonDefs.h:343
AkForceInline void Clear()
Clear the channel config. Becomes "invalid" (IsValid() returns false).
AkReal32 AkSampleType
Audio sample data type (32 bit floating point)
Definition: AkCommonDefs.h:457
AK::IAkPluginParam * pParam
Custom, pluggable medata. Note: any custom metadata is expected to exist for only the current sound e...
Definition: AkCommonDefs.h:334
void ClearReference()
Definition: AkString.h:49
const AkUInt32 AK_LE_NATIVE_SAMPLETYPE
Native data type.
Definition: AkCommonDefs.h:58
#define AK_DEFAULT_LISTENER_FRONT_X
Definition: AkCommonDefs.h:237
AkForceInline void AkMemSet(void *pDest, AkInt32 iVal, AkUInt32 uSize)
Platform Independent Helper.
void Transfer(AkArray< T, ARG_T, TAlloc, TGrowBy, TMovePolicy > &in_rSource)
Definition: AkArray.h:852
AkPipelineID instigatorID
Profiling ID of the node from which the object stems (typically the voice, instance of an actor-mixer...
Definition: AkCommonDefs.h:326
Iterator Begin() const
Returns the iterator to the first item of the array, will be End() if the array is empty.
Definition: AkArray.h:344
Ak3dData threeD
3D data used for 3D spatialization.
Definition: AkCommonDefs.h:290
AkForceInline AkUInt32 GetNumNonZeroBits(AkUInt32 in_uWord)
Definition: AkBitFuncs.h:181
Struct containing metering information about a buffer. Depending on when this struct is generated,...
Definition: AkCommonDefs.h:204
AkForceInline AkUInt32 GetBitsPerSample() const
Definition: AkCommonDefs.h:98
@ AK_DataNeeded
The consumer needs more.
Definition: AkTypes.h:239
Positioning data of 3D audio objects.
Definition: AkCommonDefs.h:289
A collection of audio objects. Encapsulates the audio data and metadata of each audio object in separ...
Definition: AkCommonDefs.h:661
#define AKCODECID_BANK_EVENT
Bank encoding for event banks. These banks are contained in the /event sub-folder.
Definition: AkTypes.h:1095
uint64_t AkUInt64
Unsigned 64-bit integer.
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
Channel configuration of the main mix.
Definition: AkCommonDefs.h:430
AkForceInline AkUInt32 GetInterleaveID() const
Definition: AkCommonDefs.h:119
#define AK_DEFAULT_LISTENER_FRONT_Z
Definition: AkCommonDefs.h:239
AkForceInline bool operator!=(const AkAudioFormat &in_other) const
Definition: AkCommonDefs.h:153
#define AKCODECID_BANK
Bank encoding.
Definition: AkTypes.h:1073
void ZeroPadToMaxFrames()
Definition: AkCommonDefs.h:597
AkForceInline bool HasLFE() const
Definition: AkCommonDefs.h:82
@ AK_SpatializationMode_None
No spatialization.
Definition: AkTypes.h:1218
AkForceInline AkUInt32 GetBlockAlign() const
Definition: AkCommonDefs.h:105
AKRESULT AllocCopy()
Definition: AkString.h:84
AkChannelMask uEmitterChannelMask
Emitter channel mask. With 3D spatialization, zeroed channels should be dropped.
Definition: AkCommonDefs.h:260
uint32_t AkUInt32
Unsigned 32-bit integer.
void SetCustomMetadata(CustomMetadata *in_aCustomMetadata, AkUInt32 in_uLength)
Definition: AkCommonDefs.h:385
AkUInt8(* AkChannelMappingFunc)(const AkChannelConfig &config, AkUInt8 idx)
Definition: AkCommonDefs.h:164
AkSpeakerPanningType
Speaker panning type: type of panning logic when object is not 3D spatialized (i.e....
Definition: AkTypes.h:1183
AkUInt32 eConfigType
Channel config type (AkChannelConfigType).
AkReal32 panLR
Pan left-right [-1,1].
Definition: AkCommonDefs.h:278
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:616
void Term()
Term the array. Must be called before destroying the object.
Definition: AkArray.h:554
AkReal32 spread
Spread [0,1].
Definition: AkCommonDefs.h:258
AkForceInline bool HasLFE() const
~AkAudioObject()
Destructor.
Definition: AkCommonDefs.h:313
AkPriority priority
Audio object playback priority. Object with a higher priority will be rendered using the hardware's o...
Definition: AkCommonDefs.h:327
AkForceInline bool operator==(const AkAudioFormat &in_other) const
Definition: AkCommonDefs.h:143
AkSampleType * GetLFE()
Definition: AkCommonDefs.h:587
AkForceInline void * GetInterleavedData()
Definition: AkCommonDefs.h:513
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:357
Custom object metadata.
Definition: AkCommonDefs.h:331
AkForceInline AkUInt32 GetNumChannels() const
Definition: AkCommonDefs.h:75
void Term()
Definition: AkString.h:39
#define AK_SPEAKER_LOW_FREQUENCY
Low-frequency speaker bit mask.
Array type for carrying custom metadata.
Definition: AkCommonDefs.h:339
static bool IsBankCodecID(AkUInt32 in_codecID)
Definition: AkCommonDefs.h:222
const AkDataTypeID AK_INT
Integer data type (uchar, short, and so on)
Definition: AkCommonDefs.h:50
#define AkForceInline
Definition: AkTypes.h:63
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
bool CheckValidSamples()
Position and orientation of objects in a "local" space.
Definition: AkTypes.h:613
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()).
AkReal32 focus
Focus [0,1].
Definition: AkCommonDefs.h:259
AkTransform xform
Object position / orientation.
Definition: AkCommonDefs.h:257
AkForceInline void ClearData()
Clear data pointer.
Definition: AkCommonDefs.h:474
void AttachInterleavedData(void *in_pData, AkUInt16 in_uMaxFrames, AkUInt16 in_uValidFrames)
Attach interleaved data. Allocation is performed outside.
Definition: AkCommonDefs.h:519
AkAudioObjects(AkUInt32 in_uNumObjects=0, AkAudioBuffer **in_ppObjectBuffers=nullptr, AkAudioObject **in_ppObjects=nullptr)
Definition: AkCommonDefs.h:662
AkAudioObject ** ppObjects
Array of pointers to audio objects.
Definition: AkCommonDefs.h:670
AkUInt32 uSampleRate
Number of samples per second.
Definition: AkCommonDefs.h:64
AK::SpeakerVolumes::VectorPtr peak
Definition: AkCommonDefs.h:207
const AkDataInterleaveID AK_NONINTERLEAVED
Non-interleaved data.
Definition: AkCommonDefs.h:54
Ak3DSpatializationMode spatMode
3D spatialization mode.
Definition: AkCommonDefs.h:282
AkReal32 panBF
Pan back-front [-1,1].
Definition: AkCommonDefs.h:279
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:527
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:643

Was this page helpful?

Need Support?

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

Visit our Support page

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

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

Get started with Wwise