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_FORMATWRITER_H
#define OME_BIOFORMATS_FORMATWRITER_H

#include <set>
#include <string>
#include <vector>
#include <map>

#include <boost/optional.hpp>

#include <ome/bioformats/CoreMetadata.h>
#include <ome/bioformats/FileInfo.h>
#include <ome/bioformats/FormatHandler.h>
#include <ome/bioformats/MetadataConfigurable.h>
#include <ome/bioformats/MetadataMap.h>
#include <ome/bioformats/Types.h>

#include <ome/compat/array.h>

#include <ome/xml/meta/MetadataRetrieve.h>

namespace ome
{
  namespace bioformats
  {

    class VariantPixelBuffer;

    class FormatWriter : virtual public FormatHandler
    {
    public:
      typedef uint16_t frame_rate_type;

    protected:
      class SaveSeries
      {
      private:
        const FormatWriter& writer;
        dimension_size_type series;

      public:
        SaveSeries(const FormatWriter& writer):
          writer(writer),
          series(writer.getSeries())
        {}

        ~SaveSeries()
        {
          try
            {
              if (series != writer.getSeries())
                writer.setSeries(series);
            }
          catch (...)
            {
              // We can't throw in a destructor.
            }
        }
      };

    protected:
      FormatWriter()
      {}

    private:
      FormatWriter (const FormatWriter&);

      FormatWriter&
      operator= (const FormatWriter&);

    public:
      virtual
      ~FormatWriter()
      {}

      virtual
      void
      setLookupTable(const VariantPixelBuffer& buf) = 0;

      virtual
      void
      saveBytes(dimension_size_type no,
                VariantPixelBuffer& buf) = 0;

      virtual
      void
      saveBytes(dimension_size_type no,
                VariantPixelBuffer& buf,
                dimension_size_type x,
                dimension_size_type y,
                dimension_size_type w,
                dimension_size_type h) = 0;

      virtual
      void
      setSeries(dimension_size_type no) const = 0;

      virtual
      dimension_size_type
      getSeries() const = 0;

      virtual
      bool
      canDoStacks() const = 0;

      virtual
      void
      setMetadataRetrieve(ome::compat::shared_ptr< ::ome::xml::meta::MetadataRetrieve>& retrieve) = 0;

      virtual
      const ome::compat::shared_ptr< ::ome::xml::meta::MetadataRetrieve>&
      getMetadataRetrieve() const = 0;

      virtual
      ome::compat::shared_ptr< ::ome::xml::meta::MetadataRetrieve>&
      getMetadataRetrieve() = 0;

      virtual
      void
      setFramesPerSecond(frame_rate_type rate) = 0;

      virtual
      frame_rate_type
      getFramesPerSecond() const = 0;

      virtual
      const std::set<ome::xml::model::enums::PixelType>&
      getPixelTypes() const = 0;

      virtual
      const std::set<ome::xml::model::enums::PixelType>&
      getPixelTypes(const std::string& codec) const = 0;

      virtual
      bool
      isSupportedType(ome::xml::model::enums::PixelType type) const = 0;

      virtual
      bool
      isSupportedType(ome::xml::model::enums::PixelType type,
                      const std::string&                codec) const = 0;

      virtual
      const std::set<std::string>&
      getCompressionTypes() const  = 0;

      virtual
      void
      setCompression(const std::string& compression) = 0;

      virtual
      const boost::optional<std::string>&
      getCompression() const = 0;

      virtual
      void
      changeOutputFile(const boost::filesystem::path& id) = 0;

      virtual
      void
      setWriteSequentially(bool sequential = true) = 0;

      virtual
      bool
      getWriteSequentially() const = 0;
    };

  }
}

#endif // OME_BIOFORMATS_FORMATWRITER_H

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