vos/metaobjects/misc/festtalk.hh

Go to the documentation of this file.

/* $Id: festtalk.hh,v 1.17 2003/07/22 05:08:42 tetron Exp $ */

#ifndef FESTTALK_HH
#define FESTTALK_HH

/** @file festtalk.hh
    Defines FestTalk class, a subclass of LocalTalkative that speaks through festival voice synthesis library.
    @author Reed Hedges <reed@zerohour.net> November, 2001
    Portions of this code were developed at the University of Massachusetts

*/


/* an idea for future improvement: be a listener to the voice property directly, and only set the voice (with festival_eval_command) when it changes. */


#include <stdio.h>
#include <stdlib.h>
#include <vos/corelibs/vos/vos.hh>
#include "talkative.hh"


/** A subclass of LocalTalkative that sends "SayText" commands to a festival server.
    Use FestTalk::registerExtenders() to register FestTalk as a local
    metaobject, and regular RemoteTalkative as a remote metaobject, with the factory.
    @author reed 12/01
    @bug Due to a possible bug in Festival the first "say" message fails. Manually send
        an initial message (with do_say) to get around this.
*/


class FestTalk : public LocalTalkative {

public:

    /** An exception that indicates a general error communicating to server through network socket. (use ServerCommError::what() to get a descriptive string) */
    class ServerCommError : public runtime_error {
    public:
        ServerCommError(const string& s) : runtime_error(s) {}
    };

protected:

    int socket_fd;
    FILE *socket_fp;

    static char* festival_host;
    static int festival_port;


    void festival_server_command(const char *cmd) throw (ServerCommError);
    void festival_server_saytext(const string& text) throw (ServerCommError);
    void open_server(char *host, int port) throw (ServerCommError);
    void close_server();

public:

    /** If non-null, then text to speak is broken up into SayText commands by these delimeters. */
    char *phrase_delim;

    /** Constructor: opens socket to Festival server at 127.0.0.1:1314 */
    FestTalk(MetaObject *super) throw (ServerCommError);

    /** Destructor: closes connection to festival server */
    ~FestTalk();


    /** Say message actuator. */
    void do_say(TalkMessage& m) throw(ServerCommError);

   /** Register metaobject extenders. This method takes care of all talkative extenders (local and remote). RemoteTalkative is used for remote objects and FestTalk is used for all local objects. */
   static void registerExtenders();

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

    /** Set default host and port for the Festival server. To use a different server other than 127.0.0.1:3113, call before creating new FestTalk objects.
    @param host string contianing numerical host address. Default is "127.0.0.1".
    @param port int containing host port. Default is 3113.
    */
    static void set_server(char *host = "127.0.0.1", int port = 1314);

};


#endif

---