/*
- Copyright (C) 2000 Paul Davis
+ Copyright (C) 2000 Paul Davis
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
- $Id$
*/
#ifndef __ardour_source_h__
#define __ardour_source_h__
-#include <list>
-#include <vector>
#include <string>
+#include <set>
-#include <ctime>
+#include <glib.h>
-#include <sigc++/signal.h>
+#include <boost/utility.hpp>
+#include "pbd/statefuldestructible.h"
-#include <glibmm/thread.h>
-
-#include <ardour/ardour.h>
-#include <ardour/stateful.h>
-#include <pbd/xml++.h>
-
-using std::list;
-using std::vector;
-using std::string;
+#include "ardour/ardour.h"
+#include "ardour/session_object.h"
+#include "ardour/data_type.h"
namespace ARDOUR {
-struct PeakData {
- typedef Sample PeakDatum;
-
- PeakDatum min;
- PeakDatum max;
-};
-
-const jack_nframes_t frames_per_peak = 256;
+class Session;
-class Source : public Stateful, public sigc::trackable
+class Source : public SessionObject
{
public:
- Source (bool announce=true);
- Source (const XMLNode&);
- virtual ~Source ();
-
- const string& name() const { return _name; }
-
- ARDOUR::id_t id() const { return _id; }
-
- /* returns the number of items in this `source' */
-
- virtual jack_nframes_t length() const {
- return _length;
- }
-
- virtual jack_nframes_t available_peaks (double zoom) const;
-
- virtual jack_nframes_t read (Sample *dst, jack_nframes_t start, jack_nframes_t cnt, char * workbuf) const {
- return 0;
- }
-
- virtual jack_nframes_t write (Sample *src, jack_nframes_t cnt, char * workbuf) {
- return 0;
- }
+ enum Flag {
+ Writable = 0x1,
+ CanRename = 0x2,
+ Broadcast = 0x4,
+ Removable = 0x8,
+ RemovableIfEmpty = 0x10,
+ RemoveAtDestroy = 0x20,
+ NoPeakFile = 0x40,
+ Destructive = 0x80
+ };
- virtual float sample_rate () const { return 0; }
+ Source (Session&, DataType type, const std::string& name, Flag flags=Flag(0));
+ Source (Session&, const XMLNode&);
- uint32_t use_cnt() const { return _use_cnt; }
- void use ();
- void release ();
+ virtual ~Source ();
- virtual void mark_for_remove() = 0;
- virtual void mark_streaming_write_completed () {}
+ DataType type() { return _type; }
time_t timestamp() const { return _timestamp; }
void stamp (time_t when) { _timestamp = when; }
- void set_captured_for (string str) { _captured_for = str; }
- string captured_for() const { return _captured_for; }
+ virtual bool empty () const = 0;
+ virtual framecnt_t length (framepos_t pos) const = 0;
+ virtual void update_length (framepos_t pos, framecnt_t cnt) = 0;
- uint32_t read_data_count() const { return _read_data_count; }
- uint32_t write_data_count() const { return _write_data_count; }
+ virtual const Glib::ustring& path() const = 0;
- int read_peaks (PeakData *peaks, jack_nframes_t npeaks, jack_nframes_t start, jack_nframes_t cnt, double samples_per_unit) const;
- int build_peaks ();
- bool peaks_ready (sigc::slot<void>, sigc::connection&) const;
+ virtual framepos_t natural_position() const { return 0; }
- static sigc::signal<void,Source*> SourceCreated;
-
- sigc::signal<void,Source *> GoingAway;
- mutable sigc::signal<void> PeaksReady;
- mutable sigc::signal<void,jack_nframes_t,jack_nframes_t> PeakRangeReady;
-
- XMLNode& get_state ();
- int set_state (const XMLNode&);
+ void mark_for_remove();
- static int start_peak_thread ();
- static void stop_peak_thread ();
+ virtual void mark_streaming_write_started () {}
+ virtual void mark_streaming_write_completed () = 0;
- int rename_peakfile (std::string newpath);
+ virtual void session_saved() {}
- static void set_build_missing_peakfiles (bool yn) {
- _build_missing_peakfiles = yn;
- }
- static void set_build_peakfiles (bool yn) {
- _build_peakfiles = yn;
- }
+ XMLNode& get_state ();
+ int set_state (const XMLNode&, int version);
- protected:
- static bool _build_missing_peakfiles;
- static bool _build_peakfiles;
+ bool destructive() const { return (_flags & Destructive); }
+ bool writable () const { return (_flags & Writable); }
+ virtual bool set_destructive (bool /*yn*/) { return false; }
+ virtual bool length_mutable() const { return false; }
- string _name;
- uint32_t _use_cnt;
- bool _peaks_built;
- mutable Glib::Mutex _lock;
- jack_nframes_t _length;
- bool next_peak_clear_should_notify;
- string peakpath;
- time_t _timestamp;
- string _captured_for;
+ static PBD::Signal1<void,Source*> SourceCreated;
+ PBD::Signal1<void,boost::shared_ptr<Source> > Switched;
- mutable uint32_t _read_data_count; // modified in read()
- mutable uint32_t _write_data_count; // modified in write()
+ bool has_been_analysed() const;
+ virtual bool can_be_analysed() const { return false; }
+ virtual void set_been_analysed (bool yn);
+ virtual bool check_for_analysis_data_on_disk();
- int initialize_peakfile (bool newfile, string path);
- void build_peaks_from_scratch ();
+ PBD::Signal0<void> AnalysisChanged;
- int do_build_peak (jack_nframes_t, jack_nframes_t);
- virtual jack_nframes_t read_unlocked (Sample *dst, jack_nframes_t start, jack_nframes_t cnt, char * workbuf) const = 0;
- virtual string peak_path(string audio_path) = 0;
+ AnalysisFeatureList transients;
+ std::string get_transients_path() const;
+ int load_transients (const std::string&);
- static pthread_t peak_thread;
- static bool have_peak_thread;
- static void* peak_thread_work(void*);
+ sframes_t timeline_position() const { return _timeline_position; }
+ virtual void set_timeline_position (sframes_t pos);
- static int peak_request_pipe[2];
+ void set_allow_remove_if_empty (bool yn);
- struct PeakRequest {
- enum Type {
- Build,
- Quit
- };
- };
+ Glib::Mutex& mutex() { return _lock; }
+ Flag flags() const { return _flags; }
- static vector<Source*> pending_peak_sources;
- static Glib::StaticMutex pending_peak_sources_lock;
-
- static void queue_for_peaks (Source&);
- static void clear_queue_for_peaks ();
-
- struct PeakBuildRecord {
- jack_nframes_t frame;
- jack_nframes_t cnt;
-
- PeakBuildRecord (jack_nframes_t f, jack_nframes_t c)
- : frame (f), cnt (c) {}
- PeakBuildRecord (const PeakBuildRecord& other) {
- frame = other.frame;
- cnt = other.cnt;
- }
- };
+ virtual void inc_use_count ();
+ virtual void dec_use_count ();
+ int use_count() const { return g_atomic_int_get (&_use_count); }
+ bool used() const { return use_count() > 0; }
- list<Source::PeakBuildRecord *> pending_peak_builds;
+ protected:
+ DataType _type;
+ Flag _flags;
+ time_t _timestamp;
+ sframes_t _timeline_position;
+ bool _analysed;
+ mutable Glib::Mutex _lock;
+ mutable Glib::Mutex _analysis_lock;
+ Glib::Mutex _playlist_lock;
+ gint _use_count; /* atomic */
private:
- ARDOUR::id_t _id;
-
- bool file_changed (string path);
+ void fix_writable_flags ();
};
}