upmpdcli.conf-dist 568 lines (474 with data), 25.8 kB
# The XML tags in the comments are used to help produce the documentation # from the sample/reference file, and not at all at run time, where # comments are just comments. Edit at will. # The command line options have higher priorities than the values in # this file. # <filetitle>Upmpdcli configuration</filetitle> # <grouptitle>Upmpdcli general parameters</grouptitle> # <var name="logfilename" type="fn"><brief>Log file # name.</brief><descr>Defaults to stderr. This can also be specified as -d # logfilename.</descr></var> #logfilename = # <var name="loglevel" type="int" values="0 5 2"><brief>Log # level.</brief><descr>Can also be specified as -l loglevel.</descr></var> #loglevel = 2 # <var name="pkgdatadir" type="dfn"><brief>XML and other constant data storage # directory.</brief><descr>Default: '$prefix/share/upmpcli' (e.g.: # '/usr/share/upmpdcli').</descr></var> #pkgdatadir=/usr/share/upmpdcli # <var name="pidfile" type="fn"><brief>Name of lock file used to store the # current process pid.</brief><descr>Only used if the process is launched # by user root. Used by the init system, and to avoid multiple # instances. The only reason to change the value is if you actually want to # have several instances running (also change cachedir in this # case).</descr></var> #pidfile = /var/run/upmpdcli.pid # <grouptitle>UPnP network parameters</grouptitle> # <var name="upnpiface" type="cstr" values="dynamic"><brief>Network interface to # use for UPnP.</brief><descr>libupnp/pupnp only supports communicating on # a single interface and will use the first found, this allows forcing the # use of another interface.</descr></var> #upnpiface = # <var name="upnpip" type="string"><brief>IP address to use for UPnP, # alternative to using an interface name.</brief></var> #upnpip = # <var name="upnpport" type="int" values="0 65635 49152"><brief>Port number # used for UPnP.</brief><descr>libupnp/pupnp defaults to using the first # free port after 49152. Note that clients do not need to know about the # value, which is automatically discovered.</descr></var> #upnpport = # <grouptitle>Media Renderer parameters</grouptitle> # <var name="friendlyname" type="string"><brief>"Friendly Name" for the # UPnP Media Renderer.</brief><descr>This will be displayed by most Control # Points to identify the Renderer. Some OpenHome Control Points may display # the 'ohproductroom' value instead.</descr></var> #friendlyname = UpMpd # <var name="upnpav" type="bool" values="1"><brief>Enable UPnP AV services # (0/1).</brief><descr>This is set by default, but it may useful to switch # it off with some OpenHome Control Points which are too easily confused by # the presence of UPnP AV services.</descr></var> #upnpav = 1 # <var name="openhome" type="bool" values="1"><brief>Enable OpenHome services # (0/1).</brief><descr>This defaults to 1, as OpenHome queuing is superior # for most usages. There should be little reason to turn it # off.</descr></var> #openhome = 1 # <var name="lumincompat" type="bool" values="1"><brief>For upmpdcli # version 1.3: enable Lumin compatibility mode (lose ohcredentials) # (0/1).</brief><descr>For some unknown reason, Lumin 1.10 can't discover # upmpdcli when the OpenHome Credentials service is enabled. Setting this # allows upmpdcli to work with Lumin, at the cost of losing the use of the # Credentials service (normally used for logging in to Qobuz or Tidal inside # Kazoo).</descr></var> #lumincompat = 0 # <var name="saveohcredentials" type="bool"><brief>Save the streaming # services login parameters to disk.</brief><descr>This allows sharing the # password with the upmpdcli media server streaming service proxy, if you # are also using it. Avoids having to enter the password in the regular # configuration file. Depending on your situation, you may see this as a # security risk. The default is true, because I don't see this as a real # issue in the general case.</descr></var> # saveohcredentials = 1 # <var name="checkcontentformat" type="bool" values="1"><brief>Check that # input format is supported.</brief><descr>Extract the protocolinfo # information from the input metadata and check it against our supported # formats. Set this option to 0 if a control point or media server sends # good audio data with bad metadata.</descr></var> #checkcontentformat = 1 # <var name="iconpath" type="fn"><brief>Path to the Renderer icon.</brief> # <descr>The image will be displayed by Control Points which support # it. The UPnP protocol has provisions for a renderer to send the URL to a # descriptive icon as part of the device description. Due to current (and # probably permanent) *upmpdcli* limitations, the image file *must* be a # 64x64 32 bits-per-pixel png file. Default: '$pkgdatadir/icon.png'. # The icon will only be read once, when upmpdcli starts # up.</descr></var> #iconpath = /usr/share/upmpdcli/icon.png # <var name="cachedir" type="dfn"><brief>Directory used to store cached # data</brief><descr>Only used for the OpenHome queue metadata for now. # The default value is ~/.cache/upmpdcli for normal users or # /var/cache/upmpdcli when upmpdcli is started as root.</descr></var> #cachedir = /var/cache/upmpdcli # <var name="presentationhtml" type="fn"><brief>Path to the presentation HTML # document</brief><descr>You can change it to replace the default # presentation page. The page will only be read once, when upmpdcli starts # up. It can't presently be used for status updates (but I guess that you # could put a redirect in there, to something more dynamic served by a real # HTTP server). Default: '$pkgdatadir/presentation.html'.</descr></var> #presentationhtml = /usr/share/upmpdcli/presentation.html # <grouptitle>MPD parameters</grouptitle> # <var name="mpdhost" type="string"><brief>Host MPD runs on.</brief> # <descr>Defaults to localhost. This can also be specified as -h # host</descr></var> #mpdhost = localhost # <var name="mpdport" type="int" values="0 65635 6600"><brief>IP port used by # MPD</brief>. <descr>Can also be specified as -p port. Defaults to the # normal MPD port, 6600</descr></var> #mpdport = 6600 # <var name="mpdpassword" type="string"><brief>MPD # password.</brief><descr>Password for connecting to MPD (only necessary # if password access is enabled in the MPD configuration # file).</descr></var> #mpdpassword = # <var name="ownqueue" type="bool" values="1"><brief>Set if we own the MPD # queue.</brief>.<descr>If this is set (on by default), we own the MPD # queue and will fearlessly clear it. Can also be specified as -q # 0|1.</descr></var> #ownqueue = 1 # <grouptitle>Audio control hooks</grouptitle> # <var name="onstart" type="fn"><brief>Command to run when playback is # about to begin.</brief><descr>Specify the full path to the program, # e.g. /usr/bin/logger.</descr></var> #onstart = # <var name="onplay" type="fn"><brief>Command to run when MPD state # switches to "PLAY". </brief><descr>Specify the full path to the program, # e.g. /usr/bin/logger.</descr></var> #onplay = # <var name="onpause" type="fn"><brief>Command to run when MPD state # switches to "PAUSE". </brief><descr>Specify the full path to the program, # e.g. /usr/bin/logger.</descr></var> #onpause = # <var name="onstop" type="fn"><brief>Command to run when MPD state switches to # "STOP".</brief><descr>Specify the full path to the program, # e.g. /usr/bin/logger.</descr></var> #onstop = # <var name="onstandby" type="fn"><brief>Command to run when the setstandby # action is called.</brief><descr>Specify the full path to the program. It # is called with one 0/1 argument to change the standby state (1 for activating # standby), and with no argument to query the state. In all cases, it should # print the standby state (0/1) to stdout before exiting.</descr></var> #onstandby = # <var name="externalvolumecontrol" type="fn"><brief>Use external command # to manage the the sound volume (0/1).</brief><descr>This is used in the # case where MPD is unable to control the volume, but some other command # can, for example if you have an external amp on which it is possible to # set and read the volume through scripts. If set, the calls to MPD to set # and read the volume will be replaced by executions of 'onvolumechange' # and 'getexternalvolume'</descr></var> #externalvolumecontrol = # <var name="getexternalvolume" type="fn"><brief>Command to run for reading # the sound volume.</brief><descr>The command should write a 0-100 numeric # value to stdout.</descr></var> #getexternalvolume = # <var name="onvolumechange" type="fn"><brief>Command to run to set the # volume.</brief><descr>Used when 'externalvolumecontrol' is set. # Specify the full path to the program, which is called with the volume as # the first argument, e.g. /some/script 85.</descr></var> #onvolumechange = # <grouptitle>OpenHome parameters</grouptitle> # <var name="ohproductroom" type="string"><brief>The name of the room where # the Product is located.</brief><descr>Set to “Main Room” by default, # displayed in place of the "friendly name" by some control points. # ProductRoom is used to group the Product with other related Products in # the same physical room (e.g. a source with a pre-amp). Products which are # physically linked must always share the same ProductRoom # name.</descr></var> #ohproductroom = Main Room # <var name="radiolist" type="fn"><brief>Path to an external file with radio # definitions.</brief><descr>Radio stations can be defined at the end of # the main file, or in an external file (or both). Using an external file # can ease distribution to multiple machines. Either way, each radio # station is defined as a section with a name beginning with 'radio', # containing a mandatory URL parameter, and optional values. The part of # the name after 'radio' will be the displayed radio name (as album title). # # - artUrl: an optional static radio icon URL. # - artScript: an optional script to retrieve an image for the current title # - metaScript: an optional script to retrieve metadata for the current # title. # - preferScript: decide if values from script should override icy metadata # # See the xref:radio-definitions[section about radio station definitions] # for details about the scripts. # # Example: # # ---- # [radio My Radio] # url = http://some.host/some/path.pls # artUrl = http://some.host/icon/path.png # artScript = /path/to/script/dynamic-art-getter # metaScript = /path/to/script/metadata-getter # preferScript = 1 # ---- # </descr></var> #radiolist = /path/to/my/radio/list # <var name="ohmanufacturername" type="string"><brief>Manufacturer # name. </brief></var> #ohmanufacturername = UpMPDCli heavy industries Co. # <var name="ohmanufacturerinfo" type="string"><brief>Manufacturer # information. </brief></var> #ohmanufacturerinfo = Such nice guys and gals # <var name="ohmanufacturerurl" type="string"><brief>URL for manufacturer # web site. </brief></var> #ohmanufacturerurl = http://www.lesbonscomptes.com/upmpdcli # <var name="ohmanufacturerimageuri" type="string"><brief>Uri for # manufacturer’s logo. </brief></var> #ohmanufacturerimageuri = # <var name="ohmodelname" type="string"><brief>Model name.</brief></var> #ohmodelname = UpMPDCli UPnP-MPD gateway # <var name="ohmodelinfo" type="string"><brief>Model information.</brief></var> #ohmodelinfo = # <var name="ohmodelurl" type="string"><brief>URL for model web # site.</brief></var> #ohmodelurl = http://www.lesbonscomptes.com/upmpdcli # <var name="ohmodelimageuri" type="string"><brief>Uri for model’s # icon. </brief></var> #ohmodelimageuri = # <var name="ohproductname" type="string"><brief>User-visible product # name. By default this is set to ModelName.</brief></var> #ohproductname = Upmpdcli # <var name="ohproductinfo" type="string"><brief>Product information. # </brief></var> #ohproductinfo = # <var name="ohproducturl" type="string"><brief>URL for product web # site. This may be the UPnP presentation page.</brief></var> #ohproducturl = # <var name="ohproductimageuri" type="string"><brief>Uri for product # image. </brief></var> #ohproductimageuri = # <var name="ohmetapersist" type="bool" values="1"><brief>Save queue # metadata to disk (0/1).</brief><descr>This allows persistence of the # metadata information across restarts, the default is 1, and there is no # reason to turn it off.</descr></var> #ohmetapersist = 1 # <var name="ohmetasleep" type="int" values="0 120 0"><brief>Mimimum # interval (Seconds) between two cache saves.</brief><descr>Increasing this # may improve playlist load speed on a slow device. The default is to start # a new save as soon as the previous one is done (if the list changed again # inbetween).</descr></var> #ohmetasleep = 0 # <grouptitle>Media Server general parameters</grouptitle> # <var name="msfriendlyname" type="string"><brief>Friendly name for the # Media Server (if enabled).</brief><descr>The default is to append # "-mediaserver" to the friendlyname value.</descr></var> #msfriendlyname = # <var name="plgmicrohttpport" type="int" values="1 65535 49149"><brief>IP # port for the tidal/qobuz/gmusic local HTTP service.</brief> <descr>The # URLs for tracks streamed from these services point to a local microhttpd # server running on this port (it uses redirection to the actual service # URL when actually streaming). The default is 49149.</descr></var> #plgmicrohttpport = 49149 # <var name="plgproxymethod" type="string" values="proxy redirect"> # <brief>Decide if we proxy (copy: fetch/serve), or redirect the streaming # services streams.</brief><descr>Using redirect is much more efficient, # but the proxy has a facility to retry when a stream is dropped by the # service, which seems to happen esp. with Qobuz.</descr></var> #plgproxymethod = redirect # <grouptitle>Tidal streaming service parameters</grouptitle> # <var name="tidaluser" type="string"><brief>Tidal user name.</brief> # <descr>Your Tidal login name.</descr></var> #tidaluser = your tidal user name # <var name="tidalpass" type="string"><brief>Tidal password.</brief> # <descr>The password for your Tidal account.</descr></var> #tidalpass = your Tidal password # <var name="tidalquality" type="cstr" values="low high lossless"> # <brief>Tidal stream quality.</brief> <descr>'low' and 'high' are aac # streams. 'lossless' is FLAC and will only work if your subscription # allows it.</descr></var> #tidalquality = low/high/lossless # <grouptitle>Qobuz streaming service parameters</grouptitle> # <var name="qobuzuser" type="string"><brief>Qobuz user name.</brief> # <descr>Your Qobuz login name.</descr></var> #qobuzuser = me@some.place # <var name="qobuzpass" type="string"><brief>Qobuz password.</brief> # <descr>The password for your Qobuz account.</descr></var> #qobuzpass = agoodpassword # <var name="qobuzformatid" type="cstr" values="5 7"> # <brief>Qobuz stream quality.</brief> <descr>5 for mp3/320, 7 for FLAC if # your subscription allows it.</descr></var> #qobuzformatid = 5 # <grouptitle>Google Music streaming service parameters</grouptitle> # <var name="gmusicuser" type="string"><brief>Google Music user name.</brief> # <descr>Your Google Music login name (probably a gmail address).</descr></var> #gmusicuser = me@gmail.com # <var name="gmusicpass" type="string"><brief>Google Music password.</brief> # <descr>The password for your Google Music account.</descr></var> #gmusicpass = agoodpassword # <var name="gmusicquality" type="cstr" values="hi med low"> # <brief>Google Music stream quality.</brief> <descr>'hi' for mp3/320, 'med' # for mp3/160, 'low' for mp3/128.</descr></var> #gmusicquality = med # <var name="gmusicdeviceid" type="string"> <brief>Google Music device # id.</brief> <descr>Your system MAC address will be used by default, but # it seems that this does not work any more and that an Android deviceid is # needed. upmpdcli will try to get one from the list of registered # devices. If this does not work, you will need to set the gmusicdeviceid # value to the device ID from a phone or tablet on which you also use # Google Play Music (look up "Android deviceid" for help).</descr></var> #gmusicdeviceid = # <grouptitle>Spotify streaming service parameters</grouptitle> # <var name="spotifyuser" type="string"><brief>Spotify user name.</brief> # <descr>Your Spotify login name.</descr></var> #spotifyuser = me@some.place # <var name="spotifypass" type="string"><brief>Spotify password.</brief> # <descr>The password for your Spotify account.</descr></var> #spotifypass = agoodpassword # <grouptitle>Local Media Server parameters</grouptitle> # <var name="uprcluser" type="string"><brief>Bogus user name variable.</brief> # <descr>Used for consistency with other Media Server plugins to decide if # the service should be started (so, do set it if you want a Media Server). # </descr></var> #uprcluser = bugsbunny # <var name="uprclmediadirs" type="string"> <brief>Media # directories</brief><descr>This is a space-separated list of directories # to explore for music files. This is used directly as the recoll "topdirs" # value, so you can use double-quote quoting for paths with embedded # spaces.</descr></var> #uprclmediadirs = /tmp # <var name="uprcltitle" type="string"> <brief>Plugin Title.</brief><descr>This # will be displayed as the plugin entry in the Media Server root # directory.</descr></var> #uprcltitle = Local Music # <var name="uprclhostport" type="string"><brief>HTTP host and port for # serving media files</brief><descr>The Media Server HTTP server will run # on this address and port, which will also be inserted on the URLs we # produce. If the variable is not set, we will use port 9090 and the first # non-loopback ipv4 address in "ip addr" output, which may be right or # not. Example: 192.168.1.1:9090</descr></var> #uprclhostport = # <var name="uprclpaths" type="string"><brief>Path translations.</brief> # <descr>Translations from real paths to ones relative to the HTTP server # doc tree. If this is not set, uprcl will use a null translation for each # of the uprclmediadirs entries.</descr></var> #uprclpaths = # <var name="uprclconfdir" type="dfn"><brief>Recoll index # directory</brief><descr>This is usually not defined and defaults to # /var/cache/upmpdcli/uprcl. The name is a bit misleading because there is # no real configuration data in there: it's all programmatically # generated from actual configuration found elsewhere.</descr></var> #uprclconfdir = /var/cache/upmpdcli/uprcl # <var name="uprclautostart" type="bool"><brief>Initialize uprcl as soon as # upmpdcli starts</brief><descr>This is useful because uprcl initialization # can take quite some time so it is better not to wait for the first # access. The general default is false for the autostart variables, so this # needs to be explicitely set to true.</descr></var> #uprclautostart = 1 uprclautostart = 1 # <grouptitle>Songcast Receiver parameters</grouptitle> # Parameters for the Songcast modes. These are read by either/both the # songcast and upmpdcli processes # <var name="sclogfilename" type="fn"><brief>Log file name for sc2mpd (default # stderr)</brief><descr>The value *must not* be the same as the one used # for upmpdcli (except if empty).</descr></var> #sclogfilename = # <var name="scloglevel" type="int" values="0 5 2"><brief>Log verbosity for # sc2mpd.</brief></var> #scloglevel = 3 # <var name="scplaymethod" type="cstr" values="mpd alsa"><brief>sc2mpd # play method (mpd/alsa).</brief><descr>With this set as 'alsa', sc2mpd # will send the audio directly to the sound driver, which is the only way # to really avoid skips and control the synchronization in multi-room # setups. *For 'alsa', make sure that user upmpdcli has permission to # access the audio devices !*</descr></var> #scplaymethod = mpd # <var name="schttpport" type="int" values="0 65635 8768"><brief>Port # used by sc2mpd for MPD to connect to.</brief><descr>Used only for # scplaymethod=mpd. sc2mpd only accepts connections from # localhost.</descr></var> #schttpport = 8768 # <var name="scalsadevice" type="string"><brief>Alsa device used by sc2mpd # for playing audio.</brief><descr>Only used for scplaymethod=alsa. Use # 'aplay -L' to see the possible values.</descr></var> #scalsadevice = default # <var name="sccvttype" type="cstr" values="SRC_SINC_FASTEST # SRC_SINC_BEST_QUALITY SRC_SINC_MEDIUM_QUALITY SRC_ZERO_ORDER_HOLD # SRC_LINEAR NONE"><brief>sc2mpd resampling method.</brief><descr> # Only used for scplaymethod=alsa. sc2mpd uses libsamplerate. The default # method is SRC_SINC_FASTEST and a Rasberry Pi 1 is fast enough to use it. # Possible values: SRC_SINC_BEST_QUALITY, SRC_SINC_MEDIUM_QUALITY, # SRC_SINC_FASTEST, SRC_ZERO_ORDER_HOLD, SRC_LINEAR. See the libsamplerate # documentation for descriptions. Anything above SRC_SINC_FASTEST needs a # serious CPU. BEST_QUALITY uses approx 25% cpu on a core i7 # 4770T. Obviously too much, actually might not be sustainable (it's almost # 100% of 1 cpu). MEDIUM_QUALITY is around 10% on the same machine, # FASTEST is 4-5%. Given that this is measured for the full process, probably # a couple % for the conversion in fact. NONE will turn resampling off: # minimum CPU and best quality, but guaranteed glitches from time # to time, depending on the clocks skew.</descr></var> #sccvttype = SRC_SINC_FASTEST # <var name="sc2mpd" type="string"><brief>Path to # sc2mpd.</brief><descr>Only useful if it is not in /usr/bin and the # location is not in the $PATH for the init scripts.</descr></var> #sc2mpd = # <var name="screceiverstatefile" type="string"><brief>Path to a screceiver # state file.</brief><descr>If set, the sender uri and metadata will be read # from the file when initializing the Songcast Receiver service and written to # the file when a Sender is set for the service. Useful for preserving the # sender information between restarts.</descr></var> #screceiverstatefile = # <grouptitle>Songcast Sender parameters</grouptitle> # Parameters tor the Sender/Receiver mode. Only does anything if # scplaymethod is alsa # <var name="scstreamcodec" type="string" values="PCM FLAC OPUS"> # <brief>!!Standard Songcast receivers only support PCM!! Codec to use for # the network stream.</brief> <descr>Set to empty or PCM to support # foreign receivers. Or use FLAC or OPUS for lower network # load.</descr></var> #scstreamcodec = # <var name="scsenderpath" type="fn"><brief>Path to starter script</brief> # <descr>This is normally scmakempdsender which starts the auxiliary mpd # and the sender process. Empty and searched in the PATH by # default.</descr></var> #scsenderpath = # <var name="scstreamscaled" type="bool" values="1"><brief>Scale the # Songcast stream.</brief><descr>If set, MPD software volume control will # be applied to the stream. True by default: using a Control Point to set # the volume on the upmpdcli instance which started the Sender affects the # volume for all Receivers.</descr></var> #scstreamscaled = 1 # <var name="scsendermpdport" type="int" values="0 65635 6700"> # <brief>localhost port to be used by the auxiliary mpd.</brief></var> #scsendermpdport = 6700 # <var name="scripts_dir" type="dfn"><brief>External sources script # directory.</brief><descr>Location for the scripts used to set up # additional external sources. See the Songcast Sender support # documentation page.</descr></var> #scripts_dir = /usr/share/upmpdcli/src_scripts # <var name="scscriptgracesecs" type="int"><brief>Grace period to wait for # a script process to exit before it is forcely killed.</brief> # <descr>In seconds. Default 2 S.</descr></var> #scscriptgracesecs = 2 # Initial / default List of radios borrowed from misc sources. Edit to taste # See 'radiolist' above for a description of the entries. # # The section markers are the radio names. The definitions must be at the # end of the file because a section definition extends to the EOF and would # hide any parameters found inside which is not one of the radio # attributes. See the radio definitions section in the manual for details, # esp. about the scripts which can be used to fetch cover art and metadata # about the current song. [radio Radio Paradise (lossy)] # There are many different urls and data formats for radio paradise. See # the details here: # http://www.radioparadise.com/rp_2.php#name=Listen&file=links url = http://stream-uk1.radioparadise.com/aac-128 artUrl = https://www.radioparadise.com/graphics/fb_logo.png artScript = radio-paradise-get-art.sh [radio Radio Paradise (flac)] artUrl = https://www.radioparadise.com/graphics/fb_logo.png metaScript = radio-paradise-get-flac.py [radio Naim Radio] url = http://37.130.228.60:8090/listen.pls artUrl = https://www.naimaudio.com/sites/all/themes/naim/images/naim_records_logo.png [radio Linn Radio (Variety)] url = http://opml.radiotime.com/Tune.ashx?id=s122119 artUrl = http://small.linncdn.com/website/responsive/images/logo-black-chunky.png [radio Linn Classical (Classical)] url = http://opml.radiotime.com/Tune.ashx?id=s122116 artUrl = http://small.linncdn.com/website/responsive/images/logo-black-chunky.png [radio Linn Jazz (Jazz)] url = http://opml.radiotime.com/Tune.ashx?id=s122120 artUrl = http://small.linncdn.com/website/responsive/images/logo-black-chunky.png [radio FIP (Paris)] #url = http://direct.fipradio.fr/live/fip-midfi.mp3 url = https://chai5she.cdn.dvmr.fr/fip-midfi.mp3?ID=radiofrance artUrl = https://www.fip.fr/sites/default/files/fip-quadri-filet.png metaScript = fip-meta.py 7 preferScript = 1 [radio FIP autour du rock] #url = https://direct.fipradio.fr/live/fip-webradio1.mp3?ID=radiofrance url = https://chai5she.cdn.dvmr.fr/fip-webradio1.mp3?ID=radiofrance artUrl = https://www.fip.fr/sites/default/files/fip-quadri-filet.png metaScript = fip-meta.py 64 preferScript = 1