From: TravisCI-DocBuilder Date: Wed, 21 Oct 2015 06:04:55 +0000 (+0000) Subject: Doc generated from commit 89fc70f076222691a604aba7d2cae05254e413d1 X-Git-Url: https://chaos.moe/g/?a=commitdiff_plain;h=7498986dfbe15c65ebb885f777e65f5fb29ec1e4;p=corbenik%2Fctrulib.git Doc generated from commit 89fc70f076222691a604aba7d2cae05254e413d1 --- diff --git a/annotated.html b/annotated.html index 0303fa7..1e1b9d9 100644 --- a/annotated.html +++ b/annotated.html @@ -127,7 +127,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');  CMapEventEvent relating to the mapping of memory  CMemInfoMemory information  CmvdstdConfigProcessing configuration - CndspAdpcmData + CndspAdpcmDataADPCM data  CndspWaveBufWave buffer struct  COutputStringEventEvent relating to debug output  CPageInfoMemory page information diff --git a/apt_8h.html b/apt_8h.html index 39e1411..5e0da18 100644 --- a/apt_8h.html +++ b/apt_8h.html @@ -195,43 +195,43 @@ Enumerations } App status values. More...
  -enum  {
-  APTSIGNAL_HOMEBUTTON = 1, +enum  {
+  APTSIGNAL_HOMEBUTTON = 1,
-  APTSIGNAL_PREPARESLEEP = 3, +  APTSIGNAL_PREPARESLEEP = 3,
-  APTSIGNAL_ENTERSLEEP = 5, +  APTSIGNAL_ENTERSLEEP = 5,
-  APTSIGNAL_WAKEUP = 6, +  APTSIGNAL_WAKEUP = 6,
-  APTSIGNAL_ENABLE = 7, +  APTSIGNAL_ENABLE = 7,
-  APTSIGNAL_POWERBUTTON = 8, +  APTSIGNAL_POWERBUTTON = 8,
-  APTSIGNAL_UTILITY = 9, +  APTSIGNAL_UTILITY = 9,
-  APTSIGNAL_SLEEPSYSTEM = 10, +  APTSIGNAL_SLEEPSYSTEM = 10,
-  APTSIGNAL_ERROR = 11 +  APTSIGNAL_ERROR = 11
- } APT signals. More...
-  + } APT signals. More...
+  -enum  {
-  APTHOOK_ONSUSPEND = 0, +enum  {
+  APTHOOK_ONSUSPEND = 0,
-  APTHOOK_ONRESTORE, +  APTHOOK_ONRESTORE,
-  APTHOOK_ONSLEEP, +  APTHOOK_ONSLEEP,
-  APTHOOK_ONWAKEUP, +  APTHOOK_ONWAKEUP,
-  APTHOOK_ONEXIT, +  APTHOOK_ONEXIT,
-  APTHOOK_COUNT +  APTHOOK_COUNT
- } APT hook types. More...
-  + } APT hook types. More...
+ 

Detailed Description

APT (Applet) service.

Enumeration Type Documentation

- +

@@ -411,7 +411,7 @@ Variables

@@ -421,40 +421,31 @@ Variables
-

APT signals.

+

APT hook types.

- - - - - - - - -
Enumerator
APTSIGNAL_HOMEBUTTON  -

Home button pressed.

-
APTSIGNAL_PREPARESLEEP  -

Prepare to enter sleep mode.

-
APTSIGNAL_ENTERSLEEP  -

Enter sleep mode.

-
APTSIGNAL_WAKEUP  -

Wake from sleep mode.

+
Enumerator
APTHOOK_ONSUSPEND  +

App suspended.

APTSIGNAL_ENABLE  -

Enable.

+
APTHOOK_ONRESTORE  +

App restored.

APTSIGNAL_POWERBUTTON  -

Power button pressed.

+
APTHOOK_ONSLEEP  +

App sleeping.

APTSIGNAL_UTILITY  -

Utility called.

+
APTHOOK_ONWAKEUP  +

App waking up.

APTSIGNAL_SLEEPSYSTEM  -

System sleeping.

+
APTHOOK_ONEXIT  +

App exiting.

APTSIGNAL_ERROR  -

Error occurred.

+
APTHOOK_COUNT  +

Number of APT hook types.

- +
@@ -464,25 +455,34 @@ Variables
-

APT hook types.

+

APT signals.

- - - - - - + + +
Enumerator
APTHOOK_ONSUSPEND  -

App suspended.

+
Enumerator
APTSIGNAL_HOMEBUTTON  +

Home button pressed.

APTHOOK_ONRESTORE  -

App restored.

+
APTSIGNAL_PREPARESLEEP  +

Prepare to enter sleep mode.

APTHOOK_ONSLEEP  -

App sleeping.

+
APTSIGNAL_ENTERSLEEP  +

Enter sleep mode.

APTHOOK_ONWAKEUP  -

App waking up.

+
APTSIGNAL_WAKEUP  +

Wake from sleep mode.

APTHOOK_ONEXIT  -

App exiting.

+
APTSIGNAL_ENABLE  +

Enable.

APTHOOK_COUNT  -

Number of APT hook types.

+
APTSIGNAL_POWERBUTTON  +

Power button pressed.

+
APTSIGNAL_UTILITY  +

Utility called.

+
APTSIGNAL_SLEEPSYSTEM  +

System sleeping.

+
APTSIGNAL_ERROR  +

Error occurred.

diff --git a/apt_8h_source.html b/apt_8h_source.html index dc5076c..be0a886 100644 --- a/apt_8h_source.html +++ b/apt_8h_source.html @@ -145,28 +145,28 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
53 
54 /// APT signals.
55 enum {
-
56  APTSIGNAL_HOMEBUTTON = 1, ///< Home button pressed.
+
56  APTSIGNAL_HOMEBUTTON = 1, ///< Home button pressed.
57  // 2: sleep-mode related?
-
58  APTSIGNAL_PREPARESLEEP = 3, ///< Prepare to enter sleep mode.
+
58  APTSIGNAL_PREPARESLEEP = 3, ///< Prepare to enter sleep mode.
59  // 4: triggered when ptm:s GetShellStatus() returns 5.
-
60  APTSIGNAL_ENTERSLEEP = 5, ///< Enter sleep mode.
-
61  APTSIGNAL_WAKEUP = 6, ///< Wake from sleep mode.
-
62  APTSIGNAL_ENABLE = 7, ///< Enable.
-
63  APTSIGNAL_POWERBUTTON = 8, ///< Power button pressed.
-
64  APTSIGNAL_UTILITY = 9, ///< Utility called.
-
65  APTSIGNAL_SLEEPSYSTEM = 10, ///< System sleeping.
-
66  APTSIGNAL_ERROR = 11 ///< Error occurred.
+
60  APTSIGNAL_ENTERSLEEP = 5, ///< Enter sleep mode.
+
61  APTSIGNAL_WAKEUP = 6, ///< Wake from sleep mode.
+
62  APTSIGNAL_ENABLE = 7, ///< Enable.
+
63  APTSIGNAL_POWERBUTTON = 8, ///< Power button pressed.
+
64  APTSIGNAL_UTILITY = 9, ///< Utility called.
+
65  APTSIGNAL_SLEEPSYSTEM = 10, ///< System sleeping.
+
66  APTSIGNAL_ERROR = 11 ///< Error occurred.
67 };
68 
69 /// APT hook types.
70 enum {
-
71  APTHOOK_ONSUSPEND = 0, ///< App suspended.
-
72  APTHOOK_ONRESTORE, ///< App restored.
-
73  APTHOOK_ONSLEEP, ///< App sleeping.
-
74  APTHOOK_ONWAKEUP, ///< App waking up.
-
75  APTHOOK_ONEXIT, ///< App exiting.
+
71  APTHOOK_ONSUSPEND = 0, ///< App suspended.
+
72  APTHOOK_ONRESTORE, ///< App restored.
+
73  APTHOOK_ONSLEEP, ///< App sleeping.
+
74  APTHOOK_ONWAKEUP, ///< App waking up.
+
75  APTHOOK_ONEXIT, ///< App exiting.
76 
-
77  APTHOOK_COUNT, ///< Number of APT hook types.
+
77  APTHOOK_COUNT, ///< Number of APT hook types.
78 };
79 
80 /// APT hook function.
@@ -543,11 +543,12 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
451 Result APT_StartSystemApplet(NS_APPID appID, u32 bufSize, Handle applHandle, u8 *buf);
452 
APPID_APPLICATION
Application.
Definition: apt.h:29
+
APTHOOK_ONSLEEP
App sleeping.
Definition: apt.h:73
APPID_AMIIBO_SETTINGS
Amiibo settings applet (cabinet)
Definition: apt.h:28
aptHookCookie::callback
aptHookFn callback
Hook callback.
Definition: apt.h:87
+
APTHOOK_ONEXIT
App exiting.
Definition: apt.h:75
APT_IsRegistered
Result APT_IsRegistered(NS_APPID appID, u8 *out)
Gets whether an application is registered.
APT_ReplySleepQuery
Result APT_ReplySleepQuery(NS_APPID appID, u32 a)
Replies to a sleep query.
-
APTSIGNAL_SLEEPSYSTEM
System sleeping.
Definition: apt.h:65
Result
s32 Result
Function result.
Definition: types.h:43
APT_DoAppJump
Result APT_DoAppJump(u32 NSbuf0Size, u32 NSbuf1Size, u8 *NSbuf0Ptr, u8 *NSbuf1Ptr)
Performs an application jump.
aptOpenSession
void aptOpenSession(void)
Opens an APT session.
@@ -555,30 +556,32 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
aptSignalReadyForSleep
void aptSignalReadyForSleep(void)
Signals that the app is ready to sleep.
APT_Enable
Result APT_Enable(u32 a)
Enables APT.
aptMainLoop
bool aptMainLoop(void)
Processes the current APT status.
+
APTSIGNAL_UTILITY
Utility called.
Definition: apt.h:64
APPID_SNOTE_AP
SNOTE_AP.
Definition: apt.h:34
u16
uint16_t u16
16-bit unsigned integer
Definition: types.h:23
+
APTHOOK_COUNT
Number of APT hook types.
Definition: apt.h:77
+
APTHOOK_ONWAKEUP
App waking up.
Definition: apt.h:74
APPID_EXTRAPAD
extrapad
Definition: apt.h:37
-
APTHOOK_ONSUSPEND
App suspended.
Definition: apt.h:71
aptInit
Result aptInit(void)
Initializes APT.
aptHook
void aptHook(aptHookCookie *cookie, aptHookFn callback, void *param)
Sets up an APT status hook.
APP_RUNNING
App running.
Definition: apt.h:44
-
APTSIGNAL_POWERBUTTON
Power button pressed.
Definition: apt.h:63
+
APTSIGNAL_HOMEBUTTON
Home button pressed.
Definition: apt.h:56
APPID_FRIENDS_LIST
Friends List applet.
Definition: apt.h:21
-
APTSIGNAL_ENABLE
Enable.
Definition: apt.h:62
APT_CloseApplication
Result APT_CloseApplication(const u8 *param, size_t paramSize, Handle handle)
Closes the application.
APT_ReplySleepNotificationComplete
Result APT_ReplySleepNotificationComplete(NS_APPID appID)
Replies that a sleep notification has been completed.
APP_NOTINITIALIZED
App not initialized.
Definition: apt.h:43
aptHookCookie::next
struct tag_aptHookCookie * next
Next cookie.
Definition: apt.h:86
+
APTSIGNAL_SLEEPSYSTEM
System sleeping.
Definition: apt.h:65
APPID_INSTRUCTION_MANUAL
Instruction Manual applet.
Definition: apt.h:24
-
APTSIGNAL_PREPARESLEEP
Prepare to enter sleep mode.
Definition: apt.h:58
Handle
u32 Handle
Resource handle.
Definition: types.h:42
APT_PrepareToCloseApplication
Result APT_PrepareToCloseApplication(u8 a)
Prepares to close the application.
-
APTSIGNAL_ERROR
Error occurred.
Definition: apt.h:66
aptGetStatusPower
u32 aptGetStatusPower(void)
Gets the app's power status.
aptGetMenuAppID
NS_APPID aptGetMenuAppID(void)
Gets the menu's app ID.
+
APTSIGNAL_ENTERSLEEP
Enter sleep mode.
Definition: apt.h:60
APP_APPLETCLOSED
Applet closed.
Definition: apt.h:51
APPID_NOTIFICATIONS
Notifications applet.
Definition: apt.h:25
APT_JumpToHomeMenu
Result APT_JumpToHomeMenu(const u8 *param, size_t paramSize, Handle handle)
Jumps to the home menu.
+
APTSIGNAL_POWERBUTTON
Power button pressed.
Definition: apt.h:63
aptHookFn
void(* aptHookFn)(int hook, void *param)
APT hook function.
Definition: apt.h:81
u8
uint8_t u8
8-bit unsigned integer
Definition: types.h:22
APPID_MIIVERSE_POSTING
Miiverse posting applet (solv3)
Definition: apt.h:27
@@ -587,21 +590,22 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
APP_SUSPENDING
App suspending.
Definition: apt.h:47
APT_CheckNew3DS_System
Result APT_CheckNew3DS_System(u8 *out)
Checks whether the system is a New 3DS.
APT_SetAppCpuTimeLimit
Result APT_SetAppCpuTimeLimit(u32 percent)
Sets the application's CPU time limit.
-
APTHOOK_COUNT
Number of APT hook types.
Definition: apt.h:77
APPID_MINT
mint
Definition: apt.h:36
APP_PREPARE_SLEEPMODE
App preparing to enter sleep mode.
Definition: apt.h:49
APT_StartSystemApplet
Result APT_StartSystemApplet(NS_APPID appID, u32 bufSize, Handle applHandle, u8 *buf)
Starts a system applet.
+
APTSIGNAL_ERROR
Error occurred.
Definition: apt.h:66
APPID_MIIVERSE
Miiverse applet (olv)
Definition: apt.h:26
u32
uint32_t u32
32-bit unsigned integer
Definition: types.h:24
aptEvents
Handle aptEvents[3]
APT events.
APT_PrepareToStartLibraryApplet
Result APT_PrepareToStartLibraryApplet(NS_APPID appID)
Prepares to start a library applet.
aptSetStatusPower
void aptSetStatusPower(u32 status)
Sets the app's power status.
+
APTHOOK_ONSUSPEND
App suspended.
Definition: apt.h:71
APT_GetLockHandle
Result APT_GetLockHandle(u16 flags, Handle *lockHandle)
Gets an APT lock handle.
APPID_CAMERA
Camera applet.
Definition: apt.h:20
aptCloseSession
void aptCloseSession(void)
Closes an APT session.
+
APTSIGNAL_PREPARESLEEP
Prepare to enter sleep mode.
Definition: apt.h:58
APT_GetAppletManInfo
Result APT_GetAppletManInfo(u8 inval, u8 *outval8, u32 *outval32, NS_APPID *menu_appid, NS_APPID *active_appid)
Gets applet management info.
APT_PrepareToStartSystemApplet
Result APT_PrepareToStartSystemApplet(NS_APPID appID)
Prepares to start a system applet.
-
APTHOOK_ONEXIT
App exiting.
Definition: apt.h:75
aptExit
void aptExit(void)
Exits APT.
APT_PrepareToDoAppJump
Result APT_PrepareToDoAppJump(u8 flags, u64 programID, u8 mediatype)
Prepares for an applicaton jump.
APPID_HOMEMENU
Home Menu.
Definition: apt.h:19
@@ -610,13 +614,11 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
APT_PrepareToJumpToApplication
Result APT_PrepareToJumpToApplication(u32 a)
Prepares to jump to an application.
aptSetStatus
void aptSetStatus(APP_STATUS status)
Sets the app's status.
aptWaitStatusEvent
void aptWaitStatusEvent(void)
Waits for an APT status event.
-
APTSIGNAL_HOMEBUTTON
Home button pressed.
Definition: apt.h:56
APT_SendParameter
Result APT_SendParameter(NS_APPID src_appID, NS_APPID dst_appID, u32 bufferSize, u32 *buffer, Handle paramhandle, u8 signalType)
Sends a parameter.
APPID_ERROR
error
Definition: apt.h:35
APT_GetAppCpuTimeLimit
Result APT_GetAppCpuTimeLimit(u32 *percent)
Gets the application's CPU time limit.
aptHookCookie::param
void * param
Callback parameter.
Definition: apt.h:88
APPID_GAME_NOTES
Game Notes applet.
Definition: apt.h:22
-
APTHOOK_ONRESTORE
App restored.
Definition: apt.h:72
APP_EXITING
App exiting.
Definition: apt.h:46
aptUnhook
void aptUnhook(aptHookCookie *cookie)
Removes an APT status hook.
APT_JumpToApplication
Result APT_JumpToApplication(const u8 *param, size_t paramSize, Handle handle)
Jumps to an application.
@@ -626,18 +628,16 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
APT_InquireNotification
Result APT_InquireNotification(u32 appID, u8 *signalType)
Inquires as to whether a signal has been received.
APPID_MEMOLIB
memolib
Definition: apt.h:38
APT_HardwareResetAsync
Result APT_HardwareResetAsync(void)
Asynchronously resets the hardware.
-
APTHOOK_ONWAKEUP
App waking up.
Definition: apt.h:74
aptGetStatus
APP_STATUS aptGetStatus(void)
Gets the app's status.
APPID_WEB
Internet Browser.
Definition: apt.h:23
-
APTSIGNAL_WAKEUP
Wake from sleep mode.
Definition: apt.h:61
APT_Initialize
Result APT_Initialize(NS_APPID appId, Handle *eventHandle1, Handle *eventHandle2)
Initializes an application's registration with APT.
+
APTSIGNAL_ENABLE
Enable.
Definition: apt.h:62
APPID_SOFTWARE_KEYBOARD
Software Keyboard.
Definition: apt.h:31
APT_Finalize
Result APT_Finalize(NS_APPID appId)
Terminates an application's registration with APT.
-
APTHOOK_ONSLEEP
App sleeping.
Definition: apt.h:73
APPID_APPLETED
appletEd
Definition: apt.h:32
APT_LaunchLibraryApplet
Result APT_LaunchLibraryApplet(NS_APPID appID, Handle inhandle, u32 *parambuf, u32 parambufsize)
Launches a library applet.
-
APTSIGNAL_ENTERSLEEP
Enter sleep mode.
Definition: apt.h:60
APP_APPLETSTARTED
Applet started.
Definition: apt.h:50
+
APTHOOK_ONRESTORE
App restored.
Definition: apt.h:72
APP_SUSPENDED
App suspended.
Definition: apt.h:45
APPID_PNOTE_AP
PNOTE_AP.
Definition: apt.h:33
APT_GetAppletProgramInfo
Result APT_GetAppletProgramInfo(u32 id, u32 flags, u16 *titleversion)
Gets an applet's program information.
@@ -646,10 +646,10 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
APT_NotifyToWait
Result APT_NotifyToWait(NS_APPID appID)
Notifies an application to wait.
APT_GetProgramID
Result APT_GetProgramID(u64 *pProgramID)
Gets the current application's program ID.
APPID_ESHOP
eShop (tiger)
Definition: apt.h:30
-
APTSIGNAL_UTILITY
Utility called.
Definition: apt.h:64
APT_StartLibraryApplet
Result APT_StartLibraryApplet(NS_APPID appID, Handle inhandle, u32 *parambuf, u32 parambufsize)
Starts a library applet.
APT_GlanceParameter
Result APT_GlanceParameter(NS_APPID appID, u32 bufferSize, u32 *buffer, u32 *actualSize, u8 *signalType)
Glances at a receieved parameter without removing it from the queue.
APT_PrepareToJumpToHomeMenu
Result APT_PrepareToJumpToHomeMenu(void)
Prepares to jump to the home menu.
+
APTSIGNAL_WAKEUP
Wake from sleep mode.
Definition: apt.h:61
APT_GetAppletInfo
Result APT_GetAppletInfo(NS_APPID appID, u64 *pProgramID, u8 *pMediaType, u8 *pRegistered, u8 *pLoadState, u32 *pAttributes)
Gets an applet's information.
aptReturnToMenu
void aptReturnToMenu(void)
Triggers a return to the home menu.
diff --git a/audio_2mic_2source_2main_8c-example.html b/audio_2mic_2source_2main_8c-example.html index f86b7f8..98f66a9 100644 --- a/audio_2mic_2source_2main_8c-example.html +++ b/audio_2mic_2source_2main_8c-example.html @@ -148,7 +148,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
printf("Playing the recorded sample\n");
MIC_SetRecording(0);
GSPGPU_FlushDataCache(NULL, audiobuf, audiobuf_pos);
-
csndPlaySound(0x8, SOUND_ONE_SHOT | SOUND_FORMAT_16BIT, 16000, 1.0, 0.0, (u32*)audiobuf, NULL, audiobuf_pos);
+
csndPlaySound(0x8, SOUND_ONE_SHOT | SOUND_FORMAT_16BIT, 16000, 1.0, 0.0, (u32*)audiobuf, NULL, audiobuf_pos);
memset(framebuf, 0xe0, 0x46500);
diff --git a/channel_8h.html b/channel_8h.html index bcfdc9e..bd2ee6b 100644 --- a/channel_8h.html +++ b/channel_8h.html @@ -139,7 +139,7 @@ Functions  
IIR filters
void ndspChnIirMonoSetEnable (int id, bool enable) - Configures whether the IIR mono filter of a channel is enabled. More...
+ Configures whether the IIR monopole filter of a channel is enabled. More...
  void ndspChnIirBiquadSetEnable (int id, bool enable)  Configures whether the IIR biquad filter of a channel is enabled. More...
