1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
|
#pragma once
#include "routing/turns.hpp"
#include "routing/turns_sound_settings.hpp"
#include "routing/turns_tts_text.hpp"
#include "std/string.hpp"
namespace location
{
class FollowingInfo;
}
namespace routing
{
namespace turns
{
namespace sound
{
/// \brief The PronouncedNotification enum represents which sound notifications
/// for turns were heard.
enum class PronouncedNotification
{
Nothing,
First,
Second /** The second notification just before the turn was pronounced. */
};
string DebugPrint(PronouncedNotification const notificationProgress);
/// \brief The TurnsSound class is responsible for all route turn sound notifications functionality.
/// To be able to generate turn sound notification the class needs to have correct Settings
/// and relevant speed.
class TurnsSound
{
/// m_enabled == true when tts is turned on.
/// Important! Clients (iOS/Android) implies that m_enabled is false by default.
bool m_enabled;
/// In m_speedMetersPerSecond is intended for some speed which will be used for
/// convertion a distance in seconds to distance in meters. It could be a current
/// an end user speed or an average speed for last several seconds.
/// @TODO(vbykoianko) It's better to use an average speed
/// for last several seconds instead of the current speed here.
double m_speedMetersPerSecond;
Settings m_settings;
/// m_nextTurnNotificationProgress keeps a status which is being changing while
/// an end user is coming to the closest (the next) turn along the route.
/// When an end user is far from the next turn
/// m_nextTurnNotificationProgress == Nothing.
/// After the first turn notification has been pronounced
/// m_nextTurnNotificationProgress == First.
/// After the second notification has been pronounced
/// m_nextTurnNotificationProgress == Second.
PronouncedNotification m_nextTurnNotificationProgress;
uint32_t m_nextTurnIndex;
/// getTtsText is a convector form turn notification information and locale to
/// notification string.
GetTtsText m_getTtsText;
string GenerateTurnText(uint32_t distanceUnits, uint8_t exitNum, bool useThenInsteadOfDistance,
TurnDirection turnDir, LengthUnits lengthUnits) const;
public:
TurnsSound() : m_enabled(false), m_speedMetersPerSecond(0.), m_settings(),
m_nextTurnNotificationProgress(PronouncedNotification::Nothing), m_nextTurnIndex(0) {}
bool IsEnabled() const { return m_enabled; }
void Enable(bool enable);
void SetLengthUnits(LengthUnits units);
inline LengthUnits GetLengthUnits() const { return m_settings.GetLengthUnits(); }
inline void SetLocale(string const & locale) { m_getTtsText.SetLocale(locale); }
inline string GetLocale() const { return m_getTtsText.GetLocale(); }
/// SetLocaleWithJson is used for writing unit tests only.
void SetLocaleWithJson(string const & jsonBuffer) { m_getTtsText.SetLocaleWithJson(jsonBuffer); }
void SetSpeedMetersPerSecond(double speed);
/// \brief GenerateTurnSound updates information about the next turn notification.
/// It also fills turnNotifications when it's necessary.
/// If this TurnsSound wants to play a sound message once it should push one item to
/// the vector turnNotifications once when GenerateTurnSound is called.
/// \param turn contains information about the next turn.
/// \param distanceToTurnMeters is distance to the next turn in meters.
/// \param turnNotifications is a parameter to fill it if it's necessary.
/// \note The client implies turnNotifications does not contain empty strings.
void GenerateTurnSound(TurnItem const & turn, double distanceToTurnMeters,
vector<string> & turnNotifications);
/// Reset states which reflects current route position.
/// The method shall be called after creating a new route or after rerouting.
void Reset();
};
} // namespace sound
} // namespace turns
} // namespace routing
|
