lv_input.h

/* Libvisual - The audio visualisation framework.
 *
 * Copyright (C) 2012      Libvisual team
 *               2004-2006 Dennis Smit
 *
 * Authors: Dennis Smit <ds@nerds-incorporated.org>
 *          Chong Kai Xiong <kaixiong@codeleft.sg>
 *
 * This program 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 2.1
 * of the License, or (at your option) any later version.
 *
 * This program 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 this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 */

#ifndef _LV_INPUT_H
#define _LV_INPUT_H

#include <libvisual/lv_audio.h>
#include <libvisual/lv_plugin.h>

#ifdef __cplusplus

#include <libvisual/lv_intrusive_ptr.hpp>
#include <memory>

namespace LV {

  class Input;

  typedef LV::IntrusivePtr<Input> InputPtr;

  class LV_API Input
  {
  public:

      static InputPtr load (std::string const& name);

      ~Input ();

      VisPluginData* get_plugin ();

      bool realize ();

      void set_callback (std::function<bool (Audio&)> const& callback);

      Audio const& get_audio ();

      bool run ();

  private:

      friend void intrusive_ptr_add_ref (Input const* input);
      friend void intrusive_ptr_release (Input const* input);

      class Impl;
      const std::unique_ptr<Impl> m_impl;

      mutable unsigned int m_ref_count;

      explicit Input (std::string const& name);
  };

  inline void intrusive_ptr_add_ref (Input const* input)
  {
      input->m_ref_count++;
  }

  inline void intrusive_ptr_release (Input const* input)
  {
      if (--input->m_ref_count == 0) {
          delete input;
      }
  }

} // LV namespace

typedef LV::Input VisInput;

#else

typedef struct _VisInput VisInput;
struct _VisInput;

#endif /* __cplusplus */

typedef struct _VisInputPlugin VisInputPlugin;

typedef int (*VisInputUploadCallbackFunc)(VisInput *input, VisAudio *audio, void *user_data);

typedef int (*VisPluginInputUploadFunc)(VisPluginData *plugin, VisAudio *audio);

struct _VisInputPlugin {
    VisPluginInputUploadFunc upload;    
};

LV_BEGIN_DECLS

LV_API VisInput *visual_input_new     (const char *name);
LV_API void      visual_input_ref     (VisInput *input);
LV_API void      visual_input_unref   (VisInput *input);
LV_API int       visual_input_realize (VisInput *input);
LV_API int       visual_input_run     (VisInput *input);

LV_API VisPluginData *visual_input_get_plugin  (VisInput *input);
LV_API VisAudio      *visual_input_get_audio    (VisInput *audio);
LV_API void           visual_input_set_callback (VisInput *input, VisInputUploadCallbackFunc callback, void *user_data);

LV_API const char *visual_input_get_next_by_name (const char *name);

LV_API const char *visual_input_get_prev_by_name (const char *name);

LV_END_DECLS

#endif /* _LV_INPUT_H */