readme

一个很棒的视频服务器

------------------------------
filters:  Probably one of the more interesting && useful sections of the 
          camserv configuration.  The filters section allows you to setup how
          the image should be processed before it is sent to the remote
          client.  The filters each get their chance to manipulate the image
          before sending it on to the next filter, so the order definitely
          matters.

Variables     num_filters  = The number of filters that are in the filters
                             section.  There should always be at least 1 filter
	                     (namely the jpg_filter), for changing the image
	                     from the internal RGB representation to the
                             jpg stream.
              filter#_section = Where # is anywhere from 0-> num_filters-1,
                                this designates which filter is to be applied
                                at which stage.  For instance:
		                  filter0_section     time_stamp
				Will look at the [time_stamp] section of the
                                configuration file for processing the image.
-------------------------------
main:    Provides information about how the main program should be run.  This
         affects the program as a whole

Variables      output_snapfile = A filename to output the image to.  If this
                                 option is specified, a picture will be taken,
                                 placed in this file, and then camserv will
                                 exit.
	       output_presnaps = A number of pictures to take before finally
                                 taking the 'snapfile' snapshot.  This only
                                 has any meaning when output_snapfile is
                                 given.
	       shm_alloc       = Amount of memory to allocate for shared 
                                 memory.  This defaults to the largest 
                                 potential memory that a picture may need when
                                 being processed, but if you feel that you
                                 can safely limit this, it is up to you.  
                         	 ** WARNING ** -- this is dangerous to change! 
------------------------------

==============================
MODULE INFORMATION && OPTIONS
==============================

The following are flags for the different modules and filters
that are distributed with the camserv package:


----------------
video_basic:  This module is mostly intended to give people who want to port
	      video modules for a given interface.  It currently just cycles
	      through some colours.

Variables     width   =  Width the video device should assume.
	      height  =  Height the video device should assume.


----------------
video_v4l:    This module is intended for use on Linux systems with the 
	      Video4Linux kernel options compiled in (and obviously some
	      imput device).  This module supports both color and B&W devices.

Variables:    device_path = Path to the device file to use for the camera.
	      width   =  Requested width from the video device (can change)
	      height  =  Requested height from the video device (can change)
              brightness, hue, color, contrast, whiteness: Params from 0->60000
	      port    =  Input port to take data from.  Often cards such as
	                 the bttv cards have multiple inputs such as RCA, etc.
	      frequency =  On cards with a tuner, this option will set the
	                   frequency that it is tuned to.
	      brightmean = When using autobright, this is the mean value of
			   a pixel that the camera attempts to attain.
	      brightx1,y1,x2,y2 = Coordinates of the region to gauge the
		                  brightness measurements.
	      autobright = Autobrightness adjustment variable.  A value of 0
			   disables the feature, else the value represents the
		           number of frames to wait in-between checking the
		           picture for brightness balance.  When the picture is
			   checked it will be brightneed or darkened depending
		           on the pixel values & the brightmean.
	      mode = Mode for the camera to use.  0 == PAL, 1 == NTSC, 
	             2 == SECAM, 3 == AUTO.
-----------------
video_fbsd_bttv:  This module is for people with cameras attached to BTTV
		  devices under FreeBSD.  	      

Variables:    device_path = Device path of the actual brooktree device.  
		            Defaults to /dev/bktr0.
	      tuner_path  = Path to the tuner device.  
			    Defaults to /dev/tuner0
	      width,height = Requested width & height of the camera pictures.
	      port        = Port number of the card input (0-4)
	      brightness  = Initial brightness of the camera.
	      chroma      = Initial chroma saturation axxion 
	      contrast    = Initial contrast of the device.
	      autobright  = If 0, this functionality will be disabled.  Else
		            it represents the number of frames until the 
		            brightness and the contrast will be auto-adjusted.
              channelset  = Channelset to use (nabscst=1, cableirc=2, 
	                    cablehrc=3, weurope=4, jpnbcst=5, jpncable=6,
	                    xussr=7, australia=8)
	      channel     = Channel # to view

-----------------
rand_filter:  A filter which should provide a basic example of how to do
	      filter programming.  This one will throw random dots all over
	      the picture.

Variables:    num_perline = Random modifier for how many pixels to put on each
	                    scanline
	      coloredpix  = 1 if colored pixels are to be used, else 0.

------------------
text_filter:  This filter will display text at arbitrary locations on the
	      picture.  

Variables:    bg = Backgound color for the text.  If B&W camera, then the 
	           value is #cc, with a hex value representing the 'blackness'
		   of the background.  If instead of #CC it is the string
	           transparent, the background will be transparent.
	      fg = Same as BG except for the foreground.
	      x,y= Pixel Coordinates to place the text bo.
	      mangle = 1 if the system should 'mangle' the text, else 0.
	      text = Text to display on the screen.  If mangle == 1, then the
		     text has special metacharacters "$X", etc which are 
		     replaced each time the filter is run.  Currently only a
	             few metachars are supported -- (from the date command)
		     (additionally $v == the current version of camserv)
	      fontname = Font to put the text in (either 6x11 or 8x8)

--------------------
jpg_filter:   Probably the most important filter, this one takes input of
	      either RGB or B&W values, and outputs a jpeg.  This is generally
	      the last filter in the chain.

Variable:     quality = A value from 0->100 representing the quality of the
	                jpeg

--------------------
imlib2_filter:  A preliminary test of this filter.  This filter will take an
	        image, import it and plaster it onto the output -- It will
	        respect the alpha values, so semi-transparency can be 
	        achieved.  Available by CVS from enlightenment.org.

Variables:	file = File of the image to import
	        x    = X location to place the image
		y    = Y location to place the image.

---------------------


======================
Getting Camserv
======================
Camserv is currently available from:
	http://cserv.sourceforge.net
			    

=======================
Bug reports & Additions
=======================

This is a work in progress!  If you have decided to make any new filters,
video input libraries, or modifications, please send patches to me for
inclusion into the program.  If you have any bugs, please also feel free to
send me an email.  [e-mail]
     


=======================
Mad Props:
=======================

Merc ([e-mail]) - 
	For testing of the installation and the B&W quickcam
	code.

Kaz Kylheku ([e-mail]) - 
	For not making me re-write hashing
	and linked list code for the 3 millionth time, and
	doing so in a free fashion.

Gary Lawrence Murphy  ([e-mail]) - 
	For providing lots of ideas for the overall product,
	patches for brightness modifications, and testing.

Joerg Henne ([e-mail]) - 
	For patches for non-NTSC inputs as well as resource management
	routines & single snapshot routines.

Andreas Wrede ([e-mail]) -
	For testing && patches for NetBSD/i386 (patches for multiple processes
        accessing multiple cards)

Scott Presnell ([e-mail]) -
	Mods for {Free,Net}BSD video server code to support tuning and
	channel sets.

Torsten Mueller ([e-mail]) -
	Javascript examples for IE users.

Barak Pearlmutter ([e-mail]) -
        Lots of code cleanups including YUV->RGB

Walter Haidinger ([e-mail]) -
        YUV->RGB as well as other patches