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,
197 std::string auto_state_to_string (AutoState);
198 AutoState string_to_auto_state (std::string);
205 std::string auto_style_to_string (AutoStyle);
206 AutoStyle string_to_auto_style (std::string);
228 MeterMaxSignal = 0x0001,
229 MeterMaxPeak = 0x0002,
234 MeterIEC1DIN = 0x0040,
235 MeterIEC1NOR = 0x0080,
236 MeterIEC2BBC = 0x0100,
237 MeterIEC2EBU = 0x0200,
240 MeterPeak0dB = 0x1000,
256 AllChannels = 0, ///< Pass through all channel information unmodified
257 FilterChannels, ///< Ignore events on certain channels
258 ForceChannel ///< Force all events to a certain channel
268 RoundDownMaybe = -2, ///< Round down only if necessary
269 RoundDownAlways = -1, ///< Always round down, even if on a division
270 RoundNearest = 0, ///< Round to nearest
271 RoundUpAlways = 1, ///< Always round up, even if on a division
272 RoundUpMaybe = 2 ///< Round up only if necessary
286 Timecode::Time timecode;
287 Timecode::BBT_Time bbt;
294 AnyTime() { type = Frames; frames = 0; }
296 bool operator== (AnyTime const & other) const {
297 if (type != other.type) { return false; }
301 return timecode == other.timecode;
303 return bbt == other.bbt;
305 return frames == other.frames;
307 return seconds == other.seconds;
309 return false; // get rid of warning
312 bool not_zero() const
316 return timecode.hours != 0 || timecode.minutes != 0 ||
317 timecode.seconds != 0 || timecode.frames != 0;
319 return bbt.bars != 0 || bbt.beats != 0 || bbt.ticks != 0;
326 abort(); /* NOTREACHED */
331 /* XXX: slightly unfortunate that there is this and Evoral::Range<>,
332 but this has a uint32_t id which Evoral::Range<> does not.
339 AudioRange (framepos_t s, framepos_t e, uint32_t i) : start (s), end (e) , id (i) {}
341 framecnt_t length() { return end - start + 1; }
343 bool operator== (const AudioRange& other) const {
344 return start == other.start && end == other.end && id == other.id;
347 bool equal (const AudioRange& other) const {
348 return start == other.start && end == other.end;
351 Evoral::OverlapType coverage (framepos_t s, framepos_t e) const {
352 return Evoral::coverage (start, end, s, e);
357 Timecode::BBT_Time start;
358 Timecode::BBT_Time end;
361 MusicRange (Timecode::BBT_Time& s, Timecode::BBT_Time& e, uint32_t i)
362 : start (s), end (e), id (i) {}
364 bool operator== (const MusicRange& other) const {
365 return start == other.start && end == other.end && id == other.id;
368 bool equal (const MusicRange& other) const {
369 return start == other.start && end == other.end;
374 Slowest = 6.6dB/sec falloff at update rate of 40ms
375 Slow = 6.8dB/sec falloff at update rate of 40ms
380 MeterFalloffSlowest = 1,
381 MeterFalloffSlow = 2,
382 MeterFalloffSlowish = 3,
383 MeterFalloffModerate = 4,
384 MeterFalloffMedium = 5,
385 MeterFalloffFast = 6,
386 MeterFalloffFaster = 7,
387 MeterFalloffFastest = 8,
393 MeterHoldMedium = 100,
404 enum RegionSelectionAfterSplit {
406 NewlyCreatedLeft = 1, // bit 0
407 NewlyCreatedRight = 2, // bit 1
408 NewlyCreatedBoth = 3,
409 Existing = 4, // bit 2
410 ExistingNewlyCreatedLeft = 5,
411 ExistingNewlyCreatedRight = 6,
412 ExistingNewlyCreatedBoth = 7
427 HardwareMonitoring, ///< JACK does monitoring
428 SoftwareMonitoring, ///< Ardour does monitoring
429 ExternalMonitoring ///< we leave monitoring to the audio hardware
440 MonitoringSilence = 0x1,
441 MonitoringInput = 0x2,
442 MonitoringDisk = 0x4,
446 MeteringInput, ///< meter the input IO, regardless of what is going through the route
447 MeteringRoute ///< meter what is going through the route
450 enum VUMeterStandard {
451 MeteringVUfrench, // 0VU = -2dBu
452 MeteringVUamerican, // 0VU = 0dBu
453 MeteringVUstandard, // 0VU = +4dBu
454 MeteringVUeight // 0VU = +8dBu
465 /** PFL signals come from before pre-fader processors */
466 PFLFromBeforeProcessors,
467 /** PFL signals come pre-fader but after pre-fader processors */
468 PFLFromAfterProcessors
472 /** AFL signals come post-fader and before post-fader processors */
473 AFLFromBeforeProcessors,
474 /** AFL signals come post-fader but after post-fader processors */
475 AFLFromAfterProcessors
495 enum ListenPosition {
500 enum AutoConnectOption {
502 AutoConnectPhysical = 0x1,
503 AutoConnectMaster = 0x2
506 enum TracksAutoNamingRule {
507 UseDefaultNames = 0x1,
508 NameAfterDriver = 0x2
517 int format_data_width (ARDOUR::SampleFormat);
519 enum CDMarkerFormat {
539 typedef Sample PeakDatum;
552 /* These are "synonyms". It is important for JACK to be first
553 both here and in enums.cc, so that the string "JACK" is
554 correctly recognized in older session and preference files.
563 enum ShuttleBehaviour {
573 typedef std::vector<boost::shared_ptr<Source> > SourceList;
583 typedef std::list<framepos_t> AnalysisFeatureList;
585 typedef std::list<boost::shared_ptr<Route> > RouteList;
586 typedef std::list<boost::weak_ptr <Route> > WeakRouteList;
589 typedef std::vector<boost::shared_ptr<Bundle> > BundleList;
601 struct CleanupReport {
602 std::vector<std::string> paths;
606 enum PositionLockStyle {
611 /** A struct used to describe changes to processors in a route.
612 * This is useful because objects that respond to a change in processors
613 * can optimise what work they do based on details of what has changed.
615 struct RouteProcessorChange {
618 MeterPointChange = 0x1,
622 RouteProcessorChange () : type (GeneralChange), meter_visibly_changed (true)
625 RouteProcessorChange (Type t) : type (t), meter_visibly_changed (true)
628 RouteProcessorChange (Type t, bool m) : type (t), meter_visibly_changed (m)
631 /** type of change; "GeneralChange" means anything could have changed */
633 /** true if, when a MeterPointChange has occurred, the change is visible to the user */
634 bool meter_visibly_changed;
638 AutoConnectOption input_ac; /* override the RC config for input auto-connection */
639 AutoConnectOption output_ac; /* override the RC config for output auto-connection */
640 uint32_t master_out_channels; /* how many channels for the master bus */
641 uint32_t requested_physical_in; /* now many of the available physical inputs to consider usable */
642 uint32_t requested_physical_out; /* now many of the available physical inputs to consider usable */
653 enum TransportState {
654 /* these values happen to match the constants used by JACK but
655 this equality cannot be assumed.
657 TransportStopped = 0,
658 TransportRolling = 1,
659 TransportLooping = 2,
660 TransportStarting = 3,
664 /* these values happen to match the constants used by JACK but
665 this equality cannot be assumed.
674 struct LatencyRange {
675 uint32_t min; //< samples
676 uint32_t max; //< samples
679 enum BufferingPreset {
686 enum AutoReturnTarget {
688 RangeSelectionStart = 0x2,
690 RegionSelectionStart = 0x8,
693 enum PlaylistDisposition {
699 } // namespace ARDOUR
702 /* these cover types declared above in this header. See enums.cc
705 std::istream& operator>>(std::istream& o, ARDOUR::SampleFormat& sf);
706 std::istream& operator>>(std::istream& o, ARDOUR::HeaderFormat& sf);
707 std::istream& operator>>(std::istream& o, ARDOUR::AutoConnectOption& sf);
708 std::istream& operator>>(std::istream& o, ARDOUR::TracksAutoNamingRule& sf);
709 std::istream& operator>>(std::istream& o, ARDOUR::EditMode& sf);
710 std::istream& operator>>(std::istream& o, ARDOUR::MonitorModel& sf);
711 std::istream& operator>>(std::istream& o, ARDOUR::PFLPosition& sf);
712 std::istream& operator>>(std::istream& o, ARDOUR::AFLPosition& sf);
713 std::istream& operator>>(std::istream& o, ARDOUR::RemoteModel& sf);
714 std::istream& operator>>(std::istream& o, ARDOUR::ListenPosition& sf);
715 std::istream& operator>>(std::istream& o, ARDOUR::LayerModel& sf);
716 std::istream& operator>>(std::istream& o, ARDOUR::InsertMergePolicy& sf);
717 std::istream& operator>>(std::istream& o, ARDOUR::SyncSource& sf);
718 std::istream& operator>>(std::istream& o, ARDOUR::ShuttleBehaviour& sf);
719 std::istream& operator>>(std::istream& o, ARDOUR::ShuttleUnits& sf);
720 std::istream& operator>>(std::istream& o, Timecode::TimecodeFormat& sf);
721 std::istream& operator>>(std::istream& o, ARDOUR::DenormalModel& sf);
722 std::istream& operator>>(std::istream& o, ARDOUR::PositionLockStyle& sf);
723 std::istream& operator>>(std::istream& o, ARDOUR::FadeShape& sf);
724 std::istream& operator>>(std::istream& o, ARDOUR::RegionSelectionAfterSplit& sf);
725 std::istream& operator>>(std::istream& o, ARDOUR::BufferingPreset& var);
726 std::istream& operator>>(std::istream& o, ARDOUR::AutoReturnTarget& sf);
727 std::istream& operator>>(std::istream& o, ARDOUR::MeterType& sf);
729 std::ostream& operator<<(std::ostream& o, const ARDOUR::SampleFormat& sf);
730 std::ostream& operator<<(std::ostream& o, const ARDOUR::HeaderFormat& sf);
731 std::ostream& operator<<(std::ostream& o, const ARDOUR::AutoConnectOption& sf);
732 std::ostream& operator<<(std::ostream& o, const ARDOUR::TracksAutoNamingRule& sf);
733 std::ostream& operator<<(std::ostream& o, const ARDOUR::EditMode& sf);
734 std::ostream& operator<<(std::ostream& o, const ARDOUR::MonitorModel& sf);
735 std::ostream& operator<<(std::ostream& o, const ARDOUR::PFLPosition& sf);
736 std::ostream& operator<<(std::ostream& o, const ARDOUR::AFLPosition& sf);
737 std::ostream& operator<<(std::ostream& o, const ARDOUR::RemoteModel& sf);
738 std::ostream& operator<<(std::ostream& o, const ARDOUR::ListenPosition& sf);
739 std::ostream& operator<<(std::ostream& o, const ARDOUR::LayerModel& sf);
740 std::ostream& operator<<(std::ostream& o, const ARDOUR::InsertMergePolicy& sf);
741 std::ostream& operator<<(std::ostream& o, const ARDOUR::SyncSource& sf);
742 std::ostream& operator<<(std::ostream& o, const ARDOUR::ShuttleBehaviour& sf);
743 std::ostream& operator<<(std::ostream& o, const ARDOUR::ShuttleUnits& sf);
744 std::ostream& operator<<(std::ostream& o, const Timecode::TimecodeFormat& sf);
745 std::ostream& operator<<(std::ostream& o, const ARDOUR::DenormalModel& sf);
746 std::ostream& operator<<(std::ostream& o, const ARDOUR::PositionLockStyle& sf);
747 std::ostream& operator<<(std::ostream& o, const ARDOUR::FadeShape& sf);
748 std::ostream& operator<<(std::ostream& o, const ARDOUR::RegionSelectionAfterSplit& sf);
749 std::ostream& operator<<(std::ostream& o, const ARDOUR::BufferingPreset& var);
750 std::ostream& operator<<(std::ostream& o, const ARDOUR::AutoReturnTarget& sf);
751 std::ostream& operator<<(std::ostream& o, const ARDOUR::MeterType& sf);
753 /* because these operators work on types which can be used when making
754 a UI_CONFIG_VARIABLE (in gtk2_ardour) we need them to be exported.
756 LIBARDOUR_API std::istream& operator>>(std::istream& o, ARDOUR::WaveformScale& sf);
757 LIBARDOUR_API std::istream& operator>>(std::istream& o, ARDOUR::WaveformShape& sf);
758 LIBARDOUR_API std::istream& operator>>(std::istream& o, ARDOUR::VUMeterStandard& sf);
759 LIBARDOUR_API std::istream& operator>>(std::istream& o, ARDOUR::MeterLineUp& sf);
761 LIBARDOUR_API std::ostream& operator<<(std::ostream& o, const ARDOUR::WaveformScale& sf);
762 LIBARDOUR_API std::ostream& operator<<(std::ostream& o, const ARDOUR::WaveformShape& sf);
763 LIBARDOUR_API std::ostream& operator<<(std::ostream& o, const ARDOUR::VUMeterStandard& sf);
764 LIBARDOUR_API std::ostream& operator<<(std::ostream& o, const ARDOUR::MeterLineUp& sf);
767 static inline ARDOUR::framepos_t
768 session_frame_to_track_frame (ARDOUR::framepos_t session_frame, double speed)
770 long double result = (long double) session_frame * (long double) speed;
772 if (result >= (long double) ARDOUR::max_framepos) {
773 return ARDOUR::max_framepos;
774 } else if (result <= (long double) (ARDOUR::max_framepos) * (ARDOUR::framepos_t)(-1)) {
775 return (ARDOUR::max_framepos * (ARDOUR::framepos_t)(-1));
781 static inline ARDOUR::framepos_t
782 track_frame_to_session_frame (ARDOUR::framepos_t track_frame, double speed)
784 /* NB - do we need a check for speed == 0 ??? */
785 long double result = (long double) track_frame / (long double) speed;
787 if (result >= (long double) ARDOUR::max_framepos) {
788 return ARDOUR::max_framepos;
789 } else if (result <= (long double) (ARDOUR::max_framepos) * (ARDOUR::framepos_t)(-1)) {
790 return (ARDOUR::max_framepos * (ARDOUR::framepos_t)(-1));
796 /* for now, break the rules and use "using" to make this "global" */
798 using ARDOUR::framepos_t;
801 #endif /* __ardour_types_h__ */