Files
qt4-x11/doc/html/demos-spectrum-app-waveform-h.html
2025-08-24 20:55:26 +08:00

406 lines
20 KiB
HTML

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Qt 4.8: waveform.h Example File (demos/spectrum/app/waveform.h)</title>
<link rel="stylesheet" type="text/css" href="style/style.css" />
<script src="scripts/jquery.js" type="text/javascript"></script>
<script src="scripts/functions.js" type="text/javascript"></script>
<link rel="stylesheet" type="text/css" href="style/superfish.css" />
<link rel="stylesheet" type="text/css" href="style/narrow.css" />
<!--[if IE]>
<meta name="MSSmartTagsPreventParsing" content="true">
<meta http-equiv="imagetoolbar" content="no">
<![endif]-->
<!--[if lt IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie6.css">
<![endif]-->
<!--[if IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie7.css">
<![endif]-->
<!--[if IE 8]>
<link rel="stylesheet" type="text/css" href="style/style_ie8.css">
<![endif]-->
<script src="scripts/superfish.js" type="text/javascript"></script>
<script src="scripts/narrow.js" type="text/javascript"></script>
</head>
<body class="" onload="CheckEmptyAndLoadList();">
<div class="header" id="qtdocheader">
<div class="content">
<div id="nav-logo">
<a href="index.html">Home</a></div>
<a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a>
<div id="narrowsearch"></div>
<div id="nav-topright">
<ul>
<li class="nav-topright-home"><a href="http://qt.digia.com/">Qt HOME</a></li>
<li class="nav-topright-dev"><a href="http://qt-project.org/">DEV</a></li>
<li class="nav-topright-doc nav-topright-doc-active"><a href="http://qt-project.org/doc/">
DOC</a></li>
<li class="nav-topright-blog"><a href="http://blog.qt.digia.com/">BLOG</a></li>
</ul>
</div>
<div id="shortCut">
<ul>
<li class="shortCut-topleft-inactive"><span><a href="index.html">Qt 4.8</a></span></li>
<li class="shortCut-topleft-active"><a href="http://qt-project.org/doc/">ALL VERSIONS </a></li>
</ul>
</div>
<ul class="sf-menu" id="narrowmenu">
<li><a href="#">API Lookup</a>
<ul>
<li><a href="classes.html">Class index</a></li>
<li><a href="functions.html">Function index</a></li>
<li><a href="modules.html">Modules</a></li>
<li><a href="namespaces.html">Namespaces</a></li>
<li><a href="qtglobal.html">Global Declarations</a></li>
<li><a href="qdeclarativeelements.html">QML elements</a></li>
</ul>
</li>
<li><a href="#">Qt Topics</a>
<ul>
<li><a href="qt-basic-concepts.html">Programming with Qt</a></li>
<li><a href="qtquick.html">Device UIs &amp; Qt Quick</a></li>
<li><a href="qt-gui-concepts.html">UI Design with Qt</a></li>
<li><a href="supported-platforms.html">Supported Platforms</a></li>
<li><a href="technology-apis.html">Qt and Key Technologies</a></li>
<li><a href="best-practices.html">How-To's and Best Practices</a></li>
</ul>
</li>
<li><a href="#">Examples</a>
<ul>
<li><a href="all-examples.html">Examples</a></li>
<li><a href="tutorials.html">Tutorials</a></li>
<li><a href="demos.html">Demos</a></li>
<li><a href="qdeclarativeexamples.html">QML Examples</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="wrapper">
<div class="hd">
<span></span>
</div>
<div class="bd group">
<div class="sidebar">
<div class="searchlabel">
Search index:</div>
<div class="search" id="sidebarsearch">
<form id="qtdocsearch" action="" onsubmit="return false;">
<fieldset>
<input type="text" name="searchstring" id="pageType" value="" />
<div id="resultdialog">
<a href="#" id="resultclose">Close</a>
<p id="resultlinks" class="all"><a href="#" id="showallresults">All</a> | <a href="#" id="showapiresults">API</a> | <a href="#" id="showarticleresults">Articles</a> | <a href="#" id="showexampleresults">Examples</a></p>
<p id="searchcount" class="all"><span id="resultcount"></span><span id="apicount"></span><span id="articlecount"></span><span id="examplecount"></span>&nbsp;results:</p>
<ul id="resultlist" class="all">
</ul>
</div>
</fieldset>
</form>
</div>
<div class="box first bottombar" id="lookup">
<h2 title="API Lookup"><span></span>
API Lookup</h2>
<div id="list001" class="list">
<ul id="ul001" >
<li class="defaultLink"><a href="classes.html">Class index</a></li>
<li class="defaultLink"><a href="functions.html">Function index</a></li>
<li class="defaultLink"><a href="modules.html">Modules</a></li>
<li class="defaultLink"><a href="namespaces.html">Namespaces</a></li>
<li class="defaultLink"><a href="qtglobal.html">Global Declarations</a></li>
<li class="defaultLink"><a href="qdeclarativeelements.html">QML elements</a></li>
</ul>
</div>
</div>
<div class="box bottombar" id="topics">
<h2 title="Qt Topics"><span></span>
Qt Topics</h2>
<div id="list002" class="list">
<ul id="ul002" >
<li class="defaultLink"><a href="qt-basic-concepts.html">Programming with Qt</a></li>
<li class="defaultLink"><a href="qtquick.html">Device UIs &amp; Qt Quick</a></li>
<li class="defaultLink"><a href="qt-gui-concepts.html">UI Design with Qt</a></li>
<li class="defaultLink"><a href="supported-platforms.html">Supported Platforms</a></li>
<li class="defaultLink"><a href="technology-apis.html">Qt and Key Technologies</a></li>
<li class="defaultLink"><a href="best-practices.html">How-To's and Best Practices</a></li>
</ul>
</div>
</div>
<div class="box" id="examples">
<h2 title="Examples"><span></span>
Examples</h2>
<div id="list003" class="list">
<ul id="ul003">
<li class="defaultLink"><a href="all-examples.html">Examples</a></li>
<li class="defaultLink"><a href="tutorials.html">Tutorials</a></li>
<li class="defaultLink"><a href="demos.html">Demos</a></li>
<li class="defaultLink"><a href="qdeclarativeexamples.html">QML Examples</a></li>
</ul>
</div>
</div>
</div>
<div class="wrap">
<div class="toolbar">
<div class="breadcrumb toolblock">
<ul>
<li class="first"><a href="index.html">Home</a></li>
<!-- Breadcrumbs go here -->
</ul>
</div>
<div class="toolbuttons toolblock">
<ul>
<li id="smallA" class="t_button">A</li>
<li id="medA" class="t_button active">A</li>
<li id="bigA" class="t_button">A</li>
<li id="print" class="t_button"><a href="javascript:this.print();">
<span>Print</span></a></li>
</ul>
</div>
</div>
<div class="content mainContent">
<h1 class="title">waveform.h Example File</h1>
<span class="small-subtitle">demos/spectrum/app/waveform.h</span>
<!-- $$$demos/spectrum/app/waveform.h-description -->
<div class="descr"> <a name="details"></a>
<pre class="cpp"> <span class="comment">/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing/
**
** This file is part of the examples of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:BSD$
** You may use this file under the terms of the BSD license as follows:
**
** &quot;Redistribution and use in source and binary forms, with or without
** modification, are permitted provided that the following conditions are
** met:
** * Redistributions of source code must retain the above copyright
** notice, this list of conditions and the following disclaimer.
** * Redistributions in binary form must reproduce the above copyright
** notice, this list of conditions and the following disclaimer in
** the documentation and/or other materials provided with the
** distribution.
** * Neither the name of The Qt Company Ltd nor the names of its
** contributors may be used to endorse or promote products derived
** from this software without specific prior written permission.
**
**
** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
** &quot;AS IS&quot; AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.&quot;
**
** $QT_END_LICENSE$
**
****************************************************************************/</span>
<span class="preprocessor">#ifndef WAVEFORM_H</span>
<span class="preprocessor">#define WAVEFORM_H</span>
<span class="preprocessor">#include &lt;QWidget&gt;</span>
<span class="preprocessor">#include &lt;QtMultimedia/QAudioFormat&gt;</span>
<span class="preprocessor">#include &lt;QPixmap&gt;</span>
<span class="preprocessor">#include &lt;QScopedPointer&gt;</span>
QT_FORWARD_DECLARE_CLASS(<span class="type"><a href="qbytearray.html">QByteArray</a></span>)
<span class="comment">/**
* Widget which displays a section of the audio waveform.
*
* The waveform is rendered on a set of QPixmaps which form a group of tiles
* whose extent covers the widget. As the audio position is updated, these
* tiles are scrolled from left to right; when the left-most tile scrolls
* outside the widget, it is moved to the right end of the tile array and
* painted with the next section of the waveform.
*/</span>
<span class="keyword">class</span> Waveform : <span class="keyword">public</span> <span class="type"><a href="qwidget.html">QWidget</a></span> {
Q_OBJECT
<span class="keyword">public</span>:
Waveform(<span class="type"><a href="qwidget.html">QWidget</a></span> <span class="operator">*</span>parent <span class="operator">=</span> <span class="number">0</span>);
<span class="operator">~</span>Waveform();
<span class="comment">// QWidget</span>
<span class="type">void</span> paintEvent(<span class="type"><a href="qpaintevent.html">QPaintEvent</a></span> <span class="operator">*</span>event);
<span class="type">void</span> resizeEvent(<span class="type"><a href="qresizeevent.html">QResizeEvent</a></span> <span class="operator">*</span>event);
<span class="type">void</span> initialize(<span class="keyword">const</span> <span class="type"><a href="qaudioformat.html">QAudioFormat</a></span> <span class="operator">&amp;</span>format<span class="operator">,</span> <span class="type"><a href="qtglobal.html#qint64-typedef">qint64</a></span> audioBufferSize<span class="operator">,</span> <span class="type"><a href="qtglobal.html#qint64-typedef">qint64</a></span> windowDurationUs);
<span class="type">void</span> reset();
<span class="type">void</span> setAutoUpdatePosition(<span class="type">bool</span> enabled);
<span class="keyword">public</span> <span class="keyword">slots</span>:
<span class="type">void</span> bufferChanged(<span class="type"><a href="qtglobal.html#qint64-typedef">qint64</a></span> position<span class="operator">,</span> <span class="type"><a href="qtglobal.html#qint64-typedef">qint64</a></span> length<span class="operator">,</span> <span class="keyword">const</span> <span class="type"><a href="qbytearray.html">QByteArray</a></span> <span class="operator">&amp;</span>buffer);
<span class="type">void</span> audioPositionChanged(<span class="type"><a href="qtglobal.html#qint64-typedef">qint64</a></span> position);
<span class="keyword">private</span>:
<span class="keyword">static</span> <span class="keyword">const</span> <span class="type">int</span> NullIndex <span class="operator">=</span> <span class="operator">-</span><span class="number">1</span>;
<span class="type">void</span> deletePixmaps();
<span class="comment">/*
* (Re)create all pixmaps, repaint and update the display.
* Triggers an update();
*/</span>
<span class="type">void</span> createPixmaps(<span class="keyword">const</span> <span class="type"><a href="qsize.html">QSize</a></span> <span class="operator">&amp;</span>newSize);
<span class="comment">/*
* Update window position.
* Triggers an update().
*/</span>
<span class="type">void</span> setWindowPosition(<span class="type"><a href="qtglobal.html#qint64-typedef">qint64</a></span> position);
<span class="comment">/*
* Base position of tile
*/</span>
<span class="type"><a href="qtglobal.html#qint64-typedef">qint64</a></span> tilePosition(<span class="type">int</span> index) <span class="keyword">const</span>;
<span class="comment">/*
* Structure which identifies a point within a given
* tile.
*/</span>
<span class="keyword">struct</span> TilePoint
{
TilePoint(<span class="type">int</span> idx <span class="operator">=</span> <span class="number">0</span><span class="operator">,</span> <span class="type"><a href="qtglobal.html#qint64-typedef">qint64</a></span> pos <span class="operator">=</span> <span class="number">0</span><span class="operator">,</span> <span class="type"><a href="qtglobal.html#qint64-typedef">qint64</a></span> pix <span class="operator">=</span> <span class="number">0</span>)
: index(idx)<span class="operator">,</span> positionOffset(pos)<span class="operator">,</span> pixelOffset(pix)
{ }
<span class="comment">// Index of tile</span>
<span class="type">int</span> index;
<span class="comment">// Number of bytes from start of tile</span>
<span class="type"><a href="qtglobal.html#qint64-typedef">qint64</a></span> positionOffset;
<span class="comment">// Number of pixels from left of corresponding pixmap</span>
<span class="type">int</span> pixelOffset;
};
<span class="comment">/*
* Convert position in m_buffer into a tile index and an offset in pixels
* into the corresponding pixmap.
*
* \param position Offset into m_buffer, in bytes
* If position is outside the tile array, index is NullIndex and
* offset is zero.
*/</span>
TilePoint tilePoint(<span class="type"><a href="qtglobal.html#qint64-typedef">qint64</a></span> position) <span class="keyword">const</span>;
<span class="comment">/*
* Convert offset in bytes into a tile into an offset in pixels
* within that tile.
*/</span>
<span class="type">int</span> tilePixelOffset(<span class="type"><a href="qtglobal.html#qint64-typedef">qint64</a></span> positionOffset) <span class="keyword">const</span>;
<span class="comment">/*
* Convert offset in bytes into the window into an offset in pixels
* within the widget rect().
*/</span>
<span class="type">int</span> windowPixelOffset(<span class="type"><a href="qtglobal.html#qint64-typedef">qint64</a></span> positionOffset) <span class="keyword">const</span>;
<span class="comment">/*
* Paint all tiles which can be painted.
* \return true iff update() was called
*/</span>
<span class="type">bool</span> paintTiles();
<span class="comment">/*
* Paint the specified tile
*
* \pre Sufficient data is available to completely paint the tile, i.e.
* m_dataLength is greater than the upper bound of the tile.
*/</span>
<span class="type">void</span> paintTile(<span class="type">int</span> index);
<span class="comment">/*
* Move the first n tiles to the end of the array, and mark them as not
* painted.
*/</span>
<span class="type">void</span> shuffleTiles(<span class="type">int</span> n);
<span class="comment">/*
* Reset tile array
*/</span>
<span class="type">void</span> resetTiles(<span class="type"><a href="qtglobal.html#qint64-typedef">qint64</a></span> newStartPos);
<span class="keyword">private</span>:
<span class="type"><a href="qtglobal.html#qint64-typedef">qint64</a></span> m_bufferPosition;
<span class="type"><a href="qtglobal.html#qint64-typedef">qint64</a></span> m_bufferLength;
<span class="type"><a href="qbytearray.html">QByteArray</a></span> m_buffer;
<span class="type"><a href="qtglobal.html#qint64-typedef">qint64</a></span> m_audioPosition;
<span class="type"><a href="qaudioformat.html">QAudioFormat</a></span> m_format;
<span class="type">bool</span> m_active;
<span class="type"><a href="qsize.html">QSize</a></span> m_pixmapSize;
<span class="type"><a href="qvector.html">QVector</a></span><span class="operator">&lt;</span><span class="type"><a href="qpixmap.html">QPixmap</a></span><span class="operator">*</span><span class="operator">&gt;</span> m_pixmaps;
<span class="keyword">struct</span> Tile {
<span class="comment">// Pointer into parent m_pixmaps array</span>
<span class="type"><a href="qpixmap.html">QPixmap</a></span><span class="operator">*</span> pixmap;
<span class="comment">// Flag indicating whether this tile has been painted</span>
<span class="type">bool</span> painted;
};
<span class="type"><a href="qvector.html">QVector</a></span><span class="operator">&lt;</span>Tile<span class="operator">&gt;</span> m_tiles;
<span class="comment">// Length of audio data in bytes depicted by each tile</span>
<span class="type"><a href="qtglobal.html#qint64-typedef">qint64</a></span> m_tileLength;
<span class="comment">// Position in bytes of the first tile, relative to m_buffer</span>
<span class="type"><a href="qtglobal.html#qint64-typedef">qint64</a></span> m_tileArrayStart;
<span class="type"><a href="qtglobal.html#qint64-typedef">qint64</a></span> m_windowPosition;
<span class="type"><a href="qtglobal.html#qint64-typedef">qint64</a></span> m_windowLength;
};
<span class="preprocessor">#endif // WAVEFORM_H</span></pre>
</div>
<!-- @@@demos/spectrum/app/waveform.h -->
</div>
</div>
</div>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">&copy;</acronym> 2015 The Qt Company Ltd.
Documentation contributions included herein are the copyrights of
their respective owners.</p>
<br />
<p>
The documentation provided herein is licensed under the terms of the
<a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation
License version 1.3</a> as published by the Free Software Foundation.</p>
<p>
Documentation sources may be obtained from <a href="http://www.qt-project.org">
www.qt-project.org</a>.</p>
<br />
<p>
Qt and respective logos are trademarks of The Qt Company Ltd
in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. <a title="Privacy Policy"
href="http://en.gitorious.org/privacy_policy/">Privacy Policy</a></p>
</div>
<script src="scripts/functions.js" type="text/javascript"></script>
</body>
</html>