Prevent clipping during the import of files from sources that have
[ardour.git] / libs / ardour / ardour / audiosource.h
index 93708a5b07b5dc2561ad4c38e7cfce477b4a5770..96779864493a22cc0f1e51881c88367196a08242 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
@@ -20,9 +20,6 @@
 #ifndef __ardour_audio_source_h__
 #define __ardour_audio_source_h__
 
-#include <list>
-#include <vector>
-
 #include <boost/shared_ptr.hpp>
 #include <boost/enable_shared_from_this.hpp>
 
 
 #include <glibmm/thread.h>
 #include <glibmm/ustring.h>
+#include <boost/function.hpp>
 
-#include <sigc++/signal.h>
-
-#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 "pbd/stateful.h"
+#include "pbd/xml++.h"
 
 namespace ARDOUR {
 
-class AudioSource : public Source, public boost::enable_shared_from_this<ARDOUR::AudioSource>
+class AudioSource : virtual public Source,
+               public ARDOUR::Readable,
+               public boost::enable_shared_from_this<ARDOUR::AudioSource>
 {
   public:
        AudioSource (Session&, Glib::ustring name);
        AudioSource (Session&, const XMLNode&);
        virtual ~AudioSource ();
 
-       /* returns the number of items in this `audio_source' */
+       framecnt_t readable_length() const { return _length; }
+       uint32_t   n_channels()      const { return 1; }
 
-       virtual nframes_t available_peaks (double zoom) const;
+       framecnt_t length (framepos_t pos) const;
+       void      update_length (framepos_t pos, 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 bool can_truncate_peaks() const { return true; }
@@ -70,16 +68,17 @@ class AudioSource : public Source, public boost::enable_shared_from_this<ARDOUR:
        uint32_t read_data_count() const { return _read_data_count; }
        uint32_t write_data_count() const { return _write_data_count; }
 
-       int read_peaks (PeakData *peaks, nframes_t npeaks, nframes_t start, nframes_t cnt, double samples_per_visual_peak) const;
+       int read_peaks (PeakData *peaks, framecnt_t npeaks,
+                       framepos_t start, framecnt_t cnt, double samples_per_visual_peak) const;
 
-       int  build_peaks ();
-       bool peaks_ready (sigc::slot<void>, sigc::connection&) const;
+       int  build_peaks ();
+       bool peaks_ready (boost::function<void()> callWhenReady, PBD::ScopedConnection& connection_created_if_not_ready, PBD::EventLoop* event_loop) 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);
        void touch_peakfile ();
@@ -101,12 +100,15 @@ class AudioSource : public Source, public boost::enable_shared_from_this<ARDOUR:
        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;
+
   protected:
        static bool _build_missing_peakfiles;
        static bool _build_peakfiles;
 
+       framecnt_t           _length;
        bool                 _peaks_built;
-       mutable Glib::Mutex  _lock;
        mutable Glib::Mutex  _peaks_ready_lock;
        Glib::ustring         peakpath;
        Glib::ustring        _captured_for;
@@ -116,32 +118,32 @@ class AudioSource : public Source, public boost::enable_shared_from_this<ARDOUR:
 
        int initialize_peakfile (bool newfile, Glib::ustring path);
        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, framepos_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 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 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 int read_peaks_with_fpp (PeakData *peaks, nframes_t npeaks, nframes_t start, nframes_t cnt, 
-                                        double samples_per_visual_peak, nframes_t fpp) const;
+       virtual Glib::ustring find_broken_peakfile (Glib::ustring missing_peak_path,
+                                                   Glib::ustring audio_path) = 0;
 
-       int compute_and_write_peaks (Sample* buf, nframes_t first_frame, nframes_t cnt, bool force, 
-                                    bool intermediate_peaks_ready_signal, nframes_t frames_per_peak);
+       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, framepos_t first_frame, framecnt_t cnt,
+                                    bool force, bool intermediate_peaks_ready_signal, 
+                                    framecnt_t frames_per_peak);
 
   private:
-       int peakfile;
-       nframes_t peak_leftover_cnt;
-       nframes_t peak_leftover_size;
-       Sample* peak_leftovers;
-       nframes_t peak_leftover_frame;
-
-       bool file_changed (Glib::ustring path);
+       int        peakfile;
+       framecnt_t peak_leftover_cnt;
+       framecnt_t peak_leftover_size;
+       Sample*    peak_leftovers;
+       framepos_t peak_leftover_frame;
 };
 
 }