Official Kodi Wiki - User contributions [en]

Basic playlists

2019-12-27T19:41:26Z

Cmayo: /* Playlist folder location */ Correct case of .kodi on Linux

{{mininav|[[Playlists]] }} {{to do}}
<section begin="intro" />Kodi supports both basic playlists and '''[[smart playlists]]'''. A basic playlist is a normal text file that lists one or more media files (Audio or Video), and plays them in succession. You can either create your own or use existing playlists from other sources, such as a playlist generated from Winamp, iTunes, or other sources. Basic playlists can be created and edited directly from Kodi's GUI.<section end="intro" />

== Basic playlists ==
The main way to create and manipulate playlists in Kodi is through the playlist editors (both for normal and smart playlists).

=== How to create a normal playlist ===
[[File:Playlist queue.png|500px|right]]
You can add videos/songs or entire folders with the "Queue" action of your remote/keyboard ({{keypress|Q}} on a keyboard) or the '''"Queue Item"''' option in the context menu can be used. Kodi will add the selected item to the playlist and then advance to the next item in the window.

To see the currently loaded playlist, bring up the context menu. The currently playing/queued playlist is accessible via the '''"Current playlist"''' item in the left hand sidebar menu. If the playlist is currently empty then that option will not be visible in the sidebar menu.

While in the "Current playlist" window and pressing the '''Select''' or the '''Play''' button will start playback of your playlist.

When in the "Current playlist" view, you can save your playlist by bringing up the options in the left hand sidebar menu. Playlists are, by default, saved in a subfolder of [[userdata]]/playlists (separate folder for music, video and mixed playlists).
{{-}}

