henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 1 | /* |
kjellander | b24317b | 2016-02-10 07:54:43 -0800 | [diff] [blame] | 2 | * Copyright 2013 The WebRTC project authors. All Rights Reserved. |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 3 | * |
kjellander | b24317b | 2016-02-10 07:54:43 -0800 | [diff] [blame] | 4 | * Use of this source code is governed by a BSD-style license |
| 5 | * that can be found in the LICENSE file in the root of the source |
| 6 | * tree. An additional intellectual property rights grant can be found |
| 7 | * in the file PATENTS. All contributing project authors may |
| 8 | * be found in the AUTHORS file in the root of the source tree. |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 9 | */ |
| 10 | |
| 11 | // This file contains the interface for MediaConstraints, corresponding to |
| 12 | // the definition at |
| 13 | // http://www.w3.org/TR/mediacapture-streams/#mediastreamconstraints and also |
| 14 | // used in WebRTC: http://dev.w3.org/2011/webrtc/editor/webrtc.html#constraints. |
| 15 | |
Niels Möller | f06f923 | 2018-08-07 12:32:18 +0200 | [diff] [blame] | 16 | // Implementation of the w3c constraints spec is the responsibility of the |
| 17 | // browser. Chrome no longer uses the constraints api declared here, and it will |
| 18 | // be removed from WebRTC. |
| 19 | // https://bugs.chromium.org/p/webrtc/issues/detail?id=9239 |
hta | a2a49d9 | 2016-03-04 02:51:39 -0800 | [diff] [blame] | 20 | |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 21 | #ifndef API_MEDIACONSTRAINTSINTERFACE_H_ |
| 22 | #define API_MEDIACONSTRAINTSINTERFACE_H_ |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 23 | |
| 24 | #include <string> |
| 25 | #include <vector> |
| 26 | |
Danil Chapovalov | 0bc58cf | 2018-06-21 13:32:56 +0200 | [diff] [blame] | 27 | #include "absl/types/optional.h" |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 28 | #include "api/peerconnectioninterface.h" |
hta | a2a49d9 | 2016-03-04 02:51:39 -0800 | [diff] [blame] | 29 | |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 30 | namespace webrtc { |
| 31 | |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 32 | // Interface used for passing arguments about media constraints |
| 33 | // to the MediaStream and PeerConnection implementation. |
deadbeef | b10f32f | 2017-02-08 01:38:21 -0800 | [diff] [blame] | 34 | // |
| 35 | // Constraints may be either "mandatory", which means that unless satisfied, |
| 36 | // the method taking the constraints should fail, or "optional", which means |
| 37 | // they may not be satisfied.. |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 38 | class MediaConstraintsInterface { |
| 39 | public: |
| 40 | struct Constraint { |
| 41 | Constraint() {} |
| 42 | Constraint(const std::string& key, const std::string value) |
Yves Gerey | 665174f | 2018-06-19 15:03:05 +0200 | [diff] [blame] | 43 | : key(key), value(value) {} |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 44 | std::string key; |
| 45 | std::string value; |
| 46 | }; |
| 47 | |
| 48 | class Constraints : public std::vector<Constraint> { |
| 49 | public: |
| 50 | bool FindFirst(const std::string& key, std::string* value) const; |
| 51 | }; |
| 52 | |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 53 | // Constraint keys used by a local video source. |
| 54 | // Specified by draft-alvestrand-constraints-resolution-00b |
| 55 | static const char kMinAspectRatio[]; // minAspectRatio |
| 56 | static const char kMaxAspectRatio[]; // maxAspectRatio |
Yves Gerey | 665174f | 2018-06-19 15:03:05 +0200 | [diff] [blame] | 57 | static const char kMaxWidth[]; // maxWidth |
| 58 | static const char kMinWidth[]; // minWidth |
| 59 | static const char kMaxHeight[]; // maxHeight |
| 60 | static const char kMinHeight[]; // minHeight |
| 61 | static const char kMaxFrameRate[]; // maxFrameRate |
| 62 | static const char kMinFrameRate[]; // minFrameRate |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 63 | |
| 64 | // Constraint keys used by a local audio source. |
tommi | 39b3100 | 2015-06-23 09:50:47 -0700 | [diff] [blame] | 65 | static const char kEchoCancellation[]; // echoCancellation |
| 66 | |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 67 | // These keys are google specific. |
Tommi | 70c7fe1 | 2015-06-15 09:14:03 +0200 | [diff] [blame] | 68 | static const char kGoogEchoCancellation[]; // googEchoCancellation |
| 69 | |
Henrik Lundin | 441f634 | 2015-06-09 16:03:13 +0200 | [diff] [blame] | 70 | static const char kExtendedFilterEchoCancellation[]; // googEchoCancellation2 |
Yves Gerey | 665174f | 2018-06-19 15:03:05 +0200 | [diff] [blame] | 71 | static const char kDAEchoCancellation[]; // googDAEchoCancellation |
| 72 | static const char kAutoGainControl[]; // googAutoGainControl |
| 73 | static const char kExperimentalAutoGainControl[]; // googAutoGainControl2 |
| 74 | static const char kNoiseSuppression[]; // googNoiseSuppression |
sergeyu@chromium.org | 9cf037b | 2014-02-07 19:03:26 +0000 | [diff] [blame] | 75 | static const char kExperimentalNoiseSuppression[]; // googNoiseSuppression2 |
Yves Gerey | 665174f | 2018-06-19 15:03:05 +0200 | [diff] [blame] | 76 | static const char kIntelligibilityEnhancer[]; // intelligibilityEnhancer |
| 77 | static const char kHighpassFilter[]; // googHighpassFilter |
sergeyu@chromium.org | a59696b | 2013-09-13 23:48:58 +0000 | [diff] [blame] | 78 | static const char kTypingNoiseDetection[]; // googTypingNoiseDetection |
Yves Gerey | 665174f | 2018-06-19 15:03:05 +0200 | [diff] [blame] | 79 | static const char kAudioMirroring[]; // googAudioMirroring |
minyue | ba41428 | 2016-12-11 02:17:52 -0800 | [diff] [blame] | 80 | static const char |
| 81 | kAudioNetworkAdaptorConfig[]; // goodAudioNetworkAdaptorConfig |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 82 | |
| 83 | // Google-specific constraint keys for a local video source |
| 84 | static const char kNoiseReduction[]; // googNoiseReduction |
henrike@webrtc.org | dce3feb | 2014-03-26 01:17:30 +0000 | [diff] [blame] | 85 | |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 86 | // Constraint keys for CreateOffer / CreateAnswer |
| 87 | // Specified by the W3C PeerConnection spec |
Yves Gerey | 665174f | 2018-06-19 15:03:05 +0200 | [diff] [blame] | 88 | static const char kOfferToReceiveVideo[]; // OfferToReceiveVideo |
| 89 | static const char kOfferToReceiveAudio[]; // OfferToReceiveAudio |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 90 | static const char kVoiceActivityDetection[]; // VoiceActivityDetection |
Yves Gerey | 665174f | 2018-06-19 15:03:05 +0200 | [diff] [blame] | 91 | static const char kIceRestart[]; // IceRestart |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 92 | // These keys are google specific. |
| 93 | static const char kUseRtpMux[]; // googUseRtpMUX |
| 94 | |
| 95 | // Constraints values. |
Yves Gerey | 665174f | 2018-06-19 15:03:05 +0200 | [diff] [blame] | 96 | static const char kValueTrue[]; // true |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 97 | static const char kValueFalse[]; // false |
| 98 | |
wu@webrtc.org | 1481491 | 2014-04-02 23:25:15 +0000 | [diff] [blame] | 99 | // PeerConnection constraint keys. |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 100 | // Temporary pseudo-constraints used to enable DTLS-SRTP |
| 101 | static const char kEnableDtlsSrtp[]; // Enable DTLS-SRTP |
| 102 | // Temporary pseudo-constraints used to enable DataChannels |
| 103 | static const char kEnableRtpDataChannels[]; // Enable RTP DataChannels |
wu@webrtc.org | 1481491 | 2014-04-02 23:25:15 +0000 | [diff] [blame] | 104 | // Google-specific constraint keys. |
wu@webrtc.org | de30501 | 2013-10-31 15:40:38 +0000 | [diff] [blame] | 105 | // Temporary pseudo-constraint for enabling DSCP through JS. |
wu@webrtc.org | 1481491 | 2014-04-02 23:25:15 +0000 | [diff] [blame] | 106 | static const char kEnableDscp[]; // googDscp |
henrika@webrtc.org | aebb1ad | 2014-01-14 10:00:58 +0000 | [diff] [blame] | 107 | // Constraint to enable IPv6 through JS. |
wu@webrtc.org | 1481491 | 2014-04-02 23:25:15 +0000 | [diff] [blame] | 108 | static const char kEnableIPv6[]; // googIPv6 |
henrike@webrtc.org | 6e3dbc2 | 2014-03-25 17:09:47 +0000 | [diff] [blame] | 109 | // Temporary constraint to enable suspend below min bitrate feature. |
| 110 | static const char kEnableVideoSuspendBelowMinBitrate[]; |
Yves Gerey | 665174f | 2018-06-19 15:03:05 +0200 | [diff] [blame] | 111 | // googSuspendBelowMinBitrate |
buildbot@webrtc.org | b4c7b09 | 2014-08-25 12:11:58 +0000 | [diff] [blame] | 112 | // Constraint to enable combined audio+video bandwidth estimation. |
| 113 | static const char kCombinedAudioVideoBwe[]; // googCombinedAudioVideoBwe |
Yves Gerey | 665174f | 2018-06-19 15:03:05 +0200 | [diff] [blame] | 114 | static const char kScreencastMinBitrate[]; // googScreencastMinBitrate |
| 115 | static const char kCpuOveruseDetection[]; // googCpuOveruseDetection |
| 116 | static const char kPayloadPadding[]; // googPayloadPadding |
buildbot@webrtc.org | d27d9ae | 2014-06-19 01:56:46 +0000 | [diff] [blame] | 117 | |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 118 | // The prefix of internal-only constraints whose JS set values should be |
| 119 | // stripped by Chrome before passed down to Libjingle. |
| 120 | static const char kInternalConstraintPrefix[]; |
| 121 | |
Jonas Oreland | fc1acd2 | 2018-08-24 10:58:37 +0200 | [diff] [blame] | 122 | // Specifies number of simulcast layers for all video tracks |
| 123 | // with a Plan B offer/answer |
| 124 | // (see RTCOfferAnswerOptions::num_simulcast_layers). |
| 125 | static const char kNumSimulcastLayers[]; |
| 126 | |
Magnus Jedvert | 3ecdd0f | 2017-11-24 11:21:14 +0100 | [diff] [blame] | 127 | virtual ~MediaConstraintsInterface() = default; |
| 128 | |
| 129 | virtual const Constraints& GetMandatory() const = 0; |
| 130 | virtual const Constraints& GetOptional() const = 0; |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 131 | }; |
| 132 | |
| 133 | bool FindConstraint(const MediaConstraintsInterface* constraints, |
Yves Gerey | 665174f | 2018-06-19 15:03:05 +0200 | [diff] [blame] | 134 | const std::string& key, |
| 135 | bool* value, |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 136 | size_t* mandatory_constraints); |
| 137 | |
hta | a2a49d9 | 2016-03-04 02:51:39 -0800 | [diff] [blame] | 138 | bool FindConstraint(const MediaConstraintsInterface* constraints, |
| 139 | const std::string& key, |
| 140 | int* value, |
| 141 | size_t* mandatory_constraints); |
| 142 | |
| 143 | // Copy all relevant constraints into an RTCConfiguration object. |
| 144 | void CopyConstraintsIntoRtcConfiguration( |
| 145 | const MediaConstraintsInterface* constraints, |
| 146 | PeerConnectionInterface::RTCConfiguration* configuration); |
| 147 | |
deadbeef | fe0fd41 | 2017-01-13 11:47:56 -0800 | [diff] [blame] | 148 | // Copy all relevant constraints into an AudioOptions object. |
| 149 | void CopyConstraintsIntoAudioOptions( |
| 150 | const MediaConstraintsInterface* constraints, |
| 151 | cricket::AudioOptions* options); |
| 152 | |
Niels Möller | f06f923 | 2018-08-07 12:32:18 +0200 | [diff] [blame] | 153 | bool CopyConstraintsIntoOfferAnswerOptions( |
| 154 | const MediaConstraintsInterface* constraints, |
| 155 | PeerConnectionInterface::RTCOfferAnswerOptions* offer_answer_options); |
| 156 | |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 157 | } // namespace webrtc |
| 158 | |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 159 | #endif // API_MEDIACONSTRAINTSINTERFACE_H_ |