diff mbox series

[BlueZ,v4,1/8] doc/media: Add 'broadcasting' state and 'select' method

Message ID 20240730140947.411655-2-vlad.pruteanu@nxp.com
State Superseded
Headers show
Series Add 'broadcasting' state | expand

Commit Message

Vlad Pruteanu July 30, 2024, 2:09 p.m. UTC 
This adds a new state for transports created by the Broadcast
Sink. Such transports will remain  in the 'idle' state until the
user calls 'select' on them, at which point they will be moved to
'broadcasting'. This allows the user to select the desired BIS as
the audio server automatically acquires transports that are in this
state.
---
 doc/org.bluez.MediaTransport.rst | 18 +++++++++++++++++-
 1 file changed, 17 insertions(+), 1 deletion(-)

Comments

Pauli Virtanen July 30, 2024, 6:45 p.m. UTC | #1 
Hi,

ti, 2024-07-30 kello 17:09 +0300, Vlad Pruteanu kirjoitti:
> This adds a new state for transports created by the Broadcast
> Sink. Such transports will remain  in the 'idle' state until the
> user calls 'select' on them, at which point they will be moved to
> 'broadcasting'. This allows the user to select the desired BIS as
> the audio server automatically acquires transports that are in this
> state.
> ---
>  doc/org.bluez.MediaTransport.rst | 18 +++++++++++++++++-
>  1 file changed, 17 insertions(+), 1 deletion(-)
> 
> diff --git a/doc/org.bluez.MediaTransport.rst b/doc/org.bluez.MediaTransport.rst
> index 6e95df8f2..c23d1f59f 100644
> --- a/doc/org.bluez.MediaTransport.rst
> +++ b/doc/org.bluez.MediaTransport.rst
> @@ -7,7 +7,7 @@ BlueZ D-Bus MediaTransport API documentation
>  --------------------------------------------
>  
>  :Version: BlueZ
> -:Date: September 2023
> +:Date: July 2024
>  :Manual section: 5
>  :Manual group: Linux System Administration
>  
> @@ -51,6 +51,20 @@ void Release()
>  
>  	Releases file descriptor.
>  
> +void Select_transport()

In the code I see the DBus method names actually are:

Select()
Unselect()

The DBus names are also conventionally in CamelCase().

