importer.h

Go to the documentation of this file.

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

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

#ifndef __SYNFIG_IMPORTER_H
#define __SYNFIG_IMPORTER_H

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

#include <cstdio>
#include <map>
#include <ETL/handle>
#include "string.h"
#include "time.h"
#include "gamma.h"
#include "renddesc.h"
#include "filesystem.h"

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

#define SYNFIG_IMPORTER_MODULE_EXT \
        public: static const char name__[], version__[], ext__[],cvs_id__[]; \
        static const bool supports_file_system_wrapper__; \
        static synfig::Importer *create(const synfig::FileSystem::Identifier &identifier);

#define SYNFIG_IMPORTER_MODULE_CONSTRUCTOR_DERIVED(class, parent) \
        public: class(const synfig::FileSystem::Identifier &identifier): parent(identifier) { }

#define SYNFIG_IMPORTER_MODULE_CONSTRUCTOR(class) \
        SYNFIG_IMPORTER_MODULE_CONSTRUCTOR_DERIVED(class, synfig::Importer)

#define SYNFIG_IMPORTER_MODULE_DECLARATIONS_DERIVED(class, parent) \
        SYNFIG_IMPORTER_MODULE_EXT \
        SYNFIG_IMPORTER_MODULE_CONSTRUCTOR_DERIVED(class, parent)

#define SYNFIG_IMPORTER_MODULE_DECLARATIONS(class) \
        SYNFIG_IMPORTER_MODULE_EXT \
        SYNFIG_IMPORTER_MODULE_CONSTRUCTOR(class)

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

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

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

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

#define SYNFIG_IMPORTER_SET_SUPPORTS_FILE_SYSTEM_WRAPPER(class,x) const bool class::supports_file_system_wrapper__=x

#define SYNFIG_IMPORTER_INIT(class) synfig::Importer* class::create(const synfig::FileSystem::Identifier &identifier) { return new class(identifier); }

/* === 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 ProgressCallback;

class Importer : public etl::shared_object
{
public:
    typedef Importer* (*Factory)(const FileSystem::Identifier &identifier);

    struct BookEntry
    {
        Factory factory;
        bool supports_file_system_wrapper;

        BookEntry(): factory(NULL), supports_file_system_wrapper(false) { }
        BookEntry(Factory factory, bool supports_file_system_wrapper):
        factory(factory), supports_file_system_wrapper(supports_file_system_wrapper)
        { }
    };

    typedef std::map<std::string,BookEntry> Book;
    static Book* book_;

    static Book& book();

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

    typedef etl::handle<Importer> Handle;
    typedef etl::loose_handle<Importer> LooseHandle;
    typedef etl::handle<const Importer> ConstHandle;

private:
    Gamma gamma_;

protected:

    Importer(const FileSystem::Identifier &identifier);

public:
    const FileSystem::Identifier identifier;

    Gamma& gamma() { return gamma_; }
    const Gamma& gamma()const { return gamma_; }

    virtual ~Importer();


    virtual bool get_frame(Surface &surface, const RendDesc &renddesc, Time time, ProgressCallback *callback=NULL)=0;
    virtual bool get_frame(Surface &surface, const RendDesc &renddesc,Time time,
                           bool &trimmed __attribute__ ((unused)),
                           unsigned int &width __attribute__ ((unused)),
                           unsigned int &height __attribute__ ((unused)),
                           unsigned int &top __attribute__ ((unused)),
                           unsigned int &left __attribute__ ((unused)),
                           ProgressCallback *callback=NULL)
    {
        return get_frame(surface,renddesc,time,callback);
    }

    virtual bool is_animated() { return false; }

    static Handle open(const FileSystem::Identifier &identifier);
};

}; // END of namespace synfig

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

#endif