From 641f8d2e2db60149d9ece571053e2ef27808d5aa Mon Sep 17 00:00:00 2001 From: Stein Magnus Jodal Date: Sat, 8 Sep 2012 00:39:22 +0200 Subject: [PATCH 1/7] Port NAD hardware mixer to the GStreamer mixer API Fixes #179 --- docs/changes.rst | 20 ++++ mopidy/mixers/__init__.py | 1 + mopidy/mixers/nad.py | 243 ++++++++++++++++++++++++++++++++++++++ 3 files changed, 264 insertions(+) create mode 100644 mopidy/mixers/nad.py diff --git a/docs/changes.rst b/docs/changes.rst index 963802d4..6298c8e3 100644 --- a/docs/changes.rst +++ b/docs/changes.rst @@ -42,6 +42,26 @@ v0.8 (in development) protocol support for volume has also been updated to return -1 when we have no mixer set. +- Removed the Denon hardware mixer, as it is not maintained. + +- Updated the NAD hardware mixer to work in the new GStreamer based mixing + regime. Settings are now passed as GStreamer element properties. In practice + that means that the following old-style config: + + MIXER = u'mopidy.mixers.nad.NadMixer' + MIXER_EXT_PORT = u'/dev/ttyUSB0' + MIXER_EXT_SOURCE = u'Aux' + MIXER_EXT_SPEAKERS_A = u'On' + MIXER_EXT_SPEAKERS_B = u'Off' + + Now is reduced to simply: + + MIXER = u'nadmixer port=/dev/ttyUSB0 source=Aux speakers-a=On speakers-b=Off' + + The ``port`` property defaults to ``/dev/ttyUSB0``, and the rest of the + properties may be left out if you don't want the mixer to adjust the settings + on your NAD amplifier when Mopidy is started. + v0.7.3 (2012-08-11) =================== diff --git a/mopidy/mixers/__init__.py b/mopidy/mixers/__init__.py index cf282a03..259557d1 100644 --- a/mopidy/mixers/__init__.py +++ b/mopidy/mixers/__init__.py @@ -1,2 +1,3 @@ from mopidy.mixers.auto import AutoAudioMixer from mopidy.mixers.fake import FakeMixer +from mopidy.mixers.nad import NadMixer diff --git a/mopidy/mixers/nad.py b/mopidy/mixers/nad.py new file mode 100644 index 00000000..e0bfa2d3 --- /dev/null +++ b/mopidy/mixers/nad.py @@ -0,0 +1,243 @@ +import logging + +import pygst +pygst.require('0.10') +import gobject +import gst + +try: + import serial +except ImportError: + serial = None + +from pykka.actor import ThreadingActor + +from mopidy.mixers.fake import create_fake_track + + +logger = logging.getLogger('mopidy.mixers.nad') + + +class NadMixer(gst.Element, gst.ImplementsInterface, gst.interfaces.Mixer): + __gstdetails__ = ('NadMixer', + 'Mixer', + 'Mixer to control NAD amplifiers using a serial link', + 'Stein Magnus Jodal') + + port = gobject.property(type=str, default='/dev/ttyUSB0') + source = gobject.property(type=str) + speakers_a = gobject.property(type=str) + speakers_b = gobject.property(type=str) + + def __init__(self): + gst.Element.__init__(self) + self._volume_cache = 0 + self._nad_talker = None + + def list_tracks(self): + track = create_fake_track( + label='Master', + initial_volume=0, + min_volume=0, + max_volume=100, + num_channels=1, + flags=(gst.interfaces.MIXER_TRACK_MASTER | + gst.interfaces.MIXER_TRACK_OUTPUT)) + return [track] + + def get_volume(self, track): + return [self._volume_cache] + + def set_volume(self, track, volumes): + if len(volumes): + volume = volumes[0] + self._volume_cache = volume + self._nad_talker.set_volume(volume) + + def set_mute(self, track, mute): + if mute: + self._nad_talker.mute() + else: + self._nad_talker.unmute() + + def do_change_state(self, transition): + if transition == gst.STATE_CHANGE_NULL_TO_READY: + if serial is None: + logger.warning(u'nadmixer dependency python-serial not found') + return gst.STATE_CHANGE_FAILURE + self._start_nad_talker() + return gst.STATE_CHANGE_SUCCESS + + def _start_nad_talker(self): + self._nad_talker = NadTalker.start( + port=self.port, + source=self.source or None, + speakers_a=self.speakers_a or None, + speakers_b=self.speakers_b or None + ).proxy() + + +gobject.type_register(NadMixer) +gst.element_register(NadMixer, 'nadmixer', gst.RANK_MARGINAL) + + +class NadTalker(ThreadingActor): + """ + Independent thread which does the communication with the NAD device. + + Since the communication is done in an independent thread, Mopidy won't + block other requests while doing rather time consuming work like + calibrating the NAD device's volume. + """ + + # Serial link settings + BAUDRATE = 115200 + BYTESIZE = 8 + PARITY = 'N' + STOPBITS = 1 + + # Timeout in seconds used for read/write operations. + # If you set the timeout too low, the reads will never get complete + # confirmations and calibration will decrease volume forever. If you set + # the timeout too high, stuff takes more time. 0.2s seems like a good value + # for NAD C 355BEE. + TIMEOUT = 0.2 + + # Number of volume levels the device supports. 40 for NAD C 355BEE. + VOLUME_LEVELS = 40 + + def __init__(self, port, source, speakers_a, speakers_b): + super(NadTalker, self).__init__() + + self.port = port + self.source = source + if speakers_a in ('On', 'Off'): + self.speakers_a = speakers_a + else: + logger.warning('speakers-a must be "On" or "Off", or unset') + self.speakers_a = None + if speakers_b in ('On', 'Off'): + self.speakers_b = speakers_b + else: + logger.warning('speakers-b must be "On" or "Off", or unset') + self.speakers_b = None + + # Volume in range 0..VOLUME_LEVELS. :class:`None` before calibration. + self._nad_volume = None + + self._device = None + + def on_start(self): + self._open_connection() + self._set_device_to_known_state() + + def _open_connection(self): + logger.info(u'Connecting to NAD amplifier using serial device "%s"', + self.port) + self._device = serial.Serial( + port=self.port, + baudrate=self.BAUDRATE, + bytesize=self.BYTESIZE, + parity=self.PARITY, + stopbits=self.STOPBITS, + timeout=self.TIMEOUT) + self._get_device_model() + + def _set_device_to_known_state(self): + self._power_device_on() + self._select_speakers() + self._select_input_source() + self._unmute() + self._calibrate_volume() + + def _get_device_model(self): + model = self._ask_device('Main.Model') + logger.info(u'Connected to NAD amplifier model "%s"', model) + return model + + def _power_device_on(self): + while self._ask_device('Main.Power') != 'On': + logger.info(u'Powering device on') + self._command_device('Main.Power', 'On') + + def _select_speakers(self): + if self.speakers_a is not None: + while (self._ask_device('Main.SpeakerA') != self.speakers_a): + logger.info(u'Setting speakers A to "%s"', self.speakers_a) + self._command_device('Main.SpeakerA', self.speakers_a) + if self.speakers_b is not None: + while (self._ask_device('Main.SpeakerB') != self.speakers_b): + logger.info(u'Setting speakers B to "%s"', self.speakers_b) + self._command_device('Main.SpeakerB', self.speakers_b) + + def _select_input_source(self): + if self.source is not None: + while self._ask_device('Main.Source') != self.source: + logger.info(u'Selecting input source "%s"', self.source) + self._command_device('Main.Source', self.source) + + def _unmute(self): + while self._ask_device('Main.Mute') != 'Off': + logger.info(u'Unmuting device') + self._command_device('Main.Mute', 'Off') + + def _ask_device(self, key): + self._write('%s?' % key) + return self._readline().replace('%s=' % key, '') + + def _command_device(self, key, value): + if type(value) == unicode: + value = value.encode('utf-8') + self._write('%s=%s' % (key, value)) + self._readline() + + def _calibrate_volume(self): + # The NAD C 355BEE amplifier has 40 different volume levels. We have no + # way of asking on which level we are. Thus, we must calibrate the + # mixer by decreasing the volume 39 times. + logger.info(u'Calibrating NAD amplifier by setting volume to 0') + self._nad_volume = self.VOLUME_LEVELS + self.set_volume(0) + logger.info(u'Done calibrating NAD amplifier') + + def set_volume(self, volume): + # Increase or decrease the amplifier volume until it matches the given + # target volume. + logger.debug(u'Setting volume to %d' % volume) + target_nad_volume = int(round(volume * self.VOLUME_LEVELS / 100.0)) + if self._nad_volume is None: + return # Calibration needed + while target_nad_volume > self._nad_volume: + if self._increase_volume(): + self._nad_volume += 1 + while target_nad_volume < self._nad_volume: + if self._decrease_volume(): + self._nad_volume -= 1 + + def _increase_volume(self): + # Increase volume. Returns :class:`True` if confirmed by device. + self._write('Main.Volume+') + return self._readline() == 'Main.Volume+' + + def _decrease_volume(self): + # Decrease volume. Returns :class:`True` if confirmed by device. + self._write('Main.Volume-') + return self._readline() == 'Main.Volume-' + + def _write(self, data): + # Write data to device. Prepends and appends a newline to the data, as + # recommended by the NAD documentation. + if not self._device.isOpen(): + self._device.open() + self._device.write('\n%s\n' % data) + logger.debug('Write: %s', data) + + def _readline(self): + # Read line from device. The result is stripped for leading and + # trailing whitespace. + if not self._device.isOpen(): + self._device.open() + result = self._device.readline().strip() + if result: + logger.debug('Read: %s', result) + return result From 1ccdb08420eb2af253f4efa319703605e7db15ad Mon Sep 17 00:00:00 2001 From: Stein Magnus Jodal Date: Sat, 8 Sep 2012 22:18:23 +0200 Subject: [PATCH 2/7] Use create_track() from new location --- mopidy/mixers/nad.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/mopidy/mixers/nad.py b/mopidy/mixers/nad.py index e0bfa2d3..49af8f06 100644 --- a/mopidy/mixers/nad.py +++ b/mopidy/mixers/nad.py @@ -12,7 +12,7 @@ except ImportError: from pykka.actor import ThreadingActor -from mopidy.mixers.fake import create_fake_track +from mopidy.mixers import create_track logger = logging.getLogger('mopidy.mixers.nad') @@ -35,7 +35,7 @@ class NadMixer(gst.Element, gst.ImplementsInterface, gst.interfaces.Mixer): self._nad_talker = None def list_tracks(self): - track = create_fake_track( + track = create_track( label='Master', initial_volume=0, min_volume=0, From 5368f75f3a41cca0fe333f5f75dea272d88968d2 Mon Sep 17 00:00:00 2001 From: Stein Magnus Jodal Date: Sat, 8 Sep 2012 22:22:05 +0200 Subject: [PATCH 3/7] Fix set_mute() implementation --- mopidy/mixers/nad.py | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/mopidy/mixers/nad.py b/mopidy/mixers/nad.py index 49af8f06..da205460 100644 --- a/mopidy/mixers/nad.py +++ b/mopidy/mixers/nad.py @@ -55,10 +55,7 @@ class NadMixer(gst.Element, gst.ImplementsInterface, gst.interfaces.Mixer): self._nad_talker.set_volume(volume) def set_mute(self, track, mute): - if mute: - self._nad_talker.mute() - else: - self._nad_talker.unmute() + self._nad_talker.mute(mute) def do_change_state(self, transition): if transition == gst.STATE_CHANGE_NULL_TO_READY: @@ -147,7 +144,7 @@ class NadTalker(ThreadingActor): self._power_device_on() self._select_speakers() self._select_input_source() - self._unmute() + self.mute(False) self._calibrate_volume() def _get_device_model(self): @@ -176,10 +173,15 @@ class NadTalker(ThreadingActor): logger.info(u'Selecting input source "%s"', self.source) self._command_device('Main.Source', self.source) - def _unmute(self): - while self._ask_device('Main.Mute') != 'Off': - logger.info(u'Unmuting device') - self._command_device('Main.Mute', 'Off') + def mute(self, mute): + if mute: + while self._ask_device('Main.Mute') != 'On': + logger.info(u'Muting NAD amplifier') + self._command_device('Main.Mute', 'On') + else: + while self._ask_device('Main.Mute') != 'Off': + logger.info(u'Unmuting NAD amplifier') + self._command_device('Main.Mute', 'Off') def _ask_device(self, key): self._write('%s?' % key) From e741b4db7551795afb6c40ffb21bb31efa8a720d Mon Sep 17 00:00:00 2001 From: Stein Magnus Jodal Date: Sat, 8 Sep 2012 22:24:48 +0200 Subject: [PATCH 4/7] Prefer the word 'amplifier' over too generic 'device' in docs and log messages --- mopidy/mixers/nad.py | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/mopidy/mixers/nad.py b/mopidy/mixers/nad.py index da205460..ce860d4a 100644 --- a/mopidy/mixers/nad.py +++ b/mopidy/mixers/nad.py @@ -80,11 +80,11 @@ gst.element_register(NadMixer, 'nadmixer', gst.RANK_MARGINAL) class NadTalker(ThreadingActor): """ - Independent thread which does the communication with the NAD device. + Independent thread which does the communication with the NAD amplifier Since the communication is done in an independent thread, Mopidy won't block other requests while doing rather time consuming work like - calibrating the NAD device's volume. + calibrating the NAD amplifier's volume. """ # Serial link settings @@ -100,7 +100,7 @@ class NadTalker(ThreadingActor): # for NAD C 355BEE. TIMEOUT = 0.2 - # Number of volume levels the device supports. 40 for NAD C 355BEE. + # Number of volume levels the amplifier supports. 40 for NAD C 355BEE. VOLUME_LEVELS = 40 def __init__(self, port, source, speakers_a, speakers_b): @@ -129,7 +129,7 @@ class NadTalker(ThreadingActor): self._set_device_to_known_state() def _open_connection(self): - logger.info(u'Connecting to NAD amplifier using serial device "%s"', + logger.info(u'Connecting to NAD amplifier using "%s"', self.port) self._device = serial.Serial( port=self.port, @@ -154,7 +154,7 @@ class NadTalker(ThreadingActor): def _power_device_on(self): while self._ask_device('Main.Power') != 'On': - logger.info(u'Powering device on') + logger.info(u'Powering NAD amplifier on') self._command_device('Main.Power', 'On') def _select_speakers(self): From ccf2c12a189229d9f456cabeafcb713d081c0a2b Mon Sep 17 00:00:00 2001 From: Stein Magnus Jodal Date: Sun, 9 Sep 2012 12:52:41 +0200 Subject: [PATCH 5/7] Reuse set-and-check logic --- mopidy/mixers/nad.py | 55 ++++++++++++++++++++++---------------------- 1 file changed, 27 insertions(+), 28 deletions(-) diff --git a/mopidy/mixers/nad.py b/mopidy/mixers/nad.py index ce860d4a..eecf9aab 100644 --- a/mopidy/mixers/nad.py +++ b/mopidy/mixers/nad.py @@ -153,45 +153,23 @@ class NadTalker(ThreadingActor): return model def _power_device_on(self): - while self._ask_device('Main.Power') != 'On': - logger.info(u'Powering NAD amplifier on') - self._command_device('Main.Power', 'On') + self._check_and_set('Main.Power', 'On') def _select_speakers(self): if self.speakers_a is not None: - while (self._ask_device('Main.SpeakerA') != self.speakers_a): - logger.info(u'Setting speakers A to "%s"', self.speakers_a) - self._command_device('Main.SpeakerA', self.speakers_a) + self._check_and_set('Main.SpeakerA', self.speakers_a) if self.speakers_b is not None: - while (self._ask_device('Main.SpeakerB') != self.speakers_b): - logger.info(u'Setting speakers B to "%s"', self.speakers_b) - self._command_device('Main.SpeakerB', self.speakers_b) + self._check_and_set('Main.SpeakerB', self.speakers_b) def _select_input_source(self): if self.source is not None: - while self._ask_device('Main.Source') != self.source: - logger.info(u'Selecting input source "%s"', self.source) - self._command_device('Main.Source', self.source) + self._check_and_set('Main.Source', self.source) def mute(self, mute): if mute: - while self._ask_device('Main.Mute') != 'On': - logger.info(u'Muting NAD amplifier') - self._command_device('Main.Mute', 'On') + self._check_and_set('Main.Mute', 'On') else: - while self._ask_device('Main.Mute') != 'Off': - logger.info(u'Unmuting NAD amplifier') - self._command_device('Main.Mute', 'Off') - - def _ask_device(self, key): - self._write('%s?' % key) - return self._readline().replace('%s=' % key, '') - - def _command_device(self, key, value): - if type(value) == unicode: - value = value.encode('utf-8') - self._write('%s=%s' % (key, value)) - self._readline() + self._check_and_set('Main.Mute', 'Off') def _calibrate_volume(self): # The NAD C 355BEE amplifier has 40 different volume levels. We have no @@ -226,6 +204,27 @@ class NadTalker(ThreadingActor): self._write('Main.Volume-') return self._readline() == 'Main.Volume-' + def _check_and_set(self, key, value): + for attempt in range(1, 4): + if self._ask_device(key) == value: + return + logger.info(u'NAD amplifier: Setting "%s" to "%s" (attempt %d/3)', + key, value, attempt) + self._command_device(key, value) + if self._ask_device(key) != value: + logger.info(u'NAD amplifier: Gave up on setting "%s" to "%s"', + key, value) + + def _ask_device(self, key): + self._write('%s?' % key) + return self._readline().replace('%s=' % key, '') + + def _command_device(self, key, value): + if type(value) == unicode: + value = value.encode('utf-8') + self._write('%s=%s' % (key, value)) + self._readline() + def _write(self, data): # Write data to device. Prepends and appends a newline to the data, as # recommended by the NAD documentation. From affe7795694f5a96e190cee7c083af1032369e12 Mon Sep 17 00:00:00 2001 From: Stein Magnus Jodal Date: Sun, 9 Sep 2012 12:53:36 +0200 Subject: [PATCH 6/7] Cleanup log messages --- mopidy/mixers/nad.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/mopidy/mixers/nad.py b/mopidy/mixers/nad.py index eecf9aab..dad3e853 100644 --- a/mopidy/mixers/nad.py +++ b/mopidy/mixers/nad.py @@ -129,7 +129,7 @@ class NadTalker(ThreadingActor): self._set_device_to_known_state() def _open_connection(self): - logger.info(u'Connecting to NAD amplifier using "%s"', + logger.info(u'NAD amplifier: Connecting through "%s"', self.port) self._device = serial.Serial( port=self.port, @@ -149,7 +149,7 @@ class NadTalker(ThreadingActor): def _get_device_model(self): model = self._ask_device('Main.Model') - logger.info(u'Connected to NAD amplifier model "%s"', model) + logger.info(u'NAD amplifier: Connected to model "%s"', model) return model def _power_device_on(self): @@ -175,10 +175,10 @@ class NadTalker(ThreadingActor): # The NAD C 355BEE amplifier has 40 different volume levels. We have no # way of asking on which level we are. Thus, we must calibrate the # mixer by decreasing the volume 39 times. - logger.info(u'Calibrating NAD amplifier by setting volume to 0') + logger.info(u'NAD amplifier: Calibrating by setting volume to 0') self._nad_volume = self.VOLUME_LEVELS self.set_volume(0) - logger.info(u'Done calibrating NAD amplifier') + logger.info(u'NAD amplifier: Done calibrating') def set_volume(self, volume): # Increase or decrease the amplifier volume until it matches the given From 297b8db3cd858a3faa4219b0c0d9e466e6866f9c Mon Sep 17 00:00:00 2001 From: Stein Magnus Jodal Date: Sun, 9 Sep 2012 12:54:17 +0200 Subject: [PATCH 7/7] Titlecase source and speaker settings --- docs/changes.rst | 2 +- mopidy/mixers/nad.py | 18 +++++------------- 2 files changed, 6 insertions(+), 14 deletions(-) diff --git a/docs/changes.rst b/docs/changes.rst index 6298c8e3..922eba13 100644 --- a/docs/changes.rst +++ b/docs/changes.rst @@ -56,7 +56,7 @@ v0.8 (in development) Now is reduced to simply: - MIXER = u'nadmixer port=/dev/ttyUSB0 source=Aux speakers-a=On speakers-b=Off' + MIXER = u'nadmixer port=/dev/ttyUSB0 source=aux speakers-a=on speakers-b=off' The ``port`` property defaults to ``/dev/ttyUSB0``, and the rest of the properties may be left out if you don't want the mixer to adjust the settings diff --git a/mopidy/mixers/nad.py b/mopidy/mixers/nad.py index dad3e853..de959d41 100644 --- a/mopidy/mixers/nad.py +++ b/mopidy/mixers/nad.py @@ -108,16 +108,8 @@ class NadTalker(ThreadingActor): self.port = port self.source = source - if speakers_a in ('On', 'Off'): - self.speakers_a = speakers_a - else: - logger.warning('speakers-a must be "On" or "Off", or unset') - self.speakers_a = None - if speakers_b in ('On', 'Off'): - self.speakers_b = speakers_b - else: - logger.warning('speakers-b must be "On" or "Off", or unset') - self.speakers_b = None + self.speakers_a = speakers_a + self.speakers_b = speakers_b # Volume in range 0..VOLUME_LEVELS. :class:`None` before calibration. self._nad_volume = None @@ -157,13 +149,13 @@ class NadTalker(ThreadingActor): def _select_speakers(self): if self.speakers_a is not None: - self._check_and_set('Main.SpeakerA', self.speakers_a) + self._check_and_set('Main.SpeakerA', self.speakers_a.title()) if self.speakers_b is not None: - self._check_and_set('Main.SpeakerB', self.speakers_b) + self._check_and_set('Main.SpeakerB', self.speakers_b.title()) def _select_input_source(self): if self.source is not None: - self._check_and_set('Main.Source', self.source) + self._check_and_set('Main.Source', self.source.title()) def mute(self, mute): if mute: