Difference between revisions of "Documentation:Modules/adjust"

From VideoLAN Wiki
Jump to navigation Jump to search
m (Prepare for transclusion, sections)
 
(6 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Module|name=adjust|type=Video filter|first_version=0.9.0|description=color adjust video filter}}
+
{{Module|name=adjust|type=Video filter|first_version=0.9.0|description=Image properties filter}}
  
'''Note:''' this used to be a vout filter in pre 0.9.0 VLC releases.
+
'''Note:''' Before version 0.9.0, this used to be a vout filter.
  
{{Option
+
== Options ==
 +
<onlyinclude>{{Option
 
|name=contrast
 
|name=contrast
 
|value=float
 
|value=float
 
|default=1.0
 
|default=1.0
|description=Contrast (0.0 - 2.0)
+
|min=0.0
 +
|max=2.0
 +
|description=Contrast
 
}}
 
}}
 
{{Option
 
{{Option
Line 13: Line 16:
 
|value=float
 
|value=float
 
|default=1.0
 
|default=1.0
|description=Brightness (0.0 - 2.0)
+
|min=0.0
 +
|max=2.0
 +
|description=Brightness
 
}}
 
}}
 
{{Option
 
{{Option
 
|name=hue
 
|name=hue
|value=integer
+
|value=float
 
|default=0
 
|default=0
|description=Hue (0 - 360)
+
|min=-180
 +
|max=180
 +
|description=Hue
 
}}
 
}}
 
{{Option
 
{{Option
Line 25: Line 32:
 
|value=float
 
|value=float
 
|default=1.0
 
|default=1.0
|description=Saturation (0.0 - 3.0)
+
|min=0.0
 +
|max=3.0
 +
|description=Saturation
 
}}
 
}}
 
{{Option
 
{{Option
Line 31: Line 40:
 
|value=float
 
|value=float
 
|default=1.0
 
|default=1.0
|description=Gamma (0.01 - 10.0)
+
|min=0.01
 +
|max=10.0
 +
|description=Gamma
 
}}
 
}}
 
{{Option
 
{{Option
 
|name=brightness-threshold
 
|name=brightness-threshold
 +
|value=boolean
 
|default=disabled
 
|default=disabled
|description=When this mode is enabled, pixels will be shown as black or white. The threshold value will be the brighness defined below
+
|description=When this mode is enabled, pixels will be shown as black or white. Also may invert the brightness value. The threshold value will be the brightness defined below
}}
+
}}</onlyinclude>
 +
 
 +
== Examples ==
 +
{{%}} '''vlc --video-filter "adjust{hue=120,gamma=2.}" somevideo.avi
  
== Example ==
+
== Source code ==
% '''vlc --video-filter "adjust{hue=120,gamma=2.}" somevideo.avi
+
* {{VLCSourceFile|modules/video_filter/adjust.c}}
  
{{Documentation}}
+
{{Documentation footer}}
[[Category:Video Filters]]
 

Latest revision as of 06:29, 4 April 2019

Module: adjust
Type Video filter
First VLC version 0.9.0
Last VLC version -
Operating system(s) all
Description Image properties filter
Shortcut(s) -

Note: Before version 0.9.0, this used to be a vout filter.

Options

  • contrast <float [0.0 .. 2.0]> : Contrast default value: 1.0
  • brightness <float [0.0 .. 2.0]> : Brightness default value: 1.0
  • hue <float [-180 .. 180]> : Hue default value: 0
  • saturation <float [0.0 .. 3.0]> : Saturation default value: 1.0
  • gamma <float [0.01 .. 10.0]> : Gamma default value: 1.0
  • brightness-threshold <boolean> : When this mode is enabled, pixels will be shown as black or white. Also may invert the brightness value. The threshold value will be the brightness defined below default value: disabled

Examples

% vlc --video-filter "adjust{hue=120,gamma=2.}" somevideo.avi

Source code

This page is part of official VLC media player Documentation (User GuideStreaming HowToHacker GuideModules)
Please read the Documentation Editing Guidelines before you edit the documentation
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.