treat VCA assign as a RouteGroup property.
[ardour.git] / libs / ardour / ardour / types.h
index 7444a54a7c7822c4d834c4421d3128f7ada26051..ce284845191ac667cb05cbf296499f8e8a2a485a 100644 (file)
@@ -52,6 +52,9 @@ namespace ARDOUR {
        class AudioSource;
        class Route;
        class Region;
+       class Stripable;
+       class VCA;
+       class AutomationControl;
 
        typedef float    Sample;
        typedef float    pan_t;
@@ -117,6 +120,13 @@ namespace ARDOUR {
        };
 
        /** 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,6 +139,8 @@ namespace ARDOUR {
                PluginAutomation,
                PluginPropertyAutomation,
                SoloAutomation,
+               SoloIsolateAutomation,
+               SoloSafeAutomation,
                MuteAutomation,
                MidiCCAutomation,
                MidiPgmChangeAutomation,
@@ -139,6 +151,24 @@ namespace ARDOUR {
                FadeOutAutomation,
                EnvelopeAutomation,
                RecEnableAutomation,
+               RecSafeAutomation,
+               TrimAutomation,
+               PhaseAutomation,
+               MonitoringAutomation,
+               EQGain,
+               EQFrequency,
+               EQQ,
+               EQShape,
+               EQHPF,
+               EQEnable,
+               CompThreshold,
+               CompSpeed,
+               CompMode,
+               CompMakeup,
+               CompRedux,
+               CompEnable,
+               BusSendLevel,
+               BusSendEnable,
        };
 
        enum AutoState {
@@ -179,18 +209,20 @@ namespace ARDOUR {
        };
 
        enum MeterType {
-               MeterMaxSignal = 0x001,
-               MeterMaxPeak   = 0x002,
-               MeterPeak      = 0x004,
-               MeterKrms      = 0x008,
-               MeterK20       = 0x010,
-               MeterK14       = 0x020,
-               MeterIEC1DIN   = 0x040,
-               MeterIEC1NOR   = 0x080,
-               MeterIEC2BBC   = 0x100,
-               MeterIEC2EBU   = 0x200,
-               MeterVU        = 0x400,
-               MeterK12       = 0x800
+               MeterMaxSignal = 0x0001,
+               MeterMaxPeak   = 0x0002,
+               MeterPeak      = 0x0004,
+               MeterKrms      = 0x0008,
+               MeterK20       = 0x0010,
+               MeterK14       = 0x0020,
+               MeterIEC1DIN   = 0x0040,
+               MeterIEC1NOR   = 0x0080,
+               MeterIEC2BBC   = 0x0100,
+               MeterIEC2EBU   = 0x0200,
+               MeterVU        = 0x0400,
+               MeterK12       = 0x0800,
+               MeterPeak0dB   = 0x1000,
+               MeterMCP       = 0x2000
        };
 
        enum TrackMode {
@@ -216,6 +248,14 @@ namespace ARDOUR {
                TrackColor
        };
 
+       enum RoundMode {
+               RoundDownMaybe  = -2,  ///< Round down only if necessary
+               RoundDownAlways = -1,  ///< Always round down, even if on a division
+               RoundNearest    = 0,   ///< Round to nearest
+               RoundUpAlways   = 1,   ///< Always round up, even if on a division
+               RoundUpMaybe    = 2    ///< Round up only if necessary
+       };
+
        class AnyTime {
        public:
                enum Type {
@@ -267,8 +307,7 @@ namespace ARDOUR {
                                return seconds != 0;
                        }
 
-                       /* NOTREACHED */
-                       assert (false);
+                       abort(); /* NOTREACHED */
                        return false;
                }
        };
