N-Chains: commands.h Source File

00001 /*********************************************************************** 
00002  *
00003  * Copyright (C) 2009  Nils Doormann <ndmn@users.sourceforge.net>
00004  * 
00005  * This program is free software: you can redistribute it and/or modify
00006  * it under the terms of the GNU General Public License as published by
00007  * the Free Software Foundation, either version 3 of the License, or
00008  * (at your option) any later version.
00009  *
00010  * This program is distributed in the hope that it will be useful,
00011  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00012  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00013  * GNU General Public License for more details.
00014  *
00015  * You should have received a copy of the GNU General Public License
00016  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
00017  *
00018  ***********************************************************************/
00019 
00020 /***************************************************************************
00021  * commands.h
00022  *
00023  * $Id: commands.h,v 1.3 2009/07/09 16:19:23 ndmn Exp $
00024  *
00025  * Definition of all eca commands and handles for the nchains client
00026  *
00027  **************************************************************************/
00028 
00029 #ifndef __NCHAINS_COMMANDS_H
00030 #define __NCHAINS_COMMANDS_H
00031 
00032 #include "defs.h"
00033 #include "client.h"
00034 #include "interface.h"
00035 
00036 #include <stdarg.h>
00037 
00038 //extern int cmd_command(struct _application *app, const char *cmd);
00039 extern int cmd_command(struct _application *app, const char *fmt, ...);
00040 extern char * cmd_command_str(struct _application *app, const char *fmt, ...);
00041 
00042 extern int cmd_command_v(struct _application *app, const char *fmt, ...);
00043 
00044 /**
00045  * @desc Selects chain setup <i>csname</i>
00046  */
00047 extern int cmd_cs_select(struct _application *app,const char *csname);
00048 
00049 /**
00050  * @desc Add a new chain set of name <i>csname</i>
00051  */
00052 extern int cmd_cs_add(struct _application *app,const char *csname);
00053 
00054 /**
00055  * @desc Add a new chain to the current selected chainset. Note, that in nchains,
00056  * by convention, there will only be a single chain set per session.
00057  */
00058 extern int cmd_c_add(struct _application *app,const char *cname);
00059 
00060 /**
00061  * @desc Requests the current selected chain
00062  * @return The name of the current selected chain or NULL
00063  */
00064 extern char *cmd_c_selected(struct _application *app);
00065 
00066 /**
00067  * @desc Selects chain named cname
00068  * @return If the server request failes -1 is returned and an error message is i
00069  * printed to the status window. Otherwise a value greater than or equal to 0 is 
00070  * returned.
00071  */
00072 extern int cmd_c_select(struct _application *app,const char*cname);
00073 
00074 /**
00075  * Selects all chains. Previously selected chains become unselected
00076  */
00077 extern int cmd_c_select_all(struct _application *app);
00078 
00079 /**
00080  * @desc Adds the audio input iname to the current selected chain
00081  */
00082 extern int cmd_ai_add(struct _application *app,const char*iname);
00083 
00084 /**
00085  * @desc Adds the audio output to the current selected chain
00086  */
00087 extern int cmd_ao_add(struct _application *app,const char *arg);
00088 
00089 /**
00090  * @desc Selects old chain, renames it to new chain and selects new chain
00091  * @param old the old chain name
00092  * @param new the new chain name
00093  */
00094 extern int cmd_c_rename(struct _application *app, const char *_old, const char *_new);
00095 
00096 /**
00097  * Adds Chain operator (cop) cop to the selected chain using cop-parameter list <i>params</i>
00098  */
00099 extern int cmd_cop_add(struct _application *app,const char *cop, const char *params);
00100 
00101 /**
00102  * Changes the current selected chain's muting state
00103  */
00104 extern int cmd_c_muting(struct _application *app);
00105 
00106 /**
00107  * Get the current engine status
00108  */
00109 extern char * cmd_engine_status(struct _application *app);
00110 
00111 /**
00112  * get the length in secs of the current selected audio input
00113  */
00114 extern char * cmd_ai_get_length(struct _application *app);
00115 
00116 /**
00117  * Selects an audio input by index (beginning from 1)
00118  */
00119 extern int cmd_ai_index_select(struct _application *app,int index);
00120 
00121 /** 
00122  * Returns 1 if the chain setup is valid for being connected
00123  * or 0 if not
00124  */
00125 extern int cmd_cs_is_valid(struct _application *app);
00126 
00127 /**
00128  * Returns the result string of the ecasound-iam command cop-list
00129  */
00130 extern char * cmd_cop_list(struct _application *app);
00131 
00132 extern int cmd_quit(struct _application *app,const char *arg);
00133 extern int cmd_start(struct _application *app,const char *arg);
00134 extern int cmd_stop(struct _application *app,const char *arg);
00135 extern int cmd_run(struct _application *app,const char *arg);
00136 extern int cmd_debug(struct _application *app,const char *arg);
00137 extern int cmd_resource_file(struct _application *app,const char *arg);
00138 
00139 extern int cmd_engine_launch(struct _application *app,const char *arg);
00140 extern int cmd_engine_halt(struct _application *app,const char *arg);
00141 
00142 //extern int cmd_cs_add(struct _application *app,const char *arg);
00143 extern int cmd_cs_remove(struct _application *app,const char *arg);
00144 extern int cmd_cs_list(struct _application *app,const char *arg);
00145 extern int cmd_cs_select(struct _application *app,const char *arg);
00146 extern int cmd_cs_selected(struct _application *app,const char *arg);
00147 extern int cmd_cs_index_select(struct _application *app,const char *arg);
00148 extern int cmd_cs_load(struct _application *app,const char *arg);
00149 extern int cmd_cs_save(struct _application *app,const char *arg);
00150 extern int cmd_cs_save_as(struct _application *app,const char *arg);
00151 extern int cmd_cs_edit(struct _application *app,const char *arg);
00152 extern int cmd_cs_connect(struct _application *app,const char *arg);
00153 extern int cmd_cs_disconnect(struct _application *app,const char *arg);
00154 extern int cmd_cs_connected(struct _application *app,const char *arg);
00155 extern int cmd_cs_rewind(struct _application *app,const char *arg);
00156 extern int cmd_cs_forward(struct _application *app,const char *arg);
00157 extern int cmd_cs_set_position(struct _application *app,const char *arg);
00158 extern int cmd_cs_set_position_samples(struct _application *app,const char *arg);
00159 extern int cmd_cs_get_position(struct _application *app,const char *arg);
00160 extern int cmd_cs_get_position_samples(struct _application *app,const char *arg);
00161 extern int cmd_cs_get_length(struct _application *app,const char *arg);
00162 extern int cmd_cs_get_length_samples(struct _application *app,const char *arg);
00163 extern int cmd_cs_set_length(struct _application *app,const char *arg);
00164 extern int cmd_cs_set_length_samples(struct _application *app,const char *arg);
00165 extern int cmd_cs_toggle_loop(struct _application *app,const char *arg);
00166 extern int cmd_cs_set_param(struct _application *app,const char *arg);
00167 extern int cmd_cs_set_audio_format(struct _application *app,const char *arg);
00168 extern int cmd_cs_status(struct _application *app,const char *arg);
00169 extern int cmd_cs_option(struct _application *app,const char *arg);
00170 
00171 //extern int cmd_c_add(struct _application *app,const char *arg);
00172 extern int cmd_c_list(struct _application *app,const char *arg);
00173 //extern int cmd_c_select(struct _application *app,const char *arg);
00174 extern int cmd_c_index_select(struct _application *app,const char *arg);
00175 extern int cmd_c_select_add(struct _application *app,const char *arg);
00176 extern int cmd_c_deselect(struct _application *app,const char *arg);
00177 //extern int cmd_c_selected(struct _application *app,const char *arg);
00178 extern int cmd_c_clear(struct _application *app,const char *arg);
00179 //extern int cmd_c_rename(struct _application *app,const char *arg);
00180 extern int cmd_c_bypass(struct _application *app,const char *arg);
00181 extern int cmd_c_status(struct _application *app,const char *arg);
00182 
00183 //extern int cmd_ai_add(struct _application *app,const char *arg);
00184 //extern int cmd_ao_add(struct _application *app,const char *arg);
00185 extern int cmd_ao_add_default(struct _application *app,const char *arg);
00186 extern int cmd_ai_describe(struct _application *app,const char *arg);
00187 extern int cmd_ai_select(struct _application *app,const char *arg);
00188 extern int cmd_ai_selected(struct _application *app,const char *arg);
00189 extern int cmd_ai_attach(struct _application *app,const char *arg);
00190 extern int cmd_ai_remove(struct _application *app,const char *arg);
00191 extern int cmd_ai_forward(struct _application *app,const char *arg);
00192 extern int cmd_ai_rewind(struct _application *app,const char *arg);
00193 extern int cmd_ai_setpos(struct _application *app,const char *arg);
00194 extern int cmd_ai_set_position_samples(struct _application *app,const char *arg);
00195 extern int cmd_ai_getpos(struct _application *app,const char *arg);
00196 extern int cmd_ai_get_position_samples(struct _application *app,const char *arg);
00197 extern int cmd_ai_get_length_samples(struct _application *app,const char *arg);
00198 extern int cmd_ai_get_format(struct _application *app,const char *arg);
00199 extern int cmd_ai_list(struct _application *app,const char *arg);
00200 extern int cmd_aio_register(struct _application *app,const char *arg);
00201 extern int cmd_aio_status(struct _application *app,const char *arg);
00202 
00203 
00204 extern int cmd_cop_describe(struct _application *app,const char *arg);
00205 extern int cmd_cop_remove(struct _application *app,const char *arg);
00206 extern int cmd_cop_select(struct _application *app,const char *arg);
00207 extern int cmd_cop_selected(struct _application *app,const char *arg);
00208 extern int cmd_cop_set(struct _application *app,const char *arg);
00209 extern int cmd_cop_status(struct _application *app,const char *arg);
00210 
00211 extern int cmd_copp_list(struct _application *app,const char *arg);
00212 extern int cmd_copp_select(struct _application *app,const char *arg);
00213 extern int cmd_copp_selected(struct _application *app,const char *arg);
00214 extern int cmd_copp_set(struct _application *app,const char *arg);
00215 extern int cmd_copp_get(struct _application *app,const char *arg);
00216 
00217 extern int cmd_cop_register(struct _application *app,const char *arg);
00218 extern int cmd_preset_register(struct _application *app,const char *arg);
00219 extern int cmd_ladspa_register(struct _application *app,const char *arg);
00220 
00221 extern int cmd_ctrl_add(struct _application *app,const char *arg);
00222 extern int cmd_ctrl_describe(struct _application *app,const char *arg);
00223 extern int cmd_ctrl_remove(struct _application *app,const char *arg);
00224 extern int cmd_ctrl_list(struct _application *app,const char *arg);
00225 extern int cmd_ctrl_select(struct _application *app,const char *arg);
00226 extern int cmd_ctrl_selected(struct _application *app,const char *arg);
00227 extern int cmd_ctrl_status(struct _application *app,const char *arg);
00228 extern int cmd_ctrl_register(struct _application *app,const char *arg);
00229 extern int cmd_ctrl_get_target(struct _application *app,const char *arg);
00230 
00231 extern int cmd_ctrlp_list(struct _application *app,const char *arg);
00232 extern int cmd_ctrlp_select(struct _application *app,const char *arg);
00233 extern int cmd_ctrlp_selected(struct _application *app,const char *arg);
00234 extern int cmd_ctrlp_get(struct _application *app,const char *arg);
00235 extern int cmd_ctrlp_set(struct _application *app,const char *arg);
00236 
00237 extern int cmd_jack_connect(struct _application *app,const char *arg);
00238 extern int cmd_jack_disconnect(struct _application *app,const char *arg);
00239 extern int cmd_jack_list_connections(struct _application *app,const char *arg);
00240 
00241 extern int cmd_int_cmd_list(struct _application *app,const char *arg);
00242 extern int cmd_int_log_history(struct _application *app,const char *arg);
00243 extern int cmd_int_output_mode_wellformed(struct _application *app,const char *arg);
00244 extern int cmd_int_set_float_to_string_precision(struct _application *app,const char *arg);
00245 extern int cmd_int_set_log_history_length(struct _application *app,const char *arg);
00246 extern int cmd_int_cmd_version_string(struct _application *app,const char *arg);
00247 extern int cmd_int_cmd_version_lib_current(struct _application *app,const char *arg);
00248 extern int cmd_int_cmd_version_lib_revision(struct _application *app,const char *arg);
00249 extern int cmd_int_cmd_version_lib_age(struct _application *app,const char *arg);
00250 
00251 extern int cmd_map_cop_list(struct _application *app,const char *arg);
00252 extern int cmd_map_preset_list(struct _application *app,const char *arg);
00253 extern int cmd_map_ladspa_list(struct _application *app,const char *arg);
00254 extern int cmd_map_ladspa_id_list(struct _application *app,const char *arg);
00255 extern int cmd_map_ctrl_list(struct _application *app,const char *arg);
00256 
00257 extern int cmd_dump_target(struct _application *app,const char *arg);
00258 extern int cmd_dump_status(struct _application *app,const char *arg);
00259 extern int cmd_dump_position(struct _application *app,const char *arg);
00260 extern int cmd_dump_length(struct _application *app,const char *arg);
00261 extern int cmd_dump_cs_status(struct _application *app,const char *arg);
00262 extern int cmd_dump_c_selected(struct _application *app,const char *arg);
00263 extern int cmd_dump_ai_selected(struct _application *app,const char *arg);
00264 extern int cmd_dump_ai_position(struct _application *app,const char *arg);
00265 extern int cmd_dump_ai_length(struct _application *app,const char *arg);
00266 extern int cmd_dump_ai_open_state(struct _application *app,const char *arg);
00267 extern int cmd_dump_ao_selected(struct _application *app,const char *arg);
00268 extern int cmd_dump_ao_position(struct _application *app,const char *arg);
00269 extern int cmd_dump_ao_length(struct _application *app,const char *arg);
00270 extern int cmd_dump_ao_open_state(struct _application *app,const char *arg);
00271 extern int cmd_dump_cop_value(struct _application *app,const char *arg);
00272 
00273 
00274 /*
00275  * Some default Cops follow, uugh!
00276  */
00277 
00278 /**
00279  * cop ea, defaults to 100
00280  */
00281 extern int cmd_ea_add(struct _application *app);
00282 
00283 /**
00284  * Adds chcopy cop to the current selected chain using the values chcopy:1,2
00285  */
00286 extern int cmd_chcopy_add(struct _application *app);
00287 
00288 /**
00289  * Adds panning cop to the current selected chain using the value epp:50
00290  */
00291 extern int cmd_epp_add(struct _application *app);
00292 
00293 
00294 
00295 
00296 #endif /* __NCHAINS_COMMANDS_H */