pangdudu-swiftly 1.0.1

data/external/include/swift_defs.h

@@ -0,0 +1,132 @@
+/* -*- c-file-style: "linux" -*- */
+/* swift_defs.h: Forward declarations and enumerations for Swift TTS.
+ *
+ * Copyright (c) 2004-2006 Cepstral LLC.  All rights reserved.
+ *
+ * Redistribution of this file, in whole or in part, with or without
+ * modification, is not allowed without express written permission of
+ * the copyright holder.
+ */
+
+#ifndef _SWIFT_DEFS_H_
+#define _SWIFT_DEFS_H_
+
+/**
+ * \file swift_defs.h
+ * Types and enumerations for the Swift text-to-speech API.
+ **/
+
+/** Description of a voice available to the system. */
+typedef struct swift_voice_desc_struct swift_voice;
+
+/** A linked-list of swift_voice structs **/
+typedef struct swift_voice_list_desc_struct swift_voice_list;
+
+/** TTS Engine Object through which ports may be open. */
+typedef struct swift_engine_struct swift_engine;
+
+/** Swift Port Object through which speech synthesis is performed. */
+typedef struct swift_port_struct swift_port;
+
+/** Parameter list (key-value pairs). */
+typedef struct cst_val_struct swift_params;
+
+/** Generic value object. */
+typedef struct cst_val_struct swift_val;
+
+/** Waveform object. */
+typedef struct cst_wave_struct swift_waveform;
+
+/** ID of background synthesis job. */
+typedef void * swift_background_t;
+
+/** Synthesis event. */
+typedef struct swift_event_struct swift_event;
+
+/** Result (error/success) codes for API functions. */
+typedef enum swift_result_t {
+    SWIFT_SUCCESS           = 0,   /**< Operation succeeded. */
+    SWIFT_UNKNOWN_ERROR     = -1,  /**< Unknown error. */
+    SWIFT_UNIMPLEMENTED     = -2,  /**< Function is not (yet) implemented. */
+    SWIFT_INTERNAL_ERROR    = -3,  /**< Engine internal error. */
+    SWIFT_INVALID_PARAM     = -4,  /**< Invalid parameter. */
+    SWIFT_INVALID_POINTER   = -5,  /**< Invalid NULL pointer in parameter. */
+    SWIFT_OBJECT_NOT_FOUND  = -6,  /**< File, voice, port, etc... not found. */
+    SWIFT_UNKNOWN_ENCODING  = -7,  /**< Unknown text/audio encoding. */
+    SWIFT_INTERRUPTED       = -8,  /**< Operation interrupted. */
+    SWIFT_INVALID_VOICE     = -9,  /**< Voice not present or corrupted. */
+    SWIFT_FILE_ERROR        = -10, /**< A file could not be read/written. */
+    SWIFT_WRONG_EVENT       = -11, /**< Wrong event type for the data requested.*/
+    SWIFT_ENGINE_INUSE      = -12, /**< Engine still in use by some port. */
+    SWIFT_NETWORK_ERROR     = -13, /**< Network communication failed. */
+    SWIFT_INVALID_KEY       = -14, /**< An invalid license key was specified. */
+    SWIFT_QUEUE_FULL        = -15, /**< The utterance queue is full. */
+    SWIFT_TOKEN_TIMEOUT     = -16  /**< Get concurrecny token timed out. */
+} swift_result_t;
+
+/** Status of a background job. */
+typedef enum swift_status_t {
+    SWIFT_STATUS_UNKNOWN = -1, /**< No such job. */
+    SWIFT_STATUS_DONE    = 0,  /**< Job has completed. */
+    SWIFT_STATUS_RUNNING = 1,  /**< Job is currently running. */
+    SWIFT_STATUS_PAUSED  = 2,  /**< Job is currently paused. */
+    SWIFT_STATUS_QUEUED  = 3   /**< Job is waiting to run. */
+} swift_status_t;
+
+/** Type of event for a callback (also used as a mask to request events). */
+typedef enum swift_event_t {
+    SWIFT_EVENT_NONE        = 0,
+    SWIFT_EVENT_AUDIO       = (1<<0),
+    SWIFT_EVENT_ERROR       = (1<<1),
+    SWIFT_EVENT_SENTENCE    = (1<<2),
+    SWIFT_EVENT_PHRASE      = (1<<3),
+    SWIFT_EVENT_TOKEN       = (1<<4),
+    SWIFT_EVENT_WORD        = (1<<5),
+    SWIFT_EVENT_BOOKMARK    = (1<<6),
+    SWIFT_EVENT_SYLLABLE    = (1<<7),
+    SWIFT_EVENT_PHONEME     = (1<<8),
+    SWIFT_EVENT_START       = (1<<9),     /* Synthesis job started. */
+    SWIFT_EVENT_END         = (1<<10),    /* Synthesis job completed. */
+    SWIFT_EVENT_CANCELLED   = (1<<11),    /* User cancel request completed. */
+    SWIFT_EVENT_ALL         = 0xffffffff,
+    SWIFT_EVENT_NOW         = 0xffffffff  /* Used for halt/pause. */
+} swift_event_t;
+
+/** Policy for retention of voice settings and parameters. */
+typedef enum swift_voice_retention_policy_t {
+    SWIFT_VOICE_RETAIN_FOREVER       = 0,
+    SWIFT_VOICE_RETAIN_PORT_USAGE    = (1<<0),
+    SWIFT_VOICE_RETAIN_NONE          = (1<<1)
+} swift_voice_retention_policy_t;
+
+/** No background job. */
+#define SWIFT_ASYNC_NONE ((swift_background_t)0)
+/** Any background job. */
+#define SWIFT_ASYNC_ANY ((swift_background_t)-1)
+/** Currently-running background job. */
+#define SWIFT_ASYNC_CURRENT ((swift_background_t)-3)
+
+/** Determine if an operation (in parentheses) failed. */
+#define SWIFT_FAILED(r) ((r) < 0)
+
+/* String encoding types. */
+/** UTF-8 Encoding type **/
+#define SWIFT_UTF8 "utf-8"
+/** ASCII Encoding type **/
+#define SWIFT_ASCII "us-ascii"
+/** UTF-16 Encoding type **/
+#define SWIFT_UTF16 "utf-16"
+/** Unicode Encoding type (maps to UTF-16) **/
+#define SWIFT_UNICODE "utf-16"
+/** iso8859-1 Latin-1 Encoding type **/
+#define SWIFT_LATIN_1 "iso8859-1"
+/** iso8859-1 Encoding type **/
+#define SWIFT_ISO_8859_1 "iso8859-1"
+/** iso8859-15 Latin-9 Encoding type **/
+#define SWIFT_LATIN_9 "iso8859-15"
+/** iso8859-15 Encoding type **/
+#define SWIFT_ISO_8859_15 "iso8859-15"
+/** Default Encoding type - Latin 1 - iso8859-1 **/
+#define SWIFT_DEFAULT_ENCODING SWIFT_LATIN_1
+
+#endif /* _SWIFT_DEFS_H_ */

