Mac/Modules/macspeechmodule.c

/***********************************************************
Copyright 1991-1995 by Stichting Mathematisch Centrum, Amsterdam,
The Netherlands.

                        All Rights Reserved

Permission to use, copy, modify, and distribute this software and its 
documentation for any purpose and without fee is hereby granted, 
provided that the above copyright notice appear in all copies and that
both that copyright notice and this permission notice appear in 
supporting documentation, and that the names of Stichting Mathematisch
Centrum or CWI not be used in advertising or publicity pertaining to
distribution of the software without specific, written prior permission.

STICHTING MATHEMATISCH CENTRUM DISCLAIMS ALL WARRANTIES WITH REGARD TO
THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS, IN NO EVENT SHALL STICHTING MATHEMATISCH CENTRUM BE LIABLE
FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

******************************************************************/

/* xx module */

#include "allobjects.h"
#include "modsupport.h"

#include <GestaltEqu.h>
#include "Speech.h"

#ifdef __MWERKS__
#include <Strings.h>
#define c2pstr C2PStr
#define p2cstr P2CStr
#else
#include "pascal.h"
#endif /* __MWERKS__ */

#ifdef __powerc
#include <FragLoad.h>
int lib_available;
#endif /* __powerc */

/* Somehow the Apple Fix2X and X2Fix don't do what I expect */
#define fixed2double(x) (((double)(x))/32768.0)
#define double2fixed(x) ((Fixed)((x)*32768.0))

char *CurrentSpeech;
object *ms_error_object;
int speech_available;

static
init_available() {
	OSErr err;
	long result;

#ifdef __powerc
	lib_available = ((ProcPtr)SpeakString != (ProcPtr)0);
#endif
	err = Gestalt(gestaltSpeechAttr, &result);
	if ( err == noErr && (result & (1<<gestaltSpeechMgrPresent)))
		return 1;
	return 0;
}

static
check_available() {
	if ( !speech_available ) {
		err_setstr(ms_error_object, "Speech Mgr not available");
		return 0;
	}
#ifdef __powerc
	if ( !lib_available ) {
		err_setstr(ms_error_object, "Speech Mgr available, but shared lib missing");
		return 0;
	}
#endif
	return 1;
}

/* -------------
**
** Part one - the speech channel object
*/
typedef struct {
	OB_HEAD
	SpeechChannel chan;
	object *curtext;	/* If non-NULL current text being spoken */
} scobject;

staticforward typeobject sctype;

#define is_scobject(v)		((v)->ob_type == &sctype)

static scobject *
newscobject(arg)
	VoiceSpec *arg;
{
	scobject *self;
	OSErr err;
	
	self = NEWOBJ(scobject, &sctype);
	if (self == NULL)
		return NULL;
	if ( (err=NewSpeechChannel(arg, &self->chan)) != 0) {
		DECREF(self);
		return (scobject *)PyErr_Mac(ms_error_object, err);
	}
	self->curtext = NULL;
	return self;
}

/* sc methods */

static void
sc_dealloc(self)
	scobject *self;
{
	DisposeSpeechChannel(self->chan);
	DEL(self);
}

static object *
sc_Stop(self, args)
	scobject *self;
	object *args;
{
	OSErr err;
	
	if (!getnoarg(args))
		return NULL;
	if ((err=StopSpeech(self->chan)) != 0) {
		PyErr_Mac(ms_error_object, err);
		return NULL;
	}
	if ( self->curtext ) {
		DECREF(self->curtext);
		self->curtext = NULL;
	}
	INCREF(None);
	return None;
}

static object *
sc_SpeakText(self, args)
	scobject *self;
	object *args;
{
	OSErr err;
	char *str;
	int len;
	
	if (!getargs(args, "s#", &str, &len))
		return NULL;
	if ( self->curtext ) {
		StopSpeech(self->chan);
		DECREF(self->curtext);
		self->curtext = NULL;
	}
	if ((err=SpeakText(self->chan, (Ptr)str, (long)len)) != 0) {
		PyErr_Mac(ms_error_object, err);
		return 0;
	}
	(void)getargs(args, "O", &self->curtext);	/* Or should I check this? */
	INCREF(self->curtext);
	INCREF(None);
	return None;
}

static object *
sc_GetRate(self, args)
	scobject *self;
	object *args;
{
	OSErr err;
	Fixed farg;
	
