common/vc_defs.h

   1 /*
   2 * Copyright (c) 2011-2015 Samsung Electronics Co., Ltd All Rights Reserved
   3 *
   4 * Licensed under the Apache License, Version 2.0 (the License);
   5 * you may not use this file except in compliance with the License.
   6 * You may obtain a copy of the License at
   7 *
   8 * http://www.apache.org/licenses/LICENSE-2.0
   9 *
  10 * Unless required by applicable law or agreed to in writing, software
  11 * distributed under the License is distributed on an AS IS BASIS,
  12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 * See the License for the specific language governing permissions and
  14 * limitations under the License.
  15 */
  16
  17
  18 #ifndef __VC_DEFS_H__
  19 #define __VC_DEFS_H__
  20
  21 #include <tzplatform_config.h>
  22
  23 #ifdef __cplusplus
  24 extern "C" {
  25 #endif
  26
  27
  28 /******************************************************************************************
  29 * Definitions for Dbus
  30 *******************************************************************************************/
  31
  32 #define VC_CLIENT_SERVICE_NAME         "org.tizen.voice.vcclient"
  33 #define VC_CLIENT_SERVICE_OBJECT_PATH  "/org/tize/voice/vcclient"
  34 #define VC_CLIENT_SERVICE_INTERFACE    "org.tizen.voice.vcclient"
  35
  36 #define VC_WIDGET_SERVICE_NAME        "org.tizen.voice.vcwidget"
  37 #define VC_WIDGET_SERVICE_OBJECT_PATH "/org/tize/voice/vcwidget"
  38 #define VC_WIDGET_SERVICE_INTERFACE   "org.tizen.voice.vcwidget"
  39
  40 #define VC_MANAGER_SERVICE_NAME        "org.tizen.voice.vcmanager"
  41 #define VC_MANAGER_SERVICE_OBJECT_PATH "/org/tize/voice/vcmanager"
  42 #define VC_MANAGER_SERVICE_INTERFACE   "org.tizen.voice.vcmanager"
  43
  44 #define VC_SERVER_SERVICE_NAME         "org.tizen.voice.vcserver"
  45 #define VC_SERVER_SERVICE_OBJECT_PATH  "/org/tizen/voice/vcserver"
  46 #define VC_SERVER_SERVICE_INTERFACE    "org.tizen.voice.vcserver"
  47
  48 #define VC_SETTING_SERVICE_NAME         "org.tizen.voice.vcsetting"
  49 #define VC_SETTING_SERVICE_OBJECT_PATH  "/org/tize/voice/vcsetting"
  50 #define VC_SETTING_SERVICE_INTERFACE    "org.tizen.voice.vcsetting"
  51
  52 /******************************************************************************************
  53 * Message Definition for all
  54 *******************************************************************************************/
  55
  56 #define VC_METHOD_HELLO                 "vc_method_hello"
  57
  58 /******************************************************************************************
  59 * Message Definitions for Client
  60 *******************************************************************************************/
  61
  62 #define VC_METHOD_INITIALIZE            "vc_method_initialize"
  63 #define VC_METHOD_FINALIZE              "vc_method_finalilze"
  64
  65 #define VC_METHOD_SET_EXCLUSIVE_CMD     "vc_method_set_exclusive_cmd"
  66 #define VC_METHOD_SET_COMMAND           "vc_method_set_command"
  67 #define VC_METHOD_UNSET_COMMAND         "vc_method_unset_command"
  68 #define VC_METHOD_SET_FOREGROUND        "vc_method_set_foreground"
  69 #define VC_METHOD_DIALOG                "vc_method_dialog"
  70 #define VC_METHOD_IS_SYS_COMMAND_VALID  "vc_method_is_system_command_valid"
  71
  72 #define VCD_METHOD_RESULT               "vcd_method_result"
  73 #define VCD_METHOD_ERROR                "vcd_method_error"
  74 #define VCD_METHOD_HELLO                "vcd_method_hello"
  75 #define VCD_METHOD_SET_SERVICE_STATE    "vcd_method_set_service_state"
  76 #define VCD_METHOD_SEND_MANAGER_PID     "vcd_method_send_manager_pid"
  77
  78 /* Authority */
  79 #if 0
  80 #define VC_METHOD_OBTAIN_AUTHORITY      "vc_method_obtain_authority"
  81 #define VC_METHOD_RETURN_AUTHORITY      "vc_method_return_authority"
  82
  83 #define VC_METHOD_REQUEST_START         "vc_method_request_start"
  84 #define VC_METHOD_REQUEST_STOP          "vc_method_request_stop"
  85 #define VC_METHOD_REQUEST_CANCEL        "vc_method_request_cancel"
  86 #endif
  87
  88 #define VC_METHOD_AUTH_ENABLE           "vc_method_auth_enable"
  89 #define VC_METHOD_AUTH_DISABLE          "vc_method_auth_disable"
  90
  91 #define VC_METHOD_AUTH_START            "vc_method_auth_start"
  92 #define VC_METHOD_AUTH_STOP             "vc_method_auth_stop"
  93 #define VC_METHOD_AUTH_CANCEL           "vc_method_auth_cancel"
  94
  95 /******************************************************************************************
  96 * Message Definitions for widget
  97 *******************************************************************************************/
  98
  99 #define VC_WIDGET_METHOD_INITIALIZE             "vc_widget_method_initialize"
 100 #define VC_WIDGET_METHOD_FINALIZE               "vc_widget_method_finalilze"
 101
 102 #define VC_WIDGET_METHOD_START_RECORDING        "vc_widget_method_start_recording"
 103
 104 #define VC_WIDGET_METHOD_ENABLE_ASR_RESULT      "vc_widget_method_enable_asr_result"
 105
 106 #define VC_WIDGET_METHOD_START                  "vc_widget_method_start"
 107 #define VC_WIDGET_METHOD_STOP                   "vc_widget_method_stop"
 108 #define VC_WIDGET_METHOD_CANCEL                 "vc_widget_method_cancel"
 109
 110 #define VCD_WIDGET_METHOD_RESULT                "vcd_widget_method_result"
 111 #define VCD_WIDGET_METHOD_ASR_RESULT            "vcd_widget_method_asr_result"
 112 #define VCD_WIDGET_METHOD_ERROR                 "vcd_widget_method_error"
 113 #define VCD_WIDGET_METHOD_HELLO                 "vcd_widget_method_hello"
 114 #define VCD_WIDGET_METHOD_SHOW_TOOLTIP          "vcd_widget_method_show_tooltip"
 115 #define VCD_WIDGET_METHOD_SET_SERVICE_STATE     "vcd_widget_method_set_service_state"
 116
 117
 118 /******************************************************************************************
 119 * Message Definitions for manager
 120 *******************************************************************************************/
 121
 122 #define VC_MANAGER_METHOD_INITIALIZE            "vc_manager_method_initialize"
 123 #define VC_MANAGER_METHOD_FINALIZE              "vc_manager_method_finalilze"
 124
 125 #define VC_MANAGER_METHOD_SET_COMMAND           "vc_manager_method_set_command"
 126 #define VC_MANAGER_METHOD_UNSET_COMMAND         "vc_manager_method_unset_command"
 127 #define VC_MANAGER_METHOD_SET_DEMANDABLE        "vc_manager_method_set_demandable_client"
 128 #define VC_MANAGER_METHOD_SET_AUDIO_TYPE        "vc_manager_method_set_audio_type"
 129 #define VC_MANAGER_METHOD_GET_AUDIO_TYPE        "vc_manager_method_get_audio_type"
 130 #define VC_MANAGER_METHOD_SET_CLIENT_INFO       "vc_manager_method_set_client_info"
 131 #define VC_MANAGER_METHOD_SET_PRIVATE_DATA      "vc_manager_method_set_private_data"
 132 #define VC_MANAGER_METHOD_GET_PRIVATE_DATA      "vc_manager_method_get_private_data"
 133 #define VC_MANAGER_METHOD_ENABLE_COMMAND_TYPE   "vc_manager_method_enable_command_type"
 134 #define VC_MANAGER_METHOD_DISABLE_COMMAND_TYPE  "vc_manager_method_disable_command_type"
 135
 136 #define VC_MANAGER_METHOD_START                 "vc_manager_method_request_start"
 137 #define VC_MANAGER_METHOD_STOP                  "vc_manager_method_request_stop"
 138 #define VC_MANAGER_METHOD_CANCEL                "vc_manager_method_request_cancel"
 139 #define VC_MANAGER_METHOD_RESULT_SELECTION      "vc_manager_method_result_selection"
 140 #define VC_MANAGER_METHOD_SET_DOMAIN            "vc_manager_method_set_domain"
 141 #define VC_MANAGER_METHOD_DO_ACTION             "vc_manager_method_do_action"
 142
 143 #define VCD_MANAGER_METHOD_HELLO                "vcd_manager_method_hello"
 144 #define VCD_MANAGER_METHOD_SPEECH_DETECTED      "vcd_manager_method_speech_detected"
 145 #define VCD_MANAGER_METHOD_ALL_RESULT           "vcd_manager_method_all_result"
 146 #define VCD_MANAGER_METHOD_PRE_RESULT           "vcd_manager_method_pre_result"
 147 #define VCD_MANAGER_METHOD_RESULT               "vcd_manager_method_result"
 148 #define VCD_MANAGER_METHOD_SET_VOLUME           "vcd_manager_method_set_volume"
 149 #define VCD_MANAGER_METHOD_SET_SERVICE_STATE    "vcd_manager_method_set_service_state"
 150 #define VCD_MANAGER_METHOD_DIALOG               "vcd_manager_method_dialog"
 151 #define VCD_MANAGER_METHOD_SET_PRIVATE_DATA     "vcd_manager_set_private_data"
 152 #define VCD_MANAGER_METHOD_GET_PRIVATE_DATA     "vcd_manager_get_private_data"
 153
 154 #define VCD_MANAGER_METHOD_ERROR                "vcd_manager_method_error"
 155
 156 #define VCC_MANAGER_METHOD_SET_FOREGROUND       "vcd_manager_method_set_foreground"
 157
 158
 159
 160 /******************************************************************************************
 161 * Message Definitions for setting
 162 *******************************************************************************************/
 163
 164 #define VC_SETTING_METHOD_SET_LANGUAGE          "vc_setting_method_set_language"
 165
 166
 167 /******************************************************************************************
 168 * Definitions for configuration
 169 *******************************************************************************************/
 170
 171 #define VC_DAEMON_PATH                  tzplatform_mkpath(TZ_SYS_BIN, "vc-daemon")
 172
 173 #define VC_CONFIG_DEFAULT               tzplatform_mkpath(TZ_SYS_RO_SHARE, "voice/vc/1.0/vc-config.xml")
 174
 175 #define VC_DEFAULT_BASE                 tzplatform_mkpath(TZ_SYS_RO_SHARE, "voice/vc/1.0")
 176
 177 #define VC_DEFAULT_ENGINE               tzplatform_mkpath(TZ_SYS_RO_SHARE, "voice/vc/1.0/engine")
 178
 179 #define VC_DEFAULT_ENGINE_SETTING       tzplatform_mkpath(TZ_SYS_RO_SHARE, "voice/vc/1.0/engine-setting")
 180
 181 #define VC_DEFAULT_ENGINE_INFO          tzplatform_mkpath(TZ_SYS_RO_SHARE, "voice/vc/1.0/engine-info")
 182
 183 #define VC_CONFIG_BASE                  tzplatform_mkpath(TZ_USER_HOME, "share/.voice")
 184
 185 #define VC_CONFIG                       tzplatform_mkpath(TZ_USER_HOME, "share/.voice/vc-config.xml")
 186
 187 #define VC_RUNTIME_INFO_ROOT            tzplatform_mkpath(TZ_USER_HOME, "share/.voice/vc")
 188
 189 #define VC_RUNTIME_INFO_FOREGROUND      tzplatform_mkpath(TZ_USER_HOME, "share/.voice/vc/vc-info-foreground.xml")
 190
 191 #define VC_RUNTIME_INFO_DEMANDABLE_LIST tzplatform_mkpath(TZ_USER_HOME, "share/.voice/vc/vc-demandable-client.xml")
 192
 193 #define VC_RUNTIME_INFO_RESULT          tzplatform_mkpath(TZ_USER_HOME, "share/.voice/vc/vc-result.xml")
 194
 195 #define VC_RUNTIME_INFO_EX_RESULT       tzplatform_mkpath(TZ_USER_HOME, "share/.voice/vc/vc-ex-result.xml")
 196
 197 #define VC_RUNTIME_INFO_NLU_RESULT      tzplatform_mkpath(TZ_USER_HOME, "share/.voice/vc/vc-nlu-result.xml")
 198
 199 #define VC_RUNTIME_INFO_CLIENT          tzplatform_mkpath(TZ_USER_HOME, "share/.voice/vc/vc-client-info.xml")
 200
 201 #define VC_NO_FOREGROUND_PID            -1
 202 #define VC_BASE_LANGUAGE                "en_US"
 203 #define VC_RETRY_COUNT                  5
 204 #define VC_RUNTIME_INFO_NO_FOREGROUND   -1
 205 #define VC_CONNECTION_RETRY_COUNT       10
 206
 207 #define VC_FEATURE_PATH                 "tizen.org/feature/speech.control"
 208 #define VC_MIC_FEATURE_PATH             "tizen.org/feature/microphone"
 209
 210 #define VC_PRIVILEGE                    "http://tizen.org/privilege/recorder"
 211
 212 /******************************************************************************************
 213 * Definitions for common enum
 214 *******************************************************************************************/
 215
 216 typedef enum {
 217         VC_RESULT_TYPE_NORMAL,
 218         VC_RESULT_TYPE_NOTIFICATION
 219 } vc_result_type_e;
 220
 221
 222 #ifdef __cplusplus
 223 }
 224 #endif
 225
 226 #endif /* __VC_DEFS_H__ */