expose more info from plugin-strip (for GUI display)
[ardour.git] / libs / ardour / audio_playlist_source.cc
index e8fabef7b1aa2c9c33fdd2413c924a169b10a4ca..8effdd0c808145f866056338f1ea02e203e01f41 100644 (file)
 #include <glibmm/miscutils.h>
 
 #include "pbd/error.h"
-#include "pbd/convert.h"
-#include "pbd/enumwriter.h"
 
 #include "ardour/audioplaylist.h"
 #include "ardour/audio_playlist_source.h"
 #include "ardour/audioregion.h"
-#include "ardour/debug.h"
+#include "ardour/filename_extensions.h"
 #include "ardour/session.h"
 #include "ardour/session_directory.h"
-#include "ardour/session_playlists.h"
-#include "ardour/source_factory.h"
 
 #include "i18n.h"
 
@@ -45,40 +41,34 @@ using namespace std;
 using namespace ARDOUR;
 using namespace PBD;
 
-AudioPlaylistSource::AudioPlaylistSource (Session& s, const std::string& name, boost::shared_ptr<AudioPlaylist> p, 
-                                         uint32_t chn, frameoffset_t begin, framecnt_t len, bool copy, Source::Flag flags)
+AudioPlaylistSource::AudioPlaylistSource (Session& s, const ID& orig, const std::string& name, boost::shared_ptr<AudioPlaylist> p,
+                                         uint32_t chn, frameoffset_t begin, framecnt_t len, Source::Flag flags)
        : Source (s, DataType::AUDIO, name)
+       , PlaylistSource (s, orig, name, p, DataType::AUDIO, begin, len, flags)
        , AudioSource (s, name)
-       , _playlist (p)
        , _playlist_channel (chn)
 {
-       /* PlaylistSources are never writable, renameable, removable or destructive */
-       _flags = Flag (_flags & ~(Writable|CanRename|Removable|RemovableIfEmpty|RemoveAtDestroy|Destructive));
-
-       if (!copy) {
-               _playlist = p;
-               _playlist_offset = begin;
-               _playlist_length = len;
-       } else {
-               _playlist.reset (new AudioPlaylist (p, begin, len, "XXXNAMEXXX", true));
-               _playlist_offset = 0;
-               _playlist_length = len;
-       }
-
-       _length = len;
-       _peak_path = Glib::build_filename (_session.session_directory().peak_path().to_string(), name);
-       _level = _playlist->max_source_level () + 1;
-       ensure_buffers_for_level (_level);
+       AudioSource::_length = len;
+       ensure_buffers_for_level (_level, _session.frame_rate());
 }
 
 AudioPlaylistSource::AudioPlaylistSource (Session& s, const XMLNode& node)
-       : Source (s, DataType::AUDIO, "toBeRenamed")
+       : Source (s, node)
+       , PlaylistSource (s, node)
        , AudioSource (s, node)
 {
        /* PlaylistSources are never writable, renameable, removable or destructive */
        _flags = Flag (_flags & ~(Writable|CanRename|Removable|RemovableIfEmpty|RemoveAtDestroy|Destructive));
-       
-       set_state (node, 3000);
+
+       /* ancestors have already called ::set_state() in their XML-based
+          constructors.
+       */
+
+       if (set_state (node, Stateful::loading_state_version, false)) {
+               throw failed_constructor ();
+       }
+
+       AudioSource::_length = _playlist_length;
 }
 
 AudioPlaylistSource::~AudioPlaylistSource ()
@@ -90,61 +80,38 @@ AudioPlaylistSource::get_state ()
 {
        XMLNode& node (AudioSource::get_state ());
        char buf[64];
-       snprintf (buf, sizeof (buf), "%" PRIi64, _playlist_offset);
-       node.add_property ("offset", buf);
-       snprintf (buf, sizeof (buf), "%" PRIu64, _playlist_length);
-       node.add_property ("length", buf);
+
+       /* merge PlaylistSource state */
+
+       PlaylistSource::add_state (node);
+
        snprintf (buf, sizeof (buf), "%" PRIu32, _playlist_channel);
        node.add_property ("channel", buf);
-       node.add_property ("name", name());
-       node.add_property ("peak-path", _peak_path);
 
        return node;
 }
 
 int
-AudioPlaylistSource::set_state (const XMLNode& node, int /* version */) 
+AudioPlaylistSource::set_state (const XMLNode& node, int version)
 {
-       /* get playlist ID */
-
-       const XMLProperty *prop = node.property (X_("playlist"));
-
-       if (!prop) {
-               throw failed_constructor ();
-       }
-
-       PBD::ID id (prop->value());
-
-       /* get playlist */
-
-       boost::shared_ptr<Playlist> p = _session.playlists->by_id (id);
-       _playlist = boost::dynamic_pointer_cast<AudioPlaylist>(p);
+       return set_state (node, version, true);
+}
 
