pianokeybd.h

Go to the documentation of this file.

/*
    Virtual Piano Widget for Qt
    Copyright (C) 2008-2023, Pedro Lopez-Cabanillas <plcl@users.sf.net>
 
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 3 of the License, or
    (at your option) any later version.
 
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License along 
    with this program; If not, see <http://www.gnu.org/licenses/>.
*/
 
#ifndef PIANOKEYBD_H
#define PIANOKEYBD_H
 
#include <QGraphicsView>
#include <QScopedPointer>
#include <QGraphicsScene>
#include "macros.h"
#include "pianopalette.h"
 
#if defined(DRUMSTICK_STATIC)
#define DRUMSTICK_WIDGETS_EXPORT
#else
#if defined(drumstick_widgets_EXPORTS)
#define DRUMSTICK_WIDGETS_EXPORT Q_DECL_EXPORT
#else
#define DRUMSTICK_WIDGETS_EXPORT Q_DECL_IMPORT
#endif
#endif
 
namespace drumstick { namespace widgets {
 
    Q_NAMESPACE
 
    class RawKbdHandler {
    public:
        virtual ~RawKbdHandler() = default;
        virtual bool handleKeyPressed(int keycode) = 0;
        virtual bool handleKeyReleased(int keycode) = 0;
    };
 
    class PianoHandler
    {
    public:
        virtual ~PianoHandler() = default;
        virtual void noteOn( const int note, const int vel ) = 0;
        virtual void noteOff( const int note, const int vel ) = 0;
    };
 
    typedef QHash<int, int> KeyboardMap;
 
    extern DRUMSTICK_WIDGETS_EXPORT KeyboardMap g_DefaultKeyMap;    
    extern DRUMSTICK_WIDGETS_EXPORT KeyboardMap g_DefaultRawKeyMap; 
 
    const int DEFAULTSTARTINGKEY = 9;   
    const int DEFAULTBASEOCTAVE = 1;    
    const int DEFAULTNUMBEROFKEYS = 88; 
 
    enum LabelVisibility {
        ShowNever,          
        ShowMinimum,        
        ShowActivated,      
        ShowAlways          
    };
    Q_ENUM_NS(LabelVisibility)
 
    
    enum LabelAlteration {
        ShowSharps,         
        ShowFlats,          
        ShowNothing         
    };
    Q_ENUM_NS(LabelAlteration)
 
    
    enum LabelOrientation {
        HorizontalOrientation,  
        VerticalOrientation,    
        AutomaticOrientation    
    };
    Q_ENUM_NS(LabelOrientation)
 
    
    enum LabelNaming {
        StandardNames,          
        CustomNamesWithSharps,  
        CustomNamesWithFlats    
    };
    Q_ENUM_NS(LabelNaming)
 
    
    enum LabelCentralOctave {
        OctaveNothing = -1,     
        OctaveC3,               
        OctaveC4,               
        OctaveC5                
    };
    Q_ENUM_NS(LabelCentralOctave)
 
    
    class DRUMSTICK_WIDGETS_EXPORT PianoKeybd : public QGraphicsView, public RawKbdHandler
    {
        Q_OBJECT
        Q_PROPERTY( int baseOctave READ baseOctave WRITE setBaseOctave )
        Q_PROPERTY( int numKeys READ numKeys WRITE setNumKeys )
        Q_PROPERTY( int rotation READ getRotation WRITE setRotation )
        Q_PROPERTY( QColor keyPressedColor READ getKeyPressedColor WRITE setKeyPressedColor )
        Q_PROPERTY( drumstick::widgets::LabelVisibility showLabels READ showLabels WRITE setShowLabels )
        Q_PROPERTY( drumstick::widgets::LabelAlteration alterations READ labelAlterations WRITE setLabelAlterations )
        Q_PROPERTY( drumstick::widgets::LabelOrientation labelOrientation READ labelOrientation WRITE setLabelOrientation )
        Q_PROPERTY( drumstick::widgets::LabelCentralOctave labelOctave READ labelOctave WRITE setLabelOctave )
        Q_PROPERTY( int transpose READ getTranspose WRITE setTranspose )
        Q_PROPERTY( int startKey READ startKey WRITE setStartKey )
        Q_PROPERTY( QFont labelFont READ font WRITE setFont )
 
#ifndef Q_MOC_RUN
        Q_CLASSINFO("Author", "Pedro Lopez-Cabanillas <plcl@users.sf.net>")
        Q_CLASSINFO("URL", "https://sourceforge.net/projects/drumstick")
        Q_CLASSINFO("Version", QT_STRINGIFY(VERSION))
#endif
 
