jamulus/README

68 lines
2.6 KiB
Text
Raw Normal View History

2013-02-11 15:57:11 +01:00
/******************************************************************************\
* Copyright (c) 2004-2013
*
* Author(s):
* Volker Fischer
*
******************************************************************************
*
* This program is free software; you can redistribute it and/or modify it under
* the terms of the GNU General Public License as published by the Free Software
* Foundation; either version 2 of the License, or (at your option) any later
* version.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
* details.
*
* You should have received a copy of the GNU General Public License along with
* this program; if not, write to the Free Software Foundation, Inc.,
* 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
\******************************************************************************/
2013-02-24 10:14:47 +01:00
Jamulus - Internet Jam Session Software
2013-02-11 15:57:11 +01:00
------------------------------------
2013-02-24 10:14:47 +01:00
Low-Latency (Internet) Connection tool
2013-02-11 15:57:11 +01:00
Under the GNU General Public License (GPL)
http://llcon.sourceforge.net
INTRODUCTION:
2013-02-24 10:14:47 +01:00
The Jamulus software enables musicians to perform real-time jam sessions over
the internet. There is one server running the Jamulus server software which
collects the audio data from each Jamulus client software, mixes the audio data
2013-02-11 15:57:11 +01:00
and sends the mix back to each client.
The minimum internet connection speed at each client must be 128 kbps for up-
and downstream. To get satisfactory results, the ping time from the client
computer to the server should not exceed 40 ms average.
2013-02-24 10:14:47 +01:00
Jamulus runs under Windows (ASIO), MacOS (Core Audio) and Linux (Jack). The Jamulus
2013-02-11 15:57:11 +01:00
software package includes both, the client and the server functionality which
can be selected by using command line arguments.
2013-02-24 10:14:47 +01:00
For starting the server type ./Jamulus -s
2013-02-11 15:57:11 +01:00
2013-02-16 19:00:08 +01:00
The audio is compressed with the OPUS audio codec to ensure a low delay and a
2013-02-11 15:57:11 +01:00
low upload/download rate.
EXTERNAL CODE:
This code contains open source code from different sources. The developer(s) want
to thank the developer of this code for making their efforts available under open
source:
- Qt cross-platform application framework: http://qt.digia.com
2013-02-16 19:00:08 +01:00
- Opus Interactive Audio Codec: http://www.opus-codec.org
2013-02-11 15:57:11 +01:00
- Audio reverberation code: by Perry R. Cook and Gary P. Scavone, 1995 - 2004
(taken from "The Synthesis ToolKit in C++ (STK)"):
http://ccrma.stanford.edu/software/stk
- Some pixmaps are from the Open Clip Art Library (OCAL):
http://openclipart.org