[MediaStream] Make MediaStreamVideoSource::GetWeakPtr() pure virtual

This makes this method pure virtual and implements it in all derived
classes.
Prior to this CL, MediaStreamVideoSource had a weak pointer factory,
which was incorrect as derived classes define more data fields which
could  become invalid before the factory invalidated outstanding
weak pointers.

Bug: 1158227
Change-Id: I31e6e0f624e9ba81b74e234b72c58f9dc5dbd585
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/2588928
Auto-Submit: Guido Urdaneta <guidou@chromium.org>
Commit-Queue: Bill Budge <bbudge@chromium.org>
Reviewed-by: Bill Budge <bbudge@chromium.org>
Reviewed-by: Elad Alon <eladalon@chromium.org>
Cr-Commit-Position: refs/heads/master@{#837108}

content/renderer/pepper/pepper_media_stream_video_track_host.cc

@@ -444,6 +444,10 @@ class PepperMediaStreamVideoTrackHost::VideoSource final
       host_->frame_deliverer_ = nullptr;
   }
 
+  base::WeakPtr<MediaStreamVideoSource> GetWeakPtr() const final {
+    return weak_factory_.GetWeakPtr();
+  }
+
  private:
   base::Optional<media::VideoCaptureFormat> GetCurrentFormat() const override {
     if (host_) {
@@ -456,6 +460,7 @@ class PepperMediaStreamVideoTrackHost::VideoSource final
   }
 
   const base::WeakPtr<PepperMediaStreamVideoTrackHost> host_;
+  base::WeakPtrFactory<MediaStreamVideoSource> weak_factory_{this};
 
   DISALLOW_COPY_AND_ASSIGN(VideoSource);
 };

third_party/blink/public/web/modules/mediastream/media_stream_video_source.h

@@ -182,9 +182,7 @@ class BLINK_MODULES_EXPORT MediaStreamVideoSource
     return tracks_.size();
   }
 
-  base::WeakPtr<MediaStreamVideoSource> GetWeakPtr() {
-    return weak_factory_.GetWeakPtr();
-  }
+  virtual base::WeakPtr<MediaStreamVideoSource> GetWeakPtr() const = 0;
 
  protected:
   // MediaStreamSource implementation.
@@ -365,9 +363,6 @@ class BLINK_MODULES_EXPORT MediaStreamVideoSource
   // callback to notify the caller that the request is canceled.
   base::OnceClosure remove_last_track_callback_;
 
-  // NOTE: Weak pointers must be invalidated before all other member variables.
-  base::WeakPtrFactory<MediaStreamVideoSource> weak_factory_{this};
-
   DISALLOW_COPY_AND_ASSIGN(MediaStreamVideoSource);
 };
 

third_party/blink/renderer/modules/mediastream/media_stream_video_capturer_source.cc

@@ -165,6 +165,11 @@ void MediaStreamVideoCapturerSource::ChangeSourceImpl(
                          WTF::Unretained(this), capture_params_));
 }
 
