control.h

Go to the documentation of this file.

/* -*- 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.

*/
#ifndef JACKCTL_H__2EEDAD78_DF4C_4B26_83B7_4FF1A446A47E__INCLUDED
#define JACKCTL_H__2EEDAD78_DF4C_4B26_83B7_4FF1A446A47E__INCLUDED

#include <jack/types.h>
#include <jack/jslist.h>
#include <jack/systemdeps.h>
#if !defined(sun) && !defined(__sun__)
#include <stdbool.h>
#endif

typedef enum
{
    JackParamInt = 1,                   
    JackParamUInt,                              
    JackParamChar,                              
    JackParamString,                    
    JackParamBool,                              
} jackctl_param_type_t;

typedef enum
{
    JackMaster = 1,         
    JackSlave               
} jackctl_driver_type_t;

#define JACK_PARAM_MAX (JackParamBool + 1)

#define JACK_PARAM_STRING_MAX  127

/* intentionally similar to jack_driver_param_value_t */
union jackctl_parameter_value
{
    uint32_t ui;                                
    int32_t i;                                  
    char c;                                             
    char str[JACK_PARAM_STRING_MAX + 1]; 
    bool b;                             
};

typedef struct jackctl_server jackctl_server_t;

typedef struct jackctl_driver jackctl_driver_t;

typedef struct jackctl_internal jackctl_internal_t;

typedef struct jackctl_parameter jackctl_parameter_t;

typedef struct jackctl_sigmask jackctl_sigmask_t;

#ifdef __cplusplus
extern "C" {
#endif
#if 0
} /* Adjust editor indent */
#endif

jackctl_sigmask_t *
jackctl_setup_signals(
    unsigned int flags);

void
jackctl_wait_signals(
    jackctl_sigmask_t * signals);

jackctl_server_t *
jackctl_server_create(
    bool (* on_device_acquire)(const char * device_name),
    void (* on_device_release)(const char * device_name));

void
jackctl_server_destroy(
        jackctl_server_t * server);

bool
jackctl_server_open(
    jackctl_server_t * server,
    jackctl_driver_t * driver);

bool
jackctl_server_start(
    jackctl_server_t * server);

bool
jackctl_server_stop(
        jackctl_server_t * server);

bool
jackctl_server_close(
        jackctl_server_t * server);

const JSList *
jackctl_server_get_drivers_list(
        jackctl_server_t * server);

const JSList *
jackctl_server_get_parameters(
        jackctl_server_t * server);

const JSList *
jackctl_server_get_internals_list(
        jackctl_server_t * server);

bool
jackctl_server_load_internal(
    jackctl_server_t * server,
    jackctl_internal_t * internal);

bool
jackctl_server_unload_internal(
    jackctl_server_t * server,
    jackctl_internal_t * internal);

bool
jackctl_server_add_slave(jackctl_server_t * server,
                            jackctl_driver_t * driver);

bool
jackctl_server_remove_slave(jackctl_server_t * server,
                            jackctl_driver_t * driver);

bool
jackctl_server_switch_master(jackctl_server_t * server,
                            jackctl_driver_t * driver);


const char *
jackctl_driver_get_name(
        jackctl_driver_t * driver);

jackctl_driver_type_t
jackctl_driver_get_type(
        jackctl_driver_t * driver);

const JSList *
jackctl_driver_get_parameters(
        jackctl_driver_t * driver);

int
jackctl_driver_params_parse(
    jackctl_driver_t * driver,
    int argc,
    char* argv[]);

const char *
jackctl_internal_get_name(
        jackctl_internal_t * internal);

const JSList *
jackctl_internal_get_parameters(
        jackctl_internal_t * internal);

const char *
jackctl_parameter_get_name(
        jackctl_parameter_t * parameter);

const char *
jackctl_parameter_get_short_description(
        jackctl_parameter_t * parameter);

const char *
jackctl_parameter_get_long_description(
        jackctl_parameter_t * parameter);

jackctl_param_type_t
jackctl_parameter_get_type(
        jackctl_parameter_t * parameter);

char
jackctl_parameter_get_id(
        jackctl_parameter_t * parameter);

bool
jackctl_parameter_is_set(
        jackctl_parameter_t * parameter);

bool
jackctl_parameter_reset(
        jackctl_parameter_t * parameter);

union jackctl_parameter_value
jackctl_parameter_get_value(
        jackctl_parameter_t * parameter);

bool
jackctl_parameter_set_value(
        jackctl_parameter_t * parameter,
        const union jackctl_parameter_value * value_ptr);

union jackctl_parameter_value
jackctl_parameter_get_default_value(
        jackctl_parameter_t * parameter);

bool
jackctl_parameter_has_range_constraint(
        jackctl_parameter_t * parameter);

bool
jackctl_parameter_has_enum_constraint(
        jackctl_parameter_t * parameter);

uint32_t
jackctl_parameter_get_enum_constraints_count(
        jackctl_parameter_t * parameter);

union jackctl_parameter_value
jackctl_parameter_get_enum_constraint_value(
        jackctl_parameter_t * parameter,
        uint32_t index);

const char *
jackctl_parameter_get_enum_constraint_description(
        jackctl_parameter_t * parameter,
        uint32_t index);

void
jackctl_parameter_get_range_constraint(
        jackctl_parameter_t * parameter,
        union jackctl_parameter_value * min_ptr,
        union jackctl_parameter_value * max_ptr);

bool
jackctl_parameter_constraint_is_strict(
        jackctl_parameter_t * parameter);

bool
jackctl_parameter_constraint_is_fake_value(
        jackctl_parameter_t * parameter);

void
jack_error(
        const char *format,
        ...);

void
jack_info(
        const char *format,
        ...);

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 */

---