target.h

Go to the documentation of this file.

/* === S Y N F I G ========================================================= */
/* ========================================================================= */

/* === S T A R T =========================================================== */

#ifndef __SYNFIG_TARGET_H
#define __SYNFIG_TARGET_H

/* === H E A D E R S ======================================================= */

#include <sigc++/signal.h>
#include "string.h"
#include <utility>
#include <map>
#include <ETL/handle>
#include "renddesc.h"
#include "color.h"
#include "canvas.h"
#include "targetparam.h"

/* === M A C R O S ========================================================= */

#define SYNFIG_TARGET_MODULE_EXT \
        public: static const char name__[], version__[], ext__[], cvs_id__[];\
        static Target* create (const char *filename, synfig::TargetParam p);

#define SYNFIG_TARGET_SET_NAME(class,x) const char class::name__[]=x

#define SYNFIG_TARGET_SET_EXT(class,x) const char class::ext__[]=x

#define SYNFIG_TARGET_SET_VERSION(class,x) const char class::version__[]=x

#define SYNFIG_TARGET_SET_CVS_ID(class,x) const char class::cvs_id__[]=x

#define SYNFIG_TARGET_INIT(class)                                       \
    synfig::Target* class::create (const char *filename,                \
                                   synfig::TargetParam p)               \
    { return new class(filename, p); }

/* === T Y P E D E F S ===================================================== */

/* === C L A S S E S & S T R U C T S ======================================= */

namespace synfig {

class Surface;
class CairoSurface;
class RendDesc;
class Canvas;
class ProgressCallback;
struct TargetParam;

enum TargetAlphaMode
{
    TARGET_ALPHA_MODE_KEEP,          // 0
    TARGET_ALPHA_MODE_FILL,          // 1
    TARGET_ALPHA_MODE_REDUCE,        // 2
    TARGET_ALPHA_MODE_EXTRACT        // 3
}; // END enum TargetAlphaMode

class Target : public etl::shared_object
{
public:
    typedef etl::handle<Target> Handle;
    typedef etl::loose_handle<Target> LooseHandle;
    typedef etl::handle<const Target> ConstHandle;

    /*
 -- ** -- S I G N A L S -------------------------------------------------------
    */

private:

    sigc::signal<void> signal_progress_;

    /*
 -- ** -- S I G N A L   I N T E R F A C E -------------------------------------
    */

public:

    sigc::signal<void>& signal_progress() { return signal_progress_; }

    /*
 -- ** -- C O N S T R U C T O R S ---------------------------------------------
    */

public:

    typedef Target* (*Factory)(const char *filename, TargetParam p);

    struct BookEntry
    {
        Factory factory;
        String filename; 
        TargetParam target_param; 
    };

    typedef std::map<String,BookEntry> Book;

    typedef std::map<String,String> ExtBook;

    static Book* book_;

    static ExtBook* ext_book_;

    static Book& book();
    static ExtBook& ext_book();

    static bool subsys_init();
    static bool subsys_stop();

    RendDesc desc;


    etl::handle<Canvas> canvas;

    int quality_;
    Gamma gamma_;
    
    TargetAlphaMode alpha_mode;

    bool avoid_time_sync_;
    
    int curr_frame_;

protected:
    Target();

public:
    virtual ~Target() { }
    int get_quality()const { return quality_; }
    void set_quality(int q) { quality_=q; }
    void set_avoid_time_sync(bool x=true) { avoid_time_sync_=x; }
    bool get_avoid_time_sync()const { return avoid_time_sync_; }

    TargetAlphaMode get_alpha_mode()const { return alpha_mode; }
    void set_alpha_mode(TargetAlphaMode x=TARGET_ALPHA_MODE_KEEP) { alpha_mode=x; }
    Gamma &gamma() { return gamma_; }
    const Gamma &gamma()const { return gamma_; }
    virtual void set_canvas(etl::handle<Canvas> c);
    const etl::handle<Canvas> &get_canvas()const { return canvas; }
    RendDesc &rend_desc() { return desc; }
    const RendDesc &rend_desc()const { return desc; }

    virtual bool set_rend_desc(RendDesc *d) { desc=*d; return true; }
    virtual bool render(ProgressCallback *cb=NULL)=0;

    virtual bool init(ProgressCallback *cb=NULL) { (void)cb; return true; }

    static Handle create(const String &type, const String &filename,
                         synfig::TargetParam params);
    

    virtual int next_frame(Time& time);
}; // END of class Target

}; // END of namespace synfig

/* === E N D =============================================================== */

#endif