libs/ardour/ardour/ardour.h

   1 /*
   2     Copyright (C) 1999-2009 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_ardour_h__
  21 #define __ardour_ardour_h__
  22
  23 #include <map>
  24 #include <string>
  25 #include <vector>
  26
  27 #include <limits.h>
  28 #include <signal.h>
  29
  30 #include "pbd/signals.h"
  31
  32 #include "pbd/error.h"
  33 #include "pbd/failed_constructor.h"
  34 #include "pbd/stateful.h"
  35
  36 #include "ardour/libardour_visibility.h"
  37 #include "ardour/types.h"
  38 #include "ardour/libardour_visibility.h"
  39
  40 namespace MIDI {
  41         class MachineControl;
  42         class Port;
  43 }
  44
  45 namespace ARDOUR {
  46
  47         class AudioEngine;
  48
  49         extern LIBARDOUR_API PBD::Signal1<void,std::string> BootMessage;
  50         extern LIBARDOUR_API PBD::Signal3<void,std::string,std::string,bool> PluginScanMessage;
  51         extern LIBARDOUR_API PBD::Signal1<void,int> PluginScanTimeout;
  52         extern LIBARDOUR_API PBD::Signal0<void> GUIIdle;
  53         extern LIBARDOUR_API PBD::Signal3<bool,std::string,std::string,int> CopyConfigurationFiles;
  54         extern LIBARDOUR_API std::map<std::string, bool> reserved_io_names;
  55
  56         /**
  57          * @param with_vst true to enable VST Support
  58          * @param try_optimization true to enable hardware optimized routines
  59          * for mixing, finding peak values etc.
  60          * @param localedir Directory to look for localisation files
  61          *
  62          * @return true if Ardour library was successfully initialized
  63          */
  64         LIBARDOUR_API bool init (bool with_vst, bool try_optimization, const char* localedir);
  65         LIBARDOUR_API void init_post_engine ();
  66         LIBARDOUR_API void cleanup ();
  67         LIBARDOUR_API bool no_auto_connect ();
  68         LIBARDOUR_API void make_property_quarks ();
  69
  70         extern LIBARDOUR_API PBD::PropertyChange bounds_change;
  71
  72         extern LIBARDOUR_API const char* const ardour_config_info;
  73
  74         /* these only impact bundled installations */
  75         LIBARDOUR_API std::string translation_enable_path ();
  76         LIBARDOUR_API bool translations_are_enabled ();
  77         LIBARDOUR_API bool set_translations_enabled (bool);
  78
  79         LIBARDOUR_API microseconds_t get_microseconds ();
  80
  81         LIBARDOUR_API void setup_fpu ();
  82         LIBARDOUR_API std::vector<SyncSource> get_available_sync_options();
  83
  84         /* the @param ui_handler will be called if there are old configuration
  85          * files to be copied. It should (probably) ask the user about the
  86          * action, and return true or false depending on whether or not the
  87          * copy should take place.
  88          */
  89         LIBARDOUR_API void check_for_old_configuration_files ();
  90         LIBARDOUR_API int handle_old_configuration_files (boost::function<bool (std::string const&, std::string const&, int)> ui_handler);
  91 }
  92
  93 #endif /* __ardour_ardour_h__ */
  94