    public:
        explicit PianoKeybd(QWidget *parent = nullptr);
        PianoKeybd(const int baseOctave, const int numKeys, const int startKey, QWidget *parent = nullptr);
        virtual ~PianoKeybd();
 
        void setFont(const QFont &font);
        PianoHandler* getPianoHandler() const;
        void setPianoHandler(PianoHandler* handler);
 
        PianoPalette getHighlightPalette() const;
        void setHighlightPalette(const PianoPalette& p );
        PianoPalette getBackgroundPalette() const;
        void setBackgroundPalette(const PianoPalette& p );
        PianoPalette getForegroundPalette() const;
        void setForegroundPalette(const PianoPalette& p );
 
        bool showColorScale() const;
        void setShowColorScale(const bool show);
 
        void useCustomNoteNames(const QStringList& names);
        void useStandardNoteNames();
        QStringList customNoteNames() const;
        QStringList standardNoteNames() const;
        void retranslate();
 
        int baseOctave() const;
        void setBaseOctave(const int baseOctave);
        int numKeys() const;
        int startKey() const;
        void setNumKeys(const int numKeys, const int startKey = DEFAULTSTARTINGKEY);
        int getRotation() const;
        void setRotation(int r);
        QColor getKeyPressedColor() const;
        void setKeyPressedColor(const QColor& c);
        void resetKeyPressedColor();
        LabelVisibility showLabels() const;
        void setShowLabels(const LabelVisibility show);
        LabelAlteration labelAlterations() const;
        void setLabelAlterations(const LabelAlteration use);
        LabelOrientation labelOrientation() const;
        void setLabelOrientation(const LabelOrientation orientation);
        LabelCentralOctave labelOctave() const;
        void setLabelOctave(const LabelCentralOctave octave);
        int getTranspose() const;
        void setTranspose(int t);
        int getChannel() const;
        void setChannel(const int c);
        int getVelocity() const;
        void setVelocity(const int v);
 
        bool isKeyboardEnabled() const;
        void setKeyboardEnabled( const bool enable );
        bool isMouseEnabled() const;
        void setMouseEnabled( const bool enable );
        bool isTouchEnabled() const;
        void setTouchEnabled( const bool enable );
        bool velocityTint() const ;
        void setVelocityTint( const bool enable );
        void allKeysOff();
 
        QSize sizeHint() const override;
        void setKeyboardMap(KeyboardMap* m);
        KeyboardMap* getKeyboardMap();
        void resetKeyboardMap();
        void setRawKeyboardMap(KeyboardMap* m);
        KeyboardMap* getRawKeyboardMap();
        void resetRawKeyboardMap();
        bool getRawKeyboardMode() const;
        void setRawKeyboardMode(const bool b);
 
        void showNoteOn( const int note, QColor color, int vel = -1 );
        void showNoteOn( const int note, int vel = -1 );
        void showNoteOff( const int note, int vel = -1 );
 
        // RawKbdHandler methods
        bool handleKeyPressed(int keycode) override;
        bool handleKeyReleased(int keycode) override;
 
        void setKeyPicture(const bool natural, const QPixmap& pix);
        QPixmap getKeyPicture(const bool natural);
 
        void setUseKeyPictures(const bool enable);
        bool getUseKeyPictures() const;
 
        void setUsingNativeFilter(const bool newState);
        bool isUsingNativeFilter() const;
 
        void setOctaveSubscript(const bool enable);
        bool octaveSubscript() const;
 
        void setStartKey(const int startKey);
 
    Q_SIGNALS:
        void noteOn( int midiNote, int vel );
        void noteOff( int midiNote, int vel );
        void signalName( const QString& name );
 
    protected:
        void initialize();
        void initDefaultMap();
        void initScene(int base, int num, int ini, const QColor& c = QColor());
        void resizeEvent(QResizeEvent *event) override;
        bool viewportEvent(QEvent *ev) override;
 
    private:
        class PianoKeybdPrivate;
        QScopedPointer<PianoKeybdPrivate> d;
    };
 
}} // namespace drumstick::widgets
 
#endif // PIANOKEYBD_H