File: audio_renderer_sink_cache.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 (113 lines) | stat: -rw-r--r-- 4,035 bytes parent folder | download | duplicates (9)
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
// Copyright 2016 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_MEDIA_AUDIO_AUDIO_RENDERER_SINK_CACHE_H_
#define THIRD_PARTY_BLINK_RENDERER_MODULES_MEDIA_AUDIO_AUDIO_RENDERER_SINK_CACHE_H_

#include <memory>
#include <string>

#include "base/functional/callback.h"
#include "base/memory/scoped_refptr.h"
#include "base/synchronization/lock.h"
#include "base/task/sequenced_task_runner.h"
#include "base/thread_annotations.h"
#include "base/time/time.h"
#include "base/unguessable_token.h"
#include "media/audio/audio_sink_parameters.h"
#include "media/base/output_device_info.h"
#include "third_party/blink/public/common/tokens/tokens.h"
#include "third_party/blink/renderer/modules/modules_export.h"
#include "third_party/blink/renderer/platform/wtf/vector.h"

namespace media {
class AudioRendererSink;
}

namespace blink {

class LocalDOMWindow;

// Creates temporary audio sinks in order to acquire OutputDeviceInfo from them.
// These sinks live for a total time of |delete_timeout| to allow for multiple
// queries without reconstructing the temporary sink, and are then deleted.
// Must live on the main render thread. Thread safe.
class MODULES_EXPORT AudioRendererSinkCache {
 public:
  class WindowObserver;

  // Callback to be used for AudioRendererSink creation
  using CreateSinkCallback =
      base::RepeatingCallback<scoped_refptr<media::AudioRendererSink>(
          const LocalFrameToken& frame_token,
          const std::string& device_id)>;

  // If called, the cache will drop sinks belonging to the specified window on
  // navigation.
  static void InstallWindowObserver(LocalDOMWindow&);

  // |cleanup_task_runner| will be used to delete sinks.
  // AudioRendererSinkCache must outlive any tasks posted to it. Since
  // the sink cache is normally a process-wide singleton, this isn't a problem.
  AudioRendererSinkCache(
      scoped_refptr<base::SequencedTaskRunner> cleanup_task_runner,
      CreateSinkCallback create_sink_callback,
      base::TimeDelta delete_timeout);

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

  ~AudioRendererSinkCache();

  media::OutputDeviceInfo GetSinkInfo(const LocalFrameToken& source_frame_token,
                                      const std::string& device_id);

 private:
  friend class AudioRendererSinkCacheTest;
  friend class CacheEntryFinder;
  friend class AudioRendererSinkCache::WindowObserver;

  struct CacheEntry;
  using CacheContainer = Vector<CacheEntry>;

  // Schedules a sink for deletion. Deletion will be performed on the same
  // thread the cache is created on.
  void DeleteLater(scoped_refptr<media::AudioRendererSink> sink);

  // Deletes a sink from the cache.
  void DeleteSink(const media::AudioRendererSink* sink_ptr);

  CacheContainer::iterator FindCacheEntry_Locked(
      const LocalFrameToken& source_frame_token,
      const std::string& device_id);

  void MaybeCacheSink(const LocalFrameToken& source_frame_token,
                      const std::string& device_id,
                      scoped_refptr<media::AudioRendererSink> sink);

  void DropSinksForFrame(const LocalFrameToken& source_frame_token);

  // To avoid publishing CacheEntry structure in the header.
  wtf_size_t GetCacheSizeForTesting();

  // Global instance, set in constructor and unset in destructor.
  static AudioRendererSinkCache* instance_;

  // Renderer main task runner.
  const scoped_refptr<base::SequencedTaskRunner> cleanup_task_runner_;

  // Callback used for sink creation.
  const CreateSinkCallback create_sink_cb_;

  // Cached sink deletion timeout.
  const base::TimeDelta delete_timeout_;

  // Cached sinks, protected by lock.
  base::Lock cache_lock_;
  CacheContainer cache_ GUARDED_BY(cache_lock_);
};

}  // namespace blink

#endif  // THIRD_PARTY_BLINK_RENDERER_MODULES_MEDIA_AUDIO_AUDIO_RENDERER_SINK_CACHE_H_