chrome/browser/media/router/media_router_feature.h

// Copyright 2015 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef CHROME_BROWSER_MEDIA_ROUTER_MEDIA_ROUTER_FEATURE_H_
#define CHROME_BROWSER_MEDIA_ROUTER_MEDIA_ROUTER_FEATURE_H_

#include "base/feature_list.h"
#include "base/metrics/field_trial_params.h"
#include "base/time/time.h"
#include "build/build_config.h"
#include "extensions/buildflags/buildflags.h"

class PrefRegistrySimple;
class PrefService;

namespace content {
class BrowserContext;
}

namespace media_router {

// Returns true if Media Router is enabled for |context|.
bool MediaRouterEnabled(content::BrowserContext* context);

// Clears stored prefs so they don't leak between tests running in the same
// process.
void ClearMediaRouterStoredPrefsForTesting();

#if !BUILDFLAG(IS_ANDROID) || BUILDFLAG(ENABLE_DESKTOP_ANDROID_EXTENSIONS)
// Enables the media router. Can be disabled in tests unrelated to
// Media Router where it interferes. Can also be useful to disable for local
// development on Mac because DIAL local discovery opens a local port
// and triggers a permission prompt.
BASE_DECLARE_FEATURE(kMediaRouter);

// If enabled, allows Media Router to connect to Cast devices on all IP
// addresses, not just RFC1918/RFC4193 private addresses. Workaround for
// https://crbug.com/813974.
BASE_DECLARE_FEATURE(kCastAllowAllIPsFeature);

// If enabled, allows all websites to request to start mirroring via
// Presentation API. If disabled, only the allowlisted sites can do so.
BASE_DECLARE_FEATURE(kAllowAllSitesToInitiateMirroring);

// If enabled, The browser allows discovery of the DIAL support cast device.
// It sends a discovery SSDP message every 120 seconds.
BASE_DECLARE_FEATURE(kDialMediaRouteProvider);

// If enabled, the browser delays background discovery of Cast and DIAL devices
// until explicit user interaction with the Cast feature.
BASE_DECLARE_FEATURE(kDelayMediaSinkDiscovery);

// If enabled, the Cast or Global Media Controls UI shows error messages when
// Chrome doesn't have necessary permission for discovery devices connected to
// the local network.
BASE_DECLARE_FEATURE(kShowCastPermissionRejectedError);

// If enabled, sinks that do not support presentation or remote playback, will
// fall back to audio tab mirroring when casting from the Global Media Controls.
BASE_DECLARE_FEATURE(kFallbackToAudioTabMirroring);

// When enabled, messages between websites and Chrome, and Chrome and Cast
// receivers will be logged in chrome://media-router-internals.  These messages
// can be frequent and contain sensitive information, so disabled by default.
BASE_DECLARE_FEATURE(kCastMessageLogging);

#if BUILDFLAG(IS_MAC)
// If enabled, Chrome uses the Network Framework API for local device discovery
// on Mac.
BASE_DECLARE_FEATURE(kUseNetworkFrameworkForLocalDiscovery);
#endif

extern const base::FeatureParam<int> kCastMirroringPlayoutDelayMs;

// Registers |kMediaRouterCastAllowAllIPs| with local state pref |registry|.
void RegisterLocalStatePrefs(PrefRegistrySimple* registry);

// Registers Media Router related preferences with per-profile pref |registry|.
void RegisterProfilePrefs(PrefRegistrySimple* registry);

// Returns true if CastMediaSinkService can connect to Cast devices on
// all IPs, as determined by local state |pref_service| / feature flag.
bool GetCastAllowAllIPsPref(PrefService* pref_service);

// Returns the hash token to use for externalizing MediaSink IDs from
// |pref_service|. If the token does not exist, the token will be created from a
// randomly generated string and stored in |pref_service|.
std::string GetReceiverIdHashToken(PrefService* pref_service);

// Returns true if support for DIAL devices is enabled.  Disabling DIAL support
// also disables SSDP-based discovery for Cast devices.
bool DialMediaRouteProviderEnabled();

// Returns the optional value to use for mirroring playout delay from the
// relevant command line flag or feature, if any are set.
std::optional<base::TimeDelta> GetCastMirroringPlayoutDelay();

// When enabled, logs of all the messages exchanged between Cast devices,
// Chrome, and Web pages using the Presentation API into
// chrome://media-router-internals.  These logs can verbose and contain
// sensitive information, so use with caution.
bool IsCastMessageLoggingEnabled();
#endif  // !BUILDFLAG(IS_ANDROID) ||
        // BUILDFLAG(ENABLE_DESKTOP_ANDROID_EXTENSIONS)

}  // namespace media_router

#endif  // CHROME_BROWSER_MEDIA_ROUTER_MEDIA_ROUTER_FEATURE_H_