common/JackChannel.h

   1 /*
   2 Copyright (C) 2004-2008 Grame
   3
   4 This program is free software; you can redistribute it and/or modify
   5 it under the terms of the GNU Lesser General Public License as published by
   6 the Free Software Foundation; either version 2.1 of the License, or
   7 (at your option) any later version.
   8
   9 This program is distributed in the hope that it will be useful,
  10 but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 GNU Lesser General Public License for more details.
  13
  14 You should have received a copy of the GNU Lesser General Public License
  15 along with this program; if not, write to the Free Software
  16 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  17
  18 */
  19
  20 #ifndef __JackChannel__
  21 #define __JackChannel__
  22
  23 #include "types.h"
  24
  25 namespace Jack
  26 {
  27
  28 class JackClientInterface;
  29 class JackClient;
  30 class JackServer;
  31 struct JackEngineControl;
  32 class JackGraphManager;
  33
  34 namespace detail
  35 {
  36
  37 /*!
  38 \brief Inter process channel for server/client bidirectionnal communication : request and (receiving) notifications.
  39 */
  40
  41 class JackClientChannelInterface
  42 {
  43
  44     public:
  45
  46         JackClientChannelInterface()
  47         {}
  48         virtual ~JackClientChannelInterface()
  49         {}
  50
  51         // Open the Server/Client connection
  52         virtual int Open(const char* server_name, const char* name, char* name_res, JackClient* obj, jack_options_t options, jack_status_t* status)
  53         {
  54             return 0;
  55         }
  56
  57         // Close the Server/Client connection
  58         virtual void Close()
  59         {}
  60
  61         // Start listening for messages from the server
  62         virtual int Start()
  63         {
  64             return 0;
  65         }
  66
  67         // Stop listening for messages from the server
  68         virtual void Stop()
  69         {}
  70
  71         virtual int ServerCheck(const char* server_name)
  72         {
  73             return -1;
  74         }
  75
  76         virtual void ClientCheck(const char* name, char* name_res, int protocol, int options, int* status, int* result)
  77         {}
  78         virtual void ClientOpen(const char* name, int pid, int* shared_engine, int* shared_client, int* shared_graph, int* result)
  79         {}
  80         virtual void ClientOpen(const char* name, int* ref, JackEngineControl** shared_engine, JackGraphManager** shared_manager, JackClientInterface* client, int* result)
  81         {}
  82         virtual void ClientClose(int refnum, int* result)
  83         {}
  84
  85         virtual void ClientActivate(int refnum, int is_real_time, int* result)
  86         {}
  87         virtual void ClientDeactivate(int refnum, int* result)
  88         {}
  89
  90         virtual void PortRegister(int refnum, const char* name, const char* type, unsigned int flags, unsigned int buffer_size, jack_port_id_t* port_index, int* result)
  91         {}
  92         virtual void PortUnRegister(int refnum, jack_port_id_t port_index, int* result)
  93         {}
  94
  95         virtual void PortConnect(int refnum, const char* src, const char* dst, int* result)
  96         {}
  97         virtual void PortDisconnect(int refnum, const char* src, const char* dst, int* result)
  98         {}
  99         virtual void PortConnect(int refnum, jack_port_id_t src, jack_port_id_t dst, int* result)
 100         {}
 101         virtual void PortDisconnect(int refnum, jack_port_id_t src, jack_port_id_t dst, int* result)
 102         {}
 103         virtual void PortRename(int refnum, jack_port_id_t port, const char* name, int* result)
 104         {}
 105
 106         virtual void SetBufferSize(jack_nframes_t buffer_size, int* result)
 107         {}
 108         virtual void SetFreewheel(int onoff, int* result)
 109         {}
 110
 111         virtual void ReleaseTimebase(int refnum, int* result)
 112         {}
 113
 114         virtual void SetTimebaseCallback(int refnum, int conditional, int* result)
 115         {}
 116
 117         virtual void GetInternalClientName(int refnum, int int_ref, char* name_res, int* result)
 118         {}
 119
 120         virtual void InternalClientHandle(int refnum, const char* client_name, int* status, int* int_ref, int* result)
 121         {}
 122
 123         virtual void InternalClientLoad(int refnum, const char* client_name, const char* so_name, const char* objet_data, int options, int* status, int* int_ref, int* result)
 124         {}
 125
 126         virtual void InternalClientUnload(int refnum, int int_ref, int* status, int* result)
 127         {}
 128
 129 };
 130
 131 }
 132
 133 } // end of namespace
 134
 135 #endif
 136