TMC3.cpp 17.3 KB
Newer Older
Khaled Mammou's avatar
TMC3v0  
Khaled Mammou committed
1
/* The copyright in this software is being made available under the BSD
David Flynn's avatar
David Flynn committed
2
3
4
 * Licence, included below.  This software may be subject to other third
 * party and contributor rights, including patent rights, and no such
 * rights are granted under this licence.
Khaled Mammou's avatar
TMC3v0  
Khaled Mammou committed
5
 *
David Flynn's avatar
David Flynn committed
6
 * Copyright (c) 2017-2018, ISO/IEC
Khaled Mammou's avatar
TMC3v0  
Khaled Mammou committed
7
8
9
10
11
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
David Flynn's avatar
David Flynn committed
12
13
14
15
16
17
18
19
20
21
 * * Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 *
 * * 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.
 *
 * * Neither the name of the ISO/IEC nor the names of its contributors
 *   may be used to endorse or promote products derived from this
 *   software without specific prior written permission.
Khaled Mammou's avatar
TMC3v0  
Khaled Mammou committed
22
23
24
25
 *
 * 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
David Flynn's avatar
David Flynn committed
26
27
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
Khaled Mammou's avatar
TMC3v0  
Khaled Mammou committed
28
29
30
31
 * 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)
David Flynn's avatar
David Flynn committed
32
33
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
Khaled Mammou's avatar
TMC3v0  
Khaled Mammou committed
34
35
36
 */

#include "TMC3.h"
37
#include "program_options_lite.h"
38
#include "version.h"
Khaled Mammou's avatar
TMC3v0  
Khaled Mammou committed
39
40
41
42

using namespace std;
using namespace pcc;

43
44
45
int
main(int argc, char* argv[])
{
46
  cout << "MPEG PCC tmc3 version " << ::pcc::version << endl;
47

Khaled Mammou's avatar
TMC3v0  
Khaled Mammou committed
48
49
50
51
  Parameters params;
  if (!ParseParameters(argc, argv, params)) {
    return -1;
  }
52
53
54
55
56
57
58

  // Timers to count elapsed wall/user time
  pcc::chrono::Stopwatch<std::chrono::steady_clock> clock_wall;
  pcc::chrono::Stopwatch<pcc::chrono::utime_inc_children_clock> clock_user;

  clock_wall.start();

Khaled Mammou's avatar
TMC3v0  
Khaled Mammou committed
59
  int ret = 0;
60
61
62
63
  if (
    params.mode == CODEC_MODE_ENCODE
    || params.mode == CODEC_MODE_ENCODE_LOSSLESS_GEOMETRY
    || params.mode == CODEC_MODE_ENCODE_TRISOUP_GEOMETRY) {
64
    ret = Compress(params, clock_user);
Khaled Mammou's avatar
TMC3v0  
Khaled Mammou committed
65
  } else {
66
    ret = Decompress(params, clock_user);
Khaled Mammou's avatar
TMC3v0  
Khaled Mammou committed
67
68
  }

69
70
71
72
73
74
75
76
  clock_wall.stop();

  using namespace std::chrono;
  auto total_wall = duration_cast<milliseconds>(clock_wall.count()).count();
  auto total_user = duration_cast<milliseconds>(clock_user.count()).count();
  std::cout << "Processing time (wall): " << total_wall / 1000.0 << " s\n";
  std::cout << "Processing time (user): " << total_user / 1000.0 << " s\n";

Khaled Mammou's avatar
TMC3v0  
Khaled Mammou committed
77
78
79
  return ret;
}

80
81
82
//---------------------------------------------------------------------------
// :: Command line / config parsing helpers

83
84
85
86
template<typename T>
static std::istream&
readUInt(std::istream& in, T& val)
{
87
88
89
90
91
92
  unsigned int tmp;
  in >> tmp;
  val = T(tmp);
  return in;
}

93
94
95
static std::istream&
operator>>(std::istream& in, CodecMode& val)
{
96
  return readUInt(in, val);
Khaled Mammou's avatar
TMC3v0  
Khaled Mammou committed
97
98
}

99
100
101
static std::istream&
operator>>(std::istream& in, ColorTransform& val)
{
102
103
104
  return readUInt(in, val);
}

105
namespace pcc {
106
107
108
static std::istream&
operator>>(std::istream& in, TransformType& val)
{
109
  return readUInt(in, val);
110
111
}
}  // namespace pcc
112

113
namespace pcc {
114
115
116
static std::istream&
operator>>(std::istream& in, GeometryCodecType& val)
{
117
  return readUInt(in, val);
118
119
}
}  // namespace pcc
120

