File: browser_capture_media_stream_track.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 (147 lines) | stat: -rw-r--r-- 6,671 bytes parent folder | download | duplicates (6)
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
// Copyright 2021 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_BROWSER_CAPTURE_MEDIA_STREAM_TRACK_H_
#define THIRD_PARTY_BLINK_RENDERER_MODULES_MEDIASTREAM_BROWSER_CAPTURE_MEDIA_STREAM_TRACK_H_

#include "third_party/blink/renderer/bindings/core/v8/script_promise_resolver_with_tracker.h"
#include "third_party/blink/renderer/modules/mediastream/crop_target.h"
#include "third_party/blink/renderer/modules/mediastream/media_stream_track_impl.h"
#include "third_party/blink/renderer/modules/mediastream/restriction_target.h"
#include "third_party/blink/renderer/modules/mediastream/sub_capture_target.h"
#include "third_party/blink/renderer/modules/modules_export.h"
#include "third_party/blink/renderer/platform/heap/collection_support/heap_hash_map.h"

namespace blink {

class MODULES_EXPORT BrowserCaptureMediaStreamTrack
    : public MediaStreamTrackImpl {
  DEFINE_WRAPPERTYPEINFO();

 public:
  BrowserCaptureMediaStreamTrack(ExecutionContext* execution_context,
                                 MediaStreamComponent* component,
                                 base::OnceClosure callback);

  BrowserCaptureMediaStreamTrack(ExecutionContext* execution_context,
                                 MediaStreamComponent* component,
                                 MediaStreamSource::ReadyState ready_state,
                                 base::OnceClosure callback);

  ~BrowserCaptureMediaStreamTrack() override = default;

#if !BUILDFLAG(IS_ANDROID)
  void Trace(Visitor*) const override;

  // Allows tests to invoke OnSubCaptureTargetVersionObserved() directly, since
  // triggering it via mocks would be prohibitively difficult.
  void OnSubCaptureTargetVersionObservedForTesting(
      uint32_t sub_capture_target_version) {
    OnSubCaptureTargetVersionObserved(sub_capture_target_version);
  }
#endif

  ScriptPromise<IDLUndefined> cropTo(ScriptState*,
                                     CropTarget*,
                                     ExceptionState&);
  ScriptPromise<IDLUndefined> restrictTo(ScriptState*,
                                         RestrictionTarget*,
                                         ExceptionState&);

  BrowserCaptureMediaStreamTrack* clone(ExecutionContext*) override;

  // These values are persisted to logs. Entries should not be renumbered and
  // numeric values should never be reused.
  enum class ApplySubCaptureTargetResult {
    kOk = 0,
    kTimedOut = 1,
    kInvalidFormat = 2,
    kRejectedWithErrorGeneric = 3,
    kRejectedWithUnsupportedCaptureDevice = 4,
    kRejectedWithNotImplemented = 5,
    kNonIncreasingVersion = 6,
    kInvalidTarget = 7,
    kUnsupportedPlatform = 8,
    kMaxValue = kUnsupportedPlatform
  };

 private:
  // Helper function serving cropTo(), restrictTo(), and any potential
  // future function that takes a BCMST and mutates what it is capturing
  // to some subset of the original target, based on a target identified
  // using a SubCaptureTarget.
  ScriptPromise<IDLUndefined> ApplySubCaptureTarget(ScriptState*,
                                                    SubCaptureTarget::Type,
                                                    SubCaptureTarget*,
                                                    ExceptionState&);

#if !BUILDFLAG(IS_ANDROID)
  struct PromiseInfo : GarbageCollected<PromiseInfo> {
    explicit PromiseInfo(
        ScriptPromiseResolverWithTracker<ApplySubCaptureTargetResult,
                                         IDLUndefined>* promise_resolver)
        : promise_resolver(promise_resolver) {}

    void Trace(Visitor* visitor) const { visitor->Trace(promise_resolver); }

    const Member<ScriptPromiseResolverWithTracker<ApplySubCaptureTargetResult,
                                                  IDLUndefined>>
        promise_resolver;
    std::optional<media::mojom::ApplySubCaptureTargetResult> result;
    bool sub_capture_target_version_observed = false;
  };

  using SubCaptureTargetVersionToPromiseInfoMap =
      HeapHashMap<uint32_t,
                  Member<BrowserCaptureMediaStreamTrack::PromiseInfo>>;
  using PromiseMapIterator = SubCaptureTargetVersionToPromiseInfoMap::iterator;

  // Each cropTo() or restrictTo() call is associated with a unique
  // |sub_capture_target_version| which identifies this specific invocation.
  // When the browser process responds with the result of the invocation,
  // it triggers a call to OnResultFromBrowserProcess() with that
  // |sub_capture_target_version|.
  void OnResultFromBrowserProcess(
      uint32_t sub_capture_target_version,
      media::mojom::ApplySubCaptureTargetResult result);

  // OnSubCaptureTargetVersionObserved() is posted as a callback, bound to a
  // unique |sub_capture_target_version|. This callback be invoked when the
  // first frame is observed which is associated with that
  // |sub_capture_target_version|.
  // TODO(crbug.com/1266378): The Promise should also be resolved if a
  // a barrier event is observed. (That is, although no frame is delivered,
  // there is a guarantee that all future frames will be of this version
  // or later. This would happen if cropping a muted track, for instance.)
  void OnSubCaptureTargetVersionObserved(uint32_t sub_capture_target_version);

  // The Promise that cropTo() issued is resolved when both conditions
  // are fulfulled:
  // 1. OnResultFromBrowserProcess(kSuccess) called.
  // 2. OnSubCaptureTargetVersionObserved() called for the associated
  // |sub_capture_target_version|.
  //
  // The order of fulfillment does not matter.
  //
  // The Promise is rejected if OnResultFromBrowserProcess() is called with
  // an error value.
  void MaybeFinalizeCropPromise(PromiseMapIterator iter);

  // Each time cropTo() is called on a given track, its sub-capture-target
  // version increments. Associate each Promise with its sub-capture-target
  // version, so that Viz can easily stamp each frame. When we see the first
  // such frame, or an equivalent message, we can resolve the Promise. (An
  // "equivalent message" can be a notification of a dropped frame, or a
  // notification that a frame was not produced due to consisting of 0 pixels
  // after the crop was applied, or anything similar.)
  //
  // Note that frames before the first call to cropTo() will be associated
  // with a version of 0, both here and in Viz.
  HeapHashMap<uint32_t, Member<PromiseInfo>> pending_promises_;
#endif  // !BUILDFLAG(IS_ANDROID)
};

}  // namespace blink

#endif  // THIRD_PARTY_BLINK_RENDERER_MODULES_MEDIASTREAM_BROWSER_CAPTURE_MEDIA_STREAM_TRACK_H_