libs/ardour/ardour/region_factory.h

   1 /*
   2     Copyright (C) 2000-2007 Paul Davis
   3
   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.
   8
   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.
  13
  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.
  17
  18 */
  19
  20 #ifndef __ardour_region_factory_h__
  21 #define __ardour_region_factory_h__
  22
  23 #include <map>
  24 #include <set>
  25 #include <glibmm/threads.h>
  26
  27 #include "pbd/id.h"
  28 #include "pbd/property_list.h"
  29 #include "pbd/signals.h"
  30
  31 #include "ardour/types.h"
  32
  33 class XMLNode;
  34 class RegionNamingTest;
  35
  36 namespace ARDOUR {
  37
  38 class Session;
  39 class AudioRegion;
  40
  41 class RegionFactory {
  42 public:
  43         typedef std::map<PBD::ID,boost::shared_ptr<Region> > RegionMap;
  44
  45         static boost::shared_ptr<Region> wholefile_region_by_name (const std::string& name);
  46         static boost::shared_ptr<Region> region_by_id (const PBD::ID&);
  47         static boost::shared_ptr<Region> region_by_name (const std::string& name);
  48         static const RegionMap all_regions() { return region_map; }
  49         static void clear_map ();
  50
  51         /** This is emitted only when a new id is assigned. Therefore,
  52            in a pure Region copy, it will not be emitted.
  53
  54            It must be emitted using a derived instance of Region, not Region
  55            itself, to permit dynamic_cast<> to be used to
  56            infer the type of Region.
  57         */
  58         static PBD::Signal1<void,boost::shared_ptr<Region> >  CheckNewRegion;
  59
  60         /** create a "pure copy" of Region @param other */
  61         static boost::shared_ptr<Region> create (boost::shared_ptr<const Region> other, bool announce = false);
  62
  63         /** create a region from a single Source */
  64         static boost::shared_ptr<Region> create (boost::shared_ptr<Source>,
  65                                                  const PBD::PropertyList&, bool announce = true);
  66
  67         /** create a region from a multiple sources */
  68         static boost::shared_ptr<Region> create (const SourceList &,
  69                                                  const PBD::PropertyList&, bool announce = true);
  70         /** create a copy of @other starting at zero within @param other's sources */
  71         static boost::shared_ptr<Region> create (boost::shared_ptr<Region> other,
  72                                                  const PBD::PropertyList&, bool announce = true);
  73         /** create a copy of @param other starting at @param offset within @param other */
  74         static boost::shared_ptr<Region> create (boost::shared_ptr<Region> other, frameoffset_t offset,
  75                                                  const PBD::PropertyList&, bool announce = true);
  76         /** create a "copy" of @param other but using a different set of sources @param srcs */
  77         static boost::shared_ptr<Region> create (boost::shared_ptr<Region> other, const SourceList& srcs,
  78                                                  const PBD::PropertyList&, bool announce = true);
  79
  80         /** create a region with no sources, using XML state */
  81         static boost::shared_ptr<Region> create (Session&, XMLNode&, bool);
  82         /** create a region with specified sources @param srcs and XML state */
  83         static boost::shared_ptr<Region> create (SourceList& srcs, const XMLNode&);
  84
  85         static void get_regions_using_source (boost::shared_ptr<Source>, std::set<boost::shared_ptr<Region> >& );
  86         static void remove_regions_using_source (boost::shared_ptr<Source>);
  87
  88         static void map_remove (boost::weak_ptr<Region>);
  89         static void delete_all_regions ();
  90         static const RegionMap& regions() { return region_map; }
  91         static uint32_t nregions ();
  92
  93         static int region_name (std::string &, std::string, bool new_level = false);
  94         static std::string new_region_name (std::string);
  95         static std::string compound_region_name (const std::string& playlist, uint32_t compound_ops, uint32_t depth, bool whole_source);
  96
  97         /* when we make a compound region, for every region involved there
  98          * are two "instances" - the original, which is removed from this
  99          * playlist, and a copy, which is added to the playlist used as
 100          * the source for the compound.
 101          *
 102          * when we uncombine, we want to put the originals back into this
 103          * playlist after we remove the compound. this map lets us
 104          * look them up easily. note that if the compound was trimmed or
 105          * split, we may have to trim the originals
 106          * and they may not be added back if the compound was trimmed
 107          * or split sufficiently.
 108          */
 109
 110         typedef std::map<boost::shared_ptr<Region>, boost::shared_ptr<Region> > CompoundAssociations;
 111         static CompoundAssociations& compound_associations() { return _compound_associations; }
 112
 113         static void add_compound_association (boost::shared_ptr<Region>, boost::shared_ptr<Region>);
 114
 115         /* exposed because there may be cases where regions are created with
 116          * announce=false but they still need to be in the map soon after
 117          * creation.
 118          */
 119
 120         static void map_add (boost::shared_ptr<Region>);
 121
 122   private:
 123         friend class ::RegionNamingTest;
 124
 125         static void region_changed (PBD::PropertyChange const &, boost::weak_ptr<Region>);
 126
 127         static Glib::Threads::Mutex region_map_lock;
 128
 129         static RegionMap region_map;
 130
 131         static Glib::Threads::Mutex region_name_maps_mutex;
 132         /** map of partial region names and suffix numbers */
 133         static std::map<std::string, uint32_t> region_name_number_map;
 134         /** map of complete region names with their region ID */
 135         static std::map<std::string, PBD::ID> region_name_map;
 136         static void add_to_region_name_maps (boost::shared_ptr<Region>);
 137         static void rename_in_region_name_maps (boost::shared_ptr<Region>);
 138         static void update_region_name_number_map (boost::shared_ptr<Region>);
 139         static void remove_from_region_name_map (std::string);
 140
 141         static PBD::ScopedConnectionList* region_list_connections;
 142         static CompoundAssociations _compound_associations;
 143 };
 144
 145 }
 146
 147 #endif /* __ardour_region_factory_h__  */