libs/ardour/ardour/source.h

   1 /*
   2     Copyright (C) 2000 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_source_h__
  21 #define __ardour_source_h__
  22
  23 #include <string>
  24 #include <set>
  25
  26 #include <glib.h>
  27
  28 #include <boost/utility.hpp>
  29 #include "pbd/statefuldestructible.h"
  30
  31 #include "ardour/ardour.h"
  32 #include "ardour/session_object.h"
  33 #include "ardour/data_type.h"
  34
  35 namespace ARDOUR {
  36
  37 class Session;
  38
  39 class Source : public SessionObject
  40 {
  41   public:
  42         enum Flag {
  43                 Writable = 0x1,
  44                 CanRename = 0x2,
  45                 Broadcast = 0x4,
  46                 Removable = 0x8,
  47                 RemovableIfEmpty = 0x10,
  48                 RemoveAtDestroy = 0x20,
  49                 NoPeakFile = 0x40,
  50                 Destructive = 0x80
  51         };
  52
  53         Source (Session&, DataType type, const std::string& name, Flag flags=Flag(0));
  54         Source (Session&, const XMLNode&);
  55
  56         virtual ~Source ();
  57
  58         DataType type() { return _type; }
  59
  60         time_t timestamp() const { return _timestamp; }
  61         void stamp (time_t when) { _timestamp = when; }
  62
  63         virtual framecnt_t length (framepos_t pos) const = 0;
  64         virtual void       update_length (framepos_t pos, framecnt_t cnt) = 0;
  65
  66         virtual const Glib::ustring& path() const = 0;
  67
  68         virtual framepos_t natural_position() const { return 0; }
  69
  70         void mark_for_remove();
  71
  72         virtual void mark_streaming_write_started () {}
  73         virtual void mark_streaming_write_completed () = 0;
  74
  75         virtual void session_saved() {}
  76
  77         XMLNode& get_state ();
  78         int set_state (const XMLNode&, int version);
  79
  80         bool         destructive() const       { return (_flags & Destructive); }
  81         bool         writable () const         { return (_flags & Writable); }
  82         virtual bool set_destructive (bool /*yn*/) { return false; }
  83         virtual bool length_mutable() const    { return false; }
  84
  85         static PBD::Signal1<void,Source*>             SourceCreated;
  86         PBD::Signal1<void,boost::shared_ptr<Source> > Switched;
  87
  88         bool has_been_analysed() const;
  89         virtual bool can_be_analysed() const { return false; }
  90         virtual void set_been_analysed (bool yn);
  91         virtual bool check_for_analysis_data_on_disk();
  92
  93         PBD::Signal0<void> AnalysisChanged;
  94
  95         AnalysisFeatureList transients;
  96         std::string get_transients_path() const;
  97         int load_transients (const std::string&);
  98
  99         sframes_t    timeline_position() const { return _timeline_position; }
 100         virtual void set_timeline_position (sframes_t pos);
 101
 102         void set_allow_remove_if_empty (bool yn);
 103
 104         Glib::Mutex& mutex()       { return _lock; }
 105         Flag         flags() const { return _flags; }
 106
 107         void inc_use_count () { g_atomic_int_inc (&_use_count); }
 108         void dec_use_count () {
 109 #ifndef NDEBUG
 110                 gint oldval = g_atomic_int_exchange_and_add (&_use_count, -1);
 111                 assert (oldval > 0);
 112 #else
 113                 g_atomic_int_exchange_and_add (&_use_count, -1);
 114 #endif
 115         }
 116
 117         int  use_count() const { return g_atomic_int_get (&_use_count); }
 118         bool used() const { return use_count() > 0; }
 119
 120   protected:
 121         DataType            _type;
 122         Flag                _flags;
 123         time_t              _timestamp;
 124         sframes_t           _timeline_position;
 125         bool                _analysed;
 126         mutable Glib::Mutex _lock;
 127         mutable Glib::Mutex _analysis_lock;
 128         Glib::Mutex         _playlist_lock;
 129         gint                _use_count; /* atomic */
 130
 131   private:
 132         void fix_writable_flags ();
 133 };
 134
 135 }
 136
 137 #endif /* __ardour_source_h__ */