Atom.h ファイル

#include "CoreMinimal.h"
#include "UObject/Class.h"
#include "UObject/Interface.h"
#include "Curves/CurveFloat.h"
#include "Stats/Stats.h"
#include "HAL/ThreadSafeBool.h"
#include "CriWareApi.h"
#include "CriWareUtils.h"
#include "CriWareDefines.h"
#include "AtomUtility.h"
#include "AtomAttenuation.h"
#include "AtomSourceVoiceEffect.h"
#include "AtomSoundSourceBusSend.h"
#include "AtomSoundBusSend.h"
#include "AtomEnvelope.h"
#include "AtomAisacPatch.h"
#include "AtomParameter.h"
#include "Atom/Modulation/AtomModulationDestination.h"
#include "Atom/AtomQuartzQuantizationUtilities.h"
#include "Extensions/IAtomExtensionPlugin.h"
#include "Extensions/IAtomRuntimePlugin.h"
#include "Atom.generated.h"

クラス
struct	FAtomBeatSyncInfo
class	FAtomDynamicParameter
struct	FAtomNotifyPlaybackFinishedHooks
struct	FAtomNotifyPlaybackFinishedHooks::FNotifyPlaybackDetails
struct	FAtomPlaybackInfo
struct	FAtomPlaybackInstance
struct	FAtomSequencerEventInfo
struct	FAtomSoundPlayback
class	FAtomSource
struct	FAtomSpatializationParams
struct	FAtomWaveInfo
class	IAtomPlaybackFinishedNotifiedObject
class	IAtomSoundAsset
class	UAtomPlaybackFinishedNotifiedObject
class	UAtomSoundAsset

型定義
using	FAtomPcmFilterFunction = TFunction<void(UPTRINT PlaybackInstanceHash, EAtomPcmBitDepth BitDepth, int32 NumChannels, int32 NumFrames, void* Data[])>
using	FAtomResourceId = uint32
using	FAtomRuntimeId = uint32

列挙型
enum class	EAtomBusSendStage : uint8 { PreEffect , PostEffect , Count }
enum class	EAtomFormat : uint8 {   None = 0 , ADX , HCA , HCAMX ,   AIFF , Wave , RawPCM , Vibration ,   AudioBuffer , Instrument , Hardware1 , Hardware2 ,   Num }
enum class	EAtomLoopingMode : uint8 { LoopNever , LoopWithNotification , LoopForever }
enum class	EAtomMonoChannelUpmixMethod : int8 { Linear , EqualPower , FullVolume }
enum class	EAtomPanningMethod : int8 { Linear , EqualPower }
enum class	EAtomPcmBitDepth : uint8 { Unknown , Int16 , Float32 , Unsupported }
enum class	EAtomSoundfieldRendererType : uint8 {   Default , Spatializer , Ambisonics , SoundObject ,   Passthrough , Num }
enum class	EAtomSoundPlaybackType : uint8 {   Cue , Wave , InputPort , RawPCM ,   Unknown }
enum class	EAtomSoundRendererType : uint8 {   Default , Main , BGM , Voice ,   Pad , Haptic , User , Aux ,   Asr , Muted , Num }
enum class	EAtomSoundWaveLoadingBehavior : uint8 {   Inherited = 0 , RetainOnLoad = 1 , PrimeOnLoad = 2 , LoadOnDemand = 3 ,   ForceInline = 4 , Uninitialized = 0xff }
enum class	EAtomSpeaker : uint8 {   FrontLeft , FrontRight , FrontCenter , LowFrequency ,   SurroundLeft , SurroundRight , SurroundBackLeft , SurroundBackRight ,   TopFrontLeft , TopFrontRight , TopRearLeft , TopRearRight ,   BottomFrontLeft , BottomFrontRight , BottomRearLeft , BottomRearRight ,   Count , Unknown , DefaultChannel = FrontLeft }
enum class	EAtomSpeakerChannelMap : uint8 {   Main = 0 , EndPoint = 127 , Parent = 255 , Mono = 1 ,   Stereo = 2 , FivePointOne = 6 , SevenPointOne = 8 , FivePointOnePointTwo = 9 ,   SevenPointOnePointTwo = 10 , SevenPointOnePointFour = 12 , SevenPointOnePointFourPointFour = 16 }
enum class	EAtomVoicePoolCodecType : uint8 {   Standard = 0 , HcaMx , Wave , Aiff ,   RawPcm , InputPort , External , Audio3d ,   Opus , Undefined = 0xffU }
enum class	EAtomVoicePoolStreamingType : uint8 { MemoryOnly , StreamOnly , Mixed }

