annotate main/MainWindow.h @ 77:bedc7517b6e8

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