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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
|
// Copyright 2019 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CAST_COMMON_CHANNEL_MESSAGE_UTIL_H_
#define CAST_COMMON_CHANNEL_MESSAGE_UTIL_H_
#include <string>
#include "absl/strings/string_view.h"
#include "cast/common/channel/proto/cast_channel.pb.h"
#include "util/enum_name_table.h"
namespace Json {
class Value;
}
namespace openscreen {
namespace cast {
// Reserved message namespaces for internal messages.
static constexpr char kCastInternalNamespacePrefix[] =
"urn:x-cast:com.google.cast.";
static constexpr char kTransportNamespacePrefix[] =
"urn:x-cast:com.google.cast.tp.";
static constexpr char kAuthNamespace[] =
"urn:x-cast:com.google.cast.tp.deviceauth";
static constexpr char kHeartbeatNamespace[] =
"urn:x-cast:com.google.cast.tp.heartbeat";
static constexpr char kConnectionNamespace[] =
"urn:x-cast:com.google.cast.tp.connection";
static constexpr char kReceiverNamespace[] =
"urn:x-cast:com.google.cast.receiver";
static constexpr char kBroadcastNamespace[] =
"urn:x-cast:com.google.cast.broadcast";
static constexpr char kMediaNamespace[] = "urn:x-cast:com.google.cast.media";
// Sender and receiver IDs to use for platform messages.
static constexpr char kPlatformSenderId[] = "sender-0";
static constexpr char kPlatformReceiverId[] = "receiver-0";
static constexpr char kBroadcastId[] = "*";
static constexpr ::cast::channel::CastMessage_ProtocolVersion
kDefaultOutgoingMessageVersion =
::cast::channel::CastMessage_ProtocolVersion_CASTV2_1_0;
// JSON message key strings.
static constexpr char kMessageKeyType[] = "type";
static constexpr char kMessageKeyProtocolVersion[] = "protocolVersion";
static constexpr char kMessageKeyProtocolVersionList[] = "protocolVersionList";
static constexpr char kMessageKeyReasonCode[] = "reasonCode";
static constexpr char kMessageKeyAppId[] = "appId";
static constexpr char kMessageKeyRequestId[] = "requestId";
static constexpr char kMessageKeyResponseType[] = "responseType";
static constexpr char kMessageKeyTransportId[] = "transportId";
static constexpr char kMessageKeySessionId[] = "sessionId";
// JSON message field values.
static constexpr char kMessageTypeConnect[] = "CONNECT";
static constexpr char kMessageTypeClose[] = "CLOSE";
static constexpr char kMessageTypeConnected[] = "CONNECTED";
static constexpr char kMessageValueAppAvailable[] = "APP_AVAILABLE";
static constexpr char kMessageValueAppUnavailable[] = "APP_UNAVAILABLE";
// JSON message key strings specific to CONNECT messages.
static constexpr char kMessageKeyBrowserVersion[] = "browserVersion";
static constexpr char kMessageKeyConnType[] = "connType";
static constexpr char kMessageKeyConnectionType[] = "connectionType";
static constexpr char kMessageKeyUserAgent[] = "userAgent";
static constexpr char kMessageKeyOrigin[] = "origin";
static constexpr char kMessageKeyPlatform[] = "platform";
static constexpr char kMessageKeySdkType[] = "skdType";
static constexpr char kMessageKeySenderInfo[] = "senderInfo";
static constexpr char kMessageKeyVersion[] = "version";
// JSON message key strings specific to application control messages.
static constexpr char kMessageKeyAvailability[] = "availability";
static constexpr char kMessageKeyAppParams[] = "appParams";
static constexpr char kMessageKeyApplications[] = "applications";
static constexpr char kMessageKeyControlType[] = "controlType";
static constexpr char kMessageKeyDisplayName[] = "displayName";
static constexpr char kMessageKeyIsIdleScreen[] = "isIdleScreen";
static constexpr char kMessageKeyLaunchedFromCloud[] = "launchedFromCloud";
static constexpr char kMessageKeyLevel[] = "level";
static constexpr char kMessageKeyMuted[] = "muted";
static constexpr char kMessageKeyName[] = "name";
static constexpr char kMessageKeyNamespaces[] = "namespaces";
static constexpr char kMessageKeyReason[] = "reason";
static constexpr char kMessageKeyStatus[] = "status";
static constexpr char kMessageKeyStepInterval[] = "stepInterval";
static constexpr char kMessageKeyUniversalAppId[] = "universalAppId";
static constexpr char kMessageKeyUserEq[] = "userEq";
static constexpr char kMessageKeyVolume[] = "volume";
// JSON message field value strings specific to application control messages.
static constexpr char kMessageValueAttenuation[] = "attenuation";
static constexpr char kMessageValueBadParameter[] = "BAD_PARAMETER";
static constexpr char kMessageValueInvalidSessionId[] = "INVALID_SESSION_ID";
static constexpr char kMessageValueInvalidCommand[] = "INVALID_COMMAND";
static constexpr char kMessageValueNotFound[] = "NOT_FOUND";
static constexpr char kMessageValueSystemError[] = "SYSTEM_ERROR";
// TODO(crbug.com/openscreen/111): Add validation that each message type is
// received on the correct namespace. This will probably involve creating a
// data structure for mapping between type and namespace.
enum class CastMessageType {
// Heartbeat messages.
kPing,
kPong,
// RPC control/status messages used by Media Remoting. These occur at high
// frequency, up to dozens per second at times, and should not be logged.
kRpc,
kGetAppAvailability,
kGetStatus,
// Virtual connection request.
kConnect,
// Close virtual connection.
kCloseConnection,
// Application broadcast / precache.
kBroadcast,
// Session launch request.
kLaunch,
// Session stop request.
kStop,
kReceiverStatus,
kMediaStatus,
// Error from receiver.
kLaunchError,
kOffer,
kAnswer,
kCapabilitiesResponse,
kStatusResponse,
// The following values are part of the protocol but are not currently used.
kMultizoneStatus,
kInvalidPlayerState,
kLoadFailed,
kLoadCancelled,
kInvalidRequest,
kPresentation,
kGetCapabilities,
kOther, // Add new types above |kOther|.
kMaxValue = kOther,
};
enum class AppAvailabilityResult {
kAvailable,
kUnavailable,
kUnknown,
};
std::string ToString(AppAvailabilityResult availability);
static const EnumNameTable<CastMessageType, 25> kCastMessageTypeNames{
{{"PING", CastMessageType::kPing},
{"PONG", CastMessageType::kPong},
{"RPC", CastMessageType::kRpc},
{"GET_APP_AVAILABILITY", CastMessageType::kGetAppAvailability},
{"GET_STATUS", CastMessageType::kGetStatus},
{"CONNECT", CastMessageType::kConnect},
{"CLOSE", CastMessageType::kCloseConnection},
{"APPLICATION_BROADCAST", CastMessageType::kBroadcast},
{"LAUNCH", CastMessageType::kLaunch},
{"STOP", CastMessageType::kStop},
{"RECEIVER_STATUS", CastMessageType::kReceiverStatus},
{"MEDIA_STATUS", CastMessageType::kMediaStatus},
{"LAUNCH_ERROR", CastMessageType::kLaunchError},
{"OFFER", CastMessageType::kOffer},
{"ANSWER", CastMessageType::kAnswer},
{"CAPABILITIES_RESPONSE", CastMessageType::kCapabilitiesResponse},
{"STATUS_RESPONSE", CastMessageType::kStatusResponse},
{"MULTIZONE_STATUS", CastMessageType::kMultizoneStatus},
{"INVALID_PLAYER_STATE", CastMessageType::kInvalidPlayerState},
{"LOAD_FAILED", CastMessageType::kLoadFailed},
{"LOAD_CANCELLED", CastMessageType::kLoadCancelled},
{"INVALID_REQUEST", CastMessageType::kInvalidRequest},
{"PRESENTATION", CastMessageType::kPresentation},
{"GET_CAPABILITIES", CastMessageType::kGetCapabilities},
{"OTHER", CastMessageType::kOther}}};
inline const char* CastMessageTypeToString(CastMessageType type) {
return GetEnumName(kCastMessageTypeNames, type).value("OTHER");
}
inline bool IsAuthMessage(const ::cast::channel::CastMessage& message) {
return message.namespace_() == kAuthNamespace;
}
inline bool IsTransportNamespace(absl::string_view namespace_) {
return (namespace_.size() > (sizeof(kTransportNamespacePrefix) - 1)) &&
(namespace_.find_first_of(kTransportNamespacePrefix) == 0);
}
::cast::channel::CastMessage MakeSimpleUTF8Message(
const std::string& namespace_,
std::string payload);
::cast::channel::CastMessage MakeConnectMessage(
const std::string& source_id,
const std::string& destination_id);
::cast::channel::CastMessage MakeCloseMessage(
const std::string& source_id,
const std::string& destination_id);
// Returns a session/transport ID string that is unique within this application
// instance, having the format "prefix-12345". For example, calling this with a
// |prefix| of "sender" will result in a string like "sender-12345".
std::string MakeUniqueSessionId(const char* prefix);
// Returns true if the type field in |object| is set to the given |type|.
bool HasType(const Json::Value& object, CastMessageType type);
} // namespace cast
} // namespace openscreen
#endif // CAST_COMMON_CHANNEL_MESSAGE_UTIL_H_
|
