FormatWriter.h

/*
 * #%L
 * OME-BIOFORMATS C++ library for image IO.
 * Copyright © 2006 - 2015 Open Microscopy Environment:
 *   - Massachusetts Institute of Technology
 *   - National Institutes of Health
 *   - University of Dundee
 *   - Board of Regents of the University of Wisconsin-Madison
 *   - Glencoe Software, Inc.
 * %%
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * The views and conclusions contained in the software and documentation are
 * those of the authors and should not be interpreted as representing official
 * policies, either expressed or implied, of any organization.
 * #L%
 */

#ifndef OME_BIOFORMATS_DETAIL_FORMATWRITER_H
#define OME_BIOFORMATS_DETAIL_FORMATWRITER_H

#include <ome/bioformats/FormatWriter.h>
#include <ome/bioformats/FormatHandler.h>

#include <map>

namespace ome
{
  namespace bioformats
  {
    namespace detail
    {

      struct WriterProperties
      {
        typedef std::map<std::string,
                         std::set<ome::xml::model::enums::PixelType> > codec_pixel_type_map;

        std::string name;
        std::string description;
        std::vector<boost::filesystem::path> suffixes;
        std::vector<boost::filesystem::path> compression_suffixes;
        std::set<std::string> compression_types;
        codec_pixel_type_map codec_pixel_types;
        bool stacks;

        WriterProperties(const std::string& name,
                         const std::string& description):
          name(name),
          description(description),
          suffixes(),
          compression_suffixes(),
          compression_types(),
          codec_pixel_types(),
          stacks()
        {
          compression_suffixes.push_back(boost::filesystem::path(""));
        }
      };

      class FormatWriter : public ::ome::bioformats::FormatWriter,
                           virtual public ::ome::bioformats::FormatHandler
      {
      protected:
        const WriterProperties& writerProperties;

        boost::optional<boost::filesystem::path> currentId;

        ome::compat::shared_ptr<std::ostream> out;

        mutable dimension_size_type series;

        mutable dimension_size_type plane;

        boost::optional<std::string> compression;

        boost::optional<bool> interleaved;

        bool sequential;

        frame_rate_type framesPerSecond;

        ome::compat::shared_ptr< ::ome::xml::meta::MetadataRetrieve> metadataRetrieve;

      protected:
        FormatWriter(const WriterProperties&);

      private:
        FormatWriter (const FormatWriter&);

        FormatWriter&
        operator= (const FormatWriter&);

      public:
        virtual
        ~FormatWriter();

        // Documented in superclass.
        bool
        isThisType(const boost::filesystem::path& name,
                   bool                           open = true) const;

        // Documented in superclass.
        void
        setLookupTable(dimension_size_type       plane,
                       const VariantPixelBuffer& buf);

        // Documented in superclass.
        void
        saveBytes(dimension_size_type plane,
                  VariantPixelBuffer& buf);

        // Documented in superclass.
        void
        saveBytes(dimension_size_type plane,
                  VariantPixelBuffer& buf,
                  dimension_size_type x,
                  dimension_size_type y,
                  dimension_size_type w,
                  dimension_size_type h) = 0;

        // Documented in superclass.
        void
        setSeries(dimension_size_type series) const;

        // Documented in superclass.
        dimension_size_type
        getSeries() const;

        virtual void
        setPlane(dimension_size_type plane) const;

        virtual dimension_size_type
        getPlane() const;

        // Documented in superclass.
        bool
        canDoStacks() const;

        // Documented in superclass.
        void
        setMetadataRetrieve(ome::compat::shared_ptr< ::ome::xml::meta::MetadataRetrieve>& retrieve);

        // Documented in superclass.
        const ome::compat::shared_ptr< ::ome::xml::meta::MetadataRetrieve>&
        getMetadataRetrieve() const;

        // Documented in superclass.
        ome::compat::shared_ptr< ::ome::xml::meta::MetadataRetrieve>&
        getMetadataRetrieve();

        virtual
        dimension_size_type
        getImageCount() const;

        virtual
        bool
        isRGB(dimension_size_type channel) const;

        virtual
        dimension_size_type
        getSizeX() const;

        virtual
        dimension_size_type
        getSizeY() const;

        virtual
        dimension_size_type
        getSizeZ() const;

        virtual
        dimension_size_type
        getSizeT() const;

        virtual
        dimension_size_type
        getSizeC() const;

        virtual
        ome::xml::model::enums::PixelType
        getPixelType() const;

        virtual
        pixel_size_type
        getBitsPerPixel() const;

        virtual
        dimension_size_type
        getEffectiveSizeC() const;

        virtual
        dimension_size_type
        getRGBChannelCount(dimension_size_type channel) const;

        virtual
        const std::string&
        getDimensionOrder() const;

        virtual
        dimension_size_type
        getIndex(dimension_size_type z,
                 dimension_size_type c,
                 dimension_size_type t) const;

        virtual
        ome::compat::array<dimension_size_type, 3>
        getZCTCoords(dimension_size_type index) const;

        // Documented in superclass.
        void
        setFramesPerSecond(frame_rate_type rate);

        // Documented in superclass.
        frame_rate_type
        getFramesPerSecond() const;

        // Documented in superclass.
        const std::set<ome::xml::model::enums::PixelType>&
        getPixelTypes() const;

        // Documented in superclass.
        const std::set<ome::xml::model::enums::PixelType>&
        getPixelTypes(const std::string& codec) const;

        // Documented in superclass.
        bool
        isSupportedType(ome::xml::model::enums::PixelType type) const;

        // Documented in superclass.
        bool
        isSupportedType(ome::xml::model::enums::PixelType type,
                        const std::string&                codec) const;

        // Documented in superclass.
        const std::set<std::string>&
        getCompressionTypes() const ;

        // Documented in superclass.
        void
        setCompression(const std::string& compression);

        // Documented in superclass.
        const boost::optional<std::string>&
        getCompression() const;

        // Documented in superclass.
        void
        setInterleaved(bool interleaved);

        // Documented in superclass.
        const boost::optional<bool>&
        getInterleaved() const;

        // Documented in superclass.
        void
        changeOutputFile(const boost::filesystem::path& id);

        // Documented in superclass.
        void
        setWriteSequentially(bool sequential = true);

        // Documented in superclass.
        bool
        getWriteSequentially() const;

        // Documented in superclass.
        void
        setId(const boost::filesystem::path& id);

        // Documented in superclass.
        void
        close(bool fileOnly = false);

        // Documented in superclass.
        const std::string&
        getFormat() const;

        // Documented in superclass.
        const std::string&
        getFormatDescription() const;

        // Documented in superclass.
        const std::vector<boost::filesystem::path>&
        getSuffixes() const;

        // Documented in superclass.
        const std::vector<boost::filesystem::path>&
        getCompressionSuffixes() const;
      };

    }
  }
}

#endif // OME_BIOFORMATS_DETAIL_FORMATWRITER_H

/*
 * Local Variables:
 * mode:C++
 * End:
 */