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
|
// Copyright (c) 2012 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 REMOTING_PROTOCOL_SESSION_CONFIG_H_
#define REMOTING_PROTOCOL_SESSION_CONFIG_H_
#include <list>
#include <string>
#include "base/basictypes.h"
#include "base/memory/scoped_ptr.h"
namespace remoting {
namespace protocol {
extern const int kDefaultStreamVersion;
// Struct for configuration parameters of a single channel.
// Some channels (like video) may have multiple underlying sockets that need
// to be configured simultaneously.
struct ChannelConfig {
enum TransportType {
TRANSPORT_STREAM,
TRANSPORT_MUX_STREAM,
TRANSPORT_DATAGRAM,
TRANSPORT_NONE,
};
enum Codec {
CODEC_UNDEFINED, // Used for event and control channels.
CODEC_VERBATIM,
CODEC_ZIP,
CODEC_VP8,
CODEC_VP9,
CODEC_OPUS,
CODEC_SPEEX,
};
// Creates a config with transport field set to TRANSPORT_NONE which indicates
// that corresponding channel is disabled.
static ChannelConfig None();
// Default constructor. Equivalent to None().
ChannelConfig() = default;
// Creates a channel config with the specified parameters.
ChannelConfig(TransportType transport, int version, Codec codec);
// operator== is overloaded so that std::find() works with
// std::list<ChannelConfig>.
bool operator==(const ChannelConfig& b) const;
TransportType transport = TRANSPORT_NONE;
int version = 0;
Codec codec = CODEC_UNDEFINED;
};
class CandidateSessionConfig;
// SessionConfig is used by the chromoting Session to store negotiated
// chromotocol configuration.
class SessionConfig {
public:
// Selects session configuration that is supported by both participants.
// nullptr is returned if such configuration doesn't exist. When selecting
// channel configuration priority is given to the configs listed first
// in |client_config|.
static scoped_ptr<SessionConfig> SelectCommon(
const CandidateSessionConfig* client_config,
const CandidateSessionConfig* host_config);
// Extracts final protocol configuration. Must be used for the description
// received in the session-accept stanza. If the selection is ambiguous
// (e.g. there is more than one configuration for one of the channel)
// or undefined (e.g. no configurations for a channel) then nullptr is
// returned.
static scoped_ptr<SessionConfig> GetFinalConfig(
const CandidateSessionConfig* candidate_config);
// Returns a suitable session configuration for use in tests.
static scoped_ptr<SessionConfig> ForTest();
static scoped_ptr<SessionConfig> WithLegacyIceForTest();
bool standard_ice() const { return standard_ice_; }
const ChannelConfig& control_config() const { return control_config_; }
const ChannelConfig& event_config() const { return event_config_; }
const ChannelConfig& video_config() const { return video_config_; }
const ChannelConfig& audio_config() const { return audio_config_; }
bool is_audio_enabled() const {
return audio_config_.transport != ChannelConfig::TRANSPORT_NONE;
}
private:
SessionConfig();
bool standard_ice_ = true;
ChannelConfig control_config_;
ChannelConfig event_config_;
ChannelConfig video_config_;
ChannelConfig audio_config_;
};
// Defines session description that is sent from client to the host in the
// session-initiate message. It is different from the regular Config
// because it allows one to specify multiple configurations for each channel.
class CandidateSessionConfig {
public:
static scoped_ptr<CandidateSessionConfig> CreateEmpty();
static scoped_ptr<CandidateSessionConfig> CreateFrom(
const SessionConfig& config);
static scoped_ptr<CandidateSessionConfig> CreateDefault();
~CandidateSessionConfig();
bool standard_ice() const { return standard_ice_; }
void set_standard_ice(bool standard_ice) { standard_ice_ = standard_ice; }
const std::list<ChannelConfig>& control_configs() const {
return control_configs_;
}
std::list<ChannelConfig>* mutable_control_configs() {
return &control_configs_;
}
const std::list<ChannelConfig>& event_configs() const {
return event_configs_;
}
std::list<ChannelConfig>* mutable_event_configs() {
return &event_configs_;
}
const std::list<ChannelConfig>& video_configs() const {
return video_configs_;
}
std::list<ChannelConfig>* mutable_video_configs() {
return &video_configs_;
}
const std::list<ChannelConfig>& audio_configs() const {
return audio_configs_;
}
std::list<ChannelConfig>* mutable_audio_configs() {
return &audio_configs_;
}
// Returns true if |config| is supported.
bool IsSupported(const SessionConfig& config) const;
scoped_ptr<CandidateSessionConfig> Clone() const;
// Helpers for enabling/disabling specific features.
void DisableAudioChannel();
void EnableVideoCodec(ChannelConfig::Codec codec);
private:
CandidateSessionConfig();
explicit CandidateSessionConfig(const CandidateSessionConfig& config);
CandidateSessionConfig& operator=(const CandidateSessionConfig& b);
bool standard_ice_ = true;
std::list<ChannelConfig> control_configs_;
std::list<ChannelConfig> event_configs_;
std::list<ChannelConfig> video_configs_;
std::list<ChannelConfig> audio_configs_;
};
} // namespace protocol
} // namespace remoting
#endif // REMOTING_PROTOCOL_SESSION_CONFIG_H_
|
