(Hopefully) clarify operator= and copy construction behaviour of the Property hierarc...
[ardour.git] / libs / ardour / region_factory.cc
index 631c27b42f8a3077b6c723d6528342a921c240e6..a8b0d436d64ac0334ac0cb8d8ebe5f6a1baa19de 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2000-2006 Paul Davis 
+    Copyright (C) 2000-2006 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
 
 */
 
-#include <pbd/error.h>
+#define __STDC_FORMAT_MACROS
+#include <inttypes.h>
 
-#include <ardour/session.h>
+#include "pbd/error.h"
+#include "pbd/boost_debug.h"
 
-#include <ardour/region_factory.h>
-#include <ardour/region.h>
-#include <ardour/audioregion.h>
-#include <ardour/audiosource.h>
+#include "ardour/session.h"
+
+#include "ardour/region_factory.h"
+#include "ardour/region.h"
+#include "ardour/audioregion.h"
+#include "ardour/audiosource.h"
+#include "ardour/midi_source.h"
+#include "ardour/midi_region.h"
+#include "ardour/utils.h"
 
 #include "i18n.h"
 
 using namespace ARDOUR;
 using namespace PBD;
 
-sigc::signal<void,boost::shared_ptr<Region> > RegionFactory::CheckNewRegion;
+PBD::Signal1<void,boost::shared_ptr<Region> > RegionFactory::CheckNewRegion;
+Glib::StaticMutex RegionFactory::region_map_lock;
+RegionFactory::RegionMap RegionFactory::region_map;
+PBD::ScopedConnectionList RegionFactory::region_list_connections;
+Glib::StaticMutex RegionFactory::region_name_map_lock;
+std::map<std::string, uint32_t> RegionFactory::region_name_map;
 
 boost::shared_ptr<Region>
