From 36bdfb2c658d64d1694f80f08adb25acfd9a9abc Mon Sep 17 00:00:00 2001 From: Nedko Arnaudov Date: Tue, 7 Nov 2023 01:58:02 +0200 Subject: [PATCH] remove in-tree version of control.h System wide one is used instead --- common/jack/control.h | 658 ------------------------------------------ 1 file changed, 658 deletions(-) delete mode 100644 common/jack/control.h diff --git a/common/jack/control.h b/common/jack/control.h deleted file mode 100644 index d7a0728e..00000000 --- a/common/jack/control.h +++ /dev/null @@ -1,658 +0,0 @@ -/* -*- Mode: C ; c-basic-offset: 4 -*- */ -/* - JACK control API - - Copyright (C) 2008 Nedko Arnaudov - Copyright (C) 2008 GRAME - - This program is free software; you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation; version 2 of the License. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. - -*/ -/** - * @file jack/control.h - * @ingroup publicheader - * @brief JACK control API - * - */ - -#ifndef JACKCTL_H__2EEDAD78_DF4C_4B26_83B7_4FF1A446A47E__INCLUDED -#define JACKCTL_H__2EEDAD78_DF4C_4B26_83B7_4FF1A446A47E__INCLUDED - -#include -#include -#include -#if !defined(sun) && !defined(__sun__) -#include -#endif - -/** Parameter types, intentionally similar to jack_driver_param_type_t */ -typedef enum -{ - JackParamInt = 1, /**< @brief value type is a signed integer */ - JackParamUInt, /**< @brief value type is an unsigned integer */ - JackParamChar, /**< @brief value type is a char */ - JackParamString, /**< @brief value type is a string with max size of ::JACK_PARAM_STRING_MAX+1 chars */ - JackParamBool, /**< @brief value type is a boolean */ -} jackctl_param_type_t; - -/** Driver types */ -typedef enum -{ - JackMaster = 1, /**< @brief master driver */ - JackSlave /**< @brief slave driver */ -} jackctl_driver_type_t; - -/** @brief Max value that jackctl_param_type_t type can have */ -#define JACK_PARAM_MAX (JackParamBool + 1) - -/** @brief Max length of string parameter value, excluding terminating null char */ -#define JACK_PARAM_STRING_MAX 127 - -/** @brief Type for parameter value */ -/* intentionally similar to jack_driver_param_value_t */ -union jackctl_parameter_value -{ - uint32_t ui; /**< @brief member used for ::JackParamUInt */ - int32_t i; /**< @brief member used for ::JackParamInt */ - char c; /**< @brief member used for ::JackParamChar */ - char str[JACK_PARAM_STRING_MAX + 1]; /**< @brief member used for ::JackParamString */ - bool b; /**< @brief member used for ::JackParamBool */ -}; - -/** opaque type for server object */ -typedef struct jackctl_server jackctl_server_t; - -/** opaque type for driver object */ -typedef struct jackctl_driver jackctl_driver_t; - -/** opaque type for internal client object */ -typedef struct jackctl_internal jackctl_internal_t; - -/** opaque type for parameter object */ -typedef struct jackctl_parameter jackctl_parameter_t; - -/** opaque type for sigmask object */ -typedef struct jackctl_sigmask jackctl_sigmask_t; - -#ifdef __cplusplus -extern "C" { -#endif -#if 0 -} /* Adjust editor indent */ -#endif - -/** - * @defgroup ControlAPI The API for starting and controlling a JACK server - * @{ - */ - -/** - * Call this function to setup process signal handling. As a general - * rule, it is required for proper operation for the server object. - * - * @param flags signals setup flags, use 0 for none. Currently no - * flags are defined - * - * @return the configurated signal set. - */ -jackctl_sigmask_t * -jackctl_setup_signals( - unsigned int flags); - -/** - * Call this function to wait on a signal set. - * - * @param signals signals set to wait on - */ -void -jackctl_wait_signals( - jackctl_sigmask_t * signals); - -/** - * \bold THIS FUNCTION IS DEPRECATED AND SHOULD NOT BE USED IN - * NEW JACK PROJECTS - * - * @deprecated Please use jackctl_server_create2(). - */ -jackctl_server_t * -jackctl_server_create( - bool (* on_device_acquire)(const char * device_name), - void (* on_device_release)(const char * device_name)); - -/** - * Call this function to create server object. - * - * @param on_device_acquire - Optional callback to be called before device is acquired. If false is returned, device usage will fail - * @param on_device_release - Optional callback to be called after device is released. - * @param on_device_reservation_loop - Optional callback to be called when looping/idling the reservation. - * - * @return server object handle, NULL if creation of server object - * failed. Successfully created server object must be destroyed with - * paired call to ::jackctl_server_destroy - */ -jackctl_server_t * -jackctl_server_create2( - bool (* on_device_acquire)(const char * device_name), - void (* on_device_release)(const char * device_name), - void (* on_device_reservation_loop)(void)); - -/** - * Call this function to destroy server object. - * - * @param server server object handle to destroy - */ -void -jackctl_server_destroy( - jackctl_server_t * server); - -/** - * Call this function to open JACK server - * - * @param server server object handle - * @param driver driver to use - * - * @return success status: true - success, false - fail - */ -bool -jackctl_server_open( - jackctl_server_t * server, - jackctl_driver_t * driver); - -/** - * Call this function to start JACK server - * - * @param server server object handle - * - * @return success status: true - success, false - fail - */ -bool -jackctl_server_start( - jackctl_server_t * server); - -/** - * Call this function to stop JACK server - * - * @param server server object handle - * - * @return success status: true - success, false - fail - */ -bool -jackctl_server_stop( - jackctl_server_t * server); - -/** - * Call this function to close JACK server - * - * @param server server object handle - * - * @return success status: true - success, false - fail - */ -bool -jackctl_server_close( - jackctl_server_t * server); - -/** - * Call this function to get list of available drivers. List node data - * pointers is a driver object handle (::jackctl_driver_t). - * - * @param server server object handle to get drivers for - * - * @return Single linked list of driver object handles. Must not be - * modified. Always same for same server object. - */ -const JSList * -jackctl_server_get_drivers_list( - jackctl_server_t * server); - -/** - * Call this function to get list of server parameters. List node data - * pointers is a parameter object handle (::jackctl_parameter_t). - * - * @param server server object handle to get parameters for - * - * @return Single linked list of parameter object handles. Must not be - * modified. Always same for same server object. - */ -const JSList * -jackctl_server_get_parameters( - jackctl_server_t * server); - -/** - * Call this function to get list of available internal clients. List node data - * pointers is a internal client object handle (::jackctl_internal_t). - * - * @param server server object handle to get internal clients for - * - * @return Single linked list of internal client object handles. Must not be - * modified. Always same for same server object. - */ -const JSList * -jackctl_server_get_internals_list( - jackctl_server_t * server); - -/** - * Call this function to load one internal client. - * (can be used when the server is running) - * - * @param server server object handle - * @param internal internal to use - * - * @return success status: true - success, false - fail - */ -bool -jackctl_server_load_internal( - jackctl_server_t * server, - jackctl_internal_t * internal); - -/** - * Call this function to unload one internal client. - * (can be used when the server is running) - * - * @param server server object handle - * @param internal internal to unload - * - * @return success status: true - success, false - fail - */ -bool -jackctl_server_unload_internal( - jackctl_server_t * server, - jackctl_internal_t * internal); - -/** - * Call this function to load a session file. - * (can be used when the server is running) - * - * @param server server object handle - * @param file the session file to load, containing a list of - * internal clients and connections to be made. - * - * @return success status: true - success, false - fail - */ -bool jackctl_server_load_session_file( - jackctl_server_t * server_ptr, - const char * file); - -/** - * Call this function to add a slave in the driver slave list. - * (cannot be used when the server is running that is between - * jackctl_server_start and jackctl_server_stop) - * - * @param server server object handle - * @param driver driver to add in the driver slave list. - * - * @return success status: true - success, false - fail - */ -bool -jackctl_server_add_slave(jackctl_server_t * server, - jackctl_driver_t * driver); - -/** - * Call this function to remove a slave from the driver slave list. - * (cannot be used when the server is running that is between - * jackctl_server_start and jackctl_server_stop) - * - * @param server server object handle - * @param driver driver to remove from the driver slave list. - * - * @return success status: true - success, false - fail - */ -bool -jackctl_server_remove_slave(jackctl_server_t * server, - jackctl_driver_t * driver); - -/** - * Call this function to switch master driver. - * - * @param server server object handle - * @param driver driver to switch to - * - * @return success status: true - success, false - fail - */ -bool -jackctl_server_switch_master(jackctl_server_t * server, - jackctl_driver_t * driver); - - -/** - * Call this function to get name of driver. - * - * @param driver driver object handle to get name of - * - * @return driver name. Must not be modified. Always same for same - * driver object. - */ -const char * -jackctl_driver_get_name( - jackctl_driver_t * driver); - -/** - * Call this function to get type of driver. - * - * @param driver driver object handle to get name of - * - * @return driver type. Must not be modified. Always same for same - * driver object. - */ -jackctl_driver_type_t -jackctl_driver_get_type( - jackctl_driver_t * driver); - -/** - * Call this function to get list of driver parameters. List node data - * pointers is a parameter object handle (::jackctl_parameter_t). - * - * @param driver driver object handle to get parameters for - * - * @return Single linked list of parameter object handles. Must not be - * modified. Always same for same driver object. - */ -const JSList * -jackctl_driver_get_parameters( - jackctl_driver_t * driver); - -/** - * Call this function to parse parameters for a driver. - * - * @param driver driver object handle - * @param argc parameter list len - * @param argv parameter list, as an array of char* - * - * @return success status: true - success, false - fail - */ -int -jackctl_driver_params_parse( - jackctl_driver_t * driver, - int argc, - char* argv[]); - -/** - * Call this function to get name of internal client. - * - * @param internal internal object handle to get name of - * - * @return internal name. Must not be modified. Always same for same - * internal object. - */ -const char * -jackctl_internal_get_name( - jackctl_internal_t * internal); - -/** - * Call this function to get list of internal parameters. List node data - * pointers is a parameter object handle (::jackctl_parameter_t). - * - * @param internal internal object handle to get parameters for - * - * @return Single linked list of parameter object handles. Must not be - * modified. Always same for same internal object. - */ -const JSList * -jackctl_internal_get_parameters( - jackctl_internal_t * internal); - -/** - * Call this function to get parameter name. - * - * @param parameter parameter object handle to get name of - * - * @return parameter name. Must not be modified. Always same for same - * parameter object. - */ -const char * -jackctl_parameter_get_name( - jackctl_parameter_t * parameter); - -/** - * Call this function to get parameter short description. - * - * @param parameter parameter object handle to get short description of - * - * @return parameter short description. Must not be modified. Always - * same for same parameter object. - */ -const char * -jackctl_parameter_get_short_description( - jackctl_parameter_t * parameter); - -/** - * Call this function to get parameter long description. - * - * @param parameter parameter object handle to get long description of - * - * @return parameter long description. Must not be modified. Always - * same for same parameter object. - */ -const char * -jackctl_parameter_get_long_description( - jackctl_parameter_t * parameter); - -/** - * Call this function to get parameter type. - * - * @param parameter parameter object handle to get type of - * - * @return parameter type. Always same for same parameter object. - */ -jackctl_param_type_t -jackctl_parameter_get_type( - jackctl_parameter_t * parameter); - -/** - * Call this function to get parameter character. - * - * @param parameter parameter object handle to get character of - * - * @return character. - */ -char -jackctl_parameter_get_id( - jackctl_parameter_t * parameter); - -/** - * Call this function to check whether parameter has been set, or its - * default value is being used. - * - * @param parameter parameter object handle to check - * - * @return true - parameter is set, false - parameter is using default - * value. - */ -bool -jackctl_parameter_is_set( - jackctl_parameter_t * parameter); - -/** - * Call this function to reset parameter to its default value. - * - * @param parameter parameter object handle to reset value of - * - * @return success status: true - success, false - fail - */ -bool -jackctl_parameter_reset( - jackctl_parameter_t * parameter); - -/** - * Call this function to get parameter value. - * - * @param parameter parameter object handle to get value of - * - * @return parameter value. - */ -union jackctl_parameter_value -jackctl_parameter_get_value( - jackctl_parameter_t * parameter); - -/** - * Call this function to set parameter value. - * - * @param parameter parameter object handle to get value of - * @param value_ptr pointer to variable containing parameter value - * - * @return success status: true - success, false - fail - */ -bool -jackctl_parameter_set_value( - jackctl_parameter_t * parameter, - const union jackctl_parameter_value * value_ptr); - -/** - * Call this function to get parameter default value. - * - * @param parameter parameter object handle to get default value of - * - * @return parameter default value. - */ -union jackctl_parameter_value -jackctl_parameter_get_default_value( - jackctl_parameter_t * parameter); - -/** - * Call this function check whether parameter has range constraint. - * - * @param parameter object handle of parameter to check - * - * @return whether parameter has range constraint. - */ -bool -jackctl_parameter_has_range_constraint( - jackctl_parameter_t * parameter); - -/** - * Call this function check whether parameter has enumeration constraint. - * - * @param parameter object handle of parameter to check - * - * @return whether parameter has enumeration constraint. - */ -bool -jackctl_parameter_has_enum_constraint( - jackctl_parameter_t * parameter); - -/** - * Call this function get how many enumeration values parameter has. - * - * @param parameter object handle of parameter - * - * @return number of enumeration values - */ -uint32_t -jackctl_parameter_get_enum_constraints_count( - jackctl_parameter_t * parameter); - -/** - * Call this function to get parameter enumeration value. - * - * @param parameter object handle of parameter - * @param index index of parameter enumeration value - * - * @return enumeration value. - */ -union jackctl_parameter_value -jackctl_parameter_get_enum_constraint_value( - jackctl_parameter_t * parameter, - uint32_t index); - -/** - * Call this function to get parameter enumeration value description. - * - * @param parameter object handle of parameter - * @param index index of parameter enumeration value - * - * @return enumeration value description. - */ -const char * -jackctl_parameter_get_enum_constraint_description( - jackctl_parameter_t * parameter, - uint32_t index); - -/** - * Call this function to get parameter range. - * - * @param parameter object handle of parameter - * @param min_ptr pointer to variable receiving parameter minimum value - * @param max_ptr pointer to variable receiving parameter maximum value - */ -void -jackctl_parameter_get_range_constraint( - jackctl_parameter_t * parameter, - union jackctl_parameter_value * min_ptr, - union jackctl_parameter_value * max_ptr); - -/** - * Call this function to check whether parameter constraint is strict, - * i.e. whether supplying non-matching value will not work for sure. - * - * @param parameter parameter object handle to check - * - * @return whether parameter constraint is strict. - */ -bool -jackctl_parameter_constraint_is_strict( - jackctl_parameter_t * parameter); - -/** - * Call this function to check whether parameter has fake values, - * i.e. values have no user meaningful meaning and only value - * description is meaningful to user. - * - * @param parameter parameter object handle to check - * - * @return whether parameter constraint is strict. - */ -bool -jackctl_parameter_constraint_is_fake_value( - jackctl_parameter_t * parameter); - -/** - * Call this function to log an error message. - * - * @param format string - */ -void -jack_error( - const char *format, - ...); - -/** - * Call this function to log an information message. - * - * @param format string - */ -void -jack_info( - const char *format, - ...); - -/** - * Call this function to log an information message but only when - * verbose mode is enabled. - * - * @param format string - */ -void -jack_log( - const char *format, - ...); - -/**@}*/ - -#if 0 -{ /* Adjust editor indent */ -#endif -#ifdef __cplusplus -} /* extern "C" */ -#endif - -#endif /* #ifndef JACKCTL_H__2EEDAD78_DF4C_4B26_83B7_4FF1A446A47E__INCLUDED */