client/tts_client.h

   1 /*
   2 *  Copyright (c) 2011-2016 Samsung Electronics Co., Ltd All Rights Reserved
   3 *  Licensed under the Apache License, Version 2.0 (the "License");
   4 *  you may not use this file except in compliance with the License.
   5 *  You may obtain a copy of the License at
   6 *  http://www.apache.org/licenses/LICENSE-2.0
   7 *  Unless required by applicable law or agreed to in writing, software
   8 *  distributed under the License is distributed on an "AS IS" BASIS,
   9 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  10 *  See the License for the specific language governing permissions and
  11 *  limitations under the License.
  12 */
  13
  14
  15 #ifndef __TTS_CLIENT_H_
  16 #define __TTS_CLIENT_H_
  17
  18 #include <Ecore.h>
  19
  20 #include "tts.h"
  21 #include "tts_config_mgr.h"
  22 #include "tts_main.h"
  23
  24 #ifdef __cplusplus
  25 extern "C" {
  26 #endif
  27
  28
  29 #define TTS_STATE_INVALID -1
  30
  31 typedef struct {
  32         /* base info */
  33         tts_h   tts;
  34         int     pid;
  35         unsigned int    uid;                    /*<< unique id = pid + handle */
  36         int     current_utt_id;
  37
  38         /* callback info */
  39         tts_state_changed_cb            state_changed_cb;
  40         void*                           state_changed_user_data;
  41         tts_utterance_started_cb        utt_started_cb;
  42         void*                           utt_started_user_data;
  43         tts_utterance_completed_cb      utt_completed_cb;
  44         void*                           utt_completed_user_data;
  45         tts_error_cb                    error_cb;
  46         void*                           error_user_data;
  47         tts_default_voice_changed_cb    default_voice_changed_cb;
  48         void*                           default_voice_changed_user_data;
  49         tts_engine_changed_cb           engine_changed_cb;
  50         void*                           engine_changed_user_data;
  51         tts_screen_reader_changed_cb    screen_reader_changed_cb;
  52         void*                           screen_reader_changed_user_data;
  53         tts_supported_voice_cb          supported_voice_cb;
  54         void*                           supported_voice_user_data;
  55
  56         /* mode / state */
  57         tts_mode_e      mode;
  58         tts_state_e     before_state;
  59         tts_state_e     current_state;
  60
  61         /* semaphore */
  62         int             cb_ref_count;
  63
  64         /* callback data */
  65         int             utt_id;
  66         int             reason;
  67         char*           err_msg;
  68
  69         /* connection */
  70         int             prepare_count;
  71         Ecore_Timer*    hello_timer;
  72         bool start_listening;
  73         bool reprepared;
  74
  75         /* options */
  76         char*           credential;
  77         bool            credential_needed;
  78         bool            internal;
  79
  80         /* repetition */
  81         char*           text_repeat;
  82
  83         /* timer */
  84         Ecore_Timer* notify_error_timer;
  85         Ecore_Timer* notify_state_timer;
  86
  87 } tts_client_s;
  88
  89 int tts_client_new(tts_h* tts);
  90 int tts_client_destroy(tts_h tts);
  91
  92 tts_client_s* tts_client_get(tts_h tts);
  93 tts_client_s* tts_client_get_by_uid(unsigned int uid);
  94 tts_h tts_client_get_handle(tts_client_s* client);
  95
  96 bool tts_client_is_valid_uid(unsigned int uid);
  97 bool tts_client_is_valid_client(tts_client_s* client);
  98
  99 unsigned int tts_client_get_size();
 100
 101 int tts_client_use_callback(tts_client_s* client);
 102 int tts_client_not_use_callback(tts_client_s* client);
 103
 104 int tts_client_get_use_callback(tts_client_s* client);
 105
 106 GList* tts_client_get_client_list();
 107
 108 unsigned int tts_client_get_uid(tts_client_s* client);
 109
 110 void tts_client_set_current_state(tts_client_s* client, tts_state_e state);
 111 tts_state_e tts_client_get_current_state(tts_client_s* client);
 112
 113 void tts_client_set_start_listening(unsigned int uid, bool is_listening_started);
 114 bool tts_client_is_listening_started(unsigned int uid);
 115
 116 void tts_client_set_reprepared(tts_client_s* client, bool is_reprepared);
 117 bool tts_client_is_reprepared(tts_client_s* client);
 118
 119 void tts_client_set_mode(tts_client_s* client, tts_mode_e mode);
 120 tts_mode_e tts_client_get_mode(tts_client_s* client);
 121
 122 void tts_client_set_repeat_text(tts_client_s* client, const char* text);
 123 const char* tts_client_get_repeat_text(tts_client_s* client);
 124
 125 int tts_client_new_utterance_id(tts_client_s* client);
 126
 127 void tts_client_set_error_message(tts_client_s* client, const char* error_message);
 128 const char* tts_client_get_error_message(tts_client_s* client);
 129
 130 void tts_client_set_credential_key(tts_client_s* client, const char* credential_key);
 131 const char* tts_client_get_credential_key(tts_client_s* client);
 132
 133 void tts_client_set_state_changed_cb(tts_client_s* client, tts_state_changed_cb callback, void* user_data);
 134 void tts_client_set_utterance_started_cb(tts_client_s* client, tts_utterance_started_cb callback, void* user_data);
 135 void tts_client_set_utterance_completed_cb(tts_client_s* client, tts_utterance_completed_cb callback, void* user_data);
 136 void tts_client_set_error_cb(tts_client_s* client, tts_error_cb callback, void* user_data);
 137 void tts_client_set_default_voice_changed_cb(tts_client_s* client, tts_default_voice_changed_cb callback, void* user_data);
 138 void tts_client_set_engine_changed_cb(tts_client_s* client, tts_engine_changed_cb callback, void* user_data);
 139 void tts_client_set_screen_reader_changed_cb(tts_client_s* client, tts_screen_reader_changed_cb callback, void* user_data);
 140 void tts_client_set_supported_voice_cb(tts_client_s* client, tts_supported_voice_cb callback, void* user_data);
 141
 142 tts_state_changed_cb tts_client_get_state_changed_cb(tts_client_s* client);
 143 void* tts_client_get_state_changed_user_data(tts_client_s* client);
 144
 145 tts_utterance_started_cb tts_client_get_utterance_started_cb(tts_client_s* client);
 146 void* tts_client_get_utterance_started_user_data(tts_client_s* client);
 147
 148 tts_utterance_completed_cb tts_client_get_utterance_completed_cb(tts_client_s* client);
 149 void* tts_client_get_utterance_completed_user_data(tts_client_s* client);
 150
 151 tts_error_cb tts_client_get_error_cb(tts_client_s* client);
 152 void* tts_client_get_error_user_data(tts_client_s* client);
 153
 154 tts_default_voice_changed_cb tts_client_get_default_voice_changed_cb(tts_client_s* client);
 155 void* tts_client_get_default_voice_changed_user_data(tts_client_s* client);
 156
 157 tts_engine_changed_cb tts_client_get_engine_changed_cb(tts_client_s* client);
 158 void* tts_client_get_engine_changed_user_data(tts_client_s* client);
 159
 160 tts_screen_reader_changed_cb tts_client_get_screen_reader_changed_cb(tts_client_s* client);
 161 void* tts_client_get_screen_reader_changed_user_data(tts_client_s* client);
 162
 163 tts_supported_voice_cb tts_client_get_supported_voice_cb(tts_client_s* client);
 164 void* tts_client_get_supported_voice_user_data(tts_client_s* client);
 165
 166 void tts_client_unset_all_cb(tts_client_s* client);
 167
 168 #ifdef __cplusplus
 169 }
 170 #endif
 171
 172 #endif /* __TTS_CLIENT_H_ */