lv_morph.h

/* Libvisual - The audio visualisation framework.
 *
 * Copyright (C) 2012      Libvisual team
 *               2004-2006 Dennis Smit
 *
 * Authors: Dennis Smit <ds@nerds-incorporated.org>
 *
 * 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_MORPH_H
#define _LV_MORPH_H

#include <libvisual/lv_audio.h>
#include <libvisual/lv_palette.h>
#include <libvisual/lv_plugin.h>
#include <libvisual/lv_video.h>
#include <libvisual/lv_time.h>

#ifdef __cplusplus

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

namespace LV {

  class Morph;

  typedef LV::IntrusivePtr<Morph> MorphPtr;

  class LV_API Morph
  {
  public:

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

      Morph (Morph const& morph) = delete;

      ~Morph ();

      Morph& operator= (Morph const&) = delete;

      VisPluginData* get_plugin ();

      bool realize ();

      VisVideoDepth get_supported_depths ();

      VisVideoAttrOptions const* get_video_attribute_options ();

      void set_video (VideoPtr const& video);

      void set_time (Time const& time);

      void set_progress (float progress);

      Palette const* get_palette ();

      bool is_done ();

      bool run (Audio const& audio, VideoPtr const& src1, VideoPtr const& src2);

private:

      friend void intrusive_ptr_add_ref (Morph const* morph);
      friend void intrusive_ptr_release (Morph const* morph);

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

      mutable unsigned int m_ref_count;

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

  inline void intrusive_ptr_add_ref (Morph const* morph)
  {
      morph->m_ref_count++;
  }

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

} // LV namespace

typedef LV::Morph VisMorph;

#else

typedef struct _VisMorph VisMorph;
struct _VisMorph;

#endif

typedef struct _VisMorphPlugin VisMorphPlugin;

typedef void (*VisPluginMorphPaletteFunc) (VisPluginData *plugin,
                                           float          progress,
                                           VisAudio      *audio,
                                           VisPalette    *palette,
                                           VisVideo      *src1,
                                           VisVideo      *src2);

typedef void (*VisPluginMorphApplyFunc) (VisPluginData *plugin,
                                         float          progress,
                                         VisAudio      *audio,
                                         VisVideo      *dest,
                                         VisVideo      *src1,
                                         VisVideo      *src2);

struct _VisMorphPlugin {
    VisPluginMorphPaletteFunc palette;        
    VisPluginMorphApplyFunc   apply;          
    int                       requests_audio; 
    VisVideoAttrOptions       vidoptions;
};

LV_BEGIN_DECLS

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

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

LV_API VisMorph *visual_morph_new   (const char *name);
LV_API void      visual_morph_ref   (VisMorph *morph);
LV_API void      visual_morph_unref (VisMorph *morph);

LV_API VisPluginData       *visual_morph_get_plugin                  (VisMorph *morph);
LV_API VisVideoDepth        visual_morph_get_supported_depths        (VisMorph *morph);
LV_API VisVideoAttrOptions *visual_morph_get_video_attribute_options (VisMorph *morph);
LV_API int                  visual_morph_requests_audio              (VisMorph *morph);

LV_API void visual_morph_set_video    (VisMorph *morph, VisVideo *video);
LV_API void visual_morph_set_time     (VisMorph *morph, VisTime *time);
LV_API void visual_morph_set_progress (VisMorph *morph, float progress);

LV_API int visual_morph_realize (VisMorph *morph);
LV_API int visual_morph_run     (VisMorph *morph, VisAudio *audio, VisVideo *src1, VisVideo *src2);
LV_API int visual_morph_is_done (VisMorph *morph);

LV_API VisPalette *visual_morph_get_palette (VisMorph *morph);

LV_END_DECLS

#endif /* _LV_MORPH_H */