// -*- c-basic-offset: 4 -*-
/** @file 
*
*  @author Ippei UKAI <ippei_ukai@mac.com>
*
*  $Id: StitcherAlgorithm.h 2510 2007-10-28 22:24:11Z dangelo $
*
*  This is free software; you can redistribute it and/or
*  modify it under the terms of the GNU General Public
*  License as published by the Free Software Foundation; either
*  version 2 of the License, or (at your option) any later version.
*
*  This software 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
*  General Public License for more details.
*
*  You should have received a copy of the GNU General Public License
*  along with this software; if not, write to the Free Software
*  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1307, USA.
*
*  Hereby the author, Ippei UKAI, grant the license of this particular file to
*  be relaxed to the GNU Lesser General Public License as published by the Free
*  Software Foundation; either version 2 of the License, or (at your option)
*  any later version. Please note however that when the file is linked to or
*  compiled with other files in this library, the GNU General Public License as
*  mentioned above is likely to restrict the terms of use further.
*
*/


#ifndef _ALGORITHM_STITCHERALGORITHM_H
#define _ALGORITHM_STITCHERALGORITHM_H


#include <algorithm/PanoramaAlgorithm.h>

#include <vigra/impex.hxx>
#include <panodata/PanoramaData.h>


namespace HuginBase {

    
    /// Just a conceptual base class...
    class StitcherAlgorithm : public TimeConsumingPanoramaAlgorithm
    {

    public:
        ///
        StitcherAlgorithm(PanoramaData& panoramaData,
                          AppBase::ProgressDisplay* progressDisplay,
                          const PanoramaOptions& options,
                          const UIntSet& usedImages)
            : TimeConsumingPanoramaAlgorithm(panoramaData, progressDisplay),
              o_panoramaOptions(options), o_usedImages(usedImages)
        {};
        
    public:
        ///
        virtual ~StitcherAlgorithm() {};
        
        
    public:
        /// 
        virtual bool runAlgorithm()
            { return runStitcher(); }
        
        /// returns flase, hope this is correct
        virtual bool modifiesPanoramaData() const { return false; };
    
    protected:
        ///
        virtual bool runStitcher() =0;
        
        
    protected:
        PanoramaOptions o_panoramaOptions;
        UIntSet o_usedImages;
    };
    
    
    
    /// stitch to file output
    class ImageStitcherAlgorithm : public StitcherAlgorithm
    {
    
    public:
        typedef vigra::FRGBImage DestImage;
        typedef vigra::BImage DestAlpha;
        
        ///
        ImageStitcherAlgorithm(PanoramaData& panoramaData,
                               AppBase::ProgressDisplay* progressDisplay,
                               const PanoramaOptions& options,
                               const UIntSet& usedImages,
                               DestImage& panoImage, DestAlpha& alpha)
        : StitcherAlgorithm(panoramaData, progressDisplay, options, usedImages), 
          o_panoImage(panoImage), o_alpha(alpha)
        {};
        
    public:
        ///
        virtual ~ImageStitcherAlgorithm() {};

    
    protected:
        DestImage& o_panoImage;
        DestAlpha& o_alpha;
    };
    
    
    /// stitch to file output
    class FileOutputStitcherAlgorithm : public StitcherAlgorithm
    {
        
    public:
        typedef std::string String;
        
        ///
        FileOutputStitcherAlgorithm(PanoramaData& panoramaData,
                                    AppBase::ProgressDisplay* progressDisplay,
                                    const PanoramaOptions& options,
                                    const UIntSet& usedImages,
                                    const String& filename, const bool& addExtension = true)
        : StitcherAlgorithm(panoramaData, progressDisplay, options, usedImages), 
          o_filename(filename)
        {};
        
    public:
        ///
        virtual ~FileOutputStitcherAlgorithm() {};
        
        
    
    protected:
        String o_filename;
    };
    

    // parent class does not have a default constructor, leads to compiler errors
#if 0
    /** reserved for future use; allows more control over the filenames of output. 
     * the current implementation is identical to that of FileOutputStitcherAlgorithm.
     */
    class MultiFileOutputStitcherAlgorithm : public FileOutputStitcherAlgorithm
    {
        public:
        ///
        virtual ~MultiFileOutputStitcherAlgorithm() {};
    };
#endif
    
} // namespace
#endif // _H
