Add "Lightweight Music Server" application + service #147408

arthurl · 2021-11-25T20:09:07Z

Follow up of #147206

Motivation for this change

It's a nice efficient music streaming server, especially suitable for resource constrained devices / servers. See https://github.com/epoupon/lms.

Things done

arthurl · 2021-11-25T20:17:11Z

As mentioned previously, the evaluation fails if settingsFormat = pkgs.formats.toml {}; was changed to settingsFormat = pkgs.formats.ini {};.

--show-trace gives:

error: while evaluating the attribute 'config.system.build.toplevel' at /etc/nixpkgs/nixos/modules/system/activation/top-level.nix:293:5:
while evaluating 'foldr' at /etc/nixpkgs/lib/lists.nix:52:20, called from /etc/nixpkgs/nixos/modules/system/activation/top-level.nix:128:12:
while evaluating 'fold'' at /etc/nixpkgs/lib/lists.nix:55:15, called from /etc/nixpkgs/lib/lists.nix:59:8:
while evaluating 'showWarnings' at /etc/nixpkgs/lib/trivial.nix:311:28, called from /etc/nixpkgs/nixos/modules/system/activation/top-level.nix:125:10:
while evaluating 'foldr' at /etc/nixpkgs/lib/lists.nix:52:20, called from /etc/nixpkgs/lib/trivial.nix:311:33:
while evaluating 'fold'' at /etc/nixpkgs/lib/lists.nix:55:15, called from /etc/nixpkgs/lib/lists.nix:59:8:
while evaluating the attribute 'warnings' at undefined position:
while evaluating 'g' at /etc/nixpkgs/lib/attrsets.nix:298:19, called from undefined position:
while evaluating anonymous function at /etc/nixpkgs/lib/modules.nix:140:72, called from /etc/nixpkgs/lib/attrsets.nix:301:20:
while evaluating the attribute 'value' at /etc/nixpkgs/lib/modules.nix:525:9:
while evaluating the option `warnings':
while evaluating the attribute 'mergedValue' at /etc/nixpkgs/lib/modules.nix:557:5:
while evaluating the attribute 'values' at /etc/nixpkgs/lib/modules.nix:551:9:
while evaluating the attribute 'values' at /etc/nixpkgs/lib/modules.nix:650:7:
while evaluating anonymous function at /etc/nixpkgs/lib/modules.nix:537:28, called from /etc/nixpkgs/lib/modules.nix:537:17:
while evaluating definitions from `/etc/nixpkgs/nixos/modules/system/boot/systemd.nix':
while evaluating 'dischargeProperties' at /etc/nixpkgs/lib/modules.nix:609:25, called from /etc/nixpkgs/lib/modules.nix:538:137:
while evaluating the attribute 'value' at /etc/nixpkgs/lib/modules.nix:392:44:
while evaluating anonymous function at /etc/nixpkgs/lib/attrsets.nix:256:10, called from undefined position:
while evaluating anonymous function at /etc/nixpkgs/nixos/modules/system/boot/systemd.nix:905:16, called from /etc/nixpkgs/lib/attrsets.nix:256:16:
while evaluating 'optional' at /etc/nixpkgs/lib/lists.nix:254:20, called from /etc/nixpkgs/nixos/modules/system/boot/systemd.nix:912:16:
while evaluating the attribute 'serviceConfig.Type' at undefined position:
while evaluating 'g' at /etc/nixpkgs/lib/attrsets.nix:298:19, called from undefined position:
while evaluating anonymous function at /etc/nixpkgs/lib/modules.nix:140:72, called from /etc/nixpkgs/lib/attrsets.nix:301:20:
while evaluating the attribute 'value' at /etc/nixpkgs/lib/modules.nix:525:9:
while evaluating the option `systemd.services.lms.serviceConfig':
while evaluating the attribute 'mergedValue' at /etc/nixpkgs/lib/modules.nix:557:5:
while evaluating 'merge' at /etc/nixpkgs/lib/types.nix:386:20, called from /etc/nixpkgs/lib/modules.nix:559:59:
while evaluating 'filterAttrs' at /etc/nixpkgs/lib/attrsets.nix:124:23, called from /etc/nixpkgs/lib/types.nix:387:35:
while evaluating anonymous function at /etc/nixpkgs/lib/attrsets.nix:125:29, called from /etc/nixpkgs/lib/attrsets.nix:125:18:
while evaluating anonymous function at /etc/nixpkgs/lib/types.nix:387:51, called from /etc/nixpkgs/lib/attrsets.nix:125:62:
while evaluating the attribute 'ExecStart' at /etc/nixpkgs/lib/attrsets.nix:366:7:
while evaluating anonymous function at /etc/nixpkgs/lib/types.nix:387:86, called from /etc/nixpkgs/lib/attrsets.nix:366:15:
while evaluating the attribute 'optionalValue' at /etc/nixpkgs/lib/modules.nix:569:5:
while evaluating the attribute 'values' at /etc/nixpkgs/lib/modules.nix:551:9:
while evaluating the attribute 'values' at /etc/nixpkgs/lib/modules.nix:650:7:
while evaluating anonymous function at /etc/nixpkgs/lib/modules.nix:537:28, called from /etc/nixpkgs/lib/modules.nix:537:17:
while evaluating definitions from `/etc/nixpkgs/nixos/modules/services/misc/lms.nix':
while evaluating 'dischargeProperties' at /etc/nixpkgs/lib/modules.nix:609:25, called from /etc/nixpkgs/lib/modules.nix:538:137:
while evaluating the attribute 'value' at /etc/nixpkgs/lib/types.nix:391:60:
while evaluating the attribute 'text' of the derivation 'lms.conf' at /etc/nixpkgs/pkgs/stdenv/generic/make-derivation.nix:201:11:
while evaluating 'toINI' at /etc/nixpkgs/lib/generators.nix:118:6, called from /etc/nixpkgs/pkgs/pkgs-lib/formats.nix:104:31:
while evaluating 'mapAttrsToStringsSep' at /etc/nixpkgs/lib/generators.nix:121:44, called from /etc/nixpkgs/lib/generators.nix:129:7:
while evaluating anonymous function at /etc/nixpkgs/lib/attrsets.nix:256:10, called from undefined position:
while evaluating 'mkSection' at /etc/nixpkgs/lib/generators.nix:124:31, called from /etc/nixpkgs/lib/attrsets.nix:256:16:
while evaluating anonymous function at /etc/nixpkgs/lib/generators.nix:88:6, called from /etc/nixpkgs/lib/generators.nix:126:14:
while evaluating 'mapAttrsToList' at /etc/nixpkgs/lib/attrsets.nix:255:23, called from /etc/nixpkgs/lib/generators.nix:88:52:
value is a boolean while a set was expected, at /etc/nixpkgs/lib/attrsets.nix:256:39

