Upmpdcli and associated libraries release notes

Qobuz: updated the plugin to be closer to the choices on the Web site.

Qobuz: fixed the search to better return what actually requested.

Tidal: updated plugin.

Misc fixes: restore custom icon support, clear "phantom" track from mpd to avoid its reappearance on startup,

Fix many issues with the Qobuz plugin which was actually thoroughly broken. Some restructuring remains needed, but this makes it usable again.

Fix issue with the Qobuz plugin on recent distributions (e.g. debian bookworm).

Updates to the Tidal and Subsonic plugins.

Uprcl compatibility with Recoll 1.40

There were short-lived 1.8.13-15 with a broken uprcl module and a linking issue in scctl.

Control, directory: fix handling multiple instances of a property value (try to avoid duplicates).

Control, directory: List albumartist first, if present, in artist list.

Control, directory: add property to each entry to communicate the exact order of the original content directory data (allows overriding the container/items separation in the libupnpp data).

Improved multi-interface search: send M-SEARCH on all configured interfaces instead of relying on routing.

Add interface method to set an Access-Control-Allow-Origin header on webserver responses.

Accept unquoted values in SOAPACTION headers.

Misc small fixes

Fix gcc 14 build (missing includes).

Fix gcc 14 build (missing includes).

Updates and fixes to the Tidal and Subsonic plugins.

Tidal: implement the PKCE login method to allow access to the highest definition streams.

Switched build method to meson/ninja.

Misc small fixes.

Misc internal cleanups, for npupnp mostly based on tools diagnostics (cppcheck,fanalyser, clang-tidy…​)

Tidal: avoid SQL error with older Sqlite versions.

Misc subsonic and Tidal improvements

Very minor bug fix.

Add interface for receiving events about disappearing devices.

UPnP/AV rendering control: only report events relating to the Master channel as "Volume" or "Mute". For other channels, append the channel name to the variable name, e.g. "Volume-Front". This does not change the interface for existing code (except that it won’t receive bogus event for aux. channels as if they were Master any more).

Use the same configured port for the UDP receiving sockets as well as was used for the TCP ones. Eases setting up a firewall.

More thorough cleanup when stopping the library (netif and MHD).

Misc code cleanups (portability, internal).

Implement some UPnP 1.1 features: unicast search and some additional packet fields.

libnpupnp: avoid putting the client thread to a (short) sleep when starting a search.

Both libs: add interface to perform a unicast search and to set a BOOTID.UPNP.ORG value.

Fix a bug where the search wait would end before the end of the actual search window, possibly leading to missing some renderers.

Control: add option to set timeouts for the subscription/unsubscription operations.

Control: add timeout parameter to a few action calls, to be used for testing the device health.

Device: ohproduct: export a parseSourceXML static method.

Device: added the LibUPnP::setWebServerDocumentRoot method, to activate the local file service of the libnpupnp HTTP server. Also LibUPnP::port().

Make additional escaping of URLs from Content Directories optional and non-default and add interface to activate it and choose the set of characters to be escaped.

Control: fixed misc issue with event subscription callback address computations, esp. a network mask computation bug. We could end up in selecting the wrong callback address.

Control: add programming interfaces to set custom timeouts for action and subscription calls.

Fixed Media Server proxy mode. Incorrect range handling prevented it to work with kodi

Misc updates in Media Server plugins.

1.8.5 was skipped (not published).

Misc. improvements to the Tidal, Subsonic, Media Server plugins.

New Mother Earth Radio and and Radio Paradise Media Server plugins.

New Tidal plugin by Giovanni Fulco. Tidal access is working again !

Media Server: change the internal URL format to avoid characters needing quoting in XML: work around misc. device bugs.

Qobuz: add option to obtain actual item resource info when listing a container.

Allow enabling the internal WEB server to serve local files, by setting the webserverdocumentroot parameter. This can be used by, e.g., Media Server plugins for serving icons.

Subsonic/Navidrome plugin: misc. updates and improvements.

Uprcl: fix using the albumartist in priority when it is set.

