151 lines
4.5 KiB
C
151 lines
4.5 KiB
C
/* FluidSynth - A Software Synthesizer
|
|
*
|
|
* Copyright (C) 2003 Peter Hanappe and others.
|
|
*
|
|
* This library 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 library 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 library; if not, write to the Free
|
|
* Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
|
|
* 02110-1301, USA
|
|
*/
|
|
|
|
#ifndef _FLUIDSYNTH_SHELL_H
|
|
#define _FLUIDSYNTH_SHELL_H
|
|
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
|
|
/**
|
|
* @defgroup command_interface Command Interface
|
|
*
|
|
* Control and configuration interface
|
|
*
|
|
* The command interface allows you to send textual commands to
|
|
* the synthesizer, to parse a command file, or to read commands
|
|
* from the stdin or other input streams (like a TCP socket).
|
|
*
|
|
* For a full list of available commands, type \c help in the
|
|
* \ref command_shell or send the same command via a command handler.
|
|
* Further documentation can be found at
|
|
* https://github.com/FluidSynth/fluidsynth/wiki/UserManual#shell-commands
|
|
*
|
|
* @{
|
|
*/
|
|
FLUIDSYNTH_API fluid_istream_t fluid_get_stdin(void);
|
|
FLUIDSYNTH_API fluid_ostream_t fluid_get_stdout(void);
|
|
FLUIDSYNTH_API char *fluid_get_userconf(char *buf, int len);
|
|
FLUIDSYNTH_API char *fluid_get_sysconf(char *buf, int len);
|
|
/* @} */
|
|
|
|
|
|
/**
|
|
* @defgroup command_handler Command Handler
|
|
* @ingroup command_interface
|
|
* @brief Handles text commands and reading of configuration files
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
/** @startlifecycle{Command Handler} */
|
|
FLUIDSYNTH_API
|
|
fluid_cmd_handler_t *new_fluid_cmd_handler(fluid_synth_t *synth, fluid_midi_router_t *router);
|
|
|
|
FLUIDSYNTH_API
|
|
fluid_cmd_handler_t *new_fluid_cmd_handler2(fluid_settings_t *settings, fluid_synth_t *synth,
|
|
fluid_midi_router_t *router, fluid_player_t *player);
|
|
|
|
FLUIDSYNTH_API
|
|
void delete_fluid_cmd_handler(fluid_cmd_handler_t *handler);
|
|
/** @endlifecycle */
|
|
|
|
FLUIDSYNTH_API
|
|
void fluid_cmd_handler_set_synth(fluid_cmd_handler_t *handler, fluid_synth_t *synth);
|
|
|
|
FLUIDSYNTH_API
|
|
int fluid_command(fluid_cmd_handler_t *handler, const char *cmd, fluid_ostream_t out);
|
|
|
|
FLUIDSYNTH_API
|
|
int fluid_source(fluid_cmd_handler_t *handler, const char *filename);
|
|
/* @} */
|
|
|
|
|
|
/**
|
|
* @defgroup command_shell Command Shell
|
|
* @ingroup command_interface
|
|
*
|
|
* Interactive shell to control and configure a synthesizer instance.
|
|
*
|
|
* If you need a platform independent way to get the standard input
|
|
* and output streams, use fluid_get_stdin() and fluid_get_stdout().
|
|
*
|
|
* For a full list of available commands, type \c help in the shell.
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
/** @startlifecycle{Command Shell} */
|
|
FLUIDSYNTH_API
|
|
fluid_shell_t *new_fluid_shell(fluid_settings_t *settings, fluid_cmd_handler_t *handler,
|
|
fluid_istream_t in, fluid_ostream_t out, int thread);
|
|
|
|
FLUIDSYNTH_API
|
|
void fluid_usershell(fluid_settings_t *settings, fluid_cmd_handler_t *handler);
|
|
|
|
FLUIDSYNTH_API void delete_fluid_shell(fluid_shell_t *shell);
|
|
/** @endlifecycle */
|
|
|
|
/* @} */
|
|
|
|
|
|
/**
|
|
* @defgroup command_server Command Server
|
|
* @ingroup command_interface
|
|
*
|
|
* TCP socket server for a command handler.
|
|
*
|
|
* The socket server will open the TCP port set by \ref settings_shell_port
|
|
* (default 9800) and starts a new thread and \ref command_handler for each
|
|
* incoming connection.
|
|
*
|
|
* @note The server is only available if libfluidsynth has been compiled
|
|
* with network support (enable-network). Without network support, all related
|
|
* functions will return FLUID_FAILED or NULL.
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
/** @startlifecycle{Command Server} */
|
|
FLUIDSYNTH_API
|
|
fluid_server_t *new_fluid_server(fluid_settings_t *settings,
|
|
fluid_synth_t *synth, fluid_midi_router_t *router);
|
|
|
|
FLUIDSYNTH_API
|
|
fluid_server_t *new_fluid_server2(fluid_settings_t *settings,
|
|
fluid_synth_t *synth, fluid_midi_router_t *router,
|
|
fluid_player_t *player);
|
|
|
|
FLUIDSYNTH_API void delete_fluid_server(fluid_server_t *server);
|
|
|
|
FLUIDSYNTH_API int fluid_server_join(fluid_server_t *server);
|
|
/** @endlifecycle */
|
|
|
|
/* @} */
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* _FLUIDSYNTH_SHELL_H */
|