mcs.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_MCS_H_
#define ZEPHYR_INCLUDE_BLUETOOTH_AUDIO_MCS_H_

 
#include <zephyr/sys/util.h>
#include <zephyr/sys/util_macro.h>
 
#ifdef __cplusplus
extern "C" {
#endif

#define BT_MCS_ERR_LONG_VAL_CHANGED     0x80U

#define BT_MCS_PLAYBACK_SPEED_MIN     -128
#define BT_MCS_PLAYBACK_SPEED_QUARTER -128
#define BT_MCS_PLAYBACK_SPEED_HALF     -64
#define BT_MCS_PLAYBACK_SPEED_UNITY      0
#define BT_MCS_PLAYBACK_SPEED_DOUBLE    64
#define BT_MCS_PLAYBACK_SPEED_MAX      127

#define BT_MCS_SEEKING_SPEED_FACTOR_MAX  64
#define BT_MCS_SEEKING_SPEED_FACTOR_MIN   4
#define BT_MCS_SEEKING_SPEED_FACTOR_ZERO  0

#define BT_MCS_PLAYING_ORDER_SINGLE_ONCE    0x01U
#define BT_MCS_PLAYING_ORDER_SINGLE_REPEAT  0x02U
#define BT_MCS_PLAYING_ORDER_INORDER_ONCE   0x03U
#define BT_MCS_PLAYING_ORDER_INORDER_REPEAT 0x04U
#define BT_MCS_PLAYING_ORDER_OLDEST_ONCE    0x05U
#define BT_MCS_PLAYING_ORDER_OLDEST_REPEAT  0x06U
#define BT_MCS_PLAYING_ORDER_NEWEST_ONCE    0x07U
#define BT_MCS_PLAYING_ORDER_NEWEST_REPEAT  0x08U
#define BT_MCS_PLAYING_ORDER_SHUFFLE_ONCE   0x09U
#define BT_MCS_PLAYING_ORDER_SHUFFLE_REPEAT 0x0AU

#define BT_MCS_PLAYING_ORDERS_SUPPORTED_SINGLE_ONCE    BIT(0U)
#define BT_MCS_PLAYING_ORDERS_SUPPORTED_SINGLE_REPEAT  BIT(1U)
#define BT_MCS_PLAYING_ORDERS_SUPPORTED_INORDER_ONCE   BIT(2U)
#define BT_MCS_PLAYING_ORDERS_SUPPORTED_INORDER_REPEAT BIT(3U)
#define BT_MCS_PLAYING_ORDERS_SUPPORTED_OLDEST_ONCE    BIT(4U)
#define BT_MCS_PLAYING_ORDERS_SUPPORTED_OLDEST_REPEAT  BIT(5U)
#define BT_MCS_PLAYING_ORDERS_SUPPORTED_NEWEST_ONCE    BIT(6U)
#define BT_MCS_PLAYING_ORDERS_SUPPORTED_NEWEST_REPEAT  BIT(7U)
#define BT_MCS_PLAYING_ORDERS_SUPPORTED_SHUFFLE_ONCE   BIT(8U)
#define BT_MCS_PLAYING_ORDERS_SUPPORTED_SHUFFLE_REPEAT BIT(9U)

#define BT_MCS_MEDIA_STATE_INACTIVE 0x00U
#define BT_MCS_MEDIA_STATE_PLAYING  0x01U
#define BT_MCS_MEDIA_STATE_PAUSED   0x02U
#define BT_MCS_MEDIA_STATE_SEEKING  0x03U

#define BT_MCS_OPC_PLAY          0x01U
#define BT_MCS_OPC_PAUSE         0x02U
#define BT_MCS_OPC_FAST_REWIND   0x03U
#define BT_MCS_OPC_FAST_FORWARD  0x04U
#define BT_MCS_OPC_STOP          0x05U

#define BT_MCS_OPC_MOVE_RELATIVE 0x10U

#define BT_MCS_OPC_PREV_SEGMENT  0x20U
#define BT_MCS_OPC_NEXT_SEGMENT  0x21U
#define BT_MCS_OPC_FIRST_SEGMENT 0x22U
#define BT_MCS_OPC_LAST_SEGMENT  0x23U
#define BT_MCS_OPC_GOTO_SEGMENT  0x24U

#define BT_MCS_OPC_PREV_TRACK    0x30U
#define BT_MCS_OPC_NEXT_TRACK    0x31U
#define BT_MCS_OPC_FIRST_TRACK   0x32U
#define BT_MCS_OPC_LAST_TRACK    0x33U
#define BT_MCS_OPC_GOTO_TRACK    0x34U

#define BT_MCS_OPC_PREV_GROUP    0x40U
#define BT_MCS_OPC_NEXT_GROUP    0x41U
#define BT_MCS_OPC_FIRST_GROUP   0x42U
#define BT_MCS_OPC_LAST_GROUP    0x43U
#define BT_MCS_OPC_GOTO_GROUP    0x44U

#define BT_MCS_OPCODES_SUPPORTED_LEN 4U

#define BT_MCS_OPC_SUP_PLAY          BIT(0U)
#define BT_MCS_OPC_SUP_PAUSE         BIT(1U)
#define BT_MCS_OPC_SUP_FAST_REWIND   BIT(2U)
#define BT_MCS_OPC_SUP_FAST_FORWARD  BIT(3U)
#define BT_MCS_OPC_SUP_STOP          BIT(4U)

#define BT_MCS_OPC_SUP_MOVE_RELATIVE BIT(5U)

#define BT_MCS_OPC_SUP_PREV_SEGMENT  BIT(6U)
#define BT_MCS_OPC_SUP_NEXT_SEGMENT  BIT(7U)
#define BT_MCS_OPC_SUP_FIRST_SEGMENT BIT(8U)
#define BT_MCS_OPC_SUP_LAST_SEGMENT  BIT(9U)
#define BT_MCS_OPC_SUP_GOTO_SEGMENT  BIT(10U)

#define BT_MCS_OPC_SUP_PREV_TRACK    BIT(11U)
#define BT_MCS_OPC_SUP_NEXT_TRACK    BIT(12U)
#define BT_MCS_OPC_SUP_FIRST_TRACK   BIT(13U)
#define BT_MCS_OPC_SUP_LAST_TRACK    BIT(14U)
#define BT_MCS_OPC_SUP_GOTO_TRACK    BIT(15U)

#define BT_MCS_OPC_SUP_PREV_GROUP    BIT(16U)
#define BT_MCS_OPC_SUP_NEXT_GROUP    BIT(17U)
#define BT_MCS_OPC_SUP_FIRST_GROUP   BIT(18U)
#define BT_MCS_OPC_SUP_LAST_GROUP    BIT(19U)
#define BT_MCS_OPC_SUP_GOTO_GROUP    BIT(20U)

#define BT_MCS_OPC_NTF_SUCCESS             0x01U
#define BT_MCS_OPC_NTF_NOT_SUPPORTED       0x02U
#define BT_MCS_OPC_NTF_PLAYER_INACTIVE     0x03U
#define BT_MCS_OPC_NTF_CANNOT_BE_COMPLETED 0x04U

#define BT_MCS_SEARCH_TYPE_TRACK_NAME    0x01U
#define BT_MCS_SEARCH_TYPE_ARTIST_NAME   0x02U
#define BT_MCS_SEARCH_TYPE_ALBUM_NAME    0x03U
#define BT_MCS_SEARCH_TYPE_GROUP_NAME    0x04U
#define BT_MCS_SEARCH_TYPE_EARLIEST_YEAR 0x05U
#define BT_MCS_SEARCH_TYPE_LATEST_YEAR   0x06U
#define BT_MCS_SEARCH_TYPE_GENRE         0x07U
#define BT_MCS_SEARCH_TYPE_ONLY_TRACKS   0x08U
#define BT_MCS_SEARCH_TYPE_ONLY_GROUPS   0x09U

#define SEARCH_LEN_MIN 2U

#define SEARCH_LEN_MAX 64U

#define SEARCH_SCI_LEN_MIN 1   /* An SCI length can be as little as one byte,
                                * for an SCI that has only the type field.
                                * (The SCI len is the length of type + param.)
                                */

#define SEARCH_PARAM_MAX 62U

#define BT_MCS_SCP_NTF_SUCCESS  0x01U
#define BT_MCS_SCP_NTF_FAILURE  0x02U

#define BT_MCS_GROUP_OBJECT_TRACK_TYPE 0x00U
#define BT_MCS_GROUP_OBJECT_GROUP_TYPE 0x01U
 
#ifdef __cplusplus
}
#endif

 
#endif /* ZEPHYR_INCLUDE_BLUETOOTH_AUDIO_MCS_H_ */