関数
	DECLARE_CYCLE_STAT_EXTERN (TEXT("Atom Evaluate Concurrency"), STAT_AtomEvaluateConcurrency, STATGROUP_Atom,)
	DECLARE_CYCLE_STAT_EXTERN (TEXT("Finding Nearest Location"), STAT_AtomFindNearestLocation, STATGROUP_Atom,)
	DECLARE_CYCLE_STAT_EXTERN (TEXT("Finished delegates time"), STAT_AtomSoundFinishedDelegates, STATGROUP_Atom,)
	DECLARE_CYCLE_STAT_EXTERN (TEXT("Gathering PlaybackInstances"), STAT_AtomGatherPlaybackInstances, STATGROUP_Atom,)
	DECLARE_CYCLE_STAT_EXTERN (TEXT("Processing Sources"), STAT_AtomStartSources, STATGROUP_Atom,)
	DECLARE_CYCLE_STAT_EXTERN (TEXT("Source Init"), STAT_AtomSourceInitTime, STATGROUP_Atom, CRIWARECORE_API)
	DECLARE_CYCLE_STAT_EXTERN (TEXT("Updating Sources"), STAT_AtomUpdateSources, STATGROUP_Atom, CRIWARECORE_API)
	DECLARE_DWORD_COUNTER_STAT_EXTERN (TEXT("Active Sounds"), STAT_AtomActiveSounds, STATGROUP_Atom,)
	DECLARE_DWORD_COUNTER_STAT_EXTERN (TEXT("Audible Playback Instances Dropped"), STAT_AtomAudiblePlaybacksDroppedDueToPriority, STATGROUP_Atom,)
	DECLARE_DWORD_COUNTER_STAT_EXTERN (TEXT("Finished delegates called"), STAT_AtomSoundFinishedDelegatesCalled, STATGROUP_Atom,)
	DECLARE_DWORD_COUNTER_STAT_EXTERN (TEXT("Max Channels"), STAT_AtomMaxChannels, STATGROUP_Atom,)
	DECLARE_DWORD_COUNTER_STAT_EXTERN (TEXT("Max Reserved Sources"), STAT_AtomMaxReservedSources, STATGROUP_Atom,)
	DECLARE_DWORD_COUNTER_STAT_EXTERN (TEXT("Playback Instances Dropped"), STAT_AtomPlaybacksDroppedDueToPriority, STATGROUP_Atom,)
	DECLARE_DWORD_COUNTER_STAT_EXTERN (TEXT("Playback Instances"), STAT_AtomPlaybackInstances, STATGROUP_Atom,)
	DECLARE_DWORD_COUNTER_STAT_EXTERN (TEXT("Sources"), STAT_AtomSources, STATGROUP_Atom,)
	DECLARE_DWORD_COUNTER_STAT_EXTERN (TEXT("Virtual Sounds"), STAT_AtomVirtualLoops, STATGROUP_Atom,)
CRIWARECORE_API	DECLARE_LOG_CATEGORY_EXTERN (LogCriWareAtom, Display, All)
CRIWARECORE_API	DECLARE_LOG_CATEGORY_EXTERN (LogCriWareAtomDebug, Display, All)
	DECLARE_MEMORY_STAT_EXTERN (TEXT("Atom Memory Used"), STAT_AtomMemorySize, STATGROUP_Atom,)
	DECLARE_STATS_GROUP (TEXT("Atom"), STATGROUP_Atom,)
