Sophie

Sophie

distrib > Fedora > 14 > x86_64 > media > updates > by-pkgid > 727fa15453fcace956b835e2377d4269 > files > 558

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>camerav4l2<br/>
<small>
[<a class="el" href="group__drivers.html">Drivers</a>]</small>
</h1>  </div>
</div>
<div class="contents">

<p>Video4Linux2 camera capture.  
<a href="#_details">More...</a></p>
<table class="memberdecls">
</table>
<p>Video4Linux2 camera capture. </p>
<p>The camerav4l2 driver captures images from V4L2-compatible cameras.</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/videodev2.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>sources (integer tuple)<ul>
<li>Default: NONE</li>
<li>Some capture cards have few multiple input sources; use this field to select which ones are used. You should define as many provided camera interfaces as the number of sources is given here. Source channel numbers are used as keys ('ch' prefixed) in 'provides' tuple.</li>
<li>If not given, channel 0 alone will be used by defauilt.</li>
<li>Note that switching between channels takes time. Framerate drops dramatically whenever more than one channel is used.</li>
</ul>
</li>
</ul>
<ul>
<li>norm (string)<ul>
<li>Default: "NTSC"</li>
<li>Capture format; "NTSC", "PAL" or "UNKNOWN"</li>
<li>Case sensitive!</li>
</ul>
</li>
</ul>
<ul>
<li>size (integer tuple)<ul>
<li>Default: varies with norm<ul>
<li>PAL: [768 576]</li>
<li>NTSC: [640 480]</li>
<li>other: [320 240]</li>
</ul>
</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: "BGR3"</li>
<li>Desired capture mode. Can be one of:<ul>
<li>GREY (8-bit monochrome)</li>
<li>RGBP (16-bit packed; will produce 24-bit color images)</li>
<li>BGR3, RGB3 (24-bit RGB)</li>
<li>BGR4, RGB4 (32-bit RGB)</li>
<li>BA81 (for sn9c1xx-based USB webcams; will produce 24-bit color images)</li>
<li>MJPG (for webcams producing MJPEG streams not decompressed by V4L2 driver)</li>
</ul>
</li>
</ul>
</li>
</ul>
<ul>
<li>buffers (integer)<ul>
<li>Default: 2</li>
<li>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 do not want to get stale frames.</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>
<ul>
<li>settle_time (double)<ul>
<li>Default: 0.5</li>
<li>Time (in seconds) to wait after switching to next channel; images grabbed right after channel switching are too bright or messy, so it is better to wait a little while before start grabbing.</li>
</ul>
</li>
</ul>
<ul>
<li>skip_frames (integer)<ul>
<li>Default: 10</li>
<li>See 'settle_time' - during this settle time frames are grabbed anyway and they are counted. We can decide to stop waiting for stable image after given number of frames was skipped.</li>
</ul>
</li>
</ul>
<ul>
<li>failsafe (integer)<ul>
<li>Default: 0</li>
<li>If after few days of grabbing you experience unexpected failures you can try to set this to 1. WARNING! Such failures may (or may not) suggest something wrong is going on with your system kernel. Reboot of whole system is a better solution, although it may not always be desired. This feature is turned off by default - use at your own risk.</li>
</ul>
</li>
</ul>
<p>Note that some of these options may not be honoured by the underlying V4L2 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 "camerav4l2"
  provides ["camera:0"]
)
</pre></div><dl class="user"><dt><b>Channel 2 explicitly selected:</b></dt><dd></dd></dl>
<div class="fragment"><pre class="fragment">
driver
(
  name "camerav4l2"
  sources [2]
  norm "PAL"
  size [384 288]
  mode "BGR4"
  buffers 4
  sleep_nsec 10000
  provides ["ch2:::camera:1"]
)
driver
(
  name "cameracompress"
  requires "camera:1"
  provides "camera:0"
)
</pre></div><dl class="user"><dt><b>Two channels at the same time:</b></dt><dd></dd></dl>
<div class="fragment"><pre class="fragment">
driver
(
  name "camerav4l2"
  sources [0 2]
  norm "PAL"
  provides ["ch2:::camera:0" "ch0:::camera:1"]
)
</pre></div><dl class="user"><dt><b>sn9c1xx-based USB webcam (it accepts one buffer and only 352x288 size!):</b></dt><dd></dd></dl>
<div class="fragment"><pre class="fragment">
driver
(
  name "camerav4l2"
  norm "UNKNOWN"
  mode "BA81"
  size [352 288]
  buffers 1
  provides ["camera:1"]
)
driver
(
  name "cameracompress"
  requires ["camera:1"]
  provides ["camera:0"]
)
</pre></div><dl class="author"><dt><b>Author:</b></dt><dd>Paul Osmialowski, Takafumi Mizuno </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>