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
|
/* 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$
*
*/
/* song player structure */
#ifndef _SFX_PLAYER_H
#define _SFX_PLAYER_H
#include "sci/sfx/sfx_engine.h"
#include "sci/sfx/sfx_iterator.h"
#include "sci/include/sciresource.h"
namespace Sci {
typedef void tell_synth_func(int buf_nr, byte *buf);
struct sfx_player_t {
const char *name;
const char *version;
int (*set_option)(char *name, char *value);
/* Sets an option for player timing mechanism
** Parameters: (char *) name: The name describing what to set
** (char *) value: The value to set
** Returns : (int) SFX_OK, or SFX_ERROR if the name wasn't understood
*/
int (*init)(ResourceManager *resmgr, int expected_latency);
/* Initializes the player
** Parameters: (ResourceManager *) resmgr: A resource manager for driver initialization
** (int) expected_latency: Expected delay in between calls to 'maintenance'
** (in microseconds)
** Returns : (int) SFX_OK on success, SFX_ERROR on failure
*/
int (*add_iterator)(song_iterator_t *it, GTimeVal start_time);
/* Adds an iterator to the song player
** Parameters: (songx_iterator_t *) it: The iterator to play
** (GTimeVal) start_time: The time to assume as the
** time the first MIDI command executes at
** Returns : (int) SFX_OK on success, SFX_ERROR on failure
** The iterator should not be cloned (to avoid memory leaks) and
** may be modified according to the needs of the player.
** Implementors may use the 'sfx_iterator_combine()' function
** to add iterators onto their already existing iterators
*/
int (*fade_out)();
/* Fades out the currently playing song (within two seconds
** Returns : (int) SFX_OK on success, SFX_ERROR on failure
*/
int (*stop)();
/* Stops the currently playing song and deletes the associated iterator
** Returns : (int) SFX_OK on success, SFX_ERROR on failure
*/
int (*iterator_message)(song_iterator_message_t msg);
/* Transmits a song iterator message to the active song
** Parameters: (song_iterator_message_t) msg: The message to transmit
** Returns : (int) SFX_OK on success, SFX_ERROR on failure
** OPTIONAL -- may be NULL
** If this method is not present, sending messages will stop
** and re-start playing, so it is preferred that it is present
*/
int (*pause)(); /* OPTIONAL -- may be NULL */
/* Pauses song playing
** Returns : (int) SFX_OK on success, SFX_ERROR on failure
*/
int (*resume)(); /* OPTIONAL -- may be NULL */
/* Resumes song playing after a pause
** Returns : (int) SFX_OK on success, SFX_ERROR on failure
*/
int (*exit)();
/* Stops the player
** Returns : (int) SFX_OK on success, SFX_ERROR on failure
*/
void (*maintenance)(); /* OPTIONAL -- may be NULL */
/* Regularly called maintenance function
** This function is called frequently and regularly (if present), it can be
** used to emit sound.
*/
tell_synth_func *tell_synth;
/* Pass a raw MIDI event to the synth
Parameters: (int) argc: Length of buffer holding the midi event
(byte *) argv: The buffer itself
*/
int polyphony; /* Number of voices that can play simultaneously */
};
sfx_player_t *sfx_find_player(char *name);
/* Looks up a player by name or finds the default player
** Parameters: (char *) name: Name of the player to look up, or NULL for dedault
** Returns : (sfx_player_t *) The player requested, or NULL if none was found
*/
tell_synth_func *sfx_get_player_tell_func();
/* Gets the callback function of the player in use.
** Returns: (tell_synth_func *) The callback function.
*/
int sfx_get_player_polyphony();
/* Determines the polyphony of the player in use
** Returns : (int) Number of voices the active player can emit
*/
void sfx_reset_player();
/* Tells the player to stop its internal iterator
** Parameters: None.
** Returns: Nothing.
*/
song_iterator_t *sfx_iterator_combine(song_iterator_t *it1, song_iterator_t *it2);
/* Combines two song iterators into one
** Parameters: (sfx_iterator_t *) it1: One of the two iterators, or NULL
** (sfx_iterator_t *) it2: The other iterator, or NULL
** Returns : (sfx_iterator_t *) A combined iterator
** If a combined iterator is returned, it will be flagged to be allowed to
** dispose of 'it1' and 'it2', where applicable. This means that this
** call should be used by song players, but not by the core sound system
*/
} // End of namespace Sci
#endif /* !_SFX_PLAYER_H */
|
