<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>libdc1394: dc1394/capture.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>dc1394/capture.h File Reference</h1>
<p>Capture functions.
<a href="#_details">More...</a></p>
<code>#include <<a class="el" href="log_8h.html">dc1394/log.h</a>></code><br/>
<code>#include <<a class="el" href="video_8h.html">dc1394/video.h</a>></code><br/>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="capture_8h.html#a52f45fbe19942069c3e2ea66de1a7598">DC1394_CAPTURE_FLAGS_CHANNEL_ALLOC</a> 0x00000001U</td></tr>
<tr><td colspan="2"><h2>Enumerations</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="capture_8h.html#a972fba65a8de29a8b560031d25ee21ae">dc1394capture_policy_t</a> </td></tr>
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="log_8h.html#a197fe17c786e1f915d99cb19b270e541">dc1394error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="capture_8h.html#aa8fab925911bf54fc36496dc0579ddf1">dc1394_capture_setup</a> (<a class="el" href="struct____dc1394__camera.html">dc1394camera_t</a> *camera, uint32_t num_dma_buffers, uint32_t flags)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="log_8h.html#a197fe17c786e1f915d99cb19b270e541">dc1394error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="capture_8h.html#a9ba9e052b750f71cfb8a8e00e46b2efb">dc1394_capture_stop</a> (<a class="el" href="struct____dc1394__camera.html">dc1394camera_t</a> *camera)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="capture_8h.html#a0c633d5b3204b2e4488452d77bddbc4e">dc1394_capture_get_fileno</a> (<a class="el" href="struct____dc1394__camera.html">dc1394camera_t</a> *camera)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="log_8h.html#a197fe17c786e1f915d99cb19b270e541">dc1394error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="capture_8h.html#a76f870993f3c02753fb6176c774ad213">dc1394_capture_dequeue</a> (<a class="el" href="struct____dc1394__camera.html">dc1394camera_t</a> *camera, <a class="el" href="capture_8h.html#a972fba65a8de29a8b560031d25ee21ae">dc1394capture_policy_t</a> policy, <a class="el" href="struct____dc1394__video__frame.html">dc1394video_frame_t</a> **frame)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="log_8h.html#a197fe17c786e1f915d99cb19b270e541">dc1394error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="capture_8h.html#ac6cf3a92dddaf32c01beca2b1a7cd783">dc1394_capture_enqueue</a> (<a class="el" href="struct____dc1394__camera.html">dc1394camera_t</a> *camera, <a class="el" href="struct____dc1394__video__frame.html">dc1394video_frame_t</a> *frame)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#afde759d0fe0cd735ed4ee5453775d25a">dc1394bool_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="capture_8h.html#a3101beb97e4c05d60f8458d595eea2a2">dc1394_capture_is_frame_corrupt</a> (<a class="el" href="struct____dc1394__camera.html">dc1394camera_t</a> *camera, <a class="el" href="struct____dc1394__video__frame.html">dc1394video_frame_t</a> *frame)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Capture functions. </p>
<dl class="author"><dt><b>Author:</b></dt><dd>Damien Douxchamps: coding </dd>
<dd>
Peter Antoniac: documentation maintainer</dd></dl>
<p>More details soon </p>
<hr/><h2>Define Documentation</h2>
<a class="anchor" id="a52f45fbe19942069c3e2ea66de1a7598"></a><!-- doxytag: member="capture.h::DC1394_CAPTURE_FLAGS_CHANNEL_ALLOC" ref="a52f45fbe19942069c3e2ea66de1a7598" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define DC1394_CAPTURE_FLAGS_CHANNEL_ALLOC 0x00000001U</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Capture flags. Currently limited to switching automatic functions on/off: channel allocation, bandwidth allocation and automatic starting of ISO transmission </p>
</div>
</div>
<hr/><h2>Enumeration Type Documentation</h2>
<a class="anchor" id="a972fba65a8de29a8b560031d25ee21ae"></a><!-- doxytag: member="capture.h::dc1394capture_policy_t" ref="a972fba65a8de29a8b560031d25ee21ae" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="capture_8h.html#a972fba65a8de29a8b560031d25ee21ae">dc1394capture_policy_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The capture policy.</p>
<p>Can be blocking (wait for a frame forever) or polling (returns if no frames is in the ring buffer) </p>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="a76f870993f3c02753fb6176c774ad213"></a><!-- doxytag: member="capture.h::dc1394_capture_dequeue" ref="a76f870993f3c02753fb6176c774ad213" args="(dc1394camera_t *camera, dc1394capture_policy_t policy, dc1394video_frame_t **frame)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="log_8h.html#a197fe17c786e1f915d99cb19b270e541">dc1394error_t</a> dc1394_capture_dequeue </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct____dc1394__camera.html">dc1394camera_t</a> * </td>
<td class="paramname"> <em>camera</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="capture_8h.html#a972fba65a8de29a8b560031d25ee21ae">dc1394capture_policy_t</a> </td>
<td class="paramname"> <em>policy</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct____dc1394__video__frame.html">dc1394video_frame_t</a> ** </td>
<td class="paramname"> <em>frame</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Captures a video frame. The returned struct contains the image buffer, among others. This image buffer SHALL NOT be freed, as it represents an area in the memory that belongs to the system. </p>
</div>
</div>
<a class="anchor" id="ac6cf3a92dddaf32c01beca2b1a7cd783"></a><!-- doxytag: member="capture.h::dc1394_capture_enqueue" ref="ac6cf3a92dddaf32c01beca2b1a7cd783" args="(dc1394camera_t *camera, dc1394video_frame_t *frame)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="log_8h.html#a197fe17c786e1f915d99cb19b270e541">dc1394error_t</a> dc1394_capture_enqueue </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct____dc1394__camera.html">dc1394camera_t</a> * </td>
<td class="paramname"> <em>camera</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct____dc1394__video__frame.html">dc1394video_frame_t</a> * </td>
<td class="paramname"> <em>frame</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a frame to the ring buffer once it has been used. </p>
</div>
</div>
<a class="anchor" id="a0c633d5b3204b2e4488452d77bddbc4e"></a><!-- doxytag: member="capture.h::dc1394_capture_get_fileno" ref="a0c633d5b3204b2e4488452d77bddbc4e" args="(dc1394camera_t *camera)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int dc1394_capture_get_fileno </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct____dc1394__camera.html">dc1394camera_t</a> * </td>
<td class="paramname"> <em>camera</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets a file descriptor to be used for select(). Must be called after <a class="el" href="capture_8h.html#aa8fab925911bf54fc36496dc0579ddf1">dc1394_capture_setup()</a>. </p>
</div>
</div>
<a class="anchor" id="a3101beb97e4c05d60f8458d595eea2a2"></a><!-- doxytag: member="capture.h::dc1394_capture_is_frame_corrupt" ref="a3101beb97e4c05d60f8458d595eea2a2" args="(dc1394camera_t *camera, dc1394video_frame_t *frame)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#afde759d0fe0cd735ed4ee5453775d25a">dc1394bool_t</a> dc1394_capture_is_frame_corrupt </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct____dc1394__camera.html">dc1394camera_t</a> * </td>
<td class="paramname"> <em>camera</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct____dc1394__video__frame.html">dc1394video_frame_t</a> * </td>
<td class="paramname"> <em>frame</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns DC1394_TRUE if the given frame (previously dequeued) has been detected to be corrupt (missing data, corrupted data, overrun buffer, etc.). Note that certain types of corruption may go undetected in which case DC1394_FALSE will be returned. The ability to detect corruption also varies between platforms. Note that corrupt frames still need to be enqueued with <a class="el" href="capture_8h.html#ac6cf3a92dddaf32c01beca2b1a7cd783">dc1394_capture_enqueue()</a> when no longer needed by the user. </p>
</div>
</div>
<a class="anchor" id="aa8fab925911bf54fc36496dc0579ddf1"></a><!-- doxytag: member="capture.h::dc1394_capture_setup" ref="aa8fab925911bf54fc36496dc0579ddf1" args="(dc1394camera_t *camera, uint32_t num_dma_buffers, uint32_t flags)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="log_8h.html#a197fe17c786e1f915d99cb19b270e541">dc1394error_t</a> dc1394_capture_setup </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct____dc1394__camera.html">dc1394camera_t</a> * </td>
<td class="paramname"> <em>camera</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"> <em>num_dma_buffers</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"> <em>flags</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Setup the capture, using a ring buffer of a certain size (num_dma_buffers) and certain options (flags) </p>
</div>
</div>
<a class="anchor" id="a9ba9e052b750f71cfb8a8e00e46b2efb"></a><!-- doxytag: member="capture.h::dc1394_capture_stop" ref="a9ba9e052b750f71cfb8a8e00e46b2efb" args="(dc1394camera_t *camera)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="log_8h.html#a197fe17c786e1f915d99cb19b270e541">dc1394error_t</a> dc1394_capture_stop </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct____dc1394__camera.html">dc1394camera_t</a> * </td>
<td class="paramname"> <em>camera</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Stop the capture </p>
</div>
</div>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on 10 Sep 2009 for libdc1394 by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
