add a const - just because.
[ardour.git] / libs / ardour / ardour / region_factory.h
index b88f3b225a566190c7794540f857761215a92a3c..6971e772426f94c8d69a12202eed4cdb185b91cf 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2000-2007 Paul Davis 
+    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
 #ifndef __ardour_region_factory_h__
 #define __ardour_region_factory_h__
 
-#include <ardour/types.h>
-#include <ardour/region.h>
+#include <map>
+#include <set>
+#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;
+class RegionNamingTest;
 
 namespace ARDOUR {
 
 class Session;
+class AudioRegion;
 
-class RegionFactory {
+class LIBARDOUR_API RegionFactory {
+public:
+       typedef std::map<PBD::ID,boost::shared_ptr<Region> > RegionMap;
+
+       static boost::shared_ptr<Region> wholefile_region_by_name (const std::string& name);
+       static boost::shared_ptr<Region> region_by_id (const PBD::ID&);
+       static boost::shared_ptr<Region> region_by_name (const std::string& name);
+       static const RegionMap all_regions() { return region_map; }
+       static void clear_map ();
 
-  public:
        /** This is emitted only when a new id is assigned. Therefore,
           in a pure Region copy, it will not be emitted.
 
-          It must be emitted by derived classes, not Region
-          itself, to permit dynamic_cast<> to be used to 
+          It must be emitted using a derived instance of Region, not Region
+          itself, to permit dynamic_cast<> to be used to
           infer the type of Region.
        */
-       static sigc::signal<void,boost::shared_ptr<Region> > CheckNewRegion;
-
-       static boost::shared_ptr<Region> create (boost::shared_ptr<const Region>);
-
-       /* note: both of the first two should use const shared_ptr as well, but
-          gcc 4.1 doesn't seem to be able to disambiguate them if they do.
-       */
-
-       static boost::shared_ptr<Region> create (boost::shared_ptr<Region>, nframes_t start, 
-                                                nframes_t length, const std::string& name, 
-                                                layer_t = 0, Region::Flag flags = Region::DefaultFlags, bool announce = true);
-       static boost::shared_ptr<Region> create (boost::shared_ptr<AudioRegion>, nframes_t start, 
-                                                nframes_t length, const std::string& name, 
-                                                layer_t = 0, Region::Flag flags = Region::DefaultFlags, bool announce = true);
-       static boost::shared_ptr<Region> create (boost::shared_ptr<Region>, const SourceList&, const string& name, layer_t = 0, Region::Flag flags = Region::DefaultFlags, bool announce = true);
-       static boost::shared_ptr<Region> create (boost::shared_ptr<Source>, nframes_t start, nframes_t length, const string& name, layer_t = 0, Region::Flag flags = Region::DefaultFlags, bool announce = true);
-       static boost::shared_ptr<Region> create (const SourceList &, nframes_t start, nframes_t length, const string& name, layer_t = 0, Region::Flag flags = Region::DefaultFlags, bool announce = true);
+       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, const int32_t sub_num = 0);
+
+       /** create a region from a single Source */
+       static boost::shared_ptr<Region> create (boost::shared_ptr<Source>,
+                                                const PBD::PropertyList&, bool announce = true);
+
+       /** 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 */
+       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,
+                                                const PBD::PropertyList&, bool announce = true, const int32_t sub_num = 0);
+       /** create a "copy" of @param other but using a different set of sources @param 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);
-       static boost::shared_ptr<Region> create (SourceList &, const XMLNode&);
+       /** create a region with specified sources @param srcs and XML state */
+       static boost::shared_ptr<Region> create (SourceList& srcs, const XMLNode&);
+
+       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>);
+
+       static void map_remove (boost::weak_ptr<Region>);
+       static void delete_all_regions ();
+       static const RegionMap& regions() { return region_map; }
+       static uint32_t nregions ();
+
+       static int region_name (std::string &, std::string, bool new_level = false);
+       static std::string new_region_name (std::string);
+       static std::string compound_region_name (const std::string& playlist, uint32_t compound_ops, uint32_t depth, bool whole_source);
+
+       /* when we make a compound region, for every region involved there
+        * are two "instances" - the original, which is removed from this
+        * playlist, and a copy, which is added to the playlist used as
+        * the source for the compound.
+        *
+        * when we uncombine, we want to put the originals back into this
+        * playlist after we remove the compound. this map lets us
+        * look them up easily. note that if the compound was trimmed or
+        * split, we may have to trim the originals
+        * and they may not be added back if the compound was trimmed
+        * or split sufficiently.
+        */
+
+       typedef std::map<boost::shared_ptr<Region>, boost::shared_ptr<Region> > CompoundAssociations;
+       static CompoundAssociations& compound_associations() { return _compound_associations; }
+
+       static void add_compound_association (boost::shared_ptr<Region>, boost::shared_ptr<Region>);
+
+       /* exposed because there may be cases where regions are created with
+        * announce=false but they still need to be in the map soon after
+        * creation.
+        */
+
+       static void map_add (boost::shared_ptr<Region>);
+
+  private:
+       friend class ::RegionNamingTest;
+
+       static void region_changed (PBD::PropertyChange const &, boost::weak_ptr<Region>);
+
+        static Glib::Threads::Mutex region_map_lock;
+
+       static RegionMap region_map;
+
+       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 */
+       static std::map<std::string, PBD::ID> region_name_map;
+       static void add_to_region_name_maps (boost::shared_ptr<Region>);
+       static void rename_in_region_name_maps (boost::shared_ptr<Region>);
+       static void update_region_name_number_map (boost::shared_ptr<Region>);
+       static void remove_from_region_name_map (std::string);
+
+       static PBD::ScopedConnectionList* region_list_connections;
+       static CompoundAssociations _compound_associations;
 };
 
 }