# audiveris

**Repository Path**: githubprojects/audiveris

## Basic Information

- **Project Name**: audiveris
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: AGPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2017-07-11
- **Last Updated**: 2024-02-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# audiveris

This repository contains source code for the latest generation of Audiveris optical
music recognition (OMR) engine.

## Main features

As opposed to Audiveris [earlier generation][6], which was a stand-alone OMR application composed
of an engine and a (limited) user interface, this repository is focused on the OMR engine.

The internals of OMR engine are made publicly available, either directly by XML-based ".omr" 
project files or via the Java API of this software.

The engine can directly export data using [MusicXML][8] 3.0 format, via an integrated exporter.
Other exporters could build upon the engine to support other target formats.

NOTA: The engine provides a small integrated UI which is meant for the developer to analyze, 
tune or train the various parts of the engine, but not to correct the final score.
Full GUIs, meant for the end-user, are expected to be provided by external editors.

## Building and running

First of all, you'll need the following dependencies installed and working from
the command line:

+ [Java Development Kit (JDK) version 7 or later (version 8 is recommended)][1].
  **Please ensure you're running a 64-bit JVM. Audiveris doesn't support a 32-bit
  JVM because deeplearning4j is 64-bit only.**
+ [Git](https://git-scm.com) version control system.
+ [Gradle command line tool](https://gradle.org) for building Audiveris from source

Besides the above mentioned tools you'll need to have Tesseract language files for
[Tesseract OCR][2] to work properly. Please keep in mind that Tesseract is mandatory
for both building and running Audiveris. __It's currently not possible to use
Audiveris without Tesseract.__

You'll need at least the english language data. Other required languages can be
installed, too. Please check [this guide][3] for further details.

Moreover, opening PDFs containing vector graphics on Unix-like platforms
(including the Mac) requires [FreeType library][4] to be available in your $PATH.
Fortunately, every known OS distribution already contains a package for FreeType.

To build audiveris from source, run the following command from the source code
directory:

`gradle build`

To run audiveris as GUI tool, just issue

`gradle run`

## Developers guide

Developers are encouraged to read our (still incomplete) [developers documentation][5].

[1]: http://www.oracle.com/technetwork/java/javase/downloads/index.html
[2]: https://github.com/tesseract-ocr/tesseract
[3]: https://github.com/tesseract-ocr/tesseract/wiki
[4]: https://www.freetype.org
[5]: https://github.com/Audiveris/audiveris/wiki
[6]: https://github.com/Audiveris/audiveris-eg
[7]: https://github.com/Audiveris
[8]: http://www.musicxml.com/