Configuration KiSS CE

From Digisaster
Jump to: navigation, search

Work in progress....


Paths

All paths can be relative to this scripts location or a full path.

}

Remote device settings

- remote_address Values: ip address - remote_address is the address of the KiSS Player device. It can be a domain name, but - usually is a local IP adress. - ex. - remote_address="10.0.0.90" - for a local network, behind a NAT. typical for ADSL connections - remote_address="myserver.mydomain.com" remote_address='10.0.0.90'

- remote_userid Value: String - remote_userid is the user name used by FTP to login, when collecting files. - As of today (2007) user login are not supported on KiSS devices, with standard firmware. - Only anonymous logins are accepted. Anonymous logins use the user id 'anonymous' and a password - that identifies the user, typical a mail address (or nonsens) - Ex. - remote_userid="Joe" - if you have a device that supports user login (Recommended) - remote_userid="anonymous" - when using standart firnware. remote_userid="anonymous"

- remote_password Value: String - remote_password. Either the password for the user login account og identification of the anonymous - user in form of mail address or anything else that identifies this server - Ex. - remote_password="secret password" - for user login - remote_password=$(hostname) - Use the servers official host name for anonymous login - remote_password="KiSS collect script" - Use some other text -remote_password=$(hostname) remote_password="KiSS_CE"

- remote_path Value: String - remote_path is the path to change to when loged in at the FTP root. - Ex. - remote_path='pvr' remote_path='pvr'

- remote_get_sub_dirs Value: ENABLED | DISABLED - This function is currently disabled - remote_get_sub_dirs enables/disables the search for files in subdirs, under the remote_path. - Default is 'DISABLE' - Ex. - remote_get_sub_dirs='ENABLE'


Transfer settings

- transfer Values: ENABLED/DISABLED - Enable or disable transfers from remote KiSS player transfer='ENABLED'

- transfer_start_time and transfer_end_time Value: [ 0 - 23 ] - transfer_start_time and transfer_end_time specifies at what hour of the day transfers - should start. On many player, transferring files, make it imposible to wach recorded movies - and the player will disconnect if a recording is scheduled. So its important to select - a time, where it is unlikely to desturb the user of the device. - A transfer will not be initiated after transfer_end_time, but it will continue, if started. - So you should set transfer_end_time to well before you need it to stop. - If transfer_start_time is undefined, it will run jobs continuously - Ex. - transfer_start_time="03" - transfer_end_time="15" transfer_start_time="04" transfer_end_time="15"

- transfer_list_freq Value: [ 1 - 10000 ] - transfer_list_freq determins how many hours there are between looking for new files on the - remote device. In any case, it will only look in the time interval allowed for transfers. transfer_list_freq=23

- transfer_bitrate Value: [ 0 - 100000 ] - transfer_bitrate if specified, set a limit on the bitrate files are transfered with. - This can be used to set the bitrate so low, that is dosen't desturbe the recording - and viewing operations of the device. - Specify bitrate in kilo bit per second. If nor specified, it will use maximum rate. - For KiSS VR-558: - - it will go no higher then about 9000 Kbps - - at about 800 kbps you can still watch a mpeg2 movie, while transfering. But it will keep the - harddrive busy for a long time. - transfer_bitrate=800

- transfer_retries Values: [ 1 - 100 ] - transfer_retries specifies how many times it shall try to transfer a file, if errors - occure, before giving up. - When given up, the file will be ignored in future runs transfer_retries=3

- transfer_min_age Value: [ 0 - 360 ] - transfer_min_age if set, is the minimum age of a file on the remote device, before it - will be transfered. This can be used to not processing files until you have a - opertunity to view and delete the file first. - value: age in days transfer_min_age=7

- transfer_max_exec_time Value: [ 0 - Max int ] - transfer_max_exec_time if set, is the maximun time allowed for the transfer process in - seconds. if the time are exceeded, the process is assumed dead and are killed transfer_exec_time=36000; - 10 hours

- transfer_continue Value: ENABLED/DISABLED - transfer_continue if set, let interupted file transfers continue with the data already - transfered. If not set or enabled, retrys will start from the begining transfer_continue="enabled"

- transfer_free_space Value: [ 0 - Max int ] - transfer_free_space tell how much free space there should be left on the filesystem, when - files are transfered. Set this, if input and output dir is on the same filesystem, to prevent - that transfered files fills the filesystem and there by prevents encoding. - Typical values are at least half the size of a normal file size. - value in Mega bytes transfer_free_space=17000


