Gate Sound Sync behind a beta setting and add Android top bar action

app/detekt-baseline.xml

@@ -130,7 +130,6 @@
     <ID>MagicNumber:DeviceWebview.kt$8000</ID>
     <ID>MagicNumber:DeviceWebview.kt$CustomWebChromeClient$100.0f</ID>
     <ID>MagicNumber:DeviceWebview.kt$WebViewNavigator$5</ID>
-    <ID>MagicNumber:SettingsViewModel.kt$SettingsViewModel$5000</ID>
     <ID>MagicNumber:Theme.kt$3</ID>
     <ID>MagicNumber:Theme.kt$4</ID>
     <ID>MagicNumber:UpdateInstalling.kt$0xFF00b300</ID>

app/src/main/assets/changelog/dev.md

@@ -1,5 +1,5 @@
-### Sound Sync
-Turn your phone into a live audio-reactive controller for your WLED devices. Capture sound from your microphone, and the app sends real-time frequency data and beat detection to all your WLED devices over UDP Sound Sync. Your LED strips will dance to the beat, no extra hardware required. Make sure your devices are set to Receive mode in their audio sync settings.
+### Sound Sync (Beta)
+Turn your phone into a live audio-reactive controller for your WLED devices. Capture sound from your microphone, and the app sends real-time frequency data and beat detection to all your WLED devices over UDP Sound Sync. Your LED strips will dance to the beat, no extra hardware required. Enable Sound Sync (Beta) in Settings to try it early, and make sure your devices are set to Receive mode in their audio sync settings.
 
 ### Other Improvements & Fixes
 - Fixed the home screen widget's power and refresh buttons not working while Battery Saver is on.

app/src/main/java/ca/cgagnier/wlednativeandroid/di/AppModule.kt

@@ -144,7 +144,13 @@ val appModule: Module = module {
     }
 
     viewModelOf(::MainViewModel)
