Tags.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_TIFF_TAGS_H
#define OME_BIOFORMATS_TIFF_TAGS_H

#include <string>
#include <vector>

#include <ome/bioformats/tiff/Types.h>

#include <ome/compat/memory.h>

#include <ome/compat/array.h>
#include <ome/compat/cstdint.h>

namespace ome
{
  namespace bioformats
  {
    namespace tiff
    {

      class TIFF;

      enum StringTag1
        {
          ARTIST,           
          COPYRIGHT,        
          DATETIME,         
          DOCUMENTNAME,     
          HOSTCOMPUTER,     
          IMAGEDESCRIPTION, 
          MAKE,             
          MODEL,            
          PAGENAME,         
          SOFTWARE,         
          TARGETPRINTER     
        };

      enum StringTagArray1
        {
          INKNAMES 
        };

      enum UInt16Tag1
        {
          BITSPERSAMPLE,    
          CELLWIDTH,        
          CELLLENGTH,       
          CLEANFAXDATA,     
          DATATYPE,         
          GRAYRESPONSEUNIT, 
          INDEXED,          
          INKSET,           
          MATTEING,         
          MAXSAMPLEVALUE,   
          MINSAMPLEVALUE,   
          NUMBEROFINKS,     
          RESOLUTIONUNIT,   
          SAMPLESPERPIXEL   
        };

      enum UInt16TagArray1
        {
          GRAYRESPONSECURVE 
        };

      enum UInt16Compression1
        {
          COMPRESSION 
        };

      enum UInt16FillOrder1
        {
          FILLORDER 
        };

      enum UInt16Orientation1
        {
          ORIENTATION 
        };

      enum UInt16PhotometricInterpretation1
        {
          PHOTOMETRIC 
        };

      enum UInt16PlanarConfiguration1
        {
          PLANARCONFIG 
        };

      enum UInt16Predictor1
        {
          PREDICTOR 
        };

      enum UInt16SampleFormat1
        {
          SAMPLEFORMAT 
        };

      enum UInt16Threshholding1
        {
          THRESHHOLDING 
        };

      enum UInt16YCbCrPosition1
        {
          YCBCRPOSITIONING 
        };

      enum UInt16Tag2
        {
          DOTRANGE,        
          HALFTONEHINTS,   
          PAGENUMBER,      
          YCBCRSUBSAMPLING 
        };

      enum UInt16Tag6
        {
          TRANSFERRANGE 
        };

      enum UInt16ExtraSamplesArray1
        {
          EXTRASAMPLES 
        };

      enum UInt16TagArray3
        {
          COLORMAP,        
          TRANSFERFUNCTION 
        };

      enum UInt32Tag1
        {
          BADFAXLINES,            
          CONSECUTIVEBADFAXLINES, 
          GROUP3OPTIONS,          
          GROUP4OPTIONS,          
          IMAGEDEPTH,             
          IMAGELENGTH,            
          IMAGEWIDTH,             
          ROWSPERSTRIP,           
          SUBFILETYPE,            
          T4OPTIONS,              
          T6OPTIONS,              
          TILEDEPTH,              
          TILELENGTH,             
          TILEWIDTH               
        };

      enum UInt32TagArray1
        {
          IMAGEJ_META_DATA_BYTE_COUNTS, 
          RICHTIFFIPTC                  
        };

      enum UInt64TagArray1
        {
          FREEOFFSETS,     
          FREEBYTECOUNTS,  
          SUBIFD,          
          STRIPBYTECOUNTS, 
          STRIPOFFSETS,    
          TILEBYTECOUNTS,  
          TILEOFFSETS      
        };

      enum RawDataTag1
        {
          ICCPROFILE,      
          JPEGTABLES,      
          PHOTOSHOP,       
          XMLPACKET,       
          IMAGEJ_META_DATA 
        };

      enum FloatTag1
        {
          XRESOLUTION, 
          YRESOLUTION, 
          XPOSITION,   
          YPOSITION    
        };

      enum FloatTag2
        {
          WHITEPOINT 
        };

      enum FloatTag3
        {
          YCBCRCOEFFICIENTS 
        };

      enum FloatTag6
        {
          PRIMARYCHROMATICITIES, 
          REFERENCEBLACKWHITE    
        };

      /*
       * Tags which are known but not currently wrapped.
       *
       * OSUBFILETYPE,                ///< Type of data in this subfile [old tag].
       * COLORRESPONSEUNIT,           ///<
       * SMINSAMPLEVALUE,             ///<
       * SMAXSAMPLEVALUE,             ///<
       * CLIPPATH,                    ///<
       * XCLIPPATHUNITS,              ///<
       * YCLIPPATHUNITS,              ///<
       * OPIPROXY,                    ///<
       * GLOBALPARAMETERSIFD,         ///<
       * PROFILETYPE,                 ///<
       * FAXPROFILE,                  ///<
       * CODINGMETHODS,               ///<
       * VERSIONYEAR,                 ///<
       * MODENUMBER,                  ///<
       * DECODE,                      ///<
       * IMAGEBASECOLOR,              ///<
       * T82OPTIONS,                  ///<
       * JPEGPROC,                    ///<
       * JPEGIFOFFSET,                ///<
       * JPEGIFBYTECOUNT,             ///<
       * JPEGRESTARTINTERVAL,         ///<
       * JPEGLOSSLESSPREDICTORS,      ///<
       * JPEGPOINTTRANSFORM,          ///<
       * JPEGQTABLES,                 ///<
       * JPEGDCTABLES,                ///<
       * JPEGACTABLES,                ///<
       * STRIPROWCOUNTS,              ///<
       * OPIIMAGEID,                  ///< Full pathname or identifier of original image (OPI).
       * REFPTS,                      ///<
       * REGIONTACKPOINT,             ///<
       * REGIONWARPCORNERS,           ///<
       * REGIONAFFINE,                ///<
       * PIXAR_IMAGEFULLLENGTH,       ///<
       * PIXAR_IMAGEFULLWIDTH,        ///<
       * PIXAR_TEXTUREFORMAT,         ///<
       * PIXAR_WRAPMODES,             ///<
       * PIXAR_FOVCOT,                ///<
       * PIXAR_MATRIX_WORLDTOSCREEN,  ///<
       * PIXAR_MATRIX_WORLDTOCAMERA,  ///<
       * WRITERSERIALNUMBER,          ///<
       * IT8SITE,                     ///<
       * IT8COLORSEQUENCE,            ///<
       * IT8HEADER,                   ///<
       * IT8RASTERPADDING,            ///<
       * IT8BITSPERRUNLENGTH,         ///<
       * IT8BITSPEREXTENDEDRUNLENGTH, ///<
       * IT8COLORTABLE,               ///<
       * IT8IMAGECOLORINDICATOR,      ///<
       * IT8BKGCOLORINDICATOR,        ///<
       * IT8IMAGECOLORVALUE,          ///<
       * IT8BKGCOLORVALUE,            ///<
       * IT8PIXELINTENSITYRANGE,      ///<
       * IT8TRANSPARENCYINDICATOR,    ///<
       * IT8COLORCHARACTERIZATION,    ///<
       * IT8HCUSAGE,                  ///<
       * IT8TRAPINDICATOR,            ///<
       * IT8CMYKEQUIVALENT,           ///<
       * FRAMECOUNT,                  ///<
       * EXIFIFD,                     ///<
       * IMAGELAYER,                  ///< Background, mask and foreground layers from RFC2301.
       * JBIGOPTIONS,                 ///<
       * GPSIFD,                      ///<
       * FAXRECVPARAMS,               ///<
       * FAXSUBADDRESS,               ///<
       * FAXRECVTIME,                 ///<
       * FAXDCS,                      ///<
       * STONITS,                     ///<
       * FEDEX_EDR,                   ///<
       * INTEROPERABILITYIFD,         ///<
       * DNGVERSION,                  ///<
       * DNGBACKWARDVERSION,          ///<
       * UNIQUECAMERAMODEL,           ///<
       * LOCALIZEDCAMERAMODEL,        ///<
       * CFAPLANECOLOR,               ///<
       * CFALAYOUT,                   ///<
       * LINEARIZATIONTABLE,          ///<
       * BLACKLEVELREPEATDIM,         ///<
       * BLACKLEVEL,                  ///<
       * BLACKLEVELDELTAH,            ///<
       * BLACKLEVELDELTAV,            ///<
       * WHITELEVEL,                  ///<
       * DEFAULTSCALE,                ///<
       * DEFAULTCROPORIGIN,           ///<
       * DEFAULTCROPSIZE,             ///<
       * COLORMATRIX1,                ///<
       * COLORMATRIX2,                ///<
       * CAMERACALIBRATION1,          ///<
       * CAMERACALIBRATION2,          ///<
       * REDUCTIONMATRIX1,            ///<
       * REDUCTIONMATRIX2,            ///<
       * ANALOGBALANCE,               ///<
       * ASSHOTNEUTRAL,               ///<
       * ASSHOTWHITEXY,               ///<
       * BASELINEEXPOSURE,            ///<
       * BASELINENOISE,               ///<
       * BASELINESHARPNESS,           ///<
       * BAYERGREENSPLIT,             ///<
       * LINEARRESPONSELIMIT,         ///<
       * CAMERASERIALNUMBER,          ///<
       * LENSINFO,                    ///<
       * CHROMABLURRADIUS,            ///<
       * ANTIALIASSTRENGTH,           ///<
       * SHADOWSCALE,                 ///<
       * DNGPRIVATEDATA,              ///<
       * MAKERNOTESAFETY,             ///<
       * CALIBRATIONILLUMINANT1,      ///<
       * CALIBRATIONILLUMINANT2,      ///<
       * BESTQUALITYSCALE,            ///<
       * RAWDATAUNIQUEID,             ///<
       * ORIGINALRAWFILENAME,         ///<
       * ORIGINALRAWFILEDATA,         ///<
       * ACTIVEAREA,                  ///<
       * MASKEDAREAS,                 ///<
       * ASSHOTICCPROFILE,            ///<
       * ASSHOTPREPROFILEMATRIX,      ///<
       * CURRENTICCPROFILE,           ///<
       * CURRENTPREPROFILEMATRIX,     ///<
       * DCSHUESHIFTVALUES,           ///<
       * FAXMODE,                     ///<
       * JPEGQUALITY,                 ///<
       * JPEGCOLORMODE,               ///<
       * JPEGTABLESMODE,              ///<
       * FAXFILLFUNC,                 ///<
       * PIXARLOGDATAFMT,             ///<
       * DCSIMAGERTYPE,               ///<
       * DCSINTERPMODE,               ///<
       * DCSBALANCEARRAY,             ///<
       * DCSCORRECTMATRIX,            ///<
       * DCSGAMMA,                    ///<
       * DCSTOESHOULDERPTS,           ///<
       * DCSCALIBRATIONFD,            ///<
       * ZIPQUALITY,                  ///<
       * PIXARLOGQUALITY,             ///<
       * DCSCLIPRECTANGLE,            ///<
       * SGILOGDATAFMT,               ///<
       * SGILOGENCODE,                ///<
       * LZMAPRESET,                  ///<
       * PERSAMPLE                    ///<
       */

