Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bluetooth: Audio: Rename bt_audio_codec_qos -> bt_bap_qos_cfg #76633

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Thalley
Copy link
Collaborator

@Thalley Thalley commented Aug 2, 2024

The QoS structure is not related to a codec, but rather a stream, and should thus not use the "Codec" name.

The BAP and ASCS specs refer to the QoS as
"QoS configuration" several places, so it is an obvious choice for a name.

Since the structure is defined and used by BAP, the prefix was changed from bt_audio to bt_bap.

fixes #72684

Comment on lines +252 to +264
* Unlike the other fields, this is not a preference but a minimum requirement.
*
* Value range 0 to @ref BT_AUDIO_PD_MAX, or @ref BT_AUDIO_PD_PREF_NONE
* to indicate no preference.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The documentation for the presentation delay fields seem wrong. Although fixing this is not strictly part of this PR it may as well be done here, instead of creating a separate PR for fixing it.

Suggested change
* Unlike the other fields, this is not a preference but a minimum requirement.
*
* Value range 0 to @ref BT_AUDIO_PD_MAX, or @ref BT_AUDIO_PD_PREF_NONE
* to indicate no preference.
* Unlike the other fields, this is not a preference but a minimum requirement.
*
* Value range 0 to @ref BT_AUDIO_PD_MIN

/**
* @brief Preferred minimum Presentation Delay
*
* Value range 0 to @ref BT_AUDIO_PD_MAX.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Value range 0 to @ref BT_AUDIO_PD_MAX.
* Value range pd_min to pref_pd_max, or @ref BT_AUDIO_PD_PREF_NONE
* to indicate no preference.

Comment on lines +264 to +274
* Value range 0 to @ref BT_AUDIO_PD_MAX, or @ref BT_AUDIO_PD_PREF_NONE
* to indicate no preference.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Value range 0 to @ref BT_AUDIO_PD_MAX, or @ref BT_AUDIO_PD_PREF_NONE
* to indicate no preference.
* Value range 0 to @ref BT_AUDIO_PD_MAX

/**
* @brief Preferred maximum Presentation Delay
*
* Value range 0 to @ref BT_AUDIO_PD_MAX.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Value range 0 to @ref BT_AUDIO_PD_MAX.
* Value range pref_pd_min to px_max, or @ref BT_AUDIO_PD_PREF_NONE
* to indicate no preference.

uint32_t pd_min;

/**
* @brief Maximum Presentation Delay
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* @brief Maximum Presentation Delay
* @brief Maximum Presentation Delay in microseconds

uint32_t pd_max;

/**
* @brief Preferred minimum Presentation Delay
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* @brief Preferred minimum Presentation Delay
* @brief Preferred minimum Presentation Delay in microseconds

uint32_t pref_pd_min;

/**
* @brief Preferred maximum Presentation Delay
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* @brief Preferred maximum Presentation Delay
* @brief Preferred maximum Presentation Delay in microseconds

@hermabe hermabe removed their request for review August 9, 2024 11:46
@Thalley
Copy link
Collaborator Author

Thalley commented Aug 13, 2024

@kruithofa would prefer not to modify more than necessary in this PR. It will likely conflict with #75763 and once one of them is one, I can update the remaining PR with your comments.

@Thalley Thalley requested a review from kruithofa August 13, 2024 12:22
kruithofa
kruithofa previously approved these changes Aug 14, 2024
Copy link
Collaborator

@kruithofa kruithofa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The comments will be handled in a separate PR, that's ok with me.

@Thalley
Copy link
Collaborator Author

Thalley commented Aug 14, 2024

Rebased to solve merge conflicts

@Thalley Thalley requested a review from kruithofa August 14, 2024 09:48
@zephyrbot zephyrbot added the area: Bluetooth Qualification Bluetooth Qualification -related issues and pull requests label Aug 14, 2024
kruithofa
kruithofa previously approved these changes Aug 15, 2024
@Thalley
Copy link
Collaborator Author

Thalley commented Sep 2, 2024

Rebased to fix merge conflicts

kruithofa
kruithofa previously approved these changes Sep 3, 2024
kruithofa
kruithofa previously approved these changes Sep 5, 2024
@Thalley
Copy link
Collaborator Author

Thalley commented Sep 9, 2024

Rebased to solve merge conflicts

kruithofa
kruithofa previously approved these changes Sep 9, 2024
@Thalley
Copy link
Collaborator Author

Thalley commented Sep 11, 2024

Rebased to solve merge conflicts

@Thalley
Copy link
Collaborator Author

Thalley commented Sep 23, 2024

Rebased to solve merge conflicts

kruithofa
kruithofa previously approved these changes Sep 24, 2024
The QoS structure is not related to a codec, but rather a
stream, and should thus not use the "Codec" name.

The BAP and ASCS specs refer to the QoS as
"QoS configuration" several places, so it is an obvious
choice for a name.

Since the structure is defined and used by BAP, the prefix
was changed from bt_audio to bt_bap.

Signed-off-by: Emil Gydesen <emil.gydesen@nordicsemi.no>
@Thalley
Copy link
Collaborator Author

Thalley commented Sep 27, 2024

Rebased to solve merge conflicts

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: Bluetooth Audio area: Bluetooth Qualification Bluetooth Qualification -related issues and pull requests area: Bluetooth area: Samples Samples Release Notes To be mentioned in the release notes
Projects
Status: In Review
Development

Successfully merging this pull request may close these issues.

LE Audio: Rename struct bt_audio_codec_qos
4 participants