ngs.h

Go to the documentation of this file.

 
#ifndef _PSP2_NGS_H_
#define _PSP2_NGS_H_
 
#include <psp2/ngs_internal.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define SCE_NGS_MAX_SYSTEM_CHANNELS 2
 
typedef struct SceNgsVoiceDefinition SceNgsVoiceDefinition;
 
typedef struct SceNgsBufferInfo {
    void *data;   
    SceSize size; 
} SceNgsBufferInfo;
VITASDK_BUILD_ASSERT_EQ(0x8, SceNgsBufferInfo); // size is from FW 3.60
 
typedef struct SceNgsSystemInitParams {
    SceInt32 max_racks;    
    SceInt32 max_voices;   
    SceInt32 granularity; 
    SceInt32 sample_rate;  
    SceInt32 reserved;    
} SceNgsSystemInitParams;
VITASDK_BUILD_ASSERT_EQ(0x14, SceNgsSystemInitParams); // size is from FW 3.60
 
typedef struct SceNgsRackDescription {
    const SceNgsVoiceDefinition *voice_definition; 
    SceInt32 voice_count;                          
    SceInt32 channels_per_voice;                    
    SceInt32 max_patches_per_input;                  
    SceInt32 patches_per_output;                    
    void *user_data;                               
} SceNgsRackDescription;
VITASDK_BUILD_ASSERT_EQ(0x18, SceNgsRackDescription); // size is from FW 3.60
 
typedef struct SceNgsPatchSetupInfo {
    SceNgsHVoice source_voice;       
    SceInt32 source_output_index;     
    SceInt32 source_output_sub_index;  
    SceNgsHVoice destination_voice;  
    SceInt32 destination_input_index; 
} SceNgsPatchSetupInfo;
VITASDK_BUILD_ASSERT_EQ(0x14, SceNgsPatchSetupInfo); // size is from FW 3.60
 
typedef struct SceNgsVoicePreset {
    SceInt32 name_offset;        
    SceUInt32 name_length;       
    SceInt32 preset_data_offset;  
    SceUInt32 preset_data_size;   
    SceInt32 bypass_flags_offset; 
    SceUInt32 bypass_flags_count; 
} SceNgsVoicePreset;
VITASDK_BUILD_ASSERT_EQ(0x18, SceNgsVoicePreset); // size is from FW 3.60
 
typedef struct SceNgsCallbackInfo {
    SceNgsHVoice voice_handle;  
    SceNgsHRack rack_handle;    
    SceNgsModuleID module_id;   
    SceUInt32 callback_reason;  
    SceUInt32 callback_reason2; 
    void *callback_ptr;         
    void *user_data;            
} SceNgsCallbackInfo;
VITASDK_BUILD_ASSERT_EQ(0x1C, SceNgsCallbackInfo); // size is from FW 3.60
 
typedef struct SceNgsParamsDescriptor {
    SceNgsParamsID id;
    SceSize size; 
} SceNgsParamsDescriptor;
VITASDK_BUILD_ASSERT_EQ(0x8, SceNgsParamsDescriptor); // size is from FW 3.60
 
typedef enum SceNgsErrorCode {
    SCE_NGS_OK                           = 0x00000000,
    SCE_NGS_ERROR                        = 0x804A0001,
    SCE_NGS_ERROR_INVALID_PARAM          = 0x804A0002,
    SCE_NGS_ERROR_INVALID_ALIGNMENT      = 0x804A0003,
    SCE_NGS_ERROR_NOT_IMPL               = 0x804A0004,
    SCE_NGS_ERROR_DEPENDENCY             = 0x804A0005,
    SCE_NGS_ERROR_OUT_OF_ASSETS          = 0x804A0006,
    SCE_NGS_ERROR_MODULE_NOT_AVAIL       = 0x804A0007,
    SCE_NGS_ERROR_RESOURCE_LOCKED        = 0x804A0008,
    SCE_NGS_ERROR_PARAM_OUT_OF_RANGE     = 0x804A0009,
    SCE_NGS_ERROR_INVALID_VOICE_TYPE     = 0x804A000A,
    SCE_NGS_ERROR_SYSTEM_MISMATCH        = 0x804A000B,
    SCE_NGS_ERROR_INVALID_HANDLE         = 0x804A000C,
    SCE_NGS_ERROR_SIZE_MISMATCH          = 0x804A000D,
    SCE_NGS_ERROR_PATCH_NOT_AVAIL        = 0x804A000E,
    SCE_NGS_ERROR_PARAM_TYPE_MISMATCH    = 0x804A000F,
    SCE_NGS_ERROR_INVALID_STATE          = 0x804A0010,
    SCE_NGS_ERROR_INTERNAL_ALLOC         = 0x804A0011,
    SCE_NGS_ERROR_INTERNAL_PROCESSING    = 0x804A0012,
    SCE_NGS_ERROR_INVALID_BUFFER         = 0x804A0013
} SceNgsErrorCode;
 
