← Back to branch summary

~ubuntu-branches/ubuntu/quantal/vamp-plugin-sdk/quantal-proposed

« back to all changes in this revision

Viewing changes to build/README.osx

  • Committer: Bazaar Package Importer
  • Author(s): Székelyi Szabolcs
  • Date: 2009-12-23 19:15:05 UTC
  • mfrom: (1.1.3 upstream)
  • Revision ID: james.westby@ubuntu.com-20091223191505-inv03hl177xmnos4
Tags: 2.1-1
http://bugs.debian.org/560337
http://bugs.debian.org/562653
* New upstream release (Closes: #560337)
* Added skeleton/ to vamp-plugin-sdk
* Added vamp-rdf-tempate-generator to vamp-plugin-sdk
* Added manpage for vamp-rdf-template-generator TODO
* Don't run `$(MAKE) test` if `nocheck` is present in DEB_BUILD_OPTIONS.
  This involves running several $(MAKE)s with specific targets instead
  of one generic run. TODO: check Makefile for new targets on every new
  upstream release.
* Fixed typo in debian/control, libvamp-sdk2
* Fixed debian/vamp-plugin-sdk.examples so source code for example plugins
  is really installed now
* Added #include <cstdio> to examples/FixedTempoEstimator.cpp to build
  with GCC 4.3 (Closes: #562653)
* Provide a doc-base control file in vamp-plugin-sdk-doc
* Bumped Standards-Version to 3.8.3

Show diffs side-by-side

added added

removed removed

Lines of Context:
build/README.osx
7
7
 
8
8
To build the SDK, example plugins, and command-line host:
9
9
 
10
 
 $ make -f Makefile.osx
 
10
 $ make -f build/Makefile.osx
11
11
 
12
12
You must have libsndfile (http://www.mega-nerd.com/libsndfile/)
13
13
installed in order to build the command-line host successfully.  To
14
14
build only the SDK and examples:
15
15
 
16
 
 $ make -f Makefile.osx sdk examples
 
16
 $ make -f build/Makefile.osx sdk examples
17
17
 
18
18
See the comments at the top of Makefile.osx for more information about
19
19
the libraries and other targets that are built in this way.
42
42
Plugin Linkage
43
43
--------------
44
44
 
45
 
Vamp plugins are distributed as dynamic libraries (.dylib).  A
46
 
well-packaged Vamp plugin library should export exactly one public
 
45
Vamp plugins are distributed as dynamic libraries (.dylib).  An OS/X
 
46
dynamic library has a formal installed name, which is recorded in the
 
47
library's header: you will need to ensure that this matches the
 
48
plugin's filename (e.g. vamp-example-plugins.dylib) by using the
 
49
-install_name <name> option at link time.  The Makefile.osx provided
 
50
with the SDK contains an example of this.
 
51
 
 
52
A well-packaged Vamp plugin library should export exactly one public
47
53
symbol, namely the Vamp API entry point vampGetPluginDescriptor.
48
54
 
49
55
The default for the OS/X linker is to export all of the symbols in the
68
74
but this one is simple and has the advantage of requiring no changes
69
75
to the code.
70
76
 
 
77
 
 
78
Test Your Plugins
 
79
-----------------
 
80
 
 
81
The Vamp Plugin Tester is a vital utility which you can use to test
 
82
your plugins for common problems.  It can help you if you're having
 
83
problems getting your plugin to work at all, and you're strongly
 
84
advised to use it before you release anything.  Download it from the
 
85
Vamp plugins site now!
 
86