blob: 551f5460d48a8fb78d5288a27a17b84ef2657e4a [file] [log] [blame]
/** @file
* @brief Bluetooth Media Control Service
*/
/*
* Copyright (c) 2019 - 2021 Nordic Semiconductor ASA
*
* SPDX-License-Identifier: Apache-2.0
*/
#include <zephyr/zephyr.h>
#include <stdbool.h>
#include <zephyr/device.h>
#include <zephyr/init.h>
#include <stdio.h>
#include <zephyr/types.h>
#include <zephyr/sys/util.h>
#include <zephyr/bluetooth/bluetooth.h>
#include <zephyr/bluetooth/conn.h>
#include <zephyr/bluetooth/gatt.h>
#include <zephyr/bluetooth/services/ots.h>
#include <zephyr/bluetooth/audio/media_proxy.h>
#include "media_proxy_internal.h"
#define BT_DBG_ENABLED IS_ENABLED(CONFIG_BT_DEBUG_MCS)
#define LOG_MODULE_NAME bt_mcs
#include "common/log.h"
/* TODO Media control may send a large number of notifications for a
* single command, so requires many buffers.
* (Number found by experiment.)
*
* Either find a better way of setting up the Kconfig, or serialize the
* notifications.
*/
BUILD_ASSERT(CONFIG_BT_L2CAP_TX_BUF_COUNT >= 10, "Too few L2CAP buffers");
static struct media_proxy_sctrl_cbs cbs;
/* Functions for reading and writing attributes, and for keeping track
* of attribute configuration changes.
* Functions for notifications are placed after the service definition.
*/
static ssize_t read_player_name(struct bt_conn *conn,
const struct bt_gatt_attr *attr, void *buf,
uint16_t len, uint16_t offset)
{
const char *name = media_proxy_sctrl_get_player_name();
BT_DBG("Player name read: %s", name);
return bt_gatt_attr_read(conn, attr, buf, len, offset, name,
strlen(name));
}
static void player_name_cfg_changed(const struct bt_gatt_attr *attr,
uint16_t value)
{
BT_DBG("value 0x%04x", value);
}
#ifdef CONFIG_BT_OTS
static ssize_t read_icon_id(struct bt_conn *conn,
const struct bt_gatt_attr *attr, void *buf,
uint16_t len, uint16_t offset)
{
uint64_t icon_id = media_proxy_sctrl_get_icon_id();
BT_DBG_OBJ_ID("Icon object read: ", icon_id);
return bt_gatt_attr_read(conn, attr, buf, len, offset, &icon_id,
BT_OTS_OBJ_ID_SIZE);
}
#endif /* CONFIG_BT_OTS */
static ssize_t read_icon_url(struct bt_conn *conn,
const struct bt_gatt_attr *attr, void *buf,
uint16_t len, uint16_t offset)
{
const char *url = media_proxy_sctrl_get_icon_url();
BT_DBG("Icon URL read, offset: %d, len:%d, URL: %s", offset, len,
url);
return bt_gatt_attr_read(conn, attr, buf, len, offset, url,
strlen(url));
}
static void track_cfg_changed(const struct bt_gatt_attr *attr, uint16_t value)
{
BT_DBG("value 0x%04x", value);
}
static ssize_t read_track_title(struct bt_conn *conn,
const struct bt_gatt_attr *attr,
void *buf, uint16_t len, uint16_t offset)
{
const char *title = media_proxy_sctrl_get_track_title();
BT_DBG("Track title read, offset: %d, len:%d, title: %s", offset, len,
title);
return bt_gatt_attr_read(conn, attr, buf, len, offset, title,
strlen(title));
}
static void track_title_cfg_changed(const struct bt_gatt_attr *attr,
uint16_t value)
{
BT_DBG("value 0x%04x", value);
}
static ssize_t read_track_duration(struct bt_conn *conn,
const struct bt_gatt_attr *attr, void *buf,
uint16_t len, uint16_t offset)
{
int32_t duration = media_proxy_sctrl_get_track_duration();
BT_DBG("Track duration read: %d (0x%08x)", duration, duration);
return bt_gatt_attr_read(conn, attr, buf, len, offset, &duration,
sizeof(duration));
}
static void track_duration_cfg_changed(const struct bt_gatt_attr *attr,
uint16_t value)
{
BT_DBG("value 0x%04x", value);
}
static ssize_t read_track_position(struct bt_conn *conn,
const struct bt_gatt_attr *attr, void *buf,
uint16_t len, uint16_t offset)
{
int32_t position = media_proxy_sctrl_get_track_position();
BT_DBG("Track position read: %d (0x%08x)", position, position);
return bt_gatt_attr_read(conn, attr, buf, len, offset, &position,
sizeof(position));
}
static ssize_t write_track_position(struct bt_conn *conn,
const struct bt_gatt_attr *attr,
const void *buf, uint16_t len,
uint16_t offset, uint8_t flags)
{
int32_t position;
if (offset != 0) {
return BT_GATT_ERR(BT_ATT_ERR_INVALID_OFFSET);
}
if (len != sizeof(position)) {
return BT_GATT_ERR(BT_ATT_ERR_INVALID_ATTRIBUTE_LEN);
}
memcpy(&position, buf, len);
media_proxy_sctrl_set_track_position(position);
BT_DBG("Track position write: %d", position);
return len;
}
static void track_position_cfg_changed(const struct bt_gatt_attr *attr,
uint16_t value)
{
BT_DBG("value 0x%04x", value);
}
static ssize_t read_playback_speed(struct bt_conn *conn,
const struct bt_gatt_attr *attr, void *buf,
uint16_t len, uint16_t offset)
{
int8_t speed = media_proxy_sctrl_get_playback_speed();
BT_DBG("Playback speed read: %d", speed);
return bt_gatt_attr_read(conn, attr, buf, len, offset, &speed,
sizeof(speed));
}
static ssize_t write_playback_speed(struct bt_conn *conn,
const struct bt_gatt_attr *attr,
const void *buf, uint16_t len, uint16_t offset,
uint8_t flags)
{
int8_t speed;
if (offset != 0) {
return BT_GATT_ERR(BT_ATT_ERR_INVALID_OFFSET);
}
if (len != sizeof(speed)) {
return BT_GATT_ERR(BT_ATT_ERR_INVALID_ATTRIBUTE_LEN);
}
memcpy(&speed, buf, len);
media_proxy_sctrl_set_playback_speed(speed);
BT_DBG("Playback speed write: %d", speed);
return len;
}
static void playback_speed_cfg_changed(const struct bt_gatt_attr *attr,
uint16_t value)
{
BT_DBG("value 0x%04x", value);
}
static ssize_t read_seeking_speed(struct bt_conn *conn,
const struct bt_gatt_attr *attr, void *buf,
uint16_t len, uint16_t offset)
{
int8_t speed = media_proxy_sctrl_get_seeking_speed();
BT_DBG("Seeking speed read: %d", speed);
return bt_gatt_attr_read(conn, attr, buf, len, offset, &speed,
sizeof(speed));
}
static void seeking_speed_cfg_changed(const struct bt_gatt_attr *attr,
uint16_t value)
{
BT_DBG("value 0x%04x", value);
}
#ifdef CONFIG_BT_OTS
static ssize_t read_track_segments_id(struct bt_conn *conn,
const struct bt_gatt_attr *attr,
void *buf, uint16_t len, uint16_t offset)
{
uint64_t track_segments_id = media_proxy_sctrl_get_track_segments_id();
BT_DBG_OBJ_ID("Track segments ID read: ", track_segments_id);
return bt_gatt_attr_read(conn, attr, buf, len, offset,
&track_segments_id, BT_OTS_OBJ_ID_SIZE);
}
static ssize_t read_current_track_id(struct bt_conn *conn,
const struct bt_gatt_attr *attr, void *buf,
uint16_t len, uint16_t offset)
{
uint64_t track_id = media_proxy_sctrl_get_current_track_id();
BT_DBG_OBJ_ID("Current track ID read: ", track_id);
return bt_gatt_attr_read(conn, attr, buf, len, offset, &track_id,
BT_OTS_OBJ_ID_SIZE);
}
static ssize_t write_current_track_id(struct bt_conn *conn,
const struct bt_gatt_attr *attr,
const void *buf, uint16_t len, uint16_t offset,
uint8_t flags)
{
uint64_t id;
if (offset != 0) {
BT_DBG("Invalid offset");
return BT_GATT_ERR(BT_ATT_ERR_INVALID_OFFSET);
}
if (len != BT_OTS_OBJ_ID_SIZE) {
BT_DBG("Invalid length");
return BT_GATT_ERR(BT_ATT_ERR_INVALID_ATTRIBUTE_LEN);
}
id = sys_get_le48((uint8_t *)buf);
if (IS_ENABLED(CONFIG_BT_DEBUG_MCS)) {
char str[BT_OTS_OBJ_ID_STR_LEN];
(void)bt_ots_obj_id_to_str(id, str, sizeof(str));
BT_DBG("Current track write: offset: %d, len: %d, track ID: %s",
offset, len, str);
}
media_proxy_sctrl_set_current_track_id(id);
return BT_OTS_OBJ_ID_SIZE;
}
static void current_track_id_cfg_changed(const struct bt_gatt_attr *attr,
uint16_t value)
{
BT_DBG("value 0x%04x", value);
}
static ssize_t read_next_track_id(struct bt_conn *conn,
const struct bt_gatt_attr *attr, void *buf,
uint16_t len, uint16_t offset)
{
uint64_t track_id = media_proxy_sctrl_get_next_track_id();
if (track_id == MPL_NO_TRACK_ID) {
BT_DBG("Next track read, but it is empty");
/* "If the media player has no next track, the length of the */
/* characteristic shall be zero." */
return bt_gatt_attr_read(conn, attr, buf, len, offset, NULL, 0);
}
BT_DBG_OBJ_ID("Next track read: ", track_id);
return bt_gatt_attr_read(conn, attr, buf, len, offset,
&track_id, BT_OTS_OBJ_ID_SIZE);
}
static ssize_t write_next_track_id(struct bt_conn *conn,
const struct bt_gatt_attr *attr,
const void *buf, uint16_t len, uint16_t offset,
uint8_t flags)
{
uint64_t id;
if (offset != 0) {
BT_DBG("Invalid offset");
return BT_GATT_ERR(BT_ATT_ERR_INVALID_OFFSET);
}
if (len != BT_OTS_OBJ_ID_SIZE) {
BT_DBG("Invalid length");
return BT_GATT_ERR(BT_ATT_ERR_INVALID_ATTRIBUTE_LEN);
}
id = sys_get_le48((uint8_t *)buf);
if (IS_ENABLED(CONFIG_BT_DEBUG_MCS)) {
char str[BT_OTS_OBJ_ID_STR_LEN];
(void)bt_ots_obj_id_to_str(id, str, sizeof(str));
BT_DBG("Next track write: offset: %d, len: %d, track ID: %s",
offset, len, str);
}
media_proxy_sctrl_set_next_track_id(id);
return BT_OTS_OBJ_ID_SIZE;
}
static void next_track_id_cfg_changed(const struct bt_gatt_attr *attr,
uint16_t value)
{
BT_DBG("value 0x%04x", value);
}
static ssize_t read_parent_group_id(struct bt_conn *conn,
const struct bt_gatt_attr *attr, void *buf,
uint16_t len, uint16_t offset)
{
uint64_t group_id = media_proxy_sctrl_get_parent_group_id();
BT_DBG_OBJ_ID("Parent group read: ", group_id);
return bt_gatt_attr_read(conn, attr, buf, len, offset, &group_id,
BT_OTS_OBJ_ID_SIZE);
}
static void parent_group_id_cfg_changed(const struct bt_gatt_attr *attr,
uint16_t value)
{
BT_DBG("value 0x%04x", value);
}
static ssize_t read_current_group_id(struct bt_conn *conn,
const struct bt_gatt_attr *attr, void *buf,
uint16_t len, uint16_t offset)
{
uint64_t group_id = media_proxy_sctrl_get_current_group_id();
BT_DBG_OBJ_ID("Current group read: ", group_id);
return bt_gatt_attr_read(conn, attr, buf, len, offset, &group_id,
BT_OTS_OBJ_ID_SIZE);
}
static ssize_t write_current_group_id(struct bt_conn *conn,
const struct bt_gatt_attr *attr,
const void *buf, uint16_t len, uint16_t offset,
uint8_t flags)
{
uint64_t id;
if (offset != 0) {
BT_DBG("Invalid offset");
return BT_GATT_ERR(BT_ATT_ERR_INVALID_OFFSET);
}
if (len != BT_OTS_OBJ_ID_SIZE) {
BT_DBG("Invalid length");
return BT_GATT_ERR(BT_ATT_ERR_INVALID_ATTRIBUTE_LEN);
}
id = sys_get_le48((uint8_t *)buf);
if (IS_ENABLED(CONFIG_BT_DEBUG_MCS)) {
char str[BT_OTS_OBJ_ID_STR_LEN];
(void)bt_ots_obj_id_to_str(id, str, sizeof(str));
BT_DBG("Current group ID write: offset: %d, len: %d, track ID: %s",
offset, len, str);
}
media_proxy_sctrl_set_current_group_id(id);
return BT_OTS_OBJ_ID_SIZE;
}
static void current_group_id_cfg_changed(const struct bt_gatt_attr *attr, uint16_t value)
{
BT_DBG("value 0x%04x", value);
}
#endif /* CONFIG_BT_OTS */
static ssize_t read_playing_order(struct bt_conn *conn,
const struct bt_gatt_attr *attr, void *buf,
uint16_t len, uint16_t offset)
{
uint8_t order = media_proxy_sctrl_get_playing_order();
BT_DBG("Playing order read: %d (0x%02x)", order, order);
return bt_gatt_attr_read(conn, attr, buf, len, offset, &order,
sizeof(order));
}
static ssize_t write_playing_order(struct bt_conn *conn,
const struct bt_gatt_attr *attr,
const void *buf, uint16_t len, uint16_t offset,
uint8_t flags)
{
BT_DBG("Playing order write");
int8_t order;
if (offset != 0) {
return BT_GATT_ERR(BT_ATT_ERR_INVALID_OFFSET);
}
if (len != sizeof(order)) {
return BT_GATT_ERR(BT_ATT_ERR_INVALID_ATTRIBUTE_LEN);
}
memcpy(&order, buf, len);
media_proxy_sctrl_set_playing_order(order);
BT_DBG("Playing order write: %d", order);
return len;
}
static void playing_order_cfg_changed(const struct bt_gatt_attr *attr,
uint16_t value)
{
BT_DBG("value 0x%04x", value);
}
static ssize_t read_playing_orders_supported(struct bt_conn *conn,
const struct bt_gatt_attr *attr,
void *buf, uint16_t len, uint16_t offset)
{
uint16_t orders = media_proxy_sctrl_get_playing_orders_supported();
BT_DBG("Playing orders read: %d (0x%04x)", orders, orders);
return bt_gatt_attr_read(conn, attr, buf, len, offset, &orders,
sizeof(orders));
}
static ssize_t read_media_state(struct bt_conn *conn,
const struct bt_gatt_attr *attr, void *buf,
uint16_t len, uint16_t offset)
{
uint8_t state = media_proxy_sctrl_get_media_state();
BT_DBG("Media state read: %d", state);
return bt_gatt_attr_read(conn, attr, buf, len, offset, &state,
sizeof(state));
}
static void media_state_cfg_changed(const struct bt_gatt_attr *attr,
uint16_t value)
{
BT_DBG("value 0x%04x", value);
}
static ssize_t write_control_point(struct bt_conn *conn,
const struct bt_gatt_attr *attr,
const void *buf, uint16_t len, uint16_t offset,
uint8_t flags)
{
struct mpl_cmd command;
if (offset != 0) {
return BT_GATT_ERR(BT_ATT_ERR_INVALID_OFFSET);
}
if (len != sizeof(command.opcode) &&
len != sizeof(command.opcode) + sizeof(command.param)) {
return BT_GATT_ERR(BT_ATT_ERR_INVALID_ATTRIBUTE_LEN);
}
memcpy(&command.opcode, buf, sizeof(command.opcode));
BT_DBG("Opcode: %d", command.opcode);
command.use_param = false;
if (len == sizeof(command.opcode) + sizeof(command.param)) {
memcpy(&command.param,
(char *)buf + sizeof(command.opcode),
sizeof(command.param));
command.use_param = true;
BT_DBG("Parameter: %d", command.param);
}
media_proxy_sctrl_send_command(&command);
return len;
}
static void control_point_cfg_changed(const struct bt_gatt_attr *attr,
uint16_t value)
{
BT_DBG("value 0x%04x", value);
}
static ssize_t read_opcodes_supported(struct bt_conn *conn,
const struct bt_gatt_attr *attr,
void *buf, uint16_t len, uint16_t offset)
{
uint32_t opcodes = media_proxy_sctrl_get_commands_supported();
BT_DBG("Opcodes_supported read: %d (0x%08x)", opcodes, opcodes);
return bt_gatt_attr_read(conn, attr, buf, len, offset,
&opcodes, BT_MCS_OPCODES_SUPPORTED_LEN);
}
static void opcodes_supported_cfg_changed(const struct bt_gatt_attr *attr,
uint16_t value)
{
BT_DBG("value 0x%04x", value);
}
#ifdef CONFIG_BT_OTS
static ssize_t write_search_control_point(struct bt_conn *conn,
const struct bt_gatt_attr *attr,
const void *buf, uint16_t len,
uint16_t offset, uint8_t flags)
{
struct mpl_search search = {0};
if (offset != 0) {
return BT_GATT_ERR(BT_ATT_ERR_INVALID_OFFSET);
}
if (len > SEARCH_LEN_MAX || len < SEARCH_LEN_MIN) {
return BT_GATT_ERR(BT_ATT_ERR_INVALID_ATTRIBUTE_LEN);
}
memcpy(&search.search, (char *)buf, len);
search.len = len;
BT_DBG("Search length: %d", len);
BT_HEXDUMP_DBG(&search.search, search.len, "Search content");
media_proxy_sctrl_send_search(&search);
return len;
}
static void search_control_point_cfg_changed(const struct bt_gatt_attr *attr,
uint16_t value)
{
BT_DBG("value 0x%04x", value);
}
static ssize_t read_search_results_id(struct bt_conn *conn,
const struct bt_gatt_attr *attr,
void *buf, uint16_t len, uint16_t offset)
{
uint64_t search_id = media_proxy_sctrl_get_search_results_id();
BT_DBG_OBJ_ID("Search results id read: ", search_id);
/* TODO: The permanent solution here should be that the call to */
/* mpl should fill the UUID in a pointed-to value, and return a */
/* length or an error code, to indicate whether this ID has a */
/* value now. This should be done for all functions of this kind. */
/* For now, fix the issue here - send zero-length data if the */
/* ID is zero. */
/* *Spec requirement - IDs may not be valid, in which case the */
/* characteristic shall be zero length. */
if (search_id == 0) {
return bt_gatt_attr_read(conn, attr, buf, len, offset,
NULL, 0);
} else {
return bt_gatt_attr_read(conn, attr, buf, len, offset,
&search_id, BT_OTS_OBJ_ID_SIZE);
}
}
static void search_results_id_cfg_changed(const struct bt_gatt_attr *attr,
uint16_t value)
{
BT_DBG("value 0x%04x", value);
}
#endif /* CONFIG_BT_OTS */
static ssize_t read_content_ctrl_id(struct bt_conn *conn,
const struct bt_gatt_attr *attr, void *buf,
uint16_t len, uint16_t offset)
{
uint8_t id = media_proxy_sctrl_get_content_ctrl_id();
BT_DBG("Content control ID read: %d", id);
return bt_gatt_attr_read(conn, attr, buf, len, offset, &id,
sizeof(id));
}
/* Defines for OTS-dependent characteristics - empty if no OTS */
#ifdef CONFIG_BT_OTS
#define ICON_OBJ_ID_CHARACTERISTIC_IF_OTS \
BT_GATT_CHARACTERISTIC(BT_UUID_MCS_ICON_OBJ_ID, \
BT_GATT_CHRC_READ, BT_GATT_PERM_READ_ENCRYPT, \
read_icon_id, NULL, NULL),
#define SEGMENTS_TRACK_GROUP_ID_CHARACTERISTICS_IF_OTS \
BT_GATT_CHARACTERISTIC(BT_UUID_MCS_TRACK_SEGMENTS_OBJ_ID, \
BT_GATT_CHRC_READ, BT_GATT_PERM_READ_ENCRYPT, \
read_track_segments_id, NULL, NULL), \
BT_GATT_CHARACTERISTIC(BT_UUID_MCS_CURRENT_TRACK_OBJ_ID, \
BT_GATT_CHRC_READ | BT_GATT_CHRC_WRITE | \
BT_GATT_CHRC_WRITE_WITHOUT_RESP | \
BT_GATT_CHRC_NOTIFY, \
BT_GATT_PERM_READ_ENCRYPT | \
BT_GATT_PERM_WRITE_ENCRYPT, \
read_current_track_id, write_current_track_id, \
NULL), \
BT_GATT_CCC(current_track_id_cfg_changed, \
BT_GATT_PERM_READ | BT_GATT_PERM_WRITE_ENCRYPT), \
BT_GATT_CHARACTERISTIC(BT_UUID_MCS_NEXT_TRACK_OBJ_ID, \
BT_GATT_CHRC_READ | BT_GATT_CHRC_WRITE | \
BT_GATT_CHRC_WRITE_WITHOUT_RESP | \
BT_GATT_CHRC_NOTIFY, \
BT_GATT_PERM_READ_ENCRYPT | \
BT_GATT_PERM_WRITE_ENCRYPT, \
read_next_track_id, write_next_track_id, NULL), \
BT_GATT_CCC(next_track_id_cfg_changed, \
BT_GATT_PERM_READ | BT_GATT_PERM_WRITE_ENCRYPT), \
BT_GATT_CHARACTERISTIC(BT_UUID_MCS_PARENT_GROUP_OBJ_ID, \
BT_GATT_CHRC_READ | BT_GATT_CHRC_NOTIFY, \
BT_GATT_PERM_READ_ENCRYPT, \
read_parent_group_id, NULL, NULL), \
BT_GATT_CCC(parent_group_id_cfg_changed, \
BT_GATT_PERM_READ | BT_GATT_PERM_WRITE_ENCRYPT), \
BT_GATT_CHARACTERISTIC(BT_UUID_MCS_CURRENT_GROUP_OBJ_ID, \
BT_GATT_CHRC_READ | BT_GATT_CHRC_WRITE | \
BT_GATT_CHRC_WRITE_WITHOUT_RESP | \
BT_GATT_CHRC_NOTIFY, \
BT_GATT_PERM_READ_ENCRYPT | \
BT_GATT_PERM_WRITE_ENCRYPT, \
read_current_group_id, write_current_group_id, NULL), \
BT_GATT_CCC(current_group_id_cfg_changed, \
BT_GATT_PERM_READ | BT_GATT_PERM_WRITE_ENCRYPT),
#define SEARCH_CHARACTERISTICS_IF_OTS \
BT_GATT_CHARACTERISTIC(BT_UUID_MCS_SEARCH_CONTROL_POINT, \
BT_GATT_CHRC_WRITE | \
BT_GATT_CHRC_WRITE_WITHOUT_RESP | \
BT_GATT_CHRC_NOTIFY, \
BT_GATT_PERM_WRITE_ENCRYPT, \
NULL, write_search_control_point, NULL), \
BT_GATT_CCC(search_control_point_cfg_changed, \
BT_GATT_PERM_READ | BT_GATT_PERM_WRITE_ENCRYPT), \
BT_GATT_CHARACTERISTIC(BT_UUID_MCS_SEARCH_RESULTS_OBJ_ID, \
BT_GATT_CHRC_READ | BT_GATT_CHRC_NOTIFY, \
BT_GATT_PERM_READ_ENCRYPT, \
read_search_results_id, NULL, NULL), \
BT_GATT_CCC(search_results_id_cfg_changed, \
BT_GATT_PERM_READ | BT_GATT_PERM_WRITE_ENCRYPT),
#else
#define ICON_OBJ_ID_CHARACTERISTIC_IF_OTS
#define SEGMENTS_TRACK_GROUP_ID_CHARACTERISTICS_IF_OTS
#define SEARCH_CHARACTERISTICS_IF_OTS
#endif /* CONFIG_BT_OTS */
/* Media control service attributes */
#define BT_MCS_SERVICE_DEFINITION \
BT_GATT_PRIMARY_SERVICE(BT_UUID_GMCS), \
BT_GATT_INCLUDE_SERVICE(NULL), /* To be overwritten */ \
BT_GATT_CHARACTERISTIC(BT_UUID_MCS_PLAYER_NAME, \
BT_GATT_CHRC_READ | BT_GATT_CHRC_NOTIFY, \
BT_GATT_PERM_READ_ENCRYPT, \
read_player_name, NULL, NULL), \
BT_GATT_CCC(player_name_cfg_changed, \
BT_GATT_PERM_READ | BT_GATT_PERM_WRITE_ENCRYPT), \
ICON_OBJ_ID_CHARACTERISTIC_IF_OTS \
BT_GATT_CHARACTERISTIC(BT_UUID_MCS_ICON_URL, \
BT_GATT_CHRC_READ, BT_GATT_PERM_READ_ENCRYPT, \
read_icon_url, NULL, NULL), \
BT_GATT_CHARACTERISTIC(BT_UUID_MCS_TRACK_CHANGED, \
BT_GATT_CHRC_NOTIFY, BT_GATT_PERM_NONE, \
NULL, NULL, NULL), \
BT_GATT_CCC(track_cfg_changed, \
BT_GATT_PERM_READ | BT_GATT_PERM_WRITE_ENCRYPT), \
BT_GATT_CHARACTERISTIC(BT_UUID_MCS_TRACK_TITLE, \
BT_GATT_CHRC_READ | BT_GATT_CHRC_NOTIFY, \
BT_GATT_PERM_READ_ENCRYPT, \
read_track_title, NULL, NULL), \
BT_GATT_CCC(track_title_cfg_changed, \
BT_GATT_PERM_READ | BT_GATT_PERM_WRITE_ENCRYPT), \
BT_GATT_CHARACTERISTIC(BT_UUID_MCS_TRACK_DURATION, \
BT_GATT_CHRC_READ | BT_GATT_CHRC_NOTIFY, \
BT_GATT_PERM_READ_ENCRYPT, \
read_track_duration, NULL, NULL), \
BT_GATT_CCC(track_duration_cfg_changed, \
BT_GATT_PERM_READ | BT_GATT_PERM_WRITE_ENCRYPT), \
BT_GATT_CHARACTERISTIC(BT_UUID_MCS_TRACK_POSITION, \
BT_GATT_CHRC_READ | BT_GATT_CHRC_WRITE | \
BT_GATT_CHRC_WRITE_WITHOUT_RESP | \
BT_GATT_CHRC_NOTIFY, \
BT_GATT_PERM_READ_ENCRYPT | \
BT_GATT_PERM_WRITE_ENCRYPT, \
read_track_position, \
write_track_position, NULL), \
BT_GATT_CCC(track_position_cfg_changed, \
BT_GATT_PERM_READ | BT_GATT_PERM_WRITE_ENCRYPT), \
BT_GATT_CHARACTERISTIC(BT_UUID_MCS_PLAYBACK_SPEED, \
BT_GATT_CHRC_READ | BT_GATT_CHRC_WRITE | \
BT_GATT_CHRC_WRITE_WITHOUT_RESP | \
BT_GATT_CHRC_NOTIFY, \
BT_GATT_PERM_READ_ENCRYPT | \
BT_GATT_PERM_WRITE_ENCRYPT, \
read_playback_speed, write_playback_speed, \
NULL), \
BT_GATT_CCC(playback_speed_cfg_changed, \
BT_GATT_PERM_READ | BT_GATT_PERM_WRITE_ENCRYPT), \
BT_GATT_CHARACTERISTIC(BT_UUID_MCS_SEEKING_SPEED, \
BT_GATT_CHRC_READ | BT_GATT_CHRC_NOTIFY, \
BT_GATT_PERM_READ_ENCRYPT, \
read_seeking_speed, NULL, NULL), \
BT_GATT_CCC(seeking_speed_cfg_changed, \
BT_GATT_PERM_READ | BT_GATT_PERM_WRITE_ENCRYPT), \
SEGMENTS_TRACK_GROUP_ID_CHARACTERISTICS_IF_OTS \
BT_GATT_CHARACTERISTIC(BT_UUID_MCS_PLAYING_ORDER, \
BT_GATT_CHRC_READ | BT_GATT_CHRC_WRITE | \
BT_GATT_CHRC_WRITE_WITHOUT_RESP | \
BT_GATT_CHRC_NOTIFY, \
BT_GATT_PERM_READ_ENCRYPT | \
BT_GATT_PERM_WRITE_ENCRYPT, \
read_playing_order, write_playing_order, NULL), \
BT_GATT_CCC(playing_order_cfg_changed, \
BT_GATT_PERM_READ | BT_GATT_PERM_WRITE_ENCRYPT), \
BT_GATT_CHARACTERISTIC(BT_UUID_MCS_PLAYING_ORDERS, \
BT_GATT_CHRC_READ, BT_GATT_PERM_READ_ENCRYPT, \
read_playing_orders_supported, NULL, NULL), \
BT_GATT_CHARACTERISTIC(BT_UUID_MCS_MEDIA_STATE, \
BT_GATT_CHRC_READ | BT_GATT_CHRC_NOTIFY, \
BT_GATT_PERM_READ_ENCRYPT, \
read_media_state, NULL, NULL), \
BT_GATT_CCC(media_state_cfg_changed, \
BT_GATT_PERM_READ | BT_GATT_PERM_WRITE_ENCRYPT), \
BT_GATT_CHARACTERISTIC(BT_UUID_MCS_MEDIA_CONTROL_POINT, \
BT_GATT_CHRC_WRITE | \
BT_GATT_CHRC_WRITE_WITHOUT_RESP | \
BT_GATT_CHRC_NOTIFY, \
BT_GATT_PERM_WRITE_ENCRYPT, \
NULL, write_control_point, NULL), \
BT_GATT_CCC(control_point_cfg_changed, \
BT_GATT_PERM_READ | BT_GATT_PERM_WRITE_ENCRYPT), \
BT_GATT_CHARACTERISTIC(BT_UUID_MCS_MEDIA_CONTROL_OPCODES, \
BT_GATT_CHRC_READ | BT_GATT_CHRC_NOTIFY, \
BT_GATT_PERM_READ_ENCRYPT, \
read_opcodes_supported, NULL, NULL), \
BT_GATT_CCC(opcodes_supported_cfg_changed, \
BT_GATT_PERM_READ | BT_GATT_PERM_WRITE_ENCRYPT), \
SEARCH_CHARACTERISTICS_IF_OTS \
BT_GATT_CHARACTERISTIC(BT_UUID_CCID, \
BT_GATT_CHRC_READ, \
BT_GATT_PERM_READ_ENCRYPT, \
read_content_ctrl_id, NULL, NULL)
static struct bt_gatt_attr svc_attrs[] = { BT_MCS_SERVICE_DEFINITION };
static struct bt_gatt_service mcs;
#ifdef CONFIG_BT_OTS
static struct bt_ots *ots;
#endif /* CONFIG_BT_OTS */
#ifdef CONFIG_BT_OTS
struct bt_ots *bt_mcs_get_ots(void)
{
return ots;
}
#endif /* CONFIG_BT_OTS */
/* Callback functions from the media player, notifying attributes */
/* Placed here, after the service definition, because they reference it. */
/* Helper function to notify non-string values */
static void notify(const struct bt_uuid *uuid, const void *data, uint16_t len)
{
int err = bt_gatt_notify_uuid(NULL, uuid, mcs.attrs, data, len);
if (err) {
if (err == -ENOTCONN) {
BT_DBG("Notification error: ENOTCONN (%d)", err);
} else {
BT_ERR("Notification error: %d", err);
}
}
}
/* Helper function to notify UTF8 string values
* Will truncate string to fit within notification if required.
* The string must be null-terminated.
*/
static void notify_string(const struct bt_uuid *uuid, const char *str)
{
/* TODO:
* This function will need to get the ATT_MTU to know what length to
* truncate the string to. But the ATT_MTU is per connection, and MCS
* is not connection-aware yet.
* For now: Truncate according to the default ATT_MTU, so that
* notifications will go through
*/
/* TODO: Use bt_gatt_get_mtu() to find the ATT_MTU */
const uint16_t att_mtu = 23;
const uint16_t maxlen = att_mtu - 1 - 2; /* Subtract opcode and handle */
const uint16_t len = strlen(str);
if (len > maxlen) {
/* Truncation requires, and gives, a null-terminated string. */
char trunc_str[maxlen + 1];
utf8_lcpy(trunc_str, str, sizeof(trunc_str));
/* Null-termination is not sent on air */
notify(uuid, (void *)trunc_str, strlen(trunc_str));
} else {
notify(uuid, (void *)str, len);
}
}
void media_proxy_sctrl_track_changed_cb(void)
{
BT_DBG("Notifying track change");
notify(BT_UUID_MCS_TRACK_CHANGED, NULL, 0);
}
void media_proxy_sctrl_track_title_cb(const char *title)
{
BT_DBG("Notifying track title: %s", title);
notify_string(BT_UUID_MCS_TRACK_TITLE, title);
}
void media_proxy_sctrl_track_position_cb(int32_t position)
{
BT_DBG("Notifying track position: %d", position);
notify(BT_UUID_MCS_TRACK_POSITION, &position, sizeof(position));
}
void media_proxy_sctrl_track_duration_cb(int32_t duration)
{
BT_DBG("Notifying track duration: %d", duration);
notify(BT_UUID_MCS_TRACK_DURATION, &duration, sizeof(duration));
}
void media_proxy_sctrl_playback_speed_cb(int8_t speed)
{
BT_DBG("Notifying playback speed: %d", speed);
notify(BT_UUID_MCS_PLAYBACK_SPEED, &speed, sizeof(speed));
}
void media_proxy_sctrl_seeking_speed_cb(int8_t speed)
{
BT_DBG("Notifying seeking speed: %d", speed);
notify(BT_UUID_MCS_SEEKING_SPEED, &speed, sizeof(speed));
}
void media_proxy_sctrl_current_track_id_cb(uint64_t id)
{
BT_DBG_OBJ_ID("Notifying current track ID: ", id);
notify(BT_UUID_MCS_CURRENT_TRACK_OBJ_ID, &id, BT_OTS_OBJ_ID_SIZE);
}
void media_proxy_sctrl_next_track_id_cb(uint64_t id)
{
if (id == MPL_NO_TRACK_ID) {
/* "If the media player has no next track, the length of the */
/* characteristic shall be zero." */
BT_DBG_OBJ_ID("Notifying EMPTY next track ID: ", id);
notify(BT_UUID_MCS_NEXT_TRACK_OBJ_ID, NULL, 0);
} else {
BT_DBG_OBJ_ID("Notifying next track ID: ", id);
notify(BT_UUID_MCS_NEXT_TRACK_OBJ_ID, &id, BT_OTS_OBJ_ID_SIZE);
}
}
void media_proxy_sctrl_parent_group_id_cb(uint64_t id)
{
BT_DBG_OBJ_ID("Notifying parent group ID: ", id);
notify(BT_UUID_MCS_PARENT_GROUP_OBJ_ID, &id, BT_OTS_OBJ_ID_SIZE);
}
void media_proxy_sctrl_current_group_id_cb(uint64_t id)
{
BT_DBG_OBJ_ID("Notifying current group ID: ", id);
notify(BT_UUID_MCS_CURRENT_GROUP_OBJ_ID, &id, BT_OTS_OBJ_ID_SIZE);
}
void media_proxy_sctrl_playing_order_cb(uint8_t order)
{
BT_DBG("Notifying playing order: %d", order);
notify(BT_UUID_MCS_PLAYING_ORDER, &order, sizeof(order));
}
void media_proxy_sctrl_media_state_cb(uint8_t state)
{
BT_DBG("Notifying media state: %d", state);
notify(BT_UUID_MCS_MEDIA_STATE, &state, sizeof(state));
}
void media_proxy_sctrl_command_cb(const struct mpl_cmd_ntf *cmd_ntf)
{
BT_DBG("Notifying control point command - opcode: %d, result: %d",
cmd_ntf->requested_opcode, cmd_ntf->result_code);
notify(BT_UUID_MCS_MEDIA_CONTROL_POINT, cmd_ntf, sizeof(*cmd_ntf));
}
void media_proxy_sctrl_commands_supported_cb(uint32_t opcodes)
{
BT_DBG("Notifying command opcodes supported: %d (0x%08x)", opcodes,
opcodes);
notify(BT_UUID_MCS_MEDIA_CONTROL_OPCODES, &opcodes,
BT_MCS_OPCODES_SUPPORTED_LEN);
}
void media_proxy_sctrl_search_cb(uint8_t result_code)
{
BT_DBG("Notifying search control point - result: %d", result_code);
notify(BT_UUID_MCS_SEARCH_CONTROL_POINT, &result_code,
sizeof(result_code));
}
void media_proxy_sctrl_search_results_id_cb(uint64_t id)
{
BT_DBG_OBJ_ID("Notifying search results ID: ", id);
notify(BT_UUID_MCS_SEARCH_RESULTS_OBJ_ID, &id, BT_OTS_OBJ_ID_SIZE);
}
/* Register the service */
int bt_mcs_init(struct bt_ots_cb *ots_cbs)
{
static bool initialized;
int err;
if (initialized) {
BT_DBG("Already initialized");
return -EALREADY;
}
mcs = (struct bt_gatt_service)BT_GATT_SERVICE(svc_attrs);
#ifdef CONFIG_BT_OTS
struct bt_ots_init ots_init;
ots = bt_ots_free_instance_get();
if (!ots) {
BT_ERR("Failed to retrieve OTS instance\n");
return -ENOMEM;
}
/* Configure OTS initialization. */
memset(&ots_init, 0, sizeof(ots_init));
BT_OTS_OACP_SET_FEAT_READ(ots_init.features.oacp);
BT_OTS_OLCP_SET_FEAT_GO_TO(ots_init.features.olcp);
ots_init.cb = ots_cbs;
/* Initialize OTS instance. */
err = bt_ots_init(ots, &ots_init);
if (err) {
BT_ERR("Failed to init OTS (err:%d)\n", err);
return err;
}
/* TODO: Maybe the user_data pointer can be in a different way */
for (int i = 0; i < mcs.attr_count; i++) {
if (!bt_uuid_cmp(mcs.attrs[i].uuid, BT_UUID_GATT_INCLUDE)) {
mcs.attrs[i].user_data = bt_ots_svc_decl_get(ots);
}
}
#endif /* CONFIG_BT_OTS */
err = bt_gatt_service_register(&mcs);
if (err) {
BT_ERR("Could not register the MCS service");
#ifdef CONFIG_BT_OTS
/* TODO: How does one un-register the OTS? */
#endif /* CONFIG_BT_OTS */
return -ENOEXEC;
}
/* Set up the callback structure */
cbs.track_changed = media_proxy_sctrl_track_changed_cb;
cbs.track_title = media_proxy_sctrl_track_title_cb;
cbs.track_duration = media_proxy_sctrl_track_duration_cb;
cbs.track_position = media_proxy_sctrl_track_position_cb;
cbs.playback_speed = media_proxy_sctrl_playback_speed_cb;
cbs.seeking_speed = media_proxy_sctrl_seeking_speed_cb;
#ifdef CONFIG_BT_OTS
cbs.current_track_id = media_proxy_sctrl_current_track_id_cb;
cbs.next_track_id = media_proxy_sctrl_next_track_id_cb;
cbs.parent_group_id = media_proxy_sctrl_parent_group_id_cb;
cbs.current_group_id = media_proxy_sctrl_current_group_id_cb;
#endif /* CONFIG_BT_OTS */
cbs.playing_order = media_proxy_sctrl_playing_order_cb;
cbs.media_state = media_proxy_sctrl_media_state_cb;
cbs.command = media_proxy_sctrl_command_cb;
cbs.commands_supported = media_proxy_sctrl_commands_supported_cb;
#ifdef CONFIG_BT_OTS
cbs.search = media_proxy_sctrl_search_cb;
cbs.search_results_id = media_proxy_sctrl_search_results_id_cb;
#endif /* CONFIG_BT_OTS */
media_proxy_sctrl_register(&cbs);
initialized = true;
return 0;
}