add alsa plugin

Signed-off-by: Mattias Andrée <maandree@operamail.com>

1 files changed, 101 insertions, 0 deletions

diff --git a/src/plugins/alsa.py b/src/plugins/alsa.py
new file mode 100644
index 0000000..35d23c4
--- /dev/null
+++ b/src/plugins/alsa.py
@@ -0,0 +1,101 @@
+# -*- python -*-
+'''
+xpybar – xmobar replacement written in python
+Copyright © 2014  Mattias Andrée (maandree@member.fsf.org)
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+'''
+
+import alsaaudio
+
+
+class ALSA:
+    '''
+    ALSA volume controller
+    
+    @variable  cardindex:int          The index of the audio card
+    @variable  cardname:str           The name of the audio card
+    @variable  mixername:str          The name of the mixer
+    @variable  mixer:alsaaudio.Mixer  The mixer object used internally by this class
+    '''
+    
+    
+    ALL_CHANNELS = -1
+    '''
+    :int  Channel index that selects all available channels
+    '''
+    
+    
+    def __init__(self, cardindex = 0, mixername = 'Master'):
+        '''
+        Constructor
+        
+        @param  cardindex:int  The index of the audio card
+        @param  mixername:str  The name of the mixer
+        '''
+        self.cardindex = cardindex
+        self.cardname = alsaaudio.cards()[cardindex]
+        self.mixername = mixername
+        self.mixer = alsaaudio.Mixer(self.mixername, 0, self.cardindex)
+    
+    
+    def get_volume(self):
+        '''
+        Get the volume for each channel on the mixer
+        
+        @return  :list<int?>  The [0, 100] volume for each channel, `None` on a channel indicate that it is muted
+        '''
+        self.mixer = alsaaudio.Mixer(self.mixername, 0, self.cardindex)
+        vs = self.mixer.getvolume()
+        try:
+            ms = self.mixer.getmute()
+        except:
+            ms = [0] * len(vs)
+        return [v if m == 0 else None for (v, m) in zip(vs, ms)]
+    
+    
+    def set_volume(self, volume, channel = -1):
+        '''
+        set the volume for a channel on the mixer
+        
+        @param  volume:int?  The [0, 100] volume for the channel, `None` to mute the channel
+        @param  channel:int  The index of the channel, `ALSA.ALL_CHANNELS` (-1) for all channels
+        '''
+        if volume is None:
+            self.mixer.setmute(1, channel)
+        else:
+            self.mixer.setvolume(volume, channel)
+            self.mixer.setmute(0, channel)
+    
+    
+    @staticmethod
+    def get_cards():
+        '''
+        Get the names of all available audio cards
+        
+        @return  :list<str>  The names of all available audio cards
+        '''
+        return alsaaudio.cards()
+    
+    
+    @staticmethod
+    def get_mixers(cardindex = 0):
+        '''
+        Get the names of all available mixers for an audio card
+        
+        @param   cardindex:int  The index of the audio card
+        @return  :list<str>     The names of all available mixers for an audio card
+        '''
+        return alsaaudio.mixers(cardindex)
+