Sophie: player-doc-3.0.2-5.fc14 noarch

player-doc-3.0.2-5.fc14.noarch.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
   "http://www.w3.org/TR/html4/strict.dtd">

<html>
<!-- $Id: header.html 8799 2010-06-28 04:12:42Z jpgr87 $ -->

<HEAD>


<meta HTTP-EQUIV="Content-Type" CONTENT="text/html;CHARSET=utf-8">
<meta name="keywords" content="stage, robot, simulation, player, player/stage">
<link href="doxygen.css" rel="stylesheet" type="text/css">

<style type="text/css">

.floatright { float: right; margin: 0 0 1em 1em; }

body {
  font-family: sans-serif;
  #font-family: Geneva, Verdana, Helvetica, Arial, sans-serif;
  background-color: #FFF;
  color:#000;
}


a:link { 
	color: #A00;
}

a:visited { 
	color: #800;
}

a { text-decoration: none; }
a:hover { text-decoration: underline; }


.timestamp { text-align:right; background-color: #DDD; font-size:75%;}

h1 { 
  font-size:160%; 
}

h2 {
  font-size:110%;
  #color: #FFF;
  #background-color: #666;
  #padding:3px;
}

h3 { text-align:left; }

img {
  border: 0;
}

ul.menu { 
    position:relative;
    left:-2.5em;
    margin-bottom:0px;
    margin-top:0px;
}

ul.menu1 { 
    position:relative;
    left:-2.1em;
    margin-bottom:0px;
    margin-top:0px;
}

li.menu { 
    list-style-type: none;
    position:relative;
    #left:-0.5em;
}


#sidebar { position: absolute; left:0px; padding:2em; top:0em; width:12em;}

#content { position: absolute; left:12em; top:0em; padding-left:3em; padding-right:3em; padding-bottom:2em; margin-top:1em; margin-right:2em; }

div.box { background-color:#EEE; border: 1px solid #000; padding: 0.5ex 0.4em 0.5ex 0.6em; margin:1em;  }
div.title { font-weight:bold; background-color:#eee; margin-bottom:2px;}

div.topbar { position: absolute; top:0px; left:9em; margin:1em; }

</style>

<TITLE>Player Manual</TITLE>

</HEAD>

<body>

<div id="sidebar"> 

<h2 style="text-align:center;">
<a href="index.html">
<img width=140 src="http://playerstage.sourceforge.net/images/player_button_v3.png" alt="Player logo"><br></a>
</h2>



<div class="box">
<div class=title>Player</div>

<ul class=menu>
<li class=menu><a href="index.html">Frontpage</a>
<li class=menu><a href="modules.html">Contents</a>
</ul>
</div>

<div class="box">
<div class=title>User</div>

<ul class=menu>
<li class=menu><a href="install.html">Installation</a>
<li class=menu><a href="start.html">Quick start</a>
<li class=menu><a href="supported_hardware.html">Supported&nbsp;devices</a>
<li class=menu><a href="group__tutorials.html">Tutorials</a>
<li class=menu><a href="group__utils.html">Utilities</a>
<li class=menu><a href="group__clientlibs.html">Client&nbsp;libraries</a>
<li class=menu><a href="http://playerstage.sourceforge.net/wiki/Basic_FAQ">FAQ</a>
<li class=menu><a href="help.html">Help</a>

</ul>
</div>

<div class=box>
<div class="title">Developer</div>
<ul class=menu>
<li class=menu><a href="architecture.html">Architecture</a>
<li class=menu><a href="group__libplayercore.html">libplayercore</a>
<ul class=menu1>
<li class=menu><a href="group__interfaces.html">interfaces</a></li>
</ul>
<li class=menu><a href="group__libplayerdrivers.html">libplayerdrivers</a>
<ul class=menu1>
<li class=menu><a href="group__drivers.html">drivers</a></li>
</ul>
<li class=menu><a href="group__libplayercommon.html">libplayercommon</a>
<li class=menu><a href="group__libplayerutils.html">libplayerutils</a>
<li class=menu><a href="group__libplayersd.html">libplayersd</a>
<li class=menu><a href="group__libplayertcp.html">libplayertcp</a>
<li class=menu><a href="group__libplayerxdr.html">libplayerxdr</a>
<li class=menu><a href="todo.html">TODO</a>
</ul>
</div>

<div class=box>
<!-- <a href="http://sourceforge.net"><img border=0 src="http://sourceforge.net/sflogo.php?group_id=42445&type=1"></a> -->
<div class="title">Online</div>
<a href="http://playerstage.sourceforge.net">Homepage</a><br>
<a href="http://sourceforge.net/project/showfiles.php?group_id=42445">Download</a><br>
<a href="http://sourceforge.net/projects/playerstage">Project</a><br>
<a href="http://sourceforge.net/tracker/?group_id=42445">Bugs</a><br>
<a href="http://sourceforge.net/mail/?group_id=42445">Help</a>
</div>


</div>

<div id="content" >
<!-- Generated by Doxygen 1.7.1 -->
<div class="header">
  <div class="headertitle">
<h1>camerav4l<br/>
<small>
[<a class="el" href="group__drivers.html">Drivers</a>]</small>
</h1>  </div>
</div>
<div class="contents">

<p>Video4Linux camera capture.  
<a href="#_details">More...</a></p>
<table class="memberdecls">
</table>
<p>Video4Linux camera capture. </p>
<p>The camerav4l driver captures images from V4l-compatible cameras. See below for notes on specific camera/frame grabber combinations.</p>
<dl class="user"><dt><b>Compile-time dependencies</b></dt><dd></dd></dl>
<ul>
<li>&lt;sys/types.h&gt;</li>
<li>&lt;linux/videodev.h&gt;</li>
</ul>
<dl class="user"><dt><b>Provides</b></dt><dd></dd></dl>
<ul>
<li><a class="el" href="group__interface__camera.html">camera</a></li>
</ul>
<dl class="user"><dt><b>Requires</b></dt><dd></dd></dl>
<ul>
<li>none</li>
</ul>
<dl class="user"><dt><b>Configuration requests</b></dt><dd></dd></dl>
<ul>
<li>none</li>
</ul>
<dl class="user"><dt><b>Configuration file options</b></dt><dd></dd></dl>
<ul>
<li>port (string)<ul>
<li>Default: "/dev/video0"</li>
<li><a class="el" href="classDevice.html" title="Encapsulates a device (i.e., a driver bound to an interface).">Device</a> to read video data from.</li>
</ul>
</li>
</ul>
<ul>
<li>source (integer)<ul>
<li>Default: 3</li>
<li>Some capture cards have multiple input sources; use this field to select which one is used.</li>
</ul>
</li>
</ul>
<ul>
<li>norm (string)<ul>
<li>Default: "ntsc"</li>
<li>Capture format; "ntsc" or "pal"</li>
</ul>
</li>
</ul>
<ul>
<li>size (integer tuple)<ul>
<li>Default: varies with norm</li>
<li>Desired image size. This may not be honoured if the driver does not support the requested size).</li>
</ul>
</li>
</ul>
<ul>
<li>mode (string)<ul>
<li>Default: "RGB888"</li>
<li>Desired capture mode. Can be one of:<ul>
<li>GREY (8-bit monochrome)</li>
<li>RGB565 (16-bit RGB)</li>
<li>RGB888 (24-bit RGB)</li>
<li>RGB32 (32-bit RGB; will produce 24-bit color images)</li>
<li>YUV420P (planar YUV data converted to 24-bit color images)</li>
<li>YUV420P_GREY (planar YUV data; will produce 8-bit monochrome images)</li>
<li>JPEG (for some webcams)</li>
</ul>
</li>
<li>Note that not all capture modes are supported by Player's internal image format; in these modes, images will be translated to the closest matching internal format (e.g., RGB32 -&gt; RGB888).</li>
</ul>
</li>
</ul>
<ul>
<li>save (integer)<ul>
<li>Default: 0</li>
<li>Debugging option: set this to write each frame as an image file on disk.</li>
</ul>
</li>
</ul>
<ul>
<li>have_ov519 (integer)<ul>
<li>Default: 0</li>
<li>Needed for ovc519 based cameras that send data jpeg compressed on the usb bus.</li>
</ul>
</li>
</ul>
<ul>
<li>max_buffer (integer)<ul>
<li>Default: -1 (do not set)</li>
<li>Limit the maximum number of buffers to use for grabbing. This reduces latency, but also potentially reduces throughput. Use this if you are reading slowly from the player driver and dont want to get stale frames</li>
</ul>
</li>
</ul>
<ul>
<li>brightness (integer)<ul>
<li>Default: -1 (do not set)</li>
</ul>
</li>
</ul>
<ul>
<li>hue (integer)<ul>
<li>Default: -1 (do not set)</li>
</ul>
</li>
</ul>
<ul>
<li>colour (integer)<ul>
<li>Default: -1 (do not set)</li>
</ul>
</li>
</ul>
<ul>
<li>contrast (integer)<ul>
<li>Default: -1 (do not set)</li>
</ul>
</li>
</ul>
<ul>
<li>read_mode (integer)<ul>
<li>Default: 0</li>
<li>Set to 1 if read should be used instead of grab (in most cases it isn't a good idea!)</li>
</ul>
</li>
</ul>
<ul>
<li>publish_interval (integer)<ul>
<li>Default: 0</li>
<li>how many second between publishing real images (may break your client app!)</li>
</ul>
</li>
</ul>
<ul>
<li>sleep_nsec (integer)<ul>
<li>Default: 10000000 (=10ms which gives max 100 fps)</li>
<li>timespec value for nanosleep()</li>
</ul>
</li>
</ul>
<p>Note that some of these options may not be honoured by the underlying V4L kernel driver (it may not support a given image size, for example).</p>
<dl class="user"><dt><b>Example</b></dt><dd></dd></dl>
<div class="fragment"><pre class="fragment">
driver
(
  name "camerav4l"
  provides ["camera:0"]
)
</pre></div><dl class="user"><dt><b>Logitech QuickCam Pro 4000</b></dt><dd></dd></dl>
<p>For the Logitech QuickCam Pro 4000, use: </p>
<div class="fragment"><pre class="fragment">
driver
(
  name "camerav4l"
  provides ["camera:0"]
  port "/dev/video0"
  source 0
  size [160 120]
  mode "YUV420P"
)
</pre></div><p>Kernel notes: with a little bit of tweaking, this camera will work with the pwc (Phillips Web-Cam) driver in the Linux 2.4.20 kernel. The stock driver recognizes the QC Pro 3000, but not the QC Pro 4000; to support the latter, you must modify the kernel source (add a product id in a couple of places in pwc-if.c). Milage may vary for other kernel versions. Also, the binary-only pwcx.o module is needed to access frame sizes larger than 160x120; good luck finding this and/or getting it to work (the developer spat the dummy and took down his website).</p>
<p>Update for pwc: The original source has been taken up by another developer and is now available from <a href="http://www.saillard.org/linux/pwc/.">http://www.saillard.org/linux/pwc/.</a> This new version also doesnt need the binary driver which is a bonus</p>
<dl class="author"><dt><b>Author:</b></dt><dd>Andrew Howard </dd></dl>
</div>
<!-- render the modification time of the source file -->


<div class="timestamp">
<hr>

<table style="width:100%;">
<tr>
<td style="text-align:left;">
Last updated 12 September 2005 21:38:45
<!--
<td style="text-align:right;">
<a href="http://validator.w3.org/check/referer"><img style="vertical-align:middle;border:0;width:88px;height:31px"
          src="http://www.w3.org/Icons/valid-html401"
          alt="Valid HTML 4.01!"></a>

 <a href="http://jigsaw.w3.org/css-validator/">
  <img style="vertical-align:middle;border:0;width:88px;height:31px"
       src="http://jigsaw.w3.org/css-validator/images/vcss"
       alt="Valid CSS!">
 </a>
-->
</tr>
</table>
</div>


</tr>
</table>

</BODY>
</HTML>