# Lint as: python2, python3
# Copyright 2014 The ChromiumOS Authors
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.
"""This is a server side HDMI audio test using the Chameleon board."""

import logging
import os
import time

from autotest_lib.client.common_lib import error
from autotest_lib.client.cros.audio import audio_test_data
from autotest_lib.client.cros.chameleon import audio_test_utils
from autotest_lib.client.cros.chameleon import chameleon_audio_helper
from autotest_lib.client.cros.chameleon import chameleon_audio_ids
from autotest_lib.server.cros.audio import audio_test


class audio_AudioBasicHDMI(audio_test.AudioTest):
    """Server side HDMI audio test.

    This test talks to a Chameleon board and a Cros device to verify
    HDMI audio function of the Cros device.

    """
    version = 2
    RECORDING_DURATION = 6
    WEB_PLAYBACK_SEC = 15

    def cleanup(self):
        """Restore the CPU scaling governor mode."""
        self._system_facade.set_scaling_governor_mode(0, self._original_mode)
        logging.debug('Set CPU0 mode to %s', self._original_mode)

    def set_high_performance_mode(self):
        """Set the CPU scaling governor mode to performance mode."""
        self._original_mode = self._system_facade.set_scaling_governor_mode(
                0, 'performance')
        logging.debug(
                'Set CPU0 scaling governor mode to performance, '
                'original_mode: %s', self._original_mode)

    def playback_and_suspend(self, audio_facade, while_playback):
        """ Does playback and suspend-resume.

        @param audio_facade: audio facade to check nodes.
        @param while_playback: whether to play when suspending.
        """
        if while_playback:
            logging.info('Playing audio served on the web...')
            web_file = audio_test_data.HEADPHONE_10MIN_TEST_FILE
            file_url = getattr(web_file, 'url', None)
            browser_facade = self.factory.create_browser_facade()
            tab_descriptor = browser_facade.new_tab(file_url)
            time.sleep(self.WEB_PLAYBACK_SEC)
        audio_test_utils.suspend_resume_and_verify(self.host, self.factory)

        # Stop audio playback by closing the browser tab.
        if while_playback:
            browser_facade.close_tab(tab_descriptor)

        # Explicitly select the node as there is a known issue
        # that the selected node might change after a suspension.
        # We should remove this after the issue is addressed(crbug:987529).
        audio_facade.set_selected_node_types(['HDMI'], None)
        audio_test_utils.check_audio_nodes(audio_facade, (['HDMI'], None))

    def run_once(self,
                 suspend=False,
                 while_playback=False,
                 check_quality=False,
                 skipped_model_with_bugs={}):
        """Running basic HDMI audio tests.

        @param host: device under test host
        @param suspend: whether to suspend
        @param while_playback: whether to suspend while audio playback
        @param check_quality: True to check quality.

        """
        model = self.host.get_model_from_cros_config()
        if model in skipped_model_with_bugs:
            raise error.TestNAError('model pending fix for %s!' %
                                    skipped_model_with_bugs[model])

        golden_file = audio_test_data.GenerateAudioTestData(
                    path=os.path.join(self.bindir, 'fix_2k_1k_16.raw'),
                    duration_secs=10,
                    frequencies=[2000, 1000])

        # For DUTs with permanently connected audio jack cable
        # connecting HDMI won't switch automatically the node. Adding
        # audio_jack_plugged flag to select HDMI node after binding.
        output_nodes, _ = self.facade.get_selected_node_types()
        audio_jack_plugged = False
        if output_nodes == ['HEADPHONE'] or output_nodes == ['LINEOUT']:
            audio_jack_plugged = True
            logging.debug('Found audio jack plugged!')

        self._system_facade = self.factory.create_system_facade()
        self.set_high_performance_mode()

        source = self.widget_factory.create_widget(
                chameleon_audio_ids.CrosIds.HDMI)
        recorder = self.widget_factory.create_widget(
                chameleon_audio_ids.ChameleonIds.HDMI)
        binder = self.widget_factory.create_binder(source, recorder)

        with chameleon_audio_helper.bind_widgets(binder):
            audio_test_utils.dump_cros_audio_logs(
                    self.host, self.facade, self.resultsdir, 'after_binding')

            # HDMI node needs to be selected, when audio jack is plugged
            if audio_jack_plugged:
                self.facade.set_chrome_active_node_type('HDMI', None)
            audio_test_utils.check_audio_nodes(self.facade, (['HDMI'], None))

            # Suspend after playing audio (if directed) and resume
            # before the HDMI audio test.
            if suspend:
                self.playback_and_suspend(self.facade, while_playback)

            source.set_playback_data(golden_file)

            # There is a known issue that if we reopen the HDMI device,
            # chameleon will interrupt recording (crbug.com/1027040). However,
            # if there is another stream playing earlier, CRAS may need to
            # reopen the device during recording. To fix it, we should move
            # playback before the recording of chameleon.
            logging.info('Start playing %s on Cros device', golden_file.path)
            source.start_playback()

            logging.info('Start recording from Chameleon.')
            recorder.start_recording()

            time.sleep(self.RECORDING_DURATION)

            audio_test_utils.dump_cros_audio_logs(
                    self.host, self.facade, self.resultsdir, 'after_recording')

            recorder.stop_recording()
            logging.info('Stopped recording from Chameleon.')
            recorder.read_recorded_binary()

            recorded_file = os.path.join(self.resultsdir, "recorded.raw")
            logging.info('Saving recorded data to %s', recorded_file)
            recorder.save_file(recorded_file)

            audio_test_utils.check_recorded_frequency(
                    golden_file, recorder, check_artifacts=check_quality)