volay 1.2.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0786e6be35e259e88f2c72bbd57b2b1014ec2e8e0928000c9162a2ca172cb1c0'
-  data.tar.gz: a4131cbfad89dfc19a8614c9c5a94313bd544a4c06bbdd89e443b0cd99935317
+  metadata.gz: 688ccbdc75ceb9062fb138563fa72504509a2afaffbc2b1aae9e8f9f24a3dd32
+  data.tar.gz: 2e2c26689b143f3011d04a3d522eb9bbae829254d36618b5e853b9ecc8d64006
 SHA512:
-  metadata.gz: 5e5220cba4ce083166566bcddaf825ddc77e12e78774b2fafc30f9bd6b93aa6778c9accaf18f032122dee0d36976c5a867d82e1ec8107b68530aafaf67da8272
-  data.tar.gz: e6c2f0e812fac1c0589ccc53b83229647e7edf36fa1dd0872a055f7a1dcd43cc41af6bad8f9b883b842eaffb6d5e313ba010ed3bcdeb83d0814a18dbf82e10ba
+  metadata.gz: a13b3fb7690cf4bf04bbc210deaf6317d18fbb13743877dc330b345a084aeaae1242865bf72e2cbfe8319525fbbba09eeae4be0d66e1c05609f4f270a4a81dd7
+  data.tar.gz: 6cd5dcc83ccd294308644e5b45c9871a02447ec28c13fa14bc60c2fe44403996a58490128155ef4b523fb58998f89e117f87c7874b1bc3b98a71245f05164e7f

data/.rubocop.yml

@@ -1,4 +1,7 @@
-Style/FileName:
+AllCops:
+  TargetRubyVersion: 2.3
+
+Naming:
   Enabled: false
 Metrics/AbcSize:
   Enabled: false
@@ -18,3 +21,7 @@ Metrics/BlockLength:
 Style/FrozenStringLiteralComment:
   Exclude:
     - lib/volay/cli.rb
+    - lib/volay/version.rb
+
+Performance/RegexpMatch:
+  Enabled: false

data/.travis.yml

@@ -1,7 +1,7 @@
 language: ruby
 rvm:
-  - 2.2.5
-  - 2.3.1
+  - 2.3
+  - 2.4
 
 env:
   global:

data/MANIFEST

@@ -17,8 +17,8 @@ lib/volay/app.rb
 lib/volay/cli.rb
 lib/volay/config.rb
 lib/volay/exceptions.rb
-lib/volay/mixer/alsa.rb
 lib/volay/mixer/default.rb
+lib/volay/mixer/pulse.rb
 lib/volay/utils.rb
 lib/volay/version.rb
 lib/volay/volay.rb
@@ -28,11 +28,11 @@ lib/volay/widget/volume_control.rb
 spec/spec_helper.rb
 spec/volay/app_spec.rb
 spec/volay/config_spec.rb
-spec/volay/mixer/alsa_spec.rb
 spec/volay/mixer/default_spec.rb
+spec/volay/mixer/pulse_spec.rb
 spec/volay/utils_spec.rb
 spec/volay/widget/volume_control_spec.rb
 task/manifest.rake
 task/rubocop.rake
 task/spec.rake
-volay.gemspec
+volay.gemspec

data/README.md

@@ -4,7 +4,7 @@
 
 ## Requirements
 
- * Ruby 2.0 or newer
+ * Ruby 2.3 or newer
 
 ## Installation
 

data/glade/volay.glade

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<!-- Generated with glade 3.18.3 -->
+<!-- Generated with glade 3.20.0 -->
 <interface>
   <requires lib="gtk+" version="3.6"/>
   <object class="GtkIconFactory" id="icon_factory">

data/lib/volay.rb

@@ -19,4 +19,4 @@ require 'volay/widget/events'
 require 'volay/widget/system_tray'
 require 'volay/widget/volume_control'
 require 'volay/mixer/default'
-require 'volay/mixer/alsa'
+require 'volay/mixer/pulse'

data/lib/volay/config.rb

@@ -59,9 +59,8 @@ module Volay
     # Initialize mixer for controlling volume
     #
     def self.mixer
