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"
59 typedef uint32_t layer_t;
60 typedef uint64_t microseconds_t;
61 typedef uint32_t pframes_t;
63 /* Any position measured in audio frames.
64 Assumed to be non-negative but not enforced.
66 typedef int64_t framepos_t;
68 /* Any distance from a given framepos_t.
69 Maybe positive or negative.
71 typedef int64_t frameoffset_t;
73 /* Any count of audio frames.
74 Assumed to be positive but not enforced.
76 typedef int64_t framecnt_t;
78 static const framepos_t max_framepos = INT64_MAX;
79 static const framecnt_t max_framecnt = INT64_MAX;
80 static const layer_t max_layer = UINT32_MAX;
82 // a set of (time) intervals: first of pair is the offset of the start within the region, second is the offset of the end
83 typedef std::list<std::pair<frameoffset_t, frameoffset_t> > AudioIntervalResult;
84 // associate a set of intervals with regions (e.g. for silence detection)
85 typedef std::map<boost::shared_ptr<ARDOUR::Region>,AudioIntervalResult> AudioIntervalMap;
87 typedef std::list<boost::shared_ptr<Region> > RegionList;
93 ConfigurationChanged = 0x1,
94 ConnectionsChanged = 0x2
97 IOChange () : type (NoChange) {}
98 IOChange (Type t) : type (t) {}
100 /** channel count of IO before a ConfigurationChanged, if appropriate */
101 ARDOUR::ChanCount before;
102 /** channel count of IO after a ConfigurationChanged, if appropriate */
103 ARDOUR::ChanCount after;
106 /* policies for inserting/pasting material where overlaps
110 enum InsertMergePolicy {
111 InsertMergeReject, // no overlaps allowed
112 InsertMergeRelax, // we just don't care about overlaps
113 InsertMergeReplace, // replace old with new
114 InsertMergeTruncateExisting, // shorten existing to avoid overlap
115 InsertMergeTruncateAddition, // shorten new to avoid overlap
116 InsertMergeExtend // extend new (or old) to the range of old+new
119 /** See evoral/Parameter.hpp
121 enum AutomationType {
124 PanAzimuthAutomation,
125 PanElevationAutomation,
127 PanFrontBackAutomation,
130 PluginPropertyAutomation,
134 MidiPgmChangeAutomation,
135 MidiPitchBenderAutomation,
136 MidiChannelPressureAutomation,
137 MidiSystemExclusiveAutomation,
167 std::string auto_state_to_string (AutoState);
168 AutoState string_to_auto_state (std::string);
175 std::string auto_style_to_string (AutoStyle);
176 AutoStyle string_to_auto_style (std::string);
198 MeterMaxSignal = 0x0001,
199 MeterMaxPeak = 0x0002,
204 MeterIEC1DIN = 0x0040,
205 MeterIEC1NOR = 0x0080,
206 MeterIEC2BBC = 0x0100,
207 MeterIEC2EBU = 0x0200,
210 MeterPeak0dB = 0x1000,
226 AllChannels = 0, ///< Pass through all channel information unmodified
227 FilterChannels, ///< Ignore events on certain channels
228 ForceChannel ///< Force all events to a certain channel
238 RoundDownMaybe = -2, ///< Round down only if necessary
239 RoundDownAlways = -1, ///< Always round down, even if on a division
240 RoundNearest = 0, ///< Round to nearest
241 RoundUpAlways = 1, ///< Always round up, even if on a division
242 RoundUpMaybe = 2 ///< Round up only if necessary
256 Timecode::Time timecode;
257 Timecode::BBT_Time bbt;
264 AnyTime() { type = Frames; frames = 0; }
266 bool operator== (AnyTime const & other) const {
267 if (type != other.type) { return false; }
271 return timecode == other.timecode;
273 return bbt == other.bbt;
275 return frames == other.frames;
277 return seconds == other.seconds;
279 return false; // get rid of warning
282 bool not_zero() const
286 return timecode.hours != 0 || timecode.minutes != 0 ||
287 timecode.seconds != 0 || timecode.frames != 0;
289 return bbt.bars != 0 || bbt.beats != 0 || bbt.ticks != 0;
296 abort(); /* NOTREACHED */
301 /* XXX: slightly unfortunate that there is this and Evoral::Range<>,
302 but this has a uint32_t id which Evoral::Range<> does not.
309 AudioRange (framepos_t s, framepos_t e, uint32_t i) : start (s), end (e) , id (i) {}
311 framecnt_t length() { return end - start + 1; }
313 bool operator== (const AudioRange& other) const {
314 return start == other.start && end == other.end && id == other.id;
317 bool equal (const AudioRange& other) const {
318 return start == other.start && end == other.end;
321 Evoral::OverlapType coverage (framepos_t s, framepos_t e) const {
322 return Evoral::coverage (start, end, s, e);
327 Timecode::BBT_Time start;
328 Timecode::BBT_Time end;
331 MusicRange (Timecode::BBT_Time& s, Timecode::BBT_Time& e, uint32_t i)
332 : start (s), end (e), id (i) {}
334 bool operator== (const MusicRange& other) const {
335 return start == other.start && end == other.end && id == other.id;
338 bool equal (const MusicRange& other) const {
339 return start == other.start && end == other.end;
344 Slowest = 6.6dB/sec falloff at update rate of 40ms
345 Slow = 6.8dB/sec falloff at update rate of 40ms
350 MeterFalloffSlowest = 1,
351 MeterFalloffSlow = 2,
352 MeterFalloffSlowish = 3,
353 MeterFalloffModerate = 4,
354 MeterFalloffMedium = 5,
355 MeterFalloffFast = 6,
356 MeterFalloffFaster = 7,
357 MeterFalloffFastest = 8,
363 MeterHoldMedium = 100,
374 enum RegionSelectionAfterSplit {
376 NewlyCreatedLeft = 1, // bit 0
377 NewlyCreatedRight = 2, // bit 1
378 NewlyCreatedBoth = 3,
379 Existing = 4, // bit 2
380 ExistingNewlyCreatedLeft = 5,
381 ExistingNewlyCreatedRight = 6,
382 ExistingNewlyCreatedBoth = 7
397 HardwareMonitoring, ///< JACK does monitoring
398 SoftwareMonitoring, ///< Ardour does monitoring
399 ExternalMonitoring ///< we leave monitoring to the audio hardware
410 MonitoringSilence = 0x1,
411 MonitoringInput = 0x2,
412 MonitoringDisk = 0x4,
416 MeteringInput, ///< meter the input IO, regardless of what is going through the route
417 MeteringRoute ///< meter what is going through the route
420 enum VUMeterStandard {
421 MeteringVUfrench, // 0VU = -2dBu
422 MeteringVUamerican, // 0VU = 0dBu
423 MeteringVUstandard, // 0VU = +4dBu
424 MeteringVUeight // 0VU = +8dBu
435 /** PFL signals come from before pre-fader processors */
436 PFLFromBeforeProcessors,
437 /** PFL signals come pre-fader but after pre-fader processors */
438 PFLFromAfterProcessors
442 /** AFL signals come post-fader and before post-fader processors */
443 AFLFromBeforeProcessors,
444 /** AFL signals come post-fader but after post-fader processors */
445 AFLFromAfterProcessors
465 enum ListenPosition {
470 enum AutoConnectOption {
472 AutoConnectPhysical = 0x1,
473 AutoConnectMaster = 0x2
476 enum TracksAutoNamingRule {
477 UseDefaultNames = 0x1,
478 NameAfterDriver = 0x2
487 int format_data_width (ARDOUR::SampleFormat);
489 enum CDMarkerFormat {
509 typedef Sample PeakDatum;
522 /* These are "synonyms". It is important for JACK to be first
523 both here and in enums.cc, so that the string "JACK" is
524 correctly recognized in older session and preference files.
533 enum ShuttleBehaviour {
543 typedef std::vector<boost::shared_ptr<Source> > SourceList;
553 typedef std::list<framepos_t> AnalysisFeatureList;
555 typedef std::list<boost::shared_ptr<Route> > RouteList;
556 typedef std::list<boost::weak_ptr <Route> > WeakRouteList;
559 typedef std::vector<boost::shared_ptr<Bundle> > BundleList;
571 struct CleanupReport {
572 std::vector<std::string> paths;
576 enum PositionLockStyle {
581 /** A struct used to describe changes to processors in a route.
582 * This is useful because objects that respond to a change in processors
583 * can optimise what work they do based on details of what has changed.
585 struct RouteProcessorChange {
588 MeterPointChange = 0x1,
592 RouteProcessorChange () : type (GeneralChange), meter_visibly_changed (true)
595 RouteProcessorChange (Type t) : type (t), meter_visibly_changed (true)
598 RouteProcessorChange (Type t, bool m) : type (t), meter_visibly_changed (m)
601 /** type of change; "GeneralChange" means anything could have changed */
603 /** true if, when a MeterPointChange has occurred, the change is visible to the user */
604 bool meter_visibly_changed;
608 AutoConnectOption input_ac; /* override the RC config for input auto-connection */
609 AutoConnectOption output_ac; /* override the RC config for output auto-connection */
610 uint32_t master_out_channels; /* how many channels for the master bus */
611 uint32_t requested_physical_in; /* now many of the available physical inputs to consider usable */
612 uint32_t requested_physical_out; /* now many of the available physical inputs to consider usable */
623 enum TransportState {
624 /* these values happen to match the constants used by JACK but
625 this equality cannot be assumed.
627 TransportStopped = 0,
628 TransportRolling = 1,
629 TransportLooping = 2,
630 TransportStarting = 3,
634 /* these values happen to match the constants used by JACK but
635 this equality cannot be assumed.
644 struct LatencyRange {
645 uint32_t min; //< samples
646 uint32_t max; //< samples
649 enum BufferingPreset {
656 enum AutoReturnTarget {
658 RangeSelectionStart = 0x2,
660 RegionSelectionStart = 0x8,
663 enum PlaylistDisposition {
669 } // namespace ARDOUR
672 /* these cover types declared above in this header. See enums.cc
675 std::istream& operator>>(std::istream& o, ARDOUR::SampleFormat& sf);
676 std::istream& operator>>(std::istream& o, ARDOUR::HeaderFormat& sf);
677 std::istream& operator>>(std::istream& o, ARDOUR::AutoConnectOption& sf);
678 std::istream& operator>>(std::istream& o, ARDOUR::TracksAutoNamingRule& sf);
679 std::istream& operator>>(std::istream& o, ARDOUR::EditMode& sf);
680 std::istream& operator>>(std::istream& o, ARDOUR::MonitorModel& sf);
681 std::istream& operator>>(std::istream& o, ARDOUR::PFLPosition& sf);
682 std::istream& operator>>(std::istream& o, ARDOUR::AFLPosition& sf);
683 std::istream& operator>>(std::istream& o, ARDOUR::RemoteModel& sf);
684 std::istream& operator>>(std::istream& o, ARDOUR::ListenPosition& sf);
685 std::istream& operator>>(std::istream& o, ARDOUR::LayerModel& sf);
686 std::istream& operator>>(std::istream& o, ARDOUR::InsertMergePolicy& sf);
687 std::istream& operator>>(std::istream& o, ARDOUR::SyncSource& sf);
688 std::istream& operator>>(std::istream& o, ARDOUR::ShuttleBehaviour& sf);
689 std::istream& operator>>(std::istream& o, ARDOUR::ShuttleUnits& sf);
690 std::istream& operator>>(std::istream& o, Timecode::TimecodeFormat& sf);
691 std::istream& operator>>(std::istream& o, ARDOUR::DenormalModel& sf);
692 std::istream& operator>>(std::istream& o, ARDOUR::PositionLockStyle& sf);
693 std::istream& operator>>(std::istream& o, ARDOUR::FadeShape& sf);
694 std::istream& operator>>(std::istream& o, ARDOUR::RegionSelectionAfterSplit& sf);
695 std::istream& operator>>(std::istream& o, ARDOUR::BufferingPreset& var);
696 std::istream& operator>>(std::istream& o, ARDOUR::AutoReturnTarget& sf);
697 std::istream& operator>>(std::istream& o, ARDOUR::MeterType& sf);
699 std::ostream& operator<<(std::ostream& o, const ARDOUR::SampleFormat& sf);
700 std::ostream& operator<<(std::ostream& o, const ARDOUR::HeaderFormat& sf);
701 std::ostream& operator<<(std::ostream& o, const ARDOUR::AutoConnectOption& sf);
702 std::ostream& operator<<(std::ostream& o, const ARDOUR::TracksAutoNamingRule& sf);
703 std::ostream& operator<<(std::ostream& o, const ARDOUR::EditMode& sf);
704 std::ostream& operator<<(std::ostream& o, const ARDOUR::MonitorModel& sf);
705 std::ostream& operator<<(std::ostream& o, const ARDOUR::PFLPosition& sf);
706 std::ostream& operator<<(std::ostream& o, const ARDOUR::AFLPosition& sf);
707 std::ostream& operator<<(std::ostream& o, const ARDOUR::RemoteModel& sf);
708 std::ostream& operator<<(std::ostream& o, const ARDOUR::ListenPosition& sf);
709 std::ostream& operator<<(std::ostream& o, const ARDOUR::LayerModel& sf);
710 std::ostream& operator<<(std::ostream& o, const ARDOUR::InsertMergePolicy& sf);
711 std::ostream& operator<<(std::ostream& o, const ARDOUR::SyncSource& sf);
712 std::ostream& operator<<(std::ostream& o, const ARDOUR::ShuttleBehaviour& sf);
713 std::ostream& operator<<(std::ostream& o, const ARDOUR::ShuttleUnits& sf);
714 std::ostream& operator<<(std::ostream& o, const Timecode::TimecodeFormat& sf);
715 std::ostream& operator<<(std::ostream& o, const ARDOUR::DenormalModel& sf);
716 std::ostream& operator<<(std::ostream& o, const ARDOUR::PositionLockStyle& sf);
717 std::ostream& operator<<(std::ostream& o, const ARDOUR::FadeShape& sf);
718 std::ostream& operator<<(std::ostream& o, const ARDOUR::RegionSelectionAfterSplit& sf);
719 std::ostream& operator<<(std::ostream& o, const ARDOUR::BufferingPreset& var);
720 std::ostream& operator<<(std::ostream& o, const ARDOUR::AutoReturnTarget& sf);
721 std::ostream& operator<<(std::ostream& o, const ARDOUR::MeterType& sf);
723 /* because these operators work on types which can be used when making
724 a UI_CONFIG_VARIABLE (in gtk2_ardour) we need them to be exported.
726 LIBARDOUR_API std::istream& operator>>(std::istream& o, ARDOUR::WaveformScale& sf);
727 LIBARDOUR_API std::istream& operator>>(std::istream& o, ARDOUR::WaveformShape& sf);
728 LIBARDOUR_API std::istream& operator>>(std::istream& o, ARDOUR::VUMeterStandard& sf);
729 LIBARDOUR_API std::istream& operator>>(std::istream& o, ARDOUR::MeterLineUp& sf);
731 LIBARDOUR_API std::ostream& operator<<(std::ostream& o, const ARDOUR::WaveformScale& sf);
732 LIBARDOUR_API std::ostream& operator<<(std::ostream& o, const ARDOUR::WaveformShape& sf);
733 LIBARDOUR_API std::ostream& operator<<(std::ostream& o, const ARDOUR::VUMeterStandard& sf);
734 LIBARDOUR_API std::ostream& operator<<(std::ostream& o, const ARDOUR::MeterLineUp& sf);
737 static inline ARDOUR::framepos_t
738 session_frame_to_track_frame (ARDOUR::framepos_t session_frame, double speed)
740 long double result = (long double) session_frame * (long double) speed;
742 if (result >= (long double) ARDOUR::max_framepos) {
743 return ARDOUR::max_framepos;
744 } else if (result <= (long double) (ARDOUR::max_framepos) * (ARDOUR::framepos_t)(-1)) {
745 return (ARDOUR::max_framepos * (ARDOUR::framepos_t)(-1));
751 static inline ARDOUR::framepos_t
752 track_frame_to_session_frame (ARDOUR::framepos_t track_frame, double speed)
754 /* NB - do we need a check for speed == 0 ??? */
755 long double result = (long double) track_frame / (long double) speed;
757 if (result >= (long double) ARDOUR::max_framepos) {
758 return ARDOUR::max_framepos;
759 } else if (result <= (long double) (ARDOUR::max_framepos) * (ARDOUR::framepos_t)(-1)) {
760 return (ARDOUR::max_framepos * (ARDOUR::framepos_t)(-1));
766 /* for now, break the rules and use "using" to make this "global" */
768 using ARDOUR::framepos_t;
771 #endif /* __ardour_types_h__ */