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