Thanks to visit codestin.com
Credit goes to webrtc.googlesource.com

Google Git
Sign in
webrtc / src / refs/heads/lkgr / . / api / media_stream_interface.h
blob: 07fc72dc1236ad13403a871c54e0aea5e030f286 [file] [log] [blame]
[email protected]28e20752013-07-10 00:45:36[diff] [blame]1/*
kjellanderb24317b2016-02-10 15:54:43[diff] [blame]2 * Copyright 2012 The WebRTC project authors. All Rights Reserved.
[email protected]28e20752013-07-10 00:45:36[diff] [blame]3 *
kjellanderb24317b2016-02-10 15:54:43[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.
[email protected]28e20752013-07-10 00:45:36[diff] [blame]9 */
10
11// This file contains interfaces for MediaStream, MediaTrack and MediaSource.
12// These interfaces are used for implementing MediaStream and MediaTrack as
13// defined in http://dev.w3.org/2011/webrtc/editor/webrtc.html#stream-api. These
Niels Möllere942b142019-09-17 12:30:41[diff] [blame]14// interfaces must be used only with PeerConnection.
[email protected]28e20752013-07-10 00:45:36[diff] [blame]15
Steve Anton10542f22019-01-11 17:11:00[diff] [blame]16#ifndef API_MEDIA_STREAM_INTERFACE_H_
17#define API_MEDIA_STREAM_INTERFACE_H_
[email protected]28e20752013-07-10 00:45:36[diff] [blame]18
pbos9baddf22017-01-02 14:44:41[diff] [blame]19#include <stddef.h>
Dor Henaefed552024-06-18 13:20:35[diff] [blame]20#include <stdint.h>
pbos9baddf22017-01-02 14:44:41[diff] [blame]21
Florent Castelli8037fc62024-08-29 13:00:40[diff] [blame]22#include <optional>
[email protected]28e20752013-07-10 00:45:36[diff] [blame]23#include <string>
24#include <vector>
25
Florent Castelli0afde762024-04-19 15:07:08[diff] [blame]26#include "api/audio/audio_processing_statistics.h"
Piotr (Peter) Slatala95ca6e12018-11-13 15:57:07[diff] [blame]27#include "api/audio_options.h"
Harald Alvestrande8a2b3c2023-10-31 13:30:30[diff] [blame]28#include "api/ref_count.h"
Mirko Bonadeid9708072019-01-25 19:26:48[diff] [blame]29#include "api/scoped_refptr.h"
Markus Handell9982efa2019-11-21 10:56:50[diff] [blame]30#include "api/video/recordable_encoded_frame.h"
Mirko Bonadei92ea95e2017-09-15 04:47:31[diff] [blame]31#include "api/video/video_frame.h"
Niels Möllerc6ce9c52018-05-11 09:15:30[diff] [blame]32#include "api/video/video_sink_interface.h"
Niels Möller0327c2d2018-05-21 12:09:31[diff] [blame]33#include "api/video/video_source_interface.h"
Markus Handell6fa9e682021-10-13 20:50:53[diff] [blame]34#include "api/video_track_source_constraints.h"
Dor Henaefed552024-06-18 13:20:35[diff] [blame]35#include "rtc_base/checks.h"
Mirko Bonadei66e76792019-04-02 09:33:59[diff] [blame]36#include "rtc_base/system/rtc_export.h"
[email protected]28e20752013-07-10 00:45:36[diff] [blame]37
[email protected]28e20752013-07-10 00:45:36[diff] [blame]38namespace webrtc {
39
40// Generic observer interface.
41class ObserverInterface {
42 public:
43 virtual void OnChanged() = 0;
44
45 protected:
46 virtual ~ObserverInterface() {}
47};
48
49class NotifierInterface {
50 public:
51 virtual void RegisterObserver(ObserverInterface* observer) = 0;
52 virtual void UnregisterObserver(ObserverInterface* observer) = 0;
53
54 virtual ~NotifierInterface() {}
55};
56
deadbeefb10f32f2017-02-08 09:38:21[diff] [blame]57// Base class for sources. A MediaStreamTrack has an underlying source that
58// provides media. A source can be shared by multiple tracks.
Harald Alvestrand3d120662025-06-11 07:34:39[diff] [blame]59class RTC_EXPORT MediaSourceInterface : public RefCountInterface,
Mirko Bonadei66e76792019-04-02 09:33:59[diff] [blame]60 public NotifierInterface {
[email protected]28e20752013-07-10 00:45:36[diff] [blame]61 public:
Yves Gerey665174f2018-06-19 13:03:05[diff] [blame]62 enum SourceState { kInitializing, kLive, kEnded, kMuted };
[email protected]28e20752013-07-10 00:45:36[diff] [blame]63
64 virtual SourceState state() const = 0;
65
tommi6eca7e32015-12-15 12:27:11[diff] [blame]66 virtual bool remote() const = 0;
67
[email protected]28e20752013-07-10 00:45:36[diff] [blame]68 protected:
Danil Chapovalov2a5ce2b2018-02-07 08:38:31[diff] [blame]69 ~MediaSourceInterface() override = default;
[email protected]28e20752013-07-10 00:45:36[diff] [blame]70};
71
deadbeefb10f32f2017-02-08 09:38:21[diff] [blame]72// C++ version of MediaStreamTrack.
73// See: https://www.w3.org/TR/mediacapture-streams/#mediastreamtrack
Harald Alvestrand3d120662025-06-11 07:34:39[diff] [blame]74class RTC_EXPORT MediaStreamTrackInterface : public RefCountInterface,
Mirko Bonadei66e76792019-04-02 09:33:59[diff] [blame]75 public NotifierInterface {
[email protected]28e20752013-07-10 00:45:36[diff] [blame]76 public:
77 enum TrackState {
perkjc8f952d2016-03-23 07:33:56[diff] [blame]78 kLive,
79 kEnded,
[email protected]28e20752013-07-10 00:45:36[diff] [blame]80 };
81
Niels Möller6dcd4dc2019-08-26 08:45:28[diff] [blame]82 static const char* const kAudioKind;
83 static const char* const kVideoKind;
deadbeeffac06552015-11-25 19:26:01[diff] [blame]84
nissefcc640f2016-04-01 08:10:42[diff] [blame]85 // The kind() method must return kAudioKind only if the object is a
86 // subclass of AudioTrackInterface, and kVideoKind only if the
87 // object is a subclass of VideoTrackInterface. It is typically used
88 // to protect a static_cast<> to the corresponding subclass.
[email protected]28e20752013-07-10 00:45:36[diff] [blame]89 virtual std::string kind() const = 0;
deadbeefb10f32f2017-02-08 09:38:21[diff] [blame]90
91 // Track identifier.
[email protected]28e20752013-07-10 00:45:36[diff] [blame]92 virtual std::string id() const = 0;
deadbeefb10f32f2017-02-08 09:38:21[diff] [blame]93
94 // A disabled track will produce silence (if audio) or black frames (if
95 // video). Can be disabled and re-enabled.
[email protected]28e20752013-07-10 00:45:36[diff] [blame]96 virtual bool enabled() const = 0;
[email protected]28e20752013-07-10 00:45:36[diff] [blame]97 virtual bool set_enabled(bool enable) = 0;
[email protected]32001ef2013-08-12 23:26:21[diff] [blame]98
deadbeefb10f32f2017-02-08 09:38:21[diff] [blame]99 // Live or ended. A track will never be live again after becoming ended.
100 virtual TrackState state() const = 0;
101
[email protected]32001ef2013-08-12 23:26:21[diff] [blame]102 protected:
Danil Chapovalov2a5ce2b2018-02-07 08:38:31[diff] [blame]103 ~MediaStreamTrackInterface() override = default;
[email protected]28e20752013-07-10 00:45:36[diff] [blame]104};
105
deadbeefb10f32f2017-02-08 09:38:21[diff] [blame]106// VideoTrackSourceInterface is a reference counted source used for
107// VideoTracks. The same source can be used by multiple VideoTracks.
perkj773be362017-08-01 06:22:01[diff] [blame]108// VideoTrackSourceInterface is designed to be invoked on the signaling thread
Harald Alvestrand3d120662025-06-11 07:34:39[diff] [blame]109// except for VideoSourceInterface<VideoFrame> methods that will be
Evan Shrubsoleee5ab342025-04-15 14:49:46[diff] [blame]110// invoked on the worker thread via a VideoTrack. A custom implementation of a
111// source can inherit AdaptedVideoTrackSource instead of directly implementing
112// this interface.
Yves Gerey665174f2018-06-19 13:03:05[diff] [blame]113class VideoTrackSourceInterface : public MediaSourceInterface,
Evan Shrubsole8f7678f2025-04-01 14:23:55[diff] [blame]114 public VideoSourceInterface<VideoFrame> {
perkja3ede6c2016-03-08 00:27:48[diff] [blame]115 public:
nissefcc640f2016-04-01 08:10:42[diff] [blame]116 struct Stats {
117 // Original size of captured frame, before video adaptation.
118 int input_width;
119 int input_height;
120 };
perkja3ede6c2016-03-08 00:27:48[diff] [blame]121
perkj0d3eef22016-03-09 01:39:17[diff] [blame]122 // Indicates that parameters suitable for screencasts should be automatically
123 // applied to RtpSenders.
124 // TODO(perkj): Remove these once all known applications have moved to
deadbeefb10f32f2017-02-08 09:38:21[diff] [blame]125 // explicitly setting suitable parameters for screencasts and don't need this
perkj0d3eef22016-03-09 01:39:17[diff] [blame]126 // implicit behavior.
127 virtual bool is_screencast() const = 0;
128
Perc0d31e92016-03-31 15:23:39[diff] [blame]129 // Indicates that the encoder should denoise video before encoding it.
130 // If it is not set, the default configuration is used which is different
131 // depending on video codec.
perkj0d3eef22016-03-09 01:39:17[diff] [blame]132 // TODO(perkj): Remove this once denoising is done by the source, and not by
133 // the encoder.
Florent Castelli8037fc62024-08-29 13:00:40[diff] [blame]134 virtual std::optional<bool> needs_denoising() const = 0;
perkja3ede6c2016-03-08 00:27:48[diff] [blame]135
deadbeefb10f32f2017-02-08 09:38:21[diff] [blame]136 // Returns false if no stats are available, e.g, for a remote source, or a
137 // source which has not seen its first frame yet.
138 //
139 // Implementation should avoid blocking.
nissefcc640f2016-04-01 08:10:42[diff] [blame]140 virtual bool GetStats(Stats* stats) = 0;
141
Markus Handell9982efa2019-11-21 10:56:50[diff] [blame]142 // Returns true if encoded output can be enabled in the source.
Markus Handell6efc14b2020-05-05 18:11:13[diff] [blame]143 virtual bool SupportsEncodedOutput() const = 0;
Markus Handell9982efa2019-11-21 10:56:50[diff] [blame]144
145 // Reliably cause a key frame to be generated in encoded output.
146 // TODO(bugs.webrtc.org/11115): find optimal naming.
Markus Handell6efc14b2020-05-05 18:11:13[diff] [blame]147 virtual void GenerateKeyFrame() = 0;
Markus Handell9982efa2019-11-21 10:56:50[diff] [blame]148
149 // Add an encoded video sink to the source and additionally cause
150 // a key frame to be generated from the source. The sink will be
151 // invoked from a decoder queue.
Markus Handell9982efa2019-11-21 10:56:50[diff] [blame]152 virtual void AddEncodedSink(
Evan Shrubsole8f7678f2025-04-01 14:23:55[diff] [blame]153 VideoSinkInterface<RecordableEncodedFrame>* sink) = 0;
Markus Handell9982efa2019-11-21 10:56:50[diff] [blame]154
155 // Removes an encoded video sink from the source.
Markus Handell9982efa2019-11-21 10:56:50[diff] [blame]156 virtual void RemoveEncodedSink(
Evan Shrubsole8f7678f2025-04-01 14:23:55[diff] [blame]157 VideoSinkInterface<RecordableEncodedFrame>* sink) = 0;
Markus Handell9982efa2019-11-21 10:56:50[diff] [blame]158
Markus Handell6fa9e682021-10-13 20:50:53[diff] [blame]159 // Notify about constraints set on the source. The information eventually gets
160 // routed to attached sinks via VideoSinkInterface<>::OnConstraintsChanged.
161 // The call is expected to happen on the network thread.
162 // TODO(crbug/1255737): make pure virtual once downstream project adapts.
163 virtual void ProcessConstraints(
Harald Alvestrand3d120662025-06-11 07:34:39[diff] [blame]164 const VideoTrackSourceConstraints& /* constraints */) {}
Markus Handell6fa9e682021-10-13 20:50:53[diff] [blame]165
perkja3ede6c2016-03-08 00:27:48[diff] [blame]166 protected:
Danil Chapovalov2a5ce2b2018-02-07 08:38:31[diff] [blame]167 ~VideoTrackSourceInterface() override = default;
perkja3ede6c2016-03-08 00:27:48[diff] [blame]168};
[email protected]28e20752013-07-10 00:45:36[diff] [blame]169
perkj773be362017-08-01 06:22:01[diff] [blame]170// VideoTrackInterface is designed to be invoked on the signaling thread except
Harald Alvestrand3d120662025-06-11 07:34:39[diff] [blame]171// for VideoSourceInterface<VideoFrame> methods that must be invoked
perkj773be362017-08-01 06:22:01[diff] [blame]172// on the worker thread.
173// PeerConnectionFactory::CreateVideoTrack can be used for creating a VideoTrack
174// that ensures thread safety and that all methods are called on the right
175// thread.
Evan Shrubsole8f7678f2025-04-01 14:23:55[diff] [blame]176class RTC_EXPORT VideoTrackInterface : public MediaStreamTrackInterface,
177 public VideoSourceInterface<VideoFrame> {
[email protected]28e20752013-07-10 00:45:36[diff] [blame]178 public:
pbos5214a0a2016-12-16 23:39:11[diff] [blame]179 // Video track content hint, used to override the source is_screencast
180 // property.
Harald Alvestrandc19ab072018-06-18 06:53:10[diff] [blame]181 // See https://crbug.com/653531 and https://w3c.github.io/mst-content-hint.
182 enum class ContentHint { kNone, kFluid, kDetailed, kText };
pbos5214a0a2016-12-16 23:39:11[diff] [blame]183
mbonadei539d1042017-07-10 09:40:49[diff] [blame]184 // Register a video sink for this track. Used to connect the track to the
185 // underlying video engine.
Evan Shrubsole8f7678f2025-04-01 14:23:55[diff] [blame]186 void AddOrUpdateSink(VideoSinkInterface<VideoFrame>* /* sink */,
187 const VideoSinkWants& /* wants */) override {}
188 void RemoveSink(VideoSinkInterface<VideoFrame>* /* sink */) override {}
mbonadei539d1042017-07-10 09:40:49[diff] [blame]189
perkja3ede6c2016-03-08 00:27:48[diff] [blame]190 virtual VideoTrackSourceInterface* GetSource() const = 0;
[email protected]28e20752013-07-10 00:45:36[diff] [blame]191
Danil Chapovalov2a5ce2b2018-02-07 08:38:31[diff] [blame]192 virtual ContentHint content_hint() const;
Dor Hen049b43b2024-10-15 07:51:54[diff] [blame]193 virtual void set_content_hint(ContentHint /* hint */) {}
pbos5214a0a2016-12-16 23:39:11[diff] [blame]194
[email protected]28e20752013-07-10 00:45:36[diff] [blame]195 protected:
Danil Chapovalov2a5ce2b2018-02-07 08:38:31[diff] [blame]196 ~VideoTrackInterface() override = default;
[email protected]28e20752013-07-10 00:45:36[diff] [blame]197};
198
tommi6eca7e32015-12-15 12:27:11[diff] [blame]199// Interface for receiving audio data from a AudioTrack.
200class AudioTrackSinkInterface {
201 public:
Dor Hen049b43b2024-10-15 07:51:54[diff] [blame]202 virtual void OnData(const void* /* audio_data */,
203 int /* bits_per_sample */,
204 int /* sample_rate */,
205 size_t /* number_of_channels */,
206 size_t /* number_of_frames */) {
Artem Titovd3251962021-11-15 15:57:07[diff] [blame]207 RTC_DCHECK_NOTREACHED() << "This method must be overridden, or not used.";
Minyue Li99d6d812020-01-29 09:25:12[diff] [blame]208 }
209
Artem Titov0e61fdd2021-07-25 19:50:14[diff] [blame]210 // In this method, `absolute_capture_timestamp_ms`, when available, is
Minyue Li99d6d812020-01-29 09:25:12[diff] [blame]211 // supposed to deliver the timestamp when this audio frame was originally
212 // captured. This timestamp MUST be based on the same clock as
Harald Alvestrand3d120662025-06-11 07:34:39[diff] [blame]213 // TimeMillis().
Dor Hen049b43b2024-10-15 07:51:54[diff] [blame]214 virtual void OnData(
215 const void* audio_data,
216 int bits_per_sample,
217 int sample_rate,
218 size_t number_of_channels,
219 size_t number_of_frames,
220 std::optional<int64_t> /* absolute_capture_timestamp_ms */) {
Minyue Li99d6d812020-01-29 09:25:12[diff] [blame]221 // TODO(bugs.webrtc.org/10739): Deprecate the old OnData and make this one
222 // pure virtual.
223 return OnData(audio_data, bits_per_sample, sample_rate, number_of_channels,
224 number_of_frames);
225 }
tommi6eca7e32015-12-15 12:27:11[diff] [blame]226
Gustaf Ullberg46ea5d72020-12-15 14:12:16[diff] [blame]227 // Returns the number of channels encoded by the sink. This can be less than
228 // the number_of_channels if down-mixing occur. A value of -1 means an unknown
229 // number.
230 virtual int NumPreferredChannels() const { return -1; }
231
tommi6eca7e32015-12-15 12:27:11[diff] [blame]232 protected:
233 virtual ~AudioTrackSinkInterface() {}
234};
235
[email protected]28e20752013-07-10 00:45:36[diff] [blame]236// AudioSourceInterface is a reference counted source used for AudioTracks.
deadbeefb10f32f2017-02-08 09:38:21[diff] [blame]237// The same source can be used by multiple AudioTracks.
Mirko Bonadei66e76792019-04-02 09:33:59[diff] [blame]238class RTC_EXPORT AudioSourceInterface : public MediaSourceInterface {
[email protected]b9a088b2014-02-13 23:18:49[diff] [blame]239 public:
240 class AudioObserver {
241 public:
242 virtual void OnSetVolume(double volume) = 0;
243
244 protected:
245 virtual ~AudioObserver() {}
246 };
247
deadbeefb10f32f2017-02-08 09:38:21[diff] [blame]248 // TODO(deadbeef): Makes all the interfaces pure virtual after they're
249 // implemented in chromium.
250
Artem Titov0e61fdd2021-07-25 19:50:14[diff] [blame]251 // Sets the volume of the source. `volume` is in the range of [0, 10].
Tommif888bb52015-12-12 00:37:01[diff] [blame]252 // TODO(tommi): This method should be on the track and ideally volume should
253 // be applied in the track in a way that does not affect clones of the track.
Dor Hen049b43b2024-10-15 07:51:54[diff] [blame]254 virtual void SetVolume(double /* volume */) {}
[email protected]b9a088b2014-02-13 23:18:49[diff] [blame]255
deadbeefb10f32f2017-02-08 09:38:21[diff] [blame]256 // Registers/unregisters observers to the audio source.
Dor Hen049b43b2024-10-15 07:51:54[diff] [blame]257 virtual void RegisterAudioObserver(AudioObserver* /* observer */) {}
258 virtual void UnregisterAudioObserver(AudioObserver* /* observer */) {}
[email protected]28e20752013-07-10 00:45:36[diff] [blame]259
tommi6eca7e32015-12-15 12:27:11[diff] [blame]260 // TODO(tommi): Make pure virtual.
Dor Hen049b43b2024-10-15 07:51:54[diff] [blame]261 virtual void AddSink(AudioTrackSinkInterface* /* sink */) {}
262 virtual void RemoveSink(AudioTrackSinkInterface* /* sink */) {}
Piotr (Peter) Slatala95ca6e12018-11-13 15:57:07[diff] [blame]263
264 // Returns options for the AudioSource.
265 // (for some of the settings this approach is broken, e.g. setting
266 // audio network adaptation on the source is the wrong layer of abstraction).
Evan Shrubsole945e5172025-04-08 14:11:45[diff] [blame]267 virtual const AudioOptions options() const;
[email protected]67ee6b92014-02-03 16:57:16[diff] [blame]268};
269
[email protected]40b3b682014-03-03 18:30:11[diff] [blame]270// Interface of the audio processor used by the audio track to collect
271// statistics.
Harald Alvestrand3d120662025-06-11 07:34:39[diff] [blame]272class AudioProcessorInterface : public RefCountInterface {
[email protected]40b3b682014-03-03 18:30:11[diff] [blame]273 public:
Ivo Creusenae0260962017-11-20 12:07:16[diff] [blame]274 struct AudioProcessorStatistics {
275 bool typing_noise_detected = false;
Ivo Creusen56d460902017-11-24 16:29:59[diff] [blame]276 AudioProcessingStats apm_statistics;
Ivo Creusenae0260962017-11-20 12:07:16[diff] [blame]277 };
[email protected]40b3b682014-03-03 18:30:11[diff] [blame]278
Artem Titov0e61fdd2021-07-25 19:50:14[diff] [blame]279 // Get audio processor statistics. The `has_remote_tracks` argument should be
Ivo Creusenae0260962017-11-20 12:07:16[diff] [blame]280 // set if there are active remote tracks (this would usually be true during
281 // a call). If there are no remote tracks some of the stats will not be set by
282 // the AudioProcessor, because they only make sense if there is at least one
283 // remote track.
Sam Zackrisson28127632018-11-01 10:37:15[diff] [blame]284 virtual AudioProcessorStatistics GetStats(bool has_remote_tracks) = 0;
Ivo Creusenae0260962017-11-20 12:07:16[diff] [blame]285
[email protected]40b3b682014-03-03 18:30:11[diff] [blame]286 protected:
Danil Chapovalov2a5ce2b2018-02-07 08:38:31[diff] [blame]287 ~AudioProcessorInterface() override = default;
[email protected]40b3b682014-03-03 18:30:11[diff] [blame]288};
289
Mirko Bonadei35214fc2019-09-23 12:54:28[diff] [blame]290class RTC_EXPORT AudioTrackInterface : public MediaStreamTrackInterface {
[email protected]28e20752013-07-10 00:45:36[diff] [blame]291 public:
deadbeefb10f32f2017-02-08 09:38:21[diff] [blame]292 // TODO(deadbeef): Figure out if the following interface should be const or
293 // not.
Yves Gerey665174f2018-06-19 13:03:05[diff] [blame]294 virtual AudioSourceInterface* GetSource() const = 0;
[email protected]28e20752013-07-10 00:45:36[diff] [blame]295
[email protected]40b3b682014-03-03 18:30:11[diff] [blame]296 // Add/Remove a sink that will receive the audio data from the track.
297 virtual void AddSink(AudioTrackSinkInterface* sink) = 0;
298 virtual void RemoveSink(AudioTrackSinkInterface* sink) = 0;
[email protected]67ee6b92014-02-03 16:57:16[diff] [blame]299
[email protected]40b3b682014-03-03 18:30:11[diff] [blame]300 // Get the signal level from the audio track.
301 // Return true on success, otherwise false.
deadbeefb10f32f2017-02-08 09:38:21[diff] [blame]302 // TODO(deadbeef): Change the interface to int GetSignalLevel() and pure
303 // virtual after it's implemented in chromium.
Danil Chapovalov2a5ce2b2018-02-07 08:38:31[diff] [blame]304 virtual bool GetSignalLevel(int* level);
[email protected]40b3b682014-03-03 18:30:11[diff] [blame]305
deadbeef8d60a942017-02-27 22:47:33[diff] [blame]306 // Get the audio processor used by the audio track. Return null if the track
[email protected]40b3b682014-03-03 18:30:11[diff] [blame]307 // does not have any processor.
deadbeefb10f32f2017-02-08 09:38:21[diff] [blame]308 // TODO(deadbeef): Make the interface pure virtual.
Evan Shrubsoleee5ab342025-04-15 14:49:46[diff] [blame]309 virtual scoped_refptr<AudioProcessorInterface> GetAudioProcessor();
[email protected]40b3b682014-03-03 18:30:11[diff] [blame]310
[email protected]28e20752013-07-10 00:45:36[diff] [blame]311 protected:
Danil Chapovalov2a5ce2b2018-02-07 08:38:31[diff] [blame]312 ~AudioTrackInterface() override = default;
[email protected]28e20752013-07-10 00:45:36[diff] [blame]313};
314
Evan Shrubsoleee5ab342025-04-15 14:49:46[diff] [blame]315typedef std::vector<scoped_refptr<AudioTrackInterface> > AudioTrackVector;
316typedef std::vector<scoped_refptr<VideoTrackInterface> > VideoTrackVector;
[email protected]28e20752013-07-10 00:45:36[diff] [blame]317
deadbeefb10f32f2017-02-08 09:38:21[diff] [blame]318// C++ version of https://www.w3.org/TR/mediacapture-streams/#mediastream.
319//
320// A major difference is that remote audio/video tracks (received by a
321// PeerConnection/RtpReceiver) are not synchronized simply by adding them to
322// the same stream; a session description with the correct "a=msid" attributes
323// must be pushed down.
324//
325// Thus, this interface acts as simply a container for tracks.
Harald Alvestrand3d120662025-06-11 07:34:39[diff] [blame]326class MediaStreamInterface : public RefCountInterface,
[email protected]28e20752013-07-10 00:45:36[diff] [blame]327 public NotifierInterface {
328 public:
Seth Hampson13b8bad2018-03-13 23:05:28[diff] [blame]329 virtual std::string id() const = 0;
[email protected]28e20752013-07-10 00:45:36[diff] [blame]330
331 virtual AudioTrackVector GetAudioTracks() = 0;
332 virtual VideoTrackVector GetVideoTracks() = 0;
Evan Shrubsoleee5ab342025-04-15 14:49:46[diff] [blame]333 virtual scoped_refptr<AudioTrackInterface> FindAudioTrack(
Yves Gerey665174f2018-06-19 13:03:05[diff] [blame]334 const std::string& track_id) = 0;
Evan Shrubsoleee5ab342025-04-15 14:49:46[diff] [blame]335 virtual scoped_refptr<VideoTrackInterface> FindVideoTrack(
Yves Gerey665174f2018-06-19 13:03:05[diff] [blame]336 const std::string& track_id) = 0;
[email protected]28e20752013-07-10 00:45:36[diff] [blame]337
Niels Möllere7cc8832022-01-04 14:20:03[diff] [blame]338 // Takes ownership of added tracks.
Harald Alvestrand2f7ad282022-04-21 11:35:43[diff] [blame]339 // Note: Default implementations are for avoiding link time errors in
340 // implementations that mock this API.
341 // TODO(bugs.webrtc.org/13980): Remove default implementations.
Evan Shrubsoleee5ab342025-04-15 14:49:46[diff] [blame]342 virtual bool AddTrack(scoped_refptr<AudioTrackInterface> /* track */) {
Harald Alvestrand2f7ad282022-04-21 11:35:43[diff] [blame]343 RTC_CHECK_NOTREACHED();
344 }
Evan Shrubsoleee5ab342025-04-15 14:49:46[diff] [blame]345 virtual bool AddTrack(scoped_refptr<VideoTrackInterface> /* track */) {
Harald Alvestrand2f7ad282022-04-21 11:35:43[diff] [blame]346 RTC_CHECK_NOTREACHED();
347 }
Evan Shrubsoleee5ab342025-04-15 14:49:46[diff] [blame]348 virtual bool RemoveTrack(scoped_refptr<AudioTrackInterface> /* track */) {
Harald Alvestrand2f7ad282022-04-21 11:35:43[diff] [blame]349 RTC_CHECK_NOTREACHED();
350 }
Evan Shrubsoleee5ab342025-04-15 14:49:46[diff] [blame]351 virtual bool RemoveTrack(scoped_refptr<VideoTrackInterface> /* track */) {
Harald Alvestrand2f7ad282022-04-21 11:35:43[diff] [blame]352 RTC_CHECK_NOTREACHED();
353 }
[email protected]28e20752013-07-10 00:45:36[diff] [blame]354
355 protected:
Danil Chapovalov2a5ce2b2018-02-07 08:38:31[diff] [blame]356 ~MediaStreamInterface() override = default;
[email protected]28e20752013-07-10 00:45:36[diff] [blame]357};
358
359} // namespace webrtc
360
Steve Anton10542f22019-01-11 17:11:00[diff] [blame]361#endif // API_MEDIA_STREAM_INTERFACE_H_