Commit be307f8a authored by Emil Gydesen's avatar Emil Gydesen Committed by Anas Nashif
Browse files

Bluetooth: Audio: Change lang to 3-byte value from uint32_t 



The 3-byte value suits the assigned number much better,
and also allows for less memory copies when getting and
setting the values.

Signed-off-by: default avatarEmil Gydesen <emil.gydesen@nordicsemi.no>
parent f08bc644

doc/releases/migration-guide-3.7.rst

+10 −0
Original line number Diff line number Diff line
@@ -514,6 +514,16 @@ Bluetooth Audio 


  (:github:`72584`)



* Changed ``lang`` from ``uint32_t`` to ``uint8_t [3]``. This modifies the following functions:



  * :c:func:`bt_audio_codec_cap_meta_set_lang`

  * :c:func:`bt_audio_codec_cap_meta_get_lang`

  * :c:func:`bt_audio_codec_cfg_meta_set_lang`

  * :c:func:`bt_audio_codec_cfg_meta_get_lang`



  The result of this is that string values such as ``"eng"`` and ``"deu"`` can now be used to set

  new values, and to prevent unnecessary copies of data when getting the values. (:github:`72584`)



* All occurrences of ``set_sirk`` have been changed to just ``sirk`` as the ``s`` in ``sirk`` stands

  for set. (:github:`73413`)

include/zephyr/bluetooth/audio/audio.h

