// 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.
#include "remoting/protocol/content_description.h"
#include "base/logging.h"
#include "base/string_number_conversions.h"
#include "remoting/base/constants.h"
#include "remoting/protocol/authenticator.h"
#include "third_party/libjingle/source/talk/xmllite/xmlelement.h"
using buzz::QName;
using buzz::XmlElement;
namespace remoting {
namespace protocol {
const char ContentDescription::kChromotingContentName[] = "chromoting";
namespace {
const char kDefaultNs[] = "";
// Following constants are used to format session description in XML.
const char kDescriptionTag[] = "description";
const char kControlTag[] = "control";
const char kEventTag[] = "event";
const char kVideoTag[] = "video";
const char kDeprecatedResolutionTag[] = "initial-resolution";
const char kTransportAttr[] = "transport";
const char kVersionAttr[] = "version";
const char kCodecAttr[] = "codec";
const char kDeprecatedWidthAttr[] = "width";
const char kDeprecatedHeightAttr[] = "height";
const char kStreamTransport[] = "stream";
const char kDatagramTransport[] = "datagram";
const char kSrtpTransport[] = "srtp";
const char kRtpDtlsTransport[] = "rtp-dtls";
const char kVp8Codec[] = "vp8";
const char kZipCodec[] = "zip";
const char* GetTransportName(ChannelConfig::TransportType type) {
switch (type) {
case ChannelConfig::TRANSPORT_STREAM:
return kStreamTransport;
case ChannelConfig::TRANSPORT_DATAGRAM:
return kDatagramTransport;
case ChannelConfig::TRANSPORT_SRTP:
return kSrtpTransport;
case ChannelConfig::TRANSPORT_RTP_DTLS:
return kRtpDtlsTransport;
}
NOTREACHED();
return NULL;
}
const char* GetCodecName(ChannelConfig::Codec type) {
switch (type) {
case ChannelConfig::CODEC_VP8:
return kVp8Codec;
case ChannelConfig::CODEC_ZIP:
return kZipCodec;
default:
break;
}
NOTREACHED();
return NULL;
}
// Format a channel configuration tag for chromotocol session description,
// e.g. for video channel:
//
XmlElement* FormatChannelConfig(const ChannelConfig& config,
const std::string& tag_name) {
XmlElement* result = new XmlElement(
QName(kChromotingXmlNamespace, tag_name));
result->AddAttr(QName(kDefaultNs, kTransportAttr),
GetTransportName(config.transport));
result->AddAttr(QName(kDefaultNs, kVersionAttr),
base::IntToString(config.version));
if (config.codec != ChannelConfig::CODEC_UNDEFINED) {
result->AddAttr(QName(kDefaultNs, kCodecAttr),
GetCodecName(config.codec));
}
return result;
}
bool ParseTransportName(const std::string& value,
ChannelConfig::TransportType* transport) {
if (value == kStreamTransport) {
*transport = ChannelConfig::TRANSPORT_STREAM;
} else if (value == kDatagramTransport) {
*transport = ChannelConfig::TRANSPORT_DATAGRAM;
} else if (value == kSrtpTransport) {
*transport = ChannelConfig::TRANSPORT_SRTP;
} else if (value == kRtpDtlsTransport) {
*transport = ChannelConfig::TRANSPORT_RTP_DTLS;
} else {
return false;
}
return true;
}
bool ParseCodecName(const std::string& value, ChannelConfig::Codec* codec) {
if (value == kVp8Codec) {
*codec = ChannelConfig::CODEC_VP8;
} else if (value == kZipCodec) {
*codec = ChannelConfig::CODEC_ZIP;
} else {
return false;
}
return true;
}
// Returns false if the element is invalid.
bool ParseChannelConfig(const XmlElement* element, bool codec_required,
ChannelConfig* config) {
if (!ParseTransportName(element->Attr(QName(kDefaultNs, kTransportAttr)),
&config->transport) ||
!base::StringToInt(element->Attr(QName(kDefaultNs, kVersionAttr)),
&config->version)) {
return false;
}
if (codec_required) {
if (!ParseCodecName(element->Attr(QName(kDefaultNs, kCodecAttr)),
&config->codec)) {
return false;
}
} else {
config->codec = ChannelConfig::CODEC_UNDEFINED;
}
return true;
}
} // namespace
ContentDescription::ContentDescription(
scoped_ptr config,
scoped_ptr authenticator_message)
: candidate_config_(config.Pass()),
authenticator_message_(authenticator_message.Pass()) {
}
ContentDescription::~ContentDescription() { }
// ToXml() creates content description for chromoting session. The
// description looks as follows:
//
//
//
//
//
// Message created by Authenticator implementation.
//
//
//
XmlElement* ContentDescription::ToXml() const {
XmlElement* root = new XmlElement(
QName(kChromotingXmlNamespace, kDescriptionTag), true);
std::vector::const_iterator it;
for (it = config()->control_configs().begin();
it != config()->control_configs().end(); ++it) {
root->AddElement(FormatChannelConfig(*it, kControlTag));
}
for (it = config()->event_configs().begin();
it != config()->event_configs().end(); ++it) {
root->AddElement(FormatChannelConfig(*it, kEventTag));
}
for (it = config()->video_configs().begin();
it != config()->video_configs().end(); ++it) {
root->AddElement(FormatChannelConfig(*it, kVideoTag));
}
// Older endpoints require an initial-resolution tag, but otherwise ignore it.
XmlElement* resolution_tag = new XmlElement(
QName(kChromotingXmlNamespace, kDeprecatedResolutionTag));
resolution_tag->AddAttr(QName(kDefaultNs, kDeprecatedWidthAttr), "640");
resolution_tag->AddAttr(QName(kDefaultNs, kDeprecatedHeightAttr), "480");
root->AddElement(resolution_tag);
if (authenticator_message_.get()) {
DCHECK(Authenticator::IsAuthenticatorMessage(authenticator_message_.get()));
root->AddElement(new XmlElement(*authenticator_message_));
}
return root;
}
// static
ContentDescription* ContentDescription::ParseXml(
const XmlElement* element) {
if (element->Name() == QName(kChromotingXmlNamespace, kDescriptionTag)) {
scoped_ptr config(
CandidateSessionConfig::CreateEmpty());
const XmlElement* child = NULL;
// tags.
QName control_tag(kChromotingXmlNamespace, kControlTag);
child = element->FirstNamed(control_tag);
while (child) {
ChannelConfig channel_config;
if (!ParseChannelConfig(child, false, &channel_config))
return NULL;
config->mutable_control_configs()->push_back(channel_config);
child = child->NextNamed(control_tag);
}
// tags.
QName event_tag(kChromotingXmlNamespace, kEventTag);
child = element->FirstNamed(event_tag);
while (child) {
ChannelConfig channel_config;
if (!ParseChannelConfig(child, false, &channel_config))
return NULL;
config->mutable_event_configs()->push_back(channel_config);
child = child->NextNamed(event_tag);
}
//