Official Kodi Wiki - User contributions [en]

Advancedsettings.xml

2017-10-23T12:14:04Z

FernetMenta:

{{TOC right}}{{mininav|[[Settings]]|page=advancedsettings.xml}}
{{bigger|{{note|'''The advancedsettings.xml file does not exist by default. You have to create it first!'''}} }}

<section begin="intro" />The [[advancedsettings.xml]] file, which does not exist by default, can be created by a user in their '''[[userdata folder]]'''.

This file is used for advanced settings and options that do not have GUI controls inside of {{kodi}}. Some settings are experimental or very rarely set, so they can only be used via the advancedsettings.xml file. The file is simply a plain text file and can be edited by various text editors, so long as the name is "advancedsettings.xml". These advanced settings can be used to tweak various things such as episode naming patterns, special network ports, special behaviors, and more.<section end="intro" />

The following page will describe the structure of the advancedsettings.xml file and the various individual settings.

{{note|
# All XML tags must be lowercase. The start and end of the advancedsettings.xml file must have the <advancedsettings> and </advancedsettings> tags.
# Kodi will only read the advancedsettings.xml file when it starts up. If you make changes while it is running then you must restart Kodi.
# For some Windows versions, Kodi 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%\Kodi\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 its value.

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

= 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 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 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
| description =
The logging level that Kodi 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>

<br />

{{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.}}<br />

{{Note| If debugging is switched on in the GUI when Kodi is shut down, then it will be automatically be re-enabled at level 2 when it 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>.}}<br />
}}
<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 Kodi 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 Kodi 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 h.264 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
* 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}}

