vos/metaobjects/sound/sound.cc

Go to the documentation of this file.

/* $Id: sound.cc,v 1.8 2002/10/09 15:27:27 reed 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 ADR 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.cc Code: a MetaObject for Sound object types.

    @TODO what is the correct way to send an update message?

*/

#include "vos/vos.hh"
#include "property/property.hh"
#include "sound.hh"

/* Constructors */

Sound::Sound(MetaObject* s) : MetaObject(s) {

}

LocalSound::LocalSound(MetaObject* s) : Sound(s), MetaObject(s) {
}


/* Initialize required subobjects: */
void LocalSound::initialize() {
    setSound(NULL, 0, "?");
}


RemoteSound::RemoteSound(MetaObject* s) : Sound(s), MetaObject(s) {
    addUpdateHandler<RemoteSound>("sound:play", this, &RemoteSound::handlePlay);
    addUpdateHandler<RemoteSound>("sound:stop", this, &RemoteSound::handleStop);
    addUpdateHandler<RemoteSound>("sound:pause", this, &RemoteSound::handlePause);
    addUpdateHandler<RemoteSound>("sound:resume", this, &RemoteSound::handleResume);
}



/* Return type string ("sound") */

const string Sound::getType() {
    return string("sound:sound");
}

/* Register extenders with libvos MetaFactory */
void Sound::registerExtenders() {
    LocalSite::addLocalObjectExtension(typeid(LocalSound).name(), &LocalSound::new_LocalSound);
    LocalSite::addLocalObjectExtension(typeid(Sound).name(), &LocalSound::new_LocalSound);
    LocalSite::addLocalObjectExtension("sound:sound", &LocalSound::new_LocalSound);
    RemoteSite::addRemoteObjectExtension(typeid(RemoteSound).name(), &RemoteSound::new_RemoteSound);
    RemoteSite::addRemoteObjectExtension(typeid(Sound).name(), &RemoteSound::new_RemoteSound);
    RemoteSite::addRemoteObjectExtension("sound:sound", &RemoteSound::new_RemoteSound);

}


/* Get and set Subproperties and other Subobjects */

void* Sound::getSound() {
    string s;
    rREF(Vobject&, v, findObject("sound:sound"), s = meta_cast<Property&>(v).read() );
    return (void*)s.data();
}

string Sound::getSoundDatatype() {
    string s;
    rREF(Vobject&, v, findObject("sound:sound"), s = meta_cast<Property&>(v).getDataType() );
    return s;
}

unsigned int Sound::getSoundLength() {
    unsigned int len;
    rREF(Vobject&, v, findObject("sound:sound"), len = meta_cast<Property&>(v).getLength() );
    return len;
}

void Sound::setSound(void* data, unsigned int len, const string& datatype) {
    //TODO: you might want to use different access control on the property
    string s( (char*)data, len);
    Property::setProperty(*this, "sound:sound", s, datatype, &NoPropertyAccessControl::static_);
}

bool Sound::getLoop() {
    string s;
    try {
        rREF(Vobject&, v, findObject("sound:loop"), s = meta_cast<Property&>(v).read(); );
    } catch(NoSuchObjectError) {
        return false;
    }
    return (s == "yes");
}


void Sound::setLoop(const bool value) {
    //TODO: you might want to use different access control on the property
    string s;
    if(value)
        s = "yes";
    else
        s = "no";
    Property::setProperty(*this, "sound:loop", s, "text/x-yes-no", &NoPropertyAccessControl::static_);
}

bool Sound::getImmediate() {
    string s;
    try {
        rREF(Vobject&, v, findObject("sound:immediate"), s = meta_cast<Property&>(v).read(); );
    } catch(NoSuchObjectError) {
        return false;
    }
    return (s == "yes");
}

void Sound::setImmediate(const bool value) {
    //TODO: you might want to use different access control on the property
    string s;
    if(value)
        s = "yes";
    else
        s = "no";
    Property::setProperty(*this, "sound:immediate", s, "text/x-yes-no", &NoPropertyAccessControl::static_);
}


/* Process local object messages */
void LocalSound::sendMessage(Message* m) {

    /* Let superclass have message */
    Sound::sendMessage(m);
}





/* Process remote update messages */
void RemoteSound::sendUpdateMessage(Message* m) {
    /* let superclass have message... */
    Sound::sendUpdateMessage(m);
}

/* Local Actuators: send messages to remote objects */

void LocalSound::play() {
    pREF(Message*, m, new Message(),
         m->setType("update");
         m->setFrom(getURL().getString());
         m->setTo(getSite().getURL().getString());
         m->setMethod("sound:play");
         getSite().sendMessage(m);
    );
}

void LocalSound::stop() {
    pREF(Message*, m, new Message(),
         m->setType("update");
         m->setFrom(getURL().getString());
         m->setTo(getSite().getURL().getString());
         m->setMethod("sound:stop");
         getSite().sendMessage(m);
    );
}

void LocalSound::pause() {
    pREF(Message*, m, new Message(),
         m->setType("update");
         m->setFrom(getURL().getString());
         m->setTo(getSite().getURL().getString());
         m->setMethod("sound:pause");
         getSite().sendMessage(m);
    );
}

void LocalSound::resume() {
    pREF(Message*, m, new Message(),
         m->setType("update");
         m->setFrom(getURL().getString());
         m->setTo(getSite().getURL().getString());
         m->setMethod("sound:resume");
         getSite().sendMessage(m);
    );
}

/* Message Handlers:  */

    /* TODO you might wantto override some of these methods in LocalSound  and RemoteSound */

/** Handle remote-update message sound:play (When this message is recieved by a remote object, the sound should be played from the beginning. If the sound is already playing, it may be stopped or played simultaneously, as capabilities of the system permit. When recieved by a local object (from a remote object), the message may be relayed to all remote objects (?).) */
void RemoteSound::handlePlay(Message* m) {

    //TODO: add code here

    m->release();   // decrease refcount before returning.
}

/** Handle remote-update message sound:stop (All playback of this sound should be immediately stopped. However, if "loop" is "yes", the sound should be re-played from the beginning.  When recieved by a local object (from a remote object), the message may be relayed to all remote objects (?).) */
void RemoteSound::handleStop(Message* m) {

    // TODO

    m->release();   // decrease refcount before returning.
}

/** Handle remote-update message sound:pause (When recieved by a remote object,  it sould enter a "paused" state, in which all playback is stopped, but current position is saved.When recieved by a local object (from a remote object), the message may be relayed to all remote objects (?).) */
void RemoteSound::handlePause(Message* m) {

    // TODO

    m->release();   // decrease refcount before returning.
}

/** Handle remote-update message sound:resume (If recieved by a remote object in "paused" state, it should resume playing. If not in paused state, do nothing.When recieved by a local object (from a remote object), the message may be relayed to all remote objects (?).) */
void RemoteSound::handleResume(Message* m) {

    // TODO

    m->release();   // decrease refcount before returning.
}

/* Remote Actuators: */


/* Generators for factory */


MetaObject* LocalSound::new_LocalSound(MetaObject* s, const string& type) {
    LocalSound* o = new LocalSound(s);
    o->initialize();
    return o;
}

MetaObject* RemoteSound::new_RemoteSound(MetaObject* s, const string& type) {
    return new RemoteSound(s);
}

---