File name changing

- filename_remove_datetime Value: ENABLED/DISABLED - filename_remove_datetime if enabled, removes the date and time part of the file name, that KiSS players - put in the end of filenames. eg. "X-men - fri 07-07-2007 22:10:00.vob" - This is needed it you want to transfer file to a windows file system: It dosen't - take keindly to colons in filenames. - Values enabled/disabled filename_remove_datetime='ENABLED'

- filename_remove_win_illigals Value: ENABLED/DISABLED - filename_remove_win_illigals if enabled removed windows illigal charakters from file name, such as :$\ - Values enable/fisable filename_remove_win_illigals='ENABLED'

- filename_replace_space Value: ENABLED/DISABLED - filename_replace_space if enabled, convert spaces to underscores. That is very convinent when working - with command line functions, since space is considered as a parameter separator. filename_replace_space='ENABLED'

- filename_lowercase Value: ENABLED/DISABLED - filename_lowercase if enabled, convert all letters in the file name to lowercase. In Unix systems that - practical, since it distinguish between upper and lower case letters: "Alien" and "alien" are NOT the same. filename_lowercase='ENABLED'

- filename_capital_first Value: ENABLED/DISABLED - filename_capital_first if enabled, capitalise first letter of file name. filename_capital_first='ENABLED'

- filename_convert_utf8 Value: ENABLED/DISABLED - KiSS players (to the best of my knowledge) use ISO_8859-1. TinyStocks use UTF-8 on there EPG - Therefore filenames in local language might be named with what looks like nonsens. - When filename_convert_utf8 are enabled, this function will try to correct it, if it occures. - For it to work, iconv must be installed. filename_convert_utf8='ENABLED'


Encoding settings

- encoding Values: ENABLED/DISABLED - Enable or disable encoding of input queue. encoding='ENABLED'

- encoding_pass1_options and encoding_pass2_options Value: String - encoding_pass1_options and encoding_pass2_options are flags used for mencoder, when - encoding the movie. If encoding_pass2_options are specified; its a 2 pass operation - (Better quality/smaller file size) You will have to tweek the settings to get the best result. - the right setting depends on the movie content - - The container format are always .avi - Ex. - Video are converted to XviD. Sound are copied original A3C. - encoding_pass1_options='-oac copy -ovc xvid -xvidencopts pass=1' - encoding_pass1_options='-oac copy -ovc xvid -xvidencopts pass=2:bitrate=800' - - Video are converted to XviD. Sound converted to MP3 with 128 kb sample reate and raised volum (9) - encoding_pass1_options='-oac mp3lame -lameopts br=128:vol=9 -ovc xvid -xvidencopts pass=1' - encoding_pass1_options='-oac mp3lame -lameopts br=128:vol=9 -ovc xvid -xvidencopts pass=2:bitrate=800' -

- 800 Kbps. Small Size, pretty good quality for TV shows and series, movies on VDC og for streaming or - sharing on the internet. - blockiness on dark smoothe surfaces, but not very desturbing to watch. - 1 hour = 412 MB -encoding_pass1_options='-oac mp3lame -lameopts cbr:q=2:br=128 -ovc lavc -mc 0 -lavcopts vcodec=mpeg4:vmax_b_frames=1:vb_strategy=1:trell:mbd=2:v4mv:last_pred=3:predia=2:dia=2:preme=2:precmp=2:cmp=3:subcmp=3:mv0:cbp:vqcomp=0.6:dc=10:qns=2:vbitrate=800:vpass=1:turbo -vf crop=688:544:16:16,lavcdeint,hqdn3d=2:1:2'

-encoding_pass2_options='-oac mp3lame -lameopts cbr:q=2:br=128 -ovc lavc -mc 0 -lavcopts vcodec=mpeg4:vmax_b_frames=1:vb_strategy=1:trell:mbd=2:v4mv:last_pred=3:predia=2:dia=2:preme=2:precmp=2:cmp=3:subcmp=3:mv0:cbp:vqcomp=0.6:dc=10:qns=2:vbitrate=800:vpass=2 -vf crop=688:544:16:16,lavcdeint,hqdn3d=2:1:2 -ffourcc XVID'