arthurl · 2021-11-25T20:19:02Z

It doesn't matter here since the config file here is just a trivial set of key value pairs, of types int / bool / string. So either of toml or ini will work just fine. I just don't see why the ini format should fail.

aanderse · 2021-11-25T20:57:11Z

It doesn't matter here since the config file here is just a trivial set of key value pairs, of types int / bool / string. So either of toml or ini will work just fine. I just don't see why the ini format should fail.

The ini format requires a top level section.

I'll try to get back to this and review it tonight!

aanderse

The module looks great! 👍 Someone else will come along and review the package shortly, I'm sure. Ping me if you don't hear anything back in the next few days.

pkgs/servers/misc/lms/default.nix

arthurl · 2021-11-27T09:49:02Z

The module looks great! 👍 Someone else will come along and review the package shortly, I'm sure. Ping me if you don't hear anything back in the next few days.

Thanks!

nixos/modules/services/misc/lms.nix

SuperSandro2000 · 2021-11-30T17:33:28Z

pkgs/servers/misc/lms/default.nix

+    # Docs not needed
+    doxygen = null;
+    # Graphics libraries not needed
+    glew = null; libharu = null; pango = null; graphicsmagick = null;
+    # LMS uses only sqlite
+    firebird = null; libmysqlclient = null; postgresql = null;
+    # Qt not used
+    qt48Full = null;


This is really hacky and ? null should be avoided as much as possible. Can we do this different?

I'm not sure what better way there is. 1) The wt derivation (in development/libraries/wt/default.nix) does not provide a nicer mechanism to remove components and 2) I'm don't think that the wt derivation should be expanded, given that wt simply does not build the optional components if it doesn't find the required dependencies, and that cutting out optional dependencies is likely only useful on a system that isn't served by a binary cache (e.g. armv7l, on which those dependencies are broken half the time). Having the caller pass in null seems like a robust and minimal way to include or drop those optional portions.

Or, are you against providing the "useMinimalWt" option at all? I'm happy to remove that and keep it in my overlays; I included it because I thought others might find it useful.

SuperSandro2000 · 2021-11-30T19:53:01Z

pkgs/servers/misc/lms/default.nix

