fix crash when copy'ing latent plugins
[ardour.git] / libs / ardour / region_factory.cc
index 1fd81f9a4bcea818bdb2689220c1730ea522e97a..16a9e02e378cf0f6835fe81bb973e4b5e8892c34 100644 (file)
 
 #include <inttypes.h>
 
+#include "pbd/basename.h"
 #include "pbd/error.h"
-#include "pbd/boost_debug.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 "ardour/midi_source.h"
+#include "ardour/region.h"
+#include "ardour/region_factory.h"
+#include "ardour/session.h"
 
-#include "i18n.h"
+#include "pbd/i18n.h"
 
 using namespace ARDOUR;
 using namespace PBD;
+using namespace std;
 
 PBD::Signal1<void,boost::shared_ptr<Region> > RegionFactory::CheckNewRegion;
-Glib::StaticMutex                             RegionFactory::region_map_lock;
+Glib::Threads::Mutex                          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;
+PBD::ScopedConnectionList*                    RegionFactory::region_list_connections = 0;
+Glib::Threads::Mutex                          RegionFactory::region_name_maps_mutex;
+std::map<std::string, uint32_t>               RegionFactory::region_name_number_map;
+std::map<std::string, PBD::ID>                RegionFactory::region_name_map;
+RegionFactory::CompoundAssociations           RegionFactory::_compound_associations;
 
 boost::shared_ptr<Region>
-RegionFactory::create (boost::shared_ptr<const Region> region, bool announce)
+RegionFactory::create (boost::shared_ptr<const Region> region, bool announce, const int32_t sub_num)
 {
        boost::shared_ptr<Region> ret;
        boost::shared_ptr<const AudioRegion> ar;
@@ -53,30 +54,50 @@ RegionFactory::create (boost::shared_ptr<const Region> region, bool announce)
 
        if ((ar = boost::dynamic_pointer_cast<const AudioRegion>(region)) != 0) {
 
-               ret = boost::shared_ptr<Region> (new AudioRegion (ar, 0));
+               ret = boost::shared_ptr<Region> (new AudioRegion (ar, 0, sub_num));
 
        } else if ((mr = boost::dynamic_pointer_cast<const MidiRegion>(region)) != 0) {
 
-               ret = boost::shared_ptr<Region> (new MidiRegion (mr, 0));
+               if (mr->session().config.get_midi_copy_is_fork()) {
+                       /* What we really want to do here is what Editor::fork_region()
+                          does via Session::create_midi_source_by_stealing_name(), but we
+                          don't have a Track.  We'll just live with the skipped number,
+                          and store the ancestral name of sources so multiple clones
+                          generates reasonable names that don't have too many suffixes. */
+                       const std::string ancestor_name = mr->sources().front()->ancestor_name();
+                       const std::string base          = PBD::basename_nosuffix(ancestor_name);
+
+                       boost::shared_ptr<MidiSource> source = mr->session().create_midi_source_for_session(base);
+                       source->set_ancestor_name(mr->sources().front()->name());
+                       ret = mr->clone(source);
+               } else {
+                       ret = boost::shared_ptr<Region> (new MidiRegion (mr, 0, sub_num));
+               }
 
        } else {
                fatal << _("programming error: RegionFactory::create() called with unknown Region type")
                      << endmsg;
-               /*NOTREACHED*/
+               abort(); /*NOTREACHED*/
        }
 
        if (ret) {
                ret->set_name (new_region_name(ret->name()));
-               map_add (ret);
+
+               if (ret->session().config.get_glue_new_regions_to_bars_and_beats() && ret->position_lock_style() != MusicTime) {
+                       ret->set_position_lock_style (MusicTime);
+               }
+
+               ret->set_position (region->position(), sub_num);
 
                /* pure copy constructor - no property list */
                if (announce) {
+                       map_add (ret);
                        CheckNewRegion (ret);
                }
        }
 
 #ifdef BOOST_SP_ENABLE_DEBUG_HOOKS
-       boost_debug_shared_ptr_mark_interesting (ret.get(), "Region");
+       // boost_debug_shared_ptr_mark_interesting (ret.get(), "Region");
 #endif
        return ret;
 }
