Merge with 2.0-ongoing R2885.
[ardour.git] / libs / ardour / audio_unit.cc
index 52cfc187afe20d7bfe941ef0bffa1587419e7e30..9f19a21865ee21326286a02ac7468107026da6da 100644 (file)
@@ -1,6 +1,5 @@
 /*
     Copyright (C) 2006 Paul Davis 
-       Written by Taybin Rutkin
        
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
 
 */
 
+#include <sstream>
+
+#include <pbd/transmitter.h>
+#include <pbd/xml++.h>
+#include <pbd/whitespace.h>
+
+#include <glibmm/thread.h>
+
+#include <ardour/audioengine.h>
+#include <ardour/io.h>
 #include <ardour/audio_unit.h>
+#include <ardour/session.h>
 #include <ardour/utils.h>
 
+#include <appleutility/CAAudioUnit.h>
+
 #include <CoreServices/CoreServices.h>
 #include <AudioUnit/AudioUnit.h>
 
+#include "i18n.h"
+
+using namespace std;
+using namespace PBD;
 using namespace ARDOUR;
 
+static OSStatus 
+_render_callback(void *userData,
+                AudioUnitRenderActionFlags *ioActionFlags,
+                const AudioTimeStamp    *inTimeStamp,
+                UInt32       inBusNumber,
+                UInt32       inNumberFrames,
+                AudioBufferList*       ioData)
+{
+       return ((AUPlugin*)userData)->render_callback (ioActionFlags, inTimeStamp, inBusNumber, inNumberFrames, ioData);
+}
+
+AUPlugin::AUPlugin (AudioEngine& engine, Session& session, boost::shared_ptr<CAComponent> _comp)
+       :
+       Plugin (engine, session),
+       comp (_comp),
+       unit (new CAAudioUnit),
+       initialized (false),
+       buffers (0),
+       current_maxbuf (0),
+       current_offset (0),
+       current_buffers (0),
+       frames_processed (0)
+{                      
+       OSErr err = CAAudioUnit::Open (*(comp.get()), *unit);
+
+       if (err != noErr) {
+               error << _("AudioUnit: Could not convert CAComponent to CAAudioUnit") << endmsg;
+               throw failed_constructor ();
+       }
+       
+       AURenderCallbackStruct renderCallbackInfo;
+
+       renderCallbackInfo.inputProc = _render_callback;
+       renderCallbackInfo.inputProcRefCon = this;
+
+       if ((err = unit->SetProperty (kAudioUnitProperty_SetRenderCallback, kAudioUnitScope_Input, 
+                                        0, (void*) &renderCallbackInfo, sizeof(renderCallbackInfo))) != 0) {
+               cerr << "cannot install render callback (err = " << err << ')' << endl;
+               throw failed_constructor();
+       }
+
+       unit->GetElementCount (kAudioUnitScope_Input, input_elements);
+       unit->GetElementCount (kAudioUnitScope_Output, output_elements);
+
+       // set up the basic stream format. these fields do not change
+                           
+       streamFormat.mSampleRate = session.frame_rate();
+       streamFormat.mFormatID = kAudioFormatLinearPCM;
+       streamFormat.mFormatFlags = kAudioFormatFlagIsFloat|kAudioFormatFlagIsPacked|kAudioFormatFlagIsNonInterleaved;
+       streamFormat.mBitsPerChannel = 32;
+       streamFormat.mFramesPerPacket = 1;
+
+       // subject to later modification as we discover channel counts
+
+       streamFormat.mBytesPerPacket = 4;
+       streamFormat.mBytesPerFrame = 4;
+       streamFormat.mChannelsPerFrame = 1;
+
+       format_set = 0;
+
+       if (_set_block_size (_session.get_block_size())) {
+               error << _("AUPlugin: cannot set processing block size") << endmsg;
+               throw failed_constructor();
+       }
+}
+
+AUPlugin::~AUPlugin ()
+{
+       if (unit) {
+               unit->Uninitialize ();
+       }
+
+       if (buffers) {
+               free (buffers);
+       }
+}
+
+string
+AUPlugin::unique_id () const
+{
+       return AUPluginInfo::stringify_descriptor (comp->Desc());
+}
+
+const char *
+AUPlugin::label () const
+{
+       return _info->name.c_str();
+}
+
+uint32_t
+AUPlugin::parameter_count () const
+{
+       return 0;
+}
+
+float
+AUPlugin::default_value (uint32_t port)
+{
+       // AudioUnits don't have default values.  Maybe presets though?
+       return 0;
+}
+
+nframes_t
+AUPlugin::signal_latency () const
+{
+       if (_user_latency) {
+               return _user_latency;
+       }
+
+       return unit->Latency ();
+}
+
+void
+AUPlugin::set_parameter (uint32_t which, float val)
+{
+       // unit->SetParameter (parameter_map[which].first, parameter_map[which].second, 0, val);
+}
+
+float
+AUPlugin::get_parameter (uint32_t which) const
+{
+       float outValue = 0.0;
+       
+       // unit->GetParameter(parameter_map[which].first, parameter_map[which].second, 0, outValue);
+       
+       return outValue;
+}
+
+int
+AUPlugin::get_parameter_descriptor (uint32_t which, ParameterDescriptor&) const
+{
+       return 0;
+}
+
+uint32_t
+AUPlugin::nth_parameter (uint32_t which, bool& ok) const
+{
+       return 0;
+}
+
+void
+AUPlugin::activate ()
+{
+       if (!initialized) {
+               OSErr err;
+               if ((err = unit->Initialize()) != noErr) {
+                       error << string_compose (_("AUPlugin: cannot initialize plugin (err = %1)"), err) << endmsg;
+               } else {
+                       frames_processed = 0;
+                       initialized = true;
+               }
+       }
+}
+
+void
+AUPlugin::deactivate ()
+{
+       unit->GlobalReset ();
+}
+
+void
+AUPlugin::set_block_size (nframes_t nframes)
+{
+       _set_block_size (nframes);
+}
+
+int
+AUPlugin::_set_block_size (nframes_t nframes)
+{
+       bool was_initialized = initialized;
+       UInt32 numFrames = nframes;
+       OSErr err;
+
+       if (initialized) {
+               unit->Uninitialize ();
+       }
+
+       if ((err = unit->SetProperty (kAudioUnitProperty_MaximumFramesPerSlice, kAudioUnitScope_Global, 
+                                     0, &numFrames, sizeof (numFrames))) != noErr) {
+               cerr << "cannot set max frames (err = " << err << ')' << endl;
+               return -1;
+       }
+
+       if (was_initialized) {
+               activate ();
+       }
+
+       return 0;
+}
+
+int32_t 
+AUPlugin::can_support_input_configuration (int32_t in)
+{      
+       streamFormat.mChannelsPerFrame = in;
+       /* apple says that for non-interleaved data, these
+          values always refer to a single channel.
+       */
+       streamFormat.mBytesPerPacket = 4;
+       streamFormat.mBytesPerFrame = 4;
+
+       if (set_input_format () == 0) {
+               return 1;
+       } else {
+               return -1;
+       }
+}
+
+int
+AUPlugin::set_input_format ()
+{
+       return set_stream_format (kAudioUnitScope_Input, input_elements);
+}
+
+int
+AUPlugin::set_output_format ()
+{
+       return set_stream_format (kAudioUnitScope_Output, output_elements);
+}
+
+int
+AUPlugin::set_stream_format (int scope, uint32_t cnt)
+{
+       OSErr result;
+
+       for (uint32_t i = 0; i < cnt; ++i) {
+               if ((result = unit->SetFormat (scope, i, streamFormat)) != 0) {
+                       error << string_compose (_("AUPlugin: could not set stream format for %1/%2 (err = %3)"),
+                                                (scope == kAudioUnitScope_Input ? "input" : "output"), i, result) << endmsg;
+                       return -1;
+               }
+       }
+
+       if (scope == kAudioUnitScope_Input) {
+               format_set |= 0x1;
+       } else {
+               format_set |= 0x2;
+       }
+
+       return 0;
+}
+
+int32_t 
+AUPlugin::compute_output_streams (int32_t nplugins)
+{
+       /* we will never replicate AU plugins - either they can do the I/O we need
+          or not. thus, we can ignore nplugins entirely.
+       */
+       
+       if (set_output_format() == 0) {
+
+               if (buffers) {
+                       free (buffers);
+                       buffers = 0;
+               }
+
+               buffers = (AudioBufferList *) malloc (offsetof(AudioBufferList, mBuffers) + 
+                                                     streamFormat.mChannelsPerFrame * sizeof(AudioBuffer));
+
+               Glib::Mutex::Lock em (_session.engine().process_lock());
+               IO::MoreOutputs (streamFormat.mChannelsPerFrame);
+
+               return streamFormat.mChannelsPerFrame;
+       } else {
+               return -1;
+       }
+}
+
+uint32_t
+AUPlugin::output_streams() const
+{
+       if (!(format_set & 0x2)) {
+               warning << _("AUPlugin: output_streams() called without any format set!") << endmsg;
+               return 1;
+       }
+       return streamFormat.mChannelsPerFrame;
+}
+
+
+uint32_t
+AUPlugin::input_streams() const
+{
+       if (!(format_set & 0x1)) {
+               warning << _("AUPlugin: input_streams() called without any format set!") << endmsg;
+               return 1;
+       }
+       return streamFormat.mChannelsPerFrame;
+}
+
+OSStatus 
+AUPlugin::render_callback(AudioUnitRenderActionFlags *ioActionFlags,
+                         const AudioTimeStamp    *inTimeStamp,
+                         UInt32       inBusNumber,
+                         UInt32       inNumberFrames,
+                         AudioBufferList*       ioData)
+{
+       /* not much to do - the data is already in the buffers given to us in connect_and_run() */
+
+       if (current_maxbuf == 0) {
+               error << _("AUPlugin: render callback called illegally!") << endmsg;
+               return kAudioUnitErr_CannotDoInCurrentContext;
+       }
+
+       for (uint32_t i = 0; i < current_maxbuf; ++i) {
+               ioData->mBuffers[i].mNumberChannels = 1;
+               ioData->mBuffers[i].mDataByteSize = sizeof (Sample) * inNumberFrames;
+               ioData->mBuffers[i].mData = (*current_buffers)[i] + cb_offset + current_offset;
+       }
+
+       cb_offset += inNumberFrames;
+
+       return noErr;
+}
+
+int
+AUPlugin::connect_and_run (vector<Sample*>& bufs, uint32_t maxbuf, int32_t& in, int32_t& out, nframes_t nframes, nframes_t offset)
+{
+       AudioUnitRenderActionFlags flags = 0;
+       AudioTimeStamp ts;
+
+       current_buffers = &bufs;
+       current_maxbuf = maxbuf;
+       current_offset = offset;
+       cb_offset = 0;
+
+       buffers->mNumberBuffers = maxbuf;
+
+       for (uint32_t i = 0; i < maxbuf; ++i) {
+               buffers->mBuffers[i].mNumberChannels = 1;
+               buffers->mBuffers[i].mDataByteSize = nframes * sizeof (Sample);
+               buffers->mBuffers[i].mData = 0;
+       }
+
+       ts.mSampleTime = frames_processed;
+       ts.mFlags = kAudioTimeStampSampleTimeValid;
+
+       if (unit->Render (&flags, &ts, 0, nframes, buffers) == noErr) {
+
+               current_maxbuf = 0;
+               frames_processed += nframes;
+               
+               for (uint32_t i = 0; i < maxbuf; ++i) {
+                       if (bufs[i] + offset != buffers->mBuffers[i].mData) {
+                               memcpy (bufs[i]+offset, buffers->mBuffers[i].mData, nframes * sizeof (Sample));
+                       }
+               }
+               return 0;
+       }
+
+       return -1;
+}
+
+set<uint32_t>
+AUPlugin::automatable() const
+{
+       set<uint32_t> automates;
+       
+       return automates;
+}
+
+string
+AUPlugin::describe_parameter (uint32_t)
+{
+       return "";
+}
+
+void
+AUPlugin::print_parameter (uint32_t, char*, uint32_t len) const
+{
+       
+}
+
+bool
+AUPlugin::parameter_is_audio (uint32_t) const
+{
+       return false;
+}
+
+bool
+AUPlugin::parameter_is_control (uint32_t) const
+{
+       return false;
+}
+
+bool
+AUPlugin::parameter_is_input (uint32_t) const
+{
+       return false;
+}
+
+bool
+AUPlugin::parameter_is_output (uint32_t) const
+{
+       return false;
+}
+
+XMLNode&
+AUPlugin::get_state()
+{
+       XMLNode *root = new XMLNode (state_node_name());
+       LocaleGuard lg (X_("POSIX"));
+       return *root;
+}
+
+int
+AUPlugin::set_state(const XMLNode& node)
+{
+       return -1;
+}
+
+bool
+AUPlugin::save_preset (string name)
+{
+       return false;
+}
+
+bool
+AUPlugin::load_preset (const string preset_label)
+{
+       return false;
+}
+
+vector<string>
+AUPlugin::get_presets ()
+{
+       vector<string> presets;
+       
+       return presets;
+}
+
+bool
+AUPlugin::has_editor () const
+{
+       // even if the plugin doesn't have its own editor, the AU API can be used
+       // to create one that looks native.
+       return true;
+}
+
+AUPluginInfo::AUPluginInfo (boost::shared_ptr<CAComponentDescription> d)
+       : descriptor (d)
+{
+
+}
+
+AUPluginInfo::~AUPluginInfo ()
+{
+}
+
+PluginPtr
+AUPluginInfo::load (Session& session)
+{
+       try {
+               PluginPtr plugin;
+
+               boost::shared_ptr<CAComponent> comp (new CAComponent(*descriptor));
+               
+               if (!comp->IsValid()) {
+                       error << ("AudioUnit: not a valid Component") << endmsg;
+               } else {
+                       plugin.reset (new AUPlugin (session.engine(), session, comp));
+               }
+               
+               plugin->set_info (PluginInfoPtr (new AUPluginInfo (*this)));
+               return plugin;
+       }
+
+       catch (failed_constructor &err) {
+               return PluginPtr ((Plugin*) 0);
+       }
+}
+
 PluginInfoList
 AUPluginInfo::discover ()
 {
        PluginInfoList plugs;
 
-       int numTypes = 2;    // this magic number was retrieved from the apple AUHost example.
+       discover_fx (plugs);
+       discover_music (plugs);
+
+       return plugs;
+}
 
