MixerBoard.h

Go to the documentation of this file.

/**********************************************************************
 
  Audacity: A Digital Audio Editor
 
  MixerBoard.h
 
  Vaughan Johnson, January 2007
 
**********************************************************************/
 
 
 
 
#ifndef __AUDACITY_MIXER_BOARD__
#define __AUDACITY_MIXER_BOARD__
 
#include <wx/frame.h> // to inherit
#include <wx/scrolwin.h> // to inherit
 
#include "widgets/ASlider.h" // to inherit
#include "commands/CommandManagerWindowClasses.h"
 
#include "Observer.h"
#include "Prefs.h"
 
class wxArrayString;
class wxBitmapButton;
class wxImage;
class wxMemoryDC;
class AButton;
struct AudioIOEvent;
struct TrackListEvent;
 
// containment hierarchy:
//    MixerBoardFrame -> MixerBoard -> MixerBoardScrolledWindow -> MixerTrackCluster(s)
 
 
// MixerTrackSlider is a subclass just to override OnMouseEvent,
// so we can know when adjustment ends, so we can PushState only then.
class MixerTrackSlider final : public ASlider
{
public:
   MixerTrackSlider(wxWindow * parent,
                     wxWindowID id,
                     const TranslatableString &name,
                     const wxPoint & pos,
                     const wxSize & size,
                     const ASlider::Options &options = ASlider::Options{});
   virtual ~MixerTrackSlider() {}
 
   void OnMouseEvent(wxMouseEvent & event);
 
   void OnFocus(wxFocusEvent &event);
   void OnCaptureKey(wxCommandEvent& event);
 
protected:
   bool mIsPan;
 
public:
    DECLARE_EVENT_TABLE()
};
 
 
class AudacityProject;
class MeterPanel;
class MixerBoard;
 
class Track;
#ifdef USE_MIDI
class NoteTrack;
#endif
class PlayableTrack;
 
class WaveTrack;
class auStaticText;
 
class MixerTrackCluster final : public wxPanelWrapper
{
public:
   MixerTrackCluster(wxWindow* parent,
                     MixerBoard* grandParent, AudacityProject* project,
                     const std::shared_ptr<PlayableTrack> &pTrack,
                     const wxPoint& pos = wxDefaultPosition,
                     const wxSize& size = wxDefaultSize);
   virtual ~MixerTrackCluster() {}
 
   WaveTrack *GetWave() const;
   WaveTrack *GetRight() const;
#ifdef EXPERIMENTAL_MIDI_OUT
   NoteTrack *GetNote() const;
#endif
 
   //void UpdatePrefs();
 
   void HandleResize(); // For wxSizeEvents, update gain slider and meter.
 
   void HandleSliderGain(const bool bWantPushState = false);
#ifdef EXPERIMENTAL_MIDI_OUT
   void HandleSliderVelocity(const bool bWantPushState = false);
#endif
   void HandleSliderPan(const bool bWantPushState = false);
 
   void ResetMeter(const bool bResetClipping);
 
   void UpdateForStateChange();
   void UpdateMeter(const double t0, const double t1);
 
private:
   wxColour GetTrackColor();
 
   // event handlers
   void HandleSelect(bool bShiftDown, bool bControlDown);
 
   void OnKeyEvent(wxKeyEvent& event);
   void OnMouseEvent(wxMouseEvent& event);
   void OnPaint(wxPaintEvent& evt);
 
   void OnButton_MusicalInstrument(wxCommandEvent& event);
   void OnSlider_Gain(wxCommandEvent& event);
#ifdef EXPERIMENTAL_MIDI_OUT
   void OnSlider_Velocity(wxCommandEvent& event);
#endif
   void OnSlider_Pan(wxCommandEvent& event);
   void OnButton_Mute(wxCommandEvent& event);
   void OnButton_Solo(wxCommandEvent& event);
   //v void OnSliderScroll_Gain(wxScrollEvent& event);
 
 
public:
   std::shared_ptr<PlayableTrack>   mTrack;
 
private:
   MixerBoard* mMixerBoard;
   AudacityProject* mProject;
 
   // controls
   auStaticText* mStaticText_TrackName;
   wxBitmapButton* mBitmapButton_MusicalInstrument;
   AButton* mToggleButton_Mute;
   AButton* mToggleButton_Solo;
   MixerTrackSlider* mSlider_Pan;
   MixerTrackSlider* mSlider_Gain;
#ifdef EXPERIMENTAL_MIDI_OUT
   MixerTrackSlider* mSlider_Velocity;
#endif
   wxWeakRef<MeterPanel> mMeter;
 
public:
   DECLARE_EVENT_TABLE()
};
 
 
class MusicalInstrument
{
public:
   MusicalInstrument(std::unique_ptr<wxBitmap> &&pBitmap, const wxString & strXPMfilename);
   virtual ~MusicalInstrument();
 
   std::unique_ptr<wxBitmap> mBitmap;
   wxArrayString  mKeywords;
};
 
using MusicalInstrumentArray = std::vector<std::unique_ptr<MusicalInstrument>>;
 
 
 
// wxScrolledWindow ignores mouse clicks in client area,
// but they don't get passed to Mixerboard.
// We need to catch them to deselect all track clusters.
class MixerBoardScrolledWindow final : public wxScrolledWindow
{
public:
   MixerBoardScrolledWindow(AudacityProject* project,
                              MixerBoard* parent, wxWindowID id = -1,
                              const wxPoint& pos = wxDefaultPosition,
                              const wxSize& size = wxDefaultSize,
                              long style = wxHSCROLL | wxVSCROLL);
   virtual ~MixerBoardScrolledWindow();
 
private:
   void OnMouseEvent(wxMouseEvent& event);
 
private:
   MixerBoard* mMixerBoard;
   AudacityProject* mProject;
 
public:
   DECLARE_EVENT_TABLE()
};
 
 
class MixerBoardFrame;
class TrackList;
 
class MixerBoard final : public wxWindow, private PrefsListener
{
   friend class MixerBoardFrame;
 
public:
   MixerBoard(AudacityProject* pProject,
               wxFrame* parent,
               const wxPoint& pos = wxDefaultPosition,
               const wxSize& size = wxDefaultSize);
 
   void UpdatePrefs() override;
 
   // Add clusters for any tracks we're not yet showing.
   // Update pointers for tracks we're already showing.
   void UpdateTrackClusters();
 
   int GetTrackClustersWidth();
 
 
   wxBitmap* GetMusicalInstrumentBitmap(const Track *pTrack);
 
   bool HasSolo();
 
   void RefreshTrackClusters(bool bEraseBackground = true);
   void ResizeTrackClusters();
 
   void UpdateMeters(const double t1, const bool bLoopedPlay);
 
   void UpdateWidth();
 
private:
   void ResetMeters(const bool bResetClipping);   
   void RemoveTrackCluster(size_t nIndex);
   void MakeButtonBitmap( wxMemoryDC & dc, wxBitmap & bitmap,
      wxRect & bev, const TranslatableString & str, bool up );
   void CreateMuteSoloImages();
   int FindMixerTrackCluster(const PlayableTrack* pTrack,
                              MixerTrackCluster** hMixerTrackCluster) const;
   void LoadMusicalInstruments();
 
   // event handlers
   void OnPaint(wxPaintEvent& evt);
   void OnSize(wxSizeEvent &evt);
   void OnTimer(Observer::Message);
   void OnTrackSetChanged();
   void OnTrackChanged(const TrackListEvent &event);
   void OnStartStop(AudioIOEvent);
 
public:
   // mute & solo button images: Create once and store on MixerBoard for use in all MixerTrackClusters.
   std::unique_ptr<wxImage> mImageMuteUp, mImageMuteOver, mImageMuteDown,
      mImageMuteDownWhileSolo, // the one actually alternate image
      mImageMuteDisabled, mImageSoloUp, mImageSoloOver, mImageSoloDown, mImageSoloDisabled;
 
   int mMuteSoloWidth;
 
private:
   Observer::Subscription mPlaybackScrollerSubscription,
      mTrackPanelSubscription,
      mAudioIOSubscription;
 
   // Track clusters are maintained in the same order as the WaveTracks.
   std::vector<MixerTrackCluster*> mMixerTrackClusters;
 
   MusicalInstrumentArray     mMusicalInstruments;
   AudacityProject*           mProject;
   MixerBoardScrolledWindow*  mScrolledWindow; // Holds the MixerTrackClusters and handles scrolling.
   double                     mPrevT1;
   TrackList*                 mTracks;
   bool                       mUpToDate{ false };
 
public:
   DECLARE_EVENT_TABLE()
};
 
 
class MixerBoardFrame final
   : public wxFrame
   , public TopLevelKeystrokeHandlingWindow
{
public:
   MixerBoardFrame(AudacityProject* parent);
   virtual ~MixerBoardFrame();
 
   void Recreate(AudacityProject *pProject);
 
private:
   // event handlers
   void OnCloseWindow(wxCloseEvent &WXUNUSED(event));
   void OnMaximize(wxMaximizeEvent &event);
   void OnSize(wxSizeEvent &evt);
   void OnKeyEvent(wxKeyEvent &evt);
 
   void SetWindowTitle();
 
   Observer::Subscription mTitleChangeSubscription;
   AudacityProject *mProject;
public:
   MixerBoard* mMixerBoard;
 
public:
   DECLARE_EVENT_TABLE()
};
 
#endif // __AUDACITY_MIXER_BOARD__