jackaudio
/
headers
mirror of https://github.com/jackaudio/headers
1
0
Fork 0
Code Releases 2 Activity
Browse Source

Merge 9130d18b8a into 2bfa506971

pull/12/merge
David Robillard GitHub 3 years ago
parent
2bfa506971 9130d18b8a
commit
b7a51a9a38
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
16 changed files with 489 additions and 511 deletions
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. +108
    -111
      control.h
  2. +20
    -24
      intclient.h
  3. +103
    -104
      jack.h
  4. +30
    -31
      jslist.h
  5. +22
    -22
      metadata.h
  6. +15
    -18
      midiport.h
  7. +10
    -11
      ringbuffer.h
  8. +4
    -3
      session.h
  9. +19
    -21
      statistics.h
  10. +17
    -18
      systemdeps.h
  11. +9
    -10
      thread.h
  12. +57
    -58
      transport.h
  13. +40
    -41
      types.h
  14. +7
    -9
      uuid.h
  15. +16
    -17
      weakjack.h
  16. +12
    -13
      weakmacros.h

+ 108
- 111
control.h View File

@@ -1,24 +1,21 @@
/* -*- Mode: C ; c-basic-offset: 4 -*- */
/* /*
JACK control API
Copyright (C) 2008 Nedko Arnaudov
Copyright (C) 2008 GRAME


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 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.
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 * @file jack/control.h
* @ingroup publicheader * @ingroup publicheader
@@ -26,8 +23,8 @@
* *
*/ */


#ifndef __jack_control_h__
#define __jack_control_h__
#ifndef JACK_CONTROL_H
#define JACK_CONTROL_H


#include <jack/jslist.h> #include <jack/jslist.h>


@@ -86,10 +83,10 @@ extern "C" {
* @{ * @{
*/ */


/**
/**
* Call this function to setup process signal handling. As a general * Call this function to setup process signal handling. As a general
* rule, it is required for proper operation for the server object. * rule, it is required for proper operation for the server object.
*
*
* @param flags signals setup flags, use 0 for none. Currently no * @param flags signals setup flags, use 0 for none. Currently no
* flags are defined * flags are defined
* *
@@ -99,9 +96,9 @@ sigset_t
jackctl_setup_signals( jackctl_setup_signals(
unsigned int flags); unsigned int flags);


/**
/**
* Call this function to wait on a signal set. * Call this function to wait on a signal set.
*
*
* @param signals signals set to wait on * @param signals signals set to wait on
*/ */
void void
@@ -123,21 +120,21 @@ jackctl_server_create(
bool (* on_device_acquire)(const char * device_name), bool (* on_device_acquire)(const char * device_name),
void (* on_device_release)(const char * device_name)); void (* on_device_release)(const char * device_name));


/**
/**
* Call this function to destroy server object. * Call this function to destroy server object.
*
*
* @param server server object handle to destroy * @param server server object handle to destroy
*/ */
void void
jackctl_server_destroy( jackctl_server_destroy(
jackctl_server_t * server); jackctl_server_t * server);


/**
/**
* Call this function to start JACK server * Call this function to start JACK server
*
*
* @param server server object handle * @param server server object handle
* @param driver driver to use * @param driver driver to use
*
*
* @return success status: true - success, false - fail * @return success status: true - success, false - fail
*/ */
bool bool
@@ -145,21 +142,21 @@ jackctl_server_start(
jackctl_server_t * server, jackctl_server_t * server,
jackctl_driver_t * driver); jackctl_driver_t * driver);


/**
/**
* Call this function to stop JACK server * Call this function to stop JACK server
*
*
* @param server server object handle * @param server server object handle
*
*
* @return success status: true - success, false - fail * @return success status: true - success, false - fail
*/ */
bool bool
jackctl_server_stop( jackctl_server_stop(
jackctl_server_t * server); jackctl_server_t * server);


/**
/**
* Call this function to get list of available drivers. List node data * Call this function to get list of available drivers. List node data
* pointers is a driver object handle (::jackctl_driver_t). * pointers is a driver object handle (::jackctl_driver_t).
*
*
* @param server server object handle to get drivers for * @param server server object handle to get drivers for
* *
* @return Single linked list of driver object handles. Must not be * @return Single linked list of driver object handles. Must not be
@@ -169,10 +166,10 @@ const JSList *
jackctl_server_get_drivers_list( jackctl_server_get_drivers_list(
jackctl_server_t * server); jackctl_server_t * server);


/**
/**
* Call this function to get list of server parameters. List node data * Call this function to get list of server parameters. List node data
* pointers is a parameter object handle (::jackctl_parameter_t). * pointers is a parameter object handle (::jackctl_parameter_t).
*
*
* @param server server object handle to get parameters for * @param server server object handle to get parameters for
* *
* @return Single linked list of parameter object handles. Must not be * @return Single linked list of parameter object handles. Must not be
@@ -182,10 +179,10 @@ const JSList *
jackctl_server_get_parameters( jackctl_server_get_parameters(
jackctl_server_t * server); jackctl_server_t * server);


/**
/**
* Call this function to get list of available internal clients. List node data * Call this function to get list of available internal clients. List node data
* pointers is a internal client object handle (::jackctl_internal_t). * pointers is a internal client object handle (::jackctl_internal_t).
*
*
* @param server server object handle to get internal clients for * @param server server object handle to get internal clients for
* *
* @return Single linked list of internal client object handles. Must not be * @return Single linked list of internal client object handles. Must not be
@@ -195,12 +192,12 @@ const JSList *
jackctl_server_get_internals_list( jackctl_server_get_internals_list(
jackctl_server_t * server); jackctl_server_t * server);


/**
/**
* Call this function to load one internal client. * Call this function to load one internal client.
*
*
* @param server server object handle * @param server server object handle
* @param internal internal to use * @param internal internal to use
*
*
* @return success status: true - success, false - fail * @return success status: true - success, false - fail
*/ */
bool bool
@@ -208,12 +205,12 @@ jackctl_server_load_internal(
jackctl_server_t * server, jackctl_server_t * server,
jackctl_internal_t * internal); jackctl_internal_t * internal);


/**
/**
* Call this function to unload one internal client. * Call this function to unload one internal client.
*
*
* @param server server object handle * @param server server object handle
* @param internal internal to unload * @param internal internal to unload
*
*
* @return success status: true - success, false - fail * @return success status: true - success, false - fail
*/ */
bool bool
@@ -221,46 +218,46 @@ jackctl_server_unload_internal(
jackctl_server_t * server, jackctl_server_t * server,
jackctl_internal_t * internal); jackctl_internal_t * internal);


/**
/**
* Call this function to add a slave in the driver slave list. * Call this function to add a slave in the driver slave list.
*
*
* @param server server object handle * @param server server object handle
* @param driver driver to add in the driver slave list. * @param driver driver to add in the driver slave list.
*
*
* @return success status: true - success, false - fail * @return success status: true - success, false - fail
*/
bool
*/
bool
jackctl_server_add_slave(jackctl_server_t * server, jackctl_server_add_slave(jackctl_server_t * server,
jackctl_driver_t * driver); jackctl_driver_t * driver);


/**
/**
* Call this function to remove a slave from the driver slave list. * Call this function to remove a slave from the driver slave list.
*
*
* @param server server object handle * @param server server object handle
* @param driver driver to remove from the driver slave list. * @param driver driver to remove from the driver slave list.
*
*
* @return success status: true - success, false - fail * @return success status: true - success, false - fail
*/
bool
*/
bool
jackctl_server_remove_slave(jackctl_server_t * server, jackctl_server_remove_slave(jackctl_server_t * server,
jackctl_driver_t * driver); jackctl_driver_t * driver);


/**
/**
* Call this function to switch master driver. * Call this function to switch master driver.
*
*
* @param server server object handle * @param server server object handle
* @param driver driver to switch to * @param driver driver to switch to
*
*
* @return success status: true - success, false - fail * @return success status: true - success, false - fail
*/
bool
*/
bool
jackctl_server_switch_master(jackctl_server_t * server, jackctl_server_switch_master(jackctl_server_t * server,
jackctl_driver_t * driver); jackctl_driver_t * driver);


/**

/**
* Call this function to get name of driver. * Call this function to get name of driver.
*
*
* @param driver driver object handle to get name of * @param driver driver object handle to get name of
* *
* @return driver name. Must not be modified. Always same for same * @return driver name. Must not be modified. Always same for same
@@ -270,10 +267,10 @@ const char *
jackctl_driver_get_name( jackctl_driver_get_name(
jackctl_driver_t * driver); jackctl_driver_t * driver);


/**
/**
* Call this function to get list of driver parameters. List node data * Call this function to get list of driver parameters. List node data
* pointers is a parameter object handle (::jackctl_parameter_t). * pointers is a parameter object handle (::jackctl_parameter_t).
*
*
* @param driver driver object handle to get parameters for * @param driver driver object handle to get parameters for
* *
* @return Single linked list of parameter object handles. Must not be * @return Single linked list of parameter object handles. Must not be
@@ -283,9 +280,9 @@ const JSList *
jackctl_driver_get_parameters( jackctl_driver_get_parameters(
jackctl_driver_t * driver); jackctl_driver_t * driver);


/**
/**
* Call this function to get name of internal client. * Call this function to get name of internal client.
*
*
* @param internal internal object handle to get name of * @param internal internal object handle to get name of
* *
* @return internal name. Must not be modified. Always same for same * @return internal name. Must not be modified. Always same for same
@@ -295,10 +292,10 @@ const char *
jackctl_internal_get_name( jackctl_internal_get_name(
jackctl_internal_t * internal); jackctl_internal_t * internal);


/**
/**
* Call this function to get list of internal parameters. List node data * Call this function to get list of internal parameters. List node data
* pointers is a parameter object handle (::jackctl_parameter_t). * pointers is a parameter object handle (::jackctl_parameter_t).
*
*
* @param internal internal object handle to get parameters for * @param internal internal object handle to get parameters for
* *
* @return Single linked list of parameter object handles. Must not be * @return Single linked list of parameter object handles. Must not be
@@ -308,9 +305,9 @@ const JSList *
jackctl_internal_get_parameters( jackctl_internal_get_parameters(
jackctl_internal_t * internal); jackctl_internal_t * internal);


/**
/**
* Call this function to get parameter name. * Call this function to get parameter name.
*
*
* @param parameter parameter object handle to get name of * @param parameter parameter object handle to get name of
* *
* @return parameter name. Must not be modified. Always same for same * @return parameter name. Must not be modified. Always same for same
@@ -320,9 +317,9 @@ const char *
jackctl_parameter_get_name( jackctl_parameter_get_name(
jackctl_parameter_t * parameter); jackctl_parameter_t * parameter);


/**
/**
* Call this function to get parameter short description. * Call this function to get parameter short description.
*
*
* @param parameter parameter object handle to get short description of * @param parameter parameter object handle to get short description of
* *
* @return parameter short description. Must not be modified. Always * @return parameter short description. Must not be modified. Always
@@ -332,9 +329,9 @@ const char *
jackctl_parameter_get_short_description( jackctl_parameter_get_short_description(
jackctl_parameter_t * parameter); jackctl_parameter_t * parameter);


/**
/**
* Call this function to get parameter long description. * Call this function to get parameter long description.
*
*
* @param parameter parameter object handle to get long description of * @param parameter parameter object handle to get long description of
* *
* @return parameter long description. Must not be modified. Always * @return parameter long description. Must not be modified. Always
@@ -344,9 +341,9 @@ const char *
jackctl_parameter_get_long_description( jackctl_parameter_get_long_description(
jackctl_parameter_t * parameter); jackctl_parameter_t * parameter);


/**
/**
* Call this function to get parameter type. * Call this function to get parameter type.
*
*
* @param parameter parameter object handle to get type of * @param parameter parameter object handle to get type of
* *
* @return parameter type. Always same for same parameter object. * @return parameter type. Always same for same parameter object.
@@ -355,21 +352,21 @@ jackctl_param_type_t
jackctl_parameter_get_type( jackctl_parameter_get_type(
jackctl_parameter_t * parameter); jackctl_parameter_t * parameter);


/**
/**
* Call this function to get parameter character. * Call this function to get parameter character.
*
*
* @param parameter parameter object handle to get character of * @param parameter parameter object handle to get character of
* *
* @return character.
* @return character.
*/ */
char char
jackctl_parameter_get_id( jackctl_parameter_get_id(
jackctl_parameter_t * parameter); jackctl_parameter_t * parameter);


