// FluencyAPI.h
//
// C/C++ header file for Fluency API
// Copyright (C) 2008 Fluency, Amsterdam

// implementation in FluencyAPI.cpp

// see www.fluency.nl/api for documentation


// sync events

#define SYNC_START		0
#define SYNC_PROGRESS	1
#define SYNC_FINISH		2
#define SYNC_PHONEME	3
#define SYNC_SCAN		4

// load dll

HINSTANCE fluencyLoadDLL(char *TTSPath);

// API functions

unsigned fluencyGetMajorVersion(void);
unsigned fluencyGetMinorVersion(void);
void fluencyAboutWindow(HWND Win);
void fluencyUnlock(char *Key, char *Extra);
bool fluencyInitialize(void);
bool fluencyInitializeFrom(char *TTSPath, char *UserPath);
void fluencyClose(void);
unsigned fluencyGetVoiceCount(void);
unsigned fluencyGetVoiceName(unsigned VoiceIndex, char *Name, unsigned MaxLen);
void *fluencyCreateVoice(char *Name);
void fluencyDeleteVoice(void *Voice);
void *fluencyCreateChannel(void *Voice, unsigned SamplingRate, bool Stereo);
void fluencyDeleteChannel(void *Channel);
void fluencySetVoice(void *Channel, void *Voice);
void fluencySetTempo(void *Channel, int Tempo);
void fluencySetVolume(void *Channel, unsigned Volume);
void fluencySetBalance(void *Channel, int Balance);
void fluencySetInputText(void *Channel, char *Text);
bool fluencyGetPhone(void *Channel, char **Phone, unsigned *Samples, void **Wav, unsigned *TextIndex, unsigned *WordLength);
bool fluencySpeak(void *Channel, void *Sync, unsigned User);
void fluencyStopSpeaking(void *Channel);
void fluencyPauseResumeSpeaking(void *Channel);
void fluencySpeakToFile(void *Channel, char *Filename, void *Sync, unsigned User);
void fluencyAbortSpeakToFile(void *Channel);
void fluencyScanText(void *Channel, unsigned Sensitivity, void *Sync, unsigned User);
void fluencyAbortScanText(void *Channel);
unsigned fluencyGetPreferredVoiceName(char *Name, unsigned MaxLen);
void fluencySetPreferredVoiceName(char *Name); 
int fluencyGetPreferredTempo(void);
unsigned fluencyGetPreferredVolume(void);
int fluencyGetPreferredBalance(void);
void fluencySetPreferredTempo(int Tempo);
void fluencySetPreferredVolume(unsigned Volume);
void fluencySetPreferredBalance(int Balance);
unsigned fluencyGetReadingMode(void);
void fluencySetReadingMode(unsigned Mode);
unsigned fluencyGetSpellOutMode(void);
void fluencySetSpellOutMode(unsigned Mode);
bool fluencyGetPunctuationMode(void);
void fluencySetPunctuationMode(bool Mode);
void fluencySaveSettings(void);
void fluencyUpdateSettings(void);
unsigned fluencyLookupWord(char *Word, char *Transcription, unsigned MaxLen);
void fluencyAddWord(char *Word, char *Transcription);
unsigned fluencyUserLexiconNextWord(char *Word, char *NextWord, unsigned MaxLen);
unsigned fluencyGetUserDataPath(char *Path, unsigned MaxLen);