-RegionFactory::create (boost::shared_ptr<Region> region, nframes_t start, 
-                            nframes_t length, std::string name, 
-                            layer_t layer, Region::Flag flags, bool announce)
+RegionFactory::create (boost::shared_ptr<const Region> region)
 {
-       boost::shared_ptr<const AudioRegion> other;
+       boost::shared_ptr<Region> ret;
+       boost::shared_ptr<const AudioRegion> ar;
+       boost::shared_ptr<const MidiRegion> mr;
+
+       if ((ar = boost::dynamic_pointer_cast<const AudioRegion>(region)) != 0) {
+
+               AudioRegion* arn = new AudioRegion (ar, 0, true);
+               boost_debug_shared_ptr_mark_interesting (arn, "Region");
+
+               boost::shared_ptr<AudioRegion> arp (arn);
+               ret = boost::static_pointer_cast<Region> (arp);
+
+       } else if ((mr = boost::dynamic_pointer_cast<const MidiRegion>(region)) != 0) {
+
+               MidiRegion* mrn = new MidiRegion (mr, 0, true);
+               boost::shared_ptr<MidiRegion> mrp (mrn);
+               ret = boost::static_pointer_cast<Region> (mrp);
+
+       } else {
+               fatal << _("programming error: RegionFactory::create() called with unknown Region type")
+                     << endmsg;
+               /*NOTREACHED*/
+       }
+
+       if (ret) {
+               map_add (ret);
+
+               /* pure copy constructor - no property list */
+               /* pure copy constructor - no CheckNewRegion emitted */
+       }
+
+       return ret;
+}
+
+boost::shared_ptr<Region>
+RegionFactory::create (boost::shared_ptr<Region> region, frameoffset_t offset, const PropertyList& plist, bool announce)
+{
+       return create (region, offset, true, plist, announce);
+}
+
+boost::shared_ptr<Region>
+RegionFactory::create (boost::shared_ptr<Region> region, const PropertyList& plist, bool announce)
+{
+       return create (region, 0, false, plist, announce);
+}
+
+boost::shared_ptr<Region>
+RegionFactory::create (boost::shared_ptr<Region> region, frameoffset_t offset, bool offset_relative, const PropertyList& plist, bool announce)
+{
+       boost::shared_ptr<Region> ret;
+       boost::shared_ptr<const AudioRegion> other_a;
+       boost::shared_ptr<const MidiRegion> other_m;
+
+       if ((other_a = boost::dynamic_pointer_cast<AudioRegion>(region)) != 0) {
+
+               AudioRegion* ar = new AudioRegion (other_a, offset, offset_relative);
+               boost_debug_shared_ptr_mark_interesting (ar, "Region");
 
-       if ((other = boost::dynamic_pointer_cast<AudioRegion>(region)) != 0) {
-               AudioRegion* ar = new AudioRegion (other, start, length, name, layer, flags);
                boost::shared_ptr<AudioRegion> arp (ar);
-               boost::shared_ptr<Region> ret (boost::static_pointer_cast<Region> (arp));
-               if (announce) {
-                       CheckNewRegion (ret);
-               }
-               return ret;
+               ret = boost::static_pointer_cast<Region> (arp);
+
+       } else if ((other_m = boost::dynamic_pointer_cast<MidiRegion>(region)) != 0) {
+
+               MidiRegion* mr = new MidiRegion (other_m, offset, offset_relative);
+               boost::shared_ptr<MidiRegion> mrp (mr);
+               ret = boost::static_pointer_cast<Region> (mrp);
+
        } else {
                fatal << _("programming error: RegionFactory::create() called with unknown Region type")
                      << endmsg;
                /*NOTREACHED*/
                return boost::shared_ptr<Region>();
        }
+
+       if (ret) {
+               ret->apply_changes (plist);
+               map_add (ret);
+
+               if (announce) {
+                       CheckNewRegion (ret);
+               }
+       }
+
+       return ret;
 }
 
 boost::shared_ptr<Region>
-RegionFactory::create (boost::shared_ptr<Region> region)
+RegionFactory::create (boost::shared_ptr<Region> region, const SourceList& srcs, const PropertyList& plist, bool announce)
 {
-       boost::shared_ptr<AudioRegion> other;
-       
+       boost::shared_ptr<Region> ret;
+       boost::shared_ptr<const AudioRegion> other;
+
+       /* used by AudioFilter when constructing a new region that is intended to have nearly
+          identical settings to an original, but using different sources.
+       */
+
        if ((other = boost::dynamic_pointer_cast<AudioRegion>(region)) != 0) {
-               boost::shared_ptr<Region> ret (new AudioRegion (other));
-               /* pure copy constructor - no CheckNewRegion emitted */
-               return ret;
+
+               // XXX use me in caller where plist is setup, this is start i think srcs.front()->length (srcs.front()->timeline_position())
+               
+               AudioRegion* ar = new AudioRegion (other, srcs);
+               boost_debug_shared_ptr_mark_interesting (ar, "Region");
+
+               boost::shared_ptr<AudioRegion> arp (ar);
+               ret = boost::static_pointer_cast<Region> (arp);
+
        } else {
                fatal << _("programming error: RegionFactory::create() called with unknown Region type")
                      << endmsg;
                /*NOTREACHED*/
-               return boost::shared_ptr<Region>();
        }
+
+       if (ret) {
+
+               ret->apply_changes (plist);
+               map_add (ret);
+
+               if (announce) {
+                       CheckNewRegion (ret);
+               }
+       }
+
+       return ret;
+
 }
 
 boost::shared_ptr<Region>
-RegionFactory::create (boost::shared_ptr<AudioRegion> region, nframes_t start, 
-                            nframes_t length, std::string name, 
-                            layer_t layer, Region::Flag flags, bool announce)
+RegionFactory::create (boost::shared_ptr<Source> src, const PropertyList& plist, bool announce)
 {
-       return create (boost::static_pointer_cast<Region> (region), start, length, name, layer, flags, announce);
+       SourceList srcs;
+       srcs.push_back (src);
+       return create (srcs, plist, announce);
+}
+
+boost::shared_ptr<Region>
+RegionFactory::create (const SourceList& srcs, const PropertyList& plist, bool announce)
+{
+       boost::shared_ptr<Region> ret; 
+       boost::shared_ptr<AudioSource> as;
+       boost::shared_ptr<MidiSource> ms;
+
+       if ((as = boost::dynamic_pointer_cast<AudioSource>(srcs[0])) != 0) {
+
+               AudioRegion* ar = new AudioRegion (srcs);
+               boost_debug_shared_ptr_mark_interesting (ar, "Region");
+
+               boost::shared_ptr<AudioRegion> arp (ar);
+               ret = boost::static_pointer_cast<Region> (arp);
+
+       } else if ((ms = boost::dynamic_pointer_cast<MidiSource>(srcs[0])) != 0) {
+               MidiRegion* mr = new MidiRegion (srcs);
+               boost_debug_shared_ptr_mark_interesting (mr, "Region");
+
+               boost::shared_ptr<MidiRegion> mrp (mr);
+               ret = boost::static_pointer_cast<Region> (mrp);
+       }
+
+       if (ret) {
+
+               ret->apply_changes (plist);
+               map_add (ret);
+
+               if (announce) {
+                       CheckNewRegion (ret);
+               }
+       }
+
+       return ret;
 }
 
 boost::shared_ptr<Region>
 RegionFactory::create (Session& session, XMLNode& node, bool yn)
 {
-       boost::shared_ptr<Region> r = session.XMLRegionFactory (node, yn);
-       CheckNewRegion (r);
-       return r;
+       return session.XMLRegionFactory (node, yn);
 }
-       
-boost::shared_ptr<Region> 
-RegionFactory::create (SourceList& srcs, nframes_t start, nframes_t length, const string& name, layer_t layer, Region::Flag flags, bool announce)
+
+boost::shared_ptr<Region>
+RegionFactory::create (SourceList& srcs, const XMLNode& node)
 {
-       boost::shared_ptr<AudioRegion> arp (new AudioRegion (srcs, start, length, name, layer, flags));
-       boost::shared_ptr<Region> ret (boost::static_pointer_cast<Region> (arp));
-       if (announce) {
-               CheckNewRegion (ret);
+       boost::shared_ptr<Region> ret;
+
+       if (srcs.empty()) {
+               return ret;
        }
+
+       if (srcs[0]->type() == DataType::AUDIO) {
+
+               AudioRegion* ar = new AudioRegion (srcs);
+               boost_debug_shared_ptr_mark_interesting (ar, "Region");
+
+               boost::shared_ptr<AudioRegion> arp (ar);
+               ret = boost::static_pointer_cast<Region> (arp);
+
+       } else if (srcs[0]->type() == DataType::MIDI) {
+               
+               MidiRegion* mr = new MidiRegion (srcs);
+
+               boost::shared_ptr<MidiRegion> mrp (mr);
+               ret = boost::static_pointer_cast<Region> (mrp);
+       }
+
+       if (ret) {
+
+               if (ret->set_state (node, Stateful::loading_state_version)) {
+                       ret.reset ();
+               } else {
+                       map_add (ret);
+                       CheckNewRegion (ret);
+               }
+       }
+
        return ret;
-}      
+}
 
-boost::shared_ptr<Region> 
-RegionFactory::create (SourceList& srcs, const XMLNode& node)
+void
+RegionFactory::map_add (boost::shared_ptr<Region> r)
 {
-       if (srcs.empty()) {
+       pair<ID,boost::shared_ptr<Region> > p;
+       p.first = r->id();
+       p.second = r;
+
+        { 
+                Glib::Mutex::Lock lm (region_map_lock);
+                region_map.insert (p);
+        }
+
+        r->DropReferences.connect_same_thread (region_list_connections, boost::bind (&RegionFactory::map_remove, r));
+
+       r->PropertyChanged.connect_same_thread (
+               region_list_connections,
+               boost::bind (&RegionFactory::region_changed, _1, boost::weak_ptr<Region> (r))
+               );
+
+       update_region_name_map (r);
+}
+
+void
+RegionFactory::map_remove (boost::shared_ptr<Region> r)
+{
+        Glib::Mutex::Lock lm (region_map_lock);
+        RegionMap::iterator i = region_map.find (r->id());
+
+        if (i != region_map.end()) {
+                region_map.erase (i);
+        }
+
+}
+
+void
+RegionFactory::map_remove_with_equivalents (boost::shared_ptr<Region> r)
+{
+        Glib::Mutex::Lock lm (region_map_lock);
+
+        for (RegionMap::iterator i = region_map.begin(); i != region_map.end(); ) {
+                RegionMap::iterator tmp = i;
+                ++tmp;
+
+                if (r->region_list_equivalent (i->second)) {
+                        region_map.erase (i);
+                } else if (r == i->second) {
+                        region_map.erase (i);
+                } 
+
+                i = tmp;
+        }
+
+
+}
+
+boost::shared_ptr<Region>
+RegionFactory::region_by_id (const PBD::ID& id)
+{
+       RegionMap::iterator i = region_map.find (id);
+
+       if (i == region_map.end()) {
+                cerr << "ID " << id << " not found in region map\n";
                return boost::shared_ptr<Region>();
        }
 
-       boost::shared_ptr<Region> ret (new AudioRegion (srcs, node));
-       CheckNewRegion (ret);
-       return ret;
+       return i->second;
 }
+       
+void
+RegionFactory::clear_map ()
+{
+        region_list_connections.drop_connections ();
+
+        {
+                Glib::Mutex::Lock lm (region_map_lock);
+                region_map.clear ();
+        }
 
-boost::shared_ptr<Region> 
-RegionFactory::create (boost::shared_ptr<Source> src, nframes_t start, nframes_t length, const string& name, layer_t layer, Region::Flag flags, bool announce)
+}
+
+void
+RegionFactory::delete_all_regions ()
 {
-       boost::shared_ptr<AudioSource> as;
+        RegionMap copy;
+
+        /* copy region list */
+        {
+                Glib::Mutex::Lock lm (region_map_lock);
+                copy = region_map;
+        }
+
+        /* clear existing map */
+        clear_map ();
+
+        /* tell everyone to drop references */
+        for (RegionMap::iterator i = copy.begin(); i != copy.end(); ++i) {
+                i->second->drop_references ();
+        }
+
+        /* the copy should now hold the only references, which will
+           vanish as we leave this scope, thus calling all destructors.
+        */
+}
+        
+uint32_t
+RegionFactory::nregions ()
+{
+        Glib::Mutex::Lock lm (region_map_lock);
+        return region_map.size ();
+}
+
+void
+RegionFactory::update_region_name_map (boost::shared_ptr<Region> region)
+{
+       string::size_type const last_period = region->name().find_last_of ('.');
+
+       if (last_period != string::npos && last_period < region->name().length() - 1) {
+
+               string const base = region->name().substr (0, last_period);
+               string const number = region->name().substr (last_period + 1);
+
+               /* note that if there is no number, we get zero from atoi,
+                  which is just fine
+               */
+
+               Glib::Mutex::Lock lm (region_name_map_lock);
+               region_name_map[base] = atoi (number.c_str ());
+       }
+}
+
+void
+RegionFactory::region_changed (PropertyChange const & what_changed, boost::weak_ptr<Region> w)
+{
+       boost::shared_ptr<Region> r = w.lock ();
+       if (!r) {
+               return;
+       }
+
+       if (what_changed.contains (Properties::name)) {
+               update_region_name_map (r);
+       }
+}
+
+int
+RegionFactory::region_name (string& result, string base, bool newlevel)
+{
+       char buf[16];
+       string subbase;
+
+       if (base.find("/") != string::npos) {
+               base = base.substr(base.find_last_of("/") + 1);
+       }
+
+       if (base == "") {
+
+               snprintf (buf, sizeof (buf), "%d", RegionFactory::nregions() + 1);
+               result = "region.";
+               result += buf;
+
+       } else {
+
+               if (newlevel) {
+                       subbase = base;
+               } else {
+                       string::size_type pos;
+
+                       pos = base.find_last_of ('.');
+
+                       /* pos may be npos, but then we just use entire base */
+
+                       subbase = base.substr (0, pos);
 
-       if ((as = boost::dynamic_pointer_cast<AudioSource>(src)) != 0) {
-               boost::shared_ptr<Region> ret (new AudioRegion (as, start, length, name, layer, flags));
-               if (announce) {
-                       CheckNewRegion (ret);
                }
-               return ret;
+
+               {
+                       Glib::Mutex::Lock lm (region_name_map_lock);
+
+                       map<string,uint32_t>::iterator x;
+
+                       result = subbase;
+
+                       if ((x = region_name_map.find (subbase)) == region_name_map.end()) {
+                               result += ".1";
+                               region_name_map[subbase] = 1;
+                       } else {
+                               x->second++;
+                               snprintf (buf, sizeof (buf), ".%d", x->second);
+
+                               result += buf;
+                       }
+               }
        }
 
-       return boost::shared_ptr<Region>();
+       return 0;
+}
+
+string
+RegionFactory::new_region_name (string old)
+{
+       string::size_type last_period;
+       uint32_t number;
+       string::size_type len = old.length() + 64;
+       char buf[len];
+
+       if ((last_period = old.find_last_of ('.')) == string::npos) {
+
+               /* no period present - add one explicitly */
+
+               old += '.';
+               last_period = old.length() - 1;
+               number = 0;
+
+       } else {
+
+               number = atoi (old.substr (last_period+1).c_str());
+
+       }
+
+       while (number < (UINT_MAX-1)) {
+               
+               const RegionMap& regions (RegionFactory::regions());
+               RegionMap::const_iterator i;
+               string sbuf;
+
+               number++;
+
+               snprintf (buf, len, "%s%" PRIu32, old.substr (0, last_period + 1).c_str(), number);
+               sbuf = buf;
+
+               for (i = regions.begin(); i != regions.end(); ++i) {
+                       if (i->second->name() == sbuf) {
+                               break;
+                       }
+               }
+
+               if (i == regions.end()) {
+                       break;
+               }
+       }
+
+       if (number != (UINT_MAX-1)) {
+               return buf;
+       }
+
+       error << string_compose (_("cannot create new name for region \"%1\""), old) << endmsg;
+       return old;
+}
+
+void 
+RegionFactory::get_regions_using_source (boost::shared_ptr<Source> s, std::set<boost::shared_ptr<Region> >& r)
+{
+        Glib::Mutex::Lock lm (region_map_lock);
+
+        for (RegionMap::iterator i = region_map.begin(); i != region_map.end(); ++i) {
+                if (i->second->uses_source (s)) {
+                        r.insert (i->second);
+                }
+        }
 }