add session-scope selection ops for Stripables
[ardour.git] / libs / ardour / ardour / audiosource.h
index f02b28d9f594ff1f7a7e8460b5b5f874cdb4b60f..59d5add12237bfa39892cbfe3b20749d83ca7e09 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    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
 #ifndef __ardour_audio_source_h__
 #define __ardour_audio_source_h__
 
-#include <list>
-#include <vector>
-
 #include <boost/shared_ptr.hpp>
+#include <boost/shared_array.hpp>
 #include <boost/enable_shared_from_this.hpp>
 
 #include <time.h>
 
-#include <glibmm/thread.h>
-#include <glibmm/ustring.h>
-
-#include <sigc++/signal.h>
+#include <glibmm/threads.h>
+#include <boost/function.hpp>
+#include <boost/scoped_array.hpp>
 
-#include <ardour/source.h>
-#include <ardour/ardour.h>
-#include <pbd/stateful.h> 
-#include <pbd/xml++.h>
-
-using std::list;
-using std::vector;
+#include "ardour/source.h"
+#include "ardour/ardour.h"
+#include "ardour/readable.h"
+#include "pbd/stateful.h"
+#include "pbd/xml++.h"
 
 namespace ARDOUR {
 
-const nframes_t frames_per_peak = 256;
-
class AudioSource : public Source, public boost::enable_shared_from_this<ARDOUR::AudioSource>
+class LIBARDOUR_API AudioSource : virtual public Source,
+               public ARDOUR::Readable,
              public boost::enable_shared_from_this<ARDOUR::AudioSource>
 {
   public:
-       AudioSource (Session&, Glib::ustring name);
+       AudioSource (Session&, const std::string& name);
        AudioSource (Session&, const XMLNode&);
        virtual ~AudioSource ();
 
-       /* returns the number of items in this `audio_source' */
+       framecnt_t readable_length() const { return _length; }
+       virtual uint32_t n_channels()      const { return 1; }
 
-       virtual nframes_t available_peaks (double zoom) const;
+       virtual bool       empty() const;
+       framecnt_t length (framepos_t pos) const;
+       void       update_length (framecnt_t cnt);
 
-       virtual nframes_t read (Sample *dst, nframes_t start, nframes_t cnt) const;
-       virtual nframes_t write (Sample *src, nframes_t cnt);
+       virtual framecnt_t available_peaks (double zoom) const;
+
+       virtual framecnt_t read (Sample *dst, framepos_t start, framecnt_t cnt, int channel=0) const;
+       virtual framecnt_t write (Sample *src, framecnt_t cnt);
 
        virtual float sample_rate () const = 0;
 
-       virtual void mark_for_remove() = 0;
-       virtual void mark_streaming_write_completed () {}
+       virtual void mark_streaming_write_completed (const Lock& lock);
 
        virtual bool can_truncate_peaks() const { return true; }
 
-       void set_captured_for (Glib::ustring str) { _captured_for = str; }
-       Glib::ustring captured_for() const { return _captured_for; }
+       void set_captured_for (std::string str) { _captured_for = str; }
+       std::string captured_for() const { return _captured_for; }
+
+       int read_peaks (PeakData *peaks, framecnt_t npeaks,
+                       framepos_t start, framecnt_t cnt, double samples_per_visual_peak) const;
 
-       uint32_t read_data_count() const { return _read_data_count; }
-       uint32_t write_data_count() const { return _write_data_count; }
+       int  build_peaks ();
+       bool peaks_ready (boost::function<void()> callWhenReady, PBD::ScopedConnection** connection_created_if_not_ready, PBD::EventLoop* event_loop) const;
 
-       virtual int read_peaks (PeakData *peaks, nframes_t npeaks, nframes_t start, nframes_t cnt, double samples_per_unit) const;
-       int  build_peaks ();
-       bool peaks_ready (sigc::slot<void>, sigc::connection&) const;
+       mutable PBD::Signal0<void>  PeaksReady;
+       mutable PBD::Signal2<void,framepos_t,framepos_t>  PeakRangeReady;
 
-       mutable sigc::signal<void>  PeaksReady;
-       mutable sigc::signal<void,nframes_t,nframes_t>  PeakRangeReady;
-       
        XMLNode& get_state ();
-       int set_state (const XMLNode&);
+       int set_state (const XMLNode&, int version);
 
-       int rename_peakfile (Glib::ustring newpath);
+       int rename_peakfile (std::string newpath);
        void touch_peakfile ();
 
        static void set_build_missing_peakfiles (bool yn) {
@@ -98,45 +96,79 @@ const nframes_t frames_per_peak = 256;
        }
 
        virtual int setup_peakfile () { return 0; }
+       int close_peakfile ();
 
        int prepare_for_peakfile_writes ();
        void done_with_peakfile_writes (bool done = true);
 
+       /** @return true if the each source sample s must be clamped to -1 < s < 1 */
+       virtual bool clamped_at_unity () const = 0;
+
+       static void allocate_working_buffers (framecnt_t framerate);
+
   protected:
        static bool _build_missing_peakfiles;
        static bool _build_peakfiles;
 
-       bool                 _peaks_built;
-       mutable Glib::Mutex  _lock;
-       mutable Glib::Mutex  _peaks_ready_lock;
-       Glib::ustring         peakpath;
-       Glib::ustring        _captured_for;
+       /* these collections of working buffers for supporting
+          playlist's reading from potentially nested/recursive
+          sources assume SINGLE THREADED reads by the butler
+          thread, or a lock around calls that use them.
+       */
+
+       static std::vector<boost::shared_array<Sample> > _mixdown_buffers;
+       static std::vector<boost::shared_array<gain_t> > _gain_buffers;
+       static Glib::Threads::Mutex    _level_buffer_lock;
+
+       static void ensure_buffers_for_level (uint32_t, framecnt_t);
+       static void ensure_buffers_for_level_locked (uint32_t, framecnt_t);
 
-       mutable uint32_t _read_data_count;  // modified in read()
-       mutable uint32_t _write_data_count; // modified in write()
+       framecnt_t           _length;
+       std::string         _peakpath;
+       std::string        _captured_for;
 
-       int initialize_peakfile (bool newfile, Glib::ustring path);
+       int initialize_peakfile (const std::string& path, const bool in_session = false);
        int build_peaks_from_scratch ();
-       int compute_and_write_peaks (Sample* buf, nframes_t first_frame, nframes_t cnt, bool force, bool intermediate_peaks_ready_signal);
+       int compute_and_write_peaks (Sample* buf, framecnt_t first_frame, framecnt_t cnt,
+       bool force, bool intermediate_peaks_ready_signal);
        void truncate_peakfile();
 
        mutable off_t _peak_byte_max; // modified in compute_and_write_peak()
 
-       virtual nframes_t read_unlocked (Sample *dst, nframes_t start, nframes_t cnt) const = 0;
-       virtual nframes_t write_unlocked (Sample *dst, nframes_t cnt) = 0;
-       virtual Glib::ustring peak_path(Glib::ustring audio_path) = 0;
-       virtual Glib::ustring find_broken_peakfile (Glib::ustring missing_peak_path, Glib::ustring audio_path) = 0;
-       
-       void update_length (nframes_t pos, nframes_t cnt);
+       virtual framecnt_t read_unlocked (Sample *dst, framepos_t start, framecnt_t cnt) const = 0;
+       virtual framecnt_t write_unlocked (Sample *dst, framecnt_t cnt) = 0;
+       virtual std::string construct_peak_filepath (const std::string& audio_path, const bool in_session = false, const bool old_peak_name = false) const = 0;
 
-  private:
-       int peakfile;
-       nframes_t peak_leftover_cnt;
-       nframes_t peak_leftover_size;
-       Sample* peak_leftovers;
-       nframes_t peak_leftover_frame;
+       virtual int read_peaks_with_fpp (PeakData *peaks,
+                                        framecnt_t npeaks, framepos_t start, framecnt_t cnt,
+                                        double samples_per_visual_peak, framecnt_t fpp) const;
+
+       int compute_and_write_peaks (Sample* buf, framecnt_t first_frame, framecnt_t cnt,
+                                    bool force, bool intermediate_peaks_ready_signal,
+                                    framecnt_t frames_per_peak);
 
-       bool file_changed (Glib::ustring path);
+  private:
+       bool _peaks_built;
+       /** This mutex is used to protect both the _peaks_built
+        *  variable and also the emission (and handling) of the
+        *  PeaksReady signal.  Holding the lock when emitting
+        *  PeaksReady means that _peaks_built cannot be changed
+        *  during the handling of the signal.
+        */
+        mutable Glib::Threads::Mutex _peaks_ready_lock;
+        Glib::Threads::Mutex _initialize_peaks_lock;
+
+       int        _peakfile_fd;
+       framecnt_t peak_leftover_cnt;
+       framecnt_t peak_leftover_size;
+       Sample*    peak_leftovers;
+       framepos_t peak_leftover_frame;
+
+       mutable bool _first_run;
+       mutable double _last_scale;
+       mutable off_t _last_map_off;
+       mutable size_t  _last_raw_map_length;
+       mutable boost::scoped_array<PeakData> peak_cache;
 };
 
 }