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
|
/* 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.
*
* $URL$
* $Id$
*
*/
#ifndef SCI_SFX_SOFTSEQ_H
#define SCI_SFX_SOFTSEQ_H
#include "common/error.h"
#include "sci/sfx/sfx_pcm.h"
#include "sci/sfx/sequencer.h"
namespace Sci {
/* Software sequencer */
struct sfx_softseq_t {
const char *name;
const char *version;
Common::Error (*set_option)(sfx_softseq_t *self, const char *name, const char *value);
/* Sets an option for the sequencer
** Parameters: (sfx_softseq_t *) self: Self reference
** (const char *) name: Name of the option to set
** (const char *) value: Value to set the option to
** Returns : (int) GFX_OK on success, or GFX_ERROR if not supported
*/
Common::Error (*init)(sfx_softseq_t *self, byte *res_data, int res_size,
byte *res2_data, int res2_size);
/* Initialises the sequencer
** Parameters: (sfx_softseq_t *) self: Self reference
** (byte *) res_data: Resource data for 'patch_nr' (see below)
** (int) res_size: Number of bytes in 'res_data'
** (byte *) res2_data: Resource data for 'patch2_nr' (see below)
** (int) res2_size: Number of bytes in 'res2_data'
** Returns : (int) Common::kNoError on success, Common::kUnknownError otherwise
** Note that 'res_data' is only a valid pointer for this call. If the
** data is needed later during execution, it should be backed up internally.
** If the requested resource is not available, res_data will be NULL
** /even if/ patch_nr is set.
*/
void (*exit)(sfx_softseq_t *self);
/* Uninitialises the sequencer and frees all used resources
** Parameters: (sfx_softseq_t *) self: Self reference
*/
void (*set_volume)(sfx_softseq_t *self, int new_volume);
/* Sets the sequencer volume
** Parameters: (sfx_softseq_t *) self: Self reference
** (int) new_volume: A volume, between 0 (quiet) and 127 (max)
*/
void (*handle_command)(sfx_softseq_t *self, byte cmd, int argc, byte *argv);
/* Handle a MIDI command
** Parameters: (sfx_softseq_t *) self: Self reference
** (byte) cmd: Basic MIDI command, always includes command and channel
** (int) argc: Number of additional arguments to this command
** (byte *) argv: Additional arguments to 'cmd'
*/
void (*poll)(sfx_softseq_t *self, byte *dest, int len);
/* Asks the software sequencer to fill in parts of a buffer
** Parameters: (sfx_softseq_t *) self: Self reference
** (int) len: Number of _frames_ to write
** Returns : (byte) *dest: 'len' frames must be written to this buffer
*/
void (*allstop)(sfx_softseq_t *self);
/* Stops all sound generation
** Parameters: (sfx_softseq_t *) self: Self reference
*/
void *internal; /* Internal data, may be used by sfx_softseq_t inmplementors */
int patch_nr; /* Number of the first patch file associated with this sequencer,
** or SFX_SEQ_PATCHFILE_NONE */
int patch2_nr; /* Number of the second patch file associated with this sequencer,
** or SFX_SEQ_PATCHFILE_NONE */
int playmask; /* playflag identifying the device emulated */
/* 0x01 -- MT-32
** 0x02 -- Yamaha FB-01
** 0x04 -- CMS or Game Blaster
** 0x08 -- Casio MT540 or CT460
** 0x10 -- Tandy 3-voice
** 0x20 -- PC speaker
*/
int play_rhythm; /* Whether the rhythm channel (9) should be played */
int polyphony; /* Number of voices played */
sfx_pcm_config_t pcm_conf; /* Setup of the channel the sequencer writes to */
};
sfx_softseq_t *sfx_find_softseq(const char *name);
/* Finds a given or default software sequencer
** Parameters: (const char *) name: Name of the sequencer to look up, or NULL for default
** Returns : (sfx_softseq_t *) The requested sequencer, or NULL if not found
*/
} // End of namespace Sci
#endif // SCI_SFX_SOFTSEQ_H
|