@@ -190,6 +190,16 @@ Data types } Channel format flags for use with ndspChnSetFormat. More...
  +enum  {
+  NDSP_INTERP_POLYPHASE = 0, +
+  NDSP_INTERP_LINEAR = 1, +
+  NDSP_INTERP_NONE = 2 +
+ } Interpolation types. More...
+  +

Detailed Description

Functions for interacting with DSP audio channels.

@@ -261,6 +271,31 @@ Data types +
+ + +
+
+ + + + +
anonymous enum
+
+ +

Interpolation types.

+ + + + +
Enumerator
NDSP_INTERP_POLYPHASE  +

Polyphase interpolation.

+
NDSP_INTERP_LINEAR  +

Linear interpolation.

+
NDSP_INTERP_NONE  +

No interpolation.

+
+

Function Documentation

@@ -373,11 +408,11 @@ Data types
-

Configures whether the IIR mono filter of a channel is enabled.

+

Configures whether the IIR monopole filter of a channel is enabled.

Parameters
- +
idID of the channel (0..23).
enableWhether to enable the IIR mono filter.
enableWhether to enable the IIR monopole filter.
diff --git a/channel_8h_source.html b/channel_8h_source.html index 218a5b2..74e7994 100644 --- a/channel_8h_source.html +++ b/channel_8h_source.html @@ -127,124 +127,133 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
35  // Flags
36  NDSP_FRONT_BYPASS = BIT(4), ///< Front bypass.
37  NDSP_3D_SURROUND_PREPROCESSED = BIT(6), ///< (?) Unknown, under research
-
38 };
-
39 ///@}
-
40 
-
41 ///@name Basic channel operation
-
42 ///@{
-
43 /**
-
44  * @brief Resets a channel.
-
45  * @param id ID of the channel (0..23).
-
46  */
-
47 void ndspChnReset(int id);
-
48 
-
49 /**
-
50  * @brief Initializes the parameters of a channel.
-
51  * @param id ID of the channel (0..23).
-
52  */
-
53 void ndspChnInitParams(int id);
-
54 
-
55 /**
-
56  * @brief Checks whether a channel is currently playing.
-
57  * @param id ID of the channel (0..23).
-
58  * @return Whether the channel is currently playing.
-
59  */
-
60 bool ndspChnIsPlaying(int id);
-
61 
-
62 /**
-
63  * @brief Gets the current sample position of a channel.
-
64  * @param id ID of the channel (0..23).
-
65  * @return The channel's sample position.
-
66  */
-
67 u32 ndspChnGetSamplePos(int id);
-
68 
-
69 /**
-
70  * @brief Gets the sequence ID of the wave buffer that is currently playing in a channel.
-
71  * @param id ID of the channel (0..23).
-
72  * @return The sequence ID of the wave buffer.
-
73  */
-
74 u16 ndspChnGetWaveBufSeq(int id);
-
75 ///@}
-
76 
-
77 ///@name Configuration
-
78 ///@{
-
79 /**
-
80  * @brief Sets the format of a channel.
-
81  * @sa NDSP_Encoding
-
82  * @param id ID of the channel (0..23).
-
83  * @param format Format to use.
-
84  */
-
85 void ndspChnSetFormat(int id, u16 format);
-
86 
-
87 /**
-
88  * @brief Sets the interpolation type of a channel.
-
89  * @param id ID of the channel (0..23).
-
90  * @param type Interpolation type to use.
-
91  */
-
92 void ndspChnSetInterp(int id, int type);
-
93 
-
94 /**
-
95  * @brief Sets the sample rate of a channel.
-
96  * @param id ID of the channel (0..23).
-
97  * @param rate Sample rate to use.
-
98  */
-
99 void ndspChnSetRate(int id, float rate);
-
100 
-
101 /**
-
102  * @brief Sets the mix parameters (volumes) of a channel.
-
103  * @param id ID of the channel (0..23).
-
104  * @param mix Mix parameters to use. Working hypothesis:
-
105  * - 0: Front left volume.
-
106  * - 1: Front right volume.
-
107  * - 2: Back left volume:
-
108  * - 3: Back right volume:
-
109  * - 4..7: Same as 0..3, but for auxiliary output 0.
-
110  * - 8..11: Same as 0..3, but for auxiliary output 1.
-
111  */
-
112 void ndspChnSetMix(int id, float mix[12]);
-
113 
-
114 /**
-
115  * @brief Sets the DSPADPCM coefficients of a channel.
-
116  * @param id ID of the channel (0..23).
-
117  * @param coefs DSPADPCM coefficients to use.
-
118  */
-
119 void ndspChnSetAdpcmCoefs(int id, u16 coefs[16]);
-
120 ///@}
-
121 
-
122 ///@name Wave buffers
-
123 ///@{
-
124 /**
-
125  * @brief Clears the wave buffer queue of a channel and stops playback.
-
126  * @param id ID of the channel (0..23).
+
38 };
+
39 
+
40 /// Interpolation types.
+
41 enum
+
42 {
+
43  NDSP_INTERP_POLYPHASE = 0, ///< Polyphase interpolation
+
44  NDSP_INTERP_LINEAR = 1, ///< Linear interpolation
+
45  NDSP_INTERP_NONE = 2, ///< No interpolation
+
46 };
+
47 
+
48 ///@}
+
49 
+
50 ///@name Basic channel operation
+
51 ///@{
+
52 /**
+
53  * @brief Resets a channel.
+
54  * @param id ID of the channel (0..23).
+
55  */
+
56 void ndspChnReset(int id);
+
57 
+
58 /**
+
59  * @brief Initializes the parameters of a channel.
+
60  * @param id ID of the channel (0..23).
+
61  */
+
62 void ndspChnInitParams(int id);
+
63 
+
64 /**
+
65  * @brief Checks whether a channel is currently playing.
+
66  * @param id ID of the channel (0..23).
+
67  * @return Whether the channel is currently playing.
+
68  */
+
69 bool ndspChnIsPlaying(int id);
+
70 
+
71 /**
+
72  * @brief Gets the current sample position of a channel.
+
73  * @param id ID of the channel (0..23).
+
74  * @return The channel's sample position.
+
75  */
+
76 u32 ndspChnGetSamplePos(int id);
+
77 
+
78 /**
+
79  * @brief Gets the sequence ID of the wave buffer that is currently playing in a channel.
+
80  * @param id ID of the channel (0..23).
+
81  * @return The sequence ID of the wave buffer.
+
82  */
+
83 u16 ndspChnGetWaveBufSeq(int id);
+
84 ///@}
+
85 
+
86 ///@name Configuration
+
87 ///@{
+
88 /**
+
89  * @brief Sets the format of a channel.
+
90  * @sa NDSP_Encoding
+
91  * @param id ID of the channel (0..23).
+
92  * @param format Format to use.
+
93  */
+
94 void ndspChnSetFormat(int id, u16 format);
+
95 
+
96 /**
+
97  * @brief Sets the interpolation type of a channel.
+
98  * @param id ID of the channel (0..23).
+
99  * @param type Interpolation type to use.
+
100  */
+
101 void ndspChnSetInterp(int id, int type);
+
102 
+
103 /**
+
104  * @brief Sets the sample rate of a channel.
+
105  * @param id ID of the channel (0..23).
+
106  * @param rate Sample rate to use.
+
107  */
+
108 void ndspChnSetRate(int id, float rate);
+
109 
+
110 /**
+
111  * @brief Sets the mix parameters (volumes) of a channel.
+
112  * @param id ID of the channel (0..23).
+
113  * @param mix Mix parameters to use. Working hypothesis:
+
114  * - 0: Front left volume.
+
115  * - 1: Front right volume.
+
116  * - 2: Back left volume:
+
117  * - 3: Back right volume:
+
118  * - 4..7: Same as 0..3, but for auxiliary output 0.
+
119  * - 8..11: Same as 0..3, but for auxiliary output 1.
+
120  */
+
121 void ndspChnSetMix(int id, float mix[12]);
+
122 
+
123 /**
+
124  * @brief Sets the DSPADPCM coefficients of a channel.
+
125  * @param id ID of the channel (0..23).
+
126  * @param coefs DSPADPCM coefficients to use.
127  */
-
128 void ndspChnWaveBufClear(int id);
-
129 
-
130 /**
-
131  * @brief Adds a wave buffer to the wave buffer queue of a channel.
-
132  * @remark If the channel's wave buffer queue was empty before the use of this function, playback is started.
-
133  * @param id ID of the channel (0..23).
-
134  * @param buf Wave buffer to add.
-
135  */
-
136 void ndspChnWaveBufAdd(int id, ndspWaveBuf* buf);
-
137 ///@}
-
138 
-
139 ///@name IIR filters
-
140 ///@{
-
141 /**
-
142  * @brief Configures whether the IIR mono filter of a channel is enabled.
-
143  * @param id ID of the channel (0..23).
-
144  * @param enable Whether to enable the IIR mono filter.
-
145  */
-
146 void ndspChnIirMonoSetEnable(int id, bool enable);
-
147 // ndspChnIirMonoSetParams
-
148 /**
-
149  * @brief Configures whether the IIR biquad filter of a channel is enabled.
-
150  * @param id ID of the channel (0..23).
-
151  * @param enable Whether to enable the IIR biquad filter.
-
152  */
-
153 void ndspChnIirBiquadSetEnable(int id, bool enable);
-
154 // ndspChnIirBiquadSetParams
-
155 ///@}
+
128 void ndspChnSetAdpcmCoefs(int id, u16 coefs[16]);
+
129 ///@}
+
130 
+
131 ///@name Wave buffers
+
132 ///@{
+
133 /**
+
134  * @brief Clears the wave buffer queue of a channel and stops playback.
+
135  * @param id ID of the channel (0..23).
+
136  */
+
137 void ndspChnWaveBufClear(int id);
+
138 
+
139 /**
+
140  * @brief Adds a wave buffer to the wave buffer queue of a channel.
+
141  * @remark If the channel's wave buffer queue was empty before the use of this function, playback is started.
+
142  * @param id ID of the channel (0..23).
+
143  * @param buf Wave buffer to add.
+
144  */
+
145 void ndspChnWaveBufAdd(int id, ndspWaveBuf* buf);
+
146 ///@}
+
147 
+
148 ///@name IIR filters
+
149 ///@{
+
150 /**
+
151  * @brief Configures whether the IIR monopole filter of a channel is enabled.
+
152  * @param id ID of the channel (0..23).
+
153  * @param enable Whether to enable the IIR monopole filter.
+
154  */
+
155 void ndspChnIirMonoSetEnable(int id, bool enable);
+
156 // ndspChnIirMonoSetParams
+
157 /**
+
158  * @brief Configures whether the IIR biquad filter of a channel is enabled.
+
159  * @param id ID of the channel (0..23).
+
160  * @param enable Whether to enable the IIR biquad filter.
+
161  */
+
162 void ndspChnIirBiquadSetEnable(int id, bool enable);
+
163 // ndspChnIirBiquadSetParams
+
164 ///@}
NDSP_FRONT_BYPASS
Front bypass.
Definition: channel.h:36
ndspChnSetRate
void ndspChnSetRate(int id, float rate)
Sets the sample rate of a channel.
ndspChnGetSamplePos
u32 ndspChnGetSamplePos(int id)
Gets the current sample position of a channel.
@@ -254,14 +263,16 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
ndspChnWaveBufAdd
void ndspChnWaveBufAdd(int id, ndspWaveBuf *buf)
Adds a wave buffer to the wave buffer queue of a channel.
NDSP_ENCODING_PCM8
PCM8.
Definition: channel.h:12
NDSP_ENCODING_PCM16
PCM16.
Definition: channel.h:13
-
ndspChnIirMonoSetEnable
void ndspChnIirMonoSetEnable(int id, bool enable)
Configures whether the IIR mono filter of a channel is enabled.
+
ndspChnIirMonoSetEnable
void ndspChnIirMonoSetEnable(int id, bool enable)
Configures whether the IIR monopole filter of a channel is enabled.
NDSP_ENCODING_ADPCM
DSPADPCM (GameCube format)
Definition: channel.h:14
ndspChnReset
void ndspChnReset(int id)
Resets a channel.
NDSP_FORMAT_STEREO_PCM16
Buffer contains Stereo PCM16.
Definition: channel.h:29
u32
uint32_t u32
32-bit unsigned integer
Definition: types.h:24
NDSP_FORMAT_PCM8
(Alias) Buffer contains Mono PCM8.
Definition: channel.h:31
+
NDSP_INTERP_NONE
No interpolation.
Definition: channel.h:45
ndspChnGetWaveBufSeq
u16 ndspChnGetWaveBufSeq(int id)
Gets the sequence ID of the wave buffer that is currently playing in a channel.
NDSP_CHANNELS
#define NDSP_CHANNELS(n)
Specifies the number of channels used in a sample.
Definition: channel.h:18
+
NDSP_INTERP_POLYPHASE
Polyphase interpolation.
Definition: channel.h:43
ndspChnIsPlaying
bool ndspChnIsPlaying(int id)
Checks whether a channel is currently playing.
NDSP_FORMAT_PCM16
(Alias) Buffer contains Mono PCM16.
Definition: channel.h:32
NDSP_FORMAT_MONO_PCM16
Buffer contains Mono PCM16.
Definition: channel.h:26
@@ -275,6 +286,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
ndspChnSetInterp
void ndspChnSetInterp(int id, int type)
Sets the interpolation type of a channel.
NDSP_FORMAT_MONO_ADPCM
Buffer contains Mono ADPCM.
Definition: channel.h:27
ndspChnSetMix
void ndspChnSetMix(int id, float mix[12])
Sets the mix parameters (volumes) of a channel.
+
NDSP_INTERP_LINEAR
Linear interpolation.
Definition: channel.h:44
NDSP_3D_SURROUND_PREPROCESSED
(?) Unknown, under research
Definition: channel.h:37
ndspChnSetFormat
void ndspChnSetFormat(int id, u16 format)
Sets the format of a channel.
diff --git a/csnd_8h.html b/csnd_8h.html index 4f90eeb..be0b70c 100644 --- a/csnd_8h.html +++ b/csnd_8h.html @@ -137,83 +137,83 @@ Macros - - + } + - - + } + - - + } + - - + } + - - + } +