@@ -99,27 +120,31 @@ RegionFactory::create (boost::shared_ptr<Region> region, const PropertyList& pli
        } else {
                fatal << _("programming error: RegionFactory::create() called with unknown Region type")
                      << endmsg;
-               /*NOTREACHED*/
+               abort(); /*NOTREACHED*/
                return boost::shared_ptr<Region>();
        }
 
        if (ret) {
                ret->apply_changes (plist);
-               map_add (ret);
+
+               if (ret->session().config.get_glue_new_regions_to_bars_and_beats() && ret->position_lock_style() != MusicTime) {
+                       ret->set_position_lock_style (MusicTime);
+               }
 
                if (announce) {
+                       map_add (ret);
                        CheckNewRegion (ret);
                }
        }
 
-#ifdef BOOST_SP_ENABLE_DEBUG_HOOKS     
-        boost_debug_shared_ptr_mark_interesting (ret.get(), "Region");
+#ifdef BOOST_SP_ENABLE_DEBUG_HOOKS
+        // boost_debug_shared_ptr_mark_interesting (ret.get(), "Region");
 #endif
        return ret;
 }
 
 boost::shared_ptr<Region>
-RegionFactory::create (boost::shared_ptr<Region> region, frameoffset_t offset, const PropertyList& plist, bool announce)
+RegionFactory::create (boost::shared_ptr<Region> region, frameoffset_t offset, const PropertyList& plist, bool announce, const int32_t sub_num)
 {
        boost::shared_ptr<Region> ret;
        boost::shared_ptr<const AudioRegion> other_a;
@@ -127,30 +152,34 @@ RegionFactory::create (boost::shared_ptr<Region> region, frameoffset_t offset, c
 
        if ((other_a = boost::dynamic_pointer_cast<AudioRegion>(region)) != 0) {
 
-               ret = boost::shared_ptr<Region> (new AudioRegion (other_a, offset));
-               
+               ret = boost::shared_ptr<Region> (new AudioRegion (other_a, offset, sub_num));
+
        } else if ((other_m = boost::dynamic_pointer_cast<MidiRegion>(region)) != 0) {
 
-               ret = boost::shared_ptr<Region> (new MidiRegion (other_m, offset));
+               ret = boost::shared_ptr<Region> (new MidiRegion (other_m, offset, sub_num));
 
        } else {
                fatal << _("programming error: RegionFactory::create() called with unknown Region type")
                      << endmsg;
-               /*NOTREACHED*/
+               abort(); /*NOTREACHED*/
                return boost::shared_ptr<Region>();
        }
 
        if (ret) {
                ret->apply_changes (plist);
-               map_add (ret);
+
+               if (ret->session().config.get_glue_new_regions_to_bars_and_beats() && ret->position_lock_style() != MusicTime) {
+                       ret->set_position_lock_style (MusicTime);
+               }
 
                if (announce) {
+                       map_add (ret);
                        CheckNewRegion (ret);
                }
        }
 
 #ifdef BOOST_SP_ENABLE_DEBUG_HOOKS
-       boost_debug_shared_ptr_mark_interesting (ret.get(), "Region");
+       // boost_debug_shared_ptr_mark_interesting (ret.get(), "Region");
 #endif
        return ret;
 }
@@ -168,26 +197,30 @@ RegionFactory::create (boost::shared_ptr<Region> region, const SourceList& srcs,
        if ((other = boost::dynamic_pointer_cast<AudioRegion>(region)) != 0) {
 
                // XXX use me in caller where plist is setup, this is start i think srcs.front()->length (srcs.front()->timeline_position())
-               
+
                ret = boost::shared_ptr<Region> (new AudioRegion (other, srcs));
 
        } else {
                fatal << _("programming error: RegionFactory::create() called with unknown Region type")
                      << endmsg;
-               /*NOTREACHED*/
+               abort(); /*NOTREACHED*/
        }
 
        if (ret) {
                ret->apply_changes (plist);
-               map_add (ret);
+
+               if (ret->session().config.get_glue_new_regions_to_bars_and_beats() && ret->position_lock_style() != MusicTime) {
+                       ret->set_position_lock_style (MusicTime);
+               }
 
                if (announce) {
+                       map_add (ret);
                        CheckNewRegion (ret);
                }
        }
 
-#ifdef BOOST_SP_ENABLE_DEBUG_HOOKS     
-        boost_debug_shared_ptr_mark_interesting (ret.get(), "Region");
+#ifdef BOOST_SP_ENABLE_DEBUG_HOOKS
+        // boost_debug_shared_ptr_mark_interesting (ret.get(), "Region");
 #endif
        return ret;
 }
@@ -203,7 +236,7 @@ RegionFactory::create (boost::shared_ptr<Source> src, const PropertyList& plist,
 boost::shared_ptr<Region>
 RegionFactory::create (const SourceList& srcs, const PropertyList& plist, bool announce)
 {
-       boost::shared_ptr<Region> ret; 
+       boost::shared_ptr<Region> ret;
        boost::shared_ptr<AudioSource> as;
        boost::shared_ptr<MidiSource> ms;
 
@@ -219,15 +252,19 @@ RegionFactory::create (const SourceList& srcs, const PropertyList& plist, bool a
 
        if (ret) {
                ret->apply_changes (plist);
-               map_add (ret);
+
+               if (ret->session().config.get_glue_new_regions_to_bars_and_beats() && ret->position_lock_style() != MusicTime) {
+                       ret->set_position_lock_style (MusicTime);
+               }
 
                if (announce) {
+                       map_add (ret);
                        CheckNewRegion (ret);
                }
        }
 
 #ifdef BOOST_SP_ENABLE_DEBUG_HOOKS
-       boost_debug_shared_ptr_mark_interesting (ret.get(), "Region");
+       // boost_debug_shared_ptr_mark_interesting (ret.get(), "Region");
 #endif
        return ret;
 }
@@ -252,7 +289,7 @@ RegionFactory::create (SourceList& srcs, const XMLNode& node)
                ret = boost::shared_ptr<Region> (new AudioRegion (srcs));
 
        } else if (srcs[0]->type() == DataType::MIDI) {
-               
+
                ret = boost::shared_ptr<Region> (new MidiRegion (srcs));
 
        }
@@ -262,12 +299,17 @@ RegionFactory::create (SourceList& srcs, const XMLNode& node)
                        ret.reset ();
                } else {
                        map_add (ret);
+
+                       /* Don't fiddle with position_lock_style here as the region
+                          description is coming from XML.
+                       */
+
                        CheckNewRegion (ret);
                }
        }
 
 #ifdef BOOST_SP_ENABLE_DEBUG_HOOKS