121
namespace pcc {
122
123
124
static std::ostream&
operator<<(std::ostream& out, const TransformType& val)
{
125
126
  switch (val) {
  case TransformType::kIntegerLift: out << "0 (IntegerLifting)"; break;
127
  case TransformType::kRAHT: out << "1 (RAHT)"; break;
128
129
  }
  return out;
130
131
}
}  // namespace pcc
132

133
namespace pcc {
134
135
136
static std::ostream&
operator<<(std::ostream& out, const GeometryCodecType& val)
{
137
  switch (val) {
138
139
  case GeometryCodecType::kBypass: out << "0 (Bypass)"; break;
  case GeometryCodecType::kOctree: out << "1 (TMC1 Octree)"; break;
140
141
142
  case GeometryCodecType::kTriSoup: out << "2 (TMC3 TriSoup)"; break;
  }
  return out;
143
144
}
}  // namespace pcc
145

146
147
148
//---------------------------------------------------------------------------
// :: Command line / config parsing

149
150
151
bool
ParseParameters(int argc, char* argv[], Parameters& params)
{
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
  namespace po = df::program_options_lite;

  PCCAttributeEncodeParamaters params_attr;
  bool print_help = false;

  // a helper to set the attribute
  std::function<po::OptionFunc::Func> attribute_setter =
    [&](po::Options&, const std::string& name, po::ErrorReporter) {
      // copy the current state of parsed attribute parameters
      //
      // NB: this does not cause the default values of attr to be restored
      // for the next attribute block.  A side-effect of this is that the
      // following is allowed leading to attribute foo having both X=1 and
      // Y=2:
      //   "--attr.X=1 --attribute foo --attr.Y=2 --attribute foo"
      //
      params.encodeParameters.attributeEncodeParameters[name] = params_attr;
    };

171
  /* clang-format off */
172
173
174
175
176
177
178
179
180
181
182
  // The definition of the program/config options, along with default values.
  //
  // NB: when updating the following tables:
  //      (a) please keep to 80-columns for easier reading at a glance,
  //      (b) do not vertically align values -- it breaks quickly
  //
  po::Options opts;
  opts.addOptions()
  ("help", print_help, false, "this help text")
  ("config,c", po::parseConfigFile, "configuration file name")

183
184
  (po::Section("General"))

185
  ("mode", params.mode, CODEC_MODE_ENCODE,
186
187
188
189
190
191
    "The encoding/decoding mode:\n"
    "  0: encode\n"
    "  1: decode\n"
    // NB: the following forms are deprecated
    "  2: encode with lossless geometry\n"
    "  3: decode with lossless geometry")
192
193
194

  // i/o parameters
  ("reconstructedDataPath",
195
196
    params.reconstructedDataPath, {},
    "The ouput reconstructed pointcloud file path (decoder only)")
197
198

  ("uncompressedDataPath",
199
200
    params.uncompressedDataPath, {},
    "The input pointcloud file path")
201
202

  ("compressedStreamPath",
203
204
    params.compressedStreamPath, {},
    "The compressed bitstream path (encoder=output, decoder=input)")
205

206
  ("postRecolorPath",
207
208
    params.encodeParameters.postRecolorPath, {},
    "Recolored pointcloud file path (encoder only)")
209
210

  ("preInvScalePath",
211
212
    params.decodeParameters.preInvScalePath, {},
    "Pre inverse scaled pointcloud file path (decoder only)")
213

214
215
  // general
  ("colorTransform",
216
217
218
219
    params.colorTransform, COLOR_TRANSFORM_RGB_TO_YCBCR,
    "The colour transform to be applied:\n"
    "  0: none\n"
    "  1: RGB to YCbCr (Rec.709)")
220

221
222
223
224
225
226
227
228
  (po::Section("Decoder"))

  ("roundOutputPositions",
    params.decodeParameters.roundOutputPositions, false,
    "todo(kmammou)")

  (po::Section("Encoder"))

229
  ("positionQuantizationScale",
230
231
    params.encodeParameters.positionQuantizationScale, 1.,
    "Scale factor to be applied to point positions during quantization process")
232
233

  ("mergeDuplicatedPoints",
234
235
    params.encodeParameters.mergeDuplicatedPoints, true,
    "Enables removal of duplicated points")
236

237
  (po::Section("Geometry"))
238

239
  // tools
240
  ("geometryCodec",
241
242
243
244
245
    params.encodeParameters.geometryCodec, GeometryCodecType::kOctree,
    "Controls the method used to encode geometry:"
    "  0: bypass (a priori)\n"
    "  1: octree (TMC3)\n"
    "  2: trisoup (TMC1)")
246

247
248
249
  ("neighbourContextRestriction",
    params.encodeParameters.neighbourContextRestriction, false,
    "Limit geometry octree occupancy contextualisation to sibling nodes")
250

251
  ("inferredDirectCodingMode",
252
253
    params.encodeParameters.inferredDirectCodingModeEnabled, true,
    "Permits early termination of the geometry octree for isolated points")
254

255
256
  // (trisoup) geometry parameters
  ("triSoupDepth",  // log2(maxBB+1), where maxBB+1 is analogous to image width
257
258
    params.encodeParameters.triSoup.depth, 10,
    "Depth of voxels (reconstructed points) in trisoup geometry")
259
260

  ("triSoupLevel",
261
262
    params.encodeParameters.triSoup.level, 7,
    "Level of triangles (reconstructed surface) in trisoup geometry")
263
264

  ("triSoupIntToOrigScale",  // reciprocal of positionQuantizationScale
265
266
    params.encodeParameters.triSoup.intToOrigScale, 1.,
    "orig_coords = integer_coords * intToOrigScale + intToOrigTranslation")
267
268

  ("triSoupIntToOrigTranslation",
269
270
    params.encodeParameters.triSoup.intToOrigTranslation, {0., 0., 0.},
    "orig_coords = integer_coords * intToOrigScale + intToOrigTranslation")
271

272
273
  (po::Section("Attributes"))

274
275
276
  // attribute processing
  //   NB: Attribute options are special in the way they are applied (see above)
  ("attribute",
277
278
279
    attribute_setter,
    "Encode the given attribute (NB, must appear after the"
    "following attribute parameters)")
280
281

  ("searchRange",
282
283
    params_attr.searchRange, size_t(0),
    "Attribute's todo(kmammou)")
284

285
  ("transformType",
286
287
288
289
    params_attr.transformType, TransformType::kIntegerLift,
    "Coding method to use for attribute:\n"
    "  0: Nearest neighbour prediction with integer lifting transform\n"
    "  1: Region Adaptive Hierarchical Transform (RAHT)")
290

291
  ("rahtLeafDecimationDepth",
292
293
294
    params_attr.binaryLevelThresholdRaht, 3,
    "Sets coefficients to zero in the bottom n levels of RAHT tree. "
    "Used for chroma-subsampling in attribute=color only.")
295

296
  ("rahtQuantizationStep",
297
298
    params_attr.quantizationStepRaht, 1,
    "Quantization step size used in RAHT")
299
300

  ("rahtDepth",
301
302
303
    params_attr.depthRaht, 21,
    "Number of bits for morton representation of an RAHT co-ordinate"
    "component")
304

305
  ("numberOfNearestNeighborsInPrediction",
306
307
    params_attr.numberOfNearestNeighborsInPrediction, size_t(4),
    "Attribute's maximum number of nearest neighbors to be used for prediction")
308
309

  ("levelOfDetailCount",
310
311
    params_attr.levelOfDetailCount, size_t(6),
    "Attribute's number of levels of detail")
312
313

  ("quantizationSteps",
314
315
    params_attr.quantizationSteps, {},
    "Attribute's list of quantization step sizes (one for each LoD)")
316
317

  ("dist2", params_attr.dist2, {},
318
    "Attribute's list of squared distances (one for each LoD)")
319
  ;
320
  /* clang-format on */
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335

  po::setDefaults(opts);
  po::ErrorReporter err;
  const list<const char*>& argv_unhandled =
    po::scanArgv(opts, argc, (const char**)argv, err);

  for (const auto arg : argv_unhandled) {
    err.warn() << "Unhandled argument ignored: " << arg << "\n";
  }

  if (argc == 1 || print_help) {
    po::doHelp(std::cout, opts, 78);
    return false;
  }

336
337
338
339
340
341
342
343
344
345
346
347
  // Set GeometryCodecType according to codec mode
  // NB: for bypass, the decoder must load the a priori geometry
  if (params.mode == 2 || params.mode == 3) {
    params.encodeParameters.geometryCodec = GeometryCodecType::kBypass;
  }
  if (params.mode == 4) {
    params.encodeParameters.geometryCodec = GeometryCodecType::kTriSoup;
  }

  // Restore params.mode to be encode vs decode
  params.mode = CodecMode(params.mode & 1);

348
  // For trisoup, ensure that positionQuantizationScale is the exact inverse of intToOrigScale.
349
  if (params.encodeParameters.geometryCodec == GeometryCodecType::kTriSoup) {
350
    params.encodeParameters.positionQuantizationScale =
351
      1.0 / params.encodeParameters.triSoup.intToOrigScale;
352
353
  }

354
  // For RAHT, ensure that the unused lod count = 0 (prevents mishaps)
355
  for (auto& attr : params.encodeParameters.attributeEncodeParameters) {
356
357
358
359
360
    if (attr.second.transformType != TransformType::kIntegerLift) {
      attr.second.levelOfDetailCount = 0;
    }
  }

361
  // sanity checks
362
  //  - validate that quantizationSteps, dist2
363
  //    of each attribute contain levelOfDetailCount elements.
364
  for (const auto& attr : params.encodeParameters.attributeEncodeParameters) {
365
366
    if (attr.second.transformType == TransformType::kIntegerLift) {
      int lod = attr.second.levelOfDetailCount;
367

368
369
      if (lod > 255) {
        err.error() << attr.first
370
                    << ".levelOfDetailCount must be less than 256\n";
371
372
      }
      if (attr.second.dist2.size() != lod) {
373
374
        err.error() << attr.first << ".dist2 does not have " << lod
                    << " entries\n";
375
376
      }
      if (attr.second.quantizationSteps.size() != lod) {
377
378
        err.error() << attr.first << ".quantizationSteps does not have " << lod
                    << " entries\n";
379
      }
380
381
382
383
384
      if (
        attr.second.numberOfNearestNeighborsInPrediction
        > PCCTMC3MaxPredictionNearestNeighborCount) {
        err.error()
          << attr.first
385
386
387
          << ".numberOfNearestNeighborsInPrediction must be less than "
          << PCCTMC3MaxPredictionNearestNeighborCount << "\n";
      }
388
    }
Khaled Mammou's avatar
TMC3v0  
Khaled Mammou committed
389
390
  }

391
392
  // check required arguments are specified

393
  const bool encode = params.mode == CODEC_MODE_ENCODE;
394
395
396
397
398
399
400
401
402
403
404
405

  if (encode && params.uncompressedDataPath.empty())
    err.error() << "uncompressedDataPath not set\n";

  if (!encode && params.reconstructedDataPath.empty())
    err.error() << "reconstructedDataPath not set\n";

  if (params.compressedStreamPath.empty())
    err.error() << "compressedStreamPath not set\n";

  // currently the attributes with lossless geometry require the source data
  // todo(?): remove this dependency by improving reporting
406
407
408
  if (
    params.encodeParameters.geometryCodec == GeometryCodecType::kBypass
    && params.uncompressedDataPath.empty())
409
410
411
412
413
414
415
    err.error() << "uncompressedDataPath not set\n";

  // report the current configuration (only in the absence of errors so
  // that errors/warnings are more obvious and in the same place).
  if (err.is_errored)
    return false;

416
417
  // Dump the complete derived configuration
  cout << "+ Effective configuration parameters\n";
418

419
420
421
  po::dumpCfg(cout, opts, "General", 4);
  if (params.mode == CODEC_MODE_DECODE) {
    po::dumpCfg(cout, opts, "Decoder", 4);
422
  } else {
423
424
425
426
427
428
429
430
431
    po::dumpCfg(cout, opts, "Encoder", 4);
    po::dumpCfg(cout, opts, "Geometry", 4);

    for (const auto& it : params.encodeParameters.attributeEncodeParameters) {
      // NB: when dumping the config, opts references params_attr
      params_attr = it.second;
      cout << "    " << it.first << "\n";
      po::dumpCfg(cout, opts, "Attributes", 8);
    }
Khaled Mammou's avatar
TMC3v0  
Khaled Mammou committed
432
433
  }

434
435
  cout << endl;

Khaled Mammou's avatar
TMC3v0  
Khaled Mammou committed
436
437
  return true;
}
438

