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/signals.h"
  29
  30 #include "ardour/types.h"
  31
  32 class XMLNode;
  33
  34 namespace ARDOUR {
  35
  36 class Session;
  37 class AudioRegion;
  38
  39 class RegionFactory {
  40 public:
  41         typedef std::map<PBD::ID,boost::shared_ptr<Region> > RegionMap;
  42
  43         static boost::shared_ptr<Region> wholefile_region_by_name (const std::string& name);
  44         static boost::shared_ptr<Region> region_by_id (const PBD::ID&);
  45         static boost::shared_ptr<Region> region_by_name (const std::string& name);
  46         static const RegionMap all_regions() { return region_map; }
  47         static void clear_map ();
  48
  49         /** This is emitted only when a new id is assigned. Therefore,
  50            in a pure Region copy, it will not be emitted.
  51
  52            It must be emitted using a derived instance of Region, not Region
  53            itself, to permit dynamic_cast<> to be used to
  54            infer the type of Region.
  55         */
  56         static PBD::Signal1<void,boost::shared_ptr<Region> >  CheckNewRegion;
  57
  58         /** create a "pure copy" of Region @param other */
  59         static boost::shared_ptr<Region> create (boost::shared_ptr<const Region> other, bool announce = false);
  60
  61         /** create a region from a single Source */
  62         static boost::shared_ptr<Region> create (boost::shared_ptr<Source>,
  63                                                  const PBD::PropertyList&, bool announce = true);
  64
  65         /** create a region from a multiple sources */
  66         static boost::shared_ptr<Region> create (const SourceList &,
  67                                                  const PBD::PropertyList&, bool announce = true);
  68         /** create a copy of @other starting at zero within @param other's sources */
  69         static boost::shared_ptr<Region> create (boost::shared_ptr<Region> other,
  70                                                  const PBD::PropertyList&, bool announce = true);
  71         /** create a copy of @param other starting at @param offset within @param other */
  72         static boost::shared_ptr<Region> create (boost::shared_ptr<Region> other, frameoffset_t offset,
  73                                                  const PBD::PropertyList&, bool announce = true);
  74         /** create a "copy" of @param other but using a different set of sources @param srcs */
  75         static boost::shared_ptr<Region> create (boost::shared_ptr<Region> other, const SourceList& srcs,
  76                                                  const PBD::PropertyList&, bool announce = true);
  77
  78         /** create a region with no sources, using XML state */
  79         static boost::shared_ptr<Region> create (Session&, XMLNode&, bool);
  80         /** create a region with specified sources @param srcs and XML state */
  81         static boost::shared_ptr<Region> create (SourceList& srcs, const XMLNode&);
  82
  83         static void get_regions_using_source (boost::shared_ptr<Source>, std::set<boost::shared_ptr<Region> >& );
  84         static void remove_regions_using_source (boost::shared_ptr<Source>);
  85
  86         static void map_remove (boost::shared_ptr<Region>);
  87         static void map_remove_with_equivalents (boost::shared_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   private:
 115
 116         static void region_changed (PBD::PropertyChange const &, boost::weak_ptr<Region>);
 117
 118         static Glib::StaticMutex region_map_lock;
 119
 120         static RegionMap region_map;
 121         static void map_add (boost::shared_ptr<Region>);
 122
 123         static Glib::StaticMutex region_name_map_lock;
 124
 125         static std::map<std::string, uint32_t> region_name_map;
 126         static void update_region_name_map (boost::shared_ptr<Region>);
 127
 128         static PBD::ScopedConnectionList region_list_connections;
 129         static CompoundAssociations _compound_associations;
 130 };
 131
 132 }
 133
 134 #endif /* __ardour_region_factory_h__  */