shell.h
上传用户:tjmskj2
上传日期:2020-08-17
资源大小:577k
文件大小:4k
源码类别:

midi

开发平台:

C/C++

  1. /* FluidSynth - A Software Synthesizer
  2.  *
  3.  * Copyright (C) 2003  Peter Hanappe and others.
  4.  *
  5.  * This library is free software; you can redistribute it and/or
  6.  * modify it under the terms of the GNU Library General Public License
  7.  * as published by the Free Software Foundation; either version 2 of
  8.  * the License, or (at your option) any later version.
  9.  *
  10.  * This library is distributed in the hope that it will be useful, but
  11.  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13.  * Library General Public License for more details.
  14.  *  
  15.  * You should have received a copy of the GNU Library General Public
  16.  * License along with this library; if not, write to the Free
  17.  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  18.  * 02111-1307, USA
  19.  */
  20. #ifndef _FLUIDSYNTH_SHELL_H
  21. #define _FLUIDSYNTH_SHELL_H
  22. #ifdef __cplusplus
  23. extern "C" {
  24. #endif
  25. /**
  26.  * @file shell.h
  27.  * @brief Command shell interface
  28.  *
  29.  * The shell interface allows you to send simple textual commands to
  30.  * the synthesizer, to parse a command file, or to read commands
  31.  * from the stdin or other input streams.
  32.  */
  33. FLUIDSYNTH_API fluid_istream_t fluid_get_stdin(void);
  34. FLUIDSYNTH_API fluid_ostream_t fluid_get_stdout(void);
  35. FLUIDSYNTH_API char* fluid_get_userconf(char* buf, int len);
  36. FLUIDSYNTH_API char* fluid_get_sysconf(char* buf, int len);
  37. /**
  38.  * Command handler function prototype.
  39.  * @param data User defined data
  40.  * @param ac Argument count
  41.  * @param av Array of string arguments
  42.  * @param out Output stream to send response to
  43.  * @return Should return #FLUID_OK on success, #FLUID_FAILED otherwise
  44.  */
  45. typedef int (*fluid_cmd_func_t)(void* data, int ac, char** av, fluid_ostream_t out);  
  46. /**
  47.  * Shell command information structure.
  48.  */
  49. typedef struct {
  50.   char* name;                           /**< The name of the command, as typed in the shell */
  51.   char* topic;                          /**< The help topic group of this command */ 
  52.   fluid_cmd_func_t handler;             /**< Pointer to the handler for this command */
  53.   void* data;                           /**< User data passed to the handler */
  54.   char* help;                           /**< A help string */
  55. } fluid_cmd_t;
  56. /* The command handler */
  57. FLUIDSYNTH_API 
  58. fluid_cmd_handler_t* new_fluid_cmd_handler(fluid_synth_t* synth);
  59. FLUIDSYNTH_API 
  60. void delete_fluid_cmd_handler(fluid_cmd_handler_t* handler);
  61. FLUIDSYNTH_API 
  62. void fluid_cmd_handler_set_synth(fluid_cmd_handler_t* handler, fluid_synth_t* synth);
  63. FLUIDSYNTH_API 
  64. int fluid_cmd_handler_register(fluid_cmd_handler_t* handler, fluid_cmd_t* cmd);
  65. FLUIDSYNTH_API 
  66. int fluid_cmd_handler_unregister(fluid_cmd_handler_t* handler, const char *cmd);
  67. /* Command function */
  68. FLUIDSYNTH_API 
  69. int fluid_command(fluid_cmd_handler_t* handler, const char *cmd, fluid_ostream_t out);
  70. FLUIDSYNTH_API 
  71. int fluid_source(fluid_cmd_handler_t* handler, const char *filename);
  72. FLUIDSYNTH_API 
  73. void fluid_usershell(fluid_settings_t* settings, fluid_cmd_handler_t* handler);
  74. /* Shell */
  75. FLUIDSYNTH_API 
  76. fluid_shell_t* new_fluid_shell(fluid_settings_t* settings, fluid_cmd_handler_t* handler,
  77.      fluid_istream_t in, fluid_ostream_t out, int thread);
  78. FLUIDSYNTH_API void delete_fluid_shell(fluid_shell_t* shell);
  79. /* TCP/IP server */
  80. /**
  81.  * Callback function which is executed for new server connections.
  82.  * @param data User defined data supplied in call to new_fluid_server()
  83.  * @param addr The IP address of the client (can be NULL)
  84.  * @return Should return a new command handler for the connection (new_fluid_cmd_handler()).
  85.  */
  86. typedef fluid_cmd_handler_t* (*fluid_server_newclient_func_t)(void* data, char* addr);
  87. FLUIDSYNTH_API 
  88. fluid_server_t* new_fluid_server(fluid_settings_t* settings, 
  89.        fluid_server_newclient_func_t func,
  90.        void* data);
  91. FLUIDSYNTH_API void delete_fluid_server(fluid_server_t* server);
  92. FLUIDSYNTH_API int fluid_server_join(fluid_server_t* server);
  93. #ifdef __cplusplus
  94. }
  95. #endif
  96. #endif /* _FLUIDSYNTH_SHELL_H */