Merge branch 'develop'

.github/CONTRIBUTING.md

@@ -41,7 +41,7 @@ Adding support for a new service
 
 Web streaming service integration plugins are now written in pure javascript.
 
-1. Create a new plugin using the wizard (see http://mellowplayer.readthedocs.io/en/webengine/developers/plugins.html#create-a-new-plugin)
+1. Create a new plugin using the wizard (see http://mellowplayer.readthedocs.io/en/latest/developers/plugins.html#create-a-new-plugin)
 2. Edit ``metadata.ini`` (add correct url, name, version,...)
 3. Edit ``description.html`` to describe the streaming service
 4. Customise logo.svg

.github/SUPPORT.md

@@ -0,0 +1,20 @@
+Things to check before reporting an issue
+-----------------------------------------
+
+1. Make sure the bug has not already been reported and search in the issue tracker for similar issue.
+2. If you're experiencing a crash of the application and are using open source NVIDIA drivers on GNU/Linux: please first try the proprietary NVIDIA drivers before reporting.
+3. If you're experiencing a crash of the application and are using the proprietary NVIDIA drivers: make sure you rebooted after your last NVIDIA driver update and make sure to run ``sudo nvidia-xconfig`` before reporting the issue
+
+Reporting bugs or Wishes
+------------------------
+
+Report any bugs you encountered or any wishes on our [issue tracker](https://github.com/ColinDuquesnoy/MellowPlayer/issues).
+
+If you're reporting a bug, **make sure to provide the following information**:
+
+- Information about your **Operating system** (e.g. Windows 8.1, Mac OSX Yosemite,...). If you're on Linux, you'll need to specify the
+  name of the distribution and the desktop environment you're using and whether you're using a native package or the AppImage.
+- The **music streaming service** that you were using when you encountered the bug if related to a specific streaming service.
+- A **clear description** of the bug with **steps to reproduce**.
+- You should use **English** to describe your issue. French is also accepted.
+- Paste the application log between triple backquotes ```(About > Show Logs)```.

.github_changelog_generator

@@ -1,7 +1,7 @@
 unreleased=true
-future-release=3.3.3
+future-release=3.3.4
 since-tag=2.2.5
 exclude-tags=Continuous
-exclude_labels=duplicate,question,invalid,wontfix,rejected,infrastructure,technical task,news,not our bug,discussion,website,support request
+exclude_labels=duplicate,question,invalid,wontfix,rejected,infrastructure,technical task,news,not our bug,discussion,website,support request,driver issue
 issues-wo-labels=false
 enhancement-labels=feature

CHANGELOG.md

@@ -1,10 +1,34 @@
 # Change Log
 
+## [3.3.4](https://github.com/ColinDuquesnoy/MellowPlayer/tree/3.3.4) (2018-02-18)
+[Full Changelog](https://github.com/ColinDuquesnoy/MellowPlayer/compare/3.3.3...3.3.4)
+
+**Implemented enhancements:**
+
+- add bandcamp plugin [\#200](https://github.com/ColinDuquesnoy/MellowPlayer/pull/200) ([bayang](https://github.com/bayang))
+
+**Fixed bugs:**
+
+- JS errors in ympd [\#207](https://github.com/ColinDuquesnoy/MellowPlayer/issues/207)
+- JS errors in Google Play Music [\#206](https://github.com/ColinDuquesnoy/MellowPlayer/issues/206)
+- JS Error on Deezer login page [\#205](https://github.com/ColinDuquesnoy/MellowPlayer/issues/205)
+- mellowplayer-3.3.3 compilation fails on Fedora 27 [\#196](https://github.com/ColinDuquesnoy/MellowPlayer/issues/196)
+
+**Closed issues:**
+
+- \[Documentation\] Broken links to ReadTheDocs in some files [\#201](https://github.com/ColinDuquesnoy/MellowPlayer/issues/201)
+- error message when generating man/html page with sphinx [\#199](https://github.com/ColinDuquesnoy/MellowPlayer/issues/199)
+
+**Merged pull requests:**
+
+- Fix broken links to ReadTheDocs in some files [\#202](https://github.com/ColinDuquesnoy/MellowPlayer/pull/202) ([andrewjmetzger](https://github.com/andrewjmetzger))
+
 ## [3.3.3](https://github.com/ColinDuquesnoy/MellowPlayer/tree/3.3.3) (2018-02-10)
 [Full Changelog](https://github.com/ColinDuquesnoy/MellowPlayer/compare/3.3.2...3.3.3)
 
 **Fixed bugs:**
 
+- AppImage startup fails on 3.3.3  [\#195](https://github.com/ColinDuquesnoy/MellowPlayer/issues/195)
 - Compilation issues with GCC8 [\#193](https://github.com/ColinDuquesnoy/MellowPlayer/issues/193)
 
 ## [3.3.2](https://github.com/ColinDuquesnoy/MellowPlayer/tree/3.3.2) (2018-01-28)

CMakeLists.txt

@@ -14,7 +14,7 @@ if (NOT BUILD_NUMBER)
 endif()
 
 
-project(MellowPlayer VERSION 3.3.3.${BUILD_NUMBER})
+project(MellowPlayer VERSION 3.3.4.${BUILD_NUMBER})
 set(CMAKE_VERBOSE_MAKEFILE FALSE)
 # cache version in CMakeCache.txt, so that script can easily query current version
 set(MELLOWPLAYER_VERSION "${MellowPlayer_VERSION}" CACHE STRING "")

docs/developers/contributing.rst

@@ -1 +1,81 @@
-.. include:: ../../CONTRIBUTING.rst
+Contributing to MellowPlayer
+============================
+
+Reporting bugs or Wishes
+------------------------
+
+Report any bugs you encountered or any wishes on our `issue tracker`_.
+
+If you’re reporting a bug, **make sure to provide the following
+information**:
+
+-  Information about your **Operating system** (e.g. Windows 8.1, Mac
+   OSX Yosemite,…). If you’re on Linux, you’ll need to specify the name
+   of the distribution and the desktop environment you’re using and
+   whether you’re using a native package or the AppImage.
+-  The **music streaming service** that you were using when you
+   encountered the bug if related to a specific streaming service.
+-  A **clear description** of the bug with **steps to reproduce**.
+-  You should use **English** to describe your issue. French is also
+   accepted.
+-  Paste the application log between triple backquotes
+   ``(About > Show Logs)``.
+
+Setting up a development environment
+------------------------------------
+
+Read the how to setup page of the `wiki`_
+
+We also recommend you read the `architecture`_ and the `coding
+guidelines`_ pages before hacking on MellowPlayer.
+
+Submitting a pull request
+-------------------------
+
+Here are the steps you need to follow to start working on MellowPlayer
+and submit your work for evaluation or integration into the main
+project:
+
+1. Fork the Repo on github.
+2. Create a feature or a bugfix branch before you start coding.
+3. Add your name to AUTHORS.md
+4. Format the code using ``scripts/beautify.py`` (run it from the root
+   source directory).
+5. Push to your fork and submit a pull request to **the develop
+   branch**.
+
+Adding support for a new service
+--------------------------------
+
+Web streaming service integration plugins are now written in pure
+javascript.
+
+1. Create a new plugin using the wizard (see
+   http://mellowplayer.readthedocs.io/en/latest/developers/plugins.html#create-a-new-plugin)
+2. Edit ``metadata.ini`` (add correct url, name, version,…)
+3. Edit ``description.html`` to describe the streaming service
+4. Customise logo.svg
+5. Implement the needed functions in ``integration.js``
+6. Once your plugin works, submit a pull request to **the develop
+   branch**.
+
+Adding/Updating a new translation
+---------------------------------
+
+MellowPlayer translations are hosted on `transifex`_
+
+-  Create an account at transifex
+-  Go to the project’s homepage and click on the “Join the team” button
+-  If the language you want to work on does not exists yet, send us a
+   language request. Once the request has been accepted, a new
+   translation file for the requested language will be created
+   automatically by transifex.
+-  To actually start translating, go to the project’s home page on
+   transifex and click on the tr
+
+.. _issue tracker: https://github.com/ColinDuquesnoy/MellowPlayer/issues
+.. _wiki: https://github.com/ColinDuquesnoy/MellowPlayer/wiki
+.. _architecture: https://github.com/ColinDuquesnoy/MellowPlayer/wiki/Architecture
+.. _coding guidelines: https://github.com/ColinDuquesnoy/MellowPlayer/wiki/Coding-guidelines
+.. _transifex: https://www.transifex.com/colinduquesnoy/mellowplayer
+

docs/users/faq.rst

@@ -1,17 +1,43 @@
 FAQ & Known issues
 ==================
 
-Frequently asked questions
---------------------------
+Playback does not start on some services such as Soundcloud or Mixcloud... What can I do?
+-----------------------------------------------------------------------------------------
 
-- I cannot play music on Spotify and on Mixcloud. What can I do?
+Services that don't use flash often requires proprietary audio codecs to be installed on your system. 
 
-Spotify and Mixcloud streaming has become quite tricky since they moved away from flash for managing content.
+Make sure you have installed the properietary audio codecs (ffmpeg with extra codecs) by following your distribution's install instructions.
 
-The official release of Qt and our official releases are not built with proprietary codecs for licensing reasons.
 
-**You need to recompile Qt WebEngine yourself with proprietary codecs support**. *Note that some linux distributions such as KaOS and OpenSuse ships QtWebEngine with proprietary codecs related.*
+The application crash at startup on GNU/Linux with open source NVIDIA drivers. What can I do?
+---------------------------------------------------------------------------------------------
 
-Spotify also requires the Widevine plugin to work. You can find more information in this `blog post`_.
+Qt/QML applications don't work well with the open source NVIDIA drivers (nouveau). It is recommended to **use the proprietary NVIDIA drivers**.
 
-.. _blog post: http://blog.qt.io/blog/2016/06/03/netflix-qt-webengine-5-7/
+
+There is no music playback on Spotify. What can I do?
+-----------------------------------------------------
+
+Make sure you have installed both the properietary audio codecs (ffmpeg with extra codecs) and the widevine DRM plugin. The DRM plugin can be extracted from chromium binary archive:
+
+.. code-block:: bash
+
+    wget https://archive.archlinux.org/packages/c/chromium/chromium-61.0.3163.100-1-x86_64.pkg.tar.xz
+    wget https://dl.google.com/widevine-cdm/1.4.8.1008-linux-x64.zip
+    tar -xvf chromium-61.0.3163.100-1-x86_64.pkg.tar.xz
+    unzip 1.4.8.1008-linux-x64.zip
+
+    sudo mkdir /usr/lib/chromium
+    sudo cp libwidevinecdm.so /usr/lib/chromium
+    sudo cp ./usr/lib/chromium/libwidevinecdmadapter.so /usr/lib/chromium
+    sudo chmod 644 /usr/lib/chromium/libwidevinecdm.so
+    sudo chmod 644 /usr/lib/chromium/libwidevinecdmadapter.so
+
+Not all advertised services are available on Windows, OSX and the AppImage. Is it normal?
+-----------------------------------------------------------------------------------------
+
+The official releases of Qt and our official releases are not built with proprietary audio codecs for licensing reasons. Services that require proprietary codecs are not loaded in the application.
+
+To get those service to work, you'll need to recompile Qt WebEngine and MellowPlayer yourself with proprietary codecs support.
+
+Note that with native GNU/Linux packages of MellowPlayer (Fedora, Ubuntu, Archlinux, openSUSE and KaOS) you just have to install proprietary audio codecs using your distribution's package manager (the package is usually named **ffmpeg-extra**).