-      raise MixerNotFound unless which('amixer')
-
-      @mixer ||= Volay::Mixer::Alsa.new
+      raise MixerNotFound unless which('pacmd')
+      @mixer ||= Volay::Mixer::Pulse.new
     end
 
     ##

data/lib/volay/mixer/pulse.rb

@@ -0,0 +1,197 @@
+# frozen_string_literal: true
+
+# Volay module
+module Volay
+  # Mixer module
+  module Mixer
+    # Pulse class for playing with pacmd command
+    class Pulse < Default
+      DEFAULT_VALUE = 2
+      MAX_VALUE = 65_536
+
+      attr_reader :default_sink_id
+      attr_accessor :cards
+
+      def initialize
+        @cards = {}
+        refresh
+      end
+
+      def up(value = DEFAULT_VALUE)
+        set_volume(
+          volume_percent(@cards[@default_sink_id]['volume']) + value
+        )
+      end
+
+      def down(value = DEFAULT_VALUE)
+        set_volume(
+          volume_percent(@cards[@default_sink_id]['volume']) - value
+        )
+      end
+
+      def value=(value)
+        set_volume(value.to_i)
+      end
+
+      def toggle
+        value = if current_sink['muted'] == 'yes'
+                  'no'
+                else
+                  'yes'
+                end
+        current_sink['muted'] = value
+        command("set-sink-mute #{@cards[@default_sink_id]['sink']} #{value}")
+      end
+
+      def current
+        {
+          value: current_sink['volume'],
+          max_value: MAX_VALUE,
+          percent: volume_percent(current_sink['volume']),
+          muted: current_sink['muted'] == 'yes'
+        }
+      end
+
+      ##
+      # Change card
+      #
+      # @param [Integer] newdefault New default index
+      #
+      def change_card(newdefault)
+        return unless @cards.key?(newdefault)
+
+        # Change default sink
+        command("set-default-sink #{@cards[newdefault]['sink']}")
+
+        # Now to move all current playing stuff to the new sink....
+        dump = command('list-sink-inputs').lines
+        dump.each do |line|
+          args = line.split
+          # We need to find the item index for each playing stream
+          if args[0] == 'index:'
+            # And now to shift them all to the new sink.
+            command("move-sink-input #{args[1]} #{@cards[newdefault]['sink']}")
+          end
+        end
+
+        refresh
+      end
+
+      private
+
+      ##
+      # Get volume percent
+      #
+      # @return Integer
+      #
+      def volume_percent(value)
+        value * 100 / MAX_VALUE
+      end
+
+      ##
+      # Refresh cards data
+      #
+      def refresh
+        dump = command('dump').lines
+        dump.each do |line|
+          args = line.split
+
+          # We are using the id to actually enumerate all cards.
+          if args[1] == 'module-alsa-card'
+            number = args[2].sub('device_id="', '').sub('"', '').to_i
+            @cards[number] = {}
+            @cards[number]['name'] = args[3].sub('name="', '').sub('"', '')
+          # we already have something in the array
+          elsif @cards.keys.length.positive?
+            set_data(args)
+          end
+        end
+
+        set_long_names
+      end
+
+      ##
+      # Set cards data such as default sink
+      # volume and if card is muted
+      #
+      # @param [Hash] args Parameters
+      #
+      def set_data(args)
+        @cards.each do |id, card|
+          next if args[1].nil? || !args[1].include?(card['name'])
+          case args[0]
+          when 'set-default-sink'
+            @default_sink_id = id
+          when 'set-sink-volume'
+            @cards[id]['volume'] = args[2].hex
+            @cards[id]['sink'] = args[1]
+          when 'set-sink-mute'
+            @cards[id]['muted'] = args[2]
+          end
+        end
+      end
+
+      ##
+      # Get long name from list-cards command
+      #
+      def set_long_names
+        dump = command(
+          "list-cards | grep -e device.string -e 'name:' -e 'card_name'"
+        )
+               .split('name: ')
+               .reject { |x| x.strip.empty? }
+
+        dump.each do |card|
+          id = nil
+          name = nil
+          card.lines.each do |line|
+            args = line.strip.split(' = ')
+            if args[0] == 'device.string'
+              id = args[1].delete('"').to_i
+            elsif args[0] == 'alsa.card_name'
+              name = args[1].delete('"')
+            end
+          end
+
+          @cards[id]['long_name'] = name
+        end
+      end
+
+      ##
+      # Get current sink
+      #
+      # @return [Hash]
+      #
+      def current_sink
+        @cards[@default_sink_id]
+      end
+
+      ##
+      # Set up volume
+      #
+      # @param [Integer] volume Volume to set up, must be a percentage
+      #
+      def set_volume(volume)
+        volume = [[0, (volume * MAX_VALUE / 100)].max, MAX_VALUE].min
+        @cards[@default_sink_id]['volume'] = volume
+        sink = @cards[@default_sink_id]['sink']
+        command("set-sink-volume #{sink} #{format('0x%<v>x', v: volume)}")
+      end
+
+      ##
+      # Run command
+      #
+      # @param [String] cmd Command to run
+      #
+      def command(cmd)
+        command = "pacmd #{cmd}"
+        result = Mixlib::ShellOut.new(command)
+        Volay::Config.logger.debug(command)
+        result.run_command
+        Volay::Config.logger.error(result.stderr) unless result.stderr.empty?
+        Volay::Config.logger.debug(result.stdout) unless result.stdout.empty?
+        result.stdout
+      end
+    end
+  end
+end

data/lib/volay/version.rb

@@ -1,6 +1,4 @@
-# frozen_string_literal: true
-
 # Volay module
 module Volay
-  VERSION = '1.2.0'
+  VERSION = '2.0.0'.freeze
 end

data/lib/volay/widget/events.rb

@@ -15,9 +15,11 @@ module Volay
         @app = app
 
         methods.each do |name|
-          next unless name.match?(/^on_/)
+          next unless name =~ /^on_/
           @app.signals_list[name.to_s] = method(name)
         end
+
+        init if respond_to?('init')
       end
     end
   end

data/lib/volay/widget/system_tray.rb

@@ -10,6 +10,34 @@ module Volay
       RIGHT_CLICK = 3
       M_KEYCODE = 47
 
+      ##
+      # When popup window menu is draw
+      #
+      def init
+        return unless @app&.mixer&.cards
+
+        cards_menu = Gtk::MenuItem.new(label: 'Cards')
+        menu = Gtk::Menu.new
+        last_item = nil
+        @app.mixer.cards.each do |id, card|
+          radio_menu_item = Gtk::RadioMenuItem.new(nil, card['long_name'])
+          radio_menu_item.join_group(last_item) if last_item
+          radio_menu_item.name = "card_menu_#{id}"
+          radio_menu_item.active = @app.mixer.default_sink_id == id
+          last_item = radio_menu_item
+          menu.append(radio_menu_item)
+
+          radio_menu_item.signal_connect('activate') do |widget|
+            next unless widget.active?
+            @app.mixer.change_card(id)
+            @app.utils.update_status_icon
+          end
+        end
+
+        cards_menu.submenu = menu
+        @app.get_object('popup_menu').prepend(cards_menu)
+      end
+
       ##
       # When left click on the status icon, popup the window menu
       #

data/spec/volay/app_spec.rb

@@ -9,14 +9,14 @@ require 'volay/widget/events'
 require 'volay/widget/system_tray'
 require 'volay/widget/volume_control'
 require 'volay/mixer/default'
-require 'volay/mixer/alsa'
+require 'volay/mixer/pulse'
 require 'volay/exceptions'
 
 describe 'Volay::App' do
   include FakeFS::SpecHelpers
 
   context '#events' do
-    it 'should return alsa' do
+    it 'should initiliaze events' do
       allow_any_instance_of(Volay::App).to receive(:initialize_mixer)
       allow_any_instance_of(Volay::App).to receive(:initialize_ui)
       allow_any_instance_of(Volay::Utils).to receive(:update_status_icon)
@@ -30,7 +30,7 @@ describe 'Volay::App' do
   end
 
   context '#ui' do
-    it 'should return alsa' do
+    it 'should initialize events' do
       allow_any_instance_of(Volay::App).to receive(:initialize_mixer)
       allow_any_instance_of(Volay::App).to receive(:initialize_events)
 

