/[svn]/linuxsampler/trunk/src/effects/EffectFactory.h
ViewVC logotype

Diff of /linuxsampler/trunk/src/effects/EffectFactory.h

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 2124 by schoenebeck, Sat Sep 18 09:24:41 2010 UTC revision 2135 by schoenebeck, Thu Sep 30 20:00:43 2010 UTC
# Line 21  namespace LinuxSampler { Line 21  namespace LinuxSampler {
21  class EffectFactory {  class EffectFactory {
22  public:  public:
23      /**      /**
24         * Used as search criteria for plugin DLL filenames by GetEffectInfo() .
25         * These flags can be bitwise or-ed.
26         */
27        enum ModuleMatchFlag_t {
28            MODULE_MATCH_EXACTLY = 0,    ///< The plugin DLL filename has to match exactly.
29            MODULE_IGNORE_CASE = 1,      ///< Ignore upper case / lower case differences in the module names.
30            MODULE_IGNORE_EXTENSION = 2, ///< Strip off the file extension (if any) before comparing the DLL filenames.
31            MODULE_IGNORE_PATH = 4,      ///< Strip off the path of the plugin DLL filename before comparing.
32            MODULE_IGNORE_ALL = -1       ///< Will match all modules successfully, no matter what module name was provided.
33        };
34    
35        /**
36       * Returns comma separated list of all effect systems currently available       * Returns comma separated list of all effect systems currently available
37       * for this sampler. This list can vary on the exact configuration of the       * for this sampler. This list can vary on the exact configuration of the
38       * running machine and the options with which the sampler was compiled.       * running machine and the options with which the sampler was compiled.
# Line 62  public: Line 74  public:
74      static EffectInfo* GetEffectInfo(uint index);      static EffectInfo* GetEffectInfo(uint index);
75    
76      /**      /**
77         * Returns unique identifier and further detailed informations about the
78         * the requested effect. Since the effect plugin's DLL filename (a.k.a.
79         * @a module) can vary for the very same effect on different systems, it
80         * is possible to use @a iModuleMatchFlags for defining in which way the
81         * provided DLL filename should be matched in this search or whether it
82         * should even be ignored completely. This allows to reload sampler sessions
83         * created on one system, successfully on another system, probably even
84         * having a completely different OS (e.g. Linux vs. Windows).
85         *
86         * @param effectSystem - e.g. 'LADSPA'
87         * @param module - usually the DLL filename of the effect plugin
88         * @param effectName - unique identifier of the effect within its plugin module
89         * @param iModuleMatchFlags - (optional) defines how strong the given
90         *                            @a module must match with the actual on the
91         *                            system available module name, the flags can
92         *                            be bitwise or-ed
93         *                            (default: the module name must match exactly)
94         * @returns effect info or NULL if there is no such effect
95         * @see ModuleMatchFlag_t
96         */
97        static EffectInfo* GetEffectInfo(String effectSystem, String module, String effectName, int iModuleMatchFlags = MODULE_MATCH_EXACTLY);
98    
99        /**
100       * Create an instance of the requested effect. You should call Destroy()       * Create an instance of the requested effect. You should call Destroy()
101       * once the effect is not used anymore.       * once the effect is not used anymore.
102       *       *
# Line 77  public: Line 112  public:
112       * created with Create() .       * created with Create() .
113       *       *
114       * @param pEffect - effect instance to destroy       * @param pEffect - effect instance to destroy
115         * @throws Exception - if effect is still in use
116         */
117        static void Destroy(Effect* pEffect) throw (Exception);
118    
119        /**
120         * Returns total amount of effect instances created with Create() .
121         */
122        static uint EffectInstancesCount();
123    
124        /**
125         * Returns effect instance for the given index.
126         *
127         * @param index - index of the effect instance must be between 0 and
128         *                EffectInstancesCount()
129         * @returns effect instance, or NULL if index out of bounds
130         */
131        static Effect* GetEffectInstance(uint index);
132    
133        /**
134         * Returns effect instance with the given effect instance ID.
135         *
136         * @param id - effect instance ID of sought effect instance
137         * @returns effect instance or NULL if no effect instance with that ID
138         *          could be found
139       */       */
140      static void Destroy(Effect* pEffect);      static Effect* GetEffectInstanceByID(int id);
141  };  };
142    
143  } // namespace LinuxSampler  } // namespace LinuxSampler
Legend:
Removed from v.2124  
changed lines
  Added in v.2135
  ViewVC Help
Powered by ViewVC