-       boost_debug_shared_ptr_mark_interesting (ret.get(), "Region");
+       // boost_debug_shared_ptr_mark_interesting (ret.get(), "Region");
 #endif
        return ret;
 }
@@ -279,51 +321,38 @@ RegionFactory::map_add (boost::shared_ptr<Region> r)
        p.first = r->id();
        p.second = r;
 
-       { 
-               Glib::Mutex::Lock lm (region_map_lock);
+       {
+               Glib::Threads::Mutex::Lock lm (region_map_lock);
                region_map.insert (p);
        }
 
-       r->DropReferences.connect_same_thread (region_list_connections, boost::bind (&RegionFactory::map_remove, r));
+       if (!region_list_connections) {
+               region_list_connections = new ScopedConnectionList;
+       }
 
-       r->PropertyChanged.connect_same_thread (
-               region_list_connections,
-               boost::bind (&RegionFactory::region_changed, _1, boost::weak_ptr<Region> (r))
-               );
+       r->DropReferences.connect_same_thread (*region_list_connections, boost::bind (&RegionFactory::map_remove, boost::weak_ptr<Region> (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);
+       add_to_region_name_maps (r);
 }
 
 void
-RegionFactory::map_remove (boost::shared_ptr<Region> r)
+RegionFactory::map_remove (boost::weak_ptr<Region> w)
 {
-       Glib::Mutex::Lock lm (region_map_lock);
+       boost::shared_ptr<Region> r = w.lock ();
+       if (!r) {
+               return;
+       }
+
+       Glib::Threads::Mutex::Lock lm (region_map_lock);
        RegionMap::iterator i = region_map.find (r->id());
 
        if (i != region_map.end()) {
+               remove_from_region_name_map (i->second->name ());
                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)
 {
@@ -345,7 +374,7 @@ RegionFactory::wholefile_region_by_name (const std::string& name)
                }
        }
        return boost::shared_ptr<Region>();
-}      
+}
 
 boost::shared_ptr<Region>
 RegionFactory::region_by_name (const std::string& name)
