Add a ReplayHistorySession

Author: kmadsen

changelog/unreleased/features/6855.md

@@ -0,0 +1 @@
+- Introduced `ReplayHistorySession` and `ReplayHistorySessionOptions` to simplify the implementation for replaying history files. History can also be enabled with `MapboxTripStarter.enableReplayHistory()`. This can replay large history files in a memory efficient way.

examples/src/main/java/com/mapbox/navigation/examples/MainActivity.kt

@@ -11,6 +11,8 @@ import androidx.core.app.ActivityCompat
 import androidx.core.content.ContextCompat
 import androidx.recyclerview.widget.LinearLayoutManager
 import com.mapbox.android.core.permissions.PermissionsListener
+import com.mapbox.common.LogConfiguration
+import com.mapbox.common.LoggingLevel
 import com.mapbox.navigation.examples.core.IndependentRouteGenerationActivity
 import com.mapbox.navigation.examples.core.MapboxBuildingHighlightActivity
 import com.mapbox.navigation.examples.core.MapboxCustomStyleActivity
@@ -39,6 +41,7 @@ class MainActivity : AppCompatActivity(), PermissionsListener {
 
     override fun onCreate(savedInstanceState: Bundle?) {
         super.onCreate(savedInstanceState)
+        LogConfiguration.setLoggingLevel(LoggingLevel.DEBUG)
         binding = LayoutActivityMainBinding.inflate(layoutInflater)
         setContentView(binding.root)
 

examples/src/main/java/com/mapbox/navigation/examples/core/ReplayHistoryActivity.kt

@@ -6,7 +6,6 @@ import android.content.res.Configuration
 import android.content.res.Resources
 import android.location.Location
 import android.os.Bundle
-import android.view.View
 import android.widget.Button
 import android.widget.SeekBar
 import androidx.appcompat.app.AppCompatActivity
@@ -23,11 +22,8 @@ import com.mapbox.maps.plugin.locationcomponent.location
 import com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI
 import com.mapbox.navigation.base.options.NavigationOptions
 import com.mapbox.navigation.core.MapboxNavigation
-import com.mapbox.navigation.core.MapboxNavigationProvider
 import com.mapbox.navigation.core.directions.session.RoutesObserver
-import com.mapbox.navigation.core.replay.MapboxReplayer
-import com.mapbox.navigation.core.replay.history.ReplayEventBase
-import com.mapbox.navigation.core.replay.history.ReplaySetNavigationRoute
+import com.mapbox.navigation.core.replay.history.ReplayHistorySession
 import com.mapbox.navigation.core.trip.session.LocationMatcherResult
 import com.mapbox.navigation.core.trip.session.LocationObserver
 import com.mapbox.navigation.core.trip.session.RouteProgressObserver
@@ -50,21 +46,21 @@ import com.mapbox.navigation.ui.maps.route.line.model.MapboxRouteLineOptions
 import com.mapbox.navigation.ui.maps.route.line.model.RouteLine
 import com.mapbox.navigation.ui.maps.route.line.model.RouteLineColorResources
 import com.mapbox.navigation.ui.maps.route.line.model.RouteLineResources
+import com.mapbox.navigation.utils.internal.logI
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.Job
 import kotlinx.coroutines.launch
-import java.util.Collections
 
 private const val DEFAULT_INITIAL_ZOOM = 15.0
 
+@OptIn(ExperimentalPreviewMapboxNavigationAPI::class)
 class ReplayHistoryActivity : AppCompatActivity() {
 
     private var loadNavigationJob: Job? = null
     private val navigationLocationProvider = NavigationLocationProvider()
     private lateinit var historyFileLoader: HistoryFileLoader
     private lateinit var mapboxNavigation: MapboxNavigation
-    private lateinit var mapboxReplayer: MapboxReplayer
     private lateinit var locationComponent: LocationComponentPlugin
     private lateinit var navigationCamera: NavigationCamera
     private lateinit var viewportDataSource: MapboxNavigationViewportDataSource
@@ -103,6 +99,7 @@ class ReplayHistoryActivity : AppCompatActivity() {
             40.0 * pixelDensity
         )
     }
+    private val replayHistorySession = ReplayHistorySession()
 
     private val initialCameraOptions: CameraOptions? = CameraOptions.Builder()
         .zoom(DEFAULT_INITIAL_ZOOM)
@@ -163,7 +160,7 @@ class ReplayHistoryActivity : AppCompatActivity() {
         super.onDestroy()
         routeLineApi.cancel()
         routeLineView.cancel()
-        mapboxReplayer.finish()
+        replayHistorySession.onDetached(mapboxNavigation)
         mapboxNavigation.onDestroy()
         if (::locationComponent.isInitialized) {
             locationComponent.removeOnIndicatorPositionChangedListener(onPositionChangedListener)
@@ -212,15 +209,16 @@ class ReplayHistoryActivity : AppCompatActivity() {
             viewportDataSource.onLocationChanged(locationMatcherResult.enhancedLocation)
             viewportDataSource.evaluate()
             if (!isLocationInitialized) {
+                logI("ReplayHistoryActivity") {
+                    "onNewLocationMatcherResult initialize location"
+                }
                 isLocationInitialized = true
-                val instantTransition = NavigationCameraTransitionOptions.Builder()
-                    .maxDuration(0)
-                    .build()
-                navigationCamera.requestNavigationCameraToOverview(
-                    stateTransitionOptions = instantTransition,
+                navigationCamera.requestNavigationCameraToFollowing(
+                    stateTransitionOptions = NavigationCameraTransitionOptions.Builder()
+                        .maxDuration(0)
+                        .build(),
                 )
             }
-
             navigationLocationProvider.changePosition(
                 locationMatcherResult.enhancedLocation,
                 locationMatcherResult.keyPoints,
@@ -308,21 +306,12 @@ class ReplayHistoryActivity : AppCompatActivity() {
     @SuppressLint("MissingPermission")
     private fun initNavigation() {
         historyFileLoader = HistoryFileLoader()
-        mapboxNavigation = MapboxNavigationProvider.create(
+        mapboxNavigation = MapboxNavigation(
             NavigationOptions.Builder(this)
                 .accessToken(Utils.getMapboxAccessToken(this))
                 .build()
         )
-        startReplayTripSession()
-    }
-
-    /**
-     * This is showcasing a new way to replay rides at runtime.
-     */
-    @OptIn(ExperimentalPreviewMapboxNavigationAPI::class)
-    private fun startReplayTripSession() {
-        mapboxReplayer = mapboxNavigation.mapboxReplayer
-        mapboxNavigation.startReplayTripSession()
+        replayHistorySession.onAttached(mapboxNavigation)
     }
 
     override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) {
@@ -336,24 +325,9 @@ class ReplayHistoryActivity : AppCompatActivity() {
     @SuppressLint("MissingPermission")
     private fun handleHistoryFileSelected() {
         loadNavigationJob = CoroutineScope(Dispatchers.Main).launch {
-            val events = historyFileLoader
-                .loadReplayHistory(this@ReplayHistoryActivity)
-            mapboxReplayer.clearEvents()
-            mapboxReplayer.pushEvents(events)
-            binding.playReplay.visibility = View.VISIBLE
-            mapboxNavigation.resetTripSession()
-            mapboxNavigation.setRoutes(emptyList())
+            val historyReader = historyFileLoader.loadReplayHistory(this@ReplayHistoryActivity)
+            replayHistorySession.setHistoryFile(historyReader.filePath)
             isLocationInitialized = false
-            mapboxReplayer.playFirstLocation()
-        }
-    }
-
-    @SuppressLint("SetTextI18n")
-    private fun updateReplayStatus(playbackEvents: List<ReplayEventBase>) {
-        playbackEvents.lastOrNull()?.eventTimestamp?.let {
-            val currentSecond = mapboxReplayer.eventSeconds(it).toInt()
-            val durationSecond = mapboxReplayer.durationSeconds().toInt()
-            binding.playerStatus.text = "$currentSecond:$durationSecond"
         }
     }
 
@@ -368,7 +342,7 @@ class ReplayHistoryActivity : AppCompatActivity() {
         binding.seekBar.setOnSeekBarChangeListener(
             object : SeekBar.OnSeekBarChangeListener {
                 override fun onProgressChanged(seekBar: SeekBar, progress: Int, fromUser: Boolean) {
-                    mapboxReplayer.playbackSpeed(progress.toDouble())
+                    mapboxNavigation.mapboxReplayer.playbackSpeed(progress.toDouble())
                     binding.seekBarText.text = getString(
                         R.string.replay_playback_speed_seekbar,
                         progress
@@ -379,26 +353,5 @@ class ReplayHistoryActivity : AppCompatActivity() {
                 override fun onStopTrackingTouch(seekBar: SeekBar) {}
             }
         )
-
-        binding.playReplay.setOnClickListener {
-            mapboxReplayer.play()
-            binding.playReplay.visibility = View.GONE
-            navigationCamera.requestNavigationCameraToFollowing()
-        }
-
-        mapboxReplayer.registerObserver { events ->
-            updateReplayStatus(events)
-            events.forEach {
-                when (it) {
-                    is ReplaySetNavigationRoute -> setRoute(it)
-                }
-            }
-        }
-    }
-
-    private fun setRoute(replaySetRoute: ReplaySetNavigationRoute) {
-        replaySetRoute.route?.let { directionRoute ->
-            mapboxNavigation.setNavigationRoutes(Collections.singletonList(directionRoute))
-        }
     }
 }

examples/src/main/java/com/mapbox/navigation/examples/core/replay/HistoryFileLoader.kt

@@ -3,46 +3,28 @@ package com.mapbox.navigation.examples.core.replay
 import android.annotation.SuppressLint
 import android.content.Context
 import com.mapbox.navigation.core.history.MapboxHistoryReader
-import com.mapbox.navigation.core.replay.history.ReplayEventBase
-import com.mapbox.navigation.core.replay.history.ReplayHistoryMapper
-import com.mapbox.navigation.core.replay.history.ReplaySetNavigationRoute
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.withContext
 
 class HistoryFileLoader {
-    private val replayHistoryMapper = ReplayHistoryMapper.Builder().setRouteMapper {
-        ReplaySetNavigationRoute.Builder(eventTimestamp = it.eventTimestamp)
-            .route(it.navigationRoute)
-            .build()
-    }.build()
     private val historyFilesDirectory = HistoryFilesDirectory()
 
     @SuppressLint("MissingPermission")
     suspend fun loadReplayHistory(
         context: Context
-    ): List<ReplayEventBase> = withContext(Dispatchers.IO) {
-        loadSelectedHistory() ?: loadDefaultReplayHistory(context)
+    ): MapboxHistoryReader = withContext(Dispatchers.IO) {
+        HistoryFilesActivity.selectedHistory ?: loadDefaultReplayHistory(context)
     }
 
-    private suspend fun loadSelectedHistory(): List<ReplayEventBase>? =
-        withContext(Dispatchers.IO) {
-            HistoryFilesActivity.selectedHistory?.asSequence()?.mapNotNull { historyEvent ->
-                replayHistoryMapper.mapToReplayEvent(historyEvent)
-            }?.toList()
-        }
-
     private suspend fun loadDefaultReplayHistory(
         context: Context
-    ): List<ReplayEventBase> = withContext(Dispatchers.IO) {
+    ): MapboxHistoryReader = withContext(Dispatchers.IO) {
         val fileName = "replay-history-activity.json"
         val inputStream = context.assets.open(fileName)
         val outputFile = historyFilesDirectory.outputFile(context, fileName)
         outputFile.outputStream().use { fileOut ->
             inputStream.copyTo(fileOut)
         }
         MapboxHistoryReader(outputFile.absolutePath)
-            .asSequence()
-            .mapNotNull { replayHistoryMapper.mapToReplayEvent(it) }
-            .toList()
     }
 }

examples/src/main/res/layout/activity_replay_history_layout.xml

@@ -34,23 +34,11 @@
         android:text="@string/select_history"
         />
 
-    <androidx.appcompat.widget.AppCompatButton
-        android:id="@+id/playReplay"
-        android:layout_width="0dp"
-        android:layout_height="wrap_content"
-        app:layout_constraintEnd_toEndOf="parent"
-        app:layout_constraintStart_toStartOf="parent"
-        app:layout_constraintBottom_toBottomOf="parent"
-        android:background="@color/colorPrimary"
-        android:text="@string/play_history"
-        android:textColor="@android:color/white"
-        />
-
     <com.google.android.material.card.MaterialCardView
         android:layout_width="match_parent"
         android:layout_height="wrap_content"
         android:theme="@style/Theme.MaterialComponents.Light"
-        app:layout_constraintBottom_toTopOf="@id/playReplay"
+        app:layout_constraintBottom_toBottomOf="parent"
         app:cardElevation="3dp"
         app:cardUseCompatPadding="true">
 
@@ -71,17 +59,10 @@
                 android:id="@+id/seekBar"
                 android:layout_width="match_parent"
                 android:layout_height="wrap_content"
-                android:paddingBottom="6dp"
+                android:paddingBottom="30dp"
                 android:paddingTop="6dp"
                 />
 
-            <TextView
-                android:id="@+id/playerStatus"
-                android:layout_width="match_parent"
-                android:layout_height="wrap_content"
-                android:padding="6dp"
-                android:text="Paused"/>
-
         </LinearLayout>
 
     </com.google.android.material.card.MaterialCardView>

libnavigation-core/api/current.txt

@@ -529,6 +529,9 @@ package com.mapbox.navigation.core.replay.history {
     property public final Double? time;
   }
 
+  public final class ReplayEventLocationMapperKt {
+  }
+
   public final class ReplayEventUpdateLocation implements com.mapbox.navigation.core.replay.history.ReplayEventBase {
     ctor public ReplayEventUpdateLocation(@com.google.gson.annotations.SerializedName("event_timestamp") double eventTimestamp, @com.google.gson.annotations.SerializedName("location") com.mapbox.navigation.core.replay.history.ReplayEventLocation location);
     method public double component1();
@@ -570,6 +573,33 @@ package com.mapbox.navigation.core.replay.history {
     method public com.mapbox.navigation.core.replay.history.ReplayHistoryMapper.Builder statusMapper(com.mapbox.navigation.core.replay.history.ReplayHistoryEventMapper<com.mapbox.navigation.core.history.model.HistoryEventGetStatus>? statusMapper);
   }
 
+  @com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI public final class ReplayHistorySession implements com.mapbox.navigation.core.lifecycle.MapboxNavigationObserver {
+    ctor public ReplayHistorySession();
+    method public kotlinx.coroutines.flow.StateFlow<com.mapbox.navigation.core.replay.history.ReplayHistorySessionOptions> getOptions();
+    method public void onAttached(com.mapbox.navigation.core.MapboxNavigation mapboxNavigation);
+    method public void onDetached(com.mapbox.navigation.core.MapboxNavigation mapboxNavigation);
+    method public void setHistoryFile(String absolutePath);
+    method public void setOptions(com.mapbox.navigation.core.replay.history.ReplayHistorySessionOptions options);
+  }
+
+  @com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI public final class ReplayHistorySessionOptions {
+    method public boolean getEnableSetRoute();
+    method public String? getFilePath();
+    method public com.mapbox.navigation.core.replay.history.ReplayHistoryMapper getReplayHistoryMapper();
+    method public com.mapbox.navigation.core.replay.history.ReplayHistorySessionOptions.Builder toBuilder();
+    property public final boolean enableSetRoute;
+    property public final String? filePath;
+    property public final com.mapbox.navigation.core.replay.history.ReplayHistoryMapper replayHistoryMapper;
+  }
+
+  @com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI public static final class ReplayHistorySessionOptions.Builder {
+    ctor public ReplayHistorySessionOptions.Builder();
+    method public com.mapbox.navigation.core.replay.history.ReplayHistorySessionOptions build();
+    method public com.mapbox.navigation.core.replay.history.ReplayHistorySessionOptions.Builder enableSetRoute(boolean enableSetRoute);
+    method public com.mapbox.navigation.core.replay.history.ReplayHistorySessionOptions.Builder filePath(String? filePath);
+    method public com.mapbox.navigation.core.replay.history.ReplayHistorySessionOptions.Builder replayHistoryMapper(com.mapbox.navigation.core.replay.history.ReplayHistoryMapper replayHistoryMapper);
+  }
+
   public final class ReplaySetNavigationRoute implements com.mapbox.navigation.core.replay.history.ReplayEventBase {
     method public double getEventTimestamp();
     method public com.mapbox.navigation.base.route.NavigationRoute? getRoute();
@@ -1027,8 +1057,10 @@ package com.mapbox.navigation.core.trip {
   @com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI public final class MapboxTripStarter implements com.mapbox.navigation.core.lifecycle.MapboxNavigationObserver {
     method public static com.mapbox.navigation.core.trip.MapboxTripStarter create();
     method public com.mapbox.navigation.core.trip.MapboxTripStarter enableMapMatching();
+    method public com.mapbox.navigation.core.trip.MapboxTripStarter enableReplayHistory(com.mapbox.navigation.core.replay.history.ReplayHistorySessionOptions? options = null);
     method public com.mapbox.navigation.core.trip.MapboxTripStarter enableReplayRoute(com.mapbox.navigation.core.replay.route.ReplayRouteSessionOptions? options = null);
     method public static com.mapbox.navigation.core.trip.MapboxTripStarter getRegisteredInstance();
+    method public com.mapbox.navigation.core.replay.history.ReplayHistorySessionOptions getReplayHistorySessionOptions();
     method public com.mapbox.navigation.core.replay.route.ReplayRouteSessionOptions getReplayRouteSessionOptions();
     method public void onAttached(com.mapbox.navigation.core.MapboxNavigation mapboxNavigation);
     method public void onDetached(com.mapbox.navigation.core.MapboxNavigation mapboxNavigation);

libnavigation-core/src/main/java/com/mapbox/navigation/core/history/MapboxHistoryReaderProvider.kt

@@ -0,0 +1,8 @@
+package com.mapbox.navigation.core.history
+
+import androidx.annotation.VisibleForTesting
+
+@VisibleForTesting
+internal object MapboxHistoryReaderProvider {
+    fun create(filePath: String) = MapboxHistoryReader(filePath)
+}