Bluetooth-assisted Push to Talk (PTT) via Element Call

matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/widgets/model/WidgetType.kt

@@ -28,7 +28,8 @@ private val DEFINED_TYPES by lazy {
             WidgetType.StickerPicker,
             WidgetType.Grafana,
             WidgetType.Custom,
-            WidgetType.IntegrationManager
+            WidgetType.IntegrationManager,
+            WidgetType.ElementCall
     )
 }
 
@@ -47,6 +48,7 @@ sealed class WidgetType(open val preferred: String, open val legacy: String = pr
     object Grafana : WidgetType("m.grafana")
     object Custom : WidgetType("m.custom")
     object IntegrationManager : WidgetType("m.integration_manager")
+    object ElementCall : WidgetType("io.element.call")
     data class Fallback(override val preferred: String) : WidgetType(preferred)
 
     fun matches(type: String): Boolean {

vector/src/main/AndroidManifest.xml

@@ -7,7 +7,13 @@
     <uses-permission
         android:name="android.permission.BLUETOOTH"
         android:maxSdkVersion="30" />
+    <uses-permission
+        android:name="android.permission.BLUETOOTH_ADMIN"
+        android:maxSdkVersion="30"/>
     <uses-permission android:name="android.permission.BLUETOOTH_CONNECT" />
+    <uses-permission android:name="android.permission.BLUETOOTH_SCAN"
+        android:usesPermissionFlags="neverForLocation"
+        tools:targetApi="s" />
     <uses-permission android:name="android.permission.INTERNET" />
     <uses-permission android:name="android.permission.READ_CONTACTS" />
     <uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
@@ -308,7 +314,8 @@
         <activity android:name=".features.terms.ReviewTermsActivity" />
         <activity
             android:name=".features.widgets.WidgetActivity"
-            android:configChanges="screenSize|smallestScreenSize|screenLayout|orientation" />
+            android:configChanges="screenSize|smallestScreenSize|screenLayout|orientation"
+            android:supportsPictureInPicture="true" />
 
         <activity android:name=".features.pin.PinActivity" />
         <activity android:name=".features.analytics.ui.consent.AnalyticsOptInActivity" />
@@ -385,6 +392,10 @@
             android:foregroundServiceType="mediaProjection"
             tools:targetApi="Q" />
 
+        <service
+            android:name=".features.widgets.ptt.BluetoothLowEnergyService"
+            android:exported="false" />
+
         <!-- Receivers -->
 
         <receiver

vector/src/main/java/im/vector/app/core/utils/PermissionsTools.kt

@@ -19,6 +19,8 @@ package im.vector.app.core.utils
 import android.Manifest
 import android.app.Activity
 import android.content.pm.PackageManager
+import android.os.Build
+import android.webkit.PermissionRequest
 import androidx.activity.ComponentActivity
 import androidx.activity.result.ActivityResultLauncher
 import androidx.activity.result.contract.ActivityResultContracts
@@ -43,6 +45,33 @@ val PERMISSIONS_FOR_WRITING_FILES = listOf(Manifest.permission.WRITE_EXTERNAL_ST
 val PERMISSIONS_FOR_PICKING_CONTACT = listOf(Manifest.permission.READ_CONTACTS)
 val PERMISSIONS_FOR_FOREGROUND_LOCATION_SHARING = listOf(Manifest.permission.ACCESS_COARSE_LOCATION, Manifest.permission.ACCESS_FINE_LOCATION)
 
+// See https://developer.android.com/guide/topics/connectivity/bluetooth/permissions
+val PERMISSIONS_FOR_BLUETOOTH = when {
+    Build.VERSION.SDK_INT >= Build.VERSION_CODES.S -> {
+        listOf(
+                Manifest.permission.BLUETOOTH_SCAN,
+                Manifest.permission.BLUETOOTH_CONNECT,
+                Manifest.permission.ACCESS_COARSE_LOCATION,
+                Manifest.permission.ACCESS_FINE_LOCATION,
+        )
+    }
+    Build.VERSION.SDK_INT >= Build.VERSION_CODES.Q -> {
+        listOf(
+                Manifest.permission.BLUETOOTH,
+                Manifest.permission.BLUETOOTH_ADMIN,
+                Manifest.permission.ACCESS_COARSE_LOCATION,
+                Manifest.permission.ACCESS_FINE_LOCATION,
+        )
+    }
+    else -> {
+        listOf(
+                Manifest.permission.BLUETOOTH,
+                Manifest.permission.BLUETOOTH_ADMIN,
+                Manifest.permission.ACCESS_COARSE_LOCATION,
+        )
+    }
+}
+
 // This is not ideal to store the value like that, but it works
 private var permissionDialogDisplayed = false
 
@@ -137,6 +166,32 @@ fun checkPermissions(
     }
 }
 
+/**
+ * Checks if required WebView permissions are already granted system level.
+ * @param activity the calling Activity that is requesting the permissions (or fragment parent)
+ * @param request WebView permission request of onPermissionRequest function
+ * @return true if WebView permissions are already granted, false otherwise
+ */
+fun checkWebViewPermissions(activity: Activity, request: PermissionRequest): Boolean {
+    return request.resources.all {
+        when (it) {
+            PermissionRequest.RESOURCE_AUDIO_CAPTURE -> {
+                PERMISSIONS_FOR_AUDIO_IP_CALL.all { permission ->
+                    ContextCompat.checkSelfPermission(activity.applicationContext, permission) == PackageManager.PERMISSION_GRANTED
+                }
+            }
+            PermissionRequest.RESOURCE_VIDEO_CAPTURE -> {
+                PERMISSIONS_FOR_VIDEO_IP_CALL.all { permission ->
+                    ContextCompat.checkSelfPermission(activity.applicationContext, permission) == PackageManager.PERMISSION_GRANTED
+                }
+            }
+            else -> {
+                false
+            }
+        }
+    }
+}
+
 /**
  * To be call after the permission request.
  *

vector/src/main/java/im/vector/app/features/home/room/detail/RoomDetailViewEvents.kt

@@ -86,4 +86,6 @@ sealed class RoomDetailViewEvents : VectorViewEvents {
     object RoomReplacementStarted : RoomDetailViewEvents()
 
     data class ChangeLocationIndicator(val isVisible: Boolean) : RoomDetailViewEvents()
+
+    object OpenElementCallWidget : RoomDetailViewEvents()
 }

vector/src/main/java/im/vector/app/features/home/room/detail/RoomDetailViewState.kt

@@ -100,6 +100,8 @@ data class RoomDetailViewState(
     // It can differs for a short period of time on the JitsiState as its computed async.
     fun hasActiveJitsiWidget() = activeRoomWidgets()?.any { it.type == WidgetType.Jitsi && it.isActive }.orFalse()
 
+    fun hasActiveElementCallWidget() = activeRoomWidgets()?.any { it.type == WidgetType.ElementCall && it.isActive }.orFalse()
+
     fun isDm() = asyncRoomSummary()?.isDirect == true
 
     fun isThreadTimeline() = rootThreadEventId != null

vector/src/main/java/im/vector/app/features/home/room/detail/TimelineFragment.kt

@@ -495,6 +495,7 @@ class TimelineFragment @Inject constructor(
                 is RoomDetailViewEvents.DisplayAndAcceptCall -> acceptIncomingCall(it)
                 RoomDetailViewEvents.RoomReplacementStarted -> handleRoomReplacement()
                 is RoomDetailViewEvents.ChangeLocationIndicator -> handleChangeLocationIndicator(it)
+                RoomDetailViewEvents.OpenElementCallWidget -> handleOpenElementCallWidget()
             }
         }
 
@@ -1099,7 +1100,17 @@ class TimelineFragment @Inject constructor(
             val matrixAppsMenuItem = menu.findItem(R.id.open_matrix_apps)
             val widgetsCount = state.activeRoomWidgets.invoke()?.size ?: 0
             val hasOnlyJitsiWidget = widgetsCount == 1 && state.hasActiveJitsiWidget()
-            if (widgetsCount == 0 || hasOnlyJitsiWidget) {
+            val hasOnlyElementCallWidget = widgetsCount == 1 && state.hasActiveElementCallWidget()
+            if (hasOnlyElementCallWidget) {
+                val actionView = matrixAppsMenuItem.actionView
+                actionView.findViewById<TextView>(R.id.cart_badge).isVisible = false
+                actionView
+                        .findViewById<ImageView>(R.id.action_view_icon_image)
+                        .apply {
+                            setImageResource(R.drawable.ic_phone)
+                            setColorFilter(ThemeUtils.getColor(requireContext(), R.attr.colorPrimary))
+                        }
+            } else if (widgetsCount == 0 || hasOnlyJitsiWidget) {
                 // icon should be default color no badge
                 val actionView = matrixAppsMenuItem.actionView
                 actionView
@@ -2638,6 +2649,15 @@ class TimelineFragment @Inject constructor(
                 .show(childFragmentManager, "ROOM_WIDGETS_BOTTOM_SHEET")
     }
 
+    private fun handleOpenElementCallWidget() = withState(timelineViewModel) { state ->
+        state
+                .activeRoomWidgets()
+                ?.find { it.type == WidgetType.ElementCall }
+                ?.also { widget ->
+                    navigator.openRoomWidget(requireContext(), state.roomId, widget)
+                }
+    }
+
     override fun onTapToReturnToCall() {
         callManager.getCurrentCall()?.let { call ->
             VectorCallActivity.newIntent(

vector/src/main/java/im/vector/app/features/home/room/detail/TimelineViewModel.kt

@@ -576,7 +576,10 @@ class TimelineViewModel @AssistedInject constructor(
     }
 
     private fun handleManageIntegrations() = withState { state ->
-        if (state.activeRoomWidgets().isNullOrEmpty()) {
+        val isOnlyElementCallWidget = state.activeRoomWidgets()?.size == 1 && state.hasActiveElementCallWidget()
+        if (isOnlyElementCallWidget) {
+            _viewEvents.post(RoomDetailViewEvents.OpenElementCallWidget)
+        } else if (state.activeRoomWidgets().isNullOrEmpty()) {
             // Directly open integration manager screen
             handleOpenIntegrationManager()
         } else {

vector/src/main/java/im/vector/app/features/navigation/DefaultNavigator.kt

@@ -516,6 +516,9 @@ class DefaultNavigator @Inject constructor(
                 val enableVideo = options?.get(JitsiCallViewModel.ENABLE_VIDEO_OPTION) == true
                 context.startActivity(VectorJitsiActivity.newIntent(context, roomId = roomId, widgetId = widget.widgetId, enableVideo = enableVideo))
             }
+        } else if (widget.type is WidgetType.ElementCall) {
+            val widgetArgs = widgetArgsBuilder.buildElementCallWidgetArgs(roomId, widget)
+            context.startActivity(WidgetActivity.newIntent(context, widgetArgs))
         } else {
             val widgetArgs = widgetArgsBuilder.buildRoomWidgetArgs(roomId, widget)
             context.startActivity(WidgetActivity.newIntent(context, widgetArgs))

vector/src/main/java/im/vector/app/features/notifications/NotificationUtils.kt

@@ -552,6 +552,19 @@ class NotificationUtils @Inject constructor(
                 .build()
     }
 
+    /**
+     * Creates a notification that indicates the application is communicating with a BLE device mainly for push-to-talk in Element Call Widget.
+     */
+    fun buildBluetoothLowEnergyNotification(): Notification {
+        return NotificationCompat.Builder(context, SILENT_NOTIFICATION_CHANNEL_ID)
+                .setContentTitle(stringProvider.getString(R.string.push_to_talk_notification_title))
+                .setContentText(stringProvider.getString(R.string.push_to_talk_notification_description))
+                .setSmallIcon(R.drawable.quantum_ic_bluetooth_audio_white_36)
+                .setColor(ThemeUtils.getColor(context, android.R.attr.colorPrimary))
+                .setContentIntent(buildOpenHomePendingIntentForSummary())
+                .build()
+    }
+
     /**
      * Creates a notification that indicates the application is capturing the screen.
      */

vector/src/main/java/im/vector/app/features/widgets/WidgetAction.kt

@@ -16,6 +16,7 @@
 
 package im.vector.app.features.widgets
 
+import android.bluetooth.BluetoothDevice
 import im.vector.app.core.platform.VectorViewModelAction
 
 sealed class WidgetAction : VectorViewModelAction {
@@ -26,4 +27,5 @@ sealed class WidgetAction : VectorViewModelAction {
     object DeleteWidget : WidgetAction()
     object RevokeWidget : WidgetAction()
     object OnTermsReviewed : WidgetAction()
+    data class ConnectToBluetoothDevice(val device: BluetoothDevice) : WidgetAction()
 }

vector/src/main/java/im/vector/app/features/widgets/WidgetActivity.kt

@@ -17,8 +17,11 @@
 package im.vector.app.features.widgets
 
 import android.app.Activity
+import android.app.PictureInPictureParams
 import android.content.Context
 import android.content.Intent
+import android.os.Build
+import android.util.Rational
 import androidx.core.view.isVisible
 import com.airbnb.mvrx.Mavericks
 import com.airbnb.mvrx.viewModel
@@ -84,29 +87,36 @@ class WidgetActivity : VectorBaseActivity<ActivityWidgetBinding>() {
             }
         }
 
-        permissionViewModel.observeViewEvents {
-            when (it) {
-                is RoomWidgetPermissionViewEvents.Close -> finish()
+        // Trust element call widget by default
+        if (widgetArgs.kind == WidgetKind.ELEMENT_CALL) {
+            if (supportFragmentManager.findFragmentByTag(WIDGET_FRAGMENT_TAG) == null) {
+                addFragment(views.fragmentContainer, WidgetFragment::class.java, widgetArgs, WIDGET_FRAGMENT_TAG)
             }
-        }
-
-        viewModel.onEach(WidgetViewState::status) { ws ->
-            when (ws) {
-                WidgetStatus.UNKNOWN -> {
+        } else {
+            permissionViewModel.observeViewEvents {
+                when (it) {
+                    is RoomWidgetPermissionViewEvents.Close -> finish()
                 }
-                WidgetStatus.WIDGET_NOT_ALLOWED -> {
-                    val dFrag = supportFragmentManager.findFragmentByTag(WIDGET_PERMISSION_FRAGMENT_TAG) as? RoomWidgetPermissionBottomSheet
-                    if (dFrag != null && dFrag.dialog?.isShowing == true && !dFrag.isRemoving) {
-                        return@onEach
-                    } else {
-                        RoomWidgetPermissionBottomSheet
-                                .newInstance(widgetArgs)
-                                .show(supportFragmentManager, WIDGET_PERMISSION_FRAGMENT_TAG)
+            }
+
+            viewModel.onEach(WidgetViewState::status) { ws ->
+                when (ws) {
+                    WidgetStatus.UNKNOWN -> {
                     }
-                }
-                WidgetStatus.WIDGET_ALLOWED -> {
-                    if (supportFragmentManager.findFragmentByTag(WIDGET_FRAGMENT_TAG) == null) {
-                        addFragment(views.fragmentContainer, WidgetFragment::class.java, widgetArgs, WIDGET_FRAGMENT_TAG)
+                    WidgetStatus.WIDGET_NOT_ALLOWED -> {
+                        val dFrag = supportFragmentManager.findFragmentByTag(WIDGET_PERMISSION_FRAGMENT_TAG) as? RoomWidgetPermissionBottomSheet
+                        if (dFrag != null && dFrag.dialog?.isShowing == true && !dFrag.isRemoving) {
+                            return@onEach
+                        } else {
+                            RoomWidgetPermissionBottomSheet
+                                    .newInstance(widgetArgs)
+                                    .show(supportFragmentManager, WIDGET_PERMISSION_FRAGMENT_TAG)
+                        }
+                    }
+                    WidgetStatus.WIDGET_ALLOWED -> {
+                        if (supportFragmentManager.findFragmentByTag(WIDGET_FRAGMENT_TAG) == null) {
+                            addFragment(views.fragmentContainer, WidgetFragment::class.java, widgetArgs, WIDGET_FRAGMENT_TAG)
+                        }
                     }
                 }
             }
@@ -121,6 +131,24 @@ class WidgetActivity : VectorBaseActivity<ActivityWidgetBinding>() {
         }
     }
 
+    override fun onUserLeaveHint() {
+        super.onUserLeaveHint()
+        val widgetArgs: WidgetArgs? = intent?.extras?.getParcelable(Mavericks.KEY_ARG)
+        if (widgetArgs?.kind == WidgetKind.ELEMENT_CALL) {
+            enterPictureInPicture()
+        }
+    }
+
+    private fun enterPictureInPicture() {
+        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
+            val aspectRatio = Rational(resources.getDimensionPixelSize(R.dimen.call_pip_width), resources.getDimensionPixelSize(R.dimen.call_pip_height))
+            val params = PictureInPictureParams.Builder()
+                    .setAspectRatio(aspectRatio)
+                    .build()
+            enterPictureInPictureMode(params)
+        }
+    }
+
     private fun handleClose(event: WidgetViewEvents.Close) {
         if (event.content != null) {
             val intent = createResultIntent(event.content)

vector/src/main/java/im/vector/app/features/widgets/WidgetArgsBuilder.kt

@@ -78,6 +78,13 @@ class WidgetArgsBuilder @Inject constructor(
         )
     }
 
+    fun buildElementCallWidgetArgs(roomId: String, widget: Widget): WidgetArgs {
+        return buildRoomWidgetArgs(roomId, widget)
+                .copy(
+                        kind = WidgetKind.ELEMENT_CALL
+                )
+    }
+
     @Suppress("UNCHECKED_CAST")
     private fun Map<String, String?>.filterNotNull(): Map<String, String> {
         return filterValues { it != null } as Map<String, String>