aboutsummaryrefslogtreecommitdiff
path: root/engines/tony/sound.h
blob: 8853e1a34424b8c6b8a0e53e9393c558871c5d2a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.

 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.

 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 */
/**************************************************************************
 *                                     ���������������������������������� *
 *                                             Nayma Software srl         *
 *                    e                -= We create much MORE than ALL =- *
 *        u-        z$$$c        '.    ���������������������������������� *
 *      .d"        d$$$$$b        "b.                                     *
 *   .z$*         d$$$$$$$L        ^*$c.                                  *
 *  #$$$.         $$$$$$$$$         .$$$" Project: Roasted Moths........  *
 *    ^*$b       4$$$$$$$$$F      .d$*"                                   *
 *      ^$$.     4$$$$$$$$$F     .$P"     Module:  Sound.CPP............  *
 *        *$.    '$$$$$$$$$     4$P 4                                     *
 *     J   *$     "$$$$$$$"     $P   r    Author:  Giovanni Bajo........  *
 *    z$   '$$$P*4c.*$$$*.z@*R$$$    $.                                   *
 *   z$"    ""       #$F^      ""    '$c                                  *
 *  z$$beu     .ue="  $  "=e..    .zed$$c                                 *
 *      "#$e z$*"   .  `.   ^*Nc e$""                                     *
 *         "$$".  .r"   ^4.  .^$$"                                        *
 *          ^.@*"6L=\ebu^+C$"*b."                                         *
 *        "**$.  "c 4$$$  J"  J$P*"    OS:  [ ] DOS  [X] WIN95  [ ] PORT  *
 *            ^"--.^ 9$"  .--""      COMP:  [ ] WATCOM  [X] VISUAL C++    *
 *                    "                     [ ] EIFFEL  [ ] GCC/GXX/DJGPP *
 *                                                                        *
 * This source code is Copyright (C) Nayma Software.  ALL RIGHTS RESERVED *
 *                                                                        *
 **************************************************************************/

#ifndef TONY_SOUND_H
#define TONY_SOUND_H

#include "common/file.h"
#include "tony/gfxcore.h"
#include "tony/loc.h"
#include "tony/utils.h"

namespace Tony {

// Dummy type declarations
typedef void *LPDIRECTSOUND;
typedef void *LPDIRECTSOUNDBUFFER;
typedef uint32 HWND;
struct DSCAPS {
};


class FPSTREAM;
class FPSFX;
class CODEC;

enum CODECS {
	FPCODEC_RAW,
	FPCODEC_ADPCM,
	FPCODEC_WAV
};


/****************************************************************************\
*****************************************************************************
*       class FPSound
*       -------------
* Description: Sound driver per Falling Pumpkins
*****************************************************************************
\****************************************************************************/

class FPSOUND {

private:

	bool bSoundSupported;
	LPDIRECTSOUND lpDS;
	LPDIRECTSOUNDBUFFER lpDSBPrimary;
	DSCAPS dscaps;
	HWND hwnd;

/****************************************************************************\
*       Metodi
\****************************************************************************/

public:

/****************************************************************************\
*
* Function:     FPSOUND::FPSOUND();
*
* Description:  Costruttore di default. Inizializza gli attributi.
*
\****************************************************************************/

	FPSOUND();


/****************************************************************************\
*
* 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.
*
\****************************************************************************/


	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).
*
\****************************************************************************/

	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() 
*
\****************************************************************************/

	bool CreateSfx(FPSFX **lplpSfx);



/****************************************************************************\
*
* 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)
*
\****************************************************************************/

	void GetMasterVolume(int *lpdwVolume);
};

class FPSFX {

/****************************************************************************\
*       Attributi
\****************************************************************************/

private:
/*
	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

//  CODEC* lpCodec;                       // CODEC da utilizzare.
	bool bIsPlaying;                      // TRUE se si sta playando l'effetto sonoro

	bool bIsVoice;

//  LPDIRECTSOUNDNOTIFY lpDSNotify;       // Notify degli hotspot nel buffer
//  DSBPOSITIONNOTIFY dspnHot[2];
  
public:
	HANDLE hEndOfBuffer;

private:


/****************************************************************************\
*       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:     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 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.
*
\****************************************************************************/

  bool Play();


/****************************************************************************\
*
* Function:     bool Stop();
*
* Description:  Ferma il play dello sfx.
*
* Return:       TRUE se tutto OK, FALSE in caso di errore.
*
\****************************************************************************/

  bool Stop();


/****************************************************************************\
*
* 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 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);



/****************************************************************************\
*
* Function:     void SetVolume(int dwVolume);
*
* Description:  Cambia il volume dello sfx
*
* Input:        int dwVolume            Volume da settare (0-63)
*
\****************************************************************************/

  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
*
\****************************************************************************/

  void GetVolume(int * lpdwVolume);
};

class FPSTREAM {

/****************************************************************************\
*       Attributi
\****************************************************************************/

private:

/*
	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
	uint32 dwSize;                         // Dimensione dello stream in bytes
	uint32 dwCodec;                        // CODEC utilizzato

	HANDLE hThreadEnd;                    // Evento per chiudere il thread
	Common::File _file;                   // Handle del file di stream
	HANDLE hPlayThread;                   // Handle del thread di play
	HANDLE hHot1, hHot2, hHot3;           // Eventi settati da DirectSoundNotify
	HANDLE hPlayThread_PlayFast;
	HANDLE hPlayThread_PlayNormal;

	bool bSoundSupported;                 // TRUE se il suono e' attivo
	bool bFileLoaded;                     // TRUE se e' stato aperto un file
	bool bLoop;                           // TRUE se bisogna loopare lo stream
	bool bDoFadeOut;                      // TRUE se bisogna fare un fade out
	bool bSyncExit;
	bool bPaused;
	int lastVolume;
	FPSTREAM *SyncToPlay;
//	DSBPOSITIONNOTIFY dspnHot[3];

	CODEC *lpCodec;                       // CODEC da utilizzare.
	bool CreateBuffer(int nBufSize);

public:
	bool bIsPlaying;                      // TRUE se si sta playando lo stream

private:

	static void PlayThread(FPSTREAM *This);

/****************************************************************************\
*       Metodi
\****************************************************************************/

public:

/****************************************************************************\
*
* 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.
*
\****************************************************************************/

	~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.
*
\****************************************************************************/

	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
*
\****************************************************************************/

	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.
*
\****************************************************************************/

	bool UnloadFile();


/****************************************************************************\
*
* 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.
*
\****************************************************************************/

	bool Stop(bool bSync = false);
	void WaitForSync(FPSTREAM* toplay);


/****************************************************************************\
*
* 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.
*
\****************************************************************************/

	void SetLoop(bool bLoop);



/****************************************************************************\
*
* 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
*
\****************************************************************************/

	void GetVolume(int *lpdwVolume);
};


} // End of namespace Tony

#endif