Chris@58: /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
Chris@30: 
Chris@30: /*
Chris@59:     Sonic Visualiser
Chris@59:     An audio file viewer and annotation editor.
Chris@59:     Centre for Digital Music, Queen Mary, University of London.
Chris@59:     This file copyright 2006 Chris Cannam.
Chris@30:     
Chris@59:     This program is free software; you can redistribute it and/or
Chris@59:     modify it under the terms of the GNU General Public License as
Chris@59:     published by the Free Software Foundation; either version 2 of the
Chris@59:     License, or (at your option) any later version.  See the file
Chris@59:     COPYING included with this distribution for more information.
Chris@30: */
Chris@30: 
matthiasm@620: #ifndef _FLEXINOTE_LAYER_H_
matthiasm@620: #define _FLEXINOTE_LAYER_H_
Chris@30: 
matthiasm@651: #define NOTE_HEIGHT 16
gyorgyf@646: 
Chris@287: #include "SingleColourLayer.h"
Chris@701: #include "VerticalScaleLayer.h"
Chris@701: 
matthiasm@620: #include "data/model/FlexiNoteModel.h"
Chris@30: 
Chris@30: #include <QObject>
Chris@30: #include <QColor>
Chris@30: 
Chris@30: class View;
Chris@30: class QPainter;
Chris@745: class SparseTimeValueModel;
Chris@702: 
Chris@702: class FlexiNoteLayer : public SingleColourLayer,
Chris@702:                        public VerticalScaleLayer
Chris@30: {
Chris@30:     Q_OBJECT
Chris@30: 
Chris@30: public:
matthiasm@620:     FlexiNoteLayer();
Chris@30: 
Chris@44:     virtual void paint(View *v, QPainter &paint, QRect rect) const;
Chris@30: 
Chris@692:     virtual int getVerticalScaleWidth(View *v, bool, QPainter &) const;
Chris@692:     virtual void paintVerticalScale(View *v, bool, QPainter &paint, QRect rect) const;
Chris@692: 
Chris@44:     virtual QString getFeatureDescription(View *v, QPoint &) const;
Chris@30: 
Chris@44:     virtual bool snapToFeatureFrame(View *v, int &frame,
gyorgyf@646:                     size_t &resolution,
gyorgyf@646:                     SnapType snap) const;
Chris@30: 
Chris@44:     virtual void drawStart(View *v, QMouseEvent *);
Chris@44:     virtual void drawDrag(View *v, QMouseEvent *);
Chris@44:     virtual void drawEnd(View *v, QMouseEvent *);
Chris@30: 
Chris@335:     virtual void eraseStart(View *v, QMouseEvent *);
Chris@335:     virtual void eraseDrag(View *v, QMouseEvent *);
Chris@335:     virtual void eraseEnd(View *v, QMouseEvent *);
Chris@335: 
Chris@44:     virtual void editStart(View *v, QMouseEvent *);
Chris@44:     virtual void editDrag(View *v, QMouseEvent *);
Chris@44:     virtual void editEnd(View *v, QMouseEvent *);
Chris@30: 
gyorgyf@635:     virtual void splitStart(View *v, QMouseEvent *);
gyorgyf@635:     virtual void splitEnd(View *v, QMouseEvent *);
matthiasm@660:     
matthiasm@660:     virtual void addNote(View *v, QMouseEvent *e);
gyorgyf@635: 
gyorgyf@646:     virtual void mouseMoveEvent(View *v, QMouseEvent *);
gyorgyf@646: 
Chris@255:     virtual bool editOpen(View *v, QMouseEvent *);
Chris@70: 
Chris@43:     virtual void moveSelection(Selection s, size_t newStartFrame);
Chris@43:     virtual void resizeSelection(Selection s, Selection newSize);
Chris@76:     virtual void deleteSelection(Selection s);
Chris@76: 
Chris@359:     virtual void copy(View *v, Selection s, Clipboard &to);
Chris@359:     virtual bool paste(View *v, const Clipboard &from, int frameOffset,
Chris@125:                        bool interactive);
Chris@43: 
Chris@746:     void splitNotesAt(View *v, int frame);
Chris@746:     void snapSelectedNotesToPitchTrack(View *v, Selection s);
Chris@749:     void mergeNotes(View *v, Selection s, bool inclusive);
Chris@746: 
Chris@30:     virtual const Model *getModel() const { return m_model; }
matthiasm@620:     void setModel(FlexiNoteModel *model);
Chris@30: 
Chris@30:     virtual PropertyList getProperties() const;
Chris@87:     virtual QString getPropertyLabel(const PropertyName &) const;
Chris@30:     virtual PropertyType getPropertyType(const PropertyName &) const;
Chris@198:     virtual QString getPropertyGroupName(const PropertyName &) const;
Chris@30:     virtual int getPropertyRangeAndValue(const PropertyName &,
Chris@216:                                          int *min, int *max, int *deflt) const;
Chris@30:     virtual QString getPropertyValueLabel(const PropertyName &,
gyorgyf@646:                       int value) const;
Chris@30:     virtual void setProperty(const PropertyName &, int value);
Chris@30: 
Chris@30:     enum VerticalScale {
Chris@101:         AutoAlignScale,
Chris@101:         LinearScale,
Chris@101:         LogScale,
Chris@101:         MIDIRangeScale
Chris@30:     };
gyorgyf@649:     
gyorgyf@649:     //GF: Tonioni: context sensitive note edit actions (denoted clockwise from top).
gyorgyf@649:     enum EditMode {
matthiasm@651:         DragNote,
matthiasm@651:         RightBoundary,
matthiasm@651:         SplitNote,
matthiasm@651:         LeftBoundary
gyorgyf@649:     };
gyorgyf@658:     
gyorgyf@658:     void setIntelligentActions(bool on) { m_intelligentActions=on; }
Chris@30: 
Chris@30:     void setVerticalScale(VerticalScale scale);
Chris@30:     VerticalScale getVerticalScale() const { return m_verticalScale; }
Chris@30: 
Chris@44:     virtual bool isLayerScrollable(const View *v) const;
Chris@30: 
Chris@30:     virtual bool isLayerEditable() const { return true; }
Chris@30: 
Chris@115:     virtual int getCompletion(View *) const { return m_model->getCompletion(); }
Chris@30: 
Chris@101:     virtual bool getValueExtents(float &min, float &max,
Chris@101:                                  bool &log, QString &unit) const;
Chris@101: 
Chris@101:     virtual bool getDisplayExtents(float &min, float &max) const;
Chris@439:     virtual bool setDisplayExtents(float min, float max);
Chris@439: 
Chris@439:     virtual int getVerticalZoomSteps(int &defaultStep) const;
Chris@439:     virtual int getCurrentVerticalZoomStep() const;
Chris@439:     virtual void setVerticalZoomStep(int);
Chris@439:     virtual RangeMapper *getNewVerticalZoomRangeMapper() const;
Chris@79: 
Chris@507:     /**
Chris@507:      * Add a note-on.  Used when recording MIDI "live".  The note will
Chris@507:      * not be finally added to the layer until the corresponding
Chris@507:      * note-off.
Chris@507:      */
Chris@507:     void addNoteOn(long frame, int pitch, int velocity);
Chris@507:     
Chris@507:     /**
Chris@507:      * Add a note-off.  This will cause a note to appear, if and only
Chris@507:      * if there is a matching pending note-on.
Chris@507:      */
Chris@507:     void addNoteOff(long frame, int pitch);
Chris@507: 
Chris@507:     /**
Chris@507:      * Abandon all pending note-on events.
Chris@507:      */
Chris@507:     void abandonNoteOns();
Chris@507: 
Chris@316:     virtual void toXml(QTextStream &stream, QString indent = "",
Chris@316:                        QString extraAttributes = "") const;
Chris@30: 
Chris@30:     void setProperties(const QXmlAttributes &attributes);
matthiasm@651:     
matthiasm@656:     void setVerticalRangeToNoteRange(View *v);
Chris@30: 
Chris@701:     /// VerticalScaleLayer methods
Chris@701:     virtual int getYForValue(View *v, float value) const;
Chris@701:     virtual float getValueForY(View *v, int y) const;
Chris@701:     virtual QString getScaleUnits() const;
Chris@701: 
Chris@30: protected:
Chris@101:     void getScaleExtents(View *, float &min, float &max, bool &log) const;
Chris@101:     bool shouldConvertMIDIToHz() const;
Chris@30: 
Chris@287:     virtual int getDefaultColourHint(bool dark, bool &impose);
Chris@287: 
matthiasm@620:     FlexiNoteModel::PointList getLocalPoints(View *v, int) const;
Chris@30: 
matthiasm@620:     bool getPointToDrag(View *v, int x, int y, FlexiNoteModel::Point &) const;
gyorgyf@646:     bool getNoteToEdit(View *v, int x, int y, FlexiNoteModel::Point &) const;
gyorgyf@646:     void getRelativeMousePosition(View *v, FlexiNoteModel::Point &note, int x, int y, bool &closeToLeft, bool &closeToRight, bool &closeToTop, bool &closeToBottom) const;
Chris@745:     SparseTimeValueModel *getAssociatedPitchModel(View *v) const;
Chris@747:     bool updateNoteValue(View *v, FlexiNoteModel::Point &note) const;
Chris@753:     void splitNotesAt(View *v, int frame, QMouseEvent *e);
Chris@550: 
matthiasm@620:     FlexiNoteModel *m_model;
Chris@30:     bool m_editing;
gyorgyf@658:     bool m_intelligentActions;
Chris@551:     int m_dragPointX;
Chris@551:     int m_dragPointY;
Chris@551:     int m_dragStartX;
Chris@551:     int m_dragStartY;
matthiasm@620:     FlexiNoteModel::Point m_originalPoint;
matthiasm@620:     FlexiNoteModel::Point m_editingPoint;
matthiasm@651:     long m_greatestLeftNeighbourFrame;
matthiasm@651:     long m_smallestRightNeighbourFrame;
matthiasm@620:     FlexiNoteModel::EditCommand *m_editingCommand;
Chris@30:     VerticalScale m_verticalScale;
gyorgyf@649:     EditMode m_editMode;
Chris@376: 
matthiasm@620:     typedef std::set<FlexiNoteModel::Point, FlexiNoteModel::Point::Comparator> FlexiNoteSet;
matthiasm@620:     FlexiNoteSet m_pendingNoteOns;
Chris@507: 
Chris@439:     mutable float m_scaleMinimum;
Chris@439:     mutable float m_scaleMaximum;
Chris@439: 
Chris@439:     bool shouldAutoAlign() const;
Chris@439: 
matthiasm@620:     void finish(FlexiNoteModel::EditCommand *command) {
Chris@376:         Command *c = command->finish();
Chris@376:         if (c) CommandHistory::getInstance()->addCommand(c, false);
Chris@376:     }
Chris@30: };
Chris@30: 
Chris@30: #endif
Chris@30: