text: # -*- coding: utf-8 -*-
  # This file is part of beets.
  # Copyright 2016, Thomas Scholtes
  #
  # Permission is hereby granted, free of charge, to any person obtaining
  # a copy of this software and associated documentation files (the
  # "Software"), to deal in the Software without restriction, including
  # without limitation the rights to use, copy, modify, merge, publish,
  # distribute, sublicense, and/or sell copies of the Software, and to
  # permit persons to whom the Software is furnished to do so, subject to
  # the following conditions:
  #
  # The above copyright notice and this permission notice shall be
  # included in all copies or substantial portions of the Software.
  
  
  from __future__ import division, absolute_import, print_function
  
  from test._common import unittest
  from test.helper import TestHelper, has_program
  
  from beets import config
  from beets.mediafile import MediaFile
  from beetsplug.replaygain import (FatalGstreamerPluginReplayGainError,
                                    GStreamerBackend)
  import six
  
  try:
      import gi
      gi.require_version('Gst', '1.0')
      GST_AVAILABLE = True
  except (ImportError, ValueError):
      GST_AVAILABLE = False
  
  if any(has_program(cmd, ['-v']) for cmd in ['mp3gain', 'aacgain']):
      GAIN_PROG_AVAILABLE = True
  else:
      GAIN_PROG_AVAILABLE = False
  
  if has_program('bs1770gain', ['--replaygain']):
      LOUDNESS_PROG_AVAILABLE = True
  else:
      LOUDNESS_PROG_AVAILABLE = False
  
  
  class ReplayGainCliTestBase(TestHelper):
  
      def setUp(self):
          self.setup_beets()
          self.config['replaygain']['backend'] = self.backend
  
          try:
              self.load_plugins('replaygain')
          except:
              import sys
              # store exception info so an error in teardown does not swallow it
              exc_info = sys.exc_info()
              try:
                  self.teardown_beets()
                  self.unload_plugins()
              except:
                  # if load_plugins() failed then setup is incomplete and
                  # teardown operations may fail. In particular # {Item,Album}
                  # may not have the _original_types attribute in unload_plugins
                  pass
              six.reraise(exc_info[1], None, exc_info[2])
  
          album = self.add_album_fixture(2)
          for item in album.items():
              self._reset_replaygain(item)
  
      def tearDown(self):
          self.teardown_beets()
          self.unload_plugins()
  
      def _reset_replaygain(self, item):
          item['rg_track_peak'] = None
          item['rg_track_gain'] = None
          item['rg_album_gain'] = None
          item['rg_album_gain'] = None
          item.write()
          item.store()
  
      def test_cli_saves_track_gain(self):
          for item in self.lib.items():
              self.assertIsNone(item.rg_track_peak)
              self.assertIsNone(item.rg_track_gain)
              mediafile = MediaFile(item.path)
              self.assertIsNone(mediafile.rg_track_peak)
              self.assertIsNone(mediafile.rg_track_gain)
  
          self.run_command('replaygain')
  
          # Skip the test if rg_track_peak and rg_track gain is None, assuming
          # that it could only happen if the decoder plugins are missing.
          if all(i.rg_track_peak is None and i.rg_track_gain is None
                 for i in self.lib.items()):
              self.skipTest(u'decoder plugins could not be loaded.')
  
          for item in self.lib.items():
              self.assertIsNotNone(item.rg_track_peak)
              self.assertIsNotNone(item.rg_track_gain)
              mediafile = MediaFile(item.path)
              self.assertAlmostEqual(
                  mediafile.rg_track_peak, item.rg_track_peak, places=6)
              self.assertAlmostEqual(
                  mediafile.rg_track_gain, item.rg_track_gain, places=2)
  
      def test_cli_skips_calculated_tracks(self):
          self.run_command(u'replaygain')
          item = self.lib.items()[0]
          peak = item.rg_track_peak
          item.rg_track_gain = 0.0
          self.run_command(u'replaygain')
          self.assertEqual(item.rg_track_gain, 0.0)
          self.assertEqual(item.rg_track_peak, peak)
  
      def test_cli_saves_album_gain_to_file(self):
          for item in self.lib.items():
              mediafile = MediaFile(item.path)
              self.assertIsNone(mediafile.rg_album_peak)
              self.assertIsNone(mediafile.rg_album_gain)
  
          self.run_command(u'replaygain', u'-a')
  
          peaks = []
          gains = []
          for item in self.lib.items():
              mediafile = MediaFile(item.path)
              peaks.append(mediafile.rg_album_peak)
              gains.append(mediafile.rg_album_gain)
  
          # Make sure they are all the same
          self.assertEqual(max(peaks), min(peaks))
          self.assertEqual(max(gains), min(gains))
  
          self.assertNotEqual(max(gains), 0.0)
          self.assertNotEqual(max(peaks), 0.0)
  
  
  @unittest.skipIf(not GST_AVAILABLE, u'gstreamer cannot be found')
  class ReplayGainGstCliTest(ReplayGainCliTestBase, unittest.TestCase):
      backend = u'gstreamer'
  
      def setUp(self):
          try:
              # Check if required plugins can be loaded by instantiating a
              # GStreamerBackend (via its .__init__).
              config['replaygain']['targetlevel'] = 89
              GStreamerBackend(config['replaygain'], None)
          except FatalGstreamerPluginReplayGainError as e:
              # Skip the test if plugins could not be loaded.
              self.skipTest(str(e))
  
          super(ReplayGainGstCliTest, self).setUp()
  
  
  @unittest.skipIf(not GAIN_PROG_AVAILABLE, u'no *gain command found')
  class ReplayGainCmdCliTest(ReplayGainCliTestBase, unittest.TestCase):
      backend = u'command'
  
  
  @unittest.skipIf(not LOUDNESS_PROG_AVAILABLE, u'bs1770gain cannot be found')
  class ReplayGainLdnsCliTest(ReplayGainCliTestBase, unittest.TestCase):
      backend = u'bs1770gain'
  
  
  def suite():
      return unittest.TestLoader().loadTestsFromName(__name__)
  
  if __name__ == '__main__':
      unittest.main(defaultTest='suite')
  