OMWriter.cc 16.1 KB
Newer Older
Jan Möbius's avatar
Jan Möbius committed
1
/* ========================================================================= *
Jan Möbius's avatar
Jan Möbius committed
2
3
 *                                                                           *
 *                               OpenMesh                                    *
Jan Möbius's avatar
Jan Möbius committed
4
 *           Copyright (c) 2001-2015, RWTH-Aachen University                 *
Jan Möbius's avatar
Typo    
Jan Möbius committed
5
 *           Department of Computer Graphics and Multimedia                  *
Jan Möbius's avatar
Jan Möbius committed
6
7
 *                          All rights reserved.                             *
 *                            www.openmesh.org                               *
Jan Möbius's avatar
Jan Möbius committed
8
 *                                                                           *
9
 *---------------------------------------------------------------------------*
Jan Möbius's avatar
Jan Möbius committed
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 * This file is part of OpenMesh.                                            *
 *---------------------------------------------------------------------------*
 *                                                                           *
 * 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.   *
 *                                                                           *
 * 3. Neither the name of the copyright holder nor the names of its          *
 *    contributors may be used to endorse or promote products derived from   *
 *    this software without specific prior written permission.               *
 *                                                                           *
 * 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 HOLDER *
 * 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.              *
Jan Möbius's avatar
Jan Möbius committed
39
40
 *                                                                           *
 * ========================================================================= */
41
42

/*===========================================================================*\
43
 *                                                                           *
44
45
 *   $Revision$                                                         *
 *   $Date$                   *
Jan Möbius's avatar
Jan Möbius committed
46
47
48
49
50
51
52
53
54
 *                                                                           *
\*===========================================================================*/


//== INCLUDES =================================================================

#include <OpenMesh/Core/System/config.h>
// -------------------- STL
#if defined( OM_CC_MIPS )
Jan Möbius's avatar
Jan Möbius committed
55
56
  #include <time.h>
  #include <string.h>
Jan Möbius's avatar
Jan Möbius committed
57
#else
Jan Möbius's avatar
Jan Möbius committed
58
59
  #include <ctime>
  #include <cstring>
Jan Möbius's avatar
Jan Möbius committed
60
#endif
Jan Möbius's avatar
Jan Möbius committed
61

Jan Möbius's avatar
Jan Möbius committed
62
#include <fstream>
63
64
#include <vector>

Jan Möbius's avatar
Jan Möbius committed
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
// -------------------- OpenMesh
#include <OpenMesh/Core/IO/OMFormat.hh>
#include <OpenMesh/Core/IO/exporter/BaseExporter.hh>
#include <OpenMesh/Core/IO/writer/OMWriter.hh>

//=== NAMESPACES ==============================================================


