Canvas.hpp

Go to the documentation of this file.

#ifndef CANVAS_HPP
#define CANVAS_HPP
/*
This file is part of AlgAudio.

AlgAudio, Copyright (C) 2015 CeTA - Audiovisual Technology Center

AlgAudio is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.

AlgAudio 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 Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License
along with AlgAudio.  If not, see <http://www.gnu.org/licenses/>.
*/

#include <memory>
#include <set>
#include "Module.hpp"
#include "Utilities.hpp"

namespace AlgAudio{

namespace Exceptions{
struct MultipleConnections : public Exception{
  MultipleConnections(std::string t) : Exception(t) {}
};
struct ConnectionLoop : public Exception{
  ConnectionLoop(std::string t) : Exception(t) {}
};
struct DoubleConnection : public Exception{
  DoubleConnection(std::string t) : Exception(t) {}
};
} // namespace Exceptions

class Canvas : public std::enable_shared_from_this<Canvas>{
public:
  static LateReturn<std::shared_ptr<Canvas>> CreateEmpty(std::shared_ptr<Canvas> parent);

  virtual ~Canvas();
  
  std::shared_ptr<Group> GetGroup() const {return group;}
  
  LateReturn<std::shared_ptr<Module>> CreateModule(std::string id);
  void RemoveModule(std::shared_ptr<Module>);

  std::set<std::shared_ptr<Module>> modules;

  std::shared_ptr<Module> owner_hint = nullptr;
  
  struct IOID{
    std::shared_ptr<Module> module;
    std::string iolet;
    bool operator<(const IOID& other) const {return (module==other.module)?(iolet<other.iolet):(module<other.module);}
    bool operator==(const IOID& other) const {return (module==other.module)?(iolet==other.iolet):false;}
  };
  std::shared_ptr<Module::Inlet >  GetInletByIOID(IOID) const;
  std::shared_ptr<Module::Outlet> GetOutletByIOID(IOID) const;
  
  // === AUDIO CONNECTIONS ====
  
  void Connect(IOID from, IOID to);
  bool GetDirectAudioConnectionExists(IOID from, IOID to);
  void Disconnect(IOID from, IOID to);

  bool TestNewConnectionForLoop(IOID from, IOID to);
  std::list<std::shared_ptr<Module>> GetConnectedModules(std::shared_ptr<Module> m);

  void RecalculateOrder();
  void BlockReordering(bool enable);
  
  /*The list of all audio connections "from-to", in the format of one-to-many. */
  std::map<IOID, std::list<IOID>> audio_connections;
  
  // === DATA CONNECTIONS ====
  
  enum class DataConnectionMode{
    Relative, 
    Absolute
  };
    
  void ConnectData(IOID from, IOID to, DataConnectionMode m);
  std::pair<bool, DataConnectionMode>  GetDirectDataConnectionExists(IOID from, IOID to);
  void DisconnectData(IOID from, IOID to);
  
  struct IOIDWithMode{
    IOID ioid;
    mutable DataConnectionMode mode;
    bool operator==(const IOIDWithMode& other) const {return ioid == other.ioid; /* Ignore modes for comparison. */}
  };
  std::map<IOID, std::list<IOIDWithMode>> data_connections;

private:
  Canvas();

  std::shared_ptr<Group> group;
  
  std::weak_ptr<Canvas> parent;
  
  std::map<IOID, Subscription> data_connections_subscriptions;
  void PassData(IOID source, float value, float relative);
  bool do_not_recalculate_ordering;
};

} // namespace AlgAudio

#endif //CANVAS_HPP