CRIWARECORE_API UClass *	GetAtomPluginCustomSettingsClass (EAtomPlugin PluginType)
CRIWARECORE_API TArray< UClass * >	GetAtomRuntimePluginCustomSettingsClasses ()
const TCHAR *	ToString (EAtomFormat Format)
const TCHAR *	ToString (EAtomPcmBitDepth PcmBitDepth)
const TCHAR *	ToString (EAtomSoundfieldRendererType SoundRendererType)
const TCHAR *	ToString (EAtomSoundRendererType SoundRendererType)
const TCHAR *	ToString (EAtomSoundWaveLoadingBehavior InCurrentState)
const TCHAR *	ToString (EAtomSpeaker InSpeaker)
const TCHAR *	ToString (EAtomVoicePoolCodecType VoicePoolCodecType)
const TCHAR *	ToString (EAtomVoicePoolStreamingType VoicePoolStreamingType)

型定義詳解

FAtomPcmFilterFunction

using FAtomPcmFilterFunction = TFunction<void(UPTRINT PlaybackInstanceHash, EAtomPcmBitDepth BitDepth, int32 NumChannels, int32 NumFrames, void* Data[])>

FAtomResourceId

using FAtomResourceId = uint32

Typed identifier for Atom Resource Id

FAtomRuntimeId

using FAtomRuntimeId = uint32

Typed identifier for Atom Runtime Id

Typed identifier for AtomRuntime ID

列挙型詳解

EAtomBusSendStage

enum class EAtomBusSendStage : uint8

strong

DSP Bus send Stage

列挙値
PreEffect
PostEffect
Count

EAtomFormat

enum class EAtomFormat : uint8

strong

列挙値
None	No Format
ADX	CRI's Adaptive Differential Extended sound.
HCA	CRI's High Compression Audio sound.
HCAMX	CRI's High Compression Audio Mix sound.
AIFF	AIFF format sound
Wave	Wave format sound
RawPCM	Raw PCM sound
Vibration	Haptic vibrations
AudioBuffer	Audio buffer
Instrument	Synthesizer
Hardware1	Hardware 1 sound (VAG or OPUS)
Hardware2	Hardware 2 sound (ATRAC)
Num

EAtomLoopingMode

enum class EAtomLoopingMode : uint8

strong

列挙値
LoopNever	One shot sound
LoopWithNotification	Call the user callback on each loop for dynamic control
LoopForever	Loop the sound forever

EAtomMonoChannelUpmixMethod

enum class EAtomMonoChannelUpmixMethod : int8

strong

列挙値
Linear
EqualPower
FullVolume

EAtomPanningMethod

enum class EAtomPanningMethod : int8

strong

列挙値
Linear
EqualPower

EAtomPcmBitDepth

enum class EAtomPcmBitDepth : uint8

strong

列挙値
Unknown
Int16	Signed Integer 16-bits
Float32	Float 32-bits
Unsupported

EAtomSoundfieldRendererType

enum class EAtomSoundfieldRendererType : uint8

strong

Native Soundfield Renderer Type

列挙値
Default
Spatializer
Ambisonics
SoundObject
Passthrough
Num

EAtomSoundPlaybackType

enum class EAtomSoundPlaybackType : uint8

strong

列挙値
Cue
Wave
InputPort
RawPCM
Unknown

EAtomSoundRendererType

enum class EAtomSoundRendererType : uint8

strong

Native Sound Renderer Type

列挙値
Default
Main
BGM
Voice
Pad
Haptic
User
Aux
Asr
Muted
Num

EAtomSoundWaveLoadingBehavior

enum class EAtomSoundWaveLoadingBehavior : uint8

strong

Note: not yet usable per AtomSoundWave -> only AtomSoundBank currently.
Determines how we are going to load or retain a given Atom asset. An UAtomSoundBank's loading behavior can be overridden by cvars.

列挙値
Inherited
RetainOnLoad
PrimeOnLoad
LoadOnDemand
ForceInline
Uninitialized

EAtomSpeaker

