vos/metaobjects/sound/sound.hh

Go to the documentation of this file.

/* $Id: sound.hh,v 1.6 2003/07/22 05:08:34 tetron Exp $ */

/*
    Copyright (C) 2002 Reed Hedges

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library 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
    Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public
    License along with this library; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA


    This file was generated by otd2cpp.pl, a script for VOS by Reed Hedges <reed@zerohour.net>. 

   I can make no garuntee that this code will work, or even that it even is safe to run.
   Use it at your own risk.
*/

/** @file sound.hh Defines MetaObject class for Sound type (revision 0).

*/ 

#ifndef _SOUND_HH_
#define _SOUND_HH_

#include <vos/corelibs/vos/vos.hh>
#include <vos/metaobjects/property/property.hh>

/** MetaObject implementing Sound Object Type. 
    
        This object type contains sound data and information regarding playback of the sound effect or stream, and sends and receives messages to control playback of the associated sounds.  It may be combined with other object types to place the sound in a particular context, for example, in a 3D space using object3d.
        The behavior of remote and local objects is different: remote objects recieve updates from the local object, and should perform the acctual sound playback (on their local host).  The local sound may (optinally) accept the same messages from remote objects, and just forward the message to all local objects (allowing remote objects to control the sound as heard by all remote instances). 
    
*/

class Sound : public virtual MetaObject
{

public:

    /** Constructor */
    Sound(MetaObject* superobject);


    /** Return type string ("sound") */
    const string getType();

    /** Register Extenders */
    static void registerExtenders();


    /** @name Access Subobjects */
    //@{

    /** Get the value of sound property (
            The sound data. Recommended types to support are the various MOD formats (sound/x-mod, sound/x-s3m, sound/x-xm, sound/x-it), raw wave samples (sound/wav, sound/aiff), Ogg Vorbis (sound/x-ogg), and MP3 (sound/mp3), and URL to Ogg or MP3 ("Shoutcast") stream (sound/x-mp3-stream? sound/x-ogg-stream?). 
        ). */
    void* getSound();

    /** Get the length of the sound */
    unsigned int getSoundLength();

    /** Get the datatype of sound property. */
    string getSoundDatatype();

    /** Set sound property. 
        @param value The sound data
        @param value The size of the data (bytes)
        @param datatype The new datatype: if omitted, then the existing datatype will be preserved. */
    void setSound(void* data, unsigned int length, const string& datatype = "?");

    /** Get the value of sound:loop property (
        If this value is true, then playback of the sound should loop; that is, when the end of the sound is reached, it should begin again.  
        ). */
    bool getLoop();

    /** Set sound:loop property. 
        @param value The new value
    */
    void setLoop(const bool value);

    /** Get the value of sound:immediate property (
        If this value is true, then the sound should be played as soon as the "sound" property changes, or is first recieved (that is, when a "property-update" message is recieved for "sound").
        ). */
    bool getImmediate();

    /** Set sound:immediate property. 
        @param value The new value
    */
    void setImmediate(const bool value);

    //@}
};



/** Local version of Sound. 
    Stores sound information. Use the object to control remote objects
    which perform the actual playback
*/

class LocalSound : public virtual Sound
{
public:

    /** Constructor */
    LocalSound(MetaObject* superobject);

    /** Initialize subproperties */
    virtual void initialize();

    /** Static generator, for factory. */
    static MetaObject* new_LocalSound(MetaObject* superobject, const string& type);

    /** Called when this object gets a message */
    virtual void sendMessage(Message* m);

    /**  @name Actuators. These are user-functions corresponding to messages. */
    //@{

    /** Play the sound from the beginning.
        Sends remote-update message sound:play */
    void play();

    /** Stop playing the sound.
        Sends remote-update message sound:stop */
    void stop();

    /** Pause the sound. 
        Sends remote update message sound:pause */
    void pause();

    /** Resume after pausing.
        Sends remote update message sound:resume */
    void resume();

    //@}

 
};


/** Remote version of Sound. 
    This object listens to the local object's properties, responds to
    update messages from the local object, and performs the actual
    playback
*/

class RemoteSound : public virtual Sound
{

public:

    /** Constructor */
    RemoteSound(MetaObject* superobject);

    /** Static generator, for factory. */
    static MetaObject* new_RemoteSound(MetaObject* superobject, const string& type);

    /** Called when this object gets an update message from its Local master across the network. */
    void sendUpdateMessage(Message *m);



protected:

    /** @name Update Handlers. Handlers for remote update messages */
    //@{

    /** Handle remote-update message sound:play */
    void handlePlay(Message* m);

    /** Handle remote-update message sound:stop */
    void handleStop(Message* m);

    /** Handle remote-update message sound:pause */
    void handlePause(Message* m);

    /** Handle remote-update message sound:resume */
    void handleResume(Message* m);

    //@}

};


#endif // #ifdef _SOUND_HH_

---