libs/midi++2/midi++/manager.h

   1 /*
   2     Copyright (C) 1998 Paul Barton-Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 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 General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #ifndef __midi_manager_h__
  21 #define __midi_manager_h__
  22
  23 #include <map>
  24 #include <string>
  25
  26 #include <midi++/types.h>
  27 #include <midi++/port.h>
  28
  29 namespace MIDI {
  30
  31 /** Creates, stores, and manages system MIDI ports.
  32  */
  33 class Manager {
  34   public:
  35         ~Manager ();
  36
  37         void set_api_data(void* data) { api_data = data; }
  38
  39         /** Signal the start of an audio cycle.
  40          * This MUST be called before any reading/writing for this cycle.
  41          * Realtime safe.
  42          */
  43         void cycle_start(nframes_t nframes);
  44
  45         /** Signal the end of an audio cycle.
  46          * This signifies that the cycle began with @ref cycle_start has ended.
  47          * This MUST be called at the end of each cycle.
  48          * Realtime safe.
  49          */
  50         void cycle_end();
  51
  52         Port *add_port (PortRequest &);
  53         int   remove_port (std::string port);
  54
  55         Port *port (std::string name);
  56         Port *port (size_t number);
  57
  58         size_t    nports () { return ports_by_device.size(); }
  59
  60         int foreach_port (int (*func)(const Port &, size_t n, void *),
  61                           void *arg);
  62
  63         typedef std::map<std::string, Port *> PortMap;
  64
  65         const PortMap& get_midi_ports() const { return ports_by_tag; }
  66
  67         static Manager *instance () {
  68                 if (theManager == 0) {
  69                         theManager = new Manager;
  70                 }
  71                 return theManager;
  72         }
  73
  74         static int parse_port_request (std::string str, Port::Type type);
  75
  76   private:
  77         /* This is a SINGLETON pattern */
  78
  79         Manager ();
  80
  81         static Manager *theManager;
  82         PortMap         ports_by_device; /* canonical */
  83         PortMap         ports_by_tag;    /* may contain duplicate Ports */
  84
  85         void *api_data;
  86
  87         void close_ports ();
  88 };
  89
  90 } // namespace MIDI
  91
  92 #endif  // __midi_manager_h__