File: user_media_client.h

package info (click to toggle)
chromium 138.0.7204.183-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 6,071,908 kB
  • sloc: cpp: 34,937,088; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,953; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,806; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (153 lines) | stat: -rw-r--r-- 5,836 bytes parent folder | download | duplicates (10)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
// Copyright 2012 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef THIRD_PARTY_BLINK_RENDERER_MODULES_MEDIASTREAM_USER_MEDIA_CLIENT_H_
#define THIRD_PARTY_BLINK_RENDERER_MODULES_MEDIASTREAM_USER_MEDIA_CLIENT_H_

#include <memory>

#include "base/memory/scoped_refptr.h"
#include "base/threading/thread_checker.h"
#include "build/build_config.h"
#include "mojo/public/cpp/bindings/pending_remote.h"
#include "third_party/blink/public/common/mediastream/media_devices.h"
#include "third_party/blink/public/mojom/mediastream/media_devices.mojom-blink-forward.h"
#include "third_party/blink/renderer/core/execution_context/execution_context_lifecycle_observer.h"
#include "third_party/blink/renderer/modules/mediastream/apply_constraints_request.h"
#include "third_party/blink/renderer/modules/mediastream/user_media_processor.h"
#include "third_party/blink/renderer/modules/mediastream/user_media_request.h"
#include "third_party/blink/renderer/modules/modules_export.h"
#include "third_party/blink/renderer/platform/heap/collection_support/heap_deque.h"
#include "third_party/blink/renderer/platform/mediastream/media_stream_component.h"
#include "third_party/blink/renderer/platform/mojo/heap_mojo_remote.h"
#include "third_party/blink/renderer/platform/mojo/heap_mojo_wrapper_mode.h"
#include "third_party/blink/renderer/platform/wtf/deque.h"

namespace base {
class SingleThreadTaskRunner;
}

namespace blink {

class LocalFrame;

// UserMediaClient handles requests coming from the Blink MediaDevices
// object. This includes getUserMedia and enumerateDevices. It must be created,
// called and destroyed on the render thread.
class MODULES_EXPORT UserMediaClient
    : public GarbageCollected<UserMediaClient>,
      public Supplement<LocalDOMWindow>,
      public ExecutionContextLifecycleObserver {
 public:
  static const char kSupplementName[];

  // TODO(guidou): Make all constructors private and replace with Create methods
  // that return a std::unique_ptr. This class is intended for instantiation on
  // the free store. https://crbug.com/764293
  // |frame| and its respective RenderFrame must outlive this instance.
  UserMediaClient(LocalFrame* frame,
                  scoped_refptr<base::SingleThreadTaskRunner> task_runner);

  UserMediaClient(const UserMediaClient&) = delete;
  UserMediaClient& operator=(const UserMediaClient&) = delete;

  void RequestUserMedia(UserMediaRequest* user_media_request);
  void CancelUserMediaRequest(UserMediaRequest* user_media_request);
  void ApplyConstraints(blink::ApplyConstraintsRequest* user_media_request);
  void StopTrack(MediaStreamComponent* track);

  // ExecutionContextLifecycleObserver implementation.
  void ContextDestroyed() override;

  bool IsCapturing();

  static UserMediaClient* From(LocalDOMWindow*);

#if !BUILDFLAG(IS_ANDROID) && !BUILDFLAG(IS_IOS)
  void FocusCapturedSurface(const String& label, bool focus);
#endif

  void Trace(Visitor*) const override;

  void SetMediaDevicesDispatcherForTesting(
      mojo::PendingRemote<blink::mojom::blink::MediaDevicesDispatcherHost>
          media_devices_dispatcher);

  // Ensure the MediaStreamDevice underlying a source is not closed even if
  // there are no remaining usages from this frame, as it's in the process of
  // being transferred.
  void KeepDeviceAliveForTransfer(
      base::UnguessableToken session_id,
      base::UnguessableToken transfer_id,
      UserMediaProcessor::KeepDeviceAliveForTransferCallback keep_alive_cb);

 protected:
  // Production code forwards the main ctor to this one.
  // Tests use this ctor directly.
  UserMediaClient(LocalFrame* frame,
                  UserMediaProcessor* user_media_processor,
                  UserMediaProcessor* display_user_media_processor,
                  scoped_refptr<base::SingleThreadTaskRunner> task_runner);

 private:
  class Request final : public GarbageCollected<Request> {
   public:
    explicit Request(UserMediaRequest* request);
    explicit Request(blink::ApplyConstraintsRequest* request);
    explicit Request(MediaStreamComponent* request);

    Request(const Request&) = delete;
    Request& operator=(const Request&) = delete;

    ~Request();

    UserMediaRequest* MoveUserMediaRequest();

    UserMediaRequest* user_media_request() const {
      return user_media_request_.Get();
    }
    blink::ApplyConstraintsRequest* apply_constraints_request() const {
      return apply_constraints_request_.Get();
    }
    MediaStreamComponent* track_to_stop() const { return track_to_stop_.Get(); }

    bool IsUserMedia() const { return !!user_media_request_; }
    bool IsApplyConstraints() const { return !!apply_constraints_request_; }
    bool IsStopTrack() const { return !!track_to_stop_; }

    void Trace(Visitor* visitor) const {
      visitor->Trace(user_media_request_);
      visitor->Trace(apply_constraints_request_);
      visitor->Trace(track_to_stop_);
    }

   private:
    Member<UserMediaRequest> user_media_request_;
    Member<blink::ApplyConstraintsRequest> apply_constraints_request_;
    Member<MediaStreamComponent> track_to_stop_;
  };

  class RequestQueue;

  void DeleteAllUserMediaRequests();

  blink::mojom::blink::MediaDevicesDispatcherHost* GetMediaDevicesDispatcher();
  RequestQueue* GetRequestQueue(
      mojom::blink::MediaStreamType user_media_request);

  // LocalFrame instance that own this UserMediaClient.
  WeakMember<LocalFrame> frame_;

  HeapMojoRemote<blink::mojom::blink::MediaDevicesDispatcherHost>
      media_devices_dispatcher_;

  Member<RequestQueue> pending_device_requests_;
  Member<RequestQueue> pending_display_requests_;

  THREAD_CHECKER(thread_checker_);
};

}  // namespace blink

#endif  // THIRD_PARTY_BLINK_RENDERER_MODULES_MEDIASTREAM_USER_MEDIA_CLIENT_H_