2 // Author: Andrey Betenev
3 // Copyright: Open CASCADE 2016
5 // This file is part of Open CASCADE Technology software library.
7 // This library is free software; you can redistribute it and/or modify it under
8 // the terms of the GNU Lesser General Public License version 2.1 as published
9 // by the Free Software Foundation, with special exception defined in the file
10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
11 // distribution for complete text of the license and disclaimer of any warranty.
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement.
16 #include <RWStl_Reader.hxx>
19 #include <Message.hxx>
20 #include <Message_Messenger.hxx>
21 #include <Message_ProgressSentry.hxx>
22 #include <NCollection_DataMap.hxx>
23 #include <NCollection_IncAllocator.hxx>
24 #include <FSD_BinaryFile.hxx>
25 #include <OSD_OpenFile.hxx>
26 #include <OSD_Timer.hxx>
27 #include <Precision.hxx>
28 #include <Standard_CLocaleSentry.hxx>
29 #include <Standard_ReadLineBuffer.hxx>
34 IMPLEMENT_STANDARD_RTTIEXT(RWStl_Reader, Standard_Transient)
39 static const size_t THE_STL_HEADER_SIZE = 84;
40 static const size_t THE_STL_SIZEOF_FACET = 50;
41 static const size_t THE_STL_MIN_FILE_SIZE = THE_STL_HEADER_SIZE + THE_STL_SIZEOF_FACET;
43 // The length of buffer to read (in bytes)
44 static const size_t THE_BUFFER_SIZE = 1024;
47 Standard_ReadLineBuffer THE_BUFFER (THE_BUFFER_SIZE);
49 //! Auxiliary tool for merging nodes during STL reading.
55 MergeNodeTool (RWStl_Reader* theReader)
56 : myReader (theReader),
57 myMap (1024, new NCollection_IncAllocator (1024 * 1024))
62 int AddNode (double theX, double theY, double theZ)
64 // use existing node if found at the same point
65 gp_XYZ aPnt (theX, theY, theZ);
67 Standard_Integer anIndex = -1;
68 if (myMap.Find (aPnt, anIndex))
73 anIndex = myReader->AddNode (aPnt);
74 myMap.Bind (aPnt, anIndex);
80 static Standard_Boolean IsEqual (const gp_XYZ& thePnt1, const gp_XYZ& thePnt2)
82 return (thePnt1 - thePnt2).SquareModulus() < Precision::SquareConfusion();
85 //! Computes a hash code for the point, in the range [1, theUpperBound]
86 //! @param thePoint the point which hash code is to be computed
87 //! @param theUpperBound the upper bound of the range a computing hash code must be within
88 //! @return a computed hash code, in the range [1, theUpperBound]
89 static Standard_Integer HashCode (const gp_XYZ& thePoint, const Standard_Integer theUpperBound)
91 return ::HashCode (thePoint.X() * M_LN10 + thePoint.Y() * M_PI + thePoint.Z() * M_E, theUpperBound);
95 RWStl_Reader* myReader;
96 NCollection_DataMap<gp_XYZ, Standard_Integer, MergeNodeTool> myMap;
99 //! Read a Little Endian 32 bits float
100 inline static float readStlFloat (const char* theData)
102 #if OCCT_BINARY_FILE_DO_INVERSE
103 // on big-endian platform, map values byte-per-byte
109 bidargum.i = theData[0] & 0xFF;
110 bidargum.i |= (theData[1] & 0xFF) << 0x08;
111 bidargum.i |= (theData[2] & 0xFF) << 0x10;
112 bidargum.i |= (theData[3] & 0xFF) << 0x18;
115 // on little-endian platform, use plain cast
116 return *reinterpret_cast<const float*>(theData);
120 //! Read a Little Endian 32 bits float
121 inline static gp_XYZ readStlFloatVec3 (const char* theData)
123 return gp_XYZ (readStlFloat (theData),
124 readStlFloat (theData + sizeof(float)),
125 readStlFloat (theData + sizeof(float) * 2));
130 //==============================================================================
133 //==============================================================================
135 Standard_Boolean RWStl_Reader::Read (const char* theFile,
136 const Handle(Message_ProgressIndicator)& theProgress)
139 OSD_OpenStream (aBuf, theFile, std::ios::in | std::ios::binary);
142 return Standard_False;
145 Standard_IStream aStream (&aBuf);
147 // get length of file to feed progress indicator in Ascii mode
148 aStream.seekg (0, aStream.end);
149 std::streampos theEnd = aStream.tellg();
150 aStream.seekg (0, aStream.beg);
152 // binary STL files cannot be shorter than 134 bytes
153 // (80 bytes header + 4 bytes facet count + 50 bytes for one facet);
154 // thus assume files shorter than 134 as Ascii without probing
155 // (probing may bring stream to fail state if EOF is reached)
156 bool isAscii = ((size_t)theEnd < THE_STL_MIN_FILE_SIZE || IsAscii (aStream));
158 while (aStream.good())
162 if (!ReadAscii (aStream, theEnd, theProgress))
169 if (!ReadBinary (aStream, theProgress))
174 aStream >> std::ws; // skip any white spaces
176 return ! aStream.fail();
179 //==============================================================================
182 //==============================================================================
184 Standard_Boolean RWStl_Reader::IsAscii (Standard_IStream& theStream)
186 // read first 134 bytes to detect file format
187 char aBuffer[THE_STL_MIN_FILE_SIZE];
188 std::streamsize aNbRead = theStream.read (aBuffer, THE_STL_MIN_FILE_SIZE).gcount();
191 Message::DefaultMessenger()->Send ("Error: Cannot read file", Message_Fail);
195 // put back the read symbols
196 for (std::streamsize aByteIter = aNbRead; aByteIter > 0; --aByteIter)
201 // if file is shorter than size of binary file with 1 facet, it must be ascii
202 if (aNbRead < std::streamsize(THE_STL_MIN_FILE_SIZE))
207 // otherwise, detect binary format by presence of non-ascii symbols in first 128 bytes
208 // (note that binary STL file may start with the same bytes "solid " as Ascii one)
209 for (Standard_Integer aByteIter = 0; aByteIter < aNbRead; ++aByteIter)
211 if ((unsigned char )aBuffer[aByteIter] > (unsigned char )'~')
219 // adapted from Standard_CString.cxx
221 // There are a lot of *_l functions availalbe on Mac OS X - we use them
223 #elif defined(_MSC_VER)
224 // MSVCRT has equivalents with slightly different syntax
226 #define sscanf_l(theBuffer, theLocale, theFormat, ...) _sscanf_s_l(theBuffer, theFormat, theLocale, __VA_ARGS__)
228 // glibc provides only limited xlocale implementation:
229 // strtod_l/strtol_l/strtoll_l functions with explicitly specified locale
230 // and newlocale/uselocale/freelocale to switch locale within current thread only.
231 // So we switch to C locale temporarily
232 #define SAVE_TL() Standard_CLocaleSentry aLocaleSentry;
233 #define sscanf_l(theBuffer, theLocale, theFormat, ...) sscanf(theBuffer, theFormat, __VA_ARGS__)
236 // Macro to get 64-bit position of the file from std::streampos
237 #if defined(_MSC_VER) && _MSC_VER < 1700
238 // In MSVC 2010, cast of std::streampos to 64-bit int is implemented incorrectly;
239 // work-around (relevant for files larger than 4 GB) is to use internal function seekpos().
240 // Since MSVC 15.8, seekpos() is deprecated and is said to always return 0.
241 #define GETPOS(aPos) aPos.seekpos()
243 #define GETPOS(aPos) ((int64_t)aPos)
246 # if defined(_MSC_VER) && ! defined(strncasecmp)
247 # define strncasecmp _strnicmp
250 static inline bool str_starts_with (const char* theStr, const char* theWord, int theN)
252 while (isspace (*theStr) && *theStr != '\0') theStr++;
253 return !strncasecmp (theStr, theWord, theN);
256 static bool ReadVertex (const char* theStr, double& theX, double& theY, double& theZ)
258 const char *aStr = theStr;
261 while (isspace ((unsigned char)*aStr) || isalpha ((unsigned char)*aStr))
266 theX = Strtod (aStr, &aEnd);
267 theY = Strtod (aStr = aEnd, &aEnd);
268 theZ = Strtod (aStr = aEnd, &aEnd);
273 //==============================================================================
274 //function : ReadAscii
276 //==============================================================================
277 Standard_Boolean RWStl_Reader::ReadAscii (Standard_IStream& theStream,
278 const std::streampos theUntilPos,
279 const Handle(Message_ProgressIndicator)& theProgress)
281 // use method seekpos() to get true 64-bit offset to enable
282 // handling of large files (VS 2010 64-bit)
283 const int64_t aStartPos = GETPOS(theStream.tellg());
287 // skip header "solid ..."
288 aLine = THE_BUFFER.ReadLine (theStream, aLineLen);
291 Message::DefaultMessenger()->Send ("Error: premature end of file", Message_Fail);
295 MergeNodeTool aMergeTool (this);
296 Standard_CLocaleSentry::clocale_t aLocale = Standard_CLocaleSentry::GetCLocale();
297 (void)aLocale; // to avoid warning on GCC where it is actually not used
298 SAVE_TL() // for GCC only, set C locale globally
300 // report progress every 1 MiB of read data
301 const int aStepB = 1024 * 1024;
302 const Standard_Integer aNbSteps = 1 + Standard_Integer((GETPOS(theUntilPos) - aStartPos) / aStepB);
303 Message_ProgressSentry aPSentry (theProgress, "Reading text STL file", 0, aNbSteps, 1);
304 int64_t aProgressPos = aStartPos + aStepB;
307 while (aPSentry.More())
309 if (GETPOS(theStream.tellg()) > aProgressPos)
312 aProgressPos += aStepB;
315 aLine = THE_BUFFER.ReadLine (theStream, aLineLen); // "facet normal nx ny nz"
318 Message::DefaultMessenger()->Send ("Error: premature end of file", Message_Fail);
321 if (str_starts_with (aLine, "endsolid", 8))
326 if (!str_starts_with (aLine, "facet", 5))
328 TCollection_AsciiString aStr ("Error: unexpected format of facet at line ");
330 Message::DefaultMessenger()->Send (aStr, Message_Fail);
334 aLine = THE_BUFFER.ReadLine (theStream, aLineLen); // "outer loop"
335 if (aLine == NULL || !str_starts_with (aLine, "outer", 5))
337 TCollection_AsciiString aStr ("Error: unexpected format of facet at line ");
339 Message::DefaultMessenger()->Send (aStr, Message_Fail);
344 Standard_Boolean isEOF = false;
345 for (Standard_Integer i = 0; i < 3; i++)
347 aLine = THE_BUFFER.ReadLine (theStream, aLineLen);
354 if (!ReadVertex (aLine, aReadVertex.ChangeCoord (1), aReadVertex.ChangeCoord (2), aReadVertex.ChangeCoord (3)))
356 TCollection_AsciiString aStr ("Error: cannot read vertex co-ordinates at line ");
358 Message::DefaultMessenger()->Send (aStr, Message_Fail);
361 aVertex[i] = aReadVertex;
364 // stop reading if end of file is reached;
365 // note that well-formatted file never ends by the vertex line
374 int n1 = aMergeTool.AddNode (aVertex[0].X(), aVertex[0].Y(), aVertex[0].Z());
375 int n2 = aMergeTool.AddNode (aVertex[1].X(), aVertex[1].Y(), aVertex[1].Z());
376 int n3 = aMergeTool.AddNode (aVertex[2].X(), aVertex[2].Y(), aVertex[2].Z());
377 if (n1 != n2 && n2 != n3 && n3 != n1)
379 AddTriangle (n1, n2, n3);
382 THE_BUFFER.ReadLine (theStream, aLineLen); // skip "endloop"
383 THE_BUFFER.ReadLine (theStream, aLineLen); // skip "endfacet"
388 return aPSentry.More();
391 //==============================================================================
392 //function : readStlBinary
394 //==============================================================================
396 Standard_Boolean RWStl_Reader::ReadBinary (Standard_IStream& theStream,
397 const Handle(Message_ProgressIndicator)& theProgress)
400 // the size of the file (minus the header size)
401 // must be a multiple of SIZEOF_STL_FACET
402 if ((theFileLen - THE_STL_HEADER_SIZE) % THE_STL_SIZEOF_FACET != 0
403 || (theFileLen < THE_STL_MIN_FILE_SIZE))
405 Message::DefaultMessenger()->Send ("Error: Corrupted binary STL file (inconsistent file size)!", Message_Fail);
406 return Standard_False;
408 const Standard_Integer aNbFacets = Standard_Integer((theFileLen - THE_STL_HEADER_SIZE) / THE_STL_SIZEOF_FACET);
411 // read file header at first
412 char aHeader[THE_STL_HEADER_SIZE + 1];
413 if (theStream.read (aHeader, THE_STL_HEADER_SIZE).gcount() != std::streamsize(THE_STL_HEADER_SIZE))
415 Message::DefaultMessenger()->Send ("Error: Corrupted binary STL file!", Message_Fail);
419 // number of facets is stored as 32-bit integer at position 80
420 const Standard_Integer aNbFacets = *(int32_t*)(aHeader + 80);
422 MergeNodeTool aMergeTool (this);
424 // don't trust the number of triangles which is coded in the file
425 // sometimes it is wrong, and with this technique we don't need to swap endians for integer
426 Message_ProgressSentry aPSentry (theProgress, "Reading binary STL file", 0, aNbFacets, 1);
427 Standard_Integer aNbRead = 0;
429 // allocate buffer for 80 triangles
430 const int THE_CHUNK_NBFACETS = 80;
431 char aBuffer[THE_STL_SIZEOF_FACET * THE_CHUNK_NBFACETS];
433 // normal + 3 nodes + 2 extra bytes
434 const size_t aVec3Size = sizeof(float) * 3;
435 const size_t aFaceDataLen = aVec3Size * 4 + 2;
436 const char* aBufferPtr = aBuffer;
437 Standard_Integer aNbFacesInBuffer = 0;
438 for (Standard_Integer aNbFacetRead = 0; aNbFacetRead < aNbFacets && aPSentry.More();
439 ++aNbFacetRead, ++aNbRead, --aNbFacesInBuffer, aBufferPtr += aFaceDataLen, aPSentry.Next())
442 if (aNbFacesInBuffer <= 0)
444 aNbFacesInBuffer = Min (THE_CHUNK_NBFACETS, aNbFacets - aNbFacetRead);
445 const std::streamsize aDataToRead = aNbFacesInBuffer * aFaceDataLen;
446 if (theStream.read (aBuffer, aDataToRead).gcount() != aDataToRead)
448 Message::DefaultMessenger()->Send ("Error: binary STL read failed", Message_Fail);
451 aBufferPtr = aBuffer;
454 // get points from buffer
455 // readStlFloatVec3 (aBufferPtr); // skip normal
456 gp_XYZ aP1 = readStlFloatVec3 (aBufferPtr + aVec3Size);
457 gp_XYZ aP2 = readStlFloatVec3 (aBufferPtr + aVec3Size * 2);
458 gp_XYZ aP3 = readStlFloatVec3 (aBufferPtr + aVec3Size * 3);
461 int n1 = aMergeTool.AddNode (aP1.X(), aP1.Y(), aP1.Z());
462 int n2 = aMergeTool.AddNode (aP2.X(), aP2.Y(), aP2.Z());
463 int n3 = aMergeTool.AddNode (aP3.X(), aP3.Y(), aP3.Z());
464 if (n1 != n2 && n2 != n3 && n3 != n1)
466 AddTriangle (n1, n2, n3);