-    viewModelOf(::SettingsViewModel)
+    viewModel {
+        SettingsViewModel(
+            preferencesRepository = get(),
+            soundSyncManager = get(),
+            ioDispatcher = get(IO_DISPATCHER),
+        )
+    }
     viewModelOf(::ChangelogViewModel)
     viewModelOf(::ThemeViewModel)
     viewModel {

app/src/main/java/ca/cgagnier/wlednativeandroid/ui/homeScreen/DeviceListDetail.kt

@@ -79,7 +79,7 @@ fun DeviceListDetail(
     val selectedDeviceMacAddress = navigator.currentDestination?.contentKey as? String
     val selectedDevice = rememberSelectedDevice(devices, selectedDeviceMacAddress)
 
-    val showHiddenDevices by viewModel.showHiddenDevices.collectAsStateWithLifecycle()
+    val showSoundSync by deviceWebsocketListViewModel.soundSyncBetaEnabled.collectAsStateWithLifecycle()
     val isWLEDCaptivePortal by viewModel.isWLEDCaptivePortal.collectAsStateWithLifecycle()
     val isAddDeviceDialogVisible by viewModel.isAddDeviceDialogVisible.collectAsStateWithLifecycle()
 
@@ -102,7 +102,7 @@ fun DeviceListDetail(
                 DrawerSheetContent(
                     coroutineScope = coroutineScope,
                     drawerState = drawerState,
-                    showHiddenDevices = showHiddenDevices,
+                    showSoundSync = showSoundSync,
                     viewModel = viewModel,
                     actions = actions,
                 )
@@ -126,6 +126,7 @@ fun DeviceListDetail(
                             actions = DeviceListActions(
                                 onItemClick = navigateToDetail,
                                 onAddDevice = { viewModel.showAddDeviceDialog() },
+                                onOpenSoundSync = actions.openSoundSync,
                                 onShowHiddenDevices = { viewModel.toggleShowHiddenDevices() },
                                 onRequestLocalNetworkAccess = localNetworkPermission.requestLocalNetworkAccess,
                                 onRefresh = { viewModel.startDiscoveryServiceTimed() },
@@ -191,12 +192,14 @@ private fun rememberSelectedDevice(
 private fun DrawerSheetContent(
     coroutineScope: CoroutineScope,
     drawerState: DrawerState,
-    showHiddenDevices: Boolean,
+    showSoundSync: Boolean,
     viewModel: DeviceListDetailViewModel,
     actions: DeviceListDetailActions,
 ) {
+    val showHiddenDevices by viewModel.showHiddenDevices.collectAsStateWithLifecycle()
     DrawerContent(
         showHiddenDevices = showHiddenDevices,
+        showSoundSync = showSoundSync,
         actions = DrawerActions(
             addDevice = {
                 coroutineScope.launch {

app/src/main/java/ca/cgagnier/wlednativeandroid/ui/homeScreen/DrawerContent.kt

@@ -33,15 +33,15 @@ import ca.cgagnier.wlednativeandroid.R
 import ca.cgagnier.wlednativeandroid.util.openUriSafely
 
 @Composable
-internal fun DrawerContent(showHiddenDevices: Boolean, actions: DrawerActions) {
+internal fun DrawerContent(showHiddenDevices: Boolean, showSoundSync: Boolean = false, actions: DrawerActions) {
     val uriHandler = LocalUriHandler.current
     val scrollState = rememberScrollState()
 
     Column(
         modifier = Modifier.verticalScroll(scrollState),
     ) {
         DrawerHeader()
-        DrawerMainActions(showHiddenDevices, actions)
+        DrawerMainActions(showHiddenDevices, showSoundSync, actions)
         HorizontalDivider(modifier = Modifier.padding(12.dp))
         DrawerExternalLinks(uriHandler)
         Spacer(Modifier.height(24.dp))
@@ -65,7 +65,7 @@ private fun DrawerHeader() {
 }
 
 @Composable
-private fun DrawerMainActions(showHiddenDevices: Boolean, actions: DrawerActions) {
+private fun DrawerMainActions(showHiddenDevices: Boolean, showSoundSync: Boolean, actions: DrawerActions) {
     NavigationDrawerItem(
         label = { Text(text = stringResource(R.string.add_a_device)) },
         icon = {
@@ -103,18 +103,20 @@ private fun DrawerMainActions(showHiddenDevices: Boolean, actions: DrawerActions
         onClick = actions.openSettings,
         modifier = Modifier.padding(NavigationDrawerItemDefaults.ItemPadding),
     )
-    NavigationDrawerItem(
-        label = { Text(text = stringResource(R.string.sound_sync)) },
-        icon = {
-            Icon(
-                painter = painterResource(id = R.drawable.baseline_graphic_eq_24),
-                contentDescription = stringResource(R.string.sound_sync),
-            )
-        },
-        selected = false,
-        onClick = actions.openSoundSync,
-        modifier = Modifier.padding(NavigationDrawerItemDefaults.ItemPadding),
-    )
+    if (showSoundSync) {
+        NavigationDrawerItem(
+            label = { Text(text = stringResource(R.string.sound_sync)) },
+            icon = {
+                Icon(
+                    painter = painterResource(id = R.drawable.baseline_graphic_eq_24),
+                    contentDescription = stringResource(R.string.sound_sync),
+                )
+            },
+            selected = false,
+            onClick = actions.openSoundSync,
+            modifier = Modifier.padding(NavigationDrawerItemDefaults.ItemPadding),
+        )
+    }
 }
 
 @Composable

app/src/main/java/ca/cgagnier/wlednativeandroid/ui/homeScreen/list/DeviceList.kt

@@ -20,6 +20,7 @@ import androidx.compose.material3.Card
 import androidx.compose.material3.CenterAlignedTopAppBar
 import androidx.compose.material3.Icon
 import androidx.compose.material3.IconButton
+import androidx.compose.material3.LocalContentColor
 import androidx.compose.material3.MaterialTheme
 import androidx.compose.material3.Scaffold
 import androidx.compose.material3.SwipeToDismissBoxValue
@@ -65,6 +66,8 @@ data class DeviceListState(
     val isLocalNetworkDenied: Boolean = false,
     val showOfflineDevicesLast: Boolean = true,
     val showHiddenDevices: Boolean = false,
+    val showSoundSync: Boolean = false,
+    val isSoundSyncRunning: Boolean = false,
     val isInitialLoading: Boolean = false,
     val currentTime: Long = 0L,
 )
@@ -73,6 +76,7 @@ data class DeviceListActions(
     val onItemClick: (DeviceWithState) -> Unit = {},
     val onItemEdit: (DeviceWithState) -> Unit = {},
     val onAddDevice: () -> Unit = {},
+    val onOpenSoundSync: () -> Unit = {},
     val onShowHiddenDevices: () -> Unit = {},
     val onRequestLocalNetworkAccess: () -> Unit = {},
     val onRefresh: () -> Unit = {},
@@ -93,6 +97,8 @@ fun DeviceList(
     val allDevices by viewModel.allDevicesWithState.collectAsStateWithLifecycle()
     val showOfflineDevicesLast by viewModel.showOfflineDevicesLast.collectAsStateWithLifecycle()
     val showHiddenDevices by viewModel.showHiddenDevices.collectAsStateWithLifecycle()
+    val showSoundSync by viewModel.soundSyncBetaEnabled.collectAsStateWithLifecycle()
+    val isSoundSyncRunning by viewModel.isSoundSyncRunning.collectAsStateWithLifecycle()
 
     var isInitialLoading by rememberSaveable { mutableStateOf(true) }
 
@@ -123,6 +129,8 @@ fun DeviceList(
             isLocalNetworkDenied = isLocalNetworkDenied,
             showOfflineDevicesLast = showOfflineDevicesLast,
             showHiddenDevices = showHiddenDevices,
+            showSoundSync = showSoundSync,
+            isSoundSyncRunning = isSoundSyncRunning,
             isInitialLoading = isInitialLoading,
             currentTime = currentTime,
         ),
@@ -167,8 +175,8 @@ fun DeviceListContent(state: DeviceListState, actions: DeviceListActions = Devic
     Scaffold(
         topBar = {
             DeviceListAppBar(
-                onOpenDrawer = actions.onOpenDrawer,
-                onAddDevice = actions.onAddDevice,
+                state = state,
+                actions = actions,
             )
         },
     ) { innerPadding ->
@@ -412,21 +420,34 @@ fun LazyItemScope.DeviceRow(
 }
 
 @Composable
-fun DeviceListAppBar(modifier: Modifier = Modifier, onOpenDrawer: () -> Unit, onAddDevice: () -> Unit) {
+fun DeviceListAppBar(state: DeviceListState, actions: DeviceListActions, modifier: Modifier = Modifier) {
     CenterAlignedTopAppBar(modifier = modifier, title = {
         Image(
             painter = painterResource(id = R.drawable.wled_logo_akemi),
             contentDescription = stringResource(R.string.app_logo),
         )
     }, navigationIcon = {
-        IconButton(onClick = onOpenDrawer) {
+        IconButton(onClick = actions.onOpenDrawer) {
             Icon(
                 imageVector = Icons.Filled.Menu,
                 contentDescription = stringResource(R.string.description_menu_button),
             )
         }
     }, actions = {
-        IconButton(onClick = onAddDevice) {
+        if (state.showSoundSync) {
+            IconButton(onClick = actions.onOpenSoundSync) {
+                Icon(
+                    painter = painterResource(id = R.drawable.baseline_graphic_eq_24),
+                    contentDescription = stringResource(R.string.sound_sync),
+                    tint = if (state.isSoundSyncRunning) {
+                        MaterialTheme.colorScheme.primary
+                    } else {
+                        LocalContentColor.current
+                    },
+                )
+            }
+        }
+        IconButton(onClick = actions.onAddDevice) {
             Icon(
                 imageVector = Icons.Filled.Add,
                 contentDescription = stringResource(R.string.add_a_device),

app/src/main/java/ca/cgagnier/wlednativeandroid/ui/homeScreen/list/DeviceWebsocketListViewModel.kt

@@ -5,9 +5,11 @@ import androidx.lifecycle.viewModelScope
 import ca.cgagnier.wlednativeandroid.model.Device
 import ca.cgagnier.wlednativeandroid.repository.UserPreferencesRepository
 import ca.cgagnier.wlednativeandroid.service.DeviceConnectionManager
+import ca.cgagnier.wlednativeandroid.service.soundsync.SoundSyncManager
 import ca.cgagnier.wlednativeandroid.service.websocket.DeviceWithState
 import kotlinx.coroutines.flow.SharingStarted
 import kotlinx.coroutines.flow.StateFlow
+import kotlinx.coroutines.flow.map
 import kotlinx.coroutines.flow.stateIn
 import kotlinx.coroutines.launch
 
@@ -20,6 +22,7 @@ private const val SUBSCRIPTION_TIMEOUT_MS = 5000L
 class DeviceWebsocketListViewModel(
     userPreferencesRepository: UserPreferencesRepository,
     private val deviceConnectionManager: DeviceConnectionManager,
+    soundSyncManager: SoundSyncManager,
 ) : ViewModel() {
 
     val allDevicesWithState: StateFlow<List<DeviceWithState>> =
@@ -39,6 +42,22 @@ class DeviceWebsocketListViewModel(
             initialValue = false,
         )
 
+    val soundSyncBetaEnabled: StateFlow<Boolean> =
+        userPreferencesRepository.soundSyncBetaEnabled.stateIn(
+            scope = viewModelScope,
+            started = SharingStarted.WhileSubscribed(SUBSCRIPTION_TIMEOUT_MS),
+            initialValue = false,
+        )
+
+    val isSoundSyncRunning: StateFlow<Boolean> =
+        soundSyncManager.state
+            .map { it.isRunning }
+            .stateIn(
+                scope = viewModelScope,
+                started = SharingStarted.WhileSubscribed(SUBSCRIPTION_TIMEOUT_MS),
+                initialValue = soundSyncManager.state.value.isRunning,
+            )
+
     val isPaused: StateFlow<Boolean> = deviceConnectionManager.isPaused
 
     fun setBrightness(device: DeviceWithState, brightness: Int) {

app/src/main/java/ca/cgagnier/wlednativeandroid/ui/settingsScreen/Settings.kt

@@ -44,6 +44,7 @@ fun Settings(navigateUp: () -> Unit, viewModel: SettingsViewModel = koinViewMode
             setAutoDiscover = { viewModel.setAutoDiscover(it) },
             setShowOfflineDevicesLast = { viewModel.setShowOfflineDevicesLast(it) },
             setTheme = { viewModel.setTheme(it) },
+            setSoundSyncBetaEnabled = { viewModel.setSoundSyncBetaEnabled(it) },
         )
     }
     SettingsContent(
@@ -63,6 +64,7 @@ data class SettingsActions(
     val setAutoDiscover: (Boolean) -> Unit = {},
     val setShowOfflineDevicesLast: (Boolean) -> Unit = {},
     val setTheme: (ThemeSettings) -> Unit = {},
+    val setSoundSyncBetaEnabled: (Boolean) -> Unit = {},
 )
 
 @Composable
@@ -106,6 +108,10 @@ fun SettingsContent(
                         currentTheme = settingsState.theme,
                         setTheme = actions.setTheme,
                     )
+                    BetaOptions(
+                        isSoundSyncBetaEnabled = settingsState.isSoundSyncBetaEnabled,
+                        setSoundSyncBetaEnabled = actions.setSoundSyncBetaEnabled,
+                    )
                 },
             )
         }
@@ -232,6 +238,25 @@ fun ThemeOptions(currentTheme: ThemeSettings, setTheme: (ThemeSettings) -> Unit
     }
 }
 
+@Composable
+fun BetaOptions(isSoundSyncBetaEnabled: Boolean, setSoundSyncBetaEnabled: (Boolean) -> Unit = {}) {
+    Card(modifier = Modifier.padding(horizontal = 16.dp, vertical = 8.dp)) {
+        Column(modifier = Modifier.padding(12.dp)) {
+            Text(
+                stringResource(R.string.beta_features),
+                style = MaterialTheme.typography.labelLarge,
+                color = MaterialTheme.colorScheme.primary,
+            )
+            SwitchRow(
+                label = stringResource(R.string.sound_sync_beta_setting),
+                checked = isSoundSyncBetaEnabled,
+                onCheckedChange = setSoundSyncBetaEnabled,
+                description = stringResource(R.string.sound_sync_beta_setting_description),
+            )
+        }
+    }
+}
+
 @Composable
 fun OneOrTwoColumnLayout(
     modifier: Modifier = Modifier,

app/src/main/java/ca/cgagnier/wlednativeandroid/ui/settingsScreen/SettingsViewModel.kt

@@ -5,45 +5,64 @@ import androidx.lifecycle.ViewModel
 import androidx.lifecycle.viewModelScope
 import ca.cgagnier.wlednativeandroid.repository.ThemeSettings
 import ca.cgagnier.wlednativeandroid.repository.UserPreferencesRepository
+import ca.cgagnier.wlednativeandroid.service.soundsync.SoundSyncManager
+import kotlinx.coroutines.CoroutineDispatcher
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.flow.SharingStarted.Companion.WhileSubscribed
 import kotlinx.coroutines.flow.combine
 import kotlinx.coroutines.flow.stateIn
 import kotlinx.coroutines.launch
 
-class SettingsViewModel(private val preferencesRepository: UserPreferencesRepository) : ViewModel() {
+private const val STATE_FLOW_TIMEOUT_MS = 5000L
+
+class SettingsViewModel(
+    private val preferencesRepository: UserPreferencesRepository,
+    private val soundSyncManager: SoundSyncManager,
+    private val ioDispatcher: CoroutineDispatcher = Dispatchers.IO,
+) : ViewModel() {
 
     private val theme = preferencesRepository.themeMode
     private val autoDiscovery = preferencesRepository.autoDiscovery
     private val showOfflineDevicesLast = preferencesRepository.showOfflineDevicesLast
     private val showHiddenDevices = preferencesRepository.showHiddenDevices
+    private val soundSyncBetaEnabled = preferencesRepository.soundSyncBetaEnabled
 
     val settingsState = combine(
         autoDiscovery,
         showOfflineDevicesLast,
         showHiddenDevices,
         theme,
-    ) { autoDiscovery, showOfflineDevicesLast, showHiddenDevices, theme ->
+        soundSyncBetaEnabled,
+    ) { autoDiscovery, showOfflineDevicesLast, showHiddenDevices, theme, soundSyncBetaEnabled ->
         SettingsState(
             isAutoDiscoveryEnabled = autoDiscovery,
             showOfflineLast = showOfflineDevicesLast,
             showHiddenDevices = showHiddenDevices,
             theme = theme,
+            isSoundSyncBetaEnabled = soundSyncBetaEnabled,
         )
-    }.stateIn(viewModelScope, WhileSubscribed(5000), SettingsState())
+    }.stateIn(viewModelScope, WhileSubscribed(STATE_FLOW_TIMEOUT_MS), SettingsState())
 
-    fun setAutoDiscover(enabled: Boolean) = viewModelScope.launch(Dispatchers.IO) {
+    fun setAutoDiscover(enabled: Boolean) = viewModelScope.launch(ioDispatcher) {
         preferencesRepository.updateAutoDiscovery(enabled)
     }
-    fun setShowOfflineDevicesLast(enabled: Boolean) = viewModelScope.launch(Dispatchers.IO) {
+    fun setShowOfflineDevicesLast(enabled: Boolean) = viewModelScope.launch(ioDispatcher) {
         preferencesRepository.updateShowOfflineDeviceLast(enabled)
     }
-    fun setShowHiddenDevices(enabled: Boolean) = viewModelScope.launch(Dispatchers.IO) {
+    fun setShowHiddenDevices(enabled: Boolean) = viewModelScope.launch(ioDispatcher) {
         preferencesRepository.updateShowHiddenDevices(enabled)
     }
-    fun setTheme(theme: ThemeSettings) = viewModelScope.launch(Dispatchers.IO) {
+    fun setTheme(theme: ThemeSettings) = viewModelScope.launch(ioDispatcher) {
         preferencesRepository.updateThemeMode(theme)
     }
+    fun setSoundSyncBetaEnabled(enabled: Boolean) {
+        if (!enabled) {
+            soundSyncManager.stop()
+        }
+        viewModelScope.launch(ioDispatcher) {
+            preferencesRepository.updateSoundSyncBetaEnabled(enabled)
+        }
+    }
 }
 
 @Stable
@@ -52,4 +71,5 @@ data class SettingsState(
     val showOfflineLast: Boolean = true,
     val showHiddenDevices: Boolean = false,
     val theme: ThemeSettings = ThemeSettings.Auto,
+    val isSoundSyncBetaEnabled: Boolean = false,
 )