mcc.h

Go to the documentation of this file.

 
/*
 * Copyright (c) 2019 - 2024 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_BLUETOOTH_AUDIO_MCC_
#define ZEPHYR_INCLUDE_BLUETOOTH_AUDIO_MCC_
 
#include <stdint.h>
#include <stdbool.h>
 
#include <zephyr/bluetooth/conn.h>
#include <zephyr/net/buf.h>
#include <zephyr/bluetooth/audio/media_proxy.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/**** Callback functions ******************************************************/
 
typedef void (*bt_mcc_discover_mcs_cb)(struct bt_conn *conn, int err);
 
typedef void (*bt_mcc_read_player_name_cb)(struct bt_conn *conn, int err, const char *name);
 
typedef void (*bt_mcc_read_icon_obj_id_cb)(struct bt_conn *conn, int err, uint64_t icon_id);
 
typedef void (*bt_mcc_read_icon_url_cb)(struct bt_conn *conn, int err, const char *icon_url);
 
typedef void (*bt_mcc_track_changed_ntf_cb)(struct bt_conn *conn, int err);
 
 
typedef void (*bt_mcc_read_track_title_cb)(struct bt_conn *conn, int err, const char *title);
 
typedef void (*bt_mcc_read_track_duration_cb)(struct bt_conn *conn, int err, int32_t dur);
 
typedef void (*bt_mcc_read_track_position_cb)(struct bt_conn *conn, int err, int32_t pos);
 
typedef void (*bt_mcc_set_track_position_cb)(struct bt_conn *conn, int err, int32_t pos);
 
typedef void (*bt_mcc_read_playback_speed_cb)(struct bt_conn *conn, int err, int8_t speed);
 
typedef void (*bt_mcc_set_playback_speed_cb)(struct bt_conn *conn, int err, int8_t speed);
 
typedef void (*bt_mcc_read_seeking_speed_cb)(struct bt_conn *conn, int err, int8_t speed);
 
typedef void (*bt_mcc_read_segments_obj_id_cb)(struct bt_conn *conn, int err, uint64_t id);
 
typedef void (*bt_mcc_read_current_track_obj_id_cb)(struct bt_conn *conn, int err, uint64_t id);
 
typedef void (*bt_mcc_set_current_track_obj_id_cb)(struct bt_conn *conn, int err, uint64_t id);
 
typedef void (*bt_mcc_read_next_track_obj_id_cb)(struct bt_conn *conn, int err, uint64_t id);
 
typedef void (*bt_mcc_set_next_track_obj_id_cb)(struct bt_conn *conn, int err, uint64_t id);
 
typedef void (*bt_mcc_read_parent_group_obj_id_cb)(struct bt_conn *conn, int err, uint64_t id);
 
typedef void (*bt_mcc_read_current_group_obj_id_cb)(struct bt_conn *conn, int err, uint64_t id);
 
typedef void (*bt_mcc_set_current_group_obj_id_cb)(struct bt_conn *conn, int err, uint64_t obj_id);
 
typedef void (*bt_mcc_read_playing_order_cb)(struct bt_conn *conn, int err, uint8_t order);
 
typedef void (*bt_mcc_set_playing_order_cb)(struct bt_conn *conn, int err, uint8_t order);
 
typedef void (*bt_mcc_read_playing_orders_supported_cb)(struct bt_conn *conn, int err,
                                                        uint16_t orders);
 
typedef void (*bt_mcc_read_media_state_cb)(struct bt_conn *conn, int err, uint8_t state);
 
typedef void (*bt_mcc_send_cmd_cb)(struct bt_conn *conn, int err, const struct mpl_cmd *cmd);
 
typedef void (*bt_mcc_cmd_ntf_cb)(struct bt_conn *conn, int err, const struct mpl_cmd_ntf *ntf);
 
typedef void (*bt_mcc_read_opcodes_supported_cb)(struct bt_conn *conn, int err,
                                                 uint32_t opcodes);
 
