NOAA/seiscomp-training
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
59ff39ef0d0caa9a2b817f5f3a02bc9c770d0013
seiscomp-training/share/doc/caps/html/apps/v4l2caps.html

386 lines
22 KiB
HTML
Raw Blame History

<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>v4l2caps &#8212; CAPS: Common Acquisition Protocol Server documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/gempa.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../_static/gempa.css?v=c960eebf" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<script type="text/javascript" src="../_static/gempa.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=b3ba4146"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="win2caps" href="win2caps.html" />
<link rel="prev" title="test2caps" href="test2caps.html" />
</head>
<body>
<div class="header">
<div class="container">
<img class="background" src="../_static/icon.png"/>
<div class="content">
<span class="title">CAPS: Common Acquisition Protocol Server </span>
<span class="version">2025.254#f0c77b29e</span></h1>
</div>
</div>
</div>
<div class="nav">
<div class="container">
<div class="content"><a class="pull-right" id="sidebar-toggle">TOC</a>
<div class="related" role="navigation" aria-label="related navigation">
<ul>
<li class="right">
<a href="../genindex.html" title="General Index"
accesskey="I">
index
</a>
</li>
<li class="right">
<a href="win2caps.html" title="win2caps"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="test2caps.html" title="test2caps"
accesskey="P">
previous
</a>
</li>
<li class="nav-item nav-item-0">
<a href="../index.html">Home</a>
</li>
<li class="nav-item nav-item-1">
<a href="../base/plugins.html" accesskey="U">Data Acquisition and Manipulation by Plugins</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="v4l2caps">
<span id="id1"></span><h1>v4l2caps<a class="headerlink" href="#v4l2caps" title="Permalink to this heading"></a></h1>
<p><strong>Video for Linux capture plugin</strong></p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>Video for Linux is a video capture application programming interface(API) and
library for Linux. The library supports many USB web cams, TV tuners as
well as other devices and is the common way to access multimedia devices under
Linux. The v4l2caps plugin uses the Video for Linux API to capture frames from
compatible hardware devices and stores each frame into CAPS.
Available resolutions, pixel formats and other parameters depend on the used
device. See the manual of the hardware manufacturer for more details.
The capture process of the plugin gets a frame in a given sampling interval.
For each frame a new ANY packet is created which uses the sampling time
of the frame as start and end time for the packet. In addition the format of the
packet is set to the selected pixel format. Frame drops may occur when the
storage system is not fast enough to handle incoming data.</p>
</section>
<section id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2>
<p>To capture 15 images per second (the maximum number of images depends on your hardware) and store the output into CAPS use:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>v4l2caps<span class="w"> </span>-s<span class="w"> </span>SW.HMA.317.CAM<span class="w"> </span>--interval<span class="w"> </span><span class="m">15</span>/1
</pre></div>
</div>
</section>
<section id="module-configuration">
<h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading"></a></h2>
<div class="line-block">
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/v4l2caps.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/v4l2caps.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/v4l2caps.cfg</span></code></div>
</div>
<p>v4l2caps inherits <a class="reference internal" href="global.html#global-configuration"><span class="std std-ref">global options</span></a>.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Modules/plugins may require a license file. The default path to license
files is <code class="file docutils literal notranslate"><span class="pre">&#64;DATADIR&#64;/licenses/</span></code> which can be overridden by global
configuration of the parameter <code class="xref std std-confval docutils literal notranslate"><span class="pre">gempa.licensePath</span></code>. Example:</p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>gempa.licensePath = @CONFIGDIR@/licenses
</pre></div>
</div>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-host">
<span class="sig-name descname"><span class="pre">host</span></span><a class="headerlink" href="#confval-host" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">localhost</span></code></p>
<p>Type: <em>string</em></p>
<p>Data output host</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-port">
<span class="sig-name descname"><span class="pre">port</span></span><a class="headerlink" href="#confval-port" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">18003</span></code></p>
<p>Type: <em>uint</em></p>
<p>Data output host</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-streamID">
<span class="sig-name descname"><span class="pre">streamID</span></span><a class="headerlink" href="#confval-streamID" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Stream ID to use, format is [net.sta.loc.cha]</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-resolution">
<span class="sig-name descname"><span class="pre">resolution</span></span><a class="headerlink" href="#confval-resolution" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Resolution to use</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-outputFormat">
<span class="sig-name descname"><span class="pre">outputFormat</span></span><a class="headerlink" href="#confval-outputFormat" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Output format to use [rgb, jpg]</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-outputQuality">
<span class="sig-name descname"><span class="pre">outputQuality</span></span><a class="headerlink" href="#confval-outputQuality" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">100</span></code></p>
<p>Type: <em>int</em></p>
<p>Output quality to use [0-100]</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-interval">
<span class="sig-name descname"><span class="pre">interval</span></span><a class="headerlink" href="#confval-interval" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>uint</em></p>
<p>Sampling interval to use, format is [Denominator/Numerator]</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-pixelFormat">
<span class="sig-name descname"><span class="pre">pixelFormat</span></span><a class="headerlink" href="#confval-pixelFormat" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Pixel format to use, expected as four character code[ABCD]</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-count">
<span class="sig-name descname"><span class="pre">count</span></span><a class="headerlink" href="#confval-count" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">0</span></code></p>
<p>Type: <em>uint</em></p>
<p>Number of frames to grab</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-skip">
<span class="sig-name descname"><span class="pre">skip</span></span><a class="headerlink" href="#confval-skip" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">0</span></code></p>
<p>Type: <em>uint</em></p>
<p>Number of frames to skip</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-bufferSize">
<span class="sig-name descname"><span class="pre">bufferSize</span></span><a class="headerlink" href="#confval-bufferSize" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">1048576</span></code></p>
<p>Type: <em>uint</em></p>
<p>Size (bytes) of the internal buffer to keep still unconfirmed packages</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-device">
<span class="sig-name descname"><span class="pre">device</span></span><a class="headerlink" href="#confval-device" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">/dev/video0</span></code></p>
<p>Type: <em>string</em></p>
<p>Video device name</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-io">
<span class="sig-name descname"><span class="pre">io</span></span><a class="headerlink" href="#confval-io" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">1</span></code></p>
<p>Type: <em>uint</em></p>
<p>I/O method. 0: Use read function, 1: Use memory mapped buffers</p>
</dd></dl>
</section>
<section id="command-line-options">
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading"></a></h2>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-b">
<span id="cmdoption-buffer-size"></span><span class="sig-name descname"><span class="pre">-b</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--buffer-size</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-b" title="Permalink to this definition"></a></dt>
<dd><p>Size (bytes) of the internal buffer to keep still unconfirmed packages</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-c">
<span id="cmdoption-count"></span><span class="sig-name descname"><span class="pre">-c</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--count</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-c" title="Permalink to this definition"></a></dt>
<dd><p>Number of frames to grab</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-config">
<span class="sig-name descname"><span class="pre">--config</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-config" title="Permalink to this definition"></a></dt>
<dd><p>Path to configuration file</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-d">
<span id="cmdoption-device"></span><span class="sig-name descname"><span class="pre">-d</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--device</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-d" title="Permalink to this definition"></a></dt>
<dd><p>Video device name</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-dump">
<span class="sig-name descname"><span class="pre">--dump</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-dump" title="Permalink to this definition"></a></dt>
<dd><p>Dump output to file</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-f">
<span id="cmdoption-pixel-format"></span><span class="sig-name descname"><span class="pre">-f</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--pixel-format</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-f" title="Permalink to this definition"></a></dt>
<dd><p>Pixel format to use, expected as four character code[ABCD]</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-F">
<span id="cmdoption-output-format"></span><span class="sig-name descname"><span class="pre">-F</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--output-format</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-F" title="Permalink to this definition"></a></dt>
<dd><p>Output format to use [rgb, jpg]</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-H">
<span id="cmdoption-host"></span><span class="sig-name descname"><span class="pre">-H</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--host</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-H" title="Permalink to this definition"></a></dt>
<dd><p>Data output host</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-h">
<span id="cmdoption-help"></span><span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--help</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-h" title="Permalink to this definition"></a></dt>
<dd><p>Print help</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-info">
<span class="sig-name descname"><span class="pre">--info</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-info" title="Permalink to this definition"></a></dt>
<dd><p>Print device info</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-i">
<span id="cmdoption-interval"></span><span class="sig-name descname"><span class="pre">-i</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--interval</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-i" title="Permalink to this definition"></a></dt>
<dd><p>Sampling interval to use, format is [Denominator/Numerator]</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-io">
<span class="sig-name descname"><span class="pre">--io</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-io" title="Permalink to this definition"></a></dt>
<dd><p>I/O method. 0: Use read function, 1: Use memory mapped buffers [default]</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-p">
<span id="cmdoption-port"></span><span class="sig-name descname"><span class="pre">-p</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--port</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-p" title="Permalink to this definition"></a></dt>
<dd><p>Data output port</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-q">
<span id="cmdoption-output-quality"></span><span class="sig-name descname"><span class="pre">-q</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--output-quality</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-q" title="Permalink to this definition"></a></dt>
<dd><p>Output quality to use [0-100]</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-r">
<span id="cmdoption-resolution"></span><span class="sig-name descname"><span class="pre">-r</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--resolution</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-r" title="Permalink to this definition"></a></dt>
<dd><p>Resolution to use</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-s">
<span id="cmdoption-stream-id"></span><span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--stream-id</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-s" title="Permalink to this definition"></a></dt>
<dd><p>Stream ID to use, format is [net.sta.loc.cha]</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-S">
<span id="cmdoption-skip"></span><span class="sig-name descname"><span class="pre">-S</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--skip</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-S" title="Permalink to this definition"></a></dt>
<dd><p>Number of frames to skip</p>
</dd></dl>
</section>
</section>
<div id="anchors-bottom"></div>
</div>
<div class="sidebar" role="navigation" aria-label="main navigation">
<div id="anchors-top"></div>
<div id="anchors" class="content">
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">v4l2caps</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#examples">Examples</a></li>
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a></li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="test2caps.html"
title="previous chapter">test2caps</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="win2caps.html"
title="next chapter">win2caps</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/v4l2caps.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<div class="container">
<div class="content">
Release <b></b> version <b>2025.254#f0c77b29e</b>
<div class="copyright">
&copy; Copyright <a href="https://www.gempa.de">2013, gempa GmbH.</a>
</div>
</div>
</div>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink