[Debconf-video-commits] r212 - package/trunk/doc

[benh at alioth.debian.org]

Author: benh
Date: 2008-08-07 20:07:07 +0000 (Thu, 07 Aug 2008)
New Revision: 212

Added:
   package/trunk/doc/README
Log:
A short introduction to the debconf-video scripts


Added: package/trunk/doc/README
===================================================================
--- package/trunk/doc/README	                        (rev 0)
+++ package/trunk/doc/README	2008-08-07 20:07:07 UTC (rev 212)
@@ -0,0 +1,95 @@
+A short introduction to the debconf-video scripts
+=================================================
+
+The scripts are variously written in bash and Python.  They all use
+the configuration file /etc/default/debconf-video which is a series
+of variable assignments in a subset of shell syntax.  (In Python
+this is parsed using the shellconfig module included in the package.)
+
+Configuration variables
+-----------------------
+
+General:
+
+FILE_BASE - base directory for file storage
+    Recordings go under $FILE_BASE/dv/<date>/<room>.
+    Transcoded files go under $FILE_BASE/<format>.
+
+Mixer host:
+
+SOURCES - list of sources for mixer to use
+    The format is ( "firewire:" <hostname> [ "/" <card-number> ] )+
+    The hostname specifies where the dvsource-firewire program will run.
+SINKS - list of sinks for mixer to use
+    The format is ( ( "file:" | "icecast:" ) <hostname> )+
+    The hostname specifies where the dvsink-* program will run.
+VENUE_NAME - venue name for metadata
+ROOM_NAME - room name in Pentabarf and for metadata
+    This must match the name of the room in the conference_room table.
+ICECAST_ADDR, ICECAST_PORT, ICECAST_PASS - Icecast server connection details
+VIDEO_STREAM_WIDTH, VIDEO_STREAM_HEIGHT, VIDEO_STREAM_KBPS,
+    AUDIO_STREAM_HZ, AUDIO_STREAM_KBPS - stream encoding parameters
+
+Storage host:
+
+DATABASE_DSN, DATABASE_USER, DATABASE_PASSWORD
+    - database server connection details
+    The format of $DATABASE_DSN is <hostname> ":" <database>
+DATABASE_USER - Pentabarf database username
+DATABASE_PASSWORD - Pentabarf database password
+CONFERENCE_NAME - conference name in Pentabarf
+    This must match the name of the conference in the conference table.
+ENCODING_HOSTS - hosts to use for transcoding
+    The format is ( <hostname> [ "*" <nproc> ] )+
+    <nproc> is the number of processes to start on that host; the
+    default is 2.
+
+No debconf-video configuration is required on the sink, source or
+encoding hosts since they are controlled via ssh.
+
+dc-record-stream
+----------------
+
+Start dvswitch followed by the configured sinks and sources (using
+dc-start-sink and dc-start-source).
+
+Use this on the mixer host.
+
+dc-start-sink, dc-start-source
+------------------------------
+
+Start a single sink/source specified as its argument.  These
+require ssh access (without interaction) to the hosts where the
+sink and source programs will run.
+
+dc-import-recordings
+--------------------
+
+Compare the set of files matching $FILE_BASE/dv/*/*/*.dv with the set
+of recordings listed in the database.  Add records for all files that
+are not yet listed and aren't currently being written.  If the
+'--delete' option is used, delete records referring to files that no
+longer exist.
+
+Use this on the storage host.
+
+dc-do-transcoding
+-----------------
+
+For each event-recording association and each target format, transcode
+the appropriate part of the recording into the target format.  Use the
+configured encoding hosts and numbers of processes.  Record all
+completed target files in the database.
+
+Use this on the storage host.  This runs continuously until
+interrupted.  It should normally be run overnight.  Currently it has
+no way to kill processes on the encoding hosts when interrupted so you
+will need to do that yourself.
+
+dc-make-rss
+-----------
+
+Print an RSS 2.0 / Media RSS document listing the published files in
+'low' target format.
+
+Use this on the storage host (?).