Small internal changes: eliminate explicit memory allocations, improve url sanitizing, reconcile Windows and Linux versions.

Uprcl local media server:

Qobuz: restore function, lost since last week.

Fixes bug which would prevent some renderers from seeking, (vlc as a prominent example, but also explains some more obscure issues in the past).

Fix URL comparison issue which could cause false diags in checkContentFormat()

Change the default value for checkcontentformat from true to false.

Qobuz: always use https.

New radio-browser Media Server plugin for https://www.radio-browser.info/

Ensure that we exit when getting a terminating signal while waiting for mpd during init

Uprcl: report composers as <upnp:artist role="composer>

Uprcl: fix possible loop in search string parser

Media Server: implement rootalias parameter to point to arbitrary container inside the tree. This is to avoid useless navigation from the actual root for people who, e.g., only use the uprcl '[folders]' tree.

Uprcl: support multiple values for tags (e.g. multiple genres).

Uprcl: fix miscellaneous small issues.

Removed Spotify support as libspotify does not work any more.

Uprcl: small change to support dsf file id3 metadata

Cleaned up or updated some stale entries in the default radio list.

Media Server: implemented "browse meta" in most plugins for use with Kodi.

Uprcl: sort container entries by file name if there are no actual tags.

Uprcl: add uprclnotagview variable to suppress the "Tag View" entries in the folder view.

Also perform host name substitution (%h) in the UPnP/AV renderer friendly name.

Control Point: sanitize unsufficiently quoted URLs from content directory.

Main: change order of media server and renderer initialisations so that the media server does not have to wait for mpd.

Allow substituting the host name (%h,%H) and version info (%v) in the configured friendlyname. The default friendlyname is now UpMpd-%h

Allow all configuration variables to also be set through environment variables named UPMPD_xxx where xxx is the upper-cased version of the variable name. This should facilitate running upmpdcli in a container.

Change the names of the low level UPnP library log variables from UPMPDCLI_xxx to UPMPD_xxx and manage them in the same way as the rest (with config entries too).

Uprcl: process custom tags (not predefined anywhere) as regular ones.

Uprcl: use same host as upmpdcli by default. Add uprclport configuration variable to only set the port

Preserve stored playlist order

Choose folder image file rather than track-embedded art for a folder or an album.

Misc other small fixes.

Fix bug which would prevent the control point side to work with some UPnP devices. The change should be mostly source-compatible, but code using the library must be rebuilt (ABI change). Details:

change the Upnp_SID type from a fixed size char array to an std::string
This avoids the truncation of some long subscription IDs (e.g. Linn). The change should be
source-compatible for programs which used the UpnpEvent_get_SID_cstr() macro for accessing the
value, but the API and ABI change.

Follow up the libnpupnp 5.0.0 release. Mostly for clarification, 0.21.1 should work too (but would need a rebuild anyway).

Fix incompatibility with the Logitech Media Server UPnP Renderer plugin (absolute eventSubURL).

Improved logging of error conditions.

Medium version bump necessitated by change in Songcast API ABI (source-compatible).

Fix bug which could close stderr when changing the log level.

Miscellaneous mostly stylistic small changes.

Uprcl: fix music access denied by incorrect runtime group in some cases.

Uprcl: improve init error diagnostics.

Radios: speed up radio list initialisation by using multiple threads.

Radios: support apple live streaming streams by letting mpd deal with them.

Partial sanitizing of the static library object name space.

Move openhome build to python3.

Fixes deadlock in Songcast startup.

New BBC plugin for listening to BBC station programmes and podcasts.

Add UpnpSetHostValidateCallback alias to UpnpSetWebRequestHostValidateCallback for compatibility with libupnp 1.14.x

A 4.2.0 briefly existed. The shared lib .so version was wrong.

Enable L16 by default as it is handled correctly by current mpd versions.

Add the mpd version to the description version string.

Change Qobuz default format to 6.

Misc small bug fixes.

Small fix for working in a BSD jail with single interface having a 0xffffffff netmask.

Media server: add trivial plugin just serving the upmpdcli radio list. Also do this through the uprcl playlists.

Fix consistency issue with Songcast Receiver naming.

Deezer and Qobuz: add pictures for artists and playlists.

Uprcl: implement the ">> Hide Entries" Minimserver feature to fix Control Points recursive walks.

Fix vulnerability to DNS-rebind attacks.

Fix working with multiple ipv6 link-local interfaces by adding RFC 6874 zone identifiers to the URLs passed to the client code.

Add UpnpGetUrlHostPortForClient() interface to help users of the web server compute their URLs.

Small build and compat fixes: fix mingw64 build, add empty UpnpGetServerUlaGuaPort6() call, adjust how UPNP_ENABLE_IPV6 affects module existence to make it compatible with pupnp.

Improve source-level compatibility by defining UPNP_USING_CHUNKED.

Fix HEAD requests. Samsung TVs now work with Gerbera + libnpupnp

Fix rare possible issue with Kazoo volume control

Allow configuring the subscription timeout (init option)

Add interface for the lib to report a subscription autorenewal failure, and to renew all subscriptions.

Add API to set the product/version values in User-Agent and Server headers.

Send SERVER and USER-AGENT headers in misc places where mandated or useful.

Add API for the client code to set the user-agent and server string values

Fix building and running with --disable-ipv6

Misc portability fixes.

Passthrough for CDDA urls. An URL of the form:

http://upmpdprotoescape/cdda/dev/sr0/1

cdda:///dev/sr0/1

Reconnect the event loop when mpd restarts. Before the fix, events stopped being generated after mpd restarted.

Radio metadata issues fixed.

Media Server: Deezer streaming service plugin.

Fix events not working when mpd had password set.

Fix a number of memory leak and locking issues detected by valgrind/helgrind.

Improve performance of big playlist insert by rate-limiting events.

Fix possible crash when started while mpd is not running.

Fix timeout issue while in long pause (>60S, play transition started from other client was not detected)

Fix ohinfo issue resulting in no cover art display in Kazoo "currently playing" screen.

Fix a number of issues in radio metadata.

The minimum effective volume adjustment was 5. Reset it to 1.

Cache update issues in OH playlist resulted in incomplete metadata.

Content Directory interface: accept responses with 0 TotalMatches.

Fix issue with removing tracks from the playlist (sometimes slow or freezed).

Fix bad locking causing multiple execs of radio scripts.

Setting lumincompat = 1 is not useful any more and crashes some Kazoo versions. So you should keep the default value which is off.

Improve metadata processing when playing radios with Bubble DS.

Adjust excessively noisy messages.

Modified a few things which should not have mattered but which prevented Lumin to work with upmpdcli.

The Qobuz plugin works again (for now), by identifying itself as the WEB client (thanks to qobuz-dl on github). More precisely, Qobuz access through the upmpdcli Media Server works again. Qobuz access by login from Kazoo or Lumin (Open Home Credentials service) does not work.

Tidal does not work.

Fixed crash.

Will now generate events for bitrate changes when playing.

Fix small issue resulting in missing metadata in ohinfo

Separate the OpenHome and UPnP/AV UPnP devices. The latter will now show up as <friendlyname>-UPnP/AV. Set upnpav=0 in the configuration if it bothers you. This makes upmpdcli more standard, having separate devices for the different sets of services instead of hosting them all under the same device.

Use the new libupnpp event management method by using the MPD idle interface for generating events. Will both provide more timely generation of events and no process activity whatsoever when not playing.

Add configuration options for L16 support and IPV6 operation. These are now off by default as they less useful than they are sources of trouble. Especially, the UPnP/AV upmpdcli device now works well with Windows "Cast to device" feature.

Removed the gmusic plugin from the documentation and distribution. The Tidal and Qobuz modules are still around, but untested.

Allow alternate method of event generation by letting the device code run its event loop instead of polling the services for changes.

Add new initialization method allowing easier extensibility of options.

Fix parsing of UPnP description with multiple embedded devices.

