Skip to content

Commit

Permalink
assembly of jorbis, vorbisspi and tritonus_share as well as moving to…
Browse files Browse the repository at this point in the history
… group com.github.trilarion
  • Loading branch information
Trilarion committed Jul 13, 2015
0 parents commit 283c748
Show file tree
Hide file tree
Showing 147 changed files with 29,898 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
/build/
/.nb-gradle/
/.gradle/
166 changes: 166 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,166 @@
GNU LESSER GENERAL PUBLIC LICENSE
Version 3, 29 June 2007

Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.


This version of the GNU Lesser General Public License incorporates
the terms and conditions of version 3 of the GNU General Public
License, supplemented by the additional permissions listed below.

0. Additional Definitions.

As used herein, "this License" refers to version 3 of the GNU Lesser
General Public License, and the "GNU GPL" refers to version 3 of the GNU
General Public License.

"The Library" refers to a covered work governed by this License,
other than an Application or a Combined Work as defined below.

An "Application" is any work that makes use of an interface provided
by the Library, but which is not otherwise based on the Library.
Defining a subclass of a class defined by the Library is deemed a mode
of using an interface provided by the Library.

A "Combined Work" is a work produced by combining or linking an
Application with the Library. The particular version of the Library
with which the Combined Work was made is also called the "Linked
Version".

The "Minimal Corresponding Source" for a Combined Work means the
Corresponding Source for the Combined Work, excluding any source code
for portions of the Combined Work that, considered in isolation, are
based on the Application, and not on the Linked Version.

The "Corresponding Application Code" for a Combined Work means the
object code and/or source code for the Application, including any data
and utility programs needed for reproducing the Combined Work from the
Application, but excluding the System Libraries of the Combined Work.

1. Exception to Section 3 of the GNU GPL.

You may convey a covered work under sections 3 and 4 of this License
without being bound by section 3 of the GNU GPL.

2. Conveying Modified Versions.

If you modify a copy of the Library, and, in your modifications, a
facility refers to a function or data to be supplied by an Application
that uses the facility (other than as an argument passed when the
facility is invoked), then you may convey a copy of the modified
version:

a) under this License, provided that you make a good faith effort to
ensure that, in the event an Application does not supply the
function or data, the facility still operates, and performs
whatever part of its purpose remains meaningful, or

b) under the GNU GPL, with none of the additional permissions of
this License applicable to that copy.

3. Object Code Incorporating Material from Library Header Files.

The object code form of an Application may incorporate material from
a header file that is part of the Library. You may convey such object
code under terms of your choice, provided that, if the incorporated
material is not limited to numerical parameters, data structure
layouts and accessors, or small macros, inline functions and templates
(ten or fewer lines in length), you do both of the following:

a) Give prominent notice with each copy of the object code that the
Library is used in it and that the Library and its use are
covered by this License.

b) Accompany the object code with a copy of the GNU GPL and this license
document.

4. Combined Works.

You may convey a Combined Work under terms of your choice that,
taken together, effectively do not restrict modification of the
portions of the Library contained in the Combined Work and reverse
engineering for debugging such modifications, if you also do each of
the following:

a) Give prominent notice with each copy of the Combined Work that
the Library is used in it and that the Library and its use are
covered by this License.

b) Accompany the Combined Work with a copy of the GNU GPL and this license
document.

c) For a Combined Work that displays copyright notices during
execution, include the copyright notice for the Library among
these notices, as well as a reference directing the user to the
copies of the GNU GPL and this license document.

d) Do one of the following:

0) Convey the Minimal Corresponding Source under the terms of this
License, and the Corresponding Application Code in a form
suitable for, and under terms that permit, the user to
recombine or relink the Application with a modified version of
the Linked Version to produce a modified Combined Work, in the
manner specified by section 6 of the GNU GPL for conveying
Corresponding Source.

1) Use a suitable shared library mechanism for linking with the
Library. A suitable mechanism is one that (a) uses at run time
a copy of the Library already present on the user's computer
system, and (b) will operate properly with a modified version
of the Library that is interface-compatible with the Linked
Version.

e) Provide Installation Information, but only if you would otherwise
be required to provide such information under section 6 of the
GNU GPL, and only to the extent that such information is
necessary to install and execute a modified version of the
Combined Work produced by recombining or relinking the
Application with a modified version of the Linked Version. (If
you use option 4d0, the Installation Information must accompany
the Minimal Corresponding Source and Corresponding Application
Code. If you use option 4d1, you must provide the Installation
Information in the manner specified by section 6 of the GNU GPL
for conveying Corresponding Source.)

5. Combined Libraries.

You may place library facilities that are a work based on the
Library side by side in a single library together with other library
facilities that are not Applications and are not covered by this
License, and convey such a combined library under terms of your
choice, if you do both of the following:

a) Accompany the combined library with a copy of the same work based
on the Library, uncombined with any other library facilities,
conveyed under the terms of this License.

b) Give prominent notice with the combined library that part of it
is a work based on the Library, and explaining where to find the
accompanying uncombined form of the same work.

6. Revised Versions of the GNU Lesser General Public License.

The Free Software Foundation may publish revised and/or new versions
of the GNU Lesser General Public License from time to time. Such new
versions will be similar in spirit to the present version, but may
differ in detail to address new problems or concerns.

Each version is given a distinguishing version number. If the
Library as you received it specifies that a certain numbered version
of the GNU Lesser General Public License "or any later version"
applies to it, you have the option of following the terms and
conditions either of that published version or of any later version
published by the Free Software Foundation. If the Library as you
received it does not specify a version number of the GNU Lesser
General Public License, you may choose any version of the GNU Lesser
General Public License ever published by the Free Software Foundation.

If the Library as you received it specifies that a proxy can decide
whether future versions of the GNU Lesser General Public License shall
apply, that proxy's public statement of acceptance of any version is
permanent authorization for you to choose that version for the
Library.

77 changes: 77 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
# java-vorbis-support

Combination and continuation of JOrbis, JavaSPI and Tritonus-Share to provide Ogg/Vorbis playback capabilities for Java using the Sound SPI.

## Download, License, Feedback

