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 #include "ardour/region.h"
  32
  33 class XMLNode;
  34
  35 namespace ARDOUR {
  36
  37 class Session;
  38 class AudioRegion;
  39
  40 class RegionFactory {
  41
  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         /** 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
  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
  95   private:
  96
  97         static boost::shared_ptr<Region> create (boost::shared_ptr<Region>, frameoffset_t offset,
  98                                                  bool offset_relative,
  99                                                  const PBD::PropertyList&, bool announce = true);
 100
 101         static void region_changed (PBD::PropertyChange const &, boost::weak_ptr<Region>);
 102
 103         static Glib::StaticMutex region_map_lock;
 104
 105         static RegionMap region_map;
 106         static void map_add (boost::shared_ptr<Region>);
 107
 108         static Glib::StaticMutex region_name_map_lock;
 109
 110         static std::map<std::string, uint32_t> region_name_map;
 111         static void update_region_name_map (boost::shared_ptr<Region>);
 112
 113         static PBD::ScopedConnectionList region_list_connections;
 114 };
 115
 116 }
 117
 118 #endif /* __ardour_region_factory_h__  */