KwidgetGUI_CoreEngine.h

Go to the documentation of this file.

namespace krotos
{
    class KwidgetGUI_CoreEngine : public KwidgetGUI,
                                  public WaveformViewerAndEditor::Listener,
                                  public KrotosSampleOscillatorSound::Listener,
                                  ScrollBar::Listener
    {
      public:
        KwidgetGUI_CoreEngine(Kwidget& owner, KrotosSampleOscillatorSound& sound);
        ~KwidgetGUI_CoreEngine() override;
 
        void paint(Graphics& g) override;
 
        void resized() override;
        void resizeSampler();
        void resizeGranular();
        void resizeVehicle();
 
        void tabSetupSampler();
 
        void tabSetupGranular();
 
        void soundChanged(KrotosSampleOscillatorSound* sound) override;
 
        void fileHasBeenDropped(WaveformViewerAndEditor* areaSelectionComp, const StringArray& files) override;
 
        // Callback when a selection area in waveform view has changed, passing array of ranges
        void selectionsChanged(WaveformViewerAndEditor* /*areaSelectionComp*/,
                               std::vector<Range<int>> selections) override;
 
        void resizeScrollBar(float newThumbSize) override;
 
        void resizeScrollBarFromRange(Range<float> newRange) override;
 
        void setVisibleControlsSet(Kwidget_CoreEngine::EngineMode mode);
 
        void modeParamChanged(float val);
 
        void finalSetup() override;
        void scrollBarMoved(ScrollBar* scrollBarThatHasMoved, double newRangeStart) override;
 
        void setAmpEnvTabGUI(Component* incomingGui) { m_ampEnvTab.addAndMakeVisible(incomingGui); }
 
        void setPitchEnvTabGUI(Component* incomingGui) { m_pitchEnvTab.addAndMakeVisible(incomingGui); }
 
        struct ComponentIds
        {
            static const String ComboboxTriggerId;          
            static const String ComboboxModeId;             
            static const String SliderLevelGranularId;      
            static const String SliderLevelSamplerId;       
            static const String SliderLevelRandId;          
            static const String SliderPanId;                
            static const String SliderPanRandId;            
            static const String SliderPitchSamplerId;       
            static const String SliderPitchGranularId;      
            static const String SliderGrainMaxId;           
            static const String SliderGrainShapeId;         
            static const String SliderGrainStartId;         
            static const String SliderGrainSizeId;          
            static const String SliderGrainRateId;          
            static const String SliderGrainWidthId;         
            static const String SliderGrainStartRNDId;      
            static const String SliderGrainSizeRNDId;       
            static const String SliderGrainRateRNDId;       
            static const String SliderGrainWidthRNDId;      
            static const String SliderPitchGranularRNDId;   
            static const String ButtonMuteId;               
            static const String ButtonSoloId;               
            static const String ButtonRoundRobinId;         
            static const String ButtonAutoplayId;           
            static const String ButtonReleaseTriggerId;     
            static const String ButtonLoopToggleSamplerId;  
            static const String ButtonLoopToggleGranularId; 
            static const String ButtonNormaliseToggleId;    
            static const String ButtonSampleBrowserId;      
            static const String ButtonZoomInId;             
            static const String ButtonZoomOutId;            
            static const String ScrollBarWaveformViewId;    
            static const String WaveformViewerId;           
            static const String ButtonClearEngineId;        
        };
 
        static const std::string analyticsEventClearedEngine;
        static const std::string analyticsEventAddedSamplesEngine;
        static const std::string analyticsEventChangedMidiTriggerEngine;
        static const std::string analyticsEventRemovedEngine;
 
      protected:
        // Sliders
        AttachedSlider m_Start{"Start"};
        AttachedSlider m_Size{"Size"};
        AttachedSlider m_Rate{"Rate"};
        AttachedSlider m_Detune{"Pitch"};
        AttachedSlider m_Width{"Width"};
        AttachedSlider m_Pan{"Pan"};
        AttachedSlider m_Level{"Level"};
        AttachedSlider m_SamplerLevel{"Sampler Lvl"};
        AttachedSlider m_GranularLevel{"Granular Lvl"};
        AttachedSlider m_VehicleLevel{"VehicleLevel"};
        AttachedSlider m_StartRand{"Start RND"};
        AttachedSlider m_SizeRand{"Size RND"};
        AttachedSlider m_RateRand{"Rate RND"};
        AttachedSlider m_DetuneRand{"Pitch RND"};
        AttachedSlider m_WidthRand{"Width RND"};
        AttachedSlider m_PanRand{"RND"};
        AttachedSlider m_LevelRand{"RND"};
 
        // Vehicle Sliders
        AttachedSlider m_ASize{"ASize"};
        AttachedSlider m_ARate{"ARate"};
        AttachedSlider m_ASpray{"ASpray"};
        AttachedSlider m_AMix{"AMix"};
 
        AttachedSlider m_BSize{"BSize"};
        AttachedSlider m_BRate{"BRate"};
        AttachedSlider m_BSpray{"BSpray"};
        AttachedSlider m_BMix{"BMix"};
 
        AttachedSlider m_Shape{"Shape"};
        AttachedSlider m_GrainMax{"GrainMax"};
        AttachedSlider m_Distance{"Distance"};
        AttachedSlider m_Tracking{"Track"};
        AttachedSlider m_Cycles{"Track RPM"};
        AttachedSlider m_Smoothing{"Smoothing"};
        AttachedSlider m_Sensitivity{"Sensitivity"};
 
        // m_mode combobox is a hidden component
        AttachedComboBox m_mode{Kwidget_CoreEngine::ModeNames};
        ComboBox m_trigger;
 
        // Toggle Buttons
        AttachedToggleButton m_QuenchToggle{"Quench"};
        AttachedToggleButton m_NORToggle{"Release Trig"};
        AttachedToggleButton m_RobinToggle{"Random"};
        AttachedToggleButton m_SALoopToggle{"Loop"};
        AttachedToggleButton m_AutoRateToggle{"Auto Rate"};
        AttachedToggleButton m_PhaseLockToggle{"Vehicle"};
        AttachedToggleButton m_PhaseSyncToggle{"Sync"};
        AttachedToggleButton m_NormaliseToggle{"Normalise"};
        AttachedToggleButton m_AutoplayToggle{"Autoplay"};
        AttachedToggleButton m_EnableMuteUpToggle{"MuteUp"};
        AttachedToggleButton m_EnableMuteDownToggle{"MuteDown"};
 
        // Text Buttons
        TextButton m_clearButton;
        TextButton m_tweakButton1;
        TextButton m_tweakButton2;
 
        DrawableButton m_removeEngineButton;
 
        TextButton m_muteButton;
        std::unique_ptr<ButtonParameterAttachment> m_muteButtonAttachment;
        TextButton m_soloButton;
        std::unique_ptr<ButtonParameterAttachment> m_soloButtonAttachment;
 
        bool m_noteIsOn{false};
 
        std::unique_ptr<krotos::WaveformViewerAndEditor> m_waveformViewerAndEditor;
 
        Label m_coreEngineNameLabel;
 
      private:
        String findSimilarAudioFile(String samplePaths, bool isCommandDown);
 
        void setVehicleControlsVisibility(bool shouldBeVisible);
        void setSamplerControlsVisibility(bool shouldBeVisible);
        void setGranularControlsVisibility(bool shouldBeVisible);
 
        void initialiseZoomControls();
        void initialiseTabbedComponent();
 
        void clearEngine();
 
        void resetBrowserButtonStatus();
 
        void selectSample(int segmentIndex, bool cueSelected);
 
        void selectSample(int segmentIndex);
 
        void showSampleBrowser();
 
        void mouseEnter(const MouseEvent& event);
 
        // TODO: We can discuss setting this from parent for modularity
        struct Layout
        {
            struct LeftPanel
            {
                const Rectangle<int> muteButton{26, 184, 30, 14};
                const Rectangle<int> soloButton{58, 184, 30, 14};
                const Rectangle<int> triggerCombobox{25, 153, 64, 15};
                const Rectangle<int> modeLabel{6, 4, 120, 15};
 
                const int sliderXPos = 13;
                const int sliderWidth = 87;
                const int sliderHeight = 57;
                const int randSliderXPos = 21;
                const int randSliderWidth = 78;
                const int randSliderHeight = 25;
                const int spacingBetweenSliders = 34;
 
                const Rectangle<int> levelSlider{sliderXPos, 19, sliderWidth, sliderHeight};
                const Rectangle<int> randLevelSlider{randSliderXPos, levelSlider.getY() + spacingBetweenSliders,
                                                     randSliderWidth, randSliderHeight};
                const Rectangle<int> panSlider{sliderXPos, 85, sliderWidth, sliderHeight};
                const Rectangle<int> panRandSlider{randSliderXPos, panSlider.getY() + spacingBetweenSliders,
                                                   randSliderWidth, randSliderHeight};
 
            } leftPanel;
 
            struct ControlsTabs
            {
                const Rectangle<int> tabbedComponentBounds{454, 9, 300, 180};
                const Rectangle<int> ampEnvBounds{0, 0, 300, 180};
                const Rectangle<int> pitchEnvBounds{0, 0, 300, 180};
                const int rotSliderTopRowY{8};
                const int rotSliderBottomRowY{89};
                const int rotSliderWidth{70};
                const int rotSliderHeight{53};
                const Rectangle<int> rotSliderTopL{5, rotSliderTopRowY, rotSliderWidth, rotSliderHeight};
                const Rectangle<int> rotSliderBottomL{5, rotSliderBottomRowY, rotSliderWidth, rotSliderHeight};
                const Rectangle<int> rotSliderTopM{103, rotSliderTopRowY, rotSliderWidth, rotSliderHeight};
                const Rectangle<int> rotSliderBottomM{103, rotSliderBottomRowY, rotSliderWidth, rotSliderHeight};
                const Rectangle<int> rotSliderTopR{201, rotSliderTopRowY, rotSliderWidth, rotSliderHeight};
                const Rectangle<int> rotSliderBottomR{201, rotSliderBottomRowY, rotSliderWidth, rotSliderHeight};
            } controlsTabs;
 
            // TODO: could put the other groups of controls into structs for readability?
 
            const int loopToggleWidth{43};
            const int normalizeToggleWidth{70};
            const int autoplayToggleWidth{63};
            const int releaseTrigToggleWidth{79};
            const int randomToggleWidth{50};
            Rectangle<int> toggleGroupAreaGranular{118, 180, 232, 16};
            Rectangle<int> toggleGroupAreaSampler{118, 180, 313, 16};
            const Rectangle<int> toggleGroupArea{118, 176, 232, 16};
 
            const Rectangle<int> waveformArea{118, 24, 324, 142};
            const int waveformAreaCornerRadius{4};
            const Rectangle<int> waveformZoomControls{118, 167, 324, 11};
            const Rectangle<int> waveformZoomScrollbar{118, 171, 284, 6};
            const Rectangle<int> waveformZoomOutButton{430, 168, 12, 12};
            const Rectangle<int> waveformZoomInButton{410, 168, 12, 12};
            const int scrollBarY{171};
            const int scrollBarHeight{6};
 
            const Rectangle<int> sampleBrowserButton{118, 2, 324, 18};
            const int sampleBrowserItemHeight{50};
            const int sampleBrowserMaxItemsToShow{4};
            const int sampleBrowserNumberOfFixedOptions{2};
            const int sampleBrowserWidth{526};
 
            const Rectangle<int> removeEngineButton{740, 2, 18, 18};
            // text
            const float modeFontSize{20.0f};
            const float modeExtraKerning{0.02f};
        } m_layout;
 
        struct ColourDefinitions
        {
            const Colour waveformColour{Colour::fromFloatRGBA(0.7f, 0.7f, 0.7f, 1.0f)};
        } m_colourDefinitions;
 
        SamplesTree m_samplesTree;
        KrotosSampleOscillatorSound& m_soSound;
 
        Kwidget_CoreEngine::EngineMode m_activeMode{Kwidget_CoreEngine::EngineMode::modeGranular};
        Kwidget& m_owner;
 
        // flags for determining where callback came from
        bool m_calledFromMarqueeStart = false;
        bool m_calledFromMarqueeEnd = false;
 
        // Sound similarity search
        String m_samplePathRestore{""};
        SharedResourcePointer<AudioDataset> m_audioDataset;
        const String m_defaultDropText{"Drag & Drop Samples Here or Click the Plus Icon"};
 
        std::unique_ptr<Drawable> m_defaultDeleteButton, m_hoverDeleteButton;
 
        std::unique_ptr<Drawable> m_zoomInButtonImage, m_zoomInButtonImageMouseOver;
        std::unique_ptr<Drawable> m_zoomOutButtonImage, m_zoomOutButtonImageMouseOver;
        DrawableButton m_zoomInButton{"zoomin", DrawableButton::ButtonStyle::ImageStretched};
        DrawableButton m_zoomOutButton{"zoomout", DrawableButton::ButtonStyle::ImageStretched};
        ScrollBar m_waveformViewScrollbar{/*isVertical*/ false};
 
        std::unique_ptr<TabbedComponent> m_tabbedComponent;
        Component m_mainTab, m_randTab, m_ampEnvTab, m_pitchEnvTab, m_extrasTab;
 
        SampleBrowserButton m_sampleBrowserButton;
        int m_prevSegmentIndex{-1};
        int m_selectedSegment{0};
        int m_cuedSegment{0};
 
        // Flag to control sending midi trigger change notifications to analytics
        bool m_notifyMidiTriggerChange{false};
 
        JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(KwidgetGUI_CoreEngine)
    };
} // namespace krotos