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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
|
// Copyright 2017 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "chrome/browser/media/media_engagement_session.h"
#include "chrome/browser/media/media_engagement_score.h"
#include "chrome/browser/media/media_engagement_service.h"
#include "media/base/media_switches.h"
#include "services/metrics/public/cpp/ukm_builders.h"
#include "services/metrics/public/cpp/ukm_entry_builder.h"
#include "services/metrics/public/cpp/ukm_recorder.h"
MediaEngagementSession::MediaEngagementSession(MediaEngagementService* service,
const url::Origin& origin,
RestoreType restore_status,
ukm::SourceId ukm_source_id)
: service_(service),
origin_(origin),
ukm_source_id_(ukm_source_id),
restore_status_(restore_status) {
if (restore_status_ == RestoreType::kRestored)
pending_data_to_commit_.visit = false;
}
bool MediaEngagementSession::IsSameOriginWith(const GURL& url) const {
return origin_.IsSameOriginWith(url);
}
void MediaEngagementSession::RecordSignificantMediaElementPlayback() {
DCHECK(!significant_media_element_playback_recorded_);
significant_media_element_playback_recorded_ = true;
pending_data_to_commit_.media_element_playback = true;
RecordSignificantPlayback();
}
void MediaEngagementSession::RecordSignificantAudioContextPlayback() {
DCHECK(!significant_audio_context_playback_recorded_);
significant_audio_context_playback_recorded_ = true;
pending_data_to_commit_.audio_context_playback = true;
RecordSignificantPlayback();
}
void MediaEngagementSession::RecordShortPlaybackIgnored(int length_msec) {
ukm::UkmRecorder* ukm_recorder = ukm::UkmRecorder::Get();
if (!ukm_recorder)
return;
ukm::builders::Media_Engagement_ShortPlaybackIgnored(ukm_source_id_)
.SetLength(length_msec)
.Record(ukm_recorder);
}
void MediaEngagementSession::RegisterAudiblePlayers(
int32_t audible_players,
int32_t significant_players) {
DCHECK_GE(audible_players, significant_players);
if (!audible_players && !significant_players)
return;
pending_data_to_commit_.players = true;
audible_players_delta_ += audible_players;
significant_players_delta_ += significant_players;
}
bool MediaEngagementSession::WasSignificantPlaybackRecorded() const {
return significant_media_element_playback_recorded_ ||
significant_audio_context_playback_recorded_;
}
bool MediaEngagementSession::significant_media_element_playback_recorded()
const {
return significant_media_element_playback_recorded_;
}
bool MediaEngagementSession::significant_audio_context_playback_recorded()
const {
return significant_audio_context_playback_recorded_;
}
const url::Origin& MediaEngagementSession::origin() const {
return origin_;
}
MediaEngagementSession::~MediaEngagementSession() {
// The destructor is called when all the tabs associated te the MEI session
// are closed. Metrics and data related to "visits" need to be recorded now.
if (HasPendingDataToCommit())
CommitPendingData();
RecordUkmMetrics();
}
void MediaEngagementSession::RecordSignificantPlayback() {
DCHECK(WasSignificantPlaybackRecorded());
// If this was the first time we recorded significant playback then we should
// record the playback time.
if (first_significant_playback_time_.is_null())
first_significant_playback_time_ = service_->clock()->Now();
// When a session was restored, visits are only recorded when there was a
// playback. Add back the visit now as this code can only be executed once
// per session.
if (restore_status_ == RestoreType::kRestored)
pending_data_to_commit_.visit = true;
}
void MediaEngagementSession::RecordUkmMetrics() {
ukm::UkmRecorder* ukm_recorder = ukm::UkmRecorder::Get();
if (!ukm_recorder)
return;
MediaEngagementScore score = service_->CreateEngagementScore(origin_);
ukm::builders::Media_Engagement_SessionFinished(ukm_source_id_)
.SetPlaybacks_Total(score.media_playbacks())
.SetVisits_Total(score.visits())
.SetEngagement_Score(round(score.actual_score() * 100))
.SetEngagement_IsHigh(score.high_score())
.SetPlayer_Audible_Delta(audible_players_total_)
.SetPlayer_Significant_Delta(significant_players_total_)
.Record(ukm_recorder);
}
bool MediaEngagementSession::HasPendingPlaybackToCommit() const {
return pending_data_to_commit_.audio_context_playback ||
pending_data_to_commit_.media_element_playback;
}
bool MediaEngagementSession::HasPendingDataToCommit() const {
return pending_data_to_commit_.visit || pending_data_to_commit_.players ||
HasPendingPlaybackToCommit();
}
void MediaEngagementSession::CommitPendingData() {
DCHECK(HasPendingDataToCommit());
MediaEngagementScore score = service_->CreateEngagementScore(origin_);
bool previous_high_value = score.high_score();
if (pending_data_to_commit_.visit)
score.IncrementVisits();
if (WasSignificantPlaybackRecorded() && HasPendingPlaybackToCommit()) {
score.IncrementMediaPlaybacks();
// Use the stored significant playback time.
score.set_last_media_playback_time(first_significant_playback_time_);
}
if (pending_data_to_commit_.players) {
audible_players_total_ += audible_players_delta_;
significant_players_total_ += significant_players_delta_;
audible_players_delta_ = 0;
significant_players_delta_ = 0;
}
score.Commit();
// If the high state has changed store that in a bool.
high_score_changed_ = previous_high_value != score.high_score();
pending_data_to_commit_.visit = pending_data_to_commit_.players =
pending_data_to_commit_.audio_context_playback =
pending_data_to_commit_.media_element_playback = false;
}
|
