Dear Wiki user, You have subscribed to a wiki page or wiki category on "Freevo Wiki" for change notification.
The following page has been changed by 212.187.72.55: http://freevo.sourceforge.net/cgi-bin/moin.cgi/DocumentationPage The comment on the change is: return content ------------------------------------------------------------------------------ @@ -1 +1,583 @@ -Deleted Spam +'''Subpages to this page''' +Since the main DocumentationPage (which you are reading now) has been growing to an unmanageble size over time some sections have moved to separate SubPage''''''s: +[[PageList(DocumentationPage/.*)]] + +'''Local index for this page only''' +[[TableOfContents]] + + += Introduction = + +Freevo is an open-source digital video jukebox (PVR, DVR) based on Linux in addition to a number of open-source audio/video tools. [http://www.mplayerhq.hu MPlayer] is used to play audio and video files. MPlayer is an excellent media player that can play most popular file formats. Freevo can be used both for a standalone PVR computer with a TV+remote, as well as on a regular desktop computer using the monitor and keyboard. + +Freevo is easy to download and install for new users. Most hardware is supported (graphic boards, sound cards and video capture devices). + +The Freevo core is under heavy development. It is mostly written in the [http://www.python.org Python] programming language which is very well suited for high-level control applications like Freevo. + += Installation = + +As of Freevo version 1.4, please see [http://freevo.sourceforge.net/install.html Installation page] for details on downloading a distribution specific package for several distributions, or how to perform a quick install of the binary (tar.gz) version of the freevo package. + +Freevo may be installed via apt-get on some distributions. See AptGet for more info. + +== Developmental Snapshot == + +If you are interested in trying out new development snapshots get them at http://freevo.sourceforge.net/snapshots/ + +== Quick Install == + +Consider getting the "quick install version" of Freevo. This needs only the main freevo package, and a runtime that contains everything needed to run Freevo (except m-player for legal reasons). + +An automated script is available for downloading freevo and the runtime package and installing it on your system. + {{{ +lynx http://freevo.sf.net/install.sh -dump | bash }}} + +You will still need to download and install mplayer and/or xine on your own. + +=== Manual Quick Installation === + +Make sure you have downloaded the freevo package as well as the runtime package. + + * Un-tar somewhere. /usr/local is the recommended place for a "quick install" installation, but it will run from anywhere, e.g. /tmp + {{{ +cd tmp +tar xvzf freevo-1.4.tar.gz +cd freevo-1.4 +./freevo install $PATH-TO-FREEVO-RUNTIME.tar.gz }}} + + Replace the file names in the example with the current versions. + + * Run ./freevo setup in the Freevo directory. This will create /etc/freevo/freevo.conf which contains settings for your system such as screen size, video devices, etc. The default configuration is screensize 800x600, NTSC video input/output. + + * Copy local_conf.py.example to /etc/freevo and update local_conf.py to suit your system. The settings that are in local_conf.py will override defaults in freevo_config.py. Note: Do not edit freevo_config.py. Please see the later sections in this document for more details on the config files. + + * Run Freevo: + {{{./freevo }}} + + * A version of MPlayer is no longer included in the freevo. You will need to install your own version. It is available at http://www.mplayerhq.hu + +=== Gentoo Ebuild update (quick..) === + +A quick hack on the install script method.. + {{{ +lynx http://freevo.sourceforge.net/gentoo/rsync-freevo -dump | bash }}} + +And you have 1.4.1 available. + +== Configuration == + +=== General Setup === + +moved to new wiki: http://freevo.sourceforge.net/cgi-bin/doc/Configuration + + +===== Mounting USB devices ===== + +There is some confusion on its current state. +Check the plugins usb and usbstorage. + +*note, you will need to set your OWN automount. I recoment hotplug for now. freevo 1.5 no longer mounts the device that usbstorage specifies, instead you need to have an automounter mount it and usbstorage should update the menu with the dir name. + +Yes, this is the 2.4 kernel way of doing things, hopefully for the next major release freevo will just sense a block device and mount it. + +===== Mounting remote fs's ===== + +A relative simple way to automount remote file systems is to use autofs. After install +use the following config files. +{{{ +cat /etc/autofs/auto.master +# $Id: auto.master,v 1.1 2000/08/08 17:53:33 achim Exp $ +# Sample auto.master file # Format of this file: +# mountpoint map options +# For details of the format look at autofs(8). +/smbnet /etc/autofs/auto.smbnet --timeout=30 + +cat /etc/autofs/auto.smbnet +# $Id: auto.misc,v 1.2 2002/10/27 05:21:15 bcowan Exp $ +# This is an automounter map and it has the following format +# key [ -mount-options-separated-by-comma ] location +# Details may be found in the autofs(5) manpage +#boot -fstype=ext2 :/dev/hda1 +#cd -fstype=iso9660,ro :/dev/cdrom +#floppy -fstype=auto :/dev/fd0 +storage -fstype=smbfs,users,rw,username=someuser,password=somepass ://storage/Storage +camera -fstype=auto,nosuid,nodev,noexec,user,gid=100,umask=000 :/dev/sda1 +}}} + +An entry /smbnet should show up in / dir when autofs is started from init.d. To make sure autofs is started correctly +The output of 'ps ax | grep autofs' should be something like +{{{ +5410 ? S 0:00 /usr/sbin/automount --timeout 30 /smbnet file /etc/autofs/auto.smbnet +}}} + +cd to /smbnet/storage and it should automagicly mount the filesystem + +After this edit local.conf.py and add the following in the VIDEO_ITEMS section or another ITEMS section if thats on your share. +{{{ +VIDEO_ITEMS = [ ('Storage movies','storage:/smbnet/storage')] +}}} + +Notice the hostname xp or storage before the path, it tries to ping the hostname and when succesfull the entry shows up in the menu, if not succesfull it doesn't show up and the filesystem isn't mounted. + + +=== TV setup === + +Moved to new Wiki at [http://freevo.sourceforge.net/cgi-bin/doc/TVSetup] + +=== Web Server === + +==== Version 1.4.x ==== + +'''DXR3 users must use the webserver in either inittab or boot scripts. it will not work for them in plugin mode. ''' + +'''Setup for webserver''' + +edit WWW_USERS in local_conf.py + +provide yourself with a username and password. + +edit WWW_PORT + +if you would like not to have to remember to put the port number in +the URL you can change the number to 80 here, if you have NO other +webserver on this machine on that port and you run the process +starting the server as root (inittab and init script are root, plugin +may not be). + +to check for another webserver: + +# netstat -ln + +look in the fourth column if any entry has 0.0.0.0:80 than there is +already a webserver running there. + +'''How to Run webserver''' + +There are three ways to run the webserver. Through init using a +startup script, through inittab using an entry in its file or as a +plugin. It should be noted the developer's use the inittab and +startup script methods. There is an occasional bug where by you can +see the screen flash and you lose the freevo main interface. It +doesn't happen to everyone so it is a bit of a mystery. + +''to use inittab:'' + +add these two lines to your /etc/inittab file: +{{{ +FV1:2345:respawn:/usr/local/freevo/boot/recordserver_init +FV2:2345:respawn:/usr/local/freevo/boot/webserver_init +}}} + +''to use init scripts:'' + +for debian: +{{{ +cp /usr/local/freevo/boot/recordserver /etc/init.d/freevo_recordserver +cp /usr/local/freevo/boot/webserver /etc/init.d/freevo_webserver +update-rc.d freevo_recordserver defaults 99 00 +update-rc.d freevo_webserver defaults 99 00 +}}} + +for redhat + mandrake: +{{{ +cp /usr/local/freevo/boot/boot_config /etc/freevo +cp /usr/local/freevo/boot/recordserver /etc/init.d/freevo_recordserver +cp /usr/local/freevo/boot/webserver /etc/init.d/freevo_webserver +chkconfig --add freevo_recordserver +chkconfig --add freevo_webserver +}}} + +gentoo: +{{{ +cp /usr/local/freevo/boot/gentoo-freevo /etc/init.d/freevo +cp /usr/local/freevo/boot/gentoo-conf.d /etc/conf.d/freevo +rc-update add freevo default +edit /etc/conf.d/freevo and set recordserver and webserver to yes +}}} + +''To activate the plugin:'' + +unfortuneately you still have to have record server use either the +inittab or init startup script, but for the webserver you can add +this to your local_conf.py: + +{{{ +plugin.activate('www') +}}} + +'''NOTE: you should also setup your record_server record method. +This is covered in the next section.''' + +==== Version 1.5.x ==== + +Things have changes slightly... + +To start the webserver manually: + +freevo webserver start + +To stop the webserver manually: + +freevo webserver stop + + +=== Recording Server === + +==== Version 1.4.x ==== + +If you are using Freevo 1.4 or greater then you need to be running record_server.py instead of using record_daemon.py from cron, please see below. + +If you will be recording with record_daemon.py (Freevo version 1.3.4 or older), you will need to a single cron job. This cronjob should call '<path>/freevo execute src/tv/record_daemon.py' as often as you want. Most people run this every minute of every hour, but some run only every five. That's your call-- will you miss a record command on every five? + Sample cron entry: +{{{ + # Every minute + * * * * * /usr/local/freevo/freevo execute src/tv/record_daemon.py + # Every 5 minutes instead (remove #) + #*/5 * * * * /usr/local/freevo/freevo execute src/tv/record_daemon.py +}}} + +{{{ + NOTE: + Many people have library path errors with the record_daemon.py. You should log + the output of your cronjob or watch the local mail for this account carefully + for the first few days and make sure it is working. + The error is something like: + sh: /lib/ld-linux.so.2: version `GLIBC_PRIVATE' not found + (required by ./runtime/dll/libc.so.6) + + The fix is to edit freevo/src/tv/record_daemon.py and add the second line as seen below: + import os + os.environ['LD_PRELOAD'] = '' # Add this line to stop GLIBC_2.X preload errors + +}}} + +If you are using Freevo 1.4 or greater then you need to be running record_server.py instead of using record_daemon.py from cron. + +record_server.py is a completly new interface for TV recording. This is a standalone persistant process that runs seperately from the main Freevo preocess that you see on your TV or monitor. Record server listens on the network for client connections and will communicate to a client using XML-RPC. + +Please make sure that your XMLTV data is displaying correctly in the Freevo program guide before attempting to run the record server. This will save you problems in case there is something wrong with epg_xmltv.py or your XMLTV data. Since record_server.py must run outside of the main Freevo process you should use one of the scripts in the boot/ directory to help start it. The record_server scripts here need you to have the boot_config file placed in your /etc/freevo/ directory and edited to suit your system. The record_server script is an rc style start/stop script and can be placed in your /etc/init.d/ directory (or equivalent) but must be set to start/stop at the proper runlevels. That is outside the scope of this document. The record_server_init script is designed to run from the init process using your /etc/inittab file. There are instructions for doing this at the top of the record_server_init file. + +If you are not using the Freevo binary runtime and instead installed all of the Freevo dependancies yourself, make sure you have Twisted (http://www.twistedmatrix.com) installed as well. + +'''Record server configuration:''' + +You must chose a recording plugin. The default plugin is generic_record and if you are using mencoder or any other external command to do your recording then this is the plugin for you. If, on the other hand, you are using a Hauppage WinTV PVR-250/350 then you can activate the ivtv_record plugin and it will do the recording work for you. Before using this card in Freevo please make sure that it is working properly and you have no driver problems. See http://ivtv.sourceforge.net for details. + +The recording server looks for a few items in your config: TV_RECORD_DIR, TV_RECORD_SCHEDULE, TV_RECORD_SERVER_IP, TV_RECORD_SERVER_PORT and TV_RECORD_PADDING. Please see freevo_config.py for details. Please be aware that record_server.py is a network application and your Freevo machine should not have wide open access from the internet without a firewall limiting what ports outsiders can connect to. + +If you are using the generic_record plugin (default) then you must have VCR_CMD configured to your liking. There is an example of this in freevo_config.py as well. + +In order to use the ivtv recording plugin have the following in your local_conf.py: + +{{{ +plugin.remove('tv.generic_record') +plugin_record = plugin.activate('tv.ivtv_record') +}}} + +Also for ivtv_record you may set some recording options: + +{{{ +IVTV_OPTIONS = { + 'input' : 4, + 'resolution' : '720x480', + 'aspect' : 2, + 'audio_bitmask' : 233, + 'bframes' : 3, + 'bitrate_mode' : 1, + 'bitrate' : 4000000, + 'bitrate_peak' : 4000000, + 'dnr_mode' : 0, + 'dnr_spatial' : 0, + 'dnr_temporal' : 0, + 'dnr_type' : 0, + 'framerate' : 0, + 'framespergop' : 15, + 'gop_closure' : 1, + 'pulldown' : 0, + 'stream_type' : 10, +} + +# Please see freevo_config.py for details. +}}} + +Once configured, and you would like to test the recording server, simply run ./freevo recordserver - also you may use the scripts in the boot directory. Some of the stop functions are currently broken because helper scripts don't seem to save a pid file for their process... this will be fixed soon. Remember, the boot scripts rely on the boot_config file being in /etc/freevo/ and modified for your system. Once it is running you will have a log, either in /var/log/freevo or /tmp/freevo, called internal-record_server-0.log (0 is the uid of the user running it, 'root' in this case). The web interface or the main Freevo interface will let you know if the recording server is down. It will need to be running in order to schedule and record shows. + +==== Version 1.5.x ==== + +Things have changes slightly... + +To start the record server manually: + +freevo recordserver start + +To stop the record server manually: + +freevo recordserver stop + +===== Configuring ===== + +Recordserver now supports padding. Padding will 'pad' your recordings begining and end. If there is contention, the recording due to start will start, minus the padding amount. Feel free to submit patches to enable better contention support. + +Padding defaults to 0, and is set in multiples of seconds. To set add the following to local_conf.py +{{{ +# equates to 3 minutes of padding at the start and end of the recording +TV_RECORD_PADDING = 3 * 60 +}}} + + + +[[Anchor(slideshows)]] +=== Image Slideshows === + +''How do you generate a slideshow file for a large number of files automatically?'' + +This little bit of bash code... +{{{ +echo "[Slides]" > blah.ssr; ls -B -I \*.ssr | +perl -ln -e 'print "FileName: \"$_\"; Caption: \"Image\"; Delay: \"5\";"' >> blah.ssr +}}} +(This shall be a single line. Note the ' before print, the ending one is just before >> blah.ssr) + +...will create a slideshow file, in the current directory, called blah.ssr that contains all files in the current directory EXCEPT *.ssr and *~ - if you do not desire this, remove the -B from the ls command. The delay is here set to 5 seconds, but you can change that number. To change the output file, just change the blah.ssr references to <what you want it to be called>.ssr - this will work fine. You can change the default caption, Image, to whatever you like, but be mindful of the quotemarks -- Lee Causier (SquareRoot) & mikeruelle + + +[[Anchor(lirc)]] +=== Remote control software (lirc) === + +moved to new wiki: http://freevo.sourceforge.net/cgi-bin/doc/Lirc + +=== TV-Out === + +Have a look on /SupportedHardware to find some information on how to set up graphic cards for TV-Out. +There are guides and tips for several models. + +A good resolution is 800x600 and common values are: + {{{ + HorizSync 30-50 + VertRefresh 60 +}}} + +Unfortunately with TV-Out there is often a black border around the picture, so that not the whole TV-screen is used. +A possible solution is 'overscan'. (There are special tools to set that up ) +You can set the picture to a size slightly bigger than the visible screen, and get rid of that black borders. +But then freevo's OSD might not fit into the visible part. + +To correct that effect you can use OSD_OVERSCAN_X and OSD_OVERSCAN_Y in "local_conf.py". You can shrink freevo's OSD to a size which fits perfectly into the visible part of your screen. Just play a little with that values until you have a satisfying result. + +If it is neccassary to call some programs or scripts for configuring the TV-Out, while freevo is already running, you can use OSD_SDL_EXEC_AFTER_STARTUP. +For example I need to call ''nvtv -t -r 800,600 -s Huge -S PAL'', to configure the TV-Out of my nvidia card. + +=== Recompiling the Linux kernel === + +This is only needed if your kernel is missing support for the videocard, capture card etc. + +Use this for configuration of a kernel with V''''''ideo4Linux+G400 support. You +probably have to add support for your particular V''''''ideo4Linux device as +well. + +Here is an example kernel config for Matrox G400 support: + + {{{ +Multimedia devices ---> + [Y] Video For Linux + Video For Linux ---> + [Y] V4L information in proc filesystem + +Console drivers ---> + [Y] VGA text console + [Y/M] MDA text console (dual-headed) + Frame-buffer support ---> + [Y] Support for frame buffer devices + [Y/M] Matrox acceleration + [Y] Millenium I/II support + [Y] Mystique support + [Y] G100/G200/G400/G450/G550 support + [Y/M] Matrox I2C support + [Y/M] G400 second head support + [Y] Multihead support +}}} + + +=== Booting into Freevo === + +There are several ways to do that... + +==== Approach A ==== + +Anand Patel has written a good webpage about booting Freevo in RH8: + + * [http://www.knet-work.co.uk/freevo-redhat8-guide.htm RH8 Freevo Boot] + +After freevo has been installed correctly and verified to work +when run from the command prompt, the system can be configured +for standalone operation where freevo will startup automatically +without the need for entering a username and password. Standalone +operation implies that the system will be somewhat 'insecure' as +freevo needs root priviledges for mplayer to access TV Capture +cards properly. + +'''(TBD: How to improve security settings)''' + +The following assumes that freevo will be running under X11, and +not in framebuffer mode, since X11 mode is more widely supported +by a variety of VGA display cards. The display type argument for +freevo's configure script should be either 'xv' or 'x11'. These +steps were tested on a Red Hat distribution of Linux. + +'''(TBD: TV-Out?)''' + +''Note'': The X11 window manager is started together with freevo due to +some interactions between mplayer and the freevo fullscreen menu +which may cause mplayer to hang when trying to access the screen if +the freevo menu cannot be windowed. + + 1. Create a new user account (let's use freevo for simplicity). + # adduser freevo + # passwd freevo + + 1. Create a new entry in /etc/sudoers using 'visudo' and add the following line into the file: + + freevo ALL=(ALL) NOPASSWD: /usr/local/bin/startfreevo + + 1. Create the following script 'startfreevo' in /usr/local/bin + + {{{ + # cd /usr/local/bin + # <your_favorite_editor> startfreevo + + ----------- startfreevo script contents ------------------ + #!/bin/sh + cd /usr/local/freevo; ./freevo + ----------- startfreevo script end ----------------------- + (This script assumes that the freevo directory is /usr/local/freevo) + + # chmod 755 /usr/local/bin/startfreevo + }}} + + 1. cd to the freevo home directory. + + {{{ + # cd ~freevo + + Create a .Xclients file in the freevo directory + + # <your_favorite_editor> .Xclients + + + ----------- .Xclients script contents ----------------- + sudo /usr/local/bin/startfreevo & + if [ -f /etc/X11/xinit/Xclients ]; then + [ -x /usr/bin/ssh-agent -a -z "$SSH_AGENT_PID" ] && \ + exec ssh-agent /etc/X11/xinit/Xclients || \ + exec /etc/X11/xinit/Xclients + fi + ----------- .Xclients script end ----------------------- + + # chmod 755 .Xclients; chown freevo.freevo .Xclients + }}} + + 1. The steps given in http://www.linuxgazette.com/issue52/tag/14.html to startup X11 automatically could be used to configure the system to boot into X11 on startup. + +see also ["RunningUnderX"] + +==== Approach B ==== + +moved to new wiki: http://freevo.sourceforge.net/cgi-bin/doc/BootFreevo + += Usage = + +Please see the /UsageInfo page for information on how Freevo is used. + += Supported Hardware = + +See the /SupportedHardware page. + += Skins = + +Please see the /SkinInfo for documentation on Freevo skin usage and development. + += Plugins = + +Read the config files in the freevo directory. There are explainations on how to add/remove plugins. (NOTE: Just about everything is a plugin now, so this is something you want to look at) + +Please see the /PluginInfo page for documentation on how to configure the different plugins and how to write your own plugins. + + += Extra File Information in XML metafiles = + +== Movie files == + +Please see the /UsageInfo for more info about this. + +=== Getting info from IMDB === + +==== This needs updating!! ==== + +You can use '''imdb.py''' in the helpers directory. Depeding on what version you have, it'll write a fxd (>1.3.2) or xml file which contains movie information and a jpg file which contains the movie cover to your harddisk. + +How to use imdb.py is a bit non obvious. Firstly you need to look for your movie, lets say we want to get the data for 'Romancing the Stone'. + +{{{ %imdb.py -s romancing +342943 Romancing Along (1937, Movie) +0114293 Romancing Sara (1995, Movie) +0088011 Romancing the Stone (1984, Movie) +0093056 Fu xing jia qi (1987, Movie) +0095404 Jing zhuong zhui nu zi zhi er (1988, Movie) +0098217 Lang zhi yi zu (1989, Movie) +}}} + +Now we can download the actual data into movies-data (you may need to add this directory) + +{{{ %imdb.py 0088011 movie-data/romance dvd +}}} + +Use '''imdb.py --help''' to see more options + +== Audio files == + += Troubleshooting = +== Logfiles == + +There is an option MPLAYER_DEBUG in freevo_config.py to turn on logging the MPlayer output to a logfile. +The logfiles are written in the directory freevo is started from, and they're named 'mplayer_stdout.log' and +'mplayer_stderr.log' + +Freevo also writes its own log files by default in /var/log/freevo. +To enable verbose logging in freevo and recordserver log files, add DEBUG=1 to your local_conf.py + +== Version 1.5.X == +When troubleshooting there are a few steps you need to follow to make your life reposting an issue, and our life trying to resolve the issue, easier. +=== Step 1 === +Add this line to local_conf.py +{{{ +DEBUG=1 +}}} +Then restart Freevo! + +This will turn on verbose output of most of the plugins. Warning: you'll get more info than you need, but more is better than less... +=== Step 2 === +Use the menu to do try whatever it is you are troubleshooting, then scroll through the log files for some information on what happens in the background. + +==== Recordserver ==== +Check the log file: +{{{ +/var/log/freevo/recorserver-0.log +}}} + +Try the command you find. Does it run? If so then maybe you have a persmissions issue. Freevo 1.5.X can be running as any user you specify and thus that user needs the permissions set for recording device access.. + +==== Other Stuff ==== +Playing music or movies, check the log file: +{{{ +/var/log/freevo/main-0.log +}}} + +As above, try the command freevo runs. Does it work? If so, try it as the freevo user. If not, there's your issue.. + +An example: sometimes DVDs ripped to DivX by mencoder cannot be played by freevo. They can be played by mplayer directly, however. Looking in local_conf.py we see that the "-idx" option is specified with mplayer when it runs .avi files. Normally this is unnecessary, because its purpose is to rebuild broken avi indexes and most avi files don't need this. Usually it does no harm, but with the mencoded files in question it causes a bunch of error messages and mplayer quits. The fix is simply to remove the "-idx" from the mplayer options in local_conf.py. + +=== Step 3 === +If you still can't find the cause of the issue, post a query to the mailing list. Please include the relevent settings in your local_conf.py *and* the relavent log file output. + += FAQ = +See FrequentlyAskedQuestions ------------------------------------------------------- SF email is sponsored by - The IT Product Guide Read honest & candid reviews on hundreds of IT Products from real users. Discover which products truly live up to the hype. Start reading now. http://productguide.itmanagersjournal.com/ _______________________________________________ Freevo-wikilog mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/freevo-wikilog
