Sublime-music

=======

.. note::

This version does not have a Flatpak due to issues getting Python 3.8 working
within the Flatpak environment. See `Issue 218
<https://gitlab.com/sublime-music/sublime-music/-/issues/218_>`_

.. warning::

This version is not compatible with any previous versions. If you have run a
previous version of Sublime Music, please delete your cache (likely in
``~/.local/share/sublime-music``) and your existing configuration (likely in
``~/.config/sublime-music``) and re-run Sublime Music to restart the
configuration process.

Features
--------

**Improvements to configuring Music Sources**

* The mechanism for adding new *Music Sources* (the *Server* nomenclature has)
been dropped in favor of the more generic *Music Source*) has been totally
revamped. It now is a multi-stage dialog that will (in the future) allow you
to connect to more than just Subsonic-compatible servers.
* The configuration form for Subsonic is no longer just a massive list of
options. Instead, there is an "Advanced Settings" section that is collapsed by
default.
* The configuration dialog automatically checks if you can connect to the server
and shows you any errors which means there is no need to click "Test
Connection to Server" any more!
* Adding and removing music sources is now done directly in the server popup
(see below for details).

**Offline Mode**

* You can enable *Offline Mode* from the server menu.
* Features that require network access are disabled in offline mode.
* You can still browse anything that is already cached offline.

**Albums Tab Improvements**

* The Albums tab is now paginated with configurable page sizes.
* You can sort the Albums tab ascending or descending.
* Opening an closing an album on the Albums tab now has a nice animation and the
album details panel is visually inset.
* The "Go to Album" functionality from the context menu is much more reliable.
* The album results can now be served from the cache much more often meaning
less latency when trying to load albums (this is a byproduct of the Offline
Mode work).

**Player Controls**

* The amount of the song that is cached is now shown while streaming a song.
* The notification for resuming a play queue is now a non-modal notification
that pops up right above the player controls.

**New Icons**

* The Devices button now uses the Chromecast logo. It uses a different icon
depending on whether or not you are playing on a Chromecast.
* Custom icons for "Add to play queue", and "Play next" buttons. Thanks to
`samsartor`_ for contributing the SVGs!
* A new icon for indicating the connection state to the Subsonic server.
Contributed by `samsartor`_.
* A new icon for that data wasn't able to be loaded due to being offline.
Contributed by `samsartor`_.

.. _samsartor: https://gitlab.com/samsartor

**Application Menus**

* **Settings**

* Settings are now in the popup under the gear icon rather than in a separate
popup window.

* **Downloads**

* A new Downloads popup shows the currently downloading songs.
* You can now cancel song downloads and retry failed downloads.
* You can now clear the cache (either the entire cache or just the song files)
via options in the Downloads popup.

* **Server**

* A new Server popup shows the connection state to the server in both the icon
and the popup.
* You can enable *Offline Mode* from this menu.
* You can edit the current music source's configuration, switch to a different
music source, or add a whole new music source via this menu.

**Other Features**

* You can now collapse the Artist details and the Playlist details so that you
have more room to view the actual content.

Under The Hood
--------------

This release has a ton of under-the-hood changes to make things more robust
and performant.

* The cache is now stored in a SQLite database.
* The cache and configuration no longer get corrupted when Sublime Music fails
to write to disk due to errors.
* A generic `Adapter API`_ has been created which means that Sublime Music is no
longer reliant on Subsonic. This means that in the future, more backends can
be added.

.. _Adapter API: https://sublime-music.gitlab.io/sublime-music/adapter-api.html

======

* **Flatpak support is back!** After resolving a build error that's been
plaguing us since **v0.8.9**, we once again have a Flatpak build!

The Flatpak now also exports a ``.desktop`` file and an AppStream manifest
file.

* The ``keyring`` dependency is now optional.
* The ``.desktop`` file doesn't hard-code the exec path anymore.

======

