remoting/protocol/session_config.h

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef REMOTING_PROTOCOL_SESSION_CONFIG_H_
   6 #define REMOTING_PROTOCOL_SESSION_CONFIG_H_
   7
   8 #include <list>
   9 #include <string>
  10
  11 #include "base/basictypes.h"
  12 #include "base/memory/scoped_ptr.h"
  13
  14 namespace remoting {
  15 namespace protocol {
  16
  17 extern const int kDefaultStreamVersion;
  18
  19 // Struct for configuration parameters of a single channel.
  20 // Some channels (like video) may have multiple underlying sockets that need
  21 // to be configured simultaneously.
  22 struct ChannelConfig {
  23   enum TransportType {
  24     TRANSPORT_STREAM,
  25     TRANSPORT_MUX_STREAM,
  26     TRANSPORT_DATAGRAM,
  27     TRANSPORT_NONE,
  28   };
  29
  30   enum Codec {
  31     CODEC_UNDEFINED,  // Used for event and control channels.
  32     CODEC_VERBATIM,
  33     CODEC_ZIP,
  34     CODEC_VP8,
  35     CODEC_VP9,
  36     CODEC_OPUS,
  37     CODEC_SPEEX,
  38   };
  39
  40   // Creates a config with transport field set to TRANSPORT_NONE which indicates
  41   // that corresponding channel is disabled.
  42   static ChannelConfig None();
  43
  44   // Default constructor. Equivalent to None().
  45   ChannelConfig() = default;
  46
  47   // Creates a channel config with the specified parameters.
  48   ChannelConfig(TransportType transport, int version, Codec codec);
  49
  50   // operator== is overloaded so that std::find() works with
  51   // std::list<ChannelConfig>.
  52   bool operator==(const ChannelConfig& b) const;
  53
  54   TransportType transport = TRANSPORT_NONE;
  55   int version = 0;
  56   Codec codec = CODEC_UNDEFINED;
  57 };
  58
  59 class CandidateSessionConfig;
  60
  61 // SessionConfig is used by the chromoting Session to store negotiated
  62 // chromotocol configuration.
  63 class SessionConfig {
  64  public:
  65   // Selects session configuration that is supported by both participants.
  66   // nullptr is returned if such configuration doesn't exist. When selecting
  67   // channel configuration priority is given to the configs listed first
  68   // in |client_config|.
  69   static scoped_ptr<SessionConfig> SelectCommon(
  70       const CandidateSessionConfig* client_config,
  71       const CandidateSessionConfig* host_config);
  72
  73   // Extracts final protocol configuration. Must be used for the description
  74   // received in the session-accept stanza. If the selection is ambiguous
  75   // (e.g. there is more than one configuration for one of the channel)
  76   // or undefined (e.g. no configurations for a channel) then nullptr is
  77   // returned.
  78   static scoped_ptr<SessionConfig> GetFinalConfig(
  79       const CandidateSessionConfig* candidate_config);
  80
  81   // Returns a suitable session configuration for use in tests.
  82   static scoped_ptr<SessionConfig> ForTest();
  83   static scoped_ptr<SessionConfig> WithLegacyIceForTest();
  84
  85   bool standard_ice() const { return standard_ice_; }
  86
  87   const ChannelConfig& control_config() const { return control_config_; }
  88   const ChannelConfig& event_config() const { return event_config_; }
  89   const ChannelConfig& video_config() const { return video_config_; }
  90   const ChannelConfig& audio_config() const { return audio_config_; }
  91
  92   bool is_audio_enabled() const {
  93     return audio_config_.transport != ChannelConfig::TRANSPORT_NONE;
  94   }
  95
  96  private:
  97   SessionConfig();
  98
  99   bool standard_ice_ = true;
 100
 101   ChannelConfig control_config_;
 102   ChannelConfig event_config_;
 103   ChannelConfig video_config_;
 104   ChannelConfig audio_config_;
 105 };
 106
 107 // Defines session description that is sent from client to the host in the
 108 // session-initiate message. It is different from the regular Config
 109 // because it allows one to specify multiple configurations for each channel.
 110 class CandidateSessionConfig {
 111  public:
 112   static scoped_ptr<CandidateSessionConfig> CreateEmpty();
 113   static scoped_ptr<CandidateSessionConfig> CreateFrom(
 114       const SessionConfig& config);
 115   static scoped_ptr<CandidateSessionConfig> CreateDefault();
 116
 117   ~CandidateSessionConfig();
 118
 119   bool standard_ice() const { return standard_ice_; }
 120   void set_standard_ice(bool standard_ice) { standard_ice_ = standard_ice; }
 121
 122   const std::list<ChannelConfig>& control_configs() const {
 123     return control_configs_;
 124   }
 125
 126   std::list<ChannelConfig>* mutable_control_configs() {
 127     return &control_configs_;
 128   }
 129
 130   const std::list<ChannelConfig>& event_configs() const {
 131     return event_configs_;
 132   }
 133
 134   std::list<ChannelConfig>* mutable_event_configs() {
 135     return &event_configs_;
 136   }
 137
 138   const std::list<ChannelConfig>& video_configs() const {
 139     return video_configs_;
 140   }
 141
 142   std::list<ChannelConfig>* mutable_video_configs() {
 143     return &video_configs_;
 144   }
 145
 146   const std::list<ChannelConfig>& audio_configs() const {
 147     return audio_configs_;
 148   }
 149
 150   std::list<ChannelConfig>* mutable_audio_configs() {
 151     return &audio_configs_;
 152   }
 153
 154   // Returns true if |config| is supported.
 155   bool IsSupported(const SessionConfig& config) const;
 156
 157   scoped_ptr<CandidateSessionConfig> Clone() const;
 158
 159   // Helpers for enabling/disabling specific features.
 160   void DisableAudioChannel();
 161   void EnableVideoCodec(ChannelConfig::Codec codec);
 162
 163  private:
 164   CandidateSessionConfig();
 165   explicit CandidateSessionConfig(const CandidateSessionConfig& config);
 166   CandidateSessionConfig& operator=(const CandidateSessionConfig& b);
 167
 168   bool standard_ice_ = true;
 169
 170   std::list<ChannelConfig> control_configs_;
 171   std::list<ChannelConfig> event_configs_;
 172   std::list<ChannelConfig> video_configs_;
 173   std::list<ChannelConfig> audio_configs_;
 174 };
 175
 176 }  // namespace protocol
 177 }  // namespace remoting
 178
 179 #endif  // REMOTING_PROTOCOL_SESSION_CONFIG_H_