HOW-TO:Modify the video cache: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
m (sen -> seen)
Line 16: Line 16:
If you don't already have an [[advancedsettings.xml]] file, it's very simple to make. XBMC uses this file for advanced settings and features that normal users shouldn't modify without first knowing what they do, as well as for experimental features, etc.
If you don't already have an [[advancedsettings.xml]] file, it's very simple to make. XBMC uses this file for advanced settings and features that normal users shouldn't modify without first knowing what they do, as well as for experimental features, etc.


# Since you can use all or just some of the following settings, let's start out with the basic file. Create a '''plain text file''' (no rich text formatting, don't use .doc, etc) and save it as '''advancedsettings.xml'''. Make sure that the file extension is ".xml" and '''not''' ".txt" or ".xml.txt".
:: Since you can use all or just some of the following settings, let's start out with the basic file.
# Cut and paste this into your new plain text file:
 
#:<syntaxhighlight lang="xml" enclose="div">
{{how-to
|Step1=
Create a '''plain text file''' (no rich text formatting, don't use .doc, etc) and save it as '''advancedsettings.xml'''. Make sure that the file extension is ".xml" and '''not''' ".txt" or ".xml.txt".
 
|Step2=
Cut and paste this into your new plain text file:
:<syntaxhighlight lang="xml" enclose="div">
<advancedsettings>
<advancedsettings>
   <network>
   <network>
Line 25: Line 31:
</advancedsettings>
</advancedsettings>
</syntaxhighlight>
</syntaxhighlight>
# Add some or all of the settings tags from the [[#Cache settings|next section]].
 
# Save this file in your [[userdata folder]]:
|Step3=
#:''If you have an existing file, make sure the <network></network> tags, and settings we'll add between them, are between the main <advancedsettings></advancedsettings> tags.''
Add some or all of the settings tags from the [[#Cache settings|next section]].
 
Save this file in your [[userdata folder]]:
 
:''If you have an existing file, make sure the '''<network></network>''' tags, and settings we'll add between them, are between the main '''<advancedsettings></advancedsettings>''' tags.''
::{{#lst:userdata|location all}}
::{{#lst:userdata|location all}}
}}


==Cache settings==
==Cache settings==

Revision as of 18:54, 26 January 2014

Template:Gotham


This page describes three advancedsettings.xml settings that can be used to maximize the video playback cache. You can use all or just a couple of these settings to see significant improvements in cache performance, should you require it (most users will not require these modifications). This can help with intermittent network issues, reduce how long the network is tied up, and/or improve battery life [1].


Note: Even if you change the cache settings in XBMC, that won't change how fast the video file data comes in over the network: It won't make a slow server load the video any faster, etc.


Note: XBMC v12 only: Since v12 (Frodo) does not have the <buffermode> option, the video cache affects only media over HTTP and FTP protocol , which are seen as internet sources, even if you are using them locally. SMB, NFS, and AFP are not cached in v12 Frodo.


How-to modify the cache

If you don't already have an advancedsettings.xml file, it's very simple to make. XBMC uses this file for advanced settings and features that normal users shouldn't modify without first knowing what they do, as well as for experimental features, etc.

Since you can use all or just some of the following settings, let's start out with the basic file.
1 Create a plain text file (no rich text formatting, don't use .doc, etc) and save it as advancedsettings.xml. Make sure that the file extension is ".xml" and not ".txt" or ".xml.txt".
2 Cut and paste this into your new plain text file:
<advancedsettings>
  <network>
    <!--- The three settings will go in this space, between the two network tags. --->
  </network>
</advancedsettings>
3 Add some or all of the settings tags from the next section.

Save this file in your userdata folder:

If you have an existing file, make sure the <network></network> tags, and settings we'll add between them, are between the main <advancedsettings></advancedsettings> tags.

The Userdata folder is a subfolder of the Kodi Data Folder and is located as shown in the table below.

Operating system Userdata Folder
Android Android/data/org.xbmc.kodi/files/.kodi/userdata/ (see note)
iOS /private/var/mobile/Library/Preferences/Kodi/userdata/
LibreELEC /storage/.kodi/userdata/
Linux ~/.kodi/userdata/
macOS /Users/<your_user_name>/Library/Application Support/Kodi/userdata/
Nvidia Shield (SMB) smb://<nvidiashieldurl>/internal/Android/data/org.xbmc.kodi/files/.kodi/userdata
OSMC /home/osmc/.kodi/userdata/
tvOS /private/var/mobile/Library/Preferences/Kodi/userdata/
Windows %APPDATA%\Kodi\userdata
Windows Portable <Install location chosen by you>\portable_data\userdata\
Windows via Microsoft Store %LOCALAPPDATA%\Packages\XBMCFoundation.Kodi_4n2hpmxwrvr6p\LocalCache\Roaming\Kodi\
Windows Xbox %LOCALAPPDATA%\Packages\XBMCFoundation.Kodi_4n2hpmxwrvr6p\LocalCache\Roaming\Kodi\
Note: In some Android setups the path may be slightly different to the one stated above.


Cache settings

advancedsettings.xml tag what it does
<buffermode>1</buffermode>
Requires XBMC v13alpha10 or higher
Choose what to buffer

This setting will force XBMC to use a cache for all video files, including local network, internet, and even the local hard drive. Default value is 0 and will only cache videos that use internet file paths/sources.

0 Buffer all internet filesystems (like "2" but additionally also ftp, webdav, etc.) (default)
1 Buffer all filesystems (including local)
2 Only buffer true internet filesystems (streams) (http, etc.)
3 No buffer
<cachemembuffersize>0</cachemembuffersize>
Requires XBMC v12.0 or higher
Increasing the cache

Here we can do two things:

  • Value: 5242880 - keep the cache in RAM, but increase how much RAM is used. The number is the buffer size in bytes (5242880 is the default, which is about 5MB, which requires 15MB of free RAM). XBMC will not buffer ahead more than this. Note: For the memory size set here, XBMC will require 3x the amount of RAM to be free. Setting this too high might cause XBMC to crash if it can't get enough RAM.

or

  • Value: 0 - we can use the local disk memory (typically your hard drive), which will not put any limit on the size (outside of the size of your drive). This also allows devices with low RAM, such as the Raspberry Pi, to cache more than they normally would due to the small amount of RAM they have. The cache is deleted from the local disk whenever playback is stopped. Note: This will likely cause increased wear-and-tear on your drive.
<readbufferfactor>4.0</readbufferfactor>
Requires XBMC v13alpha7 or higher
Increase the fill-rate of the cache

By default (value: 1), XBMC will only fill the cache a little above what is needed to play it back. It does this as to not max out your network and possibly max out some hardware. For most users and hardware, this setting shouldn't cause any issues, but be aware of it if you have unusual CPU spikes in your HTPC.


The value of this setting is a multiplier of the default limit. If XBMC is loading a typical bluray raw file at 36 Mbit/s, then a value of 2 will need at least 72 Mbit/s of network bandwidth. However, unlike with the RAM setting, you can safely increase this value however high you want, and XBMC won't crash. Just know that it might cause XBMC to attempt to use all available bandwidth on your HTPC during playback.

Examples

Example 1

All three options enabled, using local hard drive for cache.

advancedsettings.xml
<advancedsettings>
  <network>
    <buffermode>1</buffermode>
    <cachemembuffersize>0</cachemembuffersize>
    <readbufferfactor>4.0</readbufferfactor>
  </network>
</advancedsettings>

Example 2

Only cache size changed, using 100MB of RAM for cache (which requires 300MB of free RAM).

advancedsettings.xml
<advancedsettings>
  <network>
    <cachemembuffersize>104857600</cachemembuffersize>
  </network>
</advancedsettings>

Example 3

Two options enabled, using 50MB of RAM for cache (which requires 150MB of free RAM), and cache both internet, LAN, and local content.

advancedsettings.xml
<advancedsettings>
  <network>
    <buffermode>1</buffermode>
    <cachemembuffersize>52428800</cachemembuffersize>
  </network>
</advancedsettings>

Notes

  1. Certain devices (laptops, tablets, etc) that use sustained slow/medium-wifi usage, over the length of the video, will use more power than using fast-wifi usage for a shorter time. In other words, slowly loading a video file that is 30 minutes long, over a period of 30 minutes, can actually take more power than loading a 30 minute video in 5 minutes, even though more wifi speed/power is used during that 5 minutes.