* **macOS Support Alpha:** support for macOS is now in alpha. There is very
little documentation, and quite a few hacks, but core functionality works.
* Sublime Music is more resilient to certain libraries or functionalities not
existing on the system. (Namely libnotify, NetworkManager, and DBus)
* Sublime Music now prompts you to confirm you actually want to delete the
playlist. (81)
* Playlist and Artist info now scroll with the rest of the content which makes
Sublime Music usable on smaller screens. (152)
* Worked with deluan_ to support the Navidrome_ server.

* **Bug Fixes**

* Sublime Music no longer explodes when you say "don't save password" in your
keyring notification popup.
* The ``NM`` library is used instead of the deprecated ``NetworkManager`` and
``NMClient``. (Contributed by anarcat.)
* Sublime Music will crash less often due to missing dependencies.
* Fixed some bugs where the state of the application wouldn't update when you
deleted/downloaded songs from certain parts of the application.

.. _deluan: https://www.deluan.com/
.. _Navidrome: https://www.navidrome.org/

======

This is the first ``v0.9.*`` release. I've decided to bump the minor version,
since this is the first release where I feel that all core functionality works.
All of the releases in the ``v0.9.*`` series will build towards the ``v1.0.0``
release.

* New logo that isn't total garbage. By mountdesign_ on Fiverr_. (110)
* Cover art for a given album is now only stored once at high resolution and
scaled whenever used.
* The shuffle and repeat buttons are now toggle buttons, and no longer rely on
the icon theme to provide context as to whether they are activated or not.
(125)
* Added support for Replay Gain option which is available from the Application
Settings dialog. (137)
* All of the buttons that are only icons now have tooltips describing what they
do.

* **Bug Fixes**

* The year inputs on the Albums tab no longer allow for non-numeric inputs,
and are generally way less janky. (123)
* When dealing with track covers, the ``song.coverArt`` property is used
instead of the ``song.id``. (Contributed by sentriz.)
* The Albums tab no longer loads infinitely when there are more than 500
albums in the results. (Contributed by sentriz.)
* The Albums tab doesn't flicker every single time an ``update`` is called
from the top level. (114)
* Fixed issue with setting the title of the "Edit/Add Server" dialog.

* **Infrastructure**

* Enabled a bunch of flake8 linter extensions including:

* Enforcing using type hints on all function declarations.
* Enforcing no ``print`` statements via flake8 instead of my janky script.
* Enforcing no use of ``%`` style string formatting.

These changes resulted in a *lot* of code cleanup.

.. _mountdesign: https://www.fiverr.com/mountdesign
.. _Fiverr: https://www.fiverr.com

=======

**Hotfix Release**: the previous release had a few major bugs which are
show-stoppers. This release fixes them.

* **Bug Fixes**

* Fixed issue where Browse didn't work the first time you opened the app to
that tab.
* Fixed issue where refresh didn't work on the Artists tab.
* Fixed issue displaying with incorrectly sized cover art in the player
controls.

* **Infrastructure**

* All TODOs in the code must now have corresponding issues.

=======

:Milestone: Beta 3

* When album cover art is not provided by the server, a default album art image
is used (Contributed by sentriz.)
* **New Setting**: *Serve locally cached files over the LAN to Chromecast
devices*: If checked, a local server will be started on your computer which
will serve your locally cached music files to the Chromecast. If not checked,
the Chromecast will always stream from the server.
* When serving local files, the internal server now only exposes one song at a
time via a token and the song's token is randomized.
* The *Sync enabled* setting was renamed to *Play queue sync enabled*.

* **Bug Fixes**

* Fixed issue where the UI was still in a "Playing" state after removing all
songs from the play queue.
* Fixed a multitude of problems where the wrong data would load if you quickly
move around between cached and un-cached information.
* When you use the Google Home app to cause the device that Sublime is using
to "Stop Casting", Sublime now shows as paused.
* The Chromecast device list are only requested after the first time you click
on the Devices button.
* Seeking now works with the mouse and keyboard.

* **Documentation**

* Updated the CONTRIBUTING document to the current state of the Sublime Music
codebase.
* Added documentation for all of the settings available in Sublime Music.

* **Infrastructure**

* Fixed logo build step.
* Moved ``player`` module to root instead of being under ``ui.common``.