dali/public-api/adaptor-framework/tts-player.h

   1 #ifndef DALI_TTS_PLAYER_H
   2 #define DALI_TTS_PLAYER_H
   3
   4 /*
   5  * Copyright (c) 2020 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  22 #include <dali/public-api/object/base-handle.h>
  23 #include <dali/public-api/signals/dali-signal.h>
  24
  25 // INTERNAL INCLUDES
  26 #include <dali/public-api/dali-adaptor-common.h>
  27
  28 namespace Dali
  29 {
  30 /**
  31  * @addtogroup dali_adaptor_framework
  32  * @{
  33  */
  34
  35 namespace Internal DALI_INTERNAL
  36 {
  37 namespace Adaptor
  38 {
  39 class TtsPlayer;
  40 }
  41 }
  42
  43 /**
  44  * @brief The Text-to-speech (TTS) Player.
  45  * @SINCE_1_0.0
  46  */
  47 class DALI_ADAPTOR_API TtsPlayer : public BaseHandle
  48 {
  49 public: // ENUMs
  50
  51   /**
  52    * @brief Enumeration for the instance of TTS mode.
  53    * @SINCE_1_0.0
  54    */
  55   enum Mode
  56   {
  57     DEFAULT = 0,  ///< Default mode for normal application @SINCE_1_0.0
  58     NOTIFICATION, ///< Notification mode, such as playing utterance is started or completed @SINCE_1_0.0
  59     SCREEN_READER, ///< Screen reader mode. To help visually impaired users interact with their devices, screen reader reads text or graphic elements on the screen using the TTS engine. @SINCE_1_0.0
  60     MODE_NUM
  61   };
  62
  63   /**
  64    * @brief Enumeration for the instance of TTS state.
  65    * @SINCE_1_0.0
  66    */
  67   enum State
  68   {
  69     UNAVAILABLE = 0,    ///< Player is not available @SINCE_1_0.0
  70     READY,              ///< Player is ready to play @SINCE_1_0.0
  71     PLAYING,            ///< Player is playing @SINCE_1_0.0
  72     PAUSED              ///< Player is paused @SINCE_1_0.0
  73   };
  74
  75 public: // Typedefs
  76
  77   /**
  78    * @brief Type of signal emitted when the TTS state changes.
  79    * @SINCE_1_0.0
  80    */
  81   typedef Signal< void ( const Dali::TtsPlayer::State, const Dali::TtsPlayer::State ) > StateChangedSignalType;
  82
  83 public: // API
  84
  85   /**
  86    * @brief Creates an uninitialized handle.
  87    *
  88    * This can be initialized by calling TtsPlayer::Get().
  89    * @SINCE_1_0.0
  90    */
  91   TtsPlayer();
  92
  93   /**
  94    * @brief Gets the singleton of the TtsPlayer for the given mode.
  95    *
  96    * @SINCE_1_0.0
  97    * @param mode The mode of tts-player
  98    * @return A handle of the Ttsplayer for the given mode
  99    */
 100   static TtsPlayer Get(Dali::TtsPlayer::Mode mode = Dali::TtsPlayer::DEFAULT);
 101
 102   /**
 103    * @brief Destructor.
 104    *
 105    * This is non-virtual since derived Handle types must not contain data or virtual methods.
 106    * @SINCE_1_0.0
 107    */
 108   ~TtsPlayer();
 109
 110   /**
 111    * @brief This copy constructor is required for (smart) pointer semantics.
 112    *
 113    * @SINCE_1_0.0
 114    * @param [in] handle A reference to the copied handle
 115    */
 116   TtsPlayer(const TtsPlayer& handle);
 117
 118   /**
 119    * @brief This assignment operator is required for (smart) pointer semantics.
 120    *
 121    * @SINCE_1_0.0
 122    * @param [in] rhs A reference to the copied handle
 123    * @return A reference to this
 124    */
 125   TtsPlayer& operator=(const TtsPlayer& rhs);
 126
 127   /**
 128    * @brief Move constructor.
 129    *
 130    * @SINCE_1_9.24
 131    * @param[in] rhs A reference to the moved handle
 132    */
 133   TtsPlayer( TtsPlayer&& rhs );
 134
 135   /**
 136    * @brief Move assignment operator.
 137    *
 138    * @SINCE_1_9.24
 139    * @param[in] rhs A reference to the moved handle
 140    * @return A reference to this handle
 141    */
 142   TtsPlayer& operator=( TtsPlayer&& rhs );
 143
 144   /**
 145    * @brief Starts playing the audio data synthesized from the specified text.
 146    *
 147    * @SINCE_1_0.0
 148    * @param[in] text The text to play
 149    * @pre The TtsPlayer needs to be initialized.
 150    */
 151   void Play(const std::string& text);
 152
 153   /**
 154    * @brief Stops playing the utterance.
 155    * @SINCE_1_0.0
 156    * @pre The TtsPlayer needs to be initialized.
 157    */
 158   void Stop();
 159
 160   /**
 161    * @brief Pauses the currently playing utterance.
 162    * @SINCE_1_0.0
 163    * @pre The TtsPlayer needs to be initialized.
 164    */
 165   void Pause();
 166
 167   /**
 168    * @brief Resumes the previously paused utterance.
 169    * @SINCE_1_0.0
 170    * @pre The TtsPlayer needs to be initialized.
 171    */
 172   void Resume();
 173
 174   /**
 175    * @brief Gets the current state of the player.
 176    * @SINCE_1_0.0
 177    * @return The current TTS state
 178    * @pre The TtsPlayer needs to be initialized.
 179    */
 180   State GetState();
 181
 182   /**
 183    * @brief Allows connection TTS state change signal.
 184    * @SINCE_1_0.0
 185    * @return A reference to the signal for connection
 186    * @note Only supported by some adaptor types.
 187    */
 188   Dali::TtsPlayer::StateChangedSignalType& StateChangedSignal();
 189
 190 public: // Not intended for application developers
 191
 192   /// @cond internal
 193   /**
 194    * @brief This constructor is used by TtsPlayer::Get().
 195    * @SINCE_1_0.0
 196    * @param[in] ttsPlayer A pointer to the TTS player
 197    */
 198   explicit DALI_INTERNAL TtsPlayer( Internal::Adaptor::TtsPlayer* ttsPlayer );
 199   /// @endcond
 200 };
 201
 202 /**
 203  * @}
 204  */
 205 } // namespace Dali
 206
 207 #endif // DALI_TTS_PLAYER_H