2 Copyright (C) 2002 Paul Davis
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 #ifndef __ardour_types_h__
21 #define __ardour_types_h__
26 #include <boost/shared_ptr.hpp>
27 #include <sys/types.h>
33 #include "timecode/bbt_time.h"
34 #include "timecode/time.h"
38 #include "evoral/Range.hpp"
40 #include "ardour/chan_count.h"
41 #include "ardour/plugin_types.h"
57 class AutomationControl;
62 typedef uint32_t layer_t;
63 typedef uint64_t microseconds_t;
64 typedef uint32_t pframes_t;
66 /* Any position measured in audio frames.
67 Assumed to be non-negative but not enforced.
69 typedef int64_t framepos_t;
71 /* Any distance from a given framepos_t.
72 Maybe positive or negative.
74 typedef int64_t frameoffset_t;
76 /* Any count of audio frames.
77 Assumed to be positive but not enforced.
79 typedef int64_t framecnt_t;
81 static const framepos_t max_framepos = INT64_MAX;
82 static const framecnt_t max_framecnt = INT64_MAX;
83 static const layer_t max_layer = UINT32_MAX;
85 // a set of (time) intervals: first of pair is the offset of the start within the region, second is the offset of the end
86 typedef std::list<std::pair<frameoffset_t, frameoffset_t> > AudioIntervalResult;
87 // associate a set of intervals with regions (e.g. for silence detection)
88 typedef std::map<boost::shared_ptr<ARDOUR::Region>,AudioIntervalResult> AudioIntervalMap;
90 typedef std::list<boost::shared_ptr<Region> > RegionList;
96 ConfigurationChanged = 0x1,
97 ConnectionsChanged = 0x2
100 IOChange () : type (NoChange) {}
101 IOChange (Type t) : type (t) {}
103 /** channel count of IO before a ConfigurationChanged, if appropriate */
104 ARDOUR::ChanCount before;
105 /** channel count of IO after a ConfigurationChanged, if appropriate */
106 ARDOUR::ChanCount after;
109 /* policies for inserting/pasting material where overlaps
113 enum InsertMergePolicy {
114 InsertMergeReject, ///< no overlaps allowed
115 InsertMergeRelax, ///< we just don't care about overlaps
116 InsertMergeReplace, ///< replace old with new
117 InsertMergeTruncateExisting, ///< shorten existing to avoid overlap
118 InsertMergeTruncateAddition, ///< shorten new to avoid overlap
119 InsertMergeExtend ///< extend new (or old) to the range of old+new
122 /** See evoral/Parameter.hpp
124 * When you add things here, you REALLY SHOULD add a case clause to
125 * the constructor of ParameterDescriptor, unless the Controllables
126 * that the enum refers to are completely standard (0-1.0 range, 0.0 as
127 * normal, non-toggled, non-enumerated). Anything else needs to be
128 * added there so that things that try to represent them can do so
129 * with as much information as possible.
131 enum AutomationType {
134 PanAzimuthAutomation,
135 PanElevationAutomation,
137 PanFrontBackAutomation,
140 PluginPropertyAutomation,
142 SoloIsolateAutomation,
146 MidiPgmChangeAutomation,
147 MidiPitchBenderAutomation,
148 MidiChannelPressureAutomation,
149 MidiNotePressureAutomation,
150 MidiSystemExclusiveAutomation,
158 MonitoringAutomation,
182 std::string auto_state_to_string (AutoState);
183 AutoState string_to_auto_state (std::string);
190 std::string auto_style_to_string (AutoStyle);
191 AutoStyle string_to_auto_style (std::string);
213 MeterMaxSignal = 0x0001,
214 MeterMaxPeak = 0x0002,
219 MeterIEC1DIN = 0x0040,
220 MeterIEC1NOR = 0x0080,
221 MeterIEC2BBC = 0x0100,
222 MeterIEC2EBU = 0x0200,
225 MeterPeak0dB = 0x1000,
241 AllChannels = 0, ///< Pass through all channel information unmodified
242 FilterChannels, ///< Ignore events on certain channels
243 ForceChannel ///< Force all events to a certain channel
255 SET_LC_MESSAGES_AND_LC_NUMERIC
259 RoundDownMaybe = -2, ///< Round down only if necessary
260 RoundDownAlways = -1, ///< Always round down, even if on a division
261 RoundNearest = 0, ///< Round to nearest
262 RoundUpAlways = 1, ///< Always round up, even if on a division
263 RoundUpMaybe = 2 ///< Round up only if necessary
277 Timecode::Time timecode;
278 Timecode::BBT_Time bbt;
285 AnyTime() { type = Frames; frames = 0; }
287 bool operator== (AnyTime const & other) const {
288 if (type != other.type) { return false; }
292 return timecode == other.timecode;
294 return bbt == other.bbt;
296 return frames == other.frames;
298 return seconds == other.seconds;
300 return false; // get rid of warning
303 bool not_zero() const
307 return timecode.hours != 0 || timecode.minutes != 0 ||
308 timecode.seconds != 0 || timecode.frames != 0;
310 return bbt.bars != 0 || bbt.beats != 0 || bbt.ticks != 0;
317 abort(); /* NOTREACHED */
322 /* used for translating audio frames to an exact musical position using a note divisor.
323 an exact musical position almost never falls exactly on an audio frame, but for sub-sample
324 musical accuracy we need to derive exact musical locations from a frame position
325 the division follows TempoMap::exact_beat_at_frame().
327 -1 musical location is the bar closest to frame
328 0 musical location is the musical position of the frame
329 1 musical location is the BBT beat closest to frame
330 n musical location is the quarter-note division n closest to frame
336 MusicFrame (framepos_t f, int32_t d) : frame (f), division (d) {}
338 void set (framepos_t f, int32_t d) {frame = f; division = d; }
340 MusicFrame operator- (MusicFrame other) { return MusicFrame (frame - other.frame, 0); }
343 /* XXX: slightly unfortunate that there is this and Evoral::Range<>,
344 but this has a uint32_t id which Evoral::Range<> does not.
351 AudioRange (framepos_t s, framepos_t e, uint32_t i) : start (s), end (e) , id (i) {}
353 framecnt_t length() const { return end - start + 1; }
355 bool operator== (const AudioRange& other) const {
356 return start == other.start && end == other.end && id == other.id;
359 bool equal (const AudioRange& other) const {
360 return start == other.start && end == other.end;
363 Evoral::OverlapType coverage (framepos_t s, framepos_t e) const {
364 return Evoral::coverage (start, end, s, e);
369 Timecode::BBT_Time start;
370 Timecode::BBT_Time end;
373 MusicRange (Timecode::BBT_Time& s, Timecode::BBT_Time& e, uint32_t i)
374 : start (s), end (e), id (i) {}
376 bool operator== (const MusicRange& other) const {
377 return start == other.start && end == other.end && id == other.id;
380 bool equal (const MusicRange& other) const {
381 return start == other.start && end == other.end;
386 Slowest = 6.6dB/sec falloff at update rate of 40ms
387 Slow = 6.8dB/sec falloff at update rate of 40ms
392 MeterFalloffSlowest = 1,
393 MeterFalloffSlow = 2,
394 MeterFalloffSlowish = 3,
395 MeterFalloffModerate = 4,
396 MeterFalloffMedium = 5,
397 MeterFalloffFast = 6,
398 MeterFalloffFaster = 7,
399 MeterFalloffFastest = 8,
405 MeterHoldMedium = 100,
416 enum RegionSelectionAfterSplit {
418 NewlyCreatedLeft = 1, // bit 0
419 NewlyCreatedRight = 2, // bit 1
420 NewlyCreatedBoth = 3,
421 Existing = 4, // bit 2
422 ExistingNewlyCreatedLeft = 5,
423 ExistingNewlyCreatedRight = 6,
424 ExistingNewlyCreatedBoth = 7
439 HardwareMonitoring, ///< JACK does monitoring
440 SoftwareMonitoring, ///< Ardour does monitoring
441 ExternalMonitoring ///< we leave monitoring to the audio hardware
452 MonitoringSilence = 0x1,
453 MonitoringInput = 0x2,
454 MonitoringDisk = 0x4,
458 MeteringInput, ///< meter the input IO, regardless of what is going through the route
459 MeteringRoute ///< meter what is going through the route
462 enum VUMeterStandard {
463 MeteringVUfrench, // 0VU = -2dBu
464 MeteringVUamerican, // 0VU = 0dBu
465 MeteringVUstandard, // 0VU = +4dBu
466 MeteringVUeight // 0VU = +8dBu
477 /** PFL signals come from before pre-fader processors */
478 PFLFromBeforeProcessors,
479 /** PFL signals come pre-fader but after pre-fader processors */
480 PFLFromAfterProcessors
484 /** AFL signals come post-fader and before post-fader processors */
485 AFLFromBeforeProcessors,
486 /** AFL signals come post-fader but after post-fader processors */
487 AFLFromAfterProcessors
502 enum ListenPosition {
507 enum AutoConnectOption {
509 AutoConnectPhysical = 0x1,
510 AutoConnectMaster = 0x2
513 enum TracksAutoNamingRule {
514 UseDefaultNames = 0x1,
515 NameAfterDriver = 0x2
524 int format_data_width (ARDOUR::SampleFormat);
526 enum CDMarkerFormat {
546 typedef Sample PeakDatum;
559 /* These are "synonyms". It is important for JACK to be first
560 both here and in enums.cc, so that the string "JACK" is
561 correctly recognized in older session and preference files.
570 enum ShuttleBehaviour {
580 typedef std::vector<boost::shared_ptr<Source> > SourceList;
590 typedef std::list<framepos_t> AnalysisFeatureList;
592 typedef std::list<boost::shared_ptr<Route> > RouteList;
593 typedef std::list<boost::shared_ptr<Stripable> > StripableList;
594 typedef std::list<boost::weak_ptr <Route> > WeakRouteList;
595 typedef std::list<boost::weak_ptr <Stripable> > WeakStripableList;
596 typedef std::list<boost::shared_ptr<AutomationControl> > ControlList;
598 typedef std::list<boost::shared_ptr<VCA> > VCAList;
601 typedef std::vector<boost::shared_ptr<Bundle> > BundleList;
613 struct CleanupReport {
614 std::vector<std::string> paths;
618 enum PositionLockStyle {
623 /** A struct used to describe changes to processors in a route.
624 * This is useful because objects that respond to a change in processors
625 * can optimise what work they do based on details of what has changed.
627 struct RouteProcessorChange {
630 MeterPointChange = 0x1,
634 RouteProcessorChange () : type (GeneralChange), meter_visibly_changed (true)
637 RouteProcessorChange (Type t) : type (t), meter_visibly_changed (true)
640 RouteProcessorChange (Type t, bool m) : type (t), meter_visibly_changed (m)
643 /** type of change; "GeneralChange" means anything could have changed */
645 /** true if, when a MeterPointChange has occurred, the change is visible to the user */
646 bool meter_visibly_changed;
650 AutoConnectOption input_ac; /* override the RC config for input auto-connection */
651 AutoConnectOption output_ac; /* override the RC config for output auto-connection */
652 uint32_t master_out_channels; /* how many channels for the master bus */
653 uint32_t requested_physical_in; /* now many of the available physical inputs to consider usable */
654 uint32_t requested_physical_out; /* now many of the available physical inputs to consider usable */
665 enum TransportState {
666 /* these values happen to match the constants used by JACK but
667 this equality cannot be assumed.
669 TransportStopped = 0,
670 TransportRolling = 1,
671 TransportLooping = 2,
672 TransportStarting = 3,
676 /* these values happen to match the constants used by JACK but
677 this equality cannot be assumed.
685 /* non-JACK related flags */
692 MidiPortControl = 0x2,
693 MidiPortSelection = 0x4,
694 MidiPortVirtual = 0x8
697 struct LatencyRange {
698 uint32_t min; //< samples
699 uint32_t max; //< samples
702 enum BufferingPreset {
709 enum AutoReturnTarget {
711 RangeSelectionStart = 0x2,
713 RegionSelectionStart = 0x8,
716 enum PlaylistDisposition {
722 enum MidiTrackNameSource {
728 enum MidiTempoMapDisposition {
733 } // namespace ARDOUR
735 static inline ARDOUR::framepos_t
736 session_frame_to_track_frame (ARDOUR::framepos_t session_frame, double speed)
738 long double result = (long double) session_frame * (long double) speed;
740 if (result >= (long double) ARDOUR::max_framepos) {
741 return ARDOUR::max_framepos;
742 } else if (result <= (long double) (ARDOUR::max_framepos) * (ARDOUR::framepos_t)(-1)) {
743 return (ARDOUR::max_framepos * (ARDOUR::framepos_t)(-1));
749 static inline ARDOUR::framepos_t
750 track_frame_to_session_frame (ARDOUR::framepos_t track_frame, double speed)
752 /* NB - do we need a check for speed == 0 ??? */
753 long double result = (long double) track_frame / (long double) speed;
755 if (result >= (long double) ARDOUR::max_framepos) {
756 return ARDOUR::max_framepos;
757 } else if (result <= (long double) (ARDOUR::max_framepos) * (ARDOUR::framepos_t)(-1)) {
758 return (ARDOUR::max_framepos * (ARDOUR::framepos_t)(-1));
764 /* for now, break the rules and use "using" to make this "global" */
766 using ARDOUR::framepos_t;
769 #endif /* __ardour_types_h__ */