/**
/**
* Call this function to check whether parameter has been set, or its * Call this function to check whether parameter has been set, or its
* default value is being used. * default value is being used.
*
*
* @param parameter parameter object handle to check * @param parameter parameter object handle to check
* *
* @return true - parameter is set, false - parameter is using default * @return true - parameter is set, false - parameter is using default
@@ -379,9 +376,9 @@ bool
jackctl_parameter_is_set( jackctl_parameter_is_set(
jackctl_parameter_t * parameter); jackctl_parameter_t * parameter);


/**
/**
* Call this function to reset parameter to its default value. * Call this function to reset parameter to its default value.
*
*
* @param parameter parameter object handle to reset value of * @param parameter parameter object handle to reset value of
* *
* @return success status: true - success, false - fail * @return success status: true - success, false - fail
@@ -390,9 +387,9 @@ bool
jackctl_parameter_reset( jackctl_parameter_reset(
jackctl_parameter_t * parameter); jackctl_parameter_t * parameter);


/**
/**
* Call this function to get parameter value. * Call this function to get parameter value.
*
*
* @param parameter parameter object handle to get value of * @param parameter parameter object handle to get value of
* *
* @return parameter value. * @return parameter value.
@@ -401,9 +398,9 @@ union jackctl_parameter_value
jackctl_parameter_get_value( jackctl_parameter_get_value(
jackctl_parameter_t * parameter); jackctl_parameter_t * parameter);


/**
/**
* Call this function to set parameter value. * Call this function to set parameter value.
*
*
* @param parameter parameter object handle to get value of * @param parameter parameter object handle to get value of
* @param value_ptr pointer to variable containing parameter value * @param value_ptr pointer to variable containing parameter value
* *
@@ -414,9 +411,9 @@ jackctl_parameter_set_value(
jackctl_parameter_t * parameter, jackctl_parameter_t * parameter,
const union jackctl_parameter_value * value_ptr); const union jackctl_parameter_value * value_ptr);


/**
/**
* Call this function to get parameter default value. * Call this function to get parameter default value.
*
*
* @param parameter parameter object handle to get default value of * @param parameter parameter object handle to get default value of
* *
* @return parameter default value. * @return parameter default value.
@@ -424,10 +421,10 @@ jackctl_parameter_set_value(
union jackctl_parameter_value union jackctl_parameter_value
jackctl_parameter_get_default_value( jackctl_parameter_get_default_value(
jackctl_parameter_t * parameter); jackctl_parameter_t * parameter);
/**
/**
* Call this function check whether parameter has range constraint. * Call this function check whether parameter has range constraint.
*
*
* @param parameter object handle of parameter to check * @param parameter object handle of parameter to check
* *
* @return whether parameter has range constraint. * @return whether parameter has range constraint.
@@ -436,9 +433,9 @@ bool
jackctl_parameter_has_range_constraint( jackctl_parameter_has_range_constraint(
jackctl_parameter_t * parameter); jackctl_parameter_t * parameter);


/**
/**
* Call this function check whether parameter has enumeration constraint. * Call this function check whether parameter has enumeration constraint.
*
*
* @param parameter object handle of parameter to check * @param parameter object handle of parameter to check
* *
* @return whether parameter has enumeration constraint. * @return whether parameter has enumeration constraint.
@@ -447,9 +444,9 @@ bool
jackctl_parameter_has_enum_constraint( jackctl_parameter_has_enum_constraint(
jackctl_parameter_t * parameter); jackctl_parameter_t * parameter);


/**
/**
* Call this function get how many enumeration values parameter has. * Call this function get how many enumeration values parameter has.
*
*
* @param parameter object handle of parameter * @param parameter object handle of parameter
* *
* @return number of enumeration values * @return number of enumeration values
@@ -458,9 +455,9 @@ uint32_t
jackctl_parameter_get_enum_constraints_count( jackctl_parameter_get_enum_constraints_count(
jackctl_parameter_t * parameter); jackctl_parameter_t * parameter);


/**
/**
* Call this function to get parameter enumeration value. * Call this function to get parameter enumeration value.
*
*
* @param parameter object handle of parameter * @param parameter object handle of parameter
* @param index index of parameter enumeration value * @param index index of parameter enumeration value
* *
@@ -471,9 +468,9 @@ jackctl_parameter_get_enum_constraint_value(
jackctl_parameter_t * parameter, jackctl_parameter_t * parameter,
uint32_t index); uint32_t index);


/**
/**
* Call this function to get parameter enumeration value description. * Call this function to get parameter enumeration value description.
*
*
* @param parameter object handle of parameter * @param parameter object handle of parameter
* @param index index of parameter enumeration value * @param index index of parameter enumeration value
* *
@@ -484,9 +481,9 @@ jackctl_parameter_get_enum_constraint_description(
jackctl_parameter_t * parameter, jackctl_parameter_t * parameter,
uint32_t index); uint32_t index);


/**
/**
* Call this function to get parameter range. * Call this function to get parameter range.
*
*
* @param parameter object handle of parameter * @param parameter object handle of parameter
* @param min_ptr pointer to variable receiving parameter minimum value * @param min_ptr pointer to variable receiving parameter minimum value
* @param max_ptr pointer to variable receiving parameter maximum value * @param max_ptr pointer to variable receiving parameter maximum value
@@ -497,10 +494,10 @@ jackctl_parameter_get_range_constraint(
union jackctl_parameter_value * min_ptr, union jackctl_parameter_value * min_ptr,
union jackctl_parameter_value * max_ptr); union jackctl_parameter_value * max_ptr);


/**
/**
* Call this function to check whether parameter constraint is strict, * Call this function to check whether parameter constraint is strict,
* i.e. whether supplying non-matching value will not work for sure. * i.e. whether supplying non-matching value will not work for sure.
*
*
* @param parameter parameter object handle to check * @param parameter parameter object handle to check
* *
* @return whether parameter constraint is strict. * @return whether parameter constraint is strict.
@@ -509,11 +506,11 @@ bool
jackctl_parameter_constraint_is_strict( jackctl_parameter_constraint_is_strict(
jackctl_parameter_t * parameter); jackctl_parameter_t * parameter);


/**
/**
* Call this function to check whether parameter has fake values, * Call this function to check whether parameter has fake values,
* i.e. values have no user meaningful meaning and only value * i.e. values have no user meaningful meaning and only value
* description is meaningful to user. * description is meaningful to user.
*
*
* @param parameter parameter object handle to check * @param parameter parameter object handle to check
* *
* @return whether parameter constraint is strict. * @return whether parameter constraint is strict.
@@ -522,9 +519,9 @@ bool
jackctl_parameter_constraint_is_fake_value( jackctl_parameter_constraint_is_fake_value(
jackctl_parameter_t * parameter); jackctl_parameter_t * parameter);


/**
/**
* Call this function to log an error message. * Call this function to log an error message.
*
*
* @param format string * @param format string
*/ */
void void
@@ -532,9 +529,9 @@ jack_error(
const char *format, const char *format,
...); ...);


/**
/**
* Call this function to log an information message. * Call this function to log an information message.
*
*
* @param format string * @param format string
*/ */
void void
@@ -542,10 +539,10 @@ jack_info(
const char *format, const char *format,
...); ...);


/**
/**
* Call this function to log an information message but only when * Call this function to log an information message but only when
* verbose mode is enabled. * verbose mode is enabled.
*
*
* @param format string * @param format string
*/ */
void void
@@ -562,4 +559,4 @@ jack_log(
} /* extern "C" */ } /* extern "C" */
#endif #endif


#endif /* __jack_control_h__ */
#endif /* JACK_CONTROL_H */

+ 20
- 24
intclient.h View File

@@ -1,24 +1,23 @@
/* /*
* Copyright (C) 2004 Jack O'Quin
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser 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.
*
*/
Copyright (C) 2004 Jack O'Quin

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.


#ifndef __jack_intclient_h__
#define __jack_intclient_h__
You should have received a copy of the GNU Lesser 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.
*/

#ifndef JACK_INTCLIENT_H
#define JACK_INTCLIENT_H


