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 ActivatePort(jack_port_id_t port_index);
  69         void DeactivatePort(jack_port_id_t port_index);
  70         void GetInputPorts(int refnum, jack_int_t* res);
  71         void GetOutputPorts(int refnum, jack_int_t* res);
  72         void RemoveAllPorts(int refnum);
  73         void DisconnectAllPorts(int refnum);
  74
  75         JackPort* GetPort(jack_port_id_t index);
  76         jack_port_id_t GetPort(const char* name);
  77         int ComputeTotalLatency(jack_port_id_t port_index);
  78         int ComputeTotalLatencies();
  79         int RequestMonitor(jack_port_id_t port_index, bool onoff);
  80
  81         // Connections management
  82         int Connect(jack_port_id_t src_index, jack_port_id_t dst_index);
  83         int Disconnect(jack_port_id_t src_index, jack_port_id_t dst_index);
  84         int IsConnected(jack_port_id_t port_src, jack_port_id_t port_dst);
  85
  86         // RT, client
  87         int GetConnectionsNum(jack_port_id_t port_index)
  88         {
  89             JackConnectionManager* manager = ReadCurrentState();
  90             return manager->Connections(port_index);
  91         }
  92
  93         const char** GetConnections(jack_port_id_t port_index);
  94         void GetConnections(jack_port_id_t port_index, jack_int_t* connections);  // TODO
  95         const char** GetPorts(const char* port_name_pattern, const char* type_name_pattern, unsigned long flags);
  96
  97         int GetTwoPorts(const char* src, const char* dst, jack_port_id_t* src_index, jack_port_id_t* dst_index);
  98         int CheckPorts(jack_port_id_t port_src, jack_port_id_t port_dst);
  99
 100         void DisconnectAllInput(jack_port_id_t port_index);
 101         void DisconnectAllOutput(jack_port_id_t port_index);
 102         int DisconnectAll(jack_port_id_t port_index);
 103
 104         bool IsDirectConnection(int ref1, int ref2);
 105         void DirectConnect(int ref1, int ref2);
 106         void DirectDisconnect(int ref1, int ref2);
 107
 108         void Activate(int refnum);
 109         void Deactivate(int refnum);
 110
 111         int GetInputRefNum(jack_port_id_t port_index);
 112         int GetOutputRefNum(jack_port_id_t port_index);
 113
 114         // Buffer management
 115         void* GetBuffer(jack_port_id_t port_index, jack_nframes_t frames);
 116
 117         // Activation management
 118         void RunCurrentGraph();
 119         bool RunNextGraph();
 120         bool IsFinishedGraph();
 121
 122         void InitRefNum(int refnum);
 123         int ResumeRefNum(JackClientControl* control, JackSynchro* table);
 124         int SuspendRefNum(JackClientControl* control, JackSynchro* table, long usecs);
 125
 126         JackClientTiming* GetClientTiming(int refnum)
 127         {
 128             return &fClientTiming[refnum];
 129         }
 130
 131         void Save(JackConnectionManager* dst);
 132         void Restore(JackConnectionManager* src);
 133
 134         static JackGraphManager* Allocate(int port_max);
 135         static void Destroy(JackGraphManager* manager);
 136
 137 } POST_PACKED_STRUCTURE;
 138
 139
 140 } // end of namespace
 141
 142 #endif
 143