jackaudio
/
jack2
mirror of https://github.com/jackaudio/jack2
1
0
Fork 0
Code Releases 45 Activity
jack2 codebase
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
1220 Commits
7 Branches
185MB
Tree: a52cb6eaa4
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'a52cb6eaa4'
${ noResults }
jack2/common/JackClient.h

198 lines
7.1KB
Raw Blame History 

  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 __JackClient__

  22. #define __JackClient__

  23. 

  24. #include "JackClientInterface.h"

  25. #include "JackThread.h"

  26. #include "JackConstants.h"

  27. #include "JackSynchro.h"

  28. #include "types.h"

  29. #include "varargs.h"

  30. #include <list>

  31. 

  32. #include "JackPlatformSynchro.h"

  33. #include "JackPlatformThread.h"

  34. #include "JackChannel.h"

  35. 

  36. namespace Jack

  37. {

  38. 

  39. class JackGraphManager;

  40. class JackServer;

  41. class JackEngine;

  42. struct JackClientControl;

  43. struct JackEngineControl;

  44. 

  45. typedef void (*JackShutdownCallback)(void *arg);

  46. 

  47. /*!

  48. \brief The base class for clients: share part of the implementation for JackInternalClient and JackLibClient.

  49. */

  50. 

  51. class JackClient : public JackClientInterface, public JackRunnableInterface

  52. {

  53.         friend class JackDebugClient;

  54. 

  55.     protected:

  56. 

  57.         JackProcessCallback fProcess;

  58.         JackGraphOrderCallback fGraphOrder;

  59.         JackXRunCallback fXrun;

  60.         JackShutdownCallback fShutdown;

  61.         JackThreadInitCallback fInit;

  62.         JackBufferSizeCallback fBufferSize;

  63.         JackSampleRateCallback fSampleRate;

  64.         JackClientRegistrationCallback fClientRegistration;

  65.         JackFreewheelCallback fFreewheel;

  66.         JackPortRegistrationCallback fPortRegistration;

  67.         JackPortConnectCallback fPortConnect;

  68.         JackTimebaseCallback fTimebase;

  69.         JackSyncCallback fSync;

  70.         JackThreadCallback fThreadFun;

  71. 

  72.         void* fProcessArg;

  73.         void* fGraphOrderArg;

  74.         void* fXrunArg;

  75.         void* fShutdownArg;

  76.         void* fInitArg;

  77.         void* fBufferSizeArg;

  78.         void* fSampleRateArg;

  79.         void* fClientRegistrationArg;

  80.         void* fFreewheelArg;

  81.         void* fPortRegistrationArg;

  82.         void* fPortConnectArg;

  83.         void* fTimebaseArg;

  84.         void* fSyncArg;

  85.         void* fThreadFunArg;

  86.         char fServerName[64];

  87. 

  88.         JackThread fThread;    /*! Thread to execute the Process function */

  89.         detail::JackClientChannelInterface* fChannel;

  90.         JackSynchro* fSynchroTable;

  91.         std::list<jack_port_id_t> fPortList;

  92.         bool fServerRunning;

  93. 

  94.         int StartThread();

  95.         void SetupDriverSync(bool freewheel);

  96.         bool IsActive();

  97. 

  98.         void CallSyncCallback();

  99.         void CallTimebaseCallback();

  100.    

  101.         virtual int ClientNotifyImp(int refnum, const char* name, int notify, int sync, int value1, int value);

  102. 

  103.         // Fons Adriaensen thread model

  104.         inline bool WaitFirstSync();

  105.         inline void ExecuteThread();

  106.         inline bool WaitSync();

  107.         inline void SignalSync();

  108.         inline int CallProcessCallback();

  109.         inline int End();

  110.         inline int Error();

  111. 

  112.     public:

  113. 

  114.         JackClient();

  115.         JackClient(JackSynchro* table);

  116.         virtual ~JackClient();

  117. 

  118.         virtual int Open(const char* server_name, const char* name, jack_options_t options, jack_status_t* status) = 0;

  119.         virtual int Close();

  120. 

  121.         virtual JackGraphManager* GetGraphManager() const = 0;

  122.         virtual JackEngineControl* GetEngineControl() const = 0;

  123. 

  124.         // Notifications

  125.         virtual int ClientNotify(int refnum, const char* name, int notify, int sync, int value1, int value2);

  126. 

  127.         virtual int Activate();

  128.         virtual int Deactivate();

  129. 

  130.         // Context

  131.         virtual int SetBufferSize(jack_nframes_t buffer_size);

  132.         virtual int SetFreeWheel(int onoff);

  133.         virtual void ShutDown();

  134.         virtual pthread_t GetThreadID();

  135. 

  136.         // Port management

  137.         virtual int PortRegister(const char* port_name, const char* port_type, unsigned long flags, unsigned long buffer_size);

  138.         virtual int PortUnRegister(jack_port_id_t port);

  139. 

  140.         virtual int PortConnect(const char* src, const char* dst);

  141.         virtual int PortDisconnect(const char* src, const char* dst);

  142.         virtual int PortDisconnect(jack_port_id_t src);

  143. 

  144.         virtual int PortIsMine(jack_port_id_t port_index);

  145. 

  146.         // Transport

  147.         virtual int ReleaseTimebase();

  148.         virtual int SetSyncCallback(JackSyncCallback sync_callback, void* arg);

  149.         virtual int SetSyncTimeout(jack_time_t timeout);

  150.         virtual int SetTimebaseCallback(int conditional, JackTimebaseCallback timebase_callback, void* arg);

  151.         virtual void TransportLocate(jack_nframes_t frame);

  152.         virtual jack_transport_state_t TransportQuery(jack_position_t* pos);

  153.         virtual jack_nframes_t GetCurrentTransportFrame();

  154.         virtual int TransportReposition(jack_position_t* pos);

  155.         virtual void TransportStart();

  156.         virtual void TransportStop();

  157. 

  158.         // Callbacks

  159.         virtual void OnShutdown(JackShutdownCallback callback, void *arg);

  160.         virtual int SetProcessCallback(JackProcessCallback callback, void* arg);

  161.         virtual int SetXRunCallback(JackXRunCallback callback, void* arg);

  162.         virtual int SetInitCallback(JackThreadInitCallback callback, void* arg);

  163.         virtual int SetGraphOrderCallback(JackGraphOrderCallback callback, void* arg);

  164.         virtual int SetBufferSizeCallback(JackBufferSizeCallback callback, void* arg);

  165.         virtual int SetSampleRateCallback(JackBufferSizeCallback callback, void* arg);

  166.         virtual int SetClientRegistrationCallback(JackClientRegistrationCallback callback, void* arg);

  167.         virtual int SetFreewheelCallback(JackFreewheelCallback callback, void* arg);

  168.         virtual int SetPortRegistrationCallback(JackPortRegistrationCallback callback, void* arg);

  169.         virtual int SetPortConnectCallback(JackPortConnectCallback callback, void *arg);

  170. 

  171.         // Internal clients

  172.         virtual char* GetInternalClientName(int ref);

  173.         virtual int InternalClientHandle(const char* client_name, jack_status_t* status);

  174.         virtual int InternalClientLoad(const char* client_name, jack_options_t options, jack_status_t* status, jack_varargs_t* va);

  175.         virtual void InternalClientUnload(int ref, jack_status_t* status);

  176. 

  177.         // Fons Adriaensen thread model

  178.         virtual jack_nframes_t Wait(int status);

  179. 

  180.         virtual jack_nframes_t CycleWait();

  181.         void CycleSignal(int status);

  182.         int SetProcessThread(JackThreadCallback fun, void *arg);

  183. 

  184.         // JackRunnableInterface interface

  185.         bool Init();

  186.         bool Execute();

  187.  

  188. };

  189. 

  190. // Each "side" server and client will implement this to get the shared graph manager, engine control and inter-process synchro table.

  191. extern JackGraphManager* GetGraphManager();

  192. extern JackEngineControl* GetEngineControl();

  193. extern JackSynchro* GetSynchroTable();

  194. 

  195. } // end of namespace

  196. 

  197. #endif