typedef enum SceNgsSystemFlag {
    SCE_NGS_SYSTEM_FLAG_CHECK_PARAMS = 0x00000001 
} SceNgsSystemFlag;
 
typedef enum SceNgsVoiceInitFlag {
    SCE_NGS_VOICE_INIT_BASE      = 0x00000000,
    SCE_NGS_VOICE_INIT_ROUTING   = 0x00000001, 
    SCE_NGS_VOICE_INIT_PRESET    = 0x00000002, 
    SCE_NGS_VOICE_INIT_CALLBACKS = 0x00000004, 
    SCE_NGS_VOICE_INIT_ALL       = 0x00000007
} SceNgsVoiceInitFlag;
 
typedef enum SceNgsVoiceState {
    SCE_NGS_VOICE_STATE_AVAILABLE = 0x00000000,
    SCE_NGS_VOICE_STATE_ACTIVE    = 0x00000001,
    SCE_NGS_VOICE_STATE_FINALIZE  = 0x00000004,
    SCE_NGS_VOICE_STATE_UNLOADING = 0x00000008,
    SCE_NGS_VOICE_STATE_PENDING   = 0x00000010,
    SCE_NGS_VOICE_STATE_PAUSED    = 0x00000020,
    SCE_NGS_VOICE_STATE_KEY_OFF   = 0x00000040
} SceNgsVoiceState;
 
typedef enum SceNgsModuleBypassFlag {
    SCE_NGS_MODULE_FLAG_NOT_BYPASSED = 0,
    SCE_NGS_MODULE_FLAG_BYPASSED     = 2
} SceNgsModuleBypassFlag;
 
typedef struct SceNgsAT9SkipBufferInfo {
    SceInt32 start_byte_offset; 
    SceInt32 num_bytes;        
    SceInt16 start_skip;       
    SceInt16 end_skip;         
    SceInt32 is_super_packet;   
} SceNgsAT9SkipBufferInfo;
VITASDK_BUILD_ASSERT_EQ(0x10, SceNgsAT9SkipBufferInfo); // size is from FW 3.60
 
typedef struct SceNgsModuleParamHeader {
    SceInt32 module_index;  
    SceInt32 channel_index; 
} SceNgsModuleParamHeader;
VITASDK_BUILD_ASSERT_EQ(0x8, SceNgsModuleParamHeader); // size is from FW 3.60
 
typedef struct SceNgsVolumeMatrix {
    SceFloat32 matrix[SCE_NGS_MAX_SYSTEM_CHANNELS][SCE_NGS_MAX_SYSTEM_CHANNELS];
} SceNgsVolumeMatrix;
VITASDK_BUILD_ASSERT_EQ(0x10, SceNgsVolumeMatrix); // size is from FW 3.60
 
typedef struct SceNgsPatchRouteInfo {
    SceInt32 output_channels;         
    SceInt32 input_channels;          
    SceNgsVolumeMatrix volume_matrix; 
} SceNgsPatchRouteInfo;
VITASDK_BUILD_ASSERT_EQ(0x18, SceNgsPatchRouteInfo); // size is from FW 3.60
 
typedef struct SceNgsVoiceInfo {
    SceUInt32 voice_state;          
    SceUInt32 num_modules;          
    SceUInt32 num_inputs;           
    SceUInt32 num_outputs;          
    SceUInt32 num_patches_per_output; 
    SceUInt32 update_passed;        
} SceNgsVoiceInfo;
VITASDK_BUILD_ASSERT_EQ(0x18, SceNgsVoiceInfo); // size is from FW 3.60
 
typedef struct SceSulphaNgsConfig {
    SceUInt32 max_named_samples;    
    SceUInt32 api_trace_buffer_size; 
} SceSulphaNgsConfig;
VITASDK_BUILD_ASSERT_EQ(0x8, SceSulphaNgsConfig); // size is from FW 3.60
 
SceInt32 sceNgsAT9GetSectionDetails(SceInt32 start_sample_offset, SceInt32 num_samples, SceInt32 config_data, SceNgsAT9SkipBufferInfo *at9_info_buffer);
 
