annotate main/MainWindow.h @ 11:0dbd08e365ce

* Add session management support (commitData)
author Chris Cannam
date Tue, 12 Sep 2006 12:15:44 +0000
parents c3ef80114040
children 3715efc38f95
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@0 7 This file copyright 2006 Chris Cannam.
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@0 27 #include "layer/LayerFactory.h"
Chris@0 28 #include "transform/Transform.h"
Chris@1 29 #include "document/SVFileReader.h"
Chris@0 30 #include <map>
Chris@0 31
Chris@0 32 class Document;
Chris@0 33 class PaneStack;
Chris@0 34 class Pane;
Chris@0 35 class View;
Chris@0 36 class Fader;
Chris@0 37 class Panner;
Chris@0 38 class Layer;
Chris@0 39 class WaveformLayer;
Chris@0 40 class WaveFileModel;
Chris@0 41 class AudioCallbackPlaySource;
Chris@0 42 class AudioCallbackPlayTarget;
Chris@0 43 class CommandHistory;
Chris@0 44 class QMenu;
Chris@0 45 class AudioDial;
Chris@0 46 class QLabel;
Chris@0 47 class PreferencesDialog;
Chris@0 48
Chris@0 49
Chris@0 50 class MainWindow : public QMainWindow
Chris@0 51 {
Chris@0 52 Q_OBJECT
Chris@0 53
Chris@0 54 public:
Chris@0 55 MainWindow();
Chris@0 56 virtual ~MainWindow();
Chris@0 57
Chris@0 58 enum AudioFileOpenMode {
Chris@0 59 ReplaceMainModel,
Chris@0 60 CreateAdditionalModel,
Chris@0 61 AskUser
Chris@0 62 };
Chris@0 63
Chris@0 64 bool openSomeFile(QString path);
Chris@0 65 bool openAudioFile(QString path, AudioFileOpenMode = AskUser);
Chris@0 66 bool openLayerFile(QString path);
Chris@0 67 bool openSessionFile(QString path);
Chris@0 68 bool saveSessionFile(QString path);
Chris@11 69 bool commitData(bool mayAskUser); // on session shutdown
Chris@0 70
Chris@0 71 signals:
Chris@0 72 // Used to toggle the availability of menu actions
Chris@0 73 void canAddPane(bool);
Chris@0 74 void canDeleteCurrentPane(bool);
Chris@0 75 void canAddLayer(bool);
Chris@0 76 void canImportMoreAudio(bool);
Chris@0 77 void canImportLayer(bool);
Chris@0 78 void canExportAudio(bool);
Chris@0 79 void canExportLayer(bool);
Chris@0 80 void canRenameLayer(bool);
Chris@0 81 void canEditLayer(bool);
Chris@0 82 void canSelect(bool);
Chris@0 83 void canClearSelection(bool);
Chris@0 84 void canEditSelection(bool);
Chris@0 85 void canPaste(bool);
Chris@0 86 void canInsertInstant(bool);
Chris@0 87 void canDeleteCurrentLayer(bool);
Chris@0 88 void canZoom(bool);
Chris@0 89 void canScroll(bool);
Chris@0 90 void canPlay(bool);
Chris@0 91 void canFfwd(bool);
Chris@0 92 void canRewind(bool);
Chris@0 93 void canPlaySelection(bool);
Chris@0 94 void canSave(bool);
Chris@0 95
Chris@0 96 protected slots:
Chris@0 97 void openSession();
Chris@0 98 void importAudio();
Chris@0 99 void importMoreAudio();
Chris@0 100 void openSomething();
Chris@0 101 void openRecentFile();
Chris@0 102 void exportAudio();
Chris@0 103 void importLayer();
Chris@0 104 void exportLayer();
Chris@0 105 void saveSession();
Chris@0 106 void saveSessionAs();
Chris@0 107 void newSession();
Chris@0 108 void closeSession();
Chris@0 109 void preferences();
Chris@0 110
Chris@0 111 void zoomIn();
Chris@0 112 void zoomOut();
Chris@0 113 void zoomToFit();
Chris@0 114 void zoomDefault();
Chris@0 115 void scrollLeft();
Chris@0 116 void scrollRight();
Chris@0 117 void jumpLeft();
Chris@0 118 void jumpRight();
Chris@0 119
Chris@0 120 void showNoOverlays();
Chris@0 121 void showBasicOverlays();
Chris@7 122 void showAllTextOverlays();
Chris@7 123
Chris@7 124 void toggleZoomWheels();
Chris@0 125
Chris@0 126 void play();
Chris@0 127 void ffwd();
Chris@0 128 void ffwdEnd();
Chris@0 129 void rewind();
Chris@0 130 void rewindStart();
Chris@0 131 void stop();
Chris@0 132
Chris@0 133 void addPane();
Chris@0 134 void addLayer();
Chris@0 135 void deleteCurrentPane();
Chris@0 136 void renameCurrentLayer();
Chris@0 137 void deleteCurrentLayer();
Chris@0 138
Chris@0 139 void playLoopToggled();
Chris@0 140 void playSelectionToggled();
Chris@0 141 void playSpeedChanged(int);
Chris@0 142 void sampleRateMismatch(size_t, size_t, bool);
Chris@0 143
Chris@0 144 void outputLevelsChanged(float, float);
Chris@0 145
Chris@0 146 void currentPaneChanged(Pane *);
Chris@0 147 void currentLayerChanged(Pane *, Layer *);
Chris@0 148
Chris@0 149 void toolNavigateSelected();
Chris@0 150 void toolSelectSelected();
Chris@0 151 void toolEditSelected();
Chris@0 152 void toolDrawSelected();
Chris@0 153
Chris@0 154 void selectAll();
Chris@0 155 void selectToStart();
Chris@0 156 void selectToEnd();
Chris@0 157 void selectVisible();
Chris@0 158 void clearSelection();
Chris@0 159 void cut();
Chris@0 160 void copy();
Chris@0 161 void paste();
Chris@0 162 void deleteSelected();
Chris@0 163 void insertInstant();
Chris@0 164
Chris@0 165 void documentModified();
Chris@0 166 void documentRestored();
Chris@0 167
Chris@0 168 void updateMenuStates();
Chris@0 169 void updateDescriptionLabel();
Chris@0 170
Chris@0 171 void layerAdded(Layer *);
Chris@0 172 void layerRemoved(Layer *);
Chris@0 173 void layerAboutToBeDeleted(Layer *);
Chris@0 174 void layerInAView(Layer *, bool);
Chris@0 175
Chris@0 176 void mainModelChanged(WaveFileModel *);
Chris@0 177 void modelAdded(Model *);
Chris@0 178 void modelAboutToBeDeleted(Model *);
Chris@0 179
Chris@0 180 void modelGenerationFailed(QString);
Chris@0 181 void modelRegenerationFailed(QString, QString);
Chris@0 182
Chris@0 183 void rightButtonMenuRequested(Pane *, QPoint point);
Chris@0 184
Chris@0 185 void preferenceChanged(PropertyContainer::PropertyName);
Chris@0 186
Chris@0 187 void setupRecentFilesMenu();
Chris@0 188
Chris@0 189 void showLayerTree();
Chris@0 190
Chris@0 191 void website();
Chris@0 192 void help();
Chris@0 193 void about();
Chris@0 194
Chris@0 195 protected:
Chris@0 196 QString m_sessionFile;
Chris@0 197 QString m_audioFile;
Chris@0 198 Document *m_document;
Chris@0 199
Chris@0 200 QLabel *m_descriptionLabel;
Chris@0 201 PaneStack *m_paneStack;
Chris@0 202 ViewManager *m_viewManager;
Chris@0 203 Panner *m_panner;
Chris@0 204 Fader *m_fader;
Chris@0 205 AudioDial *m_playSpeed;
Chris@0 206 WaveformLayer *m_panLayer;
Chris@0 207 Layer *m_timeRulerLayer;
Chris@0 208
Chris@0 209 AudioCallbackPlaySource *m_playSource;
Chris@0 210 AudioCallbackPlayTarget *m_playTarget;
Chris@0 211
Chris@0 212 bool m_mainMenusCreated;
Chris@0 213 QMenu *m_paneMenu;
Chris@0 214 QMenu *m_layerMenu;
Chris@0 215 QMenu *m_existingLayersMenu;
Chris@0 216 QMenu *m_recentFilesMenu;
Chris@0 217 QMenu *m_rightButtonMenu;
Chris@0 218 QMenu *m_rightButtonLayerMenu;
Chris@0 219
Chris@0 220 bool m_documentModified;
Chris@0 221
Chris@0 222 QPointer<PreferencesDialog> m_preferencesDialog;
Chris@0 223
Chris@0 224 WaveFileModel *getMainModel();
Chris@0 225 void createDocument();
Chris@0 226
Chris@0 227 struct PaneConfiguration {
Chris@0 228 PaneConfiguration(LayerFactory::LayerType _layer
Chris@0 229 = LayerFactory::TimeRuler,
Chris@0 230 int _channel = -1) :
Chris@0 231 layer(_layer), channel(_channel) { }
Chris@0 232 LayerFactory::LayerType layer;
Chris@0 233 int channel;
Chris@0 234 };
Chris@0 235
Chris@0 236 typedef std::map<QAction *, PaneConfiguration> PaneActionMap;
Chris@0 237 PaneActionMap m_paneActions;
Chris@0 238
Chris@0 239 typedef std::map<QAction *, TransformName> TransformActionMap;
Chris@0 240 TransformActionMap m_layerTransformActions;
Chris@0 241
Chris@0 242 typedef std::map<QAction *, LayerFactory::LayerType> LayerActionMap;
Chris@0 243 LayerActionMap m_layerActions;
Chris@0 244
Chris@0 245 typedef std::map<QAction *, Layer *> ExistingLayerActionMap;
Chris@0 246 ExistingLayerActionMap m_existingLayerActions;
Chris@0 247
Chris@0 248 typedef std::map<ViewManager::ToolMode, QAction *> ToolActionMap;
Chris@0 249 ToolActionMap m_toolActions;
Chris@0 250
Chris@0 251 void setupMenus();
Chris@0 252 void setupExistingLayersMenu();
Chris@0 253 void setupToolbars();
Chris@0 254 Pane *addPaneToStack();
Chris@0 255
Chris@0 256 class PaneCallback : public SVFileReaderPaneCallback
Chris@0 257 {
Chris@0 258 public:
Chris@0 259 PaneCallback(MainWindow *mw) : m_mw(mw) { }
Chris@0 260 virtual Pane *addPane() { return m_mw->addPaneToStack(); }
Chris@0 261 virtual void setWindowSize(int width, int height) {
Chris@0 262 m_mw->resize(width, height);
Chris@0 263 }
Chris@0 264 virtual void addSelection(int start, int end) {
Chris@0 265 m_mw->m_viewManager->addSelection(Selection(start, end));
Chris@0 266 }
Chris@0 267 protected:
Chris@0 268 MainWindow *m_mw;
Chris@0 269 };
Chris@0 270
Chris@0 271 class AddPaneCommand : public Command
Chris@0 272 {
Chris@0 273 public:
Chris@0 274 AddPaneCommand(MainWindow *mw);
Chris@0 275 virtual ~AddPaneCommand();
Chris@0 276
Chris@0 277 virtual void execute();
Chris@0 278 virtual void unexecute();
Chris@0 279 virtual QString getName() const;
Chris@0 280
Chris@0 281 Pane *getPane() { return m_pane; }
Chris@0 282
Chris@0 283 protected:
Chris@0 284 MainWindow *m_mw;
Chris@0 285 Pane *m_pane; // Main window owns this, but I determine its lifespan
Chris@0 286 Pane *m_prevCurrentPane; // I don't own this
Chris@0 287 bool m_added;
Chris@0 288 };
Chris@0 289
Chris@0 290 class RemovePaneCommand : public Command
Chris@0 291 {
Chris@0 292 public:
Chris@0 293 RemovePaneCommand(MainWindow *mw, Pane *pane);
Chris@0 294 virtual ~RemovePaneCommand();
Chris@0 295
Chris@0 296 virtual void execute();
Chris@0 297 virtual void unexecute();
Chris@0 298 virtual QString getName() const;
Chris@0 299
Chris@0 300 protected:
Chris@0 301 MainWindow *m_mw;
Chris@0 302 Pane *m_pane; // Main window owns this, but I determine its lifespan
Chris@0 303 Pane *m_prevCurrentPane; // I don't own this
Chris@0 304 bool m_added;
Chris@0 305 };
Chris@0 306
Chris@0 307 virtual void closeEvent(QCloseEvent *e);
Chris@0 308 bool checkSaveModified();
Chris@0 309
Chris@0 310 void createPlayTarget();
Chris@0 311
Chris@0 312 void openHelpUrl(QString url);
Chris@0 313
Chris@0 314 void toXml(QTextStream &stream);
Chris@0 315 };
Chris@0 316
Chris@0 317
Chris@0 318 #endif