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