blob: bc7eb69c842ffd0f82f40e185ca6cda8efe706ad [file] [log] [blame]
// Copyright 2017 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 CHROME_COMMON_MEDIA_ROUTER_DISCOVERY_MEDIA_SINK_INTERNAL_H_
#define CHROME_COMMON_MEDIA_ROUTER_DISCOVERY_MEDIA_SINK_INTERNAL_H_
#include <utility>
#include "chrome/common/media_router/media_sink.h"
#include "net/base/ip_address.h"
#include "net/base/ip_endpoint.h"
#include "url/gurl.h"
namespace media_router {
// Extra data for DIAL media sink.
struct DialSinkExtraData {
net::IPAddress ip_address;
// Model name of the sink.
std::string model_name;
// The base URL used for DIAL operations.
GURL app_url;
DialSinkExtraData();
DialSinkExtraData(const DialSinkExtraData& other);
~DialSinkExtraData();
bool operator==(const DialSinkExtraData& other) const;
};
// Extra data for Cast media sink.
struct CastSinkExtraData {
net::IPEndPoint ip_endpoint;
int port = 0;
// Model name of the sink.
std::string model_name;
// A bit vector representing the capabilities of the sink. The values are
// defined in media_router.mojom.
uint8_t capabilities = 0;
// ID of Cast channel opened for the sink. The caller must set this value to a
// valid cast_channel_id. The cast_channel_id may change over time as the
// browser reconnects to a device.
int cast_channel_id = 0;
// True if Cast channel is opened from DIAL sink.
bool discovered_by_dial = false;
CastSinkExtraData();
CastSinkExtraData(const CastSinkExtraData& other);
~CastSinkExtraData();
bool operator==(const CastSinkExtraData& other) const;
};
// Represents a media sink discovered by MediaSinkService. It is used by
// MediaSinkService to push MediaSinks with extra data to the
// MediaRouteProvider, and it is not exposed to users of MediaRouter.
class MediaSinkInternal {
public:
// Used by mojo.
MediaSinkInternal();
// Used by MediaSinkService to create media sinks.
MediaSinkInternal(const MediaSink& sink, const DialSinkExtraData& dial_data);
MediaSinkInternal(const MediaSink& sink, const CastSinkExtraData& cast_data);
// Used to push instance of this class into vector.
MediaSinkInternal(const MediaSinkInternal& other);
~MediaSinkInternal();
MediaSinkInternal& operator=(const MediaSinkInternal& other);
bool operator==(const MediaSinkInternal& other) const;
bool operator!=(const MediaSinkInternal& other) const;
// Sorted by sink id.
bool operator<(const MediaSinkInternal& other) const;
void set_sink(const MediaSink& sink);
const MediaSink& sink() const { return sink_; }
MediaSink& sink() { return sink_; }
void set_dial_data(const DialSinkExtraData& dial_data);
// Must only be called if the sink is a DIAL sink.
const DialSinkExtraData& dial_data() const;
void set_cast_data(const CastSinkExtraData& cast_data);
// Must only be called if the sink is a Cast sink.
const CastSinkExtraData& cast_data() const;
bool is_dial_sink() const { return sink_type_ == SinkType::DIAL; }
bool is_cast_sink() const { return sink_type_ == SinkType::CAST; }
static bool IsValidSinkId(const std::string& sink_id);
private:
void InternalCopyConstructFrom(const MediaSinkInternal& other);
void InternalCleanup();
enum class SinkType { GENERIC, DIAL, CAST };
MediaSink sink_;
SinkType sink_type_;
union {
// Set if sink is DIAL sink.
DialSinkExtraData dial_data_;
// Set if sink is Cast sink.
CastSinkExtraData cast_data_;
};
};
} // namespace media_router
#endif // CHROME_COMMON_MEDIA_ROUTER_DISCOVERY_MEDIA_SINK_INTERNAL_H_