annotate main/MainWindow.h @ 85:4eae5b521a34

* Framework for retrieving files from remote locations
author Chris Cannam
date Mon, 08 Jan 2007 17:04:35 +0000
parents d82e332cb178
children 6113fdda2737
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 #ifndef _MAIN_WINDOW_H_
Chris@0 17 #define _MAIN_WINDOW_H_
Chris@0 18
Chris@0 19 #include <QFrame>
Chris@0 20 #include <QString>
Chris@85 21 #include <QUrl>
Chris@0 22 #include <QMainWindow>
Chris@0 23 #include <QPointer>
Chris@0 24
Chris@0 25 #include "base/Command.h"
Chris@1 26 #include "view/ViewManager.h"
Chris@0 27 #include "base/PropertyContainer.h"
Chris@34 28 #include "base/RecentFiles.h"
Chris@0 29 #include "layer/LayerFactory.h"
Chris@0 30 #include "transform/Transform.h"
Chris@1 31 #include "document/SVFileReader.h"
Chris@0 32 #include <map>
Chris@0 33
Chris@0 34 class Document;
Chris@0 35 class PaneStack;
Chris@0 36 class Pane;
Chris@0 37 class View;
Chris@0 38 class Fader;
Chris@65 39 class Overview;
Chris@0 40 class Layer;
Chris@0 41 class WaveformLayer;
Chris@0 42 class WaveFileModel;
Chris@0 43 class AudioCallbackPlaySource;
Chris@0 44 class AudioCallbackPlayTarget;
Chris@0 45 class CommandHistory;
Chris@0 46 class QMenu;
Chris@0 47 class AudioDial;
Chris@0 48 class QLabel;
Chris@16 49 class QCheckBox;
Chris@0 50 class PreferencesDialog;
Chris@26 51 class QPushButton;
Chris@69 52 class OSCQueue;
Chris@69 53 class OSCMessage;
Chris@0 54
Chris@0 55
Chris@0 56 class MainWindow : public QMainWindow
Chris@0 57 {
Chris@0 58 Q_OBJECT
Chris@0 59
Chris@0 60 public:
Chris@70 61 MainWindow(bool withAudioOutput = true,
Chris@70 62 bool withOSCSupport = true);
Chris@0 63 virtual ~MainWindow();
Chris@0 64
Chris@0 65 enum AudioFileOpenMode {
Chris@0 66 ReplaceMainModel,
Chris@0 67 CreateAdditionalModel,
Chris@0 68 AskUser
Chris@0 69 };
Chris@0 70
Chris@82 71 enum FileOpenStatus {
Chris@82 72 FileOpenSucceeded,
Chris@82 73 FileOpenFailed,
Chris@82 74 FileOpenCancelled
Chris@82 75 };
Chris@82 76
Chris@82 77 FileOpenStatus openSomeFile(QString path, AudioFileOpenMode = AskUser);
Chris@82 78 FileOpenStatus openAudioFile(QString path, AudioFileOpenMode = AskUser);
Chris@82 79 FileOpenStatus openLayerFile(QString path);
Chris@82 80 FileOpenStatus openSessionFile(QString path);
Chris@85 81 FileOpenStatus openURL(QUrl url);
Chris@82 82
Chris@0 83 bool saveSessionFile(QString path);
Chris@11 84 bool commitData(bool mayAskUser); // on session shutdown
Chris@0 85
Chris@0 86 signals:
Chris@0 87 // Used to toggle the availability of menu actions
Chris@0 88 void canAddPane(bool);
Chris@0 89 void canDeleteCurrentPane(bool);
Chris@0 90 void canAddLayer(bool);
Chris@0 91 void canImportMoreAudio(bool);
Chris@0 92 void canImportLayer(bool);
Chris@0 93 void canExportAudio(bool);
Chris@0 94 void canExportLayer(bool);
Chris@0 95 void canRenameLayer(bool);
Chris@0 96 void canEditLayer(bool);
Chris@0 97 void canSelect(bool);
Chris@0 98 void canClearSelection(bool);
Chris@0 99 void canEditSelection(bool);
Chris@0 100 void canPaste(bool);
Chris@0 101 void canInsertInstant(bool);
Chris@81 102 void canInsertInstantsAtBoundaries(bool);
Chris@0 103 void canDeleteCurrentLayer(bool);
Chris@0 104 void canZoom(bool);
Chris@0 105 void canScroll(bool);
Chris@0 106 void canPlay(bool);
Chris@0 107 void canFfwd(bool);
Chris@0 108 void canRewind(bool);
Chris@0 109 void canPlaySelection(bool);
Chris@0 110 void canSave(bool);
Chris@0 111
Chris@0 112 protected slots:
Chris@0 113 void openSession();
Chris@0 114 void importAudio();
Chris@0 115 void importMoreAudio();
Chris@0 116 void openSomething();
Chris@0 117 void openRecentFile();
Chris@0 118 void exportAudio();
Chris@0 119 void importLayer();
Chris@0 120 void exportLayer();
Chris@0 121 void saveSession();
Chris@0 122 void saveSessionAs();
Chris@0 123 void newSession();
Chris@0 124 void closeSession();
Chris@0 125 void preferences();
Chris@0 126
Chris@0 127 void zoomIn();
Chris@0 128 void zoomOut();
Chris@0 129 void zoomToFit();
Chris@0 130 void zoomDefault();
Chris@0 131 void scrollLeft();
Chris@0 132 void scrollRight();
Chris@0 133 void jumpLeft();
Chris@0 134 void jumpRight();
Chris@0 135
Chris@0 136 void showNoOverlays();
Chris@0 137 void showBasicOverlays();
Chris@7 138 void showAllTextOverlays();
Chris@7 139
Chris@7 140 void toggleZoomWheels();
Chris@72 141 void togglePropertyBoxes();
Chris@0 142
Chris@0 143 void play();
Chris@0 144 void ffwd();
Chris@0 145 void ffwdEnd();
Chris@0 146 void rewind();
Chris@0 147 void rewindStart();
Chris@0 148 void stop();
Chris@0 149
Chris@0 150 void addPane();
Chris@0 151 void addLayer();
Chris@0 152 void deleteCurrentPane();
Chris@0 153 void renameCurrentLayer();
Chris@0 154 void deleteCurrentLayer();
Chris@0 155
Chris@0 156 void playLoopToggled();
Chris@0 157 void playSelectionToggled();
Chris@0 158 void playSpeedChanged(int);
Chris@16 159 void playSharpenToggled();
Chris@26 160 void playMonoToggled();
Chris@0 161 void sampleRateMismatch(size_t, size_t, bool);
Chris@42 162 void audioOverloadPluginDisabled();
Chris@0 163
Chris@0 164 void outputLevelsChanged(float, float);
Chris@0 165
Chris@0 166 void currentPaneChanged(Pane *);
Chris@0 167 void currentLayerChanged(Pane *, Layer *);
Chris@0 168
Chris@0 169 void toolNavigateSelected();
Chris@0 170 void toolSelectSelected();
Chris@0 171 void toolEditSelected();
Chris@0 172 void toolDrawSelected();
Chris@0 173
Chris@0 174 void selectAll();
Chris@0 175 void selectToStart();
Chris@0 176 void selectToEnd();
Chris@0 177 void selectVisible();
Chris@0 178 void clearSelection();
Chris@0 179 void cut();
Chris@0 180 void copy();
Chris@0 181 void paste();
Chris@0 182 void deleteSelected();
Chris@0 183 void insertInstant();
Chris@81 184 void insertInstantAt(size_t);
Chris@81 185 void insertInstantsAtBoundaries();
Chris@0 186
Chris@0 187 void documentModified();
Chris@0 188 void documentRestored();
Chris@0 189
Chris@0 190 void updateMenuStates();
Chris@0 191 void updateDescriptionLabel();
Chris@0 192
Chris@0 193 void layerAdded(Layer *);
Chris@0 194 void layerRemoved(Layer *);
Chris@0 195 void layerAboutToBeDeleted(Layer *);
Chris@0 196 void layerInAView(Layer *, bool);
Chris@0 197
Chris@0 198 void mainModelChanged(WaveFileModel *);
Chris@0 199 void modelAdded(Model *);
Chris@0 200 void modelAboutToBeDeleted(Model *);
Chris@0 201
Chris@0 202 void modelGenerationFailed(QString);
Chris@0 203 void modelRegenerationFailed(QString, QString);
Chris@0 204
Chris@0 205 void rightButtonMenuRequested(Pane *, QPoint point);
Chris@0 206
Chris@73 207 void propertyStacksResized();
Chris@73 208
Chris@0 209 void preferenceChanged(PropertyContainer::PropertyName);
Chris@0 210
Chris@0 211 void setupRecentFilesMenu();
Chris@34 212 void setupRecentTransformsMenu();
Chris@0 213
Chris@0 214 void showLayerTree();
Chris@0 215
Chris@69 216 void pollOSC();
Chris@69 217 void handleOSCMessage(const OSCMessage &);
Chris@69 218
Chris@0 219 void website();
Chris@0 220 void help();
Chris@0 221 void about();
Chris@0 222
Chris@0 223 protected:
Chris@0 224 QString m_sessionFile;
Chris@0 225 QString m_audioFile;
Chris@0 226 Document *m_document;
Chris@0 227
Chris@0 228 QLabel *m_descriptionLabel;
Chris@0 229 PaneStack *m_paneStack;
Chris@0 230 ViewManager *m_viewManager;
Chris@65 231 Overview *m_overview;
Chris@0 232 Fader *m_fader;
Chris@0 233 AudioDial *m_playSpeed;
Chris@26 234 QPushButton *m_playSharpen;
Chris@26 235 QPushButton *m_playMono;
Chris@0 236 WaveformLayer *m_panLayer;
Chris@0 237 Layer *m_timeRulerLayer;
Chris@0 238
Chris@46 239 bool m_audioOutput;
Chris@0 240 AudioCallbackPlaySource *m_playSource;
Chris@0 241 AudioCallbackPlayTarget *m_playTarget;
Chris@0 242
Chris@69 243 OSCQueue *m_oscQueue;
Chris@69 244
Chris@34 245 RecentFiles m_recentFiles;
Chris@34 246 RecentFiles m_recentTransforms;
Chris@34 247
Chris@0 248 bool m_mainMenusCreated;
Chris@0 249 QMenu *m_paneMenu;
Chris@0 250 QMenu *m_layerMenu;
Chris@34 251 QMenu *m_transformsMenu;
Chris@0 252 QMenu *m_existingLayersMenu;
Chris@0 253 QMenu *m_recentFilesMenu;
Chris@34 254 QMenu *m_recentTransformsMenu;
Chris@0 255 QMenu *m_rightButtonMenu;
Chris@0 256 QMenu *m_rightButtonLayerMenu;
Chris@34 257 QMenu *m_rightButtonTransformsMenu;
Chris@0 258
Chris@0 259 bool m_documentModified;
Chris@70 260 bool m_openingAudioFile;
Chris@70 261 bool m_abandoning;
Chris@0 262
Chris@0 263 QPointer<PreferencesDialog> m_preferencesDialog;
Chris@0 264
Chris@0 265 WaveFileModel *getMainModel();
Chris@0 266 void createDocument();
Chris@0 267
Chris@0 268 struct PaneConfiguration {
Chris@0 269 PaneConfiguration(LayerFactory::LayerType _layer
Chris@0 270 = LayerFactory::TimeRuler,
Chris@66 271 Model *_source = 0,
Chris@0 272 int _channel = -1) :
Chris@66 273 layer(_layer), sourceModel(_source), channel(_channel) { }
Chris@0 274 LayerFactory::LayerType layer;
Chris@66 275 Model *sourceModel;
Chris@0 276 int channel;
Chris@0 277 };
Chris@0 278
Chris@0 279 typedef std::map<QAction *, PaneConfiguration> PaneActionMap;
Chris@0 280 PaneActionMap m_paneActions;
Chris@0 281
Chris@0 282 typedef std::map<QAction *, TransformName> TransformActionMap;
Chris@34 283 TransformActionMap m_transformActions;
Chris@34 284
Chris@34 285 typedef std::map<TransformName, QAction *> TransformActionReverseMap;
Chris@34 286 TransformActionReverseMap m_transformActionsReverse;
Chris@0 287
Chris@0 288 typedef std::map<QAction *, LayerFactory::LayerType> LayerActionMap;
Chris@0 289 LayerActionMap m_layerActions;
Chris@0 290
Chris@0 291 typedef std::map<QAction *, Layer *> ExistingLayerActionMap;
Chris@0 292 ExistingLayerActionMap m_existingLayerActions;
Chris@0 293
Chris@0 294 typedef std::map<ViewManager::ToolMode, QAction *> ToolActionMap;
Chris@0 295 ToolActionMap m_toolActions;
Chris@0 296
Chris@0 297 void setupMenus();
Chris@66 298 void setupFileMenu();
Chris@66 299 void setupEditMenu();
Chris@66 300 void setupViewMenu();
Chris@66 301 void setupPaneAndLayerMenus();
Chris@66 302 void setupTransformsMenu();
Chris@66 303 void setupHelpMenu();
Chris@0 304 void setupExistingLayersMenu();
Chris@0 305 void setupToolbars();
Chris@66 306
Chris@0 307 Pane *addPaneToStack();
Chris@0 308
Chris@69 309 void addPane(const PaneConfiguration &configuration, QString text);
Chris@69 310
Chris@0 311 class PaneCallback : public SVFileReaderPaneCallback
Chris@0 312 {
Chris@0 313 public:
Chris@0 314 PaneCallback(MainWindow *mw) : m_mw(mw) { }
Chris@0 315 virtual Pane *addPane() { return m_mw->addPaneToStack(); }
Chris@0 316 virtual void setWindowSize(int width, int height) {
Chris@0 317 m_mw->resize(width, height);
Chris@0 318 }
Chris@0 319 virtual void addSelection(int start, int end) {
Chris@0 320 m_mw->m_viewManager->addSelection(Selection(start, end));
Chris@0 321 }
Chris@0 322 protected:
Chris@0 323 MainWindow *m_mw;
Chris@0 324 };
Chris@0 325
Chris@0 326 class AddPaneCommand : public Command
Chris@0 327 {
Chris@0 328 public:
Chris@0 329 AddPaneCommand(MainWindow *mw);
Chris@0 330 virtual ~AddPaneCommand();
Chris@0 331
Chris@0 332 virtual void execute();
Chris@0 333 virtual void unexecute();
Chris@0 334 virtual QString getName() const;
Chris@0 335
Chris@0 336 Pane *getPane() { return m_pane; }
Chris@0 337
Chris@0 338 protected:
Chris@0 339 MainWindow *m_mw;
Chris@0 340 Pane *m_pane; // Main window owns this, but I determine its lifespan
Chris@0 341 Pane *m_prevCurrentPane; // I don't own this
Chris@0 342 bool m_added;
Chris@0 343 };
Chris@0 344
Chris@0 345 class RemovePaneCommand : public Command
Chris@0 346 {
Chris@0 347 public:
Chris@0 348 RemovePaneCommand(MainWindow *mw, Pane *pane);
Chris@0 349 virtual ~RemovePaneCommand();
Chris@0 350
Chris@0 351 virtual void execute();
Chris@0 352 virtual void unexecute();
Chris@0 353 virtual QString getName() const;
Chris@0 354
Chris@0 355 protected:
Chris@0 356 MainWindow *m_mw;
Chris@0 357 Pane *m_pane; // Main window owns this, but I determine its lifespan
Chris@0 358 Pane *m_prevCurrentPane; // I don't own this
Chris@0 359 bool m_added;
Chris@0 360 };
Chris@0 361
Chris@0 362 virtual void closeEvent(QCloseEvent *e);
Chris@0 363 bool checkSaveModified();
Chris@0 364
Chris@81 365 enum FileType {
Chris@81 366 SessionFile,
Chris@81 367 AudioFile,
Chris@81 368 LayerFile,
Chris@81 369 AnyFile
Chris@81 370 };
Chris@81 371
Chris@81 372 QString getOpenFileName(FileType type);
Chris@81 373 QString getSaveFileName(FileType type);
Chris@81 374 void registerLastOpenedFilePath(FileType type, QString path);
Chris@81 375
Chris@0 376 void createPlayTarget();
Chris@0 377
Chris@0 378 void openHelpUrl(QString url);
Chris@0 379
Chris@0 380 void toXml(QTextStream &stream);
Chris@0 381 };
Chris@0 382
Chris@0 383
Chris@0 384 #endif