location.h

Go to the documentation of this file.

/*
 * Copyright (C) 2006-2017 Paul Davis <paul@linuxaudiosystems.com>
 * Copyright (C) 2006 Hans Fugal <hans@fugal.net>
 * Copyright (C) 2008-2011 David Robillard <d@drobilla.net>
 * Copyright (C) 2008 Sakari Bergen <sakari.bergen@beatwaves.net>
 * Copyright (C) 2009-2012 Carl Hetherington <carl@carlh.net>
 * Copyright (C) 2015-2016 Nick Mainsbridge <mainsbridge@gmail.com>
 * Copyright (C) 2016-2019 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 <string>
#include <list>
#include <iostream>
#include <map>
#include <vector>
 
#include <sys/types.h>
 
#include <glibmm/threads.h>
 
#include "pbd/undo.h"
#include "pbd/stateful.h"
#include "pbd/statefuldestructible.h"
 
#include "temporal/domain_provider.h"
#include "temporal/domain_swap.h"
#include "temporal/types.h"
 
#include "ardour/ardour.h"
#include "ardour/scene_change.h"
#include "ardour/session_handle.h"
 
namespace ARDOUR {
 
class SceneChange;
 
class LIBARDOUR_API Location : public SessionHandleRef, public PBD::StatefulDestructible
{
public:
        enum Flags {
                IsMark = 0x1,
                IsAutoPunch = 0x2,
                IsAutoLoop = 0x4,
                IsHidden = 0x8,
                IsCDMarker = 0x10,
                IsRangeMarker = 0x20,
                IsSessionRange = 0x40,
                IsSkip = 0x80,
                IsSkipping = 0x100, /* skipping is active (or not) */
                IsClockOrigin = 0x200,
                IsXrun = 0x400,
                IsCueMarker = 0x800,
                IsSection = 0x1000,
                IsScene = 0x2000
        };
 
        Location (Session &);
        Location (Session &, Temporal::timepos_t const &, Temporal::timepos_t const &, const std::string &, Flags bits = Flags(0), int32_t cue_id = 0);
        Location (Location const& other, bool no_signal);
        Location (Session &, const XMLNode&);
        Location* operator= (const Location& other);
 
        bool operator==(const Location& other);
 
        bool locked() const { return _locked; }
        void lock ();
        void unlock ();
 
        int64_t timestamp() const { return _timestamp; };
        timepos_t start() const { return _start; }
        timepos_t end() const { return _end; }
        timecnt_t length() const { return _start.distance (_end); }
 
        samplepos_t start_sample() const  { return _start.samples(); }
        samplepos_t end_sample() const { return _end.samples(); }
        samplecnt_t length_samples() const { return _end.samples() - _start.samples(); }
 
        int set_start (timepos_t const & s, bool force = false);
        int set_end (timepos_t const & e, bool force = false);
        int set (timepos_t const & start, timepos_t const & end);
 
        int move_to (timepos_t const & pos);
 
        const std::string& name() const { return _name; }
        void set_name (const std::string &str);
 
        void set_auto_punch (bool yn, void *src);
        void set_auto_loop (bool yn, void *src);
        void set_hidden (bool yn, void *src);
        void set_cd (bool yn, void *src);
        void set_cue (bool yn, void *src);
        void set_is_range_marker (bool yn, void* src);
        void set_is_clock_origin (bool yn, void* src);
        void set_skip (bool yn);
        void set_skipping (bool yn);
        void set_section (bool yn);
 
        bool is_auto_punch () const { return _flags & IsAutoPunch; }
        bool is_auto_loop () const { return _flags & IsAutoLoop; }
        bool is_mark () const { return _flags & IsMark; }
        bool is_hidden () const { return _flags & IsHidden; }
        bool is_cd_marker () const { return _flags & IsCDMarker; }
        bool is_cue_marker () const { return _flags & IsCueMarker; }
        bool is_session_range () const { return _flags & IsSessionRange; }
        bool is_range_marker() const { return _flags & IsRangeMarker; }
        bool is_skip() const { return _flags & IsSkip; }
        bool is_clock_origin() const { return _flags & IsClockOrigin; }
        bool is_skipping() const { return (_flags & IsSkip) && (_flags & IsSkipping); }
        bool is_xrun() const { return _flags & IsXrun; }
        bool is_section() const { return _flags & IsSection; }
        bool is_scene() const { return (bool) _scene_change && _flags & IsScene; }
        bool matches (Flags f) const { return _flags & f; }
 
        /* any range with start < end  -- not a marker */
        bool is_range() const { return _flags & (IsSessionRange | IsRangeMarker | IsAutoLoop | IsAutoPunch | IsCDMarker); }
 
        Flags flags () const { return _flags; }
 
        std::shared_ptr<SceneChange> scene_change() const { return _scene_change; }
        void set_scene_change (std::shared_ptr<SceneChange>);
 
        int32_t cue_id() const { assert (is_cue_marker()); return _cue; }
        void set_cue_id (int32_t);
 
        /* these are static signals for objects that want to listen to all
         * locations at once.
         */
 
        static PBD::Signal<void(Location*)> name_changed;
        static PBD::Signal<void(Location*)> end_changed;
        static PBD::Signal<void(Location*)> start_changed;
        static PBD::Signal<void(Location*)> flags_changed;
        static PBD::Signal<void(Location*)> lock_changed;
        static PBD::Signal<void(Location*)> cue_change;
        static PBD::Signal<void(Location*)> scene_changed;
        static PBD::Signal<void(Location*)> time_domain_changed; /* unused */
 
        /* this is sent only when both start and end change at the same time */
        static PBD::Signal<void(Location*)> changed;
 
        /* these are member signals for objects that care only about
         * changes to this object
         */
 
        PBD::Signal<void()> Changed;
 
        PBD::Signal<void()> NameChanged;
        PBD::Signal<void()> EndChanged;
        PBD::Signal<void()> StartChanged;
        PBD::Signal<void()> FlagsChanged;
        PBD::Signal<void()> LockChanged;
        PBD::Signal<void()> CueChanged;
        PBD::Signal<void()> SceneChanged; /* unused */
        PBD::Signal<void()> TimeDomainChanged;
 
        /* CD Track / CD-Text info */
 
        std::map<std::string, std::string> cd_info;
        static XMLNode& cd_info_node (const std::string &, const std::string &);
 
        XMLNode& get_state () const;
        int set_state (const XMLNode&, int version);
 
        Temporal::TimeDomain position_time_domain() const { return _start.time_domain(); }
 
        /* Similar to, but not identical to the Temporal::TimeDomainSwapper API */
 
        void start_domain_bounce (Temporal::DomainBounceInfo&);
        void finish_domain_bounce (Temporal::DomainBounceInfo&);
 
        void set_time_domain (Temporal::TimeDomain);
 
        class ChangeSuspender {
                public:
                        ChangeSuspender (Location* l) : _l (l) {
                                _l->suspend_signals ();
                        }
                        ChangeSuspender (ChangeSuspender const& other) : _l (other._l) {
                                _l->suspend_signals ();
                        }
                        ~ChangeSuspender () {
                                _l->resume_signals ();
                        }
                private:
                        Location* _l;
        };
 