      tag_type
      getWrappedTag(StringTag1 tag);

      tag_type
      getWrappedTag(StringTagArray1 tag);

      tag_type
      getWrappedTag(UInt16Tag1 tag);

      tag_type
      getWrappedTag(UInt16TagArray1 tag);

      tag_type
      getWrappedTag(UInt16Compression1 tag);

      tag_type
      getWrappedTag(UInt16FillOrder1 tag);

      tag_type
      getWrappedTag(UInt16Orientation1 tag);

      tag_type
      getWrappedTag(UInt16PhotometricInterpretation1 tag);

      tag_type
      getWrappedTag(UInt16PlanarConfiguration1 tag);

      tag_type
      getWrappedTag(UInt16Predictor1 tag);

      tag_type
      getWrappedTag(UInt16SampleFormat1 tag);

      tag_type
      getWrappedTag(UInt16Threshholding1 tag);

      tag_type
      getWrappedTag(UInt16YCbCrPosition1 tag);

      tag_type
      getWrappedTag(UInt16Tag2 tag);

      tag_type
      getWrappedTag(UInt16Tag6 tag);

      tag_type
      getWrappedTag(UInt16ExtraSamplesArray1 tag);

      tag_type
      getWrappedTag(UInt16TagArray3 tag);

      tag_type
      getWrappedTag(UInt32Tag1 tag);

      tag_type
      getWrappedTag(UInt32TagArray1 tag);

      tag_type
      getWrappedTag(UInt64TagArray1 tag);

      tag_type
      getWrappedTag(RawDataTag1 tag);

      tag_type
      getWrappedTag(FloatTag1 tag);

      tag_type
      getWrappedTag(FloatTag2 tag);

      tag_type
      getWrappedTag(FloatTag3 tag);

      tag_type
      getWrappedTag(FloatTag6 tag);

    }

    namespace detail
    {
      namespace tiff
      {

        template<typename TagCategory>
        struct TagProperties;

