purezen 0.0.2

Runtime for the Pure Data (Pd) audio programming language, implemented as an extensible audio library allowing full control over signal processing, message passing, and graph manipulation. Pure Data is a graph-based programming language environment creating interactive music and multimedia works.
Documentation
/*
 *  Copyright 2009,2010,2011 Reality Jockey, Ltd.
 *                 info@rjdj.me
 *                 http://rjdj.me/
 * 
 *  This file is part of ZenGarden.
 *
 *  ZenGarden 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.
 *
 *  ZenGarden 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 ZenGarden.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef _MESSAGE_DELAY_H_
#define _MESSAGE_DELAY_H_

#include "MessageObject.h"

/**
 * [delay float]
 * A delay only has one outstanding message at any time. If a scheduled message already exists
 * and a new message is sent into the object, then the previously scheduled message will be cancelled
 * and the new one rescheduled. For a generalised delay line, use the pipe (<code>MessagePipe</code>)
 * object.
 */
class MessageDelay : public MessageObject {
  
  public:
    static MessageObject *new_object(PdMessage *init_message, PdGraph *graph);
    MessageDelay(PdMessage *init_message, PdGraph *graph);
    ~MessageDelay();
  
    static const char *get_object_label();
    std::string toString();
  
    void sendMessage(int outlet_index, PdMessage *message);
    
  private:
    void process_message(int inlet_index, PdMessage *message);
  
    void cancelScheduledMessageIfExists();
  
    double delayMs;
    PdMessage *scheduledMessage;
};

inline const char *MessageDelay::get_object_label() {
  return "delay";
}

inline std::string MessageDelay::toString() {
  return MessageDelay::get_object_label();
}

#endif // _MESSAGE_DELAY_H_