-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Co-authored-by: Gaëtan Muller <[email protected]>
- Loading branch information
Showing
3 changed files
with
230 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
205 changes: 205 additions & 0 deletions
205
...arbox-player/src/main/java/ch/srgssr/pillarbox/player/analytics/PlaybackSessionManager.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,205 @@ | ||
| /* | ||
| * Copyright (c) SRG SSR. All rights reserved. | ||
| * License information is available from the LICENSE file. | ||
| */ | ||
| package ch.srgssr.pillarbox.player.analytics | ||
|
|
||
| import androidx.media3.common.MediaItem | ||
| import androidx.media3.common.Player | ||
| import androidx.media3.common.Timeline | ||
| import androidx.media3.common.Timeline.Window | ||
| import androidx.media3.exoplayer.analytics.AnalyticsListener | ||
| import androidx.media3.exoplayer.analytics.AnalyticsListener.EventTime | ||
| import androidx.media3.exoplayer.source.LoadEventInfo | ||
| import androidx.media3.exoplayer.source.MediaLoadData | ||
| import ch.srgssr.pillarbox.player.utils.DebugLogger | ||
| import ch.srgssr.pillarbox.player.utils.StringUtil | ||
| import java.util.UUID | ||
|
|
||
| /** | ||
| * Playback session manager | ||
| * | ||
| * - Session is created when the player does something with a [MediaItem]. | ||
| * - Session is current if the media item associated with session is the current [MediaItem]. | ||
| * - Session is finished when it is no longer the current session or when the session is removed from the player. | ||
| */ | ||
| class PlaybackSessionManager : AnalyticsListener { | ||
| /** | ||
| * Listener | ||
| */ | ||
| interface Listener { | ||
| /** | ||
| * On session created | ||
| * | ||
| * @param session | ||
| */ | ||
| fun onSessionCreated(session: Session) | ||
|
|
||
| /** | ||
| * On session finished | ||
| * | ||
| * @param session | ||
| */ | ||
| fun onSessionFinished(session: Session) | ||
|
|
||
| /** | ||
| * On current session | ||
| * | ||
| * @param session | ||
| */ | ||
| fun onCurrentSession(session: Session) | ||
| } | ||
|
|
||
| /** | ||
| * Session | ||
| * | ||
| * @property mediaItem The [MediaItem] linked to the session. | ||
| */ | ||
| class Session(val mediaItem: MediaItem) { | ||
| /** | ||
| * Unique Session Id | ||
| */ | ||
| val sessionId = UUID.randomUUID().toString() | ||
|
|
||
| override fun equals(other: Any?): Boolean { | ||
| if (this === other) return true | ||
| if (javaClass != other?.javaClass) return false | ||
|
|
||
| other as Session | ||
|
|
||
| return sessionId == other.sessionId | ||
| } | ||
|
|
||
| override fun hashCode(): Int { | ||
| return sessionId.hashCode() | ||
| } | ||
| } | ||
|
|
||
| private val sessions = HashMap<String, Session>() | ||
| private val window = Window() | ||
|
|
||
| /** | ||
| * Listener | ||
| */ | ||
| var listener: Listener? = null | ||
|
|
||
| /** | ||
| * Current session | ||
| */ | ||
| var currentSession: Session? = null | ||
| private set(value) { | ||
| if (field != value) { | ||
| field?.let { | ||
| listener?.onSessionFinished(it) | ||
| sessions.remove(it.sessionId) | ||
| } | ||
| field = value | ||
| field?.let { | ||
| listener?.onCurrentSession(it) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Get or create a session from a [MediaItem]. | ||
| * | ||
| * @param mediaItem The [MediaItem]. | ||
| * @return A [Session] associated with `mediaItem`. | ||
| */ | ||
| fun getOrCreateSession(mediaItem: MediaItem): Session { | ||
| val session = sessions.values.firstOrNull { it.mediaItem.isTheSame(mediaItem) } | ||
| if (session == null) { | ||
| val newSession = Session(mediaItem) | ||
| sessions[newSession.sessionId] = newSession | ||
| listener?.onSessionCreated(newSession) | ||
| if (currentSession == null) { | ||
| currentSession = newSession | ||
| } | ||
| return newSession | ||
| } | ||
| return session | ||
| } | ||
|
|
||
| override fun onPositionDiscontinuity( | ||
| eventTime: EventTime, | ||
| oldPosition: Player.PositionInfo, | ||
| newPosition: Player.PositionInfo, | ||
| reason: Int | ||
| ) { | ||
| val oldItemIndex = oldPosition.mediaItemIndex | ||
| val newItemIndex = newPosition.mediaItemIndex | ||
| DebugLogger.debug(TAG, "onPositionDiscontinuity reason = ${StringUtil.discontinuityReasonString(reason)}") | ||
| if (oldItemIndex != newItemIndex && !eventTime.timeline.isEmpty) { | ||
| val newSession = getOrCreateSession(eventTime.timeline.getWindow(newItemIndex, window).mediaItem) | ||
| currentSession = newSession | ||
| } | ||
| } | ||
|
|
||
| override fun onMediaItemTransition(eventTime: EventTime, mediaItem: MediaItem?, reason: Int) { | ||
| DebugLogger.debug( | ||
| TAG, | ||
| "onMediaItemTransition reason = ${StringUtil.mediaItemTransitionReasonString(reason)} ${mediaItem?.mediaMetadata?.title}" | ||
| ) | ||
| currentSession = mediaItem?.let { getOrCreateSession(it) } | ||
| } | ||
|
|
||
| override fun onTimelineChanged(eventTime: EventTime, reason: Int) { | ||
| DebugLogger.debug(TAG, "onTimelineChanged ${StringUtil.timelineChangeReasonString(reason)} ${eventTime.getMediaItem().mediaMetadata.title}") | ||
| if (eventTime.timeline.isEmpty) { | ||
| finishAllSession() | ||
| return | ||
| } | ||
| val timeline = eventTime.timeline | ||
| val listNewItems = ArrayList<MediaItem>() | ||
| for (i in 0 until timeline.windowCount) { | ||
| val mediaItem = timeline.getWindow(i, window).mediaItem | ||
| listNewItems.add(mediaItem) | ||
| } | ||
| val sessions = HashSet(sessions.values) | ||
| for (session in sessions) { | ||
| val matchingItem = listNewItems.firstOrNull { it.isTheSame(session.mediaItem) } | ||
| if (matchingItem == null) { | ||
| if (session == currentSession) currentSession = null | ||
| else { | ||
| listener?.onSessionFinished(session) | ||
| this.sessions.remove(session.sessionId) | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| override fun onLoadStarted(eventTime: EventTime, loadEventInfo: LoadEventInfo, mediaLoadData: MediaLoadData) { | ||
| if (eventTime.timeline.isEmpty) return | ||
| val mediaItem = eventTime.getMediaItem() | ||
| if (mediaItem != MediaItem.EMPTY) { | ||
| getOrCreateSession(mediaItem) | ||
| } | ||
| } | ||
|
|
||
| override fun onPlayerReleased(eventTime: EventTime) { | ||
| DebugLogger.debug(TAG, "onPlayerReleased") | ||
| finishAllSession() | ||
| } | ||
|
|
||
| private fun finishAllSession() { | ||
| currentSession = null | ||
| for (session in sessions.values) { | ||
| listener?.onSessionFinished(session) | ||
| } | ||
| sessions.clear() | ||
| } | ||
|
|
||
| companion object { | ||
|
|
||
| private const val TAG = "SessionManager" | ||
|
|
||
| private fun EventTime.getMediaItem(): MediaItem { | ||
| if (timeline.isEmpty) return MediaItem.EMPTY | ||
| return timeline.getWindow(windowIndex, Timeline.Window()).mediaItem | ||
| } | ||
|
|
||
| private fun MediaItem.isTheSame(mediaItem: MediaItem): Boolean { | ||
| return mediaId == mediaItem.mediaId && localConfiguration?.uri == mediaItem.localConfiguration?.uri | ||
| } | ||
| } | ||
| } |