Also, I think this counts as my first "real" contribution to the Open Source community. I hope to help contribute to Freevo in the future.
Patched against current cvs.
-Nick
--- local_conf.py.example.old 2004-03-18 07:38:18.000000000 -0800 +++ local_conf.py.example 2004-03-28 02:19:36.000000000 -0800 @@ -43,7 +43,7 @@ # AUDIO_DEVICE = '/dev/dsp' # e.g.: /dev/dsp0, /dev/audio, /dev/alsa/? # AUDIO_INPUT_DEVICE = '/dev/dsp1' # e.g.: /dev/dsp0, /dev/audio, /dev/alsa/? # MAJOR_AUDIO_CTRL = 'VOL' # Freevo takes control over one audio ctrl - # 'VOL', 'PCM' 'OGAIN' etc. + # 'VOL', 'PCM' 'OGAIN' etc. # CONTROL_ALL_AUDIO = 1 # Should Freevo take complete control of audio # MAX_VOLUME = 90 # Set what you want maximum volume level to be. # DEFAULT_VOLUME = 40 # Set default volume level. @@ -64,76 +64,83 @@ # # Set to None to autodetect drives in during startup from /etc/fstab, # set to [] to disable rom drive support at all +# # ROM_DRIVES = None -# hide discs from the wrong menu (e.g. VCDs in audio menu) and empty discs +# +# Hide discs from the wrong menu (e.g. VCDs in audio menu) and empty discs. +# # HIDE_UNUSABLE_DISCS = 1 -# ROM_SPEED = 0 # try to set the drive speed of the rom - # drive a good value for playing movies - # with a silent drive is 8 - - -# ENABLE_SHUTDOWN_SYS = 0 # Performs a whole system shutdown at SHUTDOWN! - # For standalone boxes. +# +# Attempt to set the speed of the ROM drive. A good value for keeping the +# drive silent while playing movies is 8. +# +# ROM_SPEED = 0 +# +# Perform a whole system shutdown at SHUTDOWN! Useful for standalone boxes. +# +# ENABLE_SHUTDOWN_SYS = 0 # -# see src/event.py for a list of all possible events. You can add more keybindings -# by adding them to the correct hash. E.g. pressing 1 should send 'contrast -100' -# to mplayer, just write the folling line to your local_conf.py +# You can add more keybindings by adding them to the correct hash. +# e.g. If you want to send 'contrast -100' to mplayer by pressing the '1' key, +# just add the following line: # # EVENTS['video']['1'] = Event(VIDEO_SEND_MPLAYER_CMD, arg='contrast -100') # +# See src/event.py for a list of all possible events. # -# use arrow keys for back and select (alternative way of navigating) +# Use arrow keys for back and select (alternate way of navigating) # # MENU_ARROW_NAVIGATION = 0 # -# keymap to map keyboard keys to event strings. You can also add new keys +# Keymap to map keyboard keys to event strings. You can also add new keys # here, e.g. KEYMAP[K_x] = 'SUBTITLE'. The K_-names are defined by pygame. # # -# use resources for the internet to get more informations, like CDDB, -# IMDB and Amazon cover search. Set this variable to 0 if your computer -# has no network and stop Freevo from trying to use it. +# Use Internet resources to fetch information? +# For example, Freevo can use CDDB for album information, +# the IMDB movie database for movie info, and Amazon for cover searches. +# Set this to 0 if your computer isn't connected to a network. # # USE_NETWORK = 1 # -# directory structure to save files when the normal filesystem -# doesn't allow saving. This directory can handle covers and fxd files -# for read only filesystems like a rom drive. Set this variable to your +# Directory location to save files when the normal filesystem +# doesn't allow saving. This directory can save covers and fxd files +# for read only filesystems like ROM drives. Set this variable to your # old MOVIE_DATA_DIR if you have one. It needs to be set to a directory -# freevo can write to. +# Freevo can write to. # # OVERLAY_DIR = os.path.join(FREEVO_CACHEDIR, 'vfs') # -# umask for all files +# Umask setting for all files. # 022 means only the user has write access. If you share your Freevo -# installation with different users, set it to 002 +# installation with different users, set this to 002 # # UMASK = 022 # -# suffix for playlist files +# Suffix for playlist files # # PLAYLIST_SUFFIX = [ 'm3u' ] # -# use md5 in mmpython to create unique disc ids. Use this if you have -# problems with different discs having the same id +# Use md5 in mmpython to create unique disc ids. Enable this if you have +# problems with different discs having the same id. # # MMPYTHON_CREATE_MD5_ID = 0 # -# keep metadata in memory +# Keep metadata in memory # Setting this variable will keep all cache files in memory. Startup will be -# slower, but for large directories, this will speed up entering the dir. +# slower, but for large directories, this will speed up the display. # 0 = Only keep current dir in memory. Use this if you have too much data # and not enough RAM # 1 = Once loaded, keep cachefile for directory in memory @@ -148,9 +155,9 @@ # Plugins: # ====================================================================== -# you can remove all plugins later in your local_conf.py by setting -# plugin.remove(code). You can also use the name to remove a plugin. But -# if you do that, all instances of this plugin will be removed. +# Remove undesired plugins by setting plugin.remove(code). +# You can also use the name to remove a plugin. But if you do that, +# all instances of this plugin will be removed. # # Examples: # plugin.remove(plugin_tv) or @@ -162,13 +169,16 @@ # # See freevo_config.py for a list of loaded plugins -# Use this ivtv_record instead if you have an ivtv based card (PVR-250/350) -# and want freevo to do everthing for you. TV_SETTINGS must be set -# correctly. To use you need the following two lines in local_conf.py: +# +# Use ivtv_record instead if you have an ivtv based card (PVR-250/350) +# and want freevo to do everthing for you. TV_SETTINGS must be set +# correctly. To use you need to set the following two lines: +# # plugin.remove('tv.generic_record') # plugin_record = plugin.activate('tv.ivtv_record') -# For joystick support: +# +# Enable this for joystick support: # plugin.activate('joy') # ====================================================================== @@ -189,76 +199,81 @@ # </freevo> # -# Should directories sorted by date instead of filename -# 0 = no, 1 = yes, 2 = no for normal menus, yes for TV_RECORD_DIR +# Should directories sorted by date instead of filename? +# 0 = No, always sort by filename. +# 1 = Yes, sort by date +# 2 = No, don't sory by date for normal directories, +# but sort by date for TV_RECORD_DIR. # # DIRECTORY_SORT_BY_DATE = 2 # -# Show the items in the list in reverse order +# Should directory items be sorted in reverse order? # # DIRECTORY_REVERSE_SORT = 0 # -# Should we use "smart" sorting to ignore 'The' in directories -# 0 = no, 1 = yes +# Should we use "smart" sorting? +# Smart sorting ignores the word "The" in item names. # # DIRECTORY_SMART_SORT = 0 # -# Should freevo autoplay the item if only one item is in the directory +# Should Freevo autoplay an item if only one item is in the directory? # # DIRECTORY_AUTOPLAY_SINGLE_ITEM = 1 # -# Force the skin to a specific layout number. -1 == no force. The layout +# Force the skin to use a specific layout number. -1 == no force. The layout # toggle with DISPLAY will be disabled # # DIRECTORY_FORCE_SKIN_LAYOUT = -1 # -# Formatstring for the audio item names, possible strings: +# Format string for the audio item names. +# +# Possible strings: # a = artist, n = tracknumber, t = title, y = year, f = filename # -# This will show the title and the track number +# Example: +# This will show the title and the track number: # DIRECTORY_AUDIO_FORMAT_STRING = '%(n)s - %(t)s' -# This is the default - track name only # # DIRECTORY_AUDIO_FORMAT_STRING = '%(t)s' # # Use media id tags to generate the name of the item. This should be -# 1 all the time and only be disabled in directories with broken tags +# enabled all the time. It should only be disabled for directories with +# broken tags. # # DIRECTORY_USE_MEDIAID_TAG_NAMES = 1 # -# The next varibales are a list of types in which the feature should be -# enabled (video, audio, image, games). E.g. to enable autoplay for -# audio and images set DIRECTORY_AUTOPLAY_ITEMS = [ 'audio', 'image' ], -# to disable it set it to []. +# The following settings determine which features are available for +# which media types. # # If you set this variable in a folder.fxd, the value is 1 (enabled) # or 0 (disabled). -# +# +# Examples: +# To enable autoplay for audio and image files: +# DIRECTORY_AUTOPLAY_ITEMS = [ 'audio', 'image' ] +# To disable autoplay entirely: +# DIRECTORY_AUTOPLAY_ITEMS = [] -# # Make all items a playlist. So when one is finished, the next one will # start. It's also possible to browse through the list with UP and DOWN # # DIRECTORY_CREATE_PLAYLIST = [ 'audio', 'image' ] -# # Add playlist files ('m3u') to the directory # # DIRECTORY_ADD_PLAYLIST_FILES = [ 'audio', 'image' ] -# -# Add an item 'Random Playlist' to the directory +# Add the item 'Random Playlist' to the directory # # DIRECTORY_ADD_RANDOM_PLAYLIST = [ 'audio' ] -# # Make 'Play' not 'Browse' the default action when only items and not # subdirectories are in the directory # @@ -271,18 +286,17 @@ # # Where the movie files can be found. -# This is a list of items (e.g. directories, fxd files). The items itself +# This is a list of items (e.g. directories, fxd files). The items themselves # can also be a list of (title, file) # # VIDEO_ITEMS = [ ('action movies', '/files/movies/action'), # ('funny stuff', '/files/movies/comedy') ] # -# Some people have movies on different maschines using an automounter. +# Some people access movies on a different machine using an automounter. # To avoid timeouts, you can specify the machine name in the directory # to check if the machine is alive first # Directory myserver:/files/server-stuff will show the item for the # directory /files/server-stuff if the computer myserver is alive. -# # # The list of filename suffixes that are used to match the files that @@ -300,13 +314,13 @@ # 'asf', 'm2v', 'm2p', 'mp4', 'mov', 'cue' ] # -# Prefered video player +# Preferred video player # # VIDEO_PREFERED_PLAYER = 'mplayer' # # Only scan OVERLAY_DIR and VIDEO_SHOW_DATA_DIR for fxd files containing -# informations about a disc. If you only have the fxd files for discs in +# information about a disc. If you only have the fxd files for discs in # one of this directories (and subdirectories), set this to 1, it will # speed up startup, 0 may be needed if you have fxd files with disc links # in your normal movie tree. @@ -320,7 +334,7 @@ # # Where the Audio (mp3, ogg) files can be found. -# This is a list of items (e.g. directories, fxd files). The items itself +# This is a list of items (e.g. directories, fxd files). The items themselves # can also be a list of (title, file) # # To add webradio support, add fxd/webradio.fxd to this list @@ -335,19 +349,19 @@ # AUDIO_SUFFIX = [ 'mp3', 'ogg', 'wav','m4a', 'wma', 'aac', 'flac'] # -# This regexp should recognize filenames which are likely to be covers -# for an album. This example will match front.jpg and cover-f.jpg, but -# not back.jpg nor cover-b.jpg +# Regular expression used to recognize filenames which are likely to be +# covers for an album # +# This will match front.jpg and cover-f.jpg, but not back.jpg nor cover-b.jpg: # AUDIO_COVER_REGEXP = 'front|-f' # -# Prefered audio player +# Preferred audio player # # AUDIO_PREFERED_PLAYER = 'mplayer' # -# Also show video files in the audio menu (for musicvideos) +# Show video files in the audio menu (for music-videos) # # AUDIO_SHOW_VIDEOFILES = False @@ -356,7 +370,7 @@ # ====================================================================== # -# Where the image files can be found. +# Where image files can be found. # This is a list of items (e.g. directories, fxd files). The items itself # can also be a list of (title, file) # @@ -368,17 +382,22 @@ # # IMAGE_SUFFIX = [ 'jpg','gif','png', 'jpeg','bmp','tiff','psd' ] +# # The viewer now supports a new type of menu entry, a slideshow file. # It also has the slideshow alarm signal handler for automated shows. # It uses a new configuration option: - +# # IMAGE_SSHOW_SUFFIX = [ 'ssr' ] - -# The number of blend steps between images, 0 to disable blending +# +# The number of blend steps between images +# 0 = Disable blending +# # IMAGEVIEWER_BLEND_STEPS = 10 - + +# # Total time in seconds for blending from one image to the next +# # IMAGEVIEWER_BLEND_TIME = 0.75 @@ -393,7 +412,7 @@ # website is at http://www.mame.net, but the version that is used here # is at http://x.mame.net since the regular MAME is for Windows. # -# SNES stands for Super Nintendo Entertainment System. Freevo relies +# SNES stands for Super Nintendo Entertainment System. Freevo relies # on other programs that are not included in Freevo to play these games. # # NEW GAMES SYSTEM : @@ -419,79 +438,103 @@ # ('GENERIC', '/usr/local/vba/VisualBoyAdvance', ' ', '', [ 'gba' ] )), # ('MEGADRIVE', '/home/media/games/megadrive/roms', # ('GENESIS', '/usr/local/bin/generator-svgalib', '', '', '' )) ] - +# # GAMES_ITEMS = None -# are used for the Mame arcade emulator. # -# GAMES_NICE = -20 # Priority of the game process. 0 is unchanged, - # <0 is higher prio, >0 lower prio. - # prio <0 has no effect unless run as root. - +# These settings are used for the MAME arcade emulator: +# + +# Priority of the game process +# 0 = Don't change the priority +# >0 - Lower priority +# <0 - Higher priority +# +# GAMES_NICE = -20 + +# +# MAME cache directory +# # GAMES_MAME_CACHE = '%s/romlist-%s.pickled' % (FREEVO_CACHEDIR, os.getuid()) # ====================================================================== -# freevo SKIN section: +# Freevo SKIN settings: # ====================================================================== # # Select a way when to switch to text view even if a image menu is there -# Possible values are -# 1. force text view when all items have the same image and there are no -# directories -# 2. Ignore the directories, always switch to text view when all images -# are the same +# +# 1 = Force text view when all items have the same image and there are no +# directories +# 2 = Ignore the directories, always switch to text view when all images +# are the same # # SKIN_FORCE_TEXTVIEW_STYLE = 1 # -# Force text view for the mediamenu (first menu for video, audio, images and -# games). +# Force text view for the media menu +# (The media menu is the first menu displayed for video, audio, images +# and games). # # SKIN_MEDIAMENU_FORCE_TEXTVIEW = 0 - # ====================================================================== -# freevo OSD section: +# Freevo OSD settings: # ====================================================================== # -# Sytem Path were to search for fonts not in the Freevo distribution +# System Path to search for fonts not included in the Freevo distribution # # OSD_EXTRA_FONT_PATH = [ '/usr/X11R6/lib/X11/fonts/truetype/' ] -# Font aliases, all names must be lowercase! -# All alternate fonts must be in './share/fonts/' +# +# Font aliases +# All names must be lowercase! All alternate fonts must be in './share/fonts/' +# # OSD_FONT_ALIASES = { 'arial_bold.ttf' : 'VeraBd.ttf' } +# +# Number of seconds to wait until the busy icon is shown in the menu. +# Busy icon can also be shown right away when there is more than a certain +# number of files in a directory. +# +# Set this to None to disable this. # (seconds, files) -# number seconds until the busy icon is shown in the menu. -# or show it right away when we know it takes some time (more than files number -# of files in a directory. Set this to None to disable this +# # OSD_BUSYICON_TIMER = (0.7, 200) -# OSD_SDL_EXEC_AFTER_STARTUP = "" # OSD_OVERSCAN_X = 0 # OSD_OVERSCAN_Y = 0 - -# Exec a script on the osd close. + +# +# Execute a script on OSD startup. +# +# OSD_SDL_EXEC_AFTER_STARTUP = "" + +# +# Execute a script on OSD close. +# # OSD_SDL_EXEC_AFTER_CLOSE = "" +# # Stop the osd before playing a movie with xine or mplayer. Some output # devices need this. After playback, the osd will be restored +# # OSD_STOP_WHEN_PLAYING = 0 +# # Dim text that doesn't fit instead of using ellipses. # OSD_DIM_TEXT = 1 # ====================================================================== -# Remote control section +# Freevo remote control settings: # ====================================================================== - # -# you need a lircrc file, like this: +# Location of the lircrc file +# +# For remote control support, Freevo needs a lircrc file, like this: # # begin # prog = freevo @@ -505,13 +548,19 @@ # LIRCRC = '/etc/freevo/lircrc' # -# Set the Joy device to 0 to disable, 1 for js0, 2 for js1, etc... -# Supports as many buttons as your controller has, -# but make sure there is a corresponding entry in JOY_CMDS. +# Joystick support +# 0 = Disable joystick support +# 1 = Use js0, +# 2 = Use js1, +# ... etc +# +# JOY_DEV = 0 + +# Freevo can support as many buttons as your controller has +# as long as there is a corresponding entry in JOY_CMDS. # You will also need to plugin.activate('joy'). # FYI: new kernels use /dev/input/jsX, but joy.py will fall back on /dev/jsX # -# JOY_DEV = 0 # JOY_CMDS = { # 'up' : 'UP', # 'down' : 'DOWN', @@ -524,21 +573,24 @@ # } - # ====================================================================== -# tvtime section: +# TVtime settings: # ====================================================================== +# +# Location of the TV time program +# Default: Use the value in freevo.conf +# # TVTIME_CMD = CONF.tvtime # ====================================================================== -# MPlayer section: +# MPlayer settings: # ====================================================================== # MPLAYER_AO_DEV = 'oss:/dev/dsp' # e.g.: oss,sdl,alsa, see mplayer docs -# MPLAYER_VO_DEV_OPTS = '' # e.g.: ':some_var=vcal' +# MPLAYER_VO_DEV_OPTS = '' # e.g.: ':some_var=vcal' # DVD_LANG_PREF = 'en,se,no' # Order of preferred languages on DVD. # DVD_SUBTITLE_PREF = '' # Order of preferred subtitles on DVD. @@ -552,7 +604,7 @@ # might try a software scaler. You can disable it later for some larger files # with the mplayer option '-nosws'. If you have -framedrop or -hardframedrop # as mplayer option, the software scaler will also not be used. -# A good value for this variable is +# A good value for this variable is: # MPLAYER_SOFTWARE_SCALER = "-subfont-text-scale 5 -fs -sws 2 -vf scale=%s:-3,"\ # "expand=%s:%s " % ( CONF.width, CONF.width, CONF.height ) # older versions of mplayer may need @@ -561,8 +613,8 @@ # MPLAYER_SOFTWARE_SCALER = '' # -# Mplayer args for the different kinds of files. Possible values are dvd, vcd, -# cd (audio cd), tv, all extentions and default if nothing matches +# Mplayer arguments for different media formats. (eg DVDs, CDs, AVI files, etc) +# Uses a default value if nothing else matches. # # MPLAYER_ARGS = { 'dvd' : '-cache 8192', # 'vcd' : '-cache 4096', @@ -576,30 +628,34 @@ # 'default': '-cache 5000' # } +# # Number of seconds before seek value times out. This is used when -# seeking to a specified number of minutes into a movie. If you make +# seeking a specified number of minutes into a movie. If you make # a mistake or change your mind, the seek value will timeout after -# this many seconds +# this many seconds. # # MPLAYER_SEEK_TIMEOUT = 8 -# Autocrop files when playing. This is usefull for files in 4:3 with black +# +# Autocrop files when playing. This is useful for files in 4:3 with black # bars on a 16:9 tv # # MPLAYER_AUTOCROP = 0 # # Try to set correct 'delay' and 'mc' values for mplayer based on the delay -# from mmpython. This should correct av sync problems with mplayer for some -# files, but may also break things (I don't know, that's why it's disabled -# as default). WARNING: when seeking, the playback is out of sync for some -# seconds! This only works with mmpython > 0.2 +# from mmpython. +# +# This should correct av sync problems with mplayer for some files, but +# may also break things. (I don't know, that's why it's disabled by default). +# WARNING: When seeking, the playback is out of sync for some seconds! +# This only works with mmpython > 0.2 # # MPLAYER_SET_AUDIO_DELAY = 0 # ====================================================================== -# Xine section: +# Xine settings: # ====================================================================== # You need xine-ui version greater 0.9.21 to use the all the features @@ -615,7 +671,7 @@ # ====================================================================== -# TV: +# Freevo TV settings: # ====================================================================== # @@ -629,8 +685,6 @@ # # XXX You must change this to fit your local conditions! # -# TV_SETTINGS = 'NORM INPUT CHANLIST DEVICE' -# # NORM: ntsc, pal, secam # INPUT: television, composite1 # CHANLIST: One of the following: @@ -639,8 +693,12 @@ # europe-east, italy, newzealand, australia, ireland, france, china-bcast, # southafrica, argentina, canada-cable # -# DEVICE: Usually /dev/video0, but might be /dev/video1 instead for multiple -# boards. +# TV_SETTINGS = 'NORM INPUT CHANLIST DEVICE' + +# +# Video input device +# +# Usually /dev/video0, but might be /dev/video1 instead for multiple boards. # # FreeBSD uses the Brooktree TV-card driver, not V4L. # @@ -648,15 +706,20 @@ # TV_DEVICE = '/dev/video0' # TV_INPUT = 0 +# # Additional options to pass to mplayer in TV mode. -# For example, TV_OPTS = '-vop pp=ci' would turn on deinterlacing. +# +# eg. To turn off deinterlacing: +# TV_OPTS = '-vop pp=ci' +# # TV_OPTS = '' # TV_SETTINGS = '%s television %s %s' % (CONF.tv, CONF.chanlist, TV_DEVICE) -# This is the size (in MB) of the timeshift buffer, ie: how long you can -# pause tv for. This is set to a low default because the default buffer -# location is under FREEVO_CACHEDIR and we don't want to blow /var or /tmp. +# +# Size (in MB) of the timeshift buffer. (ie: how long you can pause tv for.) +# This is set to a low default because the default buffer location is +# under FREEVO_CACHEDIR and we don't want to blow /var or /tmp. # TIMESHIFT_BUFFER_SIZE = 128 # TIMESHIFT_ENCODE_CMD = 'mp1e -m3 -c%s -p%s -r14,100' % \ @@ -864,7 +927,7 @@ # TV_CHANNELS = None - +# # Program to grab xmltv listings. To get a grabber, you need to download # xmltv. A possible value for users in the USA is tv_grab_na # Use the tv_grab helper to grab the listings and cache them. Start @@ -872,47 +935,56 @@ # XMLTV_GRABBER = '' +# # If you want to run tv_sort on your listings add the path to tv_sort here. # tv_sort will make sure all your programs have proper stop times, otherwise # programs might get cut off at midnight. - +# # XMLTV_SORT = '' +# # Number of days the grabber should get - +# # XMLTV_DAYS = 3 # ====================================================================== -# Builtin WWW server settings +# Freevo builtin WWW server settings: # ====================================================================== -# To activate the build in web server, please activate the www plugin -# in your local_conf.py: +# +# To activate the built in web server, uncomment the following line # # plugin.activate('www') # # Web server port number. 80 is the standard port, but is often # taken already by apache, and cannot be used unless the server -# runs as root. Use port 8080 as the default, change to 80 if +# runs as root. Port 8080 is the default, change to 80 if # needed. # # WWW_PORT = 8080 # # Username / Password combinations to login to the web interface. -# These should be overridden in local_conf.py # # WWW_USERS = { "user1" : "changeme", # "optional" : "changeme2" } # -# The tv guide is divided into 30 minute intervals +# +# Divide the TV guide into intervals of this length (in minutes) +# # WWW_GUIDE_INTERVAL = 30 -# WWW_GUIDE_PRECISION = 5 # 5 minutes precision +# +# Precision for TV guide (in minutes) +# +# WWW_GUIDE_PRECISION = 5 # + +# # Show this many blocks at once +# # WWW_GUIDE_COLS = 6 # WWW_STYLESHEET = 'styles/main.css' @@ -920,9 +992,6 @@ # WWW_JAVASCRIPT = 'scripts/display_prog-head.js' - - - # ====================================================================== # Internal stuff, you shouldn't change anything here unless you know # what you are doing