enum class EAtomSpeaker : uint8

strong

Channel definitions for multistream waves

These are in the sample order Atom expects for a 7.1.4.4 / 16ch sound.

(Same as Atom::EMixerSpeaker)

列挙値
FrontLeft
FrontRight
FrontCenter
LowFrequency
SurroundLeft
SurroundRight
SurroundBackLeft
SurroundBackRight
TopFrontLeft
TopFrontRight
TopRearLeft
TopRearRight
BottomFrontLeft
BottomFrontRight
BottomRearLeft
BottomRearRight
Count
Unknown
DefaultChannel

EAtomSpeakerChannelMap

enum class EAtomSpeakerChannelMap : uint8

strong

列挙値
Main
EndPoint
Parent
Mono
Stereo
FivePointOne
SevenPointOne
FivePointOnePointTwo
SevenPointOnePointTwo
SevenPointOnePointFour
SevenPointOnePointFourPointFour

EAtomVoicePoolCodecType

enum class EAtomVoicePoolCodecType : uint8

strong

Enumeration for each voices pool codec type.

列挙値
Standard
HcaMx
Wave
Aiff
RawPcm
InputPort
External
Audio3d
Opus
Undefined

EAtomVoicePoolStreamingType

enum class EAtomVoicePoolStreamingType : uint8

strong

Enumeration for each voices pool read mode.

列挙値
MemoryOnly
StreamOnly
Mixed

関数詳解

DECLARE_CYCLE_STAT_EXTERN() [1/7]

DECLARE_CYCLE_STAT_EXTERN	(	TEXT("Atom Evaluate Concurrency")	,
		STAT_AtomEvaluateConcurrency	,
		STATGROUP_Atom	)

DECLARE_CYCLE_STAT_EXTERN() [2/7]

DECLARE_CYCLE_STAT_EXTERN	(	TEXT("Finding Nearest Location")	,
		STAT_AtomFindNearestLocation	,
		STATGROUP_Atom	)

DECLARE_CYCLE_STAT_EXTERN() [3/7]

DECLARE_CYCLE_STAT_EXTERN	(	TEXT("Finished delegates time")	,
		STAT_AtomSoundFinishedDelegates	,
		STATGROUP_Atom	)

DECLARE_CYCLE_STAT_EXTERN() [4/7]

DECLARE_CYCLE_STAT_EXTERN	(	TEXT("Gathering PlaybackInstances")	,
		STAT_AtomGatherPlaybackInstances	,
		STATGROUP_Atom	)

DECLARE_CYCLE_STAT_EXTERN() [5/7]

DECLARE_CYCLE_STAT_EXTERN	(	TEXT("Processing Sources")	,
		STAT_AtomStartSources	,
		STATGROUP_Atom	)

DECLARE_CYCLE_STAT_EXTERN() [6/7]

DECLARE_CYCLE_STAT_EXTERN	(	TEXT("Source Init")	,
		STAT_AtomSourceInitTime	,
		STATGROUP_Atom	,
		CRIWARECORE_API	)

DECLARE_CYCLE_STAT_EXTERN() [7/7]

DECLARE_CYCLE_STAT_EXTERN	(	TEXT("Updating Sources")	,
		STAT_AtomUpdateSources	,
		STATGROUP_Atom	,
		CRIWARECORE_API	)

DECLARE_DWORD_COUNTER_STAT_EXTERN() [1/9]

DECLARE_DWORD_COUNTER_STAT_EXTERN	(	TEXT("Active Sounds")	,
		STAT_AtomActiveSounds	,
		STATGROUP_Atom	)

DECLARE_DWORD_COUNTER_STAT_EXTERN() [2/9]

DECLARE_DWORD_COUNTER_STAT_EXTERN	(	TEXT("Audible Playback Instances Dropped")	,
		STAT_AtomAudiblePlaybacksDroppedDueToPriority	,
		STATGROUP_Atom	)

DECLARE_DWORD_COUNTER_STAT_EXTERN() [3/9]

