source: npl/mediabox/camsource/camsource.conf.new @ 128fde4

<?xml version="1.0"?>
<!-- $Id: camsource.conf.example,v 1.56 2003/05/01 10:29:11 dfx Exp $ -->

<!--
        As there isn't any real documentation, this file is how to find out
        how to configure and use camsource. Most of it is module and filter
        config, but the first part (<camdev>) is crucial if you're having
        any kind of problems, so be sure you read it carefully.
-->

<camsourceconfig>

        <!-- Global config options -->
        <camdev>
                <!--
                        This section gives config options for the
                        camera device. It instructs the hardware to
                        grab the frames at a certain size, at a
                        certain frame rate and from a certain input
                        channel. Note that not all hardware supports
                        every frame size, and not all hardware supports
                        setting the frame rate (and if it does, not
                        all frame rates are supported either). You will
                        see a warning message if any of the settings here
                        are incorrect.
                        
                        - The "plugin" tag defines which module should be
                          used for this device entry. See below for
                          for the <module> entries for the input plugins.
                          Most of the other options given here are specific
                          to a certain plugin type and will be different
                          for other input plugins.
                        - Path defaults to /dev/video0.
                        - Width and height default to the maximum size
                          as reported by the driver. You can specify
                          "max" or "default" for the same effect,
                          or "min" for the minimum size.
                        - Fps and channel default to unchanged/not set.
                          You can specify "default" for the same effect.
                        - Norm can be "ntsc", "pal", "secam", or "auto".
                          If not specified, it is undefined which norm
                          will be used. Note that the norm setting will
                          only be used if a channel is specified as well.
                        - Brightness, hue, colour (note the spelling),
                          contrast and whiteness are unsigned 16-bit
                          integers (0-65535) which are passed verbatim to
                          the video4linux layer if specified. The meaning
                          of these fields is more or less driver-dependent,
                          feel free to play around with them. If not
                          specified or commented out, the default value
                          will be left unchanged. Not all values are
                          meaningful in all cases (for example 'whiteness'
                          is normally only used for grayscale images).
                -->
                
                <plugin>input_v4l</plugin>
                
                <path>/dev/video0</path>
                <width>max</width>
                <height>max</height>
                <fps>15</fps>
                <channel>0</channel>
                <norm>auto</norm>

                <!-- <brightness>32767</brightness> -->
                <!-- <hue>32767</hue> -->
                <!-- <colour>32767</colour> -->
                <!-- <contrast>32767</contrast> -->
                <!-- <whiteness>32767</whiteness> -->

                <!--
                        The "autobrightness" setting controls a special algorithm
                        within camsource to dynamically adjust the camera's
                        brightness level. The value specifies the desired average
                        brightness of the output images, in the range 0 through
                        about 85. Values around 35 seem to produce good results.
                -->
                <!-- <autobrightness>35</autobrightness> -->
                
                <!--
                        You can define a command to be run when something or
                        someone is requesting frames from this device. The first
                        time a frame is requested, the program will get a 'start'
                        event. The 'end' event will be fired after there has been
                        no request for a frame for a certain time period, which
                        you can specify with the <cmdtimeout> tag, in seconds.
                        Note that the command will be run asynchronously in the
                        background. Also note that these two tags are not
                        specific to a certain input plugin, but can be used with
                        every input plugin universally.
                        The command gets the following arguments:
                        - Event type, either 'start' or 'end'.
                        - Camdev device name, either "default" or whatever name
                          you gave it.
                        - The name of the /dev/videoX device file.
                -->
                <!-- <cmd>~/bin/grabevent.sh</cmd>
                <cmdtimeout>5</cmdtimeout> -->
                
                <!--
                        Filters specified here will be applied to every framed grabbed
                        by this device. More information about filters and filter
                        modules can be found below. There is also a section with filters
                        to apply to every frame, independent of device.
                        
                        This flip filter is here because my webcam produces mirrored
                        images. If yours doesn't do this, you should probably remove this
                        filter.
                -->
                <!--
                <filter name="flip">
                        <horiz>yes</horiz>
                        <vert>no</vert>
                </filter>
                -->
        </camdev>
        
        <!--
                It is possible to have more than one input device active
                at the same time. Below is an example for how to grab
                from a second v4l device. The specified "name" attribute
                is used to uniquely identify this device; no two <camdev>
                sections can have the same name. The name defaults to
                "default". Use this name in the module configs to specify
                which device to grab images from. See the http module and
                one of the wc_serv module definitions below for examples.
                
                This example makes use of the "active" attribute of the
                <camdev> tag. If not specified, it defaults to "yes", for
                backwards compatibility.
        -->
        <camdev name="second" active="no">
                <plugin>input_v4l</plugin>
                <path>/dev/video1</path>
                <width>max</width>
                <height>max</height>
        </camdev>
        
        <!--
                This input plugin uses the "xwd" program to make screenshots
                of a local or remote x11 desktop, and uses those images
                as input to camsource. Currently this plugin only supports
                xwd dumps with 24 or 32 bits per pixel.
        -->
        <camdev name="xwd" active="no">
                <plugin>input_xwd</plugin>
                <command>DISPLAY=:0 /usr/X11R6/bin/xwd -root -silent</command>
        </camdev>
        
        
        
        
        
        
        
        <!--
                If no logfile is given (or tag is empty), camsource
                will log to stdout only and not go into background.
                The prefix "~/" has the usual meaning.
        -->
        <logfile>~/.camsource.log</logfile>
        
        <!--
                Available modules. A module will only be loaded
                if its "active" attribute is set to "yes", or if
                it's a dependency of another module. In any case,
                any module config given here is used.
        -->
        
        
        
        
        
        

        <!-- This is the default video4linux input plugin. It has no
             global config options. --> 
        <module name="input_v4l" active="yes"/>
        
        <!-- This is the xwd input plugin referenced above. -->
        <module name="input_xwd" active="no"/>
        
        
        
        
        
        
        
        <module name="wc_serv" active="no">
                <port>8888</port>

                <!--
                        Per-module filter. Works exactly the same as
                        the global filters, only that the per-module
                        filters are called from within the module's
                        worker thread.
                        The resize filter can either take a <height>
                        and a <width> option, to resize the image
                        to a fixed size, or a <scale> option to
                        resize the image to a certain percentage of
                        the original size.
                -->
                <filter name="resize">
                        <scale>50</scale>
                </filter>
                
                <!--
                        Another filter. But where is its config? The
                        "text" module supports having and using a global
                        config, specified in its <module> section. Any
                        config options that are missing in the <filter>
                        definition will be used from that global config,
                        and those options that are specified here will
                        override the global ones. See below for an
                        example for this overriding.
                -->
                <filter name="text"/>
        </module>
        
        <!--
                A second incarnation of the "wc_serv" module. It is
                possible to run the same worker module multiple times,
                each incarnation in its own thread. Each instance
                must have a unique name (the "alias" attribute). If
                no alias name is given, the actual module name is
                used as alias name. The actual module will always
                be loaded exactly once, if at least one of the aliased
                modules have "active" set to "yes". A module that is
                not active won't be run. A running worker module
                will receive a context pointer to the correct config
                to use, so it's possible to use the same module with
                different parameters/filters.
        -->
        <module name="wc_serv" alias="noresizewc" active="no">
                <port>8889</port>
                
                <!--
                        Here's the example for option overriding in the
                        text module. This filter will work the same as
                        the above text filter, only that the text will
                        be located in the top right corner. (Which doesn't
                        make much sense, but hey, it's just an exmaple.)
                        For a full description of all config options to
                        the text module, see below in its <module> section.
                -->
                <filter name="text">
                        <pos>tr</pos>
                </filter>
        </module>
        
        <module name="wc_serv" alias="seconddev" active="no">
                <!--
                        This instance of wc_serv would grab images not
                        from the "default" device, but from another.
                        The <grabdev> tag can be used universally.
                -->
                <grabdev>second</grabdev>
                <port>8890</port>
        </module>
        
        <!--
                The http module. It lets you create virtual paths to
                serve various variants of the current image. The main
                section includes global config options (such as the
                port to listen on), and can also include filter definitions.
                Those global filters will be applied to every image
                served.
                In the main section, there should be one or more <vpath>
                sections. Each of these sections describes another
                variation of the image, with different properties,
                using different filters. When requesting a certain vpath
                from the http server, you can append a query string
                to the patch, which will be stripped and ignored when
                looking for the matching vpath. For example, you can
                put "http://somehost/pic?dummy=123" into your browser,
                and it will display the image with the "/pic" vpath
                setting.
                If you want to specify a custom jpeg compression quality
                with a <jpegqual> tag, you must specify it within
                the <vpath> definitions. There is no global config
                tag for this.
                Each vpath definition should contain one or more <path>
                tags, each of which can be used to access this image
                variant (those paths can be thought of as aliases).
                If a vpath section include an <fps> tag, the image
                will be served as multipart-jpeg stream, usable for
                plugin- and applet-less streaming on netscape/mozilla
                browsers. Without fps specification, only a single
                image will be served.
        -->
        <module name="http" active="yes">
                <port>9192</port>
                
                <vpath>
                        <path>/</path>
                        <path>/small</path>
                        
                        <filter name="resize">
                                <scale>50</scale>
                        </filter>

                        <filter name="text"/>
                </vpath>

                <vpath>
                        <path>/big</path>
                        <path>/large</path>
                        <filter name="text"/>
                </vpath>

                <vpath>
                        <path>/largequal</path>
                        <filter name="text"/>
                        <jpegqual>80</jpegqual>
                </vpath>
                
                <vpath>
                        <path>/multipart</path>
                        <fps>2</fps>
                        <filter name="resize">
                                <scale>50</scale>
                        </filter>

                        <filter name="text"/>
                </vpath>

                <vpath>
                        <path>/multipart-large</path>
                        <fps>1</fps>
                        <filter name="text"/>
                </vpath>
                
                <!-- This example also shows how to deactivate
                     one vpath -->
                <vpath active="no">
                        <!-- You can use the <grabdev> tag here too -->
                        <grabdev>second</grabdev>
                        <path>/othercam</path>
                </vpath>
                
                <vpath active="no">
                        <grabdev>xwd</grabdev>
                        <path>/screenshot</path>
                        <jpegqual>40</jpegqual>
                        <!-- Can only be viewed if the correct login and password is given -->
                        <auth>screen:shot</auth>
                </vpath>

                <vpath active="no">
                        <grabdev>xwd</grabdev>
                        <path>/smallshot</path>
                        <jpegqual>40</jpegqual>
                        <auth>screen:shot</auth>
                        <filter name="resize">
                                <scale>50</scale>
                        </filter>
                </vpath>
                
                <vpath active="yes">
                        <!--
                                You can make the http module serve raw
                                image data instead of jpegs with the
                                <raw> tag. If enabled, the returned data
                                will be X*Y*3 bytes of rgb data. The http
                                headers will include the size of the image
                                (X and Y). There's an example of how to use
                                this data included with the camsource
                                distribution as scripts/camsource2bmp.pl.
                        -->
                        <path>/raw</path>
                        <raw>yes</raw>
                </vpath>
        </module>
        
        <!--
                The "filewrite" module does what its name suggests: it
                writes files. More specifically, it writes a snapshot
                jpeg periodically to a certain file location. The write
                happens in a "safe" fashion, meaning the image will
                first be written to a temporary file, and then moved
                over the real destination file.
        -->
        <module name="filewrite" active="no">
                <!--
                        Supported options:
                        
                        - path: Destination filename. The prefix "~/" has
                          the usual meaning. The filename is passed to
                          strftime(), so you can include a timestamp in
                          the filename. Check your strftime man page for
                          a list of % substitutions you can do.
                        - interval: Delay between writing snapshot files.
                          This tag can take an attribute "unit" which
                          can be one of "sec", "min", "hour" or "day".
                          Default is "sec". The meaning should be obvious.
                          If you put a negative value for interval (such
                          as -1), the module will write a snapshot file
                          once, then sleep a few seconds (allowing other
                          threads to complete), and then force camsource
                          to exit. Use this feature with care.
                        - chmod: Unix file mode to give the new file, in
                          octal numeric notation. Don't forget the leading
                          zero. If not specified, no chmod will be done
                          (meaning the file will have mode 0666 minus umask).
                        - cmd: Optional command to execute when the
                          snapshot is created. The command will get the
                          filename as its first argument. Note that
                          the command will be run on the temporary
                          file, before it is moved to the final location,
                          but after the chmod is done.
                          If the command (shell script) deletes the file,
                          the moving step will be skipped. Note the
                          the value of this tag is executed literally
                          and not passed to a shell to interpret. The
                          stdout and stderr fds will be redirected
                          to the logfile. If you need to have anything
                          fancy for a command, make a shell script.
                        - Of course you can add filters here too.
                        - And, like with all worker modules, you can
                          have multiple instances/aliases of it too,
                          each with different configurations.
                -->
                <path>/usr/local/apache/htdocs/camera.jpg</path>
                <interval unit="sec">30</interval>
                <chmod>0644</chmod>
                <!-- <cmd>~/bin/snapshot.sh</cmd> -->
                <jpegqual>75</jpegqual>
                <!-- For a description of the <jpegqual> tag, see
                        the jpeg_comp module entry -->
                
                <!--
                        A simple motion detection filter (not active by
                        default), which simply swallows the frame if
                        no motion was detected, making the receiving
                        module wait for a more interesting picture.
                        Useful for filewrite of ftpup uses, and not so
                        useful for live viewing modules.
                        
                        "Pixeldiff" is the value which is used to decide
                        whether one pixel of the new image is different
                        from the same pixel of the previous image. The
                        value is a tolerance value in percent. 0 means
                        the pixel will only be considered equal if it
                        is indeed exactly equal, otherwise it will be
                        considered different. 100 means the pixel will
                        always be considered equal. Raise this value if
                        your camera produces a lot of noise.
                        
                        "Minthres" and "maxthres" specify how many
                        percent of the pixels of the image must be
                        different to trigger the motion detection. If
                        the percentage is outside this range, the
                        detection won't trigger. There's an upper limit
                        to tag massive image changes (such as the light
                        being switched on or off) as uninteresting.
                        Raise maxthres to 100 to disable this behavior.
                        
                        If no motion is detected, the filter will wait
                        "delay" milliseconds (1/1000 seconds) before
                        grabbing another image and checking it for
                        motion.
                -->
                <filter name="motiondetect">
                        <pixeldiff>10.0</pixeldiff>
                        <minthres>0.1</minthres>
                        <maxthres>45.0</maxthres>
                        <delay>1000</delay>
                </filter>
                
                <filter name="text"/>
        </module>
        
        <module name="ftpup" active="no">
                <!--
                        Ftpup works like the filewrite module, only that
                        it doesn't save a file locally, but uploads it
                        to a site via ftp. Supported options are:
                        - host: Host to connect to. Can be either in
                          dotted ip notation or a hostname.
                        - port: optional, defaults to 21.
                        - username & password: Login information. If
                          not specified, anonymous login will be done.
                          Alternate spellings are "user" and "pass".
                        - dir: Path for the destination file,
                          excluding the actual filename. The module
                          will do the inital chdir to this dir. This
                          can be an absolute or relative pathname. If
                          not specified, the file will be put into
                          whatever dir is the current dir after login.
                        - file: Destination filename. As in the filewrite
                          module, you can put % format specifiers here,
                          which will be interpreted by strftime().
                        - passive: A yes/no option, whether to use
                          passive or active mode. Defaults to active
                          mode ("no").
                        - safemode: Another yes/no option. If set to
                          yes, a "safe" file write will be done,
                          meaning the snapshot will first be uploaded
                          to a temporary file, which will then be
                          renamed to final destination file. Defaults
                          to "no". The ftp server must support the
                          renaming commands RNFR and RNTO.
                        - interval: Same as filewrite's interval.
                          Specifying a negative interval works here
                          too.
                -->
                <host>some.host.name</host>
                <port>21</port>
                <user>snapshot</user>
                <pass>snapup</pass>
                <dir>incoming</dir>
                <file>snapshot.jpg</file>
                <passive>no</passive>
                <safemode>yes</safemode>
                <interval unit="sec">30</interval>

                <jpegqual>75</jpegqual>
                
                <!--
                        The regrab filter (not active by default) takes the
                        grabbed image, throws it away, waits "delay"
                        milliseconds (1/1000 seconds) and then grabs
                        another image. It does this "times" times. After
                        that, the receiving thread finally gets an image
                        to use. This is useful to give the camera time to
                        do brightness auto-adjusting before actually using
                        the grabbed image.
                -->
                <filter name="regrab">
                        <times>3</times>
                        <delay>1000</delay>
                </filter>
                
                <filter name="text"/>
        </module>
        
        <module name="vloopback" active="no">
                <!--
                        This module is able to act as an input channel
                        for the kernel video loopback device driver,
                        available from <http://tibit.org/video/>. This
                        lets you run camsource on your "real" video device
                        and at the same time other v4l programs on the
                        looped back device.
                -->
                <width>640</width>
                <height>480</height>
                <device>/dev/video1</device>
                
                <filter name="text"/>
        </module>
        
        
        
        
        
        

        <module name="jpeg_comp" active="yes">
                <!-- quality: default compression quality, 1-100.
                        If not specified, defaults to 75. -->
                <quality>40</quality>
                <!--
                        The modules which use jpeg_comp may pass a pointer
                        to an xml tree to it, which can include a <jpegqual>
                        tag. This tag, if present, specifies a quality
                        override. Usually you can put this tag into the
                        main <module> config section.
                -->
        </module>
        
        
        
        
        
        
        
        <!--
                The following two modules are filters which are described
                elsewhere. The flip filter by default is applied to all
                images, see its <filter> tag near the bottom of this
                file. The resize filter is applied to certain worker
                module/configurations, see there for a description.
        -->
        <module name="flip" active="yes"/>
        <module name="resize" active="yes"/>
        
        <module name="text" active="yes">
                <!--
                        Options to this filter module:
                        - text: Text to display. Duh. Mandatory option.
                          The text here is passed into the strftime()
                          function, so the usual % substitutions are
                          performed. Check the strftime man page for
                          details.
                        - cmd and file: Ok, so I lied about "text" being
                          mandatory. You must specify at least one of
                          text, cmd or file. "cmd" is the name of a
                          command to run, and the first line of its
                          output (on stdout) will be used as text.
                          Similarily, "file" is a file to open, and its
                          contents will be used as text. The "~/" prefix
                          works as expected. The % substitutions are
                          performed as with the "text" tag, unless you
                          specify the 'nosubst="yes"' attribute in the
                          tag. If more than one of these tags is specified,
                          the last specified will be used (useful for
                          setting a default <text> in the global section,
                          and then overriding it with a <cmd> or <file>
                          in a per-filter config).
                        - color: Text color, in html format. The leading
                          # sign is optional. No symbolic color names
                          are accepted. Defaults to white (ffffff).
                        - bgcolor: Same as color, only for the background
                          color. It can have the special value "trans"
                          to specify no background drawing (transparent),
                          which is also the default.
                        - pos: In which corner of the image to put the
                          text. It can be "tr" for top right corner,
                          "bl" for bottom left or any combination
                          thereof. Defaults to "bl".
                -->
                <text>[Syn-3] %b %d %Y %H:%M:%S</text>
                <color>ffffff</color>
                <bgcolor>trans</bgcolor>
                <pos>bl</pos>
        </module>
        
        <!-- This filter swaps the red and blue channels -->
        <module name="rgbbgr" active="no"/>
        
        <!--
                A filter capable of rotating the image right (90 degrees)
                or left (270 degrees). Rotating by 180 degrees is not
                supported, as the flip filter with both horiz and vert
                set to yes does exactly that. See below for an example
                config (filter disabled by default).
        -->
        <module name="rotate" active="no"/>
        
        <!-- This filter converts the image into bw (grayscale) -->
        <module name="bw" active="no"/>
        
        <!-- See the filewrite module config for a description of regrab -->
        <module name="motiondetect" active="no"/>
        
        <!-- See the ftpup module config for a description of regrab -->
        <module name="regrab" active="no"/>
        
        <!-- A simple invert filter -->
        <module name="invert" active="no"/>
        
        
        
        
        
        
        
        
        <!--
                Global filters to use. Any filter given here
                will be applied to every grabbed frame. If
                a given filter module is not loaded, the filter
                will be ignored silently. (TODO: is that a good idea?)
                Filters are always applied in order. You can
                give the same filter multiple times to apply
                it to the image several times.
                
                Global filters are applied first, then per-device
                filters (given in the <camdev> sections), then any
                possible per-module filters.
        -->
        
        <!-- Module not active by default -->
        <filter name="rgbbgr"/>
        
        <!--
                Ditto. If active, it would rotate the image right
                (= 90 degrees clockwise). The only other possible
                direction is "left".
        -->
        <filter name="rotate">
                <direction>right</direction>
        </filter>
        
        <!-- Also not active by default -->
        <filter name="bw"/>
        
        <!-- Ditto -->
        <filter name="invert"/>
        
</camsourceconfig>