+  patches = [
+    (writeText "hardcode-dependency-paths.patch" ''
+      diff --git a/src/libs/av/impl/Transcoder.cpp b/src/libs/av/impl/Transcoder.cpp
+      index 7efa044..16a6e4c 100644
+      --- a/src/libs/av/impl/Transcoder.cpp
+      +++ b/src/libs/av/impl/Transcoder.cpp
+      @@ -38,7 +38,7 @@ static std::filesystem::path	ffmpegPath;
+       void
+       Transcoder::init()
+       {
+      -	ffmpegPath = Service<IConfig>::get()->getPath("ffmpeg-file", "/usr/bin/ffmpeg");
+      +	ffmpegPath = Service<IConfig>::get()->getPath("ffmpeg-file", "${ffmpeg.bin}/bin/ffmpeg");
+       	if (!std::filesystem::exists(ffmpegPath))
+       		throw Exception {"File '" + ffmpegPath.string() + "' does not exist!"};
+       }
+      diff --git a/src/lms/main.cpp b/src/lms/main.cpp
+      index 98c0cec..b60e26a 100644
+      --- a/src/lms/main.cpp
+      +++ b/src/lms/main.cpp
+      @@ -53,7 +53,7 @@ generateWtConfig(std::string execPath)
+       	const std::filesystem::path wtConfigPath {Service<IConfig>::get()->getPath("working-dir") / "wt_config.xml"};
+       	const std::filesystem::path wtLogFilePath {Service<IConfig>::get()->getPath("log-file", "/var/log/lms.log")};


Please write that into a file.

Not possible, because I need a reference to the ffmpeg and wt paths (which is the whole point of the patch).

Or am I missing something..?

Just to add: the author of lms did not provide for a command line option to set those paths, so the usual solution of writing a wrapper shell script won't work here.

Might be cleaner to write the diff into a file with placeholders for the parts you need to modify and then use sed or something to fix them up at configure time. I think that's what Sandro meant.

That's possible, but seems way uglier than simply inlining the patch?

arthurl · 2021-12-02T11:12:19Z

@aanderse hi Aaron, could use some of your help here to move things along. Thanks!

aanderse

@aanderse hi Aaron, could use some of your help here to move things along. Thanks!

Certainly. Let me try my best here...

aanderse · 2021-12-02T16:31:39Z

pkgs/servers/misc/lms/default.nix

+      Written in C++, it has a low memory footprint and even comes with a
+      recommendation engine.
+    '';
+    homepage = https://github.com/epoupon/lms;


Since https://github.com/NixOS/rfcs/blob/master/rfcs/0045-deprecate-url-syntax.md these need to be quoted.

aanderse · 2021-12-02T16:32:11Z

pkgs/servers/misc/lms/default.nix

+    homepage = https://github.com/epoupon/lms;
+    downloadPage = "https://github.com/epoupon/lms";
+    maintainers = with maintainers; [ arthur ];
+    license = licenses.gpl3;


gpl3 was deprecated a little while ago: please choose gpl3Plus or gpl3Only.

aanderse · 2021-12-02T16:35:13Z

pkgs/servers/misc/lms/default.nix

+      --- a/src/libs/av/impl/Transcoder.cpp
+      +++ b/src/libs/av/impl/Transcoder.cpp
+      @@ -38,7 +38,7 @@ static std::filesystem::path	ffmpegPath;
+       void
+       Transcoder::init()
+       {
+      -	ffmpegPath = Service<IConfig>::get()->getPath("ffmpeg-file", "/usr/bin/ffmpeg");
+      +	ffmpegPath = Service<IConfig>::get()->getPath("ffmpeg-file", "${ffmpeg.bin}/bin/ffmpeg");
+       	if (!std::filesystem::exists(ffmpegPath))
+       		throw Exception {"File '" + ffmpegPath.string() + "' does not exist!"};
+       }


According to https://github.com/epoupon/lms/blob/835e705e09176797ce9f910640ac091c80b5f717/conf/lms.conf#L8 we could do this in the module instead:

services.lms.settings.ffmpeg-file = "${pkgs.ffmpeg_4.bin}/bin/ffmpeg";

Or is the issue that you want to be able to use this software without a configuration file?

aanderse · 2021-12-02T16:44:58Z

pkgs/servers/misc/lms/default.nix

+      -	const std::filesystem::path wtResourcesPath {Service<IConfig>::get()->getPath("wt-resources", "/usr/share/Wt/resources")};
+      +	const std::filesystem::path wtResourcesPath {Service<IConfig>::get()->getPath("wt-resources", "${wt-lms}/share/Wt/resources")};


Is everyone opposed to:

postPatch = '' substituteInPlace src/lms/main.cpp \ --replace "/usr/share/Wt/resources" "${wt-lms}/share/Wt/resources" \ --replace "/usr/bin/ffmpeg" "${ffmpeg_4.bin}/bin/ffmpeg" '';

?

I guess there is a bit of a worry that it might accidentally match other lines than the ones in this patch? But then again those paths would never be correct on NixOS you have a fair point there.

Then again less patching is better so if we can get away with only a config tweak I'd just leave it entirely unpatched. Seems like the config file has an entry for the wt-resources dir too.

mksafavi · 2024-04-19T03:46:16Z

I was wondering why this PR never got merged. I read the comments but didn't understand the final status.
Should I make a new PR for this as it is a couple of years old?
I've made a "minimal" working package for it.

Scrumplex · 2024-09-10T11:01:52Z

As #305308 was merged, this can be closed

arthurl added 2 commits October 20, 2019 10:56

lms: Init at v3.27.0

be6076c

nixos/lms: Init at v3.27.0

aa4477e

github-actions bot added 6.topic: nixos Issues or PRs affecting NixOS modules, or package usability issues specific to NixOS 8.has: module (update) This PR changes an existing module in `nixos/` labels Nov 25, 2021

arthurl requested a review from aanderse November 25, 2021 20:09

arthurl force-pushed the lightweight-music-server-PR branch 2 times, most recently from 01d4d83 to d60c16a Compare November 25, 2021 20:46

aanderse reviewed Nov 26, 2021

View reviewed changes

pkgs/servers/misc/lms/default.nix Outdated Show resolved Hide resolved

pkgs/servers/misc/lms/default.nix Outdated Show resolved Hide resolved

pkgs/servers/misc/lms/default.nix Outdated Show resolved Hide resolved

arthurl force-pushed the lightweight-music-server-PR branch 2 times, most recently from 2388de2 to f87515b Compare November 27, 2021 09:48

ofborg bot added 8.has: package (new) This PR adds a new package 11.by: package-maintainer This PR was created by the maintainer of the package it changes 10.rebuild-darwin: 1-10 10.rebuild-darwin: 1 10.rebuild-linux: 1-10 labels Nov 27, 2021

SuperSandro2000 reviewed Nov 30, 2021

View reviewed changes

nixos/modules/services/misc/lms.nix Outdated Show resolved Hide resolved

arthurl force-pushed the lightweight-music-server-PR branch from f87515b to aa4477e Compare November 30, 2021 19:39

SuperSandro2000 reviewed Nov 30, 2021

View reviewed changes

arthurl force-pushed the lightweight-music-server-PR branch 2 times, most recently from 2ad8660 to aa4477e Compare November 30, 2021 20:57

aanderse reviewed Dec 2, 2021

View reviewed changes

stale bot added the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Jun 19, 2022

wegank added the 2.status: merge conflict This PR has merge conflicts with the target branch label Mar 20, 2024

stale bot removed the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Mar 20, 2024

mksafavi mentioned this pull request Apr 19, 2024

lms: init at 3.51.1 #305308

Merged

13 tasks

wegank added the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Jul 4, 2024

Scrumplex closed this Sep 10, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add "Lightweight Music Server" application + service #147408

Add "Lightweight Music Server" application + service #147408

arthurl commented Nov 25, 2021 •

edited

Loading

arthurl commented Nov 25, 2021

arthurl commented Nov 25, 2021

aanderse commented Nov 25, 2021

aanderse left a comment

arthurl commented Nov 27, 2021

SuperSandro2000 Nov 30, 2021

arthurl Nov 30, 2021 •

edited

Loading

SuperSandro2000 Nov 30, 2021

arthurl Nov 30, 2021

arthurl Nov 30, 2021

jansol Nov 30, 2021

arthurl Dec 2, 2021

arthurl commented Dec 2, 2021

aanderse left a comment

aanderse Dec 2, 2021

aanderse Dec 2, 2021

aanderse Dec 2, 2021

aanderse Dec 2, 2021

jansol Dec 2, 2021

mksafavi commented Apr 19, 2024

Scrumplex commented Sep 10, 2024

		- const std::filesystem::path wtResourcesPath {Service<IConfig>::get()->getPath("wt-resources", "/usr/share/Wt/resources")};
		+ const std::filesystem::path wtResourcesPath {Service<IConfig>::get()->getPath("wt-resources", "${wt-lms}/share/Wt/resources")};

Add "Lightweight Music Server" application + service #147408

Add "Lightweight Music Server" application + service #147408

Conversation

arthurl commented Nov 25, 2021 • edited Loading

Motivation for this change

Things done

arthurl commented Nov 25, 2021

arthurl commented Nov 25, 2021

aanderse commented Nov 25, 2021

aanderse left a comment

Choose a reason for hiding this comment

arthurl commented Nov 27, 2021

Choose a reason for hiding this comment

arthurl Nov 30, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

arthurl commented Dec 2, 2021

aanderse left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mksafavi commented Apr 19, 2024

Scrumplex commented Sep 10, 2024

arthurl commented Nov 25, 2021 •

edited

Loading

arthurl Nov 30, 2021 •

edited

Loading