Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 75e5a76d authored by Juan Sebastian Martinez's avatar Juan Sebastian Martinez
Browse files

Introducing API to produce slider events. 

The API defines the production of slider events as a state flow. A
concrete implementation is also added in the form of a
SeekableSliderEventProducer, whose purpose is to produce a stream of
events from an Android SeekBar.

Test: atest SeekableSliderEventProducerTest
Bug: 295932558
Change-Id: Iae5d63f6bbc83d98ad12b3a115d3e8c712b82fdd
parent 269b427e

packages/SystemUI/src/com/android/systemui/haptics/slider/SeekableSliderEventProducer.kt

0 → 100644
+68 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2023 The Android Open Source Project

 *

 * Licensed under the Apache License, Version 2.0 (the "License");

 * you may not use this file except in compliance with the License.

 * You may obtain a copy of the License at

 *

 *      http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 */



package com.android.systemui.haptics.slider



import android.widget.SeekBar

import android.widget.SeekBar.OnSeekBarChangeListener

import kotlinx.coroutines.flow.Flow

import kotlinx.coroutines.flow.MutableStateFlow

import kotlinx.coroutines.flow.asStateFlow

import kotlinx.coroutines.flow.update



/** An event producer for a Seekable element such as the Android [SeekBar] */

class SeekableSliderEventProducer : SliderEventProducer, OnSeekBarChangeListener {



    /** The current event reported by a SeekBar */

    private val _currentEvent = MutableStateFlow(SliderEvent(SliderEventType.NOTHING, 0f))



    override fun produceEvents(): Flow<SliderEvent> = _currentEvent.asStateFlow()



    override fun onProgressChanged(seekBar: SeekBar, progress: Int, fromUser: Boolean) {

        val eventType =

            if (fromUser) SliderEventType.PROGRESS_CHANGE_BY_USER

            else SliderEventType.PROGRESS_CHANGE_BY_PROGRAM



        _currentEvent.value = SliderEvent(eventType, normalizeProgress(seekBar, progress))

    }



    /**

     * Normalize the integer progress of a SeekBar to the range from 0F to 1F.

     *

     * @param[seekBar] The SeekBar that reports a progress.

     * @param[progress] The integer progress of the SeekBar within its min and max values.

     * @return The progress in the range from 0F to 1F.

     */

    private fun normalizeProgress(seekBar: SeekBar, progress: Int): Float {

        if (seekBar.max == seekBar.min) {

            return 1.0f

        }

        val range = seekBar.max - seekBar.min

        return (progress - seekBar.min) / range.toFloat()

    }



    override fun onStartTrackingTouch(seekBar: SeekBar) {

        _currentEvent.update { previousEvent ->

            SliderEvent(SliderEventType.STARTED_TRACKING_TOUCH, previousEvent.currentProgress)

        }

    }



    override fun onStopTrackingTouch(seekBar: SeekBar) {

        _currentEvent.update { previousEvent ->

            SliderEvent(SliderEventType.STOPPED_TRACKING_TOUCH, previousEvent.currentProgress)

        }

    }

}

packages/SystemUI/src/com/android/systemui/haptics/slider/SliderEvent.kt

0 → 100644
+31 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2023 The Android Open Source Project

 *

 * Licensed under the Apache License, Version 2.0 (the "License");

 * you may not use this file except in compliance with the License.

 * You may obtain a copy of the License at

 *

 *      http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 */



package com.android.systemui.haptics.slider



import androidx.annotation.FloatRange



/**

 * An event arising from a slider.

 *

 * @property[type] The type of event. Must be one of [SliderEventType].

 * @property[currentProgress] The current progress of the slider normalized to the range between 0F

 *   and 1F (inclusive).

 */

data class SliderEvent(

    val type: SliderEventType,

    @FloatRange(from = 0.0, to = 1.0) val currentProgress: Float

)

packages/SystemUI/src/com/android/systemui/haptics/slider/SliderEventProducer.kt

0 → 100644
+30 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2023 The Android Open Source Project

 *

 * Licensed under the Apache License, Version 2.0 (the "License");

 * you may not use this file except in compliance with the License.

 * You may obtain a copy of the License at

 *

 *      http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 */



package com.android.systemui.haptics.slider



import kotlinx.coroutines.flow.Flow



/** Defines a producer of [SliderEvent] to be consumed as a [Flow] */

interface SliderEventProducer {



    /**

     * Produce a stream of [SliderEvent]

     *

     * @return A [Flow] of [SliderEvent] produced from the operation of a slider.

     */

    fun produceEvents(): Flow<SliderEvent>

}

packages/SystemUI/src/com/android/systemui/haptics/slider/SliderEventType.kt

0 → 100644
+33 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2023 The Android Open Source Project

 *

 * Licensed under the Apache License, Version 2.0 (the "License");

 * you may not use this file except in compliance with the License.

 * You may obtain a copy of the License at

 *

 *      http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 */



package com.android.systemui.haptics.slider



/** The type of a [SliderEvent]. */

enum class SliderEventType {

    /* No event. */

    NOTHING,

