Overview

+ + + +--- +layout: default +style: luadoc +title: Class Reference +--- + +

+This documentation is far from complete may be inaccurate and subject to change. +

+ + + +

Overview

The top-level entry point are and . Most other Classes are used indirectly starting with a Session function. e.g. Session:get_routes(). @@ -655,7 +811,7 @@ A few classes are dedicated to certain script types, e.g. Lua DSP processors hav

Detailed documentation (parameter names, method description) is not yet available. Please stay tuned.

Short introduction to Ardour classes

Ardour's structure is object oriented. The main object is the Session. A Session contains Audio Tracks, Midi Tracks and Busses. Audio and Midi tracks are derived from a more general "Track" Object, which in turn is derived from a "Route" (aka Bus). @@ -664,40 +820,135 @@ Tracks contain specifics. For Example a track has-a diskstream (for fil

Operations are performed on objects. One gets a reference to an object and then calls a method. -e.g obj = Session:route_by_name("Audio") obj:set_name("Guitar") +e.g obj = Session:route_by_name("Audio") obj:set_name("Guitar"). +

+Lua automatically follows C++ class inheritance. e.g one can directly call all SessionObject and Route methods on Track object. However lua does not automatically promote objects. A Route object which just happens to be a Track needs to be explicily cast to a Track. Methods for casts are provided with each class. Note that the cast may fail and return a nil reference. +

+Likewise multiple inheritance is a non-trivial issue in lua. To avoid performance penalties involved with lookups, explicit casts are required in this case. One example is which is-a StatefulDestructible which inhertis from both Stateful and Destructible.

Object lifetimes are managed by the Session. Most Objects cannot be directly created, but one asks the Session to create or destroy them. This is mainly due to realtime constrains: you cannot simply remove a track that is currently processing audio. There are various factory methods for object creation or removal.

Pass by Reference

+Since lua functions are closures, C++ methods that pass arguments by reference cannot be used as-is. +All parameters passed to a C++ method which uses references are returned as Lua Table. +If the C++ method also returns a value it is prefixed. Two parameters are returned: the value and a Lua Table holding the parameters. +

+ +

C++ + +

void set_ref (int& var, long& val)
+{
+	printf ("%d %ld\n", var, val);
+	var = 5;
+	val = 7;
+}
+

+ +

Lua + +

local var = 0;
+ref = set_ref (var, 2);
+-- output from C++ printf()
+0 2
+-- var is still 0 here
+print (ref[1], ref[2])
+5 7

+ +

int set_ref2 (int &var, std::string unused)
+{
+	var = 5;
+	return 3;
+}
+

+ +

rv, ref = set_ref2 (0, "hello");
+print (rv, ref[1], ref[2])
+3 5 hello

+ +

Pointer Classes

+Libardour makes extensive use of reference counted boost::shared_ptr to manage lifetimes. +The Lua bindings provide a complete abstration of this. There are no pointers in lua. +For example a is a pointer in C++, but lua functions operate on it like it was a class instance. +

+shared_ptr are reference counted. Once assigned to a lua variable, the C++ object will be kept and remains valid. +It is good practice to assign references to lua local variables or reset the variable to nil to drop the ref. +

+All pointer classes have a isnil () method. This is for two cases: +Construction may fail. e.g. .newplugin() +may not be able to find the given plugin and hence cannot create an object. +

+The second case if for boost::weak_ptr. As opposed to boost::shared_ptr weak-pointers are not reference counted. +The object may vanish at any time. +If lua code calls a method on a nil object, the interpreter will raise an exception and the script will not continue. +This is not unlike a = nil a:test() which results in en error "attempt to index a nil value". +

+From the lua side of things there is no distinction between weak and shared pointers. They behave identically. +Below they're inidicated in orange and have an arrow to indicate the pointer type. +Pointer Classes cannot be created in lua scripts. It always requires a call to C++ to create the Object and obtain a reference to it. +

+ Class Documentation'.NL; +################################# +# Main output function -- Classes + +echo '

Class Documentation