Enumerations

enum  {
-  CSND_ENCODING_PCM8 = 0, +
enum  {
+  CSND_ENCODING_PCM8 = 0,
-  CSND_ENCODING_PCM16, +  CSND_ENCODING_PCM16,
-  CSND_ENCODING_ADPCM, +  CSND_ENCODING_ADPCM,
-  CSND_ENCODING_PSG +  CSND_ENCODING_PSG
- }
 CSND encodings. More...
 
 CSND encodings. More...
 
enum  {
-  CSND_LOOPMODE_MANUAL = 0, +
enum  {
+  CSND_LOOPMODE_MANUAL = 0,
-  CSND_LOOPMODE_NORMAL, +  CSND_LOOPMODE_NORMAL,
-  CSND_LOOPMODE_ONESHOT, +  CSND_LOOPMODE_ONESHOT,
-  CSND_LOOPMODE_NORELOAD +  CSND_LOOPMODE_NORELOAD
- }
 CSND loop modes. More...
 
 CSND loop modes. More...
 
enum  {
-  SOUND_LINEAR_INTERP = BIT(6), +
enum  {
+  SOUND_LINEAR_INTERP = BIT(6),
-  SOUND_REPEAT = SOUND_LOOPMODE(CSND_LOOPMODE_NORMAL), +  SOUND_REPEAT = SOUND_LOOPMODE(CSND_LOOPMODE_NORMAL),
-  SOUND_ONE_SHOT = SOUND_LOOPMODE(CSND_LOOPMODE_ONESHOT), +  SOUND_ONE_SHOT = SOUND_LOOPMODE(CSND_LOOPMODE_ONESHOT),
-  SOUND_FORMAT_8BIT = SOUND_FORMAT(CSND_ENCODING_PCM8), +  SOUND_FORMAT_8BIT = SOUND_FORMAT(CSND_ENCODING_PCM8),
-  SOUND_FORMAT_16BIT = SOUND_FORMAT(CSND_ENCODING_PCM16), +  SOUND_FORMAT_16BIT = SOUND_FORMAT(CSND_ENCODING_PCM16),
-  SOUND_FORMAT_ADPCM = SOUND_FORMAT(CSND_ENCODING_ADPCM), +  SOUND_FORMAT_ADPCM = SOUND_FORMAT(CSND_ENCODING_ADPCM),
-  SOUND_FORMAT_PSG = SOUND_FORMAT(CSND_ENCODING_PSG), +  SOUND_FORMAT_PSG = SOUND_FORMAT(CSND_ENCODING_PSG),
-  SOUND_ENABLE = BIT(14) +  SOUND_ENABLE = BIT(14)
- }
 Sound flags. More...
 
 Sound flags. More...
 
enum  {
-  CAPTURE_REPEAT = 0, +
enum  {
+  CAPTURE_REPEAT = 0,
-  CAPTURE_ONE_SHOT = BIT(0), +  CAPTURE_ONE_SHOT = BIT(0),
-  CAPTURE_FORMAT_16BIT = 0, +  CAPTURE_FORMAT_16BIT = 0,
-  CAPTURE_FORMAT_8BIT = BIT(1), +  CAPTURE_FORMAT_8BIT = BIT(1),
-  CAPTURE_ENABLE = BIT(15) +  CAPTURE_ENABLE = BIT(15)
- }
 Capture modes. More...
 
 Capture modes. More...
 
enum  {
-  DutyCycle_0 = 7, +
enum  {
+  DutyCycle_0 = 7,
-  DutyCycle_12 = 0, +  DutyCycle_12 = 0,
-  DutyCycle_25 = 1, +  DutyCycle_25 = 1,
-  DutyCycle_37 = 2, +  DutyCycle_37 = 2,
-  DutyCycle_50 = 3, +  DutyCycle_50 = 3,
-  DutyCycle_62 = 4, +  DutyCycle_62 = 4,
-  DutyCycle_75 = 5, +  DutyCycle_75 = 5,
-  DutyCycle_87 = 6 +  DutyCycle_87 = 6
- }
 Duty cycles for a PSG channel. More...
 
