/*
- 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 "ardour/readable.h"
+#include "pbd/stateful.h"
#include "pbd/xml++.h"
-using std::list;
-using std::vector;
-
namespace ARDOUR {
-class AudioSource : virtual public Source,
+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 ();
- nframes64_t readable_length() const { return _length; }
- uint32_t n_channels() const { return 1; }
-
- sframes_t length (sframes_t pos) const;
- void update_length (sframes_t pos, sframes_t cnt);
+ samplecnt_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;
+ samplecnt_t length (samplepos_t pos) const;
+ void update_length (samplecnt_t cnt);
- virtual nframes_t read (Sample *dst, sframes_t start, nframes_t cnt, int channel=0) const;
- virtual nframes_t write (Sample *src, nframes_t cnt);
+ virtual samplecnt_t available_peaks (double zoom) const;
+
+ virtual samplecnt_t read (Sample *dst, samplepos_t start, samplecnt_t cnt, int channel=0) const;
+ virtual samplecnt_t write (Sample *src, samplecnt_t cnt);
virtual float sample_rate () const = 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; }
- 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, samplecnt_t npeaks,
+ samplepos_t start, samplecnt_t cnt, double samples_per_visual_peak) const;
- int read_peaks (PeakData *peaks, nframes_t npeaks,
- sframes_t start, nframes_t cnt, double samples_per_visual_peak) const;
+ int build_peaks ();
+ bool peaks_ready (boost::function<void()> callWhenReady, PBD::ScopedConnection** connection_created_if_not_ready, PBD::EventLoop* event_loop) const;
- int build_peaks ();
- bool peaks_ready (sigc::slot<void>, sigc::connection&) const;
+ mutable PBD::Signal0<void> PeaksReady;
+ mutable PBD::Signal2<void,samplepos_t,samplepos_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) {
}
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 (samplecnt_t framerate);
+
protected:
static bool _build_missing_peakfiles;
static bool _build_peakfiles;
- sframes_t _length;
- bool _peaks_built;
- 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, samplecnt_t);
+ static void ensure_buffers_for_level_locked (uint32_t, samplecnt_t);
- mutable uint32_t _read_data_count; // modified in read()
- mutable uint32_t _write_data_count; // modified in write()
+ samplecnt_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, sframes_t first_frame, nframes_t cnt,
- bool force, bool intermediate_peaks_ready_signal);
+ int compute_and_write_peaks (Sample* buf, samplecnt_t first_sample, samplecnt_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, sframes_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;
-
- virtual int read_peaks_with_fpp (PeakData *peaks,
- nframes_t npeaks, sframes_t start, nframes_t cnt,
- double samples_per_visual_peak, nframes_t fpp) const;
+ virtual samplecnt_t read_unlocked (Sample *dst, samplepos_t start, samplecnt_t cnt) const = 0;
+ virtual samplecnt_t write_unlocked (Sample *dst, samplecnt_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;
- int compute_and_write_peaks (Sample* buf, sframes_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,
+ samplecnt_t npeaks, samplepos_t start, samplecnt_t cnt,
+ double samples_per_visual_peak, samplecnt_t fpp) const;
- private:
- int peakfile;
- nframes_t peak_leftover_cnt;
- nframes_t peak_leftover_size;
- Sample* peak_leftovers;
- nframes_t peak_leftover_frame;
+ int compute_and_write_peaks (Sample* buf, samplecnt_t first_sample, samplecnt_t cnt,
+ bool force, bool intermediate_peaks_ready_signal,
+ samplecnt_t samples_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;
+ samplecnt_t peak_leftover_cnt;
+ samplecnt_t peak_leftover_size;
+ Sample* peak_leftovers;
+ samplepos_t peak_leftover_sample;
+
+ 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;
};
}