annotate main/main.cpp @ 317:8aa8dd8050d9 sv-v1.5

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