Skip to content

Commit

Permalink
Documentation: updates
Browse files Browse the repository at this point in the history
  • Loading branch information
@devernay
devernay committed Jan 18, 2017
1 parent 792e626 commit 44b5f04
Show file tree
Hide file tree
Showing 2 changed files with 56 additions and 13 deletions.
64 changes: 53 additions & 11 deletions Documentation/source/_prefs.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,13 @@ When checked, Natron will check for new updates on start-up of the application.

**Enable crash reporting**

When checked, if Natron crashes a window will pop-up asking you whether you want to upload the crash dump to the developers or not. This can help them track down the bug. If you need to turn the crash reporting system off, uncheck this. Note that when using the application in command-line mode, if crash reports are enabled, they will be automatically uploaded. Changing this requires a restart of the application to take effect.
When checked, if Natron crashes a window will pop-up asking you whether you want to upload the crash dump to the developers or not. This can help them track down the bug.

If you need to turn the crash reporting system off, uncheck this.

Note that when using the application in command-line mode, if crash reports are enabled, they will be automatically uploaded.

Changing this requires a restart of the application to take effect.

**Test Crash Reporting**

Expand All @@ -33,15 +39,21 @@ Threading

**Number of render threads (0="guess")**

Controls how many threads Natron should use to render. -1: Disable multithreading totally (useful for debugging) 0: Guess the thread count from the number of cores.
Controls how many threads Natron should use to render.

-1: Disable multithreading totally (useful for debugging)

0: Guess the thread count from the number of cores.

**Number of parallel renders (0="guess")**

Controls the number of parallel frame that will be rendered at the same time by the renderer.A value of 0 indicate that Natron should automatically determine the best number of parallel renders to launch given your CPU activity. Setting a value different than 0 should be done only if you know what you're doing and can lead in some situations to worse performances. Overall to get the best performances you should have your CPU at 100% activity without idle times.

**Effects use the thread-pool**

When checked, all effects will use a global thread-pool to do their processing instead of launching their own threads. This suppresses the overhead created by the operating system creating new threads on demand for each rendering of a special effect. As a result of this, the rendering might be faster on systems with a lot of cores (>= 8). WARNING: This is known not to work when using The Foundry's Furnace plug-ins (and potentially some other plug-ins that the dev team hasn't not tested against it). When using these plug-ins, make sure to uncheck this option first otherwise it will crash Natron.
When checked, all effects will use a global thread-pool to do their processing instead of launching their own threads. This suppresses the overhead created by the operating system creating new threads on demand for each rendering of a special effect. As a result of this, the rendering might be faster on systems with a lot of cores (>= 8).

WARNING: This is known not to work when using The Foundry's Furnace plug-ins (and potentially some other plug-ins that the dev team hasn't not tested against it). When using these plug-ins, make sure to uncheck this option first otherwise it will crash Natron.

**Max threads usable per effect (0="guess")**

Expand Down Expand Up @@ -148,7 +160,9 @@ This property holds the maximum number of settings panels that can be held by th

**Value increments based on cursor position**

When enabled, incrementing the value fields of parameters with the mouse wheel or with arrow keys will increment the digits on the right of the cursor. When disabled, the value fields are incremented given what the plug-in decided it should be. You can alter this increment by holding Shift (x10) or Control (/10) while incrementing.
When enabled, incrementing the value fields of parameters with the mouse wheel or with arrow keys will increment the digits on the right of the cursor.

When disabled, the value fields are incremented given what the plug-in decided it should be. You can alter this increment by holding Shift (x10) or Control (/10) while incrementing.

**Default layout file**

Expand Down Expand Up @@ -178,7 +192,9 @@ Caching

**Aggressive caching**

When checked, Natron will cache the output of all images rendered by all nodes, regardless of their "Force caching" parameter. When enabling this option you need to have at least 8GiB of RAM, and 16GiB is recommended. If not checked, Natron will only cache the nodes which have multiple outputs, or their parameter "Force caching" checked or if one of its output has its settings panel opened.
When checked, Natron will cache the output of all images rendered by all nodes, regardless of their "Force caching" parameter. When enabling this option you need to have at least 8GiB of RAM, and 16GiB is recommended.

If not checked, Natron will only cache the nodes which have multiple outputs, or their parameter "Force caching" checked or if one of its output has its settings panel opened.

**Maximum amount of RAM memory used for caching (% of total RAM)**

Expand All @@ -198,7 +214,11 @@ The maximum size that may be used by the DiskCache node on disk (in GiB)

**Disk cache path (empty = default)**

WARNING: Changing this parameter requires a restart of the application. This is points to the location where Natron on-disk caches will be. This variable should point to your fastest disk. If the parameter is left empty or the location set is invalid, the default location will be used. The default location is: /Users/devernay/Library/Caches/INRIA/Natron
WARNING: Changing this parameter requires a restart of the application.

This is points to the location where Natron on-disk caches will be. This variable should point to your fastest disk. If the parameter is left empty or the location set is invalid, the default location will be used. The default location is:

/Users/devernay/Library/Caches/INRIA/Natron

**Wipe Disk Cache**

Expand Down Expand Up @@ -241,7 +261,9 @@ Controls the maximum amount of nodes that can have their interface showing up at

**Use number keys for the viewer**

When enabled, the row of number keys on the keyboard is used for switching input ( connects input to A side, connects input to B side), even if the corresponding character in the current keyboard layout is not a number. This may have to be disabled when using a remote display connection to Linux from a different OS.
When enabled, the row of number keys on the keyboard is used for switching input (<key> connects input to A side, <shift-key> connects input to B side), even if the corresponding character in the current keyboard layout is not a number.

This may have to be disabled when using a remote display connection to Linux from a different OS.

Nodegraph
---------
Expand All @@ -260,7 +282,9 @@ When moving nodes on the node graph, snap to positions where they are lined up w

**Maximum undo/redo for the node graph**

Set the maximum of events related to the node graph Natron remembers. Past this limit, older events will be deleted forever, allowing to re-use the RAM for other purposes. Changing this value will clear the undo/redo stack.
Set the maximum of events related to the node graph Natron remembers. Past this limit, older events will be deleted forever, allowing to re-use the RAM for other purposes.

Changing this value will clear the undo/redo stack.

**Disconnected arrow length**

Expand All @@ -279,7 +303,9 @@ Plug-ins

**Use bundled plug-ins**

When checked, Natron also uses the plug-ins bundled with the binary distribution. When unchecked, only system-wide plug-ins found in are loaded (more information can be found in the help for the "Extra plug-ins search paths" setting).
When checked, Natron also uses the plug-ins bundled with the binary distribution.

When unchecked, only system-wide plug-ins found in are loaded (more information can be found in the help for the "Extra plug-ins search paths" setting).

**Prefer bundled plug-ins over system-wide plug-ins**

Expand All @@ -291,7 +317,19 @@ When checked, Natron also uses the OpenFX plug-ins found in the default location

**OpenFX plug-ins search path**

Extra search paths where Natron should scan for OpenFX plug-ins. Extra plug-ins search paths can also be specified using the OFX\_PLUGIN\_PATH environment variable. The priority order for system-wide plug-ins, from high to low, is: - plugins bundled with the binary distribution of Natron (if "Prefer bundled plug-ins over system-wide plug-ins" is checked) - plug-ins found in OFX\_PLUGIN\_PATH - plug-ins found in /Library/OFX/Plugins (if "Enable default OpenFX plug-ins location" is checked) - plugins bundled with the binary distribution of Natron (if "Prefer bundled plug-ins over system-wide plug-ins" is not checked) Any change will take effect on the next launch of Natron.
Extra search paths where Natron should scan for OpenFX plug-ins. Extra plug-ins search paths can also be specified using the OFX\_PLUGIN\_PATH environment variable.

The priority order for system-wide plug-ins, from high to low, is:

- plugins bundled with the binary distribution of Natron (if "Prefer bundled plug-ins over system-wide plug-ins" is checked)

- plug-ins found in OFX\_PLUGIN\_PATH

- plug-ins found in /Library/OFX/Plugins (if "Enable default OpenFX plug-ins location" is checked)

- plugins bundled with the binary distribution of Natron (if "Prefer bundled plug-ins over system-wide plug-ins" is not checked)

Any change will take effect on the next launch of Natron.

**PyPlugs search path**

Expand All @@ -302,7 +340,11 @@ Python

**After project created**

Callback called once a new project is created (this is never called when "After project loaded" is called.) The signature of the callback is : callback(app) where: - app: points to the current application instance
Callback called once a new project is created (this is never called when "After project loaded" is called.)

The signature of the callback is : callback(app) where:

- app: points to the current application instance

**Default after project loaded**

Expand Down
5 changes: 3 additions & 2 deletions Documentation/source/plugins/fr.inria.openfx.WriteFFmpeg.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -236,8 +236,9 @@ Controls
| Bitrate / ``bitrateMbps`` | Double | 185 | | The target bitrate the codec will attempt to reach (in Megabits/s), within the confines of the bitrate tolerance and quality min/max settings. Only supported by certain codecs (e.g. hev1, m2v1, MP42, 3IVD, but not mp4v, avc1 or H264). |
| | | | | Option -b in ffmpeg (multiplied by 1000000). |
+--------------------------------------------------+-----------+--------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Bitrate Tolerance / ``bitrateToleranceMbps`` | Double | 4000 | | Set video bitrate tolerance (in Megabits/s). In 1-pass mode, bitrate tolerance specifies how far ratecontrol is willing to deviate from the target average bitrate value. This is not related to min/max bitrate. Lowering tolerance too much has an adverse effect on quality. As a guideline, the minimum slider range of target bitrate/target fps is the lowest advisable setting. Anything below this value may result in failed renders.Only supported by certain codecs (e.g. MP42, 3IVD, but not avc1, hev1, m2v1, mp4v or H264). |
| | | | | Option -bt in ffmpeg (multiplied by 1000000). |
| Bitrate Tolerance / ``bitrateToleranceMbps`` | Double | 0 | | Set video bitrate tolerance (in Megabits/s). In 1-pass mode, bitrate tolerance specifies how far ratecontrol is willing to deviate from the target average bitrate value. This is not related to min/max bitrate. Lowering tolerance too much has an adverse effect on quality. As a guideline, the minimum slider range of target bitrate/target fps is the lowest advisable setting. Anything below this value may result in failed renders. |
| | | | | Only supported by certain codecs (e.g. MP42, 3IVD, but not avc1, hev1, m2v1, mp4v or H264). |
| | | | | A reasonable value is 5 \* bitrateMbps / fps. This corresponds to option -bt in ffmpeg (multiplied by 1000000). |
+--------------------------------------------------+-----------+--------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Quality / ``quality`` | Integer | min: 2 max: 31 | | The quality range the codec is allowed to vary the image data quantiser between to attempt to hit the desired bitrate. Higher values mean increased image degradation is possible, but with the upside of lower bit rates. Only supported by certain codecs (e.g. VP80, VP90, avc1, but not hev1 or mp4v). |
| | | | | Options -qmin and -qmax in ffmpeg. |
Expand Down

0 comments on commit 44b5f04

Please sign in to comment.