=== Current playlist window ===
{{anchor|Now Playing}}
The current playlist is a special window for the current audio or video playlist. This list is accessible from the left hand sidebar menu and [[Music#OSD .28On Screen Display.29|music OSD]]. Selecting an entry will start playback.
{{-}}<br />

==== Sidebar menu ====
[[File:Now playing 3.png|500px|right]]
On the default skin (Confluence) you can bring up these options by bringing up the sidebar menu (press {{keypress|left}} on a keyboard or remote).
;Shuffle
:Shuffles the currently playing playlist
;Repeat
:Repeats the currently playing playlist, options are: '''All''' songs/videos, '''One''' song/video or '''Off''' for no repeating.
;Save
:Saves the currently playing playlist
;Clear
:Clears the currently playing playlist
{{-}}<br />

==== Context menu ====
[[File:Now playing 2.png|500px|right]]
The context menu (press {{keypress|C}} on a keyboard) within the current playlist allows you to move the order of items or remove them.

On a [[keyboard]] you can also use:
* {{keypress|U}} - Move selected up
* {{keypress|D}} - Move selected down
* {{keypress|DEL}} - Remove from playlist.

A remote control with the proper [[keymap]] additions can also use those actions.
{{-}}

== Party Mode playlists ==
{{see|Party Mode}}

== Smart playlists ==
{{main|Smart playlists}}
{{#lst:Smart playlist|intro}}

== Other supported playlist ==
Kodi supports [http://en.wikipedia.org/wiki/PLS_%28file_format%29 PLS], Winamp [http://en.wikipedia.org/wiki/M3U M3U], [http://en.wikipedia.org/wiki/Cue_sheet Cue Sheets], and [[Smart playlists|Kodi Smart Playlist (XSP)]] playlists.

== Playlist folder location ==
The playlists should be placed into a folder named “music“, “mixed” or “video” in the following location:
* '''Windows XP:''' <code>Documents and Settings\<your_user_name>\Application Data\Kodi\userdata\playlists\</code>
* '''Vista/Windows 7:''' <code>Users\<your_user_name>\AppData\Roaming\Kodi\userdata\playlists\</code>
* '''Mac OS X:''' <code>/Users/<your_user_name>/Library/Application Support/Kodi/userdata/playlists/</code>
* '''iOS:''' <code>/private/var/mobile/Library/Preferences/Kodi/userdata/playlists/</code>
* '''Linux:''' <code>$HOME/.kodi/userdata/playlists/</code>

{{Helix updated}}

[[Category:Video library]]
[[Category:Music library]]
[[Category:Manual]]

Add-on:RTL-SDR FM Radio Client

2018-11-02T19:57:35Z

Cmayo: Tidy up the introduction and overview making the use of RTL-SDR clearer

{{incomplete}}


{{Addon
| Name = RTL-SDR FM Radio Client
| provider-name = Alwin Esch, Team XBMC
| ID = pvr.rtl.radiofm
| latest-version = 0.0.9
| extension point = xbmc.pvrclient
| provides = audio
| Platform = android freebsd linux osx windx wingl ios
| broken =
| icon url =
| repo =
| zip =
| Summary = FM Radio receiver based upon RTL-SDR as PVR addon for Kodi
| Forum = http://forum.kodi.tv/showthread.php?tid=214747
| Website = http://esmasol.de/open-source/kodi-add-on-s/fm-radio-receiver/
}}

FM Radio with RDS receiver based upon RTL-SDR as a PVR add-on for Kodi. With this you can turn your Realtek RTL2832 based DVB dongle into a FM radio receiver.

==Overview==
This add-on, which allows you to receive FM Radio with RDS on a very cheap USB DVB-T stick, relies on RTL-SDR that provides a software defined radio using the USB stick. Processing is performed on the CPU which can require a lot of CPU performance.

The add-on interfaces with RTL-SDR supported Realtek RTL2832U based USB receivers (see http://sdr.osmocom.org/trac/wiki/rtl-sdr) to decode an FM radio signal and send to Kodi the audio stream in float format and the RDS signal translated to UECP.

The add-on is usable since Kodi 15.0 and RDS support first came with Kodi 16.0.

Note! On Linux make sure the kernel module dvb_usb_rtl28xxu for DVB-T is not loaded, otherwise is it not usable for RTL-SDR!

==Settings==
?

==See also==
* [[PVR]]

==External Links==
* Website: http://esmasol.de/open-source/kodi-add-on-s/fm-radio-receiver/
* Source code: https://github.com/AlwinEsch/pvr.rtl.radiofm
* Kodi forum: https://forum.kodi.tv/showthread.php?tid=214747
===RTL SDR FM Streamer===
An alternative FM receiver based on RTL-SDR that doesn't use an add-on.
* Website: https://github.com/AlbrechtL/rtl_fm_streamer
* OpenELEC thread: https://forum.openelec.tv/showthread.php?tid=75537
* Raspberrypi.org thread: https://www.raspberrypi.org/forums/viewtopic.php?f=38&t=122372

Add-on:RTL-SDR FM Radio Client

2018-11-02T19:31:08Z

Cmayo: Separate out RTL SDR FM links making clear it is a different solution

{{incomplete}}


{{Addon
| Name = RTL-SDR FM Radio Client
| provider-name = Alwin Esch, Team XBMC
| ID = pvr.rtl.radiofm
| latest-version = 0.0.9
| extension point = xbmc.pvrclient
| provides = audio
| Platform = android freebsd linux osx windx wingl ios
| broken =
| icon url =
| repo =
| zip =
| Summary = FM Radio receiver based upon RTL-SDR as PVR addon for Kodi
| Forum = http://forum.kodi.tv/showthread.php?tid=214747
| Website = http://esmasol.de/open-source/kodi-add-on-s/fm-radio-receiver/
}}

FM Radio receiver based upon RTL-SDR as PVR addon for Kodi. FM Radio with RDS receiver based upon RTL-SDR as PVR addon for Kodi. With this you can turn your Realtek RTL2832 based DVB dongle into a FM radio receiver.

==Overview==
FM Radio receiver based upon RTL-SDR as PVR addon for Kodi. This add-on to receive FM-Radio with RDS on very cheap USB DVB-T stick relies on RTL SDR FM Streamer software which is a small tool to stream FM radio by using a DVB-T dongle to a client e.g Kodi, (or VLC, or MPlayer for that matter). Operation is complete performed inside CPU which allow a lot of features, but also requires a lot of CPU performance.

The DVB-T dongle has to be based on the Realtek RTL2832U hardware chip. See http://sdr.osmocom.org/trac/wiki/rtl-sdr for more RTL SDR details.

This addon interfaces with RTL-SDR supported receivers with Realtek RTL2832U as source (see http://sdr.osmocom.org/trac/wiki/rtl-sdr) to make FM radio signal receive and send the audio stream in float format to Kodi and send also RDS signal translated to UECP in it.

Add-on is usable since Kodi 15.0 and RDS support first came with version 16.0 of Kodi.

Note! On linux make sure the kernel part dvb_usb_rtl28xxu for DVB-T is not loaded, otherwise is it not usable for RTL-SDR!

==Settings==
?

==See also==
* [[PVR]]

==External Links==
* Website: http://esmasol.de/open-source/kodi-add-on-s/fm-radio-receiver/
* Source code: https://github.com/AlwinEsch/pvr.rtl.radiofm
* Kodi forum: https://forum.kodi.tv/showthread.php?tid=214747
===RTL SDR FM Streamer===
An alternative FM receiver based on RTL-SDR that doesn't use an add-on.
* Website: https://github.com/AlbrechtL/rtl_fm_streamer
* OpenELEC thread: https://forum.openelec.tv/showthread.php?tid=75537
* Raspberrypi.org thread: https://www.raspberrypi.org/forums/viewtopic.php?f=38&t=122372

Add-on:RTL-SDR FM Radio Client

2018-11-02T19:19:52Z

Cmayo: Fix broken external links

{{incomplete}}


{{Addon
| Name = RTL-SDR FM Radio Client
| provider-name = Alwin Esch, Team XBMC
| ID = pvr.rtl.radiofm
| latest-version = 0.0.9
| extension point = xbmc.pvrclient
| provides = audio
| Platform = android freebsd linux osx windx wingl ios
| broken =
| icon url =
| repo =
| zip =
| Summary = FM Radio receiver based upon RTL-SDR as PVR addon for Kodi
| Forum = http://forum.kodi.tv/showthread.php?tid=214747
| Website = http://esmasol.de/open-source/kodi-add-on-s/fm-radio-receiver/
}}

FM Radio receiver based upon RTL-SDR as PVR addon for Kodi. FM Radio with RDS receiver based upon RTL-SDR as PVR addon for Kodi. With this you can turn your Realtek RTL2832 based DVB dongle into a FM radio receiver.

==Overview==
FM Radio receiver based upon RTL-SDR as PVR addon for Kodi. This add-on to receive FM-Radio with RDS on very cheap USB DVB-T stick relies on RTL SDR FM Streamer software which is a small tool to stream FM radio by using a DVB-T dongle to a client e.g Kodi, (or VLC, or MPlayer for that matter). Operation is complete performed inside CPU which allow a lot of features, but also requires a lot of CPU performance.

The DVB-T dongle has to be based on the Realtek RTL2832U hardware chip. See http://sdr.osmocom.org/trac/wiki/rtl-sdr for more RTL SDR details.

This addon interfaces with RTL-SDR supported receivers with Realtek RTL2832U as source (see http://sdr.osmocom.org/trac/wiki/rtl-sdr) to make FM radio signal receive and send the audio stream in float format to Kodi and send also RDS signal translated to UECP in it.

Add-on is usable since Kodi 15.0 and RDS support first came with version 16.0 of Kodi.

Note! On linux make sure the kernel part dvb_usb_rtl28xxu for DVB-T is not loaded, otherwise is it not usable for RTL-SDR!

==Settings==
?

==See also==
* [[PVR]]

==External Links==
* Website: http://esmasol.de/open-source/kodi-add-on-s/fm-radio-receiver/
* Source code: https://github.com/AlwinEsch/pvr.rtl.radiofm
** https://github.com/AlbrechtL/rtl_fm_streamer
* Kodi forum: https://forum.kodi.tv/showthread.php?tid=214747
* OpenELEC thread: https://forum.openelec.tv/showthread.php?tid=75537
* Raspberrypi.org thread: https://www.raspberrypi.org/forums/viewtopic.php?f=38&t=122372

CEC

2017-11-29T20:03:02Z

Cmayo: /* Settings in {{Kodi}} for CEC */ Improve the recipe for finding button names.

[[File:Pulse Eight CEC.jpg|300px|right|thumb|The Pulse-Eight USB to CEC adapter, for devices that don't have CEC connected to their internal HDMI pins.]]
{{mininav|[[Remote controls]]}}
<section begin="intro" />[[w:Consumer Electronics Control|CEC]] ({{u|C}}onsumer {{u|E}}lectronics {{u|C}}ontrol) allows for control of devices over the HDMI port.

All modern televisions and AV-receivers support HDMI-CEC, which is a technology that allows devices to talk with each other over the HDMI cable. {{Kodi}} comes with [http://libcec.pulse-eight.com/ libCEC] (CEC abstraction and interface library from Pulse-Eight) which allows control of the {{Kodi}} input over the standard TV remote that comes with your TV. As buttons are pressed the remote command is sent via the HDMI cable to your {{Kodi}} device.

Using this feature a {{Kodi}} compatible CEC controller/adapter will send and receive remote key presses to and from your television and AV-receiver via [http://libcec.pulse-eight.com/ libCEC].<section end="intro" />

CEC allows you to do things such as:
* Controlling {{Kodi}} from the TV's remote control
* Automatically switch to the right TV input device
* Letting the HTPC control what mode your audio receiver is on when the TV switches on
* Turning all devices off with one remote
* Set volume/mute of the receiver
* And a lot more!

==Overview==
Consumer Electronics Control (CEC) is an HDMI feature designed to allow the user to command and control up-to 15 CEC-enabled devices, that are connected through HDMI,[63][64] by using only one of their remote controls (for example by controlling a television set, set-top box, and DVD player using only the remote control of the TV).[65] CEC also allows for individual CEC-enabled devices to command and control each other without user intervention.

It is a one-wire bidirectional serial bus that is based on the CENELEC standard AV.link protocol to perform remote control functions. CEC wiring is mandatory, although implementation of CEC in a product is optional. It was defined in HDMI Specification 1.0 and updated in HDMI 1.2, HDMI 1.2a and HDMI 1.3a (which added timer and audio commands to the bus). USB to CEC adapters exist that allow a computer to control CEC-enabled devices.

{{Kodi}} uses libCEC (CEC library) from Pulse-Eight for send and receive CEC commands over the HDMI bus, this is because libCEC acts an abstraction layer and translate the commands to match each vendor and devices compatibility issues.

libCEC is aimed at being a reference implementation of the HDMI 1.4b Specification, however what each adopter supports is not always what they should support. Equally some mandatory features of HDMI-CEC are not implemented by some vendors.

{{youtube|1eDJbT35X5k}}

'''The following is a list of the most commonly used HDMI-CEC commands:'''
* '''One Touch Play''' allows devices to switch the TV to use it as the active source when playback starts
* '''System Standby''' enables users to switch multiple devices to standby mode with the press of one button
* '''Preset Transfer''' transfers the tuner channel setup to another TV set
* '''One Touch Record''' allows users to record whatever is currently being shown on the HDTV screen on a selected recording device
* '''Timer Programming''' allows users to use the EPG (Electronic Program Guides) that are built into many HDTVs and set-top-boxes to program the timer in recording devices like PVRs and DVRs
* '''System Information''' checks all components for bus addresses and configuration
* '''Deck Control''' allows a component to interrogate and control the operation (play, pause, rewind etc.), of a playback component (Blu-ray or HD DVD player or a Camcorder, etc.)
* '''Tuner Control''' allows a component to control the tuner of another component
* '''OSD Display''' uses the OSD of the TV set to display text
* '''Device Menu Control''' allows a component to control the menu system of another component by passing through the user interface (UI) commands
* '''Routing Control''' controls the switching of signal sources
* '''Remote Control Pass Through''' allows remote control commands to be passed through to other devices within the system
* '''Device OSD Name Transfer''' transfers the preferred device names to the TV set
* '''System Audio Control''' allows the volume of an AV receiver, integrated amplifier or preamplifier to be controlled using any remote control from a suitably equipped device(s) in the system

== Settings in {{Kodi}} for CEC ==
These instructions work for all libCEC compatible HDMI-CEC controllers and adapters, such as the Pulse-Eight USB - CEC Adapter or the HDMI-CEC controller built-into the Raspberry Pi.

Settings for your CEC devices can be found in:

System -> Settings -> System -> Input Devices -> Peripherals -> CEC adapter

CEC uses the '''[[keymap|remote.xml keymap]]''', editing that XML file will allow you to customize most buttons.

To identify button names, enable the [[debug log]] and look for OnKey messages. Unfortunately the key name reported is bogus and you will need to deduce it by searching for the reported action in the [[Keymap#Defaults|default remote.xml]] and noting the key that causes the action in the window showing when the message was logged.

== CEC-capable HTPCs ==
* Most HTPCs, such as x86 ("desktop"-class) HTPCs, don't have the ability to use CEC on their internal HDMI ports. Probably because the industry is silly. Those HTPCs will need to use an adapter to inject the CEC signal into the HDMI cable, such as the Pulse-Eight CEC USB adapter: http://www.pulse-eight.com/store/products/104-usb-hdmi-cec-adapter.aspx

* Some ARM/"Android boxes" have the ability to use CEC, but only expose some basic functions to {{Kodi}}. These functions are typically enough to use a TV remote to control that box. For example, the [[Amazon Fire TV]] has this kind of CEC functionality.

* Other devices, such as the [[Raspberry Pi]], have more complete CEC abilities, and are completely built-in.

== Trade names ==
There are different trade names for HDMI CEC, depending on who is the manufacturer of your device, so it doesn't have to be stated as HDMI-CEC. Find your manufacturer on this list and see what it is called for your device:

* AOC - '''E-link'''
* Hitachi - '''HDMI-CEC'''
* LG - '''SimpLink'''
* Loewe - '''Digital Link''' or '''Digital Link Plus'''
* Mitsubishi - '''NetCommand for HDMI'''
* Onkyo - '''RIHD (Remote Interactive over HDMI)'''
* Panasonic - '''VIERA Link''' or '''HDAVI Control''' or '''EZ-Sync'''
* Philips - '''EasyLink'''
* Pioneer - '''Kuro Link'''
* Runco International - '''RuncoLink'''
* Samsung - '''Anynet+'''
* Sharp - '''Aquos Link'''
* Sony - '''BRAVIA Link''' or '''BRAVIA Sync''' (You may need to use a port labeled HDMI-MHL if the regular HDMI port does not work.)
* Toshiba - '''Regza Link''' or '''CE-Link'''

== Manufacturer Support ==
The matrix below indicates our what Pulse-Eight, the main developer of ibCEC, believe each vendor supports themselves, this matrix is by no means complete and if your device/brand is not listed then please ask us for more information. Note that cells marked "'''?'''" may work, but we have not independently verified. Cells marked Yes* are supported by libCEC but require a commercial license.

{|
| A "|| {{yes}} ||" mark indicates that the vendor support this CEC feature. This information was originally copied from http://libcec.pulse-eight.com/vendor/support
|}
{| width="100%" class="datatable"
|-
! Vendor !! One Touch Play !! Routing Control !! Standby !! One Touch Record !! Timer Programming !! System Information !! Deck Control !! Tuner Control !! OSD String Display !! Device OSD Name Transfer !! Device Menu Control !! Remote Control Passthrough !! Power Status !! System Audio Control
|-
| Akai || {{?}} || {{?}} || {{?}} || {{?}} || {{?}} || {{?}} || {{?}} || {{?}}|| {{?}} || {{?}} || {{?}} || {{?}} || {{?}} || {{?}}
|-
| AOC || {{?}} || {{?}} || {{?}} || {{?}} || {{?}} || {{?}} || {{?}} || {{?}}|| {{?}} || {{?}} || {{?}} || {{?}} || {{?}} || {{?}}
|-
| Benq || {{?}}|| {{?}} || {{?}} || {{?}} || {{?}} || {{?}} || {{?}} || {{?}}|| {{?}} || {{?}} || {{?}} || {{?}} || {{?}} || {{?}}
|-
| Daewoo || {{?}}|| {{?}} || {{?}} || {{?}} || {{?}} || {{?}} || {{?}} || {{?}}|| {{?}} || {{?}} || {{?}} || {{?}} || {{?}} || {{?}}
|-
| Grundig || {{?}}|| {{?}} || {{?}} || {{?}} || {{?}} || {{?}} || {{?}} || {{?}}|| {{?}} || {{?}} || {{?}} || {{?}} || {{?}} || {{?}}
|-
| Hitachi || {{?}}|| {{?}} || {{?}} || {{?}} || {{?}} || {{?}} || {{?}} || {{?}}|| {{?}} || {{?}} || {{?}} || {{?}} || {{?}} || {{?}}
|-
| LG || {{yes}}|| {{yes}} || {{yes}}<ref name="Supported by all devices except TVs">Supported by all devices except TVs.
See [https://forum.kodi.tv/showthread.php?tid=245169 this thread] for a workaround.</ref> || {{?}} || {{?}} || {{?}} || {{yes}} || {{?}}|| {{no}} || {{no}} || {{?}} || {{yes}} || {{?}} || {{?}}
|-
| Loewe || {{?}}|| {{?}} || {{?}} || {{?}} || {{?}} || {{?}} || {{?}} || {{?}}|| {{?}} || {{?}} || {{?}} || {{?}} || {{?}} || {{?}}
|-
| Marantz || {{?}}|| {{yes}} || {{?}} || {{?}} || {{?}} || {{?}} || {{?}} || {{?}}|| {{?}} || {{?}} || {{?}} || {{?}} || {{?}} || {{?}}
|-
| Medion || {{?}}|| {{?}} || {{?}} || {{?}} || {{?}} || {{?}} || {{?}} || {{?}}|| {{?}} || {{?}} || {{?}} || {{?}} || {{?}} || {{?}}
|-
| Mitsubishi || {{?}}|| {{?}} || {{?}} || {{?}} || {{?}} || {{?}} || {{?}} || {{?}}|| {{?}} || {{?}} || {{?}} || {{?}} || {{?}} || {{?}}
|-
| Onkyo || {{yes}}|| {{yes}} || {{yes}} || {{?}} || {{?}} || {{?}} || {{?}} || {{?}}|| {{no}} || {{?}} || {{?}} || {{yes}} || {{?}} || {{yes}}
|-
| Panasonic || {{yes}}|| {{yes}} || {{yes}} || {{?}} || {{?}} || {{?}} || {{?}} || {{?}}|| {{?}} || {{no}} || {{?}} || {{yes}} || {{?}} || {{?}}
|-
| Philips || {{yes}}|| {{yes}} || {{yes}} || {{no}} || {{no}} || {{yes}} || {{no}} || {{no}} || {{no}} || {{yes}} || {{?}} || {{yes}} || {{yes}} || {{yes}}
|-
| Pioneer || {{?}}|| {{?}} || {{?}} || {{?}} || {{?}} || {{?}} || {{?}} || {{?}}|| {{?}} || {{?}} || {{?}} || {{?}} || {{?}} || {{?}}
|-
| Runco || {{?}}|| {{?}} || {{?}} || {{?}} || {{?}} || {{?}} || {{?}} || {{?}}|| {{?}} || {{?}} || {{?}} || {{?}} || {{?}} || {{?}}
|-
| Samsung || {{yes}}|| {{yes}} || {{yes}} || {{?}} || {{?}} || {{?}} || {{yes}} || {{?}}|| {{no}} || {{yes}} || {{?}} || {{?}} || {{?}} || {{?}}
|-
| Sharp || {{yes}}|| {{yes}} || {{yes}} || {{?}} || {{?}} || {{?}} || {{?}} || {{?}}|| {{?}} || {{?}} || {{?}} || {{?}} || {{?}} || {{?}}
|-
| Sony || {{yes}}|| {{yes}} || {{yes}} || {{?}} || {{?}} || {{?}} || {{?}} || {{?}}|| {{?}} || {{?}} || {{?}} || {{?}} || {{?}} || {{?}}
|-
| Toshiba || {{yes}}|| {{yes}} || {{yes}} || {{?}} || {{?}} || {{?}} || {{?}} || {{?}}|| {{?}} || {{?}} || {{?}} || {{?}} || {{?}} || {{?}}
|-
| Vizio || {{yes}}|| {{yes}} || {{yes}} || {{?}} || {{?}} || {{?}} || {{?}} || {{?}}|| {{?}} || {{?}} || {{?}} || {{?}} || {{?}} || {{?}}
|-
| Yamaha || {{?}}|| {{?}} || {{yes}} || {{?}} || {{?}} || {{?}} || {{?}} || {{?}}|| {{?}} || {{?}} || {{?}} || {{?}} || {{?}} || {{yes}}
|}

====Notes====
<references />

== Devices Known to work ==
With different TV's and devices comes different compatibility. An up to date vendor support matrix can be found [http://libcec.pulse-eight.com/vendor/support here], which lists which features are supported for each vendor.

Please note that for HDMI-CEC volume control you must have a connected Television and A/V Receiver that are HDMI-CEC compatible. HDMI-CEC cannot control the volume of your television alone.

Below is a list of specific TV's which are known to be working with CEC and {{Kodi}}:

=== TVs ===
* LG 47LS4600
* LG 47CS570
* LG LM620T
* LG 37LG6000
* LG 42LD420
* LG 42LD550
* LG 60PM6700 (Most of the expected buttons work, EXCEPT the number & channel buttons)
* LG 32LN572B (2013 model tested on Raspberry Pi running OpenELEC 3.2.3. The regular TV remote control works except forward and rewind but the left and right skip keys works so it's quiet useable. The Magic Remote also seems to work but haven't been tested properly)
* Panasonic TXL-47DT50
* Panasonic TX-42AS500E (After pressing *Power*-button, keep it pressed, and press *7* *3* *Stop*)(see [http://forum.kodi.tv/showthread.php?tid=144956&page=2 this thread])
* Panasonic Viera GT30
* Panasonic Viera GT60
* Panasonic Viera S60
* Panasonic Viera ST50
* Panasonic Viera TH-42PX80E
* Panasonic Viera TH-42PZ85E
* Panasonic Viera TH-P42S10A
* Panasonic Viera TH-P50G10A
* Philips 37PFL6007K
* Philips 47PFL5007K
* Philips 48PFH4100/88
* Samsung ES6800
* Samsung LE32B650
* Samsung LE37D570
* Samsung LE40C650
* Samsung LN46D610/LN46D630
* Samsung UE40C7700
* Samsung UE46F8000
* Samsung UE50EH5300
* Samsung UE50ES6300
* Samsung UE55F6510
* Sharp LC-52D83X
* Sony Bravia KDL-32W5500 (Guide button doesn't work as context menu - reassign a coloured button for this function)
* Sony Bravia KDL-40M4000
* Sony Bravia KDL-46EX520
* Sony Bravia KDL-40HX705
* Sony Bravia KDL-46HX800
* Sony Bravia KDL-46NX715
* Sony Bravia KDL-52NX800
* Sony Bravia KD-55X9004A
* Sony Bravia XDR-55X800B (You must use a port labeled HDMI-MHL (2 or 4); the regular HDMI ports (1 or 3) will not work.)
* Sony NSX-40GT1 (Google TV)
* Vizio M-Series

=== Home Cinema Systems ===
* Marantz SR7005
* Onkyo HT-R390 Amplifier
* Onkyo TX-SR444 AV Receiver (Assign remote code 32910 to the input your Kodi device is connected to)
* Sony STR-DH820
* Yamaha RX-V473 AV-Receiver
* Yamaha RX-V1071 AV Receiver (only on HDMI Out 1)

=== Projectors ===
* Epson EH-TW6100
* LG PF1500

=== {{Kodi}} Devices ===
Most HDMI ports on computers (onboard or via GPU) do not have integrated support for the CEC feature, but instead can use a external CEC adapter, such as the ones from [[Pulse-Eight]], and some more recent Intel motherboards come with a integrated HTPC header to allow you to connect an internal CEC-adapter.

==== Pulse-Eight USB CEC Adapter ====
[[Pulse-Eight]] makes two different formats of HDMI-CEC USB-adapters, one for [http://www.pulse-eight.com/store/products/104-usb-hdmi-cec-adapter.aspx external] and one [http://www.pulse-eight.com/store/products/117-internal-hdmi-cec-adapter.aspx internal]. The work the same, with both permitting a connected device to send and receive HDMI-CEC control commands on the HDMI bus. The [[Pulse-Eight]] CEC adapters can be installed for use with {{Kodi}}. Your television remote can then be used to control {{Kodi}}, and {{Kodi}} can control all compatible connected devices.

==== [[Intel NUC]] ====
Intel Graphics doesn't support CEC commands (http://www.intel.com/support/graphics/sb/CS-034397.htm under "What are the differences between different HDMI versions?") and a Pulse-Eight adapter is required. Both the external USB adapter and the internal adapter (http://www.intel.com/support/motherboards/desktop/sb/CS-034631.htm) works.

==== [[Raspberry Pi]] ====
The Raspberry Pi GPU has CEC support which is supported by libCEC, and is therefore fully supported by {{Kodi}}.

==== [[Wetek Play]] ====
The Wetek Play GPU has CEC support which is supported by libCEC, and is therefore fully supported by {{Kodi}}.

=== Common Issues with CEC ===
When "setting up" CEC make sure your configuration uses good HDMI cables. Especially cheap cables - still able to support 1080p without any problems - have been reported to cause problems with CEC (eg. devices like raspberry not showing up in the CEC menu at all, devices showing up but remote not working, etc).

Using better HDMI cables might resolve that problem.

There are also reports of devices with improper HDMI CEC implementation, such as ROKU streaming box, causing problems with CEC device recognition. Disconnecting non-CEC devices, or upgrading firmware on those devices, may resolve the problem.

== Further reading ==
* http://libcec.pulse-eight.com/faq

{{gotham updated}}

[[Category:Remotes]]
[[Category:Manual]]
[[Category:Hardware]]

Userdata

2017-11-29T19:51:53Z

Cmayo: /* Location of the userdata folder */ fix typo "operative system"

{{mininav|[[General topics]]|[[Settings]]}}

{{redv|'''NOTICE:'''|Manually editing files in the '''userdata''' folder is an '''advanced topic for {{kodi}}'''. New users '''don't need to manually edit files''' in the '''userdata''' folder. {{kodi}} does this for you, when you change the options in the {{kodi}} GUI'' with the exception of [[advancedsettings.xml]]}}
{{bluev|'''NOTE'''|''There are two userdata folders, the [[Systemdata]] one contains default settings necessary for {{kodi}} to operate, and the userdata folder for user modifications. Do not touch the files in the first system-userdata folder. This page (and most references on the wiki) are about editing the second, user-accessible, '''userdata''' folder.''}}

<section begin="intro" />The '''userdata''' folder is where all of your settings and customizations are stored.<section end="intro" />
<br />
== Location of the userdata folder ==
<section begin="location all" />
<includeonly>:::</includeonly>{{Note|In older versions of the software (before v14) the <code>'''kodi'''</code> directories were named <code>'''xbmc'''</code>.}}
<includeonly>:::</includeonly>{{{!}} class="datatable" 
! Operating system
! File path
|-
| '''Android''' || {{userdata|Android}}
|-
| '''iOS''' || {{userdata|iOS}}
|-
| '''Linux''' || {{userdata|Linux}}
|-
| '''Mac''' || {{userdata|Mac}}
|-
| '''LibreELEC/OpenELEC''' || {{userdata|OpenELEC}}
|-
| '''Windows''' || {{userdata|Windows}}
|}
<section end="location all" />

=== Android location ===
Sometimes the exact path will differ from device to device. The Android userdata folder is usually inside of "sdcard" so the path might be /sdcard/Android/data/org.xbmc.kodi/files/.kodi/userdata/

=== Windows 10 App Store version ===
Kodi Krypton installed from the Win 10 App Store puts user data in %LOCALAPPDATA%\Packages\XBMCFoundation.Kodi_4n2hpmxwrvr6p\LocalCache\Roaming\Kodi\userdata

== Backing up your settings ==
{{See|Backup}}

== UserData folder contents ==
Below are the elements contained in the UserData folder and their role:

* '''addon_data''' - Contains configuration data for your currently installed addons, the addons themselves are not in userdata but one folder up in 'addons'
* '''[[Database]]''' - This is where all of the databases required for your [[Music Library|Music]] and [[Video Library|Video Libraries]] are located, containing any downloaded [[Scraper.xml|(scraped)]] music or video information.
** '''MyMusic#.db''' - Database file containing Music information.
** '''MyVideos#.db''' - Database file containing Movie, TV Show and Music Videos information.
** '''ViewModes#.db''' - Database file containing information on all Kodi views (viewmode, sorting etc.).
** '''Addons#.db''' - Database file containing information on all Kodi addons (skins, scraper, video-addons...).
** '''Textures#.db''' - Database file containing information on all Kodi textures (thumbs, fanart, posters...).
** '''TV#.db''' - Database file containing information on Live-TV channels.
** '''EPG#.db''' - Database file containing information on EPG for Live-TV.
** '''ADSP#.db''' - Database file containing information for Audio Digital Signal Processing add-ons.
:{{note|Where <big>'''#'''</big> is the number of current '''[[database version]]''' in use.}}
* '''[[keyboard.xml|keymaps]]''' - This folder is where your customized keymapping files reside (e.g. MyRemote.xml or keyboard.xml)
* '''library''' - Directory to store [[custom library nodes]].
* '''[[Playlists]]''' - This is where your playlists are stored. There are separate subfolders for mixed, music and video playlists.
** '''mixed''' - playlists containing both audio and music videos, will show in both the Music and Video Libraries.
** '''music''' - playlists containing audio only, will show in the Music Library.
** '''video''' - playlists containing videos only, will show in the Video Library.
* '''[[Thumbnails#Thumbnail Cache|Thumbnails]]''' - Cached Thumbnails (icons) are stored in this folder.
* '''[[advancedsettings.xml]]''' - A user can create this file in their UserData folder. The file can contain additional settings and pre-defined values for the settings available in the GUI (thus removing them from the GUI settings screens). Useful for advanced users and for installers.
* '''Visualizations''' - All of your visualization settings are stored in this folder. <<this is not present in frodo?
* '''[[favourites.xml]]''' - This file, which may be created by Kodi or the user in their UserData folder contains items added via the ''Add to Favourites'' context menu option.
* '''guisettings.xml''' - This is where your settings configured in the GUI are stored (through the User Interface [[Settings]]).
* '''[[lircmap.xml|Lircmap.xml]]''' - This file which may be created can contain changes to the default Lircmap (Linux Only).
* '''[[partymode.xsp]]''' - Defines the [[Playlists#Smart Playlists|Smart Playlist]] to be used when using Party Mode for music playback.
* '''[[profiles]]''' - Directory stores your additionally created user-profiles settings and data information this directory may contain all the contents of the [[userdata]] list depending on settings used to create the user. {{?}}
* '''[[RssFeeds.xml]]''' - RssFeeds.xml is used to configure the RSS feeds displayed on the home screen.
* '''[[sources.xml]]''' - Defines your [[Adding Media Sources|Media Sources]] and locations.
* '''[[mediasources.xml]]''' - Similar to sources.xml, but just for the "Browse for new share" window.
* '''[[Profiles#Profiles folder contents|profiles.xml]]''' - Stores your Master user and additional user(s) [[Master lock]] codes and profiles information see also [[Settings/System#Master lock]] and [[Media sources#Locking]] '''{{?}}'''
* '''[[autoexec.py]]''' - optional python script that is run at Kodi startup.

{{Helix updated}}

[[Category:Settings]]
[[Category:Manual]]
[[Category:Advanced topics]]

Keymap

2017-11-28T18:16:49Z

Cmayo: /* Commands */ Update Key.h link from /xbmc/guilib/ to /xbmc/input/

{{mininav| [[Remote controls]] }}
<section begin="intro" />Keymaps are XML base files that define the mappings of keys (keyboard keys, mouse/remote/joysticks buttons and more) to Kodi actions.<section end="intro" />

== Customizing keymaps through the GUI ==
{{main|Add-on:Keymap Editor}}
Users can customize keymaps for remotes in GUI by using the community [[Add-on:Keymap Editor|Keymap Editor]] add-on.

== Location of keymaps ==
User modified keymap files must be stored in the "'''keymaps'''" folder in the [[userdata]] folder:
{{#lsth:userdata|Location of the UserData folder}}

=== Defaults ===
Default keymaps are included when Kodi is installed, but users should not edit those install files directly. Instead, place user modified keymaps in the [[userdata]]/keymaps/ directory.

Kodi can process multiple keymap files and does so like this:

* All *.xml files from the default install settings and userdata/kemaps/ folders are applied as keymaps.
* All *.xml files are processed in alphabetical order.
* Keymaps defined in an .xml file add to or override mappings in previous .xml file.
* Keymaps defined in the userdata folder add to or override mappings in the global keymap.

By default there will be no files in these locations, so grab one from the link below to make a new one/over-ride:

* ''' https://github.com/xbmc/xbmc/tree/master/system/keymaps '''
* ''' https://github.com/kodi-game/peripheral.joystick/tree/master/peripheral.joystick/resources/buttonmaps/xml '''

== Structure ==

There is one '''global''' keymap and several '''window'''-specific keymaps.<br />
Kodi falls back to the global map when the window-specific map hasn't bound the key being pressed.

The format of keymapping files is as follows:

<syntaxhighlight lang="xml" enclose="div">
<keymap>
<global>
<gamepad>
<A>Select</A>
[...]
</gamepad>

<remote>
<select>Select</select>
[...]
</remote>

<keyboard>
<enter>Select</enter>
[...]
</keyboard>

<mouse>
<leftclick>Select</leftclick>
[...]
</mouse>

<universalremote>
<obc25>XBMC.ActivateWindow(MyMusic)</obc25>
[...]
</universalremote>

<joystick name="PLAYSTATION(R)3 Controller (00:1B:FB:F6:E0:F2)">
<button id="15">Select</button>
[...]
</joystick>
</global>

<Home>
[...]
</Home>

[...]

</keymap>
</syntaxhighlight>

As you can see, it's divided into a <global> section, and a number of window sections (such as <Home>).<br />
A list of the available window names can be seen [[Window IDs|here]]. The WINDOW can also be a custom window formatted as <windowId#> (e. g. <window1113>). <br />
Each of these sections can contain Gamepad, Remote, Keyboard, Universal Remote, and custom Joystick sections.

The format for mapping a particular key under one of these device types is as follows:
<syntaxhighlight lang="xml" enclose="div">
<keyname>action</keyname>
</syntaxhighlight>

== Keynames ==
Depending on your device you will need to use a specific "keyname".
=== Gamepads ===
An up to date list of the available actions can be found in the source code of Kodi in [https://github.com/xbmc/xbmc/blob/master/xbmc/input/ButtonTranslator.cpp ButtonTranslator.cpp] where the ''TranslateGamepadString()'' function does the work.

'''Example:'''
<syntaxhighlight lang="xml" enclose="div">
<gamepad>
<A>Select</A>
</gamepad>
</syntaxhighlight>

=== Remotes ===
An up to date list of the available actions can be found in the source code of Kodi in [https://github.com/xbmc/xbmc/blob/master/xbmc/input/ButtonTranslator.cpp ButtonTranslator.cpp] where the ''TranslateRemoteString()'' (NOTE: not existing anymore) function does the work.

{{Note|Some remotes (e.g. FLIRC) are actually seen as "keyboards". Those will need to use the <keyboard> tag instead.}}

'''Example:'''
<syntaxhighlight lang="xml" enclose="div">
<remote>
<play>Play</play>
</remote>
</syntaxhighlight>

=== Universal Remotes ===
To map Universal Remote buttons using the RCA infrared protocol, you may add '''<universalremote>''' sections to keymap.xml.<br />
In this case, the tags used are <obc#> where # is the original button code (OBC) of the button.<br />
You would put it inside a <universalremote> section in the <window> or <global> sections.

'''Example:'''
<syntaxhighlight lang="xml" enclose="div">
<universalremote>
<obc148>Stop</obc148>
</universalremote>
</syntaxhighlight>

:Will map ''Stop Playback'' to the RCA DVD repeat button <obc148>, which is not used by Kodi by default.

* '''Note:''' ensure that the <universalremote> section is '''NOT''' added 'within' the <remote> section - it can appear before or after. Otherwise it will not be recognised and produces errors in the logfile.

Remote keys can be observed in the kodi.log file ('''~/.kodi/temp/kodi.log''' on Linux) when debugging is enabled in the GUI (Settings -> debugging ). The list of pre-defined OBC codes can be found at [https://github.com/xbmc/xbmc/blob/master/xbmc/input/XBIRRemote.h XBIRRemote.h].

=== Keyboards ===
Valid keyboard keymap syntax includes <keyname>, <key id="">, and <keyname mod="">.

Mapping for arbitrary key codes can be configured using the following syntax:
<syntaxhighlight lang="xml" enclose="div">
<key id="123">
</syntaxhighlight>
where "123" is replaced by the key code.

A full list of valid keynames can be found in
* the ''TranslateKeyboardString()'' method in [https://github.com/xbmc/xbmc/blob/master/xbmc/input/ButtonTranslator.cpp ButtonTranslator.cpp]
* or in [[List of Kodi keynames]].<br />

'''Example:'''
<syntaxhighlight lang="xml" enclose="div">
<keyboard>
<key id="123">action</key> -- id is the keys keycode. >
<a mod="shift,alt">action</a> -- corresponds to shift-alt-a, the mod="" syntax is enabled since build 26407. >
<space>action</space> -- for a complete list of valid keynames, see ButtonTranslator.cpp or List of Kodi keynames above. >
</keyboard>
</syntaxhighlight>

;Modifiers
* shift
* alt
* ctrl

=== Mouse ===

'''''Further action required'''''

=== Custom Joystick Configuration ===
Custom joysticks are defined using the following syntax:
<syntaxhighlight lang="xml" enclose="div">
<joystick name="JOYSTICK NAME">
<button id="BUTTON ID">action</button>
</joystick>
</syntaxhighlight>

Getting the joystick name:
* On linux: 'cat /proc/bus/input/devices'
* or see your Kodi log file

Getting the button ids:
* 'id' is the button ID used by SDL. Joystick button ids of connected joysticks appear in kodi.log when they are pressed. Use your log to map custom buttons to actions.

'''Example:'''
<syntaxhighlight lang="xml" enclose="div">
<joystick name="PLAYSTATION(R)3 Controller (00:1B:FB:F6:E0:F2)">
<button id="15">Select</button>
<button id="14">PreviousMenu</button>
</joystick>
</syntaxhighlight>

== Long-press ==
{{note| Longpress seems to only be working on keyboard keymaps at the moment }}
Depending on the device, many remotes, keyboards, and gamepads can use the long-press modifier. This allows a button to do a separate action when held for a short period of time. The syntax for this is as follows:

<pre><button mod="longpress">action</button></pre>

Not all devices will correctly work with the longpress action, but most should.

{{Note|Long-press will disable keyrepeat for that key/window.}}

=== Removing a long-press action from a default keymap ===
If you want to simply remove a long-press action, rather than override it, you can place an empty long-press tag in a keymap. This also has the effect of re-enabling keyrepeat for the short-press action.

For example, this will remove the context menu action from the default keyboard.xml keymap:

<pre>
<keymap>
<global>
<keyboard>
<return mod="longpress"></return>
<enter mod="longpress"></enter>
</keyboard>
</global>
</keymap>
</pre>

== Commands ==
The most recent available actions can be found in the ''TranslateActionString()'' method in in [https://github.com/xbmc/xbmc/blob/master/xbmc/input/ButtonTranslator.cpp ButtonTranslator.cpp].

For those debugging integer action codes from the debug log, the mapping of action codes to constants is in [https://github.com/xbmc/xbmc/blob/master/xbmc/input/Key.h Key.h]

In addition to the following actions, you can also use '''[[Built-in scripting]]''' in Kodi.

=== Actions ===
{{Main|Action IDs}}
{{#lst:Action IDs|Action IDs}}

=== Functions ===
{{main|List of built-in functions|Built-in scripting}}
{{#lst:List of built-in functions|functions}}

== Windows ==
{{main|Window IDs}}
{{#lst:Window IDs|main content}}

== Additional keys ==
Other keys that can be mapped to actions.

=== Media keyboards/remotes ===
* browser_back
* browser_forward
* browser_refresh
* browser_stop
* browser_search
* browser_favorites
* browser_home
* volume_mute
* volume_down
* volume_up
* next_track
* prev_track
* stop
* play_pause
* launch_mail
* launch_media_select
* launch_app1
* launch_app2
* play
* pause
* fastforward
* rewind
* channelup
* channeldown

=== Mouse actions ===
* leftclick
* rightclick
* middleclick
* doubleclick
* wheelup
* wheeldown
* mousemove
* mousedrag
* mousedragstart
* mousedragend
* mouserdrag - right button drag
* mouserdragstart - start of right button drag
* mouserdragend - end of right button drag

== Examples and pre-made keymaps ==
{{see|:Category:Custom keymaps}}

== See also ==
* [[Remote controls]]
* [[Keyboard controls]]
'''Development:'''
* [[Add-on development]]
* [[Python development]]
* [[Skinning]]

{{Updated|16}}

[[Category:Development]]
[[Category:Manual]]
[[Category:Remotes]]
[[Category:Settings]]
[[Category:Controls]]

VideoPlayer

2016-10-27T18:57:24Z

Cmayo: Typo in FFmpeg description

{{cleanup}}
Kodi's "'''VideoPlayer'''" (formelly XBMC's "'''[[DVDPlayer]]'''") is Kodi's internal video player that all video playback is defaulted to be played in unless custom '''[[External players|external player]]''' is configured or addons make use of a other video player.

Kodi's internal VideoPlayer is capable of playing DVD-Video and Blu-ray Disc as well as most other popular video formats. VideoPlayer supports DVD-Video with menus, from CD/DVD-media, harddrive, network, ISO/IMG-images and RAR/ZIP archives (and even RARed ISO/IMG-images as long as they are in 'stored/archive' mode and not compressed).<br />

== Currently Supported Codecs ==
* [http://www.ffmpeg.org FFmpeg] - all audio and video decoders supported by FFmpeg (avcodec/avformat) open source codec suite
* [http://en.wikipedia.org/wiki/Mpeg2 MPEG-1/MPEG-2] video decoder based on [http://libmpeg2.sourceforge.net/ libmpeg2]
* MPEG-1/MPEG-2 (Layer I, Layer II, and Layer III, inc. MP3) audio decoder based on [http://www.underbit.com/products/mad/ libmad]
* [http://en.wikipedia.org/wiki/Dts DTS (Digital Theater System)] audio decoder based on [http://developers.videolan.org/libdca.html libdca] (formaly known as "libdts")
* [http://en.wikipedia.org/wiki/Dolby_Digital Dolby Digital AC3] audio decoder based on [http://liba52.sourceforge.net/ liba52]
* [http://en.wikipedia.org/wiki/Advanced_Audio_Coding AAC (Advanced Audio Coding)] MPEG-4 audio decoder based on AudioCoding.com's [http://www.audiocoding.com libfaad2]

== Known Issues ==
For every release, the internal VideoPlayer in Kodi is becoming more and more usable/stable for the average end-user. However, there is still a lot of work that can be done on it:
For one thing there are still quite a few bugs left in it that should be found and fixed, something we really need your help with (see the "[[VideoPlayer#Bug Reporting|Bug Reporting]]" section below).
Another thing is that not all features that you might expect from stand-alone DVD-Video or Blue-ray Disc player hardware are implemented yet. Some of these features are listed below under "[[VideoPlayer#Unimplemented Features|Unimplemented Features]]" and are not considered to be bugs, that does not mean that features not listed below under can be reported as bugs (something that happens too many times)!

=== Known Bugs ===
The official list/tracker of known bugs can be found [http://trac.kodi.tv trac]

== Bug Reporting ==
When reporting bugs or problems there are a few things to keep in mind before posting your bug report(s).
Bug-reports should be reported at [http://sourceforge.net/tracker/?atid=581838&group_id=87054&func=browse&_category=566353 sourceforge.net], this way we are able to track all bugs on one tracker which makes our lifes a lot easier. However, before posting a bug-report there, make sure it is a valid bug-report and not a feature-request or something that is your own fault (i.e. user-error). To do that you can start a new topic thread on the Kodi [http://www.xboxmediacenter.com/forum/forumdisplay.php?f=8 bug-discussion forum] to verify this with others. But most importantly, use the search functions first [http://sourceforge.net/tracker/?atid=581838&group_id=87054&func=browse&_category=566353 here] and [http://www.xboxmediacenter.com/forum/search.php here], to make sure you are not posting duplicate bug reports. Duplicate reports/posts of the same bug makes it much harder for us to keep track of all the bug-reports/posts, not doing so will also save you a lot of work.

When reporting a bug there are a few things we will need, if these things are not provided, it will be much harder (and many times impossible) to replicate the problem and find the bug. In the case of an invalid bug-report the report will be closed without us even looking at it.

Some things that should be in a bug report:
* A clear description of the problem and what you did (step-by-step) to see it so that we can then replicate it if and when we have the same DVD-Video disc media or a sample (see “Sample” below).
* A log file (see [[debug log]] below)
* The Kodi version you are using (exact build date)
* Did you build Kodi yourself (from GIT) or...?
* Audio output mode (analog stereo, passthrough, ...)
* Video output mode (output resolution, PAL or NTSC...)
* The amount of free memory! See the “log file” chapter below on how to enable free memory display!
** Before playing the DVD
** During the problem
** After the problem (if Kodi did not crash and just went back to the normal GUI)
* If it is a non-menu related problem
** Can you play the .vob file correctly with the VideoPlayer? (select VideoPlayer with the 'play with dialog')
* Other information you think that might be relevant

Please have a look at [[HOW-TO Submit a Proper Bug Report]] for additional information.

=== Kodi Log File ===
Kodi is able to create a log file that provides us with a lot of useful information when trying to locate a bug. See '''[[debug log]]''' for more information.

=== Sample ===
While it sometimes can be complicated to provide us with samples, it is usually worth the effort. With samples that show the problem we are able to fix bugs much easier and quicker, because with a sample we can very simply replicate the bug ourselves in our own debug enviroment, and most of the time these bugs can be fixed the same day if there is a developer with some free time available and willing. Without a sample, it will take much longer because we cannot replicate the bug ourselves and we will have to try a lot of things (which can break the current working version again).

Simplest is to just to snail-mail one of the developers a 1:1 copy of the DVD-Video disc media (or the original retail DVD-Video disc media if the bug has something to do with encryption problems), you can create a such 1:1 copy on your PC using software's like “DVDDecrypter”. Another possibility is to compress (ZIP/RAR) the sample and send it over the internet, (since most DVDs are a bit to big to send over the internet you can try to strip unneeded data out of it (read the section below about “DVD-menu related problems”). If you have the possibility to either snail-mail the disc (shipping the actual disc) or send a sample over the internet please post so in your bug-repost. Note! Please understand that if you send in a DVD-disc (copy or original) we can not send it back!

For DVD-menu related problems, the next can be done:
;strip all non-menu related vob files.
:These files take up most of the space. What is needed are the ifo and bup files, together with all menu vobs. If you are lucky the DVD has a few 1GB big vob files (these are probably the main movie and thus not needed) and one or two small vob files. These small vob files are needed. RAR or ZIP those vobs together with the ifo and bug files and provide them to us. Upload them to an upload site or find another way (like posting them on your own website or creating a torrent).

If the problem has something to do with the main movie, the only thing left todo is to take the problematic vob file and to strip it as much as is possible.

In all cases you must first test the sample yourself before you send it to the XBMC developer/team, the sample needs to have the same problem as the original DVD, (since it is not of much use otherwise).

== Development ==
See the [http://forum.kodi.tv/forumdisplay.php?fid=240 VideoPlayer Development] subforum for now.
:Help is always wanted, so if you can program C++ and C, please feel free to code and [[HOW-TO submit a patch|submit a patch]].

=== Technical Details ===
See the [http://forum.kodi.tv/forumdisplay.php?fid=240 VideoPlayer Development] subforum for now.

=== Classes ===
* InputStreams
** FactoryInputStream, creates an inputstream based on the filename
** File, general file access (hd, cdrom, samba)
** Http
** Navigator, for accessing dvd
* Demuxers
** FactoryDemuxer, creates a demuxer based on inputstream information
** FFmpeg, ffmpeg demuxer wrapper (supports all ffmpeg demuxers)
** Shoutcast, for demuxing shoutcast streams
* Codecs
** FactoryCodec, creates audio and video codecs based upon demuxer information
** Audio
*** FFmpeg, ffmpeg audio decoder wrapper
*** Liba52, liba52 wrapper
*** LibDts, libdca wrapper
*** LibFaad, libfaad wrapper
*** LibMad, libmad wrapper (for mp1, mp2, mp3 decoding)
*** LPcm, lpcm decoding
*** Passthrough, for digital passthrough
** Video
*** LibMpeg2
*** FFmpeg, ffmpeg video decoder wrapper
* Subtitles

=== Modules ===
The player is divided up into a few modules

==== Main Module ====
Runs in a separate thread
Reads data from one of the input streams and sends it over to one of the other modules listed below
Handle DVD events (such as audio / subtitle / video stream changes)
Handle events from Kodi (such as audio / subtitle changes)

==== Audio Module ====
Runs in a separate thread.
Decodes audio data

==== Video Module ====
Runs in a separate thread.
Decodes raw video data into video frames

==== Subtitle Module ====
Process subtitles

== Building Libraries (Audio / Video Codecs) ==
The dvdplayer depends on other libraries to function. These libraries are included in SVN by default as dll's under the [http://xbmc.svn.sourceforge.net/viewvc/xbmc/trunk/XBMC/system/players/dvdplayer/ "XBMC/system/players/dvdplayer"] subfolder. The full source code of these libraries can be found under the [http://xbmc.svn.sourceforge.net/viewvc/xbmc/trunk/docs/sources/dvdplayer/ "/docs/sources/dvdplayer/"] subfolder in the SVN. To build these dll's yourself you need to have the following installed, (the .dll's must be then be placed under the "[XBMCFOLDER]/system/players/dvdplayer" subfolder).

* MinGW and MSYS
** see [http://ml20rc.msnfanatic.com/ffmpeg/1.html http://ml20rc.msnfanatic.com/ffmpeg/1.html] for installation for FFmpeg
** use binutils version 2.16.91 (20060119) 1
* unrar

[[Category:Development]]
[[Category:Players]]

Archive:Remap HDMI audio on Gen 1 ION - Linux

2015-11-10T20:32:36Z

Cmayo: /* 14.x Helix */ Add warning that it can cause Kodi to crash

Some early nVidia ION-based motherboards have their HDMI audio channels mapped incorrectly. There are two relatively simple methods to remap HDMI audio at the OS-level on nVidia ION-based systems; which one you use depends on your setup. If you require passthrough, disabling Pulseaudio (if your distribution uses it by default) is necessary to configure ALSA to remap the channels. Configuring Pulseaudio to remap the channels is another option if you don't require passthrough.

It should be noted that whenever editing config files, it's best to backup the original.

== ALSA ==
The following steps require the removal of Pulseaudio if your distribution uses it by default.

HDMI audio output requires several steps to configure properly. My requirements were passthrough, non-passthrough and menu sounds all coming over HDMI to my receiver (fairly common). Some challenges were that the Gen 1 ION had incorrect channel mappings (e.g. Center came out of Left Rear) and menu sounds do not default to HDMI.

I first noticed the audio channels were mis-mapped while watching a movie - all the voices were coming out of the left rear channel, not center. To verify this, I ran the following command:

<pre>speaker-test -D hdmi -c 6</pre>

To correct the output, I created the following channel mapping in ~/.asoundrc or /etc/asound.conf(.asoundrc overrides the default alsa settings per user, while /etc/asound.conf is a global settings override)

=== 11.x Eden with 7.1 speakers ===
==== ALSA Configuration ====
Untested in Frodo.
<pre>
pcm.hdmi-remap {
type route
slave.pcm hdmi
ttable.0.0 1
ttable.1.1 1
ttable.2.4 1
ttable.3.5 1
ttable.4.2 1
ttable.5.3 1
ttable.6.6 1
ttable.7.7 1
}
</pre>

:{{Note|There is intentionally no ''slave.channels'' line in the configuration file since it seems to corrupt the digital stream and prevented proper DTS and DD passthrough to my receiver. If you hear static when using passthrough, this might be the reason why!}}
;To test our new configuration, we can run:

<pre>speaker-test -D hdmi-remap -c 6</pre>

Hopefully the channels will now be mapped correctly.

==== Kodi Configuration ====
Within Settings -> System -> Audio Output, I set the following values:

* Audio Output : '''HDMI'''
* Speaker Configuration : '''7.1'''
* Boost volume level on downmix : '''No'''
* Dolby Digital (AC3) capable receiver : '''Yes'''
* DTS capable receiver : '''Yes'''
* Audio output device : '''Custom'''
* Custom audio device : '''hdmi-remap'''
* Passthrough output device : '''hdmi(ALSA)'''

==== Menu Sounds ====
:{{Note|Not needed in Frodo.}}
To configure menu sounds, I told alsa to use the hdmi-remap device as default. I did this by adding the following section to my ~/.asoundrc file:

<pre>pcm.!default {
type plug
slave.pcm hdmi-remap
}</pre>

=== 12.x Frodo / 13.x Gotham with 5.1 speakers (simple fix) ===
==== ALSA Configuration ====
<pre>
pcm.!default {
type plug
slave {
pcm both
}
}
pcm.both {
type route
slave {
pcm hdmi
}
ttable.0.0 1
ttable.1.1 1
ttable.2.4 1
ttable.3.5 1
ttable.4.2 1
ttable.5.3 1
}
</pre>

;To test our new configuration, we can run:
<pre>speaker-test -D hdmi -c 6</pre>

==== Kodi Configuration ====
Within Settings -> System -> Audio Output, I set the following values:

* Audio Output : '''HDMI'''
* Speaker Configuration : '''5.1'''
* Boost volume level on downmix : '''No'''
* Dolby Digital (AC3) capable receiver : '''Yes'''
* DTS capable receiver : '''Yes'''
* Audio output device : '''HDA NVidia HDMI 0'''
* Passthrough output device : '''HDA NVidia HDMI 0'''

After a reboot, sound should be working as expected. Feel free to update this information as needed.

{{forum link2|[[forum:147733|'''Linux''' Frodo HDMI audio channel remap discussion]]}}

=== 12.x Frodo / 13.x Gotham with 5.1 speakers (including desktop application fix) ===
==== ALSA Configuration ====
The following .asoundrc settings will allow Kodi to use exclusive HDMI passthrough, while defaulting to a dmix plugin for the Kodibuntu desktop mode (so that multiple applications can share HDMI access):

<pre>pcm.hdmi_hw {
type hw
card=0
device=3
}

pcm.hdmi_direct {
type route
slave {
pcm hdmi_hw
}
ttable.0.0 1
ttable.1.1 1
ttable.2.4 1
ttable.3.5 1
ttable.4.2 1
ttable.5.3 1
}

pcm.hdmi_shared {
type route
slave {
pcm hdmi_dmix
}
ttable.0.0 1
ttable.1.1 1
ttable.2.4 1
ttable.3.5 1
ttable.4.2 1
ttable.5.3 1
}

pcm.hdmi_dmix {
type dmix
ipc_key 1024
ipc_key_add_uid false
ipc_perm 0666
slave {
pcm hdmi_hw
}
}

pcm.!default {
type plug
slave.pcm "hdmi_shared"
}</pre>

;Test passthrough mode with:

<pre>speaker-test -D hdmi_direct -c 6</pre>

;And default/shared mode with:

<pre>speaker-test -c 6</pre>

;It may also be worth testing each with -c 2 instead of -c 6 to ensure that 2-channel inputs will work.

==== Kodi Configuration ====
Within Settings -> System -> Audio Output, I set the following values:

* Audio Output : '''HDMI'''
* Speaker Configuration : '''5.1'''
* Boost volume level on downmix : '''No'''
* Dolby Digital (AC3) capable receiver : '''Yes'''
* DTS capable receiver : '''Yes'''
* AAC capable receiver : '''Yes''' ''(note that AAC appears to reach my receiver as 5.1 LPCM, regardless of this setting)''
* MultiChannel LPCM capable receiver : '''Yes'''
* Audio output device : '''HDA NVidia HDMI(hdmi_direct)'''
* Passthrough output device : '''HDA NVidia HDMI(hdmi_direct)''' ''(note that this setting apparently doesn't matter, as Frodo seems to use the "Audio output device" setting for both passthrough and non-passthrough modes when "Audio Output" is set to "HDMI")''

After a reboot, sound should be working as expected in both Kodi and in Kodibuntu desktop applications. Feel free to update this information as needed.

{{forum link2|[[forum:90910|Problem with 5.1 channel mapping, help configuring asound.conf]]}}

=== 14.x Helix ===
It appears that remapping may no longer be necessary in Helix for the benefit of Kodi itself, as Kodi appears to perform the remapping itself in software. If remapping is needed for other Linux apps, it should be possible to still use the Frodo/Gotham .asoundrc above but configure Kodi itself to use an output that is not remapped.

Indeed the remapping can even cause Kodi to crash with AESink recording a segfault in libasound.

== Pulseaudio ==
Some may find that removing Pulseaudio breaks other programs and causes problems. If your setup does not require passthrough and your receiver supports multichannel PCM, you may want to configure Pulseaudio instead. These directions were adapted from [http://askubuntu.com/questions/48406/inverted-surround-channels/142942#142942 here.]

=== Configure Pulseaudio ===
1. Run from the command-line: <pre>speaker-test -c6 -twav</pre>

2. Note which channels need to be remapped, I just wrote them down like so:
<pre> SOUND SPEAKER
Left Front ————-> Left Front
Center Front ————-> Left Rear
Right Front ————-> Right Front
Left Rear ————-> Center Front
Subwoofer (lfe) ————-> Right Rear
Right Rear ————-> Subwoofer (lfe)</pre>

3. Edit "/usr/share/pulseaudio/alsa-mixer/profile-sets/extra-hdmi.conf" with your favorite text editor as root. I'm using xubuntu 12.04, so I'll be using leafpad:
<pre>sudo leafpad /usr/share/pulseaudio/alsa-mixer/profile-sets/extra-hdmi.conf</pre>

4. This file contains the Pulseaudio profiles for your HDMI audio outputs. There should be a few entries that say something about 5.1 or 7.1 audio over HDMI. Like this:
<pre>[Mapping hdmi-surround]
description = Digital Surround 5.1 (HDMI)
device-strings = hdmi:%f
paths-output = hdmi-output-0
channel-map = front-left,front-right,rear-left,rear-right,front-center,lfe
priority = 3
direction = output</pre>

Edit them to fit your needs based on the channel map you wrote down earlier. I edited all of them (except the 7.1 ones, as I only have a 5.1 setup, I would assume things would be similar for 7.1) like so:
<pre>[Mapping hdmi-surround]
description = Digital Surround 5.1 (HDMI)
device-strings = hdmi:%f
paths-output = hdmi-output-0
channel-map = front-left,front-right,front-center,lfe,rear-left,rear-right
priority = 3
direction = output</pre>

5. Restart Pulseaudio to load your new channel maps and run a speaker test:
<pre>pulseaudio -k
pulseaudio --start
speaker-test -c6 -twav</pre>
If everything is coming out of the right channel then you're all set!

=== Configure Kodi ===
Within Settings -> System -> Audio Output, set:

* Audio Output : '''HDMI'''
* Speaker Configuration : '''5.1''' (or 7.1 depeding on your setup)
* Boost volume level on downmix : '''Yes'''
* Dolby Digital (AC3) capable receiver : '''No'''
* DTS capable receiver : '''No'''
* Audio output device : '''defaults(Pulseaudio)'''
* Passthrough output device : '''hdmi(ALSA)''' (won't be used, you can set it to whatever you'd like)

{{note|Pulseaudio and Kodi do not work with passthrough as of Eden (not tested in Frodo, but likely the same). That is why we are telling Kodi the receiver can't decode AC3 and DTS. Theoretically speaking, there is no difference between decoding in software or on your receiver. Some may disagree, however the receiver tells me that it is indeed receiving 5.1 multichannel PCM. Sounds seem to be mapped correctly.}}
Tested with Xubuntu 12.04, Eden, on an ASRock ION330 motherboard

{{forum link2|[[forum:150806|Linux: Remapping Pulseaudio Channels]]}}

{{helix updated}}

[[Category:Audio]]
[[Category:How-to]]
[[Category:Linux]]
[[Category:NVidia]]