File: audible_contents_tracker.h

package info (click to toggle)
chromium 138.0.7204.183-1~deb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-proposed-updates
  • size: 6,080,960 kB
  • sloc: cpp: 34,937,079; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,954; 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,811; 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 (80 lines) | stat: -rw-r--r-- 2,860 bytes parent folder | download | duplicates (4)
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
// 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 CHROME_BROWSER_METRICS_DESKTOP_SESSION_DURATION_AUDIBLE_CONTENTS_TRACKER_H_
#define CHROME_BROWSER_METRICS_DESKTOP_SESSION_DURATION_AUDIBLE_CONTENTS_TRACKER_H_

#include <set>

#include "base/functional/callback.h"
#include "base/memory/raw_ptr.h"
#include "chrome/browser/ui/browser_list_observer.h"
#include "chrome/browser/ui/tabs/tab_strip_model_observer.h"

namespace metrics {

// BrowserList / TabStripModelObserver used for tracking audio status.
// TODO(chrisha): Migrate this entire thing to use RecentlyAudibleHelper
// notifications rather then TabStripModel notifications.
// https://crbug.com/846374
class AudibleContentsTracker : public BrowserListObserver,
                               public TabStripModelObserver {
 public:
  // Interface for an observer of the AudibleContentsTracker. The only client
  // of this class is the DesktopSessionDurationTracker, but an observer
  // interface has been created for ease of testing.
  class Observer {
   public:
    Observer() = default;

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

    virtual ~Observer() = default;

    // Invoked when a first audio source starts playing after a period of no
    // audio sources.
    virtual void OnAudioStart() = 0;

    // Invoked when all audio sources stop playing.
    virtual void OnAudioEnd() = 0;
  };

  // Creates an audible contents tracker that dispatches its messages to the
  // provided |observer|.
  explicit AudibleContentsTracker(Observer* observer);

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

  ~AudibleContentsTracker() override;

 private:
  // BrowserListObserver:
  void OnBrowserAdded(Browser* browser) override;
  void OnBrowserRemoved(Browser* browser) override;

  // TabStripModelObserver:
  void OnTabStripModelChanged(
      TabStripModel* tab_strip_model,
      const TabStripModelChange& change,
      const TabStripSelectionChange& selection) override;
  void TabChangedAt(content::WebContents* web_contents,
                    int index,
                    TabChangeType change_type) override;

  // Used for managing audible_contents_, and invoking OnAudioStart and
  // OnAudioEnd callbacks.
  void AddAudibleWebContents(content::WebContents* web_contents);
  void RemoveAudibleWebContents(content::WebContents* web_contents);

  raw_ptr<Observer> observer_;

  // The set of WebContents that are currently playing audio.
  std::set<raw_ptr<content::WebContents, SetExperimental>> audible_contents_;
};

}  // namespace metrics

#endif  // CHROME_BROWSER_METRICS_DESKTOP_SESSION_DURATION_AUDIBLE_CONTENTS_TRACKER_H_