Small changes to improve performance and memory usage. Avoid std::regex use.

Do not force the network to be above the application default of 49152. There was no reason to do this, the bug was inherited from libupnp.

Fix major performance degradation in XML quoting, which could for example make reading big playlists very slow.

By default, run with IPV4 only if IPV6 is unavailable (the previous default was to fail if IPV4-only operation was not specified by setting an ip address in the configuration.

Install the include files in /usr/include/npupnp instead of /usr/include/npupnp/upnp

Fix the microhttpd version fix: the change came with 0.9.71, not 0.9.70.

Fix building with newer microhttpd version (MHD_Result issue).

Misc small fixes for marginal cases.

Source cleanup

Be more tolerant of incorrect UTF-8 data

Improved reporting of UPnP errors

Improved message log initialisation: now static so can be done before actually accessing the library object.

Use the NetIF interface from libnpupnp instead of duplicating the module.

Improved processing of device errors, better error data returned.

Optional (configure time) code to fix bad utf-8 in data returned from some Media Servers (e.g. Minidlna).

Fix/improve the network interface selection code.

Export the NetIF API to avoid duplication in libupnpp.

API Documentation.

libnpupnp: fix vulnerability to CVE-2020-12695 (CallStranger).

libnpupnp: using the same version of netif.cpp as libnpupnp should allow static builds.

Initial implementation of a HighResAudio media server module.

Improve cover art management in places.

Fix bug where media server plugin failure could terminate parent.

Short-lived 1.4.11 had a bug in the Tidal plugin

Fix bug which sometimes crashed upplay (Control Point side) when staring up.

Fix initialization not working when an interface had several IP addresses (device side).

Support running on multiple network interfaces.

Fix issue where libnpupnp would stop responding to searches from control points, becoming invisible until restarted.

There were 4.01/0.19.0 versions briefly released and replaced because of issues

Support the oauth connection method in upmpdcli-gmusic.

Small bug fix in the upmpdcli-tidal module

Allow adjusting the receiver audio delay in the configuration (see the manual). Allows better synchronisation, especially with non-sc2mpd receivers.

Allow adjusting the stream volume according to the mpd current setting (allows adjusting from control point connected to upmpdcli). Set 'scusempdvolume' to true in the config to activate.

Improve interface to ease experimental port of Gerbera.

Make reuseaddr and ipv6 support configure defaults.

Fix GENA-related crash

Fix 1.4.6 issues with Kazoo.

Fix different issues in network configuration code, including an outright crash.

Multiple small fixes, some in the radio scripts, most regarding the build system.

Avoid mpd remaining in 'single' mode after switching back from the Radio Source.

Remove the libupnp dependency from the packages. We only depend on libupnpp (which in turns depends on libnpupnp).

Switch to using libnpupnp. The slightly different API means that we are not compatible any more with libupnp, but we get rid of the libixml dependence and the libupnp history of bugs so this is a big win.

Initial release.

The 2.0.0 API is not compatible with the pupnp/libupnp API, this was necessary to get rid of libixml and the weirdness of passing DOM trees across the API.

There is a 1.0.0 version in the git history which marks the last point where libnpupnp preserves the libupnp API. Most of the other changes (switching to C++ internally, relying on expat, libcurl and libmicrohttpd) had already be done at this point.

Plug some of the memory leaks in the Spotify interface.

Extracted the Qobuz app_key/secret from the code. Get it from the configuration instead. This should make it easy for an integrator to store it securely.

API cleanup: remove upnp.h and config.h from public interfaces.

Fix crash with newer libstdc++ (buster).

Add plgmicrohttphost variable to allow setting the host used in proxy urls. This allows using localhost, which will only work with the local renderer, but allows for portable playlists.

Fix a number of small issues in the gmusic plugin.

Better updates for radio stream metadata, esp. when not using OHRadio.

Pupnp 1.8 compatibility

Restore capability to run without UPnP-AV support at all.

Fix removing tracks from the OpenHome Playlist. This was not working right when removing more than a few tracks.

Fix bug in Spotify plugin

Save the current radio settings across restarts.

Add the avtautoplay config variable to accommodate a non-conformant Control Point which does not issue a Play command after SetAVTransportURI.

Add mpdtimeoutms variable to configure MPD connections timeouts.

Use Python 3 for all scripts

gmusic: cache some data locally to improve performance.

OHCredentials: use stored authentication data if available to avoid login on CP.

Uprcl: use Waitress as WSGI server, instead of Paste.

Fix issue in Spotify access when started by root (at boot time).

Qobuz: allow longer playlists

Use the libupnpp 0.17.0 features. This makes us incompatible with 0.16.

Add the capability to run the Media Server in-process (as a separate root device). Needs a very recent libupnp.

Better support for embedded devices.

Support for multiple root devices.

Move the description document creation to the library: it is built incrementally as services are added, instead of being passed as a whole by the device. This changes the API.

Don’t delay searches after the initial one.

Work around port allocation bug in some libupnp 1.8 versions.

Add parameter to set the name of the openssl command to use. Helps with OHCredentials on jessie where the system command is too old.

Small compatibility change for helping Kazoo use our radio list. Better Kazoo compatibility (when switching between radio and playlist) still to come (not merged).

Compatibility with libupnp branch 1.8

Allow setting the name of the openssl command used to encrypt the credentials.

Fix issues in the Credentials service which prevented Tidal and Qobuz logins to work with BubbleUPnP.

Fix bug in the spotify plugin: would not work if upmpdcli was initially started by root (before switching to the upmpdcli user), which is the default for the packages.

Fix bug in the spotify plugin: would not work if plgproxymethod was set to redirect (which is the default). The plugin should ignore the value of this variable which can only be useful for the other streaming services.

Fix the radio source on systems with Python3 version older than 3.5 (e.g. Debian Jessie)

Support Spotify, through a new Media Server module. This needs a premium Spotify account. The setup is slightly more complicated than for the other services, see the upmpdcli manual

Support the OpenHome Credentials service. This allows accessing Qobuz and Tidal from Kazoo, using their internal service directory browser (instead of going through the upmpdcli media server). This allows managing favourites and other specific service functions. In theory, this should work with Lumin too, but it does not, and the presence of this feature prevents the renderer from being detected by Lumin at all, so that a 'lumincompat' was added to the configuration to allow using upmpdcli with Lumin (with the Credentials support disabled).

Support Radio Paradise FLAC channel. This is special for a radio because it uses a sequence of audio URLs instead of a single stream. Have a look at the distributed 'upmpdcli.conf' file for the radio definition to use (add it to your '/etc/upmpdcli.conf' which is not automatically updated during an upgrade). The appropriate script is now installed to '/usr/share/upmpdcli/radio_scripts' (along with a small number of art and metadata scripts for other stations).

Port all Python code to Python3 (while retaining Python2 compatibility). All Media Server plugins are run by Python3 by default.

Improve function with Google Play Music. Esp. fix bugs in playlist handling.

Add proxy mode to the Media Server. This may improve function in case the service is a bit flaky by providing retries. The default is still to redirect mpd to the actual music stream, except for Spotify (which needs local decoding).

Improved handling of halt state.

Narrower range of sample rate adjustments to avoid extreme strangeness.

Openhome updates. Switch to Joerg Krause repository on GitHub because Linn OhSongcast does not appear to be maintained any more.

Multiple small fixes for crashes in rare circumstances.

New GUI editor for the configuration file (not built by default, use configure --enable-confgui, which in turns needs qt5 dev modules).

Add wavpack, APE to supported formats (used checkcontentformat is set).

Reset MPD single, random, and repeat modes when needed (SetAVTransportURI).

Radios: add preferScript parameter to override Icy metadata with the one fetched by the script.

Radios: support HTTPS.

Fix Tidal search and other issues in the Tidal and Qobuz modules (crashes).

Fix handling of Qobuz and Tidal playlists (recently broken).

Media Server: allow configuring the names for the plugin entries in the server root (e.g. uprcl → "Local Music")

New GUI editor for the configuration file (not built by default, use configure --enable-confgui, which in turns needs qt5 dev modules).

OpenHome Receivers: add possibility to use a state file, allowing the Receiver to reconnect to the previous Sender when starting up

uprcl plugin (Media Server for local files): multiple improvements, still alpha quality.

Better handling of transition to stop state and process exit, properly close ALSA when needed.

Update the openhome code version.

Small additions to the Songcast control interface.

Worked around possible crash when calling UpnpCloseLog()

Mac OS X build tweaks

Interfaces used by the Python binding merged into the main branch.

New interface for dumping a device description files (used from upplay).

Faster Qobuz searches (less requests to the service)

Songcast: stop the inactive sender so that it does not show up in lists.

Radio dynamic metadata scripts for radio which provide metadata from the web site, instead of icy metadata.

Properly handle radios which redirect straight from http to mms.

AVTransport: accept metadata-less streams.

Volume control fix (events carried wrong value if device range was not 0-100).

Fix crash on service object delete (callback table not cleared).

Improved reliability of discovery.

Make Receiver OpenHome source visible to allow control by Linn Kazoo

Handle "Waiting" state to allow control of Linn Songcast Receivers

Updates to the build system. Small code reorganization and fixes. No external changes.

Improved handling of Qobuz favorites.

Improved dynamic radio artwork processing.

Allow media-server only mode (no talking to mpd, incomplete), and other small changes for supporting the experimental local media server module.

Fixes the 1.2.11 Content Directory bug.

Allow dynamic retrieving of radio stream artwork.

Improved Qobuz interface.

Improves streaming services search

Fix bug in UPnP/AV mode (seeking after gapless transition would not work).

Small fixes (qobuz,tidal), added protocolinfo entries, etc.

1.2.9 fixes a bug in the format of the protocolinfo data sent to the control points.

Tidal repaired (you only need the tidal Python code, the rest of upmpdcli is unchanged).

Misc bug fixes.

Split the Debian / Ubuntu packages to separate the main package from the different streaming services ones.

Implement gateway to Google Play Music, Qobuz and Tidal by exporting a Media Server UPnP device.

The code now uses c11 features, and the default build uses -std=c11, meaning that the minimum usable gcc version is 4.7.

Implement support for embedded devices in libupnpp

Support audio/L16 format (only works with patched mpd 0.19.16jfd1 until mpd gets to 0.20).

Make Volume/Mute events conform to standard (JRiver did not like our non-standard events).

Allow defining radio station in an out-of-install file.

Add content format compatibility checking. Can be disabled by setting checkcontentformat to 0.

Other small fixes.

Fix cover art display, which sometimes vanished.

Allow changing the xml data directory in the run time config.

Fix execution of onvolumechange (command could not have args).

Fixed the mpd play method for the Songcast Receiver, it was broken in 1.1.1. Even if the direct alsa is preferred, it can be useful in case of alsa trouble.

Compatibility with Linn Kazoo (also needs libupnp-1.6.19.jfd3).

Improve management of play and volume state when switching between sources

Allow volume control to be performed by an external script

Implement an OpenHome Radio source for playing Internet radio streams (needs Python).

Add capability to forward ALSA input channel (or other audio source) to Songcast (needs sc2mpd 0.14).

Fix Receiver detection from Windows Songcast

Lose the 0.x as we are reaching maturity…​

Needs libupnpp 0.14.1

Support the new sc2mpd/mpd2sc Sender/Receiver mode, allowing broadcasting the audio from the Linux host to multiple Songcast receivers (typically other upmpdcli/sc2mpd instances but should also work with other types). Previous versions needed a Windows or Mac Sender for multiroom audio.

Fix bug where we did not clear mpd "single" mode, resulting in needing to hit play after each track (in openhome playlist mode).

Fix random initial value for ohproduct standby state variable (0.13.1)

Fix eventing for ohproduct (0.13.1)

Fix the Kazoo Control Point going loopy when the upmpdcli playlist became empty.