rename all Evoral source from .(hpp|cpp)$ to .(h|cc)
[ardour.git] / libs / ardour / ardour / region_factory.h
index 471f172440509548d5aaf24fed11ef92127323d3..a3f61f88197528965eabc6c9fe0d44598f185b6e 100644 (file)
@@ -1,33 +1,38 @@
 /*
-    Copyright (C) 2000-2007 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
-    the Free Software Foundation; either version 2 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
-
-*/
+ * Copyright (C) 2000-2017 Paul Davis <paul@linuxaudiosystems.com>
+ * Copyright (C) 2006-2012 David Robillard <d@drobilla.net>
+ * Copyright (C) 2009-2012 Carl Hetherington <carl@carlh.net>
+ * Copyright (C) 2015-2017 Robin Gareus <robin@gareus.org>
+ * Copyright (C) 2016-2017 Nick Mainsbridge <mainsbridge@gmail.com>
+ * Copyright (C) 2018-2019 Ben Loftis <ben@harrisonconsoles.com>
+ *
+ * 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
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
 
 #ifndef __ardour_region_factory_h__
 #define __ardour_region_factory_h__
 
 #include <map>
 #include <set>
-#include <glibmm/thread.h>
+#include <glibmm/threads.h>
 
 #include "pbd/id.h"
 #include "pbd/property_list.h"
 #include "pbd/signals.h"
 
+#include "ardour/libardour_visibility.h"
 #include "ardour/types.h"
 
 class XMLNode;
@@ -38,7 +43,7 @@ namespace ARDOUR {
 class Session;
 class AudioRegion;
 
-class RegionFactory {
+class LIBARDOUR_API RegionFactory {
 public:
        typedef std::map<PBD::ID,boost::shared_ptr<Region> > RegionMap;
 
@@ -57,8 +62,11 @@ public:
        */
        static PBD::Signal1<void,boost::shared_ptr<Region> >  CheckNewRegion;
 
-       /** create a "pure copy" of Region @param other */
-       static boost::shared_ptr<Region> create (boost::shared_ptr<const Region> other, bool announce = false);
+       /** create a "pure copy" of Region \p other */
+       static boost::shared_ptr<Region> create (boost::shared_ptr<const Region> other, bool announce = false, bool fork = false);
+       static boost::shared_ptr<Region> create (boost::shared_ptr<Region> other, bool announce, bool fork) {
+               return create (boost::shared_ptr<const Region>(other), announce, fork);
+       }
 
        /** create a region from a single Source */
        static boost::shared_ptr<Region> create (boost::shared_ptr<Source>,
@@ -67,21 +75,23 @@ public:
        /** create a region from a multiple sources */
        static boost::shared_ptr<Region> create (const SourceList &,
                                                 const PBD::PropertyList&, bool announce = true);
-       /** create a copy of @other starting at zero within @param other's sources */
+       /** create a copy of \p other starting at zero within \p other's sources */
        static boost::shared_ptr<Region> create (boost::shared_ptr<Region> other,
                                                 const PBD::PropertyList&, bool announce = true);
-       /** create a copy of @param other starting at @param offset within @param other */
-       static boost::shared_ptr<Region> create (boost::shared_ptr<Region> other, frameoffset_t offset,
+       /** create a copy of \p other starting at \p offset within \p other */
+       static boost::shared_ptr<Region> create (boost::shared_ptr<Region> other, ARDOUR::MusicSample offset,
                                                 const PBD::PropertyList&, bool announce = true);
-       /** create a "copy" of @param other but using a different set of sources @param srcs */
+       /** create a "copy" of \p other but using a different set of sources \p srcs */
        static boost::shared_ptr<Region> create (boost::shared_ptr<Region> other, const SourceList& srcs,
                                                 const PBD::PropertyList&, bool announce = true);
 
        /** create a region with no sources, using XML state */
        static boost::shared_ptr<Region> create (Session&, XMLNode&, bool);
-       /** create a region with specified sources @param srcs and XML state */
+       /** create a region with specified sources \p srcs and XML state */
        static boost::shared_ptr<Region> create (SourceList& srcs, const XMLNode&);
 
+       static boost::shared_ptr<Region> get_whole_region_for_source (boost::shared_ptr<ARDOUR::Source>);
+       
        static void get_regions_using_source (boost::shared_ptr<Source>, std::set<boost::shared_ptr<Region> >& );
        static void remove_regions_using_source (boost::shared_ptr<Source>);
 
@@ -89,6 +99,15 @@ public:
        static void delete_all_regions ();
        static const RegionMap& regions() { return region_map; }
        static uint32_t nregions ();
+       
+       static void foreach_region (boost::function<void( boost::shared_ptr<Region> )> f) {
+               Glib::Threads::Mutex::Lock ls (region_map_lock);
+               for (RegionMap::const_iterator i = region_map.begin(); i != region_map.end(); ++i) {
+                       f ( (*i).second );
+               }
+       }
+       
+
 
        static int region_name (std::string &, std::string, bool new_level = false);
        static std::string new_region_name (std::string);
@@ -116,7 +135,7 @@ public:
         * announce=false but they still need to be in the map soon after
         * creation.
         */
-        
+
        static void map_add (boost::shared_ptr<Region>);
 
   private:
@@ -124,11 +143,11 @@ public:
 
        static void region_changed (PBD::PropertyChange const &, boost::weak_ptr<Region>);
 
-       static Glib::StaticMutex region_map_lock;
+        static Glib::Threads::Mutex region_map_lock;
 
        static RegionMap region_map;
 
-       static Glib::StaticMutex region_name_maps_mutex;
+       static Glib::Threads::Mutex region_name_maps_mutex;
        /** map of partial region names and suffix numbers */
        static std::map<std::string, uint32_t> region_name_number_map;
        /** map of complete region names with their region ID */