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