#ifdef __cplusplus #ifdef __cplusplus
extern "C" { extern "C" {
@@ -93,9 +92,6 @@ int jack_internal_client_handle (jack_client_t *client,
* information from the load operation. This status word is formed by * information from the load operation. This status word is formed by
* OR-ing together the relevant @ref JackStatus bits. * OR-ing together the relevant @ref JackStatus bits.
* *
* @param handle the client handle will be returned here (passed
* by reference because of the type.
*
* <b>Optional parameters:</b> depending on corresponding [@a options * <b>Optional parameters:</b> depending on corresponding [@a options
* bits] additional parameters may follow @a status (in this order). * bits] additional parameters may follow @a status (in this order).
* *
@@ -114,7 +110,7 @@ int jack_internal_client_handle (jack_client_t *client,
int jack_internal_client_load (jack_client_t *client, int jack_internal_client_load (jack_client_t *client,
const char *client_name, const char *client_name,
jack_options_t options, jack_options_t options,
jack_status_t *status,
jack_status_t *status,
jack_intclient_t, ...); jack_intclient_t, ...);
/** /**
* Unload an internal client from a JACK server. This calls the * Unload an internal client from a JACK server. This calls the
@@ -135,4 +131,4 @@ jack_status_t jack_internal_client_unload (jack_client_t *client,
} }
#endif #endif


#endif /* __jack_intclient_h__ */
#endif /* JACK_INTCLIENT_H */

+ 103
- 104
jack.h View File

@@ -1,25 +1,24 @@
/* /*
Copyright (C) 2001 Paul Davis Copyright (C) 2001 Paul Davis
Copyright (C) 2004 Jack O'Quin Copyright (C) 2004 Jack O'Quin
This program is free software; you can redistribute it and/or modify This program is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version. (at your option) any later version.
This program is distributed in the hope that it will be useful, This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details. GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License You should have received a copy of the GNU Lesser General Public License
along with this program; if not, write to the Free Software
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.

*/ */


#ifndef __jack_h__
#define __jack_h__
#ifndef JACK_JACK_H
#define JACK_JACK_H


#ifdef __cplusplus #ifdef __cplusplus
extern "C" { extern "C" {
@@ -37,12 +36,12 @@ extern "C" {
/************************************************************* /*************************************************************
* NOTE: JACK_WEAK_EXPORT ***MUST*** be used on every function * NOTE: JACK_WEAK_EXPORT ***MUST*** be used on every function
* added to the JACK API after the 0.116.2 release. * added to the JACK API after the 0.116.2 release.
*
* Functions that predate this release are marked with
*
* Functions that predate this release are marked with
* JACK_WEAK_OPTIONAL_EXPORT which can be defined at compile * JACK_WEAK_OPTIONAL_EXPORT which can be defined at compile
* time in a variety of ways. The default definition is empty, * time in a variety of ways. The default definition is empty,
* so that these symbols get normal linkage. If you wish to * so that these symbols get normal linkage. If you wish to
* use all JACK symbols with weak linkage, include
* use all JACK symbols with weak linkage, include
* <jack/weakjack.h> before jack.h. * <jack/weakjack.h> before jack.h.
*************************************************************/ *************************************************************/


@@ -120,7 +119,7 @@ char *jack_get_client_name (jack_client_t *client) JACK_OPTIONAL_WEAK_EXPORT;


/** /**
* @return pointer to a string representation of the UUID for * @return pointer to a string representation of the UUID for
* a client named @param name . If no such client exists, return NULL
* a client named `name`. If no such client exists, return NULL
* *
* @param client the client making the request * @param client the client making the request
* @param name the name of the client whose UUID is desired * @param name the name of the client whose UUID is desired
@@ -137,7 +136,7 @@ char *jack_get_uuid_for_client_name (jack_client_t *client,
* *
* @param client making the request * @param client making the request
* @param uuid the uuid of the client whose name is desired * @param uuid the uuid of the client whose name is desired
*
*
* Return NULL if no such client with the given UUID exists * Return NULL if no such client with the given UUID exists
*/ */
char *jack_get_client_name_by_uuid (jack_client_t *client, char *jack_get_client_name_by_uuid (jack_client_t *client,
@@ -225,21 +224,21 @@ jack_nframes_t jack_thread_wait (jack_client_t*, int status) JACK_OPTIONAL_WEAK_


/** /**
* Wait until this JACK client should process data. * Wait until this JACK client should process data.
*
*
* @param client - pointer to a JACK client structure * @param client - pointer to a JACK client structure
* *
* @return the number of frames of data to process * @return the number of frames of data to process
*/ */
jack_nframes_t jack_cycle_wait (jack_client_t* client) JACK_OPTIONAL_WEAK_EXPORT; jack_nframes_t jack_cycle_wait (jack_client_t* client) JACK_OPTIONAL_WEAK_EXPORT;
/** /**
* Signal next clients in the graph. * Signal next clients in the graph.
*
*
* @param client - pointer to a JACK client structure * @param client - pointer to a JACK client structure
* @param status - if non-zero, calling thread should exit * @param status - if non-zero, calling thread should exit
*/ */
void jack_cycle_signal (jack_client_t* client, int status) JACK_OPTIONAL_WEAK_EXPORT; void jack_cycle_signal (jack_client_t* client, int status) JACK_OPTIONAL_WEAK_EXPORT;
/** /**
* Tell the Jack server to call @a thread_callback in the RT thread. * Tell the Jack server to call @a thread_callback in the RT thread.
* Typical use are in conjunction with @a jack_cycle_wait and @ jack_cycle_signal functions. * Typical use are in conjunction with @a jack_cycle_wait and @ jack_cycle_signal functions.
@@ -247,10 +246,10 @@ void jack_cycle_signal (jack_client_t* client, int status) JACK_OPTIONAL_WEAK_EX
* execution. That means that it cannot call functions that might * execution. That means that it cannot call functions that might
* block for a long time. This includes all I/O functions (disk, TTY, network), * block for a long time. This includes all I/O functions (disk, TTY, network),
* malloc, free, printf, pthread_mutex_lock, sleep, wait, poll, select, pthread_join, * malloc, free, printf, pthread_mutex_lock, sleep, wait, poll, select, pthread_join,
* pthread_cond_wait, etc, etc.
* pthread_cond_wait, etc, etc.
* *
* @return 0 on success, otherwise a non-zero error code. * @return 0 on success, otherwise a non-zero error code.
*/
*/
int jack_set_process_thread(jack_client_t* client, JackThreadCallback fun, void *arg) JACK_OPTIONAL_WEAK_EXPORT; int jack_set_process_thread(jack_client_t* client, JackThreadCallback fun, void *arg) JACK_OPTIONAL_WEAK_EXPORT;


/*@}*/ /*@}*/
@@ -262,7 +261,7 @@ int jack_set_process_thread(jack_client_t* client, JackThreadCallback fun, void


/** /**
* Tell JACK to call @a thread_init_callback once just after * Tell JACK to call @a thread_init_callback once just after
* the creation of the thread in which all other callbacks
* the creation of the thread in which all other callbacks
* will be handled. * will be handled.
* *
* The code in the supplied function does not need to be * The code in the supplied function does not need to be
@@ -275,7 +274,7 @@ int jack_set_thread_init_callback (jack_client_t *client,
JackThreadInitCallback thread_init_callback, JackThreadInitCallback thread_init_callback,
void *arg) JACK_OPTIONAL_WEAK_EXPORT; void *arg) JACK_OPTIONAL_WEAK_EXPORT;


/**
/**
* @param client pointer to JACK client structure. * @param client pointer to JACK client structure.
* @param function The jack_shutdown function pointer. * @param function The jack_shutdown function pointer.
* @param arg The arguments for the jack_shutdown function. * @param arg The arguments for the jack_shutdown function.
@@ -292,9 +291,9 @@ int jack_set_thread_init_callback (jack_client_t *client,
* NOTE: clients do not need to call this. It exists only * NOTE: clients do not need to call this. It exists only
* to help more complex clients understand what is going * to help more complex clients understand what is going
* on. It should be called before jack_client_activate(). * on. It should be called before jack_client_activate().
*
*
* NOTE: if a client calls this AND jack_on_info_shutdown(), then * NOTE: if a client calls this AND jack_on_info_shutdown(), then
* the event of a client thread shutdown, the callback
* the event of a client thread shutdown, the callback
* passed to this function will not be called, and the one passed to * passed to this function will not be called, and the one passed to
* jack_on_info_shutdown() will. * jack_on_info_shutdown() will.
*/ */
@@ -320,7 +319,7 @@ void jack_on_shutdown (jack_client_t *client,
* on. It should be called before jack_client_activate(). * on. It should be called before jack_client_activate().
* *
* NOTE: if a client calls this AND jack_on_shutdown(), then in the * NOTE: if a client calls this AND jack_on_shutdown(), then in the
* event of a client thread shutdown, the callback passed to
* event of a client thread shutdown, the callback passed to
* this function will be called, and the one passed to * this function will be called, and the one passed to
* jack_on_shutdown() will not. * jack_on_shutdown() will not.
*/ */
@@ -335,7 +334,7 @@ void jack_on_info_shutdown (jack_client_t *client,
* execution. That means that it cannot call functions that might * execution. That means that it cannot call functions that might
* block for a long time. This includes all I/O functions (disk, TTY, network), * block for a long time. This includes all I/O functions (disk, TTY, network),
* malloc, free, printf, pthread_mutex_lock, sleep, wait, poll, select, pthread_join, * malloc, free, printf, pthread_mutex_lock, sleep, wait, poll, select, pthread_join,
* pthread_cond_wait, etc, etc.
* pthread_cond_wait, etc, etc.
* *
* @return 0 on success, otherwise a non-zero error code, causing JACK * @return 0 on success, otherwise a non-zero error code, causing JACK
* to remove that client from the process() graph. * to remove that client from the process() graph.
@@ -392,7 +391,7 @@ int jack_set_sample_rate_callback (jack_client_t *client,
int jack_set_client_registration_callback (jack_client_t *, int jack_set_client_registration_callback (jack_client_t *,
JackClientRegistrationCallback JackClientRegistrationCallback
registration_callback, void *arg) JACK_OPTIONAL_WEAK_EXPORT; registration_callback, void *arg) JACK_OPTIONAL_WEAK_EXPORT;
/** /**
* Tell the JACK server to call @a registration_callback whenever a * Tell the JACK server to call @a registration_callback whenever a
* port is registered or unregistered, passing @a arg as a parameter. * port is registered or unregistered, passing @a arg as a parameter.
@@ -462,37 +461,37 @@ int jack_set_xrun_callback (jack_client_t *,
* - have only output ports * - have only output ports
* - their output is totally unrelated to their input * - their output is totally unrelated to their input
* - their output is not delayed relative to their input * - their output is not delayed relative to their input
* (i.e. data that arrives in a given process()
* (i.e. data that arrives in a given process()
* callback is processed and output again in the * callback is processed and output again in the
* same callback) * same callback)
* *
* Clients NOT registering a latency callback MUST also * Clients NOT registering a latency callback MUST also
* satisfy this condition: * satisfy this condition:
*
*
* - have no multiple distinct internal signal pathways * - have no multiple distinct internal signal pathways
*
*
* This means that if your client has more than 1 input and * This means that if your client has more than 1 input and
* output port, and considers them always "correlated" * output port, and considers them always "correlated"
* (e.g. as a stereo pair), then there is only 1 (e.g. stereo) * (e.g. as a stereo pair), then there is only 1 (e.g. stereo)
* signal pathway through the client. This would be true, * signal pathway through the client. This would be true,
* for example, of a stereo FX rack client that has a * for example, of a stereo FX rack client that has a
* left/right input pair and a left/right output pair. * left/right input pair and a left/right output pair.
*
*
* However, this is somewhat a matter of perspective. The * However, this is somewhat a matter of perspective. The
* same FX rack client could be connected so that its
* same FX rack client could be connected so that its
* two input ports were connected to entirely separate * two input ports were connected to entirely separate
* sources. Under these conditions, the fact that the client * sources. Under these conditions, the fact that the client
* does not register a latency callback MAY result * does not register a latency callback MAY result
* in port latency values being incorrect.
* in port latency values being incorrect.
* *
* Clients that do not meet any of those conditions SHOULD * Clients that do not meet any of those conditions SHOULD
* register a latency callback.
* register a latency callback.
* *
* Another case is when a client wants to use * Another case is when a client wants to use
* @ref jack_port_get_latency_range(), which only returns meaninful * @ref jack_port_get_latency_range(), which only returns meaninful
* values when ports get connected and latency values change. * values when ports get connected and latency values change.
* *
* See the documentation for @ref jack_port_set_latency_range()
* See the documentation for @ref jack_port_set_latency_range()
* on how the callback should operate. Remember that the @a mode * on how the callback should operate. Remember that the @a mode
* argument given to the latency callback will need to be * argument given to the latency callback will need to be
* passed into @ref jack_port_set_latency_range() * passed into @ref jack_port_set_latency_range()
@@ -514,19 +513,19 @@ int jack_set_latency_callback (jack_client_t *,
* *
* When in "freewheel" mode, JACK no longer waits for * When in "freewheel" mode, JACK no longer waits for
* any external event to begin the start of the next process * any external event to begin the start of the next process
* cycle.
* cycle.
* *
* As a result, freewheel mode causes "faster than realtime" * As a result, freewheel mode causes "faster than realtime"
* execution of a JACK graph. If possessed, real-time * execution of a JACK graph. If possessed, real-time
* scheduling is dropped when entering freewheel mode, and * scheduling is dropped when entering freewheel mode, and
* if appropriate it is reacquired when stopping. * if appropriate it is reacquired when stopping.
*
*
* IMPORTANT: on systems using capabilities to provide real-time * IMPORTANT: on systems using capabilities to provide real-time
* scheduling (i.e. Linux kernel 2.4), if onoff is zero, this function * scheduling (i.e. Linux kernel 2.4), if onoff is zero, this function
* must be called from the thread that originally called jack_activate().
* This restriction does not apply to other systems (e.g. Linux kernel 2.6
* must be called from the thread that originally called jack_activate().
* This restriction does not apply to other systems (e.g. Linux kernel 2.6
* or OS X). * or OS X).
*
*
* @param client pointer to JACK client structure * @param client pointer to JACK client structure
* @param onoff if non-zero, freewheel mode starts. Otherwise * @param onoff if non-zero, freewheel mode starts. Otherwise
* freewheel mode ends. * freewheel mode ends.
@@ -588,7 +587,7 @@ int jack_engine_takeover_timebase (jack_client_t *) JACK_OPTIONAL_WEAK_DEPRECAT
* determined by the buffer size and sample rate. * determined by the buffer size and sample rate.
*/ */
float jack_cpu_load (jack_client_t *client) JACK_OPTIONAL_WEAK_EXPORT; float jack_cpu_load (jack_client_t *client) JACK_OPTIONAL_WEAK_EXPORT;


/*@}*/ /*@}*/


@@ -608,8 +607,8 @@ float jack_cpu_load (jack_client_t *client) JACK_OPTIONAL_WEAK_EXPORT;
* name. Exceeding that will cause the port registration to fail and * name. Exceeding that will cause the port registration to fail and
* return NULL. * return NULL.
* *
* The @a port_name must be unique among all ports owned by this client.
* If the name is not unique, the registration will fail.
* The @a port_name must be unique among all ports owned by this client.
* If the name is not unique, the registration will fail.
* *
* All ports have a type, which may be any non-NULL and non-zero * All ports have a type, which may be any non-NULL and non-zero
* length string, passed as an argument. Some port types are built * length string, passed as an argument. Some port types are built
@@ -632,7 +631,7 @@ jack_port_t *jack_port_register (jack_client_t *client,
unsigned long flags, unsigned long flags,
unsigned long buffer_size) JACK_OPTIONAL_WEAK_EXPORT; unsigned long buffer_size) JACK_OPTIONAL_WEAK_EXPORT;


/**
/**
* Remove the port from the client, disconnecting any existing * Remove the port from the client, disconnecting any existing
* connections. * connections.
* *
@@ -646,7 +645,7 @@ int jack_port_unregister (jack_client_t *, jack_port_t *) JACK_OPTIONAL_WEAK_EXP
* that can be written to; for an input port, it will be an area * that can be written to; for an input port, it will be an area
* containing the data from the port's connection(s), or * containing the data from the port's connection(s), or
* zero-filled. if there are multiple inbound connections, the data * zero-filled. if there are multiple inbound connections, the data
* will be mixed appropriately.
* will be mixed appropriately.
* *
* Do not cache the returned address across process() callbacks. * Do not cache the returned address across process() callbacks.
* Port buffers have to be retrieved in each callback for proper functionning. * Port buffers have to be retrieved in each callback for proper functionning.
@@ -687,12 +686,12 @@ int jack_port_flags (const jack_port_t *port) JACK_OPTIONAL_WEAK_EXPORT;
*/ */
const char *jack_port_type (const jack_port_t *port) JACK_OPTIONAL_WEAK_EXPORT; const char *jack_port_type (const jack_port_t *port) JACK_OPTIONAL_WEAK_EXPORT;


/**
/**
* @return TRUE if the jack_port_t belongs to the jack_client_t. * @return TRUE if the jack_port_t belongs to the jack_client_t.
*/ */
int jack_port_is_mine (const jack_client_t *, const jack_port_t *port) JACK_OPTIONAL_WEAK_EXPORT; int jack_port_is_mine (const jack_client_t *, const jack_port_t *port) JACK_OPTIONAL_WEAK_EXPORT;


/**
/**
* @return number of connections to or from @a port. * @return number of connections to or from @a port.
* *
* @pre The calling client must own @a port. * @pre The calling client must own @a port.
@@ -718,7 +717,7 @@ int jack_port_connected_to (const jack_port_t *port,
* @param port locally owned jack_port_t pointer. * @param port locally owned jack_port_t pointer.
* *
* @see jack_port_name_size(), jack_port_get_all_connections() * @see jack_port_name_size(), jack_port_get_all_connections()
*/
*/
const char **jack_port_get_connections (const jack_port_t *port) JACK_OPTIONAL_WEAK_EXPORT; const char **jack_port_get_connections (const jack_port_t *port) JACK_OPTIONAL_WEAK_EXPORT;


/** /**
@@ -736,17 +735,17 @@ const char **jack_port_get_connections (const jack_port_t *port) JACK_OPTIONAL_W
* you cannot use it in a GraphReordered handler. * you cannot use it in a GraphReordered handler.
* *
* 2) You need not be the owner of the port to get information * 2) You need not be the owner of the port to get information
* about its connections.
* about its connections.
* *
* @see jack_port_name_size() * @see jack_port_name_size()
*/
*/
const char **jack_port_get_all_connections (const jack_client_t *client, const char **jack_port_get_all_connections (const jack_client_t *client,
const jack_port_t *port) JACK_OPTIONAL_WEAK_EXPORT; const jack_port_t *port) JACK_OPTIONAL_WEAK_EXPORT;


/** /**
* *
* @deprecated This function will be removed from a future version
* of JACK. Do not use it. There is no replacement. It has
* @deprecated This function will be removed from a future version
* of JACK. Do not use it. There is no replacement. It has
* turned out to serve essentially no purpose in real-life * turned out to serve essentially no purpose in real-life
* JACK clients. * JACK clients.
*/ */
@@ -754,8 +753,8 @@ int jack_port_tie (jack_port_t *src, jack_port_t *dst) JACK_OPTIONAL_WEAK_DEPRE


/** /**
* *
* @deprecated This function will be removed from a future version
* of JACK. Do not use it. There is no replacement. It has
* @deprecated This function will be removed from a future version
* of JACK. Do not use it. There is no replacement. It has
* turned out to serve essentially no purpose in real-life * turned out to serve essentially no purpose in real-life
* JACK clients. * JACK clients.
*/ */
@@ -771,26 +770,26 @@ int jack_port_untie (jack_port_t *port) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT;
int jack_port_set_name (jack_port_t *port, const char *port_name) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT; int jack_port_set_name (jack_port_t *port, const char *port_name) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT;


/** /**
* Modify a port's short name. May NOT be called from a callback handling a server event.
* Modify a port's short name. May NOT be called from a callback handling a server event.
* If the resulting full name (including the @a "client_name:" prefix) is * If the resulting full name (including the @a "client_name:" prefix) is
* longer than jack_port_name_size(), it will be truncated. * longer than jack_port_name_size(), it will be truncated.
* *
* @return 0 on success, otherwise a non-zero error code. * @return 0 on success, otherwise a non-zero error code.
* *
* This differs from jack_port_set_name() by triggering PortRename notifications to
* This differs from jack_port_set_name() by triggering PortRename notifications to
* clients that have registered a port rename handler. * clients that have registered a port rename handler.
*/ */
int jack_port_rename (jack_client_t* client, jack_port_t *port, const char *port_name) JACK_OPTIONAL_WEAK_EXPORT; int jack_port_rename (jack_client_t* client, jack_port_t *port, const char *port_name) JACK_OPTIONAL_WEAK_EXPORT;
/** /**
* Set @a alias as an alias for @a port. May be called at any time. * Set @a alias as an alias for @a port. May be called at any time.
* If the alias is longer than jack_port_name_size(), it will be truncated. * If the alias is longer than jack_port_name_size(), it will be truncated.
*
*
* After a successful call, and until JACK exits or * After a successful call, and until JACK exits or
* jack_port_unset_alias() is called, may be * jack_port_unset_alias() is called, may be
* used as a alternate name for the port. * used as a alternate name for the port.
* *
* Ports can have up to two aliases - if both are already
* Ports can have up to two aliases - if both are already
* set, this function will return an error. * set, this function will return an error.
* *
* @return 0 on success, otherwise a non-zero error code. * @return 0 on success, otherwise a non-zero error code.
@@ -799,8 +798,8 @@ int jack_port_set_alias (jack_port_t *port, const char *alias) JACK_OPTIONAL_WEA


/** /**
* Remove @a alias as an alias for @a port. May be called at any time. * Remove @a alias as an alias for @a port. May be called at any time.
*
* After a successful call, @a alias can no longer be
*
* After a successful call, @a alias can no longer be
* used as a alternate name for the port. * used as a alternate name for the port.
* *
* @return 0 on success, otherwise a non-zero error code. * @return 0 on success, otherwise a non-zero error code.
@@ -808,7 +807,7 @@ int jack_port_set_alias (jack_port_t *port, const char *alias) JACK_OPTIONAL_WEA
int jack_port_unset_alias (jack_port_t *port, const char *alias) JACK_OPTIONAL_WEAK_EXPORT; int jack_port_unset_alias (jack_port_t *port, const char *alias) JACK_OPTIONAL_WEAK_EXPORT;


/* /*
* Get any aliases known for @port.
* Get any aliases known for `port`.
* *
* @return the number of aliases discovered for the port * @return the number of aliases discovered for the port
*/ */
@@ -924,7 +923,7 @@ size_t jack_port_type_get_buffer_size (jack_client_t *client, const char *port_t
* *
* The purpose of JACK's latency API is to allow clients to * The purpose of JACK's latency API is to allow clients to
* easily answer two questions: * easily answer two questions:
*
*
* - How long has it been since the data read from a port arrived * - How long has it been since the data read from a port arrived
* at the edge of the JACK graph (either via a physical port * at the edge of the JACK graph (either via a physical port
* or being synthesized from scratch)? * or being synthesized from scratch)?
@@ -932,9 +931,9 @@ size_t jack_port_type_get_buffer_size (jack_client_t *client, const char *port_t
* - How long will it be before the data written to a port arrives * - How long will it be before the data written to a port arrives
* at the edge of a JACK graph? * at the edge of a JACK graph?


* To help answering these two questions, all JACK ports have two
* To help answering these two questions, all JACK ports have two
* latency values associated with them, both measured in frames: * latency values associated with them, both measured in frames:
*
*
* <b>capture latency</b>: how long since the data read from * <b>capture latency</b>: how long since the data read from
* the buffer of a port arrived at at * the buffer of a port arrived at at
* a port marked with JackPortIsTerminal. * a port marked with JackPortIsTerminal.
@@ -943,15 +942,15 @@ size_t jack_port_type_get_buffer_size (jack_client_t *client, const char *port_t
* marked with JackPortIsPhysical, or * marked with JackPortIsPhysical, or
* will have been synthesized by the client * will have been synthesized by the client
* that owns the terminal port. * that owns the terminal port.
*
*
* <b>playback latency</b>: how long until the data * <b>playback latency</b>: how long until the data
* written to the buffer of port will reach a port * written to the buffer of port will reach a port
* marked with JackPortIsTerminal. * marked with JackPortIsTerminal.
*
*
* Both latencies might potentially have more than one value * Both latencies might potentially have more than one value
* because there may be multiple pathways to/from a given port * because there may be multiple pathways to/from a given port
* and a terminal port. Latency is therefore generally * and a terminal port. Latency is therefore generally
* expressed a min/max pair.
* expressed a min/max pair.
* *
* In most common setups, the minimum and maximum latency * In most common setups, the minimum and maximum latency
* are the same, but this design accomodates more complex * are the same, but this design accomodates more complex
@@ -963,7 +962,7 @@ size_t jack_port_type_get_buffer_size (jack_client_t *client, const char *port_t
* *
* See also @ref jack_set_latency_callback for details on how * See also @ref jack_set_latency_callback for details on how
* clients that add latency to the signal path should interact * clients that add latency to the signal path should interact
* with JACK to ensure that the correct latency figures are
* with JACK to ensure that the correct latency figures are
* used. * used.
* @{ * @{
*/ */
@@ -976,7 +975,7 @@ size_t jack_port_type_get_buffer_size (jack_client_t *client, const char *port_t
* physical hardware controlled by the client. For example, * physical hardware controlled by the client. For example,
* for a client controlling a digital audio interface connected * for a client controlling a digital audio interface connected
* to an external digital converter, the latency setting should * to an external digital converter, the latency setting should
* include both buffering by the audio interface *and* the converter.
* include both buffering by the audio interface *and* the converter.
* *
* @deprecated This method will be removed in the next major * @deprecated This method will be removed in the next major
* release of JACK. It should not be used in new code, and should * release of JACK. It should not be used in new code, and should
@@ -984,11 +983,11 @@ size_t jack_port_type_get_buffer_size (jack_client_t *client, const char *port_t
* jack_port_set_latency_range(). * jack_port_set_latency_range().
*/ */
void jack_port_set_latency (jack_port_t *, jack_nframes_t) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT; void jack_port_set_latency (jack_port_t *, jack_nframes_t) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT;
/** /**
* return the latency range defined by @a mode for
* return the latency range defined by @a mode for
* @a port, in frames. * @a port, in frames.
*
*
* See @ref LatencyFunctions for the definition of each latency value. * See @ref LatencyFunctions for the definition of each latency value.
* *
* This function is best used from callbacks, specifically the latency callback. * This function is best used from callbacks, specifically the latency callback.
@@ -1000,9 +999,9 @@ void jack_port_set_latency (jack_port_t *, jack_nframes_t) JACK_OPTIONAL_WEAK_DE
void jack_port_get_latency_range (jack_port_t *port, jack_latency_callback_mode_t mode, jack_latency_range_t *range) JACK_WEAK_EXPORT; void jack_port_get_latency_range (jack_port_t *port, jack_latency_callback_mode_t mode, jack_latency_range_t *range) JACK_WEAK_EXPORT;


/** /**
* set the minimum and maximum latencies defined by
* set the minimum and maximum latencies defined by
* @a mode for @a port, in frames. * @a mode for @a port, in frames.
*
*
* See @ref LatencyFunctions for the definition of each latency value. * See @ref LatencyFunctions for the definition of each latency value.
* *
* This function should ONLY be used inside a latency * This function should ONLY be used inside a latency
@@ -1010,8 +1009,8 @@ void jack_port_get_latency_range (jack_port_t *port, jack_latency_callback_mode_
* value of the latency using @ref jack_port_get_latency_range() * value of the latency using @ref jack_port_get_latency_range()
* (called using the same mode as @a mode) * (called using the same mode as @a mode)
* and then add some number of frames to that reflects * and then add some number of frames to that reflects
* latency added by the client.
*
* latency added by the client.
*
* How much latency a client adds will vary * How much latency a client adds will vary
* dramatically. For most clients, the answer is zero * dramatically. For most clients, the answer is zero
* and there is no reason for them to register a latency * and there is no reason for them to register a latency
@@ -1024,7 +1023,7 @@ void jack_port_get_latency_range (jack_port_t *port, jack_latency_callback_mode_
* generally know a single constant value to add * generally know a single constant value to add
* to the value returned by @ref jack_port_get_latency_range(). * to the value returned by @ref jack_port_get_latency_range().
* *
* Such clients would register a latency callback (see
* Such clients would register a latency callback (see
* @ref jack_set_latency_callback) and must know what input * @ref jack_set_latency_callback) and must know what input
* ports feed which output ports as part of their * ports feed which output ports as part of their
* internal state. Their latency callback will update * internal state. Their latency callback will update
@@ -1032,9 +1031,9 @@ void jack_port_get_latency_range (jack_port_t *port, jack_latency_callback_mode_
* *
* A pseudo-code example will help. The @a mode argument to the latency * A pseudo-code example will help. The @a mode argument to the latency
* callback will determine whether playback or capture * callback will determine whether playback or capture
* latency is being set. The callback will use
* latency is being set. The callback will use
* @ref jack_port_set_latency_range() as follows: * @ref jack_port_set_latency_range() as follows:
*
*
* \code * \code
* jack_latency_range_t range; * jack_latency_range_t range;
* if (mode == JackPlaybackLatency) { * if (mode == JackPlaybackLatency) {
@@ -1045,7 +1044,7 @@ void jack_port_get_latency_range (jack_port_t *port, jack_latency_callback_mode_
* jack_port_set_latency_range (input_port, JackPlaybackLatency, &range); * jack_port_set_latency_range (input_port, JackPlaybackLatency, &range);
* } * }
* } else if (mode == JackCaptureLatency) { * } else if (mode == JackCaptureLatency) {
* foreach output_port in (all self-registered port) {
* foreach output_port in (all self-registered port) {
* jack_port_get_latency_range (port_fed_by_output_port, JackCaptureLatency, &range); * jack_port_get_latency_range (port_fed_by_output_port, JackCaptureLatency, &range);
* range.min += min_delay_added_as_signal_flows_from_output_port_to_fed_by_port; * range.min += min_delay_added_as_signal_flows_from_output_port_to_fed_by_port;
* range.max += max_delay_added_as_signal_flows_from_output_port_to_fed_by_port; * range.max += max_delay_added_as_signal_flows_from_output_port_to_fed_by_port;
@@ -1058,12 +1057,12 @@ void jack_port_get_latency_range (jack_port_t *port, jack_latency_callback_mode_
* each input port or output is connected to only 1 output or input * each input port or output is connected to only 1 output or input
* port respectively. * port respectively.
* *
* If a port is connected to more than 1 other port, then the
* If a port is connected to more than 1 other port, then the
* range.min and range.max values passed to @ref * range.min and range.max values passed to @ref
* jack_port_set_latency_range() should reflect the minimum and * jack_port_set_latency_range() should reflect the minimum and
* maximum values across all connected ports. * maximum values across all connected ports.
* *
* See the description of @ref jack_set_latency_callback for more
* See the description of @ref jack_set_latency_callback for more
* information. * information.
*/ */
void jack_port_set_latency_range (jack_port_t *port, jack_latency_callback_mode_t mode, jack_latency_range_t *range) JACK_WEAK_EXPORT; void jack_port_set_latency_range (jack_port_t *port, jack_latency_callback_mode_t mode, jack_latency_range_t *range) JACK_WEAK_EXPORT;
@@ -1074,16 +1073,16 @@ void jack_port_set_latency_range (jack_port_t *port, jack_latency_callback_mode_
* latency of its port using jack_port_set_latency * latency of its port using jack_port_set_latency
* and wants to ensure that all signal pathways in the graph * and wants to ensure that all signal pathways in the graph
* are updated with respect to the values that will be returned * are updated with respect to the values that will be returned
* by jack_port_get_total_latency. It allows a client
* to change multiple port latencies without triggering a
* by jack_port_get_total_latency. It allows a client
* to change multiple port latencies without triggering a
* recompute for each change. * recompute for each change.
*
*
* @return zero for successful execution of the request. non-zero * @return zero for successful execution of the request. non-zero
* otherwise. * otherwise.
*/ */
int jack_recompute_total_latencies (jack_client_t*) JACK_OPTIONAL_WEAK_EXPORT; int jack_recompute_total_latencies (jack_client_t*) JACK_OPTIONAL_WEAK_EXPORT;


/**
/**
* @return the time (in frames) between data being available or * @return the time (in frames) between data being available or
* delivered at/to a port, and the time at which it arrived at or is * delivered at/to a port, and the time at which it arrived at or is
* delivered to the "other side" of the port. E.g. for a physical * delivered to the "other side" of the port. E.g. for a physical
@@ -1095,7 +1094,7 @@ int jack_recompute_total_latencies (jack_client_t*) JACK_OPTIONAL_WEAK_EXPORT;
* *
* @deprecated This method will be removed in the next major * @deprecated This method will be removed in the next major
* release of JACK. It should not be used in new code, and should * release of JACK. It should not be used in new code, and should
* be replaced by jack_port_get_latency_range() in any existing
* be replaced by jack_port_get_latency_range() in any existing
* use cases. * use cases.
*/ */
jack_nframes_t jack_port_get_latency (jack_port_t *port) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT; jack_nframes_t jack_port_get_latency (jack_port_t *port) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT;
@@ -1107,7 +1106,7 @@ jack_nframes_t jack_port_get_latency (jack_port_t *port) JACK_OPTIONAL_WEAK_DEPR
* *
* @deprecated This method will be removed in the next major * @deprecated This method will be removed in the next major
* release of JACK. It should not be used in new code, and should * release of JACK. It should not be used in new code, and should
* be replaced by jack_port_get_latency_range() in any existing
* be replaced by jack_port_get_latency_range() in any existing
* use cases. * use cases.
*/ */
jack_nframes_t jack_port_get_total_latency (jack_client_t *, jack_nframes_t jack_port_get_total_latency (jack_client_t *,
@@ -1119,8 +1118,8 @@ jack_nframes_t jack_port_get_total_latency (jack_client_t *,
* latency of its port using jack_port_set_latency * latency of its port using jack_port_set_latency
* and wants to ensure that all signal pathways in the graph * and wants to ensure that all signal pathways in the graph
* are updated with respect to the values that will be returned * are updated with respect to the values that will be returned
* by jack_port_get_total_latency.
*
* by jack_port_get_total_latency.
*
* @return zero for successful execution of the request. non-zero * @return zero for successful execution of the request. non-zero
* otherwise. * otherwise.
* *
@@ -1139,13 +1138,13 @@ int jack_recompute_total_latency (jack_client_t*, jack_port_t* port) JACK_OPTION
*/ */


/** /**
* @param port_name_pattern A regular expression used to select
* ports by name. If NULL or of zero length, no selection based
* @param port_name_pattern A regular expression used to select
* ports by name. If NULL or of zero length, no selection based
* on name will be carried out. * on name will be carried out.
* @param type_name_pattern A regular expression used to select
* ports by type. If NULL or of zero length, no selection based
* @param type_name_pattern A regular expression used to select
* ports by type. If NULL or of zero length, no selection based
* on type will be carried out. * on type will be carried out.
* @param flags A value used to select ports by their flags.
* @param flags A value used to select ports by their flags.
* If zero, no selection based on flags will be carried out. * If zero, no selection based on flags will be carried out.
* *
* @return a NULL-terminated array of ports that match the specified * @return a NULL-terminated array of ports that match the specified
@@ -1154,9 +1153,9 @@ int jack_recompute_total_latency (jack_client_t*, jack_port_t* port) JACK_OPTION
* *
* @see jack_port_name_size(), jack_port_type_size() * @see jack_port_name_size(), jack_port_type_size()
*/ */
const char **jack_get_ports (jack_client_t *,
const char *port_name_pattern,
const char *type_name_pattern,
const char **jack_get_ports (jack_client_t *,
const char *port_name_pattern,
const char *type_name_pattern,
unsigned long flags) JACK_OPTIONAL_WEAK_EXPORT; unsigned long flags) JACK_OPTIONAL_WEAK_EXPORT;


/** /**
@@ -1203,7 +1202,7 @@ jack_nframes_t jack_frame_time (const jack_client_t *) JACK_OPTIONAL_WEAK_EXPORT
* This function may only be used from the process callback, and can * This function may only be used from the process callback, and can
* be used to interpret timestamps generated by jack_frame_time() in * be used to interpret timestamps generated by jack_frame_time() in
* other threads with respect to the current process cycle. * other threads with respect to the current process cycle.
*
*
* This is the only jack time function that returns exact time: * This is the only jack time function that returns exact time:
* when used during the process callback it always returns the same * when used during the process callback it always returns the same
* value (until the next process callback, where it will return * value (until the next process callback, where it will return
@@ -1236,14 +1235,14 @@ jack_nframes_t jack_last_frame_time (const jack_client_t *client) JACK_OPTIONAL_
* microseconds. * microseconds.
* *
* NOTES: * NOTES:
*
*
* Because of the types used, all the returned values except period_usecs * Because of the types used, all the returned values except period_usecs
* are unsigned. In computations mapping between frames and microseconds * are unsigned. In computations mapping between frames and microseconds
* *signed* differences are required. The easiest way is to compute those * *signed* differences are required. The easiest way is to compute those
* separately and assign them to the appropriate signed variables, * separately and assign them to the appropriate signed variables,
* int32_t for frames and int64_t for usecs. See the implementation of * int32_t for frames and int64_t for usecs. See the implementation of
* jack_frames_to_time() and Jack_time_to_frames() for an example. * jack_frames_to_time() and Jack_time_to_frames() for an example.
*
*
* Unless there was an xrun, skipped cycles, or the current cycle is the * Unless there was an xrun, skipped cycles, or the current cycle is the
* first after freewheeling or starting Jack, the value of current_usecs * first after freewheeling or starting Jack, the value of current_usecs
* will always be the value of next_usecs of the previous cycle. * will always be the value of next_usecs of the previous cycle.
@@ -1275,8 +1274,8 @@ jack_nframes_t jack_time_to_frames(const jack_client_t *client, jack_time_t) JAC


/** /**
* @return return JACK's current system time in microseconds, * @return return JACK's current system time in microseconds,
* using the JACK clock source.
*
* using the JACK clock source.
*
* The value returned is guaranteed to be monotonic, but not linear. * The value returned is guaranteed to be monotonic, but not linear.
*/ */
jack_time_t jack_get_time(void) JACK_OPTIONAL_WEAK_EXPORT; jack_time_t jack_get_time(void) JACK_OPTIONAL_WEAK_EXPORT;
@@ -1323,7 +1322,7 @@ void jack_set_info_function (void (*func)(const char *)) JACK_OPTIONAL_WEAK_EXPO
/*@}*/ /*@}*/


/** /**
* The free function to be used on memory returned by jack_port_get_connections,
* The free function to be used on memory returned by jack_port_get_connections,
* jack_port_get_all_connections and jack_get_ports functions. * jack_port_get_all_connections and jack_get_ports functions.
* This is MANDATORY on Windows when otherwise all nasty runtime version related crashes can occur. * This is MANDATORY on Windows when otherwise all nasty runtime version related crashes can occur.
* Developers are strongly encouraged to use this function instead of the standard "free" function in new code. * Developers are strongly encouraged to use this function instead of the standard "free" function in new code.
@@ -1335,4 +1334,4 @@ void jack_free(void* ptr) JACK_OPTIONAL_WEAK_EXPORT;
} }
#endif #endif


#endif /* __jack_h__ */
#endif /* JACK_JACK_H */

+ 30
- 31
jslist.h View File

@@ -1,6 +1,6 @@
/* /*
Based on gslist.c from glib-1.2.9 (LGPL). Based on gslist.c from glib-1.2.9 (LGPL).
Adaption to JACK, Copyright (C) 2002 Kai Vehmanen. Adaption to JACK, Copyright (C) 2002 Kai Vehmanen.
- replaced use of gtypes with normal ANSI C types - replaced use of gtypes with normal ANSI C types
- glib's memery allocation routines replaced with - glib's memery allocation routines replaced with
@@ -10,20 +10,19 @@
it under the terms of the GNU Lesser General Public License as published by it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version. (at your option) any later version.
This program is distributed in the hope that it will be useful, This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details. GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License You should have received a copy of the GNU Lesser General Public License
along with this program; if not, write to the Free Software
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.

*/ */


#ifndef __jack_jslist_h__
#define __jack_jslist_h__
#ifndef JACK_JSLIST_H
#define JACK_JSLIST_H


#include <stdlib.h> #include <stdlib.h>


@@ -50,7 +49,7 @@ jack_slist_alloc (void)
return new_list; return new_list;
} }


static __inline__
static __inline__
JSList* JSList*
jack_slist_prepend (JSList *list, jack_slist_prepend (JSList *list,
void *data) void *data)
@@ -65,7 +64,7 @@ jack_slist_prepend (JSList *list,
} }


#define jack_slist_next(slist) ((slist) ? (((JSList *)(slist))->next) : NULL) #define jack_slist_next(slist) ((slist) ? (((JSList *)(slist))->next) : NULL)
static __inline__
static __inline__
JSList* JSList*
jack_slist_last (JSList *list) jack_slist_last (JSList *list)
{ {
@@ -78,7 +77,7 @@ jack_slist_last (JSList *list)
return list; return list;
} }


static __inline__
static __inline__
JSList* JSList*
jack_slist_remove_link (JSList *list, jack_slist_remove_link (JSList *list,
JSList *link) JSList *link)
@@ -109,7 +108,7 @@ jack_slist_remove_link (JSList *list,
return list; return list;
} }


static __inline__
static __inline__
void void
jack_slist_free (JSList *list) jack_slist_free (JSList *list)
{ {
@@ -121,7 +120,7 @@ jack_slist_free (JSList *list)
} }
} }


static __inline__
static __inline__
void void
jack_slist_free_1 (JSList *list) jack_slist_free_1 (JSList *list)
{ {
@@ -131,7 +130,7 @@ jack_slist_free_1 (JSList *list)
} }
} }


static __inline__
static __inline__
JSList* JSList*
jack_slist_remove (JSList *list, jack_slist_remove (JSList *list,
void *data) void *data)
@@ -164,7 +163,7 @@ jack_slist_remove (JSList *list,
return list; return list;
} }


static __inline__
static __inline__
unsigned int unsigned int
jack_slist_length (JSList *list) jack_slist_length (JSList *list)
{ {
@@ -180,7 +179,7 @@ jack_slist_length (JSList *list)
return length; return length;
} }


static __inline__
static __inline__
JSList* JSList*
jack_slist_find (JSList *list, jack_slist_find (JSList *list,
void *data) void *data)
@@ -195,7 +194,7 @@ jack_slist_find (JSList *list,
return list; return list;
} }


static __inline__
static __inline__
JSList* JSList*
jack_slist_copy (JSList *list) jack_slist_copy (JSList *list)
{ {
@@ -221,7 +220,7 @@ jack_slist_copy (JSList *list)
return new_list; return new_list;
} }


static __inline__
static __inline__
JSList* JSList*
jack_slist_append (JSList *list, jack_slist_append (JSList *list,
void *data) void *data)
@@ -243,9 +242,9 @@ jack_slist_append (JSList *list,
return new_list; return new_list;
} }


static __inline__
JSList*
jack_slist_sort_merge (JSList *l1,
static __inline__
JSList*
jack_slist_sort_merge (JSList *l1,
JSList *l2, JSList *l2,
JCompareFunc compare_func) JCompareFunc compare_func)
{ {
@@ -259,40 +258,40 @@ jack_slist_sort_merge (JSList *l1,
{ {
l=l->next=l1; l=l->next=l1;
l1=l1->next; l1=l1->next;
}
else
}
else
{ {
l=l->next=l2; l=l->next=l2;
l2=l2->next; l2=l2->next;
} }
} }
l->next= l1 ? l1 : l2; l->next= l1 ? l1 : l2;
return list.next; return list.next;
} }


static __inline__
JSList*
static __inline__
JSList*
jack_slist_sort (JSList *list, jack_slist_sort (JSList *list,
JCompareFunc compare_func) JCompareFunc compare_func)
{ {
JSList *l1, *l2; JSList *l1, *l2;


if (!list)
if (!list)
return NULL; return NULL;
if (!list->next)
if (!list->next)
return list; return list;


l1 = list;
l1 = list;
l2 = list->next; l2 = list->next;


while ((l2 = l2->next) != NULL) while ((l2 = l2->next) != NULL)
{ {
if ((l2 = l2->next) == NULL)
if ((l2 = l2->next) == NULL)
break; break;
l1=l1->next; l1=l1->next;
} }
l2 = l1->next;
l2 = l1->next;
l1->next = NULL; l1->next = NULL;


return jack_slist_sort_merge (jack_slist_sort (list, compare_func), return jack_slist_sort_merge (jack_slist_sort (list, compare_func),
@@ -300,4 +299,4 @@ jack_slist_sort (JSList *list,
compare_func); compare_func);
} }


#endif /* __jack_jslist_h__ */
#endif /* JACK_JSLIST_H */

+ 22
- 22
metadata.h View File

@@ -1,20 +1,20 @@
/* /*
Copyright (C) 2011-2014 David Robillard
Copyright (C) 2013 Paul Davis
This program is free software; you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 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 Lesser General Public
License for more details.
You should have received a copy of the GNU Lesser 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.
Copyright (C) 2011-2014 David Robillard
Copyright (C) 2013 Paul Davis
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
You should have received a copy of the GNU Lesser 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.
*/ */


/** /**
@@ -24,8 +24,8 @@
* *
*/ */


#ifndef __jack_metadata_h__
#define __jack_metadata_h__
#ifndef JACK_METADATA_H
#define JACK_METADATA_H


#include <jack/types.h> #include <jack/types.h>


@@ -128,7 +128,7 @@ typedef struct {
* Free a description. * Free a description.
* *
* @param desc a jack_description_t whose associated memory will all be released * @param desc a jack_description_t whose associated memory will all be released
* @param free_description_itself if non-zero, then @param desc will also be passed to free()
* @param free_description_itself if non-zero, then `desc` will also be passed to free()
*/ */
void void
jack_free_description (jack_description_t* desc, int free_description_itself); jack_free_description (jack_description_t* desc, int free_description_itself);
@@ -212,12 +212,12 @@ typedef void (*JackPropertyChangeCallback)(jack_uuid_t subject,
void* arg); void* arg);


/** /**
* Arrange for @p client to call @p callback whenever a property is created,
* Arrange for `client` to call `callback` whenever a property is created,
* changed or deleted. * changed or deleted.
* *
* @param client the JACK client making the request * @param client the JACK client making the request
* @param callback the function to be invoked when a property change occurs * @param callback the function to be invoked when a property change occurs
* @param arg the argument to be passed to @param callback when it is invoked
* @param arg the argument to be passed to `callback` when it is invoked
* *
* @return 0 success, -1 otherwise. * @return 0 success, -1 otherwise.
*/ */
@@ -319,4 +319,4 @@ extern const char* JACK_METADATA_SIGNAL_TYPE;
} /* namespace */ } /* namespace */
#endif #endif


#endif /* __jack_metadata_h__ */
#endif /* JACK_METADATA_H */

+ 15
- 18
midiport.h View File

@@ -1,35 +1,33 @@
/* /*
Copyright (C) 2004 Ian Esten Copyright (C) 2004 Ian Esten
This program is free software; you can redistribute it and/or modify This program is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version. (at your option) any later version.
This program is distributed in the hope that it will be useful, This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details. GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License You should have received a copy of the GNU Lesser General Public License
along with this program; if not, write to the Free Software
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.

*/ */



#ifndef __JACK_MIDIPORT_H
#define __JACK_MIDIPORT_H
#ifndef JACK_MIDIPORT_H
#define JACK_MIDIPORT_H


#ifdef __cplusplus #ifdef __cplusplus
extern "C" { extern "C" {
#endif #endif
#include <jack/weakmacros.h> #include <jack/weakmacros.h>
#include <jack/types.h> #include <jack/types.h>
#include <stdlib.h> #include <stdlib.h>


/** Type for raw event data contained in @ref jack_midi_event_t. */ /** Type for raw event data contained in @ref jack_midi_event_t. */
typedef unsigned char jack_midi_data_t; typedef unsigned char jack_midi_data_t;


@@ -44,7 +42,7 @@ typedef struct _jack_midi_event




/** /**
* @defgroup MIDIAPI Reading and writing MIDI data
* @defgroup MIDIAPI Reading and writing MIDI data
* @{ * @{
*/ */


@@ -58,7 +56,7 @@ jack_midi_get_event_count(void* port_buffer) JACK_OPTIONAL_WEAK_EXPORT;




/** Get a MIDI event from an event port buffer. /** Get a MIDI event from an event port buffer.
*
*
* Jack MIDI is normalised, the MIDI event returned by this function is * Jack MIDI is normalised, the MIDI event returned by this function is
* guaranteed to be a complete MIDI event (the status byte will always be * guaranteed to be a complete MIDI event (the status byte will always be
* present, and no realtime events will interspered with the event). * present, and no realtime events will interspered with the event).
@@ -75,7 +73,7 @@ jack_midi_event_get(jack_midi_event_t *event,




/** Clear an event buffer. /** Clear an event buffer.
*
*
* This should be called at the beginning of each process cycle before calling * This should be called at the beginning of each process cycle before calling
* @ref jack_midi_event_reserve or @ref jack_midi_event_write. This * @ref jack_midi_event_reserve or @ref jack_midi_event_write. This
* function may not be called on an input port's buffer. * function may not be called on an input port's buffer.
@@ -107,7 +105,7 @@ jack_midi_max_event_size(void* port_buffer) JACK_OPTIONAL_WEAK_EXPORT;
* when they occur on their own, like other messages). * when they occur on their own, like other messages).
* *
* Events must be written in order, sorted by their sample offsets. * Events must be written in order, sorted by their sample offsets.
* JACK will not sort the events for you, and will refuse to store
* JACK will not sort the events for you, and will refuse to store
* out-of-order events. * out-of-order events.
* *
* @param port_buffer Buffer to write event to. * @param port_buffer Buffer to write event to.
@@ -118,7 +116,7 @@ jack_midi_max_event_size(void* port_buffer) JACK_OPTIONAL_WEAK_EXPORT;
*/ */
jack_midi_data_t* jack_midi_data_t*
jack_midi_event_reserve(void *port_buffer, jack_midi_event_reserve(void *port_buffer,
jack_nframes_t time,
jack_nframes_t time,
size_t data_size) JACK_OPTIONAL_WEAK_EXPORT; size_t data_size) JACK_OPTIONAL_WEAK_EXPORT;




@@ -134,7 +132,7 @@ jack_midi_event_reserve(void *port_buffer,
* when they occur on their own, like other messages). * when they occur on their own, like other messages).
* *
* Events must be written in order, sorted by their sample offsets. * Events must be written in order, sorted by their sample offsets.
* JACK will not sort the events for you, and will refuse to store
* JACK will not sort the events for you, and will refuse to store
* out-of-order events. * out-of-order events.
* *
* @param port_buffer Buffer to write event to. * @param port_buffer Buffer to write event to.
@@ -168,7 +166,6 @@ jack_midi_get_lost_event_count(void *port_buffer) JACK_OPTIONAL_WEAK_E
} }
#endif #endif



#endif /* __JACK_MIDIPORT_H */
#endif /* JACK_MIDIPORT_H */





+ 10
- 11
ringbuffer.h View File

@@ -1,25 +1,24 @@
/* /*
Copyright (C) 2000 Paul Davis Copyright (C) 2000 Paul Davis
Copyright (C) 2003 Rohan Drape Copyright (C) 2003 Rohan Drape
This program is free software; you can redistribute it and/or modify This program is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version. (at your option) any later version.
This program is distributed in the hope that it will be useful, This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details. GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License You should have received a copy of the GNU Lesser General Public License
along with this program; if not, write to the Free Software
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.

*/ */


#ifndef _RINGBUFFER_H
#define _RINGBUFFER_H
#ifndef JACK_RINGBUFFER_H
#define JACK_RINGBUFFER_H


#ifdef __cplusplus #ifdef __cplusplus
extern "C" { extern "C" {
@@ -41,11 +40,11 @@ extern "C" {
* identities cannot be interchanged. * identities cannot be interchanged.
*/ */


typedef struct
typedef struct
{ {
char *buf; char *buf;
size_t len; size_t len;
}
}
jack_ringbuffer_data_t ; jack_ringbuffer_data_t ;


typedef struct typedef struct
@@ -56,7 +55,7 @@ typedef struct
size_t size; size_t size;
size_t size_mask; size_t size_mask;
int mlocked; int mlocked;
}
}
jack_ringbuffer_t ; jack_ringbuffer_t ;


/** /**
@@ -232,4 +231,4 @@ size_t jack_ringbuffer_write_space(const jack_ringbuffer_t *rb);
} }
#endif #endif


#endif
#endif /* JACK_RINGBUFFER_H */

+ 4
- 3
session.h View File

@@ -18,8 +18,8 @@
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*/ */


#ifndef __jack_session_h__
#define __jack_session_h__
#ifndef JACK_SESSION_H
#define JACK_SESSION_H


#ifdef __cplusplus #ifdef __cplusplus
extern "C" { extern "C" {
@@ -299,4 +299,5 @@ jack_client_has_session_callback (jack_client_t *client, const char *client_name
#ifdef __cplusplus #ifdef __cplusplus
} }
#endif #endif
#endif

#endif /* JACK_SESSION_H */

+ 19
- 21
statistics.h View File

@@ -1,25 +1,23 @@
/* /*
* Copyright (C) 2004 Rui Nuno Capela, Lee Revell
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public License
* as published by the Free Software Foundation; either version 2.1
* 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser 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.
*
*/
Copyright (C) 2004 Rui Nuno Capela, Lee Revell

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.

You should have received a copy of the GNU Lesser 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.
*/


#ifndef __statistics_h__
#define __statistics_h__
#ifndef JACK_STATISTICS_H
#define JACK_STATISTICS_H


#ifdef __cplusplus #ifdef __cplusplus
extern "C" { extern "C" {
@@ -53,4 +51,4 @@ void jack_reset_max_delayed_usecs (jack_client_t *client);
} }
#endif #endif


#endif /* __statistics_h__ */
#endif /* JACK_STATISTICS_H */

+ 17
- 18
systemdeps.h View File

@@ -1,24 +1,23 @@
/* /*
Copyright (C) 2004-2012 Grame
Copyright (C) 2004-2012 Grame


This program is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 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., 675 Mass Ave, Cambridge, MA 02139, USA.
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 Lesser General Public License for more details.


You should have received a copy of the GNU Lesser 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.
*/ */


#ifndef __jack_systemdeps_h__
#define __jack_systemdeps_h__
#ifndef JACK_SYSTEMDEPS_H
#define JACK_SYSTEMDEPS_H


#ifndef POST_PACKED_STRUCTURE #ifndef POST_PACKED_STRUCTURE


@@ -26,7 +25,7 @@ Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
/* POST_PACKED_STRUCTURE needs to be a macro which /* POST_PACKED_STRUCTURE needs to be a macro which
expands into a compiler directive. The directive must expands into a compiler directive. The directive must
tell the compiler to arrange the preceding structure tell the compiler to arrange the preceding structure
declaration so that it is packed on byte-boundaries rather
declaration so that it is packed on byte-boundaries rather
than use the natural alignment of the processor and/or than use the natural alignment of the processor and/or
compiler. compiler.
*/ */
@@ -35,7 +34,7 @@ Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
#define POST_PACKED_STRUCTURE __attribute__((__packed__)) #define POST_PACKED_STRUCTURE __attribute__((__packed__))


#else #else
#ifdef _MSC_VER #ifdef _MSC_VER
#define PRE_PACKED_STRUCTURE1 __pragma(pack(push,1)) #define PRE_PACKED_STRUCTURE1 __pragma(pack(push,1))
#define PRE_PACKED_STRUCTURE PRE_PACKED_STRUCTURE1 #define PRE_PACKED_STRUCTURE PRE_PACKED_STRUCTURE1
@@ -138,4 +137,4 @@ Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
#define JACK_LIB_EXPORT #define JACK_LIB_EXPORT
#endif #endif


#endif /* __jack_systemdeps_h__ */
#endif /* JACK_SYSTEMDEPS_H */

+ 9
- 10
thread.h View File

@@ -14,11 +14,10 @@
You should have received a copy of the GNU Lesser General Public License You should have received a copy of the GNU Lesser General Public License
along with this program; if not, write to the Free Software along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.

*/ */


#ifndef __jack_thread_h__
#define __jack_thread_h__
#ifndef JACK_THREAD_H
#define JACK_THREAD_H


#ifdef __cplusplus #ifdef __cplusplus
extern "C" { extern "C" {
@@ -29,10 +28,10 @@ extern "C" {
#include <jack/weakmacros.h> #include <jack/weakmacros.h>
#include <jack/types.h> #include <jack/types.h>


/* use 512KB stack per thread - the default is way too high to be feasible
/* use 512KB stack per thread - the default is way too high to be feasible
* with mlockall() on many systems */ * with mlockall() on many systems */
#define THREAD_STACK 524288 #define THREAD_STACK 524288
/** @file thread.h /** @file thread.h
* *
* Library functions to standardize thread creation for JACK and its * Library functions to standardize thread creation for JACK and its
@@ -47,7 +46,7 @@ extern "C" {


/** /**
* @returns if JACK is running with realtime scheduling, this returns * @returns if JACK is running with realtime scheduling, this returns
* the priority that any JACK-created client threads will run at.
* the priority that any JACK-created client threads will run at.
* Otherwise returns -1. * Otherwise returns -1.
*/ */


@@ -115,16 +114,16 @@ typedef int (*jack_thread_creator_t)(jack_native_thread_t*,
* are created by something other than pthread_create(). After * are created by something other than pthread_create(). After
* it is used, any threads that JACK needs for the client will * it is used, any threads that JACK needs for the client will
* will be created by calling the function passed to this * will be created by calling the function passed to this
* function.
* function.
* *
* No normal application/client should consider calling this. * No normal application/client should consider calling this.
* The specific case for which it was created involves running * The specific case for which it was created involves running
* win32/x86 plugins under Wine on Linux, where it is necessary * win32/x86 plugins under Wine on Linux, where it is necessary
* that all threads that might call win32 functions are known * that all threads that might call win32 functions are known
* to Wine. * to Wine.
*
*
* @param creator a function that creates a new thread * @param creator a function that creates a new thread
*
*
*/ */
void jack_set_thread_creator (jack_thread_creator_t creator) JACK_OPTIONAL_WEAK_EXPORT; void jack_set_thread_creator (jack_thread_creator_t creator) JACK_OPTIONAL_WEAK_EXPORT;


@@ -134,4 +133,4 @@ void jack_set_thread_creator (jack_thread_creator_t creator) JACK_OPTIONAL_WEAK_
} }
#endif #endif


#endif /* __jack_thread_h__ */
#endif /* JACK_THREAD_H */

+ 57
- 58
transport.h View File

@@ -1,25 +1,24 @@
/* /*
Copyright (C) 2002 Paul Davis Copyright (C) 2002 Paul Davis
Copyright (C) 2003 Jack O'Quin Copyright (C) 2003 Jack O'Quin
This program is free software; you can redistribute it and/or modify This program is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version. (at your option) any later version.
This program is distributed in the hope that it will be useful, This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details. GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License You should have received a copy of the GNU Lesser General Public License
along with this program; if not, write to the Free Software
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.

*/ */


#ifndef __jack_transport_h__
#define __jack_transport_h__
#ifndef JACK_TRANSPORT_H
#define JACK_TRANSPORT_H


#ifdef __cplusplus #ifdef __cplusplus
extern "C" { extern "C" {
@@ -66,94 +65,94 @@ typedef enum {
* Struct for transport position information. * Struct for transport position information.
*/ */
typedef struct { typedef struct {
/*@{*/ /*@{*/
/** @name Server-set fields /** @name Server-set fields
* these cannot be set from clients; the server sets them */ * these cannot be set from clients; the server sets them */
jack_unique_t unique_1; /**< unique ID */ jack_unique_t unique_1; /**< unique ID */
jack_time_t usecs; /**< microsecond timestamp that is guaranteed to be
monotonic, but not neccessarily
linear.
jack_time_t usecs; /**< microsecond timestamp that is guaranteed to be
monotonic, but not neccessarily
linear.


The absolute value is
The absolute value is
implementation-dependent (i.e. it implementation-dependent (i.e. it
could be wall-clock, time since
could be wall-clock, time since
jack started, uptime, etc). */ jack started, uptime, etc). */
jack_nframes_t frame_rate; /**< current frame rate, in frames per second */ jack_nframes_t frame_rate; /**< current frame rate, in frames per second */
/*}@*/ /*}@*/


/*@{*/ /*@{*/
/** @name Mandatory fields
/** @name Mandatory fields
*/ */
jack_nframes_t frame; /**< frame number, always present/required.
This is the frame number on the
transport timeline, which is not
the same as what @ref
jack_nframes_t frame; /**< frame number, always present/required.
This is the frame number on the
transport timeline, which is not
the same as what @ref
jack_frame_time returns. */ jack_frame_time returns. */
jack_position_bits_t valid; /**< which other fields are valid, as a jack_position_bits_t valid; /**< which other fields are valid, as a
bitmask constructed from values in
bitmask constructed from values in
\ref jack_position_bits_t */ \ref jack_position_bits_t */
/*}@*/ /*}@*/


/*@{*/ /*@{*/
/** @name JackPositionBBT fields
* Bar:Beat.Tick-related information.
/** @name JackPositionBBT fields
* Bar:Beat.Tick-related information.
* *
* Applications that support
* Applications that support
* JackPositionBBT are encouraged to also fill the JackBBTFrameOffset * JackPositionBBT are encouraged to also fill the JackBBTFrameOffset
*/ */
int32_t bar; /**< current bar
int32_t bar; /**< current bar


Should be >0: the first bar is
Should be >0: the first bar is
bar '1'. */ bar '1'. */
int32_t beat; /**< current beat-within-bar
int32_t beat; /**< current beat-within-bar


Should be >0 and <=beats_per_bar: Should be >0 and <=beats_per_bar:
the first beat is beat '1'. the first beat is beat '1'.
*/ */
int32_t tick; /**< current tick-within-beat
int32_t tick; /**< current tick-within-beat


Should be >= 0 and < ticks_per_beat: Should be >= 0 and < ticks_per_beat:
the first tick is tick '0'. */ the first tick is tick '0'. */
double bar_start_tick; /**< number of ticks that have elapsed
double bar_start_tick; /**< number of ticks that have elapsed
between frame 0 and the first beat between frame 0 and the first beat
of the current measure. */ of the current measure. */


float beats_per_bar; /**< time signature "numerator" */ float beats_per_bar; /**< time signature "numerator" */
float beat_type; /**< time signature "denominator" */ float beat_type; /**< time signature "denominator" */
double ticks_per_beat; /**< number of ticks within a beat.
double ticks_per_beat; /**< number of ticks within a beat.


Usually a moderately large integer Usually a moderately large integer
with many denominators, such as
with many denominators, such as
1920.0 */ 1920.0 */
double beats_per_minute; /**< BPM, quantized to block size. This double beats_per_minute; /**< BPM, quantized to block size. This
means when the tempo is not constant means when the tempo is not constant
within this block, the BPM value should within this block, the BPM value should
adapted to compensate for this. This adapted to compensate for this. This
is different from most fields in this is different from most fields in this
struct, which specify the value at
the beginning of the block rather
struct, which specify the value at
the beginning of the block rather
than an average.*/ than an average.*/
/*}@*/ /*}@*/


/*@{*/ /*@{*/
/** @name JackPositionTimecode fields
/** @name JackPositionTimecode fields
* EXPERIMENTAL: could change */ * EXPERIMENTAL: could change */
double frame_time; /**< current time in seconds */ double frame_time; /**< current time in seconds */
double next_time; /**< next sequential frame_time double next_time; /**< next sequential frame_time
(unless repositioned) */ (unless repositioned) */
/*}@*/ /*}@*/
/*@{*/ /*@{*/
/* JackBBTFrameOffset fields */ /* JackBBTFrameOffset fields */
jack_nframes_t bbt_offset; /**< frame offset for the BBT fields jack_nframes_t bbt_offset; /**< frame offset for the BBT fields
(the given bar, beat, and tick (the given bar, beat, and tick
values actually refer to a time values actually refer to a time
frame_offset frames before the frame_offset frames before the
start of the cycle), should
be assumed to be 0 if
JackBBTFrameOffset is not
start of the cycle), should
be assumed to be 0 if
JackBBTFrameOffset is not
set. If JackBBTFrameOffset is set. If JackBBTFrameOffset is
set and this value is zero, the BBT set and this value is zero, the BBT
time refers to the first frame of this time refers to the first frame of this
@@ -227,11 +226,11 @@ typedef struct {
int jack_release_timebase (jack_client_t *client) JACK_OPTIONAL_WEAK_EXPORT; int jack_release_timebase (jack_client_t *client) JACK_OPTIONAL_WEAK_EXPORT;


/** /**
* Prototype for the @a sync_callback defined by @ref slowsyncclients
* "slow-sync clients". When the client is active, this callback is
* invoked just before process() in the same thread. This occurs once
* after registration, then subsequently whenever some client requests
* a new position, or the transport enters the ::JackTransportStarting
* Prototype for the @a sync_callback defined by @ref slowsyncclients
* "slow-sync clients". When the client is active, this callback is
* invoked just before process() in the same thread. This occurs once
* after registration, then subsequently whenever some client requests
* a new position, or the transport enters the ::JackTransportStarting
* state. This realtime function must not wait. * state. This realtime function must not wait.
* *
* The transport @a state will be: * The transport @a state will be:
@@ -246,7 +245,7 @@ int jack_release_timebase (jack_client_t *client) JACK_OPTIONAL_WEAK_EXPORT;
* @param arg the argument supplied by jack_set_sync_callback(). * @param arg the argument supplied by jack_set_sync_callback().
* *
* @return TRUE (non-zero) when ready to roll. * @return TRUE (non-zero) when ready to roll.
*/
*/
typedef int (*JackSyncCallback)(jack_transport_state_t state, typedef int (*JackSyncCallback)(jack_transport_state_t state,
jack_position_t *pos, jack_position_t *pos,
void *arg); void *arg);
@@ -323,9 +322,9 @@ int jack_set_sync_timeout (jack_client_t *client,
* @param new_pos TRUE (non-zero) for a newly requested @a pos, or for * @param new_pos TRUE (non-zero) for a newly requested @a pos, or for
* the first cycle after the @a timebase_callback is defined. * the first cycle after the @a timebase_callback is defined.
* @param arg the argument supplied by jack_set_timebase_callback(). * @param arg the argument supplied by jack_set_timebase_callback().
*/
*/
typedef void (*JackTimebaseCallback)(jack_transport_state_t state, typedef void (*JackTimebaseCallback)(jack_transport_state_t state,
jack_nframes_t nframes,
jack_nframes_t nframes,
jack_position_t *pos, jack_position_t *pos,
int new_pos, int new_pos,
void *arg); void *arg);
@@ -366,13 +365,13 @@ int jack_set_timebase_callback (jack_client_t *client,
* Reposition the transport to a new frame number. * Reposition the transport to a new frame number.
* *
* May be called at any time by any client. The new position takes * May be called at any time by any client. The new position takes
* effect in two process cycles. If there are @ref slowsyncclients
* "slow-sync clients" and the transport is already rolling, it will
* effect in two process cycles. If there are @ref slowsyncclients
* "slow-sync clients" and the transport is already rolling, it will
* enter the ::JackTransportStarting state and begin invoking their @a * enter the ::JackTransportStarting state and begin invoking their @a
* sync_callbacks until ready. This function is realtime-safe. * sync_callbacks until ready. This function is realtime-safe.
* *
* @see jack_transport_reposition, jack_set_sync_callback * @see jack_transport_reposition, jack_set_sync_callback
*
*
* @param client the JACK client structure. * @param client the JACK client structure.
* @param frame frame number of new transport position. * @param frame frame number of new transport position.
* *
@@ -407,20 +406,20 @@ jack_transport_state_t jack_transport_query (const jack_client_t *client,
* @param client the JACK client structure * @param client the JACK client structure
*/ */
jack_nframes_t jack_get_current_transport_frame (const jack_client_t *client) JACK_OPTIONAL_WEAK_EXPORT; jack_nframes_t jack_get_current_transport_frame (const jack_client_t *client) JACK_OPTIONAL_WEAK_EXPORT;
/** /**
* Request a new transport position. * Request a new transport position.
* *
* May be called at any time by any client. The new position takes * May be called at any time by any client. The new position takes
* effect in two process cycles. If there are @ref slowsyncclients
* "slow-sync clients" and the transport is already rolling, it will
* effect in two process cycles. If there are @ref slowsyncclients
* "slow-sync clients" and the transport is already rolling, it will
* enter the ::JackTransportStarting state and begin invoking their @a * enter the ::JackTransportStarting state and begin invoking their @a
* sync_callbacks until ready. This function is realtime-safe. * sync_callbacks until ready. This function is realtime-safe.
* *
* @see jack_transport_locate, jack_set_sync_callback * @see jack_transport_locate, jack_set_sync_callback
*
*
* @param client the JACK client structure. * @param client the JACK client structure.
* @param pos requested new transport position. Fill pos->valid to specify
* @param pos requested new transport position. Fill pos->valid to specify
* which fields should be taken into account. If you mark a set of fields * which fields should be taken into account. If you mark a set of fields
* as valid, you are expected to fill them all. * as valid, you are expected to fill them all.
* *
@@ -481,14 +480,14 @@ typedef enum {
* interface. Use the jack_position_t struct, instead. * interface. Use the jack_position_t struct, instead.
*/ */
typedef struct { typedef struct {
/* these two cannot be set from clients: the server sets them */ /* these two cannot be set from clients: the server sets them */


jack_nframes_t frame_rate; /**< current frame rate (per second) */ jack_nframes_t frame_rate; /**< current frame rate (per second) */
jack_time_t usecs; /**< monotonic, free-rolling */ jack_time_t usecs; /**< monotonic, free-rolling */


jack_transport_bits_t valid; /**< which fields are legal to read */ jack_transport_bits_t valid; /**< which fields are legal to read */
jack_transport_state_t transport_state;
jack_transport_state_t transport_state;
jack_nframes_t frame; jack_nframes_t frame;
jack_nframes_t loop_start; jack_nframes_t loop_start;
jack_nframes_t loop_end; jack_nframes_t loop_end;
@@ -499,7 +498,7 @@ typedef struct {
int bar; int bar;
int beat; int beat;
int tick; int tick;
double bar_start_tick;
double bar_start_tick;


float beats_per_bar; float beats_per_bar;
float beat_type; float beat_type;
@@ -507,7 +506,7 @@ typedef struct {
double beats_per_minute; double beats_per_minute;


} jack_transport_info_t; } jack_transport_info_t;
/** /**
* Gets the current transport info structure (deprecated). * Gets the current transport info structure (deprecated).
* *
@@ -537,4 +536,4 @@ void jack_set_transport_info (jack_client_t *client,
} }
#endif #endif


#endif /* __jack_transport_h__ */
#endif /* JACK_TRANSPORT_H */

+ 40
- 41
types.h View File

@@ -1,25 +1,24 @@
/* /*
Copyright (C) 2001 Paul Davis Copyright (C) 2001 Paul Davis
Copyright (C) 2004 Jack O'Quin Copyright (C) 2004 Jack O'Quin
This program is free software; you can redistribute it and/or modify This program is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version. (at your option) any later version.
This program is distributed in the hope that it will be useful, This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details. GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License You should have received a copy of the GNU Lesser General Public License
along with this program; if not, write to the Free Software
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.

*/ */


#ifndef __jack_types_h__
#define __jack_types_h__
#ifndef JACK_TYPES_H
#define JACK_TYPES_H


#include <inttypes.h> #include <inttypes.h>
#include <pthread.h> #include <pthread.h>
@@ -268,12 +267,12 @@ enum JackLatencyCallbackMode {
typedef enum JackLatencyCallbackMode jack_latency_callback_mode_t; typedef enum JackLatencyCallbackMode jack_latency_callback_mode_t;


/** /**
* Prototype for the client supplied function that is called
* Prototype for the client supplied function that is called
* by the engine when port latencies need to be recalculated * by the engine when port latencies need to be recalculated
* *
* @param mode playback or capture latency * @param mode playback or capture latency
* @param arg pointer to a client supplied data * @param arg pointer to a client supplied data
*/
*/
typedef void (*JackLatencyCallback)(jack_latency_callback_mode_t mode, void *arg); typedef void (*JackLatencyCallback)(jack_latency_callback_mode_t mode, void *arg);


/** /**
@@ -294,7 +293,7 @@ struct _jack_latency_range
typedef struct _jack_latency_range jack_latency_range_t; typedef struct _jack_latency_range jack_latency_range_t;


/** /**
* Prototype for the client supplied function that is called
* Prototype for the client supplied function that is called
* by the engine anytime there is work to be done. * by the engine anytime there is work to be done.
* *
* @pre nframes == jack_get_buffer_size() * @pre nframes == jack_get_buffer_size()
@@ -304,11 +303,11 @@ typedef struct _jack_latency_range jack_latency_range_t;
* @param arg pointer to a client supplied data * @param arg pointer to a client supplied data
* *
* @return zero on success, non-zero on error * @return zero on success, non-zero on error
*/
*/
typedef int (*JackProcessCallback)(jack_nframes_t nframes, void *arg); typedef int (*JackProcessCallback)(jack_nframes_t nframes, void *arg);


/** /**
* Prototype for the client supplied function that is called
* Prototype for the client supplied function that is called
* once after the creation of the thread in which other * once after the creation of the thread in which other
* callbacks will be made. Special thread characteristics * callbacks will be made. Special thread characteristics
* can be set from this callback, for example. This is a * can be set from this callback, for example. This is a
@@ -318,17 +317,17 @@ typedef int (*JackProcessCallback)(jack_nframes_t nframes, void *arg);
* @param arg pointer to a client supplied structure * @param arg pointer to a client supplied structure
* *
* @return void * @return void
*/
*/
typedef void (*JackThreadInitCallback)(void *arg); typedef void (*JackThreadInitCallback)(void *arg);


/** /**
* Prototype for the client supplied function that is called
* Prototype for the client supplied function that is called
* whenever the processing graph is reordered. * whenever the processing graph is reordered.
* *
* @param arg pointer to a client supplied data * @param arg pointer to a client supplied data
* *
* @return zero on success, non-zero on error * @return zero on success, non-zero on error
*/
*/
typedef int (*JackGraphOrderCallback)(void *arg); typedef int (*JackGraphOrderCallback)(void *arg);


/** /**
@@ -340,7 +339,7 @@ typedef int (*JackGraphOrderCallback)(void *arg);
* @param arg pointer to a client supplied data * @param arg pointer to a client supplied data
* *
* @return zero on success, non-zero on error * @return zero on success, non-zero on error
*/
*/
typedef int (*JackXRunCallback)(void *arg); typedef int (*JackXRunCallback)(void *arg);


/** /**
@@ -356,55 +355,55 @@ typedef int (*JackXRunCallback)(void *arg);
* @param arg pointer supplied by jack_set_buffer_size_callback(). * @param arg pointer supplied by jack_set_buffer_size_callback().
* *
* @return zero on success, non-zero on error * @return zero on success, non-zero on error
*/
*/
typedef int (*JackBufferSizeCallback)(jack_nframes_t nframes, void *arg); typedef int (*JackBufferSizeCallback)(jack_nframes_t nframes, void *arg);


/** /**
* Prototype for the client supplied function that is called
* Prototype for the client supplied function that is called
* when the engine sample rate changes. * when the engine sample rate changes.
* *
* @param nframes new engine sample rate * @param nframes new engine sample rate
* @param arg pointer to a client supplied data * @param arg pointer to a client supplied data
* *
* @return zero on success, non-zero on error * @return zero on success, non-zero on error
*/
*/
typedef int (*JackSampleRateCallback)(jack_nframes_t nframes, void *arg); typedef int (*JackSampleRateCallback)(jack_nframes_t nframes, void *arg);


/** /**
* Prototype for the client supplied function that is called
* Prototype for the client supplied function that is called
* whenever a port is registered or unregistered. * whenever a port is registered or unregistered.
* *
* @param port the ID of the port
* @param port the ID of the port
* @param arg pointer to a client supplied data * @param arg pointer to a client supplied data
* @param register non-zero if the port is being registered,
* zero if the port is being unregistered
*/
typedef void (*JackPortRegistrationCallback)(jack_port_id_t port, int /* register */, void *arg);
* @param registered non-zero if the port is being registered,
* zero if the port is being unregistered
*/
typedef void (*JackPortRegistrationCallback)(jack_port_id_t port, int registered, void *arg);


/** /**
* Prototype for the client supplied function that is called
* Prototype for the client supplied function that is called
* whenever a port is renamed * whenever a port is renamed
* *
* @param port the ID of the port
* @param port the ID of the port
* @param arg pointer to a client supplied data * @param arg pointer to a client supplied data
* @param old_name the name of the port before the rename was carried out * @param old_name the name of the port before the rename was carried out
* @param new_name the name of the port after the rename was carried out * @param new_name the name of the port after the rename was carried out
*/
*/
typedef void (*JackPortRenameCallback)(jack_port_id_t port, const char* old_name, const char* new_name, void* arg); typedef void (*JackPortRenameCallback)(jack_port_id_t port, const char* old_name, const char* new_name, void* arg);


/** /**
* Prototype for the client supplied function that is called
* Prototype for the client supplied function that is called
* whenever a client is registered or unregistered. * whenever a client is registered or unregistered.
* *
* @param name a null-terminated string containing the client name
* @param register non-zero if the client is being registered,
* zero if the client is being unregistered
* @param name a null-terminated string containing the client name
* @param registered non-zero if the client is being registered,
* zero if the client is being unregistered
* @param arg pointer to a client supplied data * @param arg pointer to a client supplied data
*/
typedef void (*JackClientRegistrationCallback)(const char* name, int /* register */, void *arg);
*/
typedef void (*JackClientRegistrationCallback)(const char* name, int registered, void *arg);


/** /**
* Prototype for the client supplied function that is called
* Prototype for the client supplied function that is called
* whenever ports are connected or disconnected. * whenever ports are connected or disconnected.
* *
* @param a one of two ports connected or disconnected * @param a one of two ports connected or disconnected
@@ -412,11 +411,11 @@ typedef void (*JackClientRegistrationCallback)(const char* name, int /* register
* @param connect non-zero if ports were connected * @param connect non-zero if ports were connected
* zero if ports were disconnected * zero if ports were disconnected
* @param arg pointer to a client supplied data * @param arg pointer to a client supplied data
*/
*/
typedef void (*JackPortConnectCallback)(jack_port_id_t a, jack_port_id_t b, int connect, void* arg); typedef void (*JackPortConnectCallback)(jack_port_id_t a, jack_port_id_t b, int connect, void* arg);


/** /**
* Prototype for the client supplied function that is called
* Prototype for the client supplied function that is called
* whenever jackd starts or stops freewheeling. * whenever jackd starts or stops freewheeling.
* *
* @param starting non-zero if we start starting to freewheel, zero otherwise * @param starting non-zero if we start starting to freewheel, zero otherwise
@@ -492,7 +491,7 @@ enum JackPortFlags {
* if JackPortIsPhysical is set, then the port corresponds * if JackPortIsPhysical is set, then the port corresponds
* to some kind of physical I/O connector. * to some kind of physical I/O connector.
*/ */
JackPortIsPhysical = 0x4,
JackPortIsPhysical = 0x4,


/** /**
* if JackPortCanMonitor is set, then a call to * if JackPortCanMonitor is set, then a call to
@@ -503,7 +502,7 @@ enum JackPortFlags {
* that data that would be available from an output port (with * that data that would be available from an output port (with
* JackPortIsPhysical set) is sent to a physical output connector * JackPortIsPhysical set) is sent to a physical output connector
* as well, so that it can be heard/seen/whatever. * as well, so that it can be heard/seen/whatever.
*
*
* Clients that do not control physical interfaces * Clients that do not control physical interfaces
* should never create ports with this bit set. * should never create ports with this bit set.
*/ */
@@ -524,7 +523,7 @@ enum JackPortFlags {
* their ports. * their ports.
*/ */
JackPortIsTerminal = 0x10 JackPortIsTerminal = 0x10
};
};




#endif /* __jack_types_h__ */
#endif /* JACK_TYPES_H */

+ 7
- 9
uuid.h View File

@@ -1,24 +1,23 @@
/* /*
Copyright (C) 2013 Paul Davis Copyright (C) 2013 Paul Davis
This program is free software; you can redistribute it and/or modify This program is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version. (at your option) any later version.
This program is distributed in the hope that it will be useful, This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details. GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License You should have received a copy of the GNU Lesser General Public License
along with this program; if not, write to the Free Software
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.

*/ */


#ifndef __jack_uuid_h__
#define __jack_uuid_h__
#ifndef JACK_UUID_H
#define JACK_UUID_H


#include <jack/types.h> #include <jack/types.h>


@@ -46,5 +45,4 @@ extern int jack_uuid_empty (jack_uuid_t);
} /* namespace */ } /* namespace */
#endif #endif


#endif /* __jack_uuid_h__ */

#endif /* JACK_UUID_H */

+ 16
- 17
weakjack.h View File

@@ -1,24 +1,23 @@
/* /*
Copyright (C) 2010 Paul Davis Copyright (C) 2010 Paul Davis
This program is free software; you can redistribute it and/or modify This program is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version. (at your option) any later version.
This program is distributed in the hope that it will be useful, This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details. GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License You should have received a copy of the GNU Lesser General Public License
along with this program; if not, write to the Free Software
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.

*/ */


#ifndef __weakjack_h__
#define __weakjack_h__
#ifndef JACK_WEAKJACK_H
#define JACK_WEAKJACK_H


/** /**
* @defgroup WeakLinkage managing support for newer/older versions of JACK * @defgroup WeakLinkage managing support for newer/older versions of JACK
@@ -44,19 +43,19 @@
* the framework, the code module can continue to run as * the framework, the code module can continue to run as
* long as it does not reference the symbol. However, if * long as it does not reference the symbol. However, if
* the symbol is present, the code can use it normally. * the symbol is present, the code can use it normally.
*
*
* (adapted from: http://developer.apple.com/library/mac/#documentation/MacOSX/Conceptual/BPFrameworks/Concepts/WeakLinking.html) * (adapted from: http://developer.apple.com/library/mac/#documentation/MacOSX/Conceptual/BPFrameworks/Concepts/WeakLinking.html)
* *
* A concrete example will help. Suppose that someone uses a version * A concrete example will help. Suppose that someone uses a version
* of a JACK client we'll call "Jill". Jill was linked against a version * of a JACK client we'll call "Jill". Jill was linked against a version
* of JACK that contains a newer part of the API (say, jack_set_latency_callback()) * of JACK that contains a newer part of the API (say, jack_set_latency_callback())
* and would like to use it if it is available. * and would like to use it if it is available.
*
*
* When Jill is run on a system that has a suitably "new" version of * When Jill is run on a system that has a suitably "new" version of
* JACK, this function will be available entirely normally. But if Jill * JACK, this function will be available entirely normally. But if Jill
* is run on a system with an old version of JACK, the function isn't * is run on a system with an old version of JACK, the function isn't
* available.
*
* available.
*
* With normal symbol linkage, this would create a startup error whenever * With normal symbol linkage, this would create a startup error whenever
* someone tries to run Jill with the "old" version of JACK. However, functions * someone tries to run Jill with the "old" version of JACK. However, functions
* added to JACK after version 0.116.2 are all declared to have "weak" linkage * added to JACK after version 0.116.2 are all declared to have "weak" linkage
@@ -76,13 +75,13 @@
* the JACK API that predate 0.116.2. For example, they might want to see if even * the JACK API that predate 0.116.2. For example, they might want to see if even
* really old basic parts of the API like jack_client_open() exist at runtime. * really old basic parts of the API like jack_client_open() exist at runtime.
* *
* Such clients should include <jack/weakjack.h> before any other JACK header.
* Such clients should include <jack/weakjack.h> before any other JACK header.
* This will make the \b entire JACK API be subject to weak linkage, so that any * This will make the \b entire JACK API be subject to weak linkage, so that any
* and all functions can be checked for existence at runtime. It is important * and all functions can be checked for existence at runtime. It is important
* to understand that very few clients need to do this - if you use this * to understand that very few clients need to do this - if you use this
* feature you should have a clear reason to do so. * feature you should have a clear reason to do so.
*
*
*
*
*/ */


#ifdef __APPLE__ #ifdef __APPLE__
@@ -93,8 +92,8 @@


#ifndef JACK_OPTIONAL_WEAK_EXPORT #ifndef JACK_OPTIONAL_WEAK_EXPORT
/* JACK_OPTIONAL_WEAK_EXPORT needs to be a macro which /* JACK_OPTIONAL_WEAK_EXPORT needs to be a macro which
expands into a compiler directive. If non-null, the directive
must tell the compiler to arrange for weak linkage of
expands into a compiler directive. If non-null, the directive
must tell the compiler to arrange for weak linkage of
the symbol it used with. For this to work fully may the symbol it used with. For this to work fully may
require linker arguments for the client as well. require linker arguments for the client as well.
*/ */
@@ -122,4 +121,4 @@


/*@}*/ /*@}*/


#endif /* weakjack */
#endif /* JACK_WEAKJACK_H */

+ 12
- 13
weakmacros.h View File

@@ -1,34 +1,33 @@
/* /*
Copyright (C) 2010 Paul Davis Copyright (C) 2010 Paul Davis
This program is free software; you can redistribute it and/or modify This program is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version. (at your option) any later version.
This program is distributed in the hope that it will be useful, This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details. GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License You should have received a copy of the GNU Lesser General Public License
along with this program; if not, write to the Free Software
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.

*/ */


#ifndef __weakmacros_h__
#define __weakmacros_h__
#ifndef JACK_WEAKMACROS_H
#define JACK_WEAKMACROS_H


/************************************************************* /*************************************************************
* NOTE: JACK_WEAK_EXPORT ***MUST*** be used on every function * NOTE: JACK_WEAK_EXPORT ***MUST*** be used on every function
* added to the JACK API after the 0.116.2 release. * added to the JACK API after the 0.116.2 release.
*
* Functions that predate this release are marked with
*
* Functions that predate this release are marked with
* JACK_WEAK_OPTIONAL_EXPORT which can be defined at compile * JACK_WEAK_OPTIONAL_EXPORT which can be defined at compile
* time in a variety of ways. The default definition is empty, * time in a variety of ways. The default definition is empty,
* so that these symbols get normal linkage. If you wish to * so that these symbols get normal linkage. If you wish to
* use all JACK symbols with weak linkage, include
* use all JACK symbols with weak linkage, include
* <jack/weakjack.h> before jack.h. * <jack/weakjack.h> before jack.h.
*************************************************************/ *************************************************************/


@@ -41,8 +40,8 @@
#ifndef JACK_WEAK_EXPORT #ifndef JACK_WEAK_EXPORT
#ifdef __GNUC__ #ifdef __GNUC__
/* JACK_WEAK_EXPORT needs to be a macro which /* JACK_WEAK_EXPORT needs to be a macro which
expands into a compiler directive. If non-null, the directive
must tell the compiler to arrange for weak linkage of
expands into a compiler directive. If non-null, the directive
must tell the compiler to arrange for weak linkage of
the symbol it used with. For this to work full may the symbol it used with. For this to work full may
require linker arguments in the client as well. require linker arguments in the client as well.
*/ */
@@ -64,4 +63,4 @@
#endif /* __GNUC__ */ #endif /* __GNUC__ */
#endif #endif


#endif /* __weakmacros_h__ */
#endif /* JACK_WEAKMACROS_H */

Write Preview
Loading…
Cancel
Save