2 Copyright (C) 2000 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_source_h__
21 #define __ardour_source_h__
26 #include <glibmm/threads.h>
28 #include <boost/utility.hpp>
29 #include "pbd/statefuldestructible.h"
31 #include "ardour/ardour.h"
32 #include "ardour/session_object.h"
33 #include "ardour/data_type.h"
39 class LIBARDOUR_API Source : public SessionObject
47 RemovableIfEmpty = 0x10,
48 RemoveAtDestroy = 0x20,
51 Empty = 0x100, /* used for MIDI only */
54 typedef Glib::Threads::Mutex::Lock Lock;
56 Source (Session&, DataType type, const std::string& name, Flag flags=Flag(0));
57 Source (Session&, const XMLNode&);
61 DataType type() { return _type; }
63 time_t timestamp() const { return _timestamp; }
64 void stamp (time_t when) { _timestamp = when; }
66 virtual bool empty () const = 0;
67 virtual framecnt_t length (framepos_t pos) const = 0;
68 virtual void update_length (framecnt_t cnt) = 0;
70 virtual framepos_t natural_position() const { return 0; }
72 void mark_for_remove();
74 virtual void mark_streaming_write_started (const Lock& lock) {}
75 virtual void mark_streaming_write_completed (const Lock& lock) = 0;
77 virtual void session_saved() {}
79 XMLNode& get_state ();
80 int set_state (const XMLNode&, int version);
82 bool destructive() const { return (_flags & Destructive); }
83 bool writable () const;
84 virtual bool set_destructive (bool /*yn*/) { return false; }
85 virtual bool length_mutable() const { return false; }
87 static PBD::Signal1<void,Source*> SourceCreated;
89 bool has_been_analysed() const;
90 virtual bool can_be_analysed() const { return false; }
91 virtual void set_been_analysed (bool yn);
92 virtual bool check_for_analysis_data_on_disk();
94 PBD::Signal0<void> AnalysisChanged;
96 AnalysisFeatureList transients;
97 std::string get_transients_path() const;
98 int load_transients (const std::string&);
100 framepos_t timeline_position() const { return _timeline_position; }
101 virtual void set_timeline_position (framepos_t pos);
103 void set_allow_remove_if_empty (bool yn);
105 Glib::Threads::Mutex& mutex() { return _lock; }
106 Flag flags() const { return _flags; }
108 virtual void inc_use_count ();
109 virtual void dec_use_count ();
110 int use_count() const { return g_atomic_int_get (const_cast<gint*>(&_use_count)); }
111 bool used() const { return use_count() > 0; }
112 uint32_t level() const { return _level; }
114 std::string ancestor_name() { return _ancestor_name.empty() ? name() : _ancestor_name; }
115 void set_ancestor_name(const std::string& name) { _ancestor_name = name; }
121 framepos_t _timeline_position;
123 mutable Glib::Threads::Mutex _lock;
124 mutable Glib::Threads::Mutex _analysis_lock;
125 gint _use_count; /* atomic */
126 uint32_t _level; /* how deeply nested is this source w.r.t a disk file */
127 std::string _ancestor_name;
130 void fix_writable_flags ();
135 #endif /* __ardour_source_h__ */