data/spec/volay/config_spec.rb

@@ -4,7 +4,7 @@ require 'spec_helper'
 require 'logger'
 require 'volay/config'
 require 'volay/mixer/default'
-require 'volay/mixer/alsa'
+require 'volay/mixer/pulse'
 require 'volay/exceptions'
 
 describe 'Volay::Config' do
@@ -39,9 +39,9 @@ describe 'Volay::Config' do
       expect(Volay::Config.which('ruby')).to eq('/usr/bin/ruby')
     end
 
-    it "shouldn't find amixer executable" do
+    it "shouldn't find pacmd executable" do
       config
-      expect(Volay::Config.which('amixer')).to be_nil
+      expect(Volay::Config.which('pacmd')).to be_nil
     end
   end
 
@@ -53,14 +53,16 @@ describe 'Volay::Config' do
     end
 
     it 'should not return pulseaudio' do
-      app_mixer('pulseaudio-ctl')
       expect { Volay::Config.mixer }
         .to raise_error(Volay::MixerNotFound)
     end
 
-    it 'should return alsa' do
-      app_mixer('amixer')
-      expect(Volay::Config.mixer).to be_a(Volay::Mixer::Alsa)
+    it 'should return a mixer' do
+      Volay::Config.logger.level = :info
+      allow_any_instance_of(Mixlib::ShellOut).to receive(:new).twice
+      allow_any_instance_of(Mixlib::ShellOut).to receive(:run_command)
+      app_mixer('pacmd')
+      expect(Volay::Config.mixer).to be_a(Volay::Mixer::Pulse)
     end
   end
 end

data/spec/volay/mixer/pulse_spec.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'mixlib/shellout'
+require 'volay/mixer/default'
+
+describe 'Volay::Mixer::Pulse' do
+  let(:mixer) do
+    Volay::Mixer::Pulse.new
+  end
+
+  def stub_shellout(cmd, stdout = '', stderr = '')
+    shellout = double(
+      run_command: nil,
+      error!: nil,
+      stdout: stdout,
+      stderr: stderr
+    )
+
+    expect(Mixlib::ShellOut).to receive(:new)
+      .with("pacmd #{cmd}")
+      .and_return(shellout)
+  end
+
+  before(:each) do
+    stub_shellout(
+      'dump',
+      File.read(
+        File.expand_path('../stubs/pulse_dump.stub', __FILE__)
+      )
+    )
+    stub_shellout(
+      "list-cards | grep -e device.string -e 'name:' -e 'card_name'",
+      File.read(
+        File.expand_path('../stubs/pulse_list-cards.stub', __FILE__)
+      )
+    )
+  end
+
+  it 'should raise error when calling up' do
+    stub_shellout(
+      'set-sink-volume alsa_output.pci-0000_01_00.1.hdmi-stereo 0x10000',
+      'Yes'
+    )
+    expect(mixer.up).to eq('Yes')
+  end
+
+  it 'should raise error when calling down' do
+    stub_shellout(
+      'set-sink-volume alsa_output.pci-0000_01_00.1.hdmi-stereo 0xfae1',
+      'Yes'
+    )
+    expect(mixer.down).to eq('Yes')
+  end
+
+  it 'should raise error when calling value=' do
+    stub_shellout(
+      'set-sink-volume alsa_output.pci-0000_01_00.1.hdmi-stereo 0x8000',
+      'Yes'
+    )
+    expect(mixer.value = '50').to eq('50')
+  end
+
+  it 'should raise error when calling toggle' do
+    stub_shellout(
+      'set-sink-mute alsa_output.pci-0000_01_00.1.hdmi-stereo yes',
+      'Yes'
+    )
+    expect(mixer.toggle).to eq('Yes')
+  end
+
+  it 'should raise error when calling current' do
+    expect(mixer.current).to eq(value: 65_536,
+                                max_value: 65_536,
+                                percent: 100,
+                                muted: false)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: volay
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Pierre Rambaud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-17 00:00:00.000000000 Z
+date: 2018-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: glib2
@@ -190,8 +190,8 @@ files:
 - lib/volay/cli.rb
 - lib/volay/config.rb
 - lib/volay/exceptions.rb
