Chris@0: /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */ Chris@0: Chris@0: /* Chris@0: Sonic Visualiser Chris@0: An audio file viewer and annotation editor. Chris@0: Centre for Digital Music, Queen Mary, University of London. Chris@77: This file copyright 2006 Chris Cannam and QMUL. Chris@0: Chris@0: This program is free software; you can redistribute it and/or Chris@0: modify it under the terms of the GNU General Public License as Chris@0: published by the Free Software Foundation; either version 2 of the Chris@0: License, or (at your option) any later version. See the file Chris@0: COPYING included with this distribution for more information. Chris@0: */ Chris@0: Chris@0: #include "MainWindow.h" Chris@0: Chris@1: #include "system/System.h" Chris@1: #include "system/Init.h" Chris@0: #include "base/TempDirectory.h" Chris@0: #include "base/PropertyContainer.h" Chris@0: #include "base/Preferences.h" Chris@120: #include "widgets/TipDialog.h" Chris@0: Chris@0: #include Chris@0: #include Chris@0: #include Chris@0: #include Chris@0: #include Chris@0: #include Chris@5: #include Chris@7: #include Chris@11: #include Chris@165: #include Chris@0: Chris@0: #include Chris@0: #include Chris@0: Chris@127: /*! \mainpage Sonic Visualiser Chris@127: Chris@127: \section interesting Summary of interesting classes Chris@127: Chris@127: - Data models: Model and subclasses, e.g. WaveFileModel Chris@127: Chris@127: - Graphical layers: Layer and subclasses, displayed on View and its Chris@127: subclass widgets. Chris@127: Chris@127: - Main window class, document class, and file parser: MainWindow, Chris@127: Document, SVFileReader Chris@127: Chris@127: - Turning one model (e.g. audio) into another (e.g. more audio, or a Chris@127: curve extracted from it): Transform and subclasses Chris@127: Chris@127: - Creating the plugins used by transforms: RealTimePluginFactory, Chris@129: FeatureExtractionPluginFactory. See also the API documentation for Chris@129: Vamp feature extraction plugins at Chris@129: http://www.vamp-plugins.org/code-doc/. Chris@127: Chris@127: - File reading and writing code: AudioFileReader and subclasses, Chris@127: WavFileWriter, DataFileReader, SVFileReader Chris@127: Chris@127: - FFT calculation and cacheing: FFTModel, FFTDataServer Chris@127: Chris@127: - Widgets that show groups of editable properties: PropertyBox for Chris@127: layer properties (contained in a PropertyStack), PluginParameterBox Chris@127: for plugins (contained in a PluginParameterDialog) Chris@127: Chris@127: - Audio playback: AudioCallbackPlaySource and subclasses, Chris@127: AudioCallbackPlayTarget and subclasses, AudioGenerator Chris@127: Chris@127: \section model Data sources: the Model hierarchy Chris@127: Chris@127: A Model is something containing, or knowing how to obtain, data. Chris@127: Chris@127: For example, WaveFileModel is a model that knows how to get data Chris@127: from an audio file; SparseTimeValueModel is a model containing Chris@127: editable "curve" data. Chris@127: Chris@127: Models typically subclass one of a number of abstract subclasses of Chris@127: Model. For example, WaveFileModel subclasses DenseTimeValueModel, Chris@127: which describes an interface for models that have a value at each Chris@127: time point for a given sampling resolution. (Note that Chris@127: WaveFileModel does not actually read the files itself: it uses Chris@127: AudioFileReader classes for that. It just makes data from the Chris@127: files available in a Model.) SparseTimeValueModel uses the Chris@127: SparseModel template class, which provides most of the Chris@127: implementation for models that contain a series of points of some Chris@127: sort -- also used by NoteModel, TextModel, and Chris@127: SparseOneDimensionalModel. Chris@127: Chris@127: Everything that goes on the screen originates from a model, via a Chris@127: layer (see below). The models are contained in a Document object. Chris@127: There is no containment hierarchy or ordering of models in the Chris@127: document. One model is the main model, which defines the sample Chris@127: rate for playback. Chris@127: Chris@127: A model may also be marked as a "derived" model, which means it was Chris@127: generated from another model using some transform (feature Chris@127: extraction or effect plugin, etc) -- the idea being that they can Chris@127: be re-generated using the same transform if a new source model is Chris@127: loaded. Chris@127: Chris@127: \section layer Things that can display data: the Layer hierarchy Chris@127: Chris@127: A Layer is something that knows how to draw parts of a model onto a Chris@127: timeline. Chris@127: Chris@127: For example, WaveformLayer is a layer which draws waveforms, based Chris@127: on WaveFileModel; TimeValueLayer draws curves, based on Chris@127: SparseTimeValueModel; SpectrogramLayer draws spectrograms, based on Chris@127: WaveFileModel (via FFTModel). Chris@127: Chris@127: The most basic functions of a layer are: to draw itself onto a Chris@127: Pane, against a timeline on the x axis; and to permit user Chris@127: interaction. If you were thinking of adding the capability to Chris@127: display a new sort of something, then you would want to add a new Chris@127: layer type. (You may also need a new model type, depending on Chris@127: whether any existing model can capture the data you need.) Chris@127: Depending on the sort of data in question, there are various Chris@127: existing layers that might be appropriate to start from -- for Chris@127: example, a layer that displays images that the user has imported Chris@127: and associated with particular times might have something in common Chris@127: with the existing TextLayer which displays pieces of text that are Chris@127: associated with particular times. Chris@127: Chris@127: Although layers are visual objects, they are contained in the Chris@127: Document in Sonic Visualiser rather than being managed together Chris@127: with display widgets. The Sonic Visualiser file format has Chris@127: separate data and layout sections, and the layers are defined in Chris@127: the data section and then referred to in the layout section which Chris@127: determines which layers may go on which panes (see Pane below). Chris@127: Chris@127: Once a layer class is defined, some basic data about it needs to be Chris@127: set up in the LayerFactory class, and then it will appear in the Chris@127: menus and so on on the main window. Chris@127: Chris@127: \section view Widgets that are used to show layers: The View hierarchy Chris@127: Chris@127: A View is a widget that displays a stack of layers. The most Chris@127: important subclass is Pane, the widget that is used to show most of Chris@127: the data in the main window of Sonic Visualiser. Chris@127: Chris@127: All a pane really does is contain a set of layers and get them to Chris@127: render themselves (one on top of the other, with the topmost layer Chris@127: being the one that is currently interacted with), cache the Chris@127: results, negotiate user interaction with them, and so on. This is Chris@127: generally fiddly, if not especially interesting. Panes are Chris@127: strictly layout objects and are not stored in the Document class; Chris@127: instead the MainWindow contains a PaneStack widget (the widget that Chris@127: takes up most of Sonic Visualiser's main window) which contains a Chris@127: set of panes stacked vertically. Chris@127: Chris@127: Another View subclass is Overview, which is the widget that Chris@127: contains that green waveform showing the entire file at the bottom Chris@127: of the window. Chris@127: Chris@127: */ Chris@127: Chris@0: static QMutex cleanupMutex; Chris@0: Chris@0: static void Chris@0: signalHandler(int /* signal */) Chris@0: { Chris@0: // Avoid this happening more than once across threads Chris@0: Chris@0: cleanupMutex.lock(); Chris@0: std::cerr << "signalHandler: cleaning up and exiting" << std::endl; Chris@0: TempDirectory::getInstance()->cleanup(); Chris@0: exit(0); // without releasing mutex Chris@0: } Chris@0: Chris@11: class SVApplication : public QApplication Chris@11: { Chris@11: public: Chris@11: SVApplication(int argc, char **argv) : Chris@11: QApplication(argc, argv), Chris@11: m_mainWindow(0) { } Chris@11: virtual ~SVApplication() { } Chris@11: Chris@11: void setMainWindow(MainWindow *mw) { m_mainWindow = mw; } Chris@11: void releaseMainWindow() { m_mainWindow = 0; } Chris@11: Chris@11: virtual void commitData(QSessionManager &manager) { Chris@11: if (!m_mainWindow) return; Chris@11: bool mayAskUser = manager.allowsInteraction(); Chris@11: bool success = m_mainWindow->commitData(mayAskUser); Chris@11: manager.release(); Chris@11: if (!success) manager.cancel(); Chris@11: } Chris@11: Chris@11: protected: Chris@11: MainWindow *m_mainWindow; Chris@11: }; Chris@11: Chris@0: int Chris@0: main(int argc, char **argv) Chris@0: { Chris@11: SVApplication application(argc, argv); Chris@0: Chris@46: QStringList args = application.arguments(); Chris@46: Chris@0: signal(SIGINT, signalHandler); Chris@0: signal(SIGTERM, signalHandler); Chris@0: Chris@0: #ifndef Q_WS_WIN32 Chris@0: signal(SIGHUP, signalHandler); Chris@0: signal(SIGQUIT, signalHandler); Chris@0: #endif Chris@0: Chris@0: svSystemSpecificInitialisation(); Chris@0: Chris@46: bool audioOutput = true; Chris@70: bool oscSupport = true; Chris@70: Chris@133: if (args.contains("--help") || args.contains("-h") || args.contains("-?")) { Chris@70: std::cerr << QApplication::tr( Chris@70: "\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] [ ...]\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 : One or more Sonic Visualiser (.sv) and audio files may be provided.\n").arg(argv[0]).toStdString() << std::endl; Chris@70: exit(2); Chris@70: } Chris@70: Chris@46: if (args.contains("--no-audio")) audioOutput = false; Chris@70: if (args.contains("--no-osc")) oscSupport = false; Chris@46: Chris@6: QApplication::setOrganizationName("sonic-visualiser"); Chris@5: QApplication::setOrganizationDomain("sonicvisualiser.org"); Chris@6: QApplication::setApplicationName("sonic-visualiser"); Chris@141: Chris@141: QIcon icon; Chris@141: int sizes[] = { 16, 22, 24, 32, 48, 64, 128 }; Chris@141: for (int i = 0; i < sizeof(sizes)/sizeof(sizes[0]); ++i) { Chris@141: icon.addFile(QString(":icons/sv-%1x%2.png").arg(sizes[i]).arg(sizes[i])); Chris@141: } Chris@141: QApplication::setWindowIcon(icon); Chris@7: Chris@0: QString language = QLocale::system().name(); Chris@0: Chris@0: QTranslator qtTranslator; Chris@0: QString qtTrName = QString("qt_%1").arg(language); Chris@0: std::cerr << "Loading " << qtTrName.toStdString() << "..." << std::endl; Chris@165: bool success = false; Chris@165: if (!(success = qtTranslator.load(qtTrName))) { Chris@165: QString qtDir = getenv("QTDIR"); Chris@165: if (qtDir != "") { Chris@165: success = qtTranslator.load Chris@165: (qtTrName, QDir(qtDir).filePath("translations")); Chris@165: } Chris@165: } Chris@165: if (!success) { Chris@165: std::cerr << "Failed to load Qt translation for locale" << std::endl; Chris@165: } Chris@0: application.installTranslator(&qtTranslator); Chris@0: Chris@0: QTranslator svTranslator; Chris@0: QString svTrName = QString("sonic-visualiser_%1").arg(language); Chris@0: std::cerr << "Loading " << svTrName.toStdString() << "..." << std::endl; Chris@0: svTranslator.load(svTrName, ":i18n"); Chris@0: application.installTranslator(&svTranslator); Chris@0: Chris@187: StoreStartupLocale(); Chris@187: Chris@0: // Permit size_t and PropertyName to be used as args in queued signal calls Chris@0: qRegisterMetaType("size_t"); Chris@0: qRegisterMetaType("PropertyContainer::PropertyName"); Chris@0: Chris@70: MainWindow gui(audioOutput, oscSupport); Chris@11: application.setMainWindow(&gui); Chris@0: Chris@0: QDesktopWidget *desktop = QApplication::desktop(); Chris@0: QRect available = desktop->availableGeometry(); Chris@0: Chris@0: int width = available.width() * 2 / 3; Chris@0: int height = available.height() / 2; Chris@0: if (height < 450) height = available.height() * 2 / 3; Chris@0: if (width > height * 2) width = height * 2; Chris@0: Chris@5: QSettings settings; Chris@5: settings.beginGroup("MainWindow"); Chris@5: QSize size = settings.value("size", QSize(width, height)).toSize(); Chris@5: gui.resize(size); Chris@5: if (settings.contains("position")) { Chris@5: gui.move(settings.value("position").toPoint()); Chris@5: } Chris@5: settings.endGroup(); Chris@5: Chris@0: gui.show(); Chris@64: Chris@118: // The MainWindow class seems to have trouble dealing with this if Chris@118: // it tries to adapt to this preference before the constructor is Chris@118: // complete. As a lazy hack, apply it explicitly from here Chris@118: gui.preferenceChanged("Property Box Layout"); Chris@118: Chris@54: bool haveSession = false; Chris@54: bool haveMainModel = false; Chris@145: bool havePriorCommandLineModel = false; Chris@46: Chris@54: for (QStringList::iterator i = args.begin(); i != args.end(); ++i) { Chris@54: Chris@83: MainWindow::FileOpenStatus status = MainWindow::FileOpenFailed; Chris@54: Chris@54: if (i == args.begin()) continue; Chris@54: if (i->startsWith('-')) continue; Chris@54: Chris@85: if (i->startsWith("http:") || i->startsWith("ftp:")) { Chris@166: std::cerr << "opening URL: \"" << i->toStdString() << "\"..." << std::endl; Chris@180: status = gui.openURL(*i); Chris@85: continue; Chris@85: } Chris@85: Chris@54: QString path = *i; Chris@54: Chris@54: if (path.endsWith("sv")) { Chris@54: if (!haveSession) { Chris@82: status = gui.openSessionFile(path); Chris@82: if (status == MainWindow::FileOpenSucceeded) { Chris@54: haveSession = true; Chris@54: haveMainModel = true; Chris@54: } Chris@54: } else { Chris@54: std::cerr << "WARNING: Ignoring additional session file argument \"" << path.toStdString() << "\"" << std::endl; Chris@82: status = MainWindow::FileOpenSucceeded; Chris@54: } Chris@54: } Chris@82: if (status != MainWindow::FileOpenSucceeded) { Chris@54: if (!haveMainModel) { Chris@82: status = gui.openSomeFile(path, MainWindow::ReplaceMainModel); Chris@145: if (status == MainWindow::FileOpenSucceeded) { Chris@145: haveMainModel = true; Chris@145: } Chris@54: } else { Chris@145: if (haveSession && !havePriorCommandLineModel) { Chris@145: status = gui.openSomeFile(path, MainWindow::AskUser); Chris@145: if (status == MainWindow::FileOpenSucceeded) { Chris@145: havePriorCommandLineModel = true; Chris@145: } Chris@145: } else { Chris@145: status = gui.openSomeFile(path, MainWindow::CreateAdditionalModel); Chris@145: } Chris@54: } Chris@54: } Chris@82: if (status == MainWindow::FileOpenFailed) { Chris@54: QMessageBox::critical Chris@54: (&gui, QMessageBox::tr("Failed to open file"), Chris@54: QMessageBox::tr("File \"%1\" could not be opened").arg(path)); Chris@54: } Chris@180: } Chris@180: Chris@180: Chris@180: Chris@123: /* Chris@120: TipDialog tipDialog; Chris@120: if (tipDialog.isOK()) { Chris@120: tipDialog.exec(); Chris@120: } Chris@123: */ Chris@0: int rv = application.exec(); Chris@137: // std::cerr << "application.exec() returned " << rv << std::endl; Chris@0: Chris@0: cleanupMutex.lock(); Chris@0: TempDirectory::getInstance()->cleanup(); Chris@11: application.releaseMainWindow(); Chris@5: Chris@0: return rv; Chris@0: }