-       ComponentDescription desc;
+void
+AUPluginInfo::discover_music (PluginInfoList& plugs)
+{
+       CAComponentDescription desc;
        desc.componentFlags = 0;
        desc.componentFlagsMask = 0;
        desc.componentSubType = 0;
        desc.componentManufacturer = 0;
+       desc.componentType = kAudioUnitType_MusicEffect;
 
-       vector<ComponentDescription> vCompDescs;
+       discover_by_description (plugs, desc);
+}
 
-       for (int i = 0; i < numTypes; ++i) {
-               if (i == 1) {
-                       desc.componentType = kAudioUnitType_MusicEffect;
-               } else {
-                       desc.componentType = kAudioUnitType_Effect;
+void
+AUPluginInfo::discover_fx (PluginInfoList& plugs)
+{
+       CAComponentDescription desc;
+       desc.componentFlags = 0;
+       desc.componentFlagsMask = 0;
+       desc.componentSubType = 0;
+       desc.componentManufacturer = 0;
+       desc.componentType = kAudioUnitType_Effect;
+
+       discover_by_description (plugs, desc);
+}
+
+void
+AUPluginInfo::discover_by_description (PluginInfoList& plugs, CAComponentDescription& desc)
+{
+       Component comp = 0;
+
+       comp = FindNextComponent (NULL, &desc);
+
+       while (comp != NULL) {
+               CAComponentDescription temp;
+               GetComponentInfo (comp, &temp, NULL, NULL, NULL);
+
+               AUPluginInfoPtr info (new AUPluginInfo 
+                                     (boost::shared_ptr<CAComponentDescription> (new CAComponentDescription(temp))));
+
+               /* no panners, format converters or i/o AU's for our purposes
+                */
+
+               switch (info->descriptor->Type()) {
+               case kAudioUnitType_Panner:
+               case kAudioUnitType_OfflineEffect:
+               case kAudioUnitType_FormatConverter:
+                       continue;
+               default:
+                       break;
                }
 
-               Component comp = 0;
+               switch (info->descriptor->SubType()) {
+               case kAudioUnitSubType_DefaultOutput:
+               case kAudioUnitSubType_SystemOutput:
+               case kAudioUnitSubType_GenericOutput:
+               case kAudioUnitSubType_AUConverter:
+                       continue;
+                       break;
+
+               case kAudioUnitSubType_DLSSynth:
+                       info->category = "DLSSynth";
+                       break;
+
+               case kAudioUnitType_MusicEffect:
+                       info->category = "MusicEffect";
+                       break;
+
+               case kAudioUnitSubType_Varispeed:
+                       info->category = "Varispeed";
+                       break;
+
+               case kAudioUnitSubType_Delay:
+                       info->category = "Delay";
+                       break;
+
+               case kAudioUnitSubType_LowPassFilter:
+                       info->category = "LowPassFilter";
+                       break;
 
-               comp = FindNextComponent (NULL, &desc);
-               while (comp != NULL) {
-                       ComponentDescription temp;
-                       GetComponentInfo (comp, &temp, NULL, NULL, NULL);
-                       vCompDescs.push_back(temp);
-                       comp = FindNextComponent (comp, &desc);
+               case kAudioUnitSubType_HighPassFilter:
+                       info->category = "HighPassFilter";
+                       break;
+
+               case kAudioUnitSubType_BandPassFilter:
+                       info->category = "BandPassFilter";
+                       break;
+
+               case kAudioUnitSubType_HighShelfFilter:
+                       info->category = "HighShelfFilter";
+                       break;
+
+               case kAudioUnitSubType_LowShelfFilter:
+                       info->category = "LowShelfFilter";
+                       break;
+
+               case kAudioUnitSubType_ParametricEQ:
+                       info->category = "ParametricEQ";
+                       break;
+
+               case kAudioUnitSubType_GraphicEQ:
+                       info->category = "GraphicEQ";
+                       break;
+
+               case kAudioUnitSubType_PeakLimiter:
+                       info->category = "PeakLimiter";
+                       break;
+
+               case kAudioUnitSubType_DynamicsProcessor:
+                       info->category = "DynamicsProcessor";
+                       break;
+
+               case kAudioUnitSubType_MultiBandCompressor:
+                       info->category = "MultiBandCompressor";
+                       break;
+
+               case kAudioUnitSubType_MatrixReverb:
+                       info->category = "MatrixReverb";
+                       break;
+
+               case kAudioUnitType_Mixer:
+                       info->category = "Mixer";
+                       break;
+
+               case kAudioUnitSubType_StereoMixer:
+                       info->category = "StereoMixer";
+                       break;
+
+               case kAudioUnitSubType_3DMixer:
+                       info->category = "3DMixer";
+                       break;
+
+               case kAudioUnitSubType_MatrixMixer:
+                       info->category = "MatrixMixer";
+                       break;
+
+               default:
+                       info->category = "";
                }
+
+               AUPluginInfo::get_names (temp, info->name, info->creator);
+
+               info->type = ARDOUR::AudioUnit;
+               info->unique_id = stringify_descriptor (*info->descriptor);
+
+               /* mark the plugin as having flexible i/o */
+               
+               info->n_inputs = -1;
+               info->n_outputs = -1;
+
+
+               plugs.push_back (info);
+               
+               comp = FindNextComponent (comp, &desc);
        }
+}
 
-       for (unsigned int i = 0; i < vCompDescs.size(); ++i) {
-
-               // the following large block is just for determining the name of the plugin.
-               CFStringRef itemName = NULL;
-               // Marc Poirier -style item name
-               Component auComponent = FindNextComponent (0, &(vCompDescs[i]));
-               if (auComponent != NULL) {
-                       ComponentDescription dummydesc;
-                       Handle nameHandle = NewHandle(sizeof(void*));
-                       if (nameHandle != NULL) {
-                               OSErr err = GetComponentInfo(auComponent, &dummydesc, nameHandle, NULL, NULL);
-                               if (err == noErr) {
-                                       ConstStr255Param nameString = (ConstStr255Param) (*nameHandle);
-                                       if (nameString != NULL) {
-                                               itemName = CFStringCreateWithPascalString(kCFAllocatorDefault, nameString, CFStringGetSystemEncoding());
-                                       }
+void
+AUPluginInfo::get_names (CAComponentDescription& comp_desc, std::string& name, Glib::ustring& maker)
+{
+       CFStringRef itemName = NULL;
+
+       // Marc Poirier-style item name
+       CAComponent auComponent (comp_desc);
+       if (auComponent.IsValid()) {
+               CAComponentDescription dummydesc;
+               Handle nameHandle = NewHandle(sizeof(void*));
+               if (nameHandle != NULL) {
+                       OSErr err = GetComponentInfo(auComponent.Comp(), &dummydesc, nameHandle, NULL, NULL);
+                       if (err == noErr) {
+                               ConstStr255Param nameString = (ConstStr255Param) (*nameHandle);
+                               if (nameString != NULL) {
+                                       itemName = CFStringCreateWithPascalString(kCFAllocatorDefault, nameString, CFStringGetSystemEncoding());
                                }
-                               DisposeHandle(nameHandle);
                        }
+                       DisposeHandle(nameHandle);
                }
+       }
+    
+       // if Marc-style fails, do the original way
+       if (itemName == NULL) {
+               CFStringRef compTypeString = UTCreateStringForOSType(comp_desc.componentType);
+               CFStringRef compSubTypeString = UTCreateStringForOSType(comp_desc.componentSubType);
+               CFStringRef compManufacturerString = UTCreateStringForOSType(comp_desc.componentManufacturer);
+    
+               itemName = CFStringCreateWithFormat(kCFAllocatorDefault, NULL, CFSTR("%@ - %@ - %@"), 
+                       compTypeString, compManufacturerString, compSubTypeString);
+    
+               if (compTypeString != NULL)
+                       CFRelease(compTypeString);
+               if (compSubTypeString != NULL)
+                       CFRelease(compSubTypeString);
+               if (compManufacturerString != NULL)
+                       CFRelease(compManufacturerString);
+       }
+       
+       string str = CFStringRefToStdString(itemName);
+       string::size_type colon = str.find (':');
 
-               // if Marc-style fails, do the original way
-               if (itemName == NULL) {
-                       CFStringRef compTypeString = UTCreateStringForOSType(vCompDescs[i].componentType);
-                       CFStringRef compSubTypeString = UTCreateStringForOSType(vCompDescs[i].componentSubType);
-                       CFStringRef compManufacturerString = UTCreateStringForOSType(vCompDescs[i].componentManufacturer);
-
-                       itemName = CFStringCreateWithFormat(kCFAllocatorDefault, NULL, CFSTR("%@ - %@ - %@"), 
-                               compTypeString, compManufacturerString, compSubTypeString);
-
-                       if (compTypeString != NULL)
-                               CFRelease(compTypeString);
-                       if (compSubTypeString != NULL)
-                               CFRelease(compSubTypeString);
-                       if (compManufacturerString != NULL)
-                               CFRelease(compManufacturerString);
-               }
-               string realname = CFStringRefToStdString(itemName);
+       if (colon) {
+               name = str.substr (colon+1);
+               maker = str.substr (0, colon);
+               // strip_whitespace_edges (maker);
+               // strip_whitespace_edges (name);
+       } else {
+               name = str;
+               maker = "unknown";
+       }
+}
 
-               AUPluginInfoPtr plug(new AUPluginInfo);
-               plug->name = realname;
-               plug->type = PluginInfo::AudioUnit;
-               plug->n_inputs = 0;
-               plug->n_outputs = 0;
-               plug->category = "AudioUnit";
+// from CAComponentDescription.cpp (in libs/appleutility in ardour source)
+extern char *StringForOSType (OSType t, char *writeLocation);
 
-               plugs.push_back(plug);
-       }
+std::string
+AUPluginInfo::stringify_descriptor (const CAComponentDescription& desc)
+{
+       char str[24];
+       stringstream s;
 
-       return plugs;
+       s << StringForOSType (desc.Type(), str);
+       s << " - ";
+               
+       s << StringForOSType (desc.SubType(), str);
+       s << " - ";
+               
+       s << StringForOSType (desc.Manu(), str);
+
+       return s.str();
 }