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