Commit 6ba11735 authored by jcaceres's avatar jcaceres
Browse files

Fixed previous new old branch

parent f4e12e3a
---
trunk
- (added) Support for RtAudio. Jacktrip can now be used without Jack
- (added) New port to Windows XP and Windows Vista
- (added) Multiclient Server
- (added) DNS Look-up support
---
1.0.5
- (added) Compatibility with JamLink boxes (restricted at the moment to 48KHz, 64 buffer size and 1 channel)
- (added) New port structure that allows the communication between a public server and a local client
- (added) Option for packets without header
- (added) Option to change default client name
- (fixed) General optimizations and code cleanup
- (added) Improved, now cross-platform build script
---
1.0.4
- (fixed) Buss error caused when no physical inputs or outputs ports are available
---
1.0.3
- (added) Redundancy Algorithm for UDP Packets to to avoid glitches with packet losses
- (fixed) Now compiles on 64bits machines
- (fixed) Improved exceptions handling
- (added) Basic Karplus-Strong model added as Plug-in
- (added) Some functionality reimplemented using signals and slots for
more flexibility
- (added) Multiple-Client-Server in alpha testing, expect it working in the next release
---
1.0.2 Alpha
- (added) Port offset mode, to use a different UDP port than the default one.
- (fixed) Improved thread behavior
---
1.0.1 Alpha
- (added) jamlink mode to connect with jamlink boxes
- (fixed) thread priority in both Linux and Mac OS X (still need some work on the Mac OS X version)
- (fixed) Bug that was causing plug-ins not to behave correctly
- (added) Loopback mode
- (added) Underrun Modes: Wavetable (default) and set to zeros
- (added) Check for peer audio settings, program exists if they don't match
- (added) Automatically connect ports to available physical audio interface.
---
1.0 Alpha - initial release
Jacktrip : Build Instructions for Linux and MacOS X
JackTrip: A System for High-Quality Audio Network Performance over the Internet.
---
MacOS X (10.3.9 or higher) Installation:
If you are installing on MacOS X, a universal binary is provided. You just need to have JackOSX installed on your machine
http://www.jackosx.com/
To install (using Terminal): go to bin/ directory and type:
sudo cp jacktrip /usr/bin/
(enter your password when prompted)
sudo chmod 755 /usr/bin/jacktrip
(now you can run jacktrip from any directory using Terminal)
---
Dependencies:
You need to have installed the libraries in your system:
qt4-devel
jack-audio-connection-kit-devel
If you are using yum (in Fedora 8 or later) you can just install them (as root) with:
yum install qt4-devel jack-audio-connection-kit-devel
If you want to build on MacOS X, you need JackOSX
http://www.jackosx.com/
and Qt 4.5 or higher.
http://trolltech.com/products/qt/
---
Build:
If you're on Mac OS X or Fedora Linux and have all the dependencies installed,
you can build by simply going to the /src directory and typing the following:
./build
If you want to build without Jack support (meaning that you won't need jack installed
to use the app) type the following:
./build nojack
If the previous script doesn't work on a different Linux flavor, try building
the Makfiles yourself. You'd need qmake (e.g., on Fedora, this command is called
qmake-qt4). Then you can build by:
qmake jacktrip.pro
make release
Or without Jack support:
qmake -config nojack jacktrip.pro
make release
If you want to install install (using Terminal): on the /src directory type:
sudo cp jacktrip /usr/bin/
(enter your password when prompted)
sudo chmod 755 /usr/bin/jacktrip
(now you can run jacktrip from any directory using Terminal)
-----------------------------
WINDOWS (XP and later)
Dependencies:
- ASIO4all audio driver is required even with Audio interfaces that support ASIO: www.asio4all.com
Installation:
Simply Run the setup file Jacktrip-1.1.exe, which will unpack Jacktrip in the directory of your choice,
the default is Program Files/Jacktrip.
The installer also adds the executable Jacktrip.exe in the System32 directory, so that it can be executed
from a command prompt from any working directory.
This executable (jacktrip.exe) can be found in the bin directory, along with the Dynamic
Link Libraries (DLLs) it links to.
Building:
The easiest way to build is to download the free Qt Creator IDE from http://qt.nokia.com/products/
Make a copy of the src and externals directories into a new directory of your choice, open the jacktrip.pro
file in src, and build the project.
You can alternatively download the MinGW (Minimalist GNU for Windows), a Windows port of the GNU
compiler from http://www.mingw.org/ and use mingw32-make from a command terminal to build the makefile.
Building is not supported with Microsoft Visual Studio Compilers.
Note: compiling with modifications in the .pro file (like adding a new source or header file) requires
qmake which is only available in the Qt Creator package.
---
BUILD WARNING
Always keep the /src and /externals directories under the same directory.
---
Post Configuration
Detailed instructions at
http://ccrma.stanford.edu/groups/soundwire/software/jacktrip/
---
Using JackTrip
Detailed instructions at
http://ccrma.stanford.edu/groups/soundwire/software/jacktrip/
High Priority TODOS:
--------------------
- Add redundancy to UDP (DONE)
- Finish header implementation, add run-time check
Plug-ins:
---------
- Extend Plugin structure to include more than 1 plug-in and add the mode for local effect (not loopback)
- add the offset option to process starting from a different channel
- Set the faust compiler to automatically generate plugins
- Add low latency compression www.celt-codec.org
Protocol:
---------
- Add TCP clacc
- Add SCTP class
- Maybe add a layer of OSC communication for control messages
//*****************************************************************
/*
JackTrip: A System for High-Quality Audio Network Performance
over the Internet
Copyright (c) 2008 Juan-Pablo Caceres, Chris Chafe.
SoundWIRE group at CCRMA, Stanford University.
Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
*/
//*****************************************************************
/**
* \file documentation.cpp
* \author Juan-Pablo Caceres
* \date July 2008
*/
// Main Page Documentation
//-----------------------------------------------------------------
/**
\mainpage JackTrip Documentation
\section intro_sec About JackTrip
JackTrip: A System for High-Quality Audio Network Performance
over the Internet.
JackTrip is a Linux and Mac OS X-based system used for multi-machine network
performance over the Internet. It supports any number of channels
(as many as the computer/network can handle) of bidirectional, high quality,
uncompressed audio signal steaming.
You can use it between any combination of Linux and Mac OS X
(i.e., one end using Linux can connect to the other using Mac OS X).
It is currently being developed and actively tested at CCRMA by the SoundWIRE group.
\section install_sec Installation
Download the latest release:
<a href="http://code.google.com/p/jacktrip/">Download</a>
Please read the documentation inside the packet to install.
\subsection install_subsec_osx Mac OS X Requirements
You'll need: <a href="http://www.jackosx.com/">Jack OS X</a>.
The documentation explains how to install it and set it up, and it's highly recommended.
Jack OS X comes with JackPilot to do the audio routing.
An alternative is <a href="http://qjackctl.sourceforge.net/">qjackctl</a>,
which I find easier to use. You can find the binary here:
<a href="http://www.ardour.org/osx_system_requirements">qjackctl mac binary</a>
If you use Leopard, you won't need to configure the UDP ports manually.
\subsubsection install_linux Linux Requirements
Please read the documentation inside the packet to compile and install in linux.\n
The older version of JackTrip is documented
<a href="http://ccrma.stanford.edu/groups/soundwire/software/jacktrip/">here</a>.
Please follow those instructions to configure the firewall under
\section using Using JackTrip
Type jacktrip in a terminal window to display a help list with all the options.
JackTrip uses Jack as its audio server. You have to make sure that the settings in
Jack are the same in the local and remote machine.
There are two parameters that you want to tweak: Frames/Period and Sample Rate.
The Lower the Frames/Period, the lower the latency.
The higher the Sampling Rate, the higher the bandwidth requirements.
You have to make sure these settings match in both machines.
\image html jack_main_settings.jpg
You also may want to look at the internal buffering
<tt>-q, --queue</tt> parameter in JackTrip. If your connection is very unstable, with a lot of jitter,
you should increase this number at the expense of a higher latency.
The audio bit resolution parameter, <tt>-b, --bitres</tt>, can be use to decrease (or increase)
the bandwidth requirements, at the expense of a lower audio quality.
A basic connection will have one of the nodes as a server:
<tt>jacktrip -s</tt>
And the other as a client
<tt>jacktrip -c [SERVER-IP-NUMBER]</tt>
You'll see a JackTrip client in Jack. Everything you connect into the send ports
will be transmitted to your peer. You'll receive what your peer sends you on the receive ports.
\image html jack_routing.png
*/
</BODY>
</HTML>
<center>
<footer>
<p>&nbsp</p>
<font size="1">
<p>Documentation generated by Doxygen $doxygenversion on $datetime</p>
<p>
&copy; 2008 by Juan-Pablo Caceres (jcaceres <em>at</em> ccrma <em>dot</em> stanford <em>dot</em> edu) and
Chris Chafe<br />
<a href="http://ccrma.stanford.edu/groups/soundwire/" title="SoundWIRE Group">SoundWIRE Group</a> at
<a href="http://ccrma.stanford.edu/" title="CCRMA home">CCRMA</a> -
<a href="http://www.stanford.edu/" title="Stanford home">Stanford University</a>
</font>
<p>
<a href="http://sourceforge.net"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=236811&amp;type=1" width="88" height="31" border="0" alt="SourceForge.net Logo" /></a>
</p>
</center>
</footer>
/* -*- Mode: C ; c-basic-offset: 4 -*- */
/*
JACK control API
Copyright (C) 2008 Nedko Arnaudov
Copyright (C) 2008 GRAME
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; version 2 of the License.
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., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
/**
* @file jack/control.h
* @ingroup publicheader
* @brief JACK control API
*
*/
#ifndef JACKCTL_H__2EEDAD78_DF4C_4B26_83B7_4FF1A446A47E__INCLUDED
#define JACKCTL_H__2EEDAD78_DF4C_4B26_83B7_4FF1A446A47E__INCLUDED
#include <jack/jslist.h>
#include <jack/systemdeps.h>
/** Parameter types, intentionally similar to jack_driver_param_type_t */
typedef enum
{
JackParamInt = 1, /**< @brief value type is a signed integer */
JackParamUInt, /**< @brief value type is an unsigned integer */
JackParamChar, /**< @brief value type is a char */
JackParamString, /**< @brief value type is a string with max size of ::JACK_PARAM_STRING_MAX+1 chars */
JackParamBool, /**< @brief value type is a boolean */
} jackctl_param_type_t;
/** @brief Max value that jackctl_param_type_t type can have */
#define JACK_PARAM_MAX (JackParamBool + 1)
/** @brief Max length of string parameter value, excluding terminating nul char */
#define JACK_PARAM_STRING_MAX 63
/** @brief Type for parameter value */
/* intentionally similar to jack_driver_param_value_t */
union jackctl_parameter_value
{
uint32_t ui; /**< @brief member used for ::JackParamUInt */
int32_t i; /**< @brief member used for ::JackParamInt */
char c; /**< @brief member used for ::JackParamChar */
char str[JACK_PARAM_STRING_MAX + 1]; /**< @brief member used for ::JackParamString */
bool b; /**< @brief member used for ::JackParamBool */
};
/** opaque type for server object */
typedef struct jackctl_server jackctl_server_t;
/** opaque type for driver object */
typedef struct jackctl_driver jackctl_driver_t;
/** opaque type for internal client object */
typedef struct jackctl_internal jackctl_internal_t;
/** opaque type for parameter object */
typedef struct jackctl_parameter jackctl_parameter_t;
#ifdef __cplusplus
extern "C" {
#endif
#if 0
} /* Adjust editor indent */
#endif
/**
* @defgroup ServerControl Controling the server
* @{
*/
/**
* Call this function to setup process signal handling. As a general
* rule, it is required for proper operation for the server object.
*
* @param flags signals setup flags, use 0 for none. Currently no
* flags are defined
*
* @return the configurated signal set.
*/
sigset_t
jackctl_setup_signals(
unsigned int flags);
/**
* Call this function to wait on a signal set.
*
* @param signals signals set to wait on
*/
void
jackctl_wait_signals(
sigset_t signals);
/**
* Call this function to create server object.
*
* @return server object handle, NULL if creation of server object
* failed. Successfully created server object must be destroyed with
* paired call to ::jackctl_server_destroy
*/
jackctl_server_t *
jackctl_server_create();
/**
* Call this function to destroy server object.
*
* @param server server object handle to destroy
*/
void
jackctl_server_destroy(
jackctl_server_t * server);
/**
* Call this function to get list of available drivers. List node data
* pointers is a driver object handle (::jackctl_driver_t).
*
* @param server server object handle to get drivers for
*
* @return Single linked list of driver object handles. Must not be
* modified. Always same for same server object.
*/
const JSList *
jackctl_server_get_drivers_list(
jackctl_server_t * server);
/**
* Call this function to start JACK server
*
* @param server server object handle
* @param driver driver to use
*
* @return success status: true - success, false - fail
*/
bool
jackctl_server_start(
jackctl_server_t * server,
jackctl_driver_t * driver);
/**
* Call this function to stop JACK server
*
* @param server server object handle
*
* @return success status: true - success, false - fail
*/
bool
jackctl_server_stop(
jackctl_server_t * server);
/**
* Call this function to get list of server parameters. List node data
* pointers is a parameter object handle (::jackctl_parameter_t).
*
* @param server server object handle to get parameters for
*
* @return Single linked list of parameter object handles. Must not be
* modified. Always same for same server object.
*/
const JSList *
jackctl_server_get_parameters(
jackctl_server_t * server);
/**
* Call this function to get name of driver.
*
* @param driver driver object handle to get name of
*
* @return driver name. Must not be modified. Always same for same
* driver object.
*/
const char *
jackctl_driver_get_name(
jackctl_driver_t * driver);
/**
* Call this function to get list of driver parameters. List node data
* pointers is a parameter object handle (::jackctl_parameter_t).
*
* @param driver driver object handle to get parameters for
*
* @return Single linked list of parameter object handles. Must not be
* modified. Always same for same driver object.
*/
const JSList *
jackctl_driver_get_parameters(
jackctl_driver_t * driver);
/**
* Call this function to get parameter name.
*
* @param parameter parameter object handle to get name of
*
* @return parameter name. Must not be modified. Always same for same
* parameter object.
*/
const char *
jackctl_parameter_get_name(
jackctl_parameter_t * parameter);
/**
* Call this function to get parameter short description.
*
* @param parameter parameter object handle to get short description of
*
* @return parameter short description. Must not be modified. Always
* same for same parameter object.
*/
const char *
jackctl_parameter_get_short_description(
jackctl_parameter_t * parameter);
/**
* Call this function to get parameter long description.
*
* @param parameter parameter object handle to get long description of
*
* @return parameter long description. Must not be modified. Always
* same for same parameter object.
*/
const char *
jackctl_parameter_get_long_description(
jackctl_parameter_t * parameter);
/**
* Call this function to get parameter type.
*
* @param parameter parameter object handle to get type of
*
* @return parameter type. Always same for same parameter object.
*/
jackctl_param_type_t
jackctl_parameter_get_type(
jackctl_parameter_t * parameter);
/**
* Call this function to get parameter character.
*
* @param parameter parameter object handle to get character of
*
* @return character.
*/
char
jackctl_parameter_get_id(
jackctl_parameter_t * parameter);
/**
* Call this function to check whether parameter has been set, or its
* default value is being used.
*
* @param parameter parameter object handle to check
*
* @return true - parameter is set, false - parameter is using default
* value.
*/
bool
jackctl_parameter_is_set(
jackctl_parameter_t * parameter);
/**
* Call this function to reset parameter to its default value.
*
* @param parameter parameter object handle to reset value of
*
* @return success status: true - success, false - fail
*/
bool
jackctl_parameter_reset(
jackctl_parameter_t * parameter);
/**
* Call this function to get parameter value.
*
* @param parameter parameter object handle to get value of
*