Using as a library

Verovio can be built and use as C++ or C library.

Building libverovio.so on Linux or libverovio.dylib on macOS

cd tools
cmake -DBUILD_AS_LIBRARY=ON .
make

Running sudo make install will copy the library and the headers in /usr/local/lib and /usr/local/include/verovio respectively.

Building verovio.dll on Windows using Microsoft Visual Studio Build Tools 2022

Open x64 Native Tools Command Prompt for VS 2022 and enter:

cd cmake
cmake -DBUILD_AS_LIBRARY=ON -DCMAKE_BUILD_TYPE=Release -DCMAKE_WINDOWS_EXPORT_ALL_SYMBOLS=TRUE -B build 
cmake --build build --config Release

Examples

C++ interface

The following code is a minimal example using the C++ Toolkit class:

#include <iostream>
using namespace std;

// Include header for the vrv::Toolkit classl
#include "toolkit.h"
 
int main()
{
    vrv::Toolkit tk(false);
    // Print the version
    cout << tk.GetVersion() << endl;
 
    return 0;
}

The example can be built with:

g++ main.cpp -o main --std=c++17 -lverovio -I/usr/local/include/verovio

Running ./main should display the Verovio version.

C function interface

To use Verovio with any language that supports a plain C function interface you will first need to build Verovio as a library. The compiled library (libverovio.so/verovio.dll) will contain callable C symbols. These wrapper symbols are defined in ./tools/c_wrapper.h

#include "stdbool.h"
#include "stdio.h"

// Include the header with the C functions
#include "c_wrapper.h"

int main()
{
    printf("Calling constructor\n");
    void *pointer = vrvToolkit_constructorResourcePath("./path-to-the-resource-dir");
    printf("Pointer value %p\n", pointer);
    const char *options = vrvToolkit_getAvailableOptions(pointer);
    printf("%s", options);
}

You can use gcc to compile the example above and link to the pre-built library:

gcc main.c -o main -lverovio -I/usr/local/include/verovio

Run ./main or (without having installed the library or changed your default LD_LIBRARY_PATH):

LD_LIBRARY_PATH=/path-to-the-library-dir ./main

A music notation engraving library

A music notation engraving library