lv_actor.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_ACTOR_H
#define _LV_ACTOR_H

#include <libvisual/lv_defines.h>
#include <libvisual/lv_types.h>
#include <libvisual/lv_video.h>
#include <libvisual/lv_plugin.h>
#include <libvisual/lv_audio.h>

#ifdef __cplusplus

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

namespace LV
{

  class Actor;

  typedef LV::IntrusivePtr<Actor> ActorPtr;

  class LV_API Actor
  {
  public:

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

      Actor (Actor const&) = delete;

      ~Actor ();

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

      VisPluginData* get_plugin ();

      bool realize ();

      SongInfo const* get_songinfo ();

      Palette const* get_palette ();

      bool video_negotiate (VisVideoDepth run_depth, bool noevent, bool forced);

      VisVideoDepth get_supported_depths ();

      VisVideoAttrOptions const* get_video_attribute_options ();

      void set_video (VideoPtr const& video);

      VideoPtr const& get_video ();

      void run (Audio const& audio);

  private:

      friend void intrusive_ptr_add_ref (Actor const* actor);
      friend void intrusive_ptr_release (Actor const* actor);

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

      mutable unsigned int m_ref_count;

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

  inline void intrusive_ptr_add_ref (Actor const* actor)
  {
      actor->m_ref_count++;
  }

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

} // LV namespace

typedef LV::Actor VisActor;

#else

typedef struct _VisActor VisActor;
struct _VisActor;

#endif /* __cplusplus */

typedef void (*VisPluginActorRequisitionFunc)(VisPluginData *plugin, int *width, int *height);

typedef VisPalette *(*VisPluginActorPaletteFunc)(VisPluginData *plugin);

typedef void (*VisPluginActorRenderFunc)(VisPluginData *plugin, VisVideo *video, VisAudio *audio);

typedef struct _VisActorPlugin VisActorPlugin;
struct _VisActorPlugin {
    VisPluginActorRequisitionFunc requisition;    
    VisPluginActorPaletteFunc     palette;        
    VisPluginActorRenderFunc      render;         
    VisSongInfo                  *songinfo;       
    VisVideoAttrOptions           vidoptions;     
};

LV_BEGIN_DECLS

LV_API VisPluginData *visual_actor_get_plugin (VisActor *actor);

LV_API const char *visual_actor_get_prev_by_name_gl   (const char *name);
LV_API const char *visual_actor_get_next_by_name_gl   (const char *name);
LV_API const char *visual_actor_get_prev_by_name_nogl (const char *name);
LV_API const char *visual_actor_get_next_by_name_nogl (const char *name);
LV_API const char *visual_actor_get_prev_by_name      (const char *name);
LV_API const char *visual_actor_get_next_by_name      (const char *name);

LV_API VisActor *visual_actor_new     (const char *name);
LV_API int       visual_actor_realize (VisActor *actor);
LV_API void      visual_actor_run     (VisActor *actor, VisAudio *audio);
LV_API void      visual_actor_ref     (VisActor *actor);
LV_API void      visual_actor_unref   (VisActor *actor);

LV_API VisSongInfo *visual_actor_get_songinfo (VisActor *actor);
LV_API VisPalette  *visual_actor_get_palette  (VisActor *actor);

LV_API VisVideoDepth        visual_actor_get_supported_depths        (VisActor *actor);
LV_API VisVideoAttrOptions *visual_actor_get_video_attribute_options (VisActor *actor);

LV_API void      visual_actor_set_video (VisActor *actor, VisVideo *video);
LV_API VisVideo *visual_actor_get_video (VisActor *actor);

LV_API int visual_actor_video_negotiate (VisActor *actor, VisVideoDepth run_depth, int noevent, int forced);

LV_END_DECLS

#endif /* _LV_ACTOR_H */