typedef void (*bt_mcc_send_search_cb)(struct bt_conn *conn, int err,
                                      const struct mpl_search *search);
 
typedef void (*bt_mcc_search_ntf_cb)(struct bt_conn *conn, int err,
                                     uint8_t result_code);
 
typedef void (*bt_mcc_read_search_results_obj_id_cb)(struct bt_conn *conn,
                                                     int err, uint64_t id);
 
typedef void (*bt_mcc_read_content_control_id_cb)(struct bt_conn *conn,
                                                  int err, uint8_t ccid);
 
/**** Callback functions for the included Object Transfer service *************/
 
typedef void (*bt_mcc_otc_obj_selected_cb)(struct bt_conn *conn, int err);
 
typedef void (*bt_mcc_otc_obj_metadata_cb)(struct bt_conn *conn, int err);
 
typedef void (*bt_mcc_otc_read_icon_object_cb)(struct bt_conn *conn, int err,
                                               struct net_buf_simple *buf);
 
typedef void (*bt_mcc_otc_read_track_segments_object_cb)(struct bt_conn *conn, int err,
                                                         struct net_buf_simple *buf);
 
typedef void (*bt_mcc_otc_read_current_track_object_cb)(struct bt_conn *conn, int err,
                                                        struct net_buf_simple *buf);
 
typedef void (*bt_mcc_otc_read_next_track_object_cb)(struct bt_conn *conn, int err,
                                                     struct net_buf_simple *buf);
 
typedef void (*bt_mcc_otc_read_parent_group_object_cb)(struct bt_conn *conn, int err,
                                                       struct net_buf_simple *buf);
 
typedef void (*bt_mcc_otc_read_current_group_object_cb)(struct bt_conn *conn, int err,
                                                        struct net_buf_simple *buf);
 
 
