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__
27 #include <boost/shared_ptr.hpp>
28 #include <sys/types.h>
34 #include "temporal/bbt_time.h"
35 #include "temporal/time.h"
36 #include "temporal/types.h"
40 #include "evoral/Range.hpp"
42 #include "ardour/chan_count.h"
43 #include "ardour/plugin_types.h"
47 using Temporal::max_samplepos;
48 using Temporal::max_samplecnt;
62 class AutomationControl;
63 class SlavableAutomationControl;
68 typedef uint32_t layer_t;
69 typedef uint64_t microseconds_t;
70 typedef uint32_t pframes_t;
72 /* rebind Temporal position types into ARDOUR namespace */
73 typedef Temporal::samplecnt_t samplecnt_t;
74 typedef Temporal::samplepos_t samplepos_t;
75 typedef Temporal::sampleoffset_t sampleoffset_t;
77 static const layer_t max_layer = UINT32_MAX;
79 // a set of (time) intervals: first of pair is the offset of the start within the region, second is the offset of the end
80 typedef std::list<std::pair<sampleoffset_t, sampleoffset_t> > AudioIntervalResult;
81 // associate a set of intervals with regions (e.g. for silence detection)
82 typedef std::map<boost::shared_ptr<ARDOUR::Region>,AudioIntervalResult> AudioIntervalMap;
84 typedef std::list<boost::shared_ptr<Region> > RegionList;
90 ConfigurationChanged = 0x1,
91 ConnectionsChanged = 0x2
94 IOChange () : type (NoChange) {}
95 IOChange (Type t) : type (t) {}
97 /** channel count of IO before a ConfigurationChanged, if appropriate */
98 ARDOUR::ChanCount before;
99 /** channel count of IO after a ConfigurationChanged, if appropriate */
100 ARDOUR::ChanCount after;
103 /* policies for inserting/pasting material where overlaps
107 enum InsertMergePolicy {
108 InsertMergeReject, ///< no overlaps allowed
109 InsertMergeRelax, ///< we just don't care about overlaps
110 InsertMergeReplace, ///< replace old with new
111 InsertMergeTruncateExisting, ///< shorten existing to avoid overlap
112 InsertMergeTruncateAddition, ///< shorten new to avoid overlap
113 InsertMergeExtend ///< extend new (or old) to the range of old+new
116 /** See evoral/Parameter.hpp
118 * When you add things here, you REALLY SHOULD add a case clause to
119 * the constructor of ParameterDescriptor, unless the Controllables
120 * that the enum refers to are completely standard (0-1.0 range, 0.0 as
121 * normal, non-toggled, non-enumerated). Anything else needs to be
122 * added there so that things that try to represent them can do so
123 * with as much information as possible.
125 enum AutomationType {
128 PanAzimuthAutomation,
129 PanElevationAutomation,
131 PanFrontBackAutomation,
134 PluginPropertyAutomation,
136 SoloIsolateAutomation,
140 MidiPgmChangeAutomation,
141 MidiPitchBenderAutomation,
142 MidiChannelPressureAutomation,
143 MidiNotePressureAutomation,
144 MidiSystemExclusiveAutomation,
152 MonitoringAutomation,
165 std::string auto_state_to_string (AutoState);
166 AutoState string_to_auto_state (std::string);
188 DiskIOPreFader, /* after the trim control, but before other processors */
189 DiskIOPostFader, /* before the main outs, after other processors */
190 DiskIOCustom, /* up to the user. Caveat Emptor! */
194 MeterMaxSignal = 0x0001,
195 MeterMaxPeak = 0x0002,
200 MeterIEC1DIN = 0x0040,
201 MeterIEC1NOR = 0x0080,
202 MeterIEC2BBC = 0x0100,
203 MeterIEC2EBU = 0x0200,
206 MeterPeak0dB = 0x1000,
222 AllChannels = 0, ///< Pass through all channel information unmodified
223 FilterChannels, ///< Ignore events on certain channels
224 ForceChannel ///< Force all events to a certain channel
234 RoundDownMaybe = -2, ///< Round down only if necessary
235 RoundDownAlways = -1, ///< Always round down, even if on a division
236 RoundNearest = 0, ///< Round to nearest
237 RoundUpAlways = 1, ///< Always round up, even if on a division
238 RoundUpMaybe = 2 ///< Round up only if necessary
252 Timecode::Time timecode;
253 Timecode::BBT_Time bbt;
260 AnyTime() { type = Samples; samples = 0; }
262 bool operator== (AnyTime const & other) const {
263 if (type != other.type) { return false; }
267 return timecode == other.timecode;
269 return bbt == other.bbt;
271 return samples == other.samples;
273 return seconds == other.seconds;
275 return false; // get rid of warning
278 bool not_zero() const
282 return timecode.hours != 0 || timecode.minutes != 0 ||
283 timecode.seconds != 0 || timecode.frames != 0;
285 return bbt.bars != 0 || bbt.beats != 0 || bbt.ticks != 0;
292 abort(); /* NOTREACHED */
297 /* used for translating audio samples to an exact musical position using a note divisor.
298 an exact musical position almost never falls exactly on an audio sample, but for sub-sample
299 musical accuracy we need to derive exact musical locations from a sample position
300 the division follows TempoMap::exact_beat_at_sample().
302 -1 musical location is the bar closest to sample
303 0 musical location is the musical position of the sample
304 1 musical location is the BBT beat closest to sample
305 n musical location is the quarter-note division n closest to sample
311 MusicSample (samplepos_t f, int32_t d) : sample (f), division (d) {}
313 void set (samplepos_t f, int32_t d) {sample = f; division = d; }
315 MusicSample operator- (MusicSample other) { return MusicSample (sample - other.sample, 0); }
318 /* XXX: slightly unfortunate that there is this and Evoral::Range<>,
319 but this has a uint32_t id which Evoral::Range<> does not.
326 AudioRange (samplepos_t s, samplepos_t e, uint32_t i) : start (s), end (e) , id (i) {}
328 samplecnt_t length() const { return end - start + 1; }
330 bool operator== (const AudioRange& other) const {
331 return start == other.start && end == other.end && id == other.id;
334 bool equal (const AudioRange& other) const {
335 return start == other.start && end == other.end;
338 Evoral::OverlapType coverage (samplepos_t s, samplepos_t e) const {
339 return Evoral::coverage (start, end, s, e);
344 Timecode::BBT_Time start;
345 Timecode::BBT_Time end;
348 MusicRange (Timecode::BBT_Time& s, Timecode::BBT_Time& e, uint32_t i)
349 : start (s), end (e), id (i) {}
351 bool operator== (const MusicRange& other) const {
352 return start == other.start && end == other.end && id == other.id;
355 bool equal (const MusicRange& other) const {
356 return start == other.start && end == other.end;
361 Slowest = 6.6dB/sec falloff at update rate of 40ms
362 Slow = 6.8dB/sec falloff at update rate of 40ms
367 MeterFalloffSlowest = 1,
368 MeterFalloffSlow = 2,
369 MeterFalloffSlowish = 3,
370 MeterFalloffModerate = 4,
371 MeterFalloffMedium = 5,
372 MeterFalloffFast = 6,
373 MeterFalloffFaster = 7,
374 MeterFalloffFastest = 8,
380 MeterHoldMedium = 100,
391 enum RegionSelectionAfterSplit {
393 NewlyCreatedLeft = 1, // bit 0
394 NewlyCreatedRight = 2, // bit 1
395 NewlyCreatedBoth = 3,
396 Existing = 4, // bit 2
397 ExistingNewlyCreatedLeft = 5,
398 ExistingNewlyCreatedRight = 6,
399 ExistingNewlyCreatedBoth = 7
414 HardwareMonitoring, ///< JACK does monitoring
415 SoftwareMonitoring, ///< Ardour does monitoring
416 ExternalMonitoring ///< we leave monitoring to the audio hardware
427 MonitoringSilence = 0x1,
428 MonitoringInput = 0x2,
429 MonitoringDisk = 0x4,
433 MeteringInput, ///< meter the input IO, regardless of what is going through the route
434 MeteringRoute ///< meter what is going through the route
437 enum VUMeterStandard {
438 MeteringVUfrench, // 0VU = -2dBu
439 MeteringVUamerican, // 0VU = 0dBu
440 MeteringVUstandard, // 0VU = +4dBu
441 MeteringVUeight // 0VU = +8dBu
452 /** PFL signals come from before pre-fader processors */
453 PFLFromBeforeProcessors,
454 /** PFL signals come pre-fader but after pre-fader processors */
455 PFLFromAfterProcessors
459 /** AFL signals come post-fader and before post-fader processors */
460 AFLFromBeforeProcessors,
461 /** AFL signals come post-fader but after post-fader processors */
462 AFLFromAfterProcessors
477 enum ListenPosition {
482 enum AutoConnectOption {
484 AutoConnectPhysical = 0x1,
485 AutoConnectMaster = 0x2
488 enum TracksAutoNamingRule {
489 UseDefaultNames = 0x1,
490 NameAfterDriver = 0x2
499 int format_data_width (ARDOUR::SampleFormat);
501 enum CDMarkerFormat {
521 typedef Sample PeakDatum;
534 /* These are "synonyms". It is important for JACK to be first
535 both here and in enums.cc, so that the string "JACK" is
536 correctly recognized in older session and preference files.
545 enum ShuttleBehaviour {
555 typedef std::vector<boost::shared_ptr<Source> > SourceList;
565 typedef std::list<samplepos_t> AnalysisFeatureList;
567 typedef std::list<boost::shared_ptr<Route> > RouteList;
568 typedef std::list<boost::shared_ptr<Stripable> > StripableList;
569 typedef std::list<boost::weak_ptr <Route> > WeakRouteList;
570 typedef std::list<boost::weak_ptr <Stripable> > WeakStripableList;
571 typedef std::list<boost::shared_ptr<AutomationControl> > ControlList;
572 typedef std::list<boost::shared_ptr<SlavableAutomationControl> > SlavableControlList;
573 typedef std::set <boost::shared_ptr<AutomationControl> > AutomationControlSet;
575 typedef std::list<boost::shared_ptr<VCA> > VCAList;
578 typedef std::vector<boost::shared_ptr<Bundle> > BundleList;
590 struct CleanupReport {
591 std::vector<std::string> paths;
595 enum PositionLockStyle {
600 /** A struct used to describe changes to processors in a route.
601 * This is useful because objects that respond to a change in processors
602 * can optimise what work they do based on details of what has changed.
604 struct RouteProcessorChange {
607 MeterPointChange = 0x1,
611 RouteProcessorChange () : type (GeneralChange), meter_visibly_changed (true)
614 RouteProcessorChange (Type t) : type (t), meter_visibly_changed (true)
617 RouteProcessorChange (Type t, bool m) : type (t), meter_visibly_changed (m)
620 /** type of change; "GeneralChange" means anything could have changed */
622 /** true if, when a MeterPointChange has occurred, the change is visible to the user */
623 bool meter_visibly_changed;
627 uint32_t master_out_channels; /* how many channels for the master bus, 0: no master bus */
638 enum TransportState {
639 /* these values happen to match the constants used by JACK but
640 this equality cannot be assumed.
642 TransportStopped = 0,
643 TransportRolling = 1,
644 TransportLooping = 2,
645 TransportStarting = 3,
649 /* these values happen to match the constants used by JACK but
650 this equality cannot be assumed.
658 /* non-JACK related flags */
665 MidiPortControl = 0x2,
666 MidiPortSelection = 0x4,
667 MidiPortVirtual = 0x8
670 struct LatencyRange {
671 uint32_t min; //< samples
672 uint32_t max; //< samples
675 enum BufferingPreset {
682 enum AutoReturnTarget {
684 RangeSelectionStart = 0x2,
686 RegionSelectionStart = 0x8,
689 enum PlaylistDisposition {
695 enum MidiTrackNameSource {
701 enum MidiTempoMapDisposition {
711 typedef std::vector<CaptureInfo*> CaptureInfos;
713 } // namespace ARDOUR
715 /* for now, break the rules and use "using" to make this "global" */
717 using ARDOUR::samplepos_t;
719 #endif /* __ardour_types_h__ */