README

   1 SN9C20x USB 2.0 Webcam Driver
   2 ==============================
   3
   4 This driver is essentially a fork of the Syntek Webcam drivers for Linux
   5 by Nicolas Vivien, specifically to accomodate SN9C20x chipset based Webcams.
   6
   7 The driver currently supports the latest version of Video For Linux i.e
   8 V4L2. V4L1 is deprecated, and applications like Camorama that use only V4L1 will
   9 only work with libv4l ("v4l1compat.so").
  10
  11 This driver currently supports Skype v2.x, Ekiga v2.x & even aMSN
  12
  13 Warning :
  14 The SN9C20x USB 2.0 Webcam Driver for SN9C20x chipset based Webcams is
  15 currently under development. Using this driver can result in damage and data
  16 loss to your system. Use this driver only if you know what you are doing.
  17 --------------------------------------------------------------------------------
  18
  19 Table of contents :
  20
  21 1. Requirements
  22  1.1 Kernel module
  23  1.2 Documentation
  24  1.3 Decoder
  25
  26 2. Available Packages
  27
  28 3. Compilation
  29  3.1 Kernel module
  30  3.2 Documentation
  31
  32 4. Testing
  33
  34 5. Installation
  35
  36 6. Usage
  37
  38 7. Status of project
  39
  40 8. Documentation & References
  41
  42 9. Contact
  43
  44 10. Licence
  45
  46 11. Disclaimer
  47
  48 --------------------------------------------------------------------------------
  49
  50 1. Requirements
  51
  52  1.1 Kernel module
  53
  54    To compile the driver you need :
  55      Kernel 2.6.22 or higher
  56      Kernel headers
  57      make
  58      gcc
  59
  60  1.2 Documentation
  61
  62    To compile the documentation you need :
  63      doxygen
  64      graphviz
  65
  66  1.3 Decoder
  67
  68    Most video applications do not support the image encoding SN9C20x-based
  69    webcams offer. Such applications need to have the image stream converted
  70    for them. This can be done using "libv4l", which is pre-loaded between the
  71    application and the video resource and translates the image stream into a
  72    usable format.
  73
  74    Most distributions offer precompiled packages. If yours does not, the
  75    sources are available here :
  76      http://freshmeat.net/projects/libv4l/
  77
  78    Consult libv4l's README for usage details.
  79
  80 --------------------------------------------------------------------------------
  81
  82 2. Available Packages
  83
  84   There are packages for various distributions available here :
  85     http://repo.or.cz/w/pkgmicrodia.git
  86
  87 --------------------------------------------------------------------------------
  88
  89 3. Compilation
  90
  91  3.1 Kernel module
  92
  93    To build the kernel module ("driver") :
  94      $ make
  95      (This will create the kernel object file called "sn9c20x.ko".)
  96
  97  3.2 Documentation
  98
  99    To build the documentation :
 100      $ make doc
 101      $ make cleandoc
 102
 103 --------------------------------------------------------------------------------
 104
 105 4. Testing
 106
 107   To load the driver, follow these steps (as root) :
 108     # modprobe videodev
 109     # modprobe compat-ioctl32  // Only required for 64-bit Linux OS
 110     # make insmod
 111
 112   Note: Most applications require libv4l for image format decoding (see "1.3
 113   Decoder"). Consult libv4l documentation for full usage details. Here is an
 114   example for a common usage :
 115     $ LD_PRELOAD=/usr/lib/libv4l/v4l2convert.so mplayer tv:// -tv \
 116       driver=v4l2:width=640:height=480:fps=25:device=/dev/video0 -vo xv
 117
 118 --------------------------------------------------------------------------------
 119
 120 5. Installation
 121
 122   $ strip -g sn9c20x.ko
 123   And as root :
 124   # cp sn9c20x.ko /lib/modules/`uname -r`/kernel/drivers/media/video/usbvideo/
 125   # depmod -a
 126
 127 --------------------------------------------------------------------------------
 128
 129 6. Usage
 130
 131   We recommend using v4l2ucp to adjust and improve image quality.
 132     http://sourceforge.net/projects/v4l2ucp/
 133
 134   We are also developing our own GUI, available here :
 135     http://repo.or.cz/r/guimicrodia.git
 136
 137 --------------------------------------------------------------------------------
 138
 139 7. Status
 140
 141   The kernel module is currently under active development.
 142
 143   The full list of supported webcams can be found here :
 144     http://groups.google.com/group/microdia/web/project-status
 145
 146 --------------------------------------------------------------------------------
 147
 148 8. Contact
 149
 150   To request support, please contact us on Microdia Mailing List :
 151     https://groups.google.com/group/microdia/
 152     microdia@googlegroups.com
 153
 154 --------------------------------------------------------------------------------
 155
 156 9. More Documentation & References
 157
 158   All documentation and references for microdia webcam driver can be found at
 159     http://groups.google.com/group/microdia/web
 160
 161   Latest version of this driver is usually available at the following location
 162     http://repo.or.cz/w/microdia.git
 163
 164 --------------------------------------------------------------------------------
 165
 166 10. Licence
 167
 168   SN9C20x USB 2.0 Webcam Driver is distributed under the GPL licence version 2
 169   or later (GPLv2+).
 170
 171 --------------------------------------------------------------------------------
 172
 173 11. Disclaimer
 174
 175   The "microdia" project has no connection to "MICRODIA Ltd." or "Sonix
 176   Technology Co., Ltd.". They are not responsible for anything we do or our
 177   driver does and we are not responsible for their actions or their hardware.