Version 1.16 alexa-client-sdk

Changes in this update:

**Enhancements**

- Added support for SpeechSynthesizer v.1.2 which includes the new `playBehaviour` directive.  For more information, see [SpeechSynthesizer v1.2](https://github.com/alexa/avs-device-sdk/wiki/SpeechSynthesizer-Interface-v1.2).
- Added support for pre-buffering in [AudioPlayer](https://alexa.github.io/avs-device-sdk/classalexa_client_s_d_k_1_1capability_agents_1_1audio_player_1_1_audio_player.html). You can optionally choose the number of instances MediaPlayer uses in the [AlexaClientSDKconfig.json](https://github.com/alexa/avs-device-sdk/blob/master/Integration/AlexaClientSDKConfig.json). Important: the contract for [MediaPlayerInterface](https://alexa.github.io/avs-device-sdk/classalexa_client_s_d_k_1_1avs_common_1_1utils_1_1media_player_1_1_media_player_interface.html) has changed. You must now make sure that the `SourceId` value returned by `setSource()` is unique across all instances.
- AudioPlayer is now licensed under the Amazon Software License instead of the Apache Software License.

**Bug Fixes**

- Fixed Android issue that caused the build script to ignore PKG_CONFIG_PATH. This sometimes caused the build to use a preinstalled dependency instead of the specific version downloaded by the Android script (e.g - openssl).
- Fixed Android issue that prevented the Sample app from running at the same time as other applications using the microphone. Android doesn't inherently allow two applications to use the microphone. Pressing the mute button now temporarily stops Alexa from accessing the microphone.
- Added 'quit' (– q) to the settings sub menu.
- Fixed outdated dependencies issue in the Windows install script.
- Fixed reminders issue that caused Notification LEDs to stay on, even after dismissing the alert.

**Known Issues**

* Music playback history isn't displayed in the Alexa app for certain account and device types.
* When using Gnu Compiler Collection 8+ (GCC 8+), `-Wclass-memaccess` triggers warnings. You can ignore these, they don't cause the build to fail.
* Android error `libDefaultClient.so not found` might occur. Resolve this by upgrading to ADB version 1.0.40.
* If a device loses a network connection, the lost connection status isn't returned via local TTS.
* ACL encounters issues if it receives audio attachments but doesn't consume them.
* `SpeechSynthesizerState` uses `GAINING_FOCUS` and `LOSING_FOCUS` as a  workaround for handling intermediate states.
* Media steamed through Bluetooth might abruptly stop. To restart playback, resume the media in the source application or toggle next/previous.
* If a connected Bluetooth device is inactive, the Alexa app might indicates that audio is playing.
* The Bluetooth agent assumes that the Bluetooth adapter is always connected to a power source. Disconnecting from a power source during operation isn't yet supported.
* When using some products, interrupted Bluetooth playback might not resume if other content is locally streamed.
* `make integration` isn't available for Android. To run Android integration tests, manually upload the test binary and input file and run ADB.
* Alexa might truncate the beginning of speech when responding to text-to-speech (TTS) user events. This only impacts Raspberry Pi devices running Android Things with HDMI output audio.
* A reminder TTS message doesn't play if the sample app restarts and loses a network connection. Instead, the default alarm tone plays twice.
* `ServerDisconnectIntegratonTest` tests are disabled until they are updated to reflect new service behavior.
* Bluetooth initialization must complete before connecting devices, otherwise devices are ignored.
* The `DirectiveSequencerTest.test_handleBlockingThenImmediatelyThenNonBockingOnSameDialogId` test fails intermittently.
* On some devices, Alexa gets stuck in a permanent listening state. Pressing `t` and `h` in the Sample App doesn't exit the listening state.
* Exiting the `settings` menu doesn't provide a message to indicate that you are back in the main menu.

Author: Sam Coulter

ADSL/include/ADSL/DirectiveProcessor.h

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * Copyright 2017-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.
@@ -82,6 +82,14 @@ class DirectiveProcessor {
      */
     void setDialogRequestId(const std::string& dialogRequestId);
 
+    /**
+     * Returns the @c dialogRequestId currently in use for Directive handling. This may be the empty string if
+     * Directives have either experienced errors, or have been cancelled.
+     *
+     * @return dialogRequestId  The current dialog request id.
+     */
+    std::string getDialogRequestId();
+
     /**
      * Queue an @c AVSDirective for handling by whatever @c DirectiveHandler was registered to handle it.
      *

ADSL/include/ADSL/DirectiveSequencer.h

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * Copyright 2017-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.
@@ -52,6 +52,8 @@ class DirectiveSequencer : public avsCommon::sdkInterfaces::DirectiveSequencerIn
 
     void setDialogRequestId(const std::string& dialogRequestId) override;
 
+    std::string getDialogRequestId() override;
+
     bool onDirective(std::shared_ptr<avsCommon::avs::AVSDirective> directive) override;
 
     void disable() override;
@@ -67,11 +69,6 @@ class DirectiveSequencer : public avsCommon::sdkInterfaces::DirectiveSequencerIn
      */
     DirectiveSequencer(std::shared_ptr<avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface> exceptionSender);
 
-    /**
-     * @copydoc
-     *
-     * This method blocks until all processing of directives has stopped.
-     */
     void doShutdown() override;
 
     /**

ADSL/src/DirectiveProcessor.cpp

@@ -63,6 +63,11 @@ void DirectiveProcessor::setDialogRequestId(const std::string& dialogRequestId)
     setDialogRequestIdLocked(dialogRequestId);
 }
 
+std::string DirectiveProcessor::getDialogRequestId() {
+    std::lock_guard<std::mutex> lock(m_mutex);
+    return m_dialogRequestId;
+}
+
 bool DirectiveProcessor::onDirective(std::shared_ptr<AVSDirective> directive) {
     if (!directive) {
         ACSDK_ERROR(LX("onDirectiveFailed").d("action", "ignored").d("reason", "nullptrDirective"));

ADSL/src/DirectiveSequencer.cpp

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * Copyright 2017-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.
@@ -62,6 +62,10 @@ void DirectiveSequencer::setDialogRequestId(const std::string& dialogRequestId)
     m_directiveProcessor->setDialogRequestId(dialogRequestId);
 }
 
+std::string DirectiveSequencer::getDialogRequestId() {
+    return m_directiveProcessor->getDialogRequestId();
+}
+
 bool DirectiveSequencer::onDirective(std::shared_ptr<AVSDirective> directive) {
     if (!directive) {
         ACSDK_ERROR(LX("onDirectiveFailed").d("action", "ignored").d("reason", "nullptrDirective"));

ADSL/test/ADSL/MockDirectiveSequencer.h

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * Copyright 2017-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.
@@ -43,13 +43,21 @@ class MockDirectiveSequencer : public avsCommon::sdkInterfaces::DirectiveSequenc
         removeDirectiveHandler,
         bool(std::shared_ptr<avsCommon::sdkInterfaces::DirectiveHandlerInterface> handler));
 
-    MOCK_METHOD1(setDialogRequestId, void(const std::string& dialogRequestId));
+    inline void setDialogRequestId(const std::string& dialogRequestId) {
+        m_dialogRequestId = dialogRequestId;
+    };
+
+    inline std::string getDialogRequestId() {
+        return m_dialogRequestId;
+    };
 
     MOCK_METHOD1(onDirective, bool(std::shared_ptr<avsCommon::avs::AVSDirective> directive));
 
     MOCK_METHOD0(disable, void());
 
     MOCK_METHOD0(enable, void());
+
+    std::string m_dialogRequestId;
 };
 
 inline MockDirectiveSequencer::MockDirectiveSequencer() :

…layer/include/AudioPlayer/PlayBehavior.h …AVS/include/AVSCommon/AVS/PlayBehavior.hCapabilityAgents/AudioPlayer/include/AudioPlayer/PlayBehavior.h renamed to AVSCommon/AVS/include/AVSCommon/AVS/PlayBehavior.h CapabilityAgents/AudioPlayer/include/AudioPlayer/PlayBehavior.h renamed to AVSCommon/AVS/include/AVSCommon/AVS/PlayBehavior.h

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * Copyright 2017-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.
@@ -13,17 +13,17 @@
  * permissions and limitations under the License.
  */
 
-#ifndef ALEXA_CLIENT_SDK_CAPABILITYAGENTS_AUDIOPLAYER_INCLUDE_AUDIOPLAYER_PLAYBEHAVIOR_H_
-#define ALEXA_CLIENT_SDK_CAPABILITYAGENTS_AUDIOPLAYER_INCLUDE_AUDIOPLAYER_PLAYBEHAVIOR_H_
+#ifndef ALEXA_CLIENT_SDK_AVSCOMMON_AVS_INCLUDE_AVSCOMMON_AVS_PLAYBEHAVIOR_H_
+#define ALEXA_CLIENT_SDK_AVSCOMMON_AVS_INCLUDE_AVSCOMMON_AVS_PLAYBEHAVIOR_H_
 
+#include <string>
 #include <ostream>
 
-#include <AVSCommon/SDKInterfaces/DialogUXStateObserverInterface.h>
 #include <AVSCommon/Utils/JSON/JSONUtils.h>
 
 namespace alexaClientSDK {
-namespace capabilityAgents {
-namespace audioPlayer {
+namespace avsCommon {
+namespace avs {
 
 /// Used to determine how a client must handle queueing and playback of a stream.
 enum class PlayBehavior {
@@ -107,8 +107,8 @@ inline bool convertToValue(const rapidjson::Value& documentNode, PlayBehavior* p
     return stringToPlayBehavior(text, playBehavior);
 }
 
-}  // namespace audioPlayer
-}  // namespace capabilityAgents
+}  // namespace avs
+}  // namespace avsCommon
 }  // namespace alexaClientSDK
 
-#endif  // ALEXA_CLIENT_SDK_CAPABILITYAGENTS_AUDIOPLAYER_INCLUDE_AUDIOPLAYER_PLAYBEHAVIOR_H_
+#endif  // ALEXA_CLIENT_SDK_AVSCOMMON_AVS_INCLUDE_AVSCOMMON_AVS_PLAYBEHAVIOR_H_

AVSCommon/AVS/src/DialogUXStateAggregator.cpp

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * Copyright 2017-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.
@@ -103,6 +103,7 @@ void DialogUXStateAggregator::onStateChanged(SpeechSynthesizerObserverInterface:
                 setState(DialogUXStateObserverInterface::DialogUXState::SPEAKING);
                 return;
             case SpeechSynthesizerObserverInterface::SpeechSynthesizerState::FINISHED:
+            case SpeechSynthesizerObserverInterface::SpeechSynthesizerState::INTERRUPTED:
                 tryEnterIdleState();
                 return;
             case SpeechSynthesizerObserverInterface::SpeechSynthesizerState::LOSING_FOCUS:
@@ -162,7 +163,8 @@ void DialogUXStateAggregator::tryEnterIdleStateOnTimer() {
     m_executor.submit([this]() {
         if (m_currentState != sdkInterfaces::DialogUXStateObserverInterface::DialogUXState::IDLE &&
             m_audioInputProcessorState == AudioInputProcessorObserverInterface::State::IDLE &&
-            m_speechSynthesizerState == SpeechSynthesizerObserverInterface::SpeechSynthesizerState::FINISHED) {
+            (m_speechSynthesizerState == SpeechSynthesizerObserverInterface::SpeechSynthesizerState::FINISHED ||
+             m_speechSynthesizerState == SpeechSynthesizerObserverInterface::SpeechSynthesizerState::INTERRUPTED)) {
             setState(sdkInterfaces::DialogUXStateObserverInterface::DialogUXState::IDLE);
         }
     });

AVSCommon/CMakeLists.txt

@@ -67,6 +67,7 @@ add_library(AVSCommon SHARED
     Utils/src/Logger/ModuleLogger.cpp
     Utils/src/Logger/ThreadMoniker.cpp
     Utils/src/MacAddressString.cpp
+    Utils/src/MediaPlayer/PooledMediaPlayerFactory.cpp
     Utils/src/Metrics.cpp
     Utils/src/Network/InternetConnectionMonitor.cpp
     Utils/src/RequiresShutdown.cpp

AVSCommon/SDKInterfaces/include/AVSCommon/SDKInterfaces/Audio/EqualizerConfigurationInterface.h

@@ -1,5 +1,5 @@
 /*
- * Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * 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.
@@ -73,6 +73,13 @@ class EqualizerConfigurationInterface {
      */
     virtual int getMaxBandLevel() const = 0;
 
+    /**
+     * Returns the default value of band value changes.
+     *
+     * @return The default value of band value changes.
+     */
+    virtual int getDefaultBandDelta() const = 0;
+
     /**
      * Returns @c EqualizerState object defining default values for equalizer mode and band levels. These values should
      * be used when resetting any band to its default level.

AVSCommon/SDKInterfaces/include/AVSCommon/SDKInterfaces/DirectiveSequencerInterface.h

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * Copyright 2017-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.
@@ -92,6 +92,14 @@ class DirectiveSequencerInterface : public utils::RequiresShutdown {
      */
     virtual void setDialogRequestId(const std::string& dialogRequestId) = 0;
 
+    /**
+     * Returns the @c dialogRequestId currently in use for Directive handling. This may be the empty string if
+     * Directives have either experienced errors, or have been cancelled.
+     *
+     * @return dialogRequestId  The current dialog request id.
+     */
+    virtual std::string getDialogRequestId() = 0;
+
     /**
      * Sequence the handling of an @c AVSDirective.  The actual handling is done by whichever @c DirectiveHandler
      * is associated with the @c AVSDirective's (namespace, name) pair.