Skip to content

Unofficial YouTube Music / Spotify Premium client for Android, built in Liquid Glass. Audio effects, Spotify Connect, listening history, 8 languages. Rust core on librespot.

SponsorBlock skips what is not music in a YouTube track

Lelonio982b1c4491ee
diff --git a/app/src/main/java/dev/lelonio/square/backend/youtube/SponsorBlock.kt b/app/src/main/java/dev/lelonio/square/backend/youtube/SponsorBlock.kt
new file mode 100644
index 0000000..d53b8da
--- /dev/null
+++ b/app/src/main/java/dev/lelonio/square/backend/youtube/SponsorBlock.kt
@@ -0,0 +1,152 @@
+package dev.lelonio.square.backend.youtube
+
+import androidx.media3.common.MediaItem
+import androidx.media3.common.Player
+import androidx.media3.exoplayer.ExoPlayer
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.Dispatchers
+import kotlinx.coroutines.Job
+import kotlinx.coroutines.delay
+import kotlinx.coroutines.isActive
+import kotlinx.coroutines.launch
+import kotlinx.coroutines.withContext
+import org.json.JSONArray
+import java.net.HttpURLConnection
+import java.net.URL
+import java.net.URLEncoder
+
+/**
+ * Skips what is not music in a YouTube track, from SponsorBlock's database.
+ *
+ * A song on YouTube Music is very often its video: an intro before the first
+ * note, a sketch in the middle, a minute of talking after the last chord.
+ * Trimming silence does nothing for those, because none of them is silent.
+ * SponsorBlock keeps a category for exactly this, `music_offtopic`, filled in
+ * by the people who watch the videos; this asks for it once per track and
+ * jumps over each segment as playback reaches it (#30).
+ *
+ * Only the video id leaves the phone, to sponsor.ajay.app, and only for the
+ * YouTube source. A segment is skipped once per play: someone who seeks back
+ * into it means to hear it.
+ */
+class SponsorBlock(
+ private val player: ExoPlayer,
+ private val enabled: () -> Boolean,
+) : Player.Listener {
+
+ private data class Segment(val startMs: Long, val endMs: Long)
+
+ private val scope = CoroutineScope(Dispatchers.Main.immediate)
+ private var watch: Job? = null
+ private var fetch: Job? = null
+
+ /** Answers already had, by video id, for the life of the player. */
+ private val known = HashMap<String, List<Segment>>()
+
+ /** The segments of what is playing, and which of them have been jumped. */
+ private var segments: List<Segment> = emptyList()
+ private val skipped = HashSet<Segment>()
+
+ init {
+ player.addListener(this)
+ load(player.currentMediaItem)
+ }
+
+ override fun onMediaItemTransition(mediaItem: MediaItem?, reason: Int) = load(mediaItem)
+
+ override fun onIsPlayingChanged(isPlaying: Boolean) {
+ if (isPlaying) follow() else watch?.cancel()
+ }
+
+ private fun load(item: MediaItem?) {
+ segments = emptyList()
+ skipped.clear()
+ fetch?.cancel()
+ val id = item?.mediaId?.let(::videoIdOf) ?: return
+ if (!enabled()) return
+ known[id]?.let {
+ segments = it
+ follow()
+ return
+ }
+ fetch = scope.launch {
+ val found = withContext(Dispatchers.IO) { runCatching { ask(id) }.getOrDefault(emptyList()) }
+ known[id] = found
+ if (videoIdOf(player.currentMediaItem?.mediaId.orEmpty()) == id) {
+ segments = found
+ if (found.isNotEmpty()) {
+ android.util.Log.i(TAG, "$id: ${found.size} segment(s) to skip")
+ }
+ follow()
+ }
+ }
+ }
+
+ /** Checks the position a few times a second while there is anything to skip. */
+ private fun follow() {
+ watch?.cancel()
+ if (segments.isEmpty() || !player.isPlaying) return
+ watch = scope.launch {
+ while (isActive) {
+ val at = player.currentPosition
+ val inside = segments.firstOrNull { at >= it.startMs && at < it.endMs - END_SLACK_MS }
+ if (inside != null && skipped.add(inside) && enabled()) {
+ val length = player.duration
+ // A segment that runs to the end of the song is the song
+ // being over: move on rather than seek to its last frame.
+ if (length > 0 && inside.endMs >= length - END_SLACK_MS) {
+ android.util.Log.i(TAG, "skipping the rest of the track at ${at}ms")
+ if (player.hasNextMediaItem()) player.seekToNextMediaItem() else player.pause()
+ } else {
+ android.util.Log.i(TAG, "skipping ${inside.startMs}..${inside.endMs}ms")
+ player.seekTo(inside.endMs)
+ }
+ }
+ delay(TICK_MS)
+ }
+ }
+ }
+
+ private fun ask(videoId: String): List<Segment> {
+ val categories = URLEncoder.encode("[\"music_offtopic\"]", "UTF-8")
+ val url = URL("$API?videoID=${URLEncoder.encode(videoId, "UTF-8")}&categories=$categories")
+ val connection = (url.openConnection() as HttpURLConnection).apply {
+ connectTimeout = TIMEOUT_MS
+ readTimeout = TIMEOUT_MS
+ setRequestProperty("User-Agent", "Square")
+ }
+ return try {
+ // 404 is SponsorBlock saying it has nothing for this video.
+ if (connection.responseCode != HttpURLConnection.HTTP_OK) return emptyList()
+ val body = connection.inputStream.bufferedReader().use { it.readText() }
+ val array = JSONArray(body)
+ (0 until array.length()).mapNotNull { index ->
+ val entry = array.getJSONObject(index)
+ if (entry.optString("actionType", "skip") != "skip") return@mapNotNull null
+ val span = entry.getJSONArray("segment")
+ val start = (span.getDouble(0) * 1000).toLong()
+ val end = (span.getDouble(1) * 1000).toLong()
+ // Anything shorter than a second is not worth the jump it costs.
+ if (end - start < MIN_SEGMENT_MS) null else Segment(start, end)
+ }.sortedBy { it.startMs }
+ } finally {
+ connection.disconnect()
+ }
+ }
+
+ private fun videoIdOf(mediaId: String): String? =
+ mediaId.takeIf { it.startsWith(YouTubeBackend.TRACK_PREFIX) }
+ ?.removePrefix(YouTubeBackend.TRACK_PREFIX)
+ ?.takeIf { it.isNotBlank() }
+
+ private companion object {
+ const val TAG = "SquareSponsorBlock"
+ const val API = "https://sponsor.ajay.app/api/skipSegments"
+ const val TICK_MS = 250L
+ const val TIMEOUT_MS = 6_000
+ const val MIN_SEGMENT_MS = 1_000L
+
+ /** How close to a segment's end the position counts as past it. */
+ const val END_SLACK_MS = 400L
+ }
+}
diff --git a/app/src/main/java/dev/lelonio/square/backend/youtube/YouTubePlayerFactory.kt b/app/src/main/java/dev/lelonio/square/backend/youtube/YouTubePlayerFactory.kt
index 09e4ad9..398797f 100644
--- a/app/src/main/java/dev/lelonio/square/backend/youtube/YouTubePlayerFactory.kt
+++ b/app/src/main/java/dev/lelonio/square/backend/youtube/YouTubePlayerFactory.kt
@@ -69,6 +69,8 @@ object YouTubePlayerFactory {
val fades = YouTubeFadeController(exo, crossfadeStore)
val preferences = (host.context.applicationContext as? dev.lelonio.square.SquareApplication)
?.preferences
+ // The talking and the sketches around a music video; see SponsorBlock.
+ SponsorBlock(exo) { preferences?.sponsorBlock?.value ?: true }
// Every change of song the listener asks for goes through the
// fade; see SkipFadePlayer.
SkipFadePlayer(exo, fades) { preferences?.skipFadeMs() ?: 0 }
diff --git a/app/src/main/java/dev/lelonio/square/data/PreferencesStore.kt b/app/src/main/java/dev/lelonio/square/data/PreferencesStore.kt
index 386119a..0c3e8b7 100644
--- a/app/src/main/java/dev/lelonio/square/data/PreferencesStore.kt
+++ b/app/src/main/java/dev/lelonio/square/data/PreferencesStore.kt
@@ -102,6 +102,20 @@ class PreferencesStore(context: Context) {
prefs.edit().putBoolean(KEY_KEEP_PLAYING, value).apply()
}
+ private val _sponsorBlock = MutableStateFlow(prefs.getBoolean(KEY_SPONSOR_BLOCK, true))
+
+ /**
+ * Whether the non-music parts of a YouTube track are skipped; see
+ * SponsorBlock. On to begin with: nobody opens a music app for the sketch
+ * at the start of a music video.
+ */
+ val sponsorBlock: StateFlow<Boolean> = _sponsorBlock.asStateFlow()
+
+ fun setSponsorBlock(value: Boolean) {
+ _sponsorBlock.value = value
+ prefs.edit().putBoolean(KEY_SPONSOR_BLOCK, value).apply()
+ }
+
private val _autoplayInfinite = MutableStateFlow(prefs.getBoolean(KEY_AUTOPLAY_INFINITE, false))
/** Whether playback automatically appends similar tracks when reaching queue end. */
@@ -245,6 +259,7 @@ class PreferencesStore(context: Context) {
const val KEY_ONBOARDED = "onboarded"
const val KEY_CANVAS = "canvas_enabled"
const val KEY_KEEP_PLAYING = "keep_playing_on_close"
+ const val KEY_SPONSOR_BLOCK = "sponsor_block"
const val KEY_AUTOPLAY_INFINITE = "autoplay_infinite"
const val KEY_TRIM_SILENCE = "trim_silence"
const val KEY_SKIP_FADE = "skip_fade"
diff --git a/app/src/main/java/dev/lelonio/square/ui/settings/SettingsScreen.kt b/app/src/main/java/dev/lelonio/square/ui/settings/SettingsScreen.kt
index a6d75aa..134d43f 100644
--- a/app/src/main/java/dev/lelonio/square/ui/settings/SettingsScreen.kt
+++ b/app/src/main/java/dev/lelonio/square/ui/settings/SettingsScreen.kt
@@ -419,6 +419,24 @@ fun SettingsScreen(
color = InkDim,
modifier = Modifier.padding(start = ROW_TEXT_START, end = 18.dp, bottom = 14.dp),
)
+ // Only where it does anything: SponsorBlock knows YouTube videos.
+ if (!showSpotify) {
+ val sponsorBlock by prefs.sponsorBlock.collectAsStateWithLifecycle()
+ RowDivider()
+ DownloadSwitch(
+ label = stringResource(R.string.sponsor_block),
+ checked = sponsorBlock,
+ backdrop = backdrop,
+ icon = PhosphorIcons.Regular.Scissors,
+ onChange = prefs::setSponsorBlock,
+ )
+ Text(
+ stringResource(R.string.sponsor_block_note),
+ style = MaterialTheme.typography.bodySmall,
+ color = InkDim,
+ modifier = Modifier.padding(start = ROW_TEXT_START, end = 18.dp, bottom = 14.dp),
+ )
+ }
}
}
diff --git a/app/src/main/res/values-de/strings.xml b/app/src/main/res/values-de/strings.xml
index 37e3f70..49d3014 100644
--- a/app/src/main/res/values-de/strings.xml
+++ b/app/src/main/res/values-de/strings.xml
@@ -317,6 +317,8 @@
<string name="page_downloads_summary">Was auf dem Telefon liegt und was geladen wird</string>
<string name="keep_playing_on_close">Weiterspielen, wenn die App geschlossen wird</string>
<string name="keep_playing_on_close_note">Square aus den zuletzt geöffneten Apps zu wischen lässt die Musik laufen. Über die Benachrichtigung lässt sie sich stoppen.</string>
+ <string name="sponsor_block">Nicht-musikalische Teile überspringen</string>
+ <string name="sponsor_block_note">Intros, Sketche und Gesprochenes in Musikvideos, markiert von der SponsorBlock-Community. Gesendet wird nur die Video-ID.</string>
<string name="page_app_bar">Untere Leiste</string>
<string name="page_app_system">System</string>
<string name="page_app_storage">Speicher</string>
diff --git a/app/src/main/res/values-es/strings.xml b/app/src/main/res/values-es/strings.xml
index 9743f3d..74941b6 100644
--- a/app/src/main/res/values-es/strings.xml
+++ b/app/src/main/res/values-es/strings.xml
@@ -317,6 +317,8 @@
<string name="page_downloads_summary">Qué hay en el teléfono y qué se descarga</string>
<string name="keep_playing_on_close">Seguir sonando al cerrar la app</string>
<string name="keep_playing_on_close_note">Quitar Square de recientes deja la música sonando. Desde la notificación se detiene igual.</string>
+ <string name="sponsor_block">Saltar las partes sin música</string>
+ <string name="sponsor_block_note">Intros, sketches y partes habladas en videoclips, marcadas por la comunidad de SponsorBlock. Solo se envía el id del vídeo.</string>
<string name="page_app_bar">Barra inferior</string>
<string name="page_app_system">Sistema</string>
<string name="page_app_storage">Almacenamiento</string>
diff --git a/app/src/main/res/values-fr/strings.xml b/app/src/main/res/values-fr/strings.xml
index a31be80..3b903ba 100644
--- a/app/src/main/res/values-fr/strings.xml
+++ b/app/src/main/res/values-fr/strings.xml
@@ -317,6 +317,8 @@
<string name="page_downloads_summary">Ce qui est sur le téléphone et ce qui est téléchargé</string>
<string name="keep_playing_on_close">Continuer la lecture quand l\'appli est fermée</string>
<string name="keep_playing_on_close_note">Retirer Square des applis récentes laisse la musique jouer. La notification l\'arrête toujours.</string>
+ <string name="sponsor_block">Passer les parties non musicales</string>
+ <string name="sponsor_block_note">Intros, sketchs et parties parlées des clips, signalés par la communauté SponsorBlock. Seul l\'identifiant de la vidéo est envoyé.</string>
<string name="page_app_bar">Barre du bas</string>
<string name="page_app_system">Système</string>
<string name="page_app_storage">Stockage</string>
diff --git a/app/src/main/res/values-hi/strings.xml b/app/src/main/res/values-hi/strings.xml
index 47d71ca..c868799 100644
--- a/app/src/main/res/values-hi/strings.xml
+++ b/app/src/main/res/values-hi/strings.xml
@@ -332,6 +332,8 @@
<string name="page_downloads_summary">फ़ोन में क्या है और क्या डाउनलोड होता है</string>
<string name="keep_playing_on_close">ऐप बंद करने पर भी बजता रहे</string>
<string name="keep_playing_on_close_note">Square को हाल की ऐप्स से हटाने पर संगीत चलता रहता है। नोटिफिकेशन से बंद किया जा सकता है।</string>
+ <string name="sponsor_block">बिना संगीत वाले हिस्से छोड़ें</string>
+ <string name="sponsor_block_note">म्यूज़िक वीडियो के इंट्रो, स्किट और बातचीत, जिन्हें SponsorBlock समुदाय ने चिह्नित किया है। सिर्फ़ वीडियो id भेजी जाती है।</string>
<string name="page_app_bar">नीचे की पट्टी</string>
<string name="page_app_system">सिस्टम</string>
<string name="page_app_storage">स्टोरेज</string>
diff --git a/app/src/main/res/values-it/strings.xml b/app/src/main/res/values-it/strings.xml
index 94ef6a2..58e7608 100644
--- a/app/src/main/res/values-it/strings.xml
+++ b/app/src/main/res/values-it/strings.xml
@@ -318,6 +318,8 @@
<string name="page_downloads_summary">Cosa c\'è sul telefono e cosa viene scaricato</string>
<string name="keep_playing_on_close">Continua a suonare chiudendo l\'app</string>
<string name="keep_playing_on_close_note">Togliendo Square dalle recenti la musica va avanti. Dalla notifica si ferma come sempre.</string>
+ <string name="sponsor_block">Salta le parti non musicali</string>
+ <string name="sponsor_block_note">Introduzioni, scenette e parti parlate nei video musicali, segnalate dalla comunità di SponsorBlock. Viene inviato solo l\'id del video.</string>
<string name="page_app_bar">Barra in basso</string>
<string name="page_app_system">Sistema</string>
<string name="page_app_storage">Spazio</string>
diff --git a/app/src/main/res/values-pt/strings.xml b/app/src/main/res/values-pt/strings.xml
index 6cddb2f..cb34533 100644
--- a/app/src/main/res/values-pt/strings.xml
+++ b/app/src/main/res/values-pt/strings.xml
@@ -317,6 +317,8 @@
<string name="page_downloads_summary">O que está no telefone e o que é baixado</string>
<string name="keep_playing_on_close">Continuar tocando ao fechar o app</string>
<string name="keep_playing_on_close_note">Tirar o Square dos recentes deixa a música tocando. Pela notificação ela para como sempre.</string>
+ <string name="sponsor_block">Pular as partes sem música</string>
+ <string name="sponsor_block_note">Introduções, esquetes e falas em clipes, marcadas pela comunidade do SponsorBlock. Só o id do vídeo é enviado.</string>
<string name="page_app_bar">Barra inferior</string>
<string name="page_app_system">Sistema</string>
<string name="page_app_storage">Armazenamento</string>
diff --git a/app/src/main/res/values-ru/strings.xml b/app/src/main/res/values-ru/strings.xml
index f92f3fc..8a22aec 100644
--- a/app/src/main/res/values-ru/strings.xml
+++ b/app/src/main/res/values-ru/strings.xml
@@ -334,6 +334,8 @@
<string name="page_downloads_summary">Что лежит на телефоне и что скачивается</string>
<string name="keep_playing_on_close">Продолжать играть при закрытии приложения</string>
<string name="keep_playing_on_close_note">Если убрать Square из недавних, музыка продолжит играть. Остановить можно из уведомления.</string>
+ <string name="sponsor_block">Пропускать немузыкальные части</string>
+ <string name="sponsor_block_note">Вступления, сценки и разговоры в клипах, отмеченные сообществом SponsorBlock. Отправляется только id видео.</string>
<string name="page_app_bar">Нижняя панель</string>
<string name="page_app_system">Система</string>
<string name="page_app_storage">Память</string>
diff --git a/app/src/main/res/values-tr/strings.xml b/app/src/main/res/values-tr/strings.xml
index 606d7b2..fe4a593 100644
--- a/app/src/main/res/values-tr/strings.xml
+++ b/app/src/main/res/values-tr/strings.xml
@@ -332,6 +332,8 @@
<string name="page_downloads_summary">Telefonda ne var ve ne indiriliyor</string>
<string name="keep_playing_on_close">Uygulama kapatılınca çalmaya devam et</string>
<string name="keep_playing_on_close_note">Square\'i son kullanılanlardan kaydırmak müziği çalar bırakır. Bildirimden yine durdurulur.</string>
+ <string name="sponsor_block">Müzik olmayan kısımları atla</string>
+ <string name="sponsor_block_note">Klip içindeki girişler, skeçler ve konuşmalar, SponsorBlock topluluğunun işaretlediği gibi. Yalnızca video kimliği gönderilir.</string>
<string name="page_app_bar">Alt çubuk</string>
<string name="page_app_system">Sistem</string>
<string name="page_app_storage">Depolama</string>
diff --git a/app/src/main/res/values/strings.xml b/app/src/main/res/values/strings.xml
index f4ce915..924fb05 100644
--- a/app/src/main/res/values/strings.xml
+++ b/app/src/main/res/values/strings.xml
@@ -338,6 +338,8 @@
<string name="page_downloads_summary">What is on the phone, and what is fetched</string>
<string name="keep_playing_on_close">Keep playing when the app is closed</string>
<string name="keep_playing_on_close_note">Swiping Square out of the recents leaves the music playing. The notification still stops it.</string>
+ <string name="sponsor_block">Skip the non-music parts</string>
+ <string name="sponsor_block_note">Intros, sketches and talking in music videos, as marked by SponsorBlock\'s community. Only the video id is sent.</string>
<string name="page_app_bar">Bottom bar</string>
<string name="page_app_system">System</string>
<string name="page_app_storage">Storage</string>