struct bt_mcc_cb {
        bt_mcc_discover_mcs_cb                   discover_mcs;
        bt_mcc_read_player_name_cb               read_player_name;
#if defined(CONFIG_BT_OTS_CLIENT) || defined(__DOXYGEN__)
        bt_mcc_read_icon_obj_id_cb               read_icon_obj_id;
#endif /* CONFIG_BT_OTS_CLIENT */
#if defined(CONFIG_BT_MCC_READ_MEDIA_PLAYER_ICON_URL) || defined(__DOXYGEN__)
        bt_mcc_read_icon_url_cb                  read_icon_url;
#endif /* defined(CONFIG_BT_MCC_READ_MEDIA_PLAYER_ICON_URL) */
        bt_mcc_track_changed_ntf_cb              track_changed_ntf;
#if defined(CONFIG_BT_MCC_READ_TRACK_TITLE) || defined(__DOXYGEN__)
        bt_mcc_read_track_title_cb               read_track_title;
#endif /* defined(CONFIG_BT_MCC_READ_TRACK_TITLE) */
#if defined(CONFIG_BT_MCC_READ_TRACK_DURATION) || defined(__DOXYGEN__)
        bt_mcc_read_track_duration_cb            read_track_duration;
#endif /* defined(CONFIG_BT_MCC_READ_TRACK_DURATION) */
#if defined(CONFIG_BT_MCC_READ_TRACK_POSITION) || defined(__DOXYGEN__)
        bt_mcc_read_track_position_cb            read_track_position;
#endif /* defined(CONFIG_BT_MCC_READ_TRACK_POSITION) */
#if defined(CONFIG_BT_MCC_SET_TRACK_POSITION) || defined(__DOXYGEN__)
        bt_mcc_set_track_position_cb             set_track_position;
#endif /* defined(CONFIG_BT_MCC_SET_TRACK_POSITION) */
#if defined(CONFIG_BT_MCC_READ_PLAYBACK_SPEED) || defined(__DOXYGEN__)
        bt_mcc_read_playback_speed_cb            read_playback_speed;
#endif /* defined (CONFIG_BT_MCC_READ_PLAYBACK_SPEED) */
#if defined(CONFIG_BT_MCC_SET_PLAYBACK_SPEED) || defined(__DOXYGEN__)
        bt_mcc_set_playback_speed_cb             set_playback_speed;
#endif /* defined (CONFIG_BT_MCC_SET_PLAYBACK_SPEED) */
#if defined(CONFIG_BT_MCC_READ_SEEKING_SPEED) || defined(__DOXYGEN__)
        bt_mcc_read_seeking_speed_cb             read_seeking_speed;
#endif /* defined (CONFIG_BT_MCC_READ_SEEKING_SPEED) */
#if defined(CONFIG_BT_OTS_CLIENT) || defined(__DOXYGEN__)
        bt_mcc_read_segments_obj_id_cb           read_segments_obj_id;
        bt_mcc_read_current_track_obj_id_cb      read_current_track_obj_id;
        bt_mcc_set_current_track_obj_id_cb       set_current_track_obj_id;
        bt_mcc_read_next_track_obj_id_cb         read_next_track_obj_id;
        bt_mcc_set_next_track_obj_id_cb          set_next_track_obj_id;
        bt_mcc_read_current_group_obj_id_cb      read_current_group_obj_id;
        bt_mcc_set_current_group_obj_id_cb       set_current_group_obj_id;
        bt_mcc_read_parent_group_obj_id_cb       read_parent_group_obj_id;
#endif /* CONFIG_BT_OTS_CLIENT */
#if defined(CONFIG_BT_MCC_READ_PLAYING_ORDER) || defined(__DOXYGEN__)
        bt_mcc_read_playing_order_cb             read_playing_order;
#endif /* defined(CONFIG_BT_MCC_READ_PLAYING_ORDER) */
#if defined(CONFIG_BT_MCC_SET_PLAYING_ORDER) || defined(__DOXYGEN__)
        bt_mcc_set_playing_order_cb              set_playing_order;
#endif /* defined(CONFIG_BT_MCC_SET_PLAYING_ORDER) */
#if defined(CONFIG_BT_MCC_READ_PLAYING_ORDER_SUPPORTED) || defined(__DOXYGEN__)
        bt_mcc_read_playing_orders_supported_cb  read_playing_orders_supported;
#endif /* defined(CONFIG_BT_MCC_READ_PLAYING_ORDER_SUPPORTED) */
#if defined(CONFIG_BT_MCC_READ_MEDIA_STATE) || defined(__DOXYGEN__)
        bt_mcc_read_media_state_cb               read_media_state;
#endif /* defined(CONFIG_BT_MCC_READ_MEDIA_STATE) */
#if defined(CONFIG_BT_MCC_SET_MEDIA_CONTROL_POINT) || defined(__DOXYGEN__)
        bt_mcc_send_cmd_cb                       send_cmd;
#endif /* defined(CONFIG_BT_MCC_SET_MEDIA_CONTROL_POINT) */
        bt_mcc_cmd_ntf_cb                        cmd_ntf;
#if defined(CONFIG_BT_MCC_READ_MEDIA_CONTROL_POINT_OPCODES_SUPPORTED) || defined(__DOXYGEN__)
        bt_mcc_read_opcodes_supported_cb         read_opcodes_supported;
#endif /* defined(CONFIG_BT_MCC_READ_MEDIA_CONTROL_POINT_OPCODES_SUPPORTED) */
#if defined(CONFIG_BT_OTS_CLIENT) || defined(__DOXYGEN__)
        bt_mcc_send_search_cb                    send_search;
        bt_mcc_search_ntf_cb                     search_ntf;
        bt_mcc_read_search_results_obj_id_cb     read_search_results_obj_id;
#endif /* CONFIG_BT_OTS_CLIENT */
#if defined(CONFIG_BT_MCC_READ_CONTENT_CONTROL_ID) || defined(__DOXYGEN__)
        bt_mcc_read_content_control_id_cb        read_content_control_id;
#endif /* defined(CONFIG_BT_MCC_READ_CONTENT_CONTROL_ID) */
#if defined(CONFIG_BT_OTS_CLIENT) || defined(__DOXYGEN__)
        bt_mcc_otc_obj_selected_cb               otc_obj_selected;
        bt_mcc_otc_obj_metadata_cb               otc_obj_metadata;
        bt_mcc_otc_read_icon_object_cb           otc_icon_object;
        bt_mcc_otc_read_track_segments_object_cb otc_track_segments_object;
        bt_mcc_otc_read_current_track_object_cb  otc_current_track_object;
        bt_mcc_otc_read_next_track_object_cb     otc_next_track_object;
        bt_mcc_otc_read_current_group_object_cb  otc_current_group_object;
        bt_mcc_otc_read_parent_group_object_cb   otc_parent_group_object;
#endif /* CONFIG_BT_OTS_CLIENT */
};
 