data/external/include/swift_exports.h

@@ -0,0 +1,45 @@
+/* swift_exports.h: special Win32 DLL magic.
+ *
+ * Copyright (c) 2004-2006 Cepstral LLC, all rights reserved.
+ *
+ * Redistribution of this file, in whole or in part, with or without
+ * modification, is not allowed without express written permission of
+ * the copyright holder.
+ */
+
+/**
+ * \file swift_exports.h
+ * DLL import/export definitions for Windows platforms.
+ **/
+
+#ifndef _SWIFT_EXPORTS_H__
+#define _SWIFT_EXPORTS_H__
+
+/**
+ * Tells API functions to be exported from swift.dll.
+ * This is ignored on non-Windows platforms.
+ **/
+#if defined(_WIN32) && !defined(SWIFT_STATIC_LIBS)
+# if defined SWIFT_EXPORTS
+#  define SWIFT_API __declspec(dllexport)
+# else
+#  define SWIFT_API __declspec(dllimport)
+# endif /* SWIFT_EXPORTS */
+# if defined (_DEBUG)
+#  define DEBUG
+# endif
+#else
+# define SWIFT_API
+#endif /* WIN32 */
+
+/**
+ * Declares exposed API functions as __cdecl for the PocketPC 2000 x86Emulator.
+ * It is ignored by all other platforms.
+ **/
+#if defined (_WIN32_WCE_EMULATION)
+# define SWIFT_CALLCONV __cdecl
+#else
+# define SWIFT_CALLCONV
+#endif
+
+#endif /* _SWIFT_EXPORTS_H__ */

data/external/include/swift_params.h

