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/interfaces/voiceagents | |
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/interfaces/voiceagents')
-rw-r--r-- | src/plugins/interfaces/voiceagents/IVoiceAgent.h | 95 | ||||
-rw-r--r-- | src/plugins/interfaces/voiceagents/IVoiceAgentsChangeObserver.h | 80 |
2 files changed, 175 insertions, 0 deletions
diff --git a/src/plugins/interfaces/voiceagents/IVoiceAgent.h b/src/plugins/interfaces/voiceagents/IVoiceAgent.h new file mode 100644 index 0000000..367ad72 --- /dev/null +++ b/src/plugins/interfaces/voiceagents/IVoiceAgent.h @@ -0,0 +1,95 @@ +/* + * 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_COMMON_INTERFACES_IVOICEAGENT_H_ +#define VSHL_COMMON_INTERFACES_IVOICEAGENT_H_ + +#include <memory> +#include <string> +#include <unordered_set> + +using namespace std; + +namespace vshl { +namespace common { +namespace interfaces { + +/* + * This interface define the structure for VoiceAgent Information. + * The implementation of this structure is owned by voiceagents module. + */ +class IVoiceAgent { +public: + /* + * Set the active wakeword for this voiceagent + */ + virtual bool setActiveWakeWord(const string &wakeword) = 0; + + /* + * Sets the activation state of this voiceagent + */ + virtual void setIsActive(bool active) = 0; + + /* + * Returns the voiceagent's ID. + */ + virtual string getId() const = 0; + + /* + * Returns the voiceagent's name. + */ + virtual string getName() const = 0; + + /* + * Returns the voiceagent's description. + */ + virtual string getDescription() const = 0; + + /* + * Returns the voiceagent's API. + */ + virtual string getApi() const = 0; + + /* + * Returns the voiceagent's vendor information/ + */ + virtual string getVendor() const = 0; + + /* + * Returns the list of wakewords mapped to the voiceagent. + */ + virtual shared_ptr<unordered_set<string>> getWakeWords() const = 0; + + /* + * Returns true if the voiceagent is active. False otherwise. + */ + virtual bool isActive() const = 0; + + /* + * Returns the active wakeword for the voiceagent. + */ + virtual string getActiveWakeword() const = 0; + + /** + * Virtual destructor to assure proper cleanup of derived types. + */ + virtual ~IVoiceAgent() = default; +}; + +} // namespace interfaces +} // namespace common +} // namespace vshl + +#endif // VSHL_COMMON_INTERFACES_IVOICEAGENT_H_ diff --git a/src/plugins/interfaces/voiceagents/IVoiceAgentsChangeObserver.h b/src/plugins/interfaces/voiceagents/IVoiceAgentsChangeObserver.h new file mode 100644 index 0000000..e552ab5 --- /dev/null +++ b/src/plugins/interfaces/voiceagents/IVoiceAgentsChangeObserver.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_COMMON_INTERFACES_IVOICEAGENTSCHANGEOBSERVER_H_ +#define VSHL_COMMON_INTERFACES_IVOICEAGENTSCHANGEOBSERVER_H_ + +#include <memory> +#include <string> + +#include "interfaces/voiceagents/IVoiceAgent.h" + +using namespace std; + +namespace vshl { +namespace common { +namespace interfaces { + +/* + * This interface is used to observe changes to the voiceagents datastore. + * The voiceagents data store is contained in the voiceagents module. + */ +class IVoiceAgentsChangeObserver { +public: + /** + * This method notifies the observers that the default voiceagent selection + * has been updated. + */ + virtual void + OnDefaultVoiceAgentChanged(shared_ptr<IVoiceAgent> defaultVoiceAgent) = 0; + + /** + * This method notifies the observers that a new voiceagent has been added. + */ + virtual void OnVoiceAgentAdded(shared_ptr<IVoiceAgent> voiceAgent) = 0; + + /** + * This method notifies the observers that a voiceagent is removed. + */ + virtual void OnVoiceAgentRemoved(shared_ptr<IVoiceAgent> voiceAgent) = 0; + + /** + * This method notifies the observers that active wakeword for a voiceagent is + * updated. + */ + virtual void + OnVoiceAgentActiveWakeWordChanged(shared_ptr<IVoiceAgent> voiceAgent) = 0; + + /** + * This method notifies the observers that the voiceagent has been activated. + */ + virtual void OnVoiceAgentActivated(shared_ptr<IVoiceAgent> voiceAgent) = 0; + + /** + * This method notifies the observers that the voiceagent has been activated. + */ + virtual void OnVoiceAgentDeactivated(shared_ptr<IVoiceAgent> voiceAgent) = 0; + + /** + * Virtual destructor to assure proper cleanup of derived types. + */ + virtual ~IVoiceAgentsChangeObserver() = default; +}; + +} // namespace interfaces +} // namespace common +} // namespace vshl + +#endif // VSHL_COMMON_INTERFACES_IVOICEAGENTSCHANGEOBSERVER_H_ |