[Scummvm-cvs-logs] SF.net SVN: scummvm:[39289] scummvm/trunk/engines/sci
fingolfin at users.sourceforge.net
fingolfin at users.sourceforge.net
Tue Mar 10 03:42:22 CET 2009
Revision: 39289
http://scummvm.svn.sourceforge.net/scummvm/?rev=39289&view=rev
Author: fingolfin
Date: 2009-03-10 02:42:22 +0000 (Tue, 10 Mar 2009)
Log Message:
-----------
SCI: Renamed SongIteratorMessage -> SongIterator::Message; cleanup
Modified Paths:
--------------
scummvm/trunk/engines/sci/engine/ksound.cpp
scummvm/trunk/engines/sci/engine/savegame.cpp
scummvm/trunk/engines/sci/sfx/core.cpp
scummvm/trunk/engines/sci/sfx/iterator.cpp
scummvm/trunk/engines/sci/sfx/iterator.h
scummvm/trunk/engines/sci/sfx/iterator_internal.h
scummvm/trunk/engines/sci/sfx/player/polled.cpp
scummvm/trunk/engines/sci/sfx/player/realtime.cpp
scummvm/trunk/engines/sci/sfx/player.h
scummvm/trunk/engines/sci/sfx/test-iterator.cpp
Modified: scummvm/trunk/engines/sci/engine/ksound.cpp
===================================================================
--- scummvm/trunk/engines/sci/engine/ksound.cpp 2009-03-10 02:41:56 UTC (rev 39288)
+++ scummvm/trunk/engines/sci/engine/ksound.cpp 2009-03-10 02:42:22 UTC (rev 39289)
@@ -25,7 +25,6 @@
#include "sci/engine/state.h"
#include "sci/sfx/player.h"
-#include "sci/sfx/iterator.h"
#include "sci/engine/kernel.h"
namespace Sci {
Modified: scummvm/trunk/engines/sci/engine/savegame.cpp
===================================================================
--- scummvm/trunk/engines/sci/engine/savegame.cpp 2009-03-10 02:41:56 UTC (rev 39288)
+++ scummvm/trunk/engines/sci/engine/savegame.cpp 2009-03-10 02:42:22 UTC (rev 39289)
@@ -5115,16 +5115,16 @@
while (seeker) {
SongIterator *base, *ff;
int oldstatus;
- SongIteratorMessage msg;
+ SongIterator::Message msg;
base = ff = build_iterator(s, seeker->resource_num, it_type, seeker->handle);
if (seeker->restore_behavior == RESTORE_BEHAVIOR_CONTINUE)
ff = new_fast_forward_iterator(base, seeker->restore_time);
ff->init();
- msg = SongIteratorMessage(seeker->handle, SIMSG_SET_LOOPS(seeker->loops));
+ msg = SongIterator::Message(seeker->handle, SIMSG_SET_LOOPS(seeker->loops));
songit_handle_message(&ff, msg);
- msg = SongIteratorMessage(seeker->handle, SIMSG_SET_HOLD(seeker->hold));
+ msg = SongIterator::Message(seeker->handle, SIMSG_SET_HOLD(seeker->hold));
songit_handle_message(&ff, msg);
oldstatus = seeker->status;
Modified: scummvm/trunk/engines/sci/sfx/core.cpp
===================================================================
--- scummvm/trunk/engines/sci/sfx/core.cpp 2009-03-10 02:41:56 UTC (rev 39288)
+++ scummvm/trunk/engines/sci/sfx/core.cpp 2009-03-10 02:42:22 UTC (rev 39289)
@@ -124,7 +124,7 @@
if (player) {
fprintf(stderr, "Audio iterator:\n");
- player->iterator_message(SongIteratorMessage(0, SIMSG_PRINT(1)));
+ player->iterator_message(SongIterator::Message(0, SIMSG_PRINT(1)));
}
#endif
}
@@ -305,7 +305,7 @@
}
if (player && oldseeker->it)
player->iterator_message
- (SongIteratorMessage(oldseeker->it->ID, SIMSG_STOP));
+ (SongIterator::Message(oldseeker->it->ID, SIMSG_STOP));
oldseeker->next_playing = NULL; /* Clear this pointer; we don't need the tag anymore */
}
@@ -496,7 +496,7 @@
if (song->_wakeupTime.frameDiff(ctime) > 0)
return 0; /* Patience, young hacker! */
- unsigned char buf[8];
+ byte buf[8];
int result = songit_next(&(song->it), buf, cue, IT_READER_MASK_ALL);
switch (result) {
@@ -560,7 +560,7 @@
_dump_songs(self);
if (player)
- player->iterator_message(SongIteratorMessage(handle, SIMSG_STOP));
+ player->iterator_message(SongIterator::Message(handle, SIMSG_STOP));
if (song) {
_sfx_set_song_status(self, song, SOUND_STATUS_STOPPED);
@@ -657,7 +657,7 @@
void sfx_song_set_loops(sfx_state_t *self, song_handle_t handle, int loops) {
song_t *song = song_lib_find(self->songlib, handle);
- SongIteratorMessage msg = SongIteratorMessage(handle, SIMSG_SET_LOOPS(loops));
+ SongIterator::Message msg = SongIterator::Message(handle, SIMSG_SET_LOOPS(loops));
ASSERT_SONG(song);
#ifdef DEBUG_SONG_API
@@ -674,8 +674,8 @@
void sfx_song_set_hold(sfx_state_t *self, song_handle_t handle, int hold) {
song_t *song = song_lib_find(self->songlib, handle);
- SongIteratorMessage msg
- = SongIteratorMessage(handle, SIMSG_SET_HOLD(hold));
+ SongIterator::Message msg
+ = SongIterator::Message(handle, SIMSG_SET_HOLD(hold));
ASSERT_SONG(song);
song->hold = hold;
Modified: scummvm/trunk/engines/sci/sfx/iterator.cpp
===================================================================
--- scummvm/trunk/engines/sci/sfx/iterator.cpp 2009-03-10 02:41:56 UTC (rev 39288)
+++ scummvm/trunk/engines/sci/sfx/iterator.cpp 2009-03-10 02:42:22 UTC (rev 39289)
@@ -588,7 +588,7 @@
return makeStream(_data + offset + SCI0_PCM_DATA_OFFSET, size, conf);
}
-SongIterator *Sci0SongIterator::handleMessage(SongIteratorMessage msg) {
+SongIterator *Sci0SongIterator::handleMessage(Message msg) {
if (msg.recipient == _SIMSG_BASE) {
switch (msg.type) {
@@ -1075,7 +1075,7 @@
return retval;
}
-SongIterator *Sci1SongIterator::handleMessage(SongIteratorMessage msg) {
+SongIterator *Sci1SongIterator::handleMessage(Message msg) {
if (msg.recipient == _SIMSG_BASE) { /* May extend this in the future */
switch (msg.type) {
@@ -1241,12 +1241,12 @@
int nextCommand(byte *buf, int *result);
Audio::AudioStream *getAudioStream() { return NULL; }
- SongIterator *handleMessage(SongIteratorMessage msg);
+ SongIterator *handleMessage(Message msg);
int getTimepos() { return 0; }
SongIterator *clone(int delta) { return new CleanupSongIterator(*this); }
};
-SongIterator *CleanupSongIterator::handleMessage(SongIteratorMessage msg) {
+SongIterator *CleanupSongIterator::handleMessage(Message msg) {
if (msg.recipient == _SIMSG_BASEMSG_PRINT && msg.type == _SIMSG_BASEMSG_PRINT) {
print_tabs_id(msg.args[0].i, ID);
fprintf(stderr, "CLEANUP\n");
@@ -1299,37 +1299,29 @@
return _delegate->getAudioStream();
}
-SongIterator *FastForwardSongIterator::handleMessage(SongIteratorMessage msg) {
- if (msg.recipient == _SIMSG_PLASTICWRAP)
- switch (msg.type) {
+SongIterator *FastForwardSongIterator::handleMessage(Message msg) {
+ if (msg.recipient == _SIMSG_PLASTICWRAP) {
+ assert(msg.type == _SIMSG_PLASTICWRAP_ACK_MORPH);
- case _SIMSG_PLASTICWRAP_ACK_MORPH:
- if (_delta <= 0) {
- SongIterator *it = _delegate;
- delete this;
- return it;
- }
- break;
-
- default:
- BREAKPOINT();
+ if (_delta <= 0) {
+ SongIterator *it = _delegate;
+ delete this;
+ return it;
}
- else if (msg.recipient == _SIMSG_BASE) {
- switch (msg.type) {
- case _SIMSG_BASEMSG_PRINT:
- print_tabs_id(msg.args[0].i, ID);
- fprintf(stderr, "PLASTICWRAP:\n");
- msg.args[0].i++;
- songit_handle_message(&_delegate, msg);
- break;
+ warning("[ff-iterator] Morphing without need");
+ return this;
+ }
- default:
- songit_handle_message(&_delegate, msg);
- }
- } else
- songit_handle_message(&_delegate, msg);
+ if (msg.recipient == _SIMSG_BASE && msg.type == _SIMSG_BASEMSG_PRINT) {
+ print_tabs_id(msg.args[0].i, ID);
+ fprintf(stderr, "FASTFORWARD:\n");
+ msg.args[0].i++;
+ }
+ // And continue with the delegate
+ songit_handle_message(&_delegate, msg);
+
return NULL;
}
@@ -1600,7 +1592,6 @@
for (i = TEE_LEFT; i <= TEE_RIGHT; i++)
if (_status & pcm_masks[i]) {
-
_status &= ~pcm_masks[i];
return _children[i].it->getAudioStream();
}
@@ -1608,52 +1599,39 @@
return NULL; // No iterator
}
-SongIterator *TeeSongIterator::handleMessage(SongIteratorMessage msg) {
- if (msg.recipient == _SIMSG_BASE) {
- switch (msg.type) {
+SongIterator *TeeSongIterator::handleMessage(Message msg) {
+ if (msg.recipient == _SIMSG_PLASTICWRAP) {
+ assert(msg.type == _SIMSG_PLASTICWRAP_ACK_MORPH);
- case _SIMSG_BASEMSG_PRINT:
- print_tabs_id(msg.args[0].i, ID);
- fprintf(stderr, "TEE:\n");
- msg.args[0].i++;
- break; /* And continue with our children */
-
- default:
- break;
+ SongIterator *old_it;
+ if (!(_status & (TEE_LEFT_ACTIVE | TEE_RIGHT_ACTIVE))) {
+ delete this;
+ return NULL;
+ } else if (!(_status & TEE_LEFT_ACTIVE)) {
+ delete _children[TEE_LEFT].it;
+ _children[TEE_LEFT].it = 0;
+ old_it = _children[TEE_RIGHT].it;
+ delete this;
+ return old_it;
+ } else if (!(_status & TEE_RIGHT_ACTIVE)) {
+ delete _children[TEE_RIGHT].it;
+ _children[TEE_RIGHT].it = 0;
+ old_it = _children[TEE_LEFT].it;
+ delete this;
+ return old_it;
}
+
+ warning("[tee-iterator] Morphing without need");
+ return this;
}
- if (msg.recipient == _SIMSG_PLASTICWRAP) {
- SongIterator *old_it;
- switch (msg.type) {
-
- case _SIMSG_PLASTICWRAP_ACK_MORPH:
- if (!(_status & (TEE_LEFT_ACTIVE | TEE_RIGHT_ACTIVE))) {
- delete this;
- return NULL;
- } else if (!(_status & TEE_LEFT_ACTIVE)) {
- delete _children[TEE_LEFT].it;
- _children[TEE_LEFT].it = 0;
- old_it = _children[TEE_RIGHT].it;
- delete this;
- return old_it;
- } else if (!(_status & TEE_RIGHT_ACTIVE)) {
- delete _children[TEE_RIGHT].it;
- _children[TEE_RIGHT].it = 0;
- old_it = _children[TEE_LEFT].it;
- delete this;
- return old_it;
- } else {
- sciprintf("[tee-iterator] WARNING:"
- " Morphing without need\n");
- return this;
- }
-
- default:
- BREAKPOINT();
- }
+ if (msg.recipient == _SIMSG_BASE && msg.type == _SIMSG_BASEMSG_PRINT) {
+ print_tabs_id(msg.args[0].i, ID);
+ fprintf(stderr, "TEE:\n");
+ msg.args[0].i++;
}
+ // And continue with the children
if (_children[TEE_LEFT].it)
songit_handle_message(&(_children[TEE_LEFT].it), msg);
if (_children[TEE_RIGHT].it)
@@ -1785,13 +1763,13 @@
return it;
}
-SongIteratorMessage::SongIteratorMessage() {
+SongIterator::Message::Message() {
ID = 0;
recipient = 0;
type = 0;
}
-SongIteratorMessage::SongIteratorMessage(songit_id_t id, int r, int t, int a1, int a2) {
+SongIterator::Message::Message(songit_id_t id, int r, int t, int a1, int a2) {
ID = id;
recipient = r;
type = t;
@@ -1799,7 +1777,7 @@
args[1].i = a2;
}
-SongIteratorMessage::SongIteratorMessage(songit_id_t id, int r, int t, void *a1, int a2) {
+SongIterator::Message::Message(songit_id_t id, int r, int t, void *a1, int a2) {
ID = id;
recipient = r;
type = t;
@@ -1807,7 +1785,7 @@
args[1].i = a2;
}
-int songit_handle_message(SongIterator **it_reg_p, SongIteratorMessage msg) {
+int songit_handle_message(SongIterator **it_reg_p, SongIterator::Message msg) {
SongIterator *it = *it_reg_p;
SongIterator *newit;
Modified: scummvm/trunk/engines/sci/sfx/iterator.h
===================================================================
--- scummvm/trunk/engines/sci/sfx/iterator.h 2009-03-10 02:41:56 UTC (rev 39288)
+++ scummvm/trunk/engines/sci/sfx/iterator.h 2009-03-10 02:42:22 UTC (rev 39289)
@@ -91,56 +91,57 @@
/*#define SIMSG_SET_FADE(x) _SIMSG_BASE,_SIMSG_BASEMSG_SET_FADE,(x),0*/
/* Message transmission macro: Takes song reference, message reference */
-#define SIMSG_SEND(o, m) songit_handle_message(&(o), SongIteratorMessage((o)->ID, m))
-#define SIMSG_SEND_FADE(o, m) songit_handle_message(&(o), SongIteratorMessage((o)->ID, _SIMSG_BASE, _SIMSG_BASEMSG_SET_FADE, m, 0))
+#define SIMSG_SEND(o, m) songit_handle_message(&(o), SongIterator::Message((o)->ID, m))
+#define SIMSG_SEND_FADE(o, m) songit_handle_message(&(o), SongIterator::Message((o)->ID, _SIMSG_BASE, _SIMSG_BASEMSG_SET_FADE, m, 0))
typedef unsigned long songit_id_t;
-struct SongIteratorMessage {
- songit_id_t ID;
- uint recipient; /* Type of iterator supposed to receive this */
- uint type;
- union {
- uint i;
- void *p;
- } args[SONG_ITERATOR_MESSAGE_ARGUMENTS_NR];
-
- SongIteratorMessage();
-
- /**
- * Create a song iterator message.
- *
- * @param id: song ID the message is targeted to
- * @param recipient_class: Message recipient class
- * @param type message type
- * @param a1 first message argument
- * @param a2 second message argument
- *
- * @note You should only use this with the SIMSG_* macros
- */
- SongIteratorMessage(songit_id_t id, int recipient_class, int type, int a1, int a2);
-
- /**
- * Create a song iterator message, wherein the first parameter is a pointer.
- *
- * @param id: song ID the message is targeted to
- * @param recipient_class: Message recipient class
- * @param type message type
- * @param a1 first message argument
- * @param a2 second message argument
- *
- * @note You should only use this with the SIMSG_* macros
- */
- SongIteratorMessage(songit_id_t id, int recipient_class, int type, void *a1, int a2);
-};
-
#define SONGIT_MAX_LISTENERS 2
class TeeSongIterator;
class SongIterator {
public:
+ struct Message {
+ songit_id_t ID;
+ uint recipient; /* Type of iterator supposed to receive this */
+ uint type;
+ union {
+ uint i;
+ void *p;
+ } args[SONG_ITERATOR_MESSAGE_ARGUMENTS_NR];
+
+ Message();
+
+ /**
+ * Create a song iterator message.
+ *
+ * @param id: song ID the message is targeted to
+ * @param recipient_class: Message recipient class
+ * @param type message type
+ * @param a1 first message argument
+ * @param a2 second message argument
+ *
+ * @note You should only use this with the SIMSG_* macros
+ */
+ Message(songit_id_t id, int recipient_class, int type, int a1, int a2);
+
+ /**
+ * Create a song iterator message, wherein the first parameter is a pointer.
+ *
+ * @param id: song ID the message is targeted to
+ * @param recipient_class: Message recipient class
+ * @param type message type
+ * @param a1 first message argument
+ * @param a2 second message argument
+ *
+ * @note You should only use this with the SIMSG_* macros
+ */
+ Message(songit_id_t id, int recipient_class, int type, void *a1, int a2);
+ };
+
+public:
songit_id_t ID;
uint16 channel_mask; /* Bitmask of all channels this iterator will use */
fade_params_t fade;
@@ -165,20 +166,22 @@
/**
* Reads the next MIDI operation _or_ delta time.
- * Parameters: (SongIterator *) self
- * (byte *) buf: The buffer to write to (needs to be able to
- * store at least 4 bytes)
- * Returns : (int) zero if a MIDI operation was written, SI_FINISHED
+ * @param buf The buffer to write to (needs to be able to store at least 4 bytes)
+ * @param result Number of bytes written to the buffer
+ * (equals the number of bytes that need to be passed
+ * to the lower layers) for 0, the cue value for SI_CUE,
+ * or the number of loops remaining for SI_LOOP.
+ * @return zero if a MIDI operation was written, SI_FINISHED
* if the song has finished playing, SI_LOOP if looping
* (after updating the loop variable), SI_CUE if we found
* a cue, SI_PCM if a PCM was found, or the number of ticks
* to wait before this function should be called next.
- * (int) *result: Number of bytes written to the buffer
- * (equals the number of bytes that need to be passed
- * to the lower layers) for 0, the cue value for SI_CUE,
- * or the number of loops remaining for SI_LOOP.
- * If SI_PCM is returned, get_pcm() may be used to retrieve the associated
+ *
+ * @note If SI_PCM is returned, get_pcm() may be used to retrieve the associated
* PCM, but this must be done before any subsequent calls to next().
+ *
+ * @todo The actual buffer size should either be specified or passed in, so that
+ * we can detect buffer overruns.
*/
virtual int nextCommand(byte *buf, int *result) = 0;
@@ -201,7 +204,7 @@
* takes care of that and makes sure that its delegate received the message (and
* was morphed) before self.
*/
- virtual SongIterator *handleMessage(SongIteratorMessage msg) = 0;
+ virtual SongIterator *handleMessage(Message msg) = 0;
/**
* Gets the song position to store in a savegame.
@@ -274,7 +277,7 @@
*/
-int songit_handle_message(SongIterator **it_reg, SongIteratorMessage msg);
+int songit_handle_message(SongIterator **it_reg, SongIterator::Message msg);
/* Handles a message to the song iterator
** Parameters: (SongIterator **): A reference to the variable storing the song iterator
** Returns : (int) Non-zero if the message was understood
Modified: scummvm/trunk/engines/sci/sfx/iterator_internal.h
===================================================================
--- scummvm/trunk/engines/sci/sfx/iterator_internal.h 2009-03-10 02:41:56 UTC (rev 39288)
+++ scummvm/trunk/engines/sci/sfx/iterator_internal.h 2009-03-10 02:42:22 UTC (rev 39289)
@@ -118,7 +118,7 @@
int nextCommand(byte *buf, int *result);
Audio::AudioStream *getAudioStream();
- SongIterator *handleMessage(SongIteratorMessage msg);
+ SongIterator *handleMessage(Message msg);
void init();
int getTimepos();
SongIterator *clone(int delta);
@@ -163,7 +163,7 @@
int nextCommand(byte *buf, int *result);
Audio::AudioStream *getAudioStream();
- SongIterator *handleMessage(SongIteratorMessage msg);
+ SongIterator *handleMessage(Message msg);
void init();
int getTimepos();
SongIterator *clone(int delta);
@@ -185,7 +185,7 @@
int nextCommand(byte *buf, int *result);
Audio::AudioStream *getAudioStream();
- SongIterator *handleMessage(SongIteratorMessage msg);
+ SongIterator *handleMessage(Message msg);
int getTimepos();
SongIterator *clone(int delta);
};
@@ -237,7 +237,7 @@
int nextCommand(byte *buf, int *result);
Audio::AudioStream *getAudioStream();
- SongIterator *handleMessage(SongIteratorMessage msg);
+ SongIterator *handleMessage(Message msg);
void init();
int getTimepos() { return 0; }
SongIterator *clone(int delta);
Modified: scummvm/trunk/engines/sci/sfx/player/polled.cpp
===================================================================
--- scummvm/trunk/engines/sci/sfx/player/polled.cpp 2009-03-10 02:41:56 UTC (rev 39288)
+++ scummvm/trunk/engines/sci/sfx/player/polled.cpp 2009-03-10 02:42:22 UTC (rev 39289)
@@ -359,7 +359,7 @@
return SFX_OK;
}
-static int pp_send_iterator_message(const SongIteratorMessage &msg) {
+static int pp_send_iterator_message(const SongIterator::Message &msg) {
if (!play_it)
return SFX_ERROR;
Modified: scummvm/trunk/engines/sci/sfx/player/realtime.cpp
===================================================================
--- scummvm/trunk/engines/sci/sfx/player/realtime.cpp 2009-03-10 02:41:56 UTC (rev 39288)
+++ scummvm/trunk/engines/sci/sfx/player/realtime.cpp 2009-03-10 02:42:22 UTC (rev 39289)
@@ -223,7 +223,7 @@
return SFX_OK;
}
-static int rt_send_iterator_message(const SongIteratorMessage &msg) {
+static int rt_send_iterator_message(const SongIterator::Message &msg) {
if (!play_it)
return SFX_ERROR;
Modified: scummvm/trunk/engines/sci/sfx/player.h
===================================================================
--- scummvm/trunk/engines/sci/sfx/player.h 2009-03-10 02:41:56 UTC (rev 39288)
+++ scummvm/trunk/engines/sci/sfx/player.h 2009-03-10 02:42:22 UTC (rev 39289)
@@ -28,16 +28,13 @@
#ifndef SCI_SFX_SFX_PLAYER_H
#define SCI_SFX_SFX_PLAYER_H
-//#include "sci/sfx/core.h"
#include "sci/scicore/resource.h"
+#include "sci/sfx/iterator.h"
#include "common/scummsys.h"
namespace Sci {
-class SongIterator;
-struct SongIteratorMessage;
-
typedef void tell_synth_func(int buf_nr, byte *buf);
struct sfx_player_t {
@@ -81,9 +78,9 @@
** Returns : (int) SFX_OK on success, SFX_ERROR on failure
*/
- int (*iterator_message)(const SongIteratorMessage &msg);
+ int (*iterator_message)(const SongIterator::Message &msg);
/* Transmits a song iterator message to the active song
- ** Parameters: (SongIteratorMessage) msg: The message to transmit
+ ** Parameters: (SongIterator::Message) 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
Modified: scummvm/trunk/engines/sci/sfx/test-iterator.cpp
===================================================================
--- scummvm/trunk/engines/sci/sfx/test-iterator.cpp 2009-03-10 02:41:56 UTC (rev 39288)
+++ scummvm/trunk/engines/sci/sfx/test-iterator.cpp 2009-03-10 02:42:22 UTC (rev 39289)
@@ -111,7 +111,7 @@
void simple_it_init(SongIterator *_self) {
}
-SongIterator *simple_it_handle_message(SongIterator *_self, SongIteratorMessage msg) {
+SongIterator *simple_it_handle_message(SongIterator *_self, SongIterator::Message msg) {
return NULL;
}
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
More information about the Scummvm-git-logs
mailing list