ImageOperation.hpp

/*
 *  Copyright 2011, 2012 Lukas Jirkovsky
 *
 *  This file is part of FotoSHOCKcore.
 *
 *  FotoSHOCKcore 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, version 3 of the License.
 *
 *  FotoSHOCKcore 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 FotoSHOCKcore.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef IMAGEOPERATION_H
#define IMAGEOPERATION_H

#include "MipMap.hpp"
#include "UpdateInfo.hpp"
#include "FixedArray.hpp"
#include "serialization/XmlSerializer.hpp"

#include <boost/shared_ptr.hpp>
#include <vector>
#include <utility>

using std::vector;

namespace FotoSHOCKcore {


class InputProto {
    public:

        int addInput(PixelData dataFormat);


        const std::size_t size() const;
    private:
        std::vector<PixelData> inputDataFormats;
};


class OutputProto {
    public:

        int addOutput(PixelData dataFormat);

        const std::size_t size() const;
    private:
        std::vector<PixelData> outputDataFormats;
};

typedef FixedArray<MipMap*> Inputs;
typedef FixedArray<MipMap*> Outputs;


class ImageOperationDescriptor {
    public:
        ImageOperationDescriptor();

        virtual ~ImageOperationDescriptor();

        enum ImageOperationType {
            TypeNone,

            TypeRoot,
            TypeNorm,

            TypePreview,
            TypeConvertFormat
        };


        virtual const char* name() = 0;

        virtual const char* description() = 0;

        uint64_t id();

        virtual InputProto inputPrototype();

        // TODO: support multiple outputs
        virtual OutputProto outputPrototype();
        

        virtual ImageOperationType operationType();


        virtual ImageOperation* operation() = 0;

        // TODO: versioning
};


class ImageOperation {
    public:
        friend class GraphNode;


        ImageOperation();
        virtual ~ImageOperation();


        GraphNode* getOwnerNode() const;


        virtual void initialize();


        virtual bool isPrepared();


        virtual void runOperation(const Inputs& sources, const Outputs& dest, vector<UpdateInfo>& ROI, const long stamp) = 0;


        virtual bool updateROI(UpdateInfo& currentROI, UpdateInfo& parentROI);
        

        boost::shared_ptr<UpdateInfo> requestROI(boost::shared_ptr<UpdateInfo> currentROI);


        virtual void serialize(XmlSerializer& serializer);


        virtual void deserialize(XmlSerializer& serializer);
    protected:

        void setOwnerNode(GraphNode* node);
    private:
        // used to access the ROI and force redraw
        GraphNode* m_parentNode;
};

}

#endif