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: 
Chris@1362: #ifndef SV_NOTE_LAYER_H
Chris@1362: #define SV_NOTE_LAYER_H
Chris@30: 
Chris@287: #include "SingleColourLayer.h"
Chris@701: #include "VerticalScaleLayer.h"
Chris@701: 
Chris@128: #include "data/model/NoteModel.h"
Chris@30: 
Chris@30: #include <QObject>
Chris@30: #include <QColor>
Chris@30: 
Chris@30: class View;
Chris@30: class QPainter;
Chris@30: 
Chris@701: class NoteLayer : public SingleColourLayer,
Chris@701:                   public VerticalScaleLayer
Chris@30: {
Chris@30:     Q_OBJECT
Chris@30: 
Chris@30: public:
Chris@44:     NoteLayer();
Chris@30: 
Chris@916:     virtual void paint(LayerGeometryProvider *v, QPainter &paint, QRect rect) const;
Chris@30: 
Chris@918:     virtual int getVerticalScaleWidth(LayerGeometryProvider *v, bool, QPainter &) const;
Chris@918:     virtual void paintVerticalScale(LayerGeometryProvider *v, bool, QPainter &paint, QRect rect) const;
Chris@692: 
Chris@918:     virtual QString getFeatureDescription(LayerGeometryProvider *v, QPoint &) const;
Chris@30: 
Chris@918:     virtual bool snapToFeatureFrame(LayerGeometryProvider *v, sv_frame_t &frame,
Chris@1266:                                     int &resolution,
Chris@1266:                                     SnapType snap) const;
Chris@30: 
Chris@918:     virtual void drawStart(LayerGeometryProvider *v, QMouseEvent *);
Chris@918:     virtual void drawDrag(LayerGeometryProvider *v, QMouseEvent *);
Chris@918:     virtual void drawEnd(LayerGeometryProvider *v, QMouseEvent *);
Chris@30: 
Chris@918:     virtual void eraseStart(LayerGeometryProvider *v, QMouseEvent *);
Chris@918:     virtual void eraseDrag(LayerGeometryProvider *v, QMouseEvent *);
Chris@918:     virtual void eraseEnd(LayerGeometryProvider *v, QMouseEvent *);
Chris@335: 
Chris@918:     virtual void editStart(LayerGeometryProvider *v, QMouseEvent *);
Chris@918:     virtual void editDrag(LayerGeometryProvider *v, QMouseEvent *);
Chris@918:     virtual void editEnd(LayerGeometryProvider *v, QMouseEvent *);
Chris@30: 
Chris@918:     virtual bool editOpen(LayerGeometryProvider *v, QMouseEvent *);
Chris@70: 
Chris@905:     virtual void moveSelection(Selection s, sv_frame_t newStartFrame);
Chris@43:     virtual void resizeSelection(Selection s, Selection newSize);
Chris@76:     virtual void deleteSelection(Selection s);
Chris@76: 
Chris@918:     virtual void copy(LayerGeometryProvider *v, Selection s, Clipboard &to);
Chris@918:     virtual bool paste(LayerGeometryProvider *v, const Clipboard &from, sv_frame_t frameOffset,
Chris@125:                        bool interactive);
Chris@43: 
Chris@30:     virtual const Model *getModel() const { return m_model; }
Chris@30:     void setModel(NoteModel *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 &,
Chris@1266:                                           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:     };
Chris@30: 
Chris@30:     void setVerticalScale(VerticalScale scale);
Chris@30:     VerticalScale getVerticalScale() const { return m_verticalScale; }
Chris@30: 
Chris@918:     virtual bool isLayerScrollable(const LayerGeometryProvider *v) const;
Chris@30: 
Chris@30:     virtual bool isLayerEditable() const { return true; }
Chris@30: 
Chris@918:     virtual int getCompletion(LayerGeometryProvider *) const { return m_model->getCompletion(); }
Chris@30: 
Chris@905:     virtual bool getValueExtents(double &min, double &max,
Chris@101:                                  bool &log, QString &unit) const;
Chris@101: 
Chris@905:     virtual bool getDisplayExtents(double &min, double &max) const;
Chris@905:     virtual bool setDisplayExtents(double min, double 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@905:     void addNoteOn(sv_frame_t 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@905:     void addNoteOff(sv_frame_t 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);
Chris@30: 
Chris@701:     /// VerticalScaleLayer methods
Chris@918:     virtual int getYForValue(LayerGeometryProvider *v, double value) const;
Chris@918:     virtual double getValueForY(LayerGeometryProvider *v, int y) const;
Chris@701:     virtual QString getScaleUnits() const;
Chris@701: 
Chris@30: protected:
Chris@918:     void getScaleExtents(LayerGeometryProvider *, double &min, double &max, bool &log) const;
Chris@101:     bool shouldConvertMIDIToHz() const;
Chris@30: 
Chris@287:     virtual int getDefaultColourHint(bool dark, bool &impose);
Chris@287: 
Chris@918:     NoteModel::PointList getLocalPoints(LayerGeometryProvider *v, int) const;
Chris@30: 
Chris@918:     bool getPointToDrag(LayerGeometryProvider *v, int x, int y, NoteModel::Point &) const;
Chris@550: 
Chris@30:     NoteModel *m_model;
Chris@30:     bool m_editing;
Chris@551:     int m_dragPointX;
Chris@551:     int m_dragPointY;
Chris@551:     int m_dragStartX;
Chris@551:     int m_dragStartY;
Chris@30:     NoteModel::Point m_originalPoint;
Chris@30:     NoteModel::Point m_editingPoint;
Chris@30:     NoteModel::EditCommand *m_editingCommand;
Chris@30:     VerticalScale m_verticalScale;
Chris@376: 
Chris@507:     typedef std::set<NoteModel::Point, NoteModel::Point::Comparator> NoteSet;
Chris@507:     NoteSet m_pendingNoteOns;
Chris@507: 
Chris@905:     mutable double m_scaleMinimum;
Chris@905:     mutable double m_scaleMaximum;
Chris@439: 
Chris@439:     bool shouldAutoAlign() const;
Chris@439: 
Chris@376:     void finish(NoteModel::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: