1 #ifndef __DALI_INTERNAL_TTS_PLAYER_H__
2 #define __DALI_INTERNAL_TTS_PLAYER_H__
5 * Copyright (c) 2014 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
25 #include <dali/integration-api/debug.h>
26 #include <dali/public-api/object/base-object.h>
29 #include <tts-player.h>
41 * Text-to-speech player
43 class TtsPlayer : public Dali::BaseObject
49 * Create a TtsPlayer with the given mode.
50 * This should only be called once by the Adaptor class for each given mode.
51 * @param mode the mode of tts-player
52 * @return A newly created TtsPlayer.
54 static Dali::TtsPlayer New(Dali::TtsPlayer::Mode mode);
57 * @copydoc TtsPlayer::Play()
59 void Play(const std::string& text);
62 * @copydoc TtsPlayer::Stop()
67 * @copydoc TtsPlayer::Pause()
72 * @copydoc TtsPlayer::Resume()
77 * @copydoc TtsPlayer::GetState()
79 Dali::TtsPlayer::State GetState();
82 * @copydoc TtsPlayer::StateChangedSignal()
84 Dali::TtsPlayer::StateChangedSignalType& StateChangedSignal();
89 * Private Constructor; see also TtsPlayer::New()
90 * @param mode the mode of tts-player
92 TtsPlayer(Dali::TtsPlayer::Mode mode);
100 * Initializes the player.
105 * Logs the error code.
106 * @param[in] reason The error code
108 void LogErrorCode(tts_error_e reason);
111 * Used to emit the state changed signal from outside the object (EG. A static function).
112 * @param[in] previous The previous state
113 * @param[in] current The current state
115 void EmitStateChangedSignal( tts_state_e previous, tts_state_e current );
118 * Called when the state of TTS is changed.
120 * @param[in] tts The handle for TTS
121 * @param[in] previous A previous state
122 * @param[in] current A current state
123 * @param[in] userData The user data passed from the callback registration function.
125 static void StateChangedCallback(tts_h tts, tts_state_e previous, tts_state_e current, void *userData);
128 TtsPlayer(const TtsPlayer&);
131 TtsPlayer& operator=(TtsPlayer&);
135 Dali::TtsPlayer::StateChangedSignalType mStateChangedSignal; ///< Signal emitted when the TTS state changes
136 bool mInitialized; ///< Whether the TTS player is initialised successfully or not
137 std::string mUnplayedString; ///< The text that can not be played because tts engine is not yet initialized
138 tts_h mTtsHandle; ///< The handle of TTS
139 int mUtteranceId; ///< The utterance ID
141 Dali::TtsPlayer::Mode mTtsMode; ///< The current mode of tts engine
143 #if defined(DEBUG_ENABLED)
145 static Debug::Filter* gLogFilter;
149 } // namespace Adaptor
151 } // namespace Internal
153 // Helpers for public-api forwarding methods
155 inline Internal::Adaptor::TtsPlayer& GetImplementation(Dali::TtsPlayer& player)
157 DALI_ASSERT_ALWAYS( player && "TtsPlayer handle is empty" );
159 BaseObject& handle = player.GetBaseObject();
161 return static_cast<Internal::Adaptor::TtsPlayer&>(handle);
164 inline const Internal::Adaptor::TtsPlayer& GetImplementation(const Dali::TtsPlayer& player)
166 DALI_ASSERT_ALWAYS( player && "TtsPlayer handle is empty" );
168 const BaseObject& handle = player.GetBaseObject();
170 return static_cast<const Internal::Adaptor::TtsPlayer&>(handle);
175 #endif // __DALI_INTERNAL_TTS_PLAYER_H__