← Back to branch summary

~ubuntu-branches/ubuntu/gutsy/audacity/gutsy-backports

« back to all changes in this revision

Viewing changes to lib-src/libvamp/vamp-sdk/PluginHostAdapter.h

  • Committer: Bazaar Package Importer
  • Author(s): John Dong
  • Date: 2008-02-18 21:58:19 UTC
  • mfrom: (13.1.2 hardy)
  • Revision ID: james.westby@ubuntu.com-20080218215819-tmbcf1rx238r8gdv
Tags: 1.3.4-1.1ubuntu1~gutsy1
Automated backport upload; no source changes.

Show diffs side-by-side

added added

removed removed

Lines of Context:
lib-src/libvamp/vamp-sdk/PluginHostAdapter.h
 
1
/* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
 
2
 
 
3
/*
 
4
    Vamp
 
5
 
 
6
    An API for audio analysis and feature extraction plugins.
 
7
 
 
8
    Centre for Digital Music, Queen Mary, University of London.
 
9
    Copyright 2006 Chris Cannam.
 
10
  
 
11
    Permission is hereby granted, free of charge, to any person
 
12
    obtaining a copy of this software and associated documentation
 
13
    files (the "Software"), to deal in the Software without
 
14
    restriction, including without limitation the rights to use, copy,
 
15
    modify, merge, publish, distribute, sublicense, and/or sell copies
 
16
    of the Software, and to permit persons to whom the Software is
 
17
    furnished to do so, subject to the following conditions:
 
18
 
 
19
    The above copyright notice and this permission notice shall be
 
20
    included in all copies or substantial portions of the Software.
 
21
 
 
22
    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 
23
    EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 
24
    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 
25
    NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
 
26
    ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
 
27
    CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 
28
    WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
29
 
 
30
    Except as contained in this notice, the names of the Centre for
 
31
    Digital Music; Queen Mary, University of London; and Chris Cannam
 
32
    shall not be used in advertising or otherwise to promote the sale,
 
33
    use or other dealings in this Software without prior written
 
34
    authorization.
 
35
*/
 
36
 
 
37
#ifndef _VAMP_PLUGIN_HOST_ADAPTER_H_
 
38
#define _VAMP_PLUGIN_HOST_ADAPTER_H_
 
39
 
 
40
#include <vamp/vamp.h>
 
41
#include <vamp-sdk/Plugin.h>
 
42
 
 
43
#include <vector>
 
44
 
 
45
namespace Vamp {
 
46
 
 
47
/**
 
48
 * \class PluginHostAdapter PluginHostAdapter.h <vamp-sdk/PluginHostAdapter.h>
 
49
 * 
 
50
 * PluginHostAdapter is a wrapper class that a Vamp host can use to
 
51
 * make the C-language VampPluginDescriptor object appear as a C++
 
52
 * Vamp::Plugin object.
 
53
 *
 
54
 * The Vamp API is defined in vamp/vamp.h as a C API.  The C++ objects
 
55
 * used for convenience by plugins and hosts actually communicate
 
56
 * using the C low-level API, but the details of this communication
 
57
 * are handled seamlessly by the Vamp SDK implementation provided the
 
58
 * plugin and host use the proper C++ wrapper objects.
 
59
 *
 
60
 * See also PluginAdapter, the plugin-side wrapper that makes a C++
 
61
 * plugin object available using the C query API.
 
62
 */
 
63
 
 
64
class PluginHostAdapter : public Plugin
 
65
{
 
66
public:
 
67
    PluginHostAdapter(const VampPluginDescriptor *descriptor,
 
68
                      float inputSampleRate);
 
69
    virtual ~PluginHostAdapter();
 
70
    
 
71
    static std::vector<std::string> getPluginPath();
 
72
 
 
73
    bool initialise(size_t channels, size_t stepSize, size_t blockSize);
 
74
    void reset();
 
75
 
 
76
    InputDomain getInputDomain() const;
 
77
 
 
78
    unsigned int getVampApiVersion() const;
 
79
    std::string getIdentifier() const;
 
80
    std::string getName() const;
 
81
    std::string getDescription() const;
 
82
    std::string getMaker() const;
 
83
    int getPluginVersion() const;
 
84
    std::string getCopyright() const;
 
85
 
 
86
    ParameterList getParameterDescriptors() const;
 
87
    float getParameter(std::string) const;
 
88
    void setParameter(std::string, float);
 
89
 
 
90
    ProgramList getPrograms() const;
 
91
    std::string getCurrentProgram() const;
 
92
    void selectProgram(std::string);
 
93
 
 
94
    size_t getPreferredStepSize() const;
 
95
    size_t getPreferredBlockSize() const;
 
96
 
 
97
    size_t getMinChannelCount() const;
 
98
    size_t getMaxChannelCount() const;
 
99
 
 
100
    OutputList getOutputDescriptors() const;
 
101
 
 
102
    FeatureSet process(const float *const *inputBuffers, RealTime timestamp);
 
103
 
 
104
    FeatureSet getRemainingFeatures();
 
105
 
 
106
protected:
 
107
    void convertFeatures(VampFeatureList *, FeatureSet &);
 
108
 
 
109
    const VampPluginDescriptor *m_descriptor;
 
110
    VampPluginHandle m_handle;
 
111
};
 
112
 
 
113
}
 
114
 
 
115
#endif
 
116
 
 
117