1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
|
/*
Copyright (c) 2013, Ford Motor Company
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following
disclaimer in the documentation and/or other materials provided with the
distribution.
Neither the name of the Ford Motor Company nor the names of its contributors
may be used to endorse or promote products derived from this software
without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_COMMANDS_PERFORM_AUDIO_PASS_THRU_REQUEST_H_
#define SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_COMMANDS_PERFORM_AUDIO_PASS_THRU_REQUEST_H_
#include "application_manager/commands/command_request_impl.h"
#include "utils/macro.h"
#include "interfaces/MOBILE_API.h"
namespace application_manager {
namespace commands {
/**
* @brief PerformAudioPassThruRequest command class
**/
class PerformAudioPassThruRequest : public CommandRequestImpl {
public:
/**
* @brief PerformAudioPassThruRequest class constructor
*
* @param message Incoming SmartObject message
**/
PerformAudioPassThruRequest(const MessageSharedPtr& message,
ApplicationManager& application_manager);
/**
* @brief PerformAudioPassThruRequest class destructor
**/
virtual ~PerformAudioPassThruRequest();
/**
* @brief Function is called by RequestController when request execution time
* has exceed it's limit
*
*/
virtual void onTimeOut();
/**
* @brief Init required by command resources
**/
bool Init();
/**
* @brief Execute command
**/
virtual void Run();
/**
* @brief Interface method that is called whenever new event received
*
* @param event The received event
*/
void on_event(const event_engine::Event& event);
private:
/**
* @brief Prepare result code, result and info for sending to mobile
* application
* @param result_code contains result code for sending to mobile application
* @return result for sending to mobile application.
*/
bool PrepareResponseParameters(mobile_apis::Result::eType& result_code,
std::string& info);
/**
* @brief Sends TTS Speak request
*/
void SendSpeakRequest();
/**
* @brief Sends UI PerformAudioPassThru request
*/
void SendPerformAudioPassThruRequest();
/**
* @brief Sends UI RecordStart notification after TTS Speak response received.
* Indicates that capturing mic data should be started
*/
void SendRecordStartNotification();
/**
* @brief Starts microphone recording
*/
void StartMicrophoneRecording();
/**
* @brief Checks perform audio pass thru params(initialPrompt, ...).
* When type is String there is a check on the contents \t\n \\t \\n
* @return if perform audio pass thru contains \t\n \\t \\n return TRUE,
* FALSE otherwise
*/
bool IsWhiteSpaceExist();
/**
* @brief If is_active_tts_speak_ TRUE - set up to FALSE and send request
* TTS_StopSpeaking to HMI
*/
void FinishTTSSpeak();
/*
* @brief Tells if there are sent requests without responses
*/
bool IsWaitingHMIResponse();
/**
* @brief Validates audioPassThruIcon parameter and
* removes it if is not valid
* @param app Pointer to the application whose storage directory
* must be accessed
*/
void ProcessAudioPassThruIcon(ApplicationSharedPtr app);
/**
* @brief Checks if the audioPassThruIcon parameter value
* contains special characters (\n,\t) or
* contains only white spaces
* @return If the audioPassthruIcon parameter value contains
* above mentioned symbols, the function returns FALSE, else
* the parameter value is valid and it returns TRUE
*/
bool IsAudioPassThruIconParamValid();
/**
* @brief Checks result code from HMI for splitted RPC
* and returns parameter for sending to mobile app in
* audioPassThru communication.
* @param ui_response contains result_code from UI
* @param tts_response contains result_code from TTS
* @return result code - 1) UI error code has precedence than TTS's
* 2) error_code from TTS is turned to WARNINGS
*/
mobile_apis::Result::eType PrepareAudioPassThruResultCodeForResponse(
const ResponseInfo& ui_response, const ResponseInfo& tts_response);
/**
* @brief Checks if any of audioPassThru communication components
* returned ABORTED code
* @param ui contains result_code from UI
* @param tts contains result_code from TTS
* @return if TTS or UI responded with ABORTED function returns TRUE,
* else is returns FALSE
*/
bool IsAnyHMIComponentAborted(const ResponseInfo& ui,
const ResponseInfo& tts);
/* flag display state of speak and ui perform audio
during perform audio pass thru*/
bool awaiting_tts_speak_response_;
bool awaiting_ui_response_;
/* flag shows if last received audioPassThruIcon exists
* in the file system
*/
bool audio_pass_thru_icon_exists_;
hmi_apis::Common_Result::eType result_tts_speak_;
hmi_apis::Common_Result::eType result_ui_;
std::string ui_info_;
std::string tts_info_;
DISALLOW_COPY_AND_ASSIGN(PerformAudioPassThruRequest);
};
} // namespace commands
} // namespace application_manager
#endif // SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_COMMANDS_PERFORM_AUDIO_PASS_THRU_REQUEST_H_
|