@@ -283,7 +322,7 @@ namespace ARDOUR {
 
                AudioRange (framepos_t s, framepos_t e, uint32_t i) : start (s), end (e) , id (i) {}
 
-               framecnt_t length() { return end - start + 1; }
+               framecnt_t length() const { return end - start + 1; }
 
                bool operator== (const AudioRange& other) const {
                        return start == other.start && end == other.end && id == other.id;
@@ -346,6 +385,17 @@ namespace ARDOUR {
                Lock
        };
 
+       enum RegionSelectionAfterSplit {
+               None = 0,
+               NewlyCreatedLeft = 1,  // bit 0
+               NewlyCreatedRight = 2, // bit 1
+               NewlyCreatedBoth = 3,
+               Existing = 4,          // bit 2
+               ExistingNewlyCreatedLeft = 5,
+               ExistingNewlyCreatedRight = 6,
+               ExistingNewlyCreatedBoth = 7
+       };
+
        enum RegionPoint {
                Start,
                End,
@@ -416,9 +466,9 @@ namespace ARDOUR {
                DenormalFTZDAZ
        };
 
-       enum RemoteModel {
-               UserOrdered,
-               MixerOrdered
+       enum LayerModel {
+               LaterHigher,
+               Manual
        };
 
        enum ListenPosition {
@@ -432,16 +482,24 @@ namespace ARDOUR {
                AutoConnectMaster = 0x2
        };
 
+    enum TracksAutoNamingRule {
+        UseDefaultNames = 0x1,
+        NameAfterDriver = 0x2
+    };
+
        enum SampleFormat {
                FormatFloat = 0,
                FormatInt24,
                FormatInt16
        };
 
+       int format_data_width (ARDOUR::SampleFormat);
+
        enum CDMarkerFormat {
                CDMarkerNone,
                CDMarkerCUE,
-               CDMarkerTOC
+               CDMarkerTOC,
+               MP4Chaps
        };
 
        enum HeaderFormat {
@@ -451,7 +509,9 @@ namespace ARDOUR {
                CAF,
                AIFF,
                iXML,
-               RF64
+               RF64,
+               RF64_WAV,
+               MBWF,
        };
 
        struct PeakData {
@@ -502,7 +562,12 @@ namespace ARDOUR {
        typedef std::list<framepos_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<VCA> > VCAList;
 
        class Bundle;
        typedef std::vector<boost::shared_ptr<Bundle> > BundleList;
@@ -534,7 +599,8 @@ namespace ARDOUR {
        struct RouteProcessorChange {
                enum Type {
                        GeneralChange = 0x0,
-                       MeterPointChange = 0x1
+                       MeterPointChange = 0x1,
+                       RealTimeChange = 0x2
                };
 
                RouteProcessorChange () : type (GeneralChange), meter_visibly_changed (true)
@@ -573,8 +639,8 @@ namespace ARDOUR {
                   this equality cannot be assumed.
                */
                TransportStopped = 0,
-               TransportRolling = 1, 
-               TransportLooping = 2, 
+               TransportRolling = 1,
+               TransportLooping = 2,
                TransportStarting = 3,
        };
 
@@ -582,7 +648,7 @@ 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,
@@ -594,67 +660,119 @@ namespace ARDOUR {
            uint32_t max; //< samples
        };
 
+       enum BufferingPreset {
+               Small,
+               Medium,
+               Large,
+               Custom,
+       };
+
+       enum AutoReturnTarget {
+               LastLocate = 0x1,
+               RangeSelectionStart = 0x2,
+               Loop = 0x4,
+               RegionSelectionStart = 0x8,
+       };
+
+       enum PlaylistDisposition {
+               CopyPlaylist,
+               NewPlaylist,
+               SharePlaylist
+       };
+
 } // namespace ARDOUR
 
 
 /* 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::VUMeterStandard& sf);
-std::istream& operator>>(std::istream& o, ARDOUR::MeterLineUp& 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::WaveformScale& sf);
-std::istream& operator>>(std::istream& o, ARDOUR::WaveformShape& 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::VUMeterStandard& sf);
-std::ostream& operator<<(std::ostream& o, const ARDOUR::MeterLineUp& 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::WaveformScale& sf);
-std::ostream& operator<<(std::ostream& o, const ARDOUR::WaveformShape& 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)
 {
-       return (ARDOUR::framepos_t) ((long double) session_frame * (long 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)
 {
-       return (ARDOUR::framepos_t) ((long double) track_frame / (long 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;
+       }
 }
 
 /* for now, break the rules and use "using" to make this "global" */
@@ -663,4 +781,3 @@ using ARDOUR::framepos_t;
 
 
 #endif /* __ardour_types_h__ */
-