audio_AudioAfterReboot.py revision fb08fe0a5296a6d24db6c7e25f7e41b6ea8104e3 
1# Copyright 2015 The Chromium OS Authors. All rights reserved.
2# Use of this source code is governed by a BSD-style license that can be
3# found in the LICENSE file.
4
5"""This is a server side audio test using the Chameleon board."""
6
7import logging
8import os
9import time
10
11from autotest_lib.client.bin import utils
12from autotest_lib.client.cros.chameleon import audio_test_utils
13from autotest_lib.client.cros.chameleon import audio_widget_link
14from autotest_lib.client.cros.chameleon import chameleon_audio_helper
15from autotest_lib.client.cros.chameleon import chameleon_audio_ids
16from autotest_lib.server.cros.audio import audio_test
17
18
19class audio_AudioAfterReboot(audio_test.AudioTest):
20    """Server side audio test.
21
22    This test talks to a Chameleon board and a Cros device to verify
23    audio function of the Cros device after reboot.
24
25    """
26    version = 1
27    DELAY_BEFORE_RECORD_SECONDS = 0.5
28    DELAY_AFTER_BINDING = 0.5
29    RECORD_SECONDS = 5
30    SHORT_WAIT = 2
31    PRC_RECONNECT_TIMEOUT = 60
32
33    def action_plug_jack(self, plug_state):
34        """Calls the audio interface API and plugs/unplugs.
35
36        @param plug_state: plug state to switch to
37
38        """
39        logging.debug('Plugging' if plug_state else 'Unplugging')
40        jack_plugger = self.audio_board.get_jack_plugger()
41        if plug_state:
42            jack_plugger.plug()
43        else:
44            jack_plugger.unplug()
45        time.sleep(self.SHORT_WAIT)
46
47
48    def play_and_record(self, source_widget, recorder_widget=None):
49        """Plays and records (if needed) audio.
50
51        @param source_widget: widget to do the playback
52        @param recorder_widget: widget to do the recording
53            None to skip recording.
54
55        """
56        self.check_correct_audio_node_selected()
57
58        # Play, wait for some time, and then start recording if needed.
59        source_widget.set_playback_data(self.golden_file)
60        logging.debug('Start playing %s', self.golden_file.path)
61        source_widget.start_playback()
62
63        if recorder_widget != None:
64            time.sleep(self.DELAY_BEFORE_RECORD_SECONDS)
65            logging.debug('Start recording.')
66            recorder_widget.start_recording()
67
68            time.sleep(self.RECORD_SECONDS)
69
70            recorder_widget.stop_recording()
71            logging.debug('Stopped recording.')
72
73            audio_test_utils.dump_cros_audio_logs(
74                    self.host, self.audio_facade, self.resultsdir,
75                    'after_recording')
76
77            recorder_widget.read_recorded_binary()
78        else:
79            time.sleep(self.RECORD_SECONDS)
80
81
82    def save_and_check_data(self, recorder_widget):
83        """Saves and checks the data from the recorder.
84
85        @param recorder_widget: recorder widget to save data from
86
87        @raise error.TestFail: if comparison fails
88
89        """
90        recorded_file = os.path.join(self.resultsdir, "recorded.raw")
91        logging.debug('Saving recorded data to %s', recorded_file)
92        recorder_widget.save_file(recorded_file)
93
94        # Removes the beginning of recorded data. This is to avoid artifact
95        # caused by codec initialization in the beginning of recording.
96        recorder_widget.remove_head(2.0)
97
98        # Removes noise by a lowpass filter.
99        recorder_widget.lowpass_filter(self.low_pass_freq)
100        recorded_file = os.path.join(self.resultsdir,
101                                     "recorded_filtered.raw")
102        logging.debug('Saving filtered data to %s', recorded_file)
103        recorder_widget.save_file(recorded_file)
104
105        # Compares data by frequency.
106        audio_test_utils.check_recorded_frequency(
107                self.golden_file, recorder_widget,
108                second_peak_ratio=self.second_peak_ratio,
109                ignore_frequencies=self.ignore_frequencies)
110
111
112    def check_correct_audio_node_selected(self):
113        """Checks the node selected by Cras is correct."""
114        audio_test_utils.check_audio_nodes(self.audio_facade, self.audio_nodes)
115
116
117    def play_reboot_play_and_record (self, source_widget, recorder_widget):
118        """Play audio, then reboot, and play and record.
119
120        @param source_widget: source widget to play with
121        @param recorder_widget: recorder widget to record with
122
123        """
124        self.play_and_record(source_widget)
125
126        # Disconnecs audio bus so Cros device can detects plugger correctly
127        # when the test involes plugger.
128        # For case where audio bus is used but no plugger is used, it is no
129        # harm to disconnect audio bus and reconnect it.
130        if self.use_audio_bus:
131            logging.info('Disconnecting audio bus before reboot')
132            self.widget_link.disconnect_audio_bus()
133
134        self.host.reboot()
135        utils.poll_for_condition(condition=self.factory.ready,
136                                 timeout=self.PRC_RECONNECT_TIMEOUT,)
137        logging.debug('After reboot')
138
139        audio_test_utils.dump_cros_audio_logs(
140                self.host, self.audio_facade, self.resultsdir,
141                'after_reboot')
142
143        self.check_correct_audio_node_selected()
144
145        if self.use_audio_bus:
146            logging.info('Reconnecting audio bus after reboot before playback')
147            self.widget_link.reconnect_audio_bus()
148
149        audio_test_utils.dump_cros_audio_logs(
150                self.host, self.audio_facade, self.resultsdir,
151                'after_bus_reconnect')
152
153        self.play_and_record(source_widget, recorder_widget)
154
155
156    def run_once(self, host, golden_data, audio_nodes, bind_from=None, bind_to=None,
157                 source=None, recorder=None, is_internal=False):
158        """Runs the test main workflow.
159
160        @param host: A host object representing the DUT.
161        @param golden_data: audio file and low pass filter frequency
162           the audio file should be test data defined in audio_test_data
163        @param audio_nodes: audio nodes supposed to be selected
164        @param bind_from: audio originating entity to be binded
165            should be defined in chameleon_audio_ids
166        @param bind_to: audio directed_to entity to be binded
167            should be defined in chameleon_audio_ids
168        @param source: source widget entity
169            should be defined in chameleon_audio_ids
170        @param recorder: recorder widget entity
171            should be defined in chameleon_audio_ids
172        @param is_internal: whether internal audio is tested flag
173
174        """
175        if (recorder == chameleon_audio_ids.CrosIds.INTERNAL_MIC and
176            not audio_test_utils.has_internal_microphone(host)):
177            return
178
179        if (source == chameleon_audio_ids.CrosIds.SPEAKER and
180            not audio_test_utils.has_internal_speaker(host)):
181            return
182
183        self.host = host
184        self.audio_nodes = audio_nodes
185        self.golden_file, self.low_pass_freq = golden_data
186        chameleon_board = self.host.chameleon
187        self.factory = self.create_remote_facade_factory(self.host)
188        self.audio_facade = self.factory.create_audio_facade()
189        chameleon_board.setup_and_reset(self.outputdir)
190        widget_factory = chameleon_audio_helper.AudioWidgetFactory(
191                self.factory, host)
192        self.audio_board = chameleon_board.get_audio_board()
193        self.widget_link = None
194        self.use_audio_bus = False
195
196        self.second_peak_ratio = audio_test_utils.get_second_peak_ratio(
197                source_id=source,
198                recorder_id=recorder)
199
200        self.ignore_frequencies = None
201        if source == chameleon_audio_ids.CrosIds.SPEAKER:
202            self.ignore_frequencies = [50, 60]
203
204        # Two widgets are binded in the factory if necessary
205        binder_widget = None
206        bind_from_widget = None
207        bind_to_widget = None
208        if bind_from != None and bind_to != None:
209            bind_from_widget = widget_factory.create_widget(bind_from)
210            bind_to_widget = widget_factory.create_widget(bind_to)
211            binder_widget = widget_factory.create_binder(bind_from_widget,
212                                                         bind_to_widget)
213            self.widget_link = binder_widget.get_link()
214            if isinstance(self.widget_link, audio_widget_link.AudioBusLink):
215                self.use_audio_bus = True
216
217        # Additional widgets that could be part of the factory
218        if source == None:
219            source_widget = bind_from_widget
220        else:
221            source_widget = widget_factory.create_widget(source)
222        if recorder == None:
223            recorder_widget = bind_to_widget
224        else:
225            recorder_widget = widget_factory.create_widget(recorder)
226
227        # Plug for external audio
228        self.action_plug_jack(not is_internal)
229
230        # Play only, reboot, then play and record.
231        if binder_widget != None:
232            with chameleon_audio_helper.bind_widgets(binder_widget):
233                time.sleep(self.DELAY_AFTER_BINDING)
234                self.play_reboot_play_and_record(source_widget, recorder_widget)
235        else:
236            self.play_reboot_play_and_record(source_widget, recorder_widget)
237
238        self.save_and_check_data(recorder_widget)
239