<!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 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 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>v4lcapture.h</h1> </div>
</div>
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">//==========================================================================</span>
<a name="l00002"></a>00002 <span class="comment">//</span>
<a name="l00003"></a>00003 <span class="comment">// Project: libfg - Frame Grabber interface for Linux</span>
<a name="l00004"></a>00004 <span class="comment">//</span>
<a name="l00005"></a>00005 <span class="comment">// Module: Capture client interface</span>
<a name="l00006"></a>00006 <span class="comment">//</span>
<a name="l00007"></a>00007 <span class="comment">// Description: Provides a high-level C interface for controlling frame</span>
<a name="l00008"></a>00008 <span class="comment">// grabber and TV tuner cards. Uses the Video 4 Linux API</span>
<a name="l00009"></a>00009 <span class="comment">// (currently v1) and thus supports any V4L supported</span>
<a name="l00010"></a>00010 <span class="comment">// device.</span>
<a name="l00011"></a>00011 <span class="comment">//</span>
<a name="l00012"></a>00012 <span class="comment">// Author: Gavin Baker <gavinb@antonym.org></span>
<a name="l00013"></a>00013 <span class="comment">//</span>
<a name="l00014"></a>00014 <span class="comment">// Homepage: http://www.antonym.org/libfg</span>
<a name="l00015"></a>00015 <span class="comment">//</span>
<a name="l00016"></a>00016 <span class="comment">//--------------------------------------------------------------------------</span>
<a name="l00017"></a>00017 <span class="comment">//</span>
<a name="l00018"></a>00018 <span class="comment">// libfg - Frame Grabber interface for Linux</span>
<a name="l00019"></a>00019 <span class="comment">// Copyright (c) 2002 Gavin Baker</span>
<a name="l00020"></a>00020 <span class="comment">//</span>
<a name="l00021"></a>00021 <span class="comment">// This library is free software; you can redistribute it and/or</span>
<a name="l00022"></a>00022 <span class="comment">// modify it under the terms of the GNU Lesser General Public</span>
<a name="l00023"></a>00023 <span class="comment">// License as published by the Free Software Foundation; either</span>
<a name="l00024"></a>00024 <span class="comment">// version 2.1 of the License, or (at your option) any later version.</span>
<a name="l00025"></a>00025 <span class="comment">//</span>
<a name="l00026"></a>00026 <span class="comment">// This library is distributed in the hope that it will be useful,</span>
<a name="l00027"></a>00027 <span class="comment">// but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00028"></a>00028 <span class="comment">// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span>
<a name="l00029"></a>00029 <span class="comment">// Lesser General Public License for more details.</span>
<a name="l00030"></a>00030 <span class="comment">//</span>
<a name="l00031"></a>00031 <span class="comment">// You should have received a copy of the GNU Lesser General Public</span>
<a name="l00032"></a>00032 <span class="comment">// License along with this library; if not, write to the Free Software</span>
<a name="l00033"></a>00033 <span class="comment">// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</span>
<a name="l00034"></a>00034 <span class="comment">// or obtain a copy from the GNU website at http://www.gnu.org/</span>
<a name="l00035"></a>00035 <span class="comment">//</span>
<a name="l00036"></a>00036 <span class="comment">//==========================================================================</span>
<a name="l00037"></a>00037
<a name="l00038"></a>00038 <span class="preprocessor">#ifndef __V4LCAPTURE__H_</span>
<a name="l00039"></a>00039 <span class="preprocessor"></span><span class="preprocessor">#define __V4LCAPTURE__H_</span>
<a name="l00040"></a>00040 <span class="preprocessor"></span>
<a name="l00041"></a>00041
<a name="l00042"></a>00042 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00043"></a>00043 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span>
<a name="l00044"></a>00044 {
<a name="l00045"></a>00045 <span class="preprocessor">#endif</span>
<a name="l00046"></a>00046 <span class="preprocessor"></span>
<a name="l00047"></a>00047
<a name="l00048"></a>00048 <span class="preprocessor">#include <stdio.h></span>
<a name="l00049"></a>00049 <span class="preprocessor">#include <fcntl.h></span>
<a name="l00050"></a>00050 <span class="preprocessor">#include <stdlib.h></span>
<a name="l00051"></a>00051 <span class="preprocessor">#include <unistd.h></span>
<a name="l00052"></a>00052
<a name="l00053"></a>00053 <span class="preprocessor">#include <sys/mman.h></span>
<a name="l00054"></a>00054 <span class="preprocessor">#include <sys/ioctl.h></span>
<a name="l00055"></a>00055
<a name="l00056"></a>00056 <span class="preprocessor">#if !defined (sun)</span>
<a name="l00057"></a>00057 <span class="preprocessor"></span><span class="preprocessor"> #include <linux/fs.h></span>
<a name="l00058"></a>00058 <span class="preprocessor"> #include <linux/kernel.h></span>
<a name="l00059"></a>00059 <span class="preprocessor">#endif</span>
<a name="l00060"></a>00060 <span class="preprocessor"></span><span class="preprocessor">#include <sys/types.h></span>
<a name="l00061"></a>00061 <span class="preprocessor">#include <linux/videodev.h></span>
<a name="l00062"></a>00062
<a name="l00063"></a>00063 <span class="preprocessor">#include "v4lframe.h"</span>
<a name="l00064"></a>00064
<a name="l00065"></a>00065 <span class="comment">//==========================================================================</span>
<a name="l00066"></a>00066 <span class="comment">// Definitions</span>
<a name="l00067"></a>00067 <span class="comment">//==========================================================================</span>
<a name="l00068"></a>00068
<a name="l00069"></a>00069 <span class="preprocessor">#ifndef VIDEO_PALETTE_JPEG</span>
<a name="l00070"></a>00070 <span class="preprocessor"></span><span class="preprocessor">#define VIDEO_PALETTE_JPEG 21</span>
<a name="l00071"></a>00071 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00072"></a>00072 <span class="preprocessor"></span>
<a name="l00073"></a>00073 <span class="comment">// Standard device for fg_open()</span>
<a name="l00074"></a>00074 <span class="preprocessor">#define FG_DEFAULT_DEVICE "/dev/video0"</span>
<a name="l00075"></a>00075 <span class="preprocessor"></span>
<a name="l00076"></a>00076 <span class="comment">// Normal capture size</span>
<a name="l00077"></a>00077 <span class="preprocessor">#define FG_DEFAULT_WIDTH 640</span>
<a name="l00078"></a>00078 <span class="preprocessor"></span><span class="preprocessor">#define FG_DEFAULT_HEIGHT 480</span>
<a name="l00079"></a>00079 <span class="preprocessor"></span>
<a name="l00080"></a>00080 <span class="comment">// Percentage of a ushort</span>
<a name="l00081"></a>00081 <span class="preprocessor">#define FG_PERCENT(n) ((n)*65535/100)</span>
<a name="l00082"></a>00082 <span class="preprocessor"></span><span class="preprocessor">#define FG_50PC FG_PERCENT(50)</span>
<a name="l00083"></a>00083 <span class="preprocessor"></span>
<a name="l00084"></a>00084 <span class="comment">// Default input sources</span>
<a name="l00085"></a>00085 <span class="preprocessor">#define FG_SOURCE_TV 0</span>
<a name="l00086"></a>00086 <span class="preprocessor"></span><span class="preprocessor">#define FG_SOURCE_COMPOSITE 1</span>
<a name="l00087"></a>00087 <span class="preprocessor"></span><span class="preprocessor">#define FG_SOURCE_SVIDEO 2</span>
<a name="l00088"></a>00088 <span class="preprocessor"></span>
<a name="l00089"></a>00089
<a name="l00090"></a>00090 <span class="comment">//--------------------------------------------------------------------------</span>
<a name="l00091"></a>00091 <span class="comment">//</span>
<a name="l00092"></a>00092 <span class="comment">// Type: FRAMEGRABBER</span>
<a name="l00093"></a>00093 <span class="comment">//</span>
<a name="l00094"></a>00094 <span class="comment">// Description: Represents all information about a frame grabber</span>
<a name="l00095"></a>00095 <span class="comment">// device. Returned by fg_open(), and used as the first</span>
<a name="l00096"></a>00096 <span class="comment">// parameter for all other fg_*() calls.</span>
<a name="l00097"></a>00097 <span class="comment">//</span>
<a name="l00098"></a>00098 <span class="comment">//--------------------------------------------------------------------------</span>
<a name="l00099"></a><a class="code" href="structFRAMEGRABBER.html">00099</a> <span class="keyword">typedef</span> <span class="keyword">struct</span>
<a name="l00100"></a>00100 {
<a name="l00101"></a>00101 <span class="keywordtype">char</span>* device; <span class="comment">// Device name, eg. "/dev/video"</span>
<a name="l00102"></a>00102 <span class="keywordtype">int</span> fd; <span class="comment">// File handle for open device</span>
<a name="l00103"></a>00103 <span class="keyword">struct </span>video_capability caps; <span class="comment">// Capabilities</span>
<a name="l00104"></a>00104 <span class="keyword">struct </span>video_channel* sources; <span class="comment">// Input sources (eg. TV, SVideo)</span>
<a name="l00105"></a>00105 <span class="keywordtype">int</span> source; <span class="comment">// Currently selected source</span>
<a name="l00106"></a>00106 <span class="keyword">struct </span>video_tuner tuner; <span class="comment">// TV or Radio tuner</span>
<a name="l00107"></a>00107 <span class="keyword">struct </span>video_window window; <span class="comment">// Capture window</span>
<a name="l00108"></a>00108 <span class="keyword">struct </span>video_picture picture; <span class="comment">// Picture controls (eg. bright)</span>
<a name="l00109"></a>00109 <span class="keyword">struct </span>video_mmap mmap; <span class="comment">// Memory-mapped info</span>
<a name="l00110"></a>00110 <span class="keyword">struct </span>video_buffer fbuffer; <span class="comment">// Frame buffer</span>
<a name="l00111"></a>00111 <span class="keyword">struct </span>video_mbuf mbuf; <span class="comment">// Memory buffer #frames, offsets</span>
<a name="l00112"></a>00112 <span class="keywordtype">void</span>* mb_map; <span class="comment">// Memory-mapped buffer</span>
<a name="l00113"></a>00113 <span class="keywordtype">int</span> cur_frame; <span class="comment">// Currently capuring frame no.</span>
<a name="l00114"></a>00114 <span class="keywordtype">int</span> max_buffer; <span class="comment">// Maximum number of frames to buffer</span>
<a name="l00115"></a>00115
<a name="l00116"></a>00116 } <a class="code" href="structFRAMEGRABBER.html">FRAMEGRABBER</a>;
<a name="l00117"></a>00117
<a name="l00118"></a>00118
<a name="l00119"></a>00119
<a name="l00120"></a>00120 <span class="comment">//==========================================================================</span>
<a name="l00121"></a>00121 <span class="comment">// Prototypes</span>
<a name="l00122"></a>00122 <span class="comment">//==========================================================================</span>
<a name="l00123"></a>00123
<a name="l00124"></a>00124
<a name="l00125"></a>00125 <span class="comment">//--------------------------------------------------------------------------</span>
<a name="l00126"></a>00126 <span class="comment">//</span>
<a name="l00127"></a>00127 <span class="comment">// Function: fg_open</span>
<a name="l00128"></a>00128 <span class="comment">//</span>
<a name="l00129"></a>00129 <span class="comment">// Description: Opens and initialises the frame grabber device with</span>
<a name="l00130"></a>00130 <span class="comment">// some reasonable default values, and queries for all</span>
<a name="l00131"></a>00131 <span class="comment">// capabilities.</span>
<a name="l00132"></a>00132 <span class="comment">//</span>
<a name="l00133"></a>00133 <span class="comment">// Parameters: char* dev Device name to open, eg. "/dev/video2"</span>
<a name="l00134"></a>00134 <span class="comment">// or NULL for "/dev/video".</span>
<a name="l00135"></a>00135 <span class="comment">//</span>
<a name="l00136"></a>00136 <span class="comment">// Returns: FRAMEGRABBER* The open framegrabber device, or</span>
<a name="l00137"></a>00137 <span class="comment">// NULL in the case of an error.</span>
<a name="l00138"></a>00138 <span class="comment">//</span>
<a name="l00139"></a>00139 <span class="comment">//--------------------------------------------------------------------------</span>
<a name="l00140"></a>00140
<a name="l00141"></a>00141 <a class="code" href="structFRAMEGRABBER.html">FRAMEGRABBER</a>* fg_open( <span class="keyword">const</span> <span class="keywordtype">char</span> *dev );
<a name="l00142"></a>00142
<a name="l00143"></a>00143 <span class="keywordtype">int</span> fg_enable_capture( <a class="code" href="structFRAMEGRABBER.html">FRAMEGRABBER</a>* fg, <span class="keywordtype">int</span> flag );
<a name="l00144"></a>00144
<a name="l00145"></a>00145 <span class="comment">//--------------------------------------------------------------------------</span>
<a name="l00146"></a>00146 <span class="comment">//</span>
<a name="l00147"></a>00147 <span class="comment">// Function: fg_close</span>
<a name="l00148"></a>00148 <span class="comment">//</span>
<a name="l00149"></a>00149 <span class="comment">// Description: Closes an open framegrabber device, and releases all</span>
<a name="l00150"></a>00150 <span class="comment">// memory allocated to it.</span>
<a name="l00151"></a>00151 <span class="comment">//</span>
<a name="l00152"></a>00152 <span class="comment">//--------------------------------------------------------------------------</span>
<a name="l00153"></a>00153
<a name="l00154"></a>00154 <span class="keywordtype">void</span> fg_close( <a class="code" href="structFRAMEGRABBER.html">FRAMEGRABBER</a>* fg );
<a name="l00155"></a>00155
<a name="l00156"></a>00156
<a name="l00157"></a>00157 <span class="comment">//--------------------------------------------------------------------------</span>
<a name="l00158"></a>00158 <span class="comment">//</span>
<a name="l00159"></a>00159 <span class="comment">// Function: fg_grab</span>
<a name="l00160"></a>00160 <span class="comment">//</span>
<a name="l00161"></a>00161 <span class="comment">// Description: Reads a frame from the capture device, allocating</span>
<a name="l00162"></a>00162 <span class="comment">// a new FRAME instance and returning it.</span>
<a name="l00163"></a>00163 <span class="comment">// Note that this is a *blocking* read, and thus will</span>
<a name="l00164"></a>00164 <span class="comment">// wait until the next frame is ready.</span>
<a name="l00165"></a>00165 <span class="comment">// The caller is responsible for doing a frame_release()</span>
<a name="l00166"></a>00166 <span class="comment">// when done with the frame (to free memory).</span>
<a name="l00167"></a>00167 <span class="comment">//</span>
<a name="l00168"></a>00168 <span class="comment">// Returns: FRAME* The most recently captured frame</span>
<a name="l00169"></a>00169 <span class="comment">// NULL On error</span>
<a name="l00170"></a>00170 <span class="comment">//</span>
<a name="l00171"></a>00171 <span class="comment">// Notes: This function blocks!</span>
<a name="l00172"></a>00172 <span class="comment">//</span>
<a name="l00173"></a>00173 <span class="comment">//--------------------------------------------------------------------------</span>
<a name="l00174"></a>00174
<a name="l00175"></a>00175 <a class="code" href="structFRAME.html">FRAME</a>* fg_grab( <a class="code" href="structFRAMEGRABBER.html">FRAMEGRABBER</a>* fg );
<a name="l00176"></a>00176
<a name="l00177"></a>00177 <span class="keywordtype">int</span> fg_read(<a class="code" href="structFRAMEGRABBER.html">FRAMEGRABBER</a> * fg, <a class="code" href="structFRAME.html">FRAME</a> * fr);
<a name="l00178"></a>00178
<a name="l00179"></a>00179 <span class="comment">//--------------------------------------------------------------------------</span>
<a name="l00180"></a>00180 <span class="comment">//</span>
<a name="l00181"></a>00181 <span class="comment">// Function: fg_grab_frame</span>
<a name="l00182"></a>00182 <span class="comment">//</span>
<a name="l00183"></a>00183 <span class="comment">// Description: Reads a frame from the capture device, using the</span>
<a name="l00184"></a>00184 <span class="comment">// existing frame storage as passed in. Returns the</span>
<a name="l00185"></a>00185 <span class="comment">// same instance, with the contents of the last frame.</span>
<a name="l00186"></a>00186 <span class="comment">// Note that this is a *blocking* read, and thus will</span>
<a name="l00187"></a>00187 <span class="comment">// wait until the next frame is ready.</span>
<a name="l00188"></a>00188 <span class="comment">//</span>
<a name="l00189"></a>00189 <span class="comment">// Parameters: FRAME* An existing frame</span>
<a name="l00190"></a>00190 <span class="comment">//</span>
<a name="l00191"></a>00191 <span class="comment">// Returns: FRAME* The most recently captured frame</span>
<a name="l00192"></a>00192 <span class="comment">// NULL On error</span>
<a name="l00193"></a>00193 <span class="comment">//</span>
<a name="l00194"></a>00194 <span class="comment">// Notes: This function blocks!</span>
<a name="l00195"></a>00195 <span class="comment">// The size *must* be correct!</span>
<a name="l00196"></a>00196 <span class="comment">//</span>
<a name="l00197"></a>00197 <span class="comment">//--------------------------------------------------------------------------</span>
<a name="l00198"></a>00198
<a name="l00199"></a>00199 <a class="code" href="structFRAME.html">FRAME</a>* fg_grab_frame( <a class="code" href="structFRAMEGRABBER.html">FRAMEGRABBER</a>* fg, <a class="code" href="structFRAME.html">FRAME</a>* fr );
<a name="l00200"></a>00200
<a name="l00201"></a>00201
<a name="l00202"></a>00202 <span class="comment">//--------------------------------------------------------------------------</span>
<a name="l00203"></a>00203 <span class="comment">//</span>
<a name="l00204"></a>00204 <span class="comment">// Function: fg_set_source</span>
<a name="l00205"></a>00205 <span class="comment">//</span>
<a name="l00206"></a>00206 <span class="comment">// Description: Specifies the number of the video source to be used</span>
<a name="l00207"></a>00207 <span class="comment">// for the input signal. For example, tuner, composite</span>
<a name="l00208"></a>00208 <span class="comment">// or S/Video signal.</span>
<a name="l00209"></a>00209 <span class="comment">//</span>
<a name="l00210"></a>00210 <span class="comment">// Parameters: int src Source id (eg. FG_SOURCE_SVIDEO)</span>
<a name="l00211"></a>00211 <span class="comment">//</span>
<a name="l00212"></a>00212 <span class="comment">// Returns: 0 On success</span>
<a name="l00213"></a>00213 <span class="comment">// -1 Failure</span>
<a name="l00214"></a>00214 <span class="comment">//</span>
<a name="l00215"></a>00215 <span class="comment">//--------------------------------------------------------------------------</span>
<a name="l00216"></a>00216
<a name="l00217"></a>00217 <span class="keywordtype">int</span> fg_set_source( <a class="code" href="structFRAMEGRABBER.html">FRAMEGRABBER</a>* fg, <span class="keywordtype">int</span> src );
<a name="l00218"></a>00218
<a name="l00219"></a>00219
<a name="l00220"></a>00220 <span class="comment">//--------------------------------------------------------------------------</span>
<a name="l00221"></a>00221 <span class="comment">//</span>
<a name="l00222"></a>00222 <span class="comment">// Function: fg_set_source_norm</span>
<a name="l00223"></a>00223 <span class="comment">//</span>
<a name="l00224"></a>00224 <span class="comment">// Description: Specifies the video signal norm (eg. PAL, NTSC, SECAM)</span>
<a name="l00225"></a>00225 <span class="comment">// for the current input source.</span>
<a name="l00226"></a>00226 <span class="comment">//</span>
<a name="l00227"></a>00227 <span class="comment">// Parameters: int norm Signal norm (eg. VIDEO_MODE_PAL)</span>
<a name="l00228"></a>00228 <span class="comment">//</span>
<a name="l00229"></a>00229 <span class="comment">// Returns: 0 On success</span>
<a name="l00230"></a>00230 <span class="comment">// -1 Failure</span>
<a name="l00231"></a>00231 <span class="comment">//</span>
<a name="l00232"></a>00232 <span class="comment">//--------------------------------------------------------------------------</span>
<a name="l00233"></a>00233
<a name="l00234"></a>00234 <span class="keywordtype">int</span> fg_set_source_norm( <a class="code" href="structFRAMEGRABBER.html">FRAMEGRABBER</a>* fg, <span class="keywordtype">int</span> norm );
<a name="l00235"></a>00235
<a name="l00236"></a>00236
<a name="l00237"></a>00237 <span class="comment">//--------------------------------------------------------------------------</span>
<a name="l00238"></a>00238 <span class="comment">//</span>
<a name="l00239"></a>00239 <span class="comment">// Function: fg_get_source_count</span>
<a name="l00240"></a>00240 <span class="comment">//</span>
<a name="l00241"></a>00241 <span class="comment">// Description: Returns the number of input sources available.</span>
<a name="l00242"></a>00242 <span class="comment">//</span>
<a name="l00243"></a>00243 <span class="comment">// Returns: >0 Sources (can be used in fg_set_source)</span>
<a name="l00244"></a>00244 <span class="comment">//</span>
<a name="l00245"></a>00245 <span class="comment">//--------------------------------------------------------------------------</span>
<a name="l00246"></a>00246
<a name="l00247"></a>00247 <span class="keywordtype">int</span> fg_get_source_count( <a class="code" href="structFRAMEGRABBER.html">FRAMEGRABBER</a>* fg );
<a name="l00248"></a>00248
<a name="l00249"></a>00249
<a name="l00250"></a>00250 <span class="comment">//--------------------------------------------------------------------------</span>
<a name="l00251"></a>00251 <span class="comment">//</span>
<a name="l00252"></a>00252 <span class="comment">// Function: fg_get_source_name</span>
<a name="l00253"></a>00253 <span class="comment">//</span>
<a name="l00254"></a>00254 <span class="comment">// Description: Returns a user-friendly name corresponding to the</span>
<a name="l00255"></a>00255 <span class="comment">// supplied channel number.</span>
<a name="l00256"></a>00256 <span class="comment">//</span>
<a name="l00257"></a>00257 <span class="comment">// Parameters: int src Source id (eg. FG_SOURCE_TV)</span>
<a name="l00258"></a>00258 <span class="comment">//</span>
<a name="l00259"></a>00259 <span class="comment">// Returns: char* Name, like "Television"</span>
<a name="l00260"></a>00260 <span class="comment">//</span>
<a name="l00261"></a>00261 <span class="comment">//--------------------------------------------------------------------------</span>
<a name="l00262"></a>00262
<a name="l00263"></a>00263 <span class="keywordtype">char</span>* fg_get_source_name( <a class="code" href="structFRAMEGRABBER.html">FRAMEGRABBER</a>* fg, <span class="keywordtype">int</span> src );
<a name="l00264"></a>00264
<a name="l00265"></a>00265
<a name="l00266"></a>00266 <span class="comment">//--------------------------------------------------------------------------</span>
<a name="l00267"></a>00267 <span class="comment">//</span>
<a name="l00268"></a>00268 <span class="comment">// Function: fg_set_channel</span>
<a name="l00269"></a>00269 <span class="comment">//</span>
<a name="l00270"></a>00270 <span class="comment">// Description: Sets the TV tuner to the specified frequency.</span>
<a name="l00271"></a>00271 <span class="comment">//</span>
<a name="l00272"></a>00272 <span class="comment">// Parameters: float freq Tuner frequency, in MHz</span>
<a name="l00273"></a>00273 <span class="comment">//</span>
<a name="l00274"></a>00274 <span class="comment">// Returns: 0 Success, tuned in</span>
<a name="l00275"></a>00275 <span class="comment">// -1 Failure</span>
<a name="l00276"></a>00276 <span class="comment">//</span>
<a name="l00277"></a>00277 <span class="comment">//--------------------------------------------------------------------------</span>
<a name="l00278"></a>00278
<a name="l00279"></a>00279 <span class="keywordtype">int</span> fg_set_channel( <a class="code" href="structFRAMEGRABBER.html">FRAMEGRABBER</a>* fg, <span class="keywordtype">float</span> freq );
<a name="l00280"></a>00280
<a name="l00281"></a>00281
<a name="l00282"></a>00282 <span class="comment">//--------------------------------------------------------------------------</span>
<a name="l00283"></a>00283 <span class="comment">//</span>
<a name="l00284"></a>00284 <span class="comment">// Function: fg_get_channel</span>
<a name="l00285"></a>00285 <span class="comment">//</span>
<a name="l00286"></a>00286 <span class="comment">// Description: Queries the current frequency of the TV tuner.</span>
<a name="l00287"></a>00287 <span class="comment">//</span>
<a name="l00288"></a>00288 <span class="comment">// Returns: float The frequency in MHz</span>
<a name="l00289"></a>00289 <span class="comment">//</span>
<a name="l00290"></a>00290 <span class="comment">//--------------------------------------------------------------------------</span>
<a name="l00291"></a>00291
<a name="l00292"></a>00292 <span class="keywordtype">float</span> fg_get_channel( <a class="code" href="structFRAMEGRABBER.html">FRAMEGRABBER</a>* fg );
<a name="l00293"></a>00293
<a name="l00294"></a>00294
<a name="l00295"></a>00295 <span class="comment">//--------------------------------------------------------------------------</span>
<a name="l00296"></a>00296 <span class="comment">//</span>
<a name="l00297"></a>00297 <span class="comment">// Function: fg_set_format</span>
<a name="l00298"></a>00298 <span class="comment">//</span>
<a name="l00299"></a>00299 <span class="comment">// Description: Specifies the capture format to use. Must be one of</span>
<a name="l00300"></a>00300 <span class="comment">// the VIDEO_PALETTE_* flags.</span>
<a name="l00301"></a>00301 <span class="comment">//</span>
<a name="l00302"></a>00302 <span class="comment">// Notes: Currently only RGB32 and RGB24 are properly supported.</span>
<a name="l00303"></a>00303 <span class="comment">//</span>
<a name="l00304"></a>00304 <span class="comment">// Returns: 0 Success</span>
<a name="l00305"></a>00305 <span class="comment">//</span>
<a name="l00306"></a>00306 <span class="comment">//--------------------------------------------------------------------------</span>
<a name="l00307"></a>00307
<a name="l00308"></a>00308 <span class="keywordtype">int</span> fg_set_format( <a class="code" href="structFRAMEGRABBER.html">FRAMEGRABBER</a>* fg, <span class="keywordtype">int</span> fmt );
<a name="l00309"></a>00309
<a name="l00310"></a>00310 <span class="comment">//--------------------------------------------------------------------------</span>
<a name="l00311"></a>00311 <span class="comment">//</span>
<a name="l00312"></a>00312 <span class="comment">// Function: fg_set_capture_window</span>
<a name="l00313"></a>00313 <span class="comment">//</span>
<a name="l00314"></a>00314 <span class="comment">// Description: Specifies a sub-window of the input source to capture.</span>
<a name="l00315"></a>00315 <span class="comment">//</span>
<a name="l00316"></a>00316 <span class="comment">// Parameters: int x }</span>
<a name="l00317"></a>00317 <span class="comment">// int y } A window that is smaller than</span>
<a name="l00318"></a>00318 <span class="comment">// int width } or equal to the capture window</span>
<a name="l00319"></a>00319 <span class="comment">// int height }</span>
<a name="l00320"></a>00320 <span class="comment">//</span>
<a name="l00321"></a>00321 <span class="comment">// Returns: 0 Success</span>
<a name="l00322"></a>00322 <span class="comment">// -1 Failure</span>
<a name="l00323"></a>00323 <span class="comment">//</span>
<a name="l00324"></a>00324 <span class="comment">//--------------------------------------------------------------------------</span>
<a name="l00325"></a>00325
<a name="l00326"></a>00326 <span class="keywordtype">int</span> fg_set_capture_window( <a class="code" href="structFRAMEGRABBER.html">FRAMEGRABBER</a>* fg,
<a name="l00327"></a>00327 <span class="keywordtype">int</span> x, <span class="keywordtype">int</span> y, <span class="keywordtype">int</span> width, <span class="keywordtype">int</span> height );
<a name="l00328"></a>00328
<a name="l00329"></a>00329
<a name="l00330"></a>00330 <span class="comment">//--------------------------------------------------------------------------</span>
<a name="l00331"></a>00331 <span class="comment">//</span>
<a name="l00332"></a>00332 <span class="comment">// Function: fg_set_brightness</span>
<a name="l00333"></a>00333 <span class="comment">//</span>
<a name="l00334"></a>00334 <span class="comment">// Description: Sets the picture brightness to the specified value.</span>
<a name="l00335"></a>00335 <span class="comment">//</span>
<a name="l00336"></a>00336 <span class="comment">// Parameters: int br Brightness (integer value)</span>
<a name="l00337"></a>00337 <span class="comment">//</span>
<a name="l00338"></a>00338 <span class="comment">// Returns: 0 Success</span>
<a name="l00339"></a>00339 <span class="comment">// -1 Failure</span>
<a name="l00340"></a>00340 <span class="comment">//</span>
<a name="l00341"></a>00341 <span class="comment">//--------------------------------------------------------------------------</span>
<a name="l00342"></a>00342
<a name="l00343"></a>00343 <span class="keywordtype">int</span> fg_set_brightness( <a class="code" href="structFRAMEGRABBER.html">FRAMEGRABBER</a>* fg, <span class="keywordtype">int</span> br );
<a name="l00344"></a>00344
<a name="l00345"></a>00345
<a name="l00346"></a>00346 <span class="comment">//--------------------------------------------------------------------------</span>
<a name="l00347"></a>00347 <span class="comment">//</span>
<a name="l00348"></a>00348 <span class="comment">// Function: fg_set_contrast</span>
<a name="l00349"></a>00349 <span class="comment">//</span>
<a name="l00350"></a>00350 <span class="comment">// Description: Sets the picture contrast to the specified value.</span>
<a name="l00351"></a>00351 <span class="comment">//</span>
<a name="l00352"></a>00352 <span class="comment">// Parameters: int ct Contrast (integer value)</span>
<a name="l00353"></a>00353 <span class="comment">//</span>
<a name="l00354"></a>00354 <span class="comment">// Returns: 0 Success</span>
<a name="l00355"></a>00355 <span class="comment">// -1 Failure</span>
<a name="l00356"></a>00356 <span class="comment">//</span>
<a name="l00357"></a>00357 <span class="comment">//--------------------------------------------------------------------------</span>
<a name="l00358"></a>00358
<a name="l00359"></a>00359 <span class="keywordtype">int</span> fg_set_contrast( <a class="code" href="structFRAMEGRABBER.html">FRAMEGRABBER</a>* fg, <span class="keywordtype">int</span> ct );
<a name="l00360"></a>00360
<a name="l00361"></a>00361 <span class="keywordtype">int</span> fg_set_hue( <a class="code" href="structFRAMEGRABBER.html">FRAMEGRABBER</a>* fg, <span class="keywordtype">int</span> hue );
<a name="l00362"></a>00362 <span class="keywordtype">int</span> fg_set_colour( <a class="code" href="structFRAMEGRABBER.html">FRAMEGRABBER</a>* fg, <span class="keywordtype">int</span> clr );
<a name="l00363"></a>00363
<a name="l00364"></a>00364 <span class="comment">//--------------------------------------------------------------------------</span>
<a name="l00365"></a>00365 <span class="comment">//</span>
<a name="l00366"></a>00366 <span class="comment">// Function: fg_new_compatible_frame</span>
<a name="l00367"></a>00367 <span class="comment">//</span>
<a name="l00368"></a>00368 <span class="comment">// Description: Returns a newly allocated frame that is compatible with</span>
<a name="l00369"></a>00369 <span class="comment">// the current frame grabber settings; that is, the window</span>
<a name="l00370"></a>00370 <span class="comment">// width and height, and the capture format. This frame</span>
<a name="l00371"></a>00371 <span class="comment">// must be deleted by the caller with frame_release().</span>
<a name="l00372"></a>00372 <span class="comment">//</span>
<a name="l00373"></a>00373 <span class="comment">// Returns: FRAME* A new frame</span>
<a name="l00374"></a>00374 <span class="comment">//</span>
<a name="l00375"></a>00375 <span class="comment">//--------------------------------------------------------------------------</span>
<a name="l00376"></a>00376
<a name="l00377"></a>00377 <a class="code" href="structFRAME.html">FRAME</a>* fg_new_compatible_frame( <a class="code" href="structFRAMEGRABBER.html">FRAMEGRABBER</a>* fg );
<a name="l00378"></a>00378
<a name="l00379"></a>00379
<a name="l00380"></a>00380 <span class="comment">//--------------------------------------------------------------------------</span>
<a name="l00381"></a>00381 <span class="comment">//</span>
<a name="l00382"></a>00382 <span class="comment">// Function: fg_dump_info</span>
<a name="l00383"></a>00383 <span class="comment">//</span>
<a name="l00384"></a>00384 <span class="comment">// Description: Dumps to the console on stdout all the status</span>
<a name="l00385"></a>00385 <span class="comment">// information available for the framegrabber.</span>
<a name="l00386"></a>00386 <span class="comment">//</span>
<a name="l00387"></a>00387 <span class="comment">//--------------------------------------------------------------------------</span>
<a name="l00388"></a>00388
<a name="l00389"></a>00389 <span class="keywordtype">void</span> fg_dump_info( <a class="code" href="structFRAMEGRABBER.html">FRAMEGRABBER</a>* fg );
<a name="l00390"></a>00390
<a name="l00391"></a>00391
<a name="l00392"></a>00392 <span class="comment">//==========================================================================</span>
<a name="l00393"></a>00393
<a name="l00394"></a>00394 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00395"></a>00395 <span class="preprocessor"></span>}
<a name="l00396"></a>00396 <span class="preprocessor">#endif</span>
<a name="l00397"></a>00397 <span class="preprocessor"></span>
<a name="l00398"></a>00398 <span class="preprocessor">#endif </span><span class="comment">/* __CAPTURE__H_ */</span>
</pre></div></div>
</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>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
727fa15453fcace956b835e2377d4269
>
files
>
1739
