Created page with "Category:Player ja:Kodi zh-cn:Kodi {{Note|XBMC rebranded to Kodi starting with the version 14 release.}} Kodi is a free, [http://www.gnu.org/copyleft/gpl.html ope..."
New page
[[Category:Player]]
[[ja:Kodi]]
[[zh-cn:Kodi]]
{{Note|XBMC rebranded to Kodi starting with the version 14 release.}}
Kodi 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 devices running Linux, Mac OS X, Windows, Android and iOS. Kodi 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. Kodi 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://kodi.wiki/index.php?title=Kodi_FAQ Kodi 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 [http://kodi.wiki/?title=PVR Kodi wiki].
== Installation ==
{{Note|There are device specific packages on Arch Linux ARM. While they should work out of the box on the specific device, they are NOT necessarily compatible with the kodi package!}}
[[Install]] the {{Pkg|kodi}} package. Be sure to install the optional dependencies listed by pacman that apply to your specific use-case.
== Configuration ==
=== Autostarting at boot or ondemand ===
The {{Pkg|kodi}} package supplies a stand-alone wrapper script {{ic|/usr/bin/kodi-standalone}} that allows a minimal system to run the application without a full blown DE. There are several methods to enable it described below.
{{Warning|Select '''only one''' of the methods listed below to Users enable this functionality!}}
==== Kodi-standalone-service ====
The {{AUR|kodi-standalone-service}} package provides {{ic|kodi.service}} and creates the needed user to run Kodi in standalone mode. This is a drop-in replacement of the package-legacy systemd service and post install script which Arch developers have removed from the package when the Xorg package updated to 1.16-1 (see [https://projects.archlinux.org/svntogit/community.git/commit/trunk?h=packages/xbmc&id=9763c6d32678f3a3f45c195bfae92eee209d504f this commit]). Functionally, there is no difference.
[[Start]] {{ic|kodi.service}} and [[enable]] it to run at boot time.
{{Note|Users of this service do not need any extra configuration beyond what the package itself supplies.}}
==== Xsession with LightDM ====
{{Note|This assumes that the user has created an kodi user on the system and that the following file is present as described.}}
{{hc|/etc/X11/Xwrapper.config|2=
needs_root_rights = yes}}
To use LightDM with automatic login, see [[LightDM#Enabling autologin]]. ''Kodi'' includes {{ic|kodi.desktop}} as [[xsession]].
{{hc|/etc/lightdm/lightdm.conf|2=
[LightDM]
minimum-vt=1
run-directory=/run/lightdm
[SeatDefaults]
session-wrapper=/etc/lightdm/Xsession
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 with ''systemctl start kodi@user.socket'' (replace ''user'' with the user running Kodi to be started as). Depending on the setup, the port in ''kodi@.socket'' might need to be changed.
{{hc|/etc/systemd/system/kodi@.service|
<nowiki>[Unit]
Description=Launch Kodi on main display
[Service]
Type=oneshot
Environment=DISPLAY=:0.0
Nice=-1
ExecStart=/usr/bin/su %i /usr/bin/kodi
ExecStartPost=/usr/bin/bash -c "sleep 15 && systemctl start kodi@%i.socket"
[Install]
WantedBy=multi-user.target</nowiki>}}
{{hc|/etc/systemd/system/kodi@.socket|
<nowiki>[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</nowiki>}}
=== Sharing a database across multiple nodes ===
One can easily configure Kodi to share a single media library (video and music). The advantage of this is that 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.
Several key things are needed for this to work:
* Network exposed media (via protocols that Kodi can read, e.g. NFS or Samba).
* A MySQL server.
{{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 to reflect your setup:
* The media is located under following mount points: {{ic|/mnt/tv-shows}} {{ic|/mnt/movies}} {{ic|/mnt/music}}.
* The network addresses of all nodes are within the 192.168.0.* subnet range.
* The user wishes to use NFSv4 exports.
* 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 [http://kodi.wiki/index.php?title=HOW-TO:Share_libraries_using_MySQL/Setting_up_MySQL#tab=Arch_Linux official Kodi wiki].
==== Setup an NFS server ====
This section provides an example using NFS exports (NFSv4), but as mentioned above, any protocol that Kodi can read is acceptable.
{{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.}}
The NFS server is provided by {{Pkg|nfs-utils}} and this only needs to be installed on the box serving up the content.
Setup the shares:
# mkdir -p /srv/nfs/{tv-shows,movies,music}
# mount --bind /mnt/tv-shows /srv/nfs/tv-shows
# mount --bind /mnt/movies /srv/nfs/movies
# mount --bind /mnt/music /srv/nfs/music
Add the corresponding entries for these bind mounts to {{ic|/etc/fstab}}:
...
/mnt/tv-shows /srv/nfs/tv-shows none bind 0 0
/mnt/movies /srv/nfs/movies none bind 0 0
/mnt/music /srv/nfs/music none bind 0 0
Share the content in {{ic|/etc/exports}}:
/srv/nfs 192.168.0.0/24(ro,fsid=0,no_subtree_check)
/srv/nfs/tv-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)
{{Tip|This example sets-up read-only exports. See {{ic|man exports}} for additional options and configurations.}}
Whenever changes are made to {{ic|/etc/exports}}, always refresh the exports:
# exportfs -rav
[[Start]] {{ic|rpcbind.service}} and {{ic|nfs-server.service}} and [[enable]] them to start automatically.
Optionally check with:
# showmount -e localhost
Export list for localhost:
/srv/nfs/tv-shows 192.168.0.0/24
/srv/nfs/movies 192.168.0.0/24
/srv/nfs/music 192.168.0.0/24
{{Note|If the box is using a firewall, ensure that it is not blocking connections. This is beyond the scope of this article.}}
==== Install and setup the MySQL server ====
The box running the library needs to be available 24/7 and is commonly the same box that holds the media.
{{Note|The following example assumes the user is running Arch Linux, but any MySQL server will work, be it Linux or BSD, etc.}}
The MySQL server is provided by {{Pkg|mariadb}} and this only needs to be installed on one box that all nodes can access.
[[Start]] {{ic|mysqld.service}} and [[enable]] it to run at boot time.
First time setup:
# mysql_secure_installation
<<follow the in-script prompts and answer "Y" to all the questions>>
$ 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)]> \q
No other setup to the MySQL server should be needed.
{{Note|If the box is using a firewall, ensure that it is not blocking connections. This is beyond the scope of this article.}}
==== 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 {{Pkg|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:
{{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>
<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 {{AUR|kodi-standalone-service}}, 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. {{ic|# chown -R kodi:kodi /var/lib/kodi}}}}
===== Setup network shares =====
{{Warning|This only needs to be done once, on only one of the nodes. Once completed, configuration of subsequent nodes is a drop-in operation of ~/.kodi/userdata/advancedsettings.xml; no other configuration is needed!}}
{{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!}}
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/tv-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.
==== Cloning the configuration to other nodes on the network ====
Setting up another Kodi node on the network to use this library is trivial. Simply copy {{ic|~/.kodi/userdata/advancedsettings.xml}} to that box and restart Kodi.
{{Note|There is NO need to do any other setup steps to define the sources since the nfs exports, the metadata for the programming, any stop/start times, view status, etc. are all stored in the MySQL tables. If problems are encountered after this file is added to the profile directory and after Kodi is restarted, it is recommended to simply re-create the Kodi profile on that node, and again copy over the advancedsettings.xml file. This way, only a trivial amount of configuration to the GUI itself is required which is often easier than troubleshooting conflicting local databases, sources, and the like.}}
=== Using a remote control ===
As Kodi 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 Kodi, a file will be required that maps the lirc events to Kodi keypresses. Create an [[Wikipedia:XML|XML]] file at {{ic|~/.kodi/userdata/Lircmap.xml}} (note the capital 'L').
{{Note|Users running Kodi from the included service file will find the kodi home (~) 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 ownership as kodi:kodi when finished.}}
Lircmap.xml format is as follows:
{{bc|1=<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 {{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://kodi.wiki/index.php?title=Keymap.xml keymap.xml].
* '''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.
* A very thorough [http://kodi.wiki/index.php?title=Lircmap.xml Lircmap.xml] page over at the [http://kodi.wiki/index.php?title=Main_Page Kodi 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 {{Pkg|lirc}} 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.
{{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'"}}
Finally, [[enable]] and start {{ic|lirc.socket}}.
This should give a fully working mce remote.
==== HDMI-CEC with Pulse Eight USB-CEC ====
An elegant way of getting remote functions in Kodi is using [[wikipedia:Consumer_Electronics_Control#CEC|CEC]], a protocol that is part of the HDMI specification. Most modern TVs support CEC, although some manufacturers advertise the feature under other names. Apart from a CEC-enabled TV some hardware that takes the CEC signals coming from the TV and present them in a way that Kodi can understand is also needed. One such device is the [http://www.pulse-eight.com/store/products/104-usb-hdmi-cec-adapter.aspx USB-CEC adapter] from Pulse Eight. Hooking up the USB-CEC is pretty simple, but in order for it to work in Arch we have to do a few things.
Install {{ic|libcec}}.
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. To add a user to both groups, run
# usermod -aG uucp,lock [username]
If more than one user uses Kodi, repeat the command for all those users. If, for example, one is using {{ic|kodi-standalone}}, the relevant command is
# usermod -aG uucp,lock kodi
Remember that modifying the groups of any logged in users means those users need to log out and login again in order for the changes to take effect.
{{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.}}
==Tips and Tricks ==
=== Fixing the Wunderground Weather Add-on ===
The wunderground now requires users to have an API key in order to receive weather data. An API key is available free of charge for kodi users. To obtain a key, and to configure the add-on follow these steps:
# Sign up for an API key at [http://www.wunderground.com/weather/api/d/login.html wunderground]'s automated system.
# Format the key for kodi's wunderground.py script (it expects the key to be reversed and base64 encoded, see below).
# Enter the formatted key into '''WAIK''' variable in {{ic|~/.kodi/addons/weather.wunderground/resources/lib/wunderground.py}}
To reverse and base64 encode the API key, run this two-liner using your own API key in the "key" variable.
$ key=9cc49125b91eb85a
$ echo $key|rev|base64
YTU4YmUxOWI1MjE5NGNjOQo=
For this example key, the first few lines of {{ic|~/.kodi/addons/weather.wunderground/resources/lib/wunderground.py}} would look like this:
# -*- coding: utf-8 -*-
import urllib2, gzip, base64
from StringIO import StringIO
WAIK = 'YTU4YmUxOWI1MjE5NGNjOQo='
=== 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 {{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
=== 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.
This udev-rule reduces the speed permanently:
{{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"
}}
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
# 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]] {{ic|kodi.service}} 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.
=== 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 [http://kodi.wiki/view/Codecinfo here].}}
If your setup doesn't or can't make use of hardware acceleration, disable it and explicitly set video decoding to software.
This is because [http://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 {{ic|System Settings}} and then to {{ic|Video}}. Set the {{ic|settings level}} to {{ic|Advanced}} or {{ic|Expert}} and go to {{ic|Acceleration}}.
There, set {{ic|Decoding method}} to {{ic|software}}.
=== Raspberry Pi ===
Kodi runs smoothly on both the Raspberry Pi (RPi) and the RPi 2. Some helpful tips to consider:
* [[pacman|Install]] the ''kodi-rbp'' package instead of ''kodi'' from the [http://archlinuxarm.org/packages Arch Linux ARM repository].
* This package ships with a systemd service to run in standalone mode.
* The memory reserved for GPU is 64 MB by default. This is insufficient for GPU accelerated HD video playback. Users can increase this value via a simple edit to the {{ic|gpu_mem}} tag in {{ic|/boot/config.txt}}. A value of at least 128 MB is recommended.
* Install ''omxplayer-git'', ''xorg-xrefresh'' and ''xorg-xset'' to get hardware acceleration working.
* Add the udev rule {{ic|1=SUBSYSTEM=="tty", KERNEL=="tty0", GROUP="tty", MODE="0666"}} to {{ic|/etc/udev/rules.d/raspberrypi.rules}} to enable typing with a physical keyboard.
== See also ==
* [http://kodi.wiki/index.php?title=Main_Page Kodi Wiki] - Excellent resource with much information about Arch Linux specifically