annotate main/main.cpp @ 228:b99c6449c2ed

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