SceInt32 sceNgsModuleGetNumPresets(SceNgsHSynSystem system_handle, SceNgsModuleID module_id, SceUInt32 *num_presets);
 
SceInt32 sceNgsModuleGetPreset(SceNgsHSynSystem system_handle, SceNgsModuleID module_id, SceUInt32 preset_index, SceNgsBufferInfo *params_buffer);
 
SceInt32 sceNgsPatchCreateRouting(const SceNgsPatchSetupInfo *patch_info, SceNgsHPatch *patch_handle);
 
SceInt32 sceNgsPatchGetInfo(SceNgsHPatch patch_handle, SceNgsPatchRouteInfo *route_info, SceNgsPatchSetupInfo *setup);
 
SceInt32 sceNgsPatchRemoveRouting(SceNgsHPatch patch_handle);
 
SceInt32 sceNgsRackGetRequiredMemorySize(SceNgsHSynSystem system_handle, const SceNgsRackDescription *rack_desc, SceSize *size);
 
SceInt32 sceNgsRackGetVoiceHandle(SceNgsHRack rack_handle, SceUInt32 index, SceNgsHVoice *voice_handle);
 
SceInt32 sceNgsRackInit(SceNgsHSynSystem system_handle, const SceNgsBufferInfo *rack_buffer, const SceNgsRackDescription *rack_desc, SceNgsHRack *rack_handle);
 
SceInt32 sceNgsRackRelease(SceNgsHRack rack_handle, SceNgsRackReleaseCallbackFunc callback_func_ptr);
 
SceInt32 sceNgsRackSetParamErrorCallback(SceNgsHRack rack_handle, SceNgsParamsErrorCallbackFunc callback_func_ptr);
 
SceInt32 sceNgsSystemGetRequiredMemorySize(const SceNgsSystemInitParams *synth_params, SceSize *size);
 
SceInt32 sceNgsSystemInit(void *synth_sys_memory, SceSize mem_size, const SceNgsSystemInitParams *synth_params, SceNgsHSynSystem *system_handle);
 
SceInt32 sceNgsSystemLock(SceNgsHSynSystem system_handle);
 
SceInt32 sceNgsSystemRelease(SceNgsHSynSystem system_handle);
 
SceInt32 sceNgsSystemSetFlags(SceNgsHSynSystem system_handle, SceUInt32 system_flags);
 
SceInt32 sceNgsSystemSetParamErrorCallback(SceNgsHSynSystem system_handle, SceNgsParamsErrorCallbackFunc callback_func_ptr);
 
SceInt32 sceNgsSystemUnlock(SceNgsHSynSystem system_handle);
 
SceInt32 sceNgsSystemUpdate(SceNgsHSynSystem system_handle);
 
SceInt32 sceNgsVoiceBypassModule(SceNgsHVoice voice_handle, SceUInt32 module, SceUInt32 bypass_flag);
const SceNgsVoiceDefinition *sceNgsVoiceDefGetAtrac9Voice(void);
 
const SceNgsVoiceDefinition *sceNgsVoiceDefGetCompressorBuss(void);
 
const SceNgsVoiceDefinition *sceNgsVoiceDefGetCompressorSideChainBuss(void);
 
const SceNgsVoiceDefinition *sceNgsVoiceDefGetDelayBuss(void);
 
const SceNgsVoiceDefinition *sceNgsVoiceDefGetDistortionBuss(void);
 
const SceNgsVoiceDefinition *sceNgsVoiceDefGetEnvelopeBuss(void);
 
const SceNgsVoiceDefinition *sceNgsVoiceDefGetEqBuss(void);
 
const SceNgsVoiceDefinition *sceNgsVoiceDefGetMasterBuss(void);
 
const SceNgsVoiceDefinition *sceNgsVoiceDefGetMixerBuss(void);
 
const SceNgsVoiceDefinition *sceNgsVoiceDefGetPauserBuss(void);
 
const SceNgsVoiceDefinition *sceNgsVoiceDefGetPitchShiftBuss(void);
 
const SceNgsVoiceDefinition *sceNgsVoiceDefGetReverbBuss(void);
 
const SceNgsVoiceDefinition *sceNgsVoiceDefGetSasEmuVoice(void);
 
const SceNgsVoiceDefinition *sceNgsVoiceDefGetScreamAtrac9Voice(void);
 
const SceNgsVoiceDefinition *sceNgsVoiceDefGetScreamVoice(void);
 
