RDKEMW-11232 getAudioFormatApi issue on Xione-UK by kiruba115 · Pull Request #188 · rdkcentral/devicesettings

kiruba115 · 2025-12-17T17:06:55Z

RDKEMW-11232 getAudioFormatApi issue on Xione-UK

Implement audio output port selection with priority.

Added debug output for audio port checks and updated fallback logic.

Rebase to latest

Copilot

Pull request overview

This pull request fixes an issue with the getAudioFormat API on Xione-UK by ensuring a valid audio port handle is passed instead of NULL. The fix introduces a new method to select the appropriate audio port based on platform configuration and connection status.

Changes:

Enhanced error logging in dsGetAudioFormat RPC handler to track failure scenarios
Added new getAudioPortHandle() method to intelligently select audio ports based on platform type and port availability
Modified getCurrentAudioFormat() to use the new port selection method instead of passing NULL

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 10 comments.

File	Description
rpc/srv/dsAudio.c	Improved error handling by storing return value and adding logging for failure cases
ds/include/host.hpp	Added declaration for new getAudioPortHandle() method
ds/include/audioOutputPort.hpp	Added getter method to expose internal _handle member and minor formatting changes
ds/host.cpp	Implemented getAudioPortHandle() with platform-specific port selection logic and updated getCurrentAudioFormat() to use it

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-01-12T18:36:54Z

ds/host.cpp

+   intptr_t Host::getAudioPortHandle()
+   {
+        try
+        {
+            if (isHDMIOutPortPresent())
+            {
+                AudioOutputPort aPort = getAudioOutputPort("HDMI0");
+                return aPort.getOutputPortHandle();
+            } 
+            else 
+            {
+                //TV profiles with multiple audio output ports
+                try
+                {
+                    // Define the priority order for audio ports
+                    const std::string portPriority[] = {"HDMI_ARC0", "HEADPHONE0", "SPDIF0"};
+
+                    // Try each port in priority order
+                    for (const auto& portName : portPriority)
+                    {
+                        try
+                        {
+                            AudioOutputPort aPort = getAudioOutputPort(portName);
+							cout << "Checking audio port: " << portName << " isEnabled: " << aPort.isEnabled() << " isConnected: " << aPort.isConnected() << "\n";
+                            // Check if port is enabled and connected
+                            if (aPort.isEnabled() && aPort.isConnected())
+                            {
+                                cout << "Using audio port: " << portName << "\n";
+                                return aPort.getOutputPortHandle();
+                            }
+                        }
+                        catch(const std::exception& e)
+                        {
+                            // Port not found or error accessing it, continue to next port
+                            continue;
+                        }
+                    }
+
+                    // Fallback: use SPEAKER0 if no other port is suitable
+                    AudioOutputPort fallback_aPort = getAudioOutputPort("SPEAKER0");
+					cout << "Using audio port: SPEAKER0" << "\n";
+                    return fallback_aPort.getOutputPortHandle();
+                }
+                catch(const std::exception& e)
+                {
+                    cout << " Exception Thrown in getAudioPortHandle().. returning NULL...!\n";
+                }
+
+                return NULL;
+            }
+        }
+        catch(const std::exception& e)
+        {
+            cout << " Exception Thrown in getAudioPortHandle().. returning NULL...!\n";
+        }
+
+        return NULL;
+   }


The new method getAudioPortHandle() lacks test coverage. Consider adding test cases in test/testHost.cpp to verify the port selection logic, including scenarios for HDMI out presence, priority-based port selection, enabled/connected state checks, and fallback behavior.

Copilot · 2026-01-12T18:36:54Z

ds/host.cpp

+                        try
+                        {
+                            AudioOutputPort aPort = getAudioOutputPort(portName);
+							cout << "Checking audio port: " << portName << " isEnabled: " << aPort.isEnabled() << " isConnected: " << aPort.isConnected() << "\n";


The indentation is inconsistent, using tabs instead of spaces like the surrounding code. Lines 411, 428 use tabs for indentation while the rest of the function uses spaces. This should be consistent with the file's indentation style.

Copilot · 2026-01-12T18:36:54Z

ds/host.cpp

+
+                    // Fallback: use SPEAKER0 if no other port is suitable
+                    AudioOutputPort fallback_aPort = getAudioOutputPort("SPEAKER0");
+					cout << "Using audio port: SPEAKER0" << "\n";


The indentation is inconsistent, using tabs instead of spaces like the surrounding code. This should be consistent with the file's indentation style.

Copilot · 2026-01-12T18:36:54Z

ds/host.cpp

+                catch(const std::exception& e)
+                {
+                    cout << " Exception Thrown in getAudioPortHandle().. returning NULL...!\n";


The exception variable 'e' is caught but never used. Consider logging the exception message using e.what() to provide better debugging information, similar to other exception handlers in this file (e.g., line 141 in manager.cpp).

Copilot · 2026-01-12T18:36:54Z

ds/host.cpp

+                    cout << " Exception Thrown in getAudioPortHandle().. returning NULL...!\n";
+                }
+
+                return NULL;


The return statement at line 436 is unreachable code. If getAudioOutputPort("SPEAKER0") at line 427 succeeds, the function returns at line 429. If it throws an exception, it's caught at line 431, which then falls through to the outer catch block at line 439 or returns NULL at line 444. This return statement can never be executed and should be removed.

ds/include/audioOutputPort.hpp

Copilot · 2026-01-12T18:36:55Z

ds/host.cpp

       dsAudioFormat_t aFormat;
-
-       ret = dsGetAudioFormat(NULL, &aFormat);
+	   intptr_t audioPortHandle = getAudioPortHandle();	


The indentation is inconsistent, using tabs instead of spaces like the surrounding code. This should be consistent with the file's indentation style.

Suggested change

intptr_t audioPortHandle = getAudioPortHandle();

intptr_t audioPortHandle = getAudioPortHandle();

Copilot · 2026-01-12T18:36:55Z

ds/host.cpp

@@ -385,6 +385,65 @@ Host::~Host()
        return std::string(socID);
   }



