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>
31 #include <jack/types.h>
32 #include <jack/midiport.h>
34 #include "timecode/bbt_time.h"
35 #include "timecode/time.h"
39 #include "evoral/Range.hpp"
41 #include "ardour/chan_count.h"
56 typedef jack_default_audio_sample_t Sample;
59 typedef uint32_t layer_t;
60 typedef uint64_t microseconds_t;
61 typedef jack_nframes_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,
133 MidiPgmChangeAutomation,
134 MidiPitchBenderAutomation,
135 MidiChannelPressureAutomation,
136 MidiSystemExclusiveAutomation,
150 std::string auto_state_to_string (AutoState);
151 AutoState string_to_auto_state (std::string);
158 std::string auto_style_to_string (AutoStyle);
159 AutoStyle string_to_auto_style (std::string);
181 MeterMaxSignal = 0x001,
182 MeterMaxPeak = 0x002,
187 MeterIEC1DIN = 0x040,
188 MeterIEC1NOR = 0x080,
189 MeterIEC2BBC = 0x100,
190 MeterIEC2EBU = 0x200,
206 AllChannels = 0, ///< Pass through all channel information unmodified
207 FilterChannels, ///< Ignore events on certain channels
208 ForceChannel ///< Force all events to a certain channel
228 Timecode::Time timecode;
229 Timecode::BBT_Time bbt;
236 AnyTime() { type = Frames; frames = 0; }
238 bool operator== (AnyTime const & other) const {
239 if (type != other.type) { return false; }
243 return timecode == other.timecode;
245 return bbt == other.bbt;
247 return frames == other.frames;
249 return seconds == other.seconds;
251 return false; // get rid of warning
254 bool not_zero() const
258 return timecode.hours != 0 || timecode.minutes != 0 ||
259 timecode.seconds != 0 || timecode.frames != 0;
261 return bbt.bars != 0 || bbt.beats != 0 || bbt.ticks != 0;
274 /* XXX: slightly unfortunate that there is this and Evoral::Range<>,
275 but this has a uint32_t id which Evoral::Range<> does not.
282 AudioRange (framepos_t s, framepos_t e, uint32_t i) : start (s), end (e) , id (i) {}
284 framecnt_t length() { return end - start + 1; }
286 bool operator== (const AudioRange& other) const {
287 return start == other.start && end == other.end && id == other.id;
290 bool equal (const AudioRange& other) const {
291 return start == other.start && end == other.end;
294 Evoral::OverlapType coverage (framepos_t s, framepos_t e) const {
295 return Evoral::coverage (start, end, s, e);
300 Timecode::BBT_Time start;
301 Timecode::BBT_Time end;
304 MusicRange (Timecode::BBT_Time& s, Timecode::BBT_Time& e, uint32_t i)
305 : start (s), end (e), id (i) {}
307 bool operator== (const MusicRange& other) const {
308 return start == other.start && end == other.end && id == other.id;
311 bool equal (const MusicRange& other) const {
312 return start == other.start && end == other.end;
317 Slowest = 6.6dB/sec falloff at update rate of 40ms
318 Slow = 6.8dB/sec falloff at update rate of 40ms
323 MeterFalloffSlowest = 1,
324 MeterFalloffSlow = 2,
325 MeterFalloffSlowish = 3,
326 MeterFalloffModerate = 4,
327 MeterFalloffMedium = 5,
328 MeterFalloffFast = 6,
329 MeterFalloffFaster = 7,
330 MeterFalloffFastest = 8,
336 MeterHoldMedium = 100,
357 enum RouteSortOrderKey {
363 HardwareMonitoring, ///< JACK does monitoring
364 SoftwareMonitoring, ///< Ardour does monitoring
365 ExternalMonitoring ///< we leave monitoring to the audio hardware
376 MonitoringSilence = 0x1,
377 MonitoringInput = 0x2,
378 MonitoringDisk = 0x4,
382 MeteringInput, ///< meter the input IO, regardless of what is going through the route
383 MeteringRoute ///< meter what is going through the route
394 /** PFL signals come from before pre-fader processors */
395 PFLFromBeforeProcessors,
396 /** PFL signals come pre-fader but after pre-fader processors */
397 PFLFromAfterProcessors
401 /** AFL signals come post-fader and before post-fader processors */
402 AFLFromBeforeProcessors,
403 /** AFL signals come post-fader but after post-fader processors */
404 AFLFromAfterProcessors
420 enum CrossfadeModel {
425 enum CrossfadeChoice {
427 ConstantPowerMinus3dB,
428 ConstantPowerMinus6dB,
431 enum ListenPosition {
436 enum AutoConnectOption {
438 AutoConnectPhysical = 0x1,
439 AutoConnectMaster = 0x2
448 enum CDMarkerFormat {
465 typedef Sample PeakDatum;
492 enum ShuttleBehaviour {
502 typedef std::vector<boost::shared_ptr<Source> > SourceList;
512 typedef std::list<framepos_t> AnalysisFeatureList;
514 typedef std::list<boost::shared_ptr<Route> > RouteList;
515 typedef std::list<boost::weak_ptr <Route> > WeakRouteList;
518 typedef std::vector<boost::shared_ptr<Bundle> > BundleList;
530 struct CleanupReport {
531 std::vector<std::string> paths;
535 enum PositionLockStyle {
540 /** A struct used to describe changes to processors in a route.
541 * This is useful because objects that respond to a change in processors
542 * can optimise what work they do based on details of what has changed.
544 struct RouteProcessorChange {
547 MeterPointChange = 0x1
550 RouteProcessorChange () : type (GeneralChange), meter_visibly_changed (true)
553 RouteProcessorChange (Type t) : type (t), meter_visibly_changed (true)
556 RouteProcessorChange (Type t, bool m) : type (t), meter_visibly_changed (m)
559 /** type of change; "GeneralChange" means anything could have changed */
561 /** true if, when a MeterPointChange has occurred, the change is visible to the user */
562 bool meter_visibly_changed;
566 AutoConnectOption input_ac; /* override the RC config for input auto-connection */
567 AutoConnectOption output_ac; /* override the RC config for output auto-connection */
568 uint32_t master_out_channels; /* how many channels for the master bus */
569 uint32_t requested_physical_in; /* now many of the available physical inputs to consider usable */
570 uint32_t requested_physical_out; /* now many of the available physical inputs to consider usable */
581 } // namespace ARDOUR
584 /* these cover types declared above in this header. See enums.cc
588 std::istream& operator>>(std::istream& o, ARDOUR::SampleFormat& sf);
589 std::istream& operator>>(std::istream& o, ARDOUR::HeaderFormat& sf);
590 std::istream& operator>>(std::istream& o, ARDOUR::AutoConnectOption& sf);
591 std::istream& operator>>(std::istream& o, ARDOUR::EditMode& sf);
592 std::istream& operator>>(std::istream& o, ARDOUR::MonitorModel& sf);
593 std::istream& operator>>(std::istream& o, ARDOUR::MeterLineUp& sf);
594 std::istream& operator>>(std::istream& o, ARDOUR::PFLPosition& sf);
595 std::istream& operator>>(std::istream& o, ARDOUR::AFLPosition& sf);
596 std::istream& operator>>(std::istream& o, ARDOUR::RemoteModel& sf);
597 std::istream& operator>>(std::istream& o, ARDOUR::ListenPosition& sf);
598 std::istream& operator>>(std::istream& o, ARDOUR::InsertMergePolicy& sf);
599 std::istream& operator>>(std::istream& o, ARDOUR::CrossfadeModel& sf);
600 std::istream& operator>>(std::istream& o, ARDOUR::CrossfadeChoice& sf);
601 std::istream& operator>>(std::istream& o, ARDOUR::SyncSource& sf);
602 std::istream& operator>>(std::istream& o, ARDOUR::ShuttleBehaviour& sf);
603 std::istream& operator>>(std::istream& o, ARDOUR::ShuttleUnits& sf);
604 std::istream& operator>>(std::istream& o, Timecode::TimecodeFormat& sf);
605 std::istream& operator>>(std::istream& o, ARDOUR::DenormalModel& sf);
606 std::istream& operator>>(std::istream& o, ARDOUR::WaveformScale& sf);
607 std::istream& operator>>(std::istream& o, ARDOUR::WaveformShape& sf);
608 std::istream& operator>>(std::istream& o, ARDOUR::PositionLockStyle& sf);
610 std::ostream& operator<<(std::ostream& o, const ARDOUR::SampleFormat& sf);
611 std::ostream& operator<<(std::ostream& o, const ARDOUR::HeaderFormat& sf);
612 std::ostream& operator<<(std::ostream& o, const ARDOUR::AutoConnectOption& sf);
613 std::ostream& operator<<(std::ostream& o, const ARDOUR::EditMode& sf);
614 std::ostream& operator<<(std::ostream& o, const ARDOUR::MonitorModel& sf);
615 std::ostream& operator<<(std::ostream& o, const ARDOUR::MeterLineUp& sf);
616 std::ostream& operator<<(std::ostream& o, const ARDOUR::PFLPosition& sf);
617 std::ostream& operator<<(std::ostream& o, const ARDOUR::AFLPosition& sf);
618 std::ostream& operator<<(std::ostream& o, const ARDOUR::RemoteModel& sf);
619 std::ostream& operator<<(std::ostream& o, const ARDOUR::ListenPosition& sf);
620 std::ostream& operator<<(std::ostream& o, const ARDOUR::InsertMergePolicy& sf);
621 std::ostream& operator<<(std::ostream& o, const ARDOUR::CrossfadeModel& sf);
622 std::ostream& operator<<(std::ostream& o, const ARDOUR::CrossfadeChoice& sf);
623 std::ostream& operator<<(std::ostream& o, const ARDOUR::SyncSource& sf);
624 std::ostream& operator<<(std::ostream& o, const ARDOUR::ShuttleBehaviour& sf);
625 std::ostream& operator<<(std::ostream& o, const ARDOUR::ShuttleUnits& sf);
626 std::ostream& operator<<(std::ostream& o, const Timecode::TimecodeFormat& sf);
627 std::ostream& operator<<(std::ostream& o, const ARDOUR::DenormalModel& sf);
628 std::ostream& operator<<(std::ostream& o, const ARDOUR::WaveformScale& sf);
629 std::ostream& operator<<(std::ostream& o, const ARDOUR::WaveformShape& sf);
630 std::ostream& operator<<(std::ostream& o, const ARDOUR::PositionLockStyle& sf);
632 static inline ARDOUR::framepos_t
633 session_frame_to_track_frame (ARDOUR::framepos_t session_frame, double speed)
635 return (ARDOUR::framepos_t) ((long double) session_frame * (long double) speed);
638 static inline ARDOUR::framepos_t
639 track_frame_to_session_frame (ARDOUR::framepos_t track_frame, double speed)
641 return (ARDOUR::framepos_t) ((long double) track_frame / (long double) speed);
644 /* for now, break the rules and use "using" to make this "global" */
646 using ARDOUR::framepos_t;
649 #endif /* __ardour_types_h__ */