[BlueZ,1/2] transport: add CIG/CIS/PHY properties, don't show unset QoS properties

Add CIG, CIS, and PHY properties to BAP transport.  The other QoS
properties are there, and these may also be useful to clients, e.g.  to
manage CIG/CIS allocation as client.

Hide transport QoS properties when they are not configured.
---
 profiles/audio/transport.c | 67 ++++++++++++++++++++++++++++++++++----
 1 file changed, 61 insertions(+), 6 deletions(-)

Hi Pauli,

On Wed, Mar 15, 2023 at 10:54 AM Pauli Virtanen <pav@iki.fi> wrote:
>
> Add CIG, CIS, and PHY properties to BAP transport.  The other QoS
> properties are there, and these may also be useful to clients, e.g.  to
> manage CIG/CIS allocation as client.
>
> Hide transport QoS properties when they are not configured.
> ---
>  profiles/audio/transport.c | 67 ++++++++++++++++++++++++++++++++++----
>  1 file changed, 61 insertions(+), 6 deletions(-)
>
> diff --git a/profiles/audio/transport.c b/profiles/audio/transport.c
> index 457590746..53bf13175 100644
> --- a/profiles/audio/transport.c
> +++ b/profiles/audio/transport.c
> @@ -811,6 +811,38 @@ static const GDBusPropertyTable a2dp_properties[] = {
>         { }
>  };
>
> +static gboolean qos_exists(const GDBusPropertyTable *property, void *data)
> +{
> +       struct media_transport *transport = data;
> +       struct bap_transport *bap = transport->data;
> +
> +       return bap->qos.phy != 0x00;
> +}
> +
> +static gboolean get_cig(const GDBusPropertyTable *property,
> +                                       DBusMessageIter *iter, void *data)
> +{
> +       struct media_transport *transport = data;
> +       struct bap_transport *bap = transport->data;
> +
> +       dbus_message_iter_append_basic(iter, DBUS_TYPE_BYTE,
> +                                                       &bap->qos.cig_id);
> +
> +       return TRUE;
> +}
> +
> +static gboolean get_cis(const GDBusPropertyTable *property,
> +                                       DBusMessageIter *iter, void *data)
> +{
> +       struct media_transport *transport = data;
> +       struct bap_transport *bap = transport->data;
> +
> +       dbus_message_iter_append_basic(iter, DBUS_TYPE_BYTE,
> +                                                       &bap->qos.cis_id);
> +
> +       return TRUE;
> +}
> +
>  static gboolean get_interval(const GDBusPropertyTable *property,
>                                         DBusMessageIter *iter, void *data)
>  {
> @@ -835,6 +867,17 @@ static gboolean get_framing(const GDBusPropertyTable *property,
>         return TRUE;
>  }
>
> +static gboolean get_phy(const GDBusPropertyTable *property,
> +                                       DBusMessageIter *iter, void *data)
> +{
> +       struct media_transport *transport = data;
> +       struct bap_transport *bap = transport->data;
> +
> +       dbus_message_iter_append_basic(iter, DBUS_TYPE_BYTE, &bap->qos.phy);
> +
> +       return TRUE;
> +}
> +
>  static gboolean get_sdu(const GDBusPropertyTable *property,
>                                         DBusMessageIter *iter, void *data)
>  {
> @@ -962,12 +1005,15 @@ static const GDBusPropertyTable bap_properties[] = {
>         { "Codec", "y", get_codec },
>         { "Configuration", "ay", get_configuration },
>         { "State", "s", get_state },
> -       { "Interval", "u", get_interval },
> -       { "Framing", "b", get_framing },
> -       { "SDU", "q", get_sdu },
> -       { "Retransmissions", "y", get_retransmissions },
> -       { "Latency", "q", get_latency },
> -       { "Delay", "u", get_delay },
> +       { "CIG", "y", get_cig, NULL, qos_exists },
> +       { "CIS", "y", get_cis, NULL, qos_exists },
> +       { "Interval", "u", get_interval, NULL, qos_exists },
> +       { "Framing", "b", get_framing, NULL, qos_exists },
> +       { "PHY", "y", get_phy, NULL, qos_exists },
> +       { "SDU", "q", get_sdu, NULL, qos_exists },
> +       { "Retransmissions", "y", get_retransmissions, NULL, qos_exists },
> +       { "Latency", "q", get_latency, NULL, qos_exists },
> +       { "Delay", "u", get_delay, NULL, qos_exists },
>         { "Endpoint", "o", get_endpoint, NULL, endpoint_exists },
>         { "Location", "u", get_location },
>         { "Metadata", "ay", get_metadata },
> @@ -1191,12 +1237,21 @@ static void bap_update_qos(const struct media_transport *transport)
>
>         bap->qos = *qos;
>
> +       g_dbus_emit_property_changed(btd_get_dbus_connection(),
> +                       transport->path, MEDIA_TRANSPORT_INTERFACE,
> +                       "CIG");
> +       g_dbus_emit_property_changed(btd_get_dbus_connection(),
> +                       transport->path, MEDIA_TRANSPORT_INTERFACE,
> +                       "CIS");
>         g_dbus_emit_property_changed(btd_get_dbus_connection(),
>                         transport->path, MEDIA_TRANSPORT_INTERFACE,
>                         "Interval");
>         g_dbus_emit_property_changed(btd_get_dbus_connection(),
>                         transport->path, MEDIA_TRANSPORT_INTERFACE,
>                         "Framing");
> +       g_dbus_emit_property_changed(btd_get_dbus_connection(),
> +                       transport->path, MEDIA_TRANSPORT_INTERFACE,
> +                       "PHY");
>         g_dbus_emit_property_changed(btd_get_dbus_connection(),
>                         transport->path, MEDIA_TRANSPORT_INTERFACE,
>                         "SDU");
> --
> 2.39.2

I'm fine adding these but you could also have used BT_ISO_QOS
socketopt to read it directly from the socket in case you want to use
it on pipewire.

Hi Luiz,

ke, 2023-03-15 kello 11:19 -0700, Luiz Augusto von Dentz kirjoitti:
> Hi Pauli,
> 
> On Wed, Mar 15, 2023 at 10:54 AM Pauli Virtanen <pav@iki.fi> wrote:
> > 
> > Add CIG, CIS, and PHY properties to BAP transport.  The other QoS
> > properties are there, and these may also be useful to clients, e.g.  to
> > manage CIG/CIS allocation as client.
> > 
> > Hide transport QoS properties when they are not configured.
> > ---
> >  profiles/audio/transport.c | 67 ++++++++++++++++++++++++++++++++++----
> >  1 file changed, 61 insertions(+), 6 deletions(-)
> > 
> > diff --git a/profiles/audio/transport.c b/profiles/audio/transport.c
> > index 457590746..53bf13175 100644
> > --- a/profiles/audio/transport.c
> > +++ b/profiles/audio/transport.c
> > @@ -811,6 +811,38 @@ static const GDBusPropertyTable a2dp_properties[] = {
> >         { }
> >  };
> > 
> > +static gboolean qos_exists(const GDBusPropertyTable *property, void *data)
> > +{
> > +       struct media_transport *transport = data;
> > +       struct bap_transport *bap = transport->data;
> > +
> > +       return bap->qos.phy != 0x00;
> > +}
> > +
> > +static gboolean get_cig(const GDBusPropertyTable *property,
> > +                                       DBusMessageIter *iter, void *data)
> > +{
> > +       struct media_transport *transport = data;
> > +       struct bap_transport *bap = transport->data;
> > +
> > +       dbus_message_iter_append_basic(iter, DBUS_TYPE_BYTE,
> > +                                                       &bap->qos.cig_id);
> > +
> > +       return TRUE;
> > +}
> > +
> > +static gboolean get_cis(const GDBusPropertyTable *property,
> > +                                       DBusMessageIter *iter, void *data)
> > +{
> > +       struct media_transport *transport = data;
> > +       struct bap_transport *bap = transport->data;
> > +
> > +       dbus_message_iter_append_basic(iter, DBUS_TYPE_BYTE,
> > +                                                       &bap->qos.cis_id);
> > +
> > +       return TRUE;
> > +}
> > +
> >  static gboolean get_interval(const GDBusPropertyTable *property,
> >                                         DBusMessageIter *iter, void *data)
> >  {
> > @@ -835,6 +867,17 @@ static gboolean get_framing(const GDBusPropertyTable *property,
> >         return TRUE;
> >  }
> > 
> > +static gboolean get_phy(const GDBusPropertyTable *property,
> > +                                       DBusMessageIter *iter, void *data)
> > +{
> > +       struct media_transport *transport = data;
> > +       struct bap_transport *bap = transport->data;
> > +
> > +       dbus_message_iter_append_basic(iter, DBUS_TYPE_BYTE, &bap->qos.phy);
> > +
> > +       return TRUE;
> > +}
> > +
> >  static gboolean get_sdu(const GDBusPropertyTable *property,
> >                                         DBusMessageIter *iter, void *data)
> >  {
> > @@ -962,12 +1005,15 @@ static const GDBusPropertyTable bap_properties[] = {
> >         { "Codec", "y", get_codec },
> >         { "Configuration", "ay", get_configuration },
> >         { "State", "s", get_state },
> > -       { "Interval", "u", get_interval },
> > -       { "Framing", "b", get_framing },
> > -       { "SDU", "q", get_sdu },
> > -       { "Retransmissions", "y", get_retransmissions },
> > -       { "Latency", "q", get_latency },
> > -       { "Delay", "u", get_delay },
> > +       { "CIG", "y", get_cig, NULL, qos_exists },
> > +       { "CIS", "y", get_cis, NULL, qos_exists },
> > +       { "Interval", "u", get_interval, NULL, qos_exists },
> > +       { "Framing", "b", get_framing, NULL, qos_exists },
> > +       { "PHY", "y", get_phy, NULL, qos_exists },
> > +       { "SDU", "q", get_sdu, NULL, qos_exists },
> > +       { "Retransmissions", "y", get_retransmissions, NULL, qos_exists },
> > +       { "Latency", "q", get_latency, NULL, qos_exists },
> > +       { "Delay", "u", get_delay, NULL, qos_exists },
> >         { "Endpoint", "o", get_endpoint, NULL, endpoint_exists },
> >         { "Location", "u", get_location },
> >         { "Metadata", "ay", get_metadata },
> > @@ -1191,12 +1237,21 @@ static void bap_update_qos(const struct media_transport *transport)
> > 
> >         bap->qos = *qos;
> > 
> > +       g_dbus_emit_property_changed(btd_get_dbus_connection(),
> > +                       transport->path, MEDIA_TRANSPORT_INTERFACE,
> > +                       "CIG");
> > +       g_dbus_emit_property_changed(btd_get_dbus_connection(),
> > +                       transport->path, MEDIA_TRANSPORT_INTERFACE,
> > +                       "CIS");
> >         g_dbus_emit_property_changed(btd_get_dbus_connection(),
> >                         transport->path, MEDIA_TRANSPORT_INTERFACE,
> >                         "Interval");
> >         g_dbus_emit_property_changed(btd_get_dbus_connection(),
> >                         transport->path, MEDIA_TRANSPORT_INTERFACE,
> >                         "Framing");
> > +       g_dbus_emit_property_changed(btd_get_dbus_connection(),
> > +                       transport->path, MEDIA_TRANSPORT_INTERFACE,
> > +                       "PHY");
> >         g_dbus_emit_property_changed(btd_get_dbus_connection(),
> >                         transport->path, MEDIA_TRANSPORT_INTERFACE,
> >                         "SDU");
> > --
> > 2.39.2
> 
> I'm fine adding these but you could also have used BT_ISO_QOS
> socketopt to read it directly from the socket in case you want to use
> it on pipewire.

Yes, we can do that once we have the fd.

But if client wants to do CIG+CIS allocation in its SelectProperties,
it needs to know already reserved CIG+CIS. Acquiring the fd moves ASEs
out from qos state, which is not wanted for this.

Also, no Acquire call will return until all CIS in the same CIG have
been connected. To acquire the right transports (only those in the same
CIG), we need to know CIGs of all transports before starting to acquire
any. So we don't have any fds at that point.

Managing that probably should be responsibility of BlueZ, it could
connect all CIS in the same CIG when one of the transports is acquired.
Or, try address it in kernel but maybe that has more constraints.

But I think these properties can be added regardless of the above,
given that they have some uses also otherwise.

Hi,

ke, 2023-03-15 kello 11:32 -0700, Luiz Augusto von Dentz kirjoitti:
> On Wed, Mar 15, 2023 at 10:54 AM Pauli Virtanen <pav@iki.fi> wrote:
> > 
> > Document the transport QoS properties. Fix documentation of Delay, it's
> > microseconds for ISO.
> > ---
> >  doc/media-api.txt | 44 ++++++++++++++++++++++++++++++++++++++++++--
> >  1 file changed, 42 insertions(+), 2 deletions(-)
> > 
> > diff --git a/doc/media-api.txt b/doc/media-api.txt
> > index 281f72c1e..eac7f081c 100644
> > --- a/doc/media-api.txt
> > +++ b/doc/media-api.txt
> > @@ -773,12 +773,17 @@ Properties        object Device [readonly]
> >                                 "pending": streaming but not acquired
> >                                 "active": streaming and acquired
> > 
> > -               uint16 Delay [readwrite]
> > +               uint16 Delay [A2DP only, readwrite, optional]
> > 
> > -                       Optional. Transport delay in 1/10 of millisecond, this
> > +                       For A2DP: transport delay in 1/10 of millisecond. This
> >                         property is only writeable when the transport was
> >                         acquired by the sender.
> > 
> > +               uint32 Delay [ISO only, optional]
> > +
> > +                       For ISO, presentation delay in microseconds.
> > +                       Note the value type is different for ISO and A2DP.
> > +
> 
> I don't think D-Bus introspection allows polymorphism of properties,
> so either we just use uint16 and limit the maximum delay to 65K or we
> have say it is in milliseconds given that in most cases the presets
> have the Presentation Delay as a round number.

How about renaming the property to PresentationDelay in ISO transports?
I think it would clearest to keep it as it is in BAP.

For A2DP changing away from the 1/10 ms unit breaks things.

> >                 uint16 Volume [readwrite]
> > 
> >                         Optional. Indicates volume level of the transport,
> > @@ -804,3 +809,38 @@ Properties object Device [readonly]
> > 
> >                         Linked transport objects which the transport is
> >                         associated with.
> > +
> > +               byte CIG [ISO only, optional, experimental]
> > +
> > +                       Indicates configured QoS CIG.
> > +                       Only present when QoS is configured.
> > +
> > +               byte CIS [ISO only, optional, experimental]
> > +
> > +                       Indicates configured QoS CIS.
> > +                       Only present when QoS is configured.
> > +
> > +               byte Interval [ISO only, optional, experimental]
> > +
> > +                       Indicates configured QoS interval.
> > +                       Only present when QoS is configured.
> 
> This should be uint32

Indeed...

> 
> > +               byte Framing [ISO only, optional, experimental]
> > +
> > +                       Indicates configured QoS framing.
> > +                       Only present when QoS is configured.
> > +
> > +               byte PHY [ISO only, optional, experimental]
> > +
> > +                       Indicates configured QoS PHY.
> > +                       Only present when QoS is configured.
> > +
> > +               uint32 Retransmissions [ISO only, optional, experimental]
> > +
> > +                       Indicates configured QoS retransmissions.
> > +                       Only present when QoS is configured.
> 
> And this should be byte
> 
> > +               uint32 Latency [ISO only, optional, experimental]
> > +
> > +                       Indicates configured QoS latency.
> > +                       Only present when QoS is configured.
> 
> uint16
> 
> > --
> > 2.39.2
> > 
> 
>