annotate main/MainWindow.h @ 82:d82e332cb178

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