• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html>
3<head>
4<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5<title>pcapparse: GStreamer Bad Plugins 1.0 Plugins Reference Manual</title>
6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
7<link rel="home" href="index.html" title="GStreamer Bad Plugins 1.0 Plugins Reference Manual">
8<link rel="up" href="ch01.html" title="gst-plugins-bad Elements">
9<link rel="prev" href="gst-plugins-bad-plugins-opusparse.html" title="opusparse">
10<link rel="next" href="gst-plugins-bad-plugins-perspective.html" title="perspective">
11<meta name="generator" content="GTK-Doc V1.28 (XML mode)">
12<link rel="stylesheet" href="style.css" type="text/css">
13</head>
14<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
16<td width="100%" align="left" class="shortcuts">
17<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span18                  <a href="#gst-plugins-bad-plugins-pcapparse.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span19                  <a href="#gst-plugins-bad-plugins-pcapparse.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span20                  <a href="#gst-plugins-bad-plugins-pcapparse.properties" class="shortcut">Properties</a></span>
21</td>
22<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
23<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
24<td><a accesskey="p" href="gst-plugins-bad-plugins-opusparse.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
25<td><a accesskey="n" href="gst-plugins-bad-plugins-perspective.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
26</tr></table>
27<div class="refentry">
28<a name="gst-plugins-bad-plugins-pcapparse"></a><div class="titlepage"></div>
29<div class="refnamediv"><table width="100%"><tr>
30<td valign="top">
31<h2><span class="refentrytitle"><a name="gst-plugins-bad-plugins-pcapparse.top_of_page"></a>pcapparse</span></h2>
32<p>pcapparse</p>
33</td>
34<td class="gallery_image" valign="top" align="right"></td>
35</tr></table></div>
36<div class="refsect1">
37<a name="gst-plugins-bad-plugins-pcapparse.properties"></a><h2>Properties</h2>
38<div class="informaltable"><table class="informaltable" border="0">
39<colgroup>
40<col width="150px" class="properties_type">
41<col width="300px" class="properties_name">
42<col width="200px" class="properties_flags">
43</colgroup>
44<tbody>
45<tr>
46<td class="property_type">
47<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
48<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-pcapparse.html#GstPcapParse--dst-ip" title="The “dst-ip” property">dst-ip</a></td>
49<td class="property_flags">Read / Write</td>
50</tr>
51<tr>
52<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
53<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-pcapparse.html#GstPcapParse--dst-port" title="The “dst-port” property">dst-port</a></td>
54<td class="property_flags">Read / Write</td>
55</tr>
56<tr>
57<td class="property_type">
58<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
59<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-pcapparse.html#GstPcapParse--src-ip" title="The “src-ip” property">src-ip</a></td>
60<td class="property_flags">Read / Write</td>
61</tr>
62<tr>
63<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
64<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-pcapparse.html#GstPcapParse--src-port" title="The “src-port” property">src-port</a></td>
65<td class="property_flags">Read / Write</td>
66</tr>
67<tr>
68<td class="property_type">
69<a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstCaps.html#GstCaps-struct"><span class="type">GstCaps</span></a> *</td>
70<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-pcapparse.html#GstPcapParse--caps" title="The “caps” property">caps</a></td>
71<td class="property_flags">Read / Write</td>
72</tr>
73<tr>
74<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a></td>
75<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-pcapparse.html#GstPcapParse--ts-offset" title="The “ts-offset” property">ts-offset</a></td>
76<td class="property_flags">Read / Write</td>
77</tr>
78</tbody>
79</table></div>
80</div>
81<a name="GstPcapParse"></a><div class="refsect1">
82<a name="gst-plugins-bad-plugins-pcapparse.other"></a><h2>Types and Values</h2>
83<div class="informaltable"><table class="informaltable" width="100%" border="0">
84<colgroup>
85<col width="150px" class="name">
86<col class="description">
87</colgroup>
88<tbody><tr>
89<td class="datatype_keyword">struct</td>
90<td class="function_name"><a class="link" href="gst-plugins-bad-plugins-pcapparse.html#GstPcapParse-struct" title="struct GstPcapParse">GstPcapParse</a></td>
91</tr></tbody>
92</table></div>
93</div>
94<div class="refsect1">
95<a name="gst-plugins-bad-plugins-pcapparse.object-hierarchy"></a><h2>Object Hierarchy</h2>
96<pre class="screen">    <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
97    <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
98        <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a>
99            <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a>
100                <span class="lineart">╰──</span> GstPcapParse
101</pre>
102</div>
103<div class="refsect1">
104<a name="gst-plugins-bad-plugins-pcapparse.description"></a><h2>Description</h2>
105<p>Extracts payloads from Ethernet-encapsulated IP packets.
106Use <a class="link" href="gst-plugins-bad-plugins-pcapparse.html#GstPcapParse--src-ip" title="The “src-ip” property"><span class="type">“src-ip”</span></a>, <a class="link" href="gst-plugins-bad-plugins-pcapparse.html#GstPcapParse--dst-ip" title="The “dst-ip” property"><span class="type">“dst-ip”</span></a>,
107<a class="link" href="gst-plugins-bad-plugins-pcapparse.html#GstPcapParse--src-port" title="The “src-port” property"><span class="type">“src-port”</span></a> and <a class="link" href="gst-plugins-bad-plugins-pcapparse.html#GstPcapParse--dst-port" title="The “dst-port” property"><span class="type">“dst-port”</span></a> to restrict which packets
108should be included.</p>
109<p>The supported data format is the classical <a class="ulink" href="https://wiki.wireshark.org/Development/LibpcapFileFormat" target="_top">libpcap file
110format</a>.</p>
111<div class="refsect3">
112<a name="id-1.2.165.7.4"></a><h4>Example pipelines</h4>
113<div class="informalexample">
114  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
115    <tbody>
116      <tr>
117        <td class="listing_lines" align="right"><pre>1
1182</pre></td>
119        <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch<span class="gtkdoc opt">-</span><span class="number">1.0</span> filesrc location<span class="gtkdoc opt">=</span>h264crasher<span class="gtkdoc opt">.</span>pcap <span class="gtkdoc opt">!</span> pcapparse <span class="gtkdoc opt">!</span> rtph264depay
120<span class="gtkdoc opt">!</span> ffdec_h264 <span class="gtkdoc opt">!</span> fakesink</pre></td>
121      </tr>
122    </tbody>
123  </table>
124</div>
125
126<p> Read from a pcap dump file using filesrc, extract the raw UDP packets,
127depayload and decode them.</p>
128</div>
129<div class="refsynopsisdiv">
130<h2>Synopsis</h2>
131<div class="refsect2">
132<a name="id-1.2.165.7.5.1"></a><h3>Element Information</h3>
133<div class="variablelist"><table border="0" class="variablelist">
134<colgroup>
135<col align="left" valign="top">
136<col>
137</colgroup>
138<tbody>
139<tr>
140<td><p><span class="term">plugin</span></p></td>
141<td>
142            <a class="link" href="gst-plugins-bad-plugins-plugin-pcapparse.html#plugin-pcapparse">pcapparse</a>
143          </td>
144</tr>
145<tr>
146<td><p><span class="term">author</span></p></td>
147<td>Ole André Vadla Ravnås &lt;ole.andre.ravnas@tandberg.com&gt;</td>
148</tr>
149<tr>
150<td><p><span class="term">class</span></p></td>
151<td>Raw/Parser</td>
152</tr>
153</tbody>
154</table></div>
155</div>
156<hr>
157<div class="refsect2">
158<a name="id-1.2.165.7.5.2"></a><h3>Element Pads</h3>
159<div class="variablelist"><table border="0" class="variablelist">
160<colgroup>
161<col align="left" valign="top">
162<col>
163</colgroup>
164<tbody>
165<tr>
166<td><p><span class="term">name</span></p></td>
167<td>sink</td>
168</tr>
169<tr>
170<td><p><span class="term">direction</span></p></td>
171<td>sink</td>
172</tr>
173<tr>
174<td><p><span class="term">presence</span></p></td>
175<td>always</td>
176</tr>
177<tr>
178<td><p><span class="term">details</span></p></td>
179<td>raw/x-pcap</td>
180</tr>
181</tbody>
182</table></div>
183<div class="variablelist"><table border="0" class="variablelist">
184<colgroup>
185<col align="left" valign="top">
186<col>
187</colgroup>
188<tbody>
189<tr>
190<td><p><span class="term">name</span></p></td>
191<td>src</td>
192</tr>
193<tr>
194<td><p><span class="term">direction</span></p></td>
195<td>source</td>
196</tr>
197<tr>
198<td><p><span class="term">presence</span></p></td>
199<td>always</td>
200</tr>
201<tr>
202<td><p><span class="term">details</span></p></td>
203<td>ANY</td>
204</tr>
205</tbody>
206</table></div>
207</div>
208</div>
209</div>
210<div class="refsect1">
211<a name="gst-plugins-bad-plugins-pcapparse.functions_details"></a><h2>Functions</h2>
212<p></p>
213</div>
214<div class="refsect1">
215<a name="gst-plugins-bad-plugins-pcapparse.other_details"></a><h2>Types and Values</h2>
216<div class="refsect2">
217<a name="GstPcapParse-struct"></a><h3>struct GstPcapParse</h3>
218<pre class="programlisting">struct GstPcapParse;</pre>
219<p>GstPcapParse element.</p>
220</div>
221</div>
222<div class="refsect1">
223<a name="gst-plugins-bad-plugins-pcapparse.property-details"></a><h2>Property Details</h2>
224<div class="refsect2">
225<a name="GstPcapParse--dst-ip"></a><h3>The <code class="literal">“dst-ip”</code> property</h3>
226<pre class="programlisting">  “dst-ip”                   <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
227<p>Destination IP to restrict to.</p>
228<p>Flags: Read / Write</p>
229<p>Default value: ""</p>
230</div>
231<hr>
232<div class="refsect2">
233<a name="GstPcapParse--dst-port"></a><h3>The <code class="literal">“dst-port”</code> property</h3>
234<pre class="programlisting">  “dst-port”                 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
235<p>Destination port to restrict to.</p>
236<p>Flags: Read / Write</p>
237<p>Allowed values: [G_MAXULONG,65535]</p>
238<p>Default value: -1</p>
239</div>
240<hr>
241<div class="refsect2">
242<a name="GstPcapParse--src-ip"></a><h3>The <code class="literal">“src-ip”</code> property</h3>
243<pre class="programlisting">  “src-ip”                   <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
244<p>Source IP to restrict to.</p>
245<p>Flags: Read / Write</p>
246<p>Default value: ""</p>
247</div>
248<hr>
249<div class="refsect2">
250<a name="GstPcapParse--src-port"></a><h3>The <code class="literal">“src-port”</code> property</h3>
251<pre class="programlisting">  “src-port”                 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
252<p>Source port to restrict to.</p>
253<p>Flags: Read / Write</p>
254<p>Allowed values: [G_MAXULONG,65535]</p>
255<p>Default value: -1</p>
256</div>
257<hr>
258<div class="refsect2">
259<a name="GstPcapParse--caps"></a><h3>The <code class="literal">“caps”</code> property</h3>
260<pre class="programlisting">  “caps”                     <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstCaps.html#GstCaps-struct"><span class="type">GstCaps</span></a> *</pre>
261<p>The caps of the source pad.</p>
262<p>Flags: Read / Write</p>
263</div>
264<hr>
265<div class="refsect2">
266<a name="GstPcapParse--ts-offset"></a><h3>The <code class="literal">“ts-offset”</code> property</h3>
267<pre class="programlisting">  “ts-offset”                <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a></pre>
268<p>Relative timestamp offset (ns) to apply (-1 = use absolute packet time).</p>
269<p>Flags: Read / Write</p>
270<p>Allowed values: &gt;= G_MAXULONG</p>
271<p>Default value: -1</p>
272</div>
273</div>
274</div>
275<div class="footer">
276<hr>Generated by GTK-Doc V1.28</div>
277</body>
278</html>