vcs.h

Go to the documentation of this file.

/*
 * Copyright (c) 2020-2021 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_BLUETOOTH_SERVICES_VCS_H_
#define ZEPHYR_INCLUDE_BLUETOOTH_SERVICES_VCS_H_
 
#include <zephyr/types.h>
#include <bluetooth/audio/aics.h>
#include <bluetooth/audio/vocs.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#if defined(CONFIG_BT_VCS)
#define BT_VCS_VOCS_CNT CONFIG_BT_VCS_VOCS_INSTANCE_COUNT
#define BT_VCS_AICS_CNT CONFIG_BT_VCS_AICS_INSTANCE_COUNT
#else
#define BT_VCS_VOCS_CNT 0
#define BT_VCS_AICS_CNT 0
#endif /* CONFIG_BT_VCS */
 
#define BT_VCS_ERR_INVALID_COUNTER             0x80
#define BT_VCS_ERR_OP_NOT_SUPPORTED            0x81
 
#define BT_VCS_STATE_UNMUTED                   0x00
#define BT_VCS_STATE_MUTED                     0x01
 
struct bt_vcs;
 
struct bt_vcs_register_param {
        uint8_t step;
 
        uint8_t mute;
 
        uint8_t volume;
 
        struct bt_vocs_register_param vocs_param[BT_VCS_VOCS_CNT];
 
        struct bt_aics_register_param aics_param[BT_VCS_AICS_CNT];
 
        struct bt_vcs_cb *cb;
};
 
struct bt_vcs_included {
        uint8_t vocs_cnt;
        struct bt_vocs **vocs;
 
        uint8_t aics_cnt;
        struct bt_aics **aics;
};
 
int bt_vcs_register(struct bt_vcs_register_param *param, struct bt_vcs **vcs);
 
int bt_vcs_included_get(struct bt_vcs *vcs, struct bt_vcs_included *included);
 
int bt_vcs_client_conn_get(const struct bt_vcs *vcs, struct bt_conn **conn);
 
typedef void (*bt_vcs_discover_cb)(struct bt_vcs *vcs, int err,
                                   uint8_t vocs_count, uint8_t aics_count);
 
typedef void (*bt_vcs_state_cb)(struct bt_vcs *vcs, int err, uint8_t volume,
                                uint8_t mute);
 
typedef void (*bt_vcs_flags_cb)(struct bt_vcs *vcs, int err, uint8_t flags);
 
typedef void (*bt_vcs_write_cb)(struct bt_vcs *vcs, int err);
 
struct bt_vcs_cb {
        /* Volume Control Service */
        bt_vcs_state_cb               state;
        bt_vcs_flags_cb               flags;
#if defined(CONFIG_BT_VCS_CLIENT)
        bt_vcs_discover_cb            discover;
        bt_vcs_write_cb               vol_down;
        bt_vcs_write_cb               vol_up;
        bt_vcs_write_cb               mute;
        bt_vcs_write_cb               unmute;
        bt_vcs_write_cb               vol_down_unmute;
        bt_vcs_write_cb               vol_up_unmute;
        bt_vcs_write_cb               vol_set;
 
        /* Volume Offset Control Service */
        struct bt_vocs_cb             vocs_cb;
 
        /* Audio Input Control Service */
        struct bt_aics_cb             aics_cb;
#endif /* CONFIG_BT_VCS_CLIENT */
};
 
int bt_vcs_discover(struct bt_conn *conn, struct bt_vcs **vcs);
 
int bt_vcs_vol_step_set(uint8_t volume_step);
 
int bt_vcs_vol_get(struct bt_vcs *vcs);
 
int bt_vcs_flags_get(struct bt_vcs *vcs);
 
int bt_vcs_vol_down(struct bt_vcs *vcs);
 
int bt_vcs_vol_up(struct bt_vcs *vcs);
 
int bt_vcs_unmute_vol_down(struct bt_vcs *vcs);
 
int bt_vcs_unmute_vol_up(struct bt_vcs *vcs);
 
int bt_vcs_vol_set(struct bt_vcs *vcs, uint8_t volume);
 
int bt_vcs_unmute(struct bt_vcs *vcs);
 
int bt_vcs_mute(struct bt_vcs *vcs);
 
int bt_vcs_vocs_state_get(struct bt_vcs *vcs, struct bt_vocs *inst);
 
int bt_vcs_vocs_location_get(struct bt_vcs *vcs, struct bt_vocs *inst);
 
int bt_vcs_vocs_location_set(struct bt_vcs *vcs, struct bt_vocs *inst,
                             uint8_t location);
 
int bt_vcs_vocs_state_set(struct bt_vcs *vcs, struct bt_vocs *inst,
                          int16_t offset);
 
int bt_vcs_vocs_description_get(struct bt_vcs *vcs, struct bt_vocs *inst);
 
int bt_vcs_vocs_description_set(struct bt_vcs *vcs, struct bt_vocs *inst,
                                const char *description);
 
int bt_vcs_aics_deactivate(struct bt_vcs *vcs, struct bt_aics *inst);
 
int bt_vcs_aics_activate(struct bt_vcs *vcs, struct bt_aics *inst);
 
int bt_vcs_aics_state_get(struct bt_vcs *vcs, struct bt_aics *inst);
 
int bt_vcs_aics_gain_setting_get(struct bt_vcs *vcs, struct bt_aics *inst);
 
int bt_vcs_aics_type_get(struct bt_vcs *vcs, struct bt_aics *inst);
 
int bt_vcs_aics_status_get(struct bt_vcs *vcs, struct bt_aics *inst);
 
int bt_vcs_aics_mute(struct bt_vcs *vcs, struct bt_aics *inst);
 
int bt_vcs_aics_unmute(struct bt_vcs *vcs, struct bt_aics *inst);
 
int bt_vcs_aics_manual_gain_set(struct bt_vcs *vcs, struct bt_aics *inst);
 
int bt_vcs_aics_automatic_gain_set(struct bt_vcs *vcs, struct bt_aics *inst);
 
int bt_vcs_aics_gain_set(struct bt_vcs *vcs, struct bt_aics *inst,
                         int8_t gain);
 
int bt_vcs_aics_description_get(struct bt_vcs *vcs, struct bt_aics *inst);
 
int bt_vcs_aics_description_set(struct bt_vcs *vcs, struct bt_aics *inst,
                                const char *description);
 
int bt_vcs_client_cb_register(struct bt_vcs_cb *cb);
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_BLUETOOTH_SERVICES_VCS_H_ */