libs/ardour/ardour/audio_unit.h

   1 /*
   2     Copyright (C) 2006 Paul Davis
   3     Written by Taybin Rutkin
   4
   5     This program is free software; you can redistribute it and/or modify
   6     it under the terms of the GNU General Public License as published by
   7     the Free Software Foundation; either version 2 of the License, or
   8     (at your option) any later version.
   9
  10     This program is distributed in the hope that it will be useful,
  11     but WITHOUT ANY WARRANTY; without even the implied warranty of
  12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13     GNU General Public License for more details.
  14
  15     You should have received a copy of the GNU General Public License
  16     along with this program; if not, write to the Free Software
  17     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18
  19 */
  20
  21 #ifndef __ardour_audio_unit_h__
  22 #define __ardour_audio_unit_h__
  23
  24 #include <stdint.h>
  25 #include <boost/shared_ptr.hpp>
  26
  27 #include <list>
  28 #include <set>
  29 #include <string>
  30 #include <vector>
  31 #include <map>
  32
  33 #include <ardour/plugin.h>
  34
  35 #include <AudioUnit/AudioUnit.h>
  36 #include <AudioUnit/AudioUnitProperties.h>
  37 #include <appleutility/AUParamInfo.h>
  38
  39 #include <boost/shared_ptr.hpp>
  40
  41 class CAComponent;
  42 class CAAudioUnit;
  43 class CAComponentDescription;
  44 struct AudioBufferList;
  45
  46 namespace ARDOUR {
  47
  48 class AudioEngine;
  49 class Session;
  50
  51 struct AUParameterDescriptor : public Plugin::ParameterDescriptor {
  52         // additional fields to make operations more efficient
  53         AudioUnitParameterID id;
  54         AudioUnitScope scope;
  55         AudioUnitElement element;
  56         float default_value;
  57         bool automatable;
  58         AudioUnitParameterUnit unit;
  59 };
  60
  61 class AUPlugin : public ARDOUR::Plugin
  62 {
  63   public:
  64         AUPlugin (AudioEngine& engine, Session& session, boost::shared_ptr<CAComponent> comp);
  65         AUPlugin (const AUPlugin& other);
  66         virtual ~AUPlugin ();
  67
  68         std::string unique_id () const;
  69         const char * label () const;
  70         const char * name () const { return _info->name.c_str(); }
  71         const char * maker () const { return _info->creator.c_str(); }
  72         uint32_t parameter_count () const;
  73         float default_value (uint32_t port);
  74         nframes_t latency () const;
  75         void set_parameter (uint32_t which, float val);
  76         float get_parameter (uint32_t which) const;
  77
  78         int get_parameter_descriptor (uint32_t which, ParameterDescriptor&) const;
  79         uint32_t nth_parameter (uint32_t which, bool& ok) const;
  80         void activate ();
  81         void deactivate ();
  82         void flush ();
  83         void set_block_size (nframes_t nframes);
  84
  85         int connect_and_run (vector<Sample*>& bufs, uint32_t maxbuf, int32_t& in, int32_t& out, nframes_t nframes, nframes_t offset);
  86         std::set<uint32_t> automatable() const;
  87         string describe_parameter (uint32_t);
  88         string state_node_name () const { return "audiounit"; }
  89         void print_parameter (uint32_t, char*, uint32_t len) const;
  90
  91         bool parameter_is_audio (uint32_t) const;
  92         bool parameter_is_control (uint32_t) const;
  93         bool parameter_is_input (uint32_t) const;
  94         bool parameter_is_output (uint32_t) const;
  95
  96         XMLNode& get_state();
  97         int set_state(const XMLNode& node);
  98
  99         bool save_preset (string name);
 100         bool load_preset (const string preset_label);
 101         std::vector<std::string> get_presets ();
 102         std::string current_preset() const;
 103
 104         bool has_editor () const;
 105
 106         int32_t can_do (int32_t in, int32_t& out);
 107         uint32_t output_streams() const;
 108         uint32_t input_streams() const;
 109         int32_t configure_io (int32_t in, int32_t out);
 110         bool requires_fixed_size_buffers() const;
 111
 112         boost::shared_ptr<CAAudioUnit> get_au () { return unit; }
 113         boost::shared_ptr<CAComponent> get_comp () const { return comp; }
 114
 115         OSStatus render_callback(AudioUnitRenderActionFlags *ioActionFlags,
 116                                  const AudioTimeStamp    *inTimeStamp,
 117                                  UInt32       inBusNumber,
 118                                  UInt32       inNumberFrames,
 119                                  AudioBufferList*       ioData);
 120
 121         /* "host" callbacks */
 122
 123         OSStatus get_beat_and_tempo_callback (Float64* outCurrentBeat,
 124                                               Float64* outCurrentTempo);
 125
 126         OSStatus get_musical_time_location_callback (UInt32*  outDeltaSampleOffsetToNextBeat,
 127                                                      Float32*  outTimeSig_Numerator,
 128                                                      UInt32*   outTimeSig_Denominator,
 129                                                      Float64*  outCurrentMeasureDownBeat);
 130
 131         OSStatus get_transport_state_callback (Boolean*  outIsPlaying,
 132                                                Boolean*  outTransportStateChanged,
 133                                                Float64*  outCurrentSampleInTimeLine,
 134                                                Boolean*  outIsCycling,
 135                                                Float64*  outCycleStartBeat,
 136                                                Float64*  outCycleEndBeat);
 137
 138         static std::string maybe_fix_broken_au_id (const std::string&);
 139
 140   private:
 141         boost::shared_ptr<CAComponent> comp;
 142         boost::shared_ptr<CAAudioUnit> unit;
 143
 144         bool initialized;
 145         int32_t input_channels;
 146         int32_t output_channels;
 147         std::vector<std::pair<int,int> > io_configs;
 148         nframes_t _current_block_size;
 149         bool _requires_fixed_size_buffers;
 150         AudioBufferList* buffers;
 151
 152         /* despite all the cool work that apple did on their AU preset
 153            system, they left factory presets and user presets as two
 154            entirely different kinds of things, handled by two entirely
 155            different parts of the API. Resolve this.
 156         */
 157
 158         /* XXX these two maps should really be shared across all instances of this AUPlugin */
 159
 160         typedef std::map<std::string,std::string> UserPresetMap;
 161         UserPresetMap user_preset_map;
 162         typedef std::map<std::string,int> FactoryPresetMap;
 163         FactoryPresetMap factory_preset_map;
 164
 165         UInt32 global_elements;
 166         UInt32 output_elements;
 167         UInt32 input_elements;
 168
 169         int set_output_format (AudioStreamBasicDescription&);
 170         int set_input_format (AudioStreamBasicDescription&);
 171         int set_stream_format (int scope, uint32_t cnt, AudioStreamBasicDescription&);
 172         int _set_block_size (nframes_t nframes);
 173         void discover_parameters ();
 174
 175         std::vector<std::pair<uint32_t, uint32_t> > parameter_map;
 176         uint32_t current_maxbuf;
 177         nframes_t current_offset;
 178         nframes_t cb_offset;
 179         vector<Sample*>* current_buffers;
 180         nframes_t frames_processed;
 181
 182         std::vector<AUParameterDescriptor> descriptors;
 183         void init ();
 184
 185         void discover_factory_presets ();
 186
 187         bool      last_transport_rolling;
 188         float     last_transport_speed;
 189 };
 190
 191 typedef boost::shared_ptr<AUPlugin> AUPluginPtr;
 192
 193 struct AUPluginCachedInfo {
 194         std::vector<std::pair<int,int> > io_configs;
 195 };
 196
 197 class AUPluginInfo : public PluginInfo {
 198   public:
 199          AUPluginInfo (boost::shared_ptr<CAComponentDescription>);
 200         ~AUPluginInfo ();
 201
 202         PluginPtr load (Session& session);
 203
 204         AUPluginCachedInfo cache;
 205
 206         static PluginInfoList discover ();
 207         static void get_names (CAComponentDescription&, std::string& name, Glib::ustring& maker);
 208         static std::string stringify_descriptor (const CAComponentDescription&);
 209
 210         static int load_cached_info ();
 211
 212   private:
 213         boost::shared_ptr<CAComponentDescription> descriptor;
 214         UInt32 version;
 215
 216         static void discover_music (PluginInfoList&);
 217         static void discover_fx (PluginInfoList&);
 218         static void discover_generators (PluginInfoList&);
 219         static void discover_by_description (PluginInfoList&, CAComponentDescription&);
 220         static Glib::ustring au_cache_path ();
 221
 222         typedef std::map<std::string,AUPluginCachedInfo> CachedInfoMap;
 223         static CachedInfoMap cached_info;
 224
 225         static bool cached_io_configuration (const std::string&, UInt32, CAComponent&, AUPluginCachedInfo&, const std::string& name);
 226         static void add_cached_info (const std::string&, AUPluginCachedInfo&);
 227         static void save_cached_info ();
 228 };
 229
 230 typedef boost::shared_ptr<AUPluginInfo> AUPluginInfoPtr;
 231
 232 } // namespace ARDOUR
 233
 234 #endif // __ardour_audio_unit_h__