File: mcp.py

package info (click to toggle)
python-bumble 0.0.225-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 9,464 kB
  • sloc: python: 75,258; java: 3,782; javascript: 823; xml: 203; sh: 172; makefile: 8
file content (451 lines) | stat: -rw-r--r-- 17,688 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
# Copyright 2021-2024 Google LLC
#
# 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
#
#      https://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.


# -----------------------------------------------------------------------------
# Imports
# -----------------------------------------------------------------------------
from __future__ import annotations

import asyncio
import dataclasses
import enum
import struct
from typing import TYPE_CHECKING, ClassVar

from typing_extensions import Self

from bumble import core, device, gatt, gatt_client, utils

# -----------------------------------------------------------------------------
# Constants
# -----------------------------------------------------------------------------


class PlayingOrder(utils.OpenIntEnum):
    '''See Media Control Service 3.15. Playing Order.'''

    SINGLE_ONCE = 0x01
    SINGLE_REPEAT = 0x02
    IN_ORDER_ONCE = 0x03
    IN_ORDER_REPEAT = 0x04
    OLDEST_ONCE = 0x05
    OLDEST_REPEAT = 0x06
    NEWEST_ONCE = 0x07
    NEWEST_REPEAT = 0x08
    SHUFFLE_ONCE = 0x09
    SHUFFLE_REPEAT = 0x0A


class PlayingOrderSupported(enum.IntFlag):
    '''See Media Control Service 3.16. Playing Orders Supported.'''

    SINGLE_ONCE = 0x0001
    SINGLE_REPEAT = 0x0002
    IN_ORDER_ONCE = 0x0004
    IN_ORDER_REPEAT = 0x0008
    OLDEST_ONCE = 0x0010
    OLDEST_REPEAT = 0x0020
    NEWEST_ONCE = 0x0040
    NEWEST_REPEAT = 0x0080
    SHUFFLE_ONCE = 0x0100
    SHUFFLE_REPEAT = 0x0200


class MediaState(utils.OpenIntEnum):
    '''See Media Control Service 3.17. Media State.'''

    INACTIVE = 0x00
    PLAYING = 0x01
    PAUSED = 0x02
    SEEKING = 0x03


class MediaControlPointOpcode(utils.OpenIntEnum):
    '''See Media Control Service 3.18. Media Control Point.'''

    PLAY = 0x01
    PAUSE = 0x02
    FAST_REWIND = 0x03
    FAST_FORWARD = 0x04
    STOP = 0x05
    MOVE_RELATIVE = 0x10
    PREVIOUS_SEGMENT = 0x20
    NEXT_SEGMENT = 0x21
    FIRST_SEGMENT = 0x22
    LAST_SEGMENT = 0x23
    GOTO_SEGMENT = 0x24
    PREVIOUS_TRACK = 0x30
    NEXT_TRACK = 0x31
    FIRST_TRACK = 0x32
    LAST_TRACK = 0x33
    GOTO_TRACK = 0x34
    PREVIOUS_GROUP = 0x40
    NEXT_GROUP = 0x41
    FIRST_GROUP = 0x42
    LAST_GROUP = 0x43
    GOTO_GROUP = 0x44


class MediaControlPointResultCode(enum.IntFlag):
    '''See Media Control Service 3.18.2. Media Control Point Notification.'''

    SUCCESS = 0x01
    OPCODE_NOT_SUPPORTED = 0x02
    MEDIA_PLAYER_INACTIVE = 0x03
    COMMAND_CANNOT_BE_COMPLETED = 0x04


