mediastreaminterface.h revision 5def7b9fdea0d027bca3df734d86fb877a83bdbf
1/* 2 * libjingle 3 * Copyright 2012 Google Inc. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions are met: 7 * 8 * 1. Redistributions of source code must retain the above copyright notice, 9 * this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright notice, 11 * this list of conditions and the following disclaimer in the documentation 12 * and/or other materials provided with the distribution. 13 * 3. The name of the author may not be used to endorse or promote products 14 * derived from this software without specific prior written permission. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED 17 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 18 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO 19 * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 20 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 21 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; 22 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 23 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR 24 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF 25 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 26 */ 27 28// This file contains interfaces for MediaStream, MediaTrack and MediaSource. 29// These interfaces are used for implementing MediaStream and MediaTrack as 30// defined in http://dev.w3.org/2011/webrtc/editor/webrtc.html#stream-api. These 31// interfaces must be used only with PeerConnection. PeerConnectionManager 32// interface provides the factory methods to create MediaStream and MediaTracks. 33 34#ifndef TALK_APP_WEBRTC_MEDIASTREAMINTERFACE_H_ 35#define TALK_APP_WEBRTC_MEDIASTREAMINTERFACE_H_ 36 37#include <string> 38#include <vector> 39 40#include "webrtc/base/basictypes.h" 41#include "webrtc/base/refcount.h" 42#include "webrtc/base/scoped_ref_ptr.h" 43 44namespace cricket { 45 46class AudioRenderer; 47class VideoCapturer; 48class VideoRenderer; 49class VideoFrame; 50 51} // namespace cricket 52 53namespace webrtc { 54 55// Generic observer interface. 56class ObserverInterface { 57 public: 58 virtual void OnChanged() = 0; 59 60 protected: 61 virtual ~ObserverInterface() {} 62}; 63 64class NotifierInterface { 65 public: 66 virtual void RegisterObserver(ObserverInterface* observer) = 0; 67 virtual void UnregisterObserver(ObserverInterface* observer) = 0; 68 69 virtual ~NotifierInterface() {} 70}; 71 72// Base class for sources. A MediaStreamTrack have an underlying source that 73// provide media. A source can be shared with multiple tracks. 74// TODO(perkj): Implement sources for local and remote audio tracks and 75// remote video tracks. 76class MediaSourceInterface : public rtc::RefCountInterface, 77 public NotifierInterface { 78 public: 79 enum SourceState { 80 kInitializing, 81 kLive, 82 kEnded, 83 kMuted 84 }; 85 86 virtual SourceState state() const = 0; 87 88 protected: 89 virtual ~MediaSourceInterface() {} 90}; 91 92// Information about a track. 93class MediaStreamTrackInterface : public rtc::RefCountInterface, 94 public NotifierInterface { 95 public: 96 enum TrackState { 97 kInitializing, // Track is beeing negotiated. 98 kLive = 1, // Track alive 99 kEnded = 2, // Track have ended 100 kFailed = 3, // Track negotiation failed. 101 }; 102 103 virtual std::string kind() const = 0; 104 virtual std::string id() const = 0; 105 virtual bool enabled() const = 0; 106 virtual TrackState state() const = 0; 107 virtual bool set_enabled(bool enable) = 0; 108 // These methods should be called by implementation only. 109 virtual bool set_state(TrackState new_state) = 0; 110 111 protected: 112 virtual ~MediaStreamTrackInterface() {} 113}; 114 115// Interface for rendering VideoFrames from a VideoTrack 116class VideoRendererInterface { 117 public: 118 // TODO(guoweis): Remove this function. Obsolete. The implementation of 119 // VideoRendererInterface should be able to handle different frame size as 120 // well as pending rotation. If it can't apply the frame rotation by itself, 121 // it should call |frame|.GetCopyWithRotationApplied() to get a frame that has 122 // the rotation applied. 123 virtual void SetSize(int width, int height) {} 124 125 // |frame| may have pending rotation. For clients which can't apply rotation, 126 // |frame|->GetCopyWithRotationApplied() will return a frame that has the 127 // rotation applied. 128 virtual void RenderFrame(const cricket::VideoFrame* frame) = 0; 129 130 protected: 131 // The destructor is protected to prevent deletion via the interface. 132 // This is so that we allow reference counted classes, where the destructor 133 // should never be public, to implement the interface. 134 virtual ~VideoRendererInterface() {} 135}; 136 137class VideoSourceInterface; 138 139class VideoTrackInterface : public MediaStreamTrackInterface { 140 public: 141 // Register a renderer that will render all frames received on this track. 142 virtual void AddRenderer(VideoRendererInterface* renderer) = 0; 143 // Deregister a renderer. 144 virtual void RemoveRenderer(VideoRendererInterface* renderer) = 0; 145 146 virtual VideoSourceInterface* GetSource() const = 0; 147 148 protected: 149 virtual ~VideoTrackInterface() {} 150}; 151 152// AudioSourceInterface is a reference counted source used for AudioTracks. 153// The same source can be used in multiple AudioTracks. 154class AudioSourceInterface : public MediaSourceInterface { 155 public: 156 class AudioObserver { 157 public: 158 virtual void OnSetVolume(double volume) = 0; 159 160 protected: 161 virtual ~AudioObserver() {} 162 }; 163 164 // TODO(xians): Makes all the interface pure virtual after Chrome has their 165 // implementations. 166 // Sets the volume to the source. |volume| is in the range of [0, 10]. 167 virtual void SetVolume(double volume) {} 168 169 // Registers/unregisters observer to the audio source. 170 virtual void RegisterAudioObserver(AudioObserver* observer) {} 171 virtual void UnregisterAudioObserver(AudioObserver* observer) {} 172}; 173 174// Interface for receiving audio data from a AudioTrack. 175class AudioTrackSinkInterface { 176 public: 177 virtual void OnData(const void* audio_data, 178 int bits_per_sample, 179 int sample_rate, 180 int number_of_channels, 181 size_t number_of_frames) = 0; 182 protected: 183 virtual ~AudioTrackSinkInterface() {} 184}; 185 186// Interface of the audio processor used by the audio track to collect 187// statistics. 188class AudioProcessorInterface : public rtc::RefCountInterface { 189 public: 190 struct AudioProcessorStats { 191 AudioProcessorStats() : typing_noise_detected(false), 192 echo_return_loss(0), 193 echo_return_loss_enhancement(0), 194 echo_delay_median_ms(0), 195 aec_quality_min(0.0), 196 echo_delay_std_ms(0) {} 197 ~AudioProcessorStats() {} 198 199 bool typing_noise_detected; 200 int echo_return_loss; 201 int echo_return_loss_enhancement; 202 int echo_delay_median_ms; 203 float aec_quality_min; 204 int echo_delay_std_ms; 205 }; 206 207 // Get audio processor statistics. 208 virtual void GetStats(AudioProcessorStats* stats) = 0; 209 210 protected: 211 virtual ~AudioProcessorInterface() {} 212}; 213 214class AudioTrackInterface : public MediaStreamTrackInterface { 215 public: 216 // TODO(xians): Figure out if the following interface should be const or not. 217 virtual AudioSourceInterface* GetSource() const = 0; 218 219 // Add/Remove a sink that will receive the audio data from the track. 220 virtual void AddSink(AudioTrackSinkInterface* sink) = 0; 221 virtual void RemoveSink(AudioTrackSinkInterface* sink) = 0; 222 223 // Get the signal level from the audio track. 224 // Return true on success, otherwise false. 225 // TODO(xians): Change the interface to int GetSignalLevel() and pure virtual 226 // after Chrome has the correct implementation of the interface. 227 virtual bool GetSignalLevel(int* level) { return false; } 228 229 // Get the audio processor used by the audio track. Return NULL if the track 230 // does not have any processor. 231 // TODO(xians): Make the interface pure virtual. 232 virtual rtc::scoped_refptr<AudioProcessorInterface> 233 GetAudioProcessor() { return NULL; } 234 235 // Get a pointer to the audio renderer of this AudioTrack. 236 // The pointer is valid for the lifetime of this AudioTrack. 237 // TODO(xians): Remove the following interface after Chrome switches to 238 // AddSink() and RemoveSink() interfaces. 239 virtual cricket::AudioRenderer* GetRenderer() { return NULL; } 240 241 protected: 242 virtual ~AudioTrackInterface() {} 243}; 244 245typedef std::vector<rtc::scoped_refptr<AudioTrackInterface> > 246 AudioTrackVector; 247typedef std::vector<rtc::scoped_refptr<VideoTrackInterface> > 248 VideoTrackVector; 249 250class MediaStreamInterface : public rtc::RefCountInterface, 251 public NotifierInterface { 252 public: 253 virtual std::string label() const = 0; 254 255 virtual AudioTrackVector GetAudioTracks() = 0; 256 virtual VideoTrackVector GetVideoTracks() = 0; 257 virtual rtc::scoped_refptr<AudioTrackInterface> 258 FindAudioTrack(const std::string& track_id) = 0; 259 virtual rtc::scoped_refptr<VideoTrackInterface> 260 FindVideoTrack(const std::string& track_id) = 0; 261 262 virtual bool AddTrack(AudioTrackInterface* track) = 0; 263 virtual bool AddTrack(VideoTrackInterface* track) = 0; 264 virtual bool RemoveTrack(AudioTrackInterface* track) = 0; 265 virtual bool RemoveTrack(VideoTrackInterface* track) = 0; 266 267 protected: 268 virtual ~MediaStreamInterface() {} 269}; 270 271} // namespace webrtc 272 273#endif // TALK_APP_WEBRTC_MEDIASTREAMINTERFACE_H_ 274