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>
32 #include "timecode/bbt_time.h"
33 #include "timecode/time.h"
37 #include "evoral/Range.hpp"
39 #include "ardour/chan_count.h"
57 typedef uint32_t layer_t;
58 typedef uint64_t microseconds_t;
59 typedef uint32_t pframes_t;
61 /* Any position measured in audio frames.
62 Assumed to be non-negative but not enforced.
64 typedef int64_t framepos_t;
66 /* Any distance from a given framepos_t.
67 Maybe positive or negative.
69 typedef int64_t frameoffset_t;
71 /* Any count of audio frames.
72 Assumed to be positive but not enforced.
74 typedef int64_t framecnt_t;
76 static const framepos_t max_framepos = INT64_MAX;
77 static const framecnt_t max_framecnt = INT64_MAX;
78 static const layer_t max_layer = UINT32_MAX;
80 // a set of (time) intervals: first of pair is the offset of the start within the region, second is the offset of the end
81 typedef std::list<std::pair<frameoffset_t, frameoffset_t> > AudioIntervalResult;
82 // associate a set of intervals with regions (e.g. for silence detection)
83 typedef std::map<boost::shared_ptr<ARDOUR::Region>,AudioIntervalResult> AudioIntervalMap;
85 typedef std::list<boost::shared_ptr<Region> > RegionList;
91 ConfigurationChanged = 0x1,
92 ConnectionsChanged = 0x2
95 IOChange () : type (NoChange) {}
96 IOChange (Type t) : type (t) {}
98 /** channel count of IO before a ConfigurationChanged, if appropriate */
99 ARDOUR::ChanCount before;
100 /** channel count of IO after a ConfigurationChanged, if appropriate */
101 ARDOUR::ChanCount after;
104 /* policies for inserting/pasting material where overlaps
108 enum InsertMergePolicy {
109 InsertMergeReject, // no overlaps allowed
110 InsertMergeRelax, // we just don't care about overlaps
111 InsertMergeReplace, // replace old with new
112 InsertMergeTruncateExisting, // shorten existing to avoid overlap
113 InsertMergeTruncateAddition, // shorten new to avoid overlap
114 InsertMergeExtend // extend new (or old) to the range of old+new
117 /** See evoral/Parameter.hpp
119 enum AutomationType {
122 PanAzimuthAutomation,
123 PanElevationAutomation,
125 PanFrontBackAutomation,
131 MidiPgmChangeAutomation,
132 MidiPitchBenderAutomation,
133 MidiChannelPressureAutomation,
134 MidiSystemExclusiveAutomation,
148 std::string auto_state_to_string (AutoState);
149 AutoState string_to_auto_state (std::string);
156 std::string auto_style_to_string (AutoStyle);
157 AutoStyle string_to_auto_style (std::string);
179 MeterMaxSignal = 0x001,
180 MeterMaxPeak = 0x002,
185 MeterIEC1DIN = 0x040,
186 MeterIEC1NOR = 0x080,
187 MeterIEC2BBC = 0x100,
188 MeterIEC2EBU = 0x200,
204 AllChannels = 0, ///< Pass through all channel information unmodified
205 FilterChannels, ///< Ignore events on certain channels
206 ForceChannel ///< Force all events to a certain channel
226 Timecode::Time timecode;
227 Timecode::BBT_Time bbt;
234 AnyTime() { type = Frames; frames = 0; }
236 bool operator== (AnyTime const & other) const {
237 if (type != other.type) { return false; }
241 return timecode == other.timecode;
243 return bbt == other.bbt;
245 return frames == other.frames;
247 return seconds == other.seconds;
249 return false; // get rid of warning
252 bool not_zero() const
256 return timecode.hours != 0 || timecode.minutes != 0 ||
257 timecode.seconds != 0 || timecode.frames != 0;
259 return bbt.bars != 0 || bbt.beats != 0 || bbt.ticks != 0;
272 /* XXX: slightly unfortunate that there is this and Evoral::Range<>,
273 but this has a uint32_t id which Evoral::Range<> does not.
280 AudioRange (framepos_t s, framepos_t e, uint32_t i) : start (s), end (e) , id (i) {}
282 framecnt_t length() { return end - start + 1; }
284 bool operator== (const AudioRange& other) const {
285 return start == other.start && end == other.end && id == other.id;
288 bool equal (const AudioRange& other) const {
289 return start == other.start && end == other.end;
292 Evoral::OverlapType coverage (framepos_t s, framepos_t e) const {
293 return Evoral::coverage (start, end, s, e);
298 Timecode::BBT_Time start;
299 Timecode::BBT_Time end;
302 MusicRange (Timecode::BBT_Time& s, Timecode::BBT_Time& e, uint32_t i)
303 : start (s), end (e), id (i) {}
305 bool operator== (const MusicRange& other) const {
306 return start == other.start && end == other.end && id == other.id;
309 bool equal (const MusicRange& other) const {
310 return start == other.start && end == other.end;
315 Slowest = 6.6dB/sec falloff at update rate of 40ms
316 Slow = 6.8dB/sec falloff at update rate of 40ms
321 MeterFalloffSlowest = 1,
322 MeterFalloffSlow = 2,
323 MeterFalloffSlowish = 3,
324 MeterFalloffModerate = 4,
325 MeterFalloffMedium = 5,
326 MeterFalloffFast = 6,
327 MeterFalloffFaster = 7,
328 MeterFalloffFastest = 8,
334 MeterHoldMedium = 100,
355 enum RouteSortOrderKey {
361 HardwareMonitoring, ///< JACK does monitoring
362 SoftwareMonitoring, ///< Ardour does monitoring
363 ExternalMonitoring ///< we leave monitoring to the audio hardware
374 MonitoringSilence = 0x1,
375 MonitoringInput = 0x2,
376 MonitoringDisk = 0x4,
380 MeteringInput, ///< meter the input IO, regardless of what is going through the route
381 MeteringRoute ///< meter what is going through the route
384 enum VUMeterStandard {
385 MeteringVUfrench, // 0VU = -2dBu
386 MeteringVUamerican, // 0VU = 0dBu
387 MeteringVUstandard, // 0VU = +4dBu
388 MeteringVUeight // 0VU = +8dBu
399 /** PFL signals come from before pre-fader processors */
400 PFLFromBeforeProcessors,
401 /** PFL signals come pre-fader but after pre-fader processors */
402 PFLFromAfterProcessors
406 /** AFL signals come post-fader and before post-fader processors */
407 AFLFromBeforeProcessors,
408 /** AFL signals come post-fader but after post-fader processors */
409 AFLFromAfterProcessors
425 enum CrossfadeModel {
430 enum CrossfadeChoice {
432 ConstantPowerMinus3dB,
433 ConstantPowerMinus6dB,
436 enum ListenPosition {
441 enum AutoConnectOption {
443 AutoConnectPhysical = 0x1,
444 AutoConnectMaster = 0x2
453 enum CDMarkerFormat {
470 typedef Sample PeakDatum;
497 enum ShuttleBehaviour {
507 typedef std::vector<boost::shared_ptr<Source> > SourceList;
517 typedef std::list<framepos_t> AnalysisFeatureList;
519 typedef std::list<boost::shared_ptr<Route> > RouteList;
520 typedef std::list<boost::weak_ptr <Route> > WeakRouteList;
523 typedef std::vector<boost::shared_ptr<Bundle> > BundleList;
535 struct CleanupReport {
536 std::vector<std::string> paths;
540 enum PositionLockStyle {
545 /** A struct used to describe changes to processors in a route.
546 * This is useful because objects that respond to a change in processors
547 * can optimise what work they do based on details of what has changed.
549 struct RouteProcessorChange {
552 MeterPointChange = 0x1
555 RouteProcessorChange () : type (GeneralChange), meter_visibly_changed (true)
558 RouteProcessorChange (Type t) : type (t), meter_visibly_changed (true)
561 RouteProcessorChange (Type t, bool m) : type (t), meter_visibly_changed (m)
564 /** type of change; "GeneralChange" means anything could have changed */
566 /** true if, when a MeterPointChange has occurred, the change is visible to the user */
567 bool meter_visibly_changed;
571 AutoConnectOption input_ac; /* override the RC config for input auto-connection */
572 AutoConnectOption output_ac; /* override the RC config for output auto-connection */
573 uint32_t master_out_channels; /* how many channels for the master bus */
574 uint32_t requested_physical_in; /* now many of the available physical inputs to consider usable */
575 uint32_t requested_physical_out; /* now many of the available physical inputs to consider usable */
586 enum TransportState {
587 /* these values happen to match the constants used by JACK but
588 this equality cannot be assumed.
590 TransportStopped = 0,
591 TransportRolling = 1,
592 TransportLooping = 2,
593 TransportStarting = 3,
597 /* these values happen to match the constants used by JACK but
598 this equality cannot be assumed.
607 struct LatencyRange {
608 uint32_t min; //< samples
609 uint32_t max; //< samples
612 } // namespace ARDOUR
615 /* these cover types declared above in this header. See enums.cc
619 std::istream& operator>>(std::istream& o, ARDOUR::SampleFormat& sf);
620 std::istream& operator>>(std::istream& o, ARDOUR::HeaderFormat& sf);
621 std::istream& operator>>(std::istream& o, ARDOUR::AutoConnectOption& sf);
622 std::istream& operator>>(std::istream& o, ARDOUR::EditMode& sf);
623 std::istream& operator>>(std::istream& o, ARDOUR::MonitorModel& sf);
624 std::istream& operator>>(std::istream& o, ARDOUR::VUMeterStandard& sf);
625 std::istream& operator>>(std::istream& o, ARDOUR::MeterLineUp& sf);
626 std::istream& operator>>(std::istream& o, ARDOUR::PFLPosition& sf);
627 std::istream& operator>>(std::istream& o, ARDOUR::AFLPosition& sf);
628 std::istream& operator>>(std::istream& o, ARDOUR::RemoteModel& sf);
629 std::istream& operator>>(std::istream& o, ARDOUR::ListenPosition& sf);
630 std::istream& operator>>(std::istream& o, ARDOUR::InsertMergePolicy& sf);
631 std::istream& operator>>(std::istream& o, ARDOUR::CrossfadeModel& sf);
632 std::istream& operator>>(std::istream& o, ARDOUR::CrossfadeChoice& sf);
633 std::istream& operator>>(std::istream& o, ARDOUR::SyncSource& sf);
634 std::istream& operator>>(std::istream& o, ARDOUR::ShuttleBehaviour& sf);
635 std::istream& operator>>(std::istream& o, ARDOUR::ShuttleUnits& sf);
636 std::istream& operator>>(std::istream& o, Timecode::TimecodeFormat& sf);
637 std::istream& operator>>(std::istream& o, ARDOUR::DenormalModel& sf);
638 std::istream& operator>>(std::istream& o, ARDOUR::WaveformScale& sf);
639 std::istream& operator>>(std::istream& o, ARDOUR::WaveformShape& sf);
640 std::istream& operator>>(std::istream& o, ARDOUR::PositionLockStyle& sf);
642 std::ostream& operator<<(std::ostream& o, const ARDOUR::SampleFormat& sf);
643 std::ostream& operator<<(std::ostream& o, const ARDOUR::HeaderFormat& sf);
644 std::ostream& operator<<(std::ostream& o, const ARDOUR::AutoConnectOption& sf);
645 std::ostream& operator<<(std::ostream& o, const ARDOUR::EditMode& sf);
646 std::ostream& operator<<(std::ostream& o, const ARDOUR::MonitorModel& sf);
647 std::ostream& operator<<(std::ostream& o, const ARDOUR::VUMeterStandard& sf);
648 std::ostream& operator<<(std::ostream& o, const ARDOUR::MeterLineUp& sf);
649 std::ostream& operator<<(std::ostream& o, const ARDOUR::PFLPosition& sf);
650 std::ostream& operator<<(std::ostream& o, const ARDOUR::AFLPosition& sf);
651 std::ostream& operator<<(std::ostream& o, const ARDOUR::RemoteModel& sf);
652 std::ostream& operator<<(std::ostream& o, const ARDOUR::ListenPosition& sf);
653 std::ostream& operator<<(std::ostream& o, const ARDOUR::InsertMergePolicy& sf);
654 std::ostream& operator<<(std::ostream& o, const ARDOUR::CrossfadeModel& sf);
655 std::ostream& operator<<(std::ostream& o, const ARDOUR::CrossfadeChoice& sf);
656 std::ostream& operator<<(std::ostream& o, const ARDOUR::SyncSource& sf);
657 std::ostream& operator<<(std::ostream& o, const ARDOUR::ShuttleBehaviour& sf);
658 std::ostream& operator<<(std::ostream& o, const ARDOUR::ShuttleUnits& sf);
659 std::ostream& operator<<(std::ostream& o, const Timecode::TimecodeFormat& sf);
660 std::ostream& operator<<(std::ostream& o, const ARDOUR::DenormalModel& sf);
661 std::ostream& operator<<(std::ostream& o, const ARDOUR::WaveformScale& sf);
662 std::ostream& operator<<(std::ostream& o, const ARDOUR::WaveformShape& sf);
663 std::ostream& operator<<(std::ostream& o, const ARDOUR::PositionLockStyle& sf);
665 static inline ARDOUR::framepos_t
666 session_frame_to_track_frame (ARDOUR::framepos_t session_frame, double speed)
668 return (ARDOUR::framepos_t) ((long double) session_frame * (long double) speed);
671 static inline ARDOUR::framepos_t
672 track_frame_to_session_frame (ARDOUR::framepos_t track_frame, double speed)
674 return (ARDOUR::framepos_t) ((long double) track_frame / (long double) speed);
677 /* for now, break the rules and use "using" to make this "global" */
679 using ARDOUR::framepos_t;
682 #endif /* __ardour_types_h__ */