        template<>
        struct TagProperties< ::ome::bioformats::tiff::StringTag1>
        {
          typedef std::string value_type;
        };

        template<>
        struct TagProperties< ::ome::bioformats::tiff::StringTagArray1>
        {
          typedef std::vector<std::string> value_type;
        };

        template<>
        struct TagProperties< ::ome::bioformats::tiff::UInt16Tag1>
        {
          typedef uint16_t value_type;
        };

        template<>
        struct TagProperties< ::ome::bioformats::tiff::UInt16TagArray1>
        {
          typedef std::vector<uint16_t> value_type;
        };

        template<>
        struct TagProperties< ::ome::bioformats::tiff::UInt16Compression1>
        {
          typedef ::ome::bioformats::tiff::Compression value_type;
        };

        template<>
        struct TagProperties< ::ome::bioformats::tiff::UInt16FillOrder1>
        {
          typedef ::ome::bioformats::tiff::FillOrder value_type;
        };

        template<>
        struct TagProperties< ::ome::bioformats::tiff::UInt16Orientation1>
        {
          typedef ::ome::bioformats::tiff::Orientation value_type;
        };

        template<>
        struct TagProperties< ::ome::bioformats::tiff::UInt16PhotometricInterpretation1>
        {
          typedef ::ome::bioformats::tiff::PhotometricInterpretation value_type;
        };

        template<>
        struct TagProperties< ::ome::bioformats::tiff::UInt16PlanarConfiguration1>
        {
          typedef ::ome::bioformats::tiff::PlanarConfiguration value_type;
        };

        template<>
        struct TagProperties< ::ome::bioformats::tiff::UInt16Predictor1>
        {
          typedef ::ome::bioformats::tiff::Predictor value_type;
        };

        template<>
        struct TagProperties< ::ome::bioformats::tiff::UInt16SampleFormat1>
        {
          typedef ::ome::bioformats::tiff::SampleFormat value_type;
        };

        template<>
        struct TagProperties< ::ome::bioformats::tiff::UInt16Threshholding1>
        {
          typedef ::ome::bioformats::tiff::Threshholding value_type;
        };

        template<>
        struct TagProperties< ::ome::bioformats::tiff::UInt16YCbCrPosition1>
        {
          typedef ::ome::bioformats::tiff::YCbCrPosition value_type;
        };

        template<>
        struct TagProperties< ::ome::bioformats::tiff::UInt16Tag2>
        {
          typedef ome::compat::array<uint16_t, 2> value_type;
        };

        template<>
        struct TagProperties< ::ome::bioformats::tiff::UInt16Tag6>
        {
          typedef ome::compat::array<uint16_t, 6> value_type;
        };

        template<>
        struct TagProperties< ::ome::bioformats::tiff::UInt16ExtraSamplesArray1>
        {
          typedef std::vector< ::ome::bioformats::tiff::ExtraSamples> value_type;
        };

        template<>
        struct TagProperties< ::ome::bioformats::tiff::UInt16TagArray3>
        {
          typedef ome::compat::array<std::vector<uint16_t>, 3> value_type;
        };

        template<>
        struct TagProperties< ::ome::bioformats::tiff::UInt32Tag1>
        {
          typedef uint32_t value_type;
        };

        template<>
        struct TagProperties< ::ome::bioformats::tiff::UInt32TagArray1>
        {
          typedef std::vector<uint32_t> value_type;
        };

        template<>
        struct TagProperties< ::ome::bioformats::tiff::UInt64TagArray1>
        {
          typedef std::vector<uint64_t> value_type;
        };

        template<>
        struct TagProperties< ::ome::bioformats::tiff::RawDataTag1>
        {
          typedef std::vector<uint8_t> value_type;
        };

        template<>
        struct TagProperties< ::ome::bioformats::tiff::FloatTag1>
        {
          typedef float value_type;
        };

        template<>
        struct TagProperties< ::ome::bioformats::tiff::FloatTag2>
        {
          typedef ome::compat::array<float, 2> value_type;
        };

        template<>
        struct TagProperties< ::ome::bioformats::tiff::FloatTag3>
        {
          typedef ome::compat::array<float, 3> value_type;
        };

        template<>
        struct TagProperties< ::ome::bioformats::tiff::FloatTag6>
        {
          typedef ome::compat::array<float, 6> value_type;
        };

      }
    }
  }
}

#endif // OME_BIOFORMATS_TIFF_TAGS_H

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