Official Kodi Wiki - User contributions [en]

Databases

2024-05-29T15:38:23Z

Prof Yaffle: Update for v21 as current and v21 as next release

{{Template:DatabasesNavBox}}
{{mininav| [[Development]] {{l2| [[Userdata]] }} }}

= Introduction =
<section begin="intro" />Kodi uses [http://www.sqlite.org/ SQLite], an open source light-weight SQL database-engine, to store all the library, add-on, EPG, textures and PVR related data using a number of specific databases.<section end="intro" /> By default, the database files (*.db) are stored in the '''''[[Kodi data folder]]\[[Userdata]]''''' folder, specifically in \Database\.

= Using the Databases =
The databases are automatically maintained by {{Kodi}}. It is recommended that {{kodi}} users do not access the database without good working knowledge of relational databases and SQL.

Database software is required to access the SQL databases. '''[https://sqlitebrowser.org/ DB Browser for SQLite]''' is available for Windows, macOS, Linux and FreeBSD.

= Accessing the Databases with Kodi Python =
Many Python plugins (and some scripts) can use the information in the Kodi database to offer users additional convenience and functionality. The easiest way to access the databases via Kodi Python is using '''[[JSON-RPC API]]'''

= Database Versions =
<section begin="database versions" />The following tables shows what database version is used for various Kodi versions. This can be useful to see what versions of Kodi can use '''[[MySQL]]''' sharing. Note that future release database versions are subject to change during development.

{|class="prettytable"
! Kodi version !! Date !! MyVideos !! MyMusic !! Textures !! Addons !! ViewModes !! TV !! EPG !! ADSP
|-
| style="width:120px;" | v10 - Dharma
| style="width:120px;" | December 2010
| style="width:80px; text-align:center;" | 37
| style="width:80px; text-align:center;" | 7
| style="width:80px; text-align:center;" | 1
| style="width:80px; text-align:center;" | 1
| style="width:80px; text-align:center;" | 1
| style="width:60px; text-align:center;" | N/A
| style="width:60px; text-align:center;" | N/A
| style="width:60px; text-align:center;" | N/A
|-
| style="width:120px;" | v11 - Eden
| style="width:120px;" | March 2012
| style="width:80px; text-align:center;" | 60
| style="width:80px; text-align:center;" | 18
| style="width:80px; text-align:center;" | 6
| style="width:80px; text-align:center;" | 15
| style="width:80px; text-align:center;" | 4
| style="width:60px; text-align:center;" | N/A
| style="width:60px; text-align:center;" | N/A
| style="width:60px; text-align:center;" | N/A
|-
| style="width:120px;" | v12 - Frodo
| style="width:120px;" | January 2013
| style="width:80px; text-align:center;" | 75
| style="width:80px; text-align:center;" | 32
| style="width:80px; text-align:center;" | 13
| style="width:80px; text-align:center;" | 15
| style="width:80px; text-align:center;" | 4
| style="width:60px; text-align:center;" | 22
| style="width:60px; text-align:center;" | 7
| style="width:60px; text-align:center;" | N/A
|-
| style="width:120px;" | v13 - Gotham
| style="width:120px;" | May 2014
| style="width:80px; text-align:center;" | 78
| style="width:80px; text-align:center;" | 46
| style="width:80px; text-align:center;" | 13
| style="width:80px; text-align:center;" | 16
| style="width:80px; text-align:center;" | 6
| style="width:60px; text-align:center;" | 22
| style="width:60px; text-align:center;" | 7
| style="width:60px; text-align:center;" | N/A
|-
| style="width:120px;" | v14 - Helix
| style="width:120px;" | December 2014
| style="width:80px; text-align:center;" | 90
| style="width:80px; text-align:center;" | 48
| style="width:80px; text-align:center;" | 13
| style="width:80px; text-align:center;" | 16
| style="width:80px; text-align:center;" | 6
| style="width:60px; text-align:center;" | 26
| style="width:60px; text-align:center;" | 8
| style="width:60px; text-align:center;" | N/A
|-
| style="width:120px;" | v15 - Isengard
| style="width:120px;" | July 2015
| style="width:80px; text-align:center;" | 93
| style="width:80px; text-align:center;" | 52
| style="width:80px; text-align:center;" | 13
| style="width:80px; text-align:center;" | 19
| style="width:80px; text-align:center;" | 6
| style="width:60px; text-align:center;" | 29
| style="width:60px; text-align:center;" | 10
| style="width:60px; text-align:center;" | N/A
|-
| style="width:120px;" | v16 - Jarvis
| style="width:120px;" | February 2016
| style="width:80px; text-align:center;" | 99
| style="width:80px; text-align:center;" | 56
| style="width:80px; text-align:center;" | 13
| style="width:80px; text-align:center;" | 20
| style="width:80px; text-align:center;" | 6
| style="width:60px; text-align:center;" | 29
| style="width:60px; text-align:center;" | 11
| style="width:60px; text-align:center;" | 0
|-
| style="width:120px;" | v17 - Krypton
| style="width:120px;" | February 2017
| style="width:80px; text-align:center;" | 107
| style="width:80px; text-align:center;" | 60
| style="width:80px; text-align:center;" | 13
| style="width:80px; text-align:center;" | 27
| style="width:80px; text-align:center;" | 6
| style="width:60px; text-align:center;" | 29
| style="width:60px; text-align:center;" | 11
| style="width:60px; text-align:center;" | 0
|-
| style="width:120px;" | v18 - Leia
| style="width:120px;" | January 2019
| style="width:80px; text-align:center;" | 116
| style="width:80px; text-align:center;" | 72
| style="width:80px; text-align:center;" | 13
| style="width:80px; text-align:center;" | 27
| style="width:80px; text-align:center;" | 6
| style="width:60px; text-align:center;" | 32
| style="width:60px; text-align:center;" | 12
| style="width:60px; text-align:center;" | 0
|-
| style="width:120px;" | v19 - Matrix
| style="width:120px;" | December 2020
| style="width:80px; text-align:center;" | 119
| style="width:80px; text-align:center;" | 82
| style="width:80px; text-align:center;" | 13
| style="width:80px; text-align:center;" | 33
| style="width:80px; text-align:center;" | 6
| style="width:60px; text-align:center;" | 38
| style="width:60px; text-align:center;" | 13
| style="width:60px; text-align:center;" | N/A
|-
| style="width:120px;" | v20 - Nexus
| style="width:120px;" | 11 January 2023
| style="width:80px; text-align:center;" | 121
| style="width:80px; text-align:center;" | 82
| style="width:80px; text-align:center;" | 13
| style="width:80px; text-align:center;" | 33
| style="width:80px; text-align:center;" | 6
| style="width:60px; text-align:center;" | 40
| style="width:60px; text-align:center;" | 16
| style="width:60px; text-align:center;" | N/A
|-
| style="width:120px; background: #a0e75a;" | v21 - Omega
| style="width:120px; background: #a0e75a;" | 2 April 2024
| style="width:80px; text-align:center; background: #a0e75a;" | 131
| style="width:80px; text-align:center; background: #a0e75a;" | 83
| style="width:80px; text-align:center; background: #a0e75a;" | 13
| style="width:80px; text-align:center; background: #a0e75a;" | 33
| style="width:80px; text-align:center; background: #a0e75a;" | 6
| style="width:60px; text-align:center; background: #a0e75a;" | 44
| style="width:60px; text-align:center; background: #a0e75a;" | 16
| style="width:60px; text-align:center; background: #a0e75a;" | N/A
|-
| style="width:120px; background: skyBlue;" | v22 - P*
| style="width:120px; background: skyBlue;" | TBD
| style="width:80px; text-align:center; background: skyBlue;" | 132
| style="width:80px; text-align:center; background: skyBlue;" | 83
| style="width:80px; text-align:center; background: skyBlue;" | 13
| style="width:80px; text-align:center; background: skyBlue;" | 33
| style="width:80px; text-align:center; background: skyBlue;" | 6
| style="width:60px; text-align:center; background: skyBlue;" | 44
| style="width:60px; text-align:center; background: skyBlue;" | 16
| style="width:60px; text-align:center; background: skyBlue;" | N/A
|}

{| class="prettytable"
|-
! colspan="2"| Legend
|-
| style="background:#a0e75a;"| Green
| Current release
|-
| style="background:skyBlue;"| Blue
| Future release
|}
<section end="database versions" />

= See also =
* [[Releases]]
* https://github.com/xbmc/xbmc/commits/master/xbmc/video/VideoDatabase.cpp - Tracking the Video Database schema version
* https://github.com/xbmc/xbmc/commits/master/xbmc/music/MusicDatabase.cpp - Tracking the Music Database schema version

{{Top}}
{{updated|22}}

[[Category:PVR]]
[[Category:Add-ons]]
[[Category:Karellen]]
[[Category:Development]]
[[Category:Video library]]
[[Category:Music library]]
[[Category:Skin_development]]

Databases

2023-01-22T10:57:20Z

Prof Yaffle: /* Database Versions */

{{Template:DatabasesNavBox}}
{{mininav| [[Development]] {{l2| [[Userdata]] }} }}

= Introduction =
<section begin="intro" />Kodi uses [http://www.sqlite.org/ SQLite], an open source light-weight SQL database-engine, to store all the library, add-on, EPG, textures and PVR related data using a number of specific databases.<section end="intro" /> By default, the database files (*.db) are stored in the '''''[[Kodi data folder]]\[[Userdata]]''''' folder, specifically in \Database\.

= Using the Databases =
The databases are automatically maintained by {{Kodi}}. It is recommended that {{kodi}} users do not access the database without good working knowledge of relational databases and SQL.

Database software is required to access the SQL databases. '''[https://sqlitebrowser.org/ DB Browser for SQLite]''' is available for Windows, macOS, Linux and FreeBSD.

= Accessing the Databases with Kodi Python =
Many Python plugins (and some scripts) can use the information in the Kodi database to offer users additional convenience and functionality. The easiest way to access the databases via Kodi Python is using '''[[JSON-RPC API]]'''

= Database Versions =
<section begin="database versions" />The following tables shows what database version is used for various Kodi versions. This can be useful to see what versions of Kodi can use '''[[MySQL]]''' sharing.

{|class="prettytable"
! Kodi version !! Date !! MyVideos !! MyMusic !! Textures !! Addons !! ViewModes !! TV !! EPG !! ADSP
|-
| style="width:120px;" | v10 - Dharma
| style="width:120px;" | December 2010
| style="width:80px; text-align:center;" | 37
| style="width:80px; text-align:center;" | 7
| style="width:80px; text-align:center;" | 1
| style="width:80px; text-align:center;" | 1
| style="width:80px; text-align:center;" | 1
| style="width:60px; text-align:center;" | N/A
| style="width:60px; text-align:center;" | N/A
| style="width:60px; text-align:center;" | N/A
|-
| style="width:120px;" | v11 - Eden
| style="width:120px;" | March 2012
| style="width:80px; text-align:center;" | 60
| style="width:80px; text-align:center;" | 18
| style="width:80px; text-align:center;" | 6
| style="width:80px; text-align:center;" | 15
| style="width:80px; text-align:center;" | 4
| style="width:60px; text-align:center;" | N/A
| style="width:60px; text-align:center;" | N/A
| style="width:60px; text-align:center;" | N/A
|-
| style="width:120px;" | v12 - Frodo
| style="width:120px;" | January 2013
| style="width:80px; text-align:center;" | 75
| style="width:80px; text-align:center;" | 32
| style="width:80px; text-align:center;" | 13
| style="width:80px; text-align:center;" | 15
| style="width:80px; text-align:center;" | 4
| style="width:60px; text-align:center;" | 22
| style="width:60px; text-align:center;" | 7
| style="width:60px; text-align:center;" | N/A
|-
| style="width:120px;" | v13 - Gotham
| style="width:120px;" | May 2014
| style="width:80px; text-align:center;" | 78
| style="width:80px; text-align:center;" | 46
| style="width:80px; text-align:center;" | 13
| style="width:80px; text-align:center;" | 16
| style="width:80px; text-align:center;" | 6
| style="width:60px; text-align:center;" | 22
| style="width:60px; text-align:center;" | 7
| style="width:60px; text-align:center;" | N/A
|-
| style="width:120px;" | v14 - Helix
| style="width:120px;" | December 2014
| style="width:80px; text-align:center;" | 90
| style="width:80px; text-align:center;" | 48
| style="width:80px; text-align:center;" | 13
| style="width:80px; text-align:center;" | 16
| style="width:80px; text-align:center;" | 6
| style="width:60px; text-align:center;" | 26
| style="width:60px; text-align:center;" | 8
| style="width:60px; text-align:center;" | N/A
|-
| style="width:120px;" | v15 - Isengard
| style="width:120px;" | July 2015
| style="width:80px; text-align:center;" | 93
| style="width:80px; text-align:center;" | 52
| style="width:80px; text-align:center;" | 13
| style="width:80px; text-align:center;" | 19
| style="width:80px; text-align:center;" | 6
| style="width:60px; text-align:center;" | 29
| style="width:60px; text-align:center;" | 10
| style="width:60px; text-align:center;" | N/A
|-
| style="width:120px;" | v16 - Jarvis
| style="width:120px;" | February 2016
| style="width:80px; text-align:center;" | 99
| style="width:80px; text-align:center;" | 56
| style="width:80px; text-align:center;" | 13
| style="width:80px; text-align:center;" | 20
| style="width:80px; text-align:center;" | 6
| style="width:60px; text-align:center;" | 29
| style="width:60px; text-align:center;" | 11
| style="width:60px; text-align:center;" | 0
|-
| style="width:120px;" | v17 - Krypton
| style="width:120px;" | February 2017
| style="width:80px; text-align:center;" | 107
| style="width:80px; text-align:center;" | 60
| style="width:80px; text-align:center;" | 13
| style="width:80px; text-align:center;" | 27
| style="width:80px; text-align:center;" | 6
| style="width:60px; text-align:center;" | 29
| style="width:60px; text-align:center;" | 11
| style="width:60px; text-align:center;" | 0
|-
| style="width:120px;" | v18 - Leia
| style="width:120px;" | January 2019
| style="width:80px; text-align:center;" | 116
| style="width:80px; text-align:center;" | 72
| style="width:80px; text-align:center;" | 13
| style="width:80px; text-align:center;" | 27
| style="width:80px; text-align:center;" | 6
| style="width:60px; text-align:center;" | 32
| style="width:60px; text-align:center;" | 12
| style="width:60px; text-align:center;" | 0
|-
| style="width:120px;" | v19 - Matrix
| style="width:120px;" | December 2020
| style="width:80px; text-align:center;" | 119
| style="width:80px; text-align:center;" | 82
| style="width:80px; text-align:center;" | 13
| style="width:80px; text-align:center;" | 33
| style="width:80px; text-align:center;" | 6
| style="width:60px; text-align:center;" | 38
| style="width:60px; text-align:center;" | 13
| style="width:60px; text-align:center;" | N/A
|-
| style="width:120px; background: #a0e75a;" | v20 - Nexus
| style="width:120px; background: #a0e75a;" | 11 January 2023
| style="width:80px; text-align:center; background: #a0e75a;" | 121
| style="width:80px; text-align:center; background: #a0e75a;" | 82
| style="width:80px; text-align:center; background: #a0e75a;" | 13
| style="width:80px; text-align:center; background: #a0e75a;" | 33
| style="width:80px; text-align:center; background: #a0e75a;" | 6
| style="width:60px; text-align:center; background: #a0e75a;" | 40
| style="width:60px; text-align:center; background: #a0e75a;" | 16
| style="width:60px; text-align:center; background: #a0e75a;" | N/A
|-
| style="width:120px; background: skyBlue;" | v21 - O*
| style="width:120px; background: skyBlue;" | TBD
| style="width:80px; text-align:center; background: skyBlue;" | TBD
| style="width:80px; text-align:center; background: skyBlue;" | TBD
| style="width:80px; text-align:center; background: skyBlue;" | TBD
| style="width:80px; text-align:center; background: skyBlue;" | TBD
| style="width:80px; text-align:center; background: skyBlue;" | TBD
| style="width:60px; text-align:center; background: skyBlue;" | TBD
| style="width:60px; text-align:center; background: skyBlue;" | TBD
| style="width:60px; text-align:center; background: skyBlue;" | TBD
|}

{| class="prettytable"
|-
! colspan="2"| Legend
|-
| style="background:#a0e75a;"| Green
| Current release
|-
| style="background:skyBlue;"| Blue
| Future release
|}
<section end="database versions" />

= See also =
* [[Releases]]
* https://github.com/xbmc/xbmc/commits/master/xbmc/video/VideoDatabase.cpp - Tracking the Video Database schema version
* https://github.com/xbmc/xbmc/commits/master/xbmc/music/MusicDatabase.cpp - Tracking the Music Database schema version

{{Top}}
{{updated|19}}

[[Category:PVR]]
[[Category:Add-ons]]
[[Category:Karellen]]
[[Category:Development]]
[[Category:Video library]]
[[Category:Music library]]
[[Category:Skin_development]]

Archive:Android FAQ

2016-03-10T21:21:39Z

Prof Yaffle: Spelling corrections - "vendor" vs "vender"

{{Kodi FAQ}}
{{mininav|[[Android]] }}
<section begin="intro" />'''F'''requently '''A'''sked '''Q'''uestions for Android.<section end="intro" />
__TOC__
{{-}}

== General FAQ ==
:{{big|''See also: '''[[Kodi all platforms FAQ]]''' for FAQs that apply to all versions of Kodi.''}}

=== Will this really do 1080p and all that stuff the desktop can do? ===
:* Yes! This is a full port of Kodi! It is not a thin client or lite version!
:* The reason Android port is to get Kodi working on Android set-top-boxes. Phones and tablets are also supported, but are not the main focus.

=== Requirements ===
{{anchor|1=Requirements}}
:{{see also|Android hardware}}
:{{#lst:Supported hardware|Android}}

=== There are two versions of Kodi for Android. Which one do I use? ===
{{anchor|1=CPU}}
:The vast majority of users will want to use the [{{download link|Android ARM}} "ARM" version]. Users who have an Android device with an Intel or AMD CPU will want to use the [{{Download link|Android x86}} "x86" version].

=== Installing/getting Kodi for Android ===
{{anchor|1=Installing}}
{{Main|HOW-TO:Install Kodi for Android}}
:* {{current version}} can be found here:
:** '''ARM''' (most users want this): {{Download link|Android ARM}}
:** '''x86''': {{Download link|Android x86}}
:* For nightlies, alphas, betas and experimental builds, see the links on '''[[Development builds]]'''

=== Is Kodi for Android different from normal Kodi? ===
{{anchor|1=Version}}
: The current version of Kodi for Android is based on {{current version}}, and is based on the same code as Kodi for all the other supported platforms.

{{anchor|1=Current_build}}
=== How do I find out what version of Kodi am I running? ===
: Kodi main menu > System > Lower submenu > System info. '''Note the version and build date.'''

=== Video and audio formats Kodi for Android can playback ===
{{anchor|1=Formats}}
:* Kodi for Android supports all the same formats that other platforms do (such as desktop OS).
:* Due to the weak processing power of most ARM processors, for smooth playback most Android hardware will require proper hardware decoding. (See [[#Requirements]] below)

=== Accessing media ===
{{anchor|1=Media}}
{{See also|Adding videos to the library|File sharing}}
:* You can connect to media that's being shared from a computer, HTPC, or NAS device on your local network.
:* You can access media on the internal memory, SD cards or from USB ports (hard drives, USB stick drives, directly or via hubs, etc).

=== Add-ons and skins ===
{{anchor|1=Add-ons|2=Skins}}
:* Kodi for Android is a full version of Kodi and will be able to use all non-platform specific [[add-ons]] and [[skins]].
:* If you are using a touch screen device and the build you are using did not include it, you can manually instal [[Add-on:Touched]] for better touch screen support.

=== Remote controls ===
{{anchor|1=Remotes}}
:* Some Android set-top-boxes come with a remote and an IR port which Kodi can use.
:* Any '''[[Keyboard]]''' such as wired, wireless, bluetooth (if supported in your Android ROM). This includes "keymotes" such as a Rii, [[Boxee remote]], most "air mouse" keyboard remotes, and others that appear as a normal USB keyboard to the system.
:* '''[[Web interface]]s''', including add-on interfaces.
:* Kodi '''[[:Category:Smartphone and tablet remotes|smartphone and tablet remote apps]]'''.
:* Other IR remotes can be used with IR receivers such as the '''[[Flirc]]'''.
:* Some Android devices support '''[[CEC]]'''

=== Launching Android apps from within Kodi ===
{{anchor|1=Apps}}
:{{main|HOW-TO:Launch Android apps}}
:{{#lst:HOW-TO:Launch Android apps|intro}}

=== Automatically start Kodi ===
{{anchor|1=Startup}}
: You can automatically start Kodi when your Android device boots up using an application such as [https://play.google.com/store/apps/details?id=imoblife.startupmanager Startup Manager (free)]

== Performance tips ==
{{Main|Android#Tips and tricks}}

=== Performance: video buffering, stuttering, choppiness ===
{{anchor|1=Buffering|2=Performance}}
:{{#lst:Android|FAQ Performance notes}}

== Troubleshooting ==
{{see also|Troubleshooting}}

=== Getting more help with Kodi for Android ===
{{anchor|1=Forum|2=IRC}}
:* '''[http://forum.kodi.tv/forumdisplay.php?fid=164 Kodi for Android specific help forum]'''
:* '''[irc://irc.freenode.org/kodi #kodi]''' [[w:IRC|IRC]] chat channel on irc.freenode.org.

=== Where is the Userdata folder ===
{{anchor|1=Userdata}}
:The userdata folder is located on external storage/sdcard at the following locations (depending on your device):
:;[[userdata folder]]
:* <code>{{userdata|Android}}</code>

=== Where is the Kodi log ===
{{anchor|1=Kodi log}}
:The Kodi log is located inside the temp folder, i.e.
:;[[debug log]]
:* /sdcard/Android/data/org.xbmc.kodi/files/.kodi/temp/kodi.log

=== How can I obtain a Minidump ===
{{anchor|1=minidump}}
:The Kodi minidumps are located inside the temp folder, i.e.
:* /sdcard/Android/data/org.xbmc.kodi/files/.kodi/temp/*.dmp

=== How can I obtain a Crash Log (logcat) ===
{{anchor|1=logcat}}
:A crash log (also called logcat) is mandatory to be able todebug hard crashes on Android
:* Download the '''[https://play.google.com/store/apps/details?id=org.l6n.sendlog SendLog app]''' from the Google Play store. It allows you to send your system log to an email address. Email it to yourself and show us where the error happened. '''(requires root)'''
:* Alternatively, you can use your computer. Plug your device, download and unzip the [http://d.android.com/sdk/index.html Android SDK] and run ddms.bat in the tools folder. There you have it under ''LogCat''.
:* The logfile is kept on a phone for a while, so you don't need to reproduce a crash in order to get the log.
:* Be sure to have hidden folders set to be shown in your file explorer.

=== How to hide the Android navigation bar ===
{{anchor|1=navbar}}
:* As of v13, Kodi supports Android 4.4 (Kitkat)'s immersive mode, allowing for fullscreen automatically.
:* '''To remove the navbar:'''
:** You can use "[http://ppareit.github.com/HideBar/ HideBar]" (Has a free version, and is open source if you wish to compile yourself)
:** The app "[https://play.google.com/store/apps/details?id=de.tsorn.FullScreen Full!Screen]" is free and should also work.
:** A custom Android distribution can be installed to correctly handle the navbar. [http://replicant.us/ Replicant], [http://www.cyanogenmod.org/ CyanogenMod] and some others offer an “extended desktop” mode which hides the navigation bar and, optionally, the status bar too. Also check for firmware on sites such as http://freaktab.com for more firmware options.

=== Audio sync/delay issues ===
{{anchor|1=audio_sync}}
:Is some or all of your audio out of sync with the video? Try these tips:
:* Check for firmware updates for your specific Android device.
:* If you have a delay that is consistent regardless of the file, you can manually adjust the delay:
:*# Open any video that has audio playing.
:*# Bring up the '''[[Video playback#On screen display (OSD)|on-screen-display]]''' and select the [[Video playback#OSD audio and subtitle settings|audio options]].
:*# Select '''[[Video playback#OSD audio and subtitle settings|Audio offset]]''' and then adjust the audio until the delay is corrected.
:*# Back in the OSD audio settings, scroll down and select '''Set as default for all videos'''.
:* {{editor note|Sometimes things can be corrected by just not using audio passthrough, but either some people don't want to do that at all, or they don't know exactly what that is. We probably need a guide about audio sync in general (not just Android), and add that to our general '''[[audio]]''' help pages.}}

{{anchor|no_video}}
=== Amlogic playback issues (zoomed in, 1/4 screen, no video, etc) ===
* As of v15 and later, Kodi will no longer ask to fix incorrect video decoding permissions on Amlogic-based devices that have incorrectly configured firmware. This might cause an issue in some situations, and if this happens to you, first try to manually disable '''amcodec''' and only use '''mediacodec''' and '''libstagefright''' under {{highlight|bordered=yes| [[Settings/Videos#Acceleration|Settings -> Videos -> Acceleration]] }}. If videos still won't play correctly then the device might a firmware/OS update for things to work properly.

* In some cases video playback is fine, but incorrectly sized so that it only takes up a small portion of the screen. This again is most likely a firmware issue, but a temp workaround would be to go into Android's system settings (not Kodi's settings) and change the GUI resolution to 720 and/or disable "auto select". Video will still render at 1080, and only the GUI is limited to 720.

* There may also be situations were Kodi isn't correctly detecting the box's ability to use the "amcodec", and thus prematurely disabling it. Our devs are currently looking into this situation, and if true, will attempt to fix it.

:;Why was this changed?
::Kodi doesn't try to manually fix the permissions anymore. Doing so was a hack that the devs didn't feel comfortable with, and vendors need to fix this on the firmware level, not the application level. Some hardware vendors are still unwilling to set the necessary permissions because of a misconception on "security", which ironically requires granting apps root-level access, which is far less secure.

::However, the mediacodec "path" to decoding doesn't require the permissions changes, and mediacodec support has improved both in Kodi and in most firmware (even in some of the flawed ones). So now when amcodec fails it falls back on mediacodec, which normally works. In that sense it is "fixed". Eventually mediacodec will be the single standard, and there won't be a need for amcodec, but the option is still there for some special situations.

=== Videos play, but are not always smooth ===
{{anchor|1=rough_playback}}
:There are a number of reasons why this can happen, so it's hard to give general advice for such a description, but here are some things that you can try:
:* Some Android hardware has bugs using the "MediaCodec" hardware decoding method, but plays video fine using "libstagefright". Try turning off "MediaCodec" and leaving "libstageright" on in: {{highlight|bordered=yes|[[Settings/Videos#Acceleration|Settings -> Videos -> Acceleration]]}}. Users of [[Android hardware|AMLogic hardware]] can ignore this, as those devices use a third "AmCodec" hardware decoding method.
:* Hardware video decoding might not be enabled at all on your device. Most Android boxes will require hardware video decoding for smooth HD video playback. Check settings under {{highlight|bordered=yes|[[Settings/Videos#Acceleration|Settings -> Videos -> Acceleration]]}}
:* Most Android boxes don't support hardware video decoding of some codecs, such as VC-1, Hi10P, and HEVC(H.265). Consult the compatibility list on '''[[Android hardware]]'''.
:* Rule out network performance by loading a small test video directly to the internal memory of your Android device.

=== Downloading Kodi results in a .txt or .zip file instead of a .apk file ===
:* Some web browsers will rename .apk files for some reason. To fix this you simply need to rename the file back to .apk and it should then work to install Kodi. To rename files you can use a file manager/explorer program.

{{Helix updated}}

[[Category:Manual]]
[[Category:FAQ|Android]]
[[Category:Android|*]]
[[Category:Troubleshooting]]

MySQL/Setting up MySQL

2015-12-28T11:40:15Z

Prof Yaffle: Grammar on bind-address stuff, mostly

{{:MySQL/Contents}}
{{mininav| [[MySQL]] }}
You'll need to choose which of your computers, Kodi devices, or [[NAS]] will be the MySQL server. The server needs to be on 24/7 or have wake-on-lan (preferably the former), and needs to have a local static IP. You will probably want the Kodi device that is hosting most or all of your videos and music to also be the MySQL server, but this is not required.
{{-}}

{{redv|'''Please Note:'''| Don't create the MySQL databases on your server'''. Simply set up the MySQL server itself, as Kodi will create the specific databases by itself.}}

MySQL can be installed on just about every major OS:

=Ubuntu Linux=
'''Ubuntu Linux:'''
#<code>$sudo apt-get install mysql-server</code> ''(see also: https://help.ubuntu.com/10.04/serverguide/C/mysql.html )''
#Create a password when asked
#To configure MySQL to listen for connections from network hosts, edit ''/etc/mysql/my.cnf'' and change the bind-address directive to the server's IP address:
##from: <code>bind-address = 127.0.0.1</code>
##to: <code>bind-address = 192.168.0.5</code>
#*Note: Replace 192.168.0.5 with the appropriate address.
#*Note: To allow both local and remote access (i.e. from both the MySQL host to itself and also from other clients), either comment out the bind-address using a hash (#) to disable it, or use <code>bind-address = 0.0.0.0</code> to open it completely.
#Restart your MySQL server. <code>$sudo restart mysql</code>
#Get into the MySQL command line utility: <code>$mysql -u root -p</code>
#Enter the following commands:
##Type in: <code>CREATE USER 'kodi' IDENTIFIED BY 'kodi';</code> and press return
##Type in: <code>GRANT ALL ON *.* TO 'kodi';</code> and press return
##Type in: <code>flush privileges;</code> and press return
#Close out the command line tool with <code>\q</code>

=Arch Linux=
'''Arch Linux:'''
*Please note: Arch, along with many other distributions, has migrated to the faster and more open MariaDB. It is a drop in replacement to MySQL and, thus, Kodi will require no modifications to work with it.
#Install MariaDB: <code>$ sudo pacman -S mariadb</code>
#Start the service: <code>$ sudo systemctl start mysqld</code>
#To have it automatically launch at startup: <code>$ sudo systemctl enable mysqld</code>
#Create a password: <code>$ /usr/bin/mysql_secure_installation</code> ''This will also clean up the demo database.''
#Get into the MariaDB command line utility: <code>$ mysql -u root -p</code>
#Enter the following commands:
##Type in: <code>CREATE USER 'kodi' IDENTIFIED BY 'kodi';</code> and press return
##Type in: <code>GRANT ALL ON *.* TO 'kodi';</code> and press return
##Type in: <code>flush privileges;</code> and press return
#Close out the command line tool with <code>\q</code>

=RedHat based Linux=
'''RedHat based Linux (RHEL, CentOS, Fedora):'''
#<code>$sudo yum install mysql-server</code>
#Create a password when asked
#To configure MySQL to listen for connections only from network hosts, edit ''/etc/mysql/my.cnf'' and add the bind-address directive to the server's IP address: <code>bind-address = 192.168.0.5</code>
#*Note: Replace 192.168.0.5 with the appropriate address.
#*Note: Alternatively you can leave this file as is to allow local and remote access.
#Restart your MySQL server. <code>$sudo /sbin/service mysqld restart</code>
#*Recommended - Set your MySQL root password with <code>/usr/bin/mysqladmin -u root password 'new-password'</code>
#Get into the MySQL command line utility: <code>$mysql -u root -p</code>
#*Enter your MySQL root password as set above, or just press enter if you didn't set one to log in with a blank password
#Enter the following commands:
##Type in: <code>CREATE USER 'kodi' IDENTIFIED BY 'kodi';</code> and press return
##Type in: <code>GRANT ALL ON *.* TO 'kodi';</code> and press return
##Type in: <code>flush privileges;</code> and press return
#Close out the command line tool with <code>\q</code>

=Mac OS X=
'''Mac OS X:'''
#Download a copy of MySQL server from http://dev.mysql.com/downloads/mysql/
#In Mac OS X, go to System Preferences -> MySQL, and click on “Start MySQL Server”. You’ll also want to tick to enable the “Automatically … on Startup” option.
#Now to set up the "kodi" user in MySQL and give it access. Launch Terminal.app on your Mac and issue the following commands, one line at a time:
##<code>sudo /usr/local/mysql/bin/mysql</code>
##<code>CREATE USER 'kodi' IDENTIFIED BY 'kodi';</code>
##<code>GRANT ALL ON *.* TO 'kodi';</code>
##<code>exit</code>
#Remain in Terminal.app. Now you'll be giving other computers on your network access to MySQL. Enter the next set of commands, one line at a time:
##<code>cd /usr/local/mysql/support-files/</code>
##<code>sudo cp my-huge.cnf /etc/my.cnf</code>
##:''The command line will ask for your Mac OS X user password. Enter it and press return. No text will show when you type your password in, this is normal.
##<code>cd /etc</code>
##<code>sudo nano my.cnf</code>
##:''This opens a file in a command line text editor''
##Scroll down to the [mysqld] section and add or edit the following line so that it appears as:
##:<code>bind-address = ***.***.***.***</code>
##Save and exit from the command line text editor
#Reboot the Mac, or restart the MySQL service from the System Preferences pane you installed earlier

*Alternative guide for Mac OS X: http://forum.kodi.tv/showthread.php?tid=151631

=Windows=
== Installing MySQL on Windows ==
If you have chocolatey installed run '''choco install mysql'''
:'''or'''
#Download a copy of MySQL server from http://dev.mysql.com/downloads/mysql/ (Grab version 5.5.42, there are issues with newer versions)
#Select ''Server only''
#Create a password when asked
#Select that you want the database to have network access when prompted during installation.

If you're using a firewall such as the one that's built into Windows, you will need to follow the steps below for the version of windows you installed Kodi on.
=== Windows 7/8/8.1 Built-in Firewall ===
: Run the following command in powershell or execute all the steps below.
:::<syntaxhighlight lang="text" enclose="div">
New-NetFirewallRule -DisplayName "Allow inbound TCP Port 3306 for MySQL" -Direction inbound –LocalPort 3306 -Protocol TCP -Action Allow
</syntaxhighlight>
:#Go to control panel and open Windows Firewall
:#Click on Advanced Settings
:#Click on Inbound Rules, then New Rule
:#For the Rule Type, choose '''''Port''''' and hit Next
:#For Protocol and Ports, select TCP protocol and type in '''''3306''''' for the '''''Specific local ports''''' and hit Next
:#For Action, leave it at default which is '''''Allow the connection''''' and hit Next
:#For Profile, you can leave it as default (everything checked by default) and hit Next
:#For Name, set it to '''''MySQL''''' or any name that you will know what it is and click Finished

=== Windows XP Built-in Firewall ===
:#Open Control Panel and Set to 'Classic View'
:#Double Click on Windows Firewall
:#Click on tab that says Exceptions
:#Click on Add Port
:#Name it '''''MySQL''''' or any other name
:#Set the port number to '''3306'''
:#Choose '''''TCP''''' and click OK

== Setup users in MySQL for Kodi clients ==

#Open the "MySQL Command Line Client" from the MySQL start menu
#Enter the following commands:
##Type in: <code>CREATE USER 'kodi' IDENTIFIED BY 'kodi';</code> and press return
##Type in: <code>GRANT ALL ON *.* TO 'kodi';</code> and press return
#Close out the command line tool

{{Note|If Kodi is unable to connect to the MySQL server, returning an error code [1130]:}} 
If this occurs to you, try amending Step 2 above to read <code>GRANT ALL ON *.* TO 'kodi'@'xxx.xxx.xxx.%';</code> where xxx.xxx.xxx is the first three quadrants of your home network's IP address (192.168.1 for example) and % as the last quadrant to allow addresses on the same subnet to connect.

=Other NAS=
MySQL can also be installed on some [[w:network-attached storage|network-attached storage (NAS)]] device devices. Here are some guides for various NAS devices that can have a MySQL server installed:

*Devices running Arch Linux ARM (such as the PogoPlug, Dockstar, etc) can use the [[HOW-TO:Share libraries using MySQL/Setting up MySQL/ALARM|Arch Linux instructions]] on this page.
*[http://quixventure.com/2011/12/configure-a-synology-nas-as-mysql-server-for-xbmc/ Synology NAS as MySQL server for XBMC] and http://youtu.be/3PmmDtK65ks
*http://www.robvanhamersveld.nl/2013/02/05/share-your-xbmc-12-0-library-on-a-synology-ds-or-other-nas/ Synology DS with MySQL guide based on Frodo
*http://forum.kodi.tv/showthread.php?tid=172548 - unRAID

=FreeNAS and freeBSD=

== About FreeNAS ==

http://www.freenas.org/

FreeNAS is a FreeBSD based NAS system that can be run on almost any hardware - it uses ZFS for disk and file management. It is used at home and in enterprise businesses. 99% of tasks can be done via the web interface.

Example below is based on FreeNAS 9.1.1 on 12/12/13, and assumes you have already configured your nas with drives, datasets etc

== How to ==

=== Make a jail ===

create a Jail via the FreeNAS webui - if unsure see here http://doc.freenas.org/index.php/Adding_Jails

make a note of the jail IP address shown - you will need this to put in the advancedsettings.xml file on the Kodi machine later

=== Prepare the jail ===

*ssh into FreeNAS
**If you have a windows PC use putty (http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html)
**(easiest) click the "shell" button in the left of the FreeNAS webui

type the following commands

*<code>jls</code>

Take note of the JID of the jail you created, use it in the command below and replace n with the number of the jail you just created

*<code>jexec n csh</code>

=== Install mysql ===
You are now inside your jail

*<code>pkg install mysql55-server</code>

*<code>pkg install nano</code>
**(nano is a text editor you will need shortly)

We now need to enable mysql in rc.conf

*<code>nano /etc/rc.conf</code>

insert the line below into the rc.conf file

*<code>mysql_enable="YES"</code>

save the file and exit (see bottom of nano edit page for keystrokes info)

*<code>service mysql-server start</code>

Optional step below - this is an automated script that will secure you mysql instance - it will prompt you for answers to questions. Its up to you if you do this.

*<code>mysql_secure_installation</code>

=== Configure mysql ready for Kodi to use ===

type in

*<code>mysql -u root -p</code>

You are now in mysql administration

* <code>CREATE USER 'kodi' IDENTIFIED BY 'kodi';</code>
* <code>GRANT ALL ON *.* TO 'kodi';</code>
* <code>flush privileges;</code>
* <code>quit;</code>

=Restricting MySQL access rights=
'''Optional:''' '''If you only use the MySQL server for Kodi and that server has non-critical data on it, then this probably not necessary.'''
For a more secure MySQL installation use these 2 commands to grant permission only to databases Kodi uses. This is useful if you plan on using your MySQL server for more than just Kodi, or if you're worried about your internal network being exposed and wanting to lock things down more, etc.
#<code>GRANT ALL ON `MyMusic%`.* TO 'kodi'@'%' IDENTIFIED BY 'kodi';</code>
#<code>GRANT ALL ON `MyVideos%`.* TO 'kodi'@'%' IDENTIFIED BY 'kodi';</code>

{{Divbox|orange||
The limited grants on this page don't give the kodi user permissions to create required TRIGGERs during install or upgrade.
'''Kodi requires these TRIGGERs to function properly.'''
Use the broader grant *.* statement that is explained on the previous tabs while creating or upgrading the tables. Only restrict rights afterwards, if you need to.

Alternatively, figure out how to specifically give the account the right to create the require TRIGGERS - this varies between MySQL versions. }}
<headertabs />

{{Next|[[MySQL/Setting up Kodi|Setting up Kodi]]}}

{{Isengard updated}}

Databases

2015-12-16T13:52:33Z

Prof Yaffle: /* bookmark */

{{mininav| [[Development]] {{l2| [[userdata folder]] }} }}
{{see also|Databases/Versions}}

<section begin="intro" />Kodi uses [http://www.sqlite.org/ SQLite], an open source light-weight SQL database-engine, to store all its library related data ([[Music Library|Music]], [[Video Library|Video]], and Program databases). By default, the database files (*.db) are stored in [[The UserData Folder]], specifically in userdata/Database.

In addition to indexing media files when activated by user-selected Content settings, Kodi also puts a video in its database if you change any OSD setting while watching it. Resume points are stored in this database as well. These entries are added to the database whether the affected video is part of the Video Library or not.<section end="intro" />

== Using the Databases ==
Databasess are automatically maintained whenever you use Kodi. You can activate the most powerful database functionality by setting the Content property on all of your media sources, and using Kodi Library Mode. This view mode allows you to browse your media based on the details available in the databases, rather than using simple folder and filenames for details. You can read more about Library Mode for [[Music Library|Music]] and [[Video Library|Video]] files on their respective pages.

Since Kodi maintains the databases on its own, the only time a developer really needs to access the databases is for display information. The following sections discuss how you can access the information contained in Kodi's databases, and give some brief examples of how to use it.

=== Building SQL Queries ===
SQLite queries can be incredibly powerful (and extraordinarily complicated). If you are not already familiar with SQL syntax, it would probably be a good idea to check out a general tutorial, such as [http://www.1keydata.com/sql/sql.html this one].

For most Kodi development projects, you're going to be doing select statements. "Select" is a SQL command used to gather data (in the form of "rows") out of a SQL database. Your select statement will include:

* A list of all the data fields (columns in the database table) you want for each row.
* A list of all the tables you need to get information from
* A list of comparisons used to narrow down your results. This last component is optional, but it makes sure your results are relevant and is often used to link database entries across multiple tables.

Below are a few sample select statements, so you can see how it works.

This query grabs all of the information for every movie in the Video Library.
<pre><nowiki>select * from movie</nowiki></pre>
Note that "*" is used to indicate all fields. Also,there is no "where" clause in this statement, so it returns every row in the table.

This query narrows down the results to just those movies released in 2007.
<pre><nowiki>select * from movie where c07 = 2007</nowiki></pre>
Note that the column containing the movie's release year is labelled simply "c07." The tables further down this page help you find out which columns contain the information you're looking for.

This query example is more semantic. Lists your movies including, in this order, internal ID, internal file ID, rating, movie year, IMDB ID, movie name and movie plot.
<pre><nowiki>select idMovie,idFile,c05,c07,c09,c00,c03,c02 from movie;</nowiki></pre>

Now the following query is a bit more complex because it joins 3 movie-related tables (movie, files and path) to list a single useful view of your movies. In human language it lists movie ID, movie year, IMDB rating, IMDB ID, movie name and full path of the movie file, ordered by IMDB rating with highest rating appearing first:
<pre><nowiki> select idMovie,c07,c05,c09,c00,path.strPath||files.strFilename from movie, files,path where movie.idFile=files.idFile and files.idPath=path.idPath order by c05 desc;</nowiki></pre>

You could also use less than or greater than symbols to get newer or older movies.

This query gets just the path and filename of all of the video files from season two of Chuck.
<pre><nowiki></nowiki></pre>
If you're not familiar with SQL queries, this query probably looks pretty complicated. It serves as a good demonstration of why there are so many tables in the list below, and how to use them. Many of the elements of a TV show's path and filename and used repeatedly, so SQL allows us to save space and speed up our searches by storing each of those elements just once, in one place, and referencing them repeatedly by the same ID.

In this case, the root path that contains your video files is a long string that repeats at the beginning of many files. The name of a TV series, too, is repeated in every single episode of that series, so it makes the most sense to save the series name once (along with all information relevant to the series). We do that in the table tvshow, and every episode of the TV show can access all of that information using just the TV show's ID.

=== Accessing the Databases with Kodi Python ===
Many Python plugins (and some scripts) can use the information in the Kodi database to offer users additional convenience and functionality. The easiest way to access the databases via Kodi Python is using [[JSON RPC]]

== The Music Library ==
This database contains all information concerning music files that you've added to the Music Library. It is used in the Music portion of Kodi. The following information is for version 32.

The music database is stored in userdata/Database/MyMusicXX.db, where XX is the version number.

=== Views ===
Views are standard queries, often long or complicated queries saved in the database for convenience. The views below allow you to easily access all the information about songs and albums in the Music Library, across all the linking tables.

==== albumview ====
A view that joins album to artist, genre, thumb, and albuminfo.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idAlbum || integer || ID from Album Table
|-
|strAlbum || varchar(256) || Album Name
|-
|strArtists || text || Album Artists
|-
|strGenres || text || Album Genres
|-
|iYear || integer || Album Release Year
|-
|idAlbumInfo || integer || ID from AlbumInfo Table
|-
|strMoods || integer || Album Moods
|-
|strStyles || text || Album Styles
|-
|strReview || text || Album Review
|-
|strLabel || text || Album Label
|-
|strType || text || Album Type
|-
|strImage || text || URL for Album Image
|-
|iRating || integer || Album Rating
|-
|bCompilation || integer || [unknown]
|-
|iTimesPlayed || integer || # of Times Played
|}

==== artistview ====
A view that joins artist to artistinfo.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idArtist || integer || ID from Artist Table
|-
|strArtist || varchar(256) || Artist Name
|-
|strBorn || text || Artist Birthday
|-
|strFormed || text || Band Formation Date
|-
|strGenres || text || Artist Genres
|-
|strMoods || text || Artist Moods
|-
|strStyles || text || Artist Styles
|-
|strInstruments || text || Artist Instruments
|-
|strBiography || text || Artist Biography
|-
|strDied || text || Artist Date Died
|-
|strDisbanded || text || Band Disbanded Date
|-
|strYearsActive || text || Years Artist is Active
|-
|strImage || text || URL of Artist Image
|-
|strFanart || text || URL of Fanart
|}

==== songview ====
A view that joins song to album, path, artist, genre, thumb, and karaokedata.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idSong || integer || ID from Song Table
|-
|strArtists || text || Song Artists
|-
|strGenres || text || Song Genres
|-
|strTitle || varchar(512) || Song Title
|-
|iTrack || integer || Song Track Number
|-
|iDuration || integer || Song Duration in seconds
|-
|iYear || integer || Song's Release Year
|-
|dwFileNameCRC || text || [unknown]
|-
|strMusicBrainzTrackID || text || Song's MusicBrainz Track ID
|-
|strMusicBrainzArtistID || text || Song's MusicBrainz Artist ID
|-
|strMusicBrainzAlbumID || text || Song's MusicBrainz Album ID
|-
|strMusicBrainzAlbumArtistID || text || Song's MusicBrainz Album Artist ID
|-
|strMusicBrainzTRMID || text || [unknown]
|-
|iTimesPlayed || integer || # of Times Played
|-
|iStartOffset || integer || [unknown]
|-
|iEndOffset || integer || [unknown]
|-
|idThumb || integer || [unknown]
|-
|lastplayed || varchar(20) || Date & Time Last Played
|-
|rating || char || Song Rating
|-
|comment || text || Song Comment
|-
|idAlbum || integer || ID from Album Table
|-
|strAlbum || varchar(256) || Album Name
|-
|strPath || varchar(512) || Media Path
|-
|iKaraNumber || integer || [unknown]
|-
|iKaraDelay || integer || [unknown]
|-
|strKaraEncoding || text || [unknown]
|-
|bCompilation || integer || [unknown]
|-
|strAlbumArtists || text || Album Artists
|}

=== Tables ===

==== album ====
This table contains basic album information.

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idAlbum || integer || Primary Key
|-
|strAlbum || varchar(256) || Album Name
|-
|strArtists || text|| Artist Name
|-
|strGenres || text || Album Genre
|-
|iYear || integer || Album Year
|-
|idThumb || integer || Foreign key to [[Databases#thumb(music)|thumb table]]
|-
|bCompilation || integer || [unknown]
|}

==== album_artist ====
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idArtist || integer || Primary Key
|-
|idAlbum || integre || Foreign key to [[Databases#album|album table]]
|-
|boolFeatured || integer || [unknown]
|-
|iOrder || integer || [unknown]
|}

==== album_genre ====
This links albums with their genres.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idGenre || integer || Foreign key to [[Databases#genre(music)|genre(music) table]]
|-
|idAlbum || integer || Foreign key to [[Databases#album|album table]]
|-
|iOrder || integer || [unknown]
|}

==== albuminfo ====
This table contains additional information about an album, such as Rating, Moods, Styles, Reviews, Image URL, and type.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idAlbumInfo || integer || Primary Key
|-
|idAlbum || integer || Foreign key to [[Databases#album|album table]]
|-
|iYear || integer || Album Year
|-
|strMoods || text || Album Moods
|-
|strStyles || text || Album Styles
|-
|strThemes || text || Album Themes
|-
|strReview || text || Album Review
|-
|strImage || text || URL of Album Image
|-
|strLabel || text || Album Label
|-
|strType || text || Album Type
|-
|iRating || integer || Album Rating
|}

==== albuminfosong ====
This table links songs to albums and stores the duration of each track.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idAlbumInfoSong || integer || Primary Key
|-
|idAlbumInfo || integer || Foreign key to [[Databases#albuminfo|albuminfo table]]
|-
|iTrack || integer || Track #
|-
|strTitle || text || Song Title
|-
|iDuration || integer || Song Duration in seconds
|}

==== art ====
{|class="prettytable"
! Column Name || Data Type || Description
|-
|art_id || integer || Primary Key
|-
|media_id || integer || [unknown]
|-
|media_type || text || [unknown]
|-
|type || text || [unknown]
|-
|url || text || [unknown]
|}

==== artist ====
This table stores the name of each artist.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idArtist || integer || Primary Key
|-
|strArtist || varchar(256) || Artist Name
|}

==== artistinfo ====
This table stores relevant information about each artist, such as when they were born, Fan Art URL's, biographical information, etc.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idArtistInfo || integer || Primary Key
|-
|idArtist || integer || Foreign key to [[Databases#artist|artist table]]
|-
|strBorn || text || Artist Birthday
|-
|strFormed || text || Band Formation Date
|-
|strGenres || text || Artist Genres
|-
|strMoods || text || Artist Moods
|-
|strStyles || text || Artist Styles
|-
|strInstruments || text || Artist's Instruments
|-
|strBiography || text || Artist's Biography
|-
|strDied || text || Artist Date Died
|-
|strDisbanded || text || Band Disbanded Date
|-
|strYearsActive || text || Years Artist is Active
|-
|strImage || text || URL of Artist Image
|-
|strFanart || text || URL of Fanart
|}

==== content ====
This table is related to the scraper.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|strPath || text || [unknown]
|-
|strScraperPath || text || [unknown]
|-
|strContent || text || [unknown]
|-
|strSettings || text || [unknown]
|}

==== discography ====
Links albums to artists with the year produced.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idArtist || integer || Foreign key to [[Databases#artist|artist table]]
|-
|strAlbum || text || Album Name
|-
|strYear || text || Year Album Produced.
|}

==== exartistablum ====
Links artists to albums

==== exartistsong ====
Links artists to songs

==== exgenrealbum ====
Links genres to albums

==== exgenresong ====
Links genres to songs

==== genre(music) ====
This table contains genre titles.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idGenre || integer || Primary Key
|-
|strGenre || varchar(256) || Genre Name
|}

==== karaokedata ====
This table contains karaoke specific information for certain songs
{|class="prettytable"
! Column Name || Data Type || Description
|-
|iKaraNumber || integer || [unknown]
|-
|idSong || integer || Foreign key to [[Databases#song|song table]]
|-
|iKaraDelay || integer || [unknown]
|-
|strKaraEncoding || text || [unknown]
|-
|strKaralyrics || text || [unknown]
|-
|strKaraLyFileCRC || text || [unknown]
|}

==== path(music) ====
This table contains paths and hashes of files in the Music Database.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idPath || integer || Primary Key
|-
|strPath || varchar(512) || Media Paths
|-
|strHash || text || [unknown]
|}

==== song ====
This table contains song information such as Name, Track Title, MusicBrainz information, times played, last played, rating, etc.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idSong || integer || Primary Key
|-
|idAlbum || integer || Foreign key to [[Databases#album|album table]]
|-
|idPath || integer || Foreign key to [[Databases#path|path table]]
|-
|strArtists || text || Song Artists
|-
|strGenres || text || Song Genres
|-
|strTitle || varchar(512) || Song Title
|-
|iTrack || integer || Song Track Number
|-
|iDuration || integer || Song Duration in seconds
|-
|iYear || integer || Song's Release Year
|-
|dwFileNameCRC || text || [unknown]
|-
|strMusicBrainzTrackID || text || Song's MusicBrainz Track ID
|-
|strMusicBrainzArtistID || text || Song's MusicBrainz Artist ID
|-
|strMusicBrainzAlbumID || text || Song's MusicBrainz Album ID
|-
|strMusicBrainzAlbumArtistID || text || Song's MusicBrainz Album Artist ID
|-
|strMusicBrainzTRMID || text || [unknown]
|-
|iTimesPlayed || integer || # of Times Played
|-
|iStartOffset || integer || [unknown]
|-
|iEndOffset || integer || [unknown]
|-
|idThumb || integer || Foreign key to [[Databases#thumb|thumb table]]
|-
|lastplayed || varchar(20) || Date & Time Last Played
|-
|rating || char || Song Rating
|-
|comment || text || Song Comment
|}

==== song_artist ====
This table links songs to artists.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idArtist || integer || Foreign key to [[Databases#artist|artist table]]
|-
|idSong || integer || Foreign key to [[Databases#song|song table]]
|-
|boolFeatured || integer || Is Artist Featured on song?
|-
|iOrder || integer || [unknown]
|}

==== song_genre ====
This table links the songs with their genre.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idGenre || integer || Foreign key to [[Databases#genre(music)|genre(music) table]]
|-
|idSong || integer || Foreign key to [[Databases#song|song table]]
|-
|iOrder || integer || [unknown]
|}

==== thumb ====
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idThumb || integer || Primary Key
|-
|strThumb || text || [unknown]
|}

==== version(music) ====
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idVersion || integer || Version of the music database
|-
|idCompressCount || integer || Number of times database has been compressed
|}

== The Video Library ==
This database contains all information concerning TV shows, movies, and music videos. It is used in the Videos portion of Kodi. The following information is for version 75.

The video database is stored in userdata/Database/MyVideosXX.db, where XX is the version number.

=== Views ===
Views are standard queries, often long or complicated queries saved in the database for convenience. The views below allow you to easily access all the information about each of the main media types in the Video Library, across all the linking tables.

==== episodeview ====
A view that joins episode to file and tvshow (through tvshowlinkepisode) and path.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idEpisode || integer || Primary Key
|-
|idFile || integer || Foreign key to the [[Databases#files|files table]]
|-
|c00 || text || Episode Title
|-
|c01 || text || Plot Summary
|-
|c02 || text || [unknown - listed as Votes]
|-
|c03 || text || Rating
|-
|c04 || text || Writer
|-
|c05 || text || First Aired
|-
|c06 || text || Thumbnail URL
|-
|c07 || text || [unknown - listed as Thumbnail URL Spoof, unused?]
|-
|c08 || text || Has the episode been watched? (unused?)
|-
|c09 || text || Episode length in minutes
|-
|c10 || text || Director
|-
|c11 || text || [unknown - listed as Indentifier]
|-
|c12 || text || Season Number
|-
|c13 || text || Episode Number
|-
|c14 || text || [unknown - listed as Original Title, unused?]
|-
|c15 || text || Season formatted for sorting
|-
|c16 || text || Episode formatted for sorting
|-
|c17 || text || Bookmark
|-
|c18 || text || Not used
|-
|c19 || text || Not used
|-
|c20 || text || Not used
|-
|idShow || integer || Foreign key to the [[Databases#tvshow|tvshow table]]
|-
|strFileName || text || Full name of file including extension
|-
|strPath || text || Path URL
|-
|playCount || integer || # of Times Played
|-
|lastPlayed || text || Date & Time Last Played
|-
|dateAdded || text || Date & Time Added to Library
|-
|strTitle || text || Episode Title
|-
|strStudio || text || Network
|-
|premiered || text || First Aired
|-
|mpaa || text || Content Rating
|-
|strShowPath || text || Show Path URL
|-
|resumeTimeInSeconds || double || Time in seconds of bookmark location
|-
|totalTimeInSeconds || double || Time in seconds of the video
|-
|idSeason || integer || Foreign key to the [[Databases#seasons|seasons table]]
|}

==== movieview ====
A view that joins movie to file and path.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idMovie || integer || Primary Key
|-
|idFile || integer || Foreign Key to [[Databases#files|files table]]
|-
|c00 || text || Local Movie Title
|-
|c01 || text || Movie Plot
|-
|c02 || text || Movie Plot Outline
|-
|c03 || text || Movie Tagline
|-
|c04 || text || Rating Votes
|-
|c05 || text || Rating
|-
|c06 || text || Writers
|-
|c07 || text || Year Released
|-
|c08 || text || Thumbnails
|-
|c09 || text || IMDB ID
|-
|c10 || text || Title formatted for sorting
|-
|c11 || text || Runtime (UPnP devices see this as seconds)
|-
|c12 || text || MPAA Rating
|-
|c13 || text || [http://www.imdb.com/chart/top IMDB Top 250] Ranking
|-
|c14 || text || Genre
|-
|c15 || text || Director
|-
|c16 || text || Original Movie Title
|-
|c17 || text || [unknown - listed as Thumbnail URL Spoof]
|-
|c18 || text || Studio
|-
|c19 || text || Trailer URL
|-
|c20 || text || Fanart URLs
|-
|c21 || text || Country (Added in r29886[http://trac.kodi.tv/changeset/29886/trunk])
|-
|c23 || text || idPath
|-
|idSet || integer || Foreign Key to [[Databases#sets|sets table]]
|-
|strSet || text || The name of the set
|-
|strFileName || text || Full name of file including extension
|-
|strPath || text || Path URL
|-
|playCount || integer || # of Times Played
|-
|lastPlayed || text || Date & Time Last Played
|-
|dateAdded || text || Date & Time Added to Library
|-
|resumeTimeInSeconds || double || Time in seconds of bookmark location
|-
|totalTimeInSeconds || double || Time in seconds of the video
|}

==== musicvideoview ====
A view that joins musicvideo to file and path.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idMVideo || integer || Primary Key
|-
|idFile || integer || Foreign Key to [[Databases#files|files table]]
|-
|c00 || text || Title
|-
|c01 || text || Thumbnail URL
|-
|c02 || text || [unknown - listed as Thumbnail URL spoof]
|-
|c03 || text || Play count (unused?)
|-
|c04 || text || Run time
|-
|c05 || text || Director
|-
|c06 || text || Studios
|-
|c07 || text || Year
|-
|c08 || text || Plot
|-
|c09 || text || Album
|-
|c10 || text || Artist
|-
|c11 || text || Genre
|-
|c12 || text || Track
|-
|c13 || text ||
|-
|c14 || text ||
|-
|c15 || text ||
|-
|c16 || text ||
|-
|c17 || text ||
|-
|c18 || text ||
|-
|c19 || text ||
|-
|c20 || text ||
|-
|c21 || text ||
|-
|c22 || text ||
|-
|c23 || text ||
|-
|strFileName || text || Full name of file including extension
|-
|strPath || text || Path URL
|-
|playCount || integer || # of Times Played
|-
|lastPlayed || text || Date & Time Last Played
|-
|dateAdded || text || Date & Time Added to Library
|-
|resumeTimeInSeconds || double || Time in seconds of bookmark location
|-
|totalTimeInSeconds || double || Time in seconds of the video
|}

==== tvshowview ====
View that joins tvshow to path. Also produces information about total number of episodes as well as number of watched and unwatched episodes.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idShow || integer || Primary Key
|-
|c00 || text || Show Title
|-
|c01 || text || Show Plot Summary
|-
|c02 || text || Status
|-
|c03 || text || Votes
|-
|c04 || text || Rating
|-
|c05 || text || First Aired
|-
|c06 || text || Thumbnail URL
|-
|c07 || text || [unknown - Spoof Thumbnail URL?]
|-
|c08 || text || Genre
|-
|c09 || text || Original Title
|-
|c10 || text || Episode Guide URL
|-
|c11 || text || Fan Art URL
|-
|c12 || text || SeriesId (when using thetvdb.com scraper)
|-
|c13 || text || Content Rating
|-
|c14 || text || Network
|-
|c15 || text || Title formatted for sorting
|-
|c16 || text || Not Used
|-
|c17 || text || Not Used
|-
|c18 || text || Not Used
|-
|c19 || text || Not Used
|-
|c20 || text || [unknown]
|-
|c21 || text || [unknown]
|-
|c22 || text || [unknown]
|-
|c23 || text || [unknown]
|-
|strPath || text || Path URL
|-
|dateAdded || text || Date & Time Added to Library
|-
|lastPlayed || text || Date & Time Last Played
|-
|totalCount || integer || # of Episodes
|-
|watchedcount || integer || # of Times Played
|-
|totalSeasons || integer || # of Seasons
|}

=== Tables ===
The information in the Video Library is organized into the following tables. Several large tables (such as [[Databases#episode|episode]], [[Databases#movie|movie]], [[Databases#settings|settings]], and [[Databases#tvshow|tvshow]]) contain the bulk of the information, while most of the others are used to link a long string to a common ID key.

==== actorlinkepisode ====
This table links actors to episodes and stores role information.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idActor || integer || Foreign key to [[Databases#actors|actors table]]
|-
|idEpisode || integer || Foreign key to [[Databases#episode|episode table]]
|-
|strRole || text || Role the actor played in this episode
|}

==== actorlinkmovie ====
This table links actors to movies and stores role information.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idActor || integer || Foreign key to [[Databases#actors|actors table]]
|-
|idMovie || integer || Foreign key to [[Databases#movie|movie table]]
|-
|strRole || text || Role the actor played in this movie
|}

==== actorlinktvshow ====
This table links actors to TV shows and stores role information.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idActor || integer || Foreign key to [[Databases#actors|actors table]]
|-
|idShow || integer || Foreign key to [[Databases#tvshow|tvshow table]]
|-
|strRole || text || Role the actor played in this TV show
|}

==== actors ====
This table stores actor, artist, director, and writer information.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idActor || integer || Primary Key
|-
|strActor|| integer || Name of the actor, artist, director, or writer
|-
|strThumb || text || Thumbnail URL
|}

==== art ====
This table stores URLs for video art metadata.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|art_id|| integer || Primary Key
|-
|media_id|| integer || The id of the media this piece of art is for
|-
|media_type|| text || The type of media this art applies to - movie, set, tvshow, season, episode, musicvideo or actor
|-
|type|| text|| The image type - poster, fanart, thumb, banner, landscape, clearlogo, clearart, characterart or discart
|-
|url|| text || Thumbnail URL
|}

==== artistlinkmusicvideo ====
This table links artists to music videos.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idArtist || integer || Foreign key to [[Databases#actors|actors table]]
|-
|idMVideo || integer || Foreign key to [[Databases#musicvideo|musicvideo table]]
|}

==== bookmark ====
This table stores bookmarks, which are timestamps representing the point in a video where a user stopped playback, an explicit bookmark requested by the user, or an automatically generated episode bookmark.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idBookmark || integer || Primary Key
|-
|idFile || integer || Foreign key to [[Databases#files|files table]]
|-
|timeInSeconds || double || Time in seconds of bookmark location
|-
|totalTimeInSeconds || integer || Time in seconds of the video
|-
|thumbNailImage || text || Thumbnail for bookmark
|-
|player || text || Player used to store bookmark
|-
|playerState || text || Player's internal state in XML
|-
|type || integer || Type of bookmark (0=standard, 1=resume, 2=episode)

|}

==== country ====
This table lists countries.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idCountry || integer || Primary Key
|-
|strCountry || text || Country Name
|}

==== countrylinkmovie ====
This table links countries to movies.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idCountry || integer || Foreign key to [[Databases#country|country table]]
|-
|idMovie || integer ||Foreign key to [[Databases#movie|movie table]]
|}

==== directorlinkepisode ====
This table links directors to TV show episodes.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idDirector || integer || Foreign key to [[Databases#actors|actors table]]
|-
|idEpisode || integer || Foreign key to [[Databases#episode|episode table]]
|-
|strRole || text || [Appears to be unused]
|}

==== directorlinkmovie ====
This table links directors to movies.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idDirector || integer || Foreign key to [[Databases#actors|actors table]]
|-
|idMovie || integer || Foreign key to [[Databases#movie|movie table]]
|}

==== directorlinkmusicvideo ====
This table links directors to music videos.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idDirector || integer || Foreign key to [[Databases#actors|actors table]]
|-
|idMVideo || integer || Foreign key to [[Databases#musicvideo|musicvideo table]]
|}

==== directorlinktvshow ====
This table links directors to TV shows.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idDirector || integer || Foreign key to [[Databases#actors|actors table]]
|-
|idShow || integer || Foreign key to [[Databases#tvshow|tvshow table]]
|}

==== episode ====
This table stores television episode information. Information concerning the series is stored in [[Databases#tvshow|tvshow]]. To link an episode to its parent series, use [[Databases#tvshowlinkepisode|tvshowlinkepisode]].
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idEpisode || integer || Primary Key
|-
|c00 || text || Episode Title
|-
|c01 || text || Plot Summary
|-
|c02 || text || [unknown - listed as Votes]
|-
|c03 || text || Rating
|-
|c04 || text || Writer
|-
|c05 || text || First Aired
|-
|c06 || text || Thumbnail URL
|-
|c07 || text || [unknown - listed as Thumbnail URL Spoof, unused?]
|-
|c08 || text || Has the episode been watched? (unused?)
|-
|c09 || text || Episode length in minutes
|-
|c10 || text || Director
|-
|c11 || text || [unknown - listed as Indentifier]
|-
|c12 || text || Season Number
|-
|c13 || text || Episode Number
|-
|c14 || text || [unknown - listed as Original Title, unused?]
|-
|c15 || text || Season formatted for sorting
|-
|c16 || text || Episode formatted for sorting
|-
|c17 || text || Bookmark
|-
|c18 || text || Not used
|-
|c19 || text || Not used
|-
|c20 || text || Not used
|-
|idFile || integer || Foreign key to the [[Databases#files|files table]]
|}

==== files ====
This table stores filenames and links the path.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idFile || integer || Primary Key
|-
|idPath || integer || Foreign key to [[Databases#path|path table]]
|-
|strFilename || text || Full name of file including extension
|-
|playCount || integer || # of Times Played
|-
|lastPlayed || text || Date & Time Last Played
|-
|dateAdded || text || Date & Time Added to Library
|}

==== genre ====
This table stores genre information. For convenience the contents are duplicated in [[Databases#movie|movie]] and [[Databases#tvshow|tvshow]], so a join isn't necessary.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idGenre || integer || Primary Key
|-
|strGenre || text || Genre label
|}

==== genrelinkmovie ====
This table links genres to movies. (The contents are also stored in movies.c14, though.)
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idGenre || integer || Foreign key to [[Databases#genre|genre table]]
|-
|idMovie || integer || Foreign key to [[Databases#movie|movie table]]
|}

==== genrelinkmusicvideo ====
This table links genres to music videos.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idGenre || integer || Foreign key to [[Databases#genre|genre table]]
|-
|idMVideo || integer || Foreign key to [[Databases#musicvideo|musicvideo table]]
|}

==== genrelinktvshow ====
This table links genres to TV show. (The contents are also stored in tvshow.c08, though.)
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idGenre || integer || Foreign key to [[Databases#genre|genre table]]
|-
|idShow || integer || Foreign key to [[Databases#tvshow|tvshow table]]
|}

==== movie ====
This table stores movie information.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idMovie || integer || Primary Key
|-
|c00 || text || Local Movie Title
|-
|c01 || text || Movie Plot
|-
|c02 || text || Movie Plot Outline
|-
|c03 || text || Movie Tagline
|-
|c04 || text || Rating Votes
|-
|c05 || text || Rating
|-
|c06 || text || Writers
|-
|c07 || text || Year Released
|-
|c08 || text || Thumbnails
|-
|c09 || text || IMDB ID
|-
|c10 || text || Title formatted for sorting
|-
|c11 || text || Runtime (UPnP devices see this as seconds)
|-
|c12 || text || MPAA Rating
|-
|c13 || text || [http://www.imdb.com/chart/top IMDB Top 250] Ranking
|-
|c14 || text || Genre
|-
|c15 || text || Director
|-
|c16 || text || Original Movie Title
|-
|c17 || text || [unknown - listed as Thumbnail URL Spoof]
|-
|c18 || text || Studio
|-
|c19 || text || Trailer URL
|-
|c20 || text || Fanart URLs
|-
|c21 || text || Country (Added in r29886[http://trac.kodi.tv/changeset/29886/trunk])
|-
|c23 || text || idPath
|-
|idFile || integer || Foreign Key to [[Databases#files|files table]]
|-
|idSet || integer || Foreign Key to [[Databases#sets|sets table]]
|}

==== movielinktvshow ====
This table links movies to TV shows.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idMovie || integer || Foreign key to [[Databases#movie|movie table]]
|-
|idShow || integer || Foreign key to [[Databases#tvshow|tvshow table]]
|}

==== musicvideo ====
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idMVideo || integer || Primary Key
|-
|c00 || text || Title
|-
|c01 || text || Thumbnail URL
|-
|c02 || text || [unknown - listed as Thumbnail URL spoof]
|-
|c03 || text || Play count (unused?)
|-
|c04 || text || Run time
|-
|c05 || text || Director
|-
|c06 || text || Studios
|-
|c07 || text || Year
|-
|c08 || text || Plot
|-
|c09 || text || Album
|-
|c10 || text || Artist
|-
|c11 || text || Genre
|-
|c12 || text || Track
|-
|c13 || text ||
|-
|c14 || text ||
|-
|c15 || text ||
|-
|c16 || text ||
|-
|c17 || text ||
|-
|c18 || text ||
|-
|c19 || text ||
|-
|c20 || text ||
|-
|c21 || text ||
|-
|c22 || text ||
|-
|c23 || text ||
|-
|idFile || integer || Foreign Key to [[Databases#files|files table]]
|}

==== path ====
This table stores path information.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idPath || integer || Primary Key
|-
|strPath || text || Path URL
|-
|strContent || text || Type of content (tvshows, movies, etc...)
|-
|strScraper || text || XML file of scraper used for this path
|-
|strHash || text || Hash
|-
|scanRecursive || integer || Recursive scan setting
|-
|useFolderNames || bool || User folder names setting
|-
|strSettings || text || Custom settings used by scraper
|}

==== seasons ====
This table stores the links between tv show and seasons.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idSeason || integer || Primary Key
|-
|idShow|| integer || Foreign key to [[Databases#tvshow|tvshow table]]
|-
|season || integer || Season number
|}

==== sets ====
This table stores the id and name for movie sets. Sets are linked to movies in the movie table (idSet column).
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idSet || integer || Primary Key
|-
|strSet || text || The name of the set
|}

==== settings ====
This table stores settings for individual files.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idFile || integer || Foreign Key to [[Databases#files|files table]]
|-
|Interleaved || bool || Interleaved
|-
|Nocache || bool || NoCache
|-
|Deinterlace || bool || Deinterlace
|-
|FilmGrain|| integer || FilmGrain
|-
|ViewMode|| integer || ViewMode
|-
|ZoomAmount|| float || ZoomAmount
|-
|PixelRatio|| float || PixelRatio
|-
|AudioStream || integer || Selected audio stream
|-
|SubtitleStream || integer || Selected subtitle stream
|-
|SubtitleDelay || float || Amount of delay for subtitles
|-
|SubtitleOn || bool || Enable subtitles
|-
|Brightness || integer || Brightness
|-
|Contrast || integer || Contrast
|-
|Gamma || integer || Gamma
|-
|VolumeAmplification || float || VolumeAmplification
|-
|AudioDelay || float || AudioDelay
|-
|OutputToAllSpeakers || bool || OutputToAllSpeakers
|-
|ResumeTime || integer || ResumeTime
|-
|Crop || bool || Crop
|-
|CropLeft || integer || CropLeft
|-
|CropRight || integer || CropRight
|-
|CropTop || integer || CropTop
|-
|CropBottom || integer || CropBottom
|}

==== stacktimes ====
This table stores playing times for files (used for playing multi-file videos).
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idFile || integer || Foreign key to [[Databases#files|files table]]
|-
|times|| text || Times
|}

==== streamdetails ====
This table contains information regarding codecs used, aspect ratios etc
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idFile || integer || Foreign Key to [[Databases#files|files table]]
|-
|iStreamType || integer || 0 = video, 1 = audio, 2 = subtitles
|-
|strVideoCodec|| text || Video codex (xvid etc)
|-
|fVideoAspect|| real || Aspect ratio
|-
|iVideoWidth|| integer || Width of the video
|-
|iVideoHeight|| integer || Height of the video
|-
|strAudioCodec|| text || Audio codec (aac, mp3 etc)
|-
|iAudioChannels|| integer || Number of audio channels (2 for stereo, 6 for 5.1 etc)
|-
|strAudioLanguage|| text || Language of the audio track
|-
|strSubtitleLanguage|| text || Language of the subtitles
|}

==== studio ====
This table stores studio information.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idStudio || integer || Primary Key
|-
|strStudio || text || Studio Label
|}

==== studiolinkmovie ====
This table links studios to movies.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idStudio || integer || Foreign key to [[Databases#studio|studio table]]
|-
|idMovie || integer || Foreign key to [[Databases#movie|movie table]]
|}

==== studiolinkmusicvideo ====
This table links studios to music videos.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idStudio || integer || Foreign key to [[Databases#studio|studio table]]
|-
|idMVideo || integer || Foreign key to [[Databases#movievideo|movievideo table]]
|}

==== studiolinktvshow ====
This table links studios to tv shows.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idStudio || integer || Foreign key to [[Databases#studio|studio table]]
|-
|idShow || integer || Foreign key to [[Databases#tvshow|tvshow table]]
|}

==== tag ====
This stores tags.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idTag || integer || Primary Key
|-
|strTag || integer || Tag
|}

==== taglinks ====
This table links tags to various media.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idTag || integer || Foreign key to [[Databases#tag|tag table]]
|-
|strTag || integer || Foreign key to a media table
|-
|media_type || text || Media type for link
|}

==== tvshow ====
This table stores information about a television series. Information concerning the shows episodes is stored in [[Databases#episode|episode]]. To link a TV show to its episodes, use [[Databases#tvshowlinkepisode|tvshowlinkepisode]].

{|class="prettytable"
! Column Name || Data Type || Description
|-
|idShow || integer || Primary Key
|-
|c00 || text || Show Title
|-
|c01 || text || Show Plot Summary
|-
|c02 || text || Status
|-
|c03 || text || Votes
|-
|c04 || text || Rating
|-
|c05 || text || First Aired
|-
|c06 || text || Thumbnail URL
|-
|c07 || text || [unknown - Spoof Thumbnail URL?]
|-
|c08 || text || Genre
|-
|c09 || text || Original Title
|-
|c10 || text || Episode Guide URL
|-
|c11 || text || Fan Art URL
|-
|c12 || text || SeriesId (when using thetvdb.com scraper)
|-
|c13 || text || Content Rating
|-
|c14 || text || Network
|-
|c15 || text || Title formatted for sorting
|-
|c16 || text || Not Used
|-
|c17 || text || Not Used
|-
|c18 || text || Not Used
|-
|c19 || text || Not Used
|-
|c20 || text || [unknown]
|-
|c21 || text || [unknown]
|-
|c22 || text || [unknown]
|-
|c23 || text || [unknown]
|}

==== tvshowlinkepisode ====
This table links TV shows (series) to episodes.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idShow || integer || Foreign Key to [[Databases#tvshow|tvshow table]]
|-
|idEpisode || integer || Foreign Key to [[Databases#episode|episode table]]
|}

==== tvshowlinkpath ====
This table links a TV show to its path.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idShow || integer || Foreign key to [[Databases#tvshow|tvshow table]]
|-
|idPath || integer || Foreign key to [[Databases#path|path table]]
|}

==== version ====
This table stores database information.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idVersion || integer || Version of database
|-
|idCompressCount || integer || Number of times database has been compressed
|}

==== writerlinkepisode ====
This table links writers to TV show episodes.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idWriter || integer || Foreign key to [[Databases#actors|actors table]]
|-
|idEpisode || integer || Foreign key to [[Databases#episode|episode table]]
|}

==== writerlinkmovie ====
This table links writers to movies.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idWriter || integer || Foreign key to [[Databases#actors|actors table]]
|-
|idMovie || integer || Foreign key to [[Databases#movie|movie table]]
|}

== The View Modes Database ==
Kodi can track a user's View Mode for every path, so you could browse movies using DVD Thumbs and browse TV shows using Fanart. This database contains the last view and sorting method a user chose for each path while navigating Kodi.

The View Modes database is stored in userdata/Database/ViewModes.db.

=== Tables ===
The View Modes database uses only two tables. Most of the useful information is in [[Databases#view|view]].

==== version ====
This table stores database information.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idVersion || integer || Version of database
|-
|idCompressCount || integer || Number of times database has been compressed
|}

==== view ====
This table stores details on the saved view mode for all known paths.
{|class="prettytable"
! Column Name || Data Type || Description
|-
|idView || integer || Primary Key
|-
|window || integer || Window GUI ID
|-
|path || text || Path to trigger the view on
|-
|viewMode || integer || View Mode
|-
|sortMethod || integer || ID of sort method
|-
|sortOrder || integer || Sort order (ascending or descending)
|}

== See also ==
* [[Version table]]
* [[MySQL]]

[[Category:Development]]

HOW-TO:HelloWorld addon

2015-11-25T22:23:21Z

Prof Yaffle: Add zip file link as per http://forum.kodi.tv/showthread.php?tid=249542&pid=2170508

{{mininav|[[Development]]|[[Add-on development]]|[[Python development]]|[[Python examples]]}}
 

=Introduction=
This tutorial will explain how to write your first Kodi/XBMC script add-on! 
In case you want to write a plugin addon, please use this tutorial: http://kodi.wiki/view/Audio-video_add-on_tutorial

=Tools=
I'd advise using a text editor for your first add-on, something like notepad++ or sublime are good due to their text syntaxing.
Also make sure you have a version of Kodi installed on your development environment.

'''URL''' = http://www.sublimetext.com

'''URL''' = http://notepad-plus-plus.org

=Installing=
For this example we use the official "Hello World" add-on. You can find the source-code here:
https://github.com/zag2me/script.hello.world

... and you can download the zip file (for installation in Kodi) here:
https://github.com/zag2me/script.hello.world/archive/master.zip

=Testing=
You can first give the add-on a test run by going to:
System >> Add-Ons >> Enabled Add-Ons >> Program Add-Ons >> Hello World. You should now see a popup with 3 lines of text.

[[File:helloworld3.jpg]]

=Modifying the Add-On=
Each time we want to change the add-on you can simply go to the appdata folder and live edit it! No need to even close Kodi. This will allow you to quickly test your add-on modifications.
On windows this will be in:
C:\Users\user\AppData\Roaming\XBMC\addons\script.hello.world

[[File:helloworld2.jpg]]

=Structure=
addon.py <-- This is the actual python code for your Add-On

addon.xml <-- This is the Add-Ons metadata

changelog.txt <-- This is a text file with any change-log information in it. We advise updating this on each release.

icon.png <-- A PNG icon for the add-on. It can be 256x256 or 512x512 pixels big. Try to make it look nice!

LICENSE.txt <-- Another text file with the Add-On license text.

[[File:helloworld2.jpg]]

=Metadata=

As we can see from the screenshot below the addon.xml is pretty simple. The main things you want to look at are on the first line of the XML. It's all pretty self-explanatory, just change the fields to your Add-On ID, name, version, and author before you start. The Add-On ID will have to be unique so try to think of a good name here separated by full stops.

The "Requires" section lets XBMC know what extra Add-On code to import. Since our Add-On is simple we only need the basic "xbmc.python" Add-On.

The "extension point" simple tells XBMC what type of Add-On you have created. In this case it's an "executable" which we put inside the <provides> field.

The final section is the extension metadata, again it's all pretty self-explanatory. You can add descriptions, summary and license information in here. You can also add links to the forum thread, source code and email help users who need support for your Add-On.

[[File:Helloworld4.png]]

=The Code=
So now we come to the actual Add-On code, this is where most of your Add-on is written and is a simple text file containing python code. It's contained in a file called "addon.py".

If at this stage you want to learn how to program python, take a look at this excellent website http://www.codecademy.com/en/tracks/python

The first 2 lines simply import the code necessary to run an Add-On and display something using the Kodi GUI.

The next 2 lines of code explain to the system that it's an Add-On and to show the name.

Lines 7,8 and 9 are where the real magic starts to happen, here we are assigning 3 strings to 3 different variables (line1, line2 and line3).

The final line of code now displays all these variables in a popup box inside the Kodi GUI using the "xbmcgui.Dialog" function. It also displays the Add-On name in the Popup boxs title and has an OK button.

[[File:Helloworld1.png]]

=Changing the code=

Hopefully by now you have managed to run the Add-On, understand the structure and can see what the code can do. Now lets trying changing it a little!

Since we already have the Add-on installed we can go directly to the Kodi userdata folder and edit the python directly. You can also have Kodi open at this time ready to run the Add-on when required. Just switch between your text editor and Kodi any time.

Now open up the addon.py file from your userdata folder and lets change what the text says.

line1 = "Goodbye World!"

line2 = "And welcome back"

line3 = "My own Add-On!"

Click save on your text editor and now try running the Add-On inside Kodi. You should see the new text appear right before your eyes.

Congratulations! you are now an XBMC/Kodi developer!!

=Final Thoughts=

Obviously this is just a simple Add-On tutorial and you can do much, much more as most Kodi commands are accessible from this python interface. You can also extend Kodi with things like the JSON interface.

If you have any questions about this tutorial, feel free to discuss it on our forums here: http://forum.kodi.tv/showthread.php?tid=209948

=Extra info=
You can find a little extra info on this page for different methods of using the GUI Hello World

http://kodi.wiki/view/GUI_Tutorial
[[Category:Add-on development]]

Archive:Intro FAQ

2015-10-14T21:04:35Z

Prof Yaffle: Trivial spelling and capitalisation.

{{XBMC FAQ}}
{{mininav| [[Kodi]] {{l2| [[FAQs]] }} }}
'''F'''requently '''A'''sked '''Q'''uestions for {{kodi}} for brand new users and curious onlookers.

__TOC__
{{-}}
== General FAQ ==
:{{big|''See also: '''[[All platforms FAQ]]''' for FAQs that apply to all versions of {{kodi}}.'' }}
{| width="100%"
{{FAQ|1=XBMC|2=What_is_it
| BGcolor=
| Question= What is Kodi? What is XBMC?
| Answer=
{{main|Kodi}}
XBMC is the old name for what is now known as Kodi. XBMC is still the proper name if you are referring to an old version of the program (e.g., XBMC v13), but versions as of v14 and the project itself is known as Kodi.

{{intro|Kodi}}
}}

{{FAQ|1=features
| BGcolor=WhiteSmoke
| Question=What can Kodi do?
| Answer=
{{main|Features and supported codecs}}
{{#lst:Features and supported codecs|intro}}
}}

{{FAQ|1=Team_Kodi|2=Team_XBMC|
| BGcolor=
| Question=Who is Team Kodi?
| Answer=
{{main|Team Kodi}}
{{#lst:Team Kodi|intro}}
}}

{{FAQ|1=XBMC_Foundation
| BGcolor=WhiteSmoke
| Question=Who is the XBMC Foundation?
| Answer=
{{Main|XBMC Foundation}}
{{#lst:XBMC Foundation|intro}}
}}

{{FAQ|1=help |2=bugs |3=troubleshooting
| BGcolor=
| Question=How do I get help or report a bug?
| Answer=
* '''[[Troubleshooting]]''' <- Start here
* '''[[HOW-TO:Submit a proper bug report]]'''
* '''[http://forum.kodi.tv/forumdisplay.php?f=33 Help and Support forums]'''
* '''[irc://irc.freenode.org/kodi #kodi]''' [[w:IRC|IRC]] chat channel on irc.freenode.org
}}

{{FAQ|1=donate |2=contribue
| BGcolor=WhiteSmoke
| Question=How can I help and/or donate?
| Answer=
{{See also|Development}}
* [http://kodi.tv/contribute/donate/ Donate]
* [http://kodi.tv/contribute/submit-a-patch/ Submit a patch]
* [http://kodi.tv/contribute/suggest-a-story/ Suggest a story]
}}

{{FAQ|1=Technical_FAQ
| BGcolor=
| Question= Where can I find an FAQ for more technical questions?
| Answer=
{{See|All platforms FAQ}}
}}

{{FAQ|1=PVR (Live TV and DVR)
| BGcolor=WhiteSmoke
| Question=Can I watch Live TV and handle PVR/DVR functions in {{Kodi}}?
| Answer=
{{Main|PVR}}
{{#lst:PVR|intro}}
}}

{{#lst:All platforms FAQ|Consoles and smartTV}}
<section begin="free content" />
{{FAQ|1=free_content
| BGcolor =
| Question = Where do I get all the movies and TV shows from?
| Answer =
Kodi does not provide any video content or video streaming services. If you bought a "Kodi" player that was advertised as a streaming service than you probably have been misled by a seller trying to make a quick buck. Kodi is a more akin to a video player, like your DVD/Blu-ray player. The main aim of Kodi is to work with video files you have on your own computer or local network (e.g. a fileserver or NAS). Kodi can also access online videos using add-ons, but these add-ons are almost always made by the community and come from a third party service/source, and do not come preinstalled from official versions of Kodi.

While there are many legal video third party '''[[add-ons]]''' and services that work with Kodi, be aware that some less reputable online sellers might try and bundle or market unofficial/unsupported piracy/bootleg add-ons. Such add-ons/services are not endorsed, encouraged, or supported by Team Kodi or the XBMC Foundation. Please do not ask about services that are explicitly for bootleg video content on official Kodi websites, forums, or other support channels. For more information, see our '''[[forum rules|forum and community rules]]'''.
}}
<section end="free content" />
|}

{{Helix updated}}

[[Category:Manual]]
[[Category:FAQ|*]]

Archive:OpenELEC

2014-02-26T20:17:19Z

Prof Yaffle: Added Gotham nightly/generic build link

{{mininav|[[General topics]]{{l2|[[Devices]]}}|[[Installing]]{{l2|[[Linux]]}}}}
<section begin=intro />'''OpenELEC''' (short for "''Open Embedded Linux Entertainment Center''") is a free and open source, small and very fast booting, embedded operating system. OpenELEC is a complete media center software suite that comes with a pre-configured version of XBMC and third-party add-ons with retro video game console emulators and PVR plugins. <section end=intro />

OpenELEC is also designed to be used with flash based drives, like compact flash, USB drives, or SSDs.

OpenELEC works on most computers you can install XBMC on, even the [[Raspberry Pi]] and the [[Apple TV 1]] (silver only).

* http://www.openelec.tv
* [http://wiki.openelec.tv/index.php?title=Installation Installing OpenELEC]
* http://openelec.thestateofme.com/ - Nightly build images for Raspberry Pi
* http://openelec.tv/forum/20-development-discussion/67846-xbmc-gotham-generic-nightly-builds - Nightly build (Gotham) images for generic x86 platforms

== See also ==
* [[Raspberry Pi]]

[[Category:Linux]]
[[Category:Raspberry Pi]]
[[Category:Embedded distro]]
[[Category:Apple TV 1]]

Archive:OpenELEC

2014-02-26T20:15:07Z

Prof Yaffle: clarified that nightly builds on this link are for R-Pi only

{{mininav|[[General topics]]{{l2|[[Devices]]}}|[[Installing]]{{l2|[[Linux]]}}}}
<section begin=intro />'''OpenELEC''' (short for "''Open Embedded Linux Entertainment Center''") is a free and open source, small and very fast booting, embedded operating system. OpenELEC is a complete media center software suite that comes with a pre-configured version of XBMC and third-party add-ons with retro video game console emulators and PVR plugins. <section end=intro />

OpenELEC is also designed to be used with flash based drives, like compact flash, USB drives, or SSDs.

OpenELEC works on most computers you can install XBMC on, even the [[Raspberry Pi]] and the [[Apple TV 1]] (silver only).

* http://www.openelec.tv
* [http://wiki.openelec.tv/index.php?title=Installation Installing OpenELEC]
* http://openelec.thestateofme.com/ - Nightly build images for Raspberry Pi

== See also ==
* [[Raspberry Pi]]

[[Category:Linux]]
[[Category:Raspberry Pi]]
[[Category:Embedded distro]]
[[Category:Apple TV 1]]

Advancedsettings.xml

2014-02-23T20:45:23Z

Prof Yaffle: Additional notes on loglevel/GUI behaviours, as per discussion on http://forum.xbmc.org/showthread.php?tid=187195

{{TOC right}}{{mininav|[[General topics]]|[[Settings]]|page=advancedsettings.xml}}

The "'''advancedsettings.xml'''" file, which does not exist by default, may be created by a user in their "'''/[[userdata]]/'''" folder.

This file can contain additional settings and pre-defined values for the settings available in the GUI (thus removing them from the GUI settings screens).

"'''advancedsettings.xml'''" is useful for advanced/expert users and for installers.

{{note|<code>'''This file will not exist unless created by the end-user, meaning YOU!'''</code>}}
The XBMC software will never write to this file, so any settings you define will not be overwritten by any XBMC GUI settings. You can only edit this file manually on your computer, via a text-editor (like Notepad in Windows or a XML-editor). All the settings available outside of the GUI are documented on this page.

If you are running XBMC on a dedicated HTPC and can only access the HTPC over the network then use an application like WinSCP to gain remote access to the file system on the HTPC from another computer and edit this file. You can edit this file from within WinSCP via the right click menu options.

{{note|
# - This file is '''C'''a'''S'''e '''S'''e'''N'''s'''I'''t'''I'''v'''E''' and must contain the <advancedsettings> tag (see the layout section below), so make sure you use all lower-case tags or they will not be read properly by XBMC.
# - After you have edited this file it is advisable to reboot XBMC completely to ensure that new settings take effect properly.
# - For some Windows versions, XBMC has two <code>\userdata\</code> folders. The correct one to put the advancedsettings.xml file in is not the one in Program Files, but in <code>%appdata%\XBMC\userdata\.</code>}}

== Layout ==

The layout of <code>advancedsettings.xml</code> is as follows:

<syntaxhighlight lang="xml" enclose="div">
<advancedsettings>
<setting>value</setting>
...
<setting>value</setting>
</advancedsettings>
</syntaxhighlight>

where "setting" gives the name of the setting, and "value" gives it's value.

A list of the available "setting" strings and their values is given below.

== How to include GUI settings ==

You can also define the settings normally defined in the GUI in advancedsettings.xml. Any GUI based settings defined in advancedsettings.xml will override the GUI values, and the settings will be removed completely from the GUI (ie only alterable by editing advancedsettings.xml).

The easiest way to include a GUI setting is to first make sure it is set in the GUI to the value that you want, and then to open the '''UserData\guisettings.xml''' file and find the XML entry that corresponds to that setting.

Then just add that entry to the advancedsettings.xml file.

For instance, to set the Font Character Set for the GUI (found in the appearance setting, in the Look and Feel section), you'd open up guisettings.xml and find:

<syntaxhighlight lang="xml" enclose="div">
<lookandfeel>
<charset>Hebrew (Windows)</charset>
</lookandfeel>
</syntaxhighlight>

Simply take that entry and place it in advancedsettings.xml. The GUI entry for the character set will then no longer appear, and XBMC will always use the Hebrew (Windows) character set.

= List of available settings =

== Troubleshooting settings ==

=== loglevel ===
{{Anchor|.3Cloglevel.3E}}
{{see also|debug log}}
<section begin="loglevel" />
{{xml setting
| tag name = loglevel
| tag attribute = hide
| tag attribute type = true_false
| tag attribute values =
{{option values
| value1= true | value1 description= Hides "enable debugging" guisetting.
| value2= false | value2 description= "enable debugging" guisetting will switch between min(loglevel, 0) and max(loglevel, 2) for off and on respectively. '''(Default)'''
}}
| tag attribute default values = true
| option type = list
| option values =
{{option values
| value1= -1 | value1 description= No logging, suppresses all log output
| value2= 0 | value2 description= Normal logging, only logging errors '''(Default)'''
| value3= 1 | value3 description= Debug logging ''(without showing text on screen)''
| value4= 2 | value4 description= Debug logging with freemem, fps and cpu usage shown on screen
| value5= 3 | value5 description= Debug logging with freemem, fps and cpu usage and full smb logging
}}
| default values = 0
| example values =
| platform = all
| XBMC version = 8-12
| description =
The logging level that XBMC will use to log errors and information. The "hide" attribute is optional.
| example =
Example:
<syntaxhighlight lang="xml" enclose="div">
<loglevel hide="false">1</loglevel>
</syntaxhighlight>

 

{{Note| If debugging is switched on in the GUI, loglevel will be set to 2 (''log to both file and on-screen information''); this will over-ride any <code>advancedsettings.xml</code> setting.}} 

{{Note| If debugging is switched on in the GUI when XBMC is shut down, then it will be automatically be re-enabled at level 2 when XBMC is re-started. This is true even if 'hide' is subsequently set to 'true' - in other words, if you enable it in the GUI and then hide the GUI toggle, it will stay on level 2 irrespective of what you subsequently set in <code>advancedsettings.xml</code>.}} 
}}
<section end="loglevel" />

=== jsonrpc ===
{{Anchor|.3Cjsonrpc.3E}}
To make it easier for developers using the [[JSON RPC]] API in their (third party) applications to debug during development the json output of XBMC can be prettified by setting '''compactoutput''' to '''false'''. Default json output mode is a compact print which does not contain any unnecessary whitespaces and therefore is difficult to read for humans.
Furthermore using the '''tcpport''' setting it is possible to change the default TCP port used by XBMC for JSON RPC (which is 9090) to any other valid port.

Example:
<syntaxhighlight lang="xml" enclose="div">
<jsonrpc>
<compactoutput>false</compactoutput>
<tcpport>9999</tcpport>
</jsonrpc>
</syntaxhighlight>

== Audio/video playback settings ==

=== skiploopfilter ===
{{anchor|.3Cskiploopfilter.3E}}
The amount of the loop filter to skip on h264 decoding. This can help the performance of slower machines when decoding h264 content. Values, in decreasing CPU usage (and decreasing quality)
* -16 None
* 0 Skip only empty frames (default)
* 8 Skip non-reference frames (default on ATV)
* 16 Skip bi-dir frames
* 32 Skip all non-key frames
* 48 Skip all frames
Example:
<syntaxhighlight lang="xml" enclose="div">
<skiploopfilter>8</skiploopfilter>
</syntaxhighlight>

=== video ===
{{anchor|.3Cvideo.3E}}
<syntaxhighlight lang="xml" enclose="div">
<video>
<subsdelayrange>10</subsdelayrange> 
<audiodelayrange>10</audiodelayrange> 
<smallstepbackseconds>7</smallstepbackseconds> 
<usetimeseeking>true</usetimeseeking> 
<timeseekforward>30</timeseekforward> 
<timeseekbackward>-30</timeseekbackward> 
<timeseekforwardbig>600</timeseekforwardbig> 
<timeseekbackwardbig>-600</timeseekbackwardbig> 
<percentseekforward>2</percentseekforward> 
<percentseekbackward>-2</percentseekbackward> 
<percentseekforwardbig>10</percentseekforwardbig> 
<percentseekbackwardbig>-10</percentseekbackwardbig> 
<blackbarcolour>1</blackbarcolour> 
<fullscreenonmoviestart>true</fullscreenonmoviestart> 
<defaultplayer>dvdplayer</defaultplayer> 
<excludefromscan> 
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp>
</excludefromscan>
<excludefromlisting> 
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp>
</excludefromlisting>
<playcountminimumpercent>90</playcountminimumpercent> 
<ignoresecondsatstart>180</ignoresecondsatstart> 
<ignorepercentatend>8</ignorepercentatend>


<vdpauscaling>true</vdpauscaling>


<enablehighqualityhwscalers>true</enablehighqualityhwscalers> 
<ppffmpegdeinterlacing>linblenddeint</ppffmpegdeinterlacing> 
<ppffmpegpostprocessing>ha:128:7,va,dr</ppffmpegpostprocessing> 
<allowmpeg4vdpau>true</allowmpeg4vdpau> 
<allowmpeg4vaapi>true</allowmpeg4vaapi> 
<autoscalemaxfps>30</autoscalemaxfps> 



<adjustrefreshrate>









<override>
<fps>23.976</fps> 
<refresh>60.0</refresh> 
</override>

<override>
<fpsmin>29.96</fpsmin> 
<fpsmax>30.01</fpsmax>
<refreshmin>59.0</refreshmin> 
<refreshmax>61.0</refreshmax>
</override>




<fallback>
<refresh>50.0</refresh> 
</fallback>


<fallback>
<refreshmin>49.0</refreshmin>
<refreshmax>51.0</refreshmax>
</fallback>




</adjustrefreshrate>

<checkdxvacompatibility>value</checkdxvacompatibility>


<useocclusionquery>-1</useocclusionquery> 
<fpsdetect>1</fpsdetect> 



<latency>


<delay>0</delay>




<refresh>
<min>23</min>
<max>24</max>
<delay>125</delay>
</refresh>


<refresh>
<rate>50</rate>
<delay>50</delay>
</refresh>

</latency>
</syntaxhighlight>
{{Gotham box|
<syntaxhighlight lang="xml" enclose="div">

<stereoscopicflagssbs>3DSBS|3D.SBS|HSBS|H.SBS|H-SBS| SBS |FULL-SBS|FULL.SBS|FULLSBS|FSBS|HALF-SBS</stereoscopicflagssbs>
<stereoscopicflagstab>3DTAB|3D.TAB|HTAB|H.TAB|3DOU|3D.OU|3D.HOU| HOU | OU |HALF-TAB</stereoscopicflagstab>
</syntaxhighlight>
}}
<syntaxhighlight lang="xml" enclose="div">
</video>
</syntaxhighlight>

=== audio ===
{{anchor|.3Caudio.3E}}
<syntaxhighlight lang="xml" enclose="div">
<audio>

<headroom>0</headroom>

<defaultplayer>paplayer</defaultplayer>

<excludefromscan>
<regexp>[-\._ ](podcast)[-\._ ]</regexp>
</excludefromscan>

<excludefromlisting>
<regexp>[-\._ ](podcast)[-\._ ]</regexp>
</excludefromlisting>

<ac3downmixgain>12.0</ac3downmixgain>

<playcountminimumpercent>99</playcountminimumpercent>

<resample>48000</resample>

<applydrc>true</applydrc>

<dvdplayerignoredtsinwav>false</dvdplayerignoredtsinwav>

<limiterhold>0.025</limiterhold>

<limiterrelease>0.1</limiterrelease>

<resample>0</resample>

<forceDirectSound>0</forceDirectSound>

<audiophile>0</audiophile>

<audiosinkbufferdurationmsec>50</audiosinkbufferdurationmsec>

<allowtranscode44100>0</allowtranscode44100>

<streamsilence>0</streamsilence>
</audio>
</syntaxhighlight>

For more information on the configuration of audio under Frodo see [[AudioEngine/HOW-TO: Configure audio]]

=== measurerefreshrate ===
{{anchor|.3Cmeasurerefreshrate.3E}}
When using "Sync playback to display" on Windows, the detected refreshrate might be wrong.
When enabling measurerefreshrate, the refreshrate is measured instead, which makes it more accurate.

<syntaxhighlight lang="xml" enclose="div">
<measurerefreshrate>true</measurerefreshrate>
</syntaxhighlight>

=== edl ===
{{anchor|.3Cedl.3E}}
{{main|EDL}}
Commercial break detection not as good you think it could be? Are some commercial breaks in a series of adverts not being skipped? Are some parts being skipped that are clearly not commercials? Does the end of the previous recording still show? The following advanced settings can be used to better identify full commercial break sequences, remove incorrectly flagged commercial breaks, and have playback start at the actual beginning of the recording.

<syntaxhighlight lang="xml" enclose="div">
<edl>

<mergeshortcommbreaks>false</mergeshortcommbreaks>

<maxcommbreaklength>250</maxcommbreaklength>

<mincommbreaklength>90</mincommbreaklength>

<maxcommbreakgap>120</maxcommbreakgap>

<commbreakautowait>0</commbreakautowait>

<commbreakautowind>0</commbreakautowind>
</edl>
</syntaxhighlight>

=== pvr ===
{{anchor|.3Cpvr.3E}}
<syntaxhighlight lang="xml" enclose="div">
<pvr>
<timecorrection>0</timecorrection> 
<infotoggleinterval>3000</infotoggleinterval> 
<showepginfoonselect>true</showepginfoonselect> 
<minvideocachelevel>5</minvideocachelevel> 
<maxvideocachelevel>10</maxvideocachelevel> 
<cacheindvdplayer>true</cacheindvdplayer> 
<channeliconsautoscan>true</channeliconsautoscan> 
<autoscaniconsuserset>false</autoscaniconsuserset> 
<numericchannelswitchtimeout>1000</numericchannelswitchtimeout> 
</pvr>
</syntaxhighlight>

=== forcedswaptime ===
{{anchor|.3Cforcedswaptime.3E}}
Use to force a backbuffer->frontbuffer swap while vsync is enabled. Set to the time (in ms) to allow for the swap (e.g. <forcedswaptime>1</forcedswaptime> is typical).

Default: Off

== Video library settings ==

=== videoextensions ===
{{anchor|.3Cvideoextensions.3E}}
A list of additional file-extensions to allow ('''add''') or exclude ('''remove''') in the My Video windows.

Default extensions for VIDEOS:
<pre>
.m4v .3gp .nsv .ts .ty .strm .rm .rmvb .m3u .ifo .mov .qt .divx .xvid .bivx .vob .nrg .img
.iso .pva .wmv .asf .asx .ogm .m2v .avi .bin .dat .dvr-ms .mpg .mpeg .mp4 .mkv .avc .vp3
.svq3 .nuv .viv .dv .fli .flv .rar .001 .wpl .zip
</pre>
Examples:
<syntaxhighlight lang="xml" enclose="div">
<videoextensions>
<add>.ex1|.ex2</add>
<remove>.ex3|.ex4</remove>
</videoextensions>
</syntaxhighlight>

=== discstubextensions ===
{{anchor|.3Cdiscstubextensions.3E}}
A list of additional file-extensions that will (<tt><add></tt>) or will not (<tt><remove></tt>) be treated as disc stubs.

Default extensions for DISC STUBS:
<pre>
.disc
</pre>

Examples:
<syntaxhighlight lang="xml" enclose="div">
<discstubextensions>
<add>.dvd|.blu</add>
<remove>.cd|.vhs</remove>
</discstubextensions>
</syntaxhighlight>

=== languagecodes ===
{{anchor|.3Clanguagecodes.3E}}
Translation table for subtitle and audio names. Contains entries of the form

<syntaxhighlight lang="xml" enclose="div">
<code><short>alt</short><long>Alternate</long></code>
</syntaxhighlight>

=== sorttokens ===
{{anchor|.3Csorttokens.3E}}
Allows you to specify additional tokens that will be ignored at the start of lines during sorting.
<syntaxhighlight lang="xml" enclose="div">
<sorttokens>
<token>the</token>
</sorttokens>
</syntaxhighlight>

=== moviestacking ===
{{anchor|.3Cmoviestacking.3E}}
This is used by the [[File Stacking]] algorithm to combine multi-part files and contains a list of "''[[Regular Expression (RegEx) Tutorial|Regular Expressions]]''"

As of XBMC v9.11, video stacking regular expressions '''must''' contain exactly four (4) capture expressions. Old ones and three capture expressions are dropped (see [[Log file|log]]). More information on how the algorithm works is available [[File Stacking#How does it work.3F|here]].

Default:
<syntaxhighlight lang="xml" enclose="div">
<moviestacking>

<regexp>(.*?)([ _.-]*(?:cd|dvd|p(?:ar)?t|dis[ck]|d)[ _.-]*[0-9]+)(.*?)(\.[^.]+)$</regexp>

<regexp>(.*?)([ _.-]*(?:cd|dvd|p(?:ar)?t|dis[ck]|d)[ _.-]*[a-d])(.*?)(\.[^.]+)$</regexp>

<regexp>(.*?)([ ._-]*[a-d])(.*?)(\.[^.]+)$</regexp>
</moviestacking>
</syntaxhighlight>

If the argument <tt>action="append"</tt> or <tt>append="yes"</tt> is supplied, the default moviestacking regular expressions will remain intact and the user specified ones will be added to the end.

Example:
<syntaxhighlight lang="xml" enclose="div">
<moviestacking action="append">

<regexp>(.*?)([ ._-]*[0-9])(.*?)(\.[^.]+)$</regexp>
</moviestacking>
</syntaxhighlight>

If the argument <tt>action="prepend"</tt> is supplied, the default moviestacking regular expressions will remain intact and the user specified ones will be added to the beginning.

Example:
<syntaxhighlight lang="xml" enclose="div">
<moviestacking action="prepend">
<regexp>(Title)(Volume)(Ignore)(Extension)</regexp>
</moviestacking>
</syntaxhighlight>

If no argument is supplied, or the argument <tt>append="no"</tt> is supplied, the default moviestacking regular expressions are overwritten by the user specified ones.

=== cleandatetime ===
{{anchor|.3Ccleandatetime.3E}}
Matches a year number in a string using a ''[[Regular Expression (RegEx) Tutorial|Regular Expression]]''

Default expression:
<syntaxhighlight lang="xml" enclose="div">
<video>
<cleandatetime>(.+[^ _\,\.\[\]\-])[ _\.\[\]\-]+(19[0-9][0-9]|20[0-1][0-9])([ _\,\.\[\]\-][^0-9]|$)</cleandatetime>
</video>
</syntaxhighlight>
:* The string found before will be used as basis string getting cleaned by the cleanstrings expressions.
:* By default date formats like MM:YY are ignored.

=== cleanstrings ===
{{anchor|.3Ccleanstrings.3E}}
Clean unwanted characters from filenames or folders by using a list of ''[[Regular Expression (RegEx) Tutorial|Regular Expressions]]''. Please note that everything right of the match (at the end of the file name) is removed, so if you would have a file named ''Super movie.mp4'' and would add <tt><regexp> </regexp></tt> (only a space), the only thing that would be left is ''Super'', which is probably not what you want.

Default expressions:
<syntaxhighlight lang="xml" enclose="div">
<video>
<cleanstrings>
<regexp>[ _\,\.\[\]\-](ac3|dts|custom|dc|divx|divx5|dsr|dsrip|dutch|dvd|dvdrip|dvdscr|dvdscreener|screener|dvdivx|cam|fragment|fs|hdtv|hdrip|hdtvrip|internal|limited|multisubs|ntsc|ogg|ogm|pal|pdtv|proper|repack|rerip|retail|r3|r5|bd5|se|svcd|swedish|german|read.nfo|nfofix|unrated|ws|telesync|ts|telecine|tc|brrip|bdrip|480p|480i|576p|576i|720p|720i|1080p|1080i|hrhd|hrhdtv|hddvd|bluray|x264|h264|xvid|xvidvd|xxx|www.www|cd[1-9]|\[.*\])([ _\,\.\[\]\-]|$)</regexp>
<regexp>(\[.*\])</regexp>
</cleanstrings>
</video>
</syntaxhighlight>

:* Arguments <tt>action="append"</tt> or <tt>action="prepend"</tt> will insert user specified expressions after, or before, the defaults above. (Further details in [[Advancedsettings.xml#.3Cmoviestacking.3E|moviestacking]] section)

=== tvshowmatching ===
{{anchor|.3Ctvshowmatching.3E}}
Matches the season and episode numbers in file paths by using a list of ''[[Regular Expression (RegEx) Tutorial|Regular Expressions]]''

Defaults:
<syntaxhighlight lang="xml" enclose="div">
<tvshowmatching>
<regexp>[Ss]([0-9]+)[][ ._-]*[Ee]([0-9]+)([^\\/]*)$</regexp> 
<regexp>[\._ -]()[Ee][Pp]_?([0-9]+)([^\\/]*)$</regexp> 
<regexp>([0-9]{4})[\.-]([0-9]{2})[\.-]([0-9]{2})</regexp> 
<regexp>([0-9]{2})[\.-]([0-9]{2})[\.-]([0-9]{4})</regexp> 
<regexp>[\\/\._ \[\(-]([0-9]+)x([0-9]+)([^\\/]*)$</regexp> 
<regexp>[\\/\._ -]([0-9]+)([0-9][0-9])([\._ -][^\\/]*)$</regexp> 
<regexp>[\/._ -]p(?:ar)?t[_. -]()([ivx]+)([._ -][^\/]*)$</regexp> 
</tvshowmatching>
</syntaxhighlight>

:* Arguments <tt>action="append"</tt> or <tt>action="prepend"</tt> will insert user specified expressions after, or before, the defaults above. (Further details in [[Advancedsettings.xml#.3Cmoviestacking.3E|moviestacking]] section)
:* Expressions are converted to lower case before being evaluated. ''(XBMC v13.0 alpha4 and earlier only)''
:* Paths are converted to lower case before matching.
:* Examples of matching regexps for certain filenames can be found on the [[TV Shows (Video Library)|TV shows]] page.

:* For multi-episode matching to work, there needs to be a third set of parentheses '()' at the end, this part is fed back into the regexp engine.

:* A [http://forum.xbmc.org/showthread.php?t=51614 forum thread] has a discussion of pre-made regex lists to match common names. These drastically improve XMBC's ability to match TV show names, at the risk of some additional false positives.

==== Filenames without Season ====
There are two methods to add episodes without a season in their file path. Both ways will force the season to '1', so that you can use
the 'Use Absolute Ordering (Single Season)' setting from the TheTvDb.com scraper.

; Simple Method ''(XBMC v9.11 onwards)''
: Use only one pair of parentheses
<syntaxhighlight lang="xml" enclose="div"><regexp>[/\._ \-]([0-9]+)</regexp></syntaxhighlight>
; Advanced Method ''(XBMC v10.05 onwards)''
: Supports multi-episode files without season
: Use an empty pair of parentheses for the season
<syntaxhighlight lang="xml" enclose="div"><regexp>[/\._ \-]()([0-9]+)(-[0-9]+)?</regexp></syntaxhighlight>

=== tvmultipartmatching ===
{{anchor|.3Ctvmultipartmatching.3E}}
Matches a multipart episode number based on a previously identified episode file, using a list of ''[[Regular Expression (RegEx) Tutorial|Regular Expressions]]''

Defaults:
<syntaxhighlight lang="xml" enclose="div">
<tvmultipartmatching>^[-_EeXx]+([0-9]+)</tvmultipartmatching>
</syntaxhighlight>
:* Text matching is compared case-insensitive.

=== excludefromscan ===
{{anchor|.3Cexcludefromscan.3E}}
Matches filenames or folders which should be excluded from a library scan (except tvshows) using a list of ''[[Regular Expression (RegEx) Tutorial|Regular Expressions]]''. This can be for both Video or Audio sections of <tt>advancedsettings.xml</tt>.

Defaults:
<syntaxhighlight lang="xml" enclose="div">
<video>
<excludefromscan>
<regexp>-trailer</regexp>
<regexp>[!-._ \\/]sample[-._ \\/]</regexp>
</excludefromscan>
</video>
</syntaxhighlight>

:* Arguments <tt>action="append"</tt> or <tt>action="prepend"</tt> will insert user specified expressions after, or before, the defaults above. (Further details in [[Advancedsettings.xml#.3Cmoviestacking.3E|moviestacking]] section)

=== excludefromlisting ===
{{anchor|.3Cexcludefromlisting.3E}}
<syntaxhighlight lang="xml" enclose="div">
<video>
<excludefromlisting> 
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp>
</excludefromlisting>
</video>
</syntaxhighlight>

=== excludetvshowsfromscan ===
{{anchor|.3Cexcludetvshowsfromscan.3E}}
Matches filenames or folders which should be excluded from a tvshow library scan using a list of ''[[Regular Expression (RegEx) Tutorial|Regular Expressions]]''

Defaults:
<syntaxhighlight lang="xml" enclose="div">
<video>
<excludetvshowsfromscan>
<regexp>[!-._ \\/]sample[-._ \\/]</regexp>
</excludetvshowsfromscan>
</video>
</syntaxhighlight>

:* Arguments <tt>action="append"</tt> or <tt>action="prepend"</tt> will insert user specified expressions after, or before, the defaults above. (Further details in [[Advancedsettings.xml#.3Cmoviestacking.3E|moviestacking]] section)

=== videolibrary ===
{{anchor|.3Cvideolibrary.3E}}
Options specific to the Video Library

<syntaxhighlight lang="xml" enclose="div">
<videolibrary>
<allitemsonbottom>false</allitemsonbottom> 
<backgroundupdate>false</backgroundupdate> 

<cleanonupdate>false</cleanonupdate> 
<hideallitems>false</hideallitems> 
<hideemptyseries>false</hideemptyseries> 
<hiderecentlyaddeditems>false</hiderecentlyaddeditems> 
<recentlyaddeditems>35</recentlyaddeditems> 
<itemseparator> / </itemseparator> 
<exportautothumbs>false</exportautothumbs> 
<importwatchedstate>false</importwatchedstate> 
<importresumepoint>false</importresumepoint> 
<mymovies> 
<categoriestogenres>false</categoriestogenres> 
</mymovies>
<dateadded>1</dateadded> 
</videolibrary>
</syntaxhighlight>

=== videoscanner ===
{{anchor|.3Cvideoscanner.3E}}
Options specific to the Video scanner
<syntaxhighlight lang="xml" enclose="div">
<videoscanner>
<ignoreerrors>true</ignoreerrors> 
</videoscanner>
</syntaxhighlight>

=== trailermatching ===
{{anchor|.3Ctrailermatching.3E}}
Contains "''[[Regular Expression (RegEx) Tutorial|Regular Expression]]''" syntax (commonly referred to as "''[[Regular Expression (RegEx) Tutorial|RegEx]]''" or "''[[Regular Expression (RegEx) Tutorial|RegExp]]''") to match the locally stored trailers to movies in the library.

<syntaxhighlight lang="xml" enclose="div">
<trailermatching>

<regexp>(.*?)(_Trailer)(\.[^.]+)$</regexp>
</trailermatching>
</syntaxhighlight>

=== myth ===
{{anchor|.3Cmyth.3E}}
Not seeing all the recordings you expected in the Movies folder? If so, it's very likely that the electronic program guide (EPG) used by MythTV doesn't accurately distinguish between TV Shows and Movies all the time. The following setting allows the length of the recording to also be used to determine if a recording is a Movie.

<syntaxhighlight lang="xml" enclose="div">
<myth>

<movielength>0</movielength>
</myth>
</syntaxhighlight>

== Artwork ==
=== imageres ===
{{anchor|.3Cimageres.3E}}
This tag is new for v12 (Frodo), replacing <thumbsize>.

Specify the maximal resolution that art should be resized to in pixels. The width is automatically calculated as being 16/9*height. The image
will be resized to fit within this size. e.g. an image that is 2000x500 will be cached at size 1280x320. An image that is 500x800 will be cached
at size 450x720 using the default value of 720.

<syntaxhighlight lang="xml" enclose="div">
<imageres>720</imageres>
</syntaxhighlight>

=== fanartres ===
{{anchor|.3Cfanartres.3E}}
This tag is new for v12 (Frodo), replacing <fanartheight>.

To specify the resolution that cached fanart should be resized to in pixels. The width is automatically calculated as being 16/9*height. Only images
that are exactly 16x9 and equal to or greater than this resolution will be cached at this size - all other images will be cached using <imageres>. The default value is 1080.

<syntaxhighlight lang="xml" enclose="div">
<fanartres>1080</fanartres>
</syntaxhighlight>

=== useddsfanart ===
{{anchor|.3Cuseddsfanart.3E}}
This settings allows XBMC to use your GPU rendering fanart and some other images. This will make loading images considerably faster, especially on systems with slower processors (e.g. atom based systems). Do not use this option on ARM based systems (Apple TV2/iOS/RPi/many Android systems) as it is likely to degrade performance because DDS images are not supported.

<syntaxhighlight lang="xml" enclose="div">
<useddsfanart>true</useddsfanart>
</syntaxhighlight>

=== musicthumbs ===
{{anchor|.3Cmusicthumbs.3E}}
A list of additional files to try when searching for music thumbnail images. (The default is folder.jpg which can be removed.)

Example:
<syntaxhighlight lang="xml" enclose="div">
<musicthumbs>
<remove>folder.jpg</remove>
<add>thumb.jpg|cover.jpg</add>
</musicthumbs>
</syntaxhighlight>

=== fanart ===
{{anchor|.3Cfanart.3E}}
As of v12 (Frodo), this tag is only used for music and not video.

A list of additional files to try when searching for fanart images. (The defaults are fanart.jpg and fanart.png which can be removed.)

Example:
<syntaxhighlight lang="xml" enclose="div">
<fanart>
<remove>fanart.jpg</remove>
<add>backdrop.jpg</add>
</fanart>
</syntaxhighlight>

== Video and music library settings ==

=== playlistasfolders ===
{{anchor|.3Cplaylistasfolders.3E}}
In the recent releases, playlists are treated as folders. Selecting a playlist no longer plays it, but opens it, as if it were a folder. 
Set to false to revert to the previous behaviour. When you select a playlist, its content is added to the list of elements to be played. 
:{{note|This setting will not affect smart playlists, they will always show as folders.}}

=== playlistretries ===
{{anchor|.3Cplaylistretries.3E}}
The number of retries attempted if a source is offline. With this control you can alter the number of consecutive failed items before a playlist fails.

Default:
<syntaxhighlight lang="xml" enclose="div">
<playlistretries>100</playlistretries>
</syntaxhighlight>

=== playlisttimeout ===
{{anchor|.3Cplaylisttimeout.3E}}
The timeout, in seconds, before item failure.

Default:
<syntaxhighlight lang="xml" enclose="div">
<playlisttimeout>20</playlisttimeout>
</syntaxhighlight>

=== musicdatabase/videodatabase ===
{{anchor|.3Cmusicdatabase.3E/.3Cvideodatabase.3E}}
{{see also|HOW-TO:Sync multiple libraries}}
<section begin="videodatabase" />
Allows advanced customization of the default database settings for both music and video.

:{{note| '''It is HIGHLY recommended that you not attempt to place an sqlite3 database outside of XBMC's path. sqlite3 contains no filesystem abstraction, so this will plain break on any non-local (as far as XBMC is concerned) paths. Use this for mysql only.'''}}
'''type'''

Can be either "sqlite3" or "mysql" (default: sqlite3)

'''host'''

sqlite3: defines the relative path to the database file (eg. /usr/local/xbmc/databases).

mysql: defines the host of the mysql socket (eg. localhost, 192.168.0.1, etc)

'''port'''

sqlite3: silently ignored

mysql: defines the port of the mysql socket (default: 3306)

'''name'''
:''Not needed by default, and some users report issues when defining the this tag. When not used "MyVideos"+DB number will be used.
sqlite3: defines the name of the database file to read from, excluding the ".db" extension.

mysql: defines the name of the database to use

'''user'''

sqlite3: silently ignored

mysql: defines the user with privileged access to the database

'''pass'''

sqlite3: silently ignored

mysql: defines the password for the user with privileged access to the database

'''Examples:'''

1) Configure a database for MySQL.
:{{note| ''The videodatabase and musicdatabase tags are interchangeable here.''}}
<syntaxhighlight lang="xml" enclose="div">
<videodatabase>
<type>mysql</type>
<host>192.168.0.10</host>
<name>xbmc_video</name>
<user>xbmc</user>
<pass>xbmc</pass>
</videodatabase>
</syntaxhighlight>

2) Configure a database for an sqlite database.
:{{note|''The videodatabase and musicdatabase tags are interchangeable here.''}}
<syntaxhighlight lang="xml" enclose="div">
<musicdatabase>
<type>sqlite3</type>
<host>/usr/local/share/xbmc/databases</host>
<name>xbmc_music</name>
</musicdatabase>
</syntaxhighlight>

{{note| ''If you use MySQL for the music database, but are finding that it slows down your music library significantly, execute the following query to create an index on the song table. This will significantly speed up queries using the songview views looking up by artist:'' }}

<syntaxhighlight lang="sql">
CREATE INDEX ixSongArtist
ON song(idArtist, idAlbum)
</syntaxhighlight>
<section end="videodatabase" />

=== externalplayer ===
{{anchor|.3Cexternalplayer.3E}}
See the relevant [[External players]].

== Music settings ==

=== musicextensions ===
{{anchor|.3Cmusicextensions.3E}}
A list of additional file-extensions to allow ('''add''') or exclude ('''remove''') in the My Music windows.

Default extensions for MUSIC:
<pre>
.nsv .m4a .flac .aac .strm .pls .rm .mpa .wav .wma .ogg .mp3 .mp2 .m3u .mod .amf .669 .dmf .dsm .far .gdm
.imf .it .m15 .med .okt .s3m .stm .sfx .ult .uni .xm .sid .ac3 .dts .cue .aif .aiff .wpl .ape .mac .mpc
.mp+ .mpp .shn .zip .rar .wv .nsf .spc .gym .adplug .adx .dsp .adp .ymf .ast .afc .hps .xsp
</pre>

Examples:
<syntaxhighlight lang="xml" enclose="div">
<musicextensions>
<add>.ex1|.ex2</add>
<remove>.ex3|.ex4</remove>
</musicextensions>
</syntaxhighlight>

=== cddbaddress ===
{{anchor|.3Ccddbaddress.3E}}
The address of the online CDDb database. You may set this to another freedb mirror if there is a more suitable one.

Default:
<syntaxhighlight lang="XML" enclose="div>
<cddbaddress>freedb.freedb.org</cddbaddress>
</syntaxhighlight>

=== songinfoduration ===
{{anchor|.3Csonginfoduration.3E}}
This controls how long the song information will remain onscreen when the song changes during visualisations. The valid range is "1" to "Indefinite (0)", in seconds. This does not include the duration of any transition effects.

Default:
<syntaxhighlight lang="xml" enclose="div">
<songinfoduration>10</songinfoduration>
</syntaxhighlight>

=== musicfilenamefilters ===
{{anchor|.3Cmusicfilenamefilters.3E}}
Contains filters to match music information (artist, title etc.) from a tag-less music filename. The first <filter> to match completely is used. Matched items include:

<pre>
%A - Artist
%T - Title
%B - Album
%N - Track number
%S - Part of set (disk number)
%D - Duration
%G - Genre
%Y - Year
%R - Rating
</pre>

Example:
<syntaxhighlight lang="xml" enclose="div">
<musicfilenamefilters>
<filter>%A - %T</filter>
</musicfilenamefilters>
</syntaxhighlight>

=== musiclibrary ===
{{anchor|.3Cmusiclibrary.3E}}
Options specific to the Music Library

<syntaxhighlight lang="xml" enclose="div">
<musiclibrary>
<hideallitems>true</hideallitems> 
<allitemsonbottom>true</allitemsonbottom> 
<backgroundupdate>true</backgroundupdate> 
<recentlyaddeditems>35</recentlyaddeditems> 
<albumssortbyartistthenyear>true</albumssortbyartistthenyear> 
<albumformat>%B - %Y</albumformat> 
<albumformatright>%A</albumformatright> 
<prioritiseapetags>true</prioritiseapetags> 
<itemseparator> / </itemseparator> 
</musiclibrary>
</syntaxhighlight>

=== karaoke ===
{{anchor|.3Ckaraoke.3E}}
{{Main|Karaoke}}
<syntaxhighlight lang="xml" enclose="div">
<karaoke>

<syncdelaycdg>0.0</syncdelaycdg>

<syncdelaylrc>0.0</syncdelaylrc>

<alwaysreplacegenre>false</alwaysreplacegenre>

<storedelay>true</storedelay>

<autoassignstartfrom>1</autoassignstartfrom>

<nocdgbackground>true</nocdgbackground>

<defaultbackground type="video" path="special://masterprofile/karaokevideobg.avi"/>

<nextsongpopuptime>0.0</nextsongpopuptime>
</karaoke>
</syntaxhighlight>

== Photos settings ==

=== pictureextensions ===
{{anchor|.3Cpictureextensions.3E}}
A list of additional file-extensions to allow ('''add''') or exclude ('''remove''') in the My Pictures window.

Default extensions for PICTURES:
<pre>
.png .jpg .jpeg .bmp .gif .ico .tif .tiff .tga .pcx .cbz .zip .cbr .rar .m3u
</pre>

Examples:
<syntaxhighlight lang="xml" enclose="div">
<pictureextensions>
<add>.ex1|.ex2</add>
<remove>.ex3|.ex4</remove>
</pictureextensions>
</syntaxhighlight>

=== pictureexcludes ===
{{anchor|.3Cpictureexcludes.3E}}
Matches filenames or folders which should be excluded from being displayed in My Pictures using a list of ''[[Regular Expression (RegEx) Tutorial|Regular Expressions]]''

<syntaxhighlight lang="xml" enclose="div">
<pictureexcludes> 
<regexp>small</regexp>
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp>
</pictureexcludes>
</syntaxhighlight>

=== slideshow ===
{{anchor|.3Cslideshow.3E}}
<syntaxhighlight lang="xml" enclose="div">
<slideshow>

<panamount>2.5</panamount>

<zoomamount>5.0</zoomamount>



<blackbarcompensation>20</blackbarcompensation>
</slideshow>
</syntaxhighlight>

== Network settings ==

=== <samba> ===
<syntaxhighlight lang="xml" enclose="div">
<samba>
<doscodepage></doscodepage> 
<clienttimeout>10</clienttimeout> 
<statfiles>true</statfiles> 
</samba>
</syntaxhighlight>

=== <ftpshowcache> ===
default is false, if set to true, shows cache (X Y Z) partitions in the root directory listing

=== <hosts> ===
Static dns entries which take precedence over your dns server.
<syntaxhighlight lang="xml" enclose="div">
<hosts>
<entry name="HOSTNAME">IPADDRESS</entry>
</hosts>
</syntaxhighlight>

=== <network> ===
{{see also|HOW-TO:Modify the cache}}
<syntaxhighlight lang="xml" enclose="div">
<network>
<curlclienttimeout>10</curlclienttimeout> 
<curllowspeedtime>5</curllowspeedtime> 
<httpproxyusername></httpproxyusername> 
<httpproxypassword></httpproxypassword> 
<cachemembuffersize>5242880</cachemembuffersize> 
</syntaxhighlight>
{{Gotham box|1=
<syntaxhighlight lang="xml" enclose="div">
<buffermode>0</buffermode> 
<readbufferfactor>1.0</readbufferfactor> 
</syntaxhighlight>}}
<syntaxhighlight lang="xml" enclose="div">
</network>
</syntaxhighlight>

=== <tuxbox> ===
<syntaxhighlight lang="xml" enclose="div">
<tuxbox>

<audiochannelselection>false</audiochannelselection>

<submenuselection>false</submenuselection>

<defaultrootmenu>0</defaultrootmenu>

<defaultsubmenu>4</defaultsubmenu>

<pictureicon>true</pictureicon>

<epgrequesttime>10</epgrequesttime>

<zapwaittime>0</zapwaittime>
</tuxbox>
</syntaxhighlight>

=== <enableairtunesdebuglog> ===
This enables the debug output of libshairport which is used for the AirTunes feature. Defaults to off - because its spamming badly.

Example:
<syntaxhighlight lang="xml" enclose="div">
<enableairtunesdebuglog>1</enableairtunesdebuglog>)
</syntaxhighlight>

=== <airtunesport> ===
This overwrites the defalt listening port of the AirTunes server (announced via zeroconf).

=== <airplayport> ===
This overwrites the default listening port of the AirPlay server (announced via zeroconf).

== File system settings ==

=== packagefoldersize ===
{{anchor|.3Cpackagefoldersize.3E}}
{{xml setting
| tag name = packagefoldersize
| option type = numerical
| option values =
| default values = 200
| platform = all
| XBMC version = 12
| description = The amount (in megabytes) of add-on zip packages saved from previous add-on installs. These packages are mainly used for the [[add-on]] rollback feature. Increasing the size should increase the amount of past versions saved.
| example = Example: <syntaxhighlight lang="xml" enclose="div"><packagefoldersize>200</packagefoldersize> </syntaxhighlight>
}}

=== <detectasudf> ===
Set to true if you wish to detect joint ISO9660/UDF disks as UDF.

Default: False

=== <virtualshares> ===
Set to false to disable virtual shares like plugin, last.fm or shoutcast sources.

Default: True

=== <pathsubstitution> ===
'''[[Path substitution]]s''' are for use for redirecting file paths. These are processed in order, and are useful for substituting an absolute path on a PC with a path suitable for XBMC to handle.

Default: No path substitutions defined.

Example:
<syntaxhighlight lang="xml" enclose="div">
<pathsubstitution>
<substitute>
<from>G:\dvds\</from>
<to>smb://somecomputer/g-share/dvds/</to> 
</substitute>
</pathsubstitution>
</syntaxhighlight>

== Remote control settings ==

=== <remotedelay> ===
The repeat delay for a LIRC remote control. A delay value between 1 and 20 before a remote button starts repeating on a long keypress (i.e. continuously sending button pushes while it's held down).

Default: 3
<syntaxhighlight lang="xml" enclose="div">
<remotedelay>10</remotedelay>
</syntaxhighlight>

=== <remoterepeat> ===
This used to adjust the amount of time in milliseconds between repeated keystrokes. Used to prevent key-bounce, in other words prevents xbmc (lirc?) seeing one key press as multiple key presses with certain remotes.

<syntaxhighlight lang="xml" enclose="div">
<remoterepeat>800</remoterepeat>
</syntaxhighlight>

=== <controllerdeadzone> ===
The controller deadzone is the region of movement around the center which is not recognized by the device. Because joysticks can have noise (report motion when still) and bias (report an offset when centered), spurious events can be reported even though the controller isn't being touched. If you notice these kinds of events, you most likely need to increase your controller's deadzone (both axes recommended). The values range from 0.0 (no deadzone, XBMC will see all input your controller is capable of registering) to 1.0 (XBMC will ignore all input inside of the device's physical limits).

<syntaxhighlight lang="xml" enclose="div">
<controllerdeadzone>0.2</remoterepeat>
</syntaxhighlight>

=== <enablemultimediakeys> ===
This setting only has any effect on Windows versions of XBMC, and only applies to builds from 28th May 2011 onwards.
In Windows the multimedia keys generate a WM_APPCOMMAND message in addition the keypress. XBMC processes both keypresses and the WM_APPCOMMAND messages, and the end result would be that the command is executed twice. To avoid this, by default multimedia keypresses are disabled. Although it should rarely be necessary, the enablemultimediakeys setting allows you to enable the multimedia keys.

Example:
<syntaxhighlight lang="xml" enclose="div">
<enablemultimediakeys>true</enablemultimediakeys>
</syntaxhighlight>

== Other GUI settings ==

=== <window> ===
This allows you to manually set the default size of XBMC's windowed mode. If you resize the window, it will return to the set size when restarting.

WIDTH and HEIGHT are the values for each dimension, in pixels.

<syntaxhighlight lang="xml" enclose="div">
<window><width>WIDTH</width><height>HEIGHT</height></window>
</syntaxhighlight>

=== <allowd3d9ex> ===
Applies only to Windows Vista and up. Values: true/false. Allows xbmc to use Direct3D 9Ex, which is a bit more stable and robust than Direct3D 9.

Default:
<syntaxhighlight lang="xml" enclose="div">
<allowd3d9ex>true</allowd3d9ex>
</syntaxhighlight>

=== <restrictcapsmask> ===
Windows only. A bitmask to prevent xbmc from using detected texture capabilities of the GPU. This helps work around buggy hardware/drivers.

1: prevent the use of compressed textures (DXT1, DXT3, DXT5)
2: prevent the use of non-power-of-two dimensions for textures
4: prevent the use of compressed textures with non-power-of-two dimensions.

<syntaxhighlight lang="xml" enclose="div">
<restrictcapsmask>0</restrictcapsmask>
</syntaxhighlight>

=== <forced3d9ex> ===
Windows only: XBMC attempts to detect drivers released for a version earlier than Vista, to avoid using advanced features which are often not emulated correctly. The detection may be incorrect and this setting allows forcing the using of D3D9Ex.

<syntaxhighlight lang="xml" enclose="div">
<forced3d9ex>false</forced3d9ex>
</syntaxhighlight>

=== <algorithmdirtyregions> ===

Enable dirty-region processing. Dirty regions are any parts of the screen that have changed since the last frame. By not re-rendering what hasn't changed, big speed gains can be seen. Because all GPUs work differently, only Mode 3, combined with nofliptimeout=0, is guaranteed to be safe for everyone, but current timing issues with nofliptimeout keep this from being the default.

{| class="wikitable"
! value !! result !! description
|-
! 0
| Off
| The entire viewport is always rendered.
|-
! 1
|Union
|All dirty regions are grouped into the smallest possible rectangle. This is typically the fastest mode for slower GPUs due to only making one pass.
|-
! 2
| {{nowrap|Cost reduction}}
| Each dirty region is presented separately, in as many passes as there are regions.
|-
! 3
| {{nowrap|Whole Screen}}
| The entire screen is rendered if there are any dirty regions. This, combined with nofliptimeout is a safe default for drivers that clear buffer contents (manifests as blinking or vibrating images). '''Default'''
|}

Example:
<syntaxhighlight lang="xml" enclose="div">
<gui>
<algorithmdirtyregions>1</algorithmdirtyregions>
</gui>
</syntaxhighlight>

=== <visualizedirtyregions> ===
Enable dirty-region visualization. Paints a rectangle over marked controls.
* true: on
* false: off (default)

Example:
<syntaxhighlight lang="xml" enclose="div">
<gui>
<visualizedirtyregions>true</visualizedirtyregions>
</gui>
</syntaxhighlight>

=== <nofliptimeout> ===
Specifies the timeout in milliseconds after which XBMC will not flip the graphics buffers anymore when nothing has been rendered, this lowers both CPU and GPU usage.
* -1: disabled
* 0 or higher: timeout in milliseconds (0 is default)

Example:
<syntaxhighlight lang="xml" enclose="div">
<gui>
<nofliptimeout>1000</nofliptimeout>
</gui>
</syntaxhighlight>

=== <showexitbutton> ===
Setting to hide the exit button, useful for people running appliance based setup's where exit would only confuse/complicate the user. Modifiable via the advancedsettings.xml by setting showexitbutton to false, default is true (show)

Example:
<syntaxhighlight lang="xml" enclose="div">
<showexitbutton>false</showexitbutton>
</syntaxhighlight>

=== <screensaver> ===
To avoid potential worries of plasma screen burn-in, you can set the Dim screensaver fade level to 0% here or in the Settings.
<syntaxhighlight lang="xml" enclose="div">
<screensaver>
<dimlevel>0</dimlevel> 
</screensaver>
</syntaxhighlight>

=== <fullscreen> ===
Starts XBMC in full screen (check resolutions!).

<syntaxhighlight lang="xml" enclose="div">
<fullscreen>false</fullscreen>
</syntaxhighlight>

=== <splash> ===
Set to false if you wish to disable the startup splash image. Defaults to true.

<syntaxhighlight lang="xml" enclose="div">
<splash>false</splash>
</syntaxhighlight>

=== <cputempcommand> ===
Provide a shell command XBMC will use to get CPU temperature. It should print out only "[temp as integer] [scale as one of "CcFf"]". 
;For Nvidia and Raspberry Pi
<syntaxhighlight lang="xml" enclose="div">
<cputempcommand>sed -e 's/$[0-9]*$[0-9]\{3\}.*/\1 C/' /sys/class/thermal/thermal_zone0/temp</cputempcommand>
</syntaxhighlight>
or
<syntaxhighlight lang="xml" enclose="div">
<cputempcommand>echo "$(sensors -u | tail -n64 | grep temp1_input | awk '{print $2 }' |awk '{printf("%d\n",$1 + 0.5);}') C"</cputempcommand>
</syntaxhighlight>
;For ATI/AMD
<syntaxhighlight lang="xml" enclose="div">
<cputempcommand>sensors|sed -ne "s/temp1: \+[-+]$[0-9]\+$.*/\1 C/p"</cputempcommand>
</syntaxhighlight>

=== <gputempcommand> ===
Provide a shell command XBMC will use to get GPU temperature. It should print out only "[temp as integer] [scale as one of "CcFf"]". 
;For Nvidia
<syntaxhighlight lang="xml" enclose="div">
<gputempcommand>echo "$(nvidia-settings -tq gpuCoreTemp) C"</gputempcommand>
</syntaxhighlight>
or
<syntaxhighlight lang="xml" enclose="div">
<gputempcommand>echo "$(nvidia-smi -q -d TEMPERATURE | grep Gpu | cut -c35-36) C"</gputempcommand>
</syntaxhighlight>
;For ATI/AMD
<syntaxhighlight lang="xml" enclose="div">
<gputempcommand>/usr/bin/aticonfig --od-gettemperature | grep Temperature | cut -f 2 -d "-" | cut -f 1 -d "." | sed -e "s, ,," | sed 's/$/ C/'</gputempcommand>
</syntaxhighlight>

;For Raspberry Pi
<syntaxhighlight lang="xml" enclose="div">
<gputempcommand>/opt/vc/bin/vcgencmd measure_temp | sed -e "s/temp=//" -e "s/\..*'/ /"</gputempcommand>
</syntaxhighlight>

=== <glrectanglehack> ===
Problems with ghosting or videos which are only played back in the left upper quarter? The following ATI hack may solve it.
<syntaxhighlight lang="xml" enclose="div">
<glrectanglehack>yes</glrectanglehack>
</syntaxhighlight>

=== <alwaysontop> ===
Added in XBMC v9.11 ('''win32 only'''). Keeps XBMC always on top when windowed.
<syntaxhighlight lang="xml" enclose="div">
<alwaysontop>yes</alwaysontop>
</syntaxhighlight>

Alternate code.
<syntaxhighlight lang="xml" enclose="div">
<videoscreen>
<fakefullscreen>false</fakefullscreen>
</videoscreen>
</syntaxhighlight>

=== busydialogdelayms ===
{{gotham box|1=
Provides control over the delay until busy dialog is shown when starting video playback. Value is given in milliseconds.

Example:
<syntaxhighlight lang="xml" enclose="div">
<busydialogdelayms>100</busydialogdelayms>
</syntaxhighlight>
}}

== Unsorted ==

=== <masterlock> ===
{{Main|Master lock}}
If you enable any masterlock settings below, they will be removed from UI. Code needs to be MD5'd, and you can use [http://pajhome.org.uk/crypt/md5/ this site] to hash it.

<syntaxhighlight lang="xml" enclose="div">
<masterlock>
<startuplock>false</startuplock> 
<automastermode>false</automastermode> 
<loginlock>true</loginlock> 

<maxretries>3<maxretries> 
</masterlock>
</syntaxhighlight>

=== <bginfoloadermaxthreads> ===
{{Gotham box|1=
'''This has been removed in Gotham'''

Control the number of threads in the background info loader thread pool (thumb generator, flagging, etc). Useful for tuning platforms that are low on CPU, like Intel Atom based systems.
<syntaxhighlight lang="xml" enclose="div">
<bginfoloadermaxthreads>5</bginfoloadermaxthreads>
</syntaxhighlight>}}

==Recently removed tags==
*<thumbsize> is replaced by <imageres> in v12 (Frodo)
*<fanartheight> is replaced by <fanartres> in v12 (Frodo)
*<dvdthumbs> is gone in (v12 Frodo)

[[Category:Settings]]
[[Category:XBMC Manual]]
[[Category:Advanced topics]]
{{DISPLAYTITLE:advancedsettings.xml}}
{{frodo updated}}

Skinning Manual

2014-02-17T13:13:28Z

Prof Yaffle: Spelling correction - "apendix" to "appendix" throughout

{{TOC right}}{{mininav|[[Development]]|[[Add-on development]]|[[Skinning]]}}

XBMC includes a new GUI library written from scratch. This library allows you to skin/change everything you see in XBMC, from the images, the sizes and positions of all controls, colours, fonts, and text, through to altering navigation and even adding new functionality. 
The skin system is quite complex, and this portion of the manual is dedicated to providing in depth information on how it all works, along with tips to make the experience a little more pleasant.

If you are just getting started with skinning XBMC, then it is suggested that the best way to learn is by modifying one of the many existing skins that are available. The default skin, Confluence, includes almost all the various tricks and features that make the XBMC skinning engine so powerful, so is an ideal place to start. You may wish to start by having a look through the [[XBMC Skinning Tutorials|tutorial section on skinning XBMC]] as well as the "[[Skinning XBMC]]" article, and try modifying a window or two by adding a button, or altering the textures or layout.
 

== Anatomy of a Skin ==
XBMC skins once installed are located in [[userdata]] addons folder. This is the folder where all skins are placed and listed. 
Any additional skins you create, or download from [[Category:Repositories]] or be installed via zip XBMC will load and ask you if you would like to load the skin and also allow you to load them up from within the Appearance Settings. It is suggested that if you want to make your own skin, then starting by copying an existing skins files over into a new folder (let's say skin/myskin) is a good place to start. You can then edit each of the files as you become more familiar with the skinning system. 
Each skin folder contains several subdirectorys, and one file:
; myskin/font
: This subdirectory contains all fonts used by the skin. you can add/replace fonts here
; myskin/media
: This subdirectory contains all the media files (.png/.gif/.jpg...) You can replace/edit these as you like.
; [[addon.xml|myskin/addon.xml]]
: This contains the information that XBMC uses to find the other files that XBMC requires to describe it's skin. It also contains credits information, and versioning information.
; myskin/720p
: This is a resolution-specific directory. XBMC can run in multiple resolutions, and thus can use different files for some resolutions (as there is a big difference between NTSC at 720x480 pixels and 1080i at 1920x1080 pixels!) [[Addon.xml#Skin_specific_elements|See here for the order in which it looks for skin files.]]

== Skin Themes ==
All the basic media files for a skin should be compressed into the Textures.xbt file, and placed in the media/ folder. You can use the tool [[Texturepacker]] for this. All the images that make up the default skin theme should be in the Textures.xbt file.

In addition to this, XBMC allows other .xbt files in the media/ folder, each one representing a different theme for your skin.
For instance, you could tint all your main textures a red colour, and create a new theme package Red.xbt.
This gives users more choice in the look of a particular skin, and only the textures change when you change themes – the layout stays the same.
If the user has selected a theme, then when a control requires a texture, XBMC will first look in the <themename>.xbt file for the texture.
It will fall back to the Textures.xbt file if <themename>.xbt doesn't contain the image. This means that the theme .xbt files need only contain the changed textures – all other textures will fallback to using Textures.xbt as usual.

A suggested method of creating a theme is as follows:

# Run Texturepacker.exe on the folder containing the default texture files, to generate Textures.xbt as you would normally do.
# Identify the textures you wish to have themed and copy them to a separate folder.
# Create a separate folder for each theme outside of your normal skin work area, and place the altered copies of each of the textures in them.
# Run Texturepacker.exe on each of the theme folders created in step 3 to create the themed .xbt files (note you can use the -output switch with Texturepacker.exe to name the theme appropriately).
# Place Textures.xbt and each of the theme .xbt files in the media/ folder of your skin. XBMC will automatically pick them up.

== Includes ==
The other special (and arguably the most important skinning file of all) is includes.xml. This is, as its title suggests, a place from which you can define the default look, size, and positioning of controls, to save you replicating many of the control's attributes throughout the window .xml files. For instance, you can setup the size, and textures used for a button control, thus allowing you to leave those details out in the rest of the skin files, unless of course you want to override the default look or size etc. in a particular window. 
This is extremely valuable as it allows you to greatly simplify a lot of the work in building a skin. For one thing, it means that once you have include files setup, many of the default parameters for a different resolution can be done by just altering the parameters within the include file(s) for the different resolution. 
With the 2.1 skinning engine, you can infact have more than one include file - you can specify the file attribute when including from a different file, allowing you to have an include file dedicated to a particular set of attributes. 
The layout of an includes file is as follows.

<source lang="xml">
<includes>
<include name="whitetext">
<textcolor>ffffffff</textcolor>
</include>
<include file="listdefaults.xml" />
<default type="button">
<include>whitetext</include>
</default>
<constant name="leftedge">50</constant>
</includes>
</source>

You'll notice in the above example that we have 4 different types of includes. The first <include> tag basically allows a substitution of the tags underneath it whenever it occurs. For instance, if in a window .xml file you have this:

<source lang="xml">
<control type="togglebutton">
<include>whitetext</include>
... other tags go here
</control>
</source>

Then it would substitute the <textcolor> tag for where the include tag is. You can have as many includes as you like, and as many tags can be inside an include - even complete controls, or complete control groups.

The second <include> tag in the example demonstrates how to include from a different file. As there is no include name specified, it will include the contents of the entire file at that point.

The <default> tag is similar to an include, except that it is used in every control of that type - even if you don't specify that the control is to use includes. Thus every buttoncontrol will have the whitetext include in it. Note that you can override this by specifying the <textcolor> tag in the buttoncontrol.

And finally, the <constant> tag allows you to define a numeric (floating point) constant by name for use in place of numeric values (<posx>, height="" etc.) would otherwise be used. This allows alignment of items using the same position values which can then easily be altered in one place.
 
=== Variables ===
Variables are a special kind of include. You can put them in Includes.xml. But usually, to keep them separate, Includes.xml gets extended with a file named Variables.xml. You can extend on the file Includes.xml by adding a line like this:
<source lang="xml">
<include file="Variables.xml" />
</source>
Variables can be used in textures or labels/textbox/buttons ect. Instead of having to include two whole controls with a condition, they allow you to just apply the condition to the actual texture or label. Meaning less controls to maintain ect. The values in the variable are read from top to bottom and the first condition that is met gets used. The last value usually has no condition and it's content acts as a fallback. The following example shows the album label if the player has audio, the year if there is no audio and no fallback is used (because there either is or is not any audio).
<source lang="xml">
<variable name="Example">
<value condition="Player.HasAudio">$INFO[ListItem.Album]</value>
<value condition="!Player.HasAudio">$INFO[ListItem.Year]</value>
<value>-</value>
</variable>
</source>
You can use a variable in a label control like this:
<source lang="xml">
<label>$VAR[Example]</label>
</source>
 

== [[Window Structure|The Window XML Files]] ==
The other xml files each define the skin for a single window. They all have the same basic layout, allowing you to place different controls on the window, and define how navigation should operate. 
A list of all window .xml files and what they represent may be found in Appendix I: List of Windows.

The important thing to remember is that each window has a unique identifying number (id). This is how XBMC identifies the window from within the source code.

Furthermore, many of the controls within each window should have a unique id as well, unless they're just used as images or labels where navigation is unimportant and XBMC does not need to be able to identify them uniquely. The window id's are all listed in the Appendix I: List of Windows. 
The structure of the window .xml files can be found below in the Window Structure.

= addon.xml =

{{see also|addon.xml}}

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

= Controls =
Controls are the substance of your skin. They define everything from buttons, to text labels, to visualization placement. This portion of the manual will explain each and every control in detail.
== Label Control ==
{{#lst:Label Control|main content}}
== Fade Label Control ==
{{#lst:Fade Label Control|main content}}
== Button Control ==
{{#lst:Button control|main content}}
== Multiselect Control ==
{{#lst:Multiselect control|main content}}
== Image Control ==
{{#lst:Image Control|main content}}
== MultiImage Control ==
{{#lst:MultiImage Control|main content}}
== Radio button Control ==
{{#lst:Radio button control|main content}}
== Select button control ==
{{#lst:Select button control|main content}}
== Toggle button control ==
{{#lst:Toggle button control|main content}}
== Spin Control ==
{{#lst:Spin_Control|main content}}
== Settings Spin Control ==
{{#lst:Settings_Spin_Control|main content}}
== Slider Control ==
{{#lst:Slider Control|main content}}
== List Container ==
{{#lst:List Container|main content}}
== Wraplist Container ==
{{#lst:Wrap List Container|main content}}
== FixedList Container ==
{{#lst:Fixed List Container|main content}}
== Panel Container ==
{{#lst:Panel Container|main content}}
== Progress Control ==
{{#lst:Progress Control|main content}}
== Text Box ==
{{#lst:Text Box|main content}}
== RSS feed Control ==
{{#lst:RSS feed Control|main content}}
== Visualisation Control ==
{{#lst:Visualisation Control|main content}}
== Video Control ==
{{#lst:Video Control|main content}}
== Mover Control ==
{{#lst:Mover Control|main content}}
== Resize Control ==
{{#lst:Resize Control|main content}}
== Edit Control ==
{{#lst:Edit Control|main content}}
== EPGGrid Control ==
{{#lst:EPGGrid_control|main content}}

== Console Control ==
used to display the last few items added to the video database.
== Checkmark Control ==
Used on the Kai Host Dialog. Similar to Radio Button but does not have the button texture, and the checkmark is on the left
== Extended List Control ==
used in the XLink Kai window.

= Conditional_Visibility =
XBMC's skinning engine versatility is based upon the fact that the skinner can display and hide portions of the skin using a variety of conditional statements that can be combined to create very user friendly UI implementations. For further information of available variable and how they can be applied.
{{#lst:Conditional Visibility|main content}}

= Animating Your Skin =
The XBMC skinning engine supports animations of any control allowing them to rotate, slide, fade or any combination there-of. Combining animations with conditional statements ensure your skin will have stunning effects that appear as professional as a 1st party product.
{{#lst:Animating Your Skin|main content}}

= Fonts =
XBMC allows you to customize which fonts are displayed onscreen in the User Interface.
{{#lst:Fonts|main content}}

= Appendix I: List of Windows =
{{#lst:Window IDs|main content}}

= Appendix II: List of Boolean Conditions =
{{#lst:List of Boolean_Conditions|main content}}

= Appendix III: List of Info Labels =
{{#lst:InfoLabels|main content}}

= Appendix IV: List of Built In Functions =
{{#lst:List of Built In Functions|main content}}

= Appendix V: List of Built In Controls =
{{#lst:List of Built In Controls|main content}}

= Appendix VI: List of Default Icons =
{{#lst:Default Icons|main content}}

[[Category:XBMC Manual]]
[[Category:Development]]
[[Category:Skin Development|*]]
[[Category:Python]]

User talk:Ned Scott

2014-02-03T20:33:44Z

Prof Yaffle: /* Linux FAQ Edits 2nd Feb 2014 */

{{notice|Press the "Add topic" tab at the top to start a new thread/section. Don't forget to sign your posts by typing <nowiki>~~~~</nowiki>. Messages left here will ping my e-mail so I will be notified ASAP.}} 

== Thanks ==

I didn't see the other section of the MySQL Howto. Thank for showing me.

== A glance to my little contribute... ==

Hi Ned,
can you take a look about my first little contribute at [[Remote_Control_Reviews#Other_unbranded_MCE_remote]] ?
--[[User:Skelos|Skelos]] 11:59, 13 September 2011 (UTC)

== NedBot keeps moving an article ==

Why do you and NedBot keep moving [http://wiki.xbmc.org/index.php?title=HOW-TO:Configure_Sony_PS3_remote_on_Asus_EB1012P&action=history this] article? [[User:Sjefen6|Sjefen6]] 17:45, 3 October 2011 (UTC)

:"HOW-TO:" has now become a namespace on the Wiki, rather than being a normal part of the title. Kind of like how there are "User:" and "Talk:" pages. In order to do this without messing things up, all pages with "How-to" or "HOW-TO" in the title had to be moved for a moment, then the new namespace added, then moved back. -- [[User:Ned Scott|Ned Scott]] 17:53, 3 October 2011 (UTC)

== General info and Dharma Guide ==

Hi Ned, 
I'd like to help out a bit on the wiki, but as you're doing a big overhaul it looks like you might have an overarching plan, and I don't want to step on your toes. Is there anything I should be aware of before delving in, or should I just go right ahead and update pages and fill in gaps wherever I find them? 
Also, what's happening with the Dharma Guide? Is this just a straight copy-paste job from the pdf with relevant internal and external links added where appropriate, or is any tweaking required beyond that? [[User:Procrastinator|Procrastinator]] 10:03, 6 October 2011 (UTC)

:Right now I have some basic ideas just sort of floating around. [[User:Ned Scott/idea pad]] has some ideas put down, and [[Help:Main page]] is basically the same thing, but a little better formatted. That's about as far as I've gotten with a formal plan, other than random things that pop up in my head :)

:I'm just doing a pretty much straight copy of the Dharma Guide that Henry Ford made just to see how it looks, and to test out some formatting ideas. The eventual idea is to work it into a "basic/new user manual" as a starting point, and expand upon it from there. Kind of a way to get a jump start on a new user manual in time for Eden's release. There's also another PDF guide out there on the forums that we might also be able to pull from, but I haven't heard back from the author yet.

:A lot of the existing pages will probably be a kind of "advanced users manual" since they go into such detail, while some pages could fall under both manuals. It's all just ideas at this point, though. In any case we'll keep our existing pages in some form or another, so feel free to update and add to them. Feel free to even try out something completely new or draft some test pages if you have ideas. -- [[User:Ned Scott|Ned Scott]] 02:39, 7 October 2011 (UTC)

== xbox ==
Hi Ned,

Since your recent changes with the unofficial repsitory wiki list us xbox users can no longer install repositories through the addons4xbox installer. Since the problem has occured there has only been an addition by DMD-XBMC-Addons and your changes to the page. I've checked the DMD addition and everything seems ok so I presume the problem is due to the page change, unfortunately I can't seem to get hold of temhil the author of addons4xbox installer so could we temporarily revert the page to how it was until I can get temhil to make the appropriate changes to his code. Unless you know how to change the code so it works with the new layout, in which case that would be great? — Preceding [[wikipedia:Wikipedia:Signatures|unsigned]] comment added by [[User:Whufclee|Whufclee]] ([[User talk:Whufclee|talk]] • [[Special:Contributions/Whufclee|contribs]]) 

:No problem. It might have been when I renamed the headers on the page to only capitalize the first word. Not sure. I've reverted all my December 3rd edits until we know what broke. Let me know if there's anything else I can do. -- [[User:Ned Scott|Ned Scott]] 11:53, 5 December 2011 (EST)

Thanks, unfortunately temhil is pretty busy at the moment and doesn't have time to look into the problem with the installer. If it's possible to create a mirror wiki page with the changes made I could take a look at the code and see if I can work out what the problem was, if not then no worries - I have plenty of other projects keeping me busy! If the mirror page is not an option then maybe you'll be ok to leave it as it is until temhil has some free time? We all really appreciate you sorting this, cheers. — Preceding [[wikipedia:Wikipedia:Signatures|unsigned]] comment added by [[User:Whufclee|Whufclee]] ([[User talk:Whufclee|talk]] • [[Special:Contributions/Whufclee|contribs]]) 

:A mirror'ed page would be easy, but I'm interested in figuring out what made it stop working. I guess it's time I fired up my old modded xbox, updated XBMC, and see if I can figure anything out on my end. -- [[User:Ned Scott|Ned Scott]] 17:36, 5 December 2011 (EST)

== HOWTO: Install XBMC on a Moneual Labs MonCaso 312 HTPC case ==

Hi Ned
After about a year of delving, I created a much needed HOWTO. Please could you assist me how to add the HOWTO?

Kind regards
cyber7 (AKA Aubrey Kloppers)

== Suggestion for the Comparison_of_skin_features Table ==

Hi,

i made a example table header here: http://wiki.xbmc.org/index.php?title=Talk:Comparison_of_skin_features
Write there what you think
[[User:Pred|Pred]] 04:39, 29 March 2012 (EDT)

== Media source types ==

Hello Ned.

I want to give an hand on the media source pages. Could you send me general explanation on what should be done?

[[User:A rno|A rno]] 06:58, 29 March 2012 (EDT)

== Generic PS3 remote ==

Hi Ned,
Sorry if this is not the correct place to ask a question, I wasn't sure where to go.
I have the remote referred to here: http://wiki.xbmc.org/index.php?title=Generic_PS3_remote but am yet to get it working. How did you set up lirc to recognise the remote? I can't seem to find / create an appropriate lircd.conf
Thanks for your help,
Sam
[[User:Samgood|Samgood]] 21:03, 20 July 2012 (EDT)

:I do not know. You'll need to ask at http://forum.xbmc.org -- [[User:Ned Scott|Ned Scott]] 21:55, 20 July 2012 (EDT)

== PVR page ==

Hi Ned,

Do you have any opinion/suggestions with respect to my comments on the PVR talk page [[Talk:PVR#Add-on namespace?]] ? Thanks. --[[User:Fiveisalive|Fiveisalive]] 19:25, 20 October 2012 (EDT)

== userdata contents proper documentation on all folders/files ==

Please see http://wiki.xbmc.org/index.php?title=Talk:Userdata I have added a full listing of what files/folders can be found in there frodo wise. Thers not much information if any about the already raised profiles.xml and now with more folders in there the information about what exactly these other folders contain and what these files do their structure etc could be better documented. who actually knows about userdata and related files/folders that can help with this? thank you.--uNiversal 07:21, 27 November 2012 (EST)

== Wiki template problem? (off-page menu next to View history) ==

I've noticed that the dropdown menu which contains the Watch and Refresh (purge) options currently opens over the edge of the page canvas.

[http://i.imgur.com/Qfrf2.png This image] illustrates the problem. Happens when logged in using Chrome and IE. Got a few gadgets enabled but nothing I can see that would (should?) affect the render. '''[[User:Synergist|Synergist''!'']]''' 06:07, 11 December 2012 (EST)

:Yeah, known issue. It shifted over when I hid the default search bar, and I'm not that great at css and wiki skins, so I haven't fixed it yet. However, the XBMC Wiki is getting a new skin where this is fixed and it has a new unified look with the whole XBMC website. Should be ready for Frodo's release, so soon. -- [[User:Ned Scott|Ned Scott]] 06:12, 11 December 2012 (EST)

I guess this is still a problem. --uNiversal 06:10, 26 February 2013 (EST)

== Review of new usb information page ==

I would like some feedback on a page I been working on [[User:UNiversal#Create_and_install_to_a_bootable_USB_flash_drive| WiP click here]]
Hopefully the format and templates I hope to create for this for amongst other <nowiki>[[File:Note.png|40px|left|link=|REMEMBER]] & [[File:Lightbulb.png|40px|left|link=|TIP]]</nowiki> and the headers will be ok, but have a glance though and provide some feedback pls as Im not familiar with some of the info in here. I would like to ideally replace the <nowiki>{{highlight|color=#whatever|'''Note:'''}} with the icon instead and TIP icon and others so it breaks up the immense spans of text that some pages have.</nowiki> --uNiversal 06:14, 22 December 2012 (EST)

: Well Since there was no feedback and cant be waiting forever, I went ahead and merged new page which is all now in [[Create_and_install_from/to_a_bootable_USB_flash_drive|Create and install from/to a bootable USB flash drive]] Which resolves the problem of no proper instructions for how to create or install from/to a USB existing. Some feedback would be a bonus ;)--uNiversal 03:32, 24 December 2012 (EST)

::Sorry about that. But yeah, it looks great and you've done a good job. The note template is nice, too. -- [[User:Ned Scott|Ned Scott]] 06:06, 24 December 2012 (EST)

== Roboto Bold Caps ==

I modified roboto bold font for XBMC and happened to notice IOS known issues - has a problem that will probably be resolved by this font

[[Known_Frodo_issues]] [[Talk:Known_Frodo_issues]]

Please pass around to devs thx--uNiversal 13:19, 4 January 2013 (EST)

== Adding link to wiki article in forum post/signature. ==

Hi Ned.

In reference to having links in forum post or signature (because of character limitation being 300 and BB code counting to this limit) to wiki contained info, could you slap a couple of examples, you mentioned it was small but idk how to.
For example If wanted to link to a section e.g. [[AudioEngine/HOW-TO:_Configure_audio#Audio_Output_Settings_Guide]] or a page [[AudioEngine/HOW-TO:_Configure_audio]] in forums how would would one achieve that? TIA--uNiversal 11:32, 6 February 2013 (EST)

== Thanks for the scrub. ==

Hello Ned. Just wanted to drop by and say thanks for scrubbing those revisions for me. Much appreciated. [[User:Powder21|Powder21]] 15:32, 23 February 2013 (EST)

== Spammers ==

This guy sneaked a clever one [[User:Supperskidvn]] in [[XBMC_Quick_Start_Guide]] Deleted link.--uNiversal 05:43, 26 February 2013 (EST)

== Cannot find video add on Mediathek ==

Hi Ned,
Is there a reason why I can no longer find mediathek on the xbmc video add ons?

Regards Blotto

[[User:Blotto|Blotto]] 09:22, 6 March 2013 (EST)

== Template note ==

Since you locking template note from all and any attempts from me to improve it here [[Template_talk:Note]] Please help me figure out how to do it that way which is best for wrapping and long notes etc.--uNiversal 05:18, 28 March 2013 (EDT)
:Just... give me a moment. -- [[User:Ned Scott|Ned Scott]] 05:20, 28 March 2013 (EDT)
::Any advances? --uNiversal 05:57, 30 March 2013 (EDT)

:::Still waiting on this here. Just a reminder :D--uNiversal 03:26, 11 April 2013 (EDT)

;Ok, still waiting on this and now found that when using = sign inside a note template it breaks the template even if enclosing <nowiki><code>=</code></nowiki> tags, dont want to be annoying and I dont understand html enough to fix it. Nor how to enhance it so it works with larger blocks of text--uNiversal 05:10, 23 April 2013 (EDT)

::I still don't see what's broken on it for "long" notes, but we really shouldn't be using a template/style like this for long notes. A "note" should be something quick and pointing out stuff that is easy to miss. If most of a page is all "notes" then they're not really "notes", but the actual subject of the page.

::As for =, you just put in <nowiki>{{note|1=</nowiki> and that will prevent all additional = from causing issues. It will prevent the template from thinking that everything before the = is a custom parameter.

::The template has been unlocked for a week or so. I would like to see it kept simple and not have icons and advanced formatting. It's just an easy way to grab attention for things that can be easily missed. -- [[User:Ned Scott|Ned Scott]] 14:08, 23 April 2013 (EDT)

::: Well the only thing it needs is aligment when its a larger portion of text i.e. more than one paragraph/line long. Otherwise its fine. Howevr its this aligment I dont understand how to achieve.--uNiversal 17:09, 23 April 2013 (EDT)

:::;See [[Template_talk:Note]] for the how is and how it should look. I cant get the right template formula. needs experienced eyes.--uNiversal 13:08, 25 April 2013 (EDT)

Aaaaaaaaaaaaaaaaaaaaaaaaah! -- [[User:Ned Scott|Ned Scott]] 17:12, 25 April 2013 (EDT)
:: great I spend all this time trying to figure it out and the answer (now so close) is forget about it!!! Yey, why even bothe :( --uNiversal 17:18, 25 April 2013 (EDT)

==Category rename==
Category:XBMC_Live should be renamed Category:XBMCbuntu now see [[Category_talk:XBMC_Live]]
I Dont seem to have move available to me anymore and cannot rename pages.--uNiversal 02:52, 8 April 2013 (EDT)

:Because categories can't be renamed. You just make a new category and change the pages over. -- [[User:Ned Scott|Ned Scott]] 03:33, 8 April 2013 (EDT)

== AirPlay DRM ==

Well, doesn't that suggest everything with DRM doesn't work? To my knowledge SVTplay use DRM, and it works. Though I guess the list still might get too long. [[User:Udepub|Udepub]] 03:43, 22 April 2013 (EDT)

:The only DRM that XBMC's AirPlay can handle is audio (AirTunes). Most AirPlay video streams are unencrypted. -- [[User:Ned Scott|Ned Scott]] 12:43, 22 April 2013 (EDT)

== TemplateHow-to ==

Great stuff, see it in use @[[User:UNiversal]] Thnaks a lot for doing it. Added some template documentation based on your sandbox.--uNiversal 13:28, 23 April 2013 (EDT)

:Hold off on that. It's not done yet and might change dramatically. -- [[User:Ned Scott|Ned Scott]] 14:02, 23 April 2013 (EDT)

:: Too late, hehe to be holding off, if it changes dramatically then I guess Im stuck fixing all that is done so far and it will take longer to be ready content for main wiki. Its still a good template. Love it.--uNiversal 17:07, 23 April 2013 (EDT)

== Frodo templates ==

Please hold off on updating those templates. There are still pages that are using them and need to be updated. -- [[User:Ned Scott|Ned Scott]] 21:04, 11 March 2013 (EDT)

: Ideally to avoid creating release specific templates, one/several should exist where you fill in the release name just like the message and just have a <nowiki>{{FR|Release|raw=msg}}</nowiki> name (future release) sor of thing, idk, beyond my abilities.--uNiversal 10:34, 25 April 2013 (EDT)

== New ICON tango ==

They all been replaced but if they final revision or correct icon idk, need a little time, as tonight Im done. Since Im doing all these manually, cause wiki cant handle svg and some I modify colors. Some look great--uNiversal 21:06, 10 May 2013 (EDT)

== Stop text flying out the boundaries. ==

See [[XBMC_Skinning_Manual#addon.xml_for_skins]] and [[Advancedsettings.xml#.3Ccleanstrings.3E]] for examples of text not wrapping its just keeps going, many many pages and many instances on single pages suffer from this problem. Please help.--uNiversal 05:57, 11 May 2013 (EDT)
:I am aware of the issue and am working on a fix. -- [[User:Ned Scott|Ned Scott]] 10:17, 11 May 2013 (EDT)

==Discussions==

You making any contributions harder and harder, like pulling teeth trying to help lately, both forums and now here... You want me to discuss stuff now but just delete my work and lock me out without discussing anything? Message received"--uNiversal 10:36, 11 May 2013 (EDT)

== XBMC on Pcduino. ==

Hi Ned! I have a Pcduino, yesterday I upgraded that device, so, the XBMC version on my Pcduino is 12.0. Which is the last XBMC version for a Pcduino? Is it the same for a Raspberry Pi?

Thanks!
[[User:Madzero|Madzero]] ([[User talk:Madzero|talk]]) 15:32, 7 August 2013 (EDT)

:Sorry, but I really don't know anything specific about the PCduino. Your best bet is to ask this in the Android section of http://forum.xbmc.org -- [[User:Ned Scott|Ned Scott]] ([[User talk:Ned Scott|talk]]) 18:45, 7 August 2013 (EDT)

== Possibility to remove or merge redundant Raspbmc FAQ's. ==

I propose that there is no need for this redundancy and that one FAQ entry should be sufficient to avoid confusion and the possibility of the two offering conflicting info. I would like to have some time to complete one of these entries with some info from the other and then have one removed. I don't know if this is possible or acceptable, so any guidance here would be appreciated. These are the links I am concerned with.
http://wiki.xbmc.org/index.php?title=Raspbmc/FAQ
http://wiki.xbmc.org/index.php?title=Raspbmc
Thanks in advance!
[[User:ActionA|ActionA]] ([[User talk:ActionA|talk]]) 10:12, 2 October 2013 (EDT)

== Linux FAQ Edits 2nd Feb 2014 ==

Ned -

Okay, I've done some work to at least re-format and tidy up the Linux FAQ page. I've tried to leave the content "as is", but reflect the formatting and syntax that I see elsewhere (e.g. use the FAQ template instead of == HEADINGS ==).

Now, I'm aware that there's no apparent save-to-draft or share-as-a-preview function, so I've made changes to a live page as part of my induction, which isn't ideal. Sooo.... can you take a look, please, and either offer me some coaching or wilfully stamp all over my changes, please. I'd rather get the feedback now, before I go off to edit anything else, plus any reversions are easier now than they would be once other folk come along and make changes on top of mine.

Cheers,

Ian
[[User:Prof Yaffle|Prof Yaffle]] ([[User talk:Prof Yaffle|talk]]) 10:00, 2 February 2014 (EST)

:Looks good. As far as showing off drafts, I normally make a sandbox page in my "userspace" like this [[User:Ned Scott/Sandbox]], and just keep reusing the same page, or sometimes making additional sandbox pages and numbering them. Live editing the main page is okay too, and is actually in the basic nature of wikis :) As they would say on Wikipedia, [[w:be bold|be bold]]! -- [[User:Ned Scott|Ned Scott]] ([[User talk:Ned Scott|talk]]) 15:20, 2 February 2014 (EST)

::Thanks... I suppose there's also the option of using the talk pages to draft or propose something if all else fails, but the sandbox looks the perfect way to trial, draft and generally tinker.

::Now, what else can I hack up as an encore... :-)

::Cheers! [[User:Prof Yaffle|Prof Yaffle]] ([[User talk:Prof Yaffle|talk]]) 15:33, 3 February 2014 (EST)

User talk:Ned Scott

2014-02-02T15:00:19Z

Prof Yaffle: /* Linux FAQ Edits 2nd Feb 2014 */ new section

Archive:Linux FAQ

2014-02-02T14:56:18Z

Prof Yaffle:

{{mininav|[[General topics]]{{l2|[[Devices]]}}|[[FAQs]]{{l2|[[Linux]]}} }}
{{cleanup}}
{{FAQ header|for XBMC running under Linux-based operating systems.}}
{{XBMC FAQ}}
__TOC__
{{-}}

== Caveat ==
:There are no official XBMC builds for Linux distributions other than Ubuntu yet. If you use something other than Ubuntu, check to see if XBMC is available via your repositories or normal software installation method.

:<big>''See also: '''[[Installing XBMC for Linux]]''' for how to install XBMC on other distributions.''</big>

== General FAQ ==
:<big>''See also: '''[[XBMC all platforms FAQ]]''' for FAQs that apply to all versions of XBMC.''</big>

{| width="100%"
{{FAQ|1= Support
| BGcolor=
| Question= I'm here because I've got a problem, so what do I do if I'm still stuck afterwards?
| Answer=
If you run into issues it is helpful to gather all of the basic information, especially when you're thinking about starting an XBMC forum thread or opening a report on the XBMC bug tracker. Below is a list of information that should be included in a forum post '''as a minimum'''. As a rule, you should include anything that's relevant, such as recent changes, detailed media information, etc. 

* '''Compulsory''' xbmc.log with '''debugging enabled''', which contains the problem or issue you're experiencing.
* '''Video driver problems:''' Include a copy of your '''/var/log/Xorg.0.log''' in addition to your debug log.
* Use a '''pastesite''' for logs: do not post logs in-line on forums. On '''trac''', you should attach/upload the logs with your report.
* '''System specs:''' ('''CPU''', '''GPU''', etc.)
* '''Playback Problems:''' include '''video''' codec (e.g. MPEG-2, H.264) and container (e.g. .mkv, .mp4, .avi) or '''audio''' codec (e.g. FLAC, MP3) and container. If possible, include samples.
* '''Details''' of steps you took to attempt to fix it, if any. Describe what it is you tried when posting.
* '''Steps''' to duplicate your problem in detail.
* '''Screenshots''' that may help illustrate your problem or show your current settings. Use sites like [http://snag.gy/ snag.gy] or [http://www.postimage.org/ postimage].

For help/support visit [http://forum.xbmc.org/ '''XBMC Community Forums'''] or IRC [irc://freenode.net/ '''#xbmc-linux''']

{{see also|HOW-TO:Submit a bug report}}
}}

{{FAQ|1= Logfile
| BGcolor= WhiteSmoke
| Question= Where's my log file?
| Answer=
In Linux your XBMC log is located in:
<source lang="bash">$HOME/.xbmc/temp/xbmc.log</source> 
{{note|The location of the log assumes you are logged in as the '''<big>xbmc user</big>''' and not '''<big>root</big>'''.}} 
'''''See also:''''' [[SSH|Accessing XBMC via SSH]] e.g. Putty
}}

{{FAQ|1= Debugfile
| BGcolor=
| Question= How do I upload my log file?
| Answer=
You can generate a debug log [http://en.wikipedia.org/wiki/Pastebin Pastebin] link automatically. This allows you to quickly post a log to anywhere that requires it.
 
{{Note|Don't forget to [[Log file#Enable Debugging|'''Enable Debugging''']] when creating the log so that maximum detail is available}} 
<source lang="bash">$ sudo apt-get install pastebinit -y
$ cat $HOME/.xbmc/temp/xbmc.log | pastebinit</source>
}}

{{FAQ|1= UserData
| BGcolor= WhiteSmoke
| Question= Where's the UserData folder?
| Answer=
<source lang="bash">$HOME/.xbmc/userdata</source>
}}

{{FAQ|1= InstallationDirectory
| BGcolor=
| Question= Where is XBMC installed?
| Answer=
The installation paths are as below:

<source lang="bash">/usr/share/xbmc/
/usr/lib/xbmc/</source> 

{{Note|No user XBMC configuration files are kept in these locations; refer to [[userdata]] for these.}}
}}

{{FAQ|1= DiscPlayback
| BGcolor= WhiteSmoke
| Question= Does XBMC for Linux support Blu-ray or HD DVD playback with or without menus?
| Answer=
Yes, without menus. As of Dharma (10.0), XBMC includes support for playback of '''unencrypted''' Blu-ray directories when [http://www.videolan.org/developers/libbluray.html libbluray] is installed. However, XBMC must be compiled from [https://github.com/xbmc/xbmc source]. Installing from a repository like the [https://launchpad.net/~team-xbmc/+archive/unstable Team-XBMC unstable ppa] will not recognize whether libbluray is installed.

Currently, only the longest title is played from the Blu-ray directory, even on multi-video Blu-rays (e.g. TV shows). To play a Blu-ray directory, select the /BDMV/index.bdmv in the Blu-ray directory. If stacking is enabled, selecting the Blu-ray directory folder will start playback.

;Frodo v12 includes better support for bluray .iso and folder, there is still work in progress in this area for post Frodo.

To play Blu-ray discs in XBMC with MakeMKV, see below.

{{forum link2|[[forum:67420|playback Blu-ray Disc in XBMC for Linux with MakeMKV (Plugin Addon) Discussion thread]]}}
}}

{{FAQ|1= Distros
| BGcolor=
| Question= What Linux distributions are supported?
| Answer=
Check the '''[[HOW-TO:Install XBMC for Linux|install page]]''' for a list of supported distributions.
}}

{{FAQ|1= Hardware
| BGcolor= WhiteSmoke
| Question= What are the current recommended hardware requirements for XBMC?
| Answer=
For end-users the recommended minimum requirement is an [http://en.wikipedia.org/wiki/X86 x86-based computer], with a [http://en.wikipedia.org/wiki/Graphics_Processing_Unit 3D GPU (Graphics Processing Unit)] that at least supports [http://en.wikipedia.org/wiki/Shader_model Shader Model 3.0] and [http://en.wikipedia.org/wiki/OpenGL OpenGL 2.0] (that features 24bpp or 32bpp for 3D hardware-acceleration support, which the XBMC GUI needs to run smoothly at an acceptable frame-rate). Graphic adapters that support [http://en.wikipedia.org/wiki/DirectX DirectX version 9.0c] or later usually meet all of those mentioned requirements, ([[Team-XBMC]] recommends [http://en.wikipedia.org/wiki/Nvidia NVIDIA GeForce 6150 or later] as NVIDIA are currently the manufacturer that offers [http://en.wikipedia.org/wiki/Graphics_hardware_and_FOSS good device-drivers for Linux] (and [http://en.wikipedia.org/wiki/Nvidia NVIDIA GeForce 6150 or later] supports OpenGL 2.0)).
}}

{{FAQ|1= LinuxHardware
| BGcolor=
| Question= XBMC for Linux minimum requirements
| Answer=
{{#lst:Supported hardware|Linux}}
}}

|}

== Troubleshooting: General ==
{| width="100%"
{{FAQ|1= BootIssues
| BGcolor=
| Question= Boot Issues
| Answer =
Some Intel GPUs have issues with rc6 it can be disabled via grub.
<source lang="bash">$ sudo nano /etc/default/grub</source>

Append '''i915.i915_enable_rc6=0''' to:

<source lang="xml">GRUB_CMDLINE_LINUX_DEFAULT="quiet splash i915.i915_enable_rc6=0"</source>

* Press {{keypress|ctrl|X}} say '''YES''' to save file

;Then run

<source lang="bash">$ sudo update-grub</source>
}}
|}

== Troubleshooting: Video ==
:{{incomplete}}
:Most of the problems that you encounter with slow display, playback or OpenGL related errors on Linux are because you do not have the proper display drivers installed, or because your versions are outdated. Using the correct drivers or updating can be a decisive step in resolving some issues.

{| width="100%"

{{FAQ|1= InstallOnUbuntu
| BGcolor=
| Question= Installing video drivers on Ubuntu and derivatives
| Answer =
:* For '''NVIDIA''' drivers follow the guide [https://help.ubuntu.com/community/BinaryDriverHowto/Nvidia click this (link)]
:* For '''ATI''' drivers follow the guide [https://help.ubuntu.com/community/BinaryDriverHowto/ATI click this (link)]
:* For '''Intel''' it is simpler since the drivers are open source so they are usually already pre-installed. You need to make sure that you use the newer '''Intel''' driver and not the older '''i810''' driver or the 'vesa' driver. This could be verified by checking the 'Driver' value in /etc/X11/xorg.conf.
:Make sure your hardware acceleration '''libva''' or '''sna''' is installed and working.
:Deinterlacing in Intel hardware needs cutting edge drivers like '''xserver-xorg-video-intel''', '''libva-intel-vaapi-driver''' 

Below, you can find forum discussions on various relevant topics, including complete setups and configuration of drivers. '''No NVIDIA forum discussion link exists yet, so please add links if you know of any relevant ones.''' 

{{forum link2|[[forum:|NVidia Place Holder forum discussion thread ?]]}}
{{forum link2|[[forum:116996|XVBA for AMD Radeon/Fusion/NVidia forum discussion thread]]}}
{{forum link2|[[forum:114368|Intel GPU forum discussion thread]]}} 
}}

{{FAQ|1= UpgradingNVIDIA
| BGcolor= WhiteSmoke
| Question= Upgrading NVIDIA drivers on Ubuntu and derivatives
| Answer =
Ubuntu (including XBMCbuntu) often ships with outdated drivers that do not fully support a platform.
Make sure that old versions of the NVIDIA drivers are removed if you use other third-party PPAs (repositories). For the sake of your sanity, '''don't remove any Ubuntu sources''', as that is highly likely to break something.

<source lang="bash">
$ sudo apt-get install python-software-properties pkg-config
$ sudo add-apt-repository -r ppa:the_3rd_party_ppa_you_wish_to_remove_here
$ sudo add-apt-repository ppa:ubuntu-x-swat/x-updates
$ apt-get update
$ sudo apt-get install nvidia-current nvidia-settings
</source> 

{{forum link2|[[forum:142220|NVidia Drivers updates XBMCBuntu, Ubuntu and variants forum discussion thread]]}} 
}}

{{FAQ|1= IntelSNA
| BGcolor=
| Question= Intel SNA Acceleration
| Answer =
Intel uses VAAPI for GPU-accelerated video playback decoding, however there are other acceleration methods in the pipeline like SNA.
The use of GPU acceleration is an essential part of getting both smooth video playback and a lag-free interface (GUI).
Create or edit your existing '''/etc/X11/xorg.conf''' and add to section '''Device''' as below.

<source lang="xml">Section "Device"
Identifier "Intel Graphics"
Driver "intel"
Option "AccelMethod" "sna"
EndSection</source>

For more information on '''SNA''', see: [http://www.phoronix.com/scan.php?page=article&item=intel_sna_july2012&num=1 '''Intel SNA vs. UXA On Ivy Bridge''']

{{forum link2|[[forum:144633|Optimal video settings for Intel GPU forum discussion thread]]}}
}}

{{FAQ|1= VerifyOpenGL
| BGcolor= WhiteSmoke
| Question= Verify OpenGL Support
| Answer =
Once you have your drivers in place, you need to make sure that OpenGL is properly configured. Run the following command:

<source lang="bash">
# glxinfo | grep -i direct
</source>

The result should be:
<pre>Direct rendering: Yes</pre>
If the result is "'''No'''", it means that the display driver have not been properly configured. Also, you can run the command '''glxgears''' and you should see the wheels turning smoothly.
}}

{{FAQ|1= Compiz
| BGcolor=
| Question= Compiz is not compatible with XBMC
| Answer =
There are several ways to address this.

* Make sure Compiz visual effects are disabled. You can do this by going to ''System'' -> ''Preferences'' -> ''Appearance'' -> ''Visual Effects''. Make sure "None" is selected.

* Alternatively, you can tell Compiz not to interfere with XBMC. Install and run CompizConfig, and under '''General Options''' tick "Unredirect Fullscreen Windows".

* For NVIDIA, you can disable this in xorg.conf, like so:
:<syntaxhighlight lang="xml" enclose="div">
Section "Extensions"
Option "Composite" "Disable"
EndSection
</syntaxhighlight>

* Or, again for NVIDIA, you can disable Compiz directly at a terminal prompt:
:<source lang="bash">$ sudo nvidia-xconfig --no-composite</source>
Example minimal xorg.conf for NVIDIA: [[Minimal NVidia xorg.conf]]
}}
|}

== Troubleshooting: Audio ==
{| width="100%"
{{FAQ|1= AudioGeneral
| BGcolor=
| Question= Audio Issues
| Answer =
For XBMC v12 Frodo specific settings please see '''[[AudioEngine]]'''.
}}

{{FAQ|1= NoAudioDevices
| BGcolor= WhiteSmoke
| Question= Why do I get ''no audio devices detected''?
| Answer =
If you have installed lightdm this will happen, it's is not a XBMC issue. A workaround exists.
:<big>'''''See: [[XBMCbuntu#XBMCbuntu no audio devices|XBMCbuntu no audio devices''''']]</big>
}}

{{FAQ|1= RequiredPackages
| BGcolor=
| Question= Required Packages
| Answer=
<source lang="bash">
$ sudo apt-get install alsa-utils libasound2
</source>
}}

{{FAQ|1= NoSound
| BGcolor= WhiteSmoke
| Question= No sound in XBMC
| Answer=
{{Note|'''Unmute channels in alsamixer''' in all cases if you're getting no sound via e.g. HDMI. Just for guidance, a couple of quick reference commands are listed below.}} 
{{tip|Substitute '''IEC958''' with your device ID depending on your '''{{code|aplay -l}} output.}}'''
<source lang="bash">
$ amixer -q set Master 100% unmute
$ amixer -q set PCM 100% unmute
$ amixer -q set 'IEC958',1 unmute
$ amixer -q set 'IEC958',0 unmute
</source> 

{{note|Make sure that your correct sound card is in use in alsamixer. To change your card, press {{keypress|F6}} and then try different cards to make ensure it's not something as simple as using the wrong card - sometimes the onboard card may not be the one you want or need.}} 

{{note|For systems that have '''multiple sound cards''' e.g. ''Intel Azalia (internal) - GT520 (external)'', you could try to disable the onboard card in your system BIOS if it's not in use. This is suitable where, for example, you're using a Soundblaster or perhaps a video card that also supports audio e.g. HDA NVIDIA.}}
}}

{{FAQ|1= HDMIRemapping
| BGcolor=
| Question= HDMI Channel Audio remapping
| Answer=
Some combinations of systems (e.g. ION) and receivers may have incorrectly mapped HDMI channels.
'''''See also:'' [[HOW-TO:Remap_HDMI_audio_on_Gen_1_ION_-_Linux|HOW-TO: Remap HDMI audio on Gen 1 ION - Linux''']]
}}
|}

== Dual Audio Setup ==
{| width="100%"
This is an ultimate goal for some XBMC users. With the move to [[AudioEngine]] it becomes more complex and even impossible in some cases.

One XBMC forum user, '''puntloos''', posted his finding which seem to work relatively well for his setup. Bear in mind that this will not be universal, though, and thus may not work under other circumstances.
 

{{forum link2|[[forum:145430|Setting up dual audio forum discussion thread]]}}
|}

== Updating XBMC ==
:{{incomplete}}
:We obviously recommend the use of our PPAs, but we recognise that Ubuntu is only one of the many Linux distributions in use and users will also have Archlinux, Debian or Gentoo (amongst many others). Please feel free to provide details on how you can upgrade packages on these and other distros. The details below are thus really intended for XBMCbuntu and Ubuntu variant (Xubuntu, Kubuntu, Mint...) installations.

{| width="100%"
{{FAQ|1= UbuntuPackages
| BGcolor=
| Question= Where are the XBMC packages for Ubuntu/Debian?
| Answer=
;Official
* https://launchpad.net/~team-xbmc/+archive/ppa '''ppa:team-xbmc/ppa'''
* https://launchpad.net/~team-xbmc/+archive/unstable '''ppa:team-xbmc/unstable'''
* https://launchpad.net/~team-xbmc/+archive/xbmc-nightly '''ppa:team-xbmc/xbmc-nightly'''
;Xvba and improved Vdpau (not mainline)
* https://launchpad.net/~wsnipex/+archive/xbmc-xvba '''ppa:wsnipex/xbmc-xvba'''
* https://launchpad.net/~wsnipex/+archive/xbmc-xvba-frodo '''ppa:wsnipex/xbmc-xvba-frodo'''

;3rd party (contains older Ubuntu support etc)
* https://launchpad.net/~nathan-renniewaldock/+archive/xbmc-stable '''ppa:nathan-renniewaldock/xbmc-stable'''
* https://launchpad.net/~nathan-renniewaldock/+archive/xbmc-nightly '''ppa:nathan-renniewaldock/xbmc-nightly'''
* http://www.loggn.de/ubuntu-xbmc-repository-11-eden-airplay-pvr-livetv/
}}

{{FAQ|1= UbuntuUpdate
| BGcolor= WhiteSmoke
| Question= Ubuntu manual XBMC upgrade process
| Answer=
{{greenv|'''NOTICE:'''|[[XBMC v12 (Frodo) FAQ#What might break when upgrading to v12.3F .28Audio and Video.2C add-ons.2C skins.2C remotes.29|'''What might break when upgrading to v12''']] is a must-read for users upgrading to a final version.}}
Below is the process to upgrade XBMC manually and/or change the repository being used if you have a different source PPA (it is recommended to remove any previous PPAs that contain the same package sources). '''If you use other distros, please update or add a subsection with relevant information'''.

Connect to your Debian/Ubuntu-based system via [[SSH]] and run the commands below:

<source lang="bash">
$ sudo apt-get install python-software-properties pkg-config
$ sudo add-apt-repository -r ppa:current_XBMC_providing_ppa
$ sudo add-apt-repository ppa:the_ppa_you_wish_to_use
$ sudo apt-get update
$ sudo apt-get upgrade
$ sudo apt-get remove xbmc xbmc.bin
$ sudo apt-get install xbmc xbmc.bin
</source>
}}

{{FAQ|1= ArchUpgrade
| BGcolor=
| Question= Arch manual XBMC upgrade process
| Answer=
This part needs to be updated <big>'''?'''</big>
}}

{{FAQ|1= FreeBSDUpgrade
| BGcolor= WhiteSmoke
| Question= FreeBSD manual XBMC upgrade process
| Answer=
Upgrading XBMC in FreeBSD is pretty simple, as long as a new version exists in port

* Update your port tree:
:<pre>$ portsnap fetch update</pre>
* Update XBMC:
:<pre>$ portmaster multimedia/xbmc</pre>
}}

{{FAQ|1= GentooUpgrade
| BGcolor=
| Question= Gentoo manual XBMC upgrade process
| Answer=
This part needs to be updated <big>'''?'''</big>
}}
|}

== Known issues ==
{| width="100%"
'''''See:''''' [[XBMC v12 (Frodo) issues]]
|}

[[Category:XBMC Manual]]
[[Category:FAQ|Linux]]
[[Category:Linux|*]]
[[Category:Troubleshooting]]
{{frodo updated}}

Archive:Linux FAQ

2014-02-02T14:54:54Z

Prof Yaffle:

{{mininav|[[General topics]]{{l2|[[Devices]]}}|[[FAQs]]{{l2|[[Linux]]}} }}
{{cleanup}}
{{FAQ header|for XBMC running under Linux-based operating systems.}}
{{XBMC FAQ}}
__TOC__
{{-}}

== Caveat ==
:There are no official XBMC builds for Linux distributions other than Ubuntu yet. If you use something other than Ubuntu, check to see if XBMC is available via your repositories or normal software installation method.

:<big>''See also: '''[[Installing XBMC for Linux]]''' for how to install XBMC on other distributions.''</big>

== General FAQ ==
:<big>''See also: '''[[XBMC all platforms FAQ]]''' for FAQs that apply to all versions of XBMC.''</big>

{| width="100%"
{{FAQ|1= Support
| BGcolor=
| Question= I'm here because I've got a problem, so what do I do if I'm still stuck afterwards?
| Answer=
If you run into issues it is helpful to gather all of the basic information, especially when you're thinking about starting an XBMC forum thread or opening a report on the XBMC bug tracker. Below is a list of information that should be included in a forum post '''as a minimum'''. As a rule, you should include anything that's relevant, such as recent changes, detailed media information, etc. 

* '''Compulsory''' xbmc.log with '''debugging enabled''', which contains the problem or issue you're experiencing.
* '''Video driver problems:''' Include a copy of your '''/var/log/Xorg.0.log''' in addition to your debug log.
* Use a '''pastesite''' for logs: do not post logs in-line on forums. On '''trac''', you should attach/upload the logs with your report.
* '''System specs:''' ('''CPU''', '''GPU''', etc.)
* '''Playback Problems:''' include '''video''' codec (e.g. MPEG-2, H.264) and container (e.g. .mkv, .mp4, .avi) or '''audio''' codec (e.g. FLAC, MP3) and container. If possible, include samples.
* '''Details''' of steps you took to attempt to fix it, if any. Describe what it is you tried when posting.
* '''Steps''' to duplicate your problem in detail.
* '''Screenshots''' that may help illustrate your problem or show your current settings. Use sites like [http://snag.gy/ snag.gy] or [http://www.postimage.org/ postimage].

For help/support visit [http://forum.xbmc.org/ '''XBMC Community Forums'''] or IRC [irc://freenode.net/ '''#xbmc-linux''']

{{see also|HOW-TO:Submit a bug report}}
}}

{{FAQ|1= Logfile
| BGcolor= WhiteSmoke
| Question= Where's my log file?
| Answer=
In Linux your XBMC log is located in:
<source lang="bash">$HOME/.xbmc/temp/xbmc.log</source> 
{{note|The location of the log assumes you are logged in as the '''<big>xbmc user</big>''' and not '''<big>root</big>'''.}} 
'''''See also:''''' [[SSH|Accessing XBMC via SSH]] e.g. Putty
}}

{{FAQ|1= Debugfile
| BGcolor=
| Question= How do I upload my log file?
| Answer=
You can generate a debug log [http://en.wikipedia.org/wiki/Pastebin Pastebin] link automatically. This allows you to quickly post a log to anywhere that requires it.
 
{{Note|Don't forget to [[Log file#Enable Debugging|'''Enable Debugging''']] when creating the log so that maximum detail is available}} 
<source lang="bash">$ sudo apt-get install pastebinit -y
$ cat $HOME/.xbmc/temp/xbmc.log | pastebinit</source>
}}

{{FAQ|1= UserData
| BGcolor= WhiteSmoke
| Question= Where's the UserData folder?
| Answer=
<source lang="bash">$HOME/.xbmc/userdata</source>
}}

{{FAQ|1= InstallationDirectory
| BGcolor=
| Question= Where is XBMC installed?
| Answer=
The installation paths are as below:

<source lang="bash">/usr/share/xbmc/
/usr/lib/xbmc/</source> 

{{Note|No user XBMC configuration files are kept in these locations; refer to [[userdata]] for these.}}
}}

{{FAQ|1= DiscPlayback
| BGcolor= WhiteSmoke
| Question= Does XBMC for Linux support Blu-ray or HD DVD playback with or without menus?
| Answer=
Yes, without menus. As of Dharma (10.0), XBMC includes support for playback of '''unencrypted''' Blu-ray directories when [http://www.videolan.org/developers/libbluray.html libbluray] is installed. However, XBMC must be compiled from [https://github.com/xbmc/xbmc source]. Installing from a repository like the [https://launchpad.net/~team-xbmc/+archive/unstable Team-XBMC unstable ppa] will not recognize whether libbluray is installed.

Currently, only the longest title is played from the Blu-ray directory, even on multi-video Blu-rays (e.g. TV shows). To play a Blu-ray directory, select the /BDMV/index.bdmv in the Blu-ray directory. If stacking is enabled, selecting the Blu-ray directory folder will start playback.

;Frodo v12 includes better support for bluray .iso and folder, there is still work in progress in this area for post Frodo.

To play Blu-ray discs in XBMC with MakeMKV, see below.

{{forum link2|[[forum:67420|playback Blu-ray Disc in XBMC for Linux with MakeMKV (Plugin Addon) Discussion thread]]}}
}}

{{FAQ|1= Distros
| BGcolor=
| Question= What Linux distributions are supported?
| Answer=
Check the '''[[HOW-TO:Install XBMC for Linux|install page]]''' for a list of supported distributions.
}}

{{FAQ|1= Hardware
| BGcolor= WhiteSmoke
| Question= What are the current recommended hardware requirements for XBMC?
| Answer=
For end-users the recommended minimum requirement is an [http://en.wikipedia.org/wiki/X86 x86-based computer], with a [http://en.wikipedia.org/wiki/Graphics_Processing_Unit 3D GPU (Graphics Processing Unit)] that at least supports [http://en.wikipedia.org/wiki/Shader_model Shader Model 3.0] and [http://en.wikipedia.org/wiki/OpenGL OpenGL 2.0] (that features 24bpp or 32bpp for 3D hardware-acceleration support, which the XBMC GUI needs to run smoothly at an acceptable frame-rate). Graphic adapters that support [http://en.wikipedia.org/wiki/DirectX DirectX version 9.0c] or later usually meet all of those mentioned requirements, ([[Team-XBMC]] recommends [http://en.wikipedia.org/wiki/Nvidia NVIDIA GeForce 6150 or later] as NVIDIA are currently the manufacturer that offers [http://en.wikipedia.org/wiki/Graphics_hardware_and_FOSS good device-drivers for Linux] (and [http://en.wikipedia.org/wiki/Nvidia NVIDIA GeForce 6150 or later] supports OpenGL 2.0)).
}}

{{FAQ|1= LinuxHardware
| BGcolor=
| Question= XBMC for Linux minimum requirements
| Answer=
{{#lst:Supported hardware|Linux}}
}}

|}

== Troubleshooting: General ==
{| width="100%"
{{FAQ|1= BootIssues
| BGcolor=
| Question= Boot Issues
| Answer =
Some Intel GPUs have issues with rc6 it can be disabled via grub.
<source lang="bash">$ sudo nano /etc/default/grub</source>

Append '''i915.i915_enable_rc6=0''' to:

<source lang="xml">GRUB_CMDLINE_LINUX_DEFAULT="quiet splash i915.i915_enable_rc6=0"</source>

* Press {{keypress|ctrl|X}} say '''YES''' to save file

;Then run

<source lang="bash">$ sudo update-grub</source>
}}
|}

== Troubleshooting: Video ==
:{{incomplete}}
:Most of the problems that you encounter with slow display, playback or OpenGL related errors on Linux are because you do not have the proper display drivers installed, or because your versions are outdated. Using the correct drivers or updating can be a decisive step in resolving some issues.

{| width="100%"

{{FAQ|1= InstallOnUbuntu
| BGcolor=
| Question= Installing video drivers on Ubuntu and derivatives
| Answer =
:* For '''NVIDIA''' drivers follow the guide [https://help.ubuntu.com/community/BinaryDriverHowto/Nvidia click this (link)]
:* For '''ATI''' drivers follow the guide [https://help.ubuntu.com/community/BinaryDriverHowto/ATI click this (link)]
:* For '''Intel''' it is simpler since the drivers are open source so they are usually already pre-installed. You need to make sure that you use the newer '''Intel''' driver and not the older '''i810''' driver or the 'vesa' driver. This could be verified by checking the 'Driver' value in /etc/X11/xorg.conf.
:Make sure your hardware acceleration '''libva''' or '''sna''' is installed and working.
:Deinterlacing in Intel hardware needs cutting edge drivers like '''xserver-xorg-video-intel''', '''libva-intel-vaapi-driver''' 

Below, you can find forum discussions on various relevant topics, including complete setups and configuration of drivers. '''No NVIDIA forum discussion link exists yet, so please add links if you know of any relevant ones.''' 

{{forum link2|[[forum:|NVidia Place Holder forum discussion thread ?]]}}
{{forum link2|[[forum:116996|XVBA for AMD Radeon/Fusion/NVidia forum discussion thread]]}}
{{forum link2|[[forum:114368|Intel GPU forum discussion thread]]}} 
}}

{{FAQ|1= UpgradingNVIDIA
| BGcolor= WhiteSmoke
| Question= Upgrading NVIDIA drivers on Ubuntu and derivatives
| Answer =
Ubuntu (including XBMCbuntu) often ships with outdated drivers that do not fully support a platform.
Make sure that old versions of the NVIDIA drivers are removed if you use other third-party PPAs (repositories). For the sake of your sanity, '''don't remove any Ubuntu sources''', as that is highly likely to break something.

<source lang="bash">
$ sudo apt-get install python-software-properties pkg-config
$ sudo add-apt-repository -r ppa:the_3rd_party_ppa_you_wish_to_remove_here
$ sudo add-apt-repository ppa:ubuntu-x-swat/x-updates
$ apt-get update
$ sudo apt-get install nvidia-current nvidia-settings
</source> 

{{forum link2|[[forum:142220|NVidia Drivers updates XBMCBuntu, Ubuntu and variants forum discussion thread]]}} 
}}

{{FAQ|1= IntelSNA
| BGcolor=
| Question= Intel SNA Acceleration
| Answer =
Intel uses VAAPI for GPU-accelerated video playback decoding, however there are other acceleration methods in the pipeline like SNA.
The use of GPU acceleration is an essential part of getting both smooth video playback and a lag-free interface (GUI).
Create or edit your existing '''/etc/X11/xorg.conf''' and add to section '''Device''' as below.

<source lang="xml">Section "Device"
Identifier "Intel Graphics"
Driver "intel"
Option "AccelMethod" "sna"
EndSection</source>

For more information on '''SNA''', see: [http://www.phoronix.com/scan.php?page=article&item=intel_sna_july2012&num=1 '''Intel SNA vs. UXA On Ivy Bridge''']

{{forum link2|[[forum:144633|Optimal video settings for Intel GPU forum discussion thread]]}}
}}

{{FAQ|1= VerifyOpenGL
| BGcolor= WhiteSmoke
| Question= Verify OpenGL Support
| Answer =
Once you have your drivers in place, you need to make sure that OpenGL is properly configured. Run the following command:

<source lang="bash">
# glxinfo | grep -i direct
</source>

The result should be:
<pre>Direct rendering: Yes</pre>
If the result is "'''No'''", it means that the display driver have not been properly configured. Also, you can run the command '''glxgears''' and you should see the wheels turning smoothly.
}}

{{FAQ|1= Compiz
| BGcolor=
| Question= Compiz is not compatible with XBMC
| Answer =
There are several ways to address this.

* Make sure Compiz visual effects are disabled. You can do this by going to ''System'' -> ''Preferences'' -> ''Appearance'' -> ''Visual Effects''. Make sure "None" is selected.

* Alternatively, you can tell Compiz not to interfere with XBMC. Install and run CompizConfig, and under '''General Options''' tick "Unredirect Fullscreen Windows".

* For NVIDIA, you can disable this in xorg.conf, like so:
:<syntaxhighlight lang="xml" enclose="div">
Section "Extensions"
Option "Composite" "Disable"
EndSection
</syntaxhighlight>

* Or, again for NVIDIA, you can disable Compiz directly at a terminal prompt:
:<source lang="bash">$ sudo nvidia-xconfig --no-composite</source>
Example minimal xorg.conf for NVIDIA: [[Minimal NVidia xorg.conf]]
}}
|}

== Troubleshooting: Audio ==
{| width="100%"
{{FAQ|1= AudioGeneral
| BGcolor=
| Question= Audio Issues
| Answer =
For XBMC v12 Frodo specific settings please see '''[[AudioEngine]]'''.
}}

{{FAQ|1= NoAudioDevices
| BGcolor= WhiteSmoke
| Question= Why do I get ''no audio devices detected''?
| Answer =
If you have installed lightdm this will happen, it's is not a XBMC issue. A workaround exists.
:<big>'''''See: [[XBMCbuntu#XBMCbuntu no audio devices|XBMCbuntu no audio devices''''']]</big>
}}

{{FAQ|1= RequiredPackages
| BGcolor=
| Question= Required Packages
| Answer=
<source lang="bash">
$ sudo apt-get install alsa-utils libasound2
</source>
}}

{{FAQ|1= NoSound
| BGcolor= WhiteSmoke
| Question= No sound in XBMC
| Answer=
{{Note|'''Unmute channels in alsamixer''' in all cases if you're getting no sound via e.g. HDMI. Just for guidance, a couple of quick reference commands are listed below.}} 
{{tip|Substitute '''IEC958''' with your device ID depending on your '''{{code|aplay -l}} output.}}'''
<source lang="bash">
$ amixer -q set Master 100% unmute
$ amixer -q set PCM 100% unmute
$ amixer -q set 'IEC958',1 unmute
$ amixer -q set 'IEC958',0 unmute
</source> 

{{note|Make sure that your correct sound card is in use in alsamixer. To change your card, press {{keypress|F6}} and then try different cards to make ensure it's not something as simple as using the wrong card - sometimes the onboard card may not be the one you want or need.}} 

{{note|For systems that have '''multiple sound cards''' e.g. ''Intel Azalia (internal) - GT520 (external)'', you could try to disable the onboard card in your system BIOS if it's not in use. This is suitable where, for example, you're using a Soundblaster or perhaps a video card that also supports audio e.g. HDA NVIDIA.}}
}}

{{FAQ|1= HDMIRemapping
| BGcolor=
| Question= HDMI Channel Audio remapping
| Answer=
Some combinations of systems (e.g. ION) and receivers may have incorrectly mapped HDMI channels.
'''''See also:'' [[HOW-TO:Remap_HDMI_audio_on_Gen_1_ION_-_Linux|HOW-TO: Remap HDMI audio on Gen 1 ION - Linux''']]
}}
|}

== Dual Audio Setup ==
{| width="100%"
This is an ultimate goal for some XBMC users. With the move to [[AudioEngine]] it becomes more complex and even impossible in some cases.

One XBMC forum user, '''puntloos''', posted his finding which seem to work relatively well for his setup. Bear in mind that this will not be universal, though, and thus may not work under other circumstances.
 

{{forum link2|[[forum:145430|Setting up dual audio forum discussion thread]]}}
|}

== Updating XBMC ==
:{{incomplete}}
:We obviously recommend the use of our PPAs, but we recognise that Ubuntu is only one of the many Linux distributions in use and users will also have Archlinux, Debian or Gentoo (amongst many others). Please feel free to provide details on how you can upgrade packages on these and other distros. The details below are thus really intended for XBMCbuntu and Ubuntu variant (Xubuntu, Kubuntu, Mint...) installations.

{| width="100%"
{{FAQ|1= UbuntuPackages
| BGcolor=
| Question= Where are the XBMC packages for Ubuntu/Debian?
| Answer=
;Official
* https://launchpad.net/~team-xbmc/+archive/ppa '''ppa:team-xbmc/ppa'''
* https://launchpad.net/~team-xbmc/+archive/unstable '''ppa:team-xbmc/unstable'''
* https://launchpad.net/~team-xbmc/+archive/xbmc-nightly '''ppa:team-xbmc/xbmc-nightly'''
;Xvba and improved Vdpau (not mainline)
* https://launchpad.net/~wsnipex/+archive/xbmc-xvba '''ppa:wsnipex/xbmc-xvba'''
* https://launchpad.net/~wsnipex/+archive/xbmc-xvba-frodo '''ppa:wsnipex/xbmc-xvba-frodo'''

;3rd party (contains older Ubuntu support etc)
* https://launchpad.net/~nathan-renniewaldock/+archive/xbmc-stable '''ppa:nathan-renniewaldock/xbmc-stable'''
* https://launchpad.net/~nathan-renniewaldock/+archive/xbmc-nightly '''ppa:nathan-renniewaldock/xbmc-nightly'''
* http://www.loggn.de/ubuntu-xbmc-repository-11-eden-airplay-pvr-livetv/
}}

{{FAQ|1= UbuntuUpdate
| BGcolor=
| Question= Ubuntu manual XBMC upgrade process
| Answer=
{{greenv|'''NOTICE:'''|[[XBMC v12 (Frodo) FAQ#What might break when upgrading to v12.3F .28Audio and Video.2C add-ons.2C skins.2C remotes.29|'''What might break when upgrading to v12''']] is a must-read for users upgrading to a final version.}}
Below is the process to upgrade XBMC manually and/or change the repository being used if you have a different source PPA (it is recommended to remove any previous PPAs that contain the same package sources). '''If you use other distros, please update or add a subsection with relevant information'''.

Connect to your Debian/Ubuntu-based system via [[SSH]] and run the commands below:

<source lang="bash">
$ sudo apt-get install python-software-properties pkg-config
$ sudo add-apt-repository -r ppa:current_XBMC_providing_ppa
$ sudo add-apt-repository ppa:the_ppa_you_wish_to_use
$ sudo apt-get update
$ sudo apt-get upgrade
$ sudo apt-get remove xbmc xbmc.bin
$ sudo apt-get install xbmc xbmc.bin
</source>
}}

{{FAQ|1= ArchUpgrade
| BGcolor=
| Question= Arch manual XBMC upgrade process
| Answer=
This part needs to be updated <big>'''?'''</big>
}}

{{FAQ|1= FreeBSDUpgrade
| BGcolor=
| Question= FreeBSD manual XBMC upgrade process
| Answer=
Upgrading XBMC in FreeBSD is pretty simple, as long as a new version exists in port

* Update your port tree:
:<pre>$ portsnap fetch update</pre>
* Update XBMC:
:<pre>$ portmaster multimedia/xbmc</pre>
}}

{{FAQ|1= GentooUpgrade
| BGcolor=
| Question= Gentoo manual XBMC upgrade process
| Answer=
This part needs to be updated <big>'''?'''</big>
}}
|}

== Known issues ==
{| width="100%"
'''''See:''''' [[XBMC v12 (Frodo) issues]]
|}

[[Category:XBMC Manual]]
[[Category:FAQ|Linux]]
[[Category:Linux|*]]
[[Category:Troubleshooting]]
{{frodo updated}}

Archive:Linux FAQ

2014-02-02T13:52:32Z

Prof Yaffle:

{{mininav|[[General topics]]{{l2|[[Devices]]}}|[[FAQs]]{{l2|[[Linux]]}} }}
{{cleanup}}
{{FAQ header|for XBMC running under Linux-based operating systems.}}
{{XBMC FAQ}}
__TOC__
{{-}}

== Caveat ==
:There are no official XBMC builds for Linux distributions other than Ubuntu yet. If you use something other than Ubuntu, check to see if XBMC is available via your repositories or normal software installation method.

:<big>''See also: '''[[Installing XBMC for Linux]]''' for how to install XBMC on other distributions.''</big>

== General FAQ ==
:<big>''See also: '''[[XBMC all platforms FAQ]]''' for FAQs that apply to all versions of XBMC.''</big>

{| width="100%"
{{FAQ|1= Support
| BGcolor=
| Question= I'm here because I've got a problem, so what do I do if I'm still stuck afterwards?
| Answer=
If you run into issues it is helpful to gather all of the basic information, especially when you're thinking about starting an XBMC forum thread or opening a report on the XBMC bug tracker. Below is a list of information that should be included in a forum post '''as a minimum'''. As a rule, you should include anything that's relevant, such as recent changes, detailed media information, etc. 

* '''Compulsory''' xbmc.log with '''debugging enabled''', which contains the problem or issue you're experiencing.
* '''Video driver problems:''' Include a copy of your '''/var/log/Xorg.0.log''' in addition to your debug log.
* Use a '''pastesite''' for logs: do not post logs in-line on forums. On '''trac''', you should attach/upload the logs with your report.
* '''System specs:''' ('''CPU''', '''GPU''', etc.)
* '''Playback Problems:''' include '''video''' codec (e.g. MPEG-2, H.264) and container (e.g. .mkv, .mp4, .avi) or '''audio''' codec (e.g. FLAC, MP3) and container. If possible, include samples.
* '''Details''' of steps you took to attempt to fix it, if any. Describe what it is you tried when posting.
* '''Steps''' to duplicate your problem in detail.
* '''Screenshots''' that may help illustrate your problem or show your current settings. Use sites like [http://snag.gy/ snag.gy] or [http://www.postimage.org/ postimage].

For help/support visit [http://forum.xbmc.org/ '''XBMC Community Forums'''] or IRC [irc://freenode.net/ '''#xbmc-linux''']

{{see also|HOW-TO:Submit a bug report}}
}}

{{FAQ|1= Logfile
| BGcolor= WhiteSmoke
| Question= Where's my log file?
| Answer=
In Linux your XBMC log is located in:
<source lang="bash">$HOME/.xbmc/temp/xbmc.log</source> 
{{note|The location of the log assumes you are logged in as the '''<big>xbmc user</big>''' and not '''<big>root</big>'''.}} 
'''''See also:''''' [[SSH|Accessing XBMC via SSH]] e.g. Putty
}}

{{FAQ|1= Debugfile
| BGcolor=
| Question= How do I upload my log file?
| Answer=
You can generate a debug log [http://en.wikipedia.org/wiki/Pastebin Pastebin] link automatically. This allows you to quickly post a log to anywhere that requires it.
 
{{Note|Don't forget to [[Log file#Enable Debugging|'''Enable Debugging''']] when creating the log so that maximum detail is available}} 
<source lang="bash">$ sudo apt-get install pastebinit -y
$ cat $HOME/.xbmc/temp/xbmc.log | pastebinit</source>
}}

{{FAQ|1= UserData
| BGcolor= WhiteSmoke
| Question= Where's the UserData folder?
| Answer=
<source lang="bash">$HOME/.xbmc/userdata</source>
}}

{{FAQ|1= InstallationDirectory
| BGcolor=
| Question= Where is XBMC installed?
| Answer=
The installation paths are as below:

<source lang="bash">/usr/share/xbmc/
/usr/lib/xbmc/</source> 

{{Note|No user XBMC configuration files are kept in these locations; refer to [[userdata]] for these.}}
}}

{{FAQ|1= DiscPlayback
| BGcolor= WhiteSmoke
| Question= Does XBMC for Linux support Blu-ray or HD DVD playback with or without menus?
| Answer=
Yes, without menus. As of Dharma (10.0), XBMC includes support for playback of '''unencrypted''' Blu-ray directories when [http://www.videolan.org/developers/libbluray.html libbluray] is installed. However, XBMC must be compiled from [https://github.com/xbmc/xbmc source]. Installing from a repository like the [https://launchpad.net/~team-xbmc/+archive/unstable Team-XBMC unstable ppa] will not recognize whether libbluray is installed.

Currently, only the longest title is played from the Blu-ray directory, even on multi-video Blu-rays (e.g. TV shows). To play a Blu-ray directory, select the /BDMV/index.bdmv in the Blu-ray directory. If stacking is enabled, selecting the Blu-ray directory folder will start playback.

;Frodo v12 includes better support for bluray .iso and folder, there is still work in progress in this area for post Frodo.

To play Blu-ray discs in XBMC with MakeMKV, see below.

{{forum link2|[[forum:67420|playback Blu-ray Disc in XBMC for Linux with MakeMKV (Plugin Addon) Discussion thread]]}}
}}

{{FAQ|1= Distros
| BGcolor=
| Question= What Linux distributions are supported?
| Answer=
Check the '''[[HOW-TO:Install XBMC for Linux|install page]]''' for a list of supported distributions.
}}

{{FAQ|1= Hardware
| BGcolor= WhiteSmoke
| Question= What are the current recommended hardware requirements for XBMC?
| Answer=
For end-users the recommended minimum requirement is an [http://en.wikipedia.org/wiki/X86 x86-based computer], with a [http://en.wikipedia.org/wiki/Graphics_Processing_Unit 3D GPU (Graphics Processing Unit)] that at least supports [http://en.wikipedia.org/wiki/Shader_model Shader Model 3.0] and [http://en.wikipedia.org/wiki/OpenGL OpenGL 2.0] (that features 24bpp or 32bpp for 3D hardware-acceleration support, which the XBMC GUI needs to run smoothly at an acceptable frame-rate). Graphic adapters that support [http://en.wikipedia.org/wiki/DirectX DirectX version 9.0c] or later usually meet all of those mentioned requirements, ([[Team-XBMC]] recommends [http://en.wikipedia.org/wiki/Nvidia NVIDIA GeForce 6150 or later] as NVIDIA are currently the manufacturer that offers [http://en.wikipedia.org/wiki/Graphics_hardware_and_FOSS good device-drivers for Linux] (and [http://en.wikipedia.org/wiki/Nvidia NVIDIA GeForce 6150 or later] supports OpenGL 2.0)).
}}

{{FAQ|1= LinuxHardware
| BGcolor=
| Question= XBMC for Linux minimum requirements
| Answer=
{{#lst:Supported hardware|Linux}}
}}

|}

== Troubleshooting: General ==
{| width="100%"
{{FAQ|1= BootIssues
| BGcolor=
| Question= Boot Issues
| Answer =
Some Intel GPUs have issues with rc6 it can be disabled via grub.
<source lang="bash">$ sudo nano /etc/default/grub</source>

Append '''i915.i915_enable_rc6=0''' to:

<source lang="xml">GRUB_CMDLINE_LINUX_DEFAULT="quiet splash i915.i915_enable_rc6=0"</source>

* Press {{keypress|ctrl|X}} say '''YES''' to save file

;Then run

<source lang="bash">$ sudo update-grub</source>
}}
|}

== Troubleshooting: Video ==
:{{incomplete}}
:Most of the problems that you encounter with slow display, playback or OpenGL related errors on Linux are because you do not have the proper display drivers installed, or because your versions are outdated. Using the correct drivers or updating can be a decisive step in resolving some issues.

{| width="100%"

{{FAQ|1= InstallOnUbuntu
| BGcolor=
| Question= Installing video drivers on Ubuntu and derivatives
| Answer =
:* For '''NVIDIA''' drivers follow the guide [https://help.ubuntu.com/community/BinaryDriverHowto/Nvidia click this (link)]
:* For '''ATI''' drivers follow the guide [https://help.ubuntu.com/community/BinaryDriverHowto/ATI click this (link)]
:* For '''Intel''' it is simpler since the drivers are open source so they are usually already pre-installed. You need to make sure that you use the newer '''Intel''' driver and not the older '''i810''' driver or the 'vesa' driver. This could be verified by checking the 'Driver' value in /etc/X11/xorg.conf.
:Make sure your hardware acceleration '''libva''' or '''sna''' is installed and working.
:Deinterlacing in Intel hardware needs cutting edge drivers like '''xserver-xorg-video-intel''', '''libva-intel-vaapi-driver''' 

Below, you can find forum discussions on various relevant topics, including complete setups and configuration of drivers. '''No NVIDIA forum discussion link exists yet, so please add links if you know of any relevant ones.''' 

{{forum link2|[[forum:|NVidia Place Holder forum discussion thread ?]]}}
{{forum link2|[[forum:116996|XVBA for AMD Radeon/Fusion/NVidia forum discussion thread]]}}
{{forum link2|[[forum:114368|Intel GPU forum discussion thread]]}} 
}}

{{FAQ|1= UpgradingNVIDIA
| BGcolor= WhiteSmoke
| Question= Upgrading NVIDIA drivers on Ubuntu and derivatives
| Answer =
Ubuntu (including XBMCbuntu) often ships with outdated drivers that do not fully support a platform.
Make sure that old versions of the NVIDIA drivers are removed if you use other third-party PPAs (repositories). For the sake of your sanity, '''don't remove any Ubuntu sources''', as that is highly likely to break something.

<source lang="bash">
$ sudo apt-get install python-software-properties pkg-config
$ sudo add-apt-repository -r ppa:the_3rd_party_ppa_you_wish_to_remove_here
$ sudo add-apt-repository ppa:ubuntu-x-swat/x-updates
$ apt-get update
$ sudo apt-get install nvidia-current nvidia-settings
</source> 

{{forum link2|[[forum:142220|NVidia Drivers updates XBMCBuntu, Ubuntu and variants forum discussion thread]]}} 
}}

{{FAQ|1= IntelSNA
| BGcolor=
| Question= Intel SNA Acceleration
| Answer =
Intel uses VAAPI for GPU-accelerated video playback decoding, however there are other acceleration methods in the pipeline like SNA.
The use of GPU acceleration is an essential part of getting both smooth video playback and a lag-free interface (GUI).
Create or edit your existing '''/etc/X11/xorg.conf''' and add to section '''Device''' as below.

<source lang="xml">Section "Device"
Identifier "Intel Graphics"
Driver "intel"
Option "AccelMethod" "sna"
EndSection</source>

For more information on '''SNA''', see: [http://www.phoronix.com/scan.php?page=article&item=intel_sna_july2012&num=1 '''Intel SNA vs. UXA On Ivy Bridge''']

{{forum link2|[[forum:144633|Optimal video settings for Intel GPU forum discussion thread]]}}
}}

{{FAQ|1= VerifyOpenGL
| BGcolor= WhiteSmoke
| Question= Verify OpenGL Support
| Answer =
Once you have your drivers in place, you need to make sure that OpenGL is properly configured. Run the following command:

<source lang="bash">
# glxinfo | grep -i direct
</source>

The result should be:
<pre>Direct rendering: Yes</pre>
If the result is "'''No'''", it means that the display driver have not been properly configured. Also, you can run the command '''glxgears''' and you should see the wheels turning smoothly.
}}

{{FAQ|1= Compiz
| BGcolor=
| Question= Compiz is not compatible with XBMC
| Answer =
There are several ways to address this.

* Make sure Compiz visual effects are disabled. You can do this by going to ''System'' -> ''Preferences'' -> ''Appearance'' -> ''Visual Effects''. Make sure "None" is selected.

* Alternatively, you can tell Compiz not to interfere with XBMC. Install and run CompizConfig, and under '''General Options''' tick "Unredirect Fullscreen Windows".

* For NVIDIA, you can disable this in xorg.conf, like so:
:<syntaxhighlight lang="xml" enclose="div">
Section "Extensions"
Option "Composite" "Disable"
EndSection
</syntaxhighlight>

* Or, again for NVIDIA, you can disable Compiz directly at a terminal prompt:
:<source lang="bash">$ sudo nvidia-xconfig --no-composite</source>
Example minimal xorg.conf for NVIDIA: [[Minimal NVidia xorg.conf]]
}}
|}

== Troubleshooting: Audio ==
{| width="100%"
{{FAQ|1= AudioGeneral
| BGcolor=
| Question= Audio Issues
| Answer =
For XBMC v12 Frodo specific settings please see '''[[AudioEngine]]'''.
}}

{{FAQ|1= NoAudioDevices
| BGcolor= WhiteSmoke
| Question= Why do I get ''no audio devices detected''?
| Answer =
If you have installed lightdm this will happen, it's is not a XBMC issue. A workaround exists.
:<big>'''''See: [[XBMCbuntu#XBMCbuntu no audio devices|XBMCbuntu no audio devices''''']]</big>
}}

{{FAQ|1= RequiredPackages
| BGcolor=
| Question= Required Packages
| Answer =
<source lang="bash">
$ sudo apt-get install alsa-utils libasound2
</source>
}}

{{FAQ|1= NoSound
| BGcolor= WhiteSmoke
| Question= No sound in XBMC
| Answer =
{{Note|'''Unmute channels in alsamixer''' in all cases if you're getting no sound via e.g. HDMI. Just for guidance, a couple of quick reference commands are listed below.}} 
{{tip|Substitute '''IEC958''' with your device ID depending on your '''{{code|aplay -l}} output.}}'''
<source lang="bash">
$ amixer -q set Master 100% unmute
$ amixer -q set PCM 100% unmute
$ amixer -q set 'IEC958',1 unmute
$ amixer -q set 'IEC958',0 unmute
</source> 

{{note|Make sure that your correct sound card is in use in alsamixer. To change your card, press {{keypress|F6}} and then try different cards to make ensure it's not something as simple as using the wrong card - sometimes the onboard card may not be the one you want or need.}} 

{{note|For systems that have '''multiple sound cards''' e.g. ''Intel Azalia (internal) - GT520 (external)'', you could try to disable the onboard card in your system BIOS if it's not in use. This is suitable where, for example, you're using a Soundblaster or perhaps a video card that also supports audio e.g. HDA NVIDIA.}}
}}

{{FAQ|1= HDMIRemapping
| BGcolor=
| Question= HDMI Channel Audio remapping
| Answer =
Some combinations of systems (e.g. ION) and receivers may have incorrectly mapped HDMI channels.
'''''See also:'' [[HOW-TO:Remap_HDMI_audio_on_Gen_1_ION_-_Linux|HOW-TO: Remap HDMI audio on Gen 1 ION - Linux''']]
|}
}}

== Dual Audio Setup ==
{| width="100%"
This is an ultimate goal for some XBMC users. With the move to [[AudioEngine]] it becomes more complex and even impossible in some cases.

One XBMC forum user, '''puntloos''', posted his finding which seem to work relatively well for his setup. Bear in mind that this will not be universal, though, and thus may not work under other circumstances.
 

{{forum link2|[[forum:145430|Setting up dual audio forum discussion thread]]}}
|}

== Updating XBMC from PPA ==
{| width="100%"
We obviously recommend the use of our PPAs, but we recognise that Ubuntu is only one of the many Linux distributions in use and users will also have Archlinux, Debian or Gentoo (amongst many others). Please feel free to provide details on how you can upgrade packages on these and other distros. The details below are thus really intended for XBMCbuntu and Ubuntu variant (Xubuntu, Kubuntu, Mint...) installations.

=== Where are XBMC Packages for Ubuntu/Debian? ===
;Official
* https://launchpad.net/~team-xbmc/+archive/ppa '''ppa:team-xbmc/ppa'''
* https://launchpad.net/~team-xbmc/+archive/unstable '''ppa:team-xbmc/unstable'''
* https://launchpad.net/~team-xbmc/+archive/xbmc-nightly '''ppa:team-xbmc/xbmc-nightly'''
;Xvba and improved Vdpau (not mainline)
* https://launchpad.net/~wsnipex/+archive/xbmc-xvba '''ppa:wsnipex/xbmc-xvba'''
* https://launchpad.net/~wsnipex/+archive/xbmc-xvba-frodo '''ppa:wsnipex/xbmc-xvba-frodo'''

;3rd party (contains older Ubuntu support etc)
* https://launchpad.net/~nathan-renniewaldock/+archive/xbmc-stable '''ppa:nathan-renniewaldock/xbmc-stable'''
* https://launchpad.net/~nathan-renniewaldock/+archive/xbmc-nightly '''ppa:nathan-renniewaldock/xbmc-nightly'''
* http://www.loggn.de/ubuntu-xbmc-repository-11-eden-airplay-pvr-livetv/

==== Ubuntu manual XBMC upgrade process ====
{{greenv|'''NOTICE:'''|[[XBMC v12 (Frodo) FAQ#What might break when upgrading to v12.3F .28Audio and Video.2C add-ons.2C skins.2C remotes.29|'''What might break when upgrading to v12''']] is a must-read for users upgrading to a final version.}}
Below is the process to upgrade XBMC manually and/or change the repository being used if you have a different source PPA (it is recommended to remove any previous PPAs that contain the same package sources). '''If you use other distros, please update or add a subsection with relevant information'''.

Connect to your Debian/Ubuntu-based system via [[SSH]] and run the commands below:

<source lang="bash">
sudo apt-get install python-software-properties pkg-config
sudo add-apt-repository -r ppa:current_XBMC_providing_ppa
sudo add-apt-repository ppa:the_ppa_you_wish_to_use
sudo apt-get update
sudo apt-get upgrade
sudo apt-get remove xbmc xbmc.bin
sudo apt-get install xbmc xbmc.bin
</source>

==== Arch manual XBMC upgrade process ====
This part needs to be updated <big>'''?'''</big>

==== FreeBSD manual XBMC upgrade process ====
:Upgrading XBMC in FreeBSD is pretty simple, as long as a new version exists in port

; Update your port tree:
<pre>portsnap fetch update</pre>
; Update XBMC:
<pre>portmaster multimedia/xbmc</pre>

==== Gentoo manual XBMC upgrade process ====
This part needs to be updated <big>'''?'''</big>
|}

== Known issues ==
{| width="100%"
'''''See:''''' [[XBMC v12 (Frodo) issues]]
|}

[[Category:XBMC Manual]]
[[Category:FAQ|Linux]]
[[Category:Linux|*]]
[[Category:Troubleshooting]]
{{frodo updated}}

Archive:Linux FAQ

2014-02-02T13:39:41Z

Prof Yaffle:

{{mininav|[[General topics]]{{l2|[[Devices]]}}|[[FAQs]]{{l2|[[Linux]]}} }}
{{cleanup}}
{{FAQ header|for XBMC running under Linux-based operating systems.}}
{{XBMC FAQ}}
__TOC__
{{-}}

== Caveat ==
:There are no official XBMC builds for Linux distributions other than Ubuntu yet. If you use something other than Ubuntu, check to see if XBMC is available via your repositories or normal software installation method.

:<big>''See also: '''[[Installing XBMC for Linux]]''' for how to install XBMC on other distributions.''</big>

== General FAQ ==
:<big>''See also: '''[[XBMC all platforms FAQ]]''' for FAQs that apply to all versions of XBMC.''</big>

{| width="100%"
{{FAQ|1= Support
| BGcolor=
| Question= I'm here because I've got a problem, so what do I do if I'm still stuck afterwards?
| Answer=
If you run into issues it is helpful to gather all of the basic information, especially when you're thinking about starting an XBMC forum thread or opening a report on the XBMC bug tracker. Below is a list of information that should be included in a forum post '''as a minimum'''. As a rule, you should include anything that's relevant, such as recent changes, detailed media information, etc. 

* '''Compulsory''' xbmc.log with '''debugging enabled''', which contains the problem or issue you're experiencing.
* '''Video driver problems:''' Include a copy of your '''/var/log/Xorg.0.log''' in addition to your debug log.
* Use a '''pastesite''' for logs: do not post logs in-line on forums. On '''trac''', you should attach/upload the logs with your report.
* '''System specs:''' ('''CPU''', '''GPU''', etc.)
* '''Playback Problems:''' include '''video''' codec (e.g. MPEG-2, H.264) and container (e.g. .mkv, .mp4, .avi) or '''audio''' codec (e.g. FLAC, MP3) and container. If possible, include samples.
* '''Details''' of steps you took to attempt to fix it, if any. Describe what it is you tried when posting.
* '''Steps''' to duplicate your problem in detail.
* '''Screenshots''' that may help illustrate your problem or show your current settings. Use sites like [http://snag.gy/ snag.gy] or [http://www.postimage.org/ postimage].

For help/support visit [http://forum.xbmc.org/ '''XBMC Community Forums'''] or IRC [irc://freenode.net/ '''#xbmc-linux''']

{{see also|HOW-TO:Submit a bug report}}
}}

{{FAQ|1= Logfile
| BGcolor= WhiteSmoke
| Question= Where's my log file?
| Answer=
In Linux your XBMC log is located in:
<source lang="bash">$HOME/.xbmc/temp/xbmc.log</source> 
{{note|The location of the log assumes you are logged in as the '''<big>xbmc user</big>''' and not '''<big>root</big>'''.}} 
'''''See also:''''' [[SSH|Accessing XBMC via SSH]] e.g. Putty
}}

{{FAQ|1= Debugfile
| BGcolor=
| Question= How do I upload my log file?
| Answer=
You can generate a debug log [http://en.wikipedia.org/wiki/Pastebin Pastebin] link automatically. This allows you to quickly post a log to anywhere that requires it.
 
{{Note|Don't forget to [[Log file#Enable Debugging|'''Enable Debugging''']] when creating the log so that maximum detail is available}} 
<source lang="bash">$ sudo apt-get install pastebinit -y
$ cat $HOME/.xbmc/temp/xbmc.log | pastebinit</source>
}}

{{FAQ|1= UserData
| BGcolor= WhiteSmoke
| Question= Where's the UserData folder?
| Answer=
<source lang="bash">$HOME/.xbmc/userdata</source>
}}

{{FAQ|1= InstallationDirectory
| BGcolor=
| Question= Where is XBMC installed?
| Answer=
The installation paths are as below:

<source lang="bash">/usr/share/xbmc/
/usr/lib/xbmc/</source> 

{{Note|No user XBMC configuration files are kept in these locations; refer to [[userdata]] for these.}}
}}

{{FAQ|1= DiscPlayback
| BGcolor= WhiteSmoke
| Question= Does XBMC for Linux support Blu-ray or HD DVD playback with or without menus?
| Answer=
Yes, without menus. As of Dharma (10.0), XBMC includes support for playback of '''unencrypted''' Blu-ray directories when [http://www.videolan.org/developers/libbluray.html libbluray] is installed. However, XBMC must be compiled from [https://github.com/xbmc/xbmc source]. Installing from a repository like the [https://launchpad.net/~team-xbmc/+archive/unstable Team-XBMC unstable ppa] will not recognize whether libbluray is installed.

Currently, only the longest title is played from the Blu-ray directory, even on multi-video Blu-rays (e.g. TV shows). To play a Blu-ray directory, select the /BDMV/index.bdmv in the Blu-ray directory. If stacking is enabled, selecting the Blu-ray directory folder will start playback.

;Frodo v12 includes better support for bluray .iso and folder, there is still work in progress in this area for post Frodo.

To play Blu-ray discs in XBMC with MakeMKV, see below.

{{forum link2|[[forum:67420|playback Blu-ray Disc in XBMC for Linux with MakeMKV (Plugin Addon) Discussion thread]]}}
}}

{{FAQ|1= Distros
| BGcolor=
| Question= What Linux distributions are supported?
| Answer=
Check the '''[[HOW-TO:Install XBMC for Linux|install page]]''' for a list of supported distributions.
}}

{{FAQ|1= Hardware
| BGcolor= WhiteSmoke
| Question= What are the current recommended hardware requirements for XBMC?
| Answer=
For end-users the recommended minimum requirement is an [http://en.wikipedia.org/wiki/X86 x86-based computer], with a [http://en.wikipedia.org/wiki/Graphics_Processing_Unit 3D GPU (Graphics Processing Unit)] that at least supports [http://en.wikipedia.org/wiki/Shader_model Shader Model 3.0] and [http://en.wikipedia.org/wiki/OpenGL OpenGL 2.0] (that features 24bpp or 32bpp for 3D hardware-acceleration support, which the XBMC GUI needs to run smoothly at an acceptable frame-rate). Graphic adapters that support [http://en.wikipedia.org/wiki/DirectX DirectX version 9.0c] or later usually meet all of those mentioned requirements, ([[Team-XBMC]] recommends [http://en.wikipedia.org/wiki/Nvidia NVIDIA GeForce 6150 or later] as NVIDIA are currently the manufacturer that offers [http://en.wikipedia.org/wiki/Graphics_hardware_and_FOSS good device-drivers for Linux] (and [http://en.wikipedia.org/wiki/Nvidia NVIDIA GeForce 6150 or later] supports OpenGL 2.0)).
}}

{{FAQ|1= LinuxHardware
| BGcolor=
| Question= XBMC for Linux minimum requirements
| Answer=
{{#lst:Supported hardware|Linux}}
}}

|}

== Troubleshooting: General ==
{| width="100%"
{{FAQ|1= BootIssues
| BGcolor=
| Question= Boot Issues
| Answer =
Some Intel GPUs have issues with rc6 it can be disabled via grub.
<source lang="bash">$ sudo nano /etc/default/grub</source>

Append '''i915.i915_enable_rc6=0''' to:

<source lang="xml">GRUB_CMDLINE_LINUX_DEFAULT="quiet splash i915.i915_enable_rc6=0"</source>

* Press {{keypress|ctrl|X}} say '''YES''' to save file

;Then run

<source lang="bash">$ sudo update-grub</source>
}}
|}

== Troubleshooting: Video ==
:{{incomplete}}
:Most of the problems that you encounter with slow display, playback or OpenGL related errors on Linux are because you do not have the proper display drivers installed, or because your versions are outdated. Using the correct drivers or updating can be a decisive step in resolving some issues.

{| width="100%"

{{FAQ|1= InstallOnUbuntu
| BGcolor=
| Question= Installing video drivers on Ubuntu and derivatives
| Answer =
:* For '''NVIDIA''' drivers follow the guide [https://help.ubuntu.com/community/BinaryDriverHowto/Nvidia click this (link)]
:* For '''ATI''' drivers follow the guide [https://help.ubuntu.com/community/BinaryDriverHowto/ATI click this (link)]
:* For '''Intel''' it is simpler since the drivers are open source so they are usually already pre-installed. You need to make sure that you use the newer '''Intel''' driver and not the older '''i810''' driver or the 'vesa' driver. This could be verified by checking the 'Driver' value in /etc/X11/xorg.conf.
:Make sure your hardware acceleration '''libva''' or '''sna''' is installed and working.
:Deinterlacing in Intel hardware needs cutting edge drivers like '''xserver-xorg-video-intel''', '''libva-intel-vaapi-driver''' 

Below, you can find forum discussions on various relevant topics, including complete setups and configuration of drivers. '''No NVIDIA forum discussion link exists yet, so please add links if you know of any relevant ones.''' 

{{forum link2|[[forum:|NVidia Place Holder forum discussion thread ?]]}}
{{forum link2|[[forum:116996|XVBA for AMD Radeon/Fusion/NVidia forum discussion thread]]}}
{{forum link2|[[forum:114368|Intel GPU forum discussion thread]]}} 
}}

{{FAQ|1= UpgradingNVIDIA
| BGcolor= WhiteSmoke
| Question= Upgrading NVIDIA drivers on Ubuntu and derivatives
| Answer =
Ubuntu (including XBMCbuntu) often ships with outdated drivers that do not fully support a platform.
Make sure that old versions of the NVIDIA drivers are removed if you use other third-party PPAs (repositories). For the sake of your sanity, '''don't remove any Ubuntu sources''', as that is highly likely to break something.

<source lang="bash">
$ sudo apt-get install python-software-properties pkg-config
$ sudo add-apt-repository -r ppa:the_3rd_party_ppa_you_wish_to_remove_here
$ sudo add-apt-repository ppa:ubuntu-x-swat/x-updates
$ apt-get update
$ sudo apt-get install nvidia-current nvidia-settings
</source> 

{{forum link2|[[forum:142220|NVidia Drivers updates XBMCBuntu, Ubuntu and variants forum discussion thread]]}} 
}}

{{FAQ|1= IntelSNA
| BGcolor=
| Question= Intel SNA Acceleration
| Answer =
Intel uses VAAPI for GPU-accelerated video playback decoding, however there are other acceleration methods in the pipeline like SNA.
The use of GPU acceleration is an essential part of getting both smooth video playback and a lag-free interface (GUI).
Create or edit your existing '''/etc/X11/xorg.conf''' and add to section '''Device''' as below.

<source lang="xml">Section "Device"
Identifier "Intel Graphics"
Driver "intel"
Option "AccelMethod" "sna"
EndSection</source>

For more information on '''SNA''', see: [http://www.phoronix.com/scan.php?page=article&item=intel_sna_july2012&num=1 '''Intel SNA vs. UXA On Ivy Bridge''']

{{forum link2|[[forum:144633|Optimal video settings for Intel GPU forum discussion thread]]}}
}}

{{FAQ|1= VerifyOpenGL
| BGcolor= WhiteSmoke
| Question= Verify OpenGL Support
| Answer =
Once you have your drivers in place, you need to make sure that OpenGL is properly configured. Run the following command:

<source lang="bash">
# glxinfo | grep -i direct
</source>

The result should be:
<pre>Direct rendering: Yes</pre>
If the result is "'''No'''", it means that the display driver have not been properly configured. Also, you can run the command '''glxgears''' and you should see the wheels turning smoothly.
}}

{{FAQ|1= Compiz
| BGcolor=
| Question= Compiz is not compatible with XBMC
| Answer =
There are several ways to address this.

* Make sure Compiz visual effects are disabled. You can do this by going to ''System'' -> ''Preferences'' -> ''Appearance'' -> ''Visual Effects''. Make sure "None" is selected.

* Alternatively, you can tell Compiz not to interfere with XBMC. Install and run CompizConfig, and under '''General Options''' tick "Unredirect Fullscreen Windows".

* For NVIDIA, you can disable this in xorg.conf, like so:
:<syntaxhighlight lang="xml" enclose="div">
Section "Extensions"
Option "Composite" "Disable"
EndSection
</syntaxhighlight>

* Or, again for NVIDIA, you can disable Compiz directly at a terminal prompt:
:<source lang="bash">$ sudo nvidia-xconfig --no-composite</source>
Example minimal xorg.conf for NVIDIA: [[Minimal NVidia xorg.conf]]
}}
|}

== Troubleshooting: Audio ==
{| width="100%"
=== Audio issues ===
For XBMC v12 Frodo specific settings please see '''[[AudioEngine]]'''.

=== '''Why do I get no audio devices detected ?''' ===
If you have installed lightdm this will happen, it's is not a XBMC issue. A workaround exists.
:<big>'''''See: [[XBMCbuntu#XBMCbuntu no audio devices|XBMCbuntu no audio devices''''']]</big>

=== Required packages ===
<source lang="bash">
sudo apt-get install alsa-utils libasound2
</source>

=== '''No sound in XBMC''' ===
{{Note|'''<big>Unmute channels in alsamixer</big>''' in all cases if you're getting no sound via e.g. '''<big>HDMI</big>'''. Just for guidance, a couple of quick reference commands are listed below.}}
{{tip|Substitute '''IEC958''' with your device ID depending on your '''{{code|aplay -l}} output.}}'''
<source lang="bash">
amixer -q set Master 100% unmute
amixer -q set PCM 100% unmute
amixer -q set 'IEC958',1 unmute
amixer -q set 'IEC958',0 unmute
</source>

{{note|Make sure that your correct sound card is in use in alsamixer. To change your card, press {{keypress|F6}} and then try different cards to make ensure it's not something as simple as using the wrong card - sometimes the onboard card may not be the one you want or need.}}
{{note|For systems that have '''multiple sound cards''' e.g. Intel Azalia (internal) - GT520 (external), you could try to disable the onboard card in '''system BIOS''' if it's not in use. This is suitable where, for example, you're using a Soundblaster or perhaps a video card that also audio e.g. HDA NVIDIA.}}

=== '''HDMI Channel Audio remapping''' ===
Some combinations of systems (e.g. ION) and receivers may have incorrectly mapped HDMI channels.
:'''''See also:'' [[HOW-TO:Remap_HDMI_audio_on_Gen_1_ION_-_Linux|HOW-TO: Remap HDMI audio on Gen 1 ION - Linux''']]
|}

== Dual Audio setup ==
{| width="100%"
This is a grail for some XBMC users and with inclusion of [[AudioEngine]] it becomes more complex and even impossible in some cases.

One XBMC forum user, '''puntloos''', posted his finding which seem to work relatively well for his setup. Bear in mind that this will not be universal, though, and thus may not work under other circumstances.
 

{{forum link2|[[forum:145430|Setting up dual audio forum discussion thread]]}}
|}

== Updating XBMC from PPA ==
{| width="100%"
We obviously recommend the use of our PPAs, but we recognise that Ubuntu is only one of the many Linux distributions in use and users will also have Archlinux, Debian or Gentoo (amongst many others). Please feel free to provide details on how you can upgrade packages on these and other distros. The details below are thus really intended for XBMCbuntu and Ubuntu variant (Xubuntu, Kubuntu, Mint...) installations.

=== Where are XBMC Packages for Ubuntu/Debian? ===
;Official
* https://launchpad.net/~team-xbmc/+archive/ppa '''ppa:team-xbmc/ppa'''
* https://launchpad.net/~team-xbmc/+archive/unstable '''ppa:team-xbmc/unstable'''
* https://launchpad.net/~team-xbmc/+archive/xbmc-nightly '''ppa:team-xbmc/xbmc-nightly'''
;Xvba and improved Vdpau (not mainline)
* https://launchpad.net/~wsnipex/+archive/xbmc-xvba '''ppa:wsnipex/xbmc-xvba'''
* https://launchpad.net/~wsnipex/+archive/xbmc-xvba-frodo '''ppa:wsnipex/xbmc-xvba-frodo'''

;3rd party (contains older Ubuntu support etc)
* https://launchpad.net/~nathan-renniewaldock/+archive/xbmc-stable '''ppa:nathan-renniewaldock/xbmc-stable'''
* https://launchpad.net/~nathan-renniewaldock/+archive/xbmc-nightly '''ppa:nathan-renniewaldock/xbmc-nightly'''
* http://www.loggn.de/ubuntu-xbmc-repository-11-eden-airplay-pvr-livetv/

==== Ubuntu manual XBMC upgrade process ====
{{greenv|'''NOTICE:'''|[[XBMC v12 (Frodo) FAQ#What might break when upgrading to v12.3F .28Audio and Video.2C add-ons.2C skins.2C remotes.29|'''What might break when upgrading to v12''']] is a must-read for users upgrading to a final version.}}
Below is the process to upgrade XBMC manually and/or change the repository being used if you have a different source PPA (it is recommended to remove any previous PPAs that contain the same package sources). '''If you use other distros, please update or add a subsection with relevant information'''.

Connect to your Debian/Ubuntu-based system via [[SSH]] and run the commands below:

<source lang="bash">
sudo apt-get install python-software-properties pkg-config
sudo add-apt-repository -r ppa:current_XBMC_providing_ppa
sudo add-apt-repository ppa:the_ppa_you_wish_to_use
sudo apt-get update
sudo apt-get upgrade
sudo apt-get remove xbmc xbmc.bin
sudo apt-get install xbmc xbmc.bin
</source>

==== Arch manual XBMC upgrade process ====
This part needs to be updated <big>'''?'''</big>

==== FreeBSD manual XBMC upgrade process ====
:Upgrading XBMC in FreeBSD is pretty simple, as long as a new version exists in port

; Update your port tree:
<pre>portsnap fetch update</pre>
; Update XBMC:
<pre>portmaster multimedia/xbmc</pre>

==== Gentoo manual XBMC upgrade process ====
This part needs to be updated <big>'''?'''</big>
|}

== Known issues ==
{| width="100%"
'''''See:''''' [[XBMC v12 (Frodo) issues]]
|}

[[Category:XBMC Manual]]
[[Category:FAQ|Linux]]
[[Category:Linux|*]]
[[Category:Troubleshooting]]
{{frodo updated}}

Archive:Linux FAQ

2014-02-02T12:06:24Z

Prof Yaffle:

{{mininav|[[General topics]]{{l2|[[Devices]]}}|[[FAQs]]{{l2|[[Linux]]}} }}
{{cleanup}}
{{FAQ header|for XBMC running under Linux-based operating systems.}}
{{XBMC FAQ}}
__TOC__
{{-}}
== General FAQ ==
:<big>''See also: '''[[XBMC all platforms FAQ]]''' for FAQs that apply to all versions of XBMC.''</big>
There are no official XBMC builds in other distros outside Ubuntu yet, if you use something other than Ubuntu check to see if XBMC is available via repositories.
:<big>''See also: '''[[Installing XBMC for Linux]]''' for How-to install XBMC in other distros''</big>

{| width="100%"

{{FAQ|1= Support
| BGcolor=
| Question= I'm here because I've got a problem, so what do I do if I'm still stuck afterwards?
| Answer=
If you run into issues it is helpful to keep certain things in mind, especially when you're thinking about starting an XBMC forum thread or opening a report on the XBMC bug tracker. Below is a list of information that should be included in a forum post '''as a minimum'''. As a rule, you should include anything that's relevant, such as recent changes, detailed media information, etc. 

* '''Compulsory''' xbmc.log with '''debugging enabled''', which contains the problem or issue you're experiencing.
* '''Video driver problems:''' Include a copy of your '''/var/log/Xorg.0.log''' in addition to your debug log.
* '''Use a pastesite''' for logs: do not post logs in-line on forums. '''On trac''' you should attach/upload the logs with your report.
* '''System specs:''' (CPU, '''GPU''', etc.)
* '''Playback Problems:''' include '''Video''' codec and container or '''audio''' codec and container. If possible, include samples.
* '''Details''' of steps you took to attempt to fix it, if any. Describe what it is you tried when posting.
* '''Steps''' to duplicate your problem in detail.
* '''Screenshots''' that may help illustrate your problem or show your current settings. Use sites like [http://snag.gy/ snag.gy] or [http://www.postimage.org/ postimage].

For help/support visit [http://forum.xbmc.org/ '''XBMC Community Forums'''] or IRC [irc://freenode.net/ '''#xbmc-linux''']

{{see also|HOW-TO:Submit a bug report}}
}}

{{FAQ|1= Logfile
| BGcolor= WhiteSmoke
| Question= Where's my log file?
| Answer=
In Linux your XBMC log is located in the path below:

{{note|The location of the log assumes you are logged in as the '''<big>xbmc user</big>''' and not '''<big>root</big>'''.}} 

<source lang="bash">$HOME/.xbmc/temp/xbmc.log</source>
 
:'''''See also:''''' [[SSH|Accessing XBMC via SSH]] e.g. Putty
}}

{{FAQ|1= Debugfile
| BGcolor=
| Question= How do I upload my log file?
| Answer=
You can generate a debug log [http://en.wikipedia.org/wiki/Pastebin Pastebin] link automatically. This allows you to quickly post a log to anywhere that requires it.
 
{{Note|Don't forget to [[Log file#Enable Debugging|'''Enable Debugging''']] when creating the log so that maximum detail is available}} 
<source lang="bash">sudo apt-get install pastebinit -y

cat $HOME/.xbmc/temp/xbmc.log | pastebinit</source>
}}

{{FAQ|1= UserData
| BGcolor= WhiteSmoke
| Question= Where's the UserData folder?
| Answer=
<source lang="bash">$HOME/.xbmc/userdata</source>
}}

{{FAQ|1= InstallationDirectory
| BGcolor=
| Question= Where is XBMC installed?
| Answer=
The installation paths are as below:

'''Please remember''' that '''no''' user XBMC configuration files are kept here, refer to [[userdata]] for user-space files.

<pre>/usr/share/xbmc/

/usr/lib/xbmc/</pre>
}}

{{FAQ|1= DiscPlayback
| BGcolor= WhiteSmoke
| Question= Does XBMC for Linux support Blu-ray or HD DVD playback with or without menus?
| Answer=
Yes, without menus. As of Dharma (10.0), XBMC includes support for playback of '''unencrypted''' Blu-ray directories when [http://www.videolan.org/developers/libbluray.html libbluray] is installed. However, XBMC must be compiled from [https://github.com/xbmc/xbmc source]. Installing from a repository like the [https://launchpad.net/~team-xbmc/+archive/unstable Team-XBMC unstable ppa] will not recognize whether libbluray is installed.

Currently, only the longest title is played from the Blu-ray directory, even on multi-video Blu-rays (e.g. TV shows). To play a Blu-ray directory, select the /BDMV/index.bdmv in the Blu-ray directory. If stacking is enabled, selecting the Blu-ray directory folder will start playback.

;Frodo v12 includes better support for bluray .iso and folder, there is still work in progress in this area for post Frodo.

To play Blu-ray discs in XBMC with MakeMKV, see below.

{{forum link2|[[forum:67420|playback Blu-ray Disc in XBMC for Linux with MakeMKV (Plugin Addon) Discussion thread]]}}
}}

{{FAQ|1= Distros
| BGcolor=
| Question= What Linux distributions are supported?
| Answer=
Check the '''[[HOW-TO:Install XBMC for Linux|install page]]''' for a list of supported distributions.
}}

{{FAQ|1= Hardware
| BGcolor= WhiteSmoke
| Question= What are the current recommended hardware requirements for XBMC?
| Answer=
For end-users the recommended minimum requirement is an [http://en.wikipedia.org/wiki/X86 x86-based computer], with a [http://en.wikipedia.org/wiki/Graphics_Processing_Unit 3D GPU (Graphics Processing Unit)] that at least supports [http://en.wikipedia.org/wiki/Shader_model Shader Model 3.0] and [http://en.wikipedia.org/wiki/OpenGL OpenGL 2.0] (that features 24bpp or 32bpp for 3D hardware-acceleration support, which the XBMC GUI needs to run smoothly at an acceptable frame-rate). Graphic adapters that support [http://en.wikipedia.org/wiki/DirectX DirectX version 9.0c] or later usually meet all of those mentioned requirements, ([[Team-XBMC]] recommends [http://en.wikipedia.org/wiki/Nvidia NVIDIA GeForce 6150 or later] as NVIDIA are currently the manufacturer that offers [http://en.wikipedia.org/wiki/Graphics_hardware_and_FOSS good device-drivers for Linux] (and [http://en.wikipedia.org/wiki/Nvidia NVIDIA GeForce 6150 or later] supports OpenGL 2.0)).
}}

{{FAQ|1= LinuxHardware
| BGcolor=
| Question= XBMC for Linux minimum requirements
| Answer=
{{#lst:Supported hardware|Linux}}
}}

== Troubleshooting ==
=== Boot issues ===
Some Intel GPUs have issues with rc6 it can be disabled via grub.
<source lang="bash">sudo nano /etc/default/grub</source>

Append '''i915.i915_enable_rc6=0''' to:

<source lang="xml">GRUB_CMDLINE_LINUX_DEFAULT="quiet splash i915.i915_enable_rc6=0"</source>

* Press {{keypress|ctrl|X}} say '''YES''' to save file

;Then run

<source lang="bash">sudo update-grub</source>
=== Video Device Driver ===
{{incomplete}}
:Most of the problems that you encounter with slow display or OpenGL related errors are because you do not have the proper or outdated display drivers installed.

=== Begin but install the video drivers the Ubuntu Way ===
:* For '''NVIDIA''' drivers follow the guide [https://help.ubuntu.com/community/BinaryDriverHowto/Nvidia click this (link)]
:* For '''ATI''' drivers follow the guide [https://help.ubuntu.com/community/BinaryDriverHowto/ATI click this (link)]
:* For '''Intel''' it is simpler since the drivers are open source so they are usually already pre-installed. You need to make sure that you use the newer '''Intel''' driver and not the older '''i810''' driver or the 'vesa' driver. This could be verified by checking the 'Driver' value in /etc/X11/xorg.conf.
:Make sure your hardware acceleration '''libva''' or '''sna''' is installed and working.
:Deinterlacing in Intel hardware needs cutting edge drivers like '''xserver-xorg-video-intel''', '''libva-intel-vaapi-driver''' 

Below, you can find forum discussions on various relevant topics, including complete setups and configuration of drivers. '''No NVidia forum discussion link exists yet, so please add links if you know of any relevant ones.''' 

{{forum link2|[[forum:|NVidia Place Holder forum discussion thread ?]]}}
{{forum link2|[[forum:116996|XVBA for AMD Radeon/Fusion/NVidia forum discussion thread]]}}
{{forum link2|[[forum:114368|Intel GPU forum discussion thread]]}} 

=== Upgrading NVidia drivers in Ubuntu and variants ===
'''For Linux''', updating your graphics drivers can be a decisive step in resolving some issues. Ubuntu and XBMCbuntu ship with often outdated drivers that do not support a platform fully.
Make sure that old versions of the NVidia drivers are removed if you use other 3rd party PPAs (repositories). For the sake of your sanity, '''don't remove any Ubuntu sources''', as that is likely to break something if you remove them.

<source lang="bash">
sudo apt-get install python-software-properties pkg-config
sudo add-apt-repository -r ppa:the_3rd_party_ppa_you_wish_to_remove_here
sudo add-apt-repository ppa:ubuntu-x-swat/x-updates
apt-get update
sudo apt-get install nvidia-current nvidia-settings
</source> 

{{forum link2|[[forum:142220|NVidia Drivers updates XBMCBuntu, Ubuntu and variants forum discussion thread]]}} 

=== Intel SNA Acceleration ===
Intel uses VAAPI for GPU-accelerated video playback decoding, however there are other acceleration methods in the pipeline like SNA.
The use of GPU acceleration is an essential part of getting both smooth video playback and a lag-free interface (GUI).
Create or edit your existing '''/etc/X11/xorg.conf''' and add to section '''Device''' as below.

<pre>Section "Device"
Identifier "Intel Graphics"
Driver "intel"
Option "AccelMethod" "sna"
EndSection</pre>

For more information on '''SNA''', see: [http://www.phoronix.com/scan.php?page=article&item=intel_sna_july2012&num=1 '''Intel SNA vs. UXA On Ivy Bridge''']

{{forum link2|[[forum:144633|Optimal video settings for Intel GPU forum discussion thread]]}}

=== Verify OpenGL support ===
:Once you have your drivers in place, you need to make sure that OpenGL is properly configured. Run the following command:

<source lang="bash">
# glxinfo | grep -i direct
</source>

:The result should be:
<pre>Direct rendering: Yes</pre>
:If the result is "'''No'''", it means that the display driver have not been properly configured. Also, you can run the command '''glxgears''' and you should see the wheels turning smoothly.

== Update XBMC from any PPA ==
We obviously recommend the use of our PPAs, but we recognise that Ubuntu is only one of the many Linux distributions in use and users will also have Archlinux, Debian or Gentoo (amongst many others). Please feel free to provide details on how you can upgrade packages on these and other distros. The details below are thus really intended for XBMCbuntu and Ubuntu variant (Xubuntu, Kubuntu, Mint...) installations.

=== Where are XBMC Packages for Ubuntu/Debian? ===
;Official
* https://launchpad.net/~team-xbmc/+archive/ppa '''ppa:team-xbmc/ppa'''
* https://launchpad.net/~team-xbmc/+archive/unstable '''ppa:team-xbmc/unstable'''
* https://launchpad.net/~team-xbmc/+archive/xbmc-nightly '''ppa:team-xbmc/xbmc-nightly'''
;Xvba and improved Vdpau (not mainline)
* https://launchpad.net/~wsnipex/+archive/xbmc-xvba '''ppa:wsnipex/xbmc-xvba'''
* https://launchpad.net/~wsnipex/+archive/xbmc-xvba-frodo '''ppa:wsnipex/xbmc-xvba-frodo'''

;3rd party (contains older Ubuntu support etc)
* https://launchpad.net/~nathan-renniewaldock/+archive/xbmc-stable '''ppa:nathan-renniewaldock/xbmc-stable'''
* https://launchpad.net/~nathan-renniewaldock/+archive/xbmc-nightly '''ppa:nathan-renniewaldock/xbmc-nightly'''
* http://www.loggn.de/ubuntu-xbmc-repository-11-eden-airplay-pvr-livetv/

==== Ubuntu manual XBMC upgrade process ====
{{greenv|'''NOTICE:'''|[[XBMC v12 (Frodo) FAQ#What might break when upgrading to v12.3F .28Audio and Video.2C add-ons.2C skins.2C remotes.29|'''What might break when upgrading to v12''']] is a must-read for users upgrading to a final version.}}
Below is the process to upgrade XBMC manually and/or change the repository being used if you have a different source PPA (it is recommended to remove any previous PPAs that contain the same package sources). '''If you use other distros, please update or add a subsection with relevant information'''.

Connect to your Debian/Ubuntu-based distro via [[SSH]] and run the commands below:

<source lang="bash">
sudo apt-get install python-software-properties pkg-config
sudo add-apt-repository -r ppa:current_XBMC_providing_ppa
sudo add-apt-repository ppa:the_ppa_you_wish_to_use
sudo apt-get update
sudo apt-get upgrade
sudo apt-get remove xbmc xbmc.bin
sudo apt-get install xbmc xbmc.bin
</source>

==== Arch manual XBMC upgrade process ====
This part needs to be updated <big>'''?'''</big>

==== FreeBSD manual XBMC upgrade process ====
:Upgrading XBMC in FreeBSD is pretty simple, as long as a new version exists in port

; Update you port tree:
<pre>portsnap fetch update</pre>
; Update XBMC:
<pre>portmaster multimedia/xbmc</pre>

==== Gentoo manual XBMC upgrade process ====
This part needs to be updated <big>'''?'''</big>

=== Compiz is not compatible with XBMC ===
:Make sure Compiz visual effects is disabled. You can do this by going to System -> Preferences -> Appearance -> Visual Effects. Make sure "None" is selected. Alternatively, you can tell Compiz not to interfere with XBMC. Install and run CompizConfig, and under General Options tick Unredirect Fullscreen Windows.

:For NVIDIA-Graphics use Disable composite in xorg.conf, like so:
<pre>Section "Extensions"
Option "Composite" "Disable"
EndSection</pre>
Or in terminal
<source lang="bash">
sudo nvidia-xconfig --no-composite
</source>
: '''Minimal xorg.conf for NVidia''' [[Minimal NVidia xorg.conf]]

=== Audio issues ===
For XBMC v12 Frodo specific settings please see '''[[AudioEngine]]'''.

=== '''Why do I get no audio devices detected ?''' ===
If you have installed lightdm this will happen, it's is not a XBMC issue. A workaround exists.
:<big>'''''See: [[XBMCbuntu#XBMCbuntu no audio devices|XBMCbuntu no audio devices''''']]</big>

=== Required packages ===
<source lang="bash">
sudo apt-get install alsa-utils libasound2
</source>

=== '''No sound in XBMC''' ===
{{Note|'''<big>Unmute channels in alsamixer</big>''' in all cases if you're getting no sound via e.g. '''<big>HDMI</big>'''. Just for guidance, a couple of quick reference commands are listed below.}}
{{tip|Substitute '''IEC958''' with your device ID depending on your '''{{code|aplay -l}} output.}}'''
<source lang="bash">
amixer -q set Master 100% unmute
amixer -q set PCM 100% unmute
amixer -q set 'IEC958',1 unmute
amixer -q set 'IEC958',0 unmute
</source>

{{note|Make sure that your correct sound card is in use in alsamixer. To change your card, press {{keypress|F6}} and then try different cards to make ensure it's not something as simple as using the wrong card - sometimes the onboard card may not be the one you want or need.}}
{{note|For systems that have '''multiple sound cards''' e.g. Intel Azalia (internal) - GT520 (external), you could try to disable the onboard card in '''system BIOS''' if it's not in use. This is suitable where, for example, you're using a Soundblaster or perhaps a video card that also audio e.g. HDA Nvidia.}}

=== '''HDMI Channel Audio remapping''' ===
Some combinations of systems (e.g. ION) and receivers may have incorrectly mapped HDMI channels.
:'''''See also:'' [[HOW-TO:Remap_HDMI_audio_on_Gen_1_ION_-_Linux|HOW-TO: Remap HDMI audio on Gen 1 ION - Linux''']]

== Dual Audio setup ==
This is a grail for some XBMC users and with inclusion of [[AudioEngine]] it becomes more complex and even impossible in some cases.

One XBMC forum user, '''puntloos''', posted his finding which seem to work relatively well for his setup. Bear in mind that this will not be universal, though, and thus may not work under other circumstances.
 

{{forum link2|[[forum:145430|Setting up dual audio forum discussion thread]]}}

== Known issues ==
'''''See:''''' [[XBMC v12 (Frodo) issues]]

[[Category:XBMC Manual]]
[[Category:FAQ|Linux]]
[[Category:Linux|*]]
[[Category:Troubleshooting]]
{{frodo updated}}

Archive:Linux FAQ

2014-02-02T12:03:14Z

Prof Yaffle:

{{mininav|[[General topics]]{{l2|[[Devices]]}}|[[FAQs]]{{l2|[[Linux]]}} }}
{{cleanup}}
{{FAQ header|for XBMC running under Linux-based operating systems.}}
{{XBMC FAQ}}
__TOC__
{{-}}
== General FAQ ==
:<big>''See also: '''[[XBMC all platforms FAQ]]''' for FAQs that apply to all versions of XBMC.''</big>
There are no official XBMC builds in other distros outside Ubuntu yet, if you use something other than Ubuntu check to see if XBMC is available via repositories.
:<big>''See also: '''[[Installing XBMC for Linux]]''' for How-to install XBMC in other distros''</big>

{| width="100%"

{{FAQ|1= Support
| BGcolor=
| Question= I'm here because I've got a problem, so what do I do if I'm still stuck afterwards?
| Answer=
If you run into issues it is helpful to keep certain things in mind, especially when you're thinking about starting an XBMC forum thread or opening a report on the XBMC bug tracker. Below is a list of information that should be included in a forum post '''as a minimum'''. As a rule, you should include anything that's relevant, such as recent changes, detailed media information, etc. 

* '''Compulsory''' xbmc.log with '''debugging enabled''', which contains the problem or issue you're experiencing.
* '''Video driver problems:''' Include a copy of your '''/var/log/Xorg.0.log''' in addition to your debug log.
* '''Use a pastesite''' for logs: do not post logs in-line on forums. '''On trac''' you should attach/upload the logs with your report.
* '''System specs:''' (CPU, '''GPU''', etc.)
* '''Playback Problems:''' include '''Video''' codec and container or '''audio''' codec and container. If possible, include samples.
* '''Details''' of steps you took to attempt to fix it, if any. Describe what it is you tried when posting.
* '''Steps''' to duplicate your problem in detail.
* '''Screenshots''' that may help illustrate your problem or show your current settings. Use sites like [http://snag.gy/ snag.gy] or [http://www.postimage.org/ postimage].

For help/support visit [http://forum.xbmc.org/ '''XBMC Community Forums'''] or IRC [irc://freenode.net/ '''#xbmc-linux''']

{{see also|HOW-TO:Submit a bug report}}
}}

{{FAQ|2= Logfile
| BGcolor= WhiteSmoke
| Question= Where's my log file?
| Answer=
In Linux your XBMC log is located in the path below:

{{note|The location of the log assumes you are logged in as the '''<big>xbmc user</big>''' and not '''<big>root</big>'''.}} 

<source lang="bash">$HOME/.xbmc/temp/xbmc.log</source>
 
:'''''See also:''''' [[SSH|Accessing XBMC via SSH]] e.g. Putty
}}

{{FAQ|3= Debugfile
| BGcolor=
| Question= How do I upload my log file?
| Answer=
You can generate a debug log [http://en.wikipedia.org/wiki/Pastebin Pastebin] link automatically. This allows you to quickly post a log to anywhere that requires it.
 
{{Note|Don't forget to [[Log file#Enable Debugging|'''Enable Debugging''']] when creating the log so that maximum detail is available}} 
<source lang="bash">sudo apt-get install pastebinit -y

cat $HOME/.xbmc/temp/xbmc.log | pastebinit</source>
}}

{{FAQ|4= UserData
| BGcolor= WhiteSmoke
| Question= Where's the UserData folder?
| Answer=
<source lang="bash">$HOME/.xbmc/userdata</source>
}}

{{FAQ|5= InstallationDirectory
| BGcolor=
| Question= Where is XBMC installed?
| Answer=
The installation paths are as below:

'''Please remember''' that '''no''' user XBMC configuration files are kept here, refer to [[userdata]] for user-space files.

<pre>/usr/share/xbmc/

/usr/lib/xbmc/</pre>
}}

{{FAQ|6= DiscPlayback
| BGcolor= WhiteSmoke
| Question= Does XBMC for Linux support Blu-ray or HD DVD playback with or without menus?
| Answer=
Yes, without menus. As of Dharma (10.0), XBMC includes support for playback of '''unencrypted''' Blu-ray directories when [http://www.videolan.org/developers/libbluray.html libbluray] is installed. However, XBMC must be compiled from [https://github.com/xbmc/xbmc source]. Installing from a repository like the [https://launchpad.net/~team-xbmc/+archive/unstable Team-XBMC unstable ppa] will not recognize whether libbluray is installed.

Currently, only the longest title is played from the Blu-ray directory, even on multi-video Blu-rays (e.g. TV shows). To play a Blu-ray directory, select the /BDMV/index.bdmv in the Blu-ray directory. If stacking is enabled, selecting the Blu-ray directory folder will start playback.

;Frodo v12 includes better support for bluray .iso and folder, there is still work in progress in this area for post Frodo.

To play Blu-ray discs in XBMC with MakeMKV, see below.

{{forum link2|[[forum:67420|playback Blu-ray Disc in XBMC for Linux with MakeMKV (Plugin Addon) Discussion thread]]}}
}}

{{FAQ|7= Distros
| BGcolor=
| Question= What Linux distributions are supported?
| Answer=
Check the '''[[HOW-TO:Install XBMC for Linux|install page]]''' for a list of supported distributions.
}}

{{FAQ|8= Hardware
| BGcolor= WhiteSmoke
| Question= What are the current recommended hardware requirements for XBMC?
| Answer=
For end-users the recommended minimum requirement is an [http://en.wikipedia.org/wiki/X86 x86-based computer], with a [http://en.wikipedia.org/wiki/Graphics_Processing_Unit 3D GPU (Graphics Processing Unit)] that at least supports [http://en.wikipedia.org/wiki/Shader_model Shader Model 3.0] and [http://en.wikipedia.org/wiki/OpenGL OpenGL 2.0] (that features 24bpp or 32bpp for 3D hardware-acceleration support, which the XBMC GUI needs to run smoothly at an acceptable frame-rate). Graphic adapters that support [http://en.wikipedia.org/wiki/DirectX DirectX version 9.0c] or later usually meet all of those mentioned requirements, ([[Team-XBMC]] recommends [http://en.wikipedia.org/wiki/Nvidia NVIDIA GeForce 6150 or later] as NVIDIA are currently the manufacturer that offers [http://en.wikipedia.org/wiki/Graphics_hardware_and_FOSS good device-drivers for Linux] (and [http://en.wikipedia.org/wiki/Nvidia NVIDIA GeForce 6150 or later] supports OpenGL 2.0)).
}}

{{FAQ|9= LinuxHardware
| BGcolor=
| Question= XBMC for Linux minimum requirements
| Answer=
{{#lst:Supported hardware|Linux}}
}}

== Troubleshooting ==
=== Boot issues ===
Some Intel GPUs have issues with rc6 it can be disabled via grub.
<source lang="bash">sudo nano /etc/default/grub</source>

Append '''i915.i915_enable_rc6=0''' to:

<source lang="xml">GRUB_CMDLINE_LINUX_DEFAULT="quiet splash i915.i915_enable_rc6=0"</source>

* Press {{keypress|ctrl|X}} say '''YES''' to save file

;Then run

<source lang="bash">sudo update-grub</source>
=== Video Device Driver ===
{{incomplete}}
:Most of the problems that you encounter with slow display or OpenGL related errors are because you do not have the proper or outdated display drivers installed.

=== Begin but install the video drivers the Ubuntu Way ===
:* For '''NVIDIA''' drivers follow the guide [https://help.ubuntu.com/community/BinaryDriverHowto/Nvidia click this (link)]
:* For '''ATI''' drivers follow the guide [https://help.ubuntu.com/community/BinaryDriverHowto/ATI click this (link)]
:* For '''Intel''' it is simpler since the drivers are open source so they are usually already pre-installed. You need to make sure that you use the newer '''Intel''' driver and not the older '''i810''' driver or the 'vesa' driver. This could be verified by checking the 'Driver' value in /etc/X11/xorg.conf.
:Make sure your hardware acceleration '''libva''' or '''sna''' is installed and working.
:Deinterlacing in Intel hardware needs cutting edge drivers like '''xserver-xorg-video-intel''', '''libva-intel-vaapi-driver''' 

Below, you can find forum discussions on various relevant topics, including complete setups and configuration of drivers. '''No NVidia forum discussion link exists yet, so please add links if you know of any relevant ones.''' 

{{forum link2|[[forum:|NVidia Place Holder forum discussion thread ?]]}}
{{forum link2|[[forum:116996|XVBA for AMD Radeon/Fusion/NVidia forum discussion thread]]}}
{{forum link2|[[forum:114368|Intel GPU forum discussion thread]]}} 

=== Upgrading NVidia drivers in Ubuntu and variants ===
'''For Linux''', updating your graphics drivers can be a decisive step in resolving some issues. Ubuntu and XBMCbuntu ship with often outdated drivers that do not support a platform fully.
Make sure that old versions of the NVidia drivers are removed if you use other 3rd party PPAs (repositories). For the sake of your sanity, '''don't remove any Ubuntu sources''', as that is likely to break something if you remove them.

<source lang="bash">
sudo apt-get install python-software-properties pkg-config
sudo add-apt-repository -r ppa:the_3rd_party_ppa_you_wish_to_remove_here
sudo add-apt-repository ppa:ubuntu-x-swat/x-updates
apt-get update
sudo apt-get install nvidia-current nvidia-settings
</source> 

{{forum link2|[[forum:142220|NVidia Drivers updates XBMCBuntu, Ubuntu and variants forum discussion thread]]}} 

=== Intel SNA Acceleration ===
Intel uses VAAPI for GPU-accelerated video playback decoding, however there are other acceleration methods in the pipeline like SNA.
The use of GPU acceleration is an essential part of getting both smooth video playback and a lag-free interface (GUI).
Create or edit your existing '''/etc/X11/xorg.conf''' and add to section '''Device''' as below.

<pre>Section "Device"
Identifier "Intel Graphics"
Driver "intel"
Option "AccelMethod" "sna"
EndSection</pre>

For more information on '''SNA''', see: [http://www.phoronix.com/scan.php?page=article&item=intel_sna_july2012&num=1 '''Intel SNA vs. UXA On Ivy Bridge''']

{{forum link2|[[forum:144633|Optimal video settings for Intel GPU forum discussion thread]]}}

=== Verify OpenGL support ===
:Once you have your drivers in place, you need to make sure that OpenGL is properly configured. Run the following command:

<source lang="bash">
# glxinfo | grep -i direct
</source>

:The result should be:
<pre>Direct rendering: Yes</pre>
:If the result is "'''No'''", it means that the display driver have not been properly configured. Also, you can run the command '''glxgears''' and you should see the wheels turning smoothly.

== Update XBMC from any PPA ==
We obviously recommend the use of our PPAs, but we recognise that Ubuntu is only one of the many Linux distributions in use and users will also have Archlinux, Debian or Gentoo (amongst many others). Please feel free to provide details on how you can upgrade packages on these and other distros. The details below are thus really intended for XBMCbuntu and Ubuntu variant (Xubuntu, Kubuntu, Mint...) installations.

=== Where are XBMC Packages for Ubuntu/Debian? ===
;Official
* https://launchpad.net/~team-xbmc/+archive/ppa '''ppa:team-xbmc/ppa'''
* https://launchpad.net/~team-xbmc/+archive/unstable '''ppa:team-xbmc/unstable'''
* https://launchpad.net/~team-xbmc/+archive/xbmc-nightly '''ppa:team-xbmc/xbmc-nightly'''
;Xvba and improved Vdpau (not mainline)
* https://launchpad.net/~wsnipex/+archive/xbmc-xvba '''ppa:wsnipex/xbmc-xvba'''
* https://launchpad.net/~wsnipex/+archive/xbmc-xvba-frodo '''ppa:wsnipex/xbmc-xvba-frodo'''

;3rd party (contains older Ubuntu support etc)
* https://launchpad.net/~nathan-renniewaldock/+archive/xbmc-stable '''ppa:nathan-renniewaldock/xbmc-stable'''
* https://launchpad.net/~nathan-renniewaldock/+archive/xbmc-nightly '''ppa:nathan-renniewaldock/xbmc-nightly'''
* http://www.loggn.de/ubuntu-xbmc-repository-11-eden-airplay-pvr-livetv/

==== Ubuntu manual XBMC upgrade process ====
{{greenv|'''NOTICE:'''|[[XBMC v12 (Frodo) FAQ#What might break when upgrading to v12.3F .28Audio and Video.2C add-ons.2C skins.2C remotes.29|'''What might break when upgrading to v12''']] is a must-read for users upgrading to a final version.}}
Below is the process to upgrade XBMC manually and/or change the repository being used if you have a different source PPA (it is recommended to remove any previous PPAs that contain the same package sources). '''If you use other distros, please update or add a subsection with relevant information'''.

Connect to your Debian/Ubuntu-based distro via [[SSH]] and run the commands below:

<source lang="bash">
sudo apt-get install python-software-properties pkg-config
sudo add-apt-repository -r ppa:current_XBMC_providing_ppa
sudo add-apt-repository ppa:the_ppa_you_wish_to_use
sudo apt-get update
sudo apt-get upgrade
sudo apt-get remove xbmc xbmc.bin
sudo apt-get install xbmc xbmc.bin
</source>

==== Arch manual XBMC upgrade process ====
This part needs to be updated <big>'''?'''</big>

==== FreeBSD manual XBMC upgrade process ====
:Upgrading XBMC in FreeBSD is pretty simple, as long as a new version exists in port

; Update you port tree:
<pre>portsnap fetch update</pre>
; Update XBMC:
<pre>portmaster multimedia/xbmc</pre>

==== Gentoo manual XBMC upgrade process ====
This part needs to be updated <big>'''?'''</big>

=== Compiz is not compatible with XBMC ===
:Make sure Compiz visual effects is disabled. You can do this by going to System -> Preferences -> Appearance -> Visual Effects. Make sure "None" is selected. Alternatively, you can tell Compiz not to interfere with XBMC. Install and run CompizConfig, and under General Options tick Unredirect Fullscreen Windows.

:For NVIDIA-Graphics use Disable composite in xorg.conf, like so:
<pre>Section "Extensions"
Option "Composite" "Disable"
EndSection</pre>
Or in terminal
<source lang="bash">
sudo nvidia-xconfig --no-composite
</source>
: '''Minimal xorg.conf for NVidia''' [[Minimal NVidia xorg.conf]]

=== Audio issues ===
For XBMC v12 Frodo specific settings please see '''[[AudioEngine]]'''.

=== '''Why do I get no audio devices detected ?''' ===
If you have installed lightdm this will happen, it's is not a XBMC issue. A workaround exists.
:<big>'''''See: [[XBMCbuntu#XBMCbuntu no audio devices|XBMCbuntu no audio devices''''']]</big>

=== Required packages ===
<source lang="bash">
sudo apt-get install alsa-utils libasound2
</source>

=== '''No sound in XBMC''' ===
{{Note|'''<big>Unmute channels in alsamixer</big>''' in all cases if you're getting no sound via e.g. '''<big>HDMI</big>'''. Just for guidance, a couple of quick reference commands are listed below.}}
{{tip|Substitute '''IEC958''' with your device ID depending on your '''{{code|aplay -l}} output.}}'''
<source lang="bash">
amixer -q set Master 100% unmute
amixer -q set PCM 100% unmute
amixer -q set 'IEC958',1 unmute
amixer -q set 'IEC958',0 unmute
</source>

{{note|Make sure that your correct sound card is in use in alsamixer. To change your card, press {{keypress|F6}} and then try different cards to make ensure it's not something as simple as using the wrong card - sometimes the onboard card may not be the one you want or need.}}
{{note|For systems that have '''multiple sound cards''' e.g. Intel Azalia (internal) - GT520 (external), you could try to disable the onboard card in '''system BIOS''' if it's not in use. This is suitable where, for example, you're using a Soundblaster or perhaps a video card that also audio e.g. HDA Nvidia.}}

=== '''HDMI Channel Audio remapping''' ===
Some combinations of systems (e.g. ION) and receivers may have incorrectly mapped HDMI channels.
:'''''See also:'' [[HOW-TO:Remap_HDMI_audio_on_Gen_1_ION_-_Linux|HOW-TO: Remap HDMI audio on Gen 1 ION - Linux''']]

== Dual Audio setup ==
This is a grail for some XBMC users and with inclusion of [[AudioEngine]] it becomes more complex and even impossible in some cases.

One XBMC forum user, '''puntloos''', posted his finding which seem to work relatively well for his setup. Bear in mind that this will not be universal, though, and thus may not work under other circumstances.
 

{{forum link2|[[forum:145430|Setting up dual audio forum discussion thread]]}}

== Known issues ==
'''''See:''''' [[XBMC v12 (Frodo) issues]]

[[Category:XBMC Manual]]
[[Category:FAQ|Linux]]
[[Category:Linux|*]]
[[Category:Troubleshooting]]
{{frodo updated}}

Archive talk:XBMC v13 (Gotham) changelog

2014-02-02T11:28:32Z

Prof Yaffle:

==Posted initial condensed changelog for Gotham==
Marry X(BMC)mas! I now posted an initial condensed changelog list here at [[XBMC v13 (Gotham) changelog]] just to help anyone get started. I am not sure if all the features and functions that I posted actually made it into Gotham before the feature freeze or not, or if some of them was bumped to the next of future version of XBMC, and some things that I did put it have probably been sorted into the wrong category. However what I am sure of is that I know I missed many things and that list is not complete, even as just a condensed changelog, so please, any assistance in improving is would be very much appreciated [[User:Gamester17|Gamester17]] ([[User talk:Gamester17|talk]]) 13:54, 23 December 2013 (EST)

==Tips for maintaining release changelogs==
Hiya all! If any of you guys are looking to volunteer assisting with maintaining a condensed changelog then may I suggest that you utilize the XBMC article on Wikipedia and/or XBMC's own Wiki here on wiki.xbmc.org

XBMC condensed changelog is available on Wikipedia today as release history listed under the Releases section (click "[expand]" to see the list):
* http://en.wikipedia.org/wiki/XBMC#Releases

Most of that information has been copied the Changelog (for a full changelog) and Releases (for condensed changelogs history) articles on wiki.xbmc.org or vice verse:
* http://wiki.xbmc.org/index.php?title=Releases
* http://wiki.xbmc.org/index.php?title=XBMC_v13_(Gotham)_changelog
* http://wiki.xbmc.org/index.php?title=XBMC_v12_(Frodo)_changelog
* http://wiki.xbmc.org/index.php?title=XBMC_v11_(Eden)_changelog

Before the changelogs wiki.xbmc.org was listed per point release:
* http://wiki.xbmc.org/index.php?title=Category:Point_releases
* http://wiki.xbmc.org/index.php?title=XBMC_9.04_point_release

Best source today is the closed pull requests, and you also have all non-pull repository checkins under Timeline on XBMC's Trac site:
* http://github.com/xbmc/xbmc/issues/milestones?state=closed
* http://trac.xbmc.org/timeline

There used to be a condensed changelog available as Roadmap on XBMC's Trac but that has not been maintained for a long time:
* http://trac.xbmc.org/roadmap
* http://trac.xbmc.org/milestone/Future%20/%20Pending
* http://trac.xbmc.org/milestone/11.0
* http://trac.xbmc.org/milestone/10.0

Some more information on the new Frodo features also look to be available in the xbmc.org wiki today, and hopefully this will become a tradition to follow in future releases as well:
* http://wiki.xbmc.org/index.php?title=Category:Frodo_feature

Personally I think it is mostly uninteresting to keep a condensed changelog for each nightly or even alpha releases, as the monthly blog posts on xbmc.org work better for those. Regards // [[User:Gamester17|Gamester17]] ([[User talk:Gamester17|talk]]) 14:00, 23 December 2013 (EST)

:Very nice! Thanks for the tips, and great work as always on the changelogs :D -- [[User:Ned Scott|Ned Scott]] ([[User talk:Ned Scott|talk]]) 22:22, 23 December 2013 (EST)

==Features and functions that did not make it into Gotham?==
Here below is a condensed list of larger features and functions that it looks like they did not make it into Gotham but there still are opened pull requests or development branches for these things. [[User:Gamester17|Gamester17]] ([[User talk:Gamester17|talk]]) 14:13, 23 December 2013 (EST)
* Add a unified Games Manager Library and GUI front-end launcher with online metadata web scraping support
* Add Games entry to the GUI, also introduces Game Addons as new type of addons with just-in-time emulator installation
* Add Games Library for Game Metadata, exposing info (current level, number of lives, number of coins earned, etc.) to GUI
* Add "Heimdall" new multi-scource metadata extraction engine and web scraper framework and addon API for compatible scrapers
* Add new "Heimdall" compatible scrapers for Games (e.g. TheGamesDB.net), Movies, TV Shows, Music Videos, and Music, etc.
* Extend the Addon API to support Game Client Addons, supporting XBMC's VFS (Virtual File System), etc.
* Add RetroPlayer Video Game Console Emulator (ROM image player) interface supporting the libretro API and emulator cores
* Add generic and user-mappable cross-platform Joystick (and Gamepad) abstraction layer for joystick APIs and joystick clients
* Add support for "Peripheral" Addons for updatable configuration of input devices[http://github.com/xbmc/xbmc/pull/2706]
* Add UPnP Multi-Client support with full UPnP server/backend Bi-Directional client/frontend communication and sharing
* Add support for flagging of local verses remote content, and flagging of online verses temporary offline remote content
* Add support for handling duplicate media in several ways (ex. multiple versions of same movie in different resolutions)
* Add Pictures (Digital Images) Library GUI with metadata tags scraper to database and OSD interface
* Add further optimizations to XBMC's GUI engine for faster rendering on low resource embedded devices
* Add abstracted scene-graph deferred rendering for GUI renderer abstraction[http://github.com/xbmc/xbmc/pull/2681]
* Add framework support for binary addons (inc. closed source proprietary addons), for media player cores, and codecs
* Extend Addons API to support binary addons (inc. closed source proprietary addons), for media player cores, and codecs
* Add support for C#, Java, Go, Modula-3, OCaml, Octav], and Scheme addons via [[Groovy (programming language)|Groovy]] and [[SWIG]] code-generation
* Add support for Lua, Perl, PHP, R, Ruby, Tcl scripting languages based add-ons via [[Groovy]] and [[SWIG]]
* MIPS processor architecture support ([[Sigma Designs]] reference)
* Add support for display on [[DirectFB]] support via Mesa and DRM for OpenGL ES 2.0 support
* Added initial native support for rendering display and input on [[Wayland (display server protocol)|Wayland]] compositors
* Add native [[XvBA]] accelerated video decoding for AMD/ATI GPUs on Linux
* Add support for [[place-shifting|Place-Shifting]] streaming videos / music output ability to UPnP Server, Web Server and JSON-RPC API's
* Add on-the-fly video transcoding output ability to the UPnP Server, Web Server, and JSON-RPC API's for remote apps
* Add on-the-fly audio transcoding output ability to the UPnP Server, Web Server, and JSON-RPC API's for remote apps
* Add on-the-fly image transcoding output ability to UPnP Server, Web Server, and JSON-RPC API for remote apps
* Add initial optional X11 support on EGL (EGL-X11) based systems on Linux, full-screen mode only
* Add native [[BD-J]] (Blu-ray Disc Java) and [[BD-Live#BD-Live|BD-Live]] menu and navigation support for decrypted Blu-ray Disc (via libbluray)
* Add Blu-ray AACS decryption and DRM encrypted playback via third-party library (libaacs)
* Add support for [[HEVC|High Efficiency Video Coding]] a.k.a. H.265 video decoding (as updated FFmpeg uses OpenHEVC)
* Move music lyrics addon core handling to core and added native support for lyric plugin services
* Move LCD API and LCDproc support out of XBMC's core and instead into a Python script service add-on
* Move [[Last.fm]] scrobbler and Love/Hate scrobbling out of XBMC's core and instead into an add-on
* Replace cximage and imagelib with the freeimage
* Upgrade FFmpeg (libavcodec and libavformat) libraries to release version 2.x

Archive:Linux FAQ

2014-02-01T20:52:08Z

Prof Yaffle:

{{mininav|[[General topics]]{{l2|[[Devices]]}}|[[FAQs]]{{l2|[[Linux]]}} }}
{{cleanup}}
{{FAQ header|for XBMC running under Linux-based operating systems.}}
{{XBMC FAQ}}
__TOC__
{{-}}
== General FAQ ==
:<big>''See also: '''[[XBMC all platforms FAQ]]''' for FAQs that apply to all versions of XBMC.''</big>
There are no official XBMC builds in other distros outside Ubuntu yet, if you use something other than Ubuntu check to see if XBMC is available via repositories.
:<big>''See also: '''[[Installing XBMC for Linux]]''' for How-to install XBMC in other distros''</big>

=== Linux XBMC log ===
In Linux your XBMC log is located in the path below (bear in mind this is when logged in as the xbmc user and not root):

:'''''See also:''''' [[SSH|Accessing XBMC via SSH]] e.g. Putty
{{note|The location of the log assumes you are logged in as '''<big>user</big>''' and not '''<big>root</big>'''.}} 

<source lang="bash">$HOME/.xbmc/temp/xbmc.log</source>
You can generate a debug log [http://en.wikipedia.org/wiki/Pastebin Pastebin] link automatically. This allows you to quickly post a log to anywhere that requires it.
 
{{Note|Don't forget to [[Log file#Enable Debugging|'''Enable Debugging''']] when creating the log so that maximum detail is available}} 
<source lang="bash">sudo apt-get install pastebinit -y

cat $HOME/.xbmc/temp/xbmc.log | pastebinit</source>

If you run into issues it is helpful to keep certain things in mind, especially when you're thinking about starting an XBMC forum thread or opening a report on the XBMC bug tracker. Below is a list of information that should be included in a forum post '''as a minimum'''. As a rule, you should include anything that's relevant, such as recent changes, detailed media information, etc. 

* '''Compulsory''' xbmc.log with '''debugging enabled''', which contains the problem or issue you're experiencing.
* '''Video driver problems:''' Include a copy of your '''/var/log/Xorg.0.log''' in addition to your debug log.
* '''Use a pastesite''' for logs: do not post logs in-line on forums. '''On trac''' you should attach/upload the logs with your report.
* '''System specs:''' (CPU, '''GPU''', etc.)
* '''Playback Problems:''' include '''Video''' codec and container or '''audio''' codec and container. If possible, include samples.
* '''Details''' of steps you took to attempt to fix it, if any. Describe what it is you tried when posting.
* '''Steps''' to duplicate your problem in detail.
* '''Screenshots''' that may help illustrate your problem or show your current settings. Use sites like [http://snag.gy/ snag.gy] or [http://www.postimage.org/ postimage].

For help/support visit [http://forum.xbmc.org/ '''XBMC Community Forums'''] or IRC [irc://freenode.net/ '''#xbmc-linux''']

{{see also|HOW-TO:Submit a bug report}}

=== Where is the UserData folder? ===
<source lang="bash">$HOME/.xbmc/userdata</source>

=== Where is XBMC installed? ===
The installation paths are like below:

'''Please remember''' that '''no''' user XBMC configuration files are kept here, refer to [[userdata]] for user-space files.

<pre>/usr/share/xbmc/

/usr/lib/xbmc/</pre>

=== Does XBMC for Linux support Blu-ray or HD DVD playback with or without menus? ===
:Yes, without menus. As of Dharma (10.0), XBMC includes support for playback of '''unencrypted''' Blu-ray directories when [http://www.videolan.org/developers/libbluray.html libbluray] is installed. However, XBMC must be compiled from [https://github.com/xbmc/xbmc source]. Installing from a repository like the [https://launchpad.net/~team-xbmc/+archive/unstable Team-XBMC unstable ppa] will not recognize whether libbluray is installed.

:Currently, only the longest title is played from the Blu-ray directory, even on multi-video Blu-rays (e.g. TV shows). To play a Blu-ray directory, select the /BDMV/index.bdmv in the Blu-ray directory. If stacking is enabled, selecting the Blu-ray directory folder will start playback.

;Frodo v12 includes better support for bluray .iso and folder, there is still work in progress in this area for post Frodo.

Playback Blu-ray Disc in XBMC with MakeMKV see below.

{{forum link2|[[forum:67420|playback Blu-ray Disc in XBMC for Linux with MakeMKV (Plugin Addon) Discussion thread]]}}

=== Which are the supported Linux distributions? ===
Check the '''[[HOW-TO:Install XBMC for Linux|install page]]''' for a list of supported distributions.

=== What is current recommended hardware requirements for XBMC ===
:For end-users the recommended minimum requirement is an [http://en.wikipedia.org/wiki/X86 x86-based computer], with a [http://en.wikipedia.org/wiki/Graphics_Processing_Unit 3D GPU (Graphics Processing Unit)] that at least supports [http://en.wikipedia.org/wiki/Shader_model Shader Model 3.0] and [http://en.wikipedia.org/wiki/OpenGL OpenGL 2.0] (that features 24bpp or 32bpp for 3D hardware-acceleration support, which the XBMC GUI needs to run smoothly at an acceptable frame-rate). Graphic adapters that support [http://en.wikipedia.org/wiki/DirectX DirectX version 9.0c] or later usually meet all of those mentioned requirements, ([[Team-XBMC]] recommends [http://en.wikipedia.org/wiki/Nvidia NVIDIA GeForce 6150 or later] as NVIDIA are currently the manufacturer that offers [http://en.wikipedia.org/wiki/Graphics_hardware_and_FOSS good device-drivers for Linux] (and [http://en.wikipedia.org/wiki/Nvidia NVIDIA GeForce 6150 or later] supports OpenGL 2.0)).

=== XBMC for Linux minimum requirements ===
{{#lst:Supported hardware|Linux}}

== Troubleshooting ==
=== Boot issues ===
Some Intel GPUs have issues with rc6 it can be disabled via grub.
<source lang="bash">sudo nano /etc/default/grub</source>

Append '''i915.i915_enable_rc6=0''' to:

<source lang="xml">GRUB_CMDLINE_LINUX_DEFAULT="quiet splash i915.i915_enable_rc6=0"</source>

* Press {{keypress|ctrl|X}} say '''YES''' to save file

;Then run

<source lang="bash">sudo update-grub</source>
=== Video Device Driver ===
{{incomplete}}
:Most of the problems that you encounter with slow display or OpenGL related errors are because you do not have the proper or outdated display drivers installed.

=== Begin but install the video drivers the Ubuntu Way ===
:* For '''NVIDIA''' drivers follow the guide [https://help.ubuntu.com/community/BinaryDriverHowto/Nvidia click this (link)]
:* For '''ATI''' drivers follow the guide [https://help.ubuntu.com/community/BinaryDriverHowto/ATI click this (link)]
:* For '''Intel''' it is simpler since the drivers are open source so they are usually already pre-installed. You need to make sure that you use the newer '''Intel''' driver and not the older '''i810''' driver or the 'vesa' driver. This could be verified by checking the 'Driver' value in /etc/X11/xorg.conf.
:Make sure your hardware acceleration '''libva''' or '''sna''' is installed and working.
:Deinterlacing in Intel hardware needs cutting edge drivers like '''xserver-xorg-video-intel''', '''libva-intel-vaapi-driver''' 

Below, you can find forum discussions on various relevant topics, including complete setups and configuration of drivers. '''No NVidia forum discussion link exists yet, so please add links if you know of any relevant ones.''' 

{{forum link2|[[forum:|NVidia Place Holder forum discussion thread ?]]}}
{{forum link2|[[forum:116996|XVBA for AMD Radeon/Fusion/NVidia forum discussion thread]]}}
{{forum link2|[[forum:114368|Intel GPU forum discussion thread]]}} 

=== Upgrading NVidia drivers in Ubuntu and variants ===
'''For Linux''', updating your graphics drivers can be a decisive step in resolving some issues. Ubuntu and XBMCbuntu ship with often outdated drivers that do not support a platform fully.
Make sure that old versions of the NVidia drivers are removed if you use other 3rd party PPAs (repositories). For the sake of your sanity, '''don't remove any Ubuntu sources''', as that is likely to break something if you remove them.

<source lang="bash">
sudo apt-get install python-software-properties pkg-config
sudo add-apt-repository -r ppa:the_3rd_party_ppa_you_wish_to_remove_here
sudo add-apt-repository ppa:ubuntu-x-swat/x-updates
apt-get update
sudo apt-get install nvidia-current nvidia-settings
</source> 

{{forum link2|[[forum:142220|NVidia Drivers updates XBMCBuntu, Ubuntu and variants forum discussion thread]]}} 

=== Intel SNA Acceleration ===
Intel uses VAAPI for GPU-accelerated video playback decoding, however there are other acceleration methods in the pipeline like SNA.
The use of GPU acceleration is an essential part of getting both smooth video playback and a lag-free interface (GUI).
Create or edit your existing '''/etc/X11/xorg.conf''' and add to section '''Device''' as below.

<pre>Section "Device"
Identifier "Intel Graphics"
Driver "intel"
Option "AccelMethod" "sna"
EndSection</pre>

For more information on '''SNA''', see: [http://www.phoronix.com/scan.php?page=article&item=intel_sna_july2012&num=1 '''Intel SNA vs. UXA On Ivy Bridge''']

{{forum link2|[[forum:144633|Optimal video settings for Intel GPU forum discussion thread]]}}

=== Verify OpenGL support ===
:Once you have your drivers in place, you need to make sure that OpenGL is properly configured. Run the following command:

<source lang="bash">
# glxinfo | grep -i direct
</source>

:The result should be:
<pre>Direct rendering: Yes</pre>
:If the result is "'''No'''", it means that the display driver have not been properly configured. Also, you can run the command '''glxgears''' and you should see the wheels turning smoothly.

== Update XBMC from any PPA ==
We obviously recommend the use of our PPAs, but we recognise that Ubuntu is only one of the many Linux distributions in use and users will also have Archlinux, Debian or Gentoo (amongst many others). Please feel free to provide details on how you can upgrade packages on these and other distros. The details below are thus really intended for XBMCbuntu and Ubuntu variant (Xubuntu, Kubuntu, Mint...) installations.

=== Where are XBMC Packages for Ubuntu/Debian? ===
;Official
* https://launchpad.net/~team-xbmc/+archive/ppa '''ppa:team-xbmc/ppa'''
* https://launchpad.net/~team-xbmc/+archive/unstable '''ppa:team-xbmc/unstable'''
* https://launchpad.net/~team-xbmc/+archive/xbmc-nightly '''ppa:team-xbmc/xbmc-nightly'''
;Xvba and improved Vdpau (not mainline)
* https://launchpad.net/~wsnipex/+archive/xbmc-xvba '''ppa:wsnipex/xbmc-xvba'''
* https://launchpad.net/~wsnipex/+archive/xbmc-xvba-frodo '''ppa:wsnipex/xbmc-xvba-frodo'''

;3rd party (contains older Ubuntu support etc)
* https://launchpad.net/~nathan-renniewaldock/+archive/xbmc-stable '''ppa:nathan-renniewaldock/xbmc-stable'''
* https://launchpad.net/~nathan-renniewaldock/+archive/xbmc-nightly '''ppa:nathan-renniewaldock/xbmc-nightly'''
* http://www.loggn.de/ubuntu-xbmc-repository-11-eden-airplay-pvr-livetv/

==== Ubuntu manual XBMC upgrade process ====
{{greenv|'''NOTICE:'''|[[XBMC v12 (Frodo) FAQ#What might break when upgrading to v12.3F .28Audio and Video.2C add-ons.2C skins.2C remotes.29|'''What might break when upgrading to v12''']] is a must-read for users upgrading to a final version.}}
Below is the process to upgrade XBMC manually and/or change the repository being used if you have a different source PPA (it is recommended to remove any previous PPAs that contain the same package sources). '''If you use other distros, please update or add a subsection with relevant information'''.

Connect to your Debian/Ubuntu-based distro via [[SSH]] and run the commands below:

<source lang="bash">
sudo apt-get install python-software-properties pkg-config
sudo add-apt-repository -r ppa:current_XBMC_providing_ppa
sudo add-apt-repository ppa:the_ppa_you_wish_to_use
sudo apt-get update
sudo apt-get upgrade
sudo apt-get remove xbmc xbmc.bin
sudo apt-get install xbmc xbmc.bin
</source>

==== Arch manual XBMC upgrade process ====
This part needs to be updated <big>'''?'''</big>

==== FreeBSD manual XBMC upgrade process ====
:Upgrading XBMC in FreeBSD is pretty simple, as long as a new version exists in port

; Update you port tree:
<pre>portsnap fetch update</pre>
; Update XBMC:
<pre>portmaster multimedia/xbmc</pre>

==== Gentoo manual XBMC upgrade process ====
This part needs to be updated <big>'''?'''</big>

=== Compiz is not compatible with XBMC ===
:Make sure Compiz visual effects is disabled. You can do this by going to System -> Preferences -> Appearance -> Visual Effects. Make sure "None" is selected. Alternatively, you can tell Compiz not to interfere with XBMC. Install and run CompizConfig, and under General Options tick Unredirect Fullscreen Windows.

:For NVIDIA-Graphics use Disable composite in xorg.conf, like so:
<pre>Section "Extensions"
Option "Composite" "Disable"
EndSection</pre>
Or in terminal
<source lang="bash">
sudo nvidia-xconfig --no-composite
</source>
: '''Minimal xorg.conf for NVidia''' [[Minimal NVidia xorg.conf]]

=== Audio issues ===
For XBMC v12 Frodo specific settings please see '''[[AudioEngine]]'''.

=== '''Why do I get no audio devices detected ?''' ===
If you have installed lightdm this will happen, it's is not a XBMC issue. A workaround exists.
:<big>'''''See: [[XBMCbuntu#XBMCbuntu no audio devices|XBMCbuntu no audio devices''''']]</big>

=== Required packages ===
<source lang="bash">
sudo apt-get install alsa-utils libasound2
</source>

=== '''No sound in XBMC''' ===
{{Note|'''<big>Unmute channels in alsamixer</big>''' in all cases if you're getting no sound via e.g. '''<big>HDMI</big>'''. Just for guidance, a couple of quick reference commands are listed below.}}
{{tip|Substitute '''IEC958''' with your device ID depending on your '''{{code|aplay -l}} output.}}'''
<source lang="bash">
amixer -q set Master 100% unmute
amixer -q set PCM 100% unmute
amixer -q set 'IEC958',1 unmute
amixer -q set 'IEC958',0 unmute
</source>

{{note|Make sure that your correct sound card is in use in alsamixer. To change your card, press {{keypress|F6}} and then try different cards to make ensure it's not something as simple as using the wrong card - sometimes the onboard card may not be the one you want or need.}}
{{note|For systems that have '''multiple sound cards''' e.g. Intel Azalia (internal) - GT520 (external), you could try to disable the onboard card in '''system BIOS''' if it's not in use. This is suitable where, for example, you're using a Soundblaster or perhaps a video card that also audio e.g. HDA Nvidia.}}

=== '''HDMI Channel Audio remapping''' ===
Some combinations of systems (e.g. ION) and receivers may have incorrectly mapped HDMI channels.
:'''''See also:'' [[HOW-TO:Remap_HDMI_audio_on_Gen_1_ION_-_Linux|HOW-TO: Remap HDMI audio on Gen 1 ION - Linux''']]

== Dual Audio setup ==
This is a grail for some XBMC users and with inclusion of [[AudioEngine]] it becomes more complex and even impossible in some cases.

One XBMC forum user, '''puntloos''', posted his finding which seem to work relatively well for his setup. Bear in mind that this will not be universal, though, and thus may not work under other circumstances.
 

{{forum link2|[[forum:145430|Setting up dual audio forum discussion thread]]}}

== Known issues ==
'''''See:''''' [[XBMC v12 (Frodo) issues]]

[[Category:XBMC Manual]]
[[Category:FAQ|Linux]]
[[Category:Linux|*]]
[[Category:Troubleshooting]]
{{frodo updated}}

Archive:HEVC

2014-02-01T20:02:46Z

Prof Yaffle: Minor cosmetic corrections and external links

===== About HEVC =====
HEVC (High Efficiency Video Coding) is a new video compression format. It was formalized on the 25th of November 2013 and published as [http://www.iso.org/iso/catalogue_detail.htm?csnumber=35424 ISO/IEC 23008-2:2013].
It is the successor of H.264 and is sometimes called ''H.265'', although that name was discarded by the commission. Work on the open source HEVC decoder and encoder ([http://x265.org/ x265]) is still being done, but a proposed implementation of the codec has been made available.

You can read more about the format on Wikipedia [http://en.wikipedia.org/wiki/High_Efficiency_Video_Coding here].

===== Support in XBMC =====
As of this moment time (January/February 2014) XBMC doesn't suppport the HEVC codec. Support will come when an update of FFmpeg is applied to DVDPlayer (XBMC's video player component).

===== Support in FFmpeg =====
The FFmpeg maintainers included support for the proposed version of the HEVC decoder in FFmpeg version 2.1.

This version of FFmpeg is not in use in the most recent builds of XBMC and, since we are not allowing any more new features to go in to v13 'Gotham' development (we are in ''feature freeze''), this feature will '''not''' make it into XBMC 13.0. We are, of course, planning to upgrade FFmpeg to a higher version but this will happen after 13.0 has been released.

===== Planning =====
A first test to upgrade FFmpeg to the latest version resulted in a severe memory leak which caused 16GB of memory usage within 20 minutes. Obviously these issues need to be resolved before you will see a version with FFmpeg 2.1, and there are developers working on it, but the main focus at this point in time is on releasing XBMC 13.0 'Gotham'

By the time the x265 encoder is finalised and people start using it widely there will be support for it in XBMC, but at this moment we are not there yet. Therefore the best suggestion is to avoid using this encoder for the moment if you intend to play your creations with XBMC.

===== Hardware acceleration =====
Currently there are no hardware accelerated options to play HEVC content, so you would need a pretty beefy CPU to decode a highly compressed HEVC movie.