protected:
        friend class ChangeSuspender;
        void suspend_signals ();
        void resume_signals ();
 
private:
        Location (Location const&); // no copy c'tor
        void set_mark (bool yn);
        bool set_flag_internal (bool yn, Flags flag);
 
        enum Signal {
                Name,
                StartEnd,
                End,
                Start,
                Flag,
                Lock,
                Cue,
                Scene,
                Domain,
        };
 
        void emit_signal (Signal);
        void actually_emit_signal (Signal);
 
 
        std::string _name;
        timepos_t   _start;
        timepos_t   _end;
        Flags       _flags;
        bool        _locked;
        int64_t     _timestamp;
        int32_t     _cue;
 
        uint32_t         _signals_suspended;
        std::set<Signal> _postponed_signals;
 
        std::shared_ptr<SceneChange> _scene_change;
 
        void set_position_time_domain (Temporal::TimeDomain);
};
 
class LIBARDOUR_API Locations : public SessionHandleRef, public PBD::StatefulDestructible, public Temporal::TimeDomainProvider, public Temporal::TimeDomainSwapper
{
public:
        typedef std::list<Location *> LocationList;
        typedef std::pair<Temporal::timepos_t, Location*> LocationPair;
 
        Locations (Session &);
        ~Locations ();
 
        const LocationList& list () const { return locations; }
        LocationList list () { return locations; }
 