@@ -0,0 +1,361 @@
+/* -*- c-file-style: "linux" -*- */
+/* swift_params.h: Parameter and value objects for the Swift TTS engine.
+ *
+ * Copyright (c) 2003-2006 Cepstral LLC.  All rights reserved.
+ *
+ * Redistribution of this file, in whole or in part, with or without
+ * modification, is not allowed without express written permission of
+ * the copyright holder.
+ */
+
+#ifndef _SWIFT_PARAMS_H_
+#define _SWIFT_PARAMS_H_
+
+#include "swift_exports.h"
+#include "swift_defs.h"
+
+/**
+ * \file swift_params.h
+ * Parameter and value objects for the Swift TTS engine.
+ **/
+
+/**
+ * Create a new parameter list.
+ *
+ * @param key The first parameter to set in the list.
+ * @return    The newly created swift_params list.
+ *
+ * NOTE: There are optional parameters.  You can pass in as many keys as
+ *       you'd like.
+ **/
+SWIFT_API
+swift_params * SWIFT_CALLCONV swift_params_new(const char *key, ...);
+
+/**
+ * Claim ownership of the parameter list (increase its reference count).
+ *
+ * @param params The parameters for which to increase the reference count.
+ * @return       The reference-counted swift_params that were passed in.
+ *
+ * Note that in all cases where a swift_params* is passed to a function in
+ * swift.h, the Swift library claims ownership of the parameter list.
+ * Therefore, you must call swift_params_ref() on it if you wish to use it
+ * afterwards, and, conversely, you must not call swift_params_delete() on
+ * it unless you have used swift_params_ref() to claim ownership.
+ *
+ * In practical terms, what this means is that you should just call
+ * swift_params_new() in the argument list of these functions, like this:
+ *
+ * p = swift_open_port(swift_params_new(...));
+ *
+ * and not care about what happens to the object created, unless you really
+ * need to know.
+ **/
+SWIFT_API
+swift_params * SWIFT_CALLCONV swift_params_ref(swift_params *params);
+
+/**
+ * Relinquish ownership of a parameter list (decrease its reference count).
+ *
+ * @param params The parameters for which to decrease the reference count.
+ * @return       The reference-decreased swift_params that were passed in.
+ *
+ * NOTE: This function decreases the reference count for the swift_params list.
+ *       If the reference count reaches zero, the parameters are deleted.
+ **/
+SWIFT_API
+swift_result_t SWIFT_CALLCONV swift_params_delete(swift_params *params);
+
+/**
+ * Dump contents of a parameter list to standard error (for debugging).
+ *
+ * @param params The swift_params list to dump to standard error.
+ * @return       SWIFT_SUCCESS, or SWIFT_INVALID_POINTER if params is NULL.
+ **/
+SWIFT_API
+swift_result_t SWIFT_CALLCONV swift_params_dump(swift_params *params);
+
+/**
+ * Set a value for a key.
+ *
+ * @param params The swift_params list in which to find the key to set.
+ * @param name   The name of the key to set.
+ * @param val    The value to set for the key.
+ * @return       The string value of the value set for the key.
+ **/
+SWIFT_API
+const char * SWIFT_CALLCONV swift_params_set_val(swift_params *params,
+                                                 const char *name,
+                                                 const swift_val *val);
+
+/** Set an integer value in a swift_params **/
+#define swift_params_set_int(p,n,i) \
+    swift_params_set_val(p,n,swift_val_int((int)(i)))
+/** Set a floating point value in a swift_params **/
+#define swift_params_set_float(p,n,f) \
+    swift_params_set_val(p,n,swift_val_float((float)(f)))
+/** Set a string value in a swift_params **/
+#define swift_params_set_string(p,n,s) \
+    swift_params_set_val(p,n,swift_val_string((const char *)(s)))
+/** Set a wide-character string value in a swift_params **/
+#define swift_params_set_string16(p,n,s) \
+    swift_params_set_val(p,n,swift_val_string16((const unsigned short *)(s)))
+
+/**
+ * User-Defined function that iterates over a parameter list.  Pointer to this
+ * function is passed to swift_params_foreach().
+ *
+ * @param params The list of parameters over which to iterate.
+ * @param name   The name of the current feature being evaluated.
+ * @param val    The value of the current feature being evaluated.
+ * @param udata  The user data pointer passed to swift_params_foreach().
+ * @return       You should define your function to return SWIFT_SUCCESS
+ *               until you no longer want to iterate.  Then return a non-
+ *               SWIFT_SUCCESS value.
+ **/
+typedef swift_result_t (*swift_params_iterator)(swift_params *params,
+                                                const char *name,
+                                                swift_val *val,
+                                                void *udata);
+/**
+ * Iterate over a parameter list.
+ *
+ * This function calls itor for each key/value pair in params,
+ * stopping either when no more parameters remain, or if itor returns
+ * a non-SWIFT_SUCCESS value.
+ *
+ * @param params The list of parameters over which to iterate.
+ * @param itor   Pointer to the user-defined function for iterating over
+ *               the params.
+ * @param udata  User Data - pointer to anything you want to pass to the
+ *               iterator function.
+ * @return       SWIFT_SUCCESS if all key/value pair is itorated upon
+ *               successfully, SWIFT_INVALID_POINTER if params is NULL, or
+ *               the return value of itor if it is non-SWIFT_SUCCESS.
+ **/
+SWIFT_API
+swift_result_t SWIFT_CALLCONV swift_params_foreach(swift_params *params,
+                                                   swift_params_iterator itor,
+                                                   void *udata);
+
+/**
+ * Search within a list of params for a key matching the given name.
+ *
+ * @param params The list of params in which to search for the key.
+ * @param name   The name of the key for which to search.
+ * @param def    Default value to return if the value for which you are
+ *               searching is not found.
+ * @return       The swift_val matching the name, if found.  If not found,
+ *               the default value is returned.
+ **/
+SWIFT_API
+const swift_val * SWIFT_CALLCONV
+swift_params_get_val(const swift_params *params,
+                     const char *name,
+                     const swift_val *def);
+/**
+ * Search within a list of params for a key matching the given name.
+ *
+ * @param params The list of params in which to search for the key.
+ * @param name   The name of the key for which to search.
+ * @param def    The default string to return if the value for which you are
+ *               searching is not found.
+ * @return       The string value of the swift_val matching the given name,
+ *               if found.  If not found, the default string is returned.
+ *
+ * NOTE: The value is returned as an 8-bit string (which is UTF-8 encoded if
+ *       you created it with swift_val_string16, otherwise the encoding is
+ *       unspecified).
+ **/
+SWIFT_API
+const char * SWIFT_CALLCONV swift_params_get_string(const swift_params *params,
+                                                    const char *name,
+                                                    const char *def);
+
+/**
+ * Search within a list of params for a key matching the given name.
+ *
+ * @param params The list of params in which to search for the key.
+ * @param name   The name of the key for which to search.
+ * @param def    The default integer value to return if the value for which
+ *               you are searching is not found.
+ * @return       The integer value of the swift_val matching the name given,
+ *               if found.  If not found, the default integer is returned.
+ **/
+SWIFT_API
+int SWIFT_CALLCONV swift_params_get_int(const swift_params *params,
+                                        const char *name,
+                                        int def);
+
+/**
+ * Search within a list of params for a key matching the given name.
+ *
+ * @param params The list of params in which to search for the key.
+ * @param name   The name of the key for which to search.
+ * @param def    The default floating-point value to return if the value for
+ *               which you are searching is not found.
+ * @return       The floating-point value of the swift_val matching the name
+ *               given, if found.  If not found, the default floating-point
+ *               value is returned.
+ **/
+SWIFT_API
+float SWIFT_CALLCONV swift_params_get_float(const swift_params *params,
+                                            const char *name,
+                                            float def);
+
+/** Types of parameters that can be set in the engine, port, or voice. */
+typedef enum {
+    SWIFT_PARAM_NONE = -1, /**< Invalid parameter. */
+    SWIFT_PARAM_FLAG,      /**< True or false (1/0). */
+    SWIFT_PARAM_INT,       /**< Integer value. */
+    SWIFT_PARAM_FLOAT,     /**< Floating point value. */
+    SWIFT_PARAM_STRING,    /**< String value. */
+    SWIFT_PARAM_ENUM       /**< Enumerated value. */
+} swift_param_type_t;
+
+/** Descriptor for an engine/port/voice parameter. */
+typedef struct swift_param_desc {
+    const char *name;        /**< Name of parameter (passed to set function). */
+    const char *help;        /**< Textual description of parameter. */
+    swift_param_type_t type; /**< Type of data accepted. */
+    int undocumented;        /**< Undocumented. */
+    const char **enum_vals;  /**< Enumeration values. */
+    void *reserved[3];       /**< Reserved for future use. */
+} swift_param_desc;
+
+/** List of descriptors for valid parameters. */
+SWIFT_API
+extern const swift_param_desc swift_param_descriptors[];
+
+/**
+ * Validate a key/value pair based on swift_param_descriptors.
+ *
+ * @param name The name of the key to validate.
+ * @param val  The value to validate against the descriptors.
+ * @return     TRUE if the key/value pair is valid.  FALSE if not.
+ **/
+int swift_param_validate(const char *name,
+                         const swift_val *val);
+
+/**
+ * Copy and validate parameters from one swift_params list to another.
+ *
+ * @param to   The list of swift_parms to which to copy.
+ * @param from The list of swift_params from which to copy.
+ * @return     SWIFT_SUCCESS if all parameters are copied successfully,<br>
+ *             SWIFT_INVALID_PARAM if any of the parameters don't validate.
+ **/
+SWIFT_API
+swift_result_t SWIFT_CALLCONV
+swift_params_set_params(swift_params *to,
+                        const swift_params *from);
+
+/**
+ * Set one parameter in a parameter list, with validation.
+ *
+ * @param to   The list of params in which to set the parameter.
+ * @param name The name of the parameter to set within the list of params.
+ * @param val  The value of the parameter to set within the list of params.
+ * @return     SWIFT_SUCCESS if the parameter is copied successfully,<br>
+ *             SWIFT_INVALID_PARAM if the parameter does not validate.
+ **/
+SWIFT_API
+swift_result_t SWIFT_CALLCONV swift_params_set_param(swift_params *to,
+                                                     const char *name,
+                                                     const swift_val *val);
+
+/**
+ * Create an integer-typed swift_val object.
+ *
+ * @param i The integer value to set within the swift_val.
+ * @return  The newly-created integer-typed swift_val object.
+ **/
+SWIFT_API
+swift_val * SWIFT_CALLCONV swift_val_int(int i);
+
+/**
+ * Create a floating-point-typed swift_val object.
+ *
+ * @param f The floating-point value to set within the swift_val.
+ * @return  The newly-created floating-point-typed swift_val object.
+ **/
+SWIFT_API
+swift_val * SWIFT_CALLCONV swift_val_float(float f);
+
+/**
+ * Create a character string-typed swift_val object.
+ *
+ * @param s The character string value to set within the swift_val.
+ * @return  The newly-created character string-typed swift_val object.
+ **/
+SWIFT_API
+swift_val * SWIFT_CALLCONV swift_val_string(const char *s);
+
+/**
+ * Create a UTF-16-encoded character string-typed swift_val object.
+ *
+ * @param s The UTF-16-encoded character string value to set within the
+ *          swift_val.
+ * @return  The newly-created UTF-16-encoded character string-typed swift_val
+ *          object.
+ **/
+SWIFT_API
+swift_val * SWIFT_CALLCONV swift_val_string16(const unsigned short *s);
+
+/**
+ * Claim ownership of the parameter list (increase its reference count).
+ *
+ * @param val The swift_val for which to increase the reference count.
+ * @return    The reference-counted swift_val that was passed in.
+ **/
+SWIFT_API
+swift_val * SWIFT_CALLCONV swift_val_ref(swift_val *val);
+
+/**
+ * Relinquish ownership of a swift_val object (decrease its reference count).
+ *
+ * @param val The swift_val for which to decrease the reference count.
+ * @return    The reference-decreased swift_val that was passed in.
+ *
+ * NOTE: This function decreases the reference count for the swift_val.
+ *       If the reference count reaches zero, the swift_val is deleted.
+ **/
+SWIFT_API
+swift_result_t SWIFT_CALLCONV swift_val_delete(swift_val *val);
+
+/**
+ * Get the integer contents of a swift_val object.
+ *
+ * @param val The swift_val object from which to get the integer value
+ * @return    The integer value of of the swift_val object
+ **/
+SWIFT_API
+int SWIFT_CALLCONV swift_val_get_int(const swift_val *val);
+
+/**
+ * Get the floating-point contents of a swift_val object.
+ *
+ * @param val The swift_val object from which to get the floating-point value.
+ * @return    The floating-point value of of the swift_val object
+ **/
+SWIFT_API
+float SWIFT_CALLCONV swift_val_get_float(const swift_val *val);
+
+/**
+ * Get the string contents of a swift_val object.
+ *
+ * @param val The swift_val object from which to get the string value.
+ *
+ * Note that the swift_val object retains ownership of the string.
+ *
+ * If val is an integer or floating-point swift_val, it will be
+ * silently "promoted" to a string.
+ *
+ * The contents are returned as an 8-bit string (which is UTF-8
+ * encoded if you created it with swift_val_string16, otherwise the
+ * encoding is unspecified).
+ **/
+SWIFT_API
+const char * SWIFT_CALLCONV swift_val_get_string(const swift_val *val);
+
+#endif /* _SWIFT_PARAMS_H_ */