439
440
441
int
Compress(const Parameters& params, Stopwatch& clock)
{
Khaled Mammou's avatar
TMC3v0  
Khaled Mammou committed
442
  PCCPointSet3 pointCloud;
443
444
445
  if (
    !pointCloud.read(params.uncompressedDataPath)
    || pointCloud.getPointCount() == 0) {
Khaled Mammou's avatar
TMC3v0  
Khaled Mammou committed
446
447
448
449
    cout << "Error: can't open input file!" << endl;
    return -1;
  }

450
451
  clock.start();

Khaled Mammou's avatar
TMC3v0  
Khaled Mammou committed
452
453
454
455
456
457
  if (params.colorTransform == COLOR_TRANSFORM_RGB_TO_YCBCR) {
    pointCloud.convertRGBToYUV();
  }
  PCCTMC3Encoder3 encoder;
  PCCBitstream bitstream = {};
  const size_t predictedBitstreamSize =
458
    encoder.estimateBitstreamSize(pointCloud, params.encodeParameters);
459
  std::unique_ptr<uint8_t[]> buffer(new uint8_t[predictedBitstreamSize]);
Khaled Mammou's avatar
TMC3v0  
Khaled Mammou committed
460
461
462
463
464
465
466
467
468
  bitstream.buffer = buffer.get();
  bitstream.capacity = predictedBitstreamSize;
  bitstream.size = 0;

  std::unique_ptr<PCCPointSet3> reconstructedPointCloud;
  if (!params.reconstructedDataPath.empty()) {
    reconstructedPointCloud.reset(new PCCPointSet3);
  }

469
  int ret = encoder.compress(
470
471
    pointCloud, params.encodeParameters, bitstream,
    reconstructedPointCloud.get());
472
  if (ret) {
Khaled Mammou's avatar
TMC3v0  
Khaled Mammou committed
473
474
475
    cout << "Error: can't compress point cloud!" << endl;
    return -1;
  }
476

477
478
  clock.stop();

Khaled Mammou's avatar
TMC3v0  
Khaled Mammou committed
479
480
481
482
483
484
  assert(bitstream.size <= bitstream.capacity);
  std::cout << "Total bitstream size " << bitstream.size << " B" << std::endl;
  ofstream fout(params.compressedStreamPath, ios::binary);
  if (!fout.is_open()) {
    return -1;
  }
485
  fout.write(reinterpret_cast<const char*>(bitstream.buffer), bitstream.size);
Khaled Mammou's avatar
TMC3v0  
Khaled Mammou committed
486
487
488
489
490
491
492
493
494
495
496
  fout.close();

  if (!params.reconstructedDataPath.empty()) {
    if (params.colorTransform == COLOR_TRANSFORM_RGB_TO_YCBCR) {
      reconstructedPointCloud->convertYUVToRGB();
    }
    reconstructedPointCloud->write(params.reconstructedDataPath, true);
  }

  return 0;
}
497
498
499
int
Decompress(const Parameters& params, Stopwatch& clock)
{
Khaled Mammou's avatar
TMC3v0  
Khaled Mammou committed
500
501
502
503
504
505
506
507
508
509
510
511
  PCCBitstream bitstream = {};
  ifstream fin(params.compressedStreamPath, ios::binary);
  if (!fin.is_open()) {
    return -1;
  }
  fin.seekg(0, std::ios::end);
  uint64_t bitStreamSize = fin.tellg();
  fin.seekg(0, std::ios::beg);
  unique_ptr<uint8_t[]> buffer(new uint8_t[bitStreamSize]);
  bitstream.buffer = buffer.get();
  bitstream.capacity = bitStreamSize;
  bitstream.size = 0;
512
  fin.read(reinterpret_cast<char*>(bitstream.buffer), bitStreamSize);
Khaled Mammou's avatar
TMC3v0  
Khaled Mammou committed
513
514
515
516
517
  if (!fin) {
    return -1;
  }
  fin.close();

518
519
  clock.start();

Khaled Mammou's avatar
TMC3v0  
Khaled Mammou committed
520
521
  PCCTMC3Decoder3 decoder;
  PCCPointSet3 pointCloud;
522
523
524

  // read a priori geometry from input file for bypass case
  if (params.encodeParameters.geometryCodec == GeometryCodecType::kBypass) {
525
526
527
    if (
      !pointCloud.read(params.uncompressedDataPath)
      || pointCloud.getPointCount() == 0) {
528
529
530
531
532
533
534
      cout << "Error: can't open input file!" << endl;
      return -1;
    }
    pointCloud.removeReflectances();
    pointCloud.removeColors();
  }

535
  int ret = decoder.decompress(params.decodeParameters, bitstream, pointCloud);
536
  if (ret) {
Khaled Mammou's avatar
TMC3v0  
Khaled Mammou committed
537
538
539
540
541
542
543
544
545
546
    cout << "Error: can't decompress point cloud!" << endl;
    return -1;
  }
  assert(bitstream.size <= bitstream.capacity);
  std::cout << "Total bitstream size " << bitstream.size << " B" << std::endl;

  if (params.colorTransform == COLOR_TRANSFORM_RGB_TO_YCBCR) {
    pointCloud.convertYUVToRGB();
  }

547
548
  clock.stop();

Khaled Mammou's avatar
TMC3v0  
Khaled Mammou committed
549
550
551
552
553
554
  if (!pointCloud.write(params.reconstructedDataPath, true)) {
    cout << "Error: can't open output file!" << endl;
    return -1;
  }
  return 0;
}