        void add (Location *, bool make_current = false);
 
        Location* add_range (timepos_t const & start, timepos_t const & end);
 
        void remove (Location *);
        bool clear ();
        bool clear_markers ();
        bool clear_xrun_markers ();
        bool clear_ranges ();
 
        bool clear_cue_markers (samplepos_t start, samplepos_t end);
        bool clear_scene_markers (samplepos_t start, samplepos_t end);
 
        void cut_copy_section (timepos_t const& start, timepos_t const& end, timepos_t const& to, SectionOperation const op);
 
        void ripple (timepos_t const & at, timecnt_t const & distance, bool include_locked);
 
        XMLNode& get_state () const;
        int set_state (const XMLNode&, int version);
        Location *get_location_by_id(PBD::ID);
 
        Location* auto_loop_location () const;
        Location* auto_punch_location () const;
        Location* session_range_location() const;
        Location* clock_origin_location() const;
 
        int next_available_name(std::string& result,std::string base);
        uint32_t num_range_markers() const;
 
        int set_current (Location *, bool want_lock = true);
        Location *current () const { return current_location; }
 
        Location* mark_at (timepos_t const &, timecnt_t const & slop = timecnt_t::zero (Temporal::AudioTime), Location::Flags flags = Location::Flags (0)) const;
 
        void set_clock_origin (Location*, void *src);
 
        timepos_t first_mark_before_flagged (timepos_t const &, bool include_special_ranges = false, Location::Flags whitelist = Location::Flags (0), Location::Flags blacklist = Location::Flags (0), Location::Flags equalist = Location::Flags (0), Location** retval = nullptr);
        timepos_t first_mark_after_flagged (timepos_t const &, bool include_special_ranges = false, Location::Flags whitelist = Location::Flags (0), Location::Flags blacklist = Location::Flags (0), Location::Flags equalist = Location::Flags (0), Location** retval = nullptr);
 
        timepos_t first_mark_after (timepos_t const & t, bool include_special_ranges = false) {
                return first_mark_after_flagged (t, include_special_ranges);
        }
        timepos_t first_mark_before (timepos_t const & t, bool include_special_ranges = false) {
                return first_mark_before_flagged (t, include_special_ranges);
        }
 
        Location* next_section (Location*, timepos_t&, timepos_t&) const;
        Location* next_section_iter (Location*, timepos_t&, timepos_t&, std::vector<LocationPair>& cache) const;
        Location* section_at (timepos_t const&, timepos_t&, timepos_t&) const;
 
        void marks_either_side (timepos_t const &, timepos_t &, timepos_t &) const;
 
        Location* range_starts_at (timepos_t const & pos, timecnt_t const & slop = timecnt_t (Temporal::AudioTime), bool incl = false) const;
 
        void find_all_between (timepos_t const & start, timepos_t const & end, LocationList&, Location::Flags);
 
        void set_time_domain (Temporal::TimeDomain);
        void start_domain_bounce (Temporal::DomainBounceInfo&);
        void finish_domain_bounce (Temporal::DomainBounceInfo&);
 
        void time_domain_changed ();
 
        PBD::Signal<void(Location*)> current_changed;
 
        /* Objects that care about individual addition and removal of Locations should connect to added/removed.
         * If an object additionally cares about potential mass clearance of Locations, they should connect to changed.
         */
 
        PBD::Signal<void(Location*)> added;
        PBD::Signal<void(Location*)> removed;
        PBD::Signal<void()> changed; /* emitted when any action that could have added/removed more than 1 location actually removed 1 or more */
 
        template<class T> void apply (T& obj, void (T::*method)(const LocationList&)) const {
                /* We don't want to hold the lock while the given method runs, so take a copy
                 * of the list and pass that instead.
                 */
                Locations::LocationList copy;
                {
                        Glib::Threads::RWLock::ReaderLock lm (_lock);
                        copy = locations;
                }
                (obj.*method)(copy);
        }
 
private:
        void sorted_section_locations (std::vector<LocationPair>&) const;
 
        LocationList locations;
        Location*    current_location;
        mutable Glib::Threads::RWLock _lock;
 
        int set_current_unlocked (Location *);
        void location_changed (Location*);
        void listen_to (Location*);
};
 
} // namespace ARDOUR