161c39eb1ec1b3b1da6084d8a39fd72f85d8b6f0
[platform/core/uifw/voice-control.git] / 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 * Definition 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
49 /******************************************************************************************
50 * Message Definition for all
51 *******************************************************************************************/
52
53 #define VC_METHOD_HELLO                 "vc_method_hello"
54
55 /******************************************************************************************
56 * Message Definition for Client
57 *******************************************************************************************/
58
59 #define VC_METHOD_INITIALIZE            "vc_method_initialize"
60 #define VC_METHOD_FINALIZE              "vc_method_finalilze"
61
62 #define VC_METHOD_SET_EXCLUSIVE_CMD     "vc_method_set_exclusive_cmd"
63 #define VC_METHOD_SET_COMMAND           "vc_method_set_command"
64 #define VC_METHOD_UNSET_COMMAND         "vc_method_unset_command"
65
66 #define VCD_METHOD_RESULT               "vcd_method_result"
67 #define VCD_METHOD_ERROR                "vcd_method_error"
68 #define VCD_METHOD_HELLO                "vcd_method_hello"
69 #define VCD_METHOD_SET_SERVICE_STATE    "vcd_method_set_service_state"
70
71 /* Authority */
72 #if 0
73 #define VC_METHOD_OBTAIN_AUTHORITY      "vc_method_obtain_authority"
74 #define VC_METHOD_RETURN_AUTHORITY      "vc_method_return_authority"
75
76 #define VC_METHOD_REQUEST_START         "vc_method_request_start"
77 #define VC_METHOD_REQUEST_STOP          "vc_method_request_stop"
78 #define VC_METHOD_REQUEST_CANCEL        "vc_method_request_cancel"
79 #endif
80
81 #define VC_METHOD_AUTH_ENABLE           "vc_method_auth_enable"
82 #define VC_METHOD_AUTH_DISABLE          "vc_method_auth_disable"
83
84 #define VC_METHOD_AUTH_START            "vc_method_auth_start"
85 #define VC_METHOD_AUTH_STOP             "vc_method_auth_stop"
86 #define VC_METHOD_AUTH_CANCEL           "vc_method_auth_cancel"
87
88 /******************************************************************************************
89 * Message Definition for widget
90 *******************************************************************************************/
91
92 #define VC_WIDGET_METHOD_INITIALIZE             "vc_widget_method_initialize"
93 #define VC_WIDGET_METHOD_FINALIZE               "vc_widget_method_finalilze"
94
95 #define VC_WIDGET_METHOD_START_RECORDING        "vc_widget_method_start_recording"
96
97 #define VC_WIDGET_METHOD_START                  "vc_widget_method_start"
98 #define VC_WIDGET_METHOD_STOP                   "vc_widget_method_stop"
99 #define VC_WIDGET_METHOD_CANCEL                 "vc_widget_method_cancel"
100
101 #define VCD_WIDGET_METHOD_RESULT                "vcd_widget_method_result"
102 #define VCD_WIDGET_METHOD_ERROR                 "vcd_widget_method_error"
103 #define VCD_WIDGET_METHOD_HELLO                 "vcd_widget_method_hello"
104 #define VCD_WIDGET_METHOD_SHOW_TOOLTIP          "vcd_widget_method_show_tooltip"
105 #define VCD_WIDGET_METHOD_SET_SERVICE_STATE     "vcd_widget_method_set_service_state"
106
107
108 /******************************************************************************************
109 * Message Definition for manager
110 *******************************************************************************************/
111
112 #define VC_MANAGER_METHOD_INITIALIZE            "vc_manager_method_initialize"
113 #define VC_MANAGER_METHOD_FINALIZE              "vc_manager_method_finalilze"
114
115 #define VC_MANAGER_METHOD_SET_COMMAND           "vc_manager_method_set_command"
116 #define VC_MANAGER_METHOD_UNSET_COMMAND         "vc_manager_method_unset_command"
117 #define VC_MANAGER_METHOD_SET_DEMANDABLE        "vc_manager_method_set_demandable_client"
118 #define VC_MANAGER_METHOD_SET_AUDIO_TYPE        "vc_manager_method_set_audio_type"
119 #define VC_MANAGER_METHOD_GET_AUDIO_TYPE        "vc_manager_method_get_audio_type"
120 #define VC_MANAGER_METHOD_SET_CLIENT_INFO       "vc_manager_method_set_client_info"
121
122 #define VC_MANAGER_METHOD_START                 "vc_manager_method_request_start"
123 #define VC_MANAGER_METHOD_STOP                  "vc_manager_method_request_stop"
124 #define VC_MANAGER_METHOD_CANCEL                "vc_manager_method_request_cancel"
125 #define VC_MANAGER_METHOD_RESULT_SELECTION      "vc_manager_method_result_selection"
126
127 #define VCD_MANAGER_METHOD_HELLO                "vcd_manager_method_hello"
128 #define VCD_MANAGER_METHOD_SPEECH_DETECTED      "vcd_manager_method_speech_detected"
129 #define VCD_MANAGER_METHOD_ALL_RESULT           "vcd_manager_method_all_result"
130 #define VCD_MANAGER_METHOD_RESULT               "vcd_manager_method_result"
131 #define VCD_MANAGER_METHOD_SET_VOLUME           "vcd_manager_method_set_volume"
132 #define VCD_MANAGER_METHOD_SET_SERVICE_STATE    "vcd_manager_method_set_service_state"
133
134 #define VCD_MANAGER_METHOD_ERROR                "vcd_manager_method_error"
135
136
137 /******************************************************************************************
138 * Defines for configuration
139 *******************************************************************************************/
140
141 #define VC_DAEMON_PATH                  "/usr/bin/vc-daemon"
142
143 #define VC_CONFIG_DEFAULT               "/usr/share/voice/vc/vc-config.xml"
144
145 #define VC_CONFIG_BASE                  tzplatform_mkpath(TZ_USER_HOME, "share/voice")
146 #define VC_CONFIG                       tzplatform_mkpath(TZ_USER_HOME, "share/voice/vc-config.xml")
147
148 #define VC_DEFAULT_ENGINE_INFO          "/usr/lib/voice/vc/1.0/engine-info"
149
150 #define VC_NO_FOREGROUND_PID            0
151
152 #define VC_BASE_LANGUAGE                "en_US"
153
154 #define VC_RETRY_COUNT                  5
155
156
157 #define VC_RUNTIME_INFO_ROOT            tzplatform_mkpath(TZ_USER_HOME, "share/voice/vc")
158
159 #define VC_RUNTIME_INFO_FOREGROUND      tzplatform_mkpath(TZ_USER_HOME, "share/voice/vc/vc-info-foreground.xml")
160
161 #define VC_RUNTIME_INFO_DEMANDABLE_LIST tzplatform_mkpath(TZ_USER_HOME, "share/voice/vc/vc-demandable-client.xml")
162
163 #define VC_RUNTIME_INFO_RESULT          tzplatform_mkpath(TZ_USER_HOME, "share/voice/vc/vc-result.xml")
164
165 #define VC_RUNTIME_INFO_EX_RESULT       tzplatform_mkpath(TZ_USER_HOME, "share/voice/vc/vc-ex-result.xml")
166
167 #define VC_RUNTIME_INFO_CLIENT          tzplatform_mkpath(TZ_USER_HOME, "share/voice/vc/vc-client-info.xml")
168
169 /******************************************************************************************
170 * Defines for common enum
171 *******************************************************************************************/
172
173 typedef enum {
174         VC_RESULT_TYPE_NORMAL,
175         VC_RESULT_TYPE_NOTIFICATION
176 } vc_result_type_e;
177
178
179 #ifdef __cplusplus
180 }
181 #endif
182
183 #endif /* __VC_DEFS_H__ */