Difference between revisions of "Kodi"

From ArchWiki
Jump to: navigation, search
m (99-lirc.rules didn't work for me. Added note to follow LIRC wiki tmpfiles.d method to set the remote to the lirc protocol.)
m (reword into 3rd person)
 
(387 intermediate revisions by 73 users not shown)
Line 1: Line 1:
[[Category:Player]]
+
[[Category:Home theater]]
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:  
+
[[ja:Kodi]]
 +
[[zh-hans:Kodi]]
 +
[https://kodi.tv/ Kodi] (formerly known as XBMC) is an award-winning free and open source (GPL) software media player and entertainment hub that can be installed on Linux, OSX, Windows, iOS and Android, featuring a 10-foot user interface for use with televisions and remote controls.  These can all be played directly from a CD/DVD, or from the hard-drive. Kodi can also play multimedia from a computer over a local network (LAN), or play media streams directly from the Internet. 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 [https://kodi.wiki/view/PVR Kodi wiki].
  
* Video - DVD-Video, VCD/SVCD, MPEG-1/2/4, DivX, XviD, Matroska
+
== Installation ==
* Audio - MP3, AAC.  
+
 
* Picture - JPG, GIF, PNG.  
+
The official stable release can be [[installed]] via the {{Pkg|kodi}} package. Alternatively, recent alpha, beta, or RC builds are available from {{AUR|kodi-pre-release}}. Be sure to review/install optional dependencies listed by pacman to enable additional functionality.
 +
 
 +
All of the official addons in the {{Grp|kodi-addons}} group are disabled by default and need to be enabled in Kodi's addon menu after installation.
 +
 
 +
== Running ==
 +
 
 +
The {{Pkg|kodi}} package supplies two binaries for two different use cases:
 +
 
 +
# {{ic|/usr/bin/kodi}} is meant to be run by any user on an on-demand basis.  Use it like any other program on the system.
 +
# {{ic|/usr/bin/kodi-standalone}} is meant to be run as the only graphical application, for example on a [[wikipedia:Home_theater_PC|HTPC]]. See [[#Running standalone]] for more information.
 +
 
 +
== Running standalone ==
 +
 
 +
Using standalone mode is advantageous for several reasons:
 +
 
 +
# The default {{ic|kodi}} user is unprivileged and cannot access a shell.
 +
# When paired with a systemd unit (or equivalent, see below), this setup makes the box on which kodi is running more like an appliance.
 +
 
 +
{{Warning|Select '''only one''' of the methods listed below.}}
 +
 
 +
=== kodi-standalone service ===
 +
 
 +
The {{AUR|kodi-standalone-service}} package provides {{ic|kodi.service}} and automatically creates the unprivileged user to run Kodi in standalone mode.  Although the correct [[Xorg#Driver_installation|driver]] is an assumed dependency, no extra Xorg packages are needed.
 +
 
 +
[[Start]] {{ic|kodi.service}} and [[enable]] it to run at boot time.
 +
 
 +
{{Note|
 +
* If {{ic|kodi.service}} fails to start, see [[Xorg#Rootless Xorg]].
 +
* The home directory for the created {{ic|kodi}} user is {{ic|/var/lib/kodi/}}.
 +
}}
 +
 
 +
=== Xsession with LightDM ===
 +
 
 +
{{Note|
 +
* This assumes that a kodi user named {{ic|kodi}} is on the system and that the following file is present as described.
 +
* {{pkg|lightdm}} does not pull in an X server as a required dependency, it is optional. The X server listed as an optional dependency ({{Pkg|xorg-server-xephyr}}) does not work when run as root by {{ic|lightdm.service}} ({{Bug|52067}}, [https://bugs.launchpad.net/lightdm/+bug/852577 LightDM Bug 852577]). [[Xorg#Installation|Install xorg-server]].
 +
}}
 +
 
 +
To use LightDM with automatic login, see [[LightDM#Enabling autologin]] and [[LightDM#Enabling interactive passwordless login]]. ''Kodi'' includes {{ic|kodi.desktop}} as [[xsession]].
 +
 
 +
{{hc|/etc/lightdm/lightdm.conf|2=
 +
[Seat:seat0]
 +
pam-service=lightdm-autologin
 +
autologin-user=kodi
 +
autologin-user-timeout=0
 +
user-session=kodi
 +
}}
 +
 
 +
=== Socket activation ===
 +
 
 +
Socket activation can be used to start Kodi when the user starts a remote control app or on a connection to Kodi's html control port. Start listening by [[starting]] {{ic|kodi@''user''.socket}} (replace ''user'' with the user running Kodi to be started as).
 +
 
 +
There are no packaged {{ic|kodi@.socket}} and {{ic|kodi@.socket}} files, one must create them manually. Depending on the setup, one can optionally change the port in {{ic|kodi@.socket}}.
  
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].
+
{{hc|/etc/systemd/system/kodi@.service|<nowiki>
 +
# This fails if the user does not have an X session.
 +
[Unit]
 +
Description=Launch Kodi on main display
 +
Conflicts=kodi.socket
  
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].
+
[Service]
 +
Type=simple
 +
Environment=DISPLAY=:0.0
 +
Nice=-1
 +
ExecStart=/usr/bin/su %i /usr/bin/kodi
 +
ExecStopPost=/usr/bin/systemctl --no-block start kodi@%i.socket
  
== Installation ==
+
[Install]
 +
WantedBy=multi-user.target
 +
</nowiki>}}
  
{{Note|These instructions assume you have a working X installation. If you have not done this yet, please consult [[Beginners_Guide#Graphical_User_Interface]].}}
+
{{hc|/etc/systemd/system/kodi@.socket|
 +
<nowiki>[Unit]
 +
Conflicts=kodi@%i.service
  
[[pacman|Install]] {{Pkg|xbmc}} from the [[official repositories]].
+
[Socket]
If you plan to use the pvr extensions of xbmc you will need to install {{Pkg|xbmc-pvr-addons}}.
+
# listen for WOL packets
 +
#ListenDatagram=9
  
== Configuration ==
+
# change this to Kodi's http control port
 +
ListenStream=8082
  
=== Autostarting at boot ===
+
[Install]
 +
WantedBy=sockets.target
 +
</nowiki>}}
  
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.
+
=== Start from remote control with LIRC / irexec ===
  
To make XBMC start at system boot you should simply enable the service:
+
Kodi can be configured to start via a key press.  Users will need {{AUR|kodi-standalone-service}} and {{Pkg|lirc}}.  This can be useful on setups running 24/7 and having kodi up on demand.
  
  # systemctl enable xbmc
+
See the corresponding [[LIRC]] article and create a functional setup with a remote. Also, the package {{AUR|kodi-standalone-service}} has to be installed.
  
=== Enabling shutdown, restart, hibernate and suspend ===
+
Generate the file {{ic|/var/lib/kodi/.lircrc}} with the following content:
  
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.
+
{{hc|/var/lib/kodi/.lircrc|<nowiki>
 +
begin
 +
prog = irexec
 +
remote = devinput
 +
button = KEY_MEDIA
 +
config = pgrep kodi-standalone || /usr/bin/kodi-standalone -l /run/lirc/lircd
 +
repeat = 0
 +
end
 +
</nowiki>}}
  
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.
+
Adopt {{ic|button}} to whatever button on the remote is to start Kodi. One can use ''irw'' (see [[LIRC#Usage]]) to find out the correct values for {{ic|remote}} and {{ic|button}}.
  
{{hc|/etc/polkit-1/rules.d/10-xbmc.rules|2=
+
Create a [[Systemd#Drop-in files|drop-in]] for {{ic|kodi.service}}:
polkit.addRule(function(action, subject) {
 
    if(action.id.match("org.freedesktop.login1.") && subject.isInGroup("power")) {
 
        return polkit.Result.YES;
 
    }
 
});
 
  
polkit.addRule(function(action, subject) {
+
{{hc|/etc/systemd/system/kodi.service.d/lirc.conf|2=
    if (action.id.indexOf("org.freedesktop.udisks") == 0 && subject.isInGroup("storage")) {
+
[Service]
        return polkit.Result.YES;
+
ExecStart =
    }
+
ExecStart = /usr/bin/irexec
});
 
 
}}
 
}}
  
=== Using a remote controller ===
+
[[Start]] {{ic|kodi.service}} and [[enable]] it to run at boot time.
 +
 
 +
== Using a remote control ==
  
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.
+
As Kodi is geared toward being a remote-controlled media center via an official app, physical remote control, or USB/bluetooth keyboard/mouse.
  
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:
+
=== Using the Android or iOS app ===
  
{{bc|1=<lircmap>
+
Both Android and iOS users can use the official app (currently free of charge) to control kodi once it is correctly setup to do so.  Steps to configure both Kodi and the app are detailed on the [https://kodi.wiki/view/Official_Kodi_Remote Official Kodi Remote] page.
 +
 
 +
=== Using a physical remote control ===
 +
 
 +
Any PC with a supported IR receiver/remote, can use [[LIRC]] or even kernel supported modules to drive it.  Configuring specific remotes with lirc is covered on the [[LIRC]] article.
 +
 
 +
To work properly with Kodi, a file that maps the lirc events to Kodi keypresses is needed.  Create an [[Wikipedia:XML|XML]] file at {{ic|~/.kodi/userdata/Lircmap.xml}} (note the capital 'L').
 +
 
 +
{{Note|Users running Kodi started with {{AUR|kodi-standalone-service}} will find the {{ic|kodi}} user's home ({{ic|~}}) under {{ic|/var/lib/kodi/}} and should substitute this in for the shortcut above.  Also make sure that if creating this file as the root user, it gets proper [[File permissions and attributes#Changing ownership|ownership]] as {{ic|kodi:kodi}} when finished.}}
 +
 
 +
{{ic|Lircmap.xml}} format is as follows:
 +
 
 +
{{bc|1=
 +
<lircmap>
 
   <remote device="devicename">
 
   <remote device="devicename">
 
       <XBMC_button>LIRC_button</XBMC_button>
 
       <XBMC_button>LIRC_button</XBMC_button>
 
       ...
 
       ...
 
   </remote>
 
   </remote>
</lircmap>}}
+
</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 {{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 [https://kodi.wiki/view/Keymap keymap.xml].
 +
* '''LIRC_button''' is the name as defined in {{ic|lircd.conf}}. If {{ic|lircd.conf}} was autogenerated using {{ic|irrecord}}, these are the names selected for the buttons. Refer back to [[LIRC]] for more information.
 +
* A very thorough [https://kodi.wiki/view/LIRC LIRC] page hosted on the Kodi Wiki should be consulted for more help and information on this subject as this is out of scope of this article.
 +
 
 +
=== HDMI-CEC ===
 +
 
 +
With a supported [https://www.pulse-eight.com/p/104/usb-hdmi-cec-adapter USB-CEC adapter], Kodi can be used to automatically turn on and off the TV and other home theater equipment. Volume control from Kodi can be sent to a supported amplifier, one can manage DVD or Blu-Ray players from inside Kodi, and redirect the active source on the TV to whichever equipment needs it, all from one remote control. For more information see the [https://kodi.wiki/view/CEC official Kodi wiki page on CEC] and [http://libcec.pulse-eight.com/faq libCEC FAQ].
 +
 
 +
Install {{Pkg|libcec}}.
 +
 
 +
{{Expansion|Add reference for the need to add users to these groups.}}
 +
 
 +
When connected, the USB-CEC's {{ic|/dev}} entry (usually {{ic|/dev/ttyACM*}}) will default to being owned by the {{ic|uucp}} group, so in order to use the device the user running Kodi needs to belong to that group. The user also needs to belong to the {{ic|lock}} group, otherwise Kodi will be unable to connect to the device. See [[Users and groups#Group management]] for instructions on how to add users to groups.
 +
 
 +
* Add all users that will use Kodi to the {{ic|uucp}} and {{ic|lock}} [[groups]].
 +
* If [[#Running standalone|running kodi-standalone]], add the user {{ic|kodi}} to the {{ic|uucp}} and {{ic|lock}} [[groups]].
 +
 
 +
{{Note|Trying to use the USB-CEC without belonging to above groups may lead to problems, including Kodi crashes, so make sure the correct user belongs to both groups.}}
 +
 
 +
== Sharing media and a centralized database across multiple nodes ==
 +
 
 +
If multiple PCs on the same network are running Kodi, they can be configured to share a single media library (video and music).  The advantage of this is media and key metadata are stored in one place, and are shared/updated by all nodes on the network.  For example, users of this setup can:
 +
 
 +
* Stop watching a movie or show in one room then finish watching it in another room automatically.
 +
* Share watched and unwatched status for media on all nodes.
 +
* Simplify the setup with only a single library to maintain.
 +
 
 +
As well, the media itself can be located in one space thus allowing a lighter footprint of client systems (ie no need for large HDD space).
 +
 
 +
Several things are needed for this to work:
 +
 
 +
* Network exposed media (via protocols that Kodi can read, e.g. NFS or Samba).
 +
* A [[MySQL]] server.
 +
 
 +
{{Warning|When sharing a database, ALL clients need to be on the same major version of Kodi due to versioned requirements of the database schema. Refer to [https://kodi.wiki/view/Databases#Database_Versions this] table for a list of database versions.}}
 +
 
 +
{{Note|The following guide is only an example of one configuration and is not meant to be limiting but illustrative.  Key steps are shown but a detailed discussion is not offered.}}
 +
 
 +
These assumptions are used for the guide, substitute as needed:
 +
 
 +
* The media is located under following mount points: {{ic|/mnt/shows}} {{ic|/mnt/movies}} {{ic|/mnt/music}}.
 +
* The network addresses of all nodes are within the 192.168.0.* subnet range.
 +
* The IP address of the machine running both the NFS exports and the MySQL database is 192.168.0.105.
 +
* Each Kodi box is referred to as a node.
 +
* The Linux user running Kodi is 'kodi' on all nodes.
 +
 
 +
For additional info, refer to the [https://kodi.wiki/view/MySQL/Setting_up_MySQL#Arch_Linux official Kodi wiki].
 +
 
 +
=== NFS server export example ===
 +
 
 +
This section provides an example using exports, see [[NFS]] for install and usage.
 +
 
 +
{{Note|Users only need one box on the LAN to serve the content, therefore, do not repeat this for each node.  The following example assumes the user is running Arch Linux, but any NFS server will work, be it Linux or BSD, etc.}}
 +
 
 +
Create an empty directory in NFS root for each media directory to be shared. E.g.:
 +
 
 +
# mkdir -p /srv/nfs/{shows,movies,music}
 +
 
 +
[[NFS#Server|Bind mount]] the media directories to the empty directories in {{ic|/srv/nfs/}}.
 +
 
 +
Setup [[NFS#Server|exports]]:
 +
 
 +
{{hc|/etc/exports.d/kodi.exports|2=
 +
/srv/nfs          192.168.0.0/24(ro,fsid=0,no_subtree_check)
 +
/srv/nfs/shows    192.168.0.0/24(ro,no_subtree_check,insecure)
 +
/srv/nfs/movies  192.168.0.0/24(ro,no_subtree_check,insecure)
 +
/srv/nfs/music    192.168.0.0/24(ro,no_subtree_check,insecure)
 +
}}
 +
 
 +
=== Install and setup the MySQL server ===
 +
 
 +
See [[MariaDB]] for installation and configuration instructions.
 +
 
 +
To create a database for Kodi, use the following commands:
 +
 
 +
$ mysql -u root -p
 +
    <<enter the mysqld root password assigned in the first step>>
 +
MariaDB [(none)]> CREATE USER 'kodi' IDENTIFIED BY 'kodi';
 +
MariaDB [(none)]> GRANT ALL ON *.* TO 'kodi';
 +
MariaDB [(none)]> flush privileges;
 +
MariaDB [(none)]> \q
  
* '''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.
+
=== Setup Kodi to use the MySQL library and the NFS exports ===
  
* '''XBMC_button''' is the name of the button as defined in [http://wiki.xbmc.org/index.php?title=Keymap.xml keymap.xml].
+
Since this example makes use of NFS shares, an optional dependency of Kodi is now required to access them.  Ensure that each of the Kodi nodes has {{Pkg|libnfs}} installed.
  
* '''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.
+
==== Setup Kodi to use the common MySQL database ====
  
* 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.
+
To tell Kodi to use the common database, insure that Kodi is not running, then create the following file:
  
==== MCE remote with Lirc and Systemd ====
+
{{hc|~/.kodi/userdata/advancedsettings.xml|
 +
<advancedsettings>
 +
  <videodatabase>
 +
    <type>mysql</type>
 +
    <host>192.168.0.105</host>
 +
    <port>3306</port>
 +
    <user>kodi</user>
 +
    <pass>kodi</pass>
 +
  </videodatabase>
  
Install {{Pkg|lirc-utils}} and link the mce config:
+
  <musicdatabase>
 +
    <type>mysql</type>
 +
    <host>192.168.0.105</host>
 +
    <port>3306</port>
 +
    <user>kodi</user>
 +
    <pass>kodi</pass>
 +
  </musicdatabase>
  
# ln -s /usr/share/lirc/mceusb/lircd.conf.mceusb /etc/lirc/lircd.conf
+
  <videolibrary>
 +
    <importwatchedstate>true</importwatchedstate>
 +
    <importresumepoint>true</importresumepoint>
 +
  </videolibrary>
 +
</advancedsettings>
 +
}}
  
Then, make sure the remote is using the lirc protocol:
+
{{Tip|If using {{AUR|kodi-standalone-service}}, the default for the profile is {{ic|/var/lib/kodi/.kodi}} and be sure to chown the newly created file to the kodi user and group, i.e. {{ic|chown -R kodi:kodi /var/lib/kodi}}}}
$ 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 doesn't seem to work, so a simple RUN command can be executed instead.
+
==== Setup network shares ====
  
{{hc|/etc/udev/rules.d/99-lirc.rules|2=
+
Load Kodi and define the network shares that correspond to the exports by browsing to the following within the interface ''Video > Files > Add Videos > Browse > Network Filesystem(NFS)''.
KERNEL=="rc*", SUBSYSTEM=="rc", ATTR{protocols}=="*lirc*", RUN+="/bin/sh -c 'echo lirc > $sys$devpath/protocols'"}}
 
  
{{Note|If this doesn't work, follow the suggestion to use tmpfiles.d as specified in the [https://wiki.archlinux.org/index.php/LIRC#Kernel_module_change LIRC wiki] to set the remote to the lirc protocol at boot time.}}
+
After a few seconds, the IP address corresponding to the NFS server should appear.
  
Next, specify the lirc device. This varies with kernel version. As of 3.6.1 {{ic|/dev/lirc0}} should work with the default driver.
+
Select {{ic|/srv/nfs/shows}} from the list of share and then ''OK'' from the menu on the right.  Assign this share the category of ''TV Shows'' to setup the appropriate scraper and to populate the MySQL database with the correct metadata.
  
{{hc|/etc/conf.d/lircd.conf|2=
+
Repeat this browsing process for the "movies" and "music" and then exit Kodi once properly configured. At this point, the MySQL tables should have been created.
#
 
# Parameters for lirc daemon
 
#
 
  
LIRC_DEVICE="/dev/lirc0"
+
{{Note|Even if Kodi is running on the same box that is also running the NFS exports and MySQL server, one '''must''' setup the media using the nfs shares only.}}
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.
+
=== Cloning the configuration to other nodes on the network ===
  
{{hc|/etc/systemd/system/lirc.service|2=
+
To set up another Kodi node on the network to use this library, simply copy {{ic|~/.kodi/userdata/advancedsettings.xml}} to that box and restart Kodi.  There is NO need to copy any other files or to do any other setup steps on the new kodi node. The nfs exports, the metadata for the programming, any stop/start times, view status, etc. are all stored in the MySQL tables.
[Unit]
 
Description=Linux Infrared Remote Control
 
  
[Service]
+
{{Note|One can optionally define other media sources that are not managed by kodi database, but they will be specific to that particular node.}}
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]
+
== Tips and Tricks ==
WantedBy=multi-user.target}}
 
  
Finally, enable and start the lirc service:
+
=== Keep a log of what is watched ===
  
# systemctl enable lirc
+
Keep track of every video watched on kodi with {{AUR|kodi-logger}}.
# systemctl start lirc
 
  
This should give a fully working mce remote.
+
=== CLI tool for kodi ===
  
=== Fullscreen mode stretches XBMC across multiple displays ===
+
A powerful CLI tool for use with kodi is {{AUR|texturecache}}.  Users can accomplish many tasks from library management to querying what is currently playing.
  
If you have got a multi-monitor setup and don't 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]]:
+
=== Hardware video acceleration ===
  
SDL_VIDEO_FULLSCREEN_HEAD=0
+
Enable and configure [[Hardware video acceleration]] to speed up playback performance.
  
{{Note|Mouse cursor will be held inside screen with XBMC.}}
+
Restart Kodi and enable the hardware backend(s) in Playback under Settings.
  
=== Slowing down CD/DVD drive speed ===
+
=== Adjusting 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.
+
The ''eject'' program from the {{Pkg|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:
 
This udev-rule reduces the speed permanently:
Line 140: Line 311:
 
}}
 
}}
  
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.
+
Replace {{ic|sr0}} with the device name of the optical drive. Replace {{ic|-x 2}} with {{ic|-x 4}} if the preference is 4x-speed instead of 2x-speed.
  
 
After creating the file, reload the udev rules with
 
After creating the file, reload the udev rules with
 +
 
  # udevadm control --reload
 
  # udevadm control --reload
 +
 +
=== Use port 80 for webserver ===
 +
 +
Kodi has a webservice that allows interaction through a web-interface. By default, it uses port {{ic|8080}} as {{ic|80}} requires root privileges. Use the following to permit it to use low port numbers:
 +
 +
# setcap 'cap_net_bind_service=+ep' /usr/lib/kodi/kodi.bin
 +
 +
Restart Kodi and set port {{ic|80}} in the configuration menu (''Services > Webserver > Port'').
 +
 +
=== Using ALSA ===
 +
 +
If [[PulseAudio]] does not work properly, try using [[ALSA]] directly by starting Kodi with the {{ic|1=AE_SINK=ALSA}} [[environment variable]].  The Kodi wiki for NUC devices provides [https://kodi.wiki/view/HOW-TO:Install_Kodi_on_an_Intel_NUC#disable_PulseAudio instructions]
 +
 +
If using {{ic|kodi-standalone}}, change the {{ic|APP}} variable in {{ic|/usr/bin/kodi-standalone}} to
 +
 +
APP="${bindir}/pasuspender -- env AE_SINK=ALSA ${bindir}/${bin_name} --standalone $@"
 +
 +
=== Audio Passthrough ===
 +
 +
To allow the receiver to decode the audio by enabling passthrough. This is useful for files encoded in TrueHD or Atmos. If using PulseAudio, follow the instructions at https://kodi.wiki/view/PulseAudio to first enable passthrough in PulseAudio. Then the passthrough options will appear in Kodi. If using ALSA, the passthrough options will appear in Kodi without modifications.
 +
 +
{{Warning|PulseAudio requires the output in Kodi to be set to 2 channel. Audio encoded in formats not passed through will only be sent as stereo audio. Use ALSA to support passthrough and passing decoded surround audio signals}}
 +
 +
{{Note|PulseAudio does not support TrueHD, DTS-MA, or Atmos passthrough. Use ALSA to pass these to through the receiver.}}
 +
 +
==== Fix for delayed startup on wifi ====
 +
 +
If running with WiFi only (wired network unplugged) while [[#Sharing media and a centralized database across multiple nodes]], kodi will likely start before the wireless network is up, which will result in failure to connect to the shares and to the mysql server.  Assuming the network is managed by the default [[systemd-networkd]], this can be fixed by using two [[Systemd#Drop-in files]], one for {{ic|kodi.service}} and another for {{ic|systemd-networkd-wait-online.service}}:
 +
 +
# systemctl edit systemd-networkd-wait-online.service
 +
[Service]
 +
ExecStart=
 +
ExecStart=/usr/lib/systemd/systemd-networkd-wait-online --ignore eth0
 +
 +
# systemctl edit kodi
 +
[Unit]
 +
After=remote-fs.target network-online.target
 +
Wants=network-online.target
 +
 +
=== Run kodi in a window manager ===
 +
 +
Users running kodi in a [[Window manager]] may see a black screen at exit.  To fix this, try switching to another tty.  A possible solution is to run kodi with this script (running as the root user):
 +
 +
{{hc|kodi.sh|
 +
#!/bin/bash
 +
kodi-standalone
 +
sudo chvt 2
 +
sleep 1
 +
sudo chvt 1
 +
}}
 +
 +
To make sure that [[sudo]] does not ask for password for {{ic|chvt}} add this line to {{ic|sudoers}} file:
 +
 +
{{hc|/etc/sudoers|
 +
''UserNameHere'' ALL&#61;NOPASSWD: /usr/bin/chvt
 +
}}
 +
 +
=== USB DAC not working ===
 +
 +
Users of USB DAC/sound cards may experience distorted sound/clicks/pops or no sound at all when selecting it from Audio settings.  A possible fix:
 +
 +
Open {{ic|guisettings.xml}} (it should be under {{ic|/var/lib/kodi/.kodi/userdata/}} if using the supplied {{ic|kodi.service}}) and change
 +
 +
<processquality default="'''true'''">'''101'''</processquality>
 +
 +
to
 +
 +
<processquality default="'''false'''">'''100'''</processquality>
 +
 +
== Troubleshooting ==
 +
 +
=== Accessing Kodi logs ===
 +
 +
In case of an error the first point to start investigation can be {{ic|~/.kodi/temp/kodi.log}}.
 +
 +
=== Fullscreen mode stretches Kodi across multiple displays ===
 +
 +
For a multi-monitor setup, Kodi may default to stretching across all screens.  One can restrict the fullscreen mode to one display by setting the [[environment variable]] {{ic|SDL_VIDEO_FULLSCREEN_HEAD}} to the number of the desired target display. For example, having Kodi show up on display 0, add the following line to the Kodi user's {{ic|~/.bashrc}} configuration:
 +
 +
SDL_VIDEO_FULLSCREEN_HEAD=0
 +
 +
{{Note|Mouse cursor will be held inside screen with Kodi.}}
 +
 +
=== Video tearing on Intel HD Graphics ===
 +
 +
Users observing tearing when watching a movie try this: https://bbs.archlinux.org/viewtopic.php?id=176651
 +
 +
Try a different X11 compositor like {{Pkg|compton}} as an alternative with [[Xfce]] which reduces video tearing. There is no essential need to install the intel driver. A tutorial how to configure compton with Xfce can be found [http://duncanlock.net/blog/2013/06/07/how-to-switch-to-compton-for-beautiful-tear-free-compositing-in-xfce/ here].
 +
 +
=== Soft subtitles not displaying ===
 +
 +
The {{Pkg|ffmpeg}} package is used to extract the subtitles.
 +
 +
=== H.264 playback is using only a single core ===
 +
 +
{{Tip|By default, press {{ic|O}} during playback to show codec information and CPU usage. More information about this overlay can be found at https://kodi.wiki/view/Codecinfo.}}
 +
 +
If the hardware does not or cannot make use of acceleration, disable it and explicitly set video decoding to software.
 +
This is because [https://forum.kodi.tv/showthread.php?tid=170084&pid=1789661#pid1789661 H.264 decoding is only multithreaded when video decoding is set to software].
 +
 +
To achieve this, go to ''System Settings > Video''. Set the {{ic|settings level}} to {{ic|Advanced}} or {{ic|Expert}}. Then go to ''Acceleration'' and set {{ic|Decoding method}} to {{ic|software}}.
 +
 +
=== Kodi hangs on exit, fully occupying one CPU core, UI unresponsive ===
 +
 +
This problem can arise with third-party plugins installed, there is some issue with their termination[https://www.linuxquestions.org/questions/linux-software-2/kodi-freezes-on-exit-kodi-bin-won't-die-4175588180/],[https://www.reddit.com/r/archlinux/comments/5029oo/kodi_freezes_on_exit_kodibin_wont_die/].
 +
 +
Workaround: find proper UI description file ({{ic|DialogButtonMenu.xml}}) and tweak exit button type from internal Kodi's {{ic|Quit()}} function call to sending signal from outside system to Kodi. Here is one-liner that makes modifications to any skin from the default Kodi package:
 +
 +
# find /usr/share/kodi/addons/skin.* -name DialogButtonMenu.xml -exec sed -i 's%<onclick>Quit()</onclick>%<onclick>System.Exec ("killall --signal SIGHUP kodi.bin")</onclick>%' {} \;
  
 
== See also ==
 
== See also ==
  
* [http://wiki.xbmc.org/index.php?title=Main_Page XBMC Wiki] - Excellent resource with much information about Arch Linux specifically
+
* [https://kodi.wiki/view/Main_Page Kodi Wiki] - Excellent resource with much information about Arch Linux specifically
 +
* [[Wikipedia:Kodi (software)]]
 +
* http://superrepo.org/{{Dead link|2018|06|13}} - xbmc Plug-in library
 +
* http://www.hdpfans.com/thread-329076-1-1.html - Kodi/xbmc Chinese plug-in library installation method
 +
* https://github.com/taxigps/xbmc-addons-chinese - xbmc-addons-chinese: Addon scripts, plugins, and skins for XBMC Media Center. Special for chinese laguage.

Latest revision as of 07:26, 8 September 2018

Kodi (formerly known as XBMC) is an award-winning free and open source (GPL) software media player and entertainment hub that can be installed on Linux, OSX, Windows, iOS and Android, featuring a 10-foot user interface for use with televisions and remote controls. These can all be played directly from a CD/DVD, or from the hard-drive. Kodi can also play multimedia from a computer over a local network (LAN), or play media streams directly from the Internet. 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 Kodi wiki.

Installation

The official stable release can be installed via the kodi package. Alternatively, recent alpha, beta, or RC builds are available from kodi-pre-releaseAUR. Be sure to review/install optional dependencies listed by pacman to enable additional functionality.

All of the official addons in the kodi-addons group are disabled by default and need to be enabled in Kodi's addon menu after installation.

Running

The kodi package supplies two binaries for two different use cases:

  1. /usr/bin/kodi is meant to be run by any user on an on-demand basis. Use it like any other program on the system.
  2. /usr/bin/kodi-standalone is meant to be run as the only graphical application, for example on a HTPC. See #Running standalone for more information.

Running standalone

Using standalone mode is advantageous for several reasons:

  1. The default kodi user is unprivileged and cannot access a shell.
  2. When paired with a systemd unit (or equivalent, see below), this setup makes the box on which kodi is running more like an appliance.
Warning: Select only one of the methods listed below.

kodi-standalone service

The kodi-standalone-serviceAUR package provides kodi.service and automatically creates the unprivileged user to run Kodi in standalone mode. Although the correct driver is an assumed dependency, no extra Xorg packages are needed.

Start kodi.service and enable it to run at boot time.

Note:
  • If kodi.service fails to start, see Xorg#Rootless Xorg.
  • The home directory for the created kodi user is /var/lib/kodi/.

Xsession with LightDM

Note:
  • This assumes that a kodi user named kodi is on the system and that the following file is present as described.
  • lightdm does not pull in an X server as a required dependency, it is optional. The X server listed as an optional dependency (xorg-server-xephyr) does not work when run as root by lightdm.service (FS#52067, LightDM Bug 852577). Install xorg-server.

To use LightDM with automatic login, see LightDM#Enabling autologin and LightDM#Enabling interactive passwordless login. Kodi includes kodi.desktop as xsession.

/etc/lightdm/lightdm.conf
[Seat:seat0]
pam-service=lightdm-autologin
autologin-user=kodi
autologin-user-timeout=0
user-session=kodi

Socket activation

Socket activation can be used to start Kodi when the user starts a remote control app or on a connection to Kodi's html control port. Start listening by starting kodi@user.socket (replace user with the user running Kodi to be started as).

There are no packaged kodi@.socket and kodi@.socket files, one must create them manually. Depending on the setup, one can optionally change the port in kodi@.socket.

/etc/systemd/system/kodi@.service
# This fails if the user does not have an X session.
[Unit]
Description=Launch Kodi on main display
Conflicts=kodi.socket

[Service]
Type=simple
Environment=DISPLAY=:0.0
Nice=-1
ExecStart=/usr/bin/su %i /usr/bin/kodi
ExecStopPost=/usr/bin/systemctl --no-block start kodi@%i.socket

[Install]
WantedBy=multi-user.target
/etc/systemd/system/kodi@.socket
[Unit]
Conflicts=kodi@%i.service

[Socket]
# listen for WOL packets
#ListenDatagram=9

# change this to Kodi's http control port
ListenStream=8082

[Install]
WantedBy=sockets.target

Start from remote control with LIRC / irexec

Kodi can be configured to start via a key press. Users will need kodi-standalone-serviceAUR and lirc. This can be useful on setups running 24/7 and having kodi up on demand.

See the corresponding LIRC article and create a functional setup with a remote. Also, the package kodi-standalone-serviceAUR has to be installed.

Generate the file /var/lib/kodi/.lircrc with the following content:

/var/lib/kodi/.lircrc
begin
prog = irexec
remote = devinput
button = KEY_MEDIA
config = pgrep kodi-standalone || /usr/bin/kodi-standalone -l /run/lirc/lircd
repeat = 0
end

Adopt button to whatever button on the remote is to start Kodi. One can use irw (see LIRC#Usage) to find out the correct values for remote and button.

Create a drop-in for kodi.service:

/etc/systemd/system/kodi.service.d/lirc.conf
[Service]
ExecStart =
ExecStart = /usr/bin/irexec

Start kodi.service and enable it to run at boot time.

Using a remote control

As Kodi is geared toward being a remote-controlled media center via an official app, physical remote control, or USB/bluetooth keyboard/mouse.

Using the Android or iOS app

Both Android and iOS users can use the official app (currently free of charge) to control kodi once it is correctly setup to do so. Steps to configure both Kodi and the app are detailed on the Official Kodi Remote page.

Using a physical remote control

Any PC with a supported IR receiver/remote, can use LIRC or even kernel supported modules to drive it. Configuring specific remotes with lirc is covered on the LIRC article.

To work properly with Kodi, a file that maps the lirc events to Kodi keypresses is needed. Create an XML file at ~/.kodi/userdata/Lircmap.xml (note the capital 'L').

Note: Users running Kodi started with kodi-standalone-serviceAUR will find the kodi user's home (~) under /var/lib/kodi/ 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 kodi:kodi 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 LIRC page hosted on the Kodi Wiki should be consulted for more help and information on this subject as this is out of scope of this article.

HDMI-CEC

With a supported USB-CEC adapter, Kodi can be used to automatically turn on and off the TV and other home theater equipment. Volume control from Kodi can be sent to a supported amplifier, one can manage DVD or Blu-Ray players from inside Kodi, and redirect the active source on the TV to whichever equipment needs it, all from one remote control. For more information see the official Kodi wiki page on CEC and libCEC FAQ.

Install libcec.

Tango-view-fullscreen.pngThis article or section needs expansion.Tango-view-fullscreen.png

Reason: Add reference for the need to add users to these groups. (Discuss in Talk:Kodi#)

When connected, the USB-CEC's /dev entry (usually /dev/ttyACM*) will default to being owned by the uucp group, so in order to use the device the user running Kodi needs to belong to that group. The user also needs to belong to the lock group, otherwise Kodi will be unable to connect to the device. See Users and groups#Group management for instructions on how to add users to groups.

Note: Trying to use the USB-CEC without belonging to above groups may lead to problems, including Kodi crashes, so make sure the correct user belongs to both groups.

Sharing media and a centralized database across multiple nodes

If multiple PCs on the same network are running Kodi, they can be configured to share a single media library (video and music). The advantage of this is media and key metadata are stored in one place, and are shared/updated by all nodes on the network. For example, users of this setup can:

  • Stop watching a movie or show in one room then finish watching it in another room automatically.
  • Share watched and unwatched status for media on all nodes.
  • Simplify the setup with only a single library to maintain.

As well, the media itself can be located in one space thus allowing a lighter footprint of client systems (ie no need for large HDD space).

Several things are needed for this to work:

  • Network exposed media (via protocols that Kodi can read, e.g. NFS or Samba).
  • A MySQL server.
Warning: When sharing a database, ALL clients need to be on the same major version of Kodi due to versioned requirements of the database schema. Refer to this table for a list of database versions.
Note: The following guide is only an example of one configuration and is not meant to be limiting but illustrative. Key steps are shown but a detailed discussion is not offered.

These assumptions are used for the guide, substitute as needed:

  • The media is located under following mount points: /mnt/shows /mnt/movies /mnt/music.
  • The network addresses of all nodes are within the 192.168.0.* subnet range.
  • The IP address of the machine running both the NFS exports and the MySQL database is 192.168.0.105.
  • Each Kodi box is referred to as a node.
  • The Linux user running Kodi is 'kodi' on all nodes.

For additional info, refer to the official Kodi wiki.

NFS server export example

This section provides an example using exports, see NFS for install and usage.

Note: Users only need one box on the LAN to serve the content, therefore, do not repeat this for each node. The following example assumes the user is running Arch Linux, but any NFS server will work, be it Linux or BSD, etc.

Create an empty directory in NFS root for each media directory to be shared. E.g.:

# mkdir -p /srv/nfs/{shows,movies,music}

Bind mount the media directories to the empty directories in /srv/nfs/.

Setup exports:

/etc/exports.d/kodi.exports
/srv/nfs          192.168.0.0/24(ro,fsid=0,no_subtree_check)
/srv/nfs/shows    192.168.0.0/24(ro,no_subtree_check,insecure)
/srv/nfs/movies   192.168.0.0/24(ro,no_subtree_check,insecure)
/srv/nfs/music    192.168.0.0/24(ro,no_subtree_check,insecure)

Install and setup the MySQL server

See MariaDB for installation and configuration instructions.

To create a database for Kodi, use the following commands:

$ mysql -u root -p
   <<enter the mysqld root password assigned in the first step>>
MariaDB [(none)]> CREATE USER 'kodi' IDENTIFIED BY 'kodi';
MariaDB [(none)]> GRANT ALL ON *.* TO 'kodi';
MariaDB [(none)]> flush privileges;
MariaDB [(none)]> \q

Setup Kodi to use the MySQL library and the NFS exports

Since this example makes use of NFS shares, an optional dependency of Kodi is now required to access them. Ensure that each of the Kodi nodes has libnfs installed.

Setup Kodi to use the common MySQL database

To tell Kodi to use the common database, insure that Kodi is not running, then create the following file:

~/.kodi/userdata/advancedsettings.xml
<advancedsettings>
  <videodatabase>
    <type>mysql</type>
    <host>192.168.0.105</host>
    <port>3306</port>
    <user>kodi</user>
    <pass>kodi</pass>
  </videodatabase>

  <musicdatabase>
    <type>mysql</type>
    <host>192.168.0.105</host>
    <port>3306</port>
    <user>kodi</user>
    <pass>kodi</pass>
  </musicdatabase>

  <videolibrary>
    <importwatchedstate>true</importwatchedstate>
    <importresumepoint>true</importresumepoint>
  </videolibrary>
</advancedsettings>
Tip: If using kodi-standalone-serviceAUR, the default for the profile is /var/lib/kodi/.kodi and be sure to chown the newly created file to the kodi user and group, i.e. chown -R kodi:kodi /var/lib/kodi

Setup network shares

Load Kodi and define the network shares that correspond to the exports by browsing to the following within the interface Video > Files > Add Videos > Browse > Network Filesystem(NFS).

After a few seconds, the IP address corresponding to the NFS server should appear.

Select /srv/nfs/shows from the list of share and then OK from the menu on the right. Assign this share the category of TV Shows to setup the appropriate scraper and to populate the MySQL database with the correct metadata.

Repeat this browsing process for the "movies" and "music" and then exit Kodi once properly configured. At this point, the MySQL tables should have been created.

Note: Even if Kodi is running on the same box that is also running the NFS exports and MySQL server, one must setup the media using the nfs shares only.

Cloning the configuration to other nodes on the network

To set up another Kodi node on the network to use this library, simply copy ~/.kodi/userdata/advancedsettings.xml to that box and restart Kodi. There is NO need to copy any other files or to do any other setup steps on the new kodi node. The nfs exports, the metadata for the programming, any stop/start times, view status, etc. are all stored in the MySQL tables.

Note: One can optionally define other media sources that are not managed by kodi database, but they will be specific to that particular node.

Tips and Tricks

Keep a log of what is watched

Keep track of every video watched on kodi with kodi-loggerAUR.

CLI tool for kodi

A powerful CLI tool for use with kodi is texturecacheAUR. Users can accomplish many tasks from library management to querying what is currently playing.

Hardware video acceleration

Enable and configure Hardware video acceleration to speed up playback performance.

Restart Kodi and enable the hardware backend(s) in Playback under Settings.

Adjusting 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 the optical drive. Replace -x 2 with -x 4 if the preference is 4x-speed instead of 2x-speed.

After creating the file, reload the udev rules with

# udevadm control --reload

Use port 80 for webserver

Kodi has a webservice that allows interaction through a web-interface. By default, it uses port 8080 as 80 requires root privileges. Use the following to permit it to use low port numbers:

# setcap 'cap_net_bind_service=+ep' /usr/lib/kodi/kodi.bin

Restart Kodi and set port 80 in the configuration menu (Services > Webserver > Port).

Using ALSA

If PulseAudio does not work properly, try using ALSA directly by starting Kodi with the AE_SINK=ALSA environment variable. The Kodi wiki for NUC devices provides instructions

If using kodi-standalone, change the APP variable in /usr/bin/kodi-standalone to

APP="${bindir}/pasuspender -- env AE_SINK=ALSA ${bindir}/${bin_name} --standalone $@"

Audio Passthrough

To allow the receiver to decode the audio by enabling passthrough. This is useful for files encoded in TrueHD or Atmos. If using PulseAudio, follow the instructions at https://kodi.wiki/view/PulseAudio to first enable passthrough in PulseAudio. Then the passthrough options will appear in Kodi. If using ALSA, the passthrough options will appear in Kodi without modifications.

Warning: PulseAudio requires the output in Kodi to be set to 2 channel. Audio encoded in formats not passed through will only be sent as stereo audio. Use ALSA to support passthrough and passing decoded surround audio signals
Note: PulseAudio does not support TrueHD, DTS-MA, or Atmos passthrough. Use ALSA to pass these to through the receiver.

Fix for delayed startup on wifi

If running with WiFi only (wired network unplugged) while #Sharing media and a centralized database across multiple nodes, kodi will likely start before the wireless network is up, which will result in failure to connect to the shares and to the mysql server. Assuming the network is managed by the default systemd-networkd, this can be fixed by using two Systemd#Drop-in files, one for kodi.service and another for systemd-networkd-wait-online.service:

# systemctl edit systemd-networkd-wait-online.service
[Service]
ExecStart=
ExecStart=/usr/lib/systemd/systemd-networkd-wait-online --ignore eth0
# systemctl edit kodi
[Unit]
After=remote-fs.target network-online.target
Wants=network-online.target

Run kodi in a window manager

Users running kodi in a Window manager may see a black screen at exit. To fix this, try switching to another tty. A possible solution is to run kodi with this script (running as the root user):

kodi.sh
#!/bin/bash
kodi-standalone
sudo chvt 2 
sleep 1
sudo chvt 1

To make sure that sudo does not ask for password for chvt add this line to sudoers file:

/etc/sudoers
UserNameHere ALL=NOPASSWD: /usr/bin/chvt

USB DAC not working

Users of USB DAC/sound cards may experience distorted sound/clicks/pops or no sound at all when selecting it from Audio settings. A possible fix:

Open guisettings.xml (it should be under /var/lib/kodi/.kodi/userdata/ if using the supplied kodi.service) and change

<processquality default="true">101</processquality>

to

<processquality default="false">100</processquality>

Troubleshooting

Accessing Kodi logs

In case of an error the first point to start investigation can be ~/.kodi/temp/kodi.log.

Fullscreen mode stretches Kodi across multiple displays

For a multi-monitor setup, Kodi 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 Kodi show up on display 0, add the following line to the Kodi user's ~/.bashrc configuration:

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

Video tearing on Intel HD Graphics

Users observing tearing when watching a movie try this: https://bbs.archlinux.org/viewtopic.php?id=176651

Try a different X11 compositor like compton as an alternative with Xfce which reduces video tearing. There is no essential need to install the intel driver. A tutorial how to configure compton with Xfce can be found here.

Soft subtitles not displaying

The ffmpeg package is used to extract the subtitles.

H.264 playback is using only a single core

Tip: By default, press O during playback to show codec information and CPU usage. More information about this overlay can be found at https://kodi.wiki/view/Codecinfo.

If the hardware does not or cannot make use of acceleration, disable it and explicitly set video decoding to software. This is because H.264 decoding is only multithreaded when video decoding is set to software.

To achieve this, go to System Settings > Video. Set the settings level to Advanced or Expert. Then go to Acceleration and set Decoding method to software.

Kodi hangs on exit, fully occupying one CPU core, UI unresponsive

This problem can arise with third-party plugins installed, there is some issue with their termination[1],[2].

Workaround: find proper UI description file (DialogButtonMenu.xml) and tweak exit button type from internal Kodi's Quit() function call to sending signal from outside system to Kodi. Here is one-liner that makes modifications to any skin from the default Kodi package:

# find /usr/share/kodi/addons/skin.* -name DialogButtonMenu.xml -exec sed -i 's%<onclick>Quit()</onclick>%<onclick>System.Exec ("killall --signal SIGHUP kodi.bin")</onclick>%' {} \;

See also