The new method getAudioPortHandle() is missing documentation. It should have a doxygen-style comment block describing its purpose, return value, and any exceptions it may throw, consistent with other methods in this file.

Suggested change

/**

* @fn Host::getAudioPortHandle()

* @brief Get the handle of the active audio output port.

*

* This API selects an appropriate audio output port and returns its

* underlying handle. On platforms with an HDMI output port, the handle

* for HDMI0 is returned. On TV profiles with multiple audio output ports,

* the ports are checked in the following priority order:

* HDMI_ARC0, HEADPHONE0, SPDIF0. The first port that is enabled and

* connected is used. If none of these ports are suitable, SPEAKER0 is

* used as a fallback.

*

* @return intptr_t Handle of the selected audio output port on success.

* @return NULL If no suitable audio port handle can be obtained or if

* an error occurs while resolving the port.

*

* @exception std::exception Exceptions from underlying audio port queries

* are caught and cause this method to return NULL.

*/

ds/host.cpp

Copilot · 2026-01-12T18:36:56Z

ds/host.cpp

+        catch(const std::exception& e)
+        {
+            cout << " Exception Thrown in getAudioPortHandle().. returning NULL...!\n";
+        }


The exception variable 'e' is caught but never used. Consider logging the exception message using e.what() to provide better debugging information, similar to other exception handlers in this file (e.g., line 141 in manager.cpp).

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

RDKEMW-11232 getAudioFormatApi issue on Xione-UK

6d4e4c3

kiruba115 requested a review from a team as a code owner December 17, 2025 17:06

kiruba115 added 5 commits January 6, 2026 14:33

Add priority-based audio output port selection

6964da0

Implement audio output port selection with priority.

Declare aPort as AudioOutputPort type

9164109

Enhance audio port logging and fallback handling

fa9773d

Added debug output for audio port checks and updated fallback logic.

Merge pull request #196 from rdkcentral/develop

b9f39d1

Rebase to latest

Check current audio format based on active AudioOutput port

d971ae3

kiruba115 requested a review from apatel859 January 12, 2026 17:41

apatel859 requested a review from Copilot January 12, 2026 18:32

Copilot started reviewing on behalf of apatel859 January 12, 2026 18:33 View session

Copilot AI reviewed Jan 12, 2026

View reviewed changes

kiruba115 and others added 5 commits January 12, 2026 13:42

Update ds/include/audioOutputPort.hpp

4ebcd0b

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update ds/host.cpp

15991c7

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Address code review comments

677ba71

Update host.cpp

716f9f3

Remove unnecessary try-catch block

b02b077

apatel859 approved these changes Jan 12, 2026

View reviewed changes

apatel859 merged commit 5dd27d7 into develop Jan 12, 2026
8 of 9 checks passed

github-actions bot locked and limited conversation to collaborators Jan 12, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Comments

RDKEMW-11232 getAudioFormatApi issue on Xione-UK#188

RDKEMW-11232 getAudioFormatApi issue on Xione-UK#188
apatel859 merged 11 commits intodevelopfrom
topic/RDKEMW-11232-getAudioFormat-Issue

kiruba115 commented Dec 17, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jan 12, 2026

Uh oh!

Copilot AI Jan 12, 2026

Uh oh!

Copilot AI Jan 12, 2026

Uh oh!

Copilot AI Jan 12, 2026

Uh oh!

Copilot AI Jan 12, 2026

Uh oh!

Uh oh!

Copilot AI Jan 12, 2026

Uh oh!

Copilot AI Jan 12, 2026

Uh oh!

Uh oh!

Copilot AI Jan 12, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	intptr_t audioPortHandle = getAudioPortHandle();
	intptr_t audioPortHandle = getAudioPortHandle();

		@@ -385,6 +385,65 @@ Host::~Host()
		return std::string(socID);
		}

+   /**
+    * @fn Host::getAudioPortHandle()
+    * @brief Get the handle of the active audio output port.
+    *
+    * This API selects an appropriate audio output port and returns its
+    * underlying handle. On platforms with an HDMI output port, the handle
+    * for HDMI0 is returned. On TV profiles with multiple audio output ports,
+    * the ports are checked in the following priority order:
+    * HDMI_ARC0, HEADPHONE0, SPDIF0. The first port that is enabled and
+    * connected is used. If none of these ports are suitable, SPEAKER0 is
+    * used as a fallback.
+    *
+    * @return intptr_t Handle of the selected audio output port on success.
+    * @return NULL If no suitable audio port handle can be obtained or if
+    *         an error occurs while resolving the port.
+    *
+    * @exception std::exception Exceptions from underlying audio port queries
+    *            are caught and cause this method to return NULL.
+    */

Comments

Conversation

kiruba115 commented Dec 17, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Jan 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 12, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI Jan 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 12, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI Jan 12, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants