annotate main/main.cpp @ 267:c452d8a7b770 sv1-v1.3 sv1-v1.3rc1

* Updates for 1.3
author Chris Cannam
date Thu, 10 Jul 2008 12:50:56 +0000
parents 6a6b5a1a6c67
children a0d3b334e7a9
rev   line source
Chris@0 1 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */
Chris@0 2
Chris@0 3 /*
Chris@0 4 Sonic Visualiser
Chris@0 5 An audio file viewer and annotation editor.
Chris@0 6 Centre for Digital Music, Queen Mary, University of London.
Chris@77 7 This file copyright 2006 Chris Cannam and QMUL.
Chris@0 8
Chris@0 9 This program is free software; you can redistribute it and/or
Chris@0 10 modify it under the terms of the GNU General Public License as
Chris@0 11 published by the Free Software Foundation; either version 2 of the
Chris@0 12 License, or (at your option) any later version. See the file
Chris@0 13 COPYING included with this distribution for more information.
Chris@0 14 */
Chris@0 15
Chris@0 16 #include "MainWindow.h"
Chris@0 17
Chris@1 18 #include "system/System.h"
Chris@1 19 #include "system/Init.h"
Chris@0 20 #include "base/TempDirectory.h"
Chris@0 21 #include "base/PropertyContainer.h"
Chris@0 22 #include "base/Preferences.h"
Chris@120 23 #include "widgets/TipDialog.h"
Chris@0 24
Chris@0 25 #include <QMetaType>
Chris@0 26 #include <QApplication>
Chris@0 27 #include <QDesktopWidget>
Chris@0 28 #include <QMessageBox>
Chris@0 29 #include <QTranslator>
Chris@0 30 #include <QLocale>
Chris@5 31 #include <QSettings>
Chris@7 32 #include <QIcon>
Chris@11 33 #include <QSessionManager>
Chris@165 34 #include <QDir>
Chris@231 35 #include <QSplashScreen>
Chris@252 36 #include <QTimer>
Chris@0 37
Chris@0 38 #include <iostream>
Chris@0 39 #include <signal.h>
Chris@0 40
Chris@215 41 #ifdef HAVE_FFTW3F
Chris@215 42 #include <fftw3.h>
Chris@215 43 #endif
Chris@215 44
Chris@127 45 /*! \mainpage Sonic Visualiser
Chris@127 46
Chris@127 47 \section interesting Summary of interesting classes
Chris@127 48
Chris@127 49 - Data models: Model and subclasses, e.g. WaveFileModel
Chris@127 50
Chris@127 51 - Graphical layers: Layer and subclasses, displayed on View and its
Chris@127 52 subclass widgets.
Chris@127 53
Chris@127 54 - Main window class, document class, and file parser: MainWindow,
Chris@127 55 Document, SVFileReader
Chris@127 56
Chris@127 57 - Turning one model (e.g. audio) into another (e.g. more audio, or a
Chris@244 58 curve extracted from it): Transform, encapsulating the data that need
Chris@244 59 to be stored to be able to reproduce a given transformation;
Chris@244 60 TransformFactory, for discovering the available types of transform;
Chris@244 61 ModelTransformerFactory, ModelTransformer and subclasses, providing
Chris@244 62 the mechanisms for applying transforms to data models
Chris@127 63
Chris@127 64 - Creating the plugins used by transforms: RealTimePluginFactory,
Chris@129 65 FeatureExtractionPluginFactory. See also the API documentation for
Chris@129 66 Vamp feature extraction plugins at
Chris@129 67 http://www.vamp-plugins.org/code-doc/.
Chris@127 68
Chris@127 69 - File reading and writing code: AudioFileReader and subclasses,
Chris@127 70 WavFileWriter, DataFileReader, SVFileReader
Chris@127 71
Chris@127 72 - FFT calculation and cacheing: FFTModel, FFTDataServer
Chris@127 73
Chris@127 74 - Widgets that show groups of editable properties: PropertyBox for
Chris@127 75 layer properties (contained in a PropertyStack), PluginParameterBox
Chris@127 76 for plugins (contained in a PluginParameterDialog)
Chris@127 77
Chris@127 78 - Audio playback: AudioCallbackPlaySource and subclasses,
Chris@127 79 AudioCallbackPlayTarget and subclasses, AudioGenerator
Chris@127 80
Chris@127 81 \section model Data sources: the Model hierarchy
Chris@127 82
Chris@127 83 A Model is something containing, or knowing how to obtain, data.
Chris@127 84
Chris@127 85 For example, WaveFileModel is a model that knows how to get data
Chris@127 86 from an audio file; SparseTimeValueModel is a model containing
Chris@127 87 editable "curve" data.
Chris@127 88
Chris@127 89 Models typically subclass one of a number of abstract subclasses of
Chris@127 90 Model. For example, WaveFileModel subclasses DenseTimeValueModel,
Chris@127 91 which describes an interface for models that have a value at each
Chris@127 92 time point for a given sampling resolution. (Note that
Chris@127 93 WaveFileModel does not actually read the files itself: it uses
Chris@127 94 AudioFileReader classes for that. It just makes data from the
Chris@127 95 files available in a Model.) SparseTimeValueModel uses the
Chris@127 96 SparseModel template class, which provides most of the
Chris@127 97 implementation for models that contain a series of points of some
Chris@127 98 sort -- also used by NoteModel, TextModel, and
Chris@127 99 SparseOneDimensionalModel.
Chris@127 100
Chris@127 101 Everything that goes on the screen originates from a model, via a
Chris@127 102 layer (see below). The models are contained in a Document object.
Chris@127 103 There is no containment hierarchy or ordering of models in the
Chris@127 104 document. One model is the main model, which defines the sample
Chris@127 105 rate for playback.
Chris@127 106
Chris@127 107 A model may also be marked as a "derived" model, which means it was
Chris@127 108 generated from another model using some transform (feature
Chris@127 109 extraction or effect plugin, etc) -- the idea being that they can
Chris@127 110 be re-generated using the same transform if a new source model is
Chris@127 111 loaded.
Chris@127 112
Chris@127 113 \section layer Things that can display data: the Layer hierarchy
Chris@127 114
Chris@127 115 A Layer is something that knows how to draw parts of a model onto a
Chris@127 116 timeline.
Chris@127 117
Chris@127 118 For example, WaveformLayer is a layer which draws waveforms, based
Chris@127 119 on WaveFileModel; TimeValueLayer draws curves, based on
Chris@127 120 SparseTimeValueModel; SpectrogramLayer draws spectrograms, based on
Chris@127 121 WaveFileModel (via FFTModel).
Chris@127 122
Chris@127 123 The most basic functions of a layer are: to draw itself onto a
Chris@127 124 Pane, against a timeline on the x axis; and to permit user
Chris@127 125 interaction. If you were thinking of adding the capability to
Chris@127 126 display a new sort of something, then you would want to add a new
Chris@127 127 layer type. (You may also need a new model type, depending on
Chris@127 128 whether any existing model can capture the data you need.)
Chris@127 129 Depending on the sort of data in question, there are various
Chris@127 130 existing layers that might be appropriate to start from -- for
Chris@127 131 example, a layer that displays images that the user has imported
Chris@127 132 and associated with particular times might have something in common
Chris@127 133 with the existing TextLayer which displays pieces of text that are
Chris@127 134 associated with particular times.
Chris@127 135
Chris@127 136 Although layers are visual objects, they are contained in the
Chris@127 137 Document in Sonic Visualiser rather than being managed together
Chris@127 138 with display widgets. The Sonic Visualiser file format has
Chris@127 139 separate data and layout sections, and the layers are defined in
Chris@127 140 the data section and then referred to in the layout section which
Chris@127 141 determines which layers may go on which panes (see Pane below).
Chris@127 142
Chris@127 143 Once a layer class is defined, some basic data about it needs to be
Chris@127 144 set up in the LayerFactory class, and then it will appear in the
Chris@127 145 menus and so on on the main window.
Chris@127 146
Chris@127 147 \section view Widgets that are used to show layers: The View hierarchy
Chris@127 148
Chris@127 149 A View is a widget that displays a stack of layers. The most
Chris@127 150 important subclass is Pane, the widget that is used to show most of
Chris@127 151 the data in the main window of Sonic Visualiser.
Chris@127 152
Chris@127 153 All a pane really does is contain a set of layers and get them to
Chris@127 154 render themselves (one on top of the other, with the topmost layer
Chris@127 155 being the one that is currently interacted with), cache the
Chris@127 156 results, negotiate user interaction with them, and so on. This is
Chris@127 157 generally fiddly, if not especially interesting. Panes are
Chris@127 158 strictly layout objects and are not stored in the Document class;
Chris@127 159 instead the MainWindow contains a PaneStack widget (the widget that
Chris@127 160 takes up most of Sonic Visualiser's main window) which contains a
Chris@127 161 set of panes stacked vertically.
Chris@127 162
Chris@127 163 Another View subclass is Overview, which is the widget that
Chris@127 164 contains that green waveform showing the entire file at the bottom
Chris@127 165 of the window.
Chris@127 166
Chris@127 167 */
Chris@127 168
Chris@0 169 static QMutex cleanupMutex;
Chris@0 170
Chris@0 171 static void
Chris@0 172 signalHandler(int /* signal */)
Chris@0 173 {
Chris@0 174 // Avoid this happening more than once across threads
Chris@0 175
Chris@0 176 cleanupMutex.lock();
Chris@0 177 std::cerr << "signalHandler: cleaning up and exiting" << std::endl;
Chris@0 178 TempDirectory::getInstance()->cleanup();
Chris@0 179 exit(0); // without releasing mutex
Chris@0 180 }
Chris@0 181
Chris@11 182 class SVApplication : public QApplication
Chris@11 183 {
Chris@11 184 public:
Chris@11 185 SVApplication(int argc, char **argv) :
Chris@11 186 QApplication(argc, argv),
Chris@11 187 m_mainWindow(0) { }
Chris@11 188 virtual ~SVApplication() { }
Chris@11 189
Chris@11 190 void setMainWindow(MainWindow *mw) { m_mainWindow = mw; }
Chris@11 191 void releaseMainWindow() { m_mainWindow = 0; }
Chris@11 192
Chris@11 193 virtual void commitData(QSessionManager &manager) {
Chris@11 194 if (!m_mainWindow) return;
Chris@11 195 bool mayAskUser = manager.allowsInteraction();
Chris@11 196 bool success = m_mainWindow->commitData(mayAskUser);
Chris@11 197 manager.release();
Chris@11 198 if (!success) manager.cancel();
Chris@11 199 }
Chris@11 200
Chris@11 201 protected:
Chris@11 202 MainWindow *m_mainWindow;
Chris@11 203 };
Chris@11 204
Chris@0 205 int
Chris@0 206 main(int argc, char **argv)
Chris@0 207 {
Chris@11 208 SVApplication application(argc, argv);
Chris@0 209
Chris@46 210 QStringList args = application.arguments();
Chris@46 211
Chris@0 212 signal(SIGINT, signalHandler);
Chris@0 213 signal(SIGTERM, signalHandler);
Chris@0 214
Chris@0 215 #ifndef Q_WS_WIN32
Chris@0 216 signal(SIGHUP, signalHandler);
Chris@0 217 signal(SIGQUIT, signalHandler);
Chris@0 218 #endif
Chris@0 219
Chris@0 220 svSystemSpecificInitialisation();
Chris@0 221
Chris@46 222 bool audioOutput = true;
Chris@70 223 bool oscSupport = true;
Chris@70 224
Chris@133 225 if (args.contains("--help") || args.contains("-h") || args.contains("-?")) {
Chris@70 226 std::cerr << QApplication::tr(
Chris@70 227 "\nSonic Visualiser is a program for viewing and exploring audio data\nfor semantic music analysis and annotation.\n\nUsage:\n\n %1 [--no-audio] [--no-osc] [<file> ...]\n\n --no-audio: Do not attempt to open an audio output device\n --no-osc: Do not provide an Open Sound Control port for remote control\n <file>: One or more Sonic Visualiser (.sv) and audio files may be provided.\n").arg(argv[0]).toStdString() << std::endl;
Chris@70 228 exit(2);
Chris@70 229 }
Chris@70 230
Chris@46 231 if (args.contains("--no-audio")) audioOutput = false;
Chris@70 232 if (args.contains("--no-osc")) oscSupport = false;
Chris@46 233
Chris@6 234 QApplication::setOrganizationName("sonic-visualiser");
Chris@5 235 QApplication::setOrganizationDomain("sonicvisualiser.org");
Chris@213 236 QApplication::setApplicationName(QApplication::tr("Sonic Visualiser"));
Chris@141 237
Chris@231 238 QPixmap pixmap(":/icons/sv-splash.png");
Chris@231 239 QSplashScreen splash(pixmap);
Chris@231 240
Chris@231 241 QSettings settings;
Chris@237 242
Chris@237 243 settings.beginGroup("Preferences");
Chris@237 244 if (settings.value("show-splash", true).toBool()) {
Chris@231 245 splash.show();
Chris@252 246 QTimer::singleShot(5000, &splash, SLOT(hide()));
Chris@231 247 application.processEvents();
Chris@231 248 }
Chris@237 249 settings.endGroup();
Chris@231 250
Chris@141 251 QIcon icon;
Chris@141 252 int sizes[] = { 16, 22, 24, 32, 48, 64, 128 };
Chris@141 253 for (int i = 0; i < sizeof(sizes)/sizeof(sizes[0]); ++i) {
Chris@141 254 icon.addFile(QString(":icons/sv-%1x%2.png").arg(sizes[i]).arg(sizes[i]));
Chris@141 255 }
Chris@141 256 QApplication::setWindowIcon(icon);
Chris@7 257
Chris@0 258 QString language = QLocale::system().name();
Chris@0 259
Chris@0 260 QTranslator qtTranslator;
Chris@0 261 QString qtTrName = QString("qt_%1").arg(language);
Chris@253 262 std::cerr << "Loading " << qtTrName.toStdString() << "... ";
Chris@165 263 bool success = false;
Chris@165 264 if (!(success = qtTranslator.load(qtTrName))) {
Chris@165 265 QString qtDir = getenv("QTDIR");
Chris@165 266 if (qtDir != "") {
Chris@165 267 success = qtTranslator.load
Chris@165 268 (qtTrName, QDir(qtDir).filePath("translations"));
Chris@165 269 }
Chris@165 270 }
Chris@165 271 if (!success) {
Chris@253 272 std::cerr << "Failed\nFailed to load Qt translation for locale" << std::endl;
Chris@253 273 } else {
Chris@253 274 std::cerr << "Done" << std::endl;
Chris@165 275 }
Chris@0 276 application.installTranslator(&qtTranslator);
Chris@0 277
Chris@0 278 QTranslator svTranslator;
Chris@0 279 QString svTrName = QString("sonic-visualiser_%1").arg(language);
Chris@253 280 std::cerr << "Loading " << svTrName.toStdString() << "... ";
Chris@0 281 svTranslator.load(svTrName, ":i18n");
Chris@253 282 std::cerr << "Done" << std::endl;
Chris@0 283 application.installTranslator(&svTranslator);
Chris@0 284
Chris@187 285 StoreStartupLocale();
Chris@187 286
Chris@0 287 // Permit size_t and PropertyName to be used as args in queued signal calls
Chris@0 288 qRegisterMetaType<size_t>("size_t");
Chris@0 289 qRegisterMetaType<PropertyContainer::PropertyName>("PropertyContainer::PropertyName");
Chris@0 290
Chris@222 291 MainWindow *gui = new MainWindow(audioOutput, oscSupport);
Chris@222 292 application.setMainWindow(gui);
Chris@247 293 QObject::connect(gui, SIGNAL(hideSplash()), &splash, SLOT(hide()));
Chris@0 294
Chris@0 295 QDesktopWidget *desktop = QApplication::desktop();
Chris@0 296 QRect available = desktop->availableGeometry();
Chris@0 297
Chris@0 298 int width = available.width() * 2 / 3;
Chris@0 299 int height = available.height() / 2;
Chris@0 300 if (height < 450) height = available.height() * 2 / 3;
Chris@0 301 if (width > height * 2) width = height * 2;
Chris@0 302
Chris@237 303 settings.beginGroup("MainWindow");
Chris@5 304 QSize size = settings.value("size", QSize(width, height)).toSize();
Chris@222 305 gui->resize(size);
Chris@5 306 if (settings.contains("position")) {
Chris@222 307 gui->move(settings.value("position").toPoint());
Chris@5 308 }
Chris@5 309 settings.endGroup();
Chris@5 310
Chris@222 311 gui->show();
Chris@64 312
Chris@118 313 // The MainWindow class seems to have trouble dealing with this if
Chris@118 314 // it tries to adapt to this preference before the constructor is
Chris@118 315 // complete. As a lazy hack, apply it explicitly from here
Chris@222 316 gui->preferenceChanged("Property Box Layout");
Chris@118 317
Chris@54 318 bool haveSession = false;
Chris@54 319 bool haveMainModel = false;
Chris@145 320 bool havePriorCommandLineModel = false;
Chris@46 321
Chris@54 322 for (QStringList::iterator i = args.begin(); i != args.end(); ++i) {
Chris@54 323
Chris@83 324 MainWindow::FileOpenStatus status = MainWindow::FileOpenFailed;
Chris@54 325
Chris@54 326 if (i == args.begin()) continue;
Chris@54 327 if (i->startsWith('-')) continue;
Chris@54 328
Chris@54 329 QString path = *i;
Chris@54 330
Chris@54 331 if (path.endsWith("sv")) {
Chris@54 332 if (!haveSession) {
Chris@222 333 status = gui->openSessionFile(path);
Chris@82 334 if (status == MainWindow::FileOpenSucceeded) {
Chris@54 335 haveSession = true;
Chris@54 336 haveMainModel = true;
Chris@54 337 }
Chris@54 338 } else {
Chris@54 339 std::cerr << "WARNING: Ignoring additional session file argument \"" << path.toStdString() << "\"" << std::endl;
Chris@82 340 status = MainWindow::FileOpenSucceeded;
Chris@54 341 }
Chris@54 342 }
Chris@82 343 if (status != MainWindow::FileOpenSucceeded) {
Chris@54 344 if (!haveMainModel) {
Chris@222 345 status = gui->open(path, MainWindow::ReplaceMainModel);
Chris@145 346 if (status == MainWindow::FileOpenSucceeded) {
Chris@145 347 haveMainModel = true;
Chris@145 348 }
Chris@54 349 } else {
Chris@145 350 if (haveSession && !havePriorCommandLineModel) {
Chris@222 351 status = gui->open(path, MainWindow::AskUser);
Chris@145 352 if (status == MainWindow::FileOpenSucceeded) {
Chris@145 353 havePriorCommandLineModel = true;
Chris@145 354 }
Chris@145 355 } else {
Chris@222 356 status = gui->open(path, MainWindow::CreateAdditionalModel);
Chris@145 357 }
Chris@54 358 }
Chris@54 359 }
Chris@82 360 if (status == MainWindow::FileOpenFailed) {
Chris@54 361 QMessageBox::critical
Chris@222 362 (gui, QMessageBox::tr("Failed to open file"),
Chris@197 363 QMessageBox::tr("File or URL \"%1\" could not be opened").arg(path));
Chris@54 364 }
Chris@180 365 }
Chris@180 366
Chris@215 367 #ifdef HAVE_FFTW3F
Chris@215 368 settings.beginGroup("FFTWisdom");
Chris@215 369 QString wisdom = settings.value("wisdom").toString();
Chris@215 370 if (wisdom != "") {
Chris@215 371 fftwf_import_wisdom_from_string(wisdom.toLocal8Bit().data());
Chris@215 372 }
Chris@267 373 #ifdef HAVE_FFTW3
Chris@267 374 wisdom = settings.value("wisdom_d").toString();
Chris@267 375 if (wisdom != "") {
Chris@267 376 fftw_import_wisdom_from_string(wisdom.toLocal8Bit().data());
Chris@267 377 }
Chris@267 378 #endif
Chris@215 379 settings.endGroup();
Chris@215 380 #endif
Chris@180 381
Chris@231 382 splash.finish(gui);
Chris@180 383
Chris@123 384 /*
Chris@120 385 TipDialog tipDialog;
Chris@120 386 if (tipDialog.isOK()) {
Chris@120 387 tipDialog.exec();
Chris@120 388 }
Chris@123 389 */
Chris@0 390 int rv = application.exec();
Chris@0 391
Chris@0 392 cleanupMutex.lock();
Chris@0 393 TempDirectory::getInstance()->cleanup();
Chris@222 394
Chris@11 395 application.releaseMainWindow();
Chris@5 396
Chris@215 397 #ifdef HAVE_FFTW3F
Chris@267 398 settings.beginGroup("FFTWisdom");
Chris@215 399 char *cwisdom = fftwf_export_wisdom_to_string();
Chris@215 400 if (cwisdom) {
Chris@215 401 settings.setValue("wisdom", cwisdom);
Chris@215 402 fftwf_free(cwisdom);
Chris@215 403 }
Chris@267 404 #ifdef HAVE_FFTW3
Chris@267 405 cwisdom = fftw_export_wisdom_to_string();
Chris@267 406 if (cwisdom) {
Chris@267 407 settings.setValue("wisdom_d", cwisdom);
Chris@267 408 fftw_free(cwisdom);
Chris@267 409 }
Chris@267 410 #endif
Chris@267 411 settings.endGroup();
Chris@215 412 #endif
Chris@215 413
Chris@222 414 delete gui;
Chris@222 415
Chris@0 416 return rv;
Chris@0 417 }