class MediaControlPointOpcodeSupported(enum.IntFlag):
    '''See Media Control Service 3.19. Media Control Point Opcodes Supported.'''

    PLAY = 0x00000001
    PAUSE = 0x00000002
    FAST_REWIND = 0x00000004
    FAST_FORWARD = 0x00000008
    STOP = 0x00000010
    MOVE_RELATIVE = 0x00000020
    PREVIOUS_SEGMENT = 0x00000040
    NEXT_SEGMENT = 0x00000080
    FIRST_SEGMENT = 0x00000100
    LAST_SEGMENT = 0x00000200
    GOTO_SEGMENT = 0x00000400
    PREVIOUS_TRACK = 0x00000800
    NEXT_TRACK = 0x00001000
    FIRST_TRACK = 0x00002000
    LAST_TRACK = 0x00004000
    GOTO_TRACK = 0x00008000
    PREVIOUS_GROUP = 0x00010000
    NEXT_GROUP = 0x00020000
    FIRST_GROUP = 0x00040000
    LAST_GROUP = 0x00080000
    GOTO_GROUP = 0x00100000


class SearchControlPointItemType(utils.OpenIntEnum):
    '''See Media Control Service 3.20. Search Control Point.'''

    TRACK_NAME = 0x01
    ARTIST_NAME = 0x02
    ALBUM_NAME = 0x03
    GROUP_NAME = 0x04
    EARLIEST_YEAR = 0x05
    LATEST_YEAR = 0x06
    GENRE = 0x07
    ONLY_TRACKS = 0x08
    ONLY_GROUPS = 0x09


class ObjectType(utils.OpenIntEnum):
    '''See Media Control Service 4.4.1. Object Type field.'''

    TASK = 0
    GROUP = 1


# -----------------------------------------------------------------------------
# Classes
# -----------------------------------------------------------------------------


class ObjectId(int):
    '''See Media Control Service 4.4.2. Object ID field.'''

    @classmethod
    def create_from_bytes(cls: type[Self], data: bytes) -> Self:
        return cls(int.from_bytes(data, byteorder='little', signed=False))

    def __bytes__(self) -> bytes:
        return self.to_bytes(6, 'little')


@dataclasses.dataclass
class GroupObjectType:
    '''See Media Control Service 4.4. Group Object Type.'''

    object_type: ObjectType
    object_id: ObjectId

    @classmethod
    def from_bytes(cls: type[Self], data: bytes) -> Self:
        return cls(
            object_type=ObjectType(data[0]),
            object_id=ObjectId.create_from_bytes(data[1:]),
        )

    def __bytes__(self) -> bytes:
        return bytes([self.object_type]) + bytes(self.object_id)


# -----------------------------------------------------------------------------
# Server
# -----------------------------------------------------------------------------
class MediaControlService(gatt.TemplateService):
    '''Media Control Service server implementation, only for testing currently.'''

    UUID = gatt.GATT_MEDIA_CONTROL_SERVICE

    def __init__(self, media_player_name: str | None = None) -> None:
        self.track_position = 0

        self.media_player_name_characteristic = gatt.Characteristic(
            uuid=gatt.GATT_MEDIA_PLAYER_NAME_CHARACTERISTIC,
            properties=gatt.Characteristic.Properties.READ
            | gatt.Characteristic.Properties.NOTIFY,
            permissions=gatt.Characteristic.Permissions.READ_REQUIRES_ENCRYPTION,
            value=(media_player_name or 'Bumble Player').encode(),
        )
        self.track_changed_characteristic = gatt.Characteristic(
            uuid=gatt.GATT_TRACK_CHANGED_CHARACTERISTIC,
            properties=gatt.Characteristic.Properties.NOTIFY,
            permissions=gatt.Characteristic.Permissions.READ_REQUIRES_ENCRYPTION,
            value=b'',
        )
        self.track_title_characteristic = gatt.Characteristic(
            uuid=gatt.GATT_TRACK_TITLE_CHARACTERISTIC,
            properties=gatt.Characteristic.Properties.READ
            | gatt.Characteristic.Properties.NOTIFY,
            permissions=gatt.Characteristic.Permissions.READ_REQUIRES_ENCRYPTION,
            value=b'',
        )
        self.track_duration_characteristic = gatt.Characteristic(
            uuid=gatt.GATT_TRACK_DURATION_CHARACTERISTIC,
            properties=gatt.Characteristic.Properties.READ
            | gatt.Characteristic.Properties.NOTIFY,
            permissions=gatt.Characteristic.Permissions.READ_REQUIRES_ENCRYPTION,
            value=b'',
        )
        self.track_position_characteristic = gatt.Characteristic(
            uuid=gatt.GATT_TRACK_POSITION_CHARACTERISTIC,
            properties=gatt.Characteristic.Properties.READ
            | gatt.Characteristic.Properties.WRITE
            | gatt.Characteristic.Properties.WRITE_WITHOUT_RESPONSE
            | gatt.Characteristic.Properties.NOTIFY,
            permissions=gatt.Characteristic.Permissions.READ_REQUIRES_ENCRYPTION
            | gatt.Characteristic.Permissions.WRITE_REQUIRES_ENCRYPTION,
            value=b'',
        )
        self.media_state_characteristic = gatt.Characteristic(
            uuid=gatt.GATT_MEDIA_STATE_CHARACTERISTIC,
            properties=gatt.Characteristic.Properties.READ
            | gatt.Characteristic.Properties.NOTIFY,
            permissions=gatt.Characteristic.Permissions.READ_REQUIRES_ENCRYPTION,
            value=b'',
        )
        self.media_control_point_characteristic: gatt.Characteristic[bytes] = (
            gatt.Characteristic(
                uuid=gatt.GATT_MEDIA_CONTROL_POINT_CHARACTERISTIC,
                properties=gatt.Characteristic.Properties.WRITE
                | gatt.Characteristic.Properties.WRITE_WITHOUT_RESPONSE
                | gatt.Characteristic.Properties.NOTIFY,
                permissions=gatt.Characteristic.Permissions.READ_REQUIRES_ENCRYPTION
                | gatt.Characteristic.Permissions.WRITE_REQUIRES_ENCRYPTION,
                value=gatt.CharacteristicValue(write=self.on_media_control_point),
            )
        )
        self.media_control_point_opcodes_supported_characteristic = gatt.Characteristic(
            uuid=gatt.GATT_MEDIA_CONTROL_POINT_OPCODES_SUPPORTED_CHARACTERISTIC,
            properties=gatt.Characteristic.Properties.READ
            | gatt.Characteristic.Properties.NOTIFY,
            permissions=gatt.Characteristic.Permissions.READ_REQUIRES_ENCRYPTION,
            value=b'',
        )
        self.content_control_id_characteristic = gatt.Characteristic(
            uuid=gatt.GATT_CONTENT_CONTROL_ID_CHARACTERISTIC,
            properties=gatt.Characteristic.Properties.READ,
            permissions=gatt.Characteristic.Permissions.READ_REQUIRES_ENCRYPTION,
            value=b'',
        )

        super().__init__(
            [
                self.media_player_name_characteristic,
                self.track_changed_characteristic,
                self.track_title_characteristic,
                self.track_duration_characteristic,
                self.track_position_characteristic,
                self.media_state_characteristic,
                self.media_control_point_characteristic,
                self.media_control_point_opcodes_supported_characteristic,
                self.content_control_id_characteristic,
            ]
        )

    async def on_media_control_point(
        self, connection: device.Connection, data: bytes
    ) -> None:
        opcode = MediaControlPointOpcode(data[0])

        await connection.device.notify_subscriber(
            connection,
            self.media_control_point_characteristic,
            value=bytes([opcode, MediaControlPointResultCode.SUCCESS]),
        )


class GenericMediaControlService(MediaControlService):
    UUID = gatt.GATT_GENERIC_MEDIA_CONTROL_SERVICE