- 1500 Kbps. Good quality, for TV recordings of movies and yet a fairly small size. - A little blockiness on dark smoothe surfaces, but not much. - 1 hour = 720 MB encoding_pass1_options='-oac mp3lame -lameopts cbr:q=2:br=128 -ovc lavc -mc 0 -lavcopts vcodec=mpeg4:vmax_b_frames=1:vb_strategy=1:trell:mbd=2:v4mv:last_pred=3:predia=2:dia=2:preme=2:precmp=2:cmp=3:subcmp=3:mv0:cbp:vqcomp=0.6:dc=10:qns=2:vbitrate=1500:vpass=1:turbo -vf crop=688:544:16:16,lavcdeint,hqdn3d=2:1:2'

encoding_pass2_options='-oac mp3lame -lameopts cbr:q=2:br=128 -ovc lavc -mc 0 -lavcopts vcodec=mpeg4:vmax_b_frames=1:vb_strategy=1:trell:mbd=2:v4mv:last_pred=3:predia=2:dia=2:preme=2:precmp=2:cmp=3:subcmp=3:mv0:cbp:vqcomp=0.6:dc=10:qns=2:vbitrate=1500:vpass=2 -vf crop=688:544:16:16,lavcdeint,hqdn3d=2:1:2 -ffourcc XVID'

- 2500 Absolute heighest quality and largest size worth dooing on TV recordings. - if you dont have a very good TV signal, this is a waist of space - almost no blockiness on dark smoothe surfaces. - 1 hour = 1200 MB -encoding_pass1_options='-oac copy -ovc lavc -mc 0 -lavcopts vcodec=mpeg4:vmax_b_frames=1:vb_strategy=1:trell:mbd=2:v4mv:last_pred=3:predia=2:dia=2:preme=2:precmp=2:cmp=3:subcmp=3:mv0:cbp:vqcomp=0.6:dc=10:qns=2:vbitrate=2500:vpass=1:turbo -vf crop=688:544:16:16,lavcdeint,hqdn3d=2:1:2'

-encoding_pass2_options='-oac copy -ovc lavc -mc 0 -lavcopts vcodec=mpeg4:vmax_b_frames=1:vb_strategy=1:trell:mbd=2:v4mv:last_pred=3:predia=2:dia=2:preme=2:precmp=2:cmp=3:subcmp=3:mv0:cbp:vqcomp=0.6:dc=10:qns=2:vbitrate=2500:vpass=2 -vf crop=688:544:16:16,lavcdeint,hqdn3d=2:1:2 -ffourcc XVID '

- encoding_exec_time Value: [ 0 - Max int ] - encoding_exec_time if set, is the maximun time allowed for the transfer process in - seconds. if the time are exceeded, the process is assumed dead and are killed - encoding_exec_time=36000; - 10 hours

- encoding_nice Value: [ 0 - 128 ] - encoding_nice is the nice level the encoding process is running under. (Se man pages for nice command) - The lower the nice value of a process, the higher its scheduling priority. Since video encoding is a - resource consuming process, its often usefull to set a nice level of 10 or more, so that other - more interactive functions run at a higer priority. If the cup is idle, there isnt much differance - in the execution time, with or without encoding_nice set. (Default 0) encoding_nice=10

- file_suffixes Value: string - file_suffixes name the extensions that are treated as video files to encode. - If more than one; separate by space. ( like "vob avi" ) file_suffixes="vob avi mpeg mpg"

Loging

- log_size Value: [ 0 - Max int / 1024 ] - log_size if specified is the maximum size in Kilo bytes the log file can have before - turnover. It should therefore only be half the total size you wish to allocate to log - files. (Default 100 (KB)) log_size=100

Cleaning

- clean_local_input Value: ENABLED/DISABLED - clean_local_input when enabled, causes the script to delete the original file, from the input dir - when the encoding is successfully completed. - clean_local_input='DISABLED' clean_local_input="ENABLED"

- clean_remote_original Value: ENABLED/DISABLED - clean_remote_original if enabled delete the remote file on successfull transfer - clean_remote_original='DISABLED' clean_remote_original='ENABLED'

Name Description Default value Example
path_input name the directory where file are first put, before encoding. Must be defined path_input='input'
path_output name the directory where the successfully encoded file are put. Must be defined path_output='output'
path_error name the directory where unprocessable files are put. Must be defined path_error='error'
path_log name the directory where the log files are put. (Defaults to current directory of script) Current directory path_log='log'
path_data name the directory where data on file and sessions are stored. (Defaults to current directory of script) Current directory path_data='data'
path_tmp name the directory where the temporary process output data are stored. (Defaults to path_data) Current directory path_tmp='tmp'