+17 −7
Original line number Diff line number Diff line
@@ -48,6 +48,9 @@ extern "C" { 


#define BT_AUDIO_BROADCAST_CODE_SIZE             16



/** Size of the stream language value, e.g. "eng" */

#define BT_AUDIO_LANG_SIZE 3



/**

 * @brief Codec capability types

 *
@@ -383,6 +386,7 @@ enum bt_audio_metadata_type { 
	/** @brief Language

	 *

	 * 3 octet lower case language code defined by ISO 639-3

	 * Possible values can be found at https://iso639-3.sil.org/code_tables/639/data

	 */

	BT_AUDIO_METADATA_TYPE_LANG                = 0x04,
@@ -1254,14 +1258,16 @@ int bt_audio_codec_cfg_meta_set_program_info(struct bt_audio_codec_cfg *codec_cf 
 *

 *  See @ref BT_AUDIO_METADATA_TYPE_LANG for more information about this value.

 *

 *  @param codec_cfg The codec data to search in.

 *  @param[in]  codec_cfg The codec data to search in.

 *  @param[out] lang      Pointer to the language bytes (of length BT_AUDIO_LANG_SIZE)

 *

 *  @retval The language if positive or 0

 *  @retval -EINVAL if arguments are invalid

 *  @retval -ENODATA if not found

 *  @retval -EBADMSG if found value has invalid size

 */

int bt_audio_codec_cfg_meta_get_lang(const struct bt_audio_codec_cfg *codec_cfg);

int bt_audio_codec_cfg_meta_get_lang(const struct bt_audio_codec_cfg *codec_cfg,

				     const uint8_t **lang);



/**

 * @brief Set the language of a codec configuration metadata.
@@ -1273,7 +1279,8 @@ int bt_audio_codec_cfg_meta_get_lang(const struct bt_audio_codec_cfg *codec_cfg) 
 * @retval -EINVAL if arguments are invalid

 * @retval -ENOMEM if the new value could not set or added due to memory

 */

int bt_audio_codec_cfg_meta_set_lang(struct bt_audio_codec_cfg *codec_cfg, uint32_t lang);

int bt_audio_codec_cfg_meta_set_lang(struct bt_audio_codec_cfg *codec_cfg,

				     const uint8_t lang[BT_AUDIO_LANG_SIZE]);



/** @brief Extract CCID list

 *
@@ -1776,14 +1783,16 @@ int bt_audio_codec_cap_meta_set_program_info(struct bt_audio_codec_cap *codec_ca 
 *

 *  See @ref BT_AUDIO_METADATA_TYPE_LANG for more information about this value.

 *

 *  @param codec_cap The codec data to search in.

 *  @param[in]  codec_cap The codec data to search in.

 *  @param[out] lang      Pointer to the language bytes (of length BT_AUDIO_LANG_SIZE)

 *

 *  @retval The language if positive or 0

 *  @retval 0 On success

 *  @retval -EINVAL if arguments are invalid

 *  @retval -ENODATA if not found

 *  @retval -EBADMSG if found value has invalid size

 */

int bt_audio_codec_cap_meta_get_lang(const struct bt_audio_codec_cap *codec_cap);

int bt_audio_codec_cap_meta_get_lang(const struct bt_audio_codec_cap *codec_cap,

				     const uint8_t **lang);



/**

 * @brief Set the language of a codec capability metadata.
@@ -1795,7 +1804,8 @@ int bt_audio_codec_cap_meta_get_lang(const struct bt_audio_codec_cap *codec_cap) 
 * @retval -EINVAL if arguments are invalid

 * @retval -ENOMEM if the new value could not set or added due to memory

 */

int bt_audio_codec_cap_meta_set_lang(struct bt_audio_codec_cap *codec_cap, uint32_t lang);

int bt_audio_codec_cap_meta_set_lang(struct bt_audio_codec_cap *codec_cap,

				     const uint8_t lang[BT_AUDIO_LANG_SIZE]);



/** @brief Extract CCID list

 *

subsys/bluetooth/audio/ascs.c

+1 −1
Original line number Diff line number Diff line
@@ -2113,7 +2113,7 @@ static bool ascs_parse_metadata(struct bt_data *data, void *user_data) 
		break;

	}

	case BT_AUDIO_METADATA_TYPE_LANG:

		if (data_len != 3) {

		if (data_len != BT_AUDIO_LANG_SIZE) {

			*result->rsp = BT_BAP_ASCS_RSP(BT_BAP_ASCS_RSP_CODE_METADATA_INVALID,

						       data_type);

			result->err = -EBADMSG;

subsys/bluetooth/audio/codec.c

+26 −18
Original line number Diff line number Diff line
@@ -804,7 +804,7 @@ static int codec_meta_set_program_info(uint8_t meta[], size_t meta_len, size_t m 
				  program_info, program_info_len);

}



static int codec_meta_get_lang(const uint8_t meta[], size_t meta_len)

static int codec_meta_get_lang(const uint8_t meta[], size_t meta_len, const uint8_t **lang)

{

	const uint8_t *data;

	int ret;
@@ -814,36 +814,40 @@ static int codec_meta_get_lang(const uint8_t meta[], size_t meta_len) 
		return -EINVAL;

	}



	CHECKIF(lang == NULL) {

		LOG_DBG("lang is NULL");

		return -EINVAL;

	}



	ret = codec_meta_get_val(meta, meta_len, BT_AUDIO_METADATA_TYPE_LANG, &data);

	if (data == NULL) {

		return -ENODATA;

	}



	if (ret != 3) { /* Language is 3 octets */

	if (ret != BT_AUDIO_LANG_SIZE) {

		return -EBADMSG;

	}



	return sys_get_le24(data);

	*lang = data;



	return 0;

}



static int codec_meta_set_lang(uint8_t meta[], size_t meta_len, size_t meta_size, uint32_t lang)

static int codec_meta_set_lang(uint8_t meta[], size_t meta_len, size_t meta_size,

			       const uint8_t lang[BT_AUDIO_LANG_SIZE])

{

	uint8_t lang_le[3];



	CHECKIF(meta == NULL) {

		LOG_DBG("meta is NULL");

		return -EINVAL;

	}



	if ((lang & 0xFFFFFFU) != lang) {

		LOG_DBG("Invalid lang value: %d", lang);

	CHECKIF(lang == NULL) {

		LOG_DBG("lang is NULL");

		return -EINVAL;

	}



	sys_put_le24(lang, lang_le);



	return codec_meta_set_val(meta, meta_len, meta_size, BT_AUDIO_METADATA_TYPE_LANG, lang_le,

				  sizeof(lang_le));

	return codec_meta_set_val(meta, meta_len, meta_size, BT_AUDIO_METADATA_TYPE_LANG, lang,

				  BT_AUDIO_LANG_SIZE);

}



static int codec_meta_get_ccid_list(const uint8_t meta[], size_t meta_len,
@@ -1255,17 +1259,19 @@ int bt_audio_codec_cfg_meta_set_program_info(struct bt_audio_codec_cfg *codec_cf 
	return ret;

}



int bt_audio_codec_cfg_meta_get_lang(const struct bt_audio_codec_cfg *codec_cfg)

int bt_audio_codec_cfg_meta_get_lang(const struct bt_audio_codec_cfg *codec_cfg,

				     const uint8_t **lang)

{

	CHECKIF(codec_cfg == NULL) {

		LOG_DBG("codec_cfg is NULL");

		return -EINVAL;

	}



	return codec_meta_get_lang(codec_cfg->meta, codec_cfg->meta_len);

	return codec_meta_get_lang(codec_cfg->meta, codec_cfg->meta_len, lang);

}



int bt_audio_codec_cfg_meta_set_lang(struct bt_audio_codec_cfg *codec_cfg, uint32_t lang)

int bt_audio_codec_cfg_meta_set_lang(struct bt_audio_codec_cfg *codec_cfg,

				     const uint8_t lang[BT_AUDIO_LANG_SIZE])

{

	int ret;
@@ -1581,17 +1587,19 @@ int bt_audio_codec_cap_meta_set_program_info(struct bt_audio_codec_cap *codec_ca 
	return ret;

}



int bt_audio_codec_cap_meta_get_lang(const struct bt_audio_codec_cap *codec_cap)

int bt_audio_codec_cap_meta_get_lang(const struct bt_audio_codec_cap *codec_cap,

				     const uint8_t **lang)

{

	CHECKIF(codec_cap == NULL) {

		LOG_DBG("codec_cap is NULL");

		return -EINVAL;

	}



	return codec_meta_get_lang(codec_cap->meta, codec_cap->meta_len);

	return codec_meta_get_lang(codec_cap->meta, codec_cap->meta_len, lang);

}



int bt_audio_codec_cap_meta_set_lang(struct bt_audio_codec_cap *codec_cap, uint32_t lang)

int bt_audio_codec_cap_meta_set_lang(struct bt_audio_codec_cap *codec_cap,

				     const uint8_t lang[BT_AUDIO_LANG_SIZE])

{

	int ret;

subsys/bluetooth/audio/shell/audio.h

+8 −11
Original line number Diff line number Diff line
@@ -373,14 +373,11 @@ static inline void print_codec_meta_program_info(const struct shell *sh, size_t 
	shell_fprintf(sh, SHELL_NORMAL, "\n");

}



static inline void print_codec_meta_language(const struct shell *sh, size_t indent, uint32_t lang)

static inline void print_codec_meta_language(const struct shell *sh, size_t indent,

					     const uint8_t lang[BT_AUDIO_LANG_SIZE])

{

	uint8_t lang_array[3];



	sys_put_be24(lang, lang_array);



	shell_print(sh, "%*sLanguage: %c%c%c", indent, "", (char)lang_array[0], (char)lang_array[1],

		    (char)lang_array[2]);

	shell_print(sh, "%*sLanguage: %c%c%c", indent, "", (char)lang[0], (char)lang[1],

		    (char)lang[2]);

}



static inline void print_codec_meta_ccid_list(const struct shell *sh, size_t indent,
@@ -732,9 +729,9 @@ static inline void print_codec_cap(const struct shell *sh, size_t indent, 
			print_codec_meta_program_info(sh, indent, data, (uint8_t)ret);

		}



		ret = bt_audio_codec_cap_meta_get_lang(codec_cap);

		ret = bt_audio_codec_cap_meta_get_lang(codec_cap, &data);

		if (ret >= 0) {

			print_codec_meta_language(sh, indent, (uint32_t)ret);

			print_codec_meta_language(sh, indent, data);

		}



		ret = bt_audio_codec_cap_meta_get_ccid_list(codec_cap, &data);
@@ -968,9 +965,9 @@ static inline void print_codec_cfg(const struct shell *sh, size_t indent, 
			print_codec_meta_program_info(sh, indent, data, (uint8_t)ret);

		}



		ret = bt_audio_codec_cfg_meta_get_lang(codec_cfg);

		ret = bt_audio_codec_cfg_meta_get_lang(codec_cfg, &data);

		if (ret >= 0) {

			print_codec_meta_language(sh, indent, (uint32_t)ret);

			print_codec_meta_language(sh, indent, data);

		}



		ret = bt_audio_codec_cfg_meta_get_ccid_list(codec_cfg, &data);

CRA Git | Maintained and supported by SUSTech CRA and CCSE