@@ -356,18 +385,21 @@ RegionFactory::region_by_name (const std::string& name)
                }
        }
        return boost::shared_ptr<Region>();
-}      
+}
 
 void
 RegionFactory::clear_map ()
 {
-       region_list_connections.drop_connections ();
+       if (region_list_connections) {
+               region_list_connections->drop_connections ();
+       }
 
        {
-               Glib::Mutex::Lock lm (region_map_lock);
+               Glib::Threads::Mutex::Lock lm (region_map_lock);
                region_map.clear ();
+               _compound_associations.clear ();
+               region_name_map.clear ();
        }
-
 }
 
 void
@@ -377,7 +409,7 @@ RegionFactory::delete_all_regions ()
 
        /* copy region list */
        {
-               Glib::Mutex::Lock lm (region_map_lock);
+               Glib::Threads::Mutex::Lock lm (region_map_lock);
                copy = region_map;
        }
 
@@ -393,16 +425,57 @@ RegionFactory::delete_all_regions ()
           vanish as we leave this scope, thus calling all destructors.
        */
 }
-        
+
 uint32_t
 RegionFactory::nregions ()
 {
-       Glib::Mutex::Lock lm (region_map_lock);
+       Glib::Threads::Mutex::Lock lm (region_map_lock);
        return region_map.size ();
 }
 
+/** Add a region to the two region name maps */
+void
+RegionFactory::add_to_region_name_maps (boost::shared_ptr<Region> region)
+{
+       update_region_name_number_map (region);
+
+       Glib::Threads::Mutex::Lock lm (region_name_maps_mutex);
+       region_name_map[region->name()] = region->id ();
+}
+
+/** Account for a region rename in the two region name maps */
+void
+RegionFactory::rename_in_region_name_maps (boost::shared_ptr<Region> region)
+{
+       update_region_name_number_map (region);
+
+       Glib::Threads::Mutex::Lock lm (region_name_maps_mutex);
+
+       map<string, PBD::ID>::iterator i = region_name_map.begin();
+       while (i != region_name_map.end() && i->second != region->id ()) {
+               ++i;
+       }
+
+       /* Erase the entry for the old name and put in a new one */
+       if (i != region_name_map.end()) {
+               region_name_map.erase (i);
+               region_name_map[region->name()] = region->id ();
+       }
+}
+
+/** Remove a region's details from the region_name_map */
+void
+RegionFactory::remove_from_region_name_map (string n)
+{
+       map<string, PBD::ID>::iterator i = region_name_map.find (n);
+       if (i != region_name_map.end ()) {
+               region_name_map.erase (i);
+       }
+}
+
+/** Update a region's entry in the region_name_number_map */
 void
-RegionFactory::update_region_name_map (boost::shared_ptr<Region> region)
+RegionFactory::update_region_name_number_map (boost::shared_ptr<Region> region)
 {
        string::size_type const last_period = region->name().find_last_of ('.');
 
@@ -415,8 +488,8 @@ RegionFactory::update_region_name_map (boost::shared_ptr<Region> region)
                   which is just fine
                */
 
-               Glib::Mutex::Lock lm (region_name_map_lock);
-               region_name_map[base] = atoi (number.c_str ());
+               Glib::Threads::Mutex::Lock lm (region_name_maps_mutex);
+               region_name_number_map[base] = atoi (number.c_str ());
        }
 }
 