- [Homepage](https://github.com/Trilarion/java-vorbis-support) of java-vorbis-support
- Requires Java 7 or later
- Download [vorbis-support-1.0.1.jar](https://github.com/Trilarion/java-vorbis-support/releases/download/v1.0.1/vorbis-support-1.0.1.jar) (released 19th June 2015) and/or [source code](https://github.com/Trilarion/java-vorbis-support/releases/tag/v1.0.1)
- License is [LGPLv3+](http://www.gnu.org/licenses/lgpl-3.0.txt)
- Support/Feedback: Create an [issue](https://github.com/Trilarion/java-vorbis-support/issues)

## Introduction

Ogg/Vorbis is a widely used free audio format featuring high compression ratios and there are libraries who enable support for Ogg in Java. Among them are [JOrbis](http://www.jcraft.com/jorbis/)
by JCraft - a pure Java Ogg/Vorbis decoder and [Ogg Vorbis SPI](http://www.javazoom.net/vorbisspi/vorbisspi.html) by JavaZoom which registers JOrbis as a service for the Java Sound API. The later also relies partly on the [Tritonus share](http://www.tritonus.org/) library. All three projects are inactive for several years now.

The reference implementation for Ogg/Vorbis is [libvorbis](http://xiph.org/vorbis/) written in C.

Vorbis support is the all-in-one combination and possibly continuation of JOrbis, JavaSPI and Tritonus-Share.

Alternatives are [Paul's SoundSystem](http://www.paulscode.com/forum/index.php?topic=4.0) (full support of Java Sound, JOAL, LWJGL gaming libraries, wrappers around JOrbis, J-OGG),
[Vorbis-Java](http://downloads.xiph.org/releases/vorbis-java/) (Java encoder and decoder at xiph.org), [EasyOgg](http://www.cokeandcode.com/index.html?page=libs) (wrapper around JOrbis)
and [J-OGG](http://www.j-ogg.de/) (independent ogg/vorbis decode). These projects are mostly inactive for years now.

## Why this project?

All three libraries, Jorbis, Vorbis SPI and Tritonus Share are almost always bundled together. Together they constitute a complete plattform independent Ogg/Vorbis support for the Java Sound API. Fortunately they share the same open source license (LGPL). Combining them together makes distribution and handling easier, can reduce the size of the download and makes testing and debugging easier. Last but not least, increasing the efficiency by optimizing the code will be a bit easier.

However since these libraries already exist, we do not need to take care of backwards compatibility, since there is always the fallback to the original libraries. Therefore to be able to use newer features of the Java language, the required Java version currently is 7 or later.

## Example

This library used the Services Provider Interface to enable Ogg/Vorbis playback under the hood without changing any of the code on the client's library side. Just put this library in the classpath
and access your sound resources (SourceDataLine or Clip) as you would without Ogg/Vorbis support. See the Java Tutorial on [Playing Back Audio](http://docs.oracle.com/javase/tutorial/sound/playing.html) for more information. And here is also an example that would play an entire ogg file.

try {
AudioInputStream in = AudioSystem.getAudioInputStream(new File("xyz.ogg");
if (in != null) {
AudioFormat baseFormat = in.getFormat();

AudioFormat targetFormat = new AudioFormat(AudioFormat.Encoding.PCM_SIGNED, baseFormat.getSampleRate(),
16, baseFormat.getChannels(), baseFormat.getChannels() * 2, baseFormat.getSampleRate(), false);

AudioInputStream dataIn = AudioSystem.getAudioInputStream(targetFormat, in);

byte[] buffer = new byte[4096];

// get a line from a mixer in the system with the wanted format
DataLine.Info info = new DataLine.Info(SourceDataLine.class, targetFormat);
SourceDataLine line = (SourceDataLine) AudioSystem.getLine(info);

if (line != null) {
line.open();

line.start();
int nBytesRead = 0, nBytesWritten = 0;
while (nBytesRead != -1) {
nBytesRead = dataIn.read(buffer, 0, buffer.length);
if (nBytesRead != -1) {
nBytesWritten = line.write(buffer, 0, nBytesRead);
}
}

line.drain();
line.stop();
line.close();

dataIn.close();
}

in.close();
// playback finished
}
} catch (UnsupportedAudioFileException | IOException | LineUnavailableException e) {
// failed
}
55 changes: 55 additions & 0 deletions build.gradle
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
description = 'Combination of JOrbis, JavaSPI and Tritonus-Share.'
version = '1.0.0'

apply plugin: 'java'

archivesBaseName = 'vorbis-support'
sourceCompatibility = 1.7
targetCompatibility = 1.7

repositories {
mavenCentral()
}

sourceSets {
examples
}

dependencies {
testCompile group: 'junit', name: 'junit', version: '4.+'
examplesCompile sourceSets.main.output
}

allprojects {
gradle.projectsEvaluated {
tasks.withType(JavaCompile) {
options.compilerArgs << "-Xlint:unchecked" << "-Xlint:deprecation"
}
}
}

task run(dependsOn: classes, type: JavaExec) {
if (project.hasProperty('mainClass')) {
main = mainClass
}
classpath = sourceSets.main.runtimeClasspath + sourceSets.examples.runtimeClasspath
standardInput = System.in
workingDir = sourceSets.examples.output.resourcesDir
}

task debug(dependsOn: classes, type: JavaExec) {
if (project.hasProperty('mainClass')) {
main = mainClass
}
classpath = sourceSets.main.runtimeClasspath + sourceSets.examples.runtimeClasspath
standardInput = System.in
workingDir = sourceSets.examples.output.resourcesDir
debug = true
}

if (sourceSets.examples.output.resourcesDir.exists()) {
test.workingDir = sourceSets.examples.output.resourcesDir
}



32 changes: 32 additions & 0 deletions precursors/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Three external libraries

## Ogg Vorbis SPI for Java™ Sound

http://www.javazoom.net/vorbisspi/vorbisspi.html

VorbisSPI is a Java Service Provider Interface that adds OGG Vorbis audio format support to Java platform. It supports icecast streaming. It is based on JOrbis Java libraries.

- download http://www.javazoom.net/vorbisspi/sources/vorbisspi1.0.3.zip from 06/08/2008
- licensed under LGPL2+

## JOrbis - Pure Java Ogg Vorbis Decoder

http://www.jcraft.com/jorbis/

JOrbis is a pure Java Ogg Vorbis decoder.
JOrbis accepts Ogg Vorbis bitstreams and decodes them to raw PCM.

- http://www.jcraft.com/jorbis/jorbis-0.0.17.zip
- licensed under LGPL2+

## Tritonus Share (Tritonus: Open Source Java Sound)

http://www.tritonus.org/

Shared classes required by all other Tritonus plug-ins.

- download cvs https://sourceforge.net/p/tritonus/code/ using pserver:anonymous@tritonus.cvs.sourceforge.net:/cvsroot/tritonus all before 2015-04-01
- licensed under LGPL2+



Loading

0 comments on commit 283c748

Please sign in to comment.