diff options
author | Naveen Bobbili <nbobbili@amazon.com> | 2018-11-12 16:12:38 -0800 |
---|---|---|
committer | Naveen Bobbili <nbobbili@amazon.com> | 2018-11-13 15:05:41 -0800 |
commit | b6abca2edcb36c0c0848d1cd8dc291f23293aa80 (patch) | |
tree | a838812e0b66f0695cb6cf0f8bebfa38315ce8b8 /src/plugins/core/include | |
parent | be70712f89eacd20dca413bcce46e4aa26b5709e (diff) |
SPEC-1924: AGL Speech Framework's Voice Service High Level 1.0 Release.
Details:
1) Control plugin implementation for VSHL 1.0
2) Exposed APIs that are documented in the confluence page
https://confluence.automotivelinux.org/display/SPE/Speech+EG+Architecture
3) Implemented 39 unit tests based on GTest framework to test all the low
level components of VSHL binding.
4) Implemented a HTML5 based VSHL API tester application to test VSHL APIs.
API specification:
https://confluence.automotivelinux.org/display/SPE/Speech+EG+Architecture#SpeechEGArchitecture-HighLevelVoiceService
Test performed:
1) Tested AGL service running Alexa Auto SDK https://github.com/alexa/aac-sdk on Ubuntu 16.04 and Renesas R-Car M3 board.
License:
Apache 2.0
Developers/Owners:
Naveen Bobbili (nbobbili@amazon.com)
Prakash Buddhiraja (buddhip@amazon.com)
Shotaro Uchida (shotaru@amazon.co.jp)
Change-Id: I3370f4ad65aff030f24f4ad571fb02d525bbfbca
Signed-off-by: Naveen Bobbili <nbobbili@amazon.com>
Diffstat (limited to 'src/plugins/core/include')
-rw-r--r-- | src/plugins/core/include/VRAgentsObserver.h | 67 | ||||
-rw-r--r-- | src/plugins/core/include/VRRequest.h | 80 | ||||
-rw-r--r-- | src/plugins/core/include/VRRequestProcessorDelegate.h | 88 |
3 files changed, 235 insertions, 0 deletions
diff --git a/src/plugins/core/include/VRAgentsObserver.h b/src/plugins/core/include/VRAgentsObserver.h new file mode 100644 index 0000000..d4c0c7b --- /dev/null +++ b/src/plugins/core/include/VRAgentsObserver.h @@ -0,0 +1,67 @@ +/* + * Copyright 2018-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"). + * You may not use this file except in compliance with the License. + * A copy of the License is located at + * + * http://aws.amazon.com/apache2.0/ + * + * or in the "license" file accompanying this file. This file is distributed + * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either + * express or implied. See the License for the specific language governing + * permissions and limitations under the License. + */ +#ifndef VSHL_CORE_INCLUDE_VR_AGENTS_OBSERVER_H_ +#define VSHL_CORE_INCLUDE_VR_AGENTS_OBSERVER_H_ + +#include <memory> + +#include "core/include/VRRequestProcessorDelegate.h" +#include "interfaces/voiceagents/IVoiceAgentsChangeObserver.h" +#include "utilities/logging/Logger.h" + +using namespace std; + +namespace vshl { +namespace core { +/* + * This class will observe the changes to the voiceagents data and transfers + * the actual handling responsibility to its delegate. + */ +class VRAgentsObserver + : public vshl::common::interfaces::IVoiceAgentsChangeObserver { +public: + // Create a VRAgentsObserver. + static shared_ptr<VRAgentsObserver> + create(weak_ptr<VRRequestProcessorDelegate> delegate); + + ~VRAgentsObserver(); + +protected: + void OnDefaultVoiceAgentChanged( + shared_ptr<vshl::common::interfaces::IVoiceAgent> defaultVoiceAgent) + override; + void OnVoiceAgentAdded( + shared_ptr<vshl::common::interfaces::IVoiceAgent> voiceAgent) override; + void OnVoiceAgentRemoved( + shared_ptr<vshl::common::interfaces::IVoiceAgent> voiceAgent) override; + void OnVoiceAgentActiveWakeWordChanged( + shared_ptr<vshl::common::interfaces::IVoiceAgent> voiceAgent) override; + void OnVoiceAgentActivated( + shared_ptr<vshl::common::interfaces::IVoiceAgent> voiceAgent) override; + void OnVoiceAgentDeactivated( + shared_ptr<vshl::common::interfaces::IVoiceAgent> voiceAgent) override; + +private: + // Constructor + VRAgentsObserver(weak_ptr<VRRequestProcessorDelegate> delegate); + + // Delegate that needs to be informed of the voiceagent data changes. + weak_ptr<VRRequestProcessorDelegate> mWeakDelegate; +}; + +} // namespace core +} // namespace vshl + +#endif // VSHL_CORE_INCLUDE_VR_AGENTS_OBSERVER_H_ diff --git a/src/plugins/core/include/VRRequest.h b/src/plugins/core/include/VRRequest.h new file mode 100644 index 0000000..522ec78 --- /dev/null +++ b/src/plugins/core/include/VRRequest.h @@ -0,0 +1,80 @@ +/* + * Copyright 2018-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"). + * You may not use this file except in compliance with the License. + * A copy of the License is located at + * + * http://aws.amazon.com/apache2.0/ + * + * or in the "license" file accompanying this file. This file is distributed + * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either + * express or implied. See the License for the specific language governing + * permissions and limitations under the License. + */ +#ifndef VSHL_CORE_INCLUDE_VR_REQUEST_H_ +#define VSHL_CORE_INCLUDE_VR_REQUEST_H_ + +#include <memory> + +#include "interfaces/afb/IAFBApi.h" +#include "interfaces/utilities/logging/ILogger.h" +#include "interfaces/voiceagents/IVoiceAgent.h" + +using namespace std; + +namespace vshl { +namespace core { +/* + * This class implements the notion of a Voice Recognition Request. + * Each VR Request is currently mapped to one voice agent. + */ +class VRRequest { +public: + // API Verbs + static std::string VA_VERB_STARTLISTENING; + static std::string VA_VERB_CANCEL; + + // Create a VRRequest. + static unique_ptr<VRRequest> create( + shared_ptr<vshl::common::interfaces::ILogger> logger, + shared_ptr<vshl::common::interfaces::IAFBApi> afbApi, + string requestId, + shared_ptr<vshl::common::interfaces::IVoiceAgent> voiceAgent); + + // Destructor + ~VRRequest(); + + // Invokes the underlying voiceagent's startlistening API. + // Returns true if started successfully. False otherwise. + bool startListening(); + + // Cancels the voice recognition in the unlerlying voiceagent. + // Returns true if canceled successfully. False otherwise. + bool cancel(); + +private: + // Constructor + VRRequest( + shared_ptr<vshl::common::interfaces::ILogger> logger, + shared_ptr<vshl::common::interfaces::IAFBApi> afbApi, + const string requestId, + shared_ptr<vshl::common::interfaces::IVoiceAgent> voiceAgent); + + // Binding API reference. + shared_ptr<vshl::common::interfaces::IAFBApi> mApi; + + // Voice agent associated with this request + shared_ptr<vshl::common::interfaces::IVoiceAgent> mVoiceAgent; + + // Request ID + string mRequestId; + + // Logger + shared_ptr<vshl::common::interfaces::ILogger> mLogger; +}; + +} // namespace core +} // namespace vshl + +#endif // VSHL_CORE_INCLUDE_VR_REQUEST_H_ diff --git a/src/plugins/core/include/VRRequestProcessorDelegate.h b/src/plugins/core/include/VRRequestProcessorDelegate.h new file mode 100644 index 0000000..94b7304 --- /dev/null +++ b/src/plugins/core/include/VRRequestProcessorDelegate.h @@ -0,0 +1,88 @@ +/* + * Copyright 2018-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"). + * You may not use this file except in compliance with the License. + * A copy of the License is located at + * + * http://aws.amazon.com/apache2.0/ + * + * or in the "license" file accompanying this file. This file is distributed + * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either + * express or implied. See the License for the specific language governing + * permissions and limitations under the License. + */ +#ifndef VSHL_CORE_INCLUDE_VR_REQUESTPROCESSORDELEGATE_H_ +#define VSHL_CORE_INCLUDE_VR_REQUESTPROCESSORDELEGATE_H_ + +#include <memory> +#include <unordered_map> + +#include "core/include/VRRequest.h" +#include "interfaces/afb/IAFBApi.h" +#include "interfaces/utilities/logging/ILogger.h" +#include "interfaces/voiceagents/IVoiceAgent.h" +#include "utilities/uuid/UUIDGeneration.h" + +using namespace std; + +namespace vshl { +namespace core { +/* + * This is a delegate for VRRequestProcessor actions. + * The lifetime and dependencies of this object is managed + * by VRRequestProcessor. It plays the role of a Delegate in + * Delegate pattern and a one shop stop for most of the core + * module's state. + */ +class VRRequestProcessorDelegate { +public: + // create method + static shared_ptr<VRRequestProcessorDelegate> create( + shared_ptr<vshl::common::interfaces::ILogger> logger, + shared_ptr<vshl::common::interfaces::IAFBApi> afbApi); + + // Destructor + ~VRRequestProcessorDelegate(); + + // Set default voiceagent + void setDefaultVoiceAgent(shared_ptr<vshl::common::interfaces::IVoiceAgent> voiceAgent); + + // Get the default voiceagent + shared_ptr<vshl::common::interfaces::IVoiceAgent> getDefaultVoiceAgent() const; + + // Add new request to the list and start processing it. + // New request is created and startListening on the + // voiceagent is called. + string startRequestForVoiceAgent(shared_ptr<vshl::common::interfaces::IVoiceAgent> voiceAgent); + + // Cancel all requests + void cancelAllRequests(); + + // Get All outstanding requests + // Used only by Test + unordered_map<string, shared_ptr<VRRequest>> getAllRequests(); + +private: + // Constructor + VRRequestProcessorDelegate( + shared_ptr<vshl::common::interfaces::ILogger> logger, + shared_ptr<vshl::common::interfaces::IAFBApi> afbApi); + + // Binding API reference + shared_ptr<vshl::common::interfaces::IAFBApi> mApi; + + // Default voiceagent + shared_ptr<vshl::common::interfaces::IVoiceAgent> mDefaultVoiceAgent; + + // A map of voiceagent IDs and their respective VR Request objects. + unordered_map<string, shared_ptr<VRRequest>> mVRRequests; + + // Logger + shared_ptr<vshl::common::interfaces::ILogger> mLogger; +}; + +} // namespace core +} // namespace vshl + +#endif // VSHL_CORE_INCLUDE_VR_REQUESTPROCESSORDELEGATE_H_ |