 Duty cycles for a PSG channel. More...
 

Detailed Description

CSND service.

Enumeration Type Documentation

- -
-
-

@@ -356,47 +356,7 @@ Variables

- - - -
anonymous enum
-
- -

Duty cycles for a PSG channel.

- - - - - - - - - -
Enumerator
DutyCycle_0  -

0.0% duty cycle

-
DutyCycle_12  -

12.5% duty cycle

-
DutyCycle_25  -

25.0% duty cycle

-
DutyCycle_37  -

37.5% duty cycle

-
DutyCycle_50  -

50.0% duty cycle

-
DutyCycle_62  -

62.5% duty cycle

-
DutyCycle_75  -

75.0% duty cycle

-
DutyCycle_87  -

87.5% duty cycle

-
- -
- - +
@@ -408,23 +368,23 @@ Variables

CSND encodings.

- - - -
Enumerator
CSND_ENCODING_PCM8  +
Enumerator
CSND_ENCODING_PCM8 

PCM8.

CSND_ENCODING_PCM16  +
CSND_ENCODING_PCM16 

PCM16.

CSND_ENCODING_ADPCM  +
CSND_ENCODING_ADPCM 

IMA-ADPCM.

CSND_ENCODING_PSG  +
CSND_ENCODING_PSG 

PSG (Similar to DS?)

- +
@@ -436,23 +396,23 @@ Variables

CSND loop modes.

- - - -
Enumerator
CSND_LOOPMODE_MANUAL  +
Enumerator
CSND_LOOPMODE_MANUAL 

Manual loop.

CSND_LOOPMODE_NORMAL  +
CSND_LOOPMODE_NORMAL 

Normal loop.

CSND_LOOPMODE_ONESHOT  +
CSND_LOOPMODE_ONESHOT 

Do not loop.

CSND_LOOPMODE_NORELOAD  +
CSND_LOOPMODE_NORELOAD 

Don't reload.

- +
@@ -464,35 +424,35 @@ Variables

Sound flags.

- - - - - - - -
Enumerator
SOUND_LINEAR_INTERP  +
Enumerator
SOUND_LINEAR_INTERP 

Linear interpolation.

SOUND_REPEAT  +
SOUND_REPEAT 

Repeat the sound.

SOUND_ONE_SHOT  +
SOUND_ONE_SHOT 

Play the sound once.

SOUND_FORMAT_8BIT  +
SOUND_FORMAT_8BIT 

PCM8.

SOUND_FORMAT_16BIT  +
SOUND_FORMAT_16BIT 

PCM16.

SOUND_FORMAT_ADPCM  +
SOUND_FORMAT_ADPCM 

ADPCM.

SOUND_FORMAT_PSG  +
SOUND_FORMAT_PSG 

PSG.

SOUND_ENABLE  +
SOUND_ENABLE 

Enable sound.

- +
@@ -504,23 +464,63 @@ Variables

Capture modes.

- - - - -
Enumerator
CAPTURE_REPEAT  +
Enumerator
CAPTURE_REPEAT 

Repeat capture.

CAPTURE_ONE_SHOT  +
CAPTURE_ONE_SHOT 

Capture once.

CAPTURE_FORMAT_16BIT  +
CAPTURE_FORMAT_16BIT 

PCM16.

CAPTURE_FORMAT_8BIT  +
CAPTURE_FORMAT_8BIT 

PCM8.

CAPTURE_ENABLE  +
CAPTURE_ENABLE 

Enable capture.

+
+
+ +
+
+ + + + +
anonymous enum
+
+ +

Duty cycles for a PSG channel.

+ + + + + + + + + +
Enumerator
DutyCycle_0  +

0.0% duty cycle

+
DutyCycle_12  +

12.5% duty cycle

+
DutyCycle_25  +

25.0% duty cycle

+
DutyCycle_37  +

37.5% duty cycle

+
DutyCycle_50  +

50.0% duty cycle

+
DutyCycle_62  +

62.5% duty cycle

+
DutyCycle_75  +

75.0% duty cycle

+
DutyCycle_87  +

87.5% duty cycle

+
+

Function Documentation

diff --git a/csnd_8h_source.html b/csnd_8h_source.html index d9f1195..9db8bf2 100644 --- a/csnd_8h_source.html +++ b/csnd_8h_source.html @@ -127,19 +127,19 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
35 /// CSND encodings.
36 enum
37 {
-
38  CSND_ENCODING_PCM8 = 0, ///< PCM8
-
39  CSND_ENCODING_PCM16, ///< PCM16
-
40  CSND_ENCODING_ADPCM, ///< IMA-ADPCM
-
41  CSND_ENCODING_PSG, ///< PSG (Similar to DS?)
+
38  CSND_ENCODING_PCM8 = 0, ///< PCM8
+
39  CSND_ENCODING_PCM16, ///< PCM16
+
40  CSND_ENCODING_ADPCM, ///< IMA-ADPCM
+
41  CSND_ENCODING_PSG, ///< PSG (Similar to DS?)
42 };
43 
44 /// CSND loop modes.
45 enum
46 {
-
47  CSND_LOOPMODE_MANUAL = 0, ///< Manual loop.
-
48  CSND_LOOPMODE_NORMAL, ///< Normal loop.
-
49  CSND_LOOPMODE_ONESHOT, ///< Do not loop.
-
50  CSND_LOOPMODE_NORELOAD, ///< Don't reload.
+
47  CSND_LOOPMODE_MANUAL = 0, ///< Manual loop.
+
48  CSND_LOOPMODE_NORMAL, ///< Normal loop.
+
49  CSND_LOOPMODE_ONESHOT, ///< Do not loop.
+
50  CSND_LOOPMODE_NORELOAD, ///< Don't reload.
51 };
52 
53 /// Creates a sound channel value from a channel number.
@@ -154,37 +154,37 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
62 /// Sound flags.
63 enum
64 {
-
65  SOUND_LINEAR_INTERP = BIT(6), ///< Linear interpolation.
-
66  SOUND_REPEAT = SOUND_LOOPMODE(CSND_LOOPMODE_NORMAL), ///< Repeat the sound.
-
67  SOUND_ONE_SHOT = SOUND_LOOPMODE(CSND_LOOPMODE_ONESHOT), ///< Play the sound once.
-
68  SOUND_FORMAT_8BIT = SOUND_FORMAT(CSND_ENCODING_PCM8), ///< PCM8
-
69  SOUND_FORMAT_16BIT = SOUND_FORMAT(CSND_ENCODING_PCM16), ///< PCM16
-
70  SOUND_FORMAT_ADPCM = SOUND_FORMAT(CSND_ENCODING_ADPCM), ///< ADPCM
-
71  SOUND_FORMAT_PSG = SOUND_FORMAT(CSND_ENCODING_PSG), ///< PSG
-
72  SOUND_ENABLE = BIT(14), ///< Enable sound.
+
65  SOUND_LINEAR_INTERP = BIT(6), ///< Linear interpolation.
+
66  SOUND_REPEAT = SOUND_LOOPMODE(CSND_LOOPMODE_NORMAL), ///< Repeat the sound.
+
67  SOUND_ONE_SHOT = SOUND_LOOPMODE(CSND_LOOPMODE_ONESHOT), ///< Play the sound once.
+
68  SOUND_FORMAT_8BIT = SOUND_FORMAT(CSND_ENCODING_PCM8), ///< PCM8
+
69  SOUND_FORMAT_16BIT = SOUND_FORMAT(CSND_ENCODING_PCM16), ///< PCM16
+
70  SOUND_FORMAT_ADPCM = SOUND_FORMAT(CSND_ENCODING_ADPCM), ///< ADPCM
+
71  SOUND_FORMAT_PSG = SOUND_FORMAT(CSND_ENCODING_PSG), ///< PSG
+
72  SOUND_ENABLE = BIT(14), ///< Enable sound.
73 };
74 
75 /// Capture modes.
76 enum
77 {
-
78  CAPTURE_REPEAT = 0, ///< Repeat capture.
-
79  CAPTURE_ONE_SHOT = BIT(0), ///< Capture once.
-
80  CAPTURE_FORMAT_16BIT = 0, ///< PCM16
-
81  CAPTURE_FORMAT_8BIT = BIT(1), ///< PCM8
-
82  CAPTURE_ENABLE = BIT(15), ///< Enable capture.
+
78  CAPTURE_REPEAT = 0, ///< Repeat capture.
+
79  CAPTURE_ONE_SHOT = BIT(0), ///< Capture once.
+
80  CAPTURE_FORMAT_16BIT = 0, ///< PCM16
+
81  CAPTURE_FORMAT_8BIT = BIT(1), ///< PCM8
+
82  CAPTURE_ENABLE = BIT(15), ///< Enable capture.
83 };
84 
85 /// Duty cycles for a PSG channel.
86 enum
87 {
-
88  DutyCycle_0 = 7, ///< 0.0% duty cycle
-
89  DutyCycle_12 = 0, ///< 12.5% duty cycle
-
90  DutyCycle_25 = 1, ///< 25.0% duty cycle
-
91  DutyCycle_37 = 2, ///< 37.5% duty cycle
-
92  DutyCycle_50 = 3, ///< 50.0% duty cycle
-
93  DutyCycle_62 = 4, ///< 62.5% duty cycle
-
94  DutyCycle_75 = 5, ///< 75.0% duty cycle
-
95  DutyCycle_87 = 6 ///< 87.5% duty cycle
+
88  DutyCycle_0 = 7, ///< 0.0% duty cycle
+
89  DutyCycle_12 = 0, ///< 12.5% duty cycle
+
90  DutyCycle_25 = 1, ///< 25.0% duty cycle
+
91  DutyCycle_37 = 2, ///< 37.5% duty cycle
+
92  DutyCycle_50 = 3, ///< 50.0% duty cycle
+
93  DutyCycle_62 = 4, ///< 62.5% duty cycle
+
94  DutyCycle_75 = 5, ///< 75.0% duty cycle
+
95  DutyCycle_87 = 6 ///< 87.5% duty cycle
96 };
97 
98 /// Channel info.
@@ -499,100 +499,100 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
407  * @param status Pointer to output the channel status to.
408  */
409 Result csndIsPlaying(u32 channel, u8* status);
+
CSND_ENCODING_PSG
PSG (Similar to DS?)
Definition: csnd.h:41
CSND_SetInterp
void CSND_SetInterp(u32 channel, bool interp)
Sets whether a channel should use interpolation.
vu32
volatile u32 vu32
32-bit volatile unsigned integer.
Definition: types.h:34
+
DutyCycle_62
62.5% duty cycle
Definition: csnd.h:93
types.h
Various system types.
Result
s32 Result
Function result.
Definition: types.h:43
-
DutyCycle_62
62.5% duty cycle
Definition: csnd.h:93
CSND_CapInfo::unknownZero
u32 unknownZero
Unknown.
Definition: csnd.h:123
-
SOUND_FORMAT_ADPCM
ADPCM.
Definition: csnd.h:70
-
CSND_ENCODING_ADPCM
IMA-ADPCM.
Definition: csnd.h:40
+
CAPTURE_ENABLE
Enable capture.
Definition: csnd.h:82
CSND_Reset
Result CSND_Reset(void)
Resets CSND.
u16
uint16_t u16
16-bit unsigned integer
Definition: types.h:23
CSND_CapInfo::_pad2
u16 _pad2
Padding.
Definition: csnd.h:122
-
DutyCycle_12
12.5% duty cycle
Definition: csnd.h:89
+
SOUND_LINEAR_INTERP
Linear interpolation.
Definition: csnd.h:65
CSND_SetLooping
void CSND_SetLooping(u32 channel, u32 value)
Sets whether to loop a channel.
+
CSND_LOOPMODE_NORMAL
Normal loop.
Definition: csnd.h:48
csndWriteCmd
void csndWriteCmd(int cmdid, u8 *cmdparams)
Adds a command to the list, copying its arguments from a buffer.
-
DutyCycle_87
87.5% duty cycle
Definition: csnd.h:95
CSND_SetChnRegsNoise
void CSND_SetChnRegsNoise(u32 flags, u32 chnVolumes, u32 capVolumes)
Sets CSND's noise channel registers.
+
CAPTURE_FORMAT_16BIT
PCM16.
Definition: csnd.h:80
CSND_ChnInfo::_pad1
u8 _pad1
Padding.
Definition: csnd.h:105
CSND_SetEncoding
void CSND_SetEncoding(u32 channel, u32 value)
Sets a channel's encoding.
u8
uint8_t u8
8-bit unsigned integer
Definition: types.h:22
-
CAPTURE_REPEAT
Repeat capture.
Definition: csnd.h:78
SOUND_FORMAT
#define SOUND_FORMAT(n)
Creates a sound format value from an encoding.
Definition: csnd.h:57
SOUND_LOOPMODE
#define SOUND_LOOPMODE(n)
Creates a sound loop mode value from a loop mode.
Definition: csnd.h:60
csndGetDspFlags
void csndGetDspFlags(u32 *outSemFlags, u32 *outIrqFlags)
Gets CSND's DSP flags.
+
DutyCycle_37
37.5% duty cycle
Definition: csnd.h:91
+
SOUND_ENABLE
Enable sound.
Definition: csnd.h:72
CSND_ChnInfo::adpcmIndex
u8 adpcmIndex
Current ADPCM index.
Definition: csnd.h:108
csndGetCapInfo
CSND_CapInfo * csndGetCapInfo(u32 capUnit)
Gets a capture unit's information.
u32
uint32_t u32
32-bit unsigned integer
Definition: types.h:24
-
CAPTURE_FORMAT_16BIT
PCM16.
Definition: csnd.h:80
+
SOUND_ONE_SHOT
Play the sound once.
Definition: csnd.h:67
+
DutyCycle_75
75.0% duty cycle
Definition: csnd.h:94
CSND_CapEnable
void CSND_CapEnable(u32 capUnit, bool enable)
Sets whether a capture unit is enabled.
csndAddCmd
u32 * csndAddCmd(int cmdid)
Adds a command to the list, returning a buffer to write arguments to.
CSND_CapSetFormat
void CSND_CapSetFormat(u32 capUnit, bool eightbit)
Sets a capture unit's format.
+
DutyCycle_50
50.0% duty cycle
Definition: csnd.h:92
CSND_SetCapRegs
void CSND_SetCapRegs(u32 capUnit, u32 flags, u32 addr, u32 size)
Sets a capture unit's capture registers.
-
DutyCycle_25
25.0% duty cycle
Definition: csnd.h:90
csndInit
Result csndInit(void)
Initializes CSND.
CSND_ReleaseCapUnit
Result CSND_ReleaseCapUnit(u32 capUnit)
Releases a capture unit.
CSND_SetPlayState
void CSND_SetPlayState(u32 channel, u32 value)
Sets a channel's play state.
-
SOUND_ENABLE
Enable sound.
Definition: csnd.h:72
-
SOUND_FORMAT_PSG
PSG.
Definition: csnd.h:71
-
DutyCycle_0
0.0% duty cycle
Definition: csnd.h:88
+
CSND_ENCODING_PCM8
PCM8.
Definition: csnd.h:38
+
SOUND_FORMAT_ADPCM
ADPCM.
Definition: csnd.h:70
CSND_SetChnRegsPSG
void CSND_SetChnRegsPSG(u32 flags, u32 chnVolumes, u32 capVolumes, u32 duty)
Sets CSND's PSG channel registers.
CSND_SetChnRegs
void CSND_SetChnRegs(u32 flags, u32 physaddr0, u32 physaddr1, u32 totalbytesize, u32 chnVolumes, u32 capVolumes)
Sets CSND's channel registers.
-
CSND_LOOPMODE_NORELOAD
Don't reload.
Definition: csnd.h:50
+
CAPTURE_REPEAT
Repeat capture.
Definition: csnd.h:78
CSND_SetAdpcmState
void CSND_SetAdpcmState(u32 channel, int block, int sample, int index)
Sets a channel's ADPCM state.
+
CAPTURE_FORMAT_8BIT
PCM8.
Definition: csnd.h:81
csndSharedMem
vu32 * csndSharedMem
CSND shared memory.
-
CSND_LOOPMODE_NORMAL
Normal loop.
Definition: csnd.h:48
CSND_ChnInfo::adpcmSample
s16 adpcmSample
Current ADPCM sample.
Definition: csnd.h:107
+
CAPTURE_ONE_SHOT
Capture once.
Definition: csnd.h:79
CSND_SetDuty
void CSND_SetDuty(u32 channel, u32 duty)
Sets a channel's duty.
+
SOUND_FORMAT_16BIT
PCM16.
Definition: csnd.h:69
+
DutyCycle_25
25.0% duty cycle
Definition: csnd.h:90
CSND_CapSetBuffer
void CSND_CapSetBuffer(u32 capUnit, u32 addr, u32 size)
Sets a capture unit's buffer.
-
SOUND_FORMAT_16BIT
PCM16.
Definition: csnd.h:69
CSND_SetPlayStateR
void CSND_SetPlayStateR(u32 channel, u32 value)
Sets a channel's play state, resetting registers on stop.
CSND_AcquireCapUnit
Result CSND_AcquireCapUnit(u32 *capUnit)
Acquires a capture unit.
CSND_SetBlock
void CSND_SetBlock(u32 channel, int block, u32 physaddr, u32 size)
Sets the data of a channel's block.
+
DutyCycle_0
0.0% duty cycle
Definition: csnd.h:88
csndExecCmds
Result csndExecCmds(bool waitDone)
Executes pending CSND commands.
-
SOUND_LINEAR_INTERP
Linear interpolation.
Definition: csnd.h:65
-
CAPTURE_ONE_SHOT
Capture once.
Definition: csnd.h:79
CSND_SetTimer
void CSND_SetTimer(u32 channel, u32 timer)
Sets a channel's timer.
+
DutyCycle_12
12.5% duty cycle
Definition: csnd.h:89
csndGetChnInfo
CSND_ChnInfo * csndGetChnInfo(u32 channel)
Gets a channel's information.
BIT
#define BIT(n)
Creates a bitmask from a bit number.
Definition: types.h:47
csndSharedMemSize
u32 csndSharedMemSize
CSND shared memory size.
-
CAPTURE_FORMAT_8BIT
PCM8.
Definition: csnd.h:81
CSND_UpdateInfo
Result CSND_UpdateInfo(bool waitDone)
Updates CSND information.
CSND_SetDspFlags
Result CSND_SetDspFlags(bool waitDone)
Sets up DSP flags.
+
CSND_LOOPMODE_NORELOAD
Don't reload.
Definition: csnd.h:50
+
SOUND_FORMAT_PSG
PSG.
Definition: csnd.h:71
CSND_ChnInfo::_pad2
u16 _pad2
Padding.
Definition: csnd.h:106
CSND_ChnInfo
Channel info.
Definition: csnd.h:99
CSND_CapInfo::active
u8 active
Capture active.
Definition: csnd.h:120
csndGetState
Result csndGetState(u32 channel, CSND_ChnInfo *out)
Gets a channel's state.
CSND_SetAdpcmReload
void CSND_SetAdpcmReload(u32 channel, bool reload)
Sets a whether channel's ADPCM data should be reloaded when the second block is played.
csndIsPlaying
Result csndIsPlaying(u32 channel, u8 *status)
Gets whether a channel is playing.
-
CSND_ENCODING_PCM16
PCM16.
Definition: csnd.h:39
-
SOUND_FORMAT_8BIT
PCM8.
Definition: csnd.h:68
+
SOUND_FORMAT_8BIT
PCM8.
Definition: csnd.h:68
+
CSND_ENCODING_ADPCM
IMA-ADPCM.
Definition: csnd.h:40
csndExit
Result csndExit(void)
Exits CSND.
CSND_CapSetBit2
void CSND_CapSetBit2(u32 capUnit, bool set)
Sets a capture unit's second bit.
-
CSND_LOOPMODE_MANUAL
Manual loop.
Definition: csnd.h:47
CSND_CapInfo
Capture info.
Definition: csnd.h:115
-
CSND_ENCODING_PCM8
PCM8.
Definition: csnd.h:38
CSND_ChnInfo::unknownZero
u32 unknownZero
Unknown.
Definition: csnd.h:110
-
CAPTURE_ENABLE
Enable capture.
Definition: csnd.h:82
CSND_SetBit7
void CSND_SetBit7(u32 channel, bool set)
Sets bit 7 of a channel.
CSND_VOL
static u32 CSND_VOL(float vol, float pan)
Converts a vol-pan pair into a left/right volume pair used by the hardware.
Definition: csnd.h:21
CSND_CapSetTimer
void CSND_CapSetTimer(u32 capUnit, u32 timer)
Sets a capture unit's timer.
csndPlaySound
Result csndPlaySound(int chn, u32 flags, u32 sampleRate, float vol, float pan, void *data0, void *data1, u32 size)
Plays a sound.
-
SOUND_ONE_SHOT
Play the sound once.
Definition: csnd.h:67
-
DutyCycle_37
37.5% duty cycle
Definition: csnd.h:91
+
CSND_ENCODING_PCM16
PCM16.
Definition: csnd.h:39
+
CSND_LOOPMODE_MANUAL
Manual loop.
Definition: csnd.h:47
csndChannels
u32 csndChannels
Bitmask of channels that are allowed for usage.
CSND_ChnInfo::active
u8 active
Channel active.
Definition: csnd.h:104
-
CSND_ENCODING_PSG
PSG (Similar to DS?)
Definition: csnd.h:41
CSND_CapSetRepeat
void CSND_CapSetRepeat(u32 capUnit, bool repeat)
Sets whether a capture unit should repeat.
-
DutyCycle_50
50.0% duty cycle
Definition: csnd.h:92
-
DutyCycle_75
75.0% duty cycle
Definition: csnd.h:94
-
CSND_LOOPMODE_ONESHOT
Do not loop.
Definition: csnd.h:49
-
SOUND_REPEAT
Repeat the sound.
Definition: csnd.h:66
CSND_ChnInfo::_pad3
u8 _pad3
Padding.
Definition: csnd.h:109
CSND_CapInfo::_pad1
u8 _pad1
Padding.
Definition: csnd.h:121
s16
int16_t s16
16-bit signed integer
Definition: types.h:28
+
DutyCycle_87
87.5% duty cycle
Definition: csnd.h:95
CSND_SetVol
void CSND_SetVol(u32 channel, u32 chnVolumes, u32 capVolumes)
Sets a channel's volume.
+
SOUND_REPEAT
Repeat the sound.
Definition: csnd.h:66
+
CSND_LOOPMODE_ONESHOT
Do not loop.
Definition: csnd.h:49
diff --git a/functions_p.html b/functions_p.html index 424f280..324f2ae 100644 --- a/functions_p.html +++ b/functions_p.html @@ -125,7 +125,6 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); : CAMU_PackageParameterCameraSelect , CAMU_StereoCameraCalibrationData , qtmHeadtrackingInfo -, ndspWaveBuf
  • param : aptHookCookie diff --git a/functions_s.html b/functions_s.html index 945b7c6..20a1e0c 100644 --- a/functions_s.html +++ b/functions_s.html @@ -165,6 +165,9 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
  • state : MemInfo
    • +
  • status +: ndspWaveBuf +
  • string_addr : OutputStringEvent
    • diff --git a/functions_vars_p.html b/functions_vars_p.html index 1485a0b..c0b0885 100644 --- a/functions_vars_p.html +++ b/functions_vars_p.html @@ -125,7 +125,6 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); : CAMU_PackageParameterCameraSelect , CAMU_StereoCameraCalibrationData , qtmHeadtrackingInfo -, ndspWaveBuf
  • param : aptHookCookie diff --git a/functions_vars_s.html b/functions_vars_s.html index af0f6c2..9edd2ea 100644 --- a/functions_vars_s.html +++ b/functions_vars_s.html @@ -165,6 +165,9 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
  • state : MemInfo
    • +
  • status +: ndspWaveBuf +
  • string_addr : OutputStringEvent
    • diff --git a/globals_a.html b/globals_a.html index cf6d46d..ac34005 100644 --- a/globals_a.html +++ b/globals_a.html @@ -410,22 +410,22 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); : apt.h
  • APTHOOK_COUNT -: apt.h +: apt.h
  • APTHOOK_ONEXIT -: apt.h +: apt.h
  • APTHOOK_ONRESTORE -: apt.h +: apt.h
  • APTHOOK_ONSLEEP -: apt.h +: apt.h
  • APTHOOK_ONSUSPEND -: apt.h +: apt.h
  • APTHOOK_ONWAKEUP -: apt.h +: apt.h
  • aptHookFn : apt.h @@ -449,31 +449,31 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); : apt.h
  • APTSIGNAL_ENABLE -: apt.h +: apt.h
  • APTSIGNAL_ENTERSLEEP -: apt.h +: apt.h
  • APTSIGNAL_ERROR -: apt.h +: apt.h
  • APTSIGNAL_HOMEBUTTON -: apt.h +: apt.h
  • APTSIGNAL_POWERBUTTON -: apt.h +: apt.h
  • APTSIGNAL_PREPARESLEEP -: apt.h +: apt.h
  • APTSIGNAL_SLEEPSYSTEM -: apt.h +: apt.h
  • APTSIGNAL_UTILITY -: apt.h +: apt.h
  • APTSIGNAL_WAKEUP -: apt.h +: apt.h
  • aptSignalReadyForSleep() : apt.h diff --git a/globals_c.html b/globals_c.html index fd30f8e..e7d3fe1 100644 --- a/globals_c.html +++ b/globals_c.html @@ -353,19 +353,19 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); : cam.h
  • CAPTURE_ENABLE -: csnd.h +: csnd.h
  • CAPTURE_FORMAT_16BIT -: csnd.h +: csnd.h
  • CAPTURE_FORMAT_8BIT -: csnd.h +: csnd.h
  • CAPTURE_ONE_SHOT -: csnd.h +: csnd.h
  • CAPTURE_REPEAT -: csnd.h +: csnd.h
  • CFGNOR_DumpFlash() : cfgnor.h @@ -527,28 +527,28 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); : csnd.h
  • CSND_ENCODING_ADPCM -: csnd.h +: csnd.h
  • CSND_ENCODING_PCM16 -: csnd.h +: csnd.h
  • CSND_ENCODING_PCM8 -: csnd.h +: csnd.h
  • CSND_ENCODING_PSG -: csnd.h +: csnd.h
  • CSND_LOOPMODE_MANUAL -: csnd.h +: csnd.h
  • CSND_LOOPMODE_NORELOAD -: csnd.h +: csnd.h
  • CSND_LOOPMODE_NORMAL -: csnd.h +: csnd.h
  • CSND_LOOPMODE_ONESHOT -: csnd.h +: csnd.h
  • CSND_NUM_CHANNELS : csnd.h diff --git a/globals_d.html b/globals_d.html index 23ef62d..8384263 100644 --- a/globals_d.html +++ b/globals_d.html @@ -257,28 +257,28 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); : dsp.h
  • DutyCycle_0 -: csnd.h +: csnd.h
  • DutyCycle_12 -: csnd.h +: csnd.h
  • DutyCycle_25 -: csnd.h +: csnd.h
  • DutyCycle_37 -: csnd.h +: csnd.h
  • DutyCycle_50 -: csnd.h +: csnd.h
  • DutyCycle_62 -: csnd.h +: csnd.h
  • DutyCycle_75 -: csnd.h +: csnd.h
  • DutyCycle_87 -: csnd.h +: csnd.h
  • DVLB_Free() : shbin.h diff --git a/globals_eval.html b/globals_eval.html index e3c247e..7f4e20e 100644 --- a/globals_eval.html +++ b/globals_eval.html @@ -209,49 +209,49 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); : apt.h
  • APTHOOK_COUNT -: apt.h +: apt.h
  • APTHOOK_ONEXIT -: apt.h +: apt.h
  • APTHOOK_ONRESTORE -: apt.h +: apt.h
  • APTHOOK_ONSLEEP -: apt.h +: apt.h
  • APTHOOK_ONSUSPEND -: apt.h +: apt.h
  • APTHOOK_ONWAKEUP -: apt.h +: apt.h
  • APTSIGNAL_ENABLE -: apt.h +: apt.h
  • APTSIGNAL_ENTERSLEEP -: apt.h +: apt.h
  • APTSIGNAL_ERROR -: apt.h +: apt.h
  • APTSIGNAL_HOMEBUTTON -: apt.h +: apt.h
  • APTSIGNAL_POWERBUTTON -: apt.h +: apt.h
  • APTSIGNAL_PREPARESLEEP -: apt.h +: apt.h
  • APTSIGNAL_SLEEPSYSTEM -: apt.h +: apt.h
  • APTSIGNAL_UTILITY -: apt.h +: apt.h
  • APTSIGNAL_WAKEUP -: apt.h +: apt.h
  • ARBITRATION_DECREMENT_AND_WAIT_IF_LESS_THAN : svc.h diff --git a/globals_eval_c.html b/globals_eval_c.html index 0ebab07..8d252a2 100644 --- a/globals_eval_c.html +++ b/globals_eval_c.html @@ -122,19 +122,19 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

    - c -

    diff --git a/globals_eval_d.html b/globals_eval_d.html index 253441b..0802a61 100644 --- a/globals_eval_d.html +++ b/globals_eval_d.html @@ -179,28 +179,28 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); : dsp.h
  • DutyCycle_0 -: csnd.h +: csnd.h
  • DutyCycle_12 -: csnd.h +: csnd.h
  • DutyCycle_25 -: csnd.h +: csnd.h
  • DutyCycle_37 -: csnd.h +: csnd.h
  • DutyCycle_50 -: csnd.h +: csnd.h
  • DutyCycle_62 -: csnd.h +: csnd.h
  • DutyCycle_75 -: csnd.h +: csnd.h
  • DutyCycle_87 -: csnd.h +: csnd.h
  • DVLE_CONST_BOOL : shbin.h diff --git a/globals_eval_n.html b/globals_eval_n.html index 45abb2c..78c71c4 100644 --- a/globals_eval_n.html +++ b/globals_eval_n.html @@ -124,6 +124,12 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
  • NDSP_3D_SURROUND_PREPROCESSED : channel.h
    • +
  • NDSP_CLIP_NORMAL +: ndsp.h +
    • +
  • NDSP_CLIP_SOFT +: ndsp.h +
  • NDSP_ENCODING_ADPCM : channel.h
    • @@ -160,6 +166,45 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
  • NDSP_FRONT_BYPASS : channel.h
    • +
  • NDSP_INTERP_LINEAR +: channel.h +
    • +
  • NDSP_INTERP_NONE +: channel.h +
    • +
  • NDSP_INTERP_POLYPHASE +: channel.h +
    • +
  • NDSP_OUTPUT_MONO +: ndsp.h +
    • +
  • NDSP_OUTPUT_STEREO +: ndsp.h +
    • +
  • NDSP_OUTPUT_SURROUND +: ndsp.h +
    • +
  • NDSP_SPKPOS_NUM +: ndsp.h +
    • +
  • NDSP_SPKPOS_SQUARE +: ndsp.h +
    • +
  • NDSP_SPKPOS_WIDE +: ndsp.h +
    • +
  • NDSP_WBUF_DONE +: ndsp.h +
    • +
  • NDSP_WBUF_FREE +: ndsp.h +
    • +
  • NDSP_WBUF_PLAYING +: ndsp.h +
    • +
  • NDSP_WBUF_QUEUED +: ndsp.h +
    • diff --git a/globals_eval_s.html b/globals_eval_s.html index ade1596..b88a31d 100644 --- a/globals_eval_s.html +++ b/globals_eval_s.html @@ -182,28 +182,28 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); : cam.h
  • SOUND_ENABLE -: csnd.h +: csnd.h
  • SOUND_FORMAT_16BIT -: csnd.h +: csnd.h
  • SOUND_FORMAT_8BIT -: csnd.h +: csnd.h
  • SOUND_FORMAT_ADPCM -: csnd.h +: csnd.h
  • SOUND_FORMAT_PSG -: csnd.h +: csnd.h
  • SOUND_LINEAR_INTERP -: csnd.h +: csnd.h
  • SOUND_ONE_SHOT -: csnd.h +: csnd.h
  • SOUND_REPEAT -: csnd.h +: csnd.h
    • diff --git a/globals_n.html b/globals_n.html index 3b946f7..6519251 100644 --- a/globals_n.html +++ b/globals_n.html @@ -130,6 +130,12 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
  • NDSP_CHANNELS : channel.h
    • +
  • NDSP_CLIP_NORMAL +: ndsp.h +
    • +
  • NDSP_CLIP_SOFT +: ndsp.h +
  • NDSP_ENCODING : channel.h
    • @@ -169,6 +175,45 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
  • NDSP_FRONT_BYPASS : channel.h
    • +
  • NDSP_INTERP_LINEAR +: channel.h +
    • +
  • NDSP_INTERP_NONE +: channel.h +
    • +
  • NDSP_INTERP_POLYPHASE +: channel.h +
    • +
  • NDSP_OUTPUT_MONO +: ndsp.h +
    • +
  • NDSP_OUTPUT_STEREO +: ndsp.h +
    • +
  • NDSP_OUTPUT_SURROUND +: ndsp.h +
    • +
  • NDSP_SPKPOS_NUM +: ndsp.h +
    • +
  • NDSP_SPKPOS_SQUARE +: ndsp.h +
    • +
  • NDSP_SPKPOS_WIDE +: ndsp.h +
    • +
  • NDSP_WBUF_DONE +: ndsp.h +
    • +
  • NDSP_WBUF_FREE +: ndsp.h +
    • +
  • NDSP_WBUF_PLAYING +: ndsp.h +
    • +
  • NDSP_WBUF_QUEUED +: ndsp.h +
  • ndspAuxCallback : ndsp.h
    • diff --git a/globals_s.html b/globals_s.html index fbb5639..9c62800 100644 --- a/globals_s.html +++ b/globals_s.html @@ -245,34 +245,34 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); : csnd.h
  • SOUND_ENABLE -: csnd.h +: csnd.h
  • SOUND_FORMAT : csnd.h
  • SOUND_FORMAT_16BIT -: csnd.h +: csnd.h
  • SOUND_FORMAT_8BIT -: csnd.h +: csnd.h
  • SOUND_FORMAT_ADPCM -: csnd.h +: csnd.h
  • SOUND_FORMAT_PSG -: csnd.h +: csnd.h
  • SOUND_LINEAR_INTERP -: csnd.h +: csnd.h
  • SOUND_LOOPMODE : csnd.h
  • SOUND_ONE_SHOT -: csnd.h +: csnd.h
  • SOUND_REPEAT -: csnd.h +: csnd.h
  • srvExit() : srv.h diff --git a/ndsp_8h.html b/ndsp_8h.html index 01e7f9c..bc96c2a 100644 --- a/ndsp_8h.html +++ b/ndsp_8h.html @@ -101,25 +101,12 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

    Data Structures

    struct  ndspAdpcmData + ADPCM data. More...
      struct  ndspWaveBuf  Wave buffer struct. More...
      - - - - - - - - - -

    -Typedefs

    Data types

    ADPCM data.

    -
    -typedef void(* ndspCallback) (void *data)
     Sound frame callback function. (data = User provided data)
     
    -typedef void(* ndspAuxCallback) (void *data, int nsamples, void *samples[4])
     Auxiliary output callback function. (data = User provided data, nsamples = Number of samples, samples = Sample data)
     
    @@ -182,10 +169,155 @@ void  +

    Functions

    Initialization and basic operations
    void ndspAuxSetCallback (int id, ndspAuxCallback callback, void *data)
     Sets the callback of an auxiliary output. More...
     
    + + + + + + + + + + + + + + + + +

    +Data types

    Sound output modes.

    +
    enum  {
    +  NDSP_OUTPUT_MONO = 0, +
    +  NDSP_OUTPUT_STEREO = 1, +
    +  NDSP_OUTPUT_SURROUND = 2 +
    + }
     
    enum  {
    +  NDSP_CLIP_NORMAL = 0, +
    +  NDSP_CLIP_SOFT = 1 +
    + }
     
    enum  {
    +  NDSP_SPKPOS_SQUARE = 0, +
    +  NDSP_SPKPOS_WIDE = 1, +
    +  NDSP_SPKPOS_NUM = 2 +
    + }
     
    enum  {
    +  NDSP_WBUF_FREE = 0, +
    +  NDSP_WBUF_QUEUED = 1, +
    +  NDSP_WBUF_PLAYING = 2, +
    +  NDSP_WBUF_DONE = 3 +
    + }
     Wave buffer status. More...
     
    +typedef void(* ndspCallback) (void *data)
     Sound frame callback function. (data = User provided data)
     
    +typedef void(* ndspAuxCallback) (void *data, int nsamples, void *samples[4])
     Auxiliary output callback function. (data = User provided data, nsamples = Number of samples, samples = Sample data)
     

    Detailed Description

    Interface for Nintendo's default DSP component.

    -

    Function Documentation

    +

    Enumeration Type Documentation

    + +
    +
    + + + + +
    anonymous enum
    +
    + + + + +
    Enumerator
    NDSP_OUTPUT_MONO  +

    Mono sound.

    +
    NDSP_OUTPUT_STEREO  +

    Stereo sound.

    +
    NDSP_OUTPUT_SURROUND  +

    3D Surround sound

    +
    + +
    +
    + +
    +
    + + + + +
    anonymous enum
    +
    + + + +
    Enumerator
    NDSP_CLIP_NORMAL  +

    "Normal" clipping mode (?)

    +
    NDSP_CLIP_SOFT  +

    "Soft" clipping mode (?)

    +
    + +
    +
    + +
    +
    + + + + +
    anonymous enum
    +
    + + + + +
    Enumerator
    NDSP_SPKPOS_SQUARE  +

    ?

    +
    NDSP_SPKPOS_WIDE  +

    ?

    +
    NDSP_SPKPOS_NUM  +

    ?

    +
    + +
    +
    + +
    +
    + + + + +
    anonymous enum
    +
    + +

    Wave buffer status.

    + + + + + +
    Enumerator
    NDSP_WBUF_FREE  +

    The wave buffer is not queued.

    +
    NDSP_WBUF_QUEUED  +

    The wave buffer is queued and has not been played yet.

    +
    NDSP_WBUF_PLAYING  +

    The wave buffer is playing right now.

    +
    NDSP_WBUF_DONE  +

    The wave buffer has finished being played.

    +
    + +
    +
    +

    Function Documentation

    @@ -447,7 +579,7 @@ void 
    Parameters
    - +
    modeClipping mode to set. Defaults to 1.
    modeClipping mode to set. Defaults to NDSP_CLIP_SOFT.
    @@ -519,7 +651,7 @@ void 
    Parameters
    - +
    modeOutput mode to set. Defaults to 0.
    modeOutput mode to set. Defaults to NDSP_OUTPUT_STEREO.
    @@ -567,7 +699,7 @@ void 
    Parameters
    - +
    posPosition to set. Defaults to 0.
    posPosition to set. Defaults to NDSP_SPKPOS_SQUARE.
    diff --git a/ndsp_8h_source.html b/ndsp_8h_source.html index 164ed53..0ca80a9 100644 --- a/ndsp_8h_source.html +++ b/ndsp_8h_source.html @@ -98,207 +98,251 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
    6 
    7 ///@name Data types
    8 ///@{
    -
    9 /// ADPCM data.
    -
    10 typedef struct
    +
    9 /// Sound output modes.
    +
    10 enum
    11 {
    -
    12  u16 index; ///< Current predictor index
    -
    13  s16 history0; ///< Last outputted PCM16 sample.
    -
    14  s16 history1; ///< Second to last outputted PCM16 sample.
    -
    15 } ndspAdpcmData;
    -
    16 
    -
    17 /// Wave buffer type.
    -
    18 typedef struct tag_ndspWaveBuf ndspWaveBuf;
    -
    19 
    -
    20 /// Wave buffer struct.
    -
    21 struct tag_ndspWaveBuf
    -
    22 {
    -
    23  union
    -
    24  {
    -
    25  s8* data_pcm8; ///< Pointer to PCM8 sample data.
    -
    26  s16* data_pcm16; ///< Pointer to PCM16 sample data.
    -
    27  u8* data_adpcm; ///< Pointer to DSPADPCM sample data.
    -
    28  u32 data_vaddr; ///< Data virtual address.
    -
    29  };
    -
    30  u32 nsamples; ///< Total number of samples (PCM8=bytes, PCM16=halfwords, DSPADPCM=nibbles without frame headers)
    -
    31  ndspAdpcmData* adpcm_data; ///< ADPCM data.
    -
    32 
    -
    33  u32 offset; ///< Buffer offset. Only used for capture.
    -
    34  bool looping; ///< Whether to loop the buffer.
    -
    35  u8 padding; ///< Padding.
    -
    36 
    -
    37  u16 sequence_id; ///< Sequence ID. Assigned automatically by ndspChnWaveBufAdd.
    -
    38  ndspWaveBuf* next; ///< Next buffer to play. Used internally, do not modify.
    -
    39 };
    -
    40 
    -
    41 /// Sound frame callback function. (data = User provided data)
    -
    42 typedef void (*ndspCallback)(void* data);
    -
    43 /// Auxiliary output callback function. (data = User provided data, nsamples = Number of samples, samples = Sample data)
    -
    44 typedef void (*ndspAuxCallback)(void* data, int nsamples, void* samples[4]);
    -
    45 ///@}
    -
    46 
    -
    47 ///@name Initialization and basic operations
    -
    48 ///@{
    -
    49 /**
    -
    50  * @brief Sets up the DSP component.
    -
    51  * @param binary DSP binary to load.
    -
    52  * @param size Size of the DSP binary.
    -
    53  * @param progMask Program RAM block mask to load the binary to.
    -
    54  * @param dataMask Data RAM block mask to load the binary to.
    -
    55  */
    -
    56 void ndspUseComponent(const void* binary, u32 size, u16 progMask, u16 dataMask);
    -
    57 
    -
    58 /// Initializes NDSP.
    -
    59 Result ndspInit(void);
    -
    60 
    -
    61 /// Exits NDSP.
    -
    62 void ndspExit(void);
    -
    63 
    -
    64 /**
    -
    65  * @brief Gets the number of dropped sound frames.
    -
    66  * @return The number of dropped sound frames.
    -
    67  */
    -
    68 u32 ndspGetDroppedFrames(void);
    -
    69 
    -
    70 /**
    -
    71  * @brief Gets the total sound frame count.
    -
    72  * @return The total sound frame count.
    -
    73  */
    -
    74 u32 ndspGetFrameCount(void);
    -
    75 ///@}
    -
    76 
    -
    77 ///@name General parameters
    -
    78 ///@{
    -
    79 /**
    -
    80  * @brief Sets the master volume.
    -
    81  * @param volume Volume to set. Defaults to 1.0f.
    -
    82  */
    -
    83 void ndspSetMasterVol(float volume);
    -
    84 
    -
    85 /**
    -
    86  * @brief Sets the output mode.
    -
    87  * @param mode Output mode to set. Defaults to 0.
    -
    88  */
    -
    89 void ndspSetOutputMode(int mode);
    -
    90 
    -
    91 /**
    -
    92  * @brief Sets the clipping mode.
    -
    93  * @param mode Clipping mode to set. Defaults to 1.
    -
    94  */
    -
    95 void ndspSetClippingMode(int mode);
    -
    96 
    -
    97 /**
    -
    98  * @brief Sets the output count.
    -
    99  * @param count Output count to set. Defaults to 2.
    -
    100  */
    -
    101 void ndspSetOutputCount(int count);
    -
    102 
    -
    103 /**
    -
    104  * @brief Sets the wave buffer to capture audio to.
    -
    105  * @param capture Wave buffer to capture to.
    -
    106  */
    -
    107 void ndspSetCapture(ndspWaveBuf* capture);
    -
    108 
    -
    109 /**
    -
    110  * @brief Sets the sound frame callback.
    -
    111  * @param callback Callback to set.
    -
    112  * @param data User-defined data to pass to the callback.
    -
    113  */
    -
    114 void ndspSetCallback(ndspCallback callback, void* data);
    -
    115 ///@}
    -
    116 
    -
    117 ///@name Surround
    -
    118 ///@{
    -
    119 /**
    -
    120  * @brief Sets the surround sound depth.
    -
    121  * @param depth Depth to set. Defaults to 0x7FFF.
    -
    122  */
    -
    123 void ndspSurroundSetDepth(u16 depth);
    -
    124 
    -
    125 /**
    -
    126  * @brief Sets the surround sound position.
    -
    127  * @param pos Position to set. Defaults to 0.
    -
    128  */
    -
    129 void ndspSurroundSetPos(u16 pos);
    -
    130 
    -
    131 /**
    -
    132  * @brief Sets the surround sound rear ratio.
    -
    133  * @param ratio Rear ratio to set. Defaults to 0x8000.
    -
    134  */
    -
    135 void ndspSurroundSetRearRatio(u16 ratio);
    -
    136 ///@}
    -
    137 
    -
    138 ///@name Auxiliary output
    -
    139 ///@{
    -
    140 /**
    -
    141  * @brief Configures whether an auxiliary output is enabled.
    -
    142  * @param id ID of the auxiliary output.
    -
    143  * @param enable Whether to enable the auxiliary output.
    -
    144  */
    -
    145 void ndspAuxSetEnable(int id, bool enable);
    -
    146 
    -
    147 /**
    -
    148  * @brief Configures whether an auxiliary output should use front bypass.
    -
    149  * @param id ID of the auxiliary output.
    -
    150  * @param bypass Whether to use front bypass.
    -
    151  */
    -
    152 void ndspAuxSetFrontBypass(int id, bool bypass);
    -
    153 
    -
    154 /**
    -
    155  * @brief Sets the volume of an auxiliary output.
    -
    156  * @param id ID of the auxiliary output.
    -
    157  * @param volume Volume to set.
    -
    158  */
    -
    159 void ndspAuxSetVolume(int id, float volume);
    -
    160 
    -
    161 /**
    -
    162  * @brief Sets the callback of an auxiliary output.
    -
    163  * @param id ID of the auxiliary output.
    -
    164  * @param callback Callback to set.
    -
    165  * @param data User-defined data to pass to the callback.
    +
    12  NDSP_OUTPUT_MONO = 0, ///< Mono sound
    +
    13  NDSP_OUTPUT_STEREO = 1, ///< Stereo sound
    +
    14  NDSP_OUTPUT_SURROUND = 2, ///< 3D Surround sound
    +
    15 };
    +
    16 
    +
    17 // Clipping modes.
    +
    18 enum
    +
    19 {
    +
    20  NDSP_CLIP_NORMAL = 0, ///< "Normal" clipping mode (?)
    +
    21  NDSP_CLIP_SOFT = 1, ///< "Soft" clipping mode (?)
    +
    22 };
    +
    23 
    +
    24 // Surround speaker positions.
    +
    25 enum
    +
    26 {
    +
    27  NDSP_SPKPOS_SQUARE = 0, ///<?
    +
    28  NDSP_SPKPOS_WIDE = 1, ///<?
    +
    29  NDSP_SPKPOS_NUM = 2, ///<?
    +
    30 };
    +
    31 
    +
    32 /// ADPCM data.
    +
    33 typedef struct
    +
    34 {
    +
    35  u16 index; ///< Current predictor index
    +
    36  s16 history0; ///< Last outputted PCM16 sample.
    +
    37  s16 history1; ///< Second to last outputted PCM16 sample.
    +
    38 } ndspAdpcmData;
    +
    39 
    +
    40 /// Wave buffer type.
    +
    41 typedef struct tag_ndspWaveBuf ndspWaveBuf;
    +
    42 
    +
    43 /// Wave buffer status.
    +
    44 enum
    +
    45 {
    +
    46  NDSP_WBUF_FREE = 0, ///< The wave buffer is not queued.
    +
    47  NDSP_WBUF_QUEUED = 1, ///< The wave buffer is queued and has not been played yet.
    +
    48  NDSP_WBUF_PLAYING = 2, ///< The wave buffer is playing right now.
    +
    49  NDSP_WBUF_DONE = 3, ///< The wave buffer has finished being played.
    +
    50 };
    +
    51 
    +
    52 /// Wave buffer struct.
    +
    53 struct tag_ndspWaveBuf
    +
    54 {
    +
    55  union
    +
    56  {
    +
    57  s8* data_pcm8; ///< Pointer to PCM8 sample data.
    +
    58  s16* data_pcm16; ///< Pointer to PCM16 sample data.
    +
    59  u8* data_adpcm; ///< Pointer to DSPADPCM sample data.
    +
    60  u32 data_vaddr; ///< Data virtual address.
    +
    61  };
    +
    62  u32 nsamples; ///< Total number of samples (PCM8=bytes, PCM16=halfwords, DSPADPCM=nibbles without frame headers)
    +
    63  ndspAdpcmData* adpcm_data; ///< ADPCM data.
    +
    64 
    +
    65  u32 offset; ///< Buffer offset. Only used for capture.
    +
    66  bool looping; ///< Whether to loop the buffer.
    +
    67  u8 status; ///< Queuing/playback status.
    +
    68 
    +
    69  u16 sequence_id; ///< Sequence ID. Assigned automatically by ndspChnWaveBufAdd.
    +
    70  ndspWaveBuf* next; ///< Next buffer to play. Used internally, do not modify.
    +
    71 };
    +
    72 
    +
    73 /// Sound frame callback function. (data = User provided data)
    +
    74 typedef void (*ndspCallback)(void* data);
    +
    75 /// Auxiliary output callback function. (data = User provided data, nsamples = Number of samples, samples = Sample data)
    +
    76 typedef void (*ndspAuxCallback)(void* data, int nsamples, void* samples[4]);
    +
    77 ///@}
    +
    78 
    +
    79 ///@name Initialization and basic operations
    +
    80 ///@{
    +
    81 /**
    +
    82  * @brief Sets up the DSP component.
    +
    83  * @param binary DSP binary to load.
    +
    84  * @param size Size of the DSP binary.
    +
    85  * @param progMask Program RAM block mask to load the binary to.
    +
    86  * @param dataMask Data RAM block mask to load the binary to.
    +
    87  */
    +
    88 void ndspUseComponent(const void* binary, u32 size, u16 progMask, u16 dataMask);
    +
    89 
    +
    90 /// Initializes NDSP.
    +
    91 Result ndspInit(void);
    +
    92 
    +
    93 /// Exits NDSP.
    +
    94 void ndspExit(void);
    +
    95 
    +
    96 /**
    +
    97  * @brief Gets the number of dropped sound frames.
    +
    98  * @return The number of dropped sound frames.
    +
    99  */
    +
    100 u32 ndspGetDroppedFrames(void);
    +
    101 
    +
    102 /**
    +
    103  * @brief Gets the total sound frame count.
    +
    104  * @return The total sound frame count.
    +
    105  */
    +
    106 u32 ndspGetFrameCount(void);
    +
    107 ///@}
    +
    108 
    +
    109 ///@name General parameters
    +
    110 ///@{
    +
    111 /**
    +
    112  * @brief Sets the master volume.
    +
    113  * @param volume Volume to set. Defaults to 1.0f.
    +
    114  */
    +
    115 void ndspSetMasterVol(float volume);
    +
    116 
    +
    117 /**
    +
    118  * @brief Sets the output mode.
    +
    119  * @param mode Output mode to set. Defaults to NDSP_OUTPUT_STEREO.
    +
    120  */
    +
    121 void ndspSetOutputMode(int mode);
    +
    122 
    +
    123 /**
    +
    124  * @brief Sets the clipping mode.
    +
    125  * @param mode Clipping mode to set. Defaults to NDSP_CLIP_SOFT.
    +
    126  */
    +
    127 void ndspSetClippingMode(int mode);
    +
    128 
    +
    129 /**
    +
    130  * @brief Sets the output count.
    +
    131  * @param count Output count to set. Defaults to 2.
    +
    132  */
    +
    133 void ndspSetOutputCount(int count);
    +
    134 
    +
    135 /**
    +
    136  * @brief Sets the wave buffer to capture audio to.
    +
    137  * @param capture Wave buffer to capture to.
    +
    138  */
    +
    139 void ndspSetCapture(ndspWaveBuf* capture);
    +
    140 
    +
    141 /**
    +
    142  * @brief Sets the sound frame callback.
    +
    143  * @param callback Callback to set.
    +
    144  * @param data User-defined data to pass to the callback.
    +
    145  */
    +
    146 void ndspSetCallback(ndspCallback callback, void* data);
    +
    147 ///@}
    +
    148 
    +
    149 ///@name Surround
    +
    150 ///@{
    +
    151 /**
    +
    152  * @brief Sets the surround sound depth.
    +
    153  * @param depth Depth to set. Defaults to 0x7FFF.
    +
    154  */
    +
    155 void ndspSurroundSetDepth(u16 depth);
    +
    156 
    +
    157 /**
    +
    158  * @brief Sets the surround sound position.
    +
    159  * @param pos Position to set. Defaults to NDSP_SPKPOS_SQUARE.
    +
    160  */
    +
    161 void ndspSurroundSetPos(u16 pos);
    +
    162 
    +
    163 /**
    +
    164  * @brief Sets the surround sound rear ratio.
    +
    165  * @param ratio Rear ratio to set. Defaults to 0x8000.
    166  */
    -
    167 void ndspAuxSetCallback(int id, ndspAuxCallback callback, void* data);
    +
    167 void ndspSurroundSetRearRatio(u16 ratio);
    168 ///@}
    +
    169 
    +
    170 ///@name Auxiliary output
    +
    171 ///@{
    +
    172 /**
    +
    173  * @brief Configures whether an auxiliary output is enabled.
    +
    174  * @param id ID of the auxiliary output.
    +
    175  * @param enable Whether to enable the auxiliary output.
    +
    176  */
    +
    177 void ndspAuxSetEnable(int id, bool enable);
    +
    178 
    +
    179 /**
    +
    180  * @brief Configures whether an auxiliary output should use front bypass.
    +
    181  * @param id ID of the auxiliary output.
    +
    182  * @param bypass Whether to use front bypass.
    +
    183  */
    +
    184 void ndspAuxSetFrontBypass(int id, bool bypass);
    +
    185 
    +
    186 /**
    +
    187  * @brief Sets the volume of an auxiliary output.
    +
    188  * @param id ID of the auxiliary output.
    +
    189  * @param volume Volume to set.
    +
    190  */
    +
    191 void ndspAuxSetVolume(int id, float volume);
    +
    192 
    +
    193 /**
    +
    194  * @brief Sets the callback of an auxiliary output.
    +
    195  * @param id ID of the auxiliary output.
    +
    196  * @param callback Callback to set.
    +
    197  * @param data User-defined data to pass to the callback.
    +
    198  */
    +
    199 void ndspAuxSetCallback(int id, ndspAuxCallback callback, void* data);
    +
    200 ///@}
    +
    NDSP_SPKPOS_NUM
    ?
    Definition: ndsp.h:29
    s8
    int8_t s8
    8-bit signed integer
    Definition: types.h:27
    -
    tag_ndspWaveBuf::data_adpcm
    u8 * data_adpcm
    Pointer to DSPADPCM sample data.
    Definition: ndsp.h:27
    -
    tag_ndspWaveBuf::data_pcm8
    s8 * data_pcm8
    Pointer to PCM8 sample data.
    Definition: ndsp.h:25
    +
    tag_ndspWaveBuf::data_adpcm
    u8 * data_adpcm
    Pointer to DSPADPCM sample data.
    Definition: ndsp.h:59
    +
    NDSP_OUTPUT_SURROUND
    3D Surround sound
    Definition: ndsp.h:14
    +
    tag_ndspWaveBuf::data_pcm8
    s8 * data_pcm8
    Pointer to PCM8 sample data.
    Definition: ndsp.h:57
    Result
    s32 Result
    Function result.
    Definition: types.h:43
    -
    tag_ndspWaveBuf
    Wave buffer struct.
    Definition: ndsp.h:21
    +
    tag_ndspWaveBuf
    Wave buffer struct.
    Definition: ndsp.h:53
    u16
    uint16_t u16
    16-bit unsigned integer
    Definition: types.h:23
    -
    ndspCallback
    void(* ndspCallback)(void *data)
    Sound frame callback function. (data = User provided data)
    Definition: ndsp.h:42
    +
    NDSP_OUTPUT_MONO
    Mono sound.
    Definition: ndsp.h:12
    +
    ndspCallback
    void(* ndspCallback)(void *data)
    Sound frame callback function. (data = User provided data)
    Definition: ndsp.h:74
    ndspExit
    void ndspExit(void)
    Exits NDSP.
    -
    ndspAdpcmData::index
    u16 index
    Current predictor index.
    Definition: ndsp.h:12
    -
    tag_ndspWaveBuf::padding
    u8 padding
    Padding.
    Definition: ndsp.h:35
    +
    NDSP_OUTPUT_STEREO
    Stereo sound.
    Definition: ndsp.h:13
    +
    ndspAdpcmData::index
    u16 index
    Current predictor index.
    Definition: ndsp.h:35
    ndspSetCallback
    void ndspSetCallback(ndspCallback callback, void *data)
    Sets the sound frame callback.
    ndspSetClippingMode
    void ndspSetClippingMode(int mode)
    Sets the clipping mode.
    -
    ndspAdpcmData::history0
    s16 history0
    Last outputted PCM16 sample.
    Definition: ndsp.h:13
    +
    ndspAdpcmData::history0
    s16 history0
    Last outputted PCM16 sample.
    Definition: ndsp.h:36
    ndspSurroundSetPos
    void ndspSurroundSetPos(u16 pos)
    Sets the surround sound position.
    +
    NDSP_CLIP_NORMAL
    "Normal" clipping mode (?)
    Definition: ndsp.h:20
    ndspInit
    Result ndspInit(void)
    Initializes NDSP.
    ndspSetMasterVol
    void ndspSetMasterVol(float volume)
    Sets the master volume.
    +
    NDSP_SPKPOS_SQUARE
    ?
    Definition: ndsp.h:27
    u8
    uint8_t u8
    8-bit unsigned integer
    Definition: types.h:22
    ndspAuxSetCallback
    void ndspAuxSetCallback(int id, ndspAuxCallback callback, void *data)
    Sets the callback of an auxiliary output.
    -
    tag_ndspWaveBuf::looping
    bool looping
    Whether to loop the buffer.
    Definition: ndsp.h:34
    -
    tag_ndspWaveBuf::data_pcm16
    s16 * data_pcm16
    Pointer to PCM16 sample data.
    Definition: ndsp.h:26
    +
    tag_ndspWaveBuf::looping
    bool looping
    Whether to loop the buffer.
    Definition: ndsp.h:66
    +
    tag_ndspWaveBuf::data_pcm16
    s16 * data_pcm16
    Pointer to PCM16 sample data.
    Definition: ndsp.h:58
    ndspSetOutputCount
    void ndspSetOutputCount(int count)
    Sets the output count.
    ndspSurroundSetDepth
    void ndspSurroundSetDepth(u16 depth)
    Sets the surround sound depth.
    -
    tag_ndspWaveBuf::adpcm_data
    ndspAdpcmData * adpcm_data
    ADPCM data.
    Definition: ndsp.h:31
    +
    tag_ndspWaveBuf::adpcm_data
    ndspAdpcmData * adpcm_data
    ADPCM data.
    Definition: ndsp.h:63
    u32
    uint32_t u32
    32-bit unsigned integer
    Definition: types.h:24
    ndspAuxSetVolume
    void ndspAuxSetVolume(int id, float volume)
    Sets the volume of an auxiliary output.
    ndspGetFrameCount
    u32 ndspGetFrameCount(void)
    Gets the total sound frame count.
    ndspAuxSetEnable
    void ndspAuxSetEnable(int id, bool enable)
    Configures whether an auxiliary output is enabled.
    +
    NDSP_WBUF_DONE
    The wave buffer has finished being played.
    Definition: ndsp.h:49
    ndspSetCapture
    void ndspSetCapture(ndspWaveBuf *capture)
    Sets the wave buffer to capture audio to.
    -
    tag_ndspWaveBuf::sequence_id
    u16 sequence_id
    Sequence ID. Assigned automatically by ndspChnWaveBufAdd.
    Definition: ndsp.h:37
    +
    NDSP_WBUF_PLAYING
    The wave buffer is playing right now.
    Definition: ndsp.h:48
    +
    tag_ndspWaveBuf::status
    u8 status
    Queuing/playback status.
    Definition: ndsp.h:67
    +
    tag_ndspWaveBuf::sequence_id
    u16 sequence_id
    Sequence ID. Assigned automatically by ndspChnWaveBufAdd.
    Definition: ndsp.h:69
    +
    NDSP_WBUF_FREE
    The wave buffer is not queued.
    Definition: ndsp.h:46
    ndspSetOutputMode
    void ndspSetOutputMode(int mode)
    Sets the output mode.
    +
    NDSP_CLIP_SOFT
    "Soft" clipping mode (?)
    Definition: ndsp.h:21
    ndspUseComponent
    void ndspUseComponent(const void *binary, u32 size, u16 progMask, u16 dataMask)
    Sets up the DSP component.
    ndspGetDroppedFrames
    u32 ndspGetDroppedFrames(void)
    Gets the number of dropped sound frames.
    -
    tag_ndspWaveBuf::offset
    u32 offset
    Buffer offset. Only used for capture.
    Definition: ndsp.h:33
    -
    ndspAdpcmData::history1
    s16 history1
    Second to last outputted PCM16 sample.
    Definition: ndsp.h:14
    -
    ndspAuxCallback
    void(* ndspAuxCallback)(void *data, int nsamples, void *samples[4])
    Auxiliary output callback function. (data = User provided data, nsamples = Number of samples...
    Definition: ndsp.h:44
    -
    tag_ndspWaveBuf::data_vaddr
    u32 data_vaddr
    Data virtual address.
    Definition: ndsp.h:28
    -
    tag_ndspWaveBuf::next
    ndspWaveBuf * next
    Next buffer to play. Used internally, do not modify.
    Definition: ndsp.h:38
    -
    tag_ndspWaveBuf::nsamples
    u32 nsamples
    Total number of samples (PCM8=bytes, PCM16=halfwords, DSPADPCM=nibbles without frame headers) ...
    Definition: ndsp.h:30
    +
    tag_ndspWaveBuf::offset
    u32 offset
    Buffer offset. Only used for capture.
    Definition: ndsp.h:65
    +
    ndspAdpcmData::history1
    s16 history1
    Second to last outputted PCM16 sample.
    Definition: ndsp.h:37
    +
    ndspAuxCallback
    void(* ndspAuxCallback)(void *data, int nsamples, void *samples[4])
    Auxiliary output callback function. (data = User provided data, nsamples = Number of samples...
    Definition: ndsp.h:76
    +
    tag_ndspWaveBuf::data_vaddr
    u32 data_vaddr
    Data virtual address.
    Definition: ndsp.h:60
    +
    tag_ndspWaveBuf::next
    ndspWaveBuf * next
    Next buffer to play. Used internally, do not modify.
    Definition: ndsp.h:70
    +
    tag_ndspWaveBuf::nsamples
    u32 nsamples
    Total number of samples (PCM8=bytes, PCM16=halfwords, DSPADPCM=nibbles without frame headers) ...
    Definition: ndsp.h:62
    ndspAuxSetFrontBypass
    void ndspAuxSetFrontBypass(int id, bool bypass)
    Configures whether an auxiliary output should use front bypass.
    ndspSurroundSetRearRatio
    void ndspSurroundSetRearRatio(u16 ratio)
    Sets the surround sound rear ratio.
    -
    ndspAdpcmData
    Definition: ndsp.h:10
    +
    NDSP_WBUF_QUEUED
    The wave buffer is queued and has not been played yet.
    Definition: ndsp.h:47
    +
    NDSP_SPKPOS_WIDE
    ?
    Definition: ndsp.h:28
    +
    ndspAdpcmData
    ADPCM data.
    Definition: ndsp.h:33
    s16
    int16_t s16
    16-bit signed integer
    Definition: types.h:28
    diff --git a/structDebugEventInfo.html b/structDebugEventInfo.html index c3adc8d..855e4a8 100644 --- a/structDebugEventInfo.html +++ b/structDebugEventInfo.html @@ -109,46 +109,46 @@ Data Fields u32 unknown [2]  Unknown data.
      - + union { - +    ProcessEvent   process - Process event data.
    -  - + Process event data.
    +  +    CreateThreadEvent   create_thread - Thread creation event data.
    -  - + Thread creation event data.
    +  +    ExitThreadEvent   exit_thread - Thread exit event data.
    -  - + Thread exit event data.
    +  +    ExitProcessEvent   exit_process - Process exit event data.
    -  - + Process exit event data.
    +  +    ExceptionEvent   exception - Exception event data.
    -  - + Exception event data.
    +  +    SchedulerInOutEvent   scheduler - Schedule in/out event data.
    -  - + Schedule in/out event data.
    +  +    SyscallInOutEvent   syscall - Syscall in/out event data.
    -  - + Syscall in/out event data.
    +  +    OutputStringEvent   output_string - Output string event data.
    -  - + Output string event data.
    +  +    MapEvent   map - Map event data.
    -  -};  -  + Map event data.
    +  +};  + 

    Detailed Description

    Information about a debug event.

    diff --git a/structndspAdpcmData.html b/structndspAdpcmData.html index a3b8099..a1f07b5 100644 --- a/structndspAdpcmData.html +++ b/structndspAdpcmData.html @@ -89,6 +89,11 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
    ndspAdpcmData Struct Reference
    + +

    ADPCM data. + More...

    + +

    #include <ndsp.h>

    @@ -105,7 +110,9 @@ Data Fields

    Data Fields

     Second to last outputted PCM16 sample.
     
    -
    The documentation for this struct was generated from the following file:
      +

      Detailed Description

      +

      ADPCM data.

      +
      The documentation for this struct was generated from the following file:
    diff --git a/structtag__ndspWaveBuf.html b/structtag__ndspWaveBuf.html index d5db700..ce20aa2 100644 --- a/structtag__ndspWaveBuf.html +++ b/structtag__ndspWaveBuf.html @@ -97,26 +97,26 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); - - - - - + + - - - + + - - - + + - - - - + + + + @@ -133,10 +133,10 @@ union { bool  - - - + + + diff --git a/unionCSND__CapInfo.html b/unionCSND__CapInfo.html index b8759c4..27aea30 100644 --- a/unionCSND__CapInfo.html +++ b/unionCSND__CapInfo.html @@ -101,26 +101,26 @@ Data Fieldsu32  - - - - - + + - - - + + - - - + + - - - - + + + +

    Data Fields

    +
    union {
    +
       s8 *   data_pcm8
     Pointer to PCM8 sample data.
     
    +
     Pointer to PCM8 sample data.
     
       s16 *   data_pcm16
     Pointer to PCM16 sample data.
     
    +
     Pointer to PCM16 sample data.
     
       u8 *   data_adpcm
     Pointer to DSPADPCM sample data.
     
    +
     Pointer to DSPADPCM sample data.
     
       u32   data_vaddr
     Data virtual address.
     
    }; 
     
     Data virtual address.
     
    }; 
     
    u32 nsamples
     Total number of samples (PCM8=bytes, PCM16=halfwords, DSPADPCM=nibbles without frame headers)
    looping
     Whether to loop the buffer.
     
    -u8 padding
     Padding.
     
    +u8 status
     Queuing/playback status.
     
    u16 sequence_id
     Sequence ID. Assigned automatically by ndspChnWaveBufAdd.
    value [2]
     Raw values.
     
    +
    struct {
    +
       u8   active
     Capture active.
     
    +
     Capture active.
     
       u8   _pad1
     Padding.
     
    +
     Padding.
     
       u16   _pad2
     Padding.
     
    +
     Padding.
     
       u32   unknownZero
     Unknown.
     
    }; 
     
     Unknown.
     
    }; 
     

    Detailed Description

    Capture info.

    diff --git a/unionCSND__ChnInfo.html b/unionCSND__ChnInfo.html index 5935f75..43e2d67 100644 --- a/unionCSND__ChnInfo.html +++ b/unionCSND__ChnInfo.html @@ -101,38 +101,38 @@ Data Fields u32 value [3]  Raw values.
      - + struct { - +    u8   active - Channel active.
    -  - + Channel active.
    +  +    u8   _pad1 - Padding.
    -  - + Padding.
    +  +    u16   _pad2 - Padding.
    -  - + Padding.
    +  +    s16   adpcmSample - Current ADPCM sample.
    -  - + Current ADPCM sample.
    +  +    u8   adpcmIndex - Current ADPCM index.
    -  - + Current ADPCM index.
    +  +    u8   _pad3 - Padding.
    -  - + Padding.
    +  +    u32   unknownZero - Unknown.
    -  -};  -  + Unknown.
    +  +};  + 

    Detailed Description

    Channel info.