<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>mrpt::hwdrivers::CFFMPEG_InputStream Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<div align="left"><a href="http://www.mrpt.org/">Main MRPT website</a> > <b>C++ reference</b> </div>
<div align="right">
<a href="index.html"><img border="0" src="mrpt_logo.png" alt="MRPT logo"></a>
</div>
<!-- Generated by Doxygen 1.7.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<div class="left">
<form id="FSearchBox" action="search.php" method="get">
<img id="MSearchSelect" src="search/mag.png" alt=""/>
<input type="text" id="MSearchField" name="query" value="Search" size="20" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"/>
</form>
</div><div class="right"></div>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacemrpt.html">mrpt</a> </li>
<li class="navelem"><a class="el" href="namespacemrpt_1_1hwdrivers.html">hwdrivers</a> </li>
<li class="navelem"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_f_f_m_p_e_g___input_stream.html">CFFMPEG_InputStream</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pri-attribs">Private Attributes</a> </div>
<div class="headertitle">
<div class="title">mrpt::hwdrivers::CFFMPEG_InputStream Class Reference<div class="ingroups"><a class="el" href="group__mrpt__hwdrivers__grp.html">[mrpt-hwdrivers]</a></div></div> </div>
</div>
<div class="contents">
<!-- doxytag: class="mrpt::hwdrivers::CFFMPEG_InputStream" --><hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A generic class which process a video file or other kind of input stream (http, rtsp) and allows the extraction of images frame by frame. </p>
<p>Video sources can be open with "openURL", which can manage both video files and "rtsp://" sources (IP cameras).</p>
<p>Frames are retrieved by calling <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_f_f_m_p_e_g___input_stream.html#a0578c1a05ce02cc82c58d0d1983684a0" title="Get the next frame from the video stream.">CFFMPEG_InputStream::retrieveFrame</a></p>
<p>For an example of usage, see the file "samples/grab_camera_ffmpeg"</p>
<dl class="note"><dt><b>Note:</b></dt><dd>This class is an easy to use C++ wrapper for ffmpeg libraries (libavcodec). In Unix systems these libraries must be installed in the system as explained in <a href="http://www.mrpt.org/Building_and_Installing_Instructions">MRPT's wiki</a>. In Win32, a precompiled version for Visual Studio must be also downloaded as explained in <a href="http://www.mrpt.org/Building_and_Installing_Instructions">the wiki</a>. </dd></dl>
</div>
<p><code>#include <<a class="el" href="_c_f_f_m_p_e_g___input_stream_8h_source.html">mrpt/hwdrivers/CFFMPEG_InputStream.h</a>></code></p>
<p><a href="classmrpt_1_1hwdrivers_1_1_c_f_f_m_p_e_g___input_stream-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_f_f_m_p_e_g___input_stream.html#a867235d49f93cd971eb0cdb71d61f09c">CFFMPEG_InputStream</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor, does not open any video source at startup. <a href="#a867235d49f93cd971eb0cdb71d61f09c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_f_f_m_p_e_g___input_stream.html#a2ea5d44076667aba8fa3860e71e49e6b">~CFFMPEG_InputStream</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a2ea5d44076667aba8fa3860e71e49e6b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_f_f_m_p_e_g___input_stream.html#a80ba00584cd413160561c07b10eab771">openURL</a> (const <a class="el" href="classstd_1_1string.html">std::string</a> &url, bool grab_as_grayscale=false, bool verbose=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Open a video file or a video stream (rtsp://) This can be used to open local video files (eg. <a href="#a80ba00584cd413160561c07b10eab771"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_f_f_m_p_e_g___input_stream.html#a987c7364348edfb2c00432ec284ef510">isOpen</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return whether the video source was open correctly. <a href="#a987c7364348edfb2c00432ec284ef510"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_f_f_m_p_e_g___input_stream.html#a72dd97b0ef9b8b6b2e5a18906f688cdd">close</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Close the video stream (this is called automatically at destruction). <a href="#a72dd97b0ef9b8b6b2e5a18906f688cdd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_f_f_m_p_e_g___input_stream.html#a656c0f66ed8d88a200bf615040b92236">getVideoFPS</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the frame-per-second (FPS) of the video source, or "-1" if the video is not open. <a href="#a656c0f66ed8d88a200bf615040b92236"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_f_f_m_p_e_g___input_stream.html#a0578c1a05ce02cc82c58d0d1983684a0">retrieveFrame</a> (<a class="el" href="classmrpt_1_1utils_1_1_c_image.html">mrpt::utils::CImage</a> &out_img)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the next frame from the video stream. <a href="#a0578c1a05ce02cc82c58d0d1983684a0"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacemrpt_1_1utils.html#ac3912bceb5e2a4662830ec51584d134b">mrpt::utils::void_ptr_noncopy</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_f_f_m_p_e_g___input_stream.html#a5bf3ab77ea19936e32ed1f5952552c05">m_state</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The internal ffmpeg state. <a href="#a5bf3ab77ea19936e32ed1f5952552c05"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstd_1_1string.html">std::string</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_f_f_m_p_e_g___input_stream.html#a828a3e17c94eddf4646c9d089175f250">m_url</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The open URL. <a href="#a828a3e17c94eddf4646c9d089175f250"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_f_f_m_p_e_g___input_stream.html#a58fd5fc58af7a12628e550596bad80c5">m_grab_as_grayscale</a></td></tr>
</table>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a867235d49f93cd971eb0cdb71d61f09c"></a><!-- doxytag: member="mrpt::hwdrivers::CFFMPEG_InputStream::CFFMPEG_InputStream" ref="a867235d49f93cd971eb0cdb71d61f09c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mrpt::hwdrivers::CFFMPEG_InputStream::CFFMPEG_InputStream </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Default constructor, does not open any video source at startup. </p>
</div>
</div>
<a class="anchor" id="a2ea5d44076667aba8fa3860e71e49e6b"></a><!-- doxytag: member="mrpt::hwdrivers::CFFMPEG_InputStream::~CFFMPEG_InputStream" ref="a2ea5d44076667aba8fa3860e71e49e6b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual mrpt::hwdrivers::CFFMPEG_InputStream::~CFFMPEG_InputStream </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a72dd97b0ef9b8b6b2e5a18906f688cdd"></a><!-- doxytag: member="mrpt::hwdrivers::CFFMPEG_InputStream::close" ref="a72dd97b0ef9b8b6b2e5a18906f688cdd" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mrpt::hwdrivers::CFFMPEG_InputStream::close </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Close the video stream (this is called automatically at destruction). </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_f_f_m_p_e_g___input_stream.html#a80ba00584cd413160561c07b10eab771" title="Open a video file or a video stream (rtsp://) This can be used to open local video files (eg...">openURL</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a656c0f66ed8d88a200bf615040b92236"></a><!-- doxytag: member="mrpt::hwdrivers::CFFMPEG_InputStream::getVideoFPS" ref="a656c0f66ed8d88a200bf615040b92236" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double mrpt::hwdrivers::CFFMPEG_InputStream::getVideoFPS </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the frame-per-second (FPS) of the video source, or "-1" if the video is not open. </p>
</div>
</div>
<a class="anchor" id="a987c7364348edfb2c00432ec284ef510"></a><!-- doxytag: member="mrpt::hwdrivers::CFFMPEG_InputStream::isOpen" ref="a987c7364348edfb2c00432ec284ef510" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool mrpt::hwdrivers::CFFMPEG_InputStream::isOpen </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return whether the video source was open correctly. </p>
</div>
</div>
<a class="anchor" id="a80ba00584cd413160561c07b10eab771"></a><!-- doxytag: member="mrpt::hwdrivers::CFFMPEG_InputStream::openURL" ref="a80ba00584cd413160561c07b10eab771" args="(const std::string &url, bool grab_as_grayscale=false, bool verbose=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool mrpt::hwdrivers::CFFMPEG_InputStream::openURL </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classstd_1_1string.html">std::string</a> & </td>
<td class="paramname"><em>url</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>grab_as_grayscale</em> = <code>false</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>verbose</em> = <code>false</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Open a video file or a video stream (rtsp://) This can be used to open local video files (eg. </p>
<p>"myVideo.avi", "c:\a.mpeg") and also IP cameras (e. "rtsp://a.b.c.d/live.sdp"). However, note that there is currently no support for user/password in IP access. If verbose is set to true, more information about the video will be dumped to cout.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_f_f_m_p_e_g___input_stream.html#a72dd97b0ef9b8b6b2e5a18906f688cdd" title="Close the video stream (this is called automatically at destruction).">close</a>, <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_f_f_m_p_e_g___input_stream.html#a0578c1a05ce02cc82c58d0d1983684a0" title="Get the next frame from the video stream.">retrieveFrame</a> </dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>false on any error (and error info dumped to cerr), true on success. </dd></dl>
</div>
</div>
<a class="anchor" id="a0578c1a05ce02cc82c58d0d1983684a0"></a><!-- doxytag: member="mrpt::hwdrivers::CFFMPEG_InputStream::retrieveFrame" ref="a0578c1a05ce02cc82c58d0d1983684a0" args="(mrpt::utils::CImage &out_img)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool mrpt::hwdrivers::CFFMPEG_InputStream::retrieveFrame </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classmrpt_1_1utils_1_1_c_image.html">mrpt::utils::CImage</a> & </td>
<td class="paramname"><em>out_img</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the next frame from the video stream. </p>
<p>Note that for remote streams (IP cameras) this method may block until enough information is read to generate a new frame. Images are returned as 8-bit depth grayscale if "grab_as_grayscale" is true. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>false on any error, true on success. </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_f_f_m_p_e_g___input_stream.html#a80ba00584cd413160561c07b10eab771" title="Open a video file or a video stream (rtsp://) This can be used to open local video files (eg...">openURL</a>, <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_f_f_m_p_e_g___input_stream.html#a72dd97b0ef9b8b6b2e5a18906f688cdd" title="Close the video stream (this is called automatically at destruction).">close</a>, <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_f_f_m_p_e_g___input_stream.html#a987c7364348edfb2c00432ec284ef510" title="Return whether the video source was open correctly.">isOpen</a> </dd></dl>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a58fd5fc58af7a12628e550596bad80c5"></a><!-- doxytag: member="mrpt::hwdrivers::CFFMPEG_InputStream::m_grab_as_grayscale" ref="a58fd5fc58af7a12628e550596bad80c5" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_f_f_m_p_e_g___input_stream.html#a58fd5fc58af7a12628e550596bad80c5">mrpt::hwdrivers::CFFMPEG_InputStream::m_grab_as_grayscale</a><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_c_f_f_m_p_e_g___input_stream_8h_source.html#l00061">61</a> of file <a class="el" href="_c_f_f_m_p_e_g___input_stream_8h_source.html">CFFMPEG_InputStream.h</a>.</p>
</div>
</div>
<a class="anchor" id="a5bf3ab77ea19936e32ed1f5952552c05"></a><!-- doxytag: member="mrpt::hwdrivers::CFFMPEG_InputStream::m_state" ref="a5bf3ab77ea19936e32ed1f5952552c05" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacemrpt_1_1utils.html#ac3912bceb5e2a4662830ec51584d134b">mrpt::utils::void_ptr_noncopy</a> <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_f_f_m_p_e_g___input_stream.html#a5bf3ab77ea19936e32ed1f5952552c05">mrpt::hwdrivers::CFFMPEG_InputStream::m_state</a><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The internal ffmpeg state. </p>
<p>Definition at line <a class="el" href="_c_f_f_m_p_e_g___input_stream_8h_source.html#l00059">59</a> of file <a class="el" href="_c_f_f_m_p_e_g___input_stream_8h_source.html">CFFMPEG_InputStream.h</a>.</p>
</div>
</div>
<a class="anchor" id="a828a3e17c94eddf4646c9d089175f250"></a><!-- doxytag: member="mrpt::hwdrivers::CFFMPEG_InputStream::m_url" ref="a828a3e17c94eddf4646c9d089175f250" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classstd_1_1string.html">std::string</a> <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_f_f_m_p_e_g___input_stream.html#a828a3e17c94eddf4646c9d089175f250">mrpt::hwdrivers::CFFMPEG_InputStream::m_url</a><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The open URL. </p>
<p>Definition at line <a class="el" href="_c_f_f_m_p_e_g___input_stream_8h_source.html#l00060">60</a> of file <a class="el" href="_c_f_f_m_p_e_g___input_stream_8h_source.html">CFFMPEG_InputStream.h</a>.</p>
</div>
</div>
</div>
<br><hr><br> <table border="0" width="100%"> <tr> <td> Page generated by <a href="http://www.doxygen.org" target="_blank">Doxygen 1.7.5</a> for MRPT 0.9.5 SVN: at Sun Sep 25 17:20:18 UTC 2011</td><td></td> <td width="100"> </td> <td width="150"> </td></tr> </table> </body></html>
