gtk2_ardour/selection.h

Go to the documentation of this file.

/*
 * Copyright (C) 2005 Taybin Rutkin <taybin@taybin.com>
 * Copyright (C) 2006-2014 David Robillard <d@drobilla.net>
 * Copyright (C) 2006-2017 Paul Davis <paul@linuxaudiosystems.com>
 * Copyright (C) 2007-2012 Carl Hetherington <carl@carlh.net>
 * Copyright (C) 2014-2018 Ben Loftis <ben@harrisonconsoles.com>
 * Copyright (C) 2015-2016 Nick Mainsbridge <mainsbridge@gmail.com>
 * Copyright (C) 2015-2017 Robin Gareus <robin@gareus.org>
 *
 * 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 2 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, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
#pragma once
 
#include <memory>
#include <vector>
 
#include <sigc++/signal.h>
 
#include "pbd/signals.h"
 
#include "ardour/types.h"
 
#include "time_selection.h"
#include "region_selection.h"
#include "track_selection.h"
#include "automation_selection.h"
#include "playlist_selection.h"
#include "processor_selection.h"
#include "point_selection.h"
#include "marker_selection.h"
#include "midi_selection.h"
#include "trigger_selection.h"
 
class TimeAxisView;
class RegionView;
class Selectable;
class EditingContext;
class MidiRegionView;
class EditorAutomationLine;
class ControlPoint;
 
 
namespace ARDOUR {
        class Region;
        class AudioRegion;
        class Playlist;
        class Processor;
        class AutomationList;
}
 
namespace Evoral {
        class ControlList;
}
 
 
class Selection : public sigc::trackable, public PBD::ScopedConnectionList
{
public:
        enum SelectionType {
                Object = 0x1,
                Range = 0x2
        };
 
        TrackSelection       tracks;
        RegionSelection      regions;
        TimeSelection        time;
        AutomationSelection  lines;
        PlaylistSelection    playlists;
        PointSelection       points;
        MarkerSelection      markers;
        TriggerSelection     triggers;
 
        MidiNoteSelection    midi_notes;
 
        MidiRegionSelection midi_regions();
 
        Selection (EditingContext const * e, bool manage_libardour_selection);
 
        // Selection& operator= (const Selection& other);
 
        sigc::signal<void> TracksChanged;
        sigc::signal<void> RegionsChanged;
        sigc::signal<void> TimeChanged;
        sigc::signal<void> LinesChanged;
        sigc::signal<void> PlaylistsChanged;
        sigc::signal<void> PointsChanged;
        sigc::signal<void> MarkersChanged;
        sigc::signal<void> MidiNotesChanged;
        sigc::signal<void> TriggersChanged;
 
        void clear ();
 
        bool empty (bool internal_selection = false);
 
        void dump_region_layers();
 
        bool selected (TimeAxisView*) const;
        bool selected (RegionView*) const;
        bool selected (ArdourMarker*) const;
        bool selected (ControlPoint*) const;
        bool selected (TriggerEntry*) const;
 
        /* ToDo: some region operations (midi quantize, audio reverse) expect
         * a RegionSelection (a list of regionviews).  We're likely going to
         * need a region_view + time_axis_view proxy, and this will get it.
         */
        RegionSelection trigger_regionview_proxy () const;
 
        void set (std::list<Selectable*> const &);
        void add (std::list<Selectable*> const &);
        void toggle (std::list<Selectable*> const &);
 
        void set (TimeAxisView*);
        void set (const TrackViewList&);
        void set (const MidiNoteSelection&);
        void set (RegionView*, bool also_clear_tracks = true);
        void set (std::vector<RegionView*>&);
        long set (Temporal::timepos_t const &, Temporal::timepos_t const &);
        void set_preserving_all_ranges (Temporal::timepos_t const &, Temporal::timepos_t const &);
        void set (std::shared_ptr<Evoral::ControlList>);
        void set (std::shared_ptr<ARDOUR::Playlist>);
        void set (const std::list<std::shared_ptr<ARDOUR::Playlist> >&);
        void set (ControlPoint *);
        void set (ArdourMarker*);
        void set (const RegionSelection&);
        void set (TriggerEntry*);
 
        void toggle (TimeAxisView*);
        void toggle (const TrackViewList&);
        void toggle (const MidiNoteSelection&);
        void toggle (RegionView*);
        void toggle (MidiCutBuffer*);
        void toggle (std::vector<RegionView*>&);
        long toggle (Temporal::timepos_t const &, Temporal::timepos_t const &);
        void toggle (ARDOUR::AutomationList*);
        void toggle (std::shared_ptr<ARDOUR::Playlist>);
        void toggle (const std::list<std::shared_ptr<ARDOUR::Playlist> >&);
        void toggle (ControlPoint *);
        void toggle (std::vector<ControlPoint*> const &);
        void toggle (ArdourMarker*);
        void toggle (TriggerEntry*);
 
        void add (TimeAxisView*);
        void add (const TrackViewList&);
        void add (const MidiNoteSelection&);
        void add (RegionView*);
        void add (MidiCutBuffer*);
        void add (std::vector<RegionView*>&);
        long add (Temporal::timepos_t const &, Temporal::timepos_t const &);
        void add (std::shared_ptr<Evoral::ControlList>);
        void add (std::shared_ptr<ARDOUR::Playlist>);
        void add (const std::list<std::shared_ptr<ARDOUR::Playlist> >&);
        void add (ControlPoint *);
        void add (std::vector<ControlPoint*> const &);
        void add (ArdourMarker*);
        void add (const std::list<ArdourMarker*>&);
        void add (const RegionSelection&);
        void add (const PointSelection&);
        void add (TriggerEntry*);
 
        void remove (TimeAxisView*);
        void remove (const TrackViewList&);
        void remove (const MidiNoteSelection&);
        void remove (RegionView*);
        void remove (std::vector<RegionView*>);
        void remove (MidiCutBuffer*);
        void remove (uint32_t selection_id);
        void remove (samplepos_t, samplepos_t);
        void remove (std::shared_ptr<ARDOUR::AutomationList>);
        void remove (std::shared_ptr<ARDOUR::Playlist>);
        void remove (const std::list<std::shared_ptr<ARDOUR::Playlist> >&);
        void remove (const std::list<Selectable*>&);
        void remove (ArdourMarker*);
        void remove (ControlPoint *);
        void remove (TriggerEntry*);
 
        void remove_regions (TimeAxisView *);
 
        void move_time (Temporal::timecnt_t const &);
 
        void replace (uint32_t time_index, Temporal::timepos_t const & start, Temporal::timepos_t const & end);
 
        /*
         * A note about items in an editing Selection:
         * At a high level, selections can include Tracks, Objects, or Time Ranges
         * Range and Object selections are mutually exclusive.
         * Selecting a Range will deselect all Objects, and vice versa.
         * This is done to avoid confusion over what will happen in an operation such as Delete
         * Tracks are somewhat orthogonal b/c editing operations don't apply to tracks.
         * The Track selection isn't affected when ranges or objects are added.
         */
 
        void clear_all() { clear_time(); clear_tracks(); clear_objects(); }
 
        void clear_time(bool with_signal = true);  //clears any time selection  ( i.e. Range )
        void clear_tracks (bool with_signal = true);  //clears the track header selections
        void clear_objects(bool with_signal = true);  //clears the items listed below
 
        // these items get cleared wholesale in clear_objects
        void clear_regions(bool with_signal = true);
        void clear_lines (bool with_signal = true);
        void clear_playlists (bool with_signal = true);
        void clear_points (bool with_signal = true);
        void clear_markers (bool with_signal = true);
        void clear_midi_notes (bool with_signal = true);
        void clear_triggers (bool with_signal = true);
 
        void foreach_region (void (ARDOUR::Region::*method)(void));
        void foreach_regionview (void (RegionView::*method)(void));
        void foreach_midi_regionview (void (MidiRegionView::*method)(void));
        template<class A> void foreach_region (void (ARDOUR::Region::*method)(A), A arg);
 
        XMLNode& get_state () const;
        int set_state (XMLNode const &, int);
 
        std::list<std::pair<PBD::ID const, std::list<Evoral::event_id_t> > > pending_midi_note_selection;
 
        void core_selection_changed (PBD::PropertyChange const & pc);
 
private:
        EditingContext const * editor;
        uint32_t next_time_id;
        bool     manage_libardour_selection;
};
 
bool operator==(const Selection& a, const Selection& b);