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.

6.8 KB
Raw Blame
package dev.lelonio.square.ui.player

import androidx.compose.foundation.background
import androidx.compose.foundation.layout.Box
import androidx.compose.foundation.shape.CornerBasedShape
import androidx.compose.runtime.Composable
import androidx.compose.ui.Modifier
import androidx.compose.ui.graphics.Color
import androidx.compose.ui.graphics.Shape
import androidx.compose.ui.graphics.isSpecified
import androidx.compose.ui.unit.Dp
import androidx.compose.ui.unit.dp
import dev.lelonio.square.ui.glass.backdrop.Backdrop
import dev.lelonio.square.ui.glass.liquidGlass

/**
 * A pane of glass over [backdrop].
 *
 * One call for every glass surface outside the bottom bar: the sheets, the
 * menus, the cards a link opens, the player's own panels. What it is made of is
 * not decided here any more — it defers to the bar's [liquidGlass], so there is
 * a single answer in the app to what glass looks like, and changing it changes
 * everything at once.
 *
 * Everything degrades on its own below Android 13: the library checks for
 * RuntimeShader support and skips the refraction, leaving the blur, and below
 * Android 12 the blur goes too. What is left is a plain translucent surface, so
 * the screen stays usable rather than breaking on older phones.
 */
/**
 * Whether panes refresh what they are reflecting, or hold the last look at it.
 *
 * False while the player is in motion. A pane's blur and lens are RuntimeShaders
 * sampling a recorded layer, and during the expansion that layer changes every
 * frame — several full-screen shader passes per frame, which is most of what
 * made the animation stutter.
 *
 * It used to mean "no glass at all", and the pane fell back to a plain film for
 * the length of the travel. That saved the same work and cost a visible one:
 * this is the only surface in the player that answers the flag, so the title
 * capsule alone arrived as a flat grey patch among panes of glass and turned
 * into glass a frame after the player stopped. Holding the recording gets the
 * saving without the change of material — what is behind the player barely
 * moves anyway, being the artwork it is opening over.
 */
val LocalGlassEnabled = androidx.compose.runtime.staticCompositionLocalOf { true }

/**
 * Whether the player is standing still.
 *
 * False for the frames of an opening or a closing, and read by the two things
 * in the player that are video: a TextureView inside a layer that is being
 * scaled and faded has its surface detached and re-attached around the change,
 * and draws black for the length of the travel — a black rectangle sliding down
 * the screen, and the last thing to go.
 *
 * Kept apart from [LocalGlassEnabled], which the sheet used to answer this
 * question with. That one carries the listener's glass setting as well, so a
 * player with the glass turned off had no moving cover either — two unrelated
 * things behind one flag.
 */
val LocalPlayerSettled = androidx.compose.runtime.staticCompositionLocalOf { true }

@Composable
fun GlassSurface(
    backdrop: Backdrop,
    shape: Shape,
    modifier: Modifier = Modifier,
    /**
     * How thick this pane is, as a multiple of the app's own frost.
     *
     * The one thing a caller still decides, and it is a ratio rather than a
     * number of dp on purpose: a panel covering half the screen has to hide what
     * is under it in a way a pill the size of a word does not, but both have to
     * answer the setting. Fixed dp here is what made the player's surfaces stop
     * listening to it — a hardcoded 8 next to a bar on 2 is a different
     * material, whatever the slider says.
     */
    blurScale: Float = 1f,
    /**
     * The film, for the surfaces that do not get real glass.
     *
     * Where they do, the film comes from the shared recipe with everything else
     * about the material. This is what an unsupported device, a shape the
     * refraction cannot follow, or a moving player falls back to.
     */
    surfaceColor: Color = Color.Unspecified,
    /**
     * The least this pane blurs, whatever the setting says.
     *
     * For the panes whose job is to stand in front of the page: a menu over a
     * list, with the frost turned down to nothing, showed the list sharp
     * through its own rows and could not be read (#132).
     */
    minBlurDp: Float = 0f,
    content: @Composable () -> Unit,
) {
    // The same material the bottom bar is made of, so one app has one glass.
    //
    // The bar came from elsewhere and brought its own recipe with it, and next
    // to it every other pane in this app read as a different substance: a
    // different saturation, a different bend at the edge, and a thin white film
    // where the bar has a lit grey one. Asking both recipes to agree by hand was
    // the previous attempt and it changed nothing anybody could see, so there is
    // only one recipe now — [Modifier.liquidGlass], the bar's own — and the
    // parameters below are what a pane is still allowed to choose.
    //
    // Only how thick it is, in other words. How far it blurs is a real
    // difference between a small pill and a panel covering half the screen; what
    // the material *is* is not.
    val config = dev.lelonio.square.ui.glass.LocalGlassEffectConfig.current
    // The refraction is part of that recipe now, and it is the reason this takes
    // a shape it can bend light along. Anything else keeps the film below.
    val blurDp = (config.blurRadius * blurScale).coerceAtLeast(minBlurDp)
    val cornerShape = shape as? CornerBasedShape
    if (cornerShape == null) {
        Box(
            modifier.background(
                color = if (surfaceColor.isSpecified) surfaceColor else FallbackFilm,
                shape = shape,
            ),
        ) {
            content()
        }
        return
    }

    // Held rather than dropped while the player travels; see LocalGlassEnabled.
    val moving = !LocalGlassEnabled.current

    Box(
        modifier.liquidGlass(
            config = config,
            shape = cornerShape,
            blurRadiusDp = blurDp,
            frozen = { moving },
            // The bar's rim, not the library's default: the app's chrome is one
            // material and the edge light is most of what says so.
            highlightAlpha = BarHighlightAlpha,
            // Panes sit over their own backdrop: the player's is the artwork
            // behind it rather than the page under that.
            ownBackdrop = backdrop,
        ),
    ) {
        content()
    }
}

/**
 * The rim every surface in this app is lit with.
 *
 * The bottom bar picked this when it arrived and everything else kept the
 * library's brighter default, which is why the player read as a different
 * material even once the rest of the recipe was shared.
 */
internal const val BarHighlightAlpha = 0.3f

/** What a pane looks like with the refraction switched off. */
private val FallbackFilm = Color.White.copy(alpha = 0.12f)