The <video> section also includes the following child-tags, which have their own sections:
*[[#cleandatetime]]
*[[#cleanstrings]]
*[[#excludefromscan]]
*[[#excludefromlisting]]
*[[#excludetvshowsfromscan]]

{{note|Some tags that have a "third-level" and are grouped together are highlighted in color.}}

{| class="prettytable"
! Tag !! Description
|-
|
<syntaxhighlight lang="xml">
<video>
</syntaxhighlight>
| Parent tag that all other child tags need to be placed inside of. Do not use more than one '''<code><video></code>''' tag, but instead place all other child-tags within a single '''<code><video></video></code>''' set.
|-
|
<syntaxhighlight lang="xml">
<subsdelayrange>10</subsdelayrange>
</syntaxhighlight>
| Delay range for subtitles, in seconds.
|-
|
<syntaxhighlight lang="xml">
<audiodelayrange>10</audiodelayrange>
</syntaxhighlight>
| Delay range for audio/video sync, in seconds.
|-
|
<syntaxhighlight lang="xml">
<usetimeseeking>true</usetimeseeking>
</syntaxhighlight>
| Whether to use time based or percentage based seeking. {{small see also|HOW-TO:Modify time seeking}}
|-
|
<syntaxhighlight lang="xml">
<timeseekforwardbig>600</timeseekforwardbig>
<timeseekbackwardbig>-600</timeseekbackwardbig>
</syntaxhighlight>
| Time to seek forward in seconds when doing a long seek. Defaults to 600 (10 minutes) and -600 (-10 minutes) respectively. ''{{small|See also: [[HOW-TO:Modify time seeking]] }}''
|-
|
<syntaxhighlight lang="xml">
<percentseekforward>2</percentseekforward>
<percentseekbackward>-2</percentseekbackward>
</syntaxhighlight>
| Amount to seek forward as a percentage, when doing a short seek. Defaults to 2 (2%) and -2 (2%) respectively. ''{{small|See also: [[HOW-TO:Modify time seeking]] }}''
|-
|
<syntaxhighlight lang="xml">
<percentseekforwardbig>10</percentseekforwardbig>
<percentseekbackwardbig>-10</percentseekbackwardbig>
</syntaxhighlight>
| Amount to seek forward as a percentage, when doing a long seek. Defaults to 10 (10%) and -10 (10%) respectively. ''{{small|See also: [[HOW-TO:Modify time seeking]] }}''
|-
|
<syntaxhighlight lang="xml">
<fullscreenonmoviestart>true</fullscreenonmoviestart>
</syntaxhighlight>
| Whether to go to fullscreen or not when starting a movie. Defaults to true.
|-
|
<syntaxhighlight lang="xml">
<defaultplayer>VideoPlayer</defaultplayer>
</syntaxhighlight>
| Set the default video player: VideoPlayer or an external player. See '''[[External players]]''' for more info.
|-
|
<syntaxhighlight lang="xml">
<excludefromscan>
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp>
</excludefromscan>
</syntaxhighlight>
| Regular expressions that if evaluated to true won't be added to library. It is possible to add multiple <code><regexp></code> tags to match multiple patterns
|-
|
<syntaxhighlight lang="xml">
<excludefromlisting>
<regexp>[-\._ ](sample|trailer)[-\._ ]</regexp>
</excludefromlisting>
</syntaxhighlight>
| Regular expressions that if evaluated to true won't be displayed in files view.
|-
|
<syntaxhighlight lang="xml">
<playcountminimumpercent>90</playcountminimumpercent>
</syntaxhighlight>
| Minimum percentage that has to be played before it is marked as watched. Set to 101 to never auto-mark items as watched. ''{{small|See also: [[HOW-TO:Modify automatic watch and resume points]] }}''
|-
|
<syntaxhighlight lang="xml">
<ignoresecondsatstart>180</ignoresecondsatstart>
</syntaxhighlight>
| Number of seconds to ignore at video start after which a resume point is created. ''{{small|See also: [[HOW-TO:Modify automatic watch and resume points]] }}''
|-
|
<syntaxhighlight lang="xml">
<ignorepercentatend>8</ignorepercentatend>
</syntaxhighlight>
| Percentage of video to ignore at the end. If you stop watching the video here no resume point is created. Set to 101 to never save a resume point. The video is already marked as watched at 90%, see above. ''{{small|See also: [[HOW-TO:Modify automatic watch and resume points]] }}''
|-
|
<syntaxhighlight lang="xml">
<vdpauscaling>true</vdpauscaling>
</syntaxhighlight>
| Scales with vdpau instead of opengl and turns on its HQ scaler when available, enabling this might slow down rendering and cause framedrops especially on ION systems, this setting requires a vdpau feature set C GPU.
|-
|
<syntaxhighlight lang="xml">
<enablehighqualityhwscalers>true</enablehighqualityhwscalers>
</syntaxhighlight>
| Allow turning on the spline36 and lanczos3 shader (for GL builds).
|-
|
<syntaxhighlight lang="xml">
<dxvaallowhqscaling>false</dxvaallowhqscaling>
</syntaxhighlight>
| Enables high quality video upscaling for Windows.
|-
|
<syntaxhighlight lang="xml">
<ppffmpegdeinterlacing>linblenddeint</ppffmpegdeinterlacing>
</syntaxhighlight>
| Override the deinterlacing options passed to libpostproc.
|-
|
<syntaxhighlight lang="xml">
<ppffmpegpostprocessing>ha:128:7,va,dr</ppffmpegpostprocessing>
</syntaxhighlight>
| Override the post processing options passed to libpostproc when 'Video post-processing' is activated in GUI Videos-Settings-Playback.
|-
|
<syntaxhighlight lang="xml">
<autoscalemaxfps>30</autoscalemaxfps>
</syntaxhighlight>
| When scaling method is set to auto, bilinear is chosen when the fps is higher than this limit, the default is 30.
|-
|
<syntaxhighlight lang="xml">
<adjustrefreshrate>
</syntaxhighlight>
| style="background:#CADCFB;" | Settings for when "Adjust refreshrate to match video fps" is enabled in the video playback GUI settings.
|-
|
<syntaxhighlight lang="xml">
<override>
<fps>23.976</fps>
<refresh>60.0</refresh>
</override>
</syntaxhighlight>
| style="background:#CADCFB;" | '''Example -''' "Adjust refreshrate to match video fps" will try to select the best refreshrate for the video fps but it doesn't always get it right, for example it might switch to an unsupported refreshrate. You can add overrides here to switch to a certain refreshrate based on video fps. It's possible to add as many overrides as you need. Overrides are processed in order, if the first one doesn't match the fps or no refreshrates match that override, it will try the next one until no overrides are left.

* '''fps''' - if the fps is between 23.966 and 23.986
* '''refresh''' - switch to the first found refreshrate that is between 59.99 and 60.01
|-
|
<syntaxhighlight lang="xml">
<override>
<fpsmin>29.96</fpsmin>
<fpsmax>30.01</fpsmax>
<refreshmin>59.0</refreshmin>
<refreshmax>61.0</refreshmax>
</override>
</syntaxhighlight>
| style="background:#CADCFB;" | '''Example -'''
* '''fpsmin''' / '''fpsmin''' - You can also specify the fps range yourself.
* '''refreshmin''' / '''refreshmax''' - Same for the refreshrate
|-
|
<syntaxhighlight lang="xml">
<fallback>
<refresh>50.0</refresh>
</fallback>
</syntaxhighlight>
| style="background:#CADCFB;" | '''Example -''' If none of the overrides match, or none of the refreshrates match any of the fps matching overrides, it will choose a fallback refreshrate. Fallbacks are process in order, if the first fallback doesn't match any refreshrate, it will try the next one until no fallbacks are left.

* '''refresh''' - Switch to the first found refreshrate that is between 49.99 and 50.01.
|-
|
<syntaxhighlight lang="xml">
<fallback>
<refreshmin>49.0</refreshmin>
<refreshmax>51.0</refreshmax>
</fallback>
</syntaxhighlight>
| style="background:#CADCFB;" | '''Example -''' You can also specify the range for the fallback yourself.

If none of the overrides match the video fps, or no refreshrates match any of the fps matching overrides, and no fallbacks are specified or no refreshrates match any fallbacks, it will automatically choose the best refreshrate (same as having no overrides and fallbacks).
|-
|
<syntaxhighlight lang="xml">
</adjustrefreshrate>
</syntaxhighlight>
| style="background:#CADCFB;" |
|-
|
<syntaxhighlight lang="xml">
<checkdxvacompatibility>value</checkdxvacompatibility>
</syntaxhighlight>
| Advanced setting not present: let Kodi autodetect cards that support H.264 profile > L4.1. Set value to false to enable DXVA no matter what. Set value to true if Kodi doesn't autodetect that the graphics card doesn't support > L4.1.
|-
|
<syntaxhighlight lang="xml">
<useocclusionquery>-1</useocclusionquery>
</syntaxhighlight>
| Use an occlusion query when capturing videoframes, -1 means auto detect, 0 means disabled, 1 means enabled, the default is -1.
|-
|
<syntaxhighlight lang="xml">
<fpsdetect>1</fpsdetect>
</syntaxhighlight>
| FPS detection for video playback
* 0 = trust codec fps
* 1 = recalculate from video timestamps with uniform spacing
* 2 = recalculate from video timestamps always
|-
|
<syntaxhighlight lang="xml">
<latency>
</syntaxhighlight>
| style="background:#F0E68C;"| Start of '''latency''' tags. Display latency (video lag). Latency is given in msecs.
|-
|
<syntaxhighlight lang="xml">
<delay>0</delay>
</syntaxhighlight>
| style="background:#F0E68C;" | Global default display latency.
|-
|
<syntaxhighlight lang="xml">
<refresh></refresh>
</syntaxhighlight>
| style="background:#F0E68C;" | Override latency for given display (not video) refresh rates. When Kodi is in windowed mode, override is ignored. Multiple overrides are allowed.

Syntax of an override entry:
<syntaxhighlight lang="xml">
<refresh>
<min>, <max> refresh rate range, OR
<rate> exact refresh rate
<delay> display latency for the given refresh rate
</refresh>
</syntaxhighlight>
|-
|
<syntaxhighlight lang="xml">
<refresh>
<min>23</min>
<max>24</max>
<delay>125</delay>
</refresh>
</syntaxhighlight>
| style="background:#F0E68C;" | '''Example:''' display has 125 msec latency at 23-24 Hz
|-
|
<syntaxhighlight lang="xml">
<refresh>
<rate>50</rate>
<delay>50</delay>
</refresh>
</syntaxhighlight>
| style="background:#F0E68C;" | '''Example:''' display has 50 msec latency at 50 (+/-0.01) Hz
|-
|
<syntaxhighlight lang="xml">
</latency>
</syntaxhighlight>
| style="background:#F0E68C;" |
|-
|
<syntaxhighlight lang="xml">
<stereoscopicregex3d>[-. _]3d[-. _]</stereoscopicregex3d>
<stereoscopicregexsbs>[-. _]h?sbs[-. _]</stereoscopicregexsbs>
<stereoscopicregextab>[-. _]h?tab[-. _]</stereoscopicregextab>
</syntaxhighlight>
| Filename triggers for 3D (stereoscopic) mode.
|-
|
<syntaxhighlight lang="xml">
<assfixedworks>false</assfixedworks>
</syntaxhighlight>
| Position behavior of ass subtitiles when setting "subtitle position on screen" set to "fixed". True to show at the fixed position set in video calibration. False to show at the bottom of video (default).
|-
|
<syntaxhighlight lang="xml">
</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>

<applydrc>-1.0</applydrc>

<limiterhold>0.025</limiterhold>

<limiterrelease>0.1</limiterrelease>
</audio>
</syntaxhighlight>

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

=== 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> 
<channeliconsautoscan>true</channeliconsautoscan> 
<autoscaniconsuserset>false</autoscaniconsuserset> 
<numericchannelswitchtimeout>1000</numericchannelswitchtimeout> 
</pvr>
</syntaxhighlight>

=== epg ===
{{anchor|.3Cpvr.3E}}
<syntaxhighlight lang="xml" enclose="div">
<epg>
<lingertime>1440</lingertime> 
<updatecheckinterval>300</updatecheckinterval> 
<cleanupinterval>900</cleanupinterval> 
<activetagcheckinterval>60</activetagcheckinterval> 
<retryinterruptedupdateinterval>30</retryinterruptedupdateinterval> 
<updateemptytagsinterval>60</updateemptytagsinterval> 
<displayupdatepopup>true</displayupdatepopup> 
<displayincrementalupdatepopup>false</displayincrementalupdatepopup> 
</epg>
</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}}<section begin="videoextensions" />
A list of additional file-extensions to allow ('''add''') or exclude ('''remove''') in the My Video windows.

Default extensions for VIDEOS:
<pre>
.m4v .3g2 .3gp .nsv .tp .ts .ty .strm .pls .rm .rmvb .mpd .m3u .m3u8 .ifo .mov .qt .divx .xvid
.bivx .vob .nrg .pva .wmv .asf .asx .ogm .m2v .avi .dat .mpg .mpeg .mp4 .mkv .mk3d .avc .vp3
.svq3 .nuv .viv .dv .fli .flv .001 .wpl .vdr .dvr-ms .xsp .mts .m2t .m2ts .evo .ogv .sdp .avs
.rec .url .pxml .vc1 .h264 .rcv .rss .mpls .webm .bdmv .wtv
</pre>
Examples:
<syntaxhighlight lang="xml" enclose="div">
<videoextensions>
<add>.ex1|.ex2</add>
<remove>.ex3|.ex4</remove>
</videoextensions>
</syntaxhighlight>
<section end="videoextensions" />

=== discstubextensions ===
{{anchor|.3Cdiscstubextensions.3E}}
{{main|Media stubs}}
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">
<languagecodes>
<code>
<short>alt</short>
<long>Alternate</long>
</code>
</languagecodes>
</syntaxhighlight>

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

=== moviestacking ===
{{anchor|.3Cmoviestacking.3E}}<section begin="moviestacking" />
{{main|File stacking}}
This is used by the [[file stacking]] algorithm to combine multi-part files and contains a list of "''[[Regular Expression (RegEx) Tutorial|regular expressions]]''". For stacking videos that are contained in folders, such as VIDEO_TS folders, see '''[[advancedsettings.xml#folderstacking|<folderstacking>]]'''

As of v9.11, video stacking regular expressions '''must''' contain exactly four (4) capture expressions.

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

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

<regexp>(.*?)([ _.-]*(?:cd|dvd|p(?:ar)?t|dis[ck])[ _.-]*[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.
<section end="moviestacking" />

=== folderstacking ===
{{main|File stacking}}
This is similar to '''[[advancedsettings.xml#moviestacking|<moviestacking>]]''', but is used for videos that are contained in folders that use the folder names to stack, such as VIDEO_TS folders (DVD rips that are not in ISO format).

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

<regexp>((cd|dvd|dis[ck])[0-9]+)$</regexp>
</folderstacking>
</syntaxhighlight>

=== 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|cd[1-9]|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|\[.*\])([ _\,\.\[\]\-]|$)</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>s([0-9]+)[ ._x-]*e([0-9]+(?:(?:[a-i]|\\.[1-9])(?![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)
:* 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.kodi.tv/showthread.php?t=51614 forum thread] has a discussion of pre-made regex lists to match common names. These might improve Kodi's ability to match TV show names in some situations, at the risk of 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' by default, so that you can use
the 'Use Absolute Ordering (Single Season)' setting from the TheTvDb.com scraper.

; Simple Method ''(XBMC v9.11 onwards and Kodi)''
: Use only one pair of parentheses
<syntaxhighlight lang="xml" enclose="div"><regexp>[/\._ \-]([0-9]+)</regexp></syntaxhighlight>
; Advanced Method ''(XBMC v10.05 onwards and Kodi)''
: 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>

; Specifying Default Season ''(XBMC v12.0 onwards and Kodi)''
It is possible to set the default season for specific regular expressions by setting the 'defaultseason' attribute.
: Works with both the simple method and advanced method
: If not used, the season will be set to '1'
: Useful for setting specials to season '0'
<syntaxhighlight lang="xml" enclose="div"><regexp defaultseason="0">[/\._ \-]X()([0-9]+)(-[0-9]+)?</regexp>
<regexp defaultseason="1">[/\._ \-]E()([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]]''.

Default:
<syntaxhighlight lang="xml" enclose="div">
<tvmultipartmatching>^[-_ex]+([0-9]+(?:(?:[a-i]|\\.[1-9])(?![0-9]))?)</tvmultipartmatching>
</syntaxhighlight>
:* Text matching is compared case-insensitive.
:* Specifying this option '''replaces''' the default value

=== 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)

=== 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>

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

<syntaxhighlight lang="xml" enclose="div">
<videolibrary>
<allitemsonbottom>false</allitemsonbottom> 
<cleanonupdate>false</cleanonupdate> 
<usefasthash>true</usefasthash> 
<recentlyaddeditems>35</recentlyaddeditems> 
<itemseparator> / </itemseparator> 
<exportautothumbs>false</exportautothumbs> 
<importwatchedstate>false</importwatchedstate> 
<importresumepoint>false</importresumepoint> 
<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>

== Library artwork ==

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

<section begin="imageres description" />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.<section end="imageres description" />

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

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

<section begin="fanartres description" />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.<section end="fanartres description" />

<syntaxhighlight lang="xml" enclose="div">
<fanartres>1080</fanartres>
</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>

=== musicthumbs ===
{{anchor|.3Cmusicthumbs.3E}}
<section begin="musicthumbs" />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><section end="musicthumbs" />

=== imagescalingalgorithm ===
Specify the image scaling algorithm for image resizing/caching i.e. posters, fanart, etc.
<br />
<syntaxhighlight lang="xml" enclose="div">
<imagescalingalgorithm>bicubic</imagescalingalgorithm>
</syntaxhighlight>

[https://github.com/xbmc/xbmc/blob/1a8753d5cd93890dc6a9f9d4b2ce8848066ea5d0/xbmc/pictures/PictureScalingAlgorithm.cpp#L32-L43 Available image scaling algorithms]

<syntaxhighlight lang="text" enclose="div">
fast_bilinear
bilinear
bicubic
experimental
nearest_neighbor
averaging_area
bicublin
gaussian
sinc
lanczos
bicubic_spline
</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.}}

;Example
<syntaxhighlight lang="xml" enclose="div">
<playlistasfolders>true</playlistasfolders>
</syntaxhighlight>

=== 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|musicdatabase/videodatabase|database tags music/video/tv/epg/adsp}}
{{main|MySQL}}
<section begin="videodatabase" />
Allows advanced customization of the default database settings for music, video, TV, EPG, and ADSP databases.

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

'''Parent tags:'''

* '''<videodatabase>'''
* '''<musicdatabase>'''
* '''<tvdatabase>''' - Highly experimental/unstable and no practical benefit for most users. '''Avoid using.'''
* '''<epgdatabase>''' - Highly experimental/unstable and no practical benefit for most users. '''Avoid using.'''
* '''<adspdatabase>''' - Highly experimental/unstable and no practical benefit for most users. '''Avoid using.'''
{{MySQL warning}}

'''Child tags: '''

;<type>
: ''Required'' - Can be either "sqlite3" or "mysql" (default: sqlite3)

;<host>
:''Required'' -
* sqlite3: defines the relative path to the database file (eg. /usr/local/kodi/databases).
* mysql: defines the host of the mysql socket (eg. localhost, 192.168.0.1, etc)

;<port>
: ''Optional'' -
* sqlite3: silently ignored
* mysql: defines the port of the mysql socket (default: 3306)

;<name>
: ''Optional'' -
:by default "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>
: ''Required for MySQL'' -
* sqlite3: silently ignored
* mysql: defines the user with privileged access to the database

;<pass>
: ''Required for MySQL'' -
* sqlite3: silently ignored
* mysql: defines the password for the user with privileged access to the database

;<compression>
: ''Optional'' - Defaults to false. Set to "true" to enable MySQL compression protocol. Performance benefit is going to be largely dependent on the network bandwidth, latency between database and clients and on the size of the result sets. [https://github.com/xbmc/xbmc/pull/6484]
: {{Note|Slower clients (such as the RPi and others) won't benefit from it as the zlib de-compression overhead is higher than the actual compression savings}}

;<key>
: ''Optional'' - SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]

;<cert>
: ''Optional'' - SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]

;<ca>
: ''Optional'' - SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]

;<capath>
: ''Optional'' - SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]

;<ciphers>
: ''Optional'' - SSL setting for MySQL [https://github.com/xbmc/xbmc/pull/2566]

'''Examples:'''

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

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

<section end="videodatabase" />

=== externalplayer ===
{{anchor|.3Cexternalplayer.3E}}
{{see|External players}}

== Music settings ==

=== musicextensions ===
{{anchor|.3Cmusicextensions.3E}}
<section begin="musicextensions" />
Default extensions for MUSIC:
<pre>
.nsv .m4a .flac .aac .strm .pls .rm .rma .mpa .wav .wma .ogg .mp3 .mp2 .m3u .gdm .imf .m15 .sfx
.uni .ac3 .dts .aif .aiff .wpl .ape .mac .mpc .mp+ .mpp .shn .wv .dsp .xsp .xwav .waa .wvs .wam
.gcm .idsp .mpdsp .mss .spt .rsd .sap .cmc .cmr .dmc .mpt .mpd .rmt .tmc .tm8 .tm2 .oga .url
.pxml .tta .rss .wtv .mka .tak .opus .dff .dsf .m4b .cue .zip .rar
</pre>

It is possible to add or remove extensions for Music, using the following XML tags. Useful if you keep, say, FLAC and mp3 versions of music in the same folder. The <remove> tag can be used to remove mp3 from being listed in the library, leaving only the higher quality FLAC being displayed.

<musicextensions>
<add>.ex1|.ex2</add>
<remove>.ex3|.ex4</remove>
</musicextensions>

<section end="musicextensions" />

=== 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> 
<promptfulltagscan>false</promptfulltagscan> 
<recentlyaddeditems>35</recentlyaddeditems> 
<albumformat>%B - %Y</albumformat> 
<prioritiseapetags>true</prioritiseapetags> 
<itemseparator> / </itemseparator> 
<artistseparators> 
<separator>;</separator>
<separator>:</separator>
<separator>|</separator>
<separator> feat. </separator>
<separator> ft. </separator>
</artistseparators>
<dateadded>1</dateadded> 
</musiclibrary>
</syntaxhighlight>
<br />
{{Note|Changing the <itemseparator> or <artistseparators> will only affect newly added items. Even a rescan won't change the added ones, you have to remove the music source(s) and add them again, or delete the music database to achieve this. This process should be made easier in v18 using <promptfulltagscan> (that is not available in v17)}}

== 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 .cbr .rss .webp .jp2 .apng
</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 ===
{{anchor|.3Csamba.3E}}
<syntaxhighlight lang="xml" enclose="div">
<samba>
<doscodepage></doscodepage> 
<clienttimeout>10</clienttimeout> 
<statfiles>true</statfiles> 
</samba>
</syntaxhighlight>

=== hosts ===
{{anchor|.3Cfhosts.3E}}
Static dns entries which take precedence over your dns server.
<syntaxhighlight lang="xml" enclose="div">
<hosts>
<entry name="HOSTNAME">IPADDRESS</entry>
</hosts>
</syntaxhighlight>

=== network ===
{{anchor|.3Cnetwork.3E}}
{{see also|HOW-TO:Modify the cache}}
<syntaxhighlight lang="xml" enclose="div">
<network>
<curlclienttimeout>10</curlclienttimeout> 
<curllowspeedtime>20</curllowspeedtime> 
<curlretries>2</curlretries> 
<httpproxyusername></httpproxyusername> 
<httpproxypassword></httpproxypassword> 
</network>
</syntaxhighlight>

{{Note|In Kodi v17, the three buffer settings are removed from the <code><network></code> tag and now placed under the new <code><cache></code> tag. See '''[[#cache]]''' for full details.}}

=== cache ===
{{see also|HOW-TO:Modify the cache}}
<syntaxhighlight lang="xml" enclose="div">
<cache>
<memorysize>0</memorysize> 
<buffermode>0</buffermode> 
<readfactor>4.0</readfactor> 
</cache>
</syntaxhighlight>

=== airtunesport ===
{{anchor|.3Cairtunesport.3E}}<section begin="airtunesport" />
This overwrites the defalt listening port of the AirTunes server (announced via zeroconf).
<section end="airtunesport" />

=== airplayport ===
{{anchor|.3Cairplayport.3E}}<section begin="airplayport" />
This overwrites the default listening port of the AirPlay server (announced via zeroconf).
<section end="airplayport" />

== File system settings ==

=== packagefoldersize ===
<section begin="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. Defaults to 200 MB.
| example = Example: <syntaxhighlight lang="xml" enclose="div"><packagefoldersize>200</packagefoldersize> </syntaxhighlight>
}}
<section end="packagefoldersize" />

=== detectasudf ===
{{anchor|.3Cdetectasudf.3E}}
Set to true if you wish to detect joint ISO9660/UDF disks as UDF.

Default: False

=== pathsubstitution ===
{{anchor|.3Cpathsubstitution.3E}}
{{main|Path substitution}}
Path substitutions 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 Kodi 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>

== Input control settings ==

=== remotedelay ===
{{anchor|.3Cremotedelay.3E}}
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>

=== controllerdeadzone ===
{{anchor|.3Ccontrollerdeadzone.3E}}
This advanced settings has been removed. See [[HOW-TO:Controller deadzone]].

=== enablemultimediakeys ===
{{anchor|.3Cenablemultimediakeys.3E}}
This setting only has any effect on Windows versions of Kodi, and only applies to builds from 28th May 2011 onwards.
In Windows the multimedia keys generate a WM_APPCOMMAND message in addition the keypress. Kodi 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>

=== seeksteps ===
{{Main|Skip steps}}

This setting changes which increments are available in the settings GUI for additive seeking. Note that <code><seeksteps></code> is not used to actually choose which seek steps are enabled.

'''Default:'''
<syntaxhighlight lang="xml" enclose="div">
<seeksteps>7, 15, 30, 60, 180, 300, 600, 900, 1800</seeksteps>
</syntaxhighlight>

{{editor note|the defaults need to be updated for seeksteps.}}

=== touchscreen ===
{{anchor|.3Ctouchscreen.3E}}
This setting allows you to move/align the origin of the touch screen with the origin of the display used. If touch input does not result in a correct movement of the mouse pointer, the behaviour can be corrected with an offset and a stretch/compress factor.

Example:
<syntaxhighlight lang="xml" enclose="div">
<touchscreen>
<x_offset>0</x_offset> 
<y_offset>0</y_offset> 
<x_stretch_factor>1.0</x_stretch_factor> 
<y_stretch_factor>1.0</y_stretch_factor> 
</touchscreen>
</syntaxhighlight>

== Other interface settings ==

=== window ===
{{anchor|.3Cwindow.3E}}
{{note|This is a "hidden" guisettings.xml setting (defined by the mouse moving the window size), but it is mentioned here because it is a particularly useful override when used in advancedsettings.xml}}
This allows you to manually set the default size of Kodi'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>

=== restrictcapsmask ===
{{anchor|.3Crestrictcapsmask.3E}}
Windows only. A bitmask to prevent Kodi 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>

=== algorithmdirtyregions ===
{{anchor|.3Calgorithmdirtyregions.3E}}
{{see also|HOW-TO:Modify dirty regions}}
<section begin="algorithmdirtyregions" />{{note|Some GPU/hardware configurations will have some minor issues (such as a visual "flicker"). For those situations try mode 2 or use the default (mode 3, which requires no advancedsetting). Almost all ARM-based devices (such as [[Android]]) willl likely have flickering issues.}}

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 the GUI can be sped up. Because all GPUs work differently, only Mode 3, combined with nofliptimeout=0, is guaranteed to work for everyone without flickering issues. This mode will reduce CPU/GPU usage, but will not increase GUI speed.

{| class="prettytable"
! 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'''
|}<section end="algorithmdirtyregions" />

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

=== visualizedirtyregions ===
{{anchor|.3Cvisualizedirtyregions.3E}}
{{see also|HOW-TO:Modify dirty regions}}
<section begin="visualizedirtyregions" />Enable dirty-region visualization. Paints a rectangle over marked controls.

* true: on
* false: off '''(Default)'''

{{note|This is only a development mode and isn't of use to normal users.}}
<section end="visualizedirtyregions" />
Example:
<syntaxhighlight lang="xml" enclose="div">
<gui>
<visualizedirtyregions>true</visualizedirtyregions>
</gui>
</syntaxhighlight>

=== showexitbutton ===
{{anchor|.3Cshowexitbutton.3E}}
Setting to hide the exit button, useful for people running appliance based setups 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>true</showexitbutton>
</syntaxhighlight>

=== fullscreen ===
{{anchor|.3Cfullscreen.3E}}
Starts Kodi in full screen (check resolutions!).

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

=== splash ===
{{anchor|.3Csplash.3E}}
Set to false if you wish to disable the startup splash image. Defaults to true.

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

=== cputempcommand ===
{{anchor|.3Ccputempcommand.3E}}
Provide a shell command Kodi will use to get CPU temperature. It should print out only "[temp as integer] [scale as one of "CcFf"]".<br />
;<u>For Nvidia and Raspberry Pi</u>
<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>
;<u>For ATI/AMD</u>
<syntaxhighlight lang="xml" enclose="div">
<cputempcommand>sensors|sed -ne "s/temp1: \+[-+]$[0-9]\+$.*/\1 C/p"</cputempcommand>
</syntaxhighlight>

=== gputempcommand ===
{{anchor|.3Cgputempcommand.3E}}
Provide a shell command Kodi will use to get GPU temperature. It should print out only "[temp as integer] [scale as one of "CcFf"]".<br />
;<u>For Nvidia</u>
<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>
;<u>For ATI/AMD</u>
<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>

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

=== glrectanglehack ===
{{anchor|.3Cglrectanglehack.3E}}
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 ===
{{anchor|.3Calwaysontop.3E}}
Added in XBMC v9.11 (Windows OS only). Keeps Kodi always on top when windowed.
<syntaxhighlight lang="xml" enclose="div">
<alwaysontop>yes</alwaysontop>
</syntaxhighlight>

There is also a fake fullscreen GUI option in Kodi's settings.

== Removed tags ==
{{anchor|Recently removed tags}}
* {{anchor|.3Cthumbsize.3E}}'''<thumbsize>''' - replaced by <[[#imageres|imageres]]> in v12 Frodo
* {{anchor|.3Cfanartheight.3E}}'''<fanartheight>''' - replaced by <[[#fanartres|fanartres]]> in v12 Frodo
* {{anchor|.3Cdvdthumbs.3E}}'''<dvdthumbs>''' - removed in v12 Frodo
* {{anchor|.3Cbusydialogdelayms.3E}}'''<busydialogdelayms>''' - removed in v12 Frodo
* {{anchor|.3Cbginfoloadermaxthreads.3E}}'''<bginfoloadermaxthreads>''' - removed in v13 Gotham
* '''<showepginfoonselect>''' - replaced by a GUI setting in v13 Gotham
* '''<resample>''', '''<forceDirectSound>''', '''<audiophile>''', '''<audiosinkbufferdurationmsec>''', '''<allowtranscode44100>''', and '''<streamsilence>''' - These were various sub-tags for <audio> that were removed in v13 Gotham and either replaced by GUI settings or were no longer needed.
* {{anchor|.3Cenableairtunesdebuglog.3E}}'''<enableairtunesdebuglog>''' - replaced by a GUI option in v14 Helix
* '''<videoDisableHi10pMultithreading>''' - renamed to <disableswmultithreading> in v14 Helix
* '''<hideallitems>''' - For both the <code><videolibrary></code> and <code><musiclibrary></code> sections, this is replaced by a GUI option in v15 Isengard
* '''<SmallStepBackSeconds>''' - In v15 the <code>SmallStepBack</code> [[action ID]] has been replaced by <code>seek(-7)</code> in default keymaps. See '''[[skip steps]]''' for details. When the original <code>SmallStepBack</code> action ID is used it defaults to the first backwards [[skip steps|additive seeking value]].
* '''<timeseekforward>/<timeseekbackward>''' - In v15 these tags are replaced by GUI options via [[skip steps|additive seeking]], which is configured in the GUI. See '''[[skip steps]]''' for details.
* {{anchor|.3Ckaraoke.3E}}'''<karaoke>''' - In v16 all of the karaoke features in Kodi were removed.
* '''<useddsfanart>''' - removed in v17 Krypton.
* '''<cachemembuffersize>''' and '''<readbufferfactor>''' - In v17 <cachemembuffersize> is renamed to <memorysize> and <code><readbufferfactor></code> is renamed to <code><readfactor></code>. In addition, all three buffer related settings in <network> are moved out of <network> and into a new <cache> parent tag.
* '''<minvideocachelevel>''', '''<minaudiocachelevel>''', and '''<cacheindvdplayer>''' have been removed in v17.
* '''<useffmpegvda>''' - Tag was only used for development testing. Removed in v17.
* '''<nofliptimeout>''' - Removed in v17
* '''<blackbarcolour>''' - Removed in v17 (maybe?)
* '''<disableswmultithreading>''' - Removed in v17 (maybe?)
* {{anchor|.3Cmeasurerefreshrate.3E}}'''<measurerefreshrate>''' - Removed in v17 or v18?
* {{anchor|.3Cmyth.3E}}'''<myth>''' - Removed sometime between v16 to v18
* {{anchor|.3Ctuxbox.3E}}'''<tuxbox>''' - Removed
* '''<backgroundupdate>''' - Removed
* '''<hideemptyseries>''' - Replaced by a GUI option.
* '''<mymovies>''' and child tag '''<categoriestogenres>''' - Removed
* '''<albumssortbyartistthenyear'''> - Removed
* '''<albumformatright>''' - Removed
* {{anchor|.3Cremoterepeat.3E}}'''<remoterepeat>''' - Removed
* {{anchor|.3Callowd3d9ex.3E}}'''<allowd3d9ex>''' and {{anchor|.3Cforced3d9ex.3E}}'''<forced3d9ex>''' - Removed sometime between v16 to v18

== guisettings.xml settings ==
You can also define the settings normally defined in the GUI (and stored in guisettings.xml) in advancedsettings.xml. Most guisettings.xml settings defined in advancedsettings.xml will override the guisettings.xml values, and the settings will be removed completely from the interface.

The easiest way to include a guisettings.xml setting is to first change the setting in the interface to the value that you want, and then 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 (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 option in Kodi's interface for the character set will then no longer be visible, and Kodi will always use the Hebrew (Windows) character set.

{{Updated|17}}
{{DISPLAYTITLE:advancedsettings.xml}}

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

HOW-TO:Autostart Kodi for Linux

2016-12-18T17:30:58Z

FernetMenta:

{{mininav| [[Linux]] }}
<section begin="intro" />How to automatically start up in Kodi using various Linux distributions.

<big>'''This how-to has flaws: Never Ever start Kodi without a window manager!''' (FernetMenta: the author of Kodi's X11 windowing system)</big>

The main goal of '''most''' of these methods is to start an Xserver only for Kodi. Most of these methods will '''not work''' if you have a window manager installed (however, it should not be hard to modify the scripts to suit your needs). The lightdm method might work if you need to use a window manager.

Choose '''only one''' method from sections 2 and on based on which distribution and init system you're using.<section end="intro" />

__TOC__
== Create a user to run Kodi ==
For security reasons, it is recommended (but optional) to use a dedicated user to run Kodi. The user needs access to audio and video devices as well as access the internet if you're going to use any features that require internet access. Most methods present here allow to specify which user will start / own the Kodi process.

Notice the groups might vary from one distro to another. The groups used below are for Debian-based distributions. To create the user (named '''kodi''' here) and give it the necessary permissions, run

<pre>
# adduser kodi
</pre>

Another option is to add a loginless and passwordless user. You can do so by running

<pre>
# adduser --disabled-password --disabled-login --gecos "" kodi
</pre>

Then, assign it to the following groups in order to give it the permissions it needs.

<pre>
# usermod -a -G cdrom,audio,video,plugdev,users,dialout,dip,input kodi
</pre>

To give it access to the internet, add the group '''netdev''' as well.

== Upstart init script ==
Works on Ubuntu up to version 14.10 (Utopic Unicorn). Stating with version 15.04 (Vivid Vervet), Ubuntu has switched to systemd and adding a systemd script might be prefereable. Create a '''<code>/etc/init/kodi.conf</code>''' with following contents.
<source lang="xml">
# kodi-upstart
# starts Kodi on startup by using xinit.
# by default runs as kodi, to change edit below.
env USER=kodi

description "Kodi-barebones-upstart-script"
author "Matt Filetto"

start on (filesystem and stopped udevtrigger)
stop on runlevel [016]

# tell upstart to respawn the process if abnormal exit
respawn

script
exec su -c "xinit /usr/bin/kodi-standalone -- -nocursor :0" $USER
end script
</source><br />

{{note|<code> -- -nocursor</code> option '''kills all X cursor''' on Kodi startup and does not interfere with mouse use/operation}}

You may have to edit '''<code>/etc/X11/Xwrapper.config</code>''' and replace the last line that says:

<source lang="xml">
allowed_users=console
</source>

to

<source lang="xml">
allowed_users=anybody
</source><br />

Kodi will now auto-start on boot and restart/respawn if killed or crashed.

== Modify the inittab ==

This was tested on Arch Linux.

To automatically start xbmc on your system, do the following:

First you need to make some changes to <code>/etc/inittab</code>. Comment out (add a #) to this line:

<pre>
id:3:initdefault
</pre>

to

<pre>
#id:3:initdefault
</pre>

and uncomment

<pre>
id:5:initdefault
</pre>

Then add this line to the bottom:

<pre>
x:5:wait:login -f <YOUR_XBMC_USERNAME> </dev/tty7 &>/dev/tty7
</pre>

Using wait instead of respawn means that you can exit out of xbmc into the console.

* NOTE*: This is a security hole as it autologins a dedicated xbmc user without asking for a password!

Now that we have the user logged in we need it to auto start XBMC.
In <code>~/.xinitrc</code> add the following to the end of the file
(after removing/commenting any other exec lines that start a windowmanager):

<pre>
exec ck-launch-session xbmc
</pre>

Add this line to your <code>~/.bash_profile</code>

<pre>
[[ $(tty) = "/dev/tty7" ]] && exec startx </dev/null &>/dev/null
</pre>

And create a hushlogin file to suppress login messages.

<pre>
touch ~/.hushlogin
</pre>

Lastly, for the magic sauce that makes this work, add dbus to your daemons in <code>/etc/rc.conf</code>.

<pre>
DAEMONS=(... dbus ...)
</pre>

You're finished. Next time you reboot you should be greeted with XBMC.

== Add a new init script ==

This method works well under Debian up to version 7 (Wheezy). As of version 8 (Jessie), Debian has switched to systemd and adding a systemd init script might be preferable. The current configuration is a HTPC running Debian Squeeze, with no window manager installed.

* Create a new script under '''/etc/init.d/'''. Call it '''kodi'''
* Change the rights, in order to allow it to be executable.
<pre># chmod a+x /etc/init.d/kodi</pre>
* copy the code under in the file. Modify the variables to suit your configuration:
<pre>#! /bin/sh

### BEGIN INIT INFO
# Provides: kodi
# Required-Start: $all
# Required-Stop: $all
# Default-Start: 2 3 4 5
# Default-Stop: 0 1 6
# Short-Description: starts instance of Kodi
# Description: starts instance of Kodi using start-stop-daemon and xinit
### END INIT INFO

############### EDIT ME ##################

# path to xinit exec
DAEMON=/usr/bin/xinit

# startup args
DAEMON_OPTS=" /usr/local/bin/kodi-standalone -- :0"

# script name
NAME=kodi

# app name
DESC=Kodi

# user
RUN_AS=kodi

# Path of the PID file
PID_FILE=/var/run/kodi.pid

############### END EDIT ME ##################

test -x $DAEMON || exit 0

set -e

case "$1" in
start)
echo "Starting $DESC"
start-stop-daemon --start -c $RUN_AS --background --pidfile $PID_FILE --make-pidfile --exec $DAEMON -- $DAEMON_OPTS
;;
stop)
echo "Stopping $DESC"
start-stop-daemon --stop --pidfile $PID_FILE
;;

restart|force-reload)
echo "Restarting $DESC"
start-stop-daemon --stop --pidfile $PID_FILE
sleep 5
start-stop-daemon --start -c $RUN_AS --background --pidfile $PID_FILE --make-pidfile --exec $DAEMON -- $DAEMON_OPTS
;;
*)
N=/etc/init.d/$NAME
echo "Usage: $N {start|stop|restart|force-reload}" >&2
exit 1
;;
esac

exit 0</pre>
* Test the script by trying to start / stop Kodi with it.
<pre># /etc/init.d/kodi start
........
# /etc/init.d/kodi stop</pre>
* If all is ok, you can add the script to your configuration, by issuing a "update-rc.d"
<pre># update-rc.d kodi defaults</pre>
* If Kodi does not start, you may need to allow X to start from non-consoles. Under Debian/Ubuntu, run:
<pre># dpkg-reconfigure x11-common</pre>
and choose "Anyone".
* You can now reboot the server, Kodi should be started just after the boot sequence.

== Add a new systemd script ==

This method is for systems that use systemd as init system such as current versions of Debian (since version 8, Jessie) and Ubuntu (since version 15.04, Vivid Vervet).

* create a new service file under '''/etc/systemd/system''', call it '''kodi.service''' and copy the following code into the file:
<pre>[Unit]
Description = Kodi Media Center

# if you don't need the MySQL DB backend, this should be sufficient
After = systemd-user-sessions.service network.target sound.target

# if you need the MySQL DB backend, use this block instead of the previous
# After = systemd-user-sessions.service network.target sound.target mysql.service
# Wants = mysql.service

[Service]
User = kodi
Group = kodi
Type = simple
#PAMName = login # you might want to try this one, did not work on all systems
ExecStart = /usr/bin/xinit /usr/bin/dbus-launch --exit-with-session /usr/bin/kodi-standalone -- :0 -nolisten tcp vt7
Restart = on-abort
RestartSec = 5

[Install]
WantedBy = multi-user.target
</pre>

* modify the variables (user, group, paths...) to match your configuration. Save the file.
* try to start (and stop) Kodi to make sure the script is working properly
<pre># systemctl start kodi
........
# systemctl stop kodi</pre>
* If Kodi does not start, you may need to allow X to start from non-consoles. Under Debian/Ubuntu, run:
<pre># dpkg-reconfigure x11-common</pre>
and choose "Anyone".
* As of Ubuntu 16.04 (Xenial Xerus), you need to install and reconfigure the package '''xserver-xorg-legacy''' instead:
<pre># apt-get install xserver-xorg-legacy
........
# dpkg-reconfigure xserver-xorg-legacy</pre>
and choose "Anyone". You'll also need edit the file '''<code>/etc/X11/Xwrapper.config</code>''' and add the following to a new line at the end of the file:
<pre>
needs_root_rights=yes
</pre>
* if you are using a minimalistic system like Ubuntu Server make sure that xinit and dbus-launch are installed
<pre># sudo apt-get install xorg dbus-x11</pre>
* if you do not experience any issues, make Kodi start automatically
<pre># systemctl enable kodi</pre>
* reboot and you're done

== Use autologin feature of lightdm ==

This works if you have a window manager as well.

* Install lightdm
<pre>
sudo apt-get install lightdm
</pre>

* Modify '''/etc/lightdm/lightdm.conf''' and set the following settings under section '''[Seat:*]''':
<pre>
[Seat:*]
autologin-user=kodi
autologin-session=kodi
</pre>
* Reboot and you're done

[[Category:Linux]]
[[Category:How-to]]
[[Category:Manual]]

HOW-TO:Autostart Kodi for Linux

2016-12-18T17:28:14Z

FernetMenta:

{{mininav| [[Linux]] }}
<section begin="intro" />How to automatically start up in Kodi using various Linux distributions.

<big>'''This how-to has flaws: Never Ever start Kodi without a window manager!''' (FernetMenta: the author of X11 windowing system)</big>

The main goal of '''most''' of these methods is to start an Xserver only for Kodi. Most of these methods will '''not work''' if you have a window manager installed (however, it should not be hard to modify the scripts to suit your needs). The lightdm method might work if you need to use a window manager.

Choose '''only one''' method from sections 2 and on based on which distribution and init system you're using.<section end="intro" />

__TOC__
== Create a user to run Kodi ==
For security reasons, it is recommended (but optional) to use a dedicated user to run Kodi. The user needs access to audio and video devices as well as access the internet if you're going to use any features that require internet access. Most methods present here allow to specify which user will start / own the Kodi process.

Notice the groups might vary from one distro to another. The groups used below are for Debian-based distributions. To create the user (named '''kodi''' here) and give it the necessary permissions, run

<pre>
# adduser kodi
</pre>

Another option is to add a loginless and passwordless user. You can do so by running

<pre>
# adduser --disabled-password --disabled-login --gecos "" kodi
</pre>

Then, assign it to the following groups in order to give it the permissions it needs.

<pre>
# usermod -a -G cdrom,audio,video,plugdev,users,dialout,dip,input kodi
</pre>

To give it access to the internet, add the group '''netdev''' as well.

== Upstart init script ==
Works on Ubuntu up to version 14.10 (Utopic Unicorn). Stating with version 15.04 (Vivid Vervet), Ubuntu has switched to systemd and adding a systemd script might be prefereable. Create a '''<code>/etc/init/kodi.conf</code>''' with following contents.
<source lang="xml">
# kodi-upstart
# starts Kodi on startup by using xinit.
# by default runs as kodi, to change edit below.
env USER=kodi

description "Kodi-barebones-upstart-script"
author "Matt Filetto"

start on (filesystem and stopped udevtrigger)
stop on runlevel [016]

# tell upstart to respawn the process if abnormal exit
respawn

script
exec su -c "xinit /usr/bin/kodi-standalone -- -nocursor :0" $USER
end script
</source><br />

{{note|<code> -- -nocursor</code> option '''kills all X cursor''' on Kodi startup and does not interfere with mouse use/operation}}

You may have to edit '''<code>/etc/X11/Xwrapper.config</code>''' and replace the last line that says:

<source lang="xml">
allowed_users=console
</source>

to

<source lang="xml">
allowed_users=anybody
</source><br />

Kodi will now auto-start on boot and restart/respawn if killed or crashed.

== Modify the inittab ==

This was tested on Arch Linux.

To automatically start xbmc on your system, do the following:

First you need to make some changes to <code>/etc/inittab</code>. Comment out (add a #) to this line:

<pre>
id:3:initdefault
</pre>

to

<pre>
#id:3:initdefault
</pre>

and uncomment

<pre>
id:5:initdefault
</pre>

Then add this line to the bottom:

<pre>
x:5:wait:login -f <YOUR_XBMC_USERNAME> </dev/tty7 &>/dev/tty7
</pre>

Using wait instead of respawn means that you can exit out of xbmc into the console.

* NOTE*: This is a security hole as it autologins a dedicated xbmc user without asking for a password!

Now that we have the user logged in we need it to auto start XBMC.
In <code>~/.xinitrc</code> add the following to the end of the file
(after removing/commenting any other exec lines that start a windowmanager):

<pre>
exec ck-launch-session xbmc
</pre>

Add this line to your <code>~/.bash_profile</code>

<pre>
[[ $(tty) = "/dev/tty7" ]] && exec startx </dev/null &>/dev/null
</pre>

And create a hushlogin file to suppress login messages.

<pre>
touch ~/.hushlogin
</pre>

Lastly, for the magic sauce that makes this work, add dbus to your daemons in <code>/etc/rc.conf</code>.

<pre>
DAEMONS=(... dbus ...)
</pre>

You're finished. Next time you reboot you should be greeted with XBMC.

== Add a new init script ==

This method works well under Debian up to version 7 (Wheezy). As of version 8 (Jessie), Debian has switched to systemd and adding a systemd init script might be preferable. The current configuration is a HTPC running Debian Squeeze, with no window manager installed.

* Create a new script under '''/etc/init.d/'''. Call it '''kodi'''
* Change the rights, in order to allow it to be executable.
<pre># chmod a+x /etc/init.d/kodi</pre>
* copy the code under in the file. Modify the variables to suit your configuration:
<pre>#! /bin/sh

### BEGIN INIT INFO
# Provides: kodi
# Required-Start: $all
# Required-Stop: $all
# Default-Start: 2 3 4 5
# Default-Stop: 0 1 6
# Short-Description: starts instance of Kodi
# Description: starts instance of Kodi using start-stop-daemon and xinit
### END INIT INFO

############### EDIT ME ##################

# path to xinit exec
DAEMON=/usr/bin/xinit

# startup args
DAEMON_OPTS=" /usr/local/bin/kodi-standalone -- :0"

# script name
NAME=kodi

# app name
DESC=Kodi

# user
RUN_AS=kodi

# Path of the PID file
PID_FILE=/var/run/kodi.pid

############### END EDIT ME ##################

test -x $DAEMON || exit 0

set -e

case "$1" in
start)
echo "Starting $DESC"
start-stop-daemon --start -c $RUN_AS --background --pidfile $PID_FILE --make-pidfile --exec $DAEMON -- $DAEMON_OPTS
;;
stop)
echo "Stopping $DESC"
start-stop-daemon --stop --pidfile $PID_FILE
;;

restart|force-reload)
echo "Restarting $DESC"
start-stop-daemon --stop --pidfile $PID_FILE
sleep 5
start-stop-daemon --start -c $RUN_AS --background --pidfile $PID_FILE --make-pidfile --exec $DAEMON -- $DAEMON_OPTS
;;
*)
N=/etc/init.d/$NAME
echo "Usage: $N {start|stop|restart|force-reload}" >&2
exit 1
;;
esac

exit 0</pre>
* Test the script by trying to start / stop Kodi with it.
<pre># /etc/init.d/kodi start
........
# /etc/init.d/kodi stop</pre>
* If all is ok, you can add the script to your configuration, by issuing a "update-rc.d"
<pre># update-rc.d kodi defaults</pre>
* If Kodi does not start, you may need to allow X to start from non-consoles. Under Debian/Ubuntu, run:
<pre># dpkg-reconfigure x11-common</pre>
and choose "Anyone".
* You can now reboot the server, Kodi should be started just after the boot sequence.

== Add a new systemd script ==

This method is for systems that use systemd as init system such as current versions of Debian (since version 8, Jessie) and Ubuntu (since version 15.04, Vivid Vervet).

* create a new service file under '''/etc/systemd/system''', call it '''kodi.service''' and copy the following code into the file:
<pre>[Unit]
Description = Kodi Media Center

# if you don't need the MySQL DB backend, this should be sufficient
After = systemd-user-sessions.service network.target sound.target

# if you need the MySQL DB backend, use this block instead of the previous
# After = systemd-user-sessions.service network.target sound.target mysql.service
# Wants = mysql.service

[Service]
User = kodi
Group = kodi
Type = simple
#PAMName = login # you might want to try this one, did not work on all systems
ExecStart = /usr/bin/xinit /usr/bin/dbus-launch --exit-with-session /usr/bin/kodi-standalone -- :0 -nolisten tcp vt7
Restart = on-abort
RestartSec = 5

[Install]
WantedBy = multi-user.target
</pre>

* modify the variables (user, group, paths...) to match your configuration. Save the file.
* try to start (and stop) Kodi to make sure the script is working properly
<pre># systemctl start kodi
........
# systemctl stop kodi</pre>
* If Kodi does not start, you may need to allow X to start from non-consoles. Under Debian/Ubuntu, run:
<pre># dpkg-reconfigure x11-common</pre>
and choose "Anyone".
* As of Ubuntu 16.04 (Xenial Xerus), you need to install and reconfigure the package '''xserver-xorg-legacy''' instead:
<pre># apt-get install xserver-xorg-legacy
........
# dpkg-reconfigure xserver-xorg-legacy</pre>
and choose "Anyone". You'll also need edit the file '''<code>/etc/X11/Xwrapper.config</code>''' and add the following to a new line at the end of the file:
<pre>
needs_root_rights=yes
</pre>
* if you are using a minimalistic system like Ubuntu Server make sure that xinit and dbus-launch are installed
<pre># sudo apt-get install xorg dbus-x11</pre>
* if you do not experience any issues, make Kodi start automatically
<pre># systemctl enable kodi</pre>
* reboot and you're done

== Use autologin feature of lightdm ==

This works if you have a window manager as well.

* Install lightdm
<pre>
sudo apt-get install lightdm
</pre>

* Modify '''/etc/lightdm/lightdm.conf''' and set the following settings under section '''[Seat:*]''':
<pre>
[Seat:*]
autologin-user=kodi
autologin-session=kodi
</pre>
* Reboot and you're done

[[Category:Linux]]
[[Category:How-to]]
[[Category:Manual]]

Archive:Codecinfo

2015-06-05T11:15:41Z

FernetMenta: /* Breakdown */

{{mininav|[[Video library]]|[[Video playback|Playback]]}}
<section begin="intro" />Whilst Kodi is playing media on screen you can activate the '''codecinfo''' overlay {{keypress|o}} key on a keyboard. This normally appears as white text on a black background bar located near the top of the screen (dependent on the skin being used). The codecinfo overlay displays a number of real time variables describing detailed information on the codecs currently in use.<section end="intro" />

{{note|The codecinfo screen is not entirely accurate for some of the reported data, due to the fact that the codecinfo screen itself will reduce performance on low powered devices (i.e., Raspberry Pi, some Android/ARM boxes). }}

{{-}}
== Current stable builds ==
[[File:Helix codecinfo.png|700px|Helix|right]]
;Video codecinfo window as seen in stable Kodi v14.x and newer builds.

Information is split into 6 lines of text:
* Audio information - '''D'''emuxer
* Audio information - '''P'''layer
* Video information - '''D'''emuxer
* Video information - '''P'''layer
* General playback information '''C'''
* '''W'''indowing and System CPU information
{{-}}

=== Breakdown ===
Samples from the screen(s) above:
{| class="prettytable"
! Audio information
! Breakdown
|-
| aac || Audio codec
|-
| mp4a / 0x6134706D || Codec ID - Format profile <ref>http://matroska.org/technical/specs/index.html#CodecID</ref>
|-
| 48000 Hz || Sampling rate
|-
| 5.1 || Audio channels
|-
| s16 || Sample size (s16 = signed 16-bit value)
|-
| fltp || float, planar
|-
| 437 kb/s || Average audio bitrate (reported by demuxer)
|-
| aq:99% || Audio queue saturation
|-
| Kb/s:437.41 || Current audio bitrate (reported by player)
|-
| att:0.0db || Attenuation / gain added by player
|-
! style="background: #DBDBDB;" | '''Video information'''
! style="background: #DBDBDB;" | '''Breakdown'''
|-
| h264 (Main) (avc1 / 0x31637661) || Video codec
|-
| yuv420p || Color space / Chroma subsampling
|-
| 1920x1080 || Resolution
|-
| SAR 1:1 DAR 16x9 || '''S'''ource '''A'''spect '''R'''atio - '''D'''isplay '''A'''spect '''R'''atio
|-
| 9282 kb/s || Average audio bitrate (reported by demuxer)
|-
| fr:24.000 || Source framerate
|-
| vq:88% || Video queue saturation
|-
| dc:ff-h264-dxva2 || Video library performing decode
|-
| Mb/s:7.79 || Current video bitrate (reported by player)
|-
| drop:12 || Number of dropped frames
|-
| skip:13 || Number of skipped frames
|-
| pc:1 || Pullup correction pattern length
|-
! style="background: #DBDBDB;" | '''General playback information'''
! style="background: #DBDBDB;" | '''Breakdown'''
|-
| ad:0.000 || Audio delay (configured)
|-
| a/v:0.030 || Audio/video sync difference (real time)
|-
| edl:- || [[Edit decision list]]
|-
| dcpu: 0% || Relative CPU Usage of the player thread
|-
| acpu: 0% || Relative CPU usage of the audio decode thread
|-
| vcpu: 0% || Relative CPU Usage of the video decode thread
|-
| cache:0 B 100% || Size of cached data and % of cache utilized
|-
! style="background: #DBDBDB;" | '''Windowing information'''
! style="background: #DBDBDB;" | '''Breakdown'''
|-
| fps:24.00 || For the user some meaningless value.

{{Note|'''NOT FPS AT ALL!!!.'''}}

This is most likely of no value to the user. I wanted to remove it but there was protest by people not knowing what this is about. Actually this has been a cycle counter of the application's main loop which in many cases was almost equal to video FPS. After introduction of dirty regions some while ago this started more and more not to be the value it pretends to be.
If you are not interested in fading control of labels or scrolling text, this is not of any interest to you.

If you want to check if your video playback is working as it should, watch the skip and drop values. If those stay low, nothing to worry about. Increasing skip value means, that video frames cannot be rendered in time. If you even see dropping, then it's our last resort, as the system seems to be too slow to play that video and we told the decoder to throw away complete frames.
|-
| CPU 4 core(s) || System processor information (this display is OS-dependent)
|-
| average: 4.7% || Average CPU load across all cores
|-
! style="background: #DBDBDB;" | '''Sync to screen information'''
! style="background: #DBDBDB;" | '''Breakdown'''
|-
| refresh || Actual refresh-rate being displayed
|-
| missed || Number of missed frames
|-
| speed || Audio speed correction to sync
|-
| sync || Video speed to enable sync
|-
| avg || Avg amount of correction
|-
| error || Percentage of errors syncing
|}

== References ==
<references/>

== Further information/discussion ==
* See the [[forum:70743|Video Diagnostic Screen]] forum topic for discussion and more information.

{{isengard updated}}

[[Category:Manual]]
[[Category:Troubleshooting]]
[[Category:Video library]]

Archive:Codecinfo

2015-06-05T11:14:49Z

FernetMenta: /* Breakdown */

{{mininav|[[Video library]]|[[Video playback|Playback]]}}
<section begin="intro" />Whilst Kodi is playing media on screen you can activate the '''codecinfo''' overlay {{keypress|o}} key on a keyboard. This normally appears as white text on a black background bar located near the top of the screen (dependent on the skin being used). The codecinfo overlay displays a number of real time variables describing detailed information on the codecs currently in use.<section end="intro" />

{{note|The codecinfo screen is not entirely accurate for some of the reported data, due to the fact that the codecinfo screen itself will reduce performance on low powered devices (i.e., Raspberry Pi, some Android/ARM boxes). }}

{{-}}
== Current stable builds ==
[[File:Helix codecinfo.png|700px|Helix|right]]
;Video codecinfo window as seen in stable Kodi v14.x and newer builds.

Information is split into 6 lines of text:
* Audio information - '''D'''emuxer
* Audio information - '''P'''layer
* Video information - '''D'''emuxer
* Video information - '''P'''layer
* General playback information '''C'''
* '''W'''indowing and System CPU information
{{-}}

=== Breakdown ===
Samples from the screen(s) above:
{| class="prettytable"
! Audio information
! Breakdown
|-
| aac || Audio codec
|-
| mp4a / 0x6134706D || Codec ID - Format profile <ref>http://matroska.org/technical/specs/index.html#CodecID</ref>
|-
| 48000 Hz || Sampling rate
|-
| 5.1 || Audio channels
|-
| s16 || Sample size (s16 = signed 16-bit value)
|-
| fltp || float, planar
|-
| 437 kb/s || Average audio bitrate (reported by demuxer)
|-
| aq:99% || Audio queue saturation
|-
| Kb/s:437.41 || Current audio bitrate (reported by player)
|-
| att:0.0db || Attenuation / gain added by player
|-
! style="background: #DBDBDB;" | '''Video information'''
! style="background: #DBDBDB;" | '''Breakdown'''
|-
| h264 (Main) (avc1 / 0x31637661) || Video codec
|-
| yuv420p || Color space / Chroma subsampling
|-
| 1920x1080 || Resolution
|-
| SAR 1:1 DAR 16x9 || '''S'''ource '''A'''spect '''R'''atio - '''D'''isplay '''A'''spect '''R'''atio
|-
| 9282 kb/s || Average audio bitrate (reported by demuxer)
|-
| fr:24.000 || Source framerate
|-
| vq:88% || Video queue saturation
|-
| dc:ff-h264-dxva2 || Video library performing decode
|-
| Mb/s:7.79 || Current video bitrate (reported by player)
|-
| drop:12 || Number of dropped frames
|-
| skip:13 || Number of skipped frames
|-
| pc:1 || Pullup correction pattern length
|-
! style="background: #DBDBDB;" | '''General playback information'''
! style="background: #DBDBDB;" | '''Breakdown'''
|-
| ad:0.000 || Audio delay (configured)
|-
| a/v:0.030 || Audio/video sync difference (real time)
|-
| edl:- || [[Edit decision list]]
|-
| dcpu: 0% || Relative CPU Usage of the player thread
|-
| acpu: 0% || Relative CPU usage of the audio decode thread
|-
| vcpu: 0% || Relative CPU Usage of the video decode thread
|-
| cache:0 B 100% || Size of cached data and % of cache utilized
|-
! style="background: #DBDBDB;" | '''Windowing information'''
! style="background: #DBDBDB;" | '''Breakdown'''
|-
| fps:24.00 || How many frames per second the user interface is rendering.

{{Note|'''NOT FPS AT ALL!!!.'''}}

This is most likely of no value to the user. I wanted to remove it but there was protest by people not knowing what this is about. Actually this has been a cycle counter of the application's main loop which in many cases was almost equal to video FPS. After introduction of dirty regions some while ago this started more and more not to be the value it pretends to be.
If you are not interested in fading control of labels or scrolling text, this is not of any interest to you.

If you want to check if your video playback is working as it should, watch the skip and drop values. If those stay low, nothing to worry about. Increasing skip value means, that video frames cannot be rendered in time. If you even see dropping, then it's our last resort, as the system seems to be too slow to play that video and we told the decoder to throw away complete frames.
|-
| CPU 4 core(s) || System processor information (this display is OS-dependent)
|-
| average: 4.7% || Average CPU load across all cores
|-
! style="background: #DBDBDB;" | '''Sync to screen information'''
! style="background: #DBDBDB;" | '''Breakdown'''
|-
| refresh || Actual refresh-rate being displayed
|-
| missed || Number of missed frames
|-
| speed || Audio speed correction to sync
|-
| sync || Video speed to enable sync
|-
| avg || Avg amount of correction
|-
| error || Percentage of errors syncing
|}

== References ==
<references/>

== Further information/discussion ==
* See the [[forum:70743|Video Diagnostic Screen]] forum topic for discussion and more information.

{{isengard updated}}

[[Category:Manual]]
[[Category:Troubleshooting]]
[[Category:Video library]]

PVR recording software

2014-03-18T11:20:00Z

FernetMenta: /* Linux */

{{:PVR/Contents}}
{{TOCleft}}
[[File:Digital broadcast standards.png|400px|thumb|center|This map will give you a basic idea of what to look for if you are unsure what format/standard your TV signal is in.]]
{{-}}
== I want to run my PVR backend server on... ==
You can run the PVR backend server on one of your existing XBMC installs, or on its own.

Using the tables below, click on the backend software which best fits your needs.

=== Linux ===

{{backend table header}}
<section begin="Tvheadend"/>
{{backend table
| Name= Tvheadend
| Page_Link= PVR/Backend/Tvheadend
| DVB=yes
| ATSC_QAM=yes
| ISDB=
| DTMB=
| CableCard= {{yes}}<ref name="HDHomerun">Via HDHomerun Prime as the tuner</ref>
| IPTV=yes
| Radio=yes
| TimeShift={{yes}}<ref name="Tvheadend timeshift">Only pause/resume are supported in Frodo.</ref>
}}<section end="Tvheadend"/>
<section begin="VDR"/>
{{backend table
| Name=VDR
| Page_Link=PVR/Backend/VDR
| DVB={{yes}}
| ATSC_QAM={{yes}}
| ISDB=
| DTMB=
| CableCard={{yes}}
| IPTV=yes
| Radio=yes
| TimeShift={{yes}}<ref name="VDR timeshift">VNSI supports full time shift. XVDR "[https://github.com/pipelka/vdr-plugin-xvdr XVDR Plugin for VDR]" does.</ref>
}}<section end="VDR"/>
<section begin="MythTV"/>
{{backend table
| Name=MythTV
| Page_Link=PVR/Backend/MythTV
| DVB={{yes}}
| ATSC_QAM={{yes}}
| ISDB={{no}}
| DTMB={{no}}
| CableCard= {{yes}}<ref name="three cableCARDs">Via Silicondust HDHomeRun Prime, the Hauppauge WinTV DCR-2650, or the Ceton InfiniTV 4.</ref>
| IPTV={{yes}}
| Radio={{yes}}
| TimeShift={{yes}}
}}<section end="MythTV"/>
|}<br />

=== Mac OS X ===
{{backend table header}}
{{#lst:PVR/Backend|MythTV}}
|}

=== Windows ===
{{backend table header}}
{{backend table
| Name=ARGUS TV
| Page_Link=PVR/Backend/ARGUS-TV
| DVB={{yes}}
| ATSC_QAM={{yes}}
| ISDB=
| DTMB=
| CableCard=
| IPTV=
| Radio={{yes}}
| TimeShift={{yes}}
}}
{{backend table
| Name=DVBLink
| Page_Link=PVR/Backend/DVBLink
| DVB={{yes}}
| ATSC_QAM=
| ISDB=
| DTMB=
| CableCard=
| IPTV=
| Radio=
| TimeShift=
}}
{{backend table
| Name=DVBViewer
| Page_Link=PVR/Backend/DVBViewer
| DVB={{yes}}
| ATSC_QAM=
| ISDB=
| DTMB=
| CableCard=
| IPTV=
| Radio=
| TimeShift=
}}
{{backend table
| Name=NextPVR
| Page_Link=PVR/Backend/NextPVR
| DVB={{yes}}
| ATSC_QAM={{yes}}
| ISDB=
| DTMB={{yes}}
| CableCard= {{yes}}<ref name="three cableCARDs" />
| IPTV={{yes}}
| Radio={{yes}}
| TimeShift={{yes}}
}}
{{backend table
| Name=MediaPortal
| Page_Link=PVR/Backend/MediaPortal
| DVB={{yes}}
| ATSC_QAM={{yes}}
| ISDB=
| DTMB=
| CableCard=
| IPTV={{yes}}
| Radio={{yes}}
| TimeShift={{yes}}
}}
{{backend table
| Name=ServerWMC
| Page_Link=PVR/Backend/ServerWMC
| DVB={{yes}}
| ATSC_QAM={{yes}}
| ISDB=
| DTMB=
| CableCard={{yes}}
| IPTV=
| Radio=
| TimeShift={{yes}}
}}
|}<br />

=== Raspberry Pi ===
The Raspberry Pi is technically just an embedded linux platform, but it's low price and features make it perfect for a PVR backend. In addition to this, since a lot of people will hopefully be using R-Pi's as backends, it will make it easier to streamline setup guides and provide help due to most of the hardware being the same for everyone.

Like every backend, the server needs to receive the live signal from a receiver. A typical DVB USB stick will do, but be aware that such a stick takes its power supply via the USB interface. It might be required to put a USB hub with independent power supply between the R-Pi and the DVB stick. Make sure that the DVB stick works with the linux OS on the R-Pi. Information can be found at http://linuxtv.org, including firmware downloads for many sticks. Alternatively, you may want to check the directory /lib/firmware on the R-Pi to list the firmware already installed.

/var/log/dmesg and .xbmc/temp/xbmc.log are files to check if the TV signal is not available.

{{note|Using the Raspberry Pi as a frontend (to view Live TV) isn't working so well. It's best to just use it for backend stuff for now until certain issues are fixed.}}
{{backend table header}}
{{#lst:PVR/Backend|Tvheadend}}
{{#lst:PVR/Backend|VDR}}
|}<br />

=== Other ===
{{backend table header}}
{{backend table
| Name=VuPlus Client for Enigma2 based set-top boxes (Vu+ and Dreambox)
| Page_Link=PVR/Backend/VUPlus
| DVB={{yes}}
| ATSC_QAM=
| ISDB=
| DTMB=
| CableCard=
| IPTV=
| Radio={{yes}}
| TimeShift=
}}
{{backend table
| Name=DVBLink for Synology NAS
| Page_Link=PVR/Backend/DVBLink
| DVB={{yes}}
| ATSC_QAM=
| ISDB=
| DTMB=
| CableCard=
| IPTV=
| Radio=
| TimeShift=
}}
{{backend table
| Name=IPTV Simple Client
| Page_Link=Add-on:IPTV Simple Client
| DVB=
| ATSC_QAM=
| ISDB=
| DTMB=
| CableCard=
| IPTV=
| Radio=
| TimeShift=
}}
{{#lst:PVR/Backend|Tvheadend}}
{{backend table
| Name= Njoy N7
| Page_Link= PVR/Backend/Njoy
| DVB={{yes}}
| ATSC_QAM=
| ISDB=
| DTMB=
| CableCard=
| IPTV={{yes}}
| Radio=
| TimeShift=
}}
|}

== Notes ==
TVHeadend under Linux does not fully support the HD Homerun Prime Cable Card implementation.
<references/>

{{Frodo updated}}