new_grid: Rewrite of Snap and Grid. (squashed commit)
[ardour.git] / libs / ardour / ardour / types.h
index 5bd7b879290c416f0c0a99950f458b3c8c489068..352c20ae9bdf55dccc27b46f0c2a4fe04990f202 100644 (file)
@@ -23,6 +23,7 @@
 #include <istream>
 #include <vector>
 #include <map>
+#include <set>
 #include <boost/shared_ptr.hpp>
 #include <sys/types.h>
 #include <stdint.h>
@@ -30,8 +31,9 @@
 
 #include <inttypes.h>
 
-#include "timecode/bbt_time.h"
-#include "timecode/time.h"
+#include "temporal/bbt_time.h"
+#include "temporal/time.h"
+#include "temporal/types.h"
 
 #include "pbd/id.h"
 
@@ -42,6 +44,9 @@
 
 #include <map>
 
+using Temporal::max_samplepos;
+using Temporal::max_samplecnt;
+
 #if __GNUC__ < 3
 typedef int intptr_t;
 #endif
@@ -52,6 +57,10 @@ namespace ARDOUR {
        class AudioSource;
        class Route;
        class Region;
+       class Stripable;
+       class VCA;
+       class AutomationControl;
+       class SlavableAutomationControl;
 
        typedef float    Sample;
        typedef float    pan_t;
@@ -60,27 +69,15 @@ namespace ARDOUR {
        typedef uint64_t microseconds_t;
        typedef uint32_t pframes_t;
 
-       /* Any position measured in audio frames.
-          Assumed to be non-negative but not enforced.
-       */
-       typedef int64_t framepos_t;
-
-       /* Any distance from a given framepos_t.
-          Maybe positive or negative.
-       */
-       typedef int64_t frameoffset_t;
-
-       /* Any count of audio frames.
-          Assumed to be positive but not enforced.
-       */
-       typedef int64_t framecnt_t;
+       /* rebind Temporal position types into ARDOUR namespace */
+       typedef Temporal::samplecnt_t samplecnt_t;
+       typedef Temporal::samplepos_t samplepos_t;
+       typedef Temporal::sampleoffset_t sampleoffset_t;
 
-       static const framepos_t max_framepos = INT64_MAX;
-       static const framecnt_t max_framecnt = INT64_MAX;
        static const layer_t    max_layer    = UINT32_MAX;
 
        // a set of (time) intervals: first of pair is the offset of the start within the region, second is the offset of the end
-       typedef std::list<std::pair<frameoffset_t, frameoffset_t> > AudioIntervalResult;
+       typedef std::list<std::pair<sampleoffset_t, sampleoffset_t> > AudioIntervalResult;
        // associate a set of intervals with regions (e.g. for silence detection)
        typedef std::map<boost::shared_ptr<ARDOUR::Region>,AudioIntervalResult> AudioIntervalMap;
 
@@ -108,15 +105,22 @@ namespace ARDOUR {
        */
 
        enum InsertMergePolicy {
-               InsertMergeReject,  // no overlaps allowed
-               InsertMergeRelax,   // we just don't care about overlaps
-               InsertMergeReplace, // replace old with new
-               InsertMergeTruncateExisting, // shorten existing to avoid overlap
-               InsertMergeTruncateAddition, // shorten new to avoid overlap
-               InsertMergeExtend   // extend new (or old) to the range of old+new
+               InsertMergeReject,  ///< no overlaps allowed
+               InsertMergeRelax,   ///< we just don't care about overlaps
+               InsertMergeReplace, ///< replace old with new
+               InsertMergeTruncateExisting, ///< shorten existing to avoid overlap
+               InsertMergeTruncateAddition, ///< shorten new to avoid overlap
+               InsertMergeExtend   ///< extend new (or old) to the range of old+new
        };
 
        /** See evoral/Parameter.hpp
+        *
+        * When you add things here, you REALLY SHOULD add a case clause to
+        * the constructor of ParameterDescriptor, unless the Controllables
+        * that the enum refers to are completely standard (0-1.0 range, 0.0 as
+        * normal, non-toggled, non-enumerated). Anything else needs to be
+        * added there so that things that try to represent them can do so
+        * with as much information as possible.
         */
        enum AutomationType {
                NullAutomation,
@@ -129,37 +133,38 @@ namespace ARDOUR {
                PluginAutomation,
                PluginPropertyAutomation,
                SoloAutomation,
+               SoloIsolateAutomation,
+               SoloSafeAutomation,
                MuteAutomation,
                MidiCCAutomation,
                MidiPgmChangeAutomation,
                MidiPitchBenderAutomation,
                MidiChannelPressureAutomation,
+               MidiNotePressureAutomation,
                MidiSystemExclusiveAutomation,
                FadeInAutomation,
                FadeOutAutomation,
                EnvelopeAutomation,
                RecEnableAutomation,
+               RecSafeAutomation,
                TrimAutomation,
+               PhaseAutomation,
+               MonitoringAutomation,
+               BusSendLevel,
+               BusSendEnable
        };
 
        enum AutoState {
-               Off = 0x0,
-               Write = 0x1,
-               Touch = 0x2,
-               Play = 0x4
+               Off   = 0x00,
+               Write = 0x01,
+               Touch = 0x02,
+               Play  = 0x04,
+               Latch = 0x08
        };
 
        std::string auto_state_to_string (AutoState);
        AutoState string_to_auto_state (std::string);
 
-       enum AutoStyle {
-               Absolute = 0x1,
-               Trim = 0x2
-       };
-
-       std::string auto_style_to_string (AutoStyle);
-       AutoStyle string_to_auto_style (std::string);
-
        enum AlignStyle {
                CaptureTime,
                ExistingMaterial
@@ -179,6 +184,12 @@ namespace ARDOUR {
                MeterCustom
        };
 
+       enum DiskIOPoint {
+               DiskIOPreFader,  /* after the trim control, but before other processors */
+               DiskIOPostFader, /* before the main outs, after other processors */
+               DiskIOCustom,   /* up to the user. Caveat Emptor! */
+       };
+
        enum MeterType {
                MeterMaxSignal = 0x0001,
                MeterMaxPeak   = 0x0002,
@@ -227,12 +238,17 @@ namespace ARDOUR {
                RoundUpMaybe    = 2    ///< Round up only if necessary
        };
 
+       enum SnapPref {
+               SnapToAny    = 0,   ///< Snaps to the closest of ( snap prefs, grid quantization )
+               SnapToGrid   = 1,   ///< Prefer snapping to the closest grid quantization, if a Grid selection is enabled
+       };
+
        class AnyTime {
        public:
                enum Type {
                        Timecode,
                        BBT,
-                       Frames,
+                       Samples,
                        Seconds
                };
 
@@ -242,11 +258,11 @@ namespace ARDOUR {
                Timecode::BBT_Time bbt;
 
                union {
-                       framecnt_t     frames;
+                       samplecnt_t     samples;
                        double         seconds;
                };
 
-               AnyTime() { type = Frames; frames = 0; }
+               AnyTime() { type = Samples; samples = 0; }
 
                bool operator== (AnyTime const & other) const {
                        if (type != other.type) { return false; }
@@ -256,8 +272,8 @@ namespace ARDOUR {
                                return timecode == other.timecode;
                          case BBT:
                                return bbt == other.bbt;
-                         case Frames:
-                               return frames == other.frames;
+                         case Samples:
+                               return samples == other.samples;
                          case Seconds:
                                return seconds == other.seconds;
                        }
@@ -272,8 +288,8 @@ namespace ARDOUR {
                                       timecode.seconds != 0 || timecode.frames != 0;
                          case BBT:
                                return bbt.bars != 0 || bbt.beats != 0 || bbt.ticks != 0;
-                         case Frames:
-                               return frames != 0;
+                         case Samples:
+                               return samples != 0;
                          case Seconds:
                                return seconds != 0;
                        }
@@ -283,17 +299,38 @@ namespace ARDOUR {
                }
        };
 
+       /* used for translating audio samples to an exact musical position using a note divisor.
+          an exact musical position almost never falls exactly on an audio sample, but for sub-sample
+          musical accuracy we need to derive exact musical locations from a sample position
+          the division follows TempoMap::exact_beat_at_sample().
+          division
+          -1       musical location is the bar closest to sample
+           0       musical location is the musical position of the sample
+           1       musical location is the BBT beat closest to sample
+           n       musical location is the quarter-note division n closest to sample
+       */
+       struct MusicSample {
+               samplepos_t sample;
+               int32_t    division;
+
+               MusicSample (samplepos_t f, int32_t d) : sample (f), division (d) {}
+
+               void set (samplepos_t f, int32_t d) {sample = f; division = d; }
+
+               MusicSample operator- (MusicSample other) { return MusicSample (sample - other.sample, 0); }
+       };
+
        /* XXX: slightly unfortunate that there is this and Evoral::Range<>,
           but this has a uint32_t id which Evoral::Range<> does not.
        */
        struct AudioRange {
-               framepos_t start;
-               framepos_t end;
+               samplepos_t start;
+               samplepos_t end;
                uint32_t id;
 
-               AudioRange (framepos_t s, framepos_t e, uint32_t i) : start (s), end (e) , id (i) {}
+               AudioRange (samplepos_t s, samplepos_t e, uint32_t i) : start (s), end (e) , id (i) {}
 
-               framecnt_t length() { return end - start + 1; }
+               samplecnt_t length() const { return end - start + 1; }
 
                bool operator== (const AudioRange& other) const {
                        return start == other.start && end == other.end && id == other.id;
@@ -303,7 +340,7 @@ namespace ARDOUR {
                        return start == other.start && end == other.end;
                }
 
-               Evoral::OverlapType coverage (framepos_t s, framepos_t e) const {
+               Evoral::OverlapType coverage (samplepos_t s, samplepos_t e) const {
                        return Evoral::coverage (start, end, s, e);
                }
        };
@@ -430,6 +467,12 @@ namespace ARDOUR {
                AFLFromAfterProcessors
        };
 
+       enum ClockDeltaMode {
+               NoDelta,
+               DeltaEditPoint,
+               DeltaOriginMarker
+       };
+
        enum DenormalModel {
                DenormalNone,
                DenormalFTZ,
@@ -437,11 +480,6 @@ namespace ARDOUR {
                DenormalFTZDAZ
        };
 
-       enum RemoteModel {
-               UserOrdered,
-               MixerOrdered
-       };
-
        enum LayerModel {
                LaterHigher,
                Manual
@@ -457,7 +495,7 @@ namespace ARDOUR {
                AutoConnectPhysical = 0x1,
                AutoConnectMaster = 0x2
        };
-        
+
     enum TracksAutoNamingRule {
         UseDefaultNames = 0x1,
         NameAfterDriver = 0x2
@@ -535,10 +573,17 @@ namespace ARDOUR {
                SrcFastest
        };
 
-       typedef std::list<framepos_t> AnalysisFeatureList;
+       typedef std::list<samplepos_t> AnalysisFeatureList;
 
        typedef std::list<boost::shared_ptr<Route> > RouteList;
+       typedef std::list<boost::shared_ptr<Stripable> > StripableList;
        typedef std::list<boost::weak_ptr  <Route> > WeakRouteList;
+       typedef std::list<boost::weak_ptr  <Stripable> > WeakStripableList;
+       typedef std::list<boost::shared_ptr<AutomationControl> > ControlList;
+       typedef std::list<boost::shared_ptr<SlavableAutomationControl> > SlavableControlList;
+       typedef std::set <boost::shared_ptr<AutomationControl> > AutomationControlSet;
+
+       typedef std::list<boost::shared_ptr<VCA> > VCAList;
 
        class Bundle;
        typedef std::vector<boost::shared_ptr<Bundle> > BundleList;
@@ -590,11 +635,7 @@ namespace ARDOUR {
        };
 
        struct BusProfile {
-               AutoConnectOption input_ac;      /* override the RC config for input auto-connection */
-               AutoConnectOption output_ac;     /* override the RC config for output auto-connection */
-               uint32_t master_out_channels;    /* how many channels for the master bus */
-               uint32_t requested_physical_in;  /* now many of the available physical inputs to consider usable */
-               uint32_t requested_physical_out; /* now many of the available physical inputs to consider usable */
+               uint32_t master_out_channels; /* how many channels for the master bus, 0: no master bus */
        };
 
        enum FadeShape {
@@ -610,8 +651,8 @@ namespace ARDOUR {
                   this equality cannot be assumed.
                */
                TransportStopped = 0,
-               TransportRolling = 1, 
-               TransportLooping = 2, 
+               TransportRolling = 1,
+               TransportLooping = 2,
                TransportStarting = 3,
        };
 
@@ -619,11 +660,22 @@ namespace ARDOUR {
                /* these values happen to match the constants used by JACK but
                   this equality cannot be assumed.
                */
-               IsInput = 0x1, 
+               IsInput = 0x1,
                IsOutput = 0x2,
                IsPhysical = 0x4,
                CanMonitor = 0x8,
-               IsTerminal = 0x10
+               IsTerminal = 0x10,
+
+               /* non-JACK related flags */
+               Hidden = 0x20,
+               Shadow = 0x40
+       };
+
+       enum MidiPortFlags {
+               MidiPortMusic = 0x1,
+               MidiPortControl = 0x2,
+               MidiPortSelection = 0x4,
+               MidiPortVirtual = 0x8
        };
 
        struct LatencyRange {
@@ -645,107 +697,34 @@ namespace ARDOUR {
                RegionSelectionStart = 0x8,
        };
 
-} // namespace ARDOUR
+       enum PlaylistDisposition {
+               CopyPlaylist,
+               NewPlaylist,
+               SharePlaylist
+       };
+
+       enum MidiTrackNameSource {
+               SMFTrackNumber,
+               SMFTrackName,
+               SMFInstrumentName
+       };
 
+       enum MidiTempoMapDisposition {
+               SMFTempoIgnore,
+               SMFTempoUse,
+       };
 
-/* these cover types declared above in this header. See enums.cc
-   for the definitions.
-*/
-std::istream& operator>>(std::istream& o, ARDOUR::SampleFormat& sf);
-std::istream& operator>>(std::istream& o, ARDOUR::HeaderFormat& sf);
-std::istream& operator>>(std::istream& o, ARDOUR::AutoConnectOption& sf);
-std::istream& operator>>(std::istream& o, ARDOUR::TracksAutoNamingRule& sf);
-std::istream& operator>>(std::istream& o, ARDOUR::EditMode& sf);
-std::istream& operator>>(std::istream& o, ARDOUR::MonitorModel& sf);
-std::istream& operator>>(std::istream& o, ARDOUR::PFLPosition& sf);
-std::istream& operator>>(std::istream& o, ARDOUR::AFLPosition& sf);
-std::istream& operator>>(std::istream& o, ARDOUR::RemoteModel& sf);
-std::istream& operator>>(std::istream& o, ARDOUR::ListenPosition& sf);
-std::istream& operator>>(std::istream& o, ARDOUR::LayerModel& sf);
-std::istream& operator>>(std::istream& o, ARDOUR::InsertMergePolicy& sf);
-std::istream& operator>>(std::istream& o, ARDOUR::SyncSource& sf);
-std::istream& operator>>(std::istream& o, ARDOUR::ShuttleBehaviour& sf);
-std::istream& operator>>(std::istream& o, ARDOUR::ShuttleUnits& sf);
-std::istream& operator>>(std::istream& o, Timecode::TimecodeFormat& sf);
-std::istream& operator>>(std::istream& o, ARDOUR::DenormalModel& sf);
-std::istream& operator>>(std::istream& o, ARDOUR::PositionLockStyle& sf);
-std::istream& operator>>(std::istream& o, ARDOUR::FadeShape& sf);
-std::istream& operator>>(std::istream& o, ARDOUR::RegionSelectionAfterSplit& sf);
-std::istream& operator>>(std::istream& o, ARDOUR::BufferingPreset& var);
-std::istream& operator>>(std::istream& o, ARDOUR::AutoReturnTarget& sf);
-std::istream& operator>>(std::istream& o, ARDOUR::MeterType& sf);
-
-std::ostream& operator<<(std::ostream& o, const ARDOUR::SampleFormat& sf);
-std::ostream& operator<<(std::ostream& o, const ARDOUR::HeaderFormat& sf);
-std::ostream& operator<<(std::ostream& o, const ARDOUR::AutoConnectOption& sf);
-std::ostream& operator<<(std::ostream& o, const ARDOUR::TracksAutoNamingRule& sf);
-std::ostream& operator<<(std::ostream& o, const ARDOUR::EditMode& sf);
-std::ostream& operator<<(std::ostream& o, const ARDOUR::MonitorModel& sf);
-std::ostream& operator<<(std::ostream& o, const ARDOUR::PFLPosition& sf);
-std::ostream& operator<<(std::ostream& o, const ARDOUR::AFLPosition& sf);
-std::ostream& operator<<(std::ostream& o, const ARDOUR::RemoteModel& sf);
-std::ostream& operator<<(std::ostream& o, const ARDOUR::ListenPosition& sf);
-std::ostream& operator<<(std::ostream& o, const ARDOUR::LayerModel& sf);
-std::ostream& operator<<(std::ostream& o, const ARDOUR::InsertMergePolicy& sf);
-std::ostream& operator<<(std::ostream& o, const ARDOUR::SyncSource& sf);
-std::ostream& operator<<(std::ostream& o, const ARDOUR::ShuttleBehaviour& sf);
-std::ostream& operator<<(std::ostream& o, const ARDOUR::ShuttleUnits& sf);
-std::ostream& operator<<(std::ostream& o, const Timecode::TimecodeFormat& sf);
-std::ostream& operator<<(std::ostream& o, const ARDOUR::DenormalModel& sf);
-std::ostream& operator<<(std::ostream& o, const ARDOUR::PositionLockStyle& sf);
-std::ostream& operator<<(std::ostream& o, const ARDOUR::FadeShape& sf);
-std::ostream& operator<<(std::ostream& o, const ARDOUR::RegionSelectionAfterSplit& sf);
-std::ostream& operator<<(std::ostream& o, const ARDOUR::BufferingPreset& var);
-std::ostream& operator<<(std::ostream& o, const ARDOUR::AutoReturnTarget& sf);
-std::ostream& operator<<(std::ostream& o, const ARDOUR::MeterType& sf);
-
-/* because these operators work on types which can be used when making
-   a UI_CONFIG_VARIABLE (in gtk2_ardour) we need them to be exported.
-*/
-LIBARDOUR_API std::istream& operator>>(std::istream& o, ARDOUR::WaveformScale& sf);
-LIBARDOUR_API std::istream& operator>>(std::istream& o, ARDOUR::WaveformShape& sf);
-LIBARDOUR_API std::istream& operator>>(std::istream& o, ARDOUR::VUMeterStandard& sf);
-LIBARDOUR_API std::istream& operator>>(std::istream& o, ARDOUR::MeterLineUp& sf);
-
-LIBARDOUR_API std::ostream& operator<<(std::ostream& o, const ARDOUR::WaveformScale& sf);
-LIBARDOUR_API std::ostream& operator<<(std::ostream& o, const ARDOUR::WaveformShape& sf);
-LIBARDOUR_API std::ostream& operator<<(std::ostream& o, const ARDOUR::VUMeterStandard& sf);
-LIBARDOUR_API std::ostream& operator<<(std::ostream& o, const ARDOUR::MeterLineUp& sf);
-
-
-static inline ARDOUR::framepos_t
-session_frame_to_track_frame (ARDOUR::framepos_t session_frame, double speed)
-{
-       long double result = (long double) session_frame * (long double) speed;
-
-       if (result >= (long double) ARDOUR::max_framepos) {
-               return ARDOUR::max_framepos;
-       } else if (result <= (long double) (ARDOUR::max_framepos) * (ARDOUR::framepos_t)(-1)) {
-               return (ARDOUR::max_framepos * (ARDOUR::framepos_t)(-1));
-       } else {
-               return result;
-       }
-}
-
-static inline ARDOUR::framepos_t
-track_frame_to_session_frame (ARDOUR::framepos_t track_frame, double speed)
-{
-       /* NB - do we need a check for speed == 0 ??? */ 
-       long double result = (long double) track_frame / (long double) speed;
-
-       if (result >= (long double) ARDOUR::max_framepos) {
-               return ARDOUR::max_framepos;
-       } else if (result <= (long double) (ARDOUR::max_framepos) * (ARDOUR::framepos_t)(-1)) {
-               return (ARDOUR::max_framepos * (ARDOUR::framepos_t)(-1));
-       } else {
-               return result;
-       }
-}
+       struct CaptureInfo {
+               samplepos_t start;
+               samplecnt_t samples;
+       };
 
-/* for now, break the rules and use "using" to make this "global" */
+       typedef std::vector<CaptureInfo*> CaptureInfos;
 
-using ARDOUR::framepos_t;
+} // namespace ARDOUR
 
+/* for now, break the rules and use "using" to make this "global" */
 
-#endif /* __ardour_types_h__ */
+using ARDOUR::samplepos_t;
 
+#endif /* __ardour_types_h__ */