libs/ardour/ardour/types.h

   1 /*
   2     Copyright (C) 2002 Paul Davis
   3
   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.
   8
   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.
  13
  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.
  17
  18 */
  19
  20 #ifndef __ardour_types_h__
  21 #define __ardour_types_h__
  22
  23 #include <istream>
  24 #include <vector>
  25 #include <map>
  26 #include <boost/shared_ptr.hpp>
  27 #include <sys/types.h>
  28 #include <stdint.h>
  29
  30 #include <inttypes.h>
  31 #include <jack/types.h>
  32 #include <jack/midiport.h>
  33
  34 #include "timecode/bbt_time.h"
  35 #include "timecode/time.h"
  36
  37 #include "pbd/id.h"
  38
  39 #include "evoral/Range.hpp"
  40
  41 #include "ardour/chan_count.h"
  42
  43 #include <map>
  44
  45 #if __GNUC__ < 3
  46 typedef int intptr_t;
  47 #endif
  48
  49 namespace ARDOUR {
  50
  51         class Source;
  52         class AudioSource;
  53         class Route;
  54         class Region;
  55
  56         typedef jack_default_audio_sample_t Sample;
  57         typedef float                       pan_t;
  58         typedef float                       gain_t;
  59         typedef uint32_t                    layer_t;
  60         typedef uint64_t                    microseconds_t;
  61         typedef jack_nframes_t              pframes_t;
  62
  63         /* Any position measured in audio frames.
  64            Assumed to be non-negative but not enforced.
  65         */
  66         typedef int64_t framepos_t;
  67
  68         /* Any distance from a given framepos_t.
  69            Maybe positive or negative.
  70         */
  71         typedef int64_t frameoffset_t;
  72
  73         /* Any count of audio frames.
  74            Assumed to be positive but not enforced.
  75         */
  76         typedef int64_t framecnt_t;
  77
  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;
  81
  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;
  86
  87         typedef std::list<boost::shared_ptr<Region> > RegionList;
  88
  89         struct IOChange {
  90
  91                 enum Type {
  92                         NoChange = 0,
  93                         ConfigurationChanged = 0x1,
  94                         ConnectionsChanged = 0x2
  95                 } type;
  96
  97                 IOChange () : type (NoChange) {}
  98                 IOChange (Type t) : type (t) {}
  99
 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;
 104         };
 105
 106         /* policies for inserting/pasting material where overlaps
 107            might be an issue.
 108         */
 109
 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
 117         };
 118
 119         /** See evoral/Parameter.hpp
 120          */
 121         enum AutomationType {
 122                 NullAutomation,
 123                 GainAutomation,
 124                 PanAzimuthAutomation,
 125                 PanElevationAutomation,
 126                 PanWidthAutomation,
 127                 PanFrontBackAutomation,
 128                 PanLFEAutomation,
 129                 PluginAutomation,
 130                 SoloAutomation,
 131                 MuteAutomation,
 132                 MidiCCAutomation,
 133                 MidiPgmChangeAutomation,
 134                 MidiPitchBenderAutomation,
 135                 MidiChannelPressureAutomation,
 136                 MidiSystemExclusiveAutomation,
 137                 FadeInAutomation,
 138                 FadeOutAutomation,
 139                 EnvelopeAutomation,
 140                 RecEnableAutomation
 141         };
 142
 143         enum AutoState {
 144                 Off = 0x0,
 145                 Write = 0x1,
 146                 Touch = 0x2,
 147                 Play = 0x4
 148         };
 149
 150         std::string auto_state_to_string (AutoState);
 151         AutoState string_to_auto_state (std::string);
 152
 153         enum AutoStyle {
 154                 Absolute = 0x1,
 155                 Trim = 0x2
 156         };
 157
 158         std::string auto_style_to_string (AutoStyle);
 159         AutoStyle string_to_auto_style (std::string);
 160
 161         enum AlignStyle {
 162                 CaptureTime,
 163                 ExistingMaterial
 164         };
 165
 166         enum AlignChoice {
 167                 UseCaptureTime,
 168                 UseExistingMaterial,
 169                 Automatic
 170         };
 171
 172         enum MeterPoint {
 173                 MeterInput,
 174                 MeterPreFader,
 175                 MeterPostFader,
 176                 MeterOutput,
 177                 MeterCustom
 178         };
 179
 180         enum TrackMode {
 181                 Normal,
 182                 NonLayered,
 183                 Destructive
 184         };
 185
 186         enum NoteMode {
 187                 Sustained,
 188                 Percussive
 189         };
 190
 191         enum ChannelMode {
 192                 AllChannels = 0, ///< Pass through all channel information unmodified
 193                 FilterChannels,  ///< Ignore events on certain channels
 194                 ForceChannel     ///< Force all events to a certain channel
 195         };
 196
 197         enum ColorMode {
 198                 MeterColors = 0,
 199                 ChannelColors,
 200                 TrackColor
 201         };
 202
 203         class AnyTime {
 204         public:
 205                 enum Type {
 206                         Timecode,
 207                         BBT,
 208                         Frames,
 209                         Seconds
 210                 };
 211
 212                 Type type;
 213
 214                 Timecode::Time     timecode;
 215                 Timecode::BBT_Time bbt;
 216
 217                 union {
 218                         framecnt_t     frames;
 219                         double         seconds;
 220                 };
 221
 222                 AnyTime() { type = Frames; frames = 0; }
 223
 224                 bool operator== (AnyTime const & other) const {
 225                         if (type != other.type) { return false; }
 226
 227                         switch (type) {
 228                           case Timecode:
 229                                 return timecode == other.timecode;
 230                           case BBT:
 231                                 return bbt == other.bbt;
 232                           case Frames:
 233                                 return frames == other.frames;
 234                           case Seconds:
 235                                 return seconds == other.seconds;
 236                         }
 237                         return false; // get rid of warning
 238                 }
 239
 240                 bool not_zero() const
 241                 {
 242                         switch (type) {
 243                           case Timecode:
 244                                 return timecode.hours != 0 || timecode.minutes != 0 ||
 245                                        timecode.seconds != 0 || timecode.frames != 0;
 246                           case BBT:
 247                                 return bbt.bars != 0 || bbt.beats != 0 || bbt.ticks != 0;
 248                           case Frames:
 249                                 return frames != 0;
 250                           case Seconds:
 251                                 return seconds != 0;
 252                         }
 253
 254                         /* NOTREACHED */
 255                         assert (false);
 256                         return false;
 257                 }
 258         };
 259
 260         /* XXX: slightly unfortunate that there is this and Evoral::Range<>,
 261            but this has a uint32_t id which Evoral::Range<> does not.
 262         */
 263         struct AudioRange {
 264                 framepos_t start;
 265                 framepos_t end;
 266                 uint32_t id;
 267
 268                 AudioRange (framepos_t s, framepos_t e, uint32_t i) : start (s), end (e) , id (i) {}
 269
 270                 framecnt_t length() { return end - start + 1; }
 271
 272                 bool operator== (const AudioRange& other) const {
 273                         return start == other.start && end == other.end && id == other.id;
 274                 }
 275
 276                 bool equal (const AudioRange& other) const {
 277                         return start == other.start && end == other.end;
 278                 }
 279
 280                 Evoral::OverlapType coverage (framepos_t s, framepos_t e) const {
 281                         return Evoral::coverage (start, end, s, e);
 282                 }
 283         };
 284
 285         struct MusicRange {
 286                 Timecode::BBT_Time start;
 287                 Timecode::BBT_Time end;
 288                 uint32_t id;
 289
 290                 MusicRange (Timecode::BBT_Time& s, Timecode::BBT_Time& e, uint32_t i)
 291                         : start (s), end (e), id (i) {}
 292
 293                 bool operator== (const MusicRange& other) const {
 294                         return start == other.start && end == other.end && id == other.id;
 295                 }
 296
 297                 bool equal (const MusicRange& other) const {
 298                         return start == other.start && end == other.end;
 299                 }
 300         };
 301
 302         /*
 303             Slowest = 6.6dB/sec falloff at update rate of 40ms
 304             Slow    = 6.8dB/sec falloff at update rate of 40ms
 305         */
 306
 307         enum MeterFalloff {
 308                 MeterFalloffOff = 0,
 309                 MeterFalloffSlowest = 1,
 310                 MeterFalloffSlow = 2,
 311                 MeterFalloffMedium = 3,
 312                 MeterFalloffFast = 4,
 313                 MeterFalloffFaster = 5,
 314                 MeterFalloffFastest = 6
 315         };
 316
 317         enum MeterHold {
 318                 MeterHoldOff = 0,
 319                 MeterHoldShort = 40,
 320                 MeterHoldMedium = 100,
 321                 MeterHoldLong = 200
 322         };
 323
 324         enum EditMode {
 325                 Slide,
 326                 Splice,
 327                 Lock
 328         };
 329
 330         enum RegionPoint {
 331                 Start,
 332                 End,
 333                 SyncPoint
 334         };
 335
 336         enum Placement {
 337                 PreFader,
 338                 PostFader
 339         };
 340
 341         enum RouteSortOrderKey {
 342                 EditorSort,
 343                 MixerSort
 344         };
 345
 346         enum MonitorModel {
 347                 HardwareMonitoring, ///< JACK does monitoring
 348                 SoftwareMonitoring, ///< Ardour does monitoring
 349                 ExternalMonitoring  ///< we leave monitoring to the audio hardware
 350         };
 351
 352         enum MonitorChoice {
 353                 MonitorAuto = 0,
 354                 MonitorInput = 0x1,
 355                 MonitorDisk = 0x2,
 356                 MonitorCue = 0x4,
 357         };
 358
 359         enum MonitorState {
 360                 MonitoringSilence = 0x1,
 361                 MonitoringInput = 0x2,
 362                 MonitoringDisk = 0x4,
 363         };
 364
 365         enum MeterState {
 366                 MeteringInput, ///< meter the input IO, regardless of what is going through the route
 367                 MeteringRoute  ///< meter what is going through the route
 368         };
 369
 370         enum MeterLineUp {
 371                 MeteringLineUp24,
 372                 MeteringLineUp20,
 373                 MeteringLineUp18,
 374                 MeteringLineUp15
 375         };
 376
 377         enum PFLPosition {
 378                 /** PFL signals come from before pre-fader processors */
 379                 PFLFromBeforeProcessors,
 380                 /** PFL signals come pre-fader but after pre-fader processors */
 381                 PFLFromAfterProcessors
 382         };
 383
 384         enum AFLPosition {
 385                 /** AFL signals come post-fader and before post-fader processors */
 386                 AFLFromBeforeProcessors,
 387                 /** AFL signals come post-fader but after post-fader processors */
 388                 AFLFromAfterProcessors
 389         };
 390
 391         enum DenormalModel {
 392                 DenormalNone,
 393                 DenormalFTZ,
 394                 DenormalDAZ,
 395                 DenormalFTZDAZ
 396         };
 397
 398         enum RemoteModel {
 399                 UserOrdered,
 400                 MixerOrdered,
 401                 EditorOrdered
 402         };
 403
 404         enum CrossfadeModel {
 405                 FullCrossfade,
 406                 ShortCrossfade
 407         };
 408
 409         enum CrossfadeChoice {
 410                 RegionFades,
 411                 ConstantPowerMinus3dB,
 412                 ConstantPowerMinus6dB,
 413         };
 414
 415         enum ListenPosition {
 416                 AfterFaderListen,
 417                 PreFaderListen
 418         };
 419
 420         enum AutoConnectOption {
 421                 ManualConnect = 0x0,
 422                 AutoConnectPhysical = 0x1,
 423                 AutoConnectMaster = 0x2
 424         };
 425
 426         enum SampleFormat {
 427                 FormatFloat = 0,
 428                 FormatInt24,
 429                 FormatInt16
 430         };
 431
 432         enum CDMarkerFormat {
 433                 CDMarkerNone,
 434                 CDMarkerCUE,
 435                 CDMarkerTOC
 436         };
 437
 438         enum HeaderFormat {
 439                 BWF,
 440                 WAVE,
 441                 WAVE64,
 442                 CAF,
 443                 AIFF,
 444                 iXML,
 445                 RF64
 446         };
 447
 448         struct PeakData {
 449                 typedef Sample PeakDatum;
 450
 451                 PeakDatum min;
 452                 PeakDatum max;
 453         };
 454
 455         enum PluginType {
 456                 AudioUnit,
 457                 LADSPA,
 458                 LV2,
 459                 Windows_VST,
 460                 LXVST,
 461         };
 462
 463         enum RunContext {
 464                 ButlerContext = 0,
 465                 TransportContext,
 466                 ExportContext
 467         };
 468
 469         enum SyncSource {
 470                 JACK,
 471                 MTC,
 472                 MIDIClock,
 473                 LTC
 474         };
 475
 476         enum ShuttleBehaviour {
 477                 Sprung,
 478                 Wheel
 479         };
 480
 481         enum ShuttleUnits {
 482                 Percentage,
 483                 Semitones
 484         };
 485
 486         typedef std::vector<boost::shared_ptr<Source> > SourceList;
 487
 488         enum SrcQuality {
 489                 SrcBest,
 490                 SrcGood,
 491                 SrcQuick,
 492                 SrcFast,
 493                 SrcFastest
 494         };
 495
 496         typedef std::list<framepos_t> AnalysisFeatureList;
 497
 498         typedef std::list<boost::shared_ptr<Route> > RouteList;
 499         typedef std::list<boost::weak_ptr  <Route> > WeakRouteList;
 500
 501         class Bundle;
 502         typedef std::vector<boost::shared_ptr<Bundle> > BundleList;
 503
 504         enum WaveformScale {
 505                 Linear,
 506                 Logarithmic
 507         };
 508
 509         enum WaveformShape {
 510                 Traditional,
 511                 Rectified
 512         };
 513
 514         struct CleanupReport {
 515                 std::vector<std::string> paths;
 516                 size_t                   space;
 517         };
 518
 519         enum PositionLockStyle {
 520                 AudioTime,
 521                 MusicTime
 522         };
 523
 524         /** A struct used to describe changes to processors in a route.
 525          *  This is useful because objects that respond to a change in processors
 526          *  can optimise what work they do based on details of what has changed.
 527         */
 528         struct RouteProcessorChange {
 529                 enum Type {
 530                         GeneralChange = 0x0,
 531                         MeterPointChange = 0x1
 532                 };
 533
 534                 RouteProcessorChange () : type (GeneralChange), meter_visibly_changed (true)
 535                 {}
 536
 537                 RouteProcessorChange (Type t) : type (t), meter_visibly_changed (true)
 538                 {}
 539
 540                 RouteProcessorChange (Type t, bool m) : type (t), meter_visibly_changed (m)
 541                 {}
 542
 543                 /** type of change; "GeneralChange" means anything could have changed */
 544                 Type type;
 545                 /** true if, when a MeterPointChange has occurred, the change is visible to the user */
 546                 bool meter_visibly_changed;
 547         };
 548
 549         struct BusProfile {
 550                 AutoConnectOption input_ac;      /* override the RC config for input auto-connection */
 551                 AutoConnectOption output_ac;     /* override the RC config for output auto-connection */
 552                 uint32_t master_out_channels;    /* how many channels for the master bus */
 553                 uint32_t requested_physical_in;  /* now many of the available physical inputs to consider usable */
 554                 uint32_t requested_physical_out; /* now many of the available physical inputs to consider usable */
 555         };
 556
 557         enum FadeShape {
 558                 FadeLinear,
 559                 FadeFast,
 560                 FadeSlow,
 561                 FadeConstantPower,
 562                 FadeSymmetric,
 563         };
 564
 565 } // namespace ARDOUR
 566
 567
 568 /* these cover types declared above in this header. See enums.cc
 569    for the definitions.
 570 */
 571
 572 std::istream& operator>>(std::istream& o, ARDOUR::SampleFormat& sf);
 573 std::istream& operator>>(std::istream& o, ARDOUR::HeaderFormat& sf);
 574 std::istream& operator>>(std::istream& o, ARDOUR::AutoConnectOption& sf);
 575 std::istream& operator>>(std::istream& o, ARDOUR::EditMode& sf);
 576 std::istream& operator>>(std::istream& o, ARDOUR::MonitorModel& sf);
 577 std::istream& operator>>(std::istream& o, ARDOUR::MeterLineUp& sf);
 578 std::istream& operator>>(std::istream& o, ARDOUR::PFLPosition& sf);
 579 std::istream& operator>>(std::istream& o, ARDOUR::AFLPosition& sf);
 580 std::istream& operator>>(std::istream& o, ARDOUR::RemoteModel& sf);
 581 std::istream& operator>>(std::istream& o, ARDOUR::ListenPosition& sf);
 582 std::istream& operator>>(std::istream& o, ARDOUR::InsertMergePolicy& sf);
 583 std::istream& operator>>(std::istream& o, ARDOUR::CrossfadeModel& sf);
 584 std::istream& operator>>(std::istream& o, ARDOUR::CrossfadeChoice& sf);
 585 std::istream& operator>>(std::istream& o, ARDOUR::SyncSource& sf);
 586 std::istream& operator>>(std::istream& o, ARDOUR::ShuttleBehaviour& sf);
 587 std::istream& operator>>(std::istream& o, ARDOUR::ShuttleUnits& sf);
 588 std::istream& operator>>(std::istream& o, Timecode::TimecodeFormat& sf);
 589 std::istream& operator>>(std::istream& o, ARDOUR::DenormalModel& sf);
 590 std::istream& operator>>(std::istream& o, ARDOUR::WaveformScale& sf);
 591 std::istream& operator>>(std::istream& o, ARDOUR::WaveformShape& sf);
 592 std::istream& operator>>(std::istream& o, ARDOUR::PositionLockStyle& sf);
 593
 594 std::ostream& operator<<(std::ostream& o, const ARDOUR::SampleFormat& sf);
 595 std::ostream& operator<<(std::ostream& o, const ARDOUR::HeaderFormat& sf);
 596 std::ostream& operator<<(std::ostream& o, const ARDOUR::AutoConnectOption& sf);
 597 std::ostream& operator<<(std::ostream& o, const ARDOUR::EditMode& sf);
 598 std::ostream& operator<<(std::ostream& o, const ARDOUR::MonitorModel& sf);
 599 std::ostream& operator<<(std::ostream& o, const ARDOUR::MeterLineUp& sf);
 600 std::ostream& operator<<(std::ostream& o, const ARDOUR::PFLPosition& sf);
 601 std::ostream& operator<<(std::ostream& o, const ARDOUR::AFLPosition& sf);
 602 std::ostream& operator<<(std::ostream& o, const ARDOUR::RemoteModel& sf);
 603 std::ostream& operator<<(std::ostream& o, const ARDOUR::ListenPosition& sf);
 604 std::ostream& operator<<(std::ostream& o, const ARDOUR::InsertMergePolicy& sf);
 605 std::ostream& operator<<(std::ostream& o, const ARDOUR::CrossfadeModel& sf);
 606 std::ostream& operator<<(std::ostream& o, const ARDOUR::CrossfadeChoice& sf);
 607 std::ostream& operator<<(std::ostream& o, const ARDOUR::SyncSource& sf);
 608 std::ostream& operator<<(std::ostream& o, const ARDOUR::ShuttleBehaviour& sf);
 609 std::ostream& operator<<(std::ostream& o, const ARDOUR::ShuttleUnits& sf);
 610 std::ostream& operator<<(std::ostream& o, const Timecode::TimecodeFormat& sf);
 611 std::ostream& operator<<(std::ostream& o, const ARDOUR::DenormalModel& sf);
 612 std::ostream& operator<<(std::ostream& o, const ARDOUR::WaveformScale& sf);
 613 std::ostream& operator<<(std::ostream& o, const ARDOUR::WaveformShape& sf);
 614 std::ostream& operator<<(std::ostream& o, const ARDOUR::PositionLockStyle& sf);
 615
 616 static inline ARDOUR::framepos_t
 617 session_frame_to_track_frame (ARDOUR::framepos_t session_frame, double speed)
 618 {
 619         return (ARDOUR::framepos_t) ((long double) session_frame * (long double) speed);
 620 }
 621
 622 static inline ARDOUR::framepos_t
 623 track_frame_to_session_frame (ARDOUR::framepos_t track_frame, double speed)
 624 {
 625         return (ARDOUR::framepos_t) ((long double) track_frame / (long double) speed);
 626 }
 627
 628 /* for now, break the rules and use "using" to make this "global" */
 629
 630 using ARDOUR::framepos_t;
 631
 632
 633 #endif /* __ardour_types_h__ */
 634