	if (!getnoarg(args))
		return NULL;
	if ((err=GetSpeechRate(self->chan, &farg)) != 0) {
		PyErr_Mac(ms_error_object, err);
		return 0;
	}
	return newfloatobject(fixed2double(farg));
}

static object *
sc_GetPitch(self, args)
	scobject *self;
	object *args;
{
	OSErr err;
	Fixed farg;
	
	if (!getnoarg(args))
		return NULL;
	if ((err=GetSpeechPitch(self->chan, &farg)) != 0) {
		PyErr_Mac(ms_error_object, err);
		return 0;
	}
	return newfloatobject(fixed2double(farg));
}

static object *
sc_SetRate(self, args)
	scobject *self;
	object *args;
{
	OSErr err;
	double darg;
	
	if (!getargs(args, "d", &darg))
		return NULL;
	if ((err=SetSpeechRate(self->chan, double2fixed(darg))) != 0) {
		PyErr_Mac(ms_error_object, err);
		return 0;
	}
	INCREF(None);
	return None;
}

static object *
sc_SetPitch(self, args)
	scobject *self;
	object *args;
{
	OSErr err;
	double darg;
	
	if (!getargs(args, "d", &darg))
		return NULL;
	if ((err=SetSpeechPitch(self->chan, double2fixed(darg))) != 0) {
		PyErr_Mac(ms_error_object, err);
		return NULL;
	}
	INCREF(None);
	return None;
}

static struct methodlist sc_methods[] = {
	{"Stop",		(method)sc_Stop},
	{"SetRate",		(method)sc_SetRate},
	{"GetRate",		(method)sc_GetRate},
	{"SetPitch",	(method)sc_SetPitch},
	{"GetPitch",	(method)sc_GetPitch},
	{"SpeakText",	(method)sc_SpeakText},
	{NULL,			NULL}		/* sentinel */
};

static object *
sc_getattr(self, name)
	scobject *self;
	char *name;
{
	return findmethod(sc_methods, (object *)self, name);
}

static typeobject sctype = {
	OB_HEAD_INIT(&Typetype)
	0,			/*ob_size*/
	"MacSpeechChannel",			/*tp_name*/
	sizeof(scobject),	/*tp_basicsize*/
	0,			/*tp_itemsize*/
	/* methods */
	(destructor)sc_dealloc, /*tp_dealloc*/
	0,			/*tp_print*/
	(getattrfunc)sc_getattr, /*tp_getattr*/
	0, 			/*tp_setattr*/
	0,			/*tp_compare*/
	0,			/*tp_repr*/
	0,			/*tp_as_number*/
	0,			/*tp_as_sequence*/
	0,			/*tp_as_mapping*/
	0,			/*tp_hash*/
};

/* -------------
**
** Part two - the voice object
*/
typedef struct {
	OB_HEAD
	int		initialized;
	VoiceSpec	vs;
	VoiceDescription vd;
} mvobject;

staticforward typeobject mvtype;

#define is_mvobject(v)		((v)->ob_type == &mvtype)

static mvobject *
newmvobject()
{
	mvobject *self;
	self = NEWOBJ(mvobject, &mvtype);
	if (self == NULL)
		return NULL;
	self->initialized = 0;
	return self;
}

static int
initmvobject(self, ind)
	mvobject *self;
	int ind;
{
	OSErr err;
	
	if ( (err=GetIndVoice((short)ind, &self->vs)) != 0 ) {
		PyErr_Mac(ms_error_object, err);
		return 0;
	}
	if ( (err=GetVoiceDescription(&self->vs, &self->vd, sizeof self->vd)) != 0) {
		PyErr_Mac(ms_error_object, err);
		return 0;
	}
	self->initialized = 1;
	return 1;
} 
/* mv methods */

static void
mv_dealloc(self)
	mvobject *self;
{
	DEL(self);
}

static object *
mv_getgender(self, args)
	mvobject *self;
	object *args;
{
	object *rv;
	
	if (!getnoarg(args))
		return NULL;
	if (!self->initialized) {
		err_setstr(ms_error_object, "Uninitialized voice");
		return NULL;
	}
	rv = newintobject(self->vd.gender);
	return rv;
}

static object *
mv_newchannel(self, args)
	mvobject *self;
	object *args;
{	
	if (!getnoarg(args))
		return NULL;
	if (!self->initialized) {
		err_setstr(ms_error_object, "Uninitialized voice");
		return NULL;
	}
	return (object *)newscobject(&self->vs);
}

