Merge plainbox-provider-checkbox:fix-audio-test-get-source-sink-ids into plainbox-provider-checkbox:master

[Yao Wei]

bin:audio_test.py: use pactl get-default-source and get-default-sink

This is to make getting default source/sink more reliable instead of manually filtering through the list.

[Kai-Chuan Hsieh (kchsieh)]

Hello Yao,

I tested on KRPL-SFF-DVT-C1_202208-30552, it will show
ubuntu@ubuntu:~$ pactl get-default-sink
alsa_output.pci-0000_00_1f.3.analog-stereo
ubuntu@ubuntu:~$ pactl get-default-source
alsa_output.pci-0000_00_1f.3.analog-stereo.monitor

The original logic seems filter out monitor.
Will it impact the result if you just return the output of $ pactl get-default-{sink,source}?

Thanks,

[Yao Wei (medicalwei)]

The command that controls the volume and unmutes

pactl set-source-volume
pactl set-source-mute
pactl set-sink-volume
pactl set-sink-mute

can actually use the identifier string (instead of numeric ID) to change the settings.

However, your concern is correct that it should disregard .monitor from the default source. It's now updated that if default source contains .monitor in the end of the string, it would return None.

[jeremyszu (os369510)]

@Wei,

This seems good to me, could you please move it to
https://github.com/canonical/checkbox
?

[Atlas Yu (pseudoc)]

I run the related test job on some platform, and the unmute logic is not working properly, and the get-default-{source,sink} could solve this problem perfectly.

Unmerged commits

47ff52c... by Yao Wei on 2022-10-07

bin:audio_test.py: use pactl get-default-source and get-default-sink

diff --git a/bin/audio_test.py b/bin/audio_test.py
index 4b3f89c..c229a4d 100755
--- a/bin/audio_test.py
+++ b/bin/audio_test.py
@@ -128,10 +128,12 @@ class PAVolumeController(object):
             return False
         if not self.identifier:
             return False
-        command = ['pactl',
-                   'set-%s-volume' % (self.pa_types[self.type]),
-                   str(self.identifier[0]),
-                   str(int(volume)) + "%"]
+        command = [
+            "pactl",
+            "set-%s-volume" % (self.pa_types[self.type]),
+            self.identifier,
+            str(int(volume)) + "%",
+        ]
         self._pactl_output(command)
         self._volume = volume
         return True
@@ -145,10 +147,12 @@ class PAVolumeController(object):
         mute = str(int(mute))
         if not self.identifier:
             return False
-        command = ['pactl',
-                   'set-%s-mute' % (self.pa_types[self.type]),
-                   str(self.identifier[0]),
-                   mute]
+        command = [
+            "pactl",
+            "set-%s-mute" % (self.pa_types[self.type]),
+            self.identifier,
+            mute,
+        ]
         self._pactl_output(command)
         return True
 
@@ -156,46 +160,38 @@ class PAVolumeController(object):
         if self.type:
             self.identifier = self._get_identifier_for(self.type)
             if self.identifier and self.logger:
-                message = "Using PulseAudio identifier %s (%s) for %s" %\
-                       (self.identifier + (self.type,))
+                message = "Using PulseAudio identifier %s for %s" % (
+                    self.identifier,
+                    self.type,
+                )
                 self.logger.info(message)
             return self.identifier
 
     def _get_identifier_for(self, type):
         """Gets default PulseAudio identifier for given type.
 
-           Arguments:
-           type: either input or output
+        Arguments:
+        type: either input or output
 
-           Returns:
-           A tuple: (pa_id, pa_description)
+        Returns:
+        A string: device_name
 
         """
 
         if type not in self.pa_types:
             return None
-        command = ['pactl', 'list', self.pa_types[type] + "s", 'short']
-
-        # Expect lines of this form (field separator is tab):
-        # <ID>\t<NAME>\t<MODULE>\t<SAMPLE_SPEC_WITH_SPACES>\t<STATE>
-        # What we need to return is the ID for the first element on this list
-        # that does not contain auto_null or monitor.
-        pa_info = self._pactl_output(command)
-        valid_elements = None
-
-        if pa_info:
-            reject_regex = '.*(monitor|auto_null).*'
-            valid_elements = [element for element in pa_info.splitlines()
-                              if not re.match(reject_regex, element)]
-        if not valid_elements:
+
+        command = ["pactl", "get-default-" + self.pa_types[type]]
+        name = self._pactl_output(command).strip()
+        if name.startswith("auto_null") or name.endswith(".monitor"):
             if self.logger:
-                self.logger.error("No valid PulseAudio elements"
-                                  " for %s" % (self.type))
+                self.logger.error(
+                    "Default PulseAudio element for %s is invalid (%s)"
+                    % (self.type, name)
+                )
             return None
-        # We only need the pulseaudio numeric ID and long name for each element
-        valid_elements = [(int(e.split()[0]), e.split()[1])
-                          for e in valid_elements]
-        return valid_elements[0]
+
+        return name
 
     def _pactl_output(self, command):
         # This method mainly calls pactl (hence the name). Since pactl may