feat: store sponsorblock segments in database

Author: Bnyro

app/schemas/com.github.libretube.db.AppDatabase/22.json

@@ -2,12 +2,14 @@ package com.github.libretube.api.obj
 
 import android.os.Parcelable
 import androidx.collection.FloatFloatPair
+import com.github.libretube.db.obj.DownloadSponsorBlockSegment
 import kotlinx.parcelize.IgnoredOnParcel
 import kotlinx.parcelize.Parcelize
 import kotlinx.serialization.SerialName
 import kotlinx.serialization.Serializable
 import kotlinx.serialization.Transient
 
+// see https://wiki.sponsor.ajay.app/w/API_Docs#GET_/api/skipSegments
 @Serializable
 @Parcelize
 data class Segment(
@@ -26,6 +28,21 @@ data class Segment(
     @IgnoredOnParcel
     val segmentStartAndEnd = FloatFloatPair(segment[0], segment[1])
 
+    // reminder: all the attributed that are asserted as non-null here are declared non-null by the
+    // SponsorBlock API, so it's safe to assert they're not null (if we trust the SponsorBlock API docs)
+    fun toDownloadSegment(videoId: String): DownloadSponsorBlockSegment = DownloadSponsorBlockSegment(
+        uuid = uuid!!,
+        videoId = videoId,
+        startTime = segmentStartAndEnd.first,
+        endTime = segmentStartAndEnd.second,
+        actionType = actionType!!,
+        category = category!!,
+        description = description,
+        locked = locked!!,
+        videoDuration = videoDuration!!.toFloat(),
+        votes = votes!!
+    )
+
     companion object {
         const val TYPE_FULL = "full"
     }

app/src/main/java/com/github/libretube/api/obj/Segment.kt

@@ -20,6 +20,7 @@ import com.github.libretube.db.obj.DownloadChapter
 import com.github.libretube.db.obj.DownloadItem
 import com.github.libretube.db.obj.DownloadPlaylist
 import com.github.libretube.db.obj.DownloadPlaylistVideosCrossRef
+import com.github.libretube.db.obj.DownloadSponsorBlockSegment
 import com.github.libretube.db.obj.LocalPlaylist
 import com.github.libretube.db.obj.LocalPlaylistItem
 import com.github.libretube.db.obj.LocalSubscription
@@ -43,12 +44,13 @@ import com.github.libretube.db.obj.WatchPosition
         Download::class,
         DownloadItem::class,
         DownloadChapter::class,
+        DownloadSponsorBlockSegment::class,
         DownloadPlaylist::class,
         DownloadPlaylistVideosCrossRef::class,
         SubscriptionGroup::class,
         SubscriptionsFeedItem::class
     ],
-    version = 21,
+    version = 22,
     autoMigrations = [
         AutoMigration(from = 7, to = 8),
         AutoMigration(from = 8, to = 9),

app/src/main/java/com/github/libretube/db/AppDatabase.kt

@@ -56,6 +56,24 @@ object DatabaseHolder {
         }
     }
 
+    private val MIGRATION_21_22 = object : Migration(21, 22) {
+        override fun migrate(db: SupportSQLiteDatabase) {
+            db.execSQL("CREATE TABLE 'downloadSponsorBlockSegment' (" +
+                    "uuid TEXT PRIMARY KEY NOT NULL, " +
+                    "videoId TEXT NOT NULL, " +
+                    "actionType TEXT NOT NULL, " +
+                    "category TEXT NOT NULL, " +
+                    "description TEXT, " +
+                    "locked INTEGER NOT NULL, " +
+                    "startTime REAL NOT NULL, " +
+                    "endTime REAL NOT NULL, " +
+                    "videoDuration REAL NOT NULL, " +
+                    "votes INTEGER NOT NULL, " +
+                    "CONSTRAINT parentDownload FOREIGN KEY (videoId) REFERENCES download (videoId) ON DELETE CASCADE" +
+                    ")")
+        }
+    }
+
     val Database by lazy {
         Room.databaseBuilder(LibreTubeApp.instance, AppDatabase::class.java, DATABASE_NAME)
             .addMigrations(
@@ -64,7 +82,8 @@ object DatabaseHolder {
                 MIGRATION_13_14,
                 MIGRATION_14_15,
                 MIGRATION_15_16,
-                MIGRATION_17_18
+                MIGRATION_17_18,
+                MIGRATION_21_22
             )
             .build()
     }

app/src/main/java/com/github/libretube/db/DatabaseHolder.kt

@@ -14,6 +14,7 @@ import com.github.libretube.db.obj.DownloadPlaylist
 import com.github.libretube.db.obj.DownloadPlaylistVideosCrossRef
 import com.github.libretube.db.obj.DownloadPlaylistWithDownload
 import com.github.libretube.db.obj.DownloadPlaylistWithDownloadWithItems
+import com.github.libretube.db.obj.DownloadSponsorBlockSegment
 import com.github.libretube.db.obj.DownloadWithItems
 
 @Dao
@@ -88,4 +89,7 @@ interface DownloadDao {
 
     @Query("SELECT * FROM downloadplaylistvideoscrossref WHERE playlistId = :playlistId")
     suspend fun getVideoIdsFromPlaylist(playlistId: String): List<DownloadPlaylistVideosCrossRef>
+
+    @Insert
+    suspend fun insertSponsorBlockSegments(segments: List<DownloadSponsorBlockSegment>)
 }

app/src/main/java/com/github/libretube/db/dao/DownloadDao.kt

@@ -0,0 +1,31 @@
+package com.github.libretube.db.obj
+
+import androidx.room.Entity
+import androidx.room.ForeignKey
+import androidx.room.PrimaryKey
+
+@Entity(
+    tableName = "downloadSponsorBlockSegment",
+    foreignKeys = [
+        ForeignKey(
+            entity = Download::class,
+            parentColumns = ["videoId"],
+            childColumns = ["videoId"],
+            onDelete = ForeignKey.CASCADE
+        )
+    ]
+)
+data class DownloadSponsorBlockSegment(
+    @PrimaryKey
+    val uuid: String,
+    val videoId: String,
+
+    val actionType: String,
+    val category: String,
+    val description: String? = null,
+    val locked: Int,
+    val startTime: Float,
+    val endTime: Float,
+    val videoDuration: Float,
+    val votes: Int,
+)

app/src/main/java/com/github/libretube/db/obj/DownloadSponsorBlockSegment.kt

@@ -16,7 +16,12 @@ data class DownloadWithItems(
         parentColumn = "videoId",
         entityColumn = "videoId"
     )
-    val downloadChapters: List<DownloadChapter> = emptyList()
+    val downloadChapters: List<DownloadChapter> = emptyList(),
+    @Relation(
+        parentColumn = "videoId",
+        entityColumn = "videoId"
+    )
+    val downloadSponsorBlockSegments: List<DownloadSponsorBlockSegment> = emptyList()
 )
 
 fun List<DownloadWithItems>.filterByTab(tab: DownloadTab) = filter { dl ->

app/src/main/java/com/github/libretube/db/obj/DownloadWithItems.kt

@@ -44,6 +44,7 @@ import com.github.libretube.helpers.DownloadHelper
 import com.github.libretube.helpers.DownloadHelper.getNotificationId
 import com.github.libretube.helpers.ImageHelper
 import com.github.libretube.helpers.NetworkHelper
+import com.github.libretube.helpers.PlayerHelper
 import com.github.libretube.helpers.ProxyHelper
 import com.github.libretube.obj.DownloadStatus
 import com.github.libretube.parcelable.DownloadData
@@ -56,6 +57,7 @@ import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.Job
 import kotlinx.coroutines.SupervisorJob
 import kotlinx.coroutines.asCoroutineDispatcher
+import kotlinx.coroutines.coroutineScope
 import kotlinx.coroutines.flow.MutableSharedFlow
 import kotlinx.coroutines.flow.SharedFlow
 import kotlinx.coroutines.launch
@@ -192,17 +194,52 @@ class DownloadService : LifecycleService() {
             Database.downloadDao().insertDownloadChapter(downloadChapter)
         }
 
-        try {
-            ImageHelper.downloadImage(
-                this@DownloadService,
-                ProxyHelper.rewriteUrlUsingProxyPreference(streams.thumbnailUrl),
-                thumbnailTargetPath
-            )
-        } catch (e: Exception) {
-            Log.e(
-                this@DownloadService::class.java.name,
-                "failed to download image ${streams.thumbnailUrl}"
-            )
+        // asynchronously load the remaining metadata
+        // this allows the main thread to already start the actual download items (i.e. video/audio)
+        // while the thumbnail and SponsorBlock segments are loaded in the background
+        coroutineScope {
+            launch(Dispatchers.IO) {
+                downloadExtraVideoMetadata(videoId, streams.thumbnailUrl, thumbnailTargetPath)
+            }
+        }
+    }
+
+    /**
+     * Download the thumbnail and SponsorBlock segments for the given [videoId].
+     */
+    private suspend fun downloadExtraVideoMetadata(
+        videoId: String,
+        thumbnailUrl: String,
+        thumbnailTargetPath: Path
+    ) {
+        coroutineScope {
+            launch {
+                val segmentData = try {
+                    val categories = PlayerHelper.getSponsorBlockCategories()
+                    MediaServiceRepository.instance.getSegments(videoId, categories.map { it.key })
+                } catch (e: Exception) {
+                    Log.e(TAG(), "failed to download SponsorBlock segments for $videoId")
+                    Log.e(TAG(), e.stackTraceToString())
+                    return@launch
+                }
+
+                Database.downloadDao().insertSponsorBlockSegments(
+                    segmentData.segments.map { it.toDownloadSegment(videoId) }
+                )
+            }
+
+            launch {
+                try {
+                    ImageHelper.downloadImage(
+                        this@DownloadService,
+                        ProxyHelper.rewriteUrlUsingProxyPreference(thumbnailUrl),
+                        thumbnailTargetPath
+                    )
+                } catch (e: Exception) {
+                    Log.e(TAG(), "failed to download image $thumbnailUrl")
+                    Log.e(TAG(), e.stackTraceToString())
+                }
+            }
         }
     }