music_manager.h

Go to the documentation of this file.

/*
 *  music_manager.h
 *
 *  This file is part of NEST.
 *
 *  Copyright (C) 2004 The NEST Initiative
 *
 *  NEST is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  NEST is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with NEST.  If not, see <http://www.gnu.org/licenses/>.
 *
 */
 
#ifndef MUSIC_MANAGER_H
#define MUSIC_MANAGER_H
 
#include "config.h"
 
#ifdef HAVE_MUSIC
#include <music.hh>
#endif
#include <string>
 
// Includes from nestkernel:
#include "manager_interface.h"
#include "nest_types.h"
 
#ifdef HAVE_MUSIC
#include "music_event_handler.h"
#include "music_rate_in_handler.h"
#endif
 
namespace nest
{
 
class MUSICManager : public ManagerInterface
{
public:
  void initialize( const bool ) override;
  void finalize( const bool ) override;
  void set_status( const Dictionary& ) override;
  void get_status( Dictionary& ) override;
 
  MUSICManager();
 
  void init_music( int* argc, char** argv[] );
 
  void enter_runtime( double h_min_delay );
 
  void advance_music_time();
 
  void music_finalize();  // called from MPIManager::mpi_finalize
 
#ifdef HAVE_MUSIC
  MPI_Comm communicator();
 
  MUSIC::Setup* get_music_setup();
  MUSIC::Runtime* get_music_runtime();
 
  void register_music_in_port( std::string portname );
 
  void unregister_music_in_port( std::string portname );
 
  void register_music_event_in_proxy( std::string portname, int channel, Node* mp );
 
  void register_music_rate_in_proxy( std::string portname, int channel, Node* mp );
 
  void set_music_in_port_acceptable_latency( std::string portname, double latency );
  void set_music_in_port_max_buffered( std::string portname, int maxbuffered );
  struct MusicPortData
  {
    MusicPortData( size_t n, double latency, int m )
      : n_input_proxies( n )
      , acceptable_latency( latency )
      , max_buffered( m )
    {
    }
    MusicPortData()
    {
    }
    size_t n_input_proxies;  // Counter for number of music_input proxies
                             // connected to this port
    double acceptable_latency;
    int max_buffered;
  };
 
  std::map< std::string, MusicPortData > music_in_portlist_;
 
  std::map< std::string, MusicEventHandler > music_event_in_portmap_;
  std::map< std::string, MusicRateInHandler > music_rate_in_portmap_;
 
  void publish_music_in_ports_();
 
  void update_music_event_handlers( Time const&, const long, const long );
#endif
 
private:
#ifdef HAVE_MUSIC
  MUSIC::Setup* music_setup;      
  MUSIC::Runtime* music_runtime;  
#endif
};
}
 
 
#endif /* MUSIC_MANAGER_H */