eessppeelllloo/veejay
1
0
Fork 0
mirror of https://github.com/game-stop/veejay.git synced 2025-12-05 15:30:02 +01:00
Code Issues Packages Projects Releases Wiki Activity

Improve help (#76 wip) : Memory concern (HowtoCache + README.memory)

Browse Source 
* README.memory --> README.memory.md
* Adpat content from HowtoCache into README.memory
* Remove HowtoCache
This commit is contained in:
Jerome Blanchi aka d.j.a.y
2019-02-11 23:38:04 +01:00
parent 92674200c0
commit 6e88c07412
4 changed files with 51 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
veejay-current/veejay-server/doc/HowtoCache.txt
View File

@@ -1,12 +0,0 @@
# Frame cache
Since version 0.9.3 veejay features a caching mechanism to load frames from disk into the system's memory. The cache size is limited to the amount of RAM available in your machine. If the cache is full, Veejay must decide which frames to discard. Veejay will discard the frame furthest away from the current position.
You can configure the cache with two commandline options:
<pre>
-m / --memory [percentage of available RAM to use]
-j / --max_chain [maximum number of samples to cache]
</pre>
The second option, '-j' is used to divide up the cache memory into a number of equal sized chunks. Veejay will cache by default up to 8 samples into your system's main memory, if you specified the -m option.

3
veejay-current/veejay-server/doc/README.md
View File

@@ -1,5 +1,4 @@
* [COPYING](./COPYING)
* [HowtoCache.txt](./HowtoCache.txt)
* [HowtoCompile.txt](./HowtoCompile.txt)
* [HowToDebugging.txt](./HowToDebugging.txt)
* [HowtoPlugins.txt](./HowtoPlugins.txt)
@@ -12,7 +11,7 @@
* [README.alpha](./README.alpha)
* [README.android](./README.android)
* [README.audio](./README.audio)
* [README.memory](./README.memory)
* Memory concern with veejay - [README.memory](./README.memory.md)
* [README.performance](./README.performance)
* [README.quickstart](./README.quickstart)
* [README.video_formats.txt](./README.video_formats.txt)

18
veejay-current/veejay-server/doc/README.memory
View File

@@ -1,18 +0,0 @@
STATIC FX CHAIN
Veejay pre-allocates a large buffer (aprox. 180 MB for 1280x720 video) to cache the entire fx_chain.
If you wish to turn off this option, you can use the -X or --dynamic-fx-chain commandline parameters.
When dynamic allocation is enabled, each chain entry is allocated and freed on the fly between switching samples.
Individual FX are always allocated and freed between switching samples.
MEMORY CACHE
Veejay can (optionally) use your RAM to cache video frames from file to memory. By default this option is turned off.
you can enable it by specifying both the -m and -l commandline parameters. They both expect arguments.
Enter a percentage of your total phsyical RAM memory to use for -m and divide it equally over -l slots.
These options will allow you to commit the frames from the sample's EDL to memory while playing, so that subsequent loops no longer require disk-access.
This option should help you increase the audio playback quality when using the FX chain (reducing or elminating stutter)

50
veejay-current/veejay-server/doc/README.memory.md Normal file
View File

@@ -0,0 +1,50 @@
Memory concern with veejay
===============
Dynamic or Static FX chain
-----
Veejay pre-allocates a large buffer (aprox. 180 MB for 1280x720 video) to cache
the entire fx_chain.
If you wish to turn off this option, you can use the `-M` or `--dynamic-fx-chain`
commandline parameters.
When dynamic allocation is enabled, each chain entry is allocated and freed on
the fly between switching samples.
Individual FX are always allocated and freed between switching samples.
```
-M / --dynamic-fx-chain Do not keep FX chain buffers in RAM (default off)
```
Caching video frames
--------
Veejay can (optionally) use your RAM to cache video frames from file to memory.
By default this option is turned off.
You can enable it by specifying both the `-m` and `-l` commandline parameters.
They both expect arguments.
Enter a percentage of your total physical RAM memory to use for `-m` and divide
it equally over `-j` samples.
These options will allow you to commit the frames from the sample's EDL to
memory while playing, so that subsequent loops no longer require disk-access.
This option should help you increase the audio playback quality when using the
FX chain (reducing or elminating stutter)
The cache size is limited to the amount of RAM available in your machine. If the
cache is full, Veejay must decide which frames to discard. Veejay will discard
the frame furthest away from the current position.
You can configure the cache with two commandline options:
```
-m / --memory <num> Maximum memory to use for cache (0=disable, default=0 max=100)
-j / --max_cache <num> Divide cache memory over N samples (default=0)
```
The second option, `-j` is used to divide up the cache memory into a number of
equal sized chunks. Veejay will cache by default up to 8 samples into your
system's main memory, if you specified the `-m` option.