From 30ea4860a7d1381e61e0de5aeebd80850c8d986a Mon Sep 17 00:00:00 2001 From: Janez Troha Date: Wed, 1 May 2013 14:12:49 +0300 Subject: [PATCH 01/15] Add mention of mopidy-convert-config --- docs/config.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/config.rst b/docs/config.rst index 9b3291c69b..856df13a95 100644 --- a/docs/config.rst +++ b/docs/config.rst @@ -37,6 +37,12 @@ below, together with their default values. In addition, all :ref:`extensions ` got additional config values. The extension's config values and config defaults are documented on the :ref:`extension pages `. +Migrating from pre 0.14 +----------------------- + +For those users upgrading from versions prior to 0.14 we made :option:`mopidy-convert-config` tool, +to ease proces of migrating settings to new config format. + Default core configuration ========================== From 9ad88f712d4872f152e1f55695dedea694a74417 Mon Sep 17 00:00:00 2001 From: Stein Magnus Jodal Date: Wed, 1 May 2013 15:07:56 +0200 Subject: [PATCH 02/15] docs: Fix typo and level of header --- docs/config.rst | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/config.rst b/docs/config.rst index 856df13a95..233ef26cc5 100644 --- a/docs/config.rst +++ b/docs/config.rst @@ -37,11 +37,13 @@ below, together with their default values. In addition, all :ref:`extensions ` got additional config values. The extension's config values and config defaults are documented on the :ref:`extension pages `. + Migrating from pre 0.14 ------------------------ +======================= -For those users upgrading from versions prior to 0.14 we made :option:`mopidy-convert-config` tool, -to ease proces of migrating settings to new config format. +For those users upgrading from versions prior to 0.14 we made +the :option:`mopidy-convert-config` tool, to ease the process of migrating +settings to the new config format. Default core configuration From db956ee1a98a19fe7136749b908aa232db5454d1 Mon Sep 17 00:00:00 2001 From: Stein Magnus Jodal Date: Wed, 1 May 2013 20:51:17 +0200 Subject: [PATCH 03/15] docs: Use 'config' more consistently --- docs/config.rst | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/config.rst b/docs/config.rst index 233ef26cc5..ff351b4af8 100644 --- a/docs/config.rst +++ b/docs/config.rst @@ -17,11 +17,11 @@ as simple as this: Mopidy primarily reads config from the file ``~/.config/mopidy/mopidy.conf``, where ``~`` means your *home directory*. If your username is ``alice`` and you -are running Linux, the settings file should probably be at +are running Linux, the config file should probably be at ``/home/alice/.config/mopidy/mopidy.conf``. You can either create the configuration file yourself, or run the ``mopidy`` command, and it will create -an empty settings file for you and print what config values must be set -to successfully start Mopidy. +an empty config file for you and print what config values must be set to +successfully start Mopidy. When you have created the configuration file, open it in a text editor, and add the config values you want to change. If you want to keep the default for a @@ -109,8 +109,8 @@ Core configuration values .. confval:: logging/config_file - Config file that overrides all logging settings, see `the Python logging - docs`_ for details. + Config file that overrides all logging config values, see `the Python + logging docs`_ for details. .. confval:: loglevels/* @@ -212,9 +212,9 @@ can use with the ``gst-launch-0.10`` command can be plugged into New configuration values ------------------------ -Mopidy's settings validator will stop you from defining any config values in -your settings file that Mopidy doesn't know about. This may sound obnoxious, -but it helps us detect typos in your settings, and deprecated settings that +Mopidy's config validator will stop you from defining any config values in +your config file that Mopidy doesn't know about. This may sound obnoxious, +but it helps us detect typos in your config, and deprecated config values that should be removed or updated. If you're extending Mopidy, and want to use Mopidy's configuration From 30ab6606278b639c5c7eecb74899d6e7cf6b9ca3 Mon Sep 17 00:00:00 2001 From: Stein Magnus Jodal Date: Wed, 1 May 2013 21:43:40 +0200 Subject: [PATCH 04/15] docs: Remove mixers' module docs --- docs/modules/audio/mixers/auto.rst | 6 ------ docs/modules/audio/mixers/fake.rst | 6 ------ mopidy/audio/mixers/auto.py | 10 ---------- mopidy/audio/mixers/fake.py | 9 --------- 4 files changed, 31 deletions(-) delete mode 100644 docs/modules/audio/mixers/auto.rst delete mode 100644 docs/modules/audio/mixers/fake.rst diff --git a/docs/modules/audio/mixers/auto.rst b/docs/modules/audio/mixers/auto.rst deleted file mode 100644 index caf6e3abab..0000000000 --- a/docs/modules/audio/mixers/auto.rst +++ /dev/null @@ -1,6 +0,0 @@ -********************************************* -:mod:`mopidy.audio.mixers.auto` -- Auto mixer -********************************************* - -.. automodule:: mopidy.audio.mixers.auto - :synopsis: Mixer element which automatically selects the real mixer to use diff --git a/docs/modules/audio/mixers/fake.rst b/docs/modules/audio/mixers/fake.rst deleted file mode 100644 index dcab77677e..0000000000 --- a/docs/modules/audio/mixers/fake.rst +++ /dev/null @@ -1,6 +0,0 @@ -********************************************* -:mod:`mopidy.audio.mixers.fake` -- Fake mixer -********************************************* - -.. automodule:: mopidy.audio.mixers.fake - :synopsis: Fake mixer for use in tests diff --git a/mopidy/audio/mixers/auto.py b/mopidy/audio/mixers/auto.py index 6b76e1a1c7..587994cb04 100644 --- a/mopidy/audio/mixers/auto.py +++ b/mopidy/audio/mixers/auto.py @@ -2,16 +2,6 @@ This is Mopidy's default mixer. - -Dependencies -============ - -None - - -Configuration -============= - If this wasn't the default, you would set the :confval:`audio/mixer` config value to ``autoaudiomixer`` to use this mixer. """ diff --git a/mopidy/audio/mixers/fake.py b/mopidy/audio/mixers/fake.py index 589610ce67..7daea6a177 100644 --- a/mopidy/audio/mixers/fake.py +++ b/mopidy/audio/mixers/fake.py @@ -1,14 +1,5 @@ """Fake mixer for use in tests. -Dependencies -============ - -None - - -Configuration -============= - Set the :confval:`audio/mixer:` config value to ``fakemixer`` to use this mixer. """ From 7560df945eeae8e4feffac5256ab8f709e69869a Mon Sep 17 00:00:00 2001 From: Stein Magnus Jodal Date: Wed, 1 May 2013 21:44:02 +0200 Subject: [PATCH 05/15] docs: Add section on extension config and disabling --- docs/config.rst | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/docs/config.rst b/docs/config.rst index ff351b4af8..1710d42df7 100644 --- a/docs/config.rst +++ b/docs/config.rst @@ -139,6 +139,24 @@ Core configuration values http://docs.python.org/2/library/logging.config.html +Extension configuration +======================= + +Mopidy's extensions have their own config values that you may want to tweak. +For the available config values, please refer to the docs for each extension. +Most, if not all, can be found at :ref:`ext`. + +Mopidy extensions are enabled by default when they are installed. If you want +to disable an extension without uninstalling it, all extensions support the +``enabled`` config value even if it isn't explicitly documented by all +extensions. If the ``enabled`` config value is set to ``false`` the extension +will not be started. For example, to disable the Spotify extension, add the +following to your ``mopidy.conf``:: + + [spotify] + enabled = false + + Advanced configurations ======================= From 7ed7cc13eef8ee13ded10de035069194de0762ba Mon Sep 17 00:00:00 2001 From: Stein Magnus Jodal Date: Thu, 2 May 2013 23:13:08 +0200 Subject: [PATCH 06/15] docs: Add glossary (fixes #430) --- docs/ext/scrobbler.rst | 2 ++ docs/glossary.rst | 37 +++++++++++++++++++++++++++++++++++++ docs/index.rst | 1 + 3 files changed, 40 insertions(+) create mode 100644 docs/glossary.rst diff --git a/docs/ext/scrobbler.rst b/docs/ext/scrobbler.rst index a0496b3741..84188d02a9 100644 --- a/docs/ext/scrobbler.rst +++ b/docs/ext/scrobbler.rst @@ -1,3 +1,5 @@ +.. _ext-scrobbler: + **************** Mopidy-Scrobbler **************** diff --git a/docs/glossary.rst b/docs/glossary.rst new file mode 100644 index 0000000000..2aa63887f4 --- /dev/null +++ b/docs/glossary.rst @@ -0,0 +1,37 @@ +******** +Glossary +******** + +.. glossary:: + + backend + A part of Mopidy providing music library, playlist storage and/or + playback capability to the :term:`core`. Mopidy have a backend for each + music store or music service it supports. See :ref:`backend-api` for + details. + + core + The part of Mopidy that makes multiple frontends capable of using + multiple backends. The core module is also the owner of the + :term:`tracklist`. To use the core module, see :ref:`core-api`. + + extension + A Python package that can extend Mopidy with on or more + :term:`backends `, :term:`frontends `, or GStreamer + elements like :term:`mixers `. See :ref:`ext` for a list of + existing extensions and :ref:`extensiondev` for how to make a new + extension. + + frontend + A part of Mopidy *using* the :term:`core` API. Existing frontends + include the :ref:`MPD server `, the :ref:`MPRIS/D-Bus + integration `, the :ref:`Last.fm scrobbler `, + and the :ref:`HTTP server ` with JavaScript API. See + :ref:`frontend-api` for details. + + mixer + A GStreamer element that controls audio volume. + + tracklist + Mopidy's name for the play queue or current playlist. The name is + inspired by the MPRIS specification. diff --git a/docs/index.rst b/docs/index.rst index 199ba31cbc..fb91244dd8 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -71,6 +71,7 @@ Reference .. toctree:: :maxdepth: 2 + glossary api/index modules/index From b2a0b58943707227509cfd87381c5ba0c0420082 Mon Sep 17 00:00:00 2001 From: Thomas Adamcik Date: Sat, 11 May 2013 00:57:49 +0200 Subject: [PATCH 07/15] docs: Add how to get good sound on raspis (fixes: #299) --- docs/installation/raspberrypi.rst | 62 +++++++++++++++++++++++++++++-- 1 file changed, 58 insertions(+), 4 deletions(-) diff --git a/docs/installation/raspberrypi.rst b/docs/installation/raspberrypi.rst index c5a4eae83e..084dc9771d 100644 --- a/docs/installation/raspberrypi.rst +++ b/docs/installation/raspberrypi.rst @@ -57,7 +57,7 @@ How to for Debian 7 (Wheezy) #. Since I have a HDMI cable connected, but want the sound on the analog sound connector, I have to run:: - amixer cset numid=3 1 + sudo amixer cset numid=3 1 to force it to use analog output. ``1`` means analog, ``0`` means auto, and is the default, while ``2`` means HDMI. You can test sound output @@ -75,6 +75,60 @@ How to for Debian 7 (Wheezy) Fixing audio quality issues =========================== -As of January 2013, some reports also indicate that pushing the audio through -PulseAudio may help. We hope to, in the future, provide a complete set of -instructions here leading to acceptable analog audio quality. +As of about April 2013 the following steps should resolve any audio +issues for HDMI and analog without the use of an external USB sound +card. + +#. Ensure you system is up to date, for debian based systems run:: + + sudo apt-get update + sudo apt-get full-upgrade + +#. Ensure you have a new enough firmware, on debian based systems + `rpi-update `_ + can be used. + +#. Update either ``~/.asoundrc`` or ``/etc/asound.conf`` to the + following:: + + pcm.!default { + type hw + card 0 + } + ctl.!default { + type hw + card 0 + } + + Note that if you have an ``asoundrc`` it will overide + any global settings. + +#. Update your ``~/.config/mopidy/mopidy.conf`` to contain:: + + [audio] + output = alsasink + + This is to tell GStreamer not to pick Jack which it seems to like + picking on RaspberryPis for some reason. + + +Following these steps you should be able to get crackle free sound on +either HDMI or analog. Note that you might need to ensure that pulse +is no longer running to get this working nicely. + +This recipe has been confirmed as working by a number of users on our +bug tracker and irc. As a reference, the following versions where used +for testing this, however all newer and some older version are likely +to work as we have not determined the exact revision that fixed this:: + + $ uname -a + Linux raspberrypi 3.6.11+ #408 PREEMPT Wed Apr 10 20:33:39 BST 2013 armv6l GNU/Linux + + $ /opt/vc/bin/vcgencmd version + Apr 25 2013 01:07:36 + Copyright (c) 2012 Broadcom + version 386589 (release) + +The only remaining known issues is a slight gap in playback at track +changes this is likely due to gapless playback not being implemented +and is being worked on irrespective of raspi related work. From 346ede73e502f3610128ac9d5821729ddf1820d9 Mon Sep 17 00:00:00 2001 From: Stein Magnus Jodal Date: Sat, 11 May 2013 18:40:08 +0200 Subject: [PATCH 08/15] docs: Review Raspi sound quality howto --- docs/installation/raspberrypi.rst | 45 +++++++++++++++---------------- 1 file changed, 22 insertions(+), 23 deletions(-) diff --git a/docs/installation/raspberrypi.rst b/docs/installation/raspberrypi.rst index 084dc9771d..acb37b36f7 100644 --- a/docs/installation/raspberrypi.rst +++ b/docs/installation/raspberrypi.rst @@ -79,12 +79,12 @@ As of about April 2013 the following steps should resolve any audio issues for HDMI and analog without the use of an external USB sound card. -#. Ensure you system is up to date, for debian based systems run:: +#. Ensure your system is up to date. On Debian based systems run:: sudo apt-get update sudo apt-get full-upgrade -#. Ensure you have a new enough firmware, on debian based systems +#. Ensure you have a new enough firmware. On Debian based systems `rpi-update `_ can be used. @@ -100,35 +100,34 @@ card. card 0 } - Note that if you have an ``asoundrc`` it will overide - any global settings. + Note that if you have an ``~-/.asoundrc`` it will overide any global + settings from ``/etc/asound.conf``. #. Update your ``~/.config/mopidy/mopidy.conf`` to contain:: [audio] output = alsasink - This is to tell GStreamer not to pick Jack which it seems to like - picking on RaspberryPis for some reason. + This is to tell GStreamer not to pick Jack which it seems to like picking on + Raspberry Pis for some reason. +Following these steps you should be able to get crackle free sound on either +HDMI or analog. Note that you might need to ensure that PulseAudio is no longer +running to get this working nicely. -Following these steps you should be able to get crackle free sound on -either HDMI or analog. Note that you might need to ensure that pulse -is no longer running to get this working nicely. +This recipe has been confirmed as working by a number of users on our issue +tracker and IRC. As a reference, the following versions where used for testing +this, however all newer and some older version are likely to work as we have +not determined the exact revision that fixed this:: -This recipe has been confirmed as working by a number of users on our -bug tracker and irc. As a reference, the following versions where used -for testing this, however all newer and some older version are likely -to work as we have not determined the exact revision that fixed this:: + $ uname -a + Linux raspberrypi 3.6.11+ #408 PREEMPT Wed Apr 10 20:33:39 BST 2013 armv6l GNU/Linux - $ uname -a - Linux raspberrypi 3.6.11+ #408 PREEMPT Wed Apr 10 20:33:39 BST 2013 armv6l GNU/Linux + $ /opt/vc/bin/vcgencmd version + Apr 25 2013 01:07:36 + Copyright (c) 2012 Broadcom + version 386589 (release) - $ /opt/vc/bin/vcgencmd version - Apr 25 2013 01:07:36 - Copyright (c) 2012 Broadcom - version 386589 (release) - -The only remaining known issues is a slight gap in playback at track -changes this is likely due to gapless playback not being implemented -and is being worked on irrespective of raspi related work. +The only remaining known issue is a slight gap in playback at track changes +this is likely due to gapless playback not being implemented and is being +worked on irrespective of Raspberry Pi related work. From ce111f6bcdb01f5a91b5fa3f4b5ee9db60644aa5 Mon Sep 17 00:00:00 2001 From: Stein Magnus Jodal Date: Sun, 12 May 2013 21:46:46 +0200 Subject: [PATCH 09/15] docs: Fix typo --- docs/installation/raspberrypi.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/installation/raspberrypi.rst b/docs/installation/raspberrypi.rst index acb37b36f7..cc46c8b1eb 100644 --- a/docs/installation/raspberrypi.rst +++ b/docs/installation/raspberrypi.rst @@ -100,7 +100,7 @@ card. card 0 } - Note that if you have an ``~-/.asoundrc`` it will overide any global + Note that if you have an ``~/.asoundrc`` it will overide any global settings from ``/etc/asound.conf``. #. Update your ``~/.config/mopidy/mopidy.conf`` to contain:: From 2a43166b50c9b9c192b6f51c6876daaa239de515 Mon Sep 17 00:00:00 2001 From: Stein Magnus Jodal Date: Thu, 13 Jun 2013 14:59:37 +0200 Subject: [PATCH 10/15] docs: Fix dist-upgrade command (fixes #470) (cherry picked from commit 31ef29e1216a856a3ce72551516ef61ea4af7701) --- docs/installation/raspberrypi.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/installation/raspberrypi.rst b/docs/installation/raspberrypi.rst index cc46c8b1eb..27aa5caf93 100644 --- a/docs/installation/raspberrypi.rst +++ b/docs/installation/raspberrypi.rst @@ -82,7 +82,7 @@ card. #. Ensure your system is up to date. On Debian based systems run:: sudo apt-get update - sudo apt-get full-upgrade + sudo apt-get dist-upgrade #. Ensure you have a new enough firmware. On Debian based systems `rpi-update `_ From a4543ca13aac1f0914e07153cc1fb7b152c366c2 Mon Sep 17 00:00:00 2001 From: Stein Magnus Jodal Date: Mon, 24 Jun 2013 23:12:17 +0200 Subject: [PATCH 11/15] docs: Fix link to rpi-update --- docs/installation/raspberrypi.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/installation/raspberrypi.rst b/docs/installation/raspberrypi.rst index 27aa5caf93..53674e7da3 100644 --- a/docs/installation/raspberrypi.rst +++ b/docs/installation/raspberrypi.rst @@ -85,7 +85,7 @@ card. sudo apt-get dist-upgrade #. Ensure you have a new enough firmware. On Debian based systems - `rpi-update `_ + `rpi-update `_ can be used. #. Update either ``~/.asoundrc`` or ``/etc/asound.conf`` to the From 4a48f8f216900a74eead9efe61b1c1569bb40f3c Mon Sep 17 00:00:00 2001 From: Stein Magnus Jodal Date: Mon, 1 Jul 2013 11:43:05 +0200 Subject: [PATCH 12/15] Allow pyspotify 1.9 and higher, including 1.11 --- requirements/spotify.txt | 2 +- setup.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/requirements/spotify.txt b/requirements/spotify.txt index 333e55c805..d11a5c0447 100644 --- a/requirements/spotify.txt +++ b/requirements/spotify.txt @@ -1,4 +1,4 @@ -pyspotify >= 1.9, < 1.11 +pyspotify >= 1.9, < 2 # The libspotify Python wrapper # Available as the python-spotify package from apt.mopidy.com diff --git a/setup.py b/setup.py index 8e02d53ddf..1eaecdae86 100644 --- a/setup.py +++ b/setup.py @@ -28,7 +28,7 @@ def get_version(filename): 'Pykka >= 1.1', ], extras_require={ - 'spotify': ['pyspotify >= 1.9, < 1.11'], + 'spotify': ['pyspotify >= 1.9, < 2'], 'scrobbler': ['pylast >= 0.5.7'], 'http': ['cherrypy >= 3.2.2', 'ws4py >= 0.2.3'], }, From cb561519dbd7be3f71f20f69415e526de8cf6a3d Mon Sep 17 00:00:00 2001 From: Stein Magnus Jodal Date: Mon, 1 Jul 2013 11:46:39 +0200 Subject: [PATCH 13/15] Bump version number to 0.14.2 --- mopidy/__init__.py | 2 +- tests/version_test.py | 5 +++-- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/mopidy/__init__.py b/mopidy/__init__.py index 14646df60f..fbd1dcca2e 100644 --- a/mopidy/__init__.py +++ b/mopidy/__init__.py @@ -23,4 +23,4 @@ warnings.filterwarnings('ignore', 'could not open display') -__version__ = '0.14.1' +__version__ = '0.14.2' diff --git a/tests/version_test.py b/tests/version_test.py index ce16d435b3..41e4f89b9b 100644 --- a/tests/version_test.py +++ b/tests/version_test.py @@ -38,5 +38,6 @@ def test_versions_can_be_strictly_ordered(self): self.assertLess(SV('0.11.1'), SV('0.12.0')) self.assertLess(SV('0.12.0'), SV('0.13.0')) self.assertLess(SV('0.13.0'), SV('0.14.0')) - self.assertLess(SV('0.14.0'), SV(__version__)) - self.assertLess(SV(__version__), SV('0.14.2')) + self.assertLess(SV('0.14.0'), SV('0.14.1')) + self.assertLess(SV('0.14.1'), SV(__version__)) + self.assertLess(SV(__version__), SV('0.14.3')) From bcf71430963ca0f1adfb29db7b84e52fa356d7ad Mon Sep 17 00:00:00 2001 From: Stein Magnus Jodal Date: Mon, 1 Jul 2013 11:46:48 +0200 Subject: [PATCH 14/15] docs: Update changelog for 0.14.2 --- docs/changelog.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/changelog.rst b/docs/changelog.rst index 1dd14fb776..fbcab5de7e 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -4,6 +4,18 @@ Changelog This changelog is used to track all major changes to Mopidy. + +v0.14.2 (2013-07-01) +==================== + +This is a maintenance release to make Mopidy 0.14 work with pyspotify 1.11. + +**Dependencies** + +- pyspotify >= 1.9, < 2 is now required for Spotify support. In other words, + you're free to upgrade to pyspotify 1.11, but it isn't a requirement. + + v0.14.1 (2013-04-28) ==================== From e206a6fdf7ba4cae372eb0728658b9c3415b66fb Mon Sep 17 00:00:00 2001 From: Stein Magnus Jodal Date: Mon, 1 Jul 2013 11:50:29 +0200 Subject: [PATCH 15/15] Release v0.14.2