WaveformViewerAndEditor.h

Go to the documentation of this file.

 
namespace krotos
{
 
    class WaveformViewerAndEditor : public ZoomableComponent, public FileDragAndDropTarget, public Timer
    {
      public:
        // classes, enums, and aliases
 
        class Listener
        {
          public:
            virtual ~Listener() = default;
            virtual void selectionsChanged(WaveformViewerAndEditor* areaSelectionComp,
                                           std::vector<Range<int>> selections) = 0;
            virtual void fileHasBeenDropped(WaveformViewerAndEditor* areaSelectionComp, const StringArray& files) = 0;
            virtual void resizeScrollBar(float newThumbSize){};
            virtual void resizeScrollBarFromRange(juce::Range<float>){};
            virtual void moveScrollBarThumb(float thumbX){};
        };
 
        enum class ZoomStyle
        {
            start,   
            centre,  
            playhead 
        };
 
        // constructors, assignments, destructor
 
        WaveformViewerAndEditor(Colour waveformColour, bool minimumSelectionAreaOn, bool enableAreaSelection = true);
        ~WaveformViewerAndEditor() override = default;
 
        // functions
 
        void paintOverChildren(Graphics& g) override;
        void timerCallback() override;
 
        void addListener(Listener* Listener);
        void removeListener(Listener* Listener);
 
        void resized() override;
 
        String getFileName();
        String getLoadedFilePathsAsCSV();
 
        void update(AudioBuffer<float>* newAudio, int sampleRate);
        void update(KrotosSampleOscillatorSound& sound);
 
        void setViewerDropText(String newText);
 
        void setViewCentre(float newRangeStart);
 
        WaveformViewer* getWaveformViewer();
 
        void clear();
 
        void setSelectionEnabled(bool newState);
 
        // Dummy methods to keep build alive
        void setStartPosInPercentage(float startPos, float nonModulatedValue = -1.0f){};
        void setEndPosInPercentage(float endPos){};
 
        void setGrainData(Grain* grains, int numSamples, int numChannels);
        void copySampleEngineSegmentToSelector(Selector& selector, int segmentIndex);
 
        void copySegmentsToSelectors();
        void setSampleEngineToDisplay(KrotosSampleOscillatorSound* sampEngine);
 
        void setZooms(const Range<float> newRange);
 
        void zoomIn();
 
        void zoomOut();
 
        void setZoomStyle(ZoomStyle);
 
        Array<File> getExtendedFilePaths(const StringArray& fileNames);
 
        void setChildComponentIds(String newId);
 
        int mouseXToSampleX(int x);
 
        void showFileChooser();
 
        void zoomToSegment(size_t segmentIndex);
 
      private:
        // classes, enums, and aliases
 
        struct Layout
        {
          public:
            const int endMarkerPixelTolerance{5};
            const float dragSelectAreaBoundary{0.66f};
            const String waveformAreaBackdropImageName{"Sample_Backdrop_x_2_png"};
        } m_layout;
 
        struct ColourDefinitions
        {
            const Colour selectionStartClick{Colours::white.withAlpha(1.0f)};
            const Colour selectionStartHover{Colours::white.withAlpha(0.7f)};
            const Colour selectionStart{Colours::white.withAlpha(0.5f)};
            const Colour selectionEndClick{Colours::white.withAlpha(1.0f)};
            const Colour selectionEndHover{Colours::white.withAlpha(0.7f)};
            const Colour selectionEnd{Colours::white.withAlpha(0.5f)};
            const Colour draggedHighlight{Colour::fromFloatRGBA(1.0f, 1.0f, 1.0f, 0.1f)};
            const Colour selectedAreaShading{Colour::fromFloatRGBA(0.0f, 0.0f, 0.0f, 0.4f)};
        } m_colourDefinitions;
 
        enum HoverMode
        {
            noHover,
            segmentDrag,
            selectionDrag,
            leftEdgeDrag,
            rightEdgeDrag,
            undecidedDrag,
            NUM_HOVER_MODES
        };
 
        // functions
 
        void moveSelectionStart(int segmentIndex, int diff);
        void setSelectionStart(int segmentIndex, int sampleIndex);
        void moveSelectionEnd(int segmentIndex, int diff);
        void setSelectionEnd(int segmentIndex, int sampleIndex);
        void moveSelection(int segmentIndex, int diff);
        Range<int> getSelection(int segmentIndex);
        void setHoverFromDirection(int segmentIndex, int mouseDeltaX);
        MouseCursor hoverModeToMouseCursor(HoverMode hMode);
        HoverMode deduceSegmentHoverMode(int segmentIndex);
        void zoomByDelta(float delta);
        void reportAnyInvalidFiles(const StringArray& filelist);
 
        // overridden functions
 
        void mouseDrag(const MouseEvent& event) override;
        void mouseWheelMove(const MouseEvent& e, const MouseWheelDetails& wheel) override;
        void mouseUp(const MouseEvent& event) override;
        void mouseDown(const MouseEvent& event) override;
        void mouseMove(const MouseEvent& event) override;
        void mouseEnter(const MouseEvent& event) override;
        void mouseExit(const MouseEvent& event) override;
        bool isInterestedInFileDrag(const StringArray& files) override;
        void filesDropped(const StringArray& files, int x, int y) override;
        void fileDragEnter(const StringArray& files, int x, int y) override;
        void fileDragExit(const StringArray& files) override;
 
        void mouseMove();
 
        // data
        bool m_selectionChanged{false};
        bool m_middleMouseDown{false};
        ListenerList<Listener> m_listeners;
 
        ScrollAndZoomManager m_scrollManager;
        HoverMode m_hoverMode = HoverMode::noHover;
        std::vector<Selector> m_selectors;
        int m_activeSegmentIndex{0};
        int m_sampleMouseX{0};
        int m_mouseX{0};
        int m_mouseY{0};
 
        int m_nextSampleEngineSegment{0};
 
        SampleEngine* m_sampleEngine{nullptr};
        std::unique_ptr<GrainDisplay> m_grainDisplay;
        std::unique_ptr<WaveformViewer> m_waveformView;
 
        String m_fileName;
        String m_filePath;
 
        int m_totalSampleLength{0};
        float m_sampleRate;
 
        bool m_minimumSelectionAreaOn{false};
        bool m_hasFileBeenDropped{false};
 
        int m_frameCooldownCounter{0};
        // The number of frames to paint after grain activity stops
        static const int FRAME_COOLDOWN{30};
 
        std::unique_ptr<FileChooser> m_sampleChooser;
        const String m_fileChooserWindowTitle{"Select file"};
        const String m_chooserAllowedFileTypes{"*.wav;*.aif;*.aiff;*.flac;*.ogg"};
        const String m_validFileExtensions{"wav;aif;aiff;flac;ogg;"};
        ZoomStyle m_zoomStyle{ZoomStyle::start};
 
        JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(WaveformViewerAndEditor)
    };
} // namespace krotos