/*
* Copyright 2020 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 androidx.wear.watchface.client
import android.content.ComponentName
import android.content.Context
import android.content.Intent
import android.content.ServiceConnection
import android.os.IBinder
import androidx.annotation.Px
import androidx.wear.complications.DefaultComplicationProviderPolicy
import androidx.wear.complications.data.ComplicationData
import androidx.wear.complications.data.ComplicationType
import androidx.wear.utility.AsyncTraceEvent
import androidx.wear.utility.TraceEvent
import androidx.wear.watchface.control.IInteractiveWatchFace
import androidx.wear.watchface.control.IPendingInteractiveWatchFace
import androidx.wear.watchface.control.IWatchFaceControlService
import androidx.wear.watchface.control.WatchFaceControlService
import androidx.wear.watchface.control.data.CrashInfoParcel
import androidx.wear.watchface.control.data.DefaultProviderPoliciesParams
import androidx.wear.watchface.control.data.HeadlessWatchFaceInstanceParams
import androidx.wear.watchface.control.data.WallpaperInteractiveWatchFaceInstanceParams
import androidx.wear.watchface.data.IdAndComplicationDataWireFormat
import androidx.wear.watchface.data.WatchUiState
import androidx.wear.watchface.style.UserStyle
import androidx.wear.watchface.style.UserStyleData
import androidx.wear.watchface.style.data.UserStyleWireFormat
import kotlinx.coroutines.CompletableDeferred
import kotlin.coroutines.resume
import kotlin.coroutines.resumeWithException
import kotlin.coroutines.suspendCoroutine
/**
* Connects to a watch face's WatchFaceControlService which allows the user to control the watch
* face.
*/
public interface WatchFaceControlClient : AutoCloseable {
public companion object {
/**
* Constructs a [WatchFaceControlClient] which attempts to connect to a watch face in the
* android package [watchFacePackageName].
*
* @param context Calling application's [Context].
* @param watchFacePackageName The name of the package containing the watch face control
* service to bind to.
* @return The [WatchFaceControlClient] if there is one.
* @throws [ServiceNotBoundException] if the watch face control service can not be bound or
* a [ServiceStartFailureException] if the watch face dies during startup.
*/
@JvmStatic
public suspend fun createWatchFaceControlClient(
context: Context,
watchFacePackageName: String
): WatchFaceControlClient = createWatchFaceControlClientImpl(
context,
Intent(WatchFaceControlService.ACTION_WATCHFACE_CONTROL_SERVICE).apply {
setPackage(watchFacePackageName)
}
)
internal suspend fun createWatchFaceControlClientImpl(
context: Context,
intent: Intent
): WatchFaceControlClient {
val deferredService = CompletableDeferred<IWatchFaceControlService>()
val traceEvent = AsyncTraceEvent("WatchFaceControlClientImpl.bindService")
val serviceConnection = object : ServiceConnection {
override fun onServiceConnected(name: ComponentName, binder: IBinder) {
traceEvent.close()
deferredService.complete(IWatchFaceControlService.Stub.asInterface(binder))
}
override fun onServiceDisconnected(name: ComponentName?) {
// Note if onServiceConnected is called first completeExceptionally will do
// nothing because the CompletableDeferred is already completed.
traceEvent.close()
deferredService.completeExceptionally(ServiceStartFailureException())
}
}
if (!context.bindService(
intent,
serviceConnection,
Context.BIND_AUTO_CREATE or Context.BIND_IMPORTANT
)
) {
traceEvent.close()
throw ServiceNotBoundException()
}
return WatchFaceControlClientImpl(
context,
deferredService.await(),
serviceConnection
)
}
}
/**
* Exception thrown by [createWatchFaceControlClient] if the remote service can't be bound.
*/
public class ServiceNotBoundException : Exception()
/** Exception thrown by [WatchFaceControlClient] methods if the service dies during start up. */
public class ServiceStartFailureException(message: String = "") : Exception(message)
/**
* Returns the [InteractiveWatchFaceClient] for the given instance id, or null if no such
* instance exists.
*
* When finished call [InteractiveWatchFaceClient.close] to release resources.
*
* @param instanceId The name of the interactive watch face instance to retrieve
* @return The [InteractiveWatchFaceClient] or `null` if [instanceId] is unrecognized, or
* [ServiceNotBoundException] if the WatchFaceControlService is not bound.
*/
public fun getInteractiveWatchFaceClientInstance(
instanceId: String
): InteractiveWatchFaceClient?
/**
* Creates a [HeadlessWatchFaceClient] with the specified [DeviceConfig]. Screenshots made with
* [HeadlessWatchFaceClient.renderWatchFaceToBitmap] will be `surfaceWidth` x `surfaceHeight` in
* size.
*
* When finished call [HeadlessWatchFaceClient.close] to release resources.
*
* @param watchFaceName The [ComponentName] of the watch face to create a headless instance for
* must be in the same APK the WatchFaceControlClient is connected to. NB a single apk can
* contain multiple watch faces.
* @param deviceConfig The hardware [DeviceConfig]
* @param surfaceWidth The width of screen shots taken by the [HeadlessWatchFaceClient]
* @param surfaceHeight The height of screen shots taken by the [HeadlessWatchFaceClient]
* @return The [HeadlessWatchFaceClient] or `null` if [watchFaceName] is unrecognized.
*/
public fun createHeadlessWatchFaceClient(
watchFaceName: ComponentName,
deviceConfig: DeviceConfig,
@Px surfaceWidth: Int,
@Px surfaceHeight: Int
): HeadlessWatchFaceClient?
/**
* Requests either an existing [InteractiveWatchFaceClient] with the specified [id] or
* schedules creation of an [InteractiveWatchFaceClient] for the next time the
* WallpaperService creates an engine.
*
* NOTE that currently only one [InteractiveWatchFaceClient] per process can exist at a time.
*
* @param id The ID for the requested [InteractiveWatchFaceClient].
* @param deviceConfig The [DeviceConfig] for the wearable.
* @param watchUiState The initial [WatchUiState] for the wearable.
* @param userStyle The initial style map encoded as [UserStyleData] (see [UserStyle]), or
* `null` if the default should be used.
* @param slotIdToComplicationData The initial [androidx.wear.watchface.ComplicationSlot] data,
* or `null` if unavailable.
* @return The [InteractiveWatchFaceClient], this should be closed when finished.
* @throws [ServiceStartFailureException] if the watchface dies during startup.
*/
public suspend fun getOrCreateInteractiveWatchFaceClient(
id: String,
deviceConfig: DeviceConfig,
watchUiState: androidx.wear.watchface.client.WatchUiState,
userStyle: UserStyleData?,
slotIdToComplicationData: Map<Int, ComplicationData>?
): InteractiveWatchFaceClient
public fun getEditorServiceClient(): EditorServiceClient
/**
* Returns a map of [androidx.wear.watchface.ComplicationSlot] id to the
* [DefaultComplicationProviderPolicyAndType] for each
* [androidx.wear.watchface.ComplicationSlot] in the watchface corresponding to [watchFaceName].
* Where possible a fast path is used that doesn't need to fully construct the corresponding
* watch face.
*
* @param watchFaceName The [ComponentName] of the watch face to obtain the map of
* [DefaultComplicationProviderPolicyAndType]s for. It must be in the same APK the
* WatchFaceControlClient is connected to. NB a single apk can contain multiple watch faces.
*/
public fun getDefaultComplicationProviderPoliciesAndType(
watchFaceName: ComponentName
): Map<Int, DefaultComplicationProviderPolicyAndType>
}
/**
* A pair of [DefaultComplicationProviderPolicy] and [ComplicationType] describing the default state
* of an [androidx.wear.watchface.ComplicationSlot].
*
* @param policy The [DefaultComplicationProviderPolicy] for the
* [androidx.wear.watchface.ComplicationSlot].
* @param type The default [ComplicationType] for the [androidx.wear.watchface.ComplicationSlot].
*/
public class DefaultComplicationProviderPolicyAndType(
public val policy: DefaultComplicationProviderPolicy,
public val type: ComplicationType
) {
override fun equals(other: Any?): Boolean {
if (this === other) return true
if (javaClass != other?.javaClass) return false
other as DefaultComplicationProviderPolicyAndType
if (policy != other.policy) return false
if (type != other.type) return false
return true
}
override fun hashCode(): Int {
var result = policy.hashCode()
result = 31 * result + type.hashCode()
return result
}
}
internal class WatchFaceControlClientImpl internal constructor(
private val context: Context,
private val service: IWatchFaceControlService,
private val serviceConnection: ServiceConnection
) : WatchFaceControlClient {
private var closed = false
override fun getInteractiveWatchFaceClientInstance(
instanceId: String
) = service.getInteractiveWatchFaceInstance(instanceId)?.let {
InteractiveWatchFaceClientImpl(it)
}
override fun createHeadlessWatchFaceClient(
watchFaceName: ComponentName,
deviceConfig: DeviceConfig,
surfaceWidth: Int,
surfaceHeight: Int
): HeadlessWatchFaceClient? = TraceEvent(
"WatchFaceControlClientImpl.createHeadlessWatchFaceClient"
).use {
requireNotClosed()
return service.createHeadlessWatchFaceInstance(
HeadlessWatchFaceInstanceParams(
watchFaceName,
androidx.wear.watchface.data.DeviceConfig(
deviceConfig.hasLowBitAmbient,
deviceConfig.hasBurnInProtection,
deviceConfig.analogPreviewReferenceTimeMillis,
deviceConfig.digitalPreviewReferenceTimeMillis
),
surfaceWidth,
surfaceHeight
)
)?.let {
HeadlessWatchFaceClientImpl(it)
}
}
override suspend fun getOrCreateInteractiveWatchFaceClient(
id: String,
deviceConfig: DeviceConfig,
watchUiState: androidx.wear.watchface.client.WatchUiState,
userStyle: UserStyleData?,
slotIdToComplicationData: Map<Int, ComplicationData>?
): InteractiveWatchFaceClient {
requireNotClosed()
val traceEvent = AsyncTraceEvent(
"WatchFaceControlClientImpl" +
".getOrCreateWallpaperServiceBackedInteractiveWatchFaceClientAsync"
)
return suspendCoroutine { continuation ->
// [IWatchFaceControlService.getOrCreateInteractiveWatchFaceWCS] has an asynchronous
// callback and it's possible the watch face might crash during start up so we register
// a death observer.
val deathObserver = IBinder.DeathRecipient {
continuation.resumeWithException(
WatchFaceControlClient.ServiceStartFailureException()
)
}
val serviceBinder = service.asBinder()
serviceBinder.linkToDeath(deathObserver, 0)
service.getOrCreateInteractiveWatchFace(
WallpaperInteractiveWatchFaceInstanceParams(
id,
androidx.wear.watchface.data.DeviceConfig(
deviceConfig.hasLowBitAmbient,
deviceConfig.hasBurnInProtection,
deviceConfig.analogPreviewReferenceTimeMillis,
deviceConfig.digitalPreviewReferenceTimeMillis
),
WatchUiState(
watchUiState.inAmbientMode,
watchUiState.interruptionFilter
),
userStyle?.toWireFormat() ?: UserStyleWireFormat(emptyMap()),
slotIdToComplicationData?.map {
IdAndComplicationDataWireFormat(
it.key,
it.value.asWireComplicationData()
)
}
),
object : IPendingInteractiveWatchFace.Stub() {
override fun getApiVersion() = IPendingInteractiveWatchFace.API_VERSION
override fun onInteractiveWatchFaceCreated(
iInteractiveWatchFace: IInteractiveWatchFace
) {
serviceBinder.unlinkToDeath(deathObserver, 0)
traceEvent.close()
continuation.resume(
InteractiveWatchFaceClientImpl(iInteractiveWatchFace)
)
}
override fun onInteractiveWatchFaceCrashed(exception: CrashInfoParcel) {
serviceBinder.unlinkToDeath(deathObserver, 0)
traceEvent.close()
continuation.resumeWithException(
WatchFaceControlClient.ServiceStartFailureException(
"Watchface crashed during init: $exception"
)
)
}
}
)?.let {
// There was an existing watchface.onInteractiveWatchFaceCreated
serviceBinder.unlinkToDeath(deathObserver, 0)
traceEvent.close()
continuation.resume(InteractiveWatchFaceClientImpl(it))
}
}
}
override fun getEditorServiceClient(): EditorServiceClient = TraceEvent(
"WatchFaceControlClientImpl.getEditorServiceClient"
).use {
requireNotClosed()
return EditorServiceClientImpl(service.editorService)
}
override fun getDefaultComplicationProviderPoliciesAndType(
watchFaceName: ComponentName
): Map<Int, DefaultComplicationProviderPolicyAndType> = TraceEvent(
"WatchFaceControlClientImpl.getDefaultProviderPolicies"
).use {
requireNotClosed()
if (service.apiVersion >= 2) {
// Fast path.
service.getDefaultProviderPolicies(DefaultProviderPoliciesParams(watchFaceName))
.associateBy(
{
it.id
},
{
DefaultComplicationProviderPolicyAndType(
DefaultComplicationProviderPolicy(
it.defaultProvidersToTry ?: emptyList(),
it.fallbackSystemProvider
),
ComplicationType.fromWireType(it.defaultProviderType)
)
}
)
} else {
// Slow backwards compatible path.
val headlessClient = createHeadlessWatchFaceClient(
watchFaceName,
DeviceConfig(false, false, 0, 0),
1,
1,
)!!
// NB .use {} syntax doesn't compile here.
try {
headlessClient.complicationSlotsState.mapValues {
DefaultComplicationProviderPolicyAndType(
it.value.defaultProviderPolicy,
it.value.defaultProviderType
)
}
} finally {
headlessClient.close()
}
}
}
private fun requireNotClosed() {
require(!closed) {
"WatchFaceControlClient method called after close"
}
}
override fun close() = TraceEvent("WatchFaceControlClientImpl.close").use {
closed = true
context.unbindService(serviceConnection)
}
}