static struct methodlist mv_methods[] = {
	{"GetGender",	(method)mv_getgender},
	{"NewChannel",	(method)mv_newchannel},
	{NULL,		NULL}		/* sentinel */
};

static object *
mv_getattr(self, name)
	mvobject *self;
	char *name;
{
	return findmethod(mv_methods, (object *)self, name);
}

static typeobject mvtype = {
	OB_HEAD_INIT(&Typetype)
	0,			/*ob_size*/
	"MacVoice",			/*tp_name*/
	sizeof(mvobject),	/*tp_basicsize*/
	0,			/*tp_itemsize*/
	/* methods */
	(destructor)mv_dealloc, /*tp_dealloc*/
	0,			/*tp_print*/
	(getattrfunc)mv_getattr, /*tp_getattr*/
	0,			/*tp_setattr*/
	0,			/*tp_compare*/
	0,			/*tp_repr*/
	0,			/*tp_as_number*/
	0,			/*tp_as_sequence*/
	0,			/*tp_as_mapping*/
	0,			/*tp_hash*/
};


/* -------------
**
** Part three - The module interface
*/

/* See if Speech manager available */

static object *
ms_Available(self, args)
	object *self; /* Not used */
	object *args;
{
	
	if (!getnoarg(args))
		return NULL;
	return newintobject(speech_available);
}

/* Count number of busy speeches */

static object *
ms_Busy(self, args)
	object *self; /* Not used */
	object *args;
{
	short result;
	
	if (!getnoarg(args))
		return NULL;
	if ( !check_available() )
		return NULL;
	result = SpeechBusy();
	return newintobject(result);
}

/* Say something */

static object *
ms_SpeakString(self, args)
	object *self; /* Not used */
	object *args;
{
	OSErr err;
	char *str;
	int len;
	
	if (!getstrarg(args, &str))
		return NULL;
	if ( !check_available())
		return NULL;
	if (CurrentSpeech) {
		/* Free the old speech, after killing it off
		** (note that speach is async and c2pstr works inplace)
		*/
		SpeakString("\p");
		free(CurrentSpeech);
	}
	len = strlen(str);
	CurrentSpeech = malloc(len+1);
	strcpy(CurrentSpeech, str);
	err = SpeakString(c2pstr(CurrentSpeech));
	if ( err ) {
		PyErr_Mac(ms_error_object, err);
		return NULL;
	}
	INCREF(None);
	return None;
}


/* Count number of available voices */

static object *
ms_CountVoices(self, args)
	object *self; /* Not used */
	object *args;
{
	short result;
	
	if (!getnoarg(args))
		return NULL;
	if ( !check_available())
		return NULL;
	CountVoices(&result);
	return newintobject(result);
}

static object *
ms_GetIndVoice(self, args)
	object *self; /* Not used */
	object *args;
{
	mvobject *rv;
	long ind;
	
	if( !getargs(args, "i", &ind))
		return NULL;
	if ( !check_available() )
		return NULL;
	rv = newmvobject();
	if ( !initmvobject(rv, ind) ) {
		DECREF(rv);
		return NULL;
	}
	return (object *)rv;
}


static object *
ms_Version(self, args)
	object *self; /* Not used */
	object *args;
{
	NumVersion v;
	
	if (!getnoarg(args))
		return NULL;
	if ( !check_available())
		return NULL;
	v = SpeechManagerVersion();
	return newintobject(*(int *)&v);
}


/* List of functions defined in the module */

static struct methodlist ms_methods[] = {
	{"Available",	ms_Available},
	{"CountVoices",	ms_CountVoices},
	{"Busy",		ms_Busy},
	{"SpeakString",	ms_SpeakString},
	{"GetIndVoice", ms_GetIndVoice},
	{"Version",		ms_Version},
	{NULL,		NULL}		/* sentinel */
};

/* Initialization function for the module (*must* be called initmacspeech) */

void
initmacspeech()
{
	object *m, *d;

	speech_available = init_available();
	/* Create the module and add the functions */
	m = initmodule("macspeech", ms_methods);

	/* Add some symbolic constants to the module */
	d = getmoduledict(m);
	ms_error_object = newstringobject("macspeech.error");
	dictinsert(d, "error", ms_error_object);

	/* Check for errors */
	if (err_occurred())
		fatal("can't initialize module macspeech");
}