-       if (!_playlist) {
-               throw failed_constructor ();
+int
+AudioPlaylistSource::set_state (const XMLNode& node, int version, bool with_descendants)
+{
+       if (with_descendants) {
+               if (Source::set_state (node, version) ||
+                   PlaylistSource::set_state (node, version) ||
+                   AudioSource::set_state (node, version)) {
+                       return -1;
+               }
        }
 
+       const XMLProperty* prop;
        pair<framepos_t,framepos_t> extent = _playlist->get_extent();
-       _length = extent.second - extent.first;
-
-       /* other properties */
-
-       if ((prop = node.property (X_("name"))) == 0) {
-               throw failed_constructor ();
-       }
-       
-       set_name (prop->value());
-
-       if ((prop = node.property (X_("offset"))) == 0) {
-               throw failed_constructor ();
-       }
-       sscanf (prop->value().c_str(), "%" PRIi64, &_playlist_offset);
-
-       if ((prop = node.property (X_("length"))) == 0) {
-               throw failed_constructor ();
-       }
 
-       sscanf (prop->value().c_str(), "%" PRIu64, &_playlist_length);
+       AudioSource::_length = extent.second - extent.first;
 
        if ((prop = node.property (X_("channel"))) == 0) {
                throw failed_constructor ();
@@ -152,26 +119,18 @@ AudioPlaylistSource::set_state (const XMLNode& node, int /* version */)
 
        sscanf (prop->value().c_str(), "%" PRIu32, &_playlist_channel);
 
-       if ((prop = node.property (X_("peak-path"))) == 0) {
-               throw failed_constructor ();
-       }
-
-       _peak_path = prop->value ();
-
-       _level = _playlist->max_source_level () + 1;
-       ensure_buffers_for_level (_level);
+       ensure_buffers_for_level (_level, _session.frame_rate());
 
        return 0;
 }
 
-framecnt_t 
+framecnt_t
 AudioPlaylistSource::read_unlocked (Sample* dst, framepos_t start, framecnt_t cnt) const
 {
-       Sample* sbuf;
-       gain_t* gbuf;
+       boost::shared_array<Sample> sbuf;
+       boost::shared_array<gain_t> gbuf;
        framecnt_t to_read;
        framecnt_t to_zero;
-       pair<framepos_t,framepos_t> extent = _playlist->get_extent();
 
        /* we must be careful not to read beyond the end of our "section" of
         * the playlist, because otherwise we may read data that exists, but
@@ -186,18 +145,18 @@ AudioPlaylistSource::read_unlocked (Sample* dst, framepos_t start, framecnt_t cn
                to_zero = 0;
        }
 
-       { 
+       {
                /* Don't need to hold the lock for the actual read, and
                   actually, we cannot, but we do want to interlock
                   with any changes to the list of buffers caused
                   by creating new nested playlists/sources
                */
-               Glib::Mutex::Lock lm (_level_buffer_lock);
+               Glib::Threads::Mutex::Lock lm (_level_buffer_lock);
                sbuf = _mixdown_buffers[_level-1];
                gbuf = _gain_buffers[_level-1];
        }
 
-       _playlist->read (dst, sbuf, gbuf, start+_playlist_offset, to_read, _playlist_channel);
+       boost::dynamic_pointer_cast<AudioPlaylist>(_playlist)->read (dst, sbuf.get(), gbuf.get(), start+_playlist_offset, to_read, _playlist_channel);
 
        if (to_zero) {
                memset (dst+to_read, 0, sizeof (Sample) * to_zero);
@@ -206,11 +165,11 @@ AudioPlaylistSource::read_unlocked (Sample* dst, framepos_t start, framecnt_t cn
        return cnt;
 }
 
-framecnt_t 
-AudioPlaylistSource::write_unlocked (Sample *src, framecnt_t cnt) 
+framecnt_t
+AudioPlaylistSource::write_unlocked (Sample *, framecnt_t)
 {
        fatal << string_compose (_("programming error: %1"), "AudioPlaylistSource::write() called - should be impossible") << endmsg;
-       /*NOTREACHED*/
+       abort(); /*NOTREACHED*/
        return 0;
 }
 
@@ -253,24 +212,14 @@ AudioPlaylistSource::sample_rate () const
 int
 AudioPlaylistSource::setup_peakfile ()
 {
-       /* the peak data is setup once and once only 
-        */
-       
-       if (!Glib::file_test (_peak_path, Glib::FILE_TEST_EXISTS)) {
-               /* the 2nd argument here will be passed
-                  in to ::peak_path, and is irrelevant
-                  since our peak file path is fixed and
-                  not dependent on anything.
-               */
-               return initialize_peakfile (false, string());
-       }
-
-       return 0;
+       _peak_path = Glib::build_filename (_session.session_directory().peak_path(), name() + ARDOUR::peakfile_suffix);
+       return initialize_peakfile (string());
 }
 
 string
-AudioPlaylistSource::peak_path (string /*audio_path*/)
+AudioPlaylistSource::construct_peak_filepath (const string& /*audio_path_*/, const bool /* in_session */, const bool /* old_peak_name */) const
 {
        return _peak_path;
 }
 
+