librespot/CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning since v0.2.0.

Unreleased

Changed

• [main] Enforce reasonable ranges for option values (breaking).
• [main] Don't evaluate options that would otherwise have no effect.
• [playback] alsa: Improve --device ? functionality for the alsa backend.
• [contrib] Hardened security of the systemd service units
• [main] Verbose logging mode (-v, --verbose) now logs all parsed environment variables and command line arguments (credentials are redacted).
• [playback] Sink: write() now receives ownership of the packet (breaking).
• [playback] pipe: create file if it doesn't already exist
• [playback] More robust dynamic limiter for very wide dynamic range (breaking)
• [core] Session: connect() now returns the long-term credentials.
• [core] Session: connect() now accespt a flag if the credentails should be stored via the cache.
• [chore] The MSRV is now 1.53.
• [playback] gstreamer: create own context, set correct states and use sync handler

Added

• [cache] Add disable-credential-cache flag (breaking).
• [main] Use different option descriptions and error messages based on what backends are enabled at build time.
• [main] Add a -q, --quiet option that changes the logging level to warn.
• [main] Add a short name for every flag and option.
• [main] Add the ability to parse environment variables.
• [playback] pulseaudio: set the PulseAudio name to match librespot's device name via PULSE_PROP_application.name environment variable (user set env var value takes precedence). (breaking)
• [playback] pulseaudio: set icon to audio-x-generic so we get an icon instead of a placeholder via PULSE_PROP_application.icon_name environment variable (user set env var value takes precedence). (breaking)
• [playback] pulseaudio: set values to: PULSE_PROP_application.version, PULSE_PROP_application.process.binary, PULSE_PROP_stream.description, PULSE_PROP_media.software and PULSE_PROP_media.role environment variables (user set env var values take precedence). (breaking)

Fixed

• [main] Prevent hang when discovery is disabled and there are no credentials or when bad credentials are given.
• [main] Don't panic when parsing options. Instead list valid values and exit.
• [main] --alsa-mixer-device and --alsa-mixer-index now fallback to the card and index specified in --device.
• [core] Removed unsafe code (breaking)
• [playback] Adhere to ReplayGain spec when calculating gain normalisation factor.
• [playback] alsa: Use --volume-range overrides for softvol controls
• [connect] Don't panic when activating shuffle without previous interaction.
• [main] Fix crash when built with Avahi support but Avahi is locally unavailable.

Removed

• [playback] alsamixer: previously deprecated option mixer-card has been removed.
• [playback] alsamixer: previously deprecated option mixer-name has been removed.
• [playback] alsamixer: previously deprecated option mixer-index has been removed.

0.3.1 - 2021-10-24

Changed

• Include build profile in the displayed version information
• [playback] Improve dithering CPU usage by about 33%

Fixed

• [connect] Partly fix behavior after last track of an album/playlist

0.3.0 - 2021-10-13

Added

• [discovery] The crate librespot-discovery for discovery in LAN was created. Its functionality was previously part of librespot-connect.
• [playback] Add support for dithering with --dither for lower requantization error (breaking)
• [playback] Add --volume-range option to set dB range and control log and cubic volume control curves
• [playback] alsamixer: support for querying dB range from Alsa softvol
• [playback] Add --format F64 (supported by Alsa and GStreamer only)
• [playback] Add --normalisation-gain-type auto that switches between album and track automatically

Changed

• [audio, playback] Moved VorbisDecoder, VorbisError, AudioPacket, PassthroughDecoder, PassthroughError, DecoderError, AudioDecoder and the convert module from librespot-audio to librespot-playback. The underlying crates vorbis, librespot-tremor, lewton and ogg should be used directly. (breaking)
• [audio, playback] Use Duration for time constants and functions (breaking)
• [connect, playback] Moved volume controls from librespot-connect to librespot-playback crate
• [connect] Synchronize player volume with mixer volume on playback
• [playback] Store and pass samples in 64-bit floating point
• [playback] Make cubic volume control available to all mixers with --volume-ctrl cubic
• [playback] Normalize volumes to [0.0..1.0] instead of [0..65535] for greater precision and performance (breaking)
• [playback] alsamixer: complete rewrite (breaking)
• [playback] alsamixer: query card dB range for the volume control unless specified otherwise
• [playback] alsamixer: use --device name for --mixer-card unless specified otherwise
• [playback] player: consider errors in sink.start, sink.stop and sink.write fatal and exit(1) (breaking)
• [playback] player: make convert and decoder public so you can implement your own Sink
• [playback] player: update default normalisation threshold to -2 dBFS
• [playback] player: default normalisation type is now auto

Deprecated

• [connect] The discovery module was deprecated in favor of the librespot-discovery crate
• [playback] alsamixer: renamed mixer-card to alsa-mixer-device
• [playback] alsamixer: renamed mixer-name to alsa-mixer-control
• [playback] alsamixer: renamed mixer-index to alsa-mixer-index

Removed

• [connect] Removed no-op mixer started/stopped logic (breaking)
• [playback] Removed with-vorbis and with-tremor features
• [playback] alsamixer: removed --mixer-linear-volume option, now that --volume-ctrl {linear|log} work as expected on Alsa

Fixed

• [connect] Fix step size on volume up/down events
• [connect] Fix looping back to the first track after the last track of an album or playlist
• [playback] Incorrect PlayerConfig::default().normalisation_threshold caused distortion when using dynamic volume normalisation downstream
• [playback] Fix log and cubic volume controls to be mute at zero volume
• [playback] Fix S24_3 format on big-endian systems
• [playback] alsamixer: make cubic consistent between cards that report minimum volume as mute, and cards that report some dB value
• [playback] alsamixer: make --volume-ctrl {linear|log} work as expected
• [playback] alsa, gstreamer, pulseaudio: always output in native endianness
• [playback] alsa: revert buffer size to ~500 ms
• [playback] alsa, pipe, pulseaudio: better error handling
• [metadata] Skip tracks whose Spotify ID's can't be found (e.g. local files, which aren't supported)

0.2.0 - 2021-05-04

0.1.6 - 2021-02-22

0.1.5 - 2021-02-21

0.1.3 - 2020-07-29

0.1.2 - 2020-07-22

0.1.1 - 2020-01-30

0.1.0 - 2019-11-06