view README.md @ 186:52322dde68ea

Fix erroneous logic for handling step and block size in prior commit

The earlier change had a logical misconception. If PluginStub is
receiving the correct step and block size back from the configure call,
the plugin on the server side must have already been successfully
initialised, as the step and block size are only returned in a
successful configure response. This means the test for a failed
initialise and redo with the correct parameters must be done on the
server side (in LoaderRequests) not the client. The client has a more
complicated job, which is to notice that a *successful* configure had
returned different framing parameters from those passed to the
initialise call, and to pretend that it had actually failed until the
host called again with the correct parameters. We definitely need tests
for this!

# Piper C++

Supporting code in C++ for the Piper audio feature extractor protocol,
primarily for making Vamp plugins work with the Piper protocol.

## Contents

 * code to adapt Piper messages to the classes used in the Vamp SDK
 * a command-line converter between Piper serialisations (via Vamp SDK
   classes)
 * a server that makes Vamp plugins available via Piper messages

## Directory index

*vamp-json* - convert between Piper JSON messages and Vamp SDK classes

*vamp-capnp* - convert between Piper Cap'n Proto messages and Vamp
abstractions

*vamp-support* - support classes for the above

*vamp-server* - main programs for command-line converter and server

*vamp-client* - logic to make Piper servers available to Vamp hosts
through a Vamp-like API

*vamp-client/qt* - logic specific to hosts written with Qt

*ext* - json11 and base-n third-party libraries: see individual
directories for copyright details

[![Build Status](https://travis-ci.org/piper-audio/piper-cpp.svg?branch=master)](https://travis-ci.org/piper-audio/piper-cpp)

## Authors and licensing

Written by Chris Cannam at the Centre for Digital Music, Queen Mary,
University of London.

Copyright (c) 2015-2017 Queen Mary, University of London, provided
under a BSD-style licence. See the file COPYING for details.