| Function uFMOD_ALSAPlayFile(filename:String,dwReserved,dwFlags,szPCM_dev:String) | |
| Description | Loads the given XM song and starts playing it immediately, unless XM_SUSPENDED is specified. It will stop any currently playing song before loading the new one. |
| Parameters |
filename A string that specifies the name of the file. dwReserved Reserved for possible future use; should be zero. dwFlags Additional flags, controlling the playback. The following values are defined:
XM_NOLOOP An XM track plays repeatedly by default. Specify
this flag to play it only once.
XM_SUSPENDED The XM track is loaded in a suspended state,
and will not play until the uFMOD_ALSAResume function
is called. This is useful for preloading a song
or testing an XM track for validity.
Set to zero, if not using any special flags.szPCM_dev ASCII identifier of the ALSA PCM device. Check the ALSA documentation for a complete reference of valid PCM device names. "plughw:0,0" should work fine for most applications. |
| Returns | On success, returns a PCM device handle. Returns 0 on error. |
| Remarks | If no valid song is specified and there is one currently being played, uFMOD_ALSAPlayFile just stops playback. So, you can call uFMOD_ALSAPlayFile(0, 0, 0, 0) instead of uFMOD_ALSAStop. |
| Function uFMOD_ALSAPlayMem(pXM:Byte Ptr,length,dwFlags,szPCM_dev:String) | |
| Description | Loads the XM song contained in the pXM memory buffer and starts playing it immediately, unless XM_SUSPENDED is specified. It will stop any currently playing song before loading the new one. |
| Parameters |
pXM Points to an image of a song in memory. length Size of the image in bytes. dwFlags Additional flags, controlling the playback. The following values are defined:
XM_NOLOOP An XM track plays repeatedly by default. Specify
this flag to play it only once.
XM_SUSPENDED The XM track is loaded in a suspended state,
and will not play until the uFMOD_ALSAResume function
is called. This is useful for preloading a song
or testing an XM track for validity.
Set to zero, if not using any special flags.szPCM_dev ASCII identifier of the ALSA PCM device. Check the ALSA documentation for a complete reference of valid PCM device names. "plughw:0,0" should work fine for most applications. |
| Returns | On success, returns a PCM device handle. Returns 0 on error. |
| Remarks | If no valid song is specified and there is one currently being played, uFMOD_ALSAPlayMem just stops playback. So, you can call uFMOD_ALSAPlayMem(0, 0, 0, 0) instead of uFMOD_ALSAStop. |
| Function uFMOD_ALSAStop() | |
| Description | Stops the currently playing song, if any. |
| Function uFMOD_ALSAPause() | |
| Description | Pauses the currently playing song, if any. |
| Remarks | While paused you can still control the volume (uFMOD_ALSASetVolume) and the pattern order (uFMOD_ALSAJump2Pattern). The RMS volume coefficients (uFMOD_ALSAGetStats) will go down to 0 and the progress tracker (uFMOD_ALSAGetTime) will "freeze" while the song is paused. uFMOD_ALSAPause doesn't perform the request immediately. Instead, it signals to pause when playback reaches next chunk of data, which may take up to about 40ms. This way, uFMOD_ALSAPause performs asynchronously and returns very fast. It is not cumulative. So, calling uFMOD_ALSAPause many times in a row has the same effect as calling it once. If you need synchronous hardware-driven pause/resuming, you can use the snd_pcm_pause API function. |
| Function uFMOD_ALSAResume() | |
| Description | Resumes the currently paused song, if any. |
| Remarks | uFMOD_ALSAResume doesn't perform the request immediately. Instead, it signals to resume when an internal thread gets a time slice, which may take some milliseconds to happen. uFMOD_ALSAResume is not cumulative. So, calling it many times in a row has the same effect as calling it once. If you need synchronous hardware-driven pause/resuming, you can use the snd_pcm_pause API function. |
| Function uFMOD_ALSAGetStats() | |
| Description | Returns the current RMS volume coefficients in (L)eft and (R)ight channels.low-order word: RMS volume in R channel hi-order word: RMS volume in L channelRange from 0 (silence) to $7FFF (maximum) on each channel. |
| Remarks | This function is useful for updating a VU meter. It's recommended to rescale the output to log10 (decibels or dB for short), because human ears track volume changes in a dB scale. You may call uFMOD_ALSAGetStats() as often as you like, but take in mind that uFMOD updates both channel RMS volumes every 20-40ms, depending on the output sampling rate. So, calling uFMOD_ALSAGetStats about 16 times a second whould be quite enough to track volume changes very closely. |
| Function uFMOD_ALSAGetRowOrder() | |
| Description | Returns the currently playing row and order.low-order word: row hi-order word: order |
| Remarks | This function is useful for synchronization. uFMOD updates both row and order values every 20-40ms, depending on the output sampling rate. So, calling uFMOD_ALSAGetRowOrder about 16 times a second whould be quite enough to track row and order progress very closely. |
| Function uFMOD_ALSAGetTime() | |
| Description | Returns the time in milliseconds since the song was started. |
| Remarks | This function is useful for synchronizing purposes. Multimedia applications can use uFMOD_ALSAGetTime to synchronize GFX to sound, for example. An XM player can use this function to update a progress meter. |
| Example | A simple way to pack an 'HH:MM:SS' progress meter:Function HHMMSS$() Local iss:Int = uFMOD_ALSAGetTime() / 1000 Local mm$ = (iss / 60) Mod 60 Local hh$ = (iss / 360) Mod 24 Local ss$ = iss Mod 60 If Len ss$ = 1 ss$ = "0" + ss$ If Len mm$ = 1 mm$ = "0" + mm$ If Len hh$ = 1 hh$ = "0" + hh$ Return hh$ + ":" + mm$ + ":" + ss$ EndFunction |
| Function uFMOD_ALSAGetTitle$() | |
| Description | Returns the current song's title. |
| Remarks | Not every song has a title, so be prepared to get an empty string. A proper way to handle such a situation is shown in the following example. |
| Example | title$ = Trim(uFMOD_ALSAGetTitle()) If Len title$ = 0 title$ = "This song has no title" |
| Function uFMOD_ALSASetVolume(vol) | |
| Description | Sets the global volume. The volume scale is linear. |
| Parameters |
vol New volume. Range: from uFMOD_MIN_VOL (muting) to uFMOD_MAX_VOL (maximum volume). Any value above uFMOD_MAX_VOL maps to maximum volume. |
| Remarks | uFMOD internally converts the given values to a logarithmic scale (dB). Maximum volume is set by default. The volume value is preserved across uFMOD_ALSAPlay* calls. You can set the desired volume level before actually starting to play a song. |
| Example | A simple fading effect:
For i = 20 To 0 Step -4
uFMOD_ALSASetVolume(i)
Delay 20
Next
|
| Function uFMOD_ALSAJump2Pattern(pat) | |
| Description | Jumps to the specified pattern index. |
| Parameters |
pat Next zero based pattern index. |
| Remarks | uFMOD doesn't automatically perform Note Off effects before jumping to the target pattern. In other words, the original pattern will remain in the mixer until it fades out. You can use this feature to your advantage. If you don't like it, just insert leading Note Off commands in all patterns intended to be used as uFMOD_ALSAJump2Pattern targets. if the pattern index lays outside of the bounds of the pattern order table, calling this function jumps to pattern 0, effectively rewinding playback. You can implement uFMOD_ALSARewind as a call to uFMOD_ALSAJump2Pattern(0). |