Difference between revisions of "Kodi"

From ArchWiki
Jump to: navigation, search
(Move to Category:Player.)
(linked shared databases)
(47 intermediate revisions by 25 users not shown)
Line 8: Line 8:
 
These can all be played directly from a CD/DVD, or from the hard-drive. XBMC can also play multimedia from a computer over a local network (LAN), or play media streams directly from the Internet. For more information, see the [http://wiki.xbmc.org/index.php?title=XBMC_FAQ XBMC FAQ].
 
These can all be played directly from a CD/DVD, or from the hard-drive. XBMC can also play multimedia from a computer over a local network (LAN), or play media streams directly from the Internet. For more information, see the [http://wiki.xbmc.org/index.php?title=XBMC_FAQ XBMC FAQ].
  
==Installation==
+
As of version 12, it can also be used to play and record live TV using a tuner, a backend server and a PVR plugin; more information about this can be found on the [http://wiki.xbmc.org/?title=PVR XBMC wiki].
  
{{Note|These instructions assume you have a working X installation. If you have not done this yet, please consult [[Beginners_Guide#Graphical_User_Interface]].}}
+
== Installation ==
 +
[[pacman|Install]] {{Pkg|xbmc}} from the [[official repositories]].
 +
Optionally install {{Pkg|xbmc-pvr-addons}} if users wish to use the pvr extensions of xbmc.
  
The stable version of XBMC is available in the community repo:
+
== Configuration ==
  
{{bc|# pacman -Syu xbmc}}
+
=== Autostarting at boot ===
 +
It is desirable to start XBMC automatically on boot.  Since version 11.0-11, the '''xbmc''' package will automatically create the xbmc group, user, and provide an xbmc.service so systemd can manage xbmc without the need for a DE.
  
The SVN (testing) version of XBMC can be downloaded from the [[AUR]] ([https://aur.archlinux.org/packages.php?ID=45036 XBMC-git]), e.g. using yaourt:
+
To make XBMC start at system boot, enable the service:
  
{{bc|$ yaourt -Syua xbmc-git}}
+
# systemctl enable xbmc
  
{{Warning|This is not the recommended way of using XBMC, as svn versions are always on the bleeding edge of development and thus can break sometimes. If you want a stable media center experience, go with the stable releases.}}
+
=== Enabling shutdown, restart, hibernate and suspend ===
  
==Starting XBMC==
+
Since version 12 XBMC supports power management via systemd logind daemon. To enable it, {{Pkg|polkit}}, {{Pkg|upower}} and {{Pkg|udisks}} are required.
  
First install [[D-Bus]] and add it to your [[Daemons#Starting_on_Boot|DAEMONS Array]] if you have not already:
+
In case XBMC is started using the systemd service, the session might not get initialized properly and therefore polkit may not allow the shutdown or reboot of the system. If this happens, adding the following rule file will allow users in the ''power'' and ''storage'' group to shutdown, restart, hibernate and suspend computer.
  
{{bc|(... '''dbus''' ...)}}
+
{{hc|/etc/polkit-1/rules.d/10-xbmc.rules|2=
 +
polkit.addRule(function(action, subject) {
 +
    if(action.id.match("org.freedesktop.login1.") && subject.isInGroup("power")) {
 +
        return polkit.Result.YES;
 +
    }
 +
});
  
Next, you'll probably want to get [[ConsoleKit]] up and running, if you have not already, and add the following line to your {{ic|.xinitrc}}:
+
polkit.addRule(function(action, subject) {
 +
    if (action.id.indexOf("org.freedesktop.udisks") == 0 && subject.isInGroup("storage")) {
 +
        return polkit.Result.YES;
 +
    }
 +
});
 +
}}
  
{{bc|exec ck-launch-session xbmc-standalone}}
+
{{Note|There is an active bug report to have the package provide this file, but as of 21-Nov-2013 it has not been implemented.}}
  
Make sure you add your user (or whatever user will run xmbc on your system) to at least groups '''audio''', '''video''', and '''storage'''.
+
=== Sharing a Database Between Multiple XBMC PCs ===
 +
Provided that a box on the network is running mariadb, one can easily configure multiple xbmc boxes to share a database.  The advantage of this is that key meta are stored in one place, a show can be paused on one box and then resumed on another seamlessly, and the record of what has been watched is unified.
  
{{bc|$ for x in audio video storage; do sudo gpasswd -a $USER $x; done}}
+
Setup of this is beyond the scope of this article.  Consult [http://wiki.xbmc.org/index.php?title=HOW-TO:Share_libraries_using_MySQL/Setting_up_MySQL#tab=Arch_Linux the Setting up MySQL for Arch Linux] hosted by the XBMC project wiki.
  
{{Note|If you do not run [[Sudo]], simply run the above command as root. You may also need to swap out $USER for another username if you are not logged in as the xbmc user.}}
+
=== Using a remote controller ===
  
===Autostarting at Boot===
+
As XBMC is geared toward being a remote-controlled media center; any PC with a supported IR receiver/remote, can use remote using [[LIRC]] or using the native kernel supported modules.  To work properly with xbmc, a file will be required that maps the lirc events to xbmc keypresses.  Create an [[Wikipedia:XML|XML]] file at {{ic|~/.xbmc/userdata/Lircmap.xml}} (note the capital 'L').
  
Using the above method, xbmc should run every time you start your X server, so auto-starting at boot can be configured just like a [[Display Manager]], with one important difference. If you choose to use the {{ic|/etc/inittab}} method, you can skip loading a display manager altogether and autologin XBMC by default. To do this, change your default runlevel to 5 in {{ic|/etc/inittab}} as usual:
+
{{Note|Users running xbmc from the included service file will find the xbmc home (~) under {{ic|/var/lib/xbmc}} and should substitute this in for the shortcut above. Also make sure that if creating this file as the root user, it gets proper ownership as xbmc:xbmc when finished.}}
 +
Lircmap.xml format is as follows:  
  
{{bc|## Only one of the following two lines can be uncommented!
+
{{bc|1=<lircmap>
# Boot to console
+
  <remote device="devicename">
'''#'''id:3:initdefault:
+
      <XBMC_button>LIRC_button</XBMC_button>
# Boot to X11
+
      ...
id:5:initdefault:}}
+
  </remote>
 +
</lircmap>}}
  
Note the comment (#) in front of {{ic|id:3:initdefault:}} and not {{ic|id:5:initdefault}}. Then, comment out all the default display manager lines at the end of the file:
+
* '''Device Name''' is whatever LIRC calls the remote. This is set using the '''Name''' directive in lircd.conf and can be viewed by running {{ic|$ irw}} and pressing a few buttons on the remote. IRW will report the name of the button pressed and the name of the remote will appear on the end of the line.
  
{{bc|# Example lines for starting a login manager
+
* '''XBMC_button''' is the name of the button as defined in [http://wiki.xbmc.org/index.php?title=Keymap.xml keymap.xml].
#x:5:respawn:/usr/bin/xdm -nodaemon
+
#x:5:respawn:/usr/sbin/gdm -nodaemon
+
#x:5:respawn:/usr/bin/kdm -nodaemon
+
#x:5:respawn:/usr/bin/slim >/dev/null 2>&1}}
+
  
Finally, add this line (toward the end of the file, near where the lines you just commented are):
+
* '''LIRC_button''' is the name as defined in {{ic|lircd.conf}}. If lircd.conf was autogenerated using {{ic|# irrecord}}, these are the names selected for the buttons. Refer back to [[LIRC]] for more information.
  
{{bc|x:5:wait:login -f <YOUR_XBMC_USERNAME> </dev/tty7 &>/dev/tty7}}
+
* A very thorough [http://wiki.xbmc.org/index.php?title=Lircmap.xml Lircmap.xml] page over at the [http://wiki.xbmc.org/index.php?title=Main_Page XBMC Wiki] should be consulted for more help and information on this subject as this is out of scope of this article.
  
{{Warning|'''There is a security risk using this method.''' This bypasses login authentication and should only be used if you are sure you know what you are doing!}}
+
==== MCE remote with Lirc and Systemd ====
  
If you use systemd you can try this:
+
Install {{Pkg|lirc-utils}} and link the mce config:
{{hc|/etc/systemd/system/autologin.service|<nowiki>
+
[Unit]
+
Description=Direct login to X
+
After=systemd-user-sessions.service
+
  
[Service]
+
# ln -s /usr/share/lirc/mceusb/lircd.conf.mceusb /etc/lirc/lircd.conf
Restart=always
+
ExecStart=/sbin/mingetty --autologin <username> tty7 linux
+
  
[Install]
+
Then, make sure the remote is using the lirc protocol:
WantedBy=graphical.target
+
$ cat /sys/class/rc/rc0/protocols
</nowiki>}}
+
If not, issue:
 +
# echo lirc > /sys/class/rc/rc0/protocols
  
Also you need install mingetty package.
+
A udev rule can be added to make lirc the default. A write rule does not seem to work, so a simple RUN command can be executed instead.
  
Save your {{ic|/etc/inittab}} changes and add the following to your {{ic|.bash_profile}}:
+
{{hc|/etc/udev/rules.d/99-lirc.rules|2=
 +
KERNEL=="rc*", SUBSYSTEM=="rc", ATTR{protocols}=="*lirc*", RUN+="/bin/sh -c 'echo lirc > $sys$devpath/protocols'"}}
  
{{bc|<nowiki>[[ $(tty) = "/dev/tty7" ]] && exec startx </dev/null &>/dev/null</nowiki>}}
+
{{Note|If this does not work, follow the suggestion to use tmpfiles.d as specified in the [[LIRC#Kernel_module_change|LIRC wiki]] to set the remote to the lirc protocol at boot time.}}
  
You may also add a {{ic|.hushlogin}} to your home directory to further suppress login messages:
+
Next, specify the lirc device. This varies with kernel version. As of 3.6.1 {{ic|/dev/lirc0}} should work with the default driver.
  
{{bc|touch ~/.hushlogin}}
+
{{hc|/etc/conf.d/lircd.conf|2=
 +
#
 +
# Parameters for lirc daemon
 +
#
  
====ConsoleKit Issues with Automatic Login via /etc/inittab====
+
LIRC_DEVICE="/dev/lirc0"
 +
LIRC_DRIVER="default"
 +
LIRC_EXTRAOPTS=""
 +
LIRC_CONFIGFILE=""}}
  
[[ConsoleKit]] is known to have problems registering a session as both local and active when logging in directly via the {{ic|/etc/inittab}} method described above.  If you would like to be able to shutdown and reboot your machine directly from XBMC while logging in via {{ic|/etc/inittab}}, perform the autologin via mingetty (note: this method requires '''mingetty''' and '''upower''' to be installed).  There are two steps involved:
+
The default service file for lirc ignores this conf file. So we need to create a custom one.
* 1. Comment out the line {{ic|x:5:wait:login -f <YOUR_XBMC_USERNAME> </dev/tty7 &>/dev/tty7}} from above and, in the consoles section of {{ic|/etc/inittab}}, append the following:
+
{{bc|c7:2345:wait:/sbin/mingetty --autologin <YOUR_XBMC_USERNAME> tty7 linux}}
+
  
* 2. Then, in your XBMC user's {{ic|~/.bash_profile}}, include the following (in place of the {{ic|.bash_profile}} line indicated above) (source: [https://bbs.archlinux.org/viewtopic.php?pid=887022#p887022 Arch forums]):
+
{{hc|/etc/systemd/system/lirc.service|2=
{{bc|<nowiki>[[ $(tty) = "/dev/tty7" ]] && exec xinit ~/.xinitrc -- /usr/bin/X -nolisten tcp vt08 &>/dev/null</nowiki>}}
+
[Unit]
 +
Description=Linux Infrared Remote Control
  
==Configuration==
+
[Service]
 +
EnvironmentFile=/etc/conf.d/lircd.conf
 +
ExecStartPre=/usr/bin/ln -sf /run/lirc/lircd /dev/lircd
 +
ExecStartPre=/usr/bin/ln -sf /dev/lirc0 /dev/lirc
 +
ExecStart=/usr/sbin/lircd --pidfile=/run/lirc/lircd.pid --device=${LIRC_DEVICE} --driver=${LIRC_DRIVER}
 +
Type=forking
 +
PIDFile=/run/lirc/lircd.pid
  
===Using a Remote===
+
[Install]
 +
WantedBy=multi-user.target}}
  
As XBMC is geared toward being a remote-controlled media center, if your computer has an IR receiver, you will probably want to set up a remote using [[LIRC]]. Once you are sure your remote is working properly (tested with {{ic|$ irw}}), add '''lircd''' to your [[Daemons#Starting_on_Boot|DAEMONS Array]] and you'll be ready to create an Lircmap.xml file for it.
+
Finally, enable and start the lirc service:
  
Using your favorite text editor, you'll need to go in and create an [[Wikipedia:XML|XML]] file at {{ic|~/.xbmc/userdata/Lircmap.xml}} (note the capital 'L'). Lircmap.xml format is as follows:
+
# systemctl enable lirc
 +
# systemctl start lirc
  
{{bc|1=<lircmap>
+
This should give a fully working mce remote.
  <remote device="devicename">
+
      <XBMC_button>LIRC_button</XBMC_button>
+
      ...
+
  </remote>
+
</lircmap>}}
+
  
* '''Device Name''' is whatever LIRC calls your remote. This is set using the '''Name''' directive in lircd.conf and can be viewed by running {{ic|$ irw}} and pressing a few buttons on the remote. IRW will report the name of the button pressed and the name of the remote will appear on the end of the line.
+
=== Fullscreen mode stretches XBMC across multiple displays ===
  
* '''XBMC_button''' is the name of the button as defined in [http://wiki.xbmc.org/index.php?title=Keymap.xml keymap.xml].
+
For a multi-monitor setup, XBMC may default to stretching across all screens.  One can restrict the fullscreen mode to one display by setting the environment variable SDL_VIDEO_FULLSCREEN_HEAD to the number of the desired target display. For example, having xbmc show up on display 0, add the following line to the xbmc user's [[Bashrc]]:
 +
 
 +
SDL_VIDEO_FULLSCREEN_HEAD=0
  
* '''LIRC_button''' is the name as defined in {{ic|lircd.conf}}. If you automatically generated your lircd.conf using {{ic|# irrecord}}, these are the names you selected for your button then. Refer back to [[LIRC]] for more information.
+
{{Note|Mouse cursor will be held inside screen with XBMC.}}
  
* You may want to check out the very thorough [http://wiki.xbmc.org/index.php?title=Lircmap.xml Lircmap.xml] page over at the [http://wiki.xbmc.org/index.php?title=Main_Page XBMC Wiki] for more help and information on this subject.
+
=== Slowing down CD/DVD drive speed ===
  
===Fullscreen mode stretches XBMC accross multiple displays===
+
The {{ic|eject}} program from the {{ic|util-linux}} package does a nice job for this, but its setting is cleared as soon as the media is changed.
  
If you have got a multi-monitor setup and don't want XBMC to stretch accross all screens, you cann restrict the fullscreen mode to one display, by setting the environment variable SDL_VIDEO_FULLSCREEN_HEAD to the number of the desired target display. For example if you want XBMC to show up on display 0 you can add the following line to your [[Bashrc]]:
+
This udev-rule reduces the speed permanently:
  
{{bc|1=SDL_VIDEO_FULLSCREEN_HEAD=0}}
+
{{hc|/etc/udev/rules.d/dvd-speed.rules|2=
 +
KERNEL=="sr0", ACTION=="change", ENV{DISK_MEDIA_CHANGE}=="1", RUN+="/usr/bin/eject -x 2 /dev/sr0"
 +
}}
  
===Shutdown-Suspend-Hibernate===
+
Replace {{ic|sr0}} with the device name of your optical drive. Replace {{ic|-x 2}} with {{ic|-x 4}} if you prefer 4x-speed instead of 2x-speed.
  
If you have problems with shutdown, suspend or hibernate within XBMC make sure your user is in the ''wheel'' group and also that the upower package is installed.
+
After creating the file, reload the udev rules with
 +
# udevadm control --reload
  
==Resources==
+
== See also ==
  
* [http://wiki.xbmc.org/index.php?title=Main_Page XBMC Wiki]: An excellent resource with much information about Arch Linux specifically (upon which the original version of this article was largely based).
+
* [http://wiki.xbmc.org/index.php?title=Main_Page XBMC Wiki] - Excellent resource with much information about Arch Linux specifically

Revision as of 22:09, 21 November 2013

XBMC (formerly "Xbox Media Center") is a free, open source (GPL) multimedia player that originally ran on the first-generation XBox, (not the newer Xbox 360), and now runs on computers running Linux, Mac OS X, Windows, and iOS. XBMC can be used to play/view the most popular video, audio, and picture formats, and many more lesser-known formats, including:

  • Video - DVD-Video, VCD/SVCD, MPEG-1/2/4, DivX, XviD, Matroska
  • Audio - MP3, AAC.
  • Picture - JPG, GIF, PNG.

These can all be played directly from a CD/DVD, or from the hard-drive. XBMC can also play multimedia from a computer over a local network (LAN), or play media streams directly from the Internet. For more information, see the XBMC FAQ.

As of version 12, it can also be used to play and record live TV using a tuner, a backend server and a PVR plugin; more information about this can be found on the XBMC wiki.

Installation

Install xbmc from the official repositories. Optionally install xbmc-pvr-addons if users wish to use the pvr extensions of xbmc.

Configuration

Autostarting at boot

It is desirable to start XBMC automatically on boot. Since version 11.0-11, the xbmc package will automatically create the xbmc group, user, and provide an xbmc.service so systemd can manage xbmc without the need for a DE.

To make XBMC start at system boot, enable the service:

# systemctl enable xbmc

Enabling shutdown, restart, hibernate and suspend

Since version 12 XBMC supports power management via systemd logind daemon. To enable it, polkit, upower and udisks are required.

In case XBMC is started using the systemd service, the session might not get initialized properly and therefore polkit may not allow the shutdown or reboot of the system. If this happens, adding the following rule file will allow users in the power and storage group to shutdown, restart, hibernate and suspend computer.

/etc/polkit-1/rules.d/10-xbmc.rules
polkit.addRule(function(action, subject) {
    if(action.id.match("org.freedesktop.login1.") && subject.isInGroup("power")) {
        return polkit.Result.YES;
    }
});

polkit.addRule(function(action, subject) {
    if (action.id.indexOf("org.freedesktop.udisks") == 0 && subject.isInGroup("storage")) {
        return polkit.Result.YES;
    }
});
Note: There is an active bug report to have the package provide this file, but as of 21-Nov-2013 it has not been implemented.

Sharing a Database Between Multiple XBMC PCs

Provided that a box on the network is running mariadb, one can easily configure multiple xbmc boxes to share a database. The advantage of this is that key meta are stored in one place, a show can be paused on one box and then resumed on another seamlessly, and the record of what has been watched is unified.

Setup of this is beyond the scope of this article. Consult the Setting up MySQL for Arch Linux hosted by the XBMC project wiki.

Using a remote controller

As XBMC is geared toward being a remote-controlled media center; any PC with a supported IR receiver/remote, can use remote using LIRC or using the native kernel supported modules. To work properly with xbmc, a file will be required that maps the lirc events to xbmc keypresses. Create an XML file at ~/.xbmc/userdata/Lircmap.xml (note the capital 'L').

Note: Users running xbmc from the included service file will find the xbmc home (~) under /var/lib/xbmc and should substitute this in for the shortcut above. Also make sure that if creating this file as the root user, it gets proper ownership as xbmc:xbmc when finished.

Lircmap.xml format is as follows:

<lircmap>
  <remote device="devicename">
      <XBMC_button>LIRC_button</XBMC_button>
      ...
  </remote>
</lircmap>
  • Device Name is whatever LIRC calls the remote. This is set using the Name directive in lircd.conf and can be viewed by running $ irw and pressing a few buttons on the remote. IRW will report the name of the button pressed and the name of the remote will appear on the end of the line.
  • XBMC_button is the name of the button as defined in keymap.xml.
  • LIRC_button is the name as defined in lircd.conf. If lircd.conf was autogenerated using # irrecord, these are the names selected for the buttons. Refer back to LIRC for more information.
  • A very thorough Lircmap.xml page over at the XBMC Wiki should be consulted for more help and information on this subject as this is out of scope of this article.

MCE remote with Lirc and Systemd

Install lirc-utils and link the mce config:

# ln -s /usr/share/lirc/mceusb/lircd.conf.mceusb /etc/lirc/lircd.conf

Then, make sure the remote is using the lirc protocol:

$ cat /sys/class/rc/rc0/protocols

If not, issue:

# echo lirc > /sys/class/rc/rc0/protocols

A udev rule can be added to make lirc the default. A write rule does not seem to work, so a simple RUN command can be executed instead.

/etc/udev/rules.d/99-lirc.rules
KERNEL=="rc*", SUBSYSTEM=="rc", ATTR{protocols}=="*lirc*", RUN+="/bin/sh -c 'echo lirc > $sys$devpath/protocols'"
Note: If this does not work, follow the suggestion to use tmpfiles.d as specified in the LIRC wiki to set the remote to the lirc protocol at boot time.

Next, specify the lirc device. This varies with kernel version. As of 3.6.1 /dev/lirc0 should work with the default driver.

/etc/conf.d/lircd.conf
#
# Parameters for lirc daemon
#

LIRC_DEVICE="/dev/lirc0"
LIRC_DRIVER="default"
LIRC_EXTRAOPTS=""
LIRC_CONFIGFILE=""

The default service file for lirc ignores this conf file. So we need to create a custom one.

/etc/systemd/system/lirc.service
[Unit]
Description=Linux Infrared Remote Control

[Service]
EnvironmentFile=/etc/conf.d/lircd.conf
ExecStartPre=/usr/bin/ln -sf /run/lirc/lircd /dev/lircd
ExecStartPre=/usr/bin/ln -sf /dev/lirc0 /dev/lirc
ExecStart=/usr/sbin/lircd --pidfile=/run/lirc/lircd.pid --device=${LIRC_DEVICE} --driver=${LIRC_DRIVER}
Type=forking
PIDFile=/run/lirc/lircd.pid

[Install]
WantedBy=multi-user.target

Finally, enable and start the lirc service:

# systemctl enable lirc
# systemctl start lirc

This should give a fully working mce remote.

Fullscreen mode stretches XBMC across multiple displays

For a multi-monitor setup, XBMC may default to stretching across all screens. One can restrict the fullscreen mode to one display by setting the environment variable SDL_VIDEO_FULLSCREEN_HEAD to the number of the desired target display. For example, having xbmc show up on display 0, add the following line to the xbmc user's Bashrc:

SDL_VIDEO_FULLSCREEN_HEAD=0
Note: Mouse cursor will be held inside screen with XBMC.

Slowing down CD/DVD drive speed

The eject program from the util-linux package does a nice job for this, but its setting is cleared as soon as the media is changed.

This udev-rule reduces the speed permanently:

/etc/udev/rules.d/dvd-speed.rules
KERNEL=="sr0", ACTION=="change", ENV{DISK_MEDIA_CHANGE}=="1", RUN+="/usr/bin/eject -x 2 /dev/sr0"

Replace sr0 with the device name of your optical drive. Replace -x 2 with -x 4 if you prefer 4x-speed instead of 2x-speed.

After creating the file, reload the udev rules with

# udevadm control --reload

See also

  • XBMC Wiki - Excellent resource with much information about Arch Linux specifically