common/JackPort.h

   1 /*
   2 Copyright (C) 2001 Paul Davis
   3 Copyright (C) 2004-2006 Grame
   4
   5 This program is free software; you can redistribute it and/or modify
   6   it under the terms of the GNU General Public License as published by
   7   the Free Software Foundation; either version 2 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 General Public License for more details.
  14
  15   You should have received a copy of the GNU General Public License
  16   along with this program; if not, write to the Free Software
  17   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18
  19 */
  20
  21 #ifndef __JackPort__
  22 #define __JackPort__
  23
  24 #include "types.h"
  25 #include "JackConstants.h"
  26
  27 namespace Jack
  28 {
  29
  30 #define ALL_PORTS       0xFFFF
  31 #define NO_PORT         0xFFFE
  32
  33 /*!
  34 \brief Base class for port.
  35 */
  36
  37 class JackPort
  38 {
  39
  40         friend class JackGraphManager;
  41
  42     private:
  43
  44         enum JackPortFlags fFlags;
  45         char fName[JACK_PORT_NAME_SIZE + 2];
  46         int fRefNum;
  47
  48         jack_nframes_t fLatency;
  49         uint8_t fMonitorRequests;
  50
  51         bool fInUse;
  52         bool fLocked;
  53         jack_port_id_t fTied;   // Locally tied source port
  54
  55         float fBuffer[BUFFER_SIZE_MAX];
  56
  57         bool IsUsed() const;
  58
  59                 static void MixBuffer(float* mixbuffer, float* buffer, jack_nframes_t frames);
  60
  61     public:
  62
  63         JackPort();
  64         virtual ~JackPort();
  65
  66         void Allocate(int refnum, const char* port_name, JackPortFlags flags);
  67         void Release();
  68         const char* GetName() const;
  69         const char* GetShortName() const;
  70         int     SetName(const char * name);
  71
  72         int     Flags() const;
  73         const char* Type() const;
  74
  75         int Lock();
  76         int Unlock();
  77
  78         int Tie(jack_port_id_t port_index);
  79         int UnTie();
  80
  81         jack_nframes_t GetLatency() const;
  82         void SetLatency(jack_nframes_t latency);
  83
  84         int RequestMonitor(bool onoff);
  85         int EnsureMonitor(bool onoff);
  86         bool MonitoringInput();
  87
  88         float* GetBuffer();
  89         int GetRefNum() const;
  90
  91 };
  92
  93
  94 } // end of namespace
  95
  96
  97 #endif
  98