docs/libs/html/gst-plugins-base-libs-gstfft.html

   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>gstfft</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
   7 <link rel="home" href="index.html" title="GStreamer Base Plugins 0.10 Library Reference Manual">
   8 <link rel="up" href="gstreamer-ffft.html" title="FFT Library">
   9 <link rel="prev" href="gstreamer-ffft.html" title="FFT Library">
  10 <link rel="next" href="gst-plugins-base-libs-gstffts16.html" title="gstffts16">
  11 <meta name="generator" content="GTK-Doc V1.17 (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="2">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="gstreamer-ffft.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="gstreamer-ffft.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">GStreamer Base Plugins 0.10 Library Reference Manual</th>
  21 <td><a accesskey="n" href="gst-plugins-base-libs-gstffts16.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#gst-plugins-base-libs-gstfft.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-base-libs-gstfft.description" class="shortcut">Description</a>
  27 </td></tr>
  28 </table>
  29 <div class="refentry">
  30 <a name="gst-plugins-base-libs-gstfft"></a><div class="titlepage"></div>
  31 <div class="refnamediv"><table width="100%"><tr>
  32 <td valign="top">
  33 <h2><span class="refentrytitle"><a name="gst-plugins-base-libs-gstfft.top_of_page"></a>gstfft</span></h2>
  34 <p>gstfft — General FFT functions and declarations</p>
  35 </td>
  36 <td valign="top" align="right"></td>
  37 </tr></table></div>
  38 <div class="refsynopsisdiv">
  39 <a name="gst-plugins-base-libs-gstfft.synopsis"></a><h2>Synopsis</h2>
  40 <pre class="synopsis">
  41 #include &lt;gst/fft/gstfft.h&gt;
  42
  43 enum                <a class="link" href="gst-plugins-base-libs-gstfft.html#GstFFTWindow" title="enum GstFFTWindow">GstFFTWindow</a>;
  44 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                <a class="link" href="gst-plugins-base-libs-gstfft.html#gst-fft-next-fast-length" title="gst_fft_next_fast_length ()">gst_fft_next_fast_length</a>            (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> n</code></em>);
  45 </pre>
  46 </div>
  47 <div class="refsect1">
  48 <a name="gst-plugins-base-libs-gstfft.description"></a><h2>Description</h2>
  49 <p>
  50 This library includes general definitions and functions, useful for
  51 all typed FFT classes.
  52 </p>
  53 </div>
  54 <div class="refsect1">
  55 <a name="gst-plugins-base-libs-gstfft.details"></a><h2>Details</h2>
  56 <div class="refsect2">
  57 <a name="GstFFTWindow"></a><h3>enum GstFFTWindow</h3>
  58 <pre class="programlisting">typedef enum
  59 {
  60   GST_FFT_WINDOW_RECTANGULAR,
  61   GST_FFT_WINDOW_HAMMING,
  62   GST_FFT_WINDOW_HANN,
  63   GST_FFT_WINDOW_BARTLETT,
  64   GST_FFT_WINDOW_BLACKMAN
  65 } GstFFTWindow;
  66 </pre>
  67 <p>
  68 The various window functions available.
  69 </p>
  70 <div class="variablelist"><table border="0">
  71 <col align="left" valign="top">
  72 <tbody>
  73 <tr>
  74 <td><p><a name="GST-FFT-WINDOW-RECTANGULAR:CAPS"></a><span class="term"><code class="literal">GST_FFT_WINDOW_RECTANGULAR</code></span></p></td>
  75 <td>Rectangular window
  76 </td>
  77 </tr>
  78 <tr>
  79 <td><p><a name="GST-FFT-WINDOW-HAMMING:CAPS"></a><span class="term"><code class="literal">GST_FFT_WINDOW_HAMMING</code></span></p></td>
  80 <td>Hamming window
  81 </td>
  82 </tr>
  83 <tr>
  84 <td><p><a name="GST-FFT-WINDOW-HANN:CAPS"></a><span class="term"><code class="literal">GST_FFT_WINDOW_HANN</code></span></p></td>
  85 <td>Hann (sometimes also called Hanning) window
  86 </td>
  87 </tr>
  88 <tr>
  89 <td><p><a name="GST-FFT-WINDOW-BARTLETT:CAPS"></a><span class="term"><code class="literal">GST_FFT_WINDOW_BARTLETT</code></span></p></td>
  90 <td>Bartlett window
  91 </td>
  92 </tr>
  93 <tr>
  94 <td><p><a name="GST-FFT-WINDOW-BLACKMAN:CAPS"></a><span class="term"><code class="literal">GST_FFT_WINDOW_BLACKMAN</code></span></p></td>
  95 <td>Blackman window
  96 </td>
  97 </tr>
  98 </tbody>
  99 </table></div>
 100 </div>
 101 <hr>
 102 <div class="refsect2">
 103 <a name="gst-fft-next-fast-length"></a><h3>gst_fft_next_fast_length ()</h3>
 104 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                gst_fft_next_fast_length            (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> n</code></em>);</pre>
 105 <p>
 106 Returns the next number to <em class="parameter"><code>n</code></em> that is entirely a product
 107 of 2, 3 and 5. Using this as the <em class="parameter"><code>len</code></em> parameter for
 108 the different GstFFT types will provide the best performance.
 109 </p>
 110 <div class="variablelist"><table border="0">
 111 <col align="left" valign="top">
 112 <tbody>
 113 <tr>
 114 <td><p><span class="term"><em class="parameter"><code>n</code></em> :</span></p></td>
 115 <td>Number for which the next fast length should be returned</td>
 116 </tr>
 117 <tr>
 118 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 119 <td>the next fast FFT length.</td>
 120 </tr>
 121 </tbody>
 122 </table></div>
 123 </div>
 124 </div>
 125 </div>
 126 <div class="footer">
 127 <hr>
 128           Generated by GTK-Doc V1.17</div>
 129 </body>
 130 </html>