Difference between revisions of "Kodi"

From ArchWiki
Jump to: navigation, search
m (Autostarting at Boot)
(Autostarting at boot)
(38 intermediate revisions by 16 users not shown)
Line 1: Line 1:
[[Category:Audio/Video (English)]]
+
[[Category:Player]]
{{i18n|Xbmc}}
+
 
+
 
XBMC (formerly "Xbox Media Center") is a free, [http://www.gnu.org/copyleft/gpl.html open source (GPL)] multimedia player that originally ran on the first-generation [[Wikipedia:Microsoft Xbox|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:  
 
XBMC (formerly "Xbox Media Center") is a free, [http://www.gnu.org/copyleft/gpl.html open source (GPL)] multimedia player that originally ran on the first-generation [[Wikipedia:Microsoft Xbox|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:  
  
Line 20: Line 18:
 
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:
 
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:
  
{{bc|$ yaourt -Syua xbmc-git}}
+
{{bc|# yaourt -Syua xbmc-git}}
  
 
{{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.}}
 
{{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.}}
  
==Starting XBMC==
+
==Configuration==
  
First install [[D-Bus]] and add it to your [[Daemons#Starting_on_Boot|DAEMONS Array]] if you have not already:
+
===Autostarting at boot===
  
{{bc|(... '''dbus''' ...)}}
+
To use XBMC on HTPC you may want to start XBMC automatically on boot. Since version 11.0-11 {{ic|xbmc}} package includes the xbmc group, user, and service file necessary to do this.
  
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}}:
+
To make XBMC start at system boot you should simply enable the service:
  
{{bc|exec ck-launch-session xbmc-standalone}}
+
{{bc|# systemctl enable xbmc}}
  
Make sure you add your user (or whatever user will run xmbc on your system) to at least groups '''audio''', '''video''', and '''storage'''.
+
===Enabling shutdown, restart, hibernate and suspend===
  
{{bc|$ for x in audio video storage; do sudo gpasswd -a $USER $x; done}}
+
Since version 12 XBMC supports power management via systemd logind daemon. To enable it you should have {{ic|polkit}} installed on your system.
  
{{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.}}
+
Add the following rule file which will allow users added to ''power'' group shutdown, restart, hibernate and suspend computer.
  
===Autostarting at Boot===
+
{{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;
 +
    }
 +
});
 +
}}
  
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:
+
===Using a Remote===
  
{{bc|## Only one of the following two lines can be uncommented!
+
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.
# Boot to console
+
'''#'''id:3:initdefault:
+
# Boot to X11
+
id:5:initdefault:}}
+
  
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:
+
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|# Example lines for starting a login manager
+
{{bc|1=<lircmap>
#x:5:respawn:/usr/bin/xdm -nodaemon
+
  <remote device="devicename">
#x:5:respawn:/usr/sbin/gdm -nodaemon
+
      <XBMC_button>LIRC_button</XBMC_button>
#x:5:respawn:/usr/bin/kdm -nodaemon
+
      ...
#x:5:respawn:/usr/bin/slim >/dev/null 2>&1}}
+
  </remote>
 +
</lircmap>}}
  
Finally, add this line (toward the end of the file, near where the lines you just commented are):
+
* '''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.
 +
 
 +
* '''XBMC_button''' is the name of the button as defined in [http://wiki.xbmc.org/index.php?title=Keymap.xml keymap.xml].
 +
 
 +
* '''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.
 +
 
 +
* 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 ====
 +
 
 +
Install lirc-utils and link the mce config:
 +
 
 +
{{bc|pacman -S lirc-utils
 +
ln -s /usr/share/lirc/remotes/mceusb/lircd.conf.mceusb /etc/lirc/lircd.conf}}
 +
 
 +
Then, make sure the remote is using the lirc protocol.
 +
 
 +
{{bc|cat /sys/class/rc/rc0/protocols # [lirc] should be selected
 +
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=
 +
KERNEL=="rc*", SUBSYSTEM=="rc", ATTR{protocols}=="*lirc*", RUN+="/bin/sh -c 'echo lirc > $sys$devpath/protocols'"}}
 +
 
 +
Next, specify the lirc device. This varies with kernel version. As of 3.6.1 {{ic|/dev/lirc0}} should work with the default driver.
 +
 
 +
{{hc|/etc/conf.d/lircd.conf|2=
 +
#
 +
# Parameters for lirc daemon
 +
#
  
{{bc|x:5:wait:login -f <YOUR_XBMC_USERNAME> </dev/tty7 &>/dev/tty7}}
+
LIRC_DEVICE="/dev/lirc0"
 +
LIRC_DRIVER="default"
 +
LIRC_EXTRAOPTS=""
 +
LIRC_CONFIGFILE=""}}
  
{{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!}}
+
The default service file for lirc ignores this conf file. So we need to create a custom one.
  
If you use systemd you can try this:
+
{{hc|/etc/systemd/system/lirc.service|2=
{{hc|/etc/systemd/system/autologin.service|<nowiki>
+
 
[Unit]
 
[Unit]
Description=Direct login to X
+
Description=Linux Infrared Remote Control
Requires=dev-tty7.device
+
yAfter=dev-tty7.device systemd-user-sessions.service
+
  
 
[Service]
 
[Service]
Restart=always
+
EnvironmentFile=/etc/conf.d/lircd.conf
ExecStart=/sbin/mingetty --autologin <username> tty7 linux
+
ExecStartPre=/usr/bin/ln -sf /run/lirc/lircd /dev/lircd
 +
ExecStart=/usr/sbin/lircd --pidfile=/run/lirc/lircd.pid --device=${LIRC_DEVICE} --driver=${LIRC_DRIVER}
 +
Type=forking
 +
PIDFile=/run/lirc/lircd.pid
  
 
[Install]
 
[Install]
WantedBy=graphical.target
+
WantedBy=multi-user.target}}
</nowiki>}}
+
  
Save your {{ic|/etc/inittab}} changes and add the following to your {{ic|.bash_profile}}:
+
Finally, enable and start the lirc service.
  
{{bc|<nowiki>[[ $(tty) = "/dev/tty7" ]] && exec startx </dev/null &>/dev/null</nowiki>}}
+
{{bc|systemctl enable lirc
 +
systemctl start lirc}}
  
You may also add a {{ic|.hushlogin}} to your home directory to further suppress login messages:
+
This should give a fully working mce remote.
  
{{bc|touch ~/.hushlogin}}
+
===Fullscreen mode stretches XBMC accross multiple displays===
  
==Configuration==
+
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]]:
  
===Using a Remote===
+
{{bc|1=SDL_VIDEO_FULLSCREEN_HEAD=0}}
  
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.
+
{{Note|Mouse corsor will be hold inside screen with XBMC.}}
  
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:
+
===Slowing down CD/DVD drive speed===
 +
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.
  
{{bc|1=<lircmap>
+
This udev-rule reduces the speed permanently:
  <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.
+
{{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"
 +
}}
  
* '''XBMC_button''' is the name of the button as defined in [http://wiki.xbmc.org/index.php?title=Keymap.xml keymap.xml].
+
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.
  
* '''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.
+
After creating the file, reload the udev rules with
 
+
{{bc|udevadm control --reload}}
* 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.
+
  
 
==Resources==
 
==Resources==
  
 
* [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]: An excellent resource with much information about Arch Linux specifically (upon which the original version of this article was largely based).

Revision as of 19:42, 25 February 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.

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.

The stable version of XBMC is available in the community repo:

# pacman -Syu xbmc

The SVN (testing) version of XBMC can be downloaded from the AUR (XBMC-git), e.g. using yaourt:

# yaourt -Syua xbmc-git
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.

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 installed on your system.

Add the following rule file which will allow users added to power group 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;
    }
});

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 $ irw), add lircd to your 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 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:

pacman -S lirc-utils
ln -s /usr/share/lirc/remotes/mceusb/lircd.conf.mceusb /etc/lirc/lircd.conf

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

cat /sys/class/rc/rc0/protocols # [lirc] should be selected
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.

/etc/udev/rules.d/99-lirc.rules
KERNEL=="rc*", SUBSYSTEM=="rc", ATTR{protocols}=="*lirc*", RUN+="/bin/sh -c 'echo lirc > $sys$devpath/protocols'"

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
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 accross multiple displays

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:

SDL_VIDEO_FULLSCREEN_HEAD=0
Note: Mouse corsor will be hold 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

Resources

  • XBMC Wiki: An excellent resource with much information about Arch Linux specifically (upon which the original version of this article was largely based).