comparison README @ 237:3ad28b1e2150

* Update OS/X build stuff, and some minor doc updates
author cannam
date Fri, 07 Nov 2008 17:05:07 +0000
parents a5a54b60e82e
children cc467e52da4c
comparison
equal deleted inserted replaced
236:7739a9ee3fa4 237:3ad28b1e2150
47 47
48 48
49 About this SDK 49 About this SDK
50 ============== 50 ==============
51 51
52 This is version 1.3 of the Vamp plugin Software Development Kit. 52 This is version 2.0 of the Vamp plugin Software Development Kit.
53
53 Plugins and hosts built with this SDK are binary compatible with those 54 Plugins and hosts built with this SDK are binary compatible with those
54 built using version 1.0 of the SDK. 55 built using version 1.0 of the SDK.
55 56
56 A documentation guide to writing plugins using the Vamp SDK can be 57 A documentation guide to writing plugins using the Vamp SDK can be
57 found at http://www.vamp-plugins.org/guide.pdf . 58 found at http://www.vamp-plugins.org/guide.pdf .
71 vamp-sdk directory (below) is preferable for most purposes and is 72 vamp-sdk directory (below) is preferable for most purposes and is
72 more thoroughly documented. 73 more thoroughly documented.
73 74
74 * vamp-sdk 75 * vamp-sdk
75 76
76 C++ classes for straightforwardly implementing Vamp plugins and hosts. 77 C++ classes for implementing Vamp plugins.
77 78
78 Plugins should subclass Vamp::Plugin and then use Vamp::PluginAdapter 79 Plugins should subclass Vamp::Plugin and then use Vamp::PluginAdapter
79 to expose the correct C API for the plugin. Plugin authors should 80 to expose the correct C API for the plugin. Plugin authors should
80 read vamp-sdk/PluginBase.h and Plugin.h for code documentation, and 81 read vamp-sdk/PluginBase.h and Plugin.h for code documentation, and
81 refer to the example plugin code in the examples directory. Plugins 82 refer to the example plugin code in the examples directory. Plugins
82 should link with -lvamp-sdk. 83 should link with -lvamp-sdk.
83 84
84 Hosts may use the Vamp::PluginHostAdapter to convert the loaded 85 * vamp-hostsdk
85 plugin's C API back into a Vamp::Plugin object. Host authors should 86
86 refer to the example host code in the host directory. Hosts should 87 C++ classes for implementing Vamp hosts.
87 link with -lvamp-hostsdk. 88
88 89 Hosts can use the Vamp::PluginHostAdapter to convert the loaded
89 * vamp-sdk/hostext 90 plugin's C API back into a Vamp::Plugin object.
90 91
91 Additional C++ classes to make a host's life easier (introduced in 92 Host authors should refer to the example host code in the host
92 versions 1.1 and 1.2 of the Vamp SDK). 93 directory. Hosts should link with -lvamp-hostsdk.
94
95 The Vamp::HostExt namespace contains several additional C++ classes to
96 make a host's life easier:
93 97
94 Vamp::HostExt::PluginLoader provides a very easy interface for a host 98 Vamp::HostExt::PluginLoader provides a very easy interface for a host
95 to discover, load, and find out category information about the 99 to discover, load, and find out category information about the
96 available plugins. Most "casual" Vamp hosts will probably want to use 100 available plugins. Most "casual" Vamp hosts will probably want to use
97 this class. 101 this class.