const SceNgsVoiceDefinition *sceNgsVoiceDefGetSimpleAtrac9Voice(void);
 
const SceNgsVoiceDefinition *sceNgsVoiceDefGetSimpleVoice(void);
 
const SceNgsVoiceDefinition *sceNgsVoiceDefGetTemplate1(void);
 
SceInt32 sceNgsVoiceGetInfo(SceNgsHVoice voice_handle, SceNgsVoiceInfo *info);
 
SceInt32 sceNgsVoiceGetModuleBypass(SceNgsHVoice voice_handle, SceUInt32 module, SceUInt32 *bypass_flag);
 
SceInt32 sceNgsVoiceGetModuleType(SceNgsHVoice voice_handle, SceUInt32 module, SceNgsModuleID *module_type);
 
SceInt32 sceNgsVoiceGetOutputPatch(SceNgsHVoice voice_handle, SceInt32 output_index, SceInt32 sub_index, SceNgsHPatch *patch_handle);
 
SceInt32 sceNgsVoiceGetParamsOutOfRange(SceNgsHVoice voice_handle, SceUInt32 module, char *message_buffer);
 
SceInt32 sceNgsVoiceGetStateData(SceNgsHVoice voice_handle, SceUInt32 module, void *memory, SceSize mem_size);
 
SceInt32 sceNgsVoiceInit(SceNgsHVoice voice_handle, const SceNgsVoicePreset *preset, SceUInt32 init_flags);
 
SceInt32 sceNgsVoiceKeyOff(SceNgsHVoice voice_handle);
 
SceInt32 sceNgsVoiceKill(SceNgsHVoice voice_handle);
 
SceInt32 sceNgsVoiceLockParams(SceNgsHVoice voice_handle, SceUInt32 module, SceNgsParamsID params_interface_id, SceNgsBufferInfo *params_buffer);
 
SceInt32 sceNgsVoicePatchSetVolume(SceNgsHPatch patch_handle, SceInt32 output_channel, SceInt32 input_channel, SceFloat32 volume);
 
SceInt32 sceNgsVoicePatchSetVolumes(SceNgsHPatch patch_handle, SceInt32 output_channel, const SceFloat32 *volumes, SceInt32 volume_count);
 
SceInt32 sceNgsVoicePatchSetVolumesMatrix(SceNgsHPatch patch_handle, const SceNgsVolumeMatrix *matrix);
 
SceInt32 sceNgsVoicePause(SceNgsHVoice voice_handle);
 
SceInt32 sceNgsVoicePlay(SceNgsHVoice voice_handle);
 
SceInt32 sceNgsVoiceResume(SceNgsHVoice voice_handle);
 
SceInt32 sceNgsVoiceSetFinishedCallback(SceNgsHVoice voice_handle, SceNgsCallbackFunc callback_func_ptr, void *user_data);
 
SceInt32 sceNgsVoiceSetModuleCallback(SceNgsHVoice voice_handle, SceUInt32 module, SceNgsModuleCallbackFunc callback_func_ptr, void *user_data);
 
SceInt32 sceNgsVoiceSetParamsBlock(SceNgsHVoice voice_handle, const SceNgsModuleParamHeader *param_data, SceSize size, SceInt32 *error_count);
 
SceInt32 sceNgsVoiceSetPreset(SceNgsHVoice voice_handle, const SceNgsVoicePreset *voice_preset);
 
SceInt32 sceNgsVoiceUnlockParams(SceNgsHVoice voice_handle, SceUInt32 module);
SceInt32 sceSulphaNgsGetDefaultConfig(SceSulphaNgsConfig *config);
 
SceInt32 sceSulphaNgsGetNeededMemory(const SceSulphaNgsConfig *config, SceSize *size_in_bytes);
 
SceInt32 sceSulphaNgsInit(const SceSulphaNgsConfig *config, void *buffer, SceSize size_in_bytes);
 
SceInt32 sceSulphaNgsSetRackName(SceNgsHRack rack_handle, const char *name);
 
SceInt32 sceSulphaNgsSetSampleName(const void *location, SceSize length, const char *name);
 
SceInt32 sceSulphaNgsSetSynthName(SceNgsHSynSystem synth_handle, const char *name);
 
SceInt32 sceSulphaNgsSetVoiceName(SceNgsHVoice voice_handle, const char *name);
 
SceInt32 sceSulphaNgsShutdown(void);
 
SceInt32 sceSulphaNgsTrace(const char *message);
 
#ifdef __cplusplus
}
#endif
 
#endif /* _PSP2_NGS_H_ */