# -----------------------------------------------------------------------------
# Client
# -----------------------------------------------------------------------------
class MediaControlServiceProxy(
    gatt_client.ProfileServiceProxy, utils.CompositeEventEmitter
):
    SERVICE_CLASS = MediaControlService

    _CHARACTERISTICS: ClassVar[dict[str, core.UUID]] = {
        'media_player_name': gatt.GATT_MEDIA_PLAYER_NAME_CHARACTERISTIC,
        'media_player_icon_object_id': gatt.GATT_MEDIA_PLAYER_ICON_OBJECT_ID_CHARACTERISTIC,
        'media_player_icon_url': gatt.GATT_MEDIA_PLAYER_ICON_URL_CHARACTERISTIC,
        'track_changed': gatt.GATT_TRACK_CHANGED_CHARACTERISTIC,
        'track_title': gatt.GATT_TRACK_TITLE_CHARACTERISTIC,
        'track_duration': gatt.GATT_TRACK_DURATION_CHARACTERISTIC,
        'track_position': gatt.GATT_TRACK_POSITION_CHARACTERISTIC,
        'playback_speed': gatt.GATT_PLAYBACK_SPEED_CHARACTERISTIC,
        'seeking_speed': gatt.GATT_SEEKING_SPEED_CHARACTERISTIC,
        'current_track_segments_object_id': gatt.GATT_CURRENT_TRACK_SEGMENTS_OBJECT_ID_CHARACTERISTIC,
        'current_track_object_id': gatt.GATT_CURRENT_TRACK_OBJECT_ID_CHARACTERISTIC,
        'next_track_object_id': gatt.GATT_NEXT_TRACK_OBJECT_ID_CHARACTERISTIC,
        'parent_group_object_id': gatt.GATT_PARENT_GROUP_OBJECT_ID_CHARACTERISTIC,
        'current_group_object_id': gatt.GATT_CURRENT_GROUP_OBJECT_ID_CHARACTERISTIC,
        'playing_order': gatt.GATT_PLAYING_ORDER_CHARACTERISTIC,
        'playing_orders_supported': gatt.GATT_PLAYING_ORDERS_SUPPORTED_CHARACTERISTIC,
        'media_state': gatt.GATT_MEDIA_STATE_CHARACTERISTIC,
        'media_control_point': gatt.GATT_MEDIA_CONTROL_POINT_CHARACTERISTIC,
        'media_control_point_opcodes_supported': gatt.GATT_MEDIA_CONTROL_POINT_OPCODES_SUPPORTED_CHARACTERISTIC,
        'search_control_point': gatt.GATT_SEARCH_CONTROL_POINT_CHARACTERISTIC,
        'search_results_object_id': gatt.GATT_SEARCH_RESULTS_OBJECT_ID_CHARACTERISTIC,
        'content_control_id': gatt.GATT_CONTENT_CONTROL_ID_CHARACTERISTIC,
    }

    EVENT_MEDIA_STATE = "media_state"
    EVENT_TRACK_CHANGED = "track_changed"
    EVENT_TRACK_TITLE = "track_title"
    EVENT_TRACK_DURATION = "track_duration"
    EVENT_TRACK_POSITION = "track_position"

    media_player_name: gatt_client.CharacteristicProxy[bytes] | None = None
    media_player_icon_object_id: gatt_client.CharacteristicProxy[bytes] | None = None
    media_player_icon_url: gatt_client.CharacteristicProxy[bytes] | None = None
    track_changed: gatt_client.CharacteristicProxy[bytes] | None = None
    track_title: gatt_client.CharacteristicProxy[bytes] | None = None
    track_duration: gatt_client.CharacteristicProxy[bytes] | None = None
    track_position: gatt_client.CharacteristicProxy[bytes] | None = None
    playback_speed: gatt_client.CharacteristicProxy[bytes] | None = None
    seeking_speed: gatt_client.CharacteristicProxy[bytes] | None = None
    current_track_segments_object_id: gatt_client.CharacteristicProxy[bytes] | None = (
        None
    )
    current_track_object_id: gatt_client.CharacteristicProxy[bytes] | None = None
    next_track_object_id: gatt_client.CharacteristicProxy[bytes] | None = None
    parent_group_object_id: gatt_client.CharacteristicProxy[bytes] | None = None
    current_group_object_id: gatt_client.CharacteristicProxy[bytes] | None = None
    playing_order: gatt_client.CharacteristicProxy[bytes] | None = None
    playing_orders_supported: gatt_client.CharacteristicProxy[bytes] | None = None
    media_state: gatt_client.CharacteristicProxy[bytes] | None = None
    media_control_point: gatt_client.CharacteristicProxy[bytes] | None = None
    media_control_point_opcodes_supported: (
        gatt_client.CharacteristicProxy[bytes] | None
    ) = None
    search_control_point: gatt_client.CharacteristicProxy[bytes] | None = None
    search_results_object_id: gatt_client.CharacteristicProxy[bytes] | None = None
    content_control_id: gatt_client.CharacteristicProxy[bytes] | None = None

    if TYPE_CHECKING:
        media_control_point_notifications: asyncio.Queue[bytes]

    def __init__(self, service_proxy: gatt_client.ServiceProxy) -> None:
        utils.CompositeEventEmitter.__init__(self)
        self.service_proxy = service_proxy
        self.lock = asyncio.Lock()
        self.media_control_point_notifications = asyncio.Queue()

        for field, uuid in self._CHARACTERISTICS.items():
            if characteristics := service_proxy.get_characteristics_by_uuid(uuid):
                setattr(self, field, characteristics[0])

    async def subscribe_characteristics(self) -> None:
        if self.media_control_point:
            await self.media_control_point.subscribe(self._on_media_control_point)
        if self.media_state:
            await self.media_state.subscribe(self._on_media_state)
        if self.track_changed:
            await self.track_changed.subscribe(self._on_track_changed)
        if self.track_title:
            await self.track_title.subscribe(self._on_track_title)
        if self.track_duration:
            await self.track_duration.subscribe(self._on_track_duration)
        if self.track_position:
            await self.track_position.subscribe(self._on_track_position)

    async def write_control_point(
        self, opcode: MediaControlPointOpcode
    ) -> MediaControlPointResultCode:
        '''Writes a Media Control Point Opcode to peer and waits for the notification.

        The write operation will be executed when there isn't other pending commands.

        Args:
            opcode: opcode defined in `MediaControlPointOpcode`.

        Returns:
            Response code provided in `MediaControlPointResultCode`

        Raises:
            InvalidOperationError: Server does not have Media Control Point Characteristic.
            InvalidStateError: Server replies a notification with mismatched opcode.
        '''
        if not self.media_control_point:
            raise core.InvalidOperationError("Peer does not have media control point")

        async with self.lock:
            await self.media_control_point.write_value(
                bytes([opcode]),
                with_response=False,
            )

            (
                response_opcode,
                response_code,
            ) = await self.media_control_point_notifications.get()
            if response_opcode != opcode:
                raise core.InvalidStateError(
                    f"Expected {opcode} notification, but get {response_opcode}"
                )
            return MediaControlPointResultCode(response_code)

    def _on_media_control_point(self, data: bytes) -> None:
        self.media_control_point_notifications.put_nowait(data)

    def _on_media_state(self, data: bytes) -> None:
        self.emit(self.EVENT_MEDIA_STATE, MediaState(data[0]))

    def _on_track_changed(self, data: bytes) -> None:
        del data
        self.emit(self.EVENT_TRACK_CHANGED)

    def _on_track_title(self, data: bytes) -> None:
        self.emit(self.EVENT_TRACK_TITLE, data.decode("utf-8"))

    def _on_track_duration(self, data: bytes) -> None:
        self.emit(self.EVENT_TRACK_DURATION, struct.unpack_from('<i', data)[0])

    def _on_track_position(self, data: bytes) -> None:
        self.emit(self.EVENT_TRACK_POSITION, struct.unpack_from('<i', data)[0])


class GenericMediaControlServiceProxy(MediaControlServiceProxy):
    SERVICE_CLASS = GenericMediaControlService