common/JackGraphManager.h

   1 /*
   2 Copyright (C) 2001 Paul Davis
   3 Copyright (C) 2004-2008 Grame
   4
   5 This program is free software; you can redistribute it and/or modify
   6 it under the terms of the GNU Lesser General Public License as published by
   7 the Free Software Foundation; either version 2.1 of the License, or
   8 (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU Lesser General Public License for more details.
  14
  15 You should have received a copy of the GNU Lesser General Public License
  16 along with this program; if not, write to the Free Software
  17 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  18
  19 */
  20
  21 #ifndef __JackGraphManager__
  22 #define __JackGraphManager__
  23
  24 #include "JackShmMem.h"
  25 #include "JackPort.h"
  26 #include "JackConstants.h"
  27 #include "JackConnectionManager.h"
  28 #include "JackAtomicState.h"
  29 #include "JackPlatformPlug.h"
  30 #include "JackSystemDeps.h"
  31
  32
  33 namespace Jack
  34 {
  35
  36 /*!
  37 \brief Graph manager: contains the connection manager and the port array.
  38 */
  39
  40 class SERVER_EXPORT JackGraphManager : public JackShmMem, public JackAtomicState<JackConnectionManager>
  41 {
  42
  43     private:
  44
  45         unsigned int fPortMax;
  46         JackClientTiming fClientTiming[CLIENT_NUM];
  47         JackPort fPortArray[0];    // The actual size depends of port_max, it will be dynamically computed and allocated using "placement" new
  48
  49         void AssertPort(jack_port_id_t port_index);
  50         jack_port_id_t AllocatePortAux(int refnum, const char* port_name, const char* port_type, JackPortFlags flags);
  51         void GetConnectionsAux(JackConnectionManager* manager, const char** res, jack_port_id_t port_index);
  52         void GetPortsAux(const char** matching_ports, const char* port_name_pattern, const char* type_name_pattern, unsigned long flags);
  53         float* GetBuffer(jack_port_id_t port_index);
  54         void* GetBufferAux(JackConnectionManager* manager, jack_port_id_t port_index, jack_nframes_t frames);
  55         jack_nframes_t ComputeTotalLatencyAux(jack_port_id_t port_index, jack_port_id_t src_port_index, JackConnectionManager* manager, int hop_count);
  56
  57     public:
  58
  59         JackGraphManager(int port_max);
  60         ~JackGraphManager()
  61         {}
  62
  63         void SetBufferSize(jack_nframes_t buffer_size);
  64
  65         // Ports management
  66         jack_port_id_t AllocatePort(int refnum, const char* port_name, const char* port_type, JackPortFlags flags, jack_nframes_t buffer_size);
  67         int ReleasePort(int refnum, jack_port_id_t port_index);
  68         void GetInputPorts(int refnum, jack_int_t* res);
  69         void GetOutputPorts(int refnum, jack_int_t* res);
  70         void RemoveAllPorts(int refnum);
  71         void DisconnectAllPorts(int refnum);
  72
  73         JackPort* GetPort(jack_port_id_t index);
  74         jack_port_id_t GetPort(const char* name);
  75         int ComputeTotalLatency(jack_port_id_t port_index);
  76         int ComputeTotalLatencies();
  77         int RequestMonitor(jack_port_id_t port_index, bool onoff);
  78
  79         // Connections management
  80         int Connect(jack_port_id_t src_index, jack_port_id_t dst_index);
  81         int Disconnect(jack_port_id_t src_index, jack_port_id_t dst_index);
  82         int IsConnected(jack_port_id_t port_src, jack_port_id_t port_dst);
  83
  84         // RT, client
  85         int GetConnectionsNum(jack_port_id_t port_index)
  86         {
  87             JackConnectionManager* manager = ReadCurrentState();
  88             return manager->Connections(port_index);
  89         }
  90
  91         const char** GetConnections(jack_port_id_t port_index);
  92         void GetConnections(jack_port_id_t port_index, jack_int_t* connections);  // TODO
  93         const char** GetPorts(const char* port_name_pattern, const char* type_name_pattern, unsigned long flags);
  94
  95         int GetTwoPorts(const char* src, const char* dst, jack_port_id_t* src_index, jack_port_id_t* dst_index);
  96         int CheckPorts(jack_port_id_t port_src, jack_port_id_t port_dst);
  97
  98         void DisconnectAllInput(jack_port_id_t port_index);
  99         void DisconnectAllOutput(jack_port_id_t port_index);
 100         int DisconnectAll(jack_port_id_t port_index);
 101
 102         bool IsDirectConnection(int ref1, int ref2);
 103         void DirectConnect(int ref1, int ref2);
 104         void DirectDisconnect(int ref1, int ref2);
 105
 106         void Activate(int refnum);
 107         void Deactivate(int refnum);
 108
 109         int GetInputRefNum(jack_port_id_t port_index);
 110         int GetOutputRefNum(jack_port_id_t port_index);
 111
 112         // Buffer management
 113         void* GetBuffer(jack_port_id_t port_index, jack_nframes_t frames);
 114
 115         // Activation management
 116         void RunCurrentGraph();
 117         bool RunNextGraph();
 118         bool IsFinishedGraph();
 119
 120         void InitRefNum(int refnum);
 121         int ResumeRefNum(JackClientControl* control, JackSynchro* table);
 122         int SuspendRefNum(JackClientControl* control, JackSynchro* table, long usecs);
 123
 124         JackClientTiming* GetClientTiming(int refnum)
 125         {
 126             return &fClientTiming[refnum];
 127         }
 128
 129         void Save(JackConnectionManager* dst);
 130         void Restore(JackConnectionManager* src);
 131
 132         static JackGraphManager* Allocate(int port_max);
 133         static void Destroy(JackGraphManager* manager);
 134
 135 } POST_PACKED_STRUCTURE;
 136
 137
 138 } // end of namespace
 139
 140 #endif
 141