-- lib/volay/mixer/alsa.rb
 - lib/volay/mixer/default.rb
+- lib/volay/mixer/pulse.rb
 - lib/volay/utils.rb
 - lib/volay/version.rb
 - lib/volay/volay.rb
@@ -201,8 +201,8 @@ files:
 - spec/spec_helper.rb
 - spec/volay/app_spec.rb
 - spec/volay/config_spec.rb
-- spec/volay/mixer/alsa_spec.rb
 - spec/volay/mixer/default_spec.rb
+- spec/volay/mixer/pulse_spec.rb
 - spec/volay/utils_spec.rb
 - spec/volay/widget/volume_control_spec.rb
 - task/manifest.rake

data/lib/volay/mixer/alsa.rb

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-# Volay module
-module Volay
-  # Mixer module
-  module Mixer
-    # Alsa class for playing with amixer
-    class Alsa < Default
-      DEFAULT_VALUE = 2
-
-      def up(value = DEFAULT_VALUE)
-        command("-q set Master #{value}%+")
-      end
-
-      def down(value = DEFAULT_VALUE)
-        command("-q set Master #{value}%-")
-      end
-
-      def value=(value)
-        command("-q set Master #{value}%")
-      end
-
-      def toggle
-        command('-q set Master toggle')
-      end
-
-      def current
-        result = command('get Master')
-        max_value = result.match(/ 0 - (\d+)/)[1].to_i
-        current_percent = result.match(/\[([0-9]+)%\]\s+\[o(?:n|ff)\]/)[1].to_i
-        current_value = ((current_percent * max_value) / 100).to_i
-        current_state = result.match(/\[([a-z]+)\]/)[1].to_s
-
-        { value: current_value,
-          max_value: max_value,
-          percent: current_percent,
-          muted: current_state != 'on' }
-      end
-
-      private
-
-      def command(cmd)
-        result = Mixlib::ShellOut.new("amixer #{cmd}")
-        result.run_command
-        Volay::Config.logger.error(result.stderr) unless result.stderr.empty?
-        result.stdout
-      end
-    end
-  end
-end

data/spec/volay/mixer/alsa_spec.rb

@@ -1,58 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-require 'mixlib/shellout'
-require 'volay/mixer/default'
-
-describe 'Volay::Mixer::Alsa' do
-  let(:mixer) do
-    Volay::Mixer::Alsa.new
-  end
-
-  def stub_shellout(cmd, stdout = '', stderr = '')
-    allow_any_instance_of(Mixlib::ShellOut).to receive(:run_command)
-    allow_any_instance_of(Mixlib::ShellOut).to receive(:new)
-      .with("amixer #{cmd}")
-    allow_any_instance_of(Mixlib::ShellOut).to receive(:stdout)
-      .and_return(stdout)
-    allow_any_instance_of(Mixlib::ShellOut).to receive(:stderr)
-      .and_return(stderr)
-  end
-
-  it 'should raise error when calling up' do
-    stub_shellout('-q set Master 2%+', 'Yes')
-    expect(mixer.up).to eq('Yes')
-  end
-
-  it 'should raise error when calling down' do
-    stub_shellout('-q set Master 2%-', 'Yes')
-    expect(mixer.down).to eq('Yes')
-  end
-
-  it 'should raise error when calling value=' do
-    stub_shellout('-q set Master 50%', 'Yes')
-    expect(mixer.value = '50').to eq('50')
-  end
-
-  it 'should raise error when calling toggle' do
-    stub_shellout('-q set Master toggle', 'Yes')
-    expect(mixer.toggle).to eq('Yes')
-  end
-
-  it 'should raise error when calling current' do
-    stdout = <<-OUTPUT
-  Simple mixer control 'Master',0
-  Capabilities: pvolume pswitch pswitch-joined
-  Playback channels: Front Left - Front Right
-  Limits: Playback 0 - 65536
-  Mono:
-  Front Left: Playback 13108 [20%] [off]
-  Front Right: Playback 13108 [20%] [off]
-OUTPUT
-    stub_shellout('get Master', stdout)
-    expect(mixer.current).to eq(value: 13_107,
-                                max_value: 65_536,
-                                percent: 20,
-                                muted: true)
-  end
-end