> +```````````````````````
> +
> +	Applicable only for transports created by a broadcast sink. This moves
> +	the transport from 'idle' to 'broadcasting'. This allows the user to
> +	select which BISes he wishes to sync to via a 2 step process:
> +	1) the user calls this method, changing the transport's state to idle
> +	2) the audio server detects that the transport is in the 'broadcasting'
> +	state and automatically acquires it
> +
> +	Possible Errors:
> +
> +	:org.bluez.Error.NotAuthorized:
> +
>  Properties
>  ----------
>  
> @@ -84,6 +98,8 @@ string State [readonly]
>  
>  	:"idle": not streaming
>  	:"pending": streaming but not acquired
> +	:"broadcasting": streaming but not acquired, applicable only for transports
> +		created by a broadcast sink
>  	:"active": streaming and acquired
>  
>  uint16 Delay [readwrite, optional]
bluez.test.bot@gmail.com July 30, 2024, 6:47 p.m. UTC | #2 
This is automated email and please do not reply to this email!

Dear submitter,

Thank you for submitting the patches to the linux bluetooth mailing list.
This is a CI test results with your patch series:
PW Link:https://patchwork.kernel.org/project/bluetooth/list/?series=875092

---Test result---

Test Summary:
CheckPatch                    FAIL      3.29 seconds
GitLint                       PASS      2.08 seconds
BuildEll                      PASS      24.72 seconds
BluezMake                     PASS      1729.78 seconds
MakeCheck                     PASS      13.71 seconds
MakeDistcheck                 PASS      182.09 seconds
CheckValgrind                 PASS      251.51 seconds
CheckSmatch                   PASS      355.43 seconds
bluezmakeextell               PASS      121.61 seconds
IncrementalBuild              PASS      12670.36 seconds
ScanBuild                     PASS      1027.60 seconds

Details
##############################
Test: CheckPatch - FAIL
Desc: Run checkpatch.pl script
Output:
[BlueZ,v4,3/8] transport: Add "select" method
ERROR:SPACING: need consistent spacing around '*' (ctx:WxV)
#128: FILE: profiles/audio/transport.c:975:
+static DBusMessage *select_transport(DBusConnection *conn, DBusMessage *msg,
                    ^

ERROR:SPACING: need consistent spacing around '*' (ctx:WxV)
#128: FILE: profiles/audio/transport.c:975:
+static DBusMessage *select_transport(DBusConnection *conn, DBusMessage *msg,
                                                     ^

ERROR:SPACING: need consistent spacing around '*' (ctx:WxV)
#128: FILE: profiles/audio/transport.c:975:
+static DBusMessage *select_transport(DBusConnection *conn, DBusMessage *msg,
                                                                        ^

/github/workspace/src/src/13747448.patch total: 3 errors, 0 warnings, 42 lines checked

NOTE: For some of the reported defects, checkpatch may be able to
      mechanically convert to the typical style using --fix or --fix-inplace.

/github/workspace/src/src/13747448.patch has style problems, please review.

NOTE: Ignored message types: COMMIT_MESSAGE COMPLEX_MACRO CONST_STRUCT FILE_PATH_CHANGES MISSING_SIGN_OFF PREFER_PACKED SPDX_LICENSE_TAG SPLIT_STRING SSCANF_TO_KSTRTO

NOTE: If any of the errors are false positives, please report
      them to the maintainer, see CHECKPATCH in MAINTAINERS.




---
Regards,
Linux Bluetooth
Vlad Pruteanu July 31, 2024, 6:16 a.m. UTC | #3 
Hello,

> -----Original Message-----
> From: Pauli Virtanen <pav@iki.fi>
> Sent: Tuesday, July 30, 2024 9:45 PM
> To: Vlad Pruteanu <vlad.pruteanu@nxp.com>; linux-bluetooth@vger.kernel.org
> Cc: Mihai-Octavian Urzica <mihai-octavian.urzica@nxp.com>; Iulia Tanasescu
> <iulia.tanasescu@nxp.com>; Andrei Istodorescu <andrei.istodorescu@nxp.com>;
> luiz.dentz@gmail.com
> Subject: [EXT] Re: [PATCH BlueZ v4 1/8] doc/media: Add 'broadcasting' state and
> 'select' method
> 
> Caution: This is an external email. Please take care when clicking links or opening
> attachments. When in doubt, report the message using the 'Report this email'
> button
> 
> 
> Hi,
> 
> ti, 2024-07-30 kello 17:09 +0300, Vlad Pruteanu kirjoitti:
> > This adds a new state for transports created by the Broadcast
> > Sink. Such transports will remain  in the 'idle' state until the
> > user calls 'select' on them, at which point they will be moved to
> > 'broadcasting'. This allows the user to select the desired BIS as
> > the audio server automatically acquires transports that are in this
> > state.
> > ---
> >  doc/org.bluez.MediaTransport.rst | 18 +++++++++++++++++-
> >  1 file changed, 17 insertions(+), 1 deletion(-)
> >
> > diff --git a/doc/org.bluez.MediaTransport.rst
> b/doc/org.bluez.MediaTransport.rst
> > index 6e95df8f2..c23d1f59f 100644
> > --- a/doc/org.bluez.MediaTransport.rst
> > +++ b/doc/org.bluez.MediaTransport.rst
> > @@ -7,7 +7,7 @@ BlueZ D-Bus MediaTransport API documentation
> >  --------------------------------------------
> >
> >  :Version: BlueZ
> > -:Date: September 2023
> > +:Date: July 2024
> >  :Manual section: 5
> >  :Manual group: Linux System Administration
> >
> > @@ -51,6 +51,20 @@ void Release()
> >
> >       Releases file descriptor.
> >
> > +void Select_transport()
> 
> In the code I see the DBus method names actually are:
> 
> Select()
> Unselect()
Thank you for pointing this out, it appears that I mistakenly used the names
of the actual functions from transport.c

> 
> The DBus names are also conventionally in CamelCase().
> 
> > +```````````````````````
> > +
> > +     Applicable only for transports created by a broadcast sink. This moves
> > +     the transport from 'idle' to 'broadcasting'. This allows the user to
> > +     select which BISes he wishes to sync to via a 2 step process:
> > +     1) the user calls this method, changing the transport's state to idle
> > +     2) the audio server detects that the transport is in the 'broadcasting'
> > +     state and automatically acquires it
> > +
> > +     Possible Errors:
> > +
> > +     :org.bluez.Error.NotAuthorized:
> > +
> >  Properties
> >  ----------
> >
> > @@ -84,6 +98,8 @@ string State [readonly]
> >
> >       :"idle": not streaming
> >       :"pending": streaming but not acquired
> > +     :"broadcasting": streaming but not acquired, applicable only for transports
> > +             created by a broadcast sink
> >       :"active": streaming and acquired
> >
> >  uint16 Delay [readwrite, optional]
> 
> --
> Pauli Virtanen

Regards,
Vlad
diff mbox series

Patch

diff --git a/doc/org.bluez.MediaTransport.rst b/doc/org.bluez.MediaTransport.rst
index 6e95df8f2..c23d1f59f 100644
--- a/doc/org.bluez.MediaTransport.rst
+++ b/doc/org.bluez.MediaTransport.rst
@@ -7,7 +7,7 @@  BlueZ D-Bus MediaTransport API documentation
 --------------------------------------------
 
 :Version: BlueZ
-:Date: September 2023
+:Date: July 2024
 :Manual section: 5
 :Manual group: Linux System Administration
 
@@ -51,6 +51,20 @@  void Release()
 
 	Releases file descriptor.
 
+void Select_transport()
+```````````````````````
+
+	Applicable only for transports created by a broadcast sink. This moves
+	the transport from 'idle' to 'broadcasting'. This allows the user to
+	select which BISes he wishes to sync to via a 2 step process:
+	1) the user calls this method, changing the transport's state to idle
+	2) the audio server detects that the transport is in the 'broadcasting'
+	state and automatically acquires it
+
+	Possible Errors:
+
+	:org.bluez.Error.NotAuthorized:
+
 Properties
 ----------
 
@@ -84,6 +98,8 @@  string State [readonly]
 
 	:"idle": not streaming
 	:"pending": streaming but not acquired
+	:"broadcasting": streaming but not acquired, applicable only for transports
+		created by a broadcast sink
 	:"active": streaming and acquired
 
 uint16 Delay [readwrite, optional]