diff options
Diffstat (limited to 'engines/sci/sfx/core.h')
| -rw-r--r-- | engines/sci/sfx/core.h | 228 |
1 files changed, 119 insertions, 109 deletions
diff --git a/engines/sci/sfx/core.h b/engines/sci/sfx/core.h index 1f2f53a051..2c327e1f6d 100644 --- a/engines/sci/sfx/core.h +++ b/engines/sci/sfx/core.h @@ -58,116 +58,126 @@ public: // FIXME, make private uint _debug; /**< Debug flags */ ResourceSync *_soundSync; /**< Used by kDoSync for speech syncing in CD talkie games */ AudioResource *_audioResource; /**< Used for audio resources in CD talkie games */ -}; - -/***********/ -/* General */ -/***********/ - -/* Initializes the sound engine -** Parameters: (ResourceManager *) resmgr: Resource manager for initialization -** (int) flags: SFX_STATE_FLAG_* -*/ -void sfx_init(SfxState *self, ResourceManager *resmgr, int flags); - -/** Deinitializes the sound subsystem. */ -void sfx_exit(SfxState *self); - -/* Suspends/unsuspends the sound sybsystem -** Parameters: (int) suspend: Whether to suspend (non-null) or to unsuspend -*/ -void sfx_suspend(SfxState *self, int suspend); - -/* Polls the sound server for cues etc. -** Returns : (int) 0 if the cue queue is empty, SI_LOOP, SI_CUE, or SI_FINISHED otherwise -** (song_handle_t) *handle: The affected handle -** (int) *cue: The sound cue number (if SI_CUE), or the loop number (if SI_LOOP) -*/ -int sfx_poll(SfxState *self, song_handle_t *handle, int *cue); - -/* Polls the sound server for cues etc. -** Parameters: (song_handle_t) handle: The handle to poll -** Returns : (int) 0 if the cue queue is empty, SI_LOOP, SI_CUE, or SI_FINISHED otherwise -** (int) *cue: The sound cue number (if SI_CUE), or the loop number (if SI_LOOP) -*/ -int sfx_poll_specific(SfxState *self, song_handle_t handle, int *cue); - -/* Determines the current global volume settings -** Returns : (int) The global volume, between 0 (silent) and 127 (max. volume) -*/ -int sfx_get_volume(SfxState *self); - -/* Determines the current global volume settings -** Parameters: (int) volume: The new global volume, between 0 and 127 (see above) -*/ -void sfx_set_volume(SfxState *self, int volume); - -/* Stops all songs currently playing, purges song library -*/ -void sfx_all_stop(SfxState *self); - - -/*****************/ -/* Song basics */ -/*****************/ - -/* Adds a song to the internal sound library -** Parameters: (SongIterator *) it: The iterator describing the song -** (int) priority: Initial song priority (higher <-> more important) -** (song_handle_t) handle: The handle to associate with the song -** Returns : (int) 0 on success, nonzero on error -*/ -int sfx_add_song(SfxState *self, SongIterator *it, int priority, song_handle_t handle, int resnum); - - -/* Deletes a song and its associated song iterator from the song queue -** Parameters: (song_handle_t) handle: The song to remove -*/ -void sfx_remove_song(SfxState *self, song_handle_t handle); - - -/**********************/ -/* Song modifications */ -/**********************/ - - -/* Sets the song status, i.e. whether it is playing, suspended, or stopped. -** Parameters: (song_handle_t) handle: Handle of the song to modify -** (int) status: The song status the song should assume -** WAITING and PLAYING are set implicitly and essentially describe the same state -** as far as this function is concerned. -*/ -void sfx_song_set_status(SfxState *self, song_handle_t handle, int status); - -/* Sets the new song priority -** Parameters: (song_handle_t) handle: The handle to modify -** (int) priority: The priority to set -*/ -void sfx_song_renice(SfxState *self, song_handle_t handle, int priority); - -/* Sets the number of loops for the specified song -** Parameters: (song_handle_t) handle: The song handle to reference -** (int) loops: Number of loops to set -*/ -void sfx_song_set_loops(SfxState *self, song_handle_t handle, int loops); - -/* Sets the number of loops for the specified song -** Parameters: (song_handle_t) handle: The song handle to reference -** (int) hold: Number of loops to setn -*/ -void sfx_song_set_hold(SfxState *self, song_handle_t handle, int hold); - -/* Instructs a song to be faded out -** Parameters: (song_handle_t) handle: The song handle to reference -** (fade_params_t *) fade_setup: The precise fade-out configuration to use -*/ -void sfx_song_set_fade(SfxState *self, song_handle_t handle, fade_params_t *fade_setup); - - -// Previously undocumented: -Common::Error sfx_send_midi(SfxState *self, song_handle_t handle, int channel, - int command, int arg1, int arg2); +public: + /***********/ + /* General */ + /***********/ + + /* Initializes the sound engine + ** Parameters: (ResourceManager *) resmgr: Resource manager for initialization + ** (int) flags: SFX_STATE_FLAG_* + */ + void sfx_init(ResourceManager *resmgr, int flags); + + /** Deinitializes the sound subsystem. */ + void sfx_exit(); + + /* Suspends/unsuspends the sound sybsystem + ** Parameters: (int) suspend: Whether to suspend (non-null) or to unsuspend + */ + void sfx_suspend(bool suspend); + + /* Polls the sound server for cues etc. + ** Returns : (int) 0 if the cue queue is empty, SI_LOOP, SI_CUE, or SI_FINISHED otherwise + ** (song_handle_t) *handle: The affected handle + ** (int) *cue: The sound cue number (if SI_CUE), or the loop number (if SI_LOOP) + */ + int sfx_poll(song_handle_t *handle, int *cue); + + /* Polls the sound server for cues etc. + ** Parameters: (song_handle_t) handle: The handle to poll + ** Returns : (int) 0 if the cue queue is empty, SI_LOOP, SI_CUE, or SI_FINISHED otherwise + ** (int) *cue: The sound cue number (if SI_CUE), or the loop number (if SI_LOOP) + */ + int sfx_poll_specific(song_handle_t handle, int *cue); + + /* Determines the current global volume settings + ** Returns : (int) The global volume, between 0 (silent) and 127 (max. volume) + */ + int sfx_get_volume(); + + /* Determines the current global volume settings + ** Parameters: (int) volume: The new global volume, between 0 and 127 (see above) + */ + void sfx_set_volume(int volume); + + /* Stops all songs currently playing, purges song library + */ + void sfx_all_stop(); + + + /*****************/ + /* Song basics */ + /*****************/ + + /* Adds a song to the internal sound library + ** Parameters: (SongIterator *) it: The iterator describing the song + ** (int) priority: Initial song priority (higher <-> more important) + ** (song_handle_t) handle: The handle to associate with the song + ** Returns : (int) 0 on success, nonzero on error + */ + int sfx_add_song(SongIterator *it, int priority, song_handle_t handle, int resnum); + + + /* Deletes a song and its associated song iterator from the song queue + ** Parameters: (song_handle_t) handle: The song to remove + */ + void sfx_remove_song(song_handle_t handle); + + + /**********************/ + /* Song modifications */ + /**********************/ + + + /* Sets the song status, i.e. whether it is playing, suspended, or stopped. + ** Parameters: (song_handle_t) handle: Handle of the song to modify + ** (int) status: The song status the song should assume + ** WAITING and PLAYING are set implicitly and essentially describe the same state + ** as far as this function is concerned. + */ + void sfx_song_set_status(song_handle_t handle, int status); + + /* Sets the new song priority + ** Parameters: (song_handle_t) handle: The handle to modify + ** (int) priority: The priority to set + */ + void sfx_song_renice(song_handle_t handle, int priority); + + /* Sets the number of loops for the specified song + ** Parameters: (song_handle_t) handle: The song handle to reference + ** (int) loops: Number of loops to set + */ + void sfx_song_set_loops(song_handle_t handle, int loops); + + /* Sets the number of loops for the specified song + ** Parameters: (song_handle_t) handle: The song handle to reference + ** (int) hold: Number of loops to setn + */ + void sfx_song_set_hold(song_handle_t handle, int hold); + + /* Instructs a song to be faded out + ** Parameters: (song_handle_t) handle: The song handle to reference + ** (fade_params_t *) fade_setup: The precise fade-out configuration to use + */ + void sfx_song_set_fade(song_handle_t handle, fade_params_t *fade_setup); + + + // Previously undocumented: + Common::Error sfx_send_midi(song_handle_t handle, int channel, + int command, int arg1, int arg2); + +protected: + void freezeTime(); + void thawTime(); + + bool isPlaying(song_t *song); + void setSongStatus(song_t *song, int status); + void updateSingleSong(); + void updateMultiSong(); + void update(); +}; } // End of namespace Sci |