2 Copyright (C) 2000-2007 Paul Davis
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 #ifndef __ardour_region_factory_h__
21 #define __ardour_region_factory_h__
25 #include <glibmm/threads.h>
28 #include "pbd/property_list.h"
29 #include "pbd/signals.h"
31 #include "ardour/libardour_visibility.h"
32 #include "ardour/types.h"
35 class RegionNamingTest;
42 class LIBARDOUR_API RegionFactory {
44 typedef std::map<PBD::ID,boost::shared_ptr<Region> > RegionMap;
46 static boost::shared_ptr<Region> wholefile_region_by_name (const std::string& name);
47 static boost::shared_ptr<Region> region_by_id (const PBD::ID&);
48 static boost::shared_ptr<Region> region_by_name (const std::string& name);
49 static const RegionMap all_regions() { return region_map; }
50 static void clear_map ();
52 /** This is emitted only when a new id is assigned. Therefore,
53 in a pure Region copy, it will not be emitted.
55 It must be emitted using a derived instance of Region, not Region
56 itself, to permit dynamic_cast<> to be used to
57 infer the type of Region.
59 static PBD::Signal1<void,boost::shared_ptr<Region> > CheckNewRegion;
61 /** create a "pure copy" of Region @param other */
62 static boost::shared_ptr<Region> create (boost::shared_ptr<const Region> other, bool announce = false, bool fork = false);
63 static boost::shared_ptr<Region> create (boost::shared_ptr<Region> other, bool announce, bool fork) {
64 return create (boost::shared_ptr<const Region>(other), announce, fork);
67 /** create a region from a single Source */
68 static boost::shared_ptr<Region> create (boost::shared_ptr<Source>,
69 const PBD::PropertyList&, bool announce = true);
71 /** create a region from a multiple sources */
72 static boost::shared_ptr<Region> create (const SourceList &,
73 const PBD::PropertyList&, bool announce = true);
74 /** create a copy of @other starting at zero within @param other's sources */
75 static boost::shared_ptr<Region> create (boost::shared_ptr<Region> other,
76 const PBD::PropertyList&, bool announce = true);
77 /** create a copy of @param other starting at @param offset within @param other */
78 static boost::shared_ptr<Region> create (boost::shared_ptr<Region> other, ARDOUR::MusicSample offset,
79 const PBD::PropertyList&, bool announce = true);
80 /** create a "copy" of @param other but using a different set of sources @param srcs */
81 static boost::shared_ptr<Region> create (boost::shared_ptr<Region> other, const SourceList& srcs,
82 const PBD::PropertyList&, bool announce = true);
84 /** create a region with no sources, using XML state */
85 static boost::shared_ptr<Region> create (Session&, XMLNode&, bool);
86 /** create a region with specified sources @param srcs and XML state */
87 static boost::shared_ptr<Region> create (SourceList& srcs, const XMLNode&);
89 static void get_regions_using_source (boost::shared_ptr<Source>, std::set<boost::shared_ptr<Region> >& );
90 static void remove_regions_using_source (boost::shared_ptr<Source>);
92 static void map_remove (boost::weak_ptr<Region>);
93 static void delete_all_regions ();
94 static const RegionMap& regions() { return region_map; }
95 static uint32_t nregions ();
97 static int region_name (std::string &, std::string, bool new_level = false);
98 static std::string new_region_name (std::string);
99 static std::string compound_region_name (const std::string& playlist, uint32_t compound_ops, uint32_t depth, bool whole_source);
101 /* when we make a compound region, for every region involved there
102 * are two "instances" - the original, which is removed from this
103 * playlist, and a copy, which is added to the playlist used as
104 * the source for the compound.
106 * when we uncombine, we want to put the originals back into this
107 * playlist after we remove the compound. this map lets us
108 * look them up easily. note that if the compound was trimmed or
109 * split, we may have to trim the originals
110 * and they may not be added back if the compound was trimmed
111 * or split sufficiently.
114 typedef std::map<boost::shared_ptr<Region>, boost::shared_ptr<Region> > CompoundAssociations;
115 static CompoundAssociations& compound_associations() { return _compound_associations; }
117 static void add_compound_association (boost::shared_ptr<Region>, boost::shared_ptr<Region>);
119 /* exposed because there may be cases where regions are created with
120 * announce=false but they still need to be in the map soon after
124 static void map_add (boost::shared_ptr<Region>);
127 friend class ::RegionNamingTest;
129 static void region_changed (PBD::PropertyChange const &, boost::weak_ptr<Region>);
131 static Glib::Threads::Mutex region_map_lock;
133 static RegionMap region_map;
135 static Glib::Threads::Mutex region_name_maps_mutex;
136 /** map of partial region names and suffix numbers */
137 static std::map<std::string, uint32_t> region_name_number_map;
138 /** map of complete region names with their region ID */
139 static std::map<std::string, PBD::ID> region_name_map;
140 static void add_to_region_name_maps (boost::shared_ptr<Region>);
141 static void rename_in_region_name_maps (boost::shared_ptr<Region>);
142 static void update_region_name_number_map (boost::shared_ptr<Region>);
143 static void remove_from_region_name_map (std::string);
145 static PBD::ScopedConnectionList* region_list_connections;
146 static CompoundAssociations _compound_associations;
151 #endif /* __ardour_region_factory_h__ */