| Next revision | Previous revision Next revisionBoth sides next revision |
| vcs:conf_files [2010/03/01 13:42] – created Toni Corvera | vcs:conf_files [2010/04/06 17:55] – Remove DVD config, not yet supported Toni Corvera |
|---|
| Configuration files follow a simplified shell-like syntax: | Configuration files follow a simplified shell-like syntax: |
| * Lines starting with ''#'' are comments (and are ignored) | * Lines starting with ''#'' are comments (and are ignored) |
| * Configuration options are set as ''OPTION=VALUE'' | * Configuration options are set as ''OPTION=VALUE''. Spaces in the value are allowed, the current version will display any quotes included. |
| * Options not recognised will be ignored | * Options not recognised will be ignored |
| |
| Certain options have no equivalent command-line option. They can be set from the command-line by using the special option ''-O'' (''%%--%%override'') followed by ''OPTION=VALUE''. In general, customisation of the script shouldn't require any editing of the script itself. | Certain options have no equivalent command-line option. They can be set from the command-line by using the special option ''-O'' (''%%--%%override'') followed by ''OPTION=VALUE''. In general, customisation of the script shouldn't require any editing of the script itself. |
| |
| **Examples:** | **Examples**\\ |
| * Setting background colour for the heading to blue: ''bg_heading=blue''. Added to a configuration file or from the command-line: ''$ vcs -O 'bg_heading=blue' file.avi'' | * Setting background colour for the heading to blue: ''bg_heading=blue''. Added to a configuration file or from the command-line: ''$ vcs -O 'bg_heading=blue' file.avi'' |
| * Output to JPEG by default: ''output_format=jpg''. Added to a configuration file (the command-line option ''[[vcs:cli_options#jpeg|-j]]'' does the same for a single run). | * Output to JPEG by default: ''output_format=jpg''. Added to a configuration file (the command-line option ''[[vcs:cli_options#jpeg|-j]]'' does the same for a single run). |
| |
| ===== List of options ===== | **Example configuration file**\\ |
| |
| In a future version (probably 1.2) a [[vcs:new_conf|cleanup of these options]] will be made, some will be renamed and maybe others removed. Those options marked as deprecated in the list below. The list of deprecated options and their replacements is not final. | # Output to JPEG... |
| | output_format=jpg |
| | # ...with 90% quality |
| | output_quality=90 |
| | # Sign as "myname" |
| | user=myname |
| | # Use "Snapshots grabbed by myname" instead of "Preview created by myname" |
| | user_signature=Snapshots grabbed by |
| |
| FIXME List of options to be added | ===== List of options ===== |
| |
| ^ Option ^ Default ^ Description ^ Additional details ^ Deprecated? ^ | In a future version (probably 1.12) a [[vcs:devel:conf:new_syntax|cleanup of these options]] will be made, some will be renamed and maybe others removed. Those options will be marked as deprecated in the list below. The list of deprecated options and their replacements is not final. |
| ^ Low level options ^^^^^ | \\ |
| | ''GETOPT'' | getopt | Getopt command | The getopt command must be set correctly or the script won't work. Must be a version accepting GNU syntax. Can only be set in configuration files (i.e. not from the command-line). | | | ''Integer'' in //Additional details// means the value can only accept numeric values. |
| | ''timecode_from'' | ''$TC_INTERVAL'' | Selects between [[vcs:usage#capture_count_modes|number of captures or interval mode]] | Symbolic: ''$TC_INTERVAL'' => interval mode, ''$TC_NUMCAPS'' => number of captures mode | Yes ((Replaced by capture_mode)) | | |
| | ''DEBUG'' | 0 | Control debug mode default status | Integer: 0=Off, 1=On | | | ^ Option ^ Default ^ Description ^ Additional details ^ Deprecated? ^ |
| | ''decoder'' | ''$DEC_FFMPEG'' | Controls which capturer to use by default | Symbolic: ''$DEC_FFMPEG'' => FFmpeg, ''$DEC_MPLAYER'' => MPlayer | | | |
| ^ Main behaviour options ^^^^^ | ^ Main behaviour options ^^^^^ |
| | ''DEFAULT_INTERVAL'' | 300 | Default capture interval | Integer: Seconds FIXME Does it take symbolic values? | | | | ''DEFAULT_INTERVAL'' | ''300'' | Default capture interval | Integer: Seconds FIXME Does it take symbolic values? | Already. Use ''interval'' instead | |
| | ''DEFAULT_NUMCAPS'' | 16 | Default number of captures | Integer only | | | | ''DEFAULT_NUMCAPS'' | ''16'' | Default number of captures | Integer | Already. Use ''numcaps'' instead | |
| | ''DEFAULT_COLS'' | 2 | Default number of columns | Integer only | | | | ''DEFAULT_COLS'' | ''2'' | Default number of columns | Integer | Already. Use ''cols'' instead | |
| | | ''HPAD'' | ''2'' | Padding between captures | Integer. **Since 1.11** | | |
| | | ''th_height'' | | Height | Can be a fixed value or a percentage. By default same as input. **Since 1.11** | | |
| | ''user_signature'' | "Preview created by" | Text before the user name in the signature | | | | | ''user_signature'' | "Preview created by" | Text before the user name in the signature | | | |
| | ''user'' | ''$(id -un)'' ((i.e. your username)) | User name for signature. | See ''[[vcs:cli_options#user|-u]]'' (''[[vcs:cli_options#user|--user]]'') and ''[[vcs:cli_options#fullname|-U]]'' (''[[vcs:cli_options#fullname|--fullname]]'') | | | | ''user'' | ''$(id -un)'' ((i.e. your username)) | User name for signature. | See ''[[vcs:cli_options#user|-u]]'' (''[[vcs:cli_options#user|--user]]'') and ''[[vcs:cli_options#fullname|-U]]'' (''[[vcs:cli_options#fullname|--fullname]]'') | | |
| | ''output_format'' | png | Sets the output format | Should match the extension of a format known by ImageMagick | Maybe | | | ''output_format'' | png | Sets the output format | Should match the extension of a format known by ImageMagick | Maybe | |
| | ''output_quality'' | 92 | Image quality for output in lossy formats | Integer, Only affects the final image | | | | ''output_quality'' | 92 | Image quality for output in lossy formats | Integer, Only affects the final image | | |
| | | ''decoder'' | ''$DEC_FFMPEG'' | Controls which capturer to use by default | Symbolic: ''$DEC_FFMPEG'' => FFmpeg, ''$DEC_MPLAYER'' => MPlayer | | |
| | | ''timecode_from'' | ''$TC_INTERVAL'' | Selects between [[vcs:usage#capture_count_modes|number of captures or interval mode]] | Symbolic: ''$TC_INTERVAL'' => interval mode, ''$TC_NUMCAPS'' => number of captures mode | Yes ((Replaced by capture_mode)) | |
| | | ''extended_factor'' | ''0'' | Set the extended factor. | ''0'' disables extended mode.\\ See [[vcs:extended_mode]] | | |
| | ^ Colours ((See ''$ convert -list color'')) ^^^^^ |
| | | ''bg_heading'' | ''#afcd7a'' ((#afcd7a=RGB(175,205,122) ))((Up to 1.11 was ''YellowGreen'')) | Background for meta info (size, codec...) | | | |
| | | ''bg_sign'' | ''SlateGray'' | Background for signature | | | |
| | | ''bg_title'' | ''White'' | Background for the title (see ''-T'') | | | |
| | | ''bg_contact'' | ''White'' | Background for the captures | | | |
| | | ''bg_tstamps'' | ''#000000aa'' | Background for the timestamps box | | | |
| | | ''fg_heading'' | ''Black'' | Font colour for meta info box | | | |
| | | ''fg_sign'' | ''Black'' | Font colour for signature | | | |
| | | ''fg_tstamps'' | ''White'' | Font colour for timestamps | | | |
| | | ''fg_title'' | ''Black'' | Font colour for the title | | | |
| | ^ Fonts ((See ''$ convert -list font'')) ^^^^^ |
| | | ''font_tstamps'' | ''DejaVu-Sans-Book'' ((Up to 1.11 was picked by ImageMagick)) | Used for timestamps over the thumbnails | | | |
| | | ''font_heading'' | ''DejaVu-Sans-Book'' ((Up to 1.11 was ''helvetica'')) | Used for the meta info heading | | | |
| | | ''font_sign'' | ''DejaVu-Sans-Book'' ((Up to 1.11 was ''helvetica'')) | Used for the signature box | | | |
| | | ''font_filename'' | ''$FF_DEFAULT'' | Picks filename font, set to ''$FF_MINCHO'' to use the alternate font | This variable only accepts the ''$FF_*'' constants | | |
| | | ''FONT_MINCHO'' | | Font used for non-latin filenames. | See ''$font_filename'' and ''-I''. Tries to pick automatically, can be set manually with -I | Partly ((Will be renamed)) | |
| | | ''font_title'' | ''DejaVu-Sans-Book'' ((Up to 1.11 was ''helvetica'')) | Used for the title (see ''-T'') | | | |
| | ^ Font sizes ((Specified in points)) ^^^^^ |
| | | ''pts_tstamps'' | ''14'' ((Up to 1.11 was ''18'')) | Used for the timestamps | Integer. This value is reduced for smaller captures | | |
| | | ''pts_meta'' | ''14'' ((Up to 1.11 was ''16'')) | Used for the meta info heading | Integer | | |
| | | ''pts_sign'' | ''10'' ((Up to 1.11 was ''11'')) | Used for the signature | Integer | | |
| | | ''pts_title'' | ''33'' ((Up to 1.11 was ''36'')) | Used for the title (see ''-T'') | Integer | | |
| | ^ Low level options ^^^^^ |
| | | ''GETOPT'' | ''getopt'' | Getopt command | The getopt command must be set correctly or the script won't work. Must be a version accepting GNU syntax. Can only be set in configuration files (i.e. not from the command-line). | | |
| | | ''DEBUG'' | ''0'' | Control debug mode default status | Integer: 0=Off, 1=On | | |
| | | ''shoehorned'' | | Inserts additional parameters into ''ffmpeg'' or ''mplayer'' capture commands | | Yes ((No longer believed to be required)) | |
| | | ''DEFAULT_END_OFFSET'' | ''60'' | Default value for end offset. See ''-E'' | | Yes ((Will be simplified in future versions)) | |
| | | ''MIN_LENGTH_FOR_END_OFFSET'' | ''19m30s'' | End offset is only used if the video is at least this long | | Yes ((Will be simplified in future versions)) | |
| | | ''safe_rename_pattern'' | ''%b-%N.%e'' | Pattern used for output files to avoid overwriting existing files. | ''%b'': Basename \\ ''%N'': Incremental number \\ ''%e'': extension | | |
| | | ''verbosity'' | ''$V_ALL'' | Verbosity level | Available: ''$V_ALL'', ''$V_NONE'', ''$V_ERROR'', ''$V_WARN'', ''$V_INFO'' \\ See also ''[[vcs:cli_options#quiet|--quiet]]'' | | |
| | | ''plain_messages'' | ''0'' | Controls colour output ((**From 1.11**: Also the alternative prefixes when no colour is available)) to console. | Set to ''1'' to disable colour | | |
| | | ''stdout'' | ''/dev/null'' | Standard output of decoder is sent here | | Maybe ((Might be moved to the ''%%--%%undocumented'' subset)) | |
| | | ''stderr'' | ''/dev/null'' | Standard error of decoder is sent here | | Maybe ((Might be moved to the ''%%--%%undocumented'' subset)) | |
| |
| Cut'n paste: | |
| <code> | |
| # Options used in imagemagick, these options set the final aspect | |
| # of the contact sheet | |
| declare output_format=png # ImageMagick decides the type from the extension | |
| declare -i output_quality=92 # Output image quality (only affects the final | |
| # image and obviously only in lossy formats) | |
| # Colours, see convert -list color to get the list | |
| declare bg_heading=YellowGreen # Background for meta info (size, codec...) | |
| declare bg_sign=SlateGray # Background for signature | |
| declare bg_title=White # Background for the title (see -T) | |
| declare bg_contact=White # Background of the thumbnails | |
| declare bg_tstamps='#000000aa' # Background for the timestamps box | |
| declare fg_heading=black # Font colour for meta info box | |
| declare fg_sign=black # Font colour for signature | |
| declare fg_tstamps=white # Font colour for timestamps | |
| declare fg_title=Black # Font colour for the title | |
| # Fonts, see convert -list type to get the list | |
| declare font_tstamps=courier # Used for timestamps over the thumbnails | |
| declare font_heading=helvetica # Used for the heading (meta info box) | |
| declare font_sign=$font_heading # Used for the signature box | |
| # Unlike other font_ variables this doesn't take a font name directly | |
| # but is restricted to the $FF_ values. This is to allow overrides | |
| # from the command line to be placed anywhere, i.e. in | |
| # $ vcs -I file.avi -O 'FONT_MINCHO=whatever' | |
| # as the font is overridden is after requesting its use, it wouldn't be | |
| # affected | |
| # The other font_ variables are only affected by overrides and not command | |
| # line options that's why this one is special. | |
| declare font_filename=$FF_DEFAULT # Used to print only the filename in the heading | |
| declare font_title=$font_heading # Used for the title (see -T) | |
| # Font sizes, in points | |
| declare -i pts_tstamps=18 # Used for the timestamps | |
| declare -i pts_meta=16 # Used for the meta info box | |
| declare -i pts_sign=11 # Used for the signature | |
| declare -i pts_title=36 # Used for the title (see -T) | |
| # See --shoehorn | |
| declare shoehorned= | |
| # See -E / $end_offset | |
| declare -i DEFAULT_END_OFFSET=60 | |
| # If the video is less than this length, end offset won't be used at all | |
| declare MIN_LENGTH_FOR_END_OFFSET=19m30s | |
| # This can only be changed in the configuration file | |
| # Change it to change the safe renanimg: | |
| # When writing the output file, the input name + output extension is | |
| # used (e.g.: "some video.avi.png"), if it already exists, though, | |
| # a number if appended to the name. This variable dictates where the number is | |
| # placed. | |
| # By default "%b-%N.%e" where: | |
| # %b is the basename (file name without extension) | |
| # %N is the appended number | |
| # %e is the extension | |
| # The default creates outputs like "output.avi-1.png" | |
| # | |
| # If overridden with an incorrect value it will be silently set to the default | |
| declare safe_rename_pattern="$DEFAULT_SAFE_REN_PATT" | |
| # Controls how many extra captures will be created in the extended mode | |
| # (see -e), 0 is the same as disabling the extended mode | |
| # This number is multiplied by the total number of captures to get | |
| # the number of extra captures. So, e.g. -n2 -e2 leads to 4 extra captures. | |
| declare extended_factor=0 | |
| # Options added always to the ones in the command line | |
| # (command line options override them). | |
| # Note using this is a bit tricky :P mostly because I've no clue of how this | |
| # should be done. | |
| # As an example: you want to set always the title to "My Title" and output | |
| # to jpeg: default_options="-T'My Title' -j" | |
| #declare default_options= | |
| # Verbosity level so far from the command line can only be muted (see -q) | |
| # it can be overridden, though | |
| declare -i verbosity=$V_ALL | |
| # When set to 0 the status messages printed by vcs while running | |
| # are coloured if the terminal supports it. Set to 1 if this annoys you. | |
| declare -i plain_messages=0 | |
| # Experimental in 1.0.7b: | |
| # Experiment to get international font support | |
| # I'll need to get some help here, so if you use anything beyond a latin | |
| # alphabet, please help me choosing the correct fonts | |
| # To my understanding Ming/MinchÅ fonts should cover most of Japanse, | |
| # Chinese and Korean | |
| # Apparently Kochi Mincho should include Hangul *and* Cyrillic... which would be | |
| # great :) Although it couldn't write my hangul test, and also the default font | |
| # (helvetica) in my system seems to include cyrillic too, or at least a subset of | |
| # it. | |
| declare FONT_MINCHO=/usr/share/fonts/truetype/kochi/kochi-mincho.ttf | |
| # Output of capturing programs is redirected here | |
| declare stdout=/dev/null stderr=/dev/null | |
| declare -i DVD_MODE=0 DVD_TITLE=1 | |
| declare DVD_FILE= | |
| declare -i multiple_input_files=0 | |
| |
| # }}} # End of override-able variables | |
| </code> | |