diff options
author | Strangerke | 2012-05-21 23:53:13 +0200 |
---|---|---|
committer | Strangerke | 2012-05-21 23:54:32 +0200 |
commit | 94d3c8ebb29699a6c7a76c08986b984523761d63 (patch) | |
tree | bbcbb59e39a95b76a65cbd44bfd382f4a82e74e3 /engines/tony/sound.h | |
parent | 6856fa2447195e8a65f6d5c7efa73543668d85b0 (diff) | |
download | scummvm-rg350-94d3c8ebb29699a6c7a76c08986b984523761d63.tar.gz scummvm-rg350-94d3c8ebb29699a6c7a76c08986b984523761d63.tar.bz2 scummvm-rg350-94d3c8ebb29699a6c7a76c08986b984523761d63.zip |
TONY: Some more code formatting
Diffstat (limited to 'engines/tony/sound.h')
-rw-r--r-- | engines/tony/sound.h | 680 |
1 files changed, 340 insertions, 340 deletions
diff --git a/engines/tony/sound.h b/engines/tony/sound.h index bfa48f4d78..7defeb1149 100644 --- a/engines/tony/sound.h +++ b/engines/tony/sound.h @@ -73,144 +73,144 @@ private: DSCAPS dscaps; HWND hwnd; -/****************************************************************************\ -* Metodi -\****************************************************************************/ + /****************************************************************************\ + * Metodi + \****************************************************************************/ public: -/****************************************************************************\ -* -* Function: FPSOUND::FPSOUND(); -* -* Description: Costruttore di default. Inizializza gli attributi. -* -\****************************************************************************/ + /****************************************************************************\ + * + * Function: FPSOUND::FPSOUND(); + * + * Description: Costruttore di default. Inizializza gli attributi. + * + \****************************************************************************/ FPSOUND(); -/****************************************************************************\ -* -* Function: FPSOUND::~FPSOUND(); -* -* Description: Deinizializza l'oggetto, disallocando la memoria. -* -\****************************************************************************/ + /****************************************************************************\ + * + * Function: FPSOUND::~FPSOUND(); + * + * Description: Deinizializza l'oggetto, disallocando la memoria. + * + \****************************************************************************/ ~FPSOUND(); -/****************************************************************************\ -* -* Function: bool FPSOUND::Init(HWND hWnd); -* -* Description: Inizializza l'oggetto, e prepara tutto il necessario per -* creare stream e effetti sonori. -* -* Input: HWND hWnd Handle della finestra principale -* -* Return: True se tutto OK, FALSE in caso di errore. -* -\****************************************************************************/ + /****************************************************************************\ + * + * Function: bool FPSOUND::Init(HWND hWnd); + * + * Description: Inizializza l'oggetto, e prepara tutto il necessario per + * creare stream e effetti sonori. + * + * Input: HWND hWnd Handle della finestra principale + * + * Return: True se tutto OK, FALSE in caso di errore. + * + \****************************************************************************/ bool Init(/*HWND hWnd*/); -/****************************************************************************\ -* -* Function: bool CreateStream(FPSTREAM** lplpStream); -* -* Description: Alloca un oggetti di tipo FPSTREAM, e ritorna il suo -* puntatore dopo averlo inizializzato. -* -* Input: FPSTREAM** lplpStream Conterra' il pointer all'oggetto -* appena creato. -* -* Return: TRUE se tutto OK, FALSE in caso di errore -* -* Note: L'utilizzo di funzioni del tipo CreateStream(), CreateSfx(), -* sono dovute al fatto che i costruttori delle classi FPSTREAM -* e FPSFX richiedono che DirectSound sia gia' stato -* inzializzato. In questo modo quindi si evitano dei bugs -* che si verrebbero a creare se venisse dichiarata un oggetto -* di tipo FPSTREAM o FPSFX globale (o cmq prima della -* inizializzazione di DirectSound). -* -\****************************************************************************/ + /****************************************************************************\ + * + * Function: bool CreateStream(FPSTREAM** lplpStream); + * + * Description: Alloca un oggetti di tipo FPSTREAM, e ritorna il suo + * puntatore dopo averlo inizializzato. + * + * Input: FPSTREAM** lplpStream Conterra' il pointer all'oggetto + * appena creato. + * + * Return: TRUE se tutto OK, FALSE in caso di errore + * + * Note: L'utilizzo di funzioni del tipo CreateStream(), CreateSfx(), + * sono dovute al fatto che i costruttori delle classi FPSTREAM + * e FPSFX richiedono che DirectSound sia gia' stato + * inzializzato. In questo modo quindi si evitano dei bugs + * che si verrebbero a creare se venisse dichiarata un oggetto + * di tipo FPSTREAM o FPSFX globale (o cmq prima della + * inizializzazione di DirectSound). + * + \****************************************************************************/ bool CreateStream(FPSTREAM **lplpStream); -/****************************************************************************\ -* -* Function: bool CreateSfx(FPSFX** lplpSfx); -* -* Description: Alloca un oggetti di tipo FPSFX e ritorna il suo -* puntatore dopo averlo inizializzato. -* -* Input: FPSFX** lplpSfx Conterra' il pointer all'oggetto -* appena creato. -* -* Return: TRUE se tutto OK, FALSE in caso di errore -* -* Note: Vedi le note di CreateStream() -* -\****************************************************************************/ + /****************************************************************************\ + * + * Function: bool CreateSfx(FPSFX** lplpSfx); + * + * Description: Alloca un oggetti di tipo FPSFX e ritorna il suo + * puntatore dopo averlo inizializzato. + * + * Input: FPSFX** lplpSfx Conterra' il pointer all'oggetto + * appena creato. + * + * Return: TRUE se tutto OK, FALSE in caso di errore + * + * Note: Vedi le note di CreateStream() + * + \****************************************************************************/ bool CreateSfx(FPSFX **lplpSfx); -/****************************************************************************\ -* -* Function: void SetMasterVolume(int dwVolume); -* -* Description: Setta il volume generale -* -* Input: int dwVolume Volume da settare (0-63) -* -\****************************************************************************/ + /****************************************************************************\ + * + * Function: void SetMasterVolume(int dwVolume); + * + * Description: Setta il volume generale + * + * Input: int dwVolume Volume da settare (0-63) + * + \****************************************************************************/ void SetMasterVolume(int dwVolume); -/****************************************************************************\ -* -* Function: void GetMasterVolume(LPINT lpdwVolume); -* -* Description: Richiede il volume generale -* -* Input: LPINT lpdwVolume Variabile che conterra' il volume (0-63) -* -\****************************************************************************/ + /****************************************************************************\ + * + * Function: void GetMasterVolume(LPINT lpdwVolume); + * + * Description: Richiede il volume generale + * + * Input: LPINT lpdwVolume Variabile che conterra' il volume (0-63) + * + \****************************************************************************/ void GetMasterVolume(int *lpdwVolume); }; class FPSFX { -/****************************************************************************\ -* Attributi -\****************************************************************************/ + /****************************************************************************\ + * Attributi + \****************************************************************************/ private: -/* - HWND hwnd; - LPDIRECTSOUND lpDS; - LPDIRECTSOUNDBUFFER lpDSBuffer; // Buffer DirectSound -*/ + /* + HWND hwnd; + LPDIRECTSOUND lpDS; + LPDIRECTSOUNDBUFFER lpDSBuffer; // Buffer DirectSound + */ bool bSoundSupported; // TRUE se il suono e' attivo bool bFileLoaded; // TRUE se e' stato aperto un file bool bLoop; // TRUE se bisogna loopare l'effetto sonoro bool bPaused; int lastVolume; - bool bStereo; // TRUE se è stereo - bool b16bit; // TRUE se è 16 bit - uint32 dwFreq; // Frequenza originale di campionamento + bool bStereo; // TRUE se è stereo + bool b16bit; // TRUE se è 16 bit + uint32 dwFreq; // Frequenza originale di campionamento // CODEC* lpCodec; // CODEC da utilizzare. bool bIsPlaying; // TRUE se si sta playando l'effetto sonoro @@ -219,178 +219,178 @@ private: // LPDIRECTSOUNDNOTIFY lpDSNotify; // Notify degli hotspot nel buffer // DSBPOSITIONNOTIFY dspnHot[2]; - + public: uint32 hEndOfBuffer; private: -/****************************************************************************\ -* Metodi -\****************************************************************************/ + /****************************************************************************\ + * Metodi + \****************************************************************************/ public: -/****************************************************************************\ -* -* Function: FPSFX(LPDIRECTSOUND lpDS, bool bSoundOn); -* -* Description: Costruttore di default. *NON* bisogna dichiarare direttamente -* un oggetto, ma crearlo piuttosto tramite FPSOUND::CreateSfx() -* -\****************************************************************************/ - - FPSFX(void * /*LPDIRECTSOUND */lpDS, uint32 /*HWND*/ hwnd, bool bSoundOn); - - -/****************************************************************************\ -* -* Function: ~FPSFX(); -* -* Description: Distruttore di default. Si preoccupa anche di fermare il sound -* effect eventualmente in esecuzione, e disallocare la memoria -* da esso occupata. -* -\****************************************************************************/ - - ~FPSFX(); - + /****************************************************************************\ + * + * Function: FPSFX(LPDIRECTSOUND lpDS, bool bSoundOn); + * + * Description: Costruttore di default. *NON* bisogna dichiarare direttamente + * un oggetto, ma crearlo piuttosto tramite FPSOUND::CreateSfx() + * + \****************************************************************************/ + + FPSFX(void * /*LPDIRECTSOUND */lpDS, uint32 /*HWND*/ hwnd, bool bSoundOn); + + + /****************************************************************************\ + * + * Function: ~FPSFX(); + * + * Description: Distruttore di default. Si preoccupa anche di fermare il sound + * effect eventualmente in esecuzione, e disallocare la memoria + * da esso occupata. + * + \****************************************************************************/ + + ~FPSFX(); + + + /****************************************************************************\ + * + * Function: Release(); + * + * Description: Rilascia la memoria dell'oggetto. Deve essere richiamata quando + * l'oggetto non serve piu' e **SOLO SE** l'oggetto e' stato + * creato con la FPSOUND::CreateStream(). + * + * Note: Eventuali puntatori all'oggetto non sono piu' validi dopo + * questa chiamata. + * + \****************************************************************************/ -/****************************************************************************\ -* -* Function: Release(); -* -* Description: Rilascia la memoria dell'oggetto. Deve essere richiamata quando -* l'oggetto non serve piu' e **SOLO SE** l'oggetto e' stato -* creato con la FPSOUND::CreateStream(). -* -* Note: Eventuali puntatori all'oggetto non sono piu' validi dopo -* questa chiamata. -* -\****************************************************************************/ - - void Release(); + void Release(); -/****************************************************************************\ -* -* Function: bool LoadFile(char *lpszFileName, uint32 dwCodec=FPCODEC_RAW); -* -* Description: Apre un file di effetto sonoro e lo carica. -* -* Input: char *lpszFile Nome del file di sfx da aprire -* uint32 dwCodec CODEC da utilizzare per decomprimere -* i campioni sonori -* -* Return: TRUE se tutto OK, FALSE in caso di errore -* -\****************************************************************************/ + /****************************************************************************\ + * + * Function: bool LoadFile(char *lpszFileName, uint32 dwCodec=FPCODEC_RAW); + * + * Description: Apre un file di effetto sonoro e lo carica. + * + * Input: char *lpszFile Nome del file di sfx da aprire + * uint32 dwCodec CODEC da utilizzare per decomprimere + * i campioni sonori + * + * Return: TRUE se tutto OK, FALSE in caso di errore + * + \****************************************************************************/ bool LoadFile(const char *lpszFileName, uint32 dwCodec = FPCODEC_RAW); bool LoadFile(byte *lpBuf, uint32 dwCodec); bool LoadVoiceFromVDB(Common::File &vdbFP); -/****************************************************************************\ -* -* Function: bool Play(); -* -* Description: Suona lo sfx caricato. -* -* Return: TRUE se tutto OK, FALSE in caso di errore. -* -\****************************************************************************/ + /****************************************************************************\ + * + * Function: bool Play(); + * + * Description: Suona lo sfx caricato. + * + * Return: TRUE se tutto OK, FALSE in caso di errore. + * + \****************************************************************************/ - bool Play(); + bool Play(); -/****************************************************************************\ -* -* Function: bool Stop(); -* -* Description: Ferma il play dello sfx. -* -* Return: TRUE se tutto OK, FALSE in caso di errore. -* -\****************************************************************************/ + /****************************************************************************\ + * + * Function: bool Stop(); + * + * Description: Ferma il play dello sfx. + * + * Return: TRUE se tutto OK, FALSE in caso di errore. + * + \****************************************************************************/ - bool Stop(); + bool Stop(); -/****************************************************************************\ -* -* Function: void Pause(bool bPause); -* -* Description: Pause dell'effetto sonoro -* -\****************************************************************************/ + /****************************************************************************\ + * + * Function: void Pause(bool bPause); + * + * Description: Pause dell'effetto sonoro + * + \****************************************************************************/ - void Pause(bool bPause); + void Pause(bool bPause); -/****************************************************************************\ -* -* Function: bool SetLoop(bool bLoop); -* -* Description: Attiva o disattiva il loop dello sfx. -* -* Input: bool bLoop TRUE per attivare il loop, FALSE per -* disattivarlo -* -* Note: Il loop deve essere attivato PRIMA di eseguire il play -* dello sfx. Qualsiasi modifica effettuata durante il play -* non avra' effetto fino a che lo sfx non viene fermato, -* e poi rimesso in play. -* -\****************************************************************************/ + /****************************************************************************\ + * + * Function: bool SetLoop(bool bLoop); + * + * Description: Attiva o disattiva il loop dello sfx. + * + * Input: bool bLoop TRUE per attivare il loop, FALSE per + * disattivarlo + * + * Note: Il loop deve essere attivato PRIMA di eseguire il play + * dello sfx. Qualsiasi modifica effettuata durante il play + * non avra' effetto fino a che lo sfx non viene fermato, + * e poi rimesso in play. + * + \****************************************************************************/ - void SetLoop(bool bLoop); + void SetLoop(bool bLoop); -/****************************************************************************\ -* -* Function: void SetVolume(int dwVolume); -* -* Description: Cambia il volume dello sfx -* -* Input: int dwVolume Volume da settare (0-63) -* -\****************************************************************************/ + /****************************************************************************\ + * + * Function: void SetVolume(int dwVolume); + * + * Description: Cambia il volume dello sfx + * + * Input: int dwVolume Volume da settare (0-63) + * + \****************************************************************************/ - void SetVolume(int dwVolume); + void SetVolume(int dwVolume); -/****************************************************************************\ -* -* Function: void GetVolume(int * lpdwVolume); -* -* Description: Chiede il volume dello sfx -* -* Input: int * lpdwVolume Variabile in cui verra' inserito -* il volume corrente -* -\****************************************************************************/ + /****************************************************************************\ + * + * Function: void GetVolume(int * lpdwVolume); + * + * Description: Chiede il volume dello sfx + * + * Input: int * lpdwVolume Variabile in cui verra' inserito + * il volume corrente + * + \****************************************************************************/ - void GetVolume(int * lpdwVolume); + void GetVolume(int *lpdwVolume); }; class FPSTREAM { -/****************************************************************************\ -* Attributi -\****************************************************************************/ + /****************************************************************************\ + * Attributi + \****************************************************************************/ private: -/* - HWND hwnd; - LPDIRECTSOUND lpDS; - LPDIRECTSOUNDBUFFER lpDSBuffer; // Buffer DirectSound circolare - LPDIRECTSOUNDNOTIFY lpDSNotify; // Notify degli hotspot nel buffer -*/ + /* + HWND hwnd; + LPDIRECTSOUND lpDS; + LPDIRECTSOUNDBUFFER lpDSBuffer; // Buffer DirectSound circolare + LPDIRECTSOUNDNOTIFY lpDSNotify; // Notify degli hotspot nel buffer + */ byte *lpTempBuffer; // Buffer temporaneo per decompressione uint32 dwBufferSize; // Dimensione del buffer in bytes @@ -424,171 +424,171 @@ private: static void PlayThread(FPSTREAM *This); -/****************************************************************************\ -* Metodi -\****************************************************************************/ + /****************************************************************************\ + * Metodi + \****************************************************************************/ public: -/****************************************************************************\ -* -* Function: FPSTREAM(LPDIRECTSOUND lpDS, bool bSoundOn); -* -* Description: Costruttore di default. *NON* bisogna dichiarare direttamente -* un oggetto, ma crearlo piuttosto tramite FPSOUND::CreateStream() -* -\****************************************************************************/ + /****************************************************************************\ + * + * Function: FPSTREAM(LPDIRECTSOUND lpDS, bool bSoundOn); + * + * Description: Costruttore di default. *NON* bisogna dichiarare direttamente + * un oggetto, ma crearlo piuttosto tramite FPSOUND::CreateStream() + * + \****************************************************************************/ FPSTREAM(void * /*LPDIRECTSOUND*/ lpDS, uint32 /*HWND hWnd */, bool bSoundOn); -/****************************************************************************\ -* -* Function: ~FPSTREAM(); -* -* Description: Distruttore di default. Si preoccupa anche di fermare stream -* eventualmente in esecuzione, e disallocare la memoria da -* essi occupata. -* -\****************************************************************************/ + /****************************************************************************\ + * + * Function: ~FPSTREAM(); + * + * Description: Distruttore di default. Si preoccupa anche di fermare stream + * eventualmente in esecuzione, e disallocare la memoria da + * essi occupata. + * + \****************************************************************************/ ~FPSTREAM(); -/****************************************************************************\ -* -* Function: Release(); -* -* Description: Rilascia la memoria dell'oggetto. Deve essere richiamata quando -* l'oggetto non serve piu' e **SOLO SE** l'oggetto e' stato -* creato con la FPSOUND::CreateStream(). -* -* Note: Eventuali puntatori all'oggetto non sono piu' validi dopo -* questa chiamata. -* -\****************************************************************************/ + /****************************************************************************\ + * + * Function: Release(); + * + * Description: Rilascia la memoria dell'oggetto. Deve essere richiamata quando + * l'oggetto non serve piu' e **SOLO SE** l'oggetto e' stato + * creato con la FPSOUND::CreateStream(). + * + * Note: Eventuali puntatori all'oggetto non sono piu' validi dopo + * questa chiamata. + * + \****************************************************************************/ void Release(); -/****************************************************************************\ -* -* Function: bool LoadFile(char *lpszFileName, uint32 dwCodec=FPCODEC_RAW); -* -* Description: Apre un file di stream. -* -* Input: char *lpszFile Nome del file di stream da aprire -* uint32 dwCodec CODEC da utilizzare per decomprimere -* i campioni sonori -* -* Return: TRUE se tutto OK, FALSE in caso di errore -* -\****************************************************************************/ + /****************************************************************************\ + * + * Function: bool LoadFile(char *lpszFileName, uint32 dwCodec=FPCODEC_RAW); + * + * Description: Apre un file di stream. + * + * Input: char *lpszFile Nome del file di stream da aprire + * uint32 dwCodec CODEC da utilizzare per decomprimere + * i campioni sonori + * + * Return: TRUE se tutto OK, FALSE in caso di errore + * + \****************************************************************************/ bool LoadFile(const char *lpszFileName, uint32 dwCodec = FPCODEC_RAW, int nSync = 2000); -/****************************************************************************\ -* -* Function: UnloadFile(); -* -* Description: Chiude un file di stream eventualmente aperto. E' necessario -* richiamare questa funzione per disallocare la memoria -* occupata dallo stream. -* -* Return: Il distruttore della classe per sicurezza richiama la -* UnloadFile() se non e' stata richiamata esplicitamente. -* -\****************************************************************************/ + /****************************************************************************\ + * + * Function: UnloadFile(); + * + * Description: Chiude un file di stream eventualmente aperto. E' necessario + * richiamare questa funzione per disallocare la memoria + * occupata dallo stream. + * + * Return: Il distruttore della classe per sicurezza richiama la + * UnloadFile() se non e' stata richiamata esplicitamente. + * + \****************************************************************************/ bool UnloadFile(); -/****************************************************************************\ -* -* Function: bool Play(); -* -* Description: Suona lo stream caricato. -* -* Return: TRUE se tutto OK, FALSE in caso di errore. -* -\****************************************************************************/ + /****************************************************************************\ + * + * Function: bool Play(); + * + * Description: Suona lo stream caricato. + * + * Return: TRUE se tutto OK, FALSE in caso di errore. + * + \****************************************************************************/ bool Play(); void PlayFast(void); void Prefetch(void); -/****************************************************************************\ -* -* Function: bool Stop(); -* -* Description: Ferma il play dello stream. -* -* Return: TRUE se tutto OK, FALSE in caso di errore. -* -\****************************************************************************/ + /****************************************************************************\ + * + * Function: bool Stop(); + * + * Description: Ferma il play dello stream. + * + * Return: TRUE se tutto OK, FALSE in caso di errore. + * + \****************************************************************************/ bool Stop(bool bSync = false); - void WaitForSync(FPSTREAM* toplay); + void WaitForSync(FPSTREAM *toplay); -/****************************************************************************\ -* -* Function: void Pause(bool bPause); -* -* Description: Pause dell'effetto sonoro -* -\****************************************************************************/ + /****************************************************************************\ + * + * Function: void Pause(bool bPause); + * + * Description: Pause dell'effetto sonoro + * + \****************************************************************************/ void Pause(bool bPause); -/****************************************************************************\ -* -* Function: bool SetLoop(bool bLoop); -* -* Description: Attiva o disattiva il loop dello stream. -* -* Input: bool bLoop TRUE per attivare il loop, FALSE per -* disattivarlo -* -* Note: Il loop deve essere attivato PRIMA di eseguire il play -* dello stream. Qualsiasi modifica effettuata durante il play -* non avra' effetto fino a che lo stream non viene fermato, -* e poi rimesso in play. -* -\****************************************************************************/ + /****************************************************************************\ + * + * Function: bool SetLoop(bool bLoop); + * + * Description: Attiva o disattiva il loop dello stream. + * + * Input: bool bLoop TRUE per attivare il loop, FALSE per + * disattivarlo + * + * Note: Il loop deve essere attivato PRIMA di eseguire il play + * dello stream. Qualsiasi modifica effettuata durante il play + * non avra' effetto fino a che lo stream non viene fermato, + * e poi rimesso in play. + * + \****************************************************************************/ void SetLoop(bool bLoop); -/****************************************************************************\ -* -* Function: void SetVolume(int dwVolume); -* -* Description: Cambia il volume dello stream -* -* Input: int dwVolume Volume da settare (0-63) -* -\****************************************************************************/ + /****************************************************************************\ + * + * Function: void SetVolume(int dwVolume); + * + * Description: Cambia il volume dello stream + * + * Input: int dwVolume Volume da settare (0-63) + * + \****************************************************************************/ void SetVolume(int dwVolume); -/****************************************************************************\ -* -* Function: void GetVolume(LPINT lpdwVolume); -* -* Description: Chiede il volume dello stream -* -* Input: LPINT lpdwVolume Variabile in cui verra' inserito -* il volume corrente -* -\****************************************************************************/ + /****************************************************************************\ + * + * Function: void GetVolume(LPINT lpdwVolume); + * + * Description: Chiede il volume dello stream + * + * Input: LPINT lpdwVolume Variabile in cui verra' inserito + * il volume corrente + * + \****************************************************************************/ void GetVolume(int *lpdwVolume); }; |