/**** Functions ***************************************************************/
 
int bt_mcc_init(struct bt_mcc_cb *cb);
 
 
int bt_mcc_discover_mcs(struct bt_conn *conn, bool subscribe);
 
int bt_mcc_read_player_name(struct bt_conn *conn);
 
int bt_mcc_read_icon_obj_id(struct bt_conn *conn);
 
int bt_mcc_read_icon_url(struct bt_conn *conn);
 
int bt_mcc_read_track_title(struct bt_conn *conn);
 
int bt_mcc_read_track_duration(struct bt_conn *conn);
 
int bt_mcc_read_track_position(struct bt_conn *conn);
 
int bt_mcc_set_track_position(struct bt_conn *conn, int32_t pos);
 
int bt_mcc_read_playback_speed(struct bt_conn *conn);
 
int bt_mcc_set_playback_speed(struct bt_conn *conn, int8_t speed);
 
int bt_mcc_read_seeking_speed(struct bt_conn *conn);
 
int bt_mcc_read_segments_obj_id(struct bt_conn *conn);
 
int bt_mcc_read_current_track_obj_id(struct bt_conn *conn);
 
int bt_mcc_set_current_track_obj_id(struct bt_conn *conn, uint64_t id);
 
int bt_mcc_read_next_track_obj_id(struct bt_conn *conn);
 
int bt_mcc_set_next_track_obj_id(struct bt_conn *conn, uint64_t id);
 
int bt_mcc_read_current_group_obj_id(struct bt_conn *conn);
 
int bt_mcc_set_current_group_obj_id(struct bt_conn *conn, uint64_t id);
 
int bt_mcc_read_parent_group_obj_id(struct bt_conn *conn);
 
int bt_mcc_read_playing_order(struct bt_conn *conn);
 
int bt_mcc_set_playing_order(struct bt_conn *conn, uint8_t order);
 
int bt_mcc_read_playing_orders_supported(struct bt_conn *conn);
 
int bt_mcc_read_media_state(struct bt_conn *conn);
 
int bt_mcc_send_cmd(struct bt_conn *conn, const struct mpl_cmd *cmd);
 
int bt_mcc_read_opcodes_supported(struct bt_conn *conn);
 
int bt_mcc_send_search(struct bt_conn *conn, const struct mpl_search *search);
 
int bt_mcc_read_search_results_obj_id(struct bt_conn *conn);
 
int bt_mcc_read_content_control_id(struct bt_conn *conn);
 
int bt_mcc_otc_read_object_metadata(struct bt_conn *conn);
 
int bt_mcc_otc_read_icon_object(struct bt_conn *conn);
 
int bt_mcc_otc_read_track_segments_object(struct bt_conn *conn);
 
int bt_mcc_otc_read_current_track_object(struct bt_conn *conn);
 
int bt_mcc_otc_read_next_track_object(struct bt_conn *conn);
 
int bt_mcc_otc_read_current_group_object(struct bt_conn *conn);
 
int bt_mcc_otc_read_parent_group_object(struct bt_conn *conn);
 
struct bt_ots_client *bt_mcc_otc_inst(struct bt_conn *conn);
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_BLUETOOTH_AUDIO_MCC__ */