media_proxy.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_MEDIA_PROXY_H_
#define ZEPHYR_INCLUDE_BLUETOOTH_AUDIO_MEDIA_PROXY_H_

 
#include <stdint.h>
#include <stdbool.h>
 
#include <zephyr/bluetooth/bluetooth.h>
#include <zephyr/sys/util_macro.h>
 
/* TODO: Remove dependency on mcs.h */
#include "mcs.h"
 
#ifdef __cplusplus
extern "C" {
#endif

struct mpl_cmd {
        uint8_t  opcode;
        bool  use_param;
        int32_t param;
};

struct mpl_cmd_ntf {
        uint8_t requested_opcode;
        uint8_t result_code;
};

struct mpl_sci {
        uint8_t len;                     
        uint8_t type;                    
        char    param[SEARCH_PARAM_MAX]; 
};

struct mpl_search {
        uint8_t len;
        char search[SEARCH_LEN_MAX];
};

#define MEDIA_PROXY_PLAYBACK_SPEED_MIN     -128
#define MEDIA_PROXY_PLAYBACK_SPEED_QUARTER -128
#define MEDIA_PROXY_PLAYBACK_SPEED_HALF    -64
#define MEDIA_PROXY_PLAYBACK_SPEED_UNITY   0
#define MEDIA_PROXY_PLAYBACK_SPEED_DOUBLE  64
#define MEDIA_PROXY_PLAYBACK_SPEED_MAX     127

#define MEDIA_PROXY_SEEKING_SPEED_FACTOR_MAX  64
#define MEDIA_PROXY_SEEKING_SPEED_FACTOR_MIN  4
#define MEDIA_PROXY_SEEKING_SPEED_FACTOR_ZERO 0

#define MEDIA_PROXY_PLAYING_ORDER_SINGLE_ONCE    0x01U
#define MEDIA_PROXY_PLAYING_ORDER_SINGLE_REPEAT  0x02U
#define MEDIA_PROXY_PLAYING_ORDER_INORDER_ONCE   0x03U
#define MEDIA_PROXY_PLAYING_ORDER_INORDER_REPEAT 0x04U
#define MEDIA_PROXY_PLAYING_ORDER_OLDEST_ONCE    0x05U
#define MEDIA_PROXY_PLAYING_ORDER_OLDEST_REPEAT  0x06U
#define MEDIA_PROXY_PLAYING_ORDER_NEWEST_ONCE    0x07U
#define MEDIA_PROXY_PLAYING_ORDER_NEWEST_REPEAT  0x08U
#define MEDIA_PROXY_PLAYING_ORDER_SHUFFLE_ONCE   0x09U
#define MEDIA_PROXY_PLAYING_ORDER_SHUFFLE_REPEAT 0x0AU

#define MEDIA_PROXY_PLAYING_ORDERS_SUPPORTED_SINGLE_ONCE    BIT(0U)
#define MEDIA_PROXY_PLAYING_ORDERS_SUPPORTED_SINGLE_REPEAT  BIT(1U)
#define MEDIA_PROXY_PLAYING_ORDERS_SUPPORTED_INORDER_ONCE   BIT(2U)
#define MEDIA_PROXY_PLAYING_ORDERS_SUPPORTED_INORDER_REPEAT BIT(3U)
#define MEDIA_PROXY_PLAYING_ORDERS_SUPPORTED_OLDEST_ONCE    BIT(4U)
#define MEDIA_PROXY_PLAYING_ORDERS_SUPPORTED_OLDEST_REPEAT  BIT(5U)
#define MEDIA_PROXY_PLAYING_ORDERS_SUPPORTED_NEWEST_ONCE    BIT(6U)
#define MEDIA_PROXY_PLAYING_ORDERS_SUPPORTED_NEWEST_REPEAT  BIT(7U)
#define MEDIA_PROXY_PLAYING_ORDERS_SUPPORTED_SHUFFLE_ONCE   BIT(8U)
#define MEDIA_PROXY_PLAYING_ORDERS_SUPPORTED_SHUFFLE_REPEAT BIT(9U)

#define MEDIA_PROXY_STATE_INACTIVE 0x00U
#define MEDIA_PROXY_STATE_PLAYING  0x01U
#define MEDIA_PROXY_STATE_PAUSED   0x02U
#define MEDIA_PROXY_STATE_SEEKING  0x03U
#define MEDIA_PROXY_STATE_LAST     0x04U

#define MEDIA_PROXY_OP_PLAY         0x01U
#define MEDIA_PROXY_OP_PAUSE        0x02U
#define MEDIA_PROXY_OP_FAST_REWIND  0x03U
#define MEDIA_PROXY_OP_FAST_FORWARD 0x04U
#define MEDIA_PROXY_OP_STOP         0x05U

#define MEDIA_PROXY_OP_MOVE_RELATIVE 0x10U

#define MEDIA_PROXY_OP_PREV_SEGMENT  0x20U
#define MEDIA_PROXY_OP_NEXT_SEGMENT  0x21U
#define MEDIA_PROXY_OP_FIRST_SEGMENT 0x22U
#define MEDIA_PROXY_OP_LAST_SEGMENT  0x23U
#define MEDIA_PROXY_OP_GOTO_SEGMENT  0x24U

#define MEDIA_PROXY_OP_PREV_TRACK  0x30U
#define MEDIA_PROXY_OP_NEXT_TRACK  0x31U
#define MEDIA_PROXY_OP_FIRST_TRACK 0x32U
#define MEDIA_PROXY_OP_LAST_TRACK  0x33U
#define MEDIA_PROXY_OP_GOTO_TRACK  0x34U

#define MEDIA_PROXY_OP_PREV_GROUP  0x40U
#define MEDIA_PROXY_OP_NEXT_GROUP  0x41U
#define MEDIA_PROXY_OP_FIRST_GROUP 0x42U
#define MEDIA_PROXY_OP_LAST_GROUP  0x43U
#define MEDIA_PROXY_OP_GOTO_GROUP  0x44U

#define MEDIA_PROXY_OPCODES_SUPPORTED_LEN 4U

#define MEDIA_PROXY_OP_SUP_PLAY         BIT(0U)
#define MEDIA_PROXY_OP_SUP_PAUSE        BIT(1U)
#define MEDIA_PROXY_OP_SUP_FAST_REWIND  BIT(2U)
#define MEDIA_PROXY_OP_SUP_FAST_FORWARD BIT(3U)
#define MEDIA_PROXY_OP_SUP_STOP         BIT(4U)

#define MEDIA_PROXY_OP_SUP_MOVE_RELATIVE BIT(5U)

#define MEDIA_PROXY_OP_SUP_PREV_SEGMENT  BIT(6U)
#define MEDIA_PROXY_OP_SUP_NEXT_SEGMENT  BIT(7U)
#define MEDIA_PROXY_OP_SUP_FIRST_SEGMENT BIT(8U)
#define MEDIA_PROXY_OP_SUP_LAST_SEGMENT  BIT(9U)
#define MEDIA_PROXY_OP_SUP_GOTO_SEGMENT  BIT(10U)

#define MEDIA_PROXY_OP_SUP_PREV_TRACK  BIT(11U)
#define MEDIA_PROXY_OP_SUP_NEXT_TRACK  BIT(12U)
#define MEDIA_PROXY_OP_SUP_FIRST_TRACK BIT(13U)
#define MEDIA_PROXY_OP_SUP_LAST_TRACK  BIT(14U)
#define MEDIA_PROXY_OP_SUP_GOTO_TRACK  BIT(15U)

#define MEDIA_PROXY_OP_SUP_PREV_GROUP  BIT(16U)
#define MEDIA_PROXY_OP_SUP_NEXT_GROUP  BIT(17U)
#define MEDIA_PROXY_OP_SUP_FIRST_GROUP BIT(18U)
#define MEDIA_PROXY_OP_SUP_LAST_GROUP  BIT(19U)
#define MEDIA_PROXY_OP_SUP_GOTO_GROUP  BIT(20U)

#define MEDIA_PROXY_CMD_SUCCESS             0x01U
#define MEDIA_PROXY_CMD_NOT_SUPPORTED       0x02U
#define MEDIA_PROXY_CMD_PLAYER_INACTIVE     0x03U
#define MEDIA_PROXY_CMD_CANNOT_BE_COMPLETED 0x04U

#define MEDIA_PROXY_SEARCH_TYPE_TRACK_NAME    0x01U
#define MEDIA_PROXY_SEARCH_TYPE_ARTIST_NAME   0x02U
#define MEDIA_PROXY_SEARCH_TYPE_ALBUM_NAME    0x03U
#define MEDIA_PROXY_SEARCH_TYPE_GROUP_NAME    0x04U
#define MEDIA_PROXY_SEARCH_TYPE_EARLIEST_YEAR 0x05U
#define MEDIA_PROXY_SEARCH_TYPE_LATEST_YEAR   0x06U
#define MEDIA_PROXY_SEARCH_TYPE_GENRE         0x07U
#define MEDIA_PROXY_SEARCH_TYPE_ONLY_TRACKS   0x08U
#define MEDIA_PROXY_SEARCH_TYPE_ONLY_GROUPS   0x09U

#define MEDIA_PROXY_SEARCH_SUCCESS 0x01U
#define MEDIA_PROXY_SEARCH_FAILURE 0x02U

#define MEDIA_PROXY_GROUP_OBJECT_TRACK_TYPE 0x00U
#define MEDIA_PROXY_GROUP_OBJECT_GROUP_TYPE 0x01U

struct media_player;
 
/* PUBLIC API FOR CONTROLLERS */

struct media_proxy_ctrl_cbs {

        void (*local_player_instance)(struct media_player *player, int err);
 
#ifdef CONFIG_MCTL_REMOTE_PLAYER_CONTROL
        void (*discover_player)(struct media_player *player, int err);
#endif /* CONFIG_MCTL_REMOTE_PLAYER_CONTROL */

        void (*player_name_recv)(struct media_player *player, int err, const char *name);

        void (*icon_id_recv)(struct media_player *player, int err, uint64_t id);

        void (*icon_url_recv)(struct media_player *player, int err, const char *url);

        void (*track_changed_recv)(struct media_player *player, int err);

        void (*track_title_recv)(struct media_player *player, int err, const char *title);

        void (*track_duration_recv)(struct media_player *player, int err, int32_t duration);

        void (*track_position_recv)(struct media_player *player, int err, int32_t position);

        void (*track_position_write)(struct media_player *player, int err, int32_t position);

        void (*playback_speed_recv)(struct media_player *player, int err, int8_t speed);

        void (*playback_speed_write)(struct media_player *player, int err, int8_t speed);

        void (*seeking_speed_recv)(struct media_player *player, int err, int8_t speed);

        void (*track_segments_id_recv)(struct media_player *player, int err, uint64_t id);

        void (*current_track_id_recv)(struct media_player *player, int err, uint64_t id);

        void (*current_track_id_write)(struct media_player *player, int err, uint64_t id);

        void (*next_track_id_recv)(struct media_player *player, int err, uint64_t id);

        void (*next_track_id_write)(struct media_player *player, int err, uint64_t id);

        void (*parent_group_id_recv)(struct media_player *player, int err, uint64_t id);

        void (*current_group_id_recv)(struct media_player *player, int err, uint64_t id);

        void (*current_group_id_write)(struct media_player *player, int err, uint64_t id);

        void (*playing_order_recv)(struct media_player *player, int err, uint8_t order);

        void (*playing_order_write)(struct media_player *player, int err, uint8_t order);

        void (*playing_orders_supported_recv)(struct media_player *player, int err,
                                              uint16_t orders);

        void (*media_state_recv)(struct media_player *player, int err, uint8_t state);

        void (*command_send)(struct media_player *player, int err, const struct mpl_cmd *cmd);

        void (*command_recv)(struct media_player *player, int err,
                             const struct mpl_cmd_ntf *result);

        void (*commands_supported_recv)(struct media_player *player, int err, uint32_t opcodes);

        void (*search_send)(struct media_player *player, int err, const struct mpl_search *search);

        void (*search_recv)(struct media_player *player, int err, uint8_t result_code);

        void (*search_results_id_recv)(struct media_player *player, int err, uint64_t id);

        void (*content_ctrl_id_recv)(struct media_player *player, int err, uint8_t ccid);
};

int media_proxy_ctrl_register(struct media_proxy_ctrl_cbs *ctrl_cbs);

int media_proxy_ctrl_discover_player(struct bt_conn *conn);

int media_proxy_ctrl_get_player_name(struct media_player *player);

int media_proxy_ctrl_get_icon_id(struct media_player *player);

int media_proxy_ctrl_get_icon_url(struct media_player *player);

int media_proxy_ctrl_get_track_title(struct media_player *player);

int media_proxy_ctrl_get_track_duration(struct media_player *player);

int media_proxy_ctrl_get_track_position(struct media_player *player);

int media_proxy_ctrl_set_track_position(struct media_player *player, int32_t position);

int media_proxy_ctrl_get_playback_speed(struct media_player *player);

int media_proxy_ctrl_set_playback_speed(struct media_player *player, int8_t speed);

int media_proxy_ctrl_get_seeking_speed(struct media_player *player);

int media_proxy_ctrl_get_track_segments_id(struct media_player *player);

int media_proxy_ctrl_get_current_track_id(struct media_player *player);

int media_proxy_ctrl_set_current_track_id(struct media_player *player, uint64_t id);

int media_proxy_ctrl_get_next_track_id(struct media_player *player);

int media_proxy_ctrl_set_next_track_id(struct media_player *player, uint64_t id);

int media_proxy_ctrl_get_parent_group_id(struct media_player *player);

int media_proxy_ctrl_get_current_group_id(struct media_player *player);

int media_proxy_ctrl_set_current_group_id(struct media_player *player, uint64_t id);

int media_proxy_ctrl_get_playing_order(struct media_player *player);

int media_proxy_ctrl_set_playing_order(struct media_player *player, uint8_t order);

int media_proxy_ctrl_get_playing_orders_supported(struct media_player *player);

int media_proxy_ctrl_get_media_state(struct media_player *player);

int media_proxy_ctrl_send_command(struct media_player *player, const struct mpl_cmd *command);

int media_proxy_ctrl_get_commands_supported(struct media_player *player);

int media_proxy_ctrl_send_search(struct media_player *player, const struct mpl_search *search);

int media_proxy_ctrl_get_search_results_id(struct media_player *player);

uint8_t media_proxy_ctrl_get_content_ctrl_id(struct media_player *player);

struct media_proxy_pl_calls {

        const char *(*get_player_name)(void);

        uint64_t (*get_icon_id)(void);

        const char *(*get_icon_url)(void);

        const char *(*get_track_title)(void);

        int32_t (*get_track_duration)(void);

        int32_t (*get_track_position)(void);

        void (*set_track_position)(int32_t position);

        int8_t (*get_playback_speed)(void);

        void (*set_playback_speed)(int8_t speed);

        int8_t (*get_seeking_speed)(void);

        uint64_t (*get_track_segments_id)(void);

        uint64_t (*get_current_track_id)(void);

        void (*set_current_track_id)(uint64_t id);

        uint64_t (*get_next_track_id)(void);

        void (*set_next_track_id)(uint64_t id);

        uint64_t (*get_parent_group_id)(void);

        uint64_t (*get_current_group_id)(void);

        void (*set_current_group_id)(uint64_t id);

        uint8_t (*get_playing_order)(void);

        void (*set_playing_order)(uint8_t order);

        uint16_t (*get_playing_orders_supported)(void);

        uint8_t (*get_media_state)(void);

        void (*send_command)(const struct mpl_cmd *command);

        uint32_t (*get_commands_supported)(void);

        void (*send_search)(const struct mpl_search *search);

        uint64_t (*get_search_results_id)(void);

        uint8_t (*get_content_ctrl_id)(void);
};

int media_proxy_pl_register(struct media_proxy_pl_calls *pl_calls);

int media_proxy_pl_init(void);

struct bt_ots *bt_mcs_get_ots(void);

void media_proxy_pl_name_cb(const char *name);

void media_proxy_pl_icon_url_cb(const char *url);

void media_proxy_pl_track_changed_cb(void);

void media_proxy_pl_track_title_cb(char *title);

void media_proxy_pl_track_duration_cb(int32_t duration);

void media_proxy_pl_track_position_cb(int32_t position);

void media_proxy_pl_playback_speed_cb(int8_t speed);

void media_proxy_pl_seeking_speed_cb(int8_t speed);

void media_proxy_pl_current_track_id_cb(uint64_t id);

void media_proxy_pl_next_track_id_cb(uint64_t id);

void media_proxy_pl_parent_group_id_cb(uint64_t id);

void media_proxy_pl_current_group_id_cb(uint64_t id);

void media_proxy_pl_playing_order_cb(uint8_t order);

void media_proxy_pl_media_state_cb(uint8_t state);

void media_proxy_pl_command_cb(const struct mpl_cmd_ntf *cmd_ntf);

void media_proxy_pl_commands_supported_cb(uint32_t opcodes);

void media_proxy_pl_search_cb(uint8_t result_code);

void media_proxy_pl_search_results_id_cb(uint64_t id);
 
#ifdef __cplusplus
}
#endif
 /* End of group bt_media_proxy */
 
#endif /* ZEPHYR_INCLUDE_BLUETOOTH_AUDIO_MEDIA_PROXY_H_ */