// ================================================================================================
// 
// This file is part of the CAMPVis Software Framework.
// 
// If not explicitly stated otherwise: Copyright (C) 2012-2015, all rights reserved,
//      Christian Schulte zu Berge <christian.szb@in.tum.de>
//      Chair for Computer Aided Medical Procedures
//      Technische Universitaet Muenchen
//      Boltzmannstr. 3, 85748 Garching b. Muenchen, Germany
// 
// For a full list of authors and contributors, please refer to the file "AUTHORS.txt".
// 
// Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file 
// except in compliance with the License. You may obtain a copy of the License at
// 
// http://www.apache.org/licenses/LICENSE-2.0
// 
// Unless required by applicable law or agreed to in writing, software distributed under the 
// License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, 
// either express or implied. See the License for the specific language governing permissions 
// and limitations under the License.
// 
// ================================================================================================

#ifndef STEREOCOMPOSITOR_H__
#define STEREOCOMPOSITOR_H__

#include "core/pipeline/visualizationprocessor.h"
#include "core/properties/datanameproperty.h"
#include "core/properties/numericproperty.h"
#include "core/properties/optionproperty.h"
#include "core/properties/floatingpointproperty.h"

#include "modules/modulesapi.h"

namespace cgt {
    class Shader;
}

namespace campvis {
    /**
     * Combines up two render targets for a left and a right eye into one render target. Supports different modi to compose the two images.
     */
    class CAMPVIS_MODULES_API StereoCompositor : public VisualizationProcessor {
    public:
        enum class StereoCompositingMode {
            SIDEBYSIDE_HORIZ,
            SIDEBYSIDE_VERT,
            INTERLACED_HORIZ,
            INTERLACED_VERT,
            ANAGLYPH_MCALLISTER,
            ANAGLYPH_HALFCOLOR,
            ANAGLYPH_WIMMER
        };

        /**
         * Constructs a new StereoCompositor Processor
         **/
        explicit StereoCompositor(IVec2Property* viewportSizeProp);

        /**
         * Destructor
         **/
        virtual ~StereoCompositor();

        /// \see AbstractProcessor::init
        virtual void init();

        /// \see AbstractProcessor::deinit
        virtual void deinit();

        /**
         * To be used in ProcessorFactory static methods
         */
        static const std::string getId() { return "StereoCompositor"; };
        /// \see AbstractProcessor::getName()
        virtual const std::string getName() const { return getId(); };
        /// \see AbstractProcessor::getDescription()
        virtual const std::string getDescription() const { return "Combines two textures to a stereo image."; };
        /// \see AbstractProcessor::getAuthor()
        virtual const std::string getAuthor() const { return "Jakob Weiss <jakob.weiss@in.tum.de>"; };
        /// \see AbstractProcessor::getProcessorState()
        virtual ProcessorState getProcessorState() const { return AbstractProcessor::TESTING; };

        DataNameProperty p_inputLeft;              ///< image ID for left input image
        DataNameProperty p_inputRight;              ///< image ID for right input image

        DataNameProperty p_outputImage;              ///< image ID for output image

        GenericOptionProperty<StereoCompositingMode> p_compositingMode;

        IVec2Property p_preferredInputViewports; ///< the optimal input viewport size
        FloatProperty p_inputViewportScaling; ///< up/downscaling factor for input viewport, can be used to reduce computational costs

    protected:
        /// \see AbstractProcessor::updateResult
        virtual void updateResult(DataContainer& dataContainer) override;

        /// \see AbstractProcessor::updateShader
        virtual void updateShader() override;

        /// \see AbstractProcessor::updateProperties
        virtual void updateProperties(DataContainer& dataContainer) override;

        cgt::Shader* _shader;                           ///< Shader for slice rendering

        static const std::string loggerCat_;
    };
}

#endif // STEREOCOMPOSITOR_H__