'.NL; foreach ($classlist as $ns => $cl) { $dups = array (); $tbl = format_class_members ($ns, $cl, $dups); - # format class title + # format class title - depending on type if (empty ($tbl)) { - echo '

∅ '.htmlentities ($ns).'

'.NL; + # classes with no members (no ctor, no methods, no data) + echo '

∅ '.htmlentities ($ns).'

'.NL; } else if (isset ($classlist[$ns]['free'])) { - echo '

ℕ '.ctorname($ns).'

'.NL; + # free functions (no class) + echo '

ℕ '.ctorname($ns).'

'.NL; } else if (isset ($classlist[$ns]['arr'])) { - echo '

⋯ '.htmlentities ($ns).'

'.NL; + # C Arrays + echo '

⋯ '.htmlentities ($ns).'

'.NL; } else if (isset ($classlist[$ns]['ptr'])) { - echo '

↠ '. htmlentities ($ns).'

'.NL; - } else { - echo '

∁ '.htmlentities ($ns).'

'.NL; + # Pointer Classes + echo '

↠ '. htmlentities ($ns).'

'.NL; } - if (isset ($cl['decl'])) { - echo '

C‡: '.htmlentities ($cl['decl']).'

'.NL; + else { + # Normal Class + echo '

∁ '.htmlentities ($ns).'

'.NL; + } + + # show original C++ declaration + if (isset ($cl['cdecl'])) { + echo '

C‡: '.htmlentities ($cl['cdecl']).'

'.NL; } - # print class inheritance + # print class inheritance (direct parent *name* only) $inherited = array (); $isa = traverse_parent ($ns, $inherited); if (!empty ($isa)) { @@ -705,6 +956,8 @@ foreach ($classlist as $ns => $cl) { } echo '

'.NL; + + # class documentation (if any) echo format_doxyclass ($cl); # member documentation @@ -716,11 +969,11 @@ foreach ($classlist as $ns => $cl) { echo ' '.NL; } - # traverse parent classes (inherited members) + # traverse parent classes (all inherited members) foreach ($inherited as $pns => $pcl) { $tbl = format_class_members ($pns, $pcl, $dups); if (!empty ($tbl)) { - echo '

Inherited from '.$pns.'

'.NL; + echo '

Inherited from '.$pns.'

'.NL; echo ''.NL; echo $tbl; echo '

'.NL; @@ -728,9 +981,12 @@ foreach ($classlist as $ns => $cl) { } } -echo '

Enum/Constants

'.NL; +#################### +# Enum and Constants + +echo '

Enum/Constants

'.NL; foreach ($constlist as $ns => $cs) { - echo '

∈ '.ctorname ($ns).'

'.NL; + echo '

∈ '.ctorname ($ns).'

'.NL; echo '

'.ctorname ($c['lua']).'

'.NL; } -echo '

Class Index

'.NL; +###################### +# Index of all classes + +echo '

Class Index

'.NL; echo '

'.typelink($ns).'

'.NL; + +# see how far there is still to go... fwrite (STDERR, "Found $dox_found annotations. missing: $dox_miss\n"); +echo ''.NL; + ?>

- - +

Ardour -

+'.NL; + echo ''.NL; + echo ''.NL; +}

Ardour Lua Bindings

Ardour Lua Bindings

Overview

Overview

Short introduction to Ardour classes

Short introduction to Ardour classes

Pass by Reference

Pointer Classes

Class Documentation

∅ '.htmlentities ($ns).'

∅ '.htmlentities ($ns).'

ℕ '.ctorname($ns).'

ℕ '.ctorname($ns).'

⋯ '.htmlentities ($ns).'

⋯ '.htmlentities ($ns).'

↠ '. htmlentities ($ns).'

∁ '.htmlentities ($ns).'

↠ '. htmlentities ($ns).'

∁ '.htmlentities ($ns).'

Inherited from '.$pns.'

Inherited from '.$pns.'

Enum/Constants

Enum/Constants

∈ '.ctorname ($ns).'

∈ '.ctorname ($ns).'

Class Index

Class Index