+base::WeakPtr<MediaStreamVideoSource>
+MediaStreamVideoCapturerSource::GetWeakPtr() const {
+  return weak_factory_.GetWeakPtr();
+}
+
 void MediaStreamVideoCapturerSource::OnRunStateChanged(
     const media::VideoCaptureParams& new_capture_params,
     bool is_running) {

third_party/blink/renderer/modules/mediastream/media_stream_video_capturer_source.h

@@ -81,6 +81,7 @@ class MODULES_EXPORT MediaStreamVideoCapturerSource
   base::Optional<media::VideoCaptureParams> GetCurrentCaptureParams()
       const override;
   void ChangeSourceImpl(const MediaStreamDevice& new_device) override;
+  base::WeakPtr<MediaStreamVideoSource> GetWeakPtr() const override;
 
   // Method to bind as RunningCallback in VideoCapturerSource::StartCapture().
   void OnRunStateChanged(const media::VideoCaptureParams& new_capture_params,
@@ -108,6 +109,8 @@ class MODULES_EXPORT MediaStreamVideoCapturerSource
   VideoCaptureDeliverFrameCB frame_callback_;
   DeviceCapturerFactoryCallback device_capturer_factory_callback_;
 
+  base::WeakPtrFactory<MediaStreamVideoSource> weak_factory_{this};
+
   DISALLOW_COPY_AND_ASSIGN(MediaStreamVideoCapturerSource);
 };
 

third_party/blink/renderer/modules/mediastream/media_stream_video_source.cc

@@ -142,8 +142,8 @@ void MediaStreamVideoSource::RemoveTrack(MediaStreamVideoTrack* video_track,
       // sources created after that StopSource() call, but before the actual
       // stop takes place. See https://crbug.com/778039.
       remove_last_track_callback_ = std::move(callback);
-      StopForRestart(WTF::Bind(&MediaStreamVideoSource::DidStopSource,
-                               weak_factory_.GetWeakPtr()));
+      StopForRestart(
+          WTF::Bind(&MediaStreamVideoSource::DidStopSource, GetWeakPtr()));
       if (state_ == STOPPING_FOR_RESTART || state_ == STOPPED_FOR_RESTART) {
         // If the source supports restarting, it is necessary to call
         // FinalizeStopSource() to ensure the same behavior as StopSource(),
@@ -457,8 +457,8 @@ void MediaStreamVideoSource::StartFrameMonitoring() {
     GetTrackAdapter()->SetSourceFrameSize(current_format->frame_size);
   }
   GetTrackAdapter()->StartFrameMonitoring(
-      frame_rate, WTF::BindRepeating(&MediaStreamVideoSource::SetMutedState,
-                                     weak_factory_.GetWeakPtr()));
+      frame_rate,
+      WTF::BindRepeating(&MediaStreamVideoSource::SetMutedState, GetWeakPtr()));
 }
 
 void MediaStreamVideoSource::SetReadyState(

third_party/blink/renderer/modules/mediastream/mock_media_stream_video_source.cc

@@ -66,6 +66,11 @@ void MockMediaStreamVideoSource::OnHasConsumers(bool has_consumers) {
   is_suspended_ = !has_consumers;
 }
 
+base::WeakPtr<MediaStreamVideoSource> MockMediaStreamVideoSource::GetWeakPtr()
+    const {
+  return weak_factory_.GetWeakPtr();
+}
+
 void MockMediaStreamVideoSource::DoChangeSource(
     const MediaStreamDevice& new_device) {
   ChangeSourceImpl(new_device);

third_party/blink/renderer/modules/mediastream/mock_media_stream_video_source.h

@@ -71,6 +71,7 @@ class MockMediaStreamVideoSource : public blink::MediaStreamVideoSource {
   base::Optional<media::VideoCaptureParams> GetCurrentCaptureParams()
       const override;
   void OnHasConsumers(bool has_consumers) override;
+  base::WeakPtr<MediaStreamVideoSource> GetWeakPtr() const override;
 
  protected:
   // Implements MediaStreamSource.
@@ -98,6 +99,8 @@ class MockMediaStreamVideoSource : public blink::MediaStreamVideoSource {
   blink::VideoCaptureDeliverFrameCB frame_callback_;
   EncodedVideoFrameCB encoded_frame_callback_;
 
+  base::WeakPtrFactory<MediaStreamVideoSource> weak_factory_{this};
+
   DISALLOW_COPY_AND_ASSIGN(MockMediaStreamVideoSource);
 };
 

third_party/blink/renderer/modules/mediastream/pushable_media_stream_video_source.cc

@@ -48,4 +48,9 @@ void PushableMediaStreamVideoSource::StopSourceImpl() {
   running_ = false;
 }
 
+base::WeakPtr<MediaStreamVideoSource>
+PushableMediaStreamVideoSource::GetWeakPtr() const {
+  return weak_factory_.GetWeakPtr();
+}
+
 }  // namespace blink

third_party/blink/renderer/modules/mediastream/pushable_media_stream_video_source.h

@@ -32,11 +32,14 @@ class MODULES_EXPORT PushableMediaStreamVideoSource
   void StartSourceImpl(VideoCaptureDeliverFrameCB frame_callback,
                        EncodedVideoFrameCB encoded_frame_callback) override;
   void StopSourceImpl() override;
+  base::WeakPtr<MediaStreamVideoSource> GetWeakPtr() const override;
 
  private:
   bool running_ = false;
   VideoCaptureDeliverFrameCB deliver_frame_cb_;
+
   THREAD_CHECKER(thread_checker_);
+  base::WeakPtrFactory<MediaStreamVideoSource> weak_factory_{this};
 };
 
 }  // namespace blink

third_party/blink/renderer/modules/peerconnection/media_stream_remote_video_source.cc

@@ -500,6 +500,11 @@ void MediaStreamRemoteVideoSource::RequestRefreshFrame() {
   }
 }
 
+base::WeakPtr<MediaStreamVideoSource> MediaStreamRemoteVideoSource::GetWeakPtr()
+    const {
+  return weak_factory_.GetWeakPtr();
+}
+
 void MediaStreamRemoteVideoSource::OnEncodedSinkEnabled() {
   DCHECK_CALLED_ON_VALID_THREAD(thread_checker_);
   if (!observer_ || !observer_->track()) {

third_party/blink/renderer/modules/peerconnection/media_stream_remote_video_source.h

@@ -36,6 +36,7 @@ class MODULES_EXPORT MediaStreamRemoteVideoSource
   // MediaStreamVideoSource overrides.
   bool SupportsEncodedOutput() const override;
   void RequestRefreshFrame() override;
+  base::WeakPtr<MediaStreamVideoSource> GetWeakPtr() const override;
 
  protected:
   // Implements MediaStreamVideoSource.
@@ -60,6 +61,8 @@ class MODULES_EXPORT MediaStreamRemoteVideoSource
   scoped_refptr<RemoteVideoSourceDelegate> delegate_;
   std::unique_ptr<TrackObserver> observer_;
 
+  base::WeakPtrFactory<MediaStreamVideoSource> weak_factory_{this};
+
   DISALLOW_COPY_AND_ASSIGN(MediaStreamRemoteVideoSource);
 };