session_utils/README

   1 Ardour Session Utilities
   2 ========================
   3
   4 This folder contains some tools which directly use libardour to access ardour
   5 sessions.
   6
   7 The overall goal it to provide some non-interactive unix-style commandline
   8 tools, which are installed along with DAW.
   9
  10 These tools depend on the "dummy" backend to be available, configure ardour with e.g.
  11
  12   ./waf configure --with-backends=jack,alsa,dummy ...
  13
  14
  15 Adding new tools
  16 ----------------
  17
  18 One C++ source per tool, see "example.cc" and "export.cc"
  19
  20   cp session_utils/example.cc session_utils/your_new_tool_name.cc
  21   edit session_utils/new_tool_name.cc
  22   ./waf
  23
  24 The tool is automatically compiled and deployed when installing, using the
  25 program-name as prefix.  e.g.  "export.cc" becomes "ardour4-export".
  26 (or "mixbus3-export", depending on the project configuration)
  27
  28
  29 Test run from the source
  30 ------------------------
  31
  32   cd session_utils
  33   ./run ardour6-your_new_tool_name
  34
  35 or
  36
  37   ./run ardour6-export --help
  38
  39 and to debug the tool under gdb/lldb:
  40
  41   ./debug ardour6-export