common/JackGenericClientChannel.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 __JackGenericClientChannel__
  21 #define __JackGenericClientChannel__
  22
  23 #include "JackChannel.h"
  24
  25 namespace Jack
  26 {
  27
  28 struct JackRequest;
  29 struct JackResult;
  30
  31 /*!
  32 \brief Generic JackClientChannel class.
  33 */
  34
  35 class JackGenericClientChannel : public detail::JackClientChannelInterface
  36 {
  37
  38     protected:
  39
  40         detail::JackClientRequestInterface* fRequest;
  41
  42         void ServerSyncCall(JackRequest* req, JackResult* res, int* result);
  43         void ServerAsyncCall(JackRequest* req, JackResult* res, int* result);
  44
  45     public:
  46
  47         JackGenericClientChannel();
  48         virtual ~JackGenericClientChannel();
  49
  50         virtual int Open(const char* server_name, const char* name, int uuid, char* name_res, JackClient* obj, jack_options_t options, jack_status_t* status) { return -1; }
  51         virtual void Close() {}
  52
  53         virtual int Start() { return -1; }
  54         virtual void Stop() {}
  55
  56         int ServerCheck(const char* server_name);
  57
  58         void ClientCheck(const char* name, int uuid, char* name_res, int protocol, int options, int* status, int* result, int open);
  59         void ClientOpen(const char* name, int pid, int uuid, int* shared_engine, int* shared_client, int* shared_graph, int* result);
  60         void ClientOpen(const char* name, int* ref, int uuid, JackEngineControl** shared_engine, JackGraphManager** shared_manager, JackClientInterface* client, int* result)
  61         {}
  62         void ClientClose(int refnum, int* result);
  63
  64         void ClientActivate(int refnum, int is_real_time, int* result);
  65         void ClientDeactivate(int refnum, int* result);
  66
  67         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);
  68         void PortUnRegister(int refnum, jack_port_id_t port_index, int* result);
  69
  70         void PortConnect(int refnum, const char* src, const char* dst, int* result);
  71         void PortDisconnect(int refnum, const char* src, const char* dst, int* result);
  72
  73         void PortConnect(int refnum, jack_port_id_t src, jack_port_id_t dst, int* result);
  74         void PortDisconnect(int refnum, jack_port_id_t src, jack_port_id_t dst, int* result);
  75
  76         void PortRename(int refnum, jack_port_id_t port, const char* name, int* result);
  77
  78         void SetBufferSize(jack_nframes_t buffer_size, int* result);
  79         void SetFreewheel(int onoff, int* result);
  80
  81         void ComputeTotalLatencies(int* result);
  82
  83         void ReleaseTimebase(int refnum, int* result);
  84         void SetTimebaseCallback(int refnum, int conditional, int* result);
  85
  86         void GetInternalClientName(int refnum, int int_ref, char* name_res, int* result);
  87         void InternalClientHandle(int refnum, const char* client_name, int* status, int* int_ref, int* result);
  88         void InternalClientLoad(int refnum, const char* client_name, const char* so_name, const char* objet_data, int options, int* status, int* int_ref, int uuid, int* result);
  89         void InternalClientUnload(int refnum, int int_ref, int* status, int* result);
  90
  91         // Session API
  92         void SessionNotify(int refnum, const char* target, jack_session_event_type_t type, const char* path, jack_session_command_t** result);
  93         void SessionReply(int refnum, int* result);
  94         void GetUUIDForClientName(int refnum, const char* client_name, char* uuid_res, int* result);
  95         void GetClientNameForUUID(int refnum, const char* uuid, char* name_res, int* result);
  96         void ReserveClientName(int refnum, const char* client_name, const char *uuid, int* result);
  97         void ClientHasSessionCallback(const char* client_name, int* result);
  98 };
  99
 100 } // end of namespace
 101
 102 #endif
 103