    /* The slider has captured a touch input and is tracking touch events. */

    STARTED_TRACKING_TOUCH,

    /* The slider progress is changing due to user touch input. */

    PROGRESS_CHANGE_BY_USER,

    /* The slider progress is changing programmatically. */

    PROGRESS_CHANGE_BY_PROGRAM,

    /* The slider has stopped tracking touch events. */

    STOPPED_TRACKING_TOUCH,

    /* The external (not touch) stimulus that was modifying the slider progress has stopped. */

    EXTERNAL_STIMULUS_RELEASE,

}

packages/SystemUI/tests/src/com/android/systemui/haptics/slider/SeekableSliderEventProducerTest.kt

0 → 100644
+126 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2023 The Android Open Source Project

 *

 * Licensed under the Apache License, Version 2.0 (the "License");

 * you may not use this file except in compliance with the License.

 * You may obtain a copy of the License at

 *

 *      http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 */



package com.android.systemui.haptics.slider



import android.widget.SeekBar

import androidx.test.ext.junit.runners.AndroidJUnit4

import androidx.test.filters.SmallTest

import com.android.systemui.SysuiTestCase

import com.android.systemui.coroutines.collectLastValue

import junit.framework.Assert.assertEquals

import kotlinx.coroutines.test.runTest

import org.junit.Test

import org.junit.runner.RunWith



@SmallTest

@RunWith(AndroidJUnit4::class)

class SeekableSliderEventProducerTest : SysuiTestCase() {



    private val seekBar = SeekBar(mContext)

    private val eventProducer = SeekableSliderEventProducer()

    private val eventFlow = eventProducer.produceEvents()



    @Test

    fun onStartTrackingTouch_noProgress_trackingTouchEventProduced() = runTest {

        val latest by collectLastValue(eventFlow)



        eventProducer.onStartTrackingTouch(seekBar)



        assertEquals(SliderEvent(SliderEventType.STARTED_TRACKING_TOUCH, 0F), latest)

    }



    @Test

    fun onStopTrackingTouch_noProgress_StoppedTrackingTouchEventProduced() = runTest {

        val latest by collectLastValue(eventFlow)



        eventProducer.onStopTrackingTouch(seekBar)



        assertEquals(SliderEvent(SliderEventType.STOPPED_TRACKING_TOUCH, 0F), latest)

    }



    @Test

    fun onProgressChangeByUser_changeByUserEventProduced_withNormalizedProgress() = runTest {

        val progress = 50

        val latest by collectLastValue(eventFlow)



        eventProducer.onProgressChanged(seekBar, progress, true)



        assertEquals(SliderEvent(SliderEventType.PROGRESS_CHANGE_BY_USER, 0.5F), latest)

    }



    @Test

    fun onProgressChangeByUser_zeroWidthSlider_changeByUserEventProduced_withMaxProgress() =

        runTest {

            // No-width slider where the min and max values are the same

            seekBar.min = 100

            seekBar.max = 100

            val progress = 50

            val latest by collectLastValue(eventFlow)



            eventProducer.onProgressChanged(seekBar, progress, true)



            assertEquals(SliderEvent(SliderEventType.PROGRESS_CHANGE_BY_USER, 1.0F), latest)

        }



    @Test

    fun onProgressChangeByProgram_changeByProgramEventProduced_withNormalizedProgress() = runTest {

        val progress = 50

        val latest by collectLastValue(eventFlow)



        eventProducer.onProgressChanged(seekBar, progress, false)



        assertEquals(SliderEvent(SliderEventType.PROGRESS_CHANGE_BY_PROGRAM, 0.5F), latest)

    }



    @Test

    fun onProgressChangeByProgram_zeroWidthSlider_changeByProgramEventProduced_withMaxProgress() =

        runTest {

            // No-width slider where the min and max values are the same

            seekBar.min = 100

            seekBar.max = 100

            val progress = 50

            val latest by collectLastValue(eventFlow)



            eventProducer.onProgressChanged(seekBar, progress, false)



            assertEquals(SliderEvent(SliderEventType.PROGRESS_CHANGE_BY_PROGRAM, 1.0F), latest)

        }



    @Test

    fun onStartTrackingTouch_afterProgress_trackingTouchEventProduced_withNormalizedProgress() =

        runTest {

            val progress = 50

            val latest by collectLastValue(eventFlow)



            eventProducer.onProgressChanged(seekBar, progress, true)

            eventProducer.onStartTrackingTouch(seekBar)



            assertEquals(SliderEvent(SliderEventType.STARTED_TRACKING_TOUCH, 0.5F), latest)

        }



    @Test

    fun onStopTrackingTouch_afterProgress_stopTrackingTouchEventProduced_withNormalizedProgress() =

        runTest {

            val progress = 50

            val latest by collectLastValue(eventFlow)



            eventProducer.onProgressChanged(seekBar, progress, true)

            eventProducer.onStopTrackingTouch(seekBar)



            assertEquals(SliderEvent(SliderEventType.STOPPED_TRACKING_TOUCH, 0.5F), latest)

        }

}