namespace OpenMesh {
namespace IO {


//=== INSTANCIATE =============================================================


// register the OMLoader singleton with MeshLoader
_OMWriter_  __OMWriterInstance;
_OMWriter_& OMWriter() { return __OMWriterInstance; }


//=== IMPLEMENTATION ==========================================================


const OMFormat::uchar _OMWriter_::magic_[3] = "OM";
const OMFormat::uint8 _OMWriter_::version_  = OMFormat::mk_version(1,2);


_OMWriter_::
93
94
95
_OMWriter_()
{
  IOManager().register_module(this);
Jan Möbius's avatar
Jan Möbius committed
96
97
98
99
100
}


bool
_OMWriter_::write(const std::string& _filename, BaseExporter& _be,
101
                   Options _opt, std::streamsize /*_precision*/) const
Jan Möbius's avatar
Jan Möbius committed
102
103
104
105
106
{
  // check whether exporter can give us an OpenMesh BaseKernel
  if (!_be.kernel()) return false;


107
108
  // check for om extension in filename, we can only handle OM
  if (_filename.rfind(".om") == std::string::npos)
Jan Möbius's avatar
Jan Möbius committed
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
    return false;

  _opt += Options::Binary; // only binary format supported

  std::ofstream ofs(_filename.c_str(), std::ios::binary);

  // check if file is open
  if (!ofs.is_open())
  {
    omerr() << "[OMWriter] : cannot open file " << _filename << std::endl;
    return false;
  }

  // call stream save method
  bool rc = write(ofs, _be, _opt);
124

Jan Möbius's avatar
Jan Möbius committed
125
126
127
128
129
130
131
132
133
134
135
  // close filestream
  ofs.close();

  // return success/failure notice
  return rc;
}


//-----------------------------------------------------------------------------

bool
136
_OMWriter_::write(std::ostream& _os, BaseExporter& _be, Options _opt, std::streamsize /*_precision*/) const
Jan Möbius's avatar
Jan Möbius committed
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
{
//   std::clog << "[OMWriter]::write( stream )\n";

  // check exporter features
  if ( !check( _be, _opt ) )
  {
    omerr() << "[OMWriter]: exporter does not support wanted feature!\n";
    return false;
  }

  // Maybe an ascii version will be implemented in the future.
  // For now, support only a binary format
  if ( !_opt.check( Options::Binary ) )
    _opt += Options::Binary;

  // Ignore LSB/MSB bit. Always store in LSB (little endian)
  _opt += Options::LSB;
  _opt -= Options::MSB;

  return write_binary(_os, _be, _opt);
}


//-----------------------------------------------------------------------------


#ifndef DOXY_IGNORE_THIS
template <typename T> struct Enabler
{
  Enabler( T& obj ) : obj_(obj)
  {}

  ~Enabler() { obj_.enable(); }

  T& obj_;
};
#endif


bool _OMWriter_::write_binary(std::ostream& _os, BaseExporter& _be,
                               Options _opt) const
{
Jan Möbius's avatar
Jan Möbius committed
179
180
181
  #ifndef DOXY_IGNORE_THIS
    Enabler<mostream> enabler(omlog());
  #endif
Jan Möbius's avatar
Jan Möbius committed
182
183
184
185
186
187
188
189
190
191
192
193
194

  size_t bytes = 0;

  bool swap = _opt.check(Options::Swap) || (Endian::local() == Endian::MSB);

  unsigned int i, nV, nF;
  Vec3f v;
  Vec2f t;
  std::vector<VertexHandle> vhandles;


  // -------------------- write header
  OMFormat::Header header;
195

Jan Möbius's avatar
Jan Möbius committed
196
197
198
199
  header.magic_[0]   = 'O';
  header.magic_[1]   = 'M';
  header.mesh_       = _be.is_triangle_mesh() ? 'T' : 'P';
  header.version_    = version_;
Jan Möbius's avatar
Jan Möbius committed
200
201
202
  header.n_vertices_ = int(_be.n_vertices());
  header.n_faces_    = int(_be.n_faces());
  header.n_edges_    = int(_be.n_edges());
203

Jan Möbius's avatar
Jan Möbius committed
204
  bytes += store( _os, header, swap );
205

Jan Möbius's avatar
Jan Möbius committed
206
  // ---------------------------------------- write chunks
207

Jan Möbius's avatar
Jan Möbius committed
208
  OMFormat::Chunk::Header chunk_header;
209
210


Jan Möbius's avatar
Jan Möbius committed
211
  // -------------------- write vertex data
212

Jan Möbius's avatar
Jan Möbius committed
213
214
215
216
217
218
219
220
221
222
223
224
  // ---------- write vertex position
  if (_be.n_vertices())
  {
    v = _be.point(VertexHandle(0));
    chunk_header.reserved_ = 0;
    chunk_header.name_     = false;
    chunk_header.entity_   = OMFormat::Chunk::Entity_Vertex;
    chunk_header.type_     = OMFormat::Chunk::Type_Pos;
    chunk_header.signed_   = OMFormat::is_signed(v[0]);
    chunk_header.float_    = OMFormat::is_float(v[0]);
    chunk_header.dim_      = OMFormat::dim(v);
    chunk_header.bits_     = OMFormat::bits(v[0]);
225

Jan Möbius's avatar
Jan Möbius committed
226
    bytes += store( _os, chunk_header, swap );
Jan Möbius's avatar
Jan Möbius committed
227
    for (i=0, nV=header.n_vertices_; i<nV; ++i)
Jan Möbius's avatar
Jan Möbius committed
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
      bytes += vector_store( _os, _be.point(VertexHandle(i)), swap );
  }


  // ---------- write vertex normal
  if (_be.n_vertices() && _opt.check( Options::VertexNormal ))
  {
    Vec3f n = _be.normal(VertexHandle(0));

    chunk_header.name_     = false;
    chunk_header.entity_   = OMFormat::Chunk::Entity_Vertex;
    chunk_header.type_     = OMFormat::Chunk::Type_Normal;
    chunk_header.signed_   = OMFormat::is_signed(n[0]);
    chunk_header.float_    = OMFormat::is_float(n[0]);
    chunk_header.dim_      = OMFormat::dim(n);
    chunk_header.bits_     = OMFormat::bits(n[0]);
244

Jan Möbius's avatar
Jan Möbius committed
245
    bytes += store( _os, chunk_header, swap );
Jan Möbius's avatar
Jan Möbius committed
246
    for (i=0, nV=header.n_vertices_; i<nV; ++i)
Jan Möbius's avatar
Jan Möbius committed
247
248
249
250
      bytes += vector_store( _os, _be.normal(VertexHandle(i)), swap );
  }

  // ---------- write vertex color
251
  if (_be.n_vertices() && _opt.check( Options::VertexColor ) && _be.has_vertex_colors() )
252
  {
Jan Möbius's avatar
Jan Möbius committed
253
    Vec3uc c = _be.color(VertexHandle(0));
254

Jan Möbius's avatar
Jan Möbius committed
255
256
257
    chunk_header.name_     = false;
    chunk_header.entity_   = OMFormat::Chunk::Entity_Vertex;
    chunk_header.type_     = OMFormat::Chunk::Type_Color;
Matthias Möller's avatar
Matthias Möller committed
258
259
    chunk_header.signed_   = OMFormat::is_signed( c[0] );
    chunk_header.float_    = OMFormat::is_float( c[0] );
Jan Möbius's avatar
Jan Möbius committed
260
    chunk_header.dim_      = OMFormat::dim( c );
Matthias Möller's avatar
Matthias Möller committed
261
    chunk_header.bits_     = OMFormat::bits( c[0] );
Jan Möbius's avatar
Jan Möbius committed
262
263

    bytes += store( _os, chunk_header, swap );
Jan Möbius's avatar
Jan Möbius committed
264
    for (i=0, nV=header.n_vertices_; i<nV; ++i)
Jan Möbius's avatar
Jan Möbius committed
265
266
267
268
      bytes += vector_store( _os, _be.color(VertexHandle(i)), swap );
  }

  // ---------- write vertex texture coords
Jan Möbius's avatar
Jan Möbius committed
269
270
  if (_be.n_vertices() && _opt.check(Options::VertexTexCoord)) {

Jan Möbius's avatar
Jan Möbius committed
271
272
    t = _be.texcoord(VertexHandle(0));

Jan Möbius's avatar
Jan Möbius committed
273
274
275
276
277
278
279
    chunk_header.name_ = false;
    chunk_header.entity_ = OMFormat::Chunk::Entity_Vertex;
    chunk_header.type_ = OMFormat::Chunk::Type_Texcoord;
    chunk_header.signed_ = OMFormat::is_signed(t[0]);
    chunk_header.float_ = OMFormat::is_float(t[0]);
    chunk_header.dim_ = OMFormat::dim(t);
    chunk_header.bits_ = OMFormat::bits(t[0]);
280

Jan Möbius's avatar
Jan Möbius committed
281
    // std::clog << chunk_header << std::endl;
Jan Möbius's avatar
Jan Möbius committed
282
283
    bytes += store(_os, chunk_header, swap);

Jan Möbius's avatar
Jan Möbius committed
284
    for (i = 0, nV = header.n_vertices_; i < nV; ++i)
Jan Möbius's avatar
Jan Möbius committed
285
      bytes += vector_store(_os, _be.texcoord(VertexHandle(i)), swap);
Jan Möbius's avatar
Jan Möbius committed
286
287
288
289
290
291
292
293
294
295
296
297
298

  }

  // -------------------- write face data

  // ---------- write topology
  {
    chunk_header.name_     = false;
    chunk_header.entity_   = OMFormat::Chunk::Entity_Face;
    chunk_header.type_     = OMFormat::Chunk::Type_Topology;
    chunk_header.signed_   = 0;
    chunk_header.float_    = 0;
    chunk_header.dim_      = OMFormat::Chunk::Dim_1D; // ignored
299
    chunk_header.bits_     = OMFormat::needed_bits(_be.n_vertices());
Jan Möbius's avatar
Jan Möbius committed
300
301
302

    bytes += store( _os, chunk_header, swap );

Jan Möbius's avatar
Jan Möbius committed
303
    for (i=0, nF=header.n_faces_; i<nF; ++i)
Jan Möbius's avatar
Jan Möbius committed
304
    {
305
      nV = _be.get_vhandles(FaceHandle(i), vhandles);
Jan Möbius's avatar
Jan Möbius committed
306
      if ( header.mesh_ == 'P' )
Jan Möbius's avatar
Jan Möbius committed
307
        bytes += store( _os, vhandles.size(), OMFormat::Chunk::Integer_16, swap );
308

Jan Möbius's avatar
Jan Möbius committed
309
310
      for (size_t j=0; j < vhandles.size(); ++j)
      {
Jan Möbius's avatar
Jan Möbius committed
311
312
        using namespace OMFormat;
        using namespace GenProg;
313

Jan Möbius's avatar
Jan Möbius committed
314
        bytes += store( _os, vhandles[j].idx(), Chunk::Integer_Size(chunk_header.bits_), swap );
Jan Möbius's avatar
Jan Möbius committed
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
      }
    }
  }

  // ---------- write face normals

  if ( _be.has_face_normals() && _opt.check(Options::FaceNormal) )
  {
#define NEW_STYLE 0
#if NEW_STYLE
    const BaseProperty *bp = _be.kernel()._get_fprop("f:normals");

    if (bp)
    {
#endif
      Vec3f n = _be.normal(FaceHandle(0));

      chunk_header.name_     = false;
      chunk_header.entity_   = OMFormat::Chunk::Entity_Face;
      chunk_header.type_     = OMFormat::Chunk::Type_Normal;
      chunk_header.signed_   = OMFormat::is_signed(n[0]);
      chunk_header.float_    = OMFormat::is_float(n[0]);
      chunk_header.dim_      = OMFormat::dim(n);
      chunk_header.bits_     = OMFormat::bits(n[0]);
339

Jan Möbius's avatar
Jan Möbius committed
340
341
      bytes += store( _os, chunk_header, swap );
#if !NEW_STYLE
Jan Möbius's avatar
Jan Möbius committed
342
      for (i=0, nF=header.n_faces_; i<nF; ++i)
Jan Möbius's avatar
Jan Möbius committed
343
344
345
346
347
348
349
350
351
352
353
354
355
356
        bytes += vector_store( _os, _be.normal(FaceHandle(i)), swap );
#else
      bytes += bp->store(_os, swap );
    }
    else
      return false;
#endif
#undef NEW_STYLE
  }


  // ---------- write face color

  if (_be.has_face_colors() && _opt.check( Options::FaceColor ))
357
  {
Jan Möbius's avatar
Jan Möbius committed
358
359
360
#define NEW_STYLE 0
#if NEW_STYLE
    const BaseProperty *bp = _be.kernel()._get_fprop("f:colors");
361

Jan Möbius's avatar
Jan Möbius committed
362
363
364
365
    if (bp)
    {
#endif
      Vec3uc c;
366

Jan Möbius's avatar
Jan Möbius committed
367
368
369
370
371
372
373
      chunk_header.name_     = false;
      chunk_header.entity_   = OMFormat::Chunk::Entity_Face;
      chunk_header.type_     = OMFormat::Chunk::Type_Color;
      chunk_header.signed_   = OMFormat::is_signed( c[0] );
      chunk_header.float_    = OMFormat::is_float( c[0] );
      chunk_header.dim_      = OMFormat::dim( c );
      chunk_header.bits_     = OMFormat::bits( c[0] );
374

Jan Möbius's avatar
Jan Möbius committed
375
376
      bytes += store( _os, chunk_header, swap );
#if !NEW_STYLE
Jan Möbius's avatar
Jan Möbius committed
377
      for (i=0, nF=header.n_faces_; i<nF; ++i)
378
        bytes += vector_store( _os, _be.color(FaceHandle(i)), swap );
Jan Möbius's avatar
Jan Möbius committed
379
380
381
382
383
384
385
386
387
388
#else
      bytes += bp->store(_os, swap);
    }
    else
      return false;
#endif
  }

  // -------------------- write custom properties

389

Jan Möbius's avatar
Jan Möbius committed
390
  BaseKernel::const_prop_iterator prop;
391

Jan Möbius's avatar
Jan Möbius committed
392
393
394
395
396
  for (prop  = _be.kernel()->vprops_begin();
       prop != _be.kernel()->vprops_end(); ++prop)
  {
    if ( !*prop ) continue;
    if ( (*prop)->name()[1]==':') continue;
397
    bytes += store_binary_custom_chunk(_os, **prop,
Jan Möbius's avatar
Jan Möbius committed
398
399
400
401
402
403
404
				       OMFormat::Chunk::Entity_Vertex, swap );
  }
  for (prop  = _be.kernel()->fprops_begin();
       prop != _be.kernel()->fprops_end(); ++prop)
  {
    if ( !*prop ) continue;
    if ( (*prop)->name()[1]==':') continue;
405
    bytes += store_binary_custom_chunk(_os, **prop,
Jan Möbius's avatar
Jan Möbius committed
406
407
408
409
410
411
412
				       OMFormat::Chunk::Entity_Face, swap );
  }
  for (prop  = _be.kernel()->eprops_begin();
       prop != _be.kernel()->eprops_end(); ++prop)
  {
    if ( !*prop ) continue;
    if ( (*prop)->name()[1]==':') continue;
413
    bytes += store_binary_custom_chunk(_os, **prop,
Jan Möbius's avatar
Jan Möbius committed
414
415
416
417
418
419
420
				       OMFormat::Chunk::Entity_Edge, swap );
  }
  for (prop  = _be.kernel()->hprops_begin();
       prop != _be.kernel()->hprops_end(); ++prop)
  {
    if ( !*prop ) continue;
    if ( (*prop)->name()[1]==':') continue;
421
    bytes += store_binary_custom_chunk(_os, **prop,
Jan Möbius's avatar
Jan Möbius committed
422
423
424
425
426
427
428
				       OMFormat::Chunk::Entity_Halfedge, swap );
  }
  for (prop  = _be.kernel()->mprops_begin();
       prop != _be.kernel()->mprops_end(); ++prop)
  {
    if ( !*prop ) continue;
    if ( (*prop)->name()[1]==':') continue;
429
    bytes += store_binary_custom_chunk(_os, **prop,
Jan Möbius's avatar
Jan Möbius committed
430
431
432
				       OMFormat::Chunk::Entity_Mesh, swap );
  }

Jan Möbius's avatar
Jan Möbius committed
433
  std::clog << "#bytes written: " << bytes << std::endl;
Jan Möbius's avatar
Jan Möbius committed
434
435
436
437
438
439

  return true;
}

// ----------------------------------------------------------------------------

440
size_t _OMWriter_::store_binary_custom_chunk(std::ostream& _os,
Jan Möbius's avatar
Jan Möbius committed
441
442
443
444
					     const BaseProperty& _bp,
					     OMFormat::Chunk::Entity _entity,
					     bool _swap) const
{
Jan Möbius's avatar
Jan Möbius committed
445
446
  //omlog() << "Custom Property " << OMFormat::as_string(_entity) << " property ["
  //	<< _bp.name() << "]" << std::endl;
Jan Möbius's avatar
Jan Möbius committed
447

448
  // Don't store if
Jan Möbius's avatar
Jan Möbius committed
449
450
451
452
  // 1. it is not persistent
  // 2. it's name is empty
  if ( !_bp.persistent() || _bp.name().empty() )
  {
Jan Möbius's avatar
Jan Möbius committed
453
    //omlog() << "  skipped\n";
Jan Möbius's avatar
Jan Möbius committed
454
455
456
457
458
    return 0;
  }

  size_t bytes = 0;

Jan Möbius's avatar
Jan Möbius committed
459
  OMFormat::Chunk::esize_t element_size   = OMFormat::Chunk::esize_t(_bp.element_size());
Jan Möbius's avatar
Jan Möbius committed
460
461
462
463
464
465
466
467
468
469
470
471
472
473
  OMFormat::Chunk::Header  chdr;

  // set header
  chdr.name_     = true;
  chdr.entity_   = _entity;
  chdr.type_     = OMFormat::Chunk::Type_Custom;
  chdr.signed_   = 0;
  chdr.float_    = 0;
  chdr.dim_      = OMFormat::Chunk::Dim_1D; // ignored
  chdr.bits_     = element_size;


  // write custom chunk

474
  // 1. chunk header
Jan Möbius's avatar
Jan Möbius committed
475
476
477
478
479
480
  bytes += store( _os, chdr, _swap );

  // 2. property name
  bytes += store( _os, OMFormat::Chunk::PropertyName(_bp.name()), _swap );

  // 3. block size
481
  bytes += store( _os, _bp.size_of(), OMFormat::Chunk::Integer_32, _swap );
Jan Möbius's avatar
Jan Möbius committed
482
  //omlog() << "  n_bytes = " << _bp.size_of() << std::endl;
Jan Möbius's avatar
Jan Möbius committed
483
484
485
486
487

  // 4. data
  {
    size_t b;
    bytes += ( b=_bp.store( _os, _swap ) );
Jan Möbius's avatar
Jan Möbius committed
488
    //omlog() << "  b       = " << b << std::endl;
Jan Möbius's avatar
Jan Möbius committed
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
    assert( b == _bp.size_of() );
  }
  return bytes;
}

// ----------------------------------------------------------------------------

size_t _OMWriter_::binary_size(BaseExporter& /* _be */, Options /* _opt */) const
{
  // std::clog << "[OMWriter]: binary_size()" << std::endl;
  size_t bytes  = sizeof( OMFormat::Header );

  // !!!TODO!!!

  return bytes;
}

//=============================================================================
} // namespace IO
} // namespace OpenMesh
//=============================================================================