Merge commit '82927817b878295060edd8fc57b3e384404dc277' as 'src/3rdParty/libE57Format'

src/3rdParty/libE57Format/include/E57SimpleReader.h

@@ -0,0 +1,214 @@
+/*
+ * E57Simple - public header of E57 Simple API for reading/writing .e57 files.
+ *
+ * Copyright (c) 2010 Stan Coleby (scoleby@intelisum.com)
+ * Copyright (c) 2020 PTC Inc.
+ * Copyright (c) 2022 Andy Maloney <asmaloney@gmail.com>
+ *
+ * Permission is hereby granted, free of charge, to any person or organization
+ * obtaining a copy of the software and accompanying documentation covered by
+ * this license (the "Software") to use, reproduce, display, distribute,
+ * execute, and transmit the Software, and to prepare derivative works of the
+ * Software, and to permit third-parties to whom the Software is furnished to
+ * do so, all subject to the following:
+ *
+ * The copyright notices in the Software and this entire statement, including
+ * the above license grant, this restriction and the following disclaimer,
+ * must be included in all copies of the Software, in whole or in part, and
+ * all derivative works of the Software, unless such copies or derivative
+ * works are solely in the form of machine-executable object code generated by
+ * a source language processor.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
+ * SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
+ * FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
+ * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+ * DEALINGS IN THE SOFTWARE.
+ */
+
+#pragma once
+
+/// @file
+/// @brief E57 Simple API for reading E57.
+/// @details This includes support for the
+/// [E57_EXT_surface_normals](http://www.libe57.org/E57_EXT_surface_normals.txt) extension.
+
+#include "E57SimpleData.h"
+
+namespace e57
+{
+   /// Options to the Reader constructor
+   struct E57_DLL ReaderOptions
+   {
+      /// Set how frequently to verify the checksums (see ReadChecksumPolicy).
+      ReadChecksumPolicy checksumPolicy = ChecksumAll;
+   };
+
+   /// @brief Used for reading an E57 file using E57 Simple API.
+   ///
+   /// The Reader includes support for the
+   /// [E57_EXT_surface_normals](http://www.libe57.org/E57_EXT_surface_normals.txt) extension.
+   class E57_DLL Reader
+   {
+   public:
+      /// @brief Reader constructor
+      /// @param [in] filePath Path to E57 file
+      /// @param [in] options Options to be used for the file
+      Reader( const ustring &filePath, const ReaderOptions &options );
+
+      /// @brief Reader constructor (deprecated)
+      /// @param [in] filePath Path to E57 file
+      /// @deprecated Will be removed in 4.0. Use Reader( const ustring &, const ReaderOptions & )
+      /// instead.
+      [[deprecated( "Will be removed in 4.0. Use Reader( const ustring, const ReaderOptions & "
+                    ")." )]] // TODO Remove in 4.0
+      explicit Reader( const ustring &filePath );
+
+      /// @brief Returns true if the file is open
+      bool IsOpen() const;
+
+      /// @brief Closes the file
+      bool Close();
+
+      /// @name File information
+      ///@{
+
+      /// @brief Returns the file header information
+      /// @param [out] fileHeader is the main header information
+      /// @return Returns true if successful
+      bool GetE57Root( E57Root &fileHeader ) const;
+
+      ///@}
+
+      /// @name Image2D
+      ///@{
+
+      /// @brief Returns the total number of Picture Blocks
+      /// @return Returns the number of Image2D blocks
+      int64_t GetImage2DCount() const;
+
+      /// @brief Returns the image2D header and positions the cursor
+      /// @param [in] imageIndex This in the index into the image2D vector
+      /// @param [out] image2DHeader pointer to the Image2D structure to receive the picture
+      /// information
+      /// @return Returns true if successful
+      bool ReadImage2D( int64_t imageIndex, Image2D &image2DHeader ) const;
+
+      /// @brief Returns the size of the image data
+      /// @param [in] imageIndex This in the index into the image2D vector
+      /// @param [out] imageProjection identifies the projection in the image2D.
+      /// @param [out] imageType identifies the image format of the projection.
+      /// @param [out] imageWidth The image width (in pixels).
+      /// @param [out] imageHeight The image height (in pixels).
+      /// @param [out] imageSize This is the total number of bytes for the image blob.
+      /// @param [out] imageMaskType This is E57_PNG_IMAGE_MASK if "imageMask" is defined in the
+      /// projection
+      /// @param [out] imageVisualType This is image type of the VisualReferenceRepresentation if
+      /// given.
+      /// @return Returns true if successful
+      bool GetImage2DSizes( int64_t imageIndex, Image2DProjection &imageProjection,
+                            Image2DType &imageType, int64_t &imageWidth, int64_t &imageHeight,
+                            int64_t &imageSize, Image2DType &imageMaskType,
+                            Image2DType &imageVisualType ) const;
+
+      /// @brief Reads an image
+      /// @param [in] imageIndex index of the image. Must be less than GetImage2DCount()
+      /// @param [in] imageProjection identifies the projection desired.
+      /// @param [in] imageType identifies the image format desired.
+      /// @param [out] buffer pointer the raw image buffer
+      /// @param [in] start position in the block to start reading
+      /// @param [in] count size of desired chuck or buffer size
+      /// @return Returns the number of bytes transferred.
+      int64_t ReadImage2DData( int64_t imageIndex, Image2DProjection imageProjection,
+                               Image2DType imageType, void *buffer, int64_t start,
+                               int64_t count ) const;
+
+      ///@}
+
+      /// @name Data3D
+      ///@{
+
+      /// @brief Returns the total number of Data3D Blocks
+      /// @return Returns number of Data3D blocks.
+      int64_t GetData3DCount() const;
+
+      /// @brief Returns the Data3D header
+      /// @param [in] dataIndex This in the index into the images3D vector. Must be less than
+      /// GetData3DCount().
+      /// @param [out] data3DHeader Data3D header
+      /// @return Returns true if successful
+      bool ReadData3D( int64_t dataIndex, Data3D &data3DHeader ) const;
+
+      /// @brief Returns the size of the point data
+      /// @param [in] dataIndex This in the index into the images3D vector. Must be less than
+      /// GetData3DCount().
+      /// @param [out] rowMax This is the maximum row size
+      /// @param [out] columnMax This is the maximum column size
+      /// @param [out] pointsSize This is the total number of point records
+      /// @param [out] groupsSize This is the total number of group records
+      /// @param [out] countSize This is the maximum point count per group
+      /// @param [out] columnIndex This indicates that the idElementName is "columnIndex"
+      /// @return Return true if successful, false otherwise
+      bool GetData3DSizes( int64_t dataIndex, int64_t &rowMax, int64_t &columnMax,
+                           int64_t &pointsSize, int64_t &groupsSize, int64_t &countSize,
+                           bool &columnIndex ) const;
+
+      /// @brief Reads the group data into the provided buffers.
+      /// @param [in] dataIndex This in the index into the images3D vector. Must be less than
+      /// GetData3DCount().
+      /// @param [in] groupCount size of each of the buffers given
+      /// @param [out] idElementValue pointer to the buffer holding indices index for this group
+      /// @param [out] startPointIndex pointer to the buffer holding Starting index in to the
+      /// "points" data vector for the groups
+      /// @param [out] pointCount pointer to the buffer holding size of the groups given
+      /// @return Return true if successful, false otherwise
+      bool ReadData3DGroupsData( int64_t dataIndex, size_t groupCount, int64_t *idElementValue,
+                                 int64_t *startPointIndex, int64_t *pointCount ) const;
+
+      /// @brief Use this to read the actual 3D data
+      /// @details All the non-NULL buffers in buffers have number of elements = pointCount.
+      ///          Call the CompressedVectorReader::read() until all data is read.
+      /// @param [in] dataIndex data block index
+      /// @param [in] pointCount size of each element buffer.
+      /// @param [in] buffers pointers to user-provided buffers
+      /// @return vector reader setup to read the selected data into the provided buffers
+      CompressedVectorReader SetUpData3DPointsData( int64_t dataIndex, size_t pointCount,
+                                                    const Data3DPointsFloat &buffers ) const;
+
+      /// @overload
+      CompressedVectorReader SetUpData3DPointsData( int64_t dataIndex, size_t pointCount,
+                                                    const Data3DPointsDouble &buffers ) const;
+
+      ///@}
+
+      /// @name File information
+      ///@{
+
+      /// @brief Returns the file raw E57Root Structure Node
+      StructureNode GetRawE57Root() const;
+
+      /// @brief Returns the raw Data3D Vector Node
+      VectorNode GetRawData3D() const;
+
+      /// @brief Returns the raw Image2D Vector Node
+      VectorNode GetRawImages2D() const;
+
+      /// @brief Returns the ram ImageFile Node which is need to add enhancements
+      ImageFile GetRawIMF() const;
+
+      ///@}
+
+      /// @cond documentNonPublic The following isn't part of the API, and isn't documented.
+   protected:
+      friend class ReaderImpl;
+
+      E57_INTERNAL_ACCESS( Reader )
+
+   protected:
+      std::shared_ptr<ReaderImpl> impl_;
+      /// @endcond
+   }; // end Reader class
+
+} // end namespace e57