DECLARE_DWORD_COUNTER_STAT_EXTERN	(	TEXT("Finished delegates called")	,
		STAT_AtomSoundFinishedDelegatesCalled	,
		STATGROUP_Atom	)

DECLARE_DWORD_COUNTER_STAT_EXTERN() [4/9]

DECLARE_DWORD_COUNTER_STAT_EXTERN	(	TEXT("Max Channels")	,
		STAT_AtomMaxChannels	,
		STATGROUP_Atom	)

DECLARE_DWORD_COUNTER_STAT_EXTERN() [5/9]

DECLARE_DWORD_COUNTER_STAT_EXTERN	(	TEXT("Max Reserved Sources")	,
		STAT_AtomMaxReservedSources	,
		STATGROUP_Atom	)

DECLARE_DWORD_COUNTER_STAT_EXTERN() [6/9]

DECLARE_DWORD_COUNTER_STAT_EXTERN	(	TEXT("Playback Instances Dropped")	,
		STAT_AtomPlaybacksDroppedDueToPriority	,
		STATGROUP_Atom	)

DECLARE_DWORD_COUNTER_STAT_EXTERN() [7/9]

DECLARE_DWORD_COUNTER_STAT_EXTERN	(	TEXT("Playback Instances")	,
		STAT_AtomPlaybackInstances	,
		STATGROUP_Atom	)

DECLARE_DWORD_COUNTER_STAT_EXTERN() [8/9]

DECLARE_DWORD_COUNTER_STAT_EXTERN	(	TEXT("Sources")	,
		STAT_AtomSources	,
		STATGROUP_Atom	)

DECLARE_DWORD_COUNTER_STAT_EXTERN() [9/9]

DECLARE_DWORD_COUNTER_STAT_EXTERN	(	TEXT("Virtual Sounds")	,
		STAT_AtomVirtualLoops	,
		STATGROUP_Atom	)

DECLARE_LOG_CATEGORY_EXTERN() [1/2]

CRIWARECORE_API DECLARE_LOG_CATEGORY_EXTERN	(	LogCriWareAtom	,
		Display	,
		All	)

DECLARE_LOG_CATEGORY_EXTERN() [2/2]

CRIWARECORE_API DECLARE_LOG_CATEGORY_EXTERN	(	LogCriWareAtomDebug	,
		Display	,
		All	)

DECLARE_MEMORY_STAT_EXTERN()

DECLARE_MEMORY_STAT_EXTERN	(	TEXT("Atom Memory Used")	,
		STAT_AtomMemorySize	,
		STATGROUP_Atom	)

DECLARE_STATS_GROUP()

DECLARE_STATS_GROUP	(	TEXT("Atom")	,
		STATGROUP_Atom	)

Atom stats

GetAtomPluginCustomSettingsClass()

CRIWARECORE_API UClass * GetAtomPluginCustomSettingsClass

(

EAtomPlugin

PluginType

)

Queries for settings a plugin of the given type.

GetAtomRuntimePluginCustomSettingsClasses()

CRIWARECORE_API TArray< UClass * > GetAtomRuntimePluginCustomSettingsClasses

(

)

ToString() [1/8]

const TCHAR * ToString ( EAtomFormat Format )

inline

ToString() [2/8]

const TCHAR * ToString ( EAtomPcmBitDepth PcmBitDepth )

inline

ToString() [3/8]

const TCHAR * ToString ( EAtomSoundfieldRendererType SoundRendererType )

inline

ToString() [4/8]

const TCHAR * ToString ( EAtomSoundRendererType SoundRendererType )

inline

ToString() [5/8]

const TCHAR * ToString ( EAtomSoundWaveLoadingBehavior InCurrentState )

inline

ToString() [6/8]

const TCHAR * ToString ( EAtomSpeaker InSpeaker )

inline

ToString() [7/8]

const TCHAR * ToString ( EAtomVoicePoolCodecType VoicePoolCodecType )

inline

ToString() [8/8]

const TCHAR * ToString ( EAtomVoicePoolStreamingType VoicePoolStreamingType )

inline