Difference between revisions of "Kodi"

From ArchWiki
Jump to: navigation, search
m (MCE Remote with Lirc and Systemd)
m (semi-automatic style fixes, see Help:Style)
(26 intermediate revisions by 17 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].
 +
 
 +
== Installation ==
  
 
{{Note|These instructions assume you have a working X installation. If you have not done this yet, please consult [[Beginners_Guide#Graphical_User_Interface]].}}
 
{{Note|These instructions assume you have a working X installation. If you have not done this yet, please consult [[Beginners_Guide#Graphical_User_Interface]].}}
  
The stable version of XBMC is available in the community repo:
+
[[pacman|Install]] {{Pkg|xbmc}} from the [[official repositories]].
 +
If you plan to use the pvr extensions of xbmc you will need to install {{Pkg|xbmc-pvr-addons}}.
  
{{bc|# pacman -Syu xbmc}}
+
== Configuration ==
  
{{Note| You may want to install [[D-Bus]] and [[upower]] to enable Shutdown-Suspend-Hibernate out of XBMC.}}
+
=== Autostarting at boot ===
  
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 use XBMC on HTPC you may want to start XBMC automatically on boot. Since version 11.0-11 '''xbmc''' package includes the xbmc group, user, and service file necessary to do this.
  
{{bc|# yaourt -Syua xbmc-git}}
+
To make XBMC start at system boot you should simply enable the service:
  
{{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.}}
+
# systemctl enable xbmc
  
==Configuration==
+
=== Enabling shutdown, restart, hibernate and suspend ===
  
===Autostarting at Boot===
+
Since version 12 XBMC supports power management via systemd logind daemon. To enable it you should have {{Pkg|polkit}}, {{Pkg|upower}} and {{Pkg|udisks}} installed on your system.
  
To use XBMC on HTPC you may want to start XBMC automatically on boot. There are a different ways to accomplish this.
+
In case XBMC is started using the systemd service, the session might not get initialzed 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.
  
{{Note|xbmc 11.0-11 includes the xbmc group, user, and service file, so those steps can be skipped if you are using that version.}}
+
{{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;
 +
    }
 +
});
  
====Setting up a service user for XBMC====
+
polkit.addRule(function(action, subject) {
 +
    if (action.id.indexOf("org.freedesktop.udisks") == 0 && subject.isInGroup("storage")) {
 +
        return polkit.Result.YES;
 +
    }
 +
});
 +
}}
  
To add a new user named ''xbmc'' and set a login password for it:
+
=== Using a remote controller ===
  
{{bc|1= # useradd -m -U -G audio,video,storage,optical,power -s /bin/bash ''xbmc''
+
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 will be ready to create an Lircmap.xml file for it.
# passwd ''xbmc''}}
+
  
To use an existing user make sure you add your user (or whatever user will run xmbc on your system) to at least groups audio, video, and storage.
+
Using your favorite text editor, you will 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:  
{{bc|# for x in audio video storage; do sudo gpasswd -a $USER $x; done}}
+
 
+
{{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.}}
+
 
+
====Starting XBMC through systemd====
+
 
+
{{Note|These instructions assume your system uses systemd as init System. Make sure to consult [[systemd]].}}
+
 
+
If your system is setup for [[systemd]] you can also start XBMC outside any session using xinit. To install xinit:
+
 
+
{{bc|# pacman -S xorg-xinit}}
+
 
+
Now you have to create a new service file.
+
 
+
{{hc|/etc/systemd/system/xbmc.service|2=
+
[Unit]
+
Description = Starts instance of XBMC using xinit
+
After = remote-fs.target
+
 
+
[Service]
+
User = xbmc
+
Type = simple
+
ExecStart = /usr/bin/xinit /usr/bin/xbmc-standalone -- :0
+
 
+
[Install]
+
WantedBy = multi-user.target}}
+
 
+
To activate this service at boot:
+
 
+
{{bc|# systemctl enable xbmc.service}}
+
 
+
If you want to use the power functions through XBMC make sure to set up a polkit rule like described [[Xbmc#Shutdown-Suspend-Hibernate does not work|here]].
+
 
+
===Using a Remote===
+
 
+
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.
+
 
+
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:  
+
  
 
{{bc|1=<lircmap>
 
{{bc|1=<lircmap>
Line 94: Line 68:
 
* 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.
 
* 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.
  
==== MCE Remote with Lirc and Systemd ====
+
==== MCE remote with Lirc and Systemd ====
  
Install lirc-utils and link the mce config:
+
Install {{Pkg|lirc-utils}} and link the mce config:
  
{{bc|pacman -S lirc-utils
+
# ln -s /usr/share/lirc/mceusb/lircd.conf.mceusb /etc/lirc/lircd.conf
ln -s /usr/share/lirc/remotes/mceusb/lircd.conf.mceusb /etc/lirc/lircd.conf}}
+
  
Then, make sure the remote is using the lirc protocol.
+
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
  
{{bc|cat /sys/class/rc/rc0/protocols # [lirc] should be selected
+
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.
echo lirc > /sys/class/rc/rc0/protocols # manually set lirc}}
+
 
+
A udev rule can be added to make lirc the default. A write rule doesn't seem to work, so a simple RUN command can be executed instead.
+
  
 
{{hc|/etc/udev/rules.d/99-lirc.rules|2=
 
{{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'"}}
+
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#Kernel_module_change|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 {{ic|/dev/lirc0}} should work with the default driver.
 
Next, specify the lirc device. This varies with kernel version. As of 3.6.1 {{ic|/dev/lirc0}} should work with the default driver.
Line 132: Line 107:
 
EnvironmentFile=/etc/conf.d/lircd.conf
 
EnvironmentFile=/etc/conf.d/lircd.conf
 
ExecStartPre=/usr/bin/ln -sf /run/lirc/lircd /dev/lircd
 
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}
 
ExecStart=/usr/sbin/lircd --pidfile=/run/lirc/lircd.pid --device=${LIRC_DEVICE} --driver=${LIRC_DRIVER}
 
Type=forking
 
Type=forking
Line 139: Line 115:
 
WantedBy=multi-user.target}}
 
WantedBy=multi-user.target}}
  
Finally, enable and start the lirc service.
+
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 ===
 +
 
 +
If you have got a multi-monitor setup and do not want XBMC to stretch across all screens, you 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 if you want XBMC to show up on display 0 you can add the following line to your [[Bashrc]]:
 +
 
 +
SDL_VIDEO_FULLSCREEN_HEAD=0
 +
 
 +
{{Note|Mouse cursor will be held inside screen with XBMC.}}
 +
 
 +
=== Slowing down CD/DVD drive speed ===
  
{{bc|systemctl enable lirc
+
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.
systemctl start lirc}}
+
  
This should give a fully working mce remote identical to the behavior in Windows.
+
This udev-rule reduces the speed permanently:
  
===Fullscreen mode stretches XBMC accross multiple displays===
+
{{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"
 +
}}
  
If you have got a multi-monitor setup and don't want XBMC to stretch accross all screens, you 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 if you want XBMC to show up on display 0 you can add the following line to your [[Bashrc]]:
+
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.
  
{{bc|1=SDL_VIDEO_FULLSCREEN_HEAD=0}}
+
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 02:30, 22 September 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

Note: These instructions assume you have a working X installation. If you have not done this yet, please consult Beginners_Guide#Graphical_User_Interface.

Install xbmc from the official repositories. If you plan to use the pvr extensions of xbmc you will need to install xbmc-pvr-addons.

Configuration

Autostarting at boot

To use XBMC on HTPC you may want to start XBMC automatically on boot. Since version 11.0-11 xbmc package includes the xbmc group, user, and service file necessary to do this.

To make XBMC start at system boot you should simply 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 you should have polkit, upower and udisks installed on your system.

In case XBMC is started using the systemd service, the session might not get initialzed 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;
    }
});

Using a remote controller

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 $ irw), add lircd to your DAEMONS Array and you will be ready to create an Lircmap.xml file for it.

Using your favorite text editor, you will need to go in and create an XML file at ~/.xbmc/userdata/Lircmap.xml (note the capital 'L'). Lircmap.xml format is as follows:

<lircmap>
  <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 $ 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 you automatically generated your lircd.conf using # irrecord, these are the names you selected for your button then. Refer back to LIRC for more information.
  • You may want to check out the very thorough Lircmap.xml page over at the XBMC Wiki for more help and information on this subject.

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

If you have got a multi-monitor setup and do not want XBMC to stretch across all screens, you 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 if you want XBMC to show up on display 0 you can add the following line to your 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