@@ -429,7 +502,7 @@ RegionFactory::region_changed (PropertyChange const & what_changed, boost::weak_
        }
 
        if (what_changed.contains (Properties::name)) {
-               update_region_name_map (r);
+               rename_in_region_name_maps (r);
        }
 }
 
@@ -465,15 +538,15 @@ RegionFactory::region_name (string& result, string base, bool newlevel)
                }
 
                {
-                       Glib::Mutex::Lock lm (region_name_map_lock);
+                       Glib::Threads::Mutex::Lock lm (region_name_maps_mutex);
 
                        map<string,uint32_t>::iterator x;
 
                        result = subbase;
 
-                       if ((x = region_name_map.find (subbase)) == region_name_map.end()) {
+                       if ((x = region_name_number_map.find (subbase)) == region_name_number_map.end()) {
                                result += ".1";
-                               region_name_map[subbase] = 1;
+                               region_name_number_map[subbase] = 1;
                        } else {
                                x->second++;
                                snprintf (buf, sizeof (buf), ".%d", x->second);
@@ -486,13 +559,24 @@ RegionFactory::region_name (string& result, string base, bool newlevel)
        return 0;
 }
 
+string
+RegionFactory::compound_region_name (const string& playlist, uint32_t compound_ops, uint32_t depth, bool whole_source)
+{
+       if (whole_source) {
+               return string_compose (_("%1 compound-%2 (%3)"), playlist, compound_ops+1, depth+1);
+       } else {
+               return string_compose (_("%1 compound-%2.1 (%3)"), playlist, compound_ops+1, depth+1);
+       }
+}
+
 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];
+       string remainder;
+       std::vector<char> buf(len);
 
        if ((last_period = old.find_last_of ('.')) == string::npos) {
 
@@ -504,48 +588,84 @@ RegionFactory::new_region_name (string old)
 
        } else {
 
-               number = atoi (old.substr (last_period+1).c_str());
+               if (last_period < old.length() - 1) {
+
+                       string period_to_end = old.substr (last_period+1);
 
+                       /* extra material after the period */
+
+                       string::size_type numerals_end = period_to_end.find_first_not_of ("0123456789");
+
+                       number = atoi (period_to_end);
+
+                       if (numerals_end < period_to_end.length() - 1) {
+                               /* extra material after the end of the digits */
+                               remainder = period_to_end.substr (numerals_end);
+                       }
+
+               } else {
+                       last_period = old.length();
+                       number = 0;
+               }
        }
 
        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;
-                       }
-               }
+               snprintf (&buf[0], len, "%s%" PRIu32 "%s", old.substr (0, last_period + 1).c_str(), number, remainder.c_str());
+               sbuf = &buf[0];
 
-               if (i == regions.end()) {
+               if (region_name_map.find (sbuf) == region_name_map.end ()) {
                        break;
                }
        }
 
        if (number != (UINT_MAX-1)) {
-               return buf;
+               return &buf[0];
        }
 
        error << string_compose (_("cannot create new name for region \"%1\""), old) << endmsg;
        return old;
 }
 
-void 
+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);
+       Glib::Threads::Mutex::Lock lm (region_map_lock);
 
-       for (RegionMap::iterator i = region_map.begin(); i != region_map.end(); ++i) {
+       for (RegionMap::const_iterator i = region_map.begin(); i != region_map.end(); ++i) {
                if (i->second->uses_source (s)) {
                        r.insert (i->second);
                }
        }
 }
+
+void
+RegionFactory::remove_regions_using_source (boost::shared_ptr<Source> src)
+{
+       Glib::Threads::Mutex::Lock lm (region_map_lock);
+
+       RegionMap::iterator i = region_map.begin();
+       while (i != region_map.end()) {
+
+               RegionMap::iterator j = i;
+               ++j;
+
+               if (i->second->uses_source (src)) {
+                       remove_from_region_name_map (i->second->name ());
+                       region_map.erase (i);
+                }
+
+               i = j;
+       }
+}
+
+void
+RegionFactory::add_compound_association (boost::shared_ptr<Region> orig, boost::shared_ptr<Region> copy)
+{
+       Glib::Threads::Mutex::Lock lm (region_map_lock);
+       _compound_associations[copy] = orig;
+}