TMC3.cpp 27 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"
David Flynn's avatar
David Flynn committed
37
38
39
40
41

#include <memory>

#include "PCCTMC3Encoder.h"
#include "PCCTMC3Decoder.h"
42
#include "constants.h"
43
#include "program_options_lite.h"
44
#include "io_tlv.h"
45
#include "version.h"
Khaled Mammou's avatar
TMC3v0  
Khaled Mammou committed
46
47
48
49

using namespace std;
using namespace pcc;

50
51
52
53
54
//============================================================================

struct Parameters {
  bool isDecoder;

55
56
57
  // command line parsing should adjust dist2 values according to PQS
  bool positionQuantizationScaleAdjustsDist2;

58
59
60
  // output mode for ply writing (binary or ascii)
  bool outputBinaryPly;

61
62
63
  // when true, configure the encoder as if no attributes are specified
  bool disableAttributeCoding;

64
65
66
67
  std::string uncompressedDataPath;
  std::string compressedStreamPath;
  std::string reconstructedDataPath;

68
69
70
  // Filename for saving pre inverse scaled point cloud.
  std::string preInvScalePath;

71
72
73
74
75
  pcc::EncoderParams encoder;
  pcc::DecoderParams decoder;

  // todo(df): this should be per-attribute
  ColorTransform colorTransform;
76
77
78

  // todo(df): this should be per-attribute
  int reflectanceScale;
79
80
81
82
};

//============================================================================

83
84
85
int
main(int argc, char* argv[])
{
86
  cout << "MPEG PCC tmc3 version " << ::pcc::version << endl;
87

Khaled Mammou's avatar
TMC3v0  
Khaled Mammou committed
88
89
90
91
  Parameters params;
  if (!ParseParameters(argc, argv, params)) {
    return -1;
  }
92
93
94
95
96
97
98

  // 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
99
  int ret = 0;
100
  if (params.isDecoder) {
101
    ret = Decompress(params, clock_user);
102
103
  } else {
    ret = Compress(params, clock_user);
Khaled Mammou's avatar
TMC3v0  
Khaled Mammou committed
104
105
  }

106
107
108
109
110
111
112
113
  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
114
115
116
  return ret;
}

117
118
119
//---------------------------------------------------------------------------
// :: Command line / config parsing helpers

120
121
122
123
template<typename T>
static std::istream&
readUInt(std::istream& in, T& val)
{
124
125
126
127
128
129
  unsigned int tmp;
  in >> tmp;
  val = T(tmp);
  return in;
}

130
131
132
static std::istream&
operator>>(std::istream& in, ColorTransform& val)
{
133
134
135
  return readUInt(in, val);
}

136
namespace pcc {
137
static std::istream&
138
operator>>(std::istream& in, AttributeEncoding& val)
139
{
140
  return readUInt(in, val);
141
142
}
}  // namespace pcc
143

144
145
146
147
148
149
150
151
namespace pcc {
static std::istream&
operator>>(std::istream& in, PartitionMethod& val)
{
  return readUInt(in, val);
}
}  // namespace pcc

152
namespace pcc {
153
static std::ostream&
154
operator<<(std::ostream& out, const AttributeEncoding& val)
155
{
156
  switch (val) {
157
158
159
  case AttributeEncoding::kPredictingTransform: out << "0 (Pred)"; break;
  case AttributeEncoding::kRAHTransform: out << "1 (RAHT)"; break;
  case AttributeEncoding::kLiftingTransform: out << "2 (Lift)"; break;
160
161
  }
  return out;
162
163
}
}  // namespace pcc
164

165
166
167
168
169
170
namespace pcc {
static std::ostream&
operator<<(std::ostream& out, const PartitionMethod& val)
{
  switch (val) {
  case PartitionMethod::kNone: out << "0 (None)"; break;
171
  case PartitionMethod::kUniformGeom: out << "0 (UniformGeom)"; break;
172
  case PartitionMethod::kOctreeUniform: out << "0 (UniformOctree)"; break;
173
  default: out << int(val) << " (Unknown)"; break;
174
175
176
177
178
  }
  return out;
}
}  // namespace pcc

179
180
181
namespace df {
namespace program_options_lite {
  template<typename T>
182
  struct option_detail<pcc::Vec3<T>> {
183
184
185
186
    static constexpr bool is_container = true;
    static constexpr bool is_fixed_size = true;
    typedef T* output_iterator;

187
188
    static void clear(pcc::Vec3<T>& container){};
    static output_iterator make_output_iterator(pcc::Vec3<T>& container)
189
190
191
192
193
194
195
    {
      return &container[0];
    }
  };
}  // namespace program_options_lite
}  // namespace df

196
197
198
//---------------------------------------------------------------------------
// :: Command line / config parsing

199
200
201
bool
ParseParameters(int argc, char* argv[], Parameters& params)
{
202
203
  namespace po = df::program_options_lite;

204
205
206
  struct {
    AttributeDescription desc;
    AttributeParameterSet aps;
207
    EncoderAttributeParams encoder;
208
209
  } params_attr;

210
211
212
213
214
215
216
217
218
219
220
221
222
  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"
      //
223
224
225
226
227
228
229
230

      // NB: insert returns any existing element
      const auto& it = params.encoder.attributeIdxMap.insert(
        {name, int(params.encoder.attributeIdxMap.size())});

      if (it.second) {
        params.encoder.sps.attributeSets.push_back(params_attr.desc);
        params.encoder.aps.push_back(params_attr.aps);
231
        params.encoder.attr.push_back(params_attr.encoder);
232
233
234
235
236
237
        return;
      }

      // update existing entry
      params.encoder.sps.attributeSets[it.first->second] = params_attr.desc;
      params.encoder.aps[it.first->second] = params_attr.aps;
238
      params.encoder.attr[it.first->second] = params_attr.encoder;
239
240
    };

241
  /* clang-format off */
242
243
244
245
246
247
248
249
250
251
252
  // 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")

253
254
  (po::Section("General"))

255
  ("mode", params.isDecoder, false,
256
257
    "The encoding/decoding mode:\n"
    "  0: encode\n"
258
    "  1: decode")
259
260
261

  // i/o parameters
  ("reconstructedDataPath",
262
263
    params.reconstructedDataPath, {},
    "The ouput reconstructed pointcloud file path (decoder only)")
264
265

  ("uncompressedDataPath",
266
267
    params.uncompressedDataPath, {},
    "The input pointcloud file path")
268
269

  ("compressedStreamPath",
270
271
    params.compressedStreamPath, {},
    "The compressed bitstream path (encoder=output, decoder=input)")
272

273
  ("postRecolorPath",
274
    params.encoder.postRecolorPath, {},
275
    "Recolored pointcloud file path (encoder only)")
276
277

  ("preInvScalePath",
278
    params.preInvScalePath, {},
279
    "Pre inverse scaled pointcloud file path (decoder only)")
280

281
282
283
284
  ("outputBinaryPly",
    params.outputBinaryPly, false,
    "Output ply files using binary (or otherwise ascii) format")

285
  // general
286
  // todo(df): this should be per-attribute
287
  ("colorTransform",
288
289
290
291
    params.colorTransform, COLOR_TRANSFORM_RGB_TO_YCBCR,
    "The colour transform to be applied:\n"
    "  0: none\n"
    "  1: RGB to YCbCr (Rec.709)")
292

293
294
295
296
297
298
  // todo(df): this should be per-attribute
  ("hack.reflectanceScale",
    params.reflectanceScale, 1,
    "scale factor to be applied to reflectance "
    "pre encoding / post reconstruction")

299
300
  // NB: if adding decoder options, uncomment the Decoder section marker
  // (po::Section("Decoder"))
301
302
303

  (po::Section("Encoder"))

304
305
306
307
308
309
310
311
312
  ("seq_bounding_box_xyz0",
    params.encoder.sps.seq_bounding_box_xyz0, {0},
    "seq_bounding_box_xyz0.  NB: seq_bounding_box_whd must be set for this "
    "parameter to have an effect")

  ("seq_bounding_box_whd",
    params.encoder.sps.seq_bounding_box_whd, {0},
    "seq_bounding_box_whd")

313
  ("positionQuantizationScale",
314
    params.encoder.sps.seq_source_geom_scale_factor, 1.f,
315
    "Scale factor to be applied to point positions during quantization process")
316

317
318
319
320
  ("positionQuantizationScaleAdjustsDist2",
    params.positionQuantizationScaleAdjustsDist2, false,
    "Scale dist2 values by squared positionQuantizationScale")

321
  ("mergeDuplicatedPoints",
322
    params.encoder.gps.geom_unique_points_flag, true,
323
    "Enables removal of duplicated points")
324

325
326
327
  ("partitionMethod",
    params.encoder.partitionMethod, PartitionMethod::kNone,
    "Method used to partition input point cloud into slices/tiles:\n"
328
329
    "  0: none\n"
    "  1: none (deprecated)\n"
330
331
    "  2: n Uniform-Geometry partition bins along the longest edge\n"
    "  3: Uniform Geometry partition at n octree depth")
332
333
334
335
336
337

  ("partitionNumUniformGeom",
    params.encoder.partitionNumUniformGeom, 0,
    "Number of bins for partitionMethod=2:\n"
    "  0: slice partition with adaptive-defined bins\n"
    "  >=1: slice partition with user-defined bins\n")
338

339
340
341
342
  ("partitionOctreeDepth",
    params.encoder.partitionOctreeDepth, 2,
    "Depth of octree partition for partitionMethod=3")

343
344
345
346
  ("disableAttributeCoding",
    params.disableAttributeCoding, false,
    "Ignore attribute coding configuration")

347
  (po::Section("Geometry"))
348

349
  // tools
350
351
352
353
354
355
  ("bitwiseOccupancyCoding",
    params.encoder.gps.bitwise_occupancy_coding_flag, true,
    "Selects between bitwise and bytewise occupancy coding:\n"
    "  0: bytewise\n"
    "  1: bitwise")

356
  ("neighbourContextRestriction",
357
    params.encoder.gps.neighbour_context_restriction_flag, false,
358
    "Limit geometry octree occupancy contextualisation to sibling nodes")
359

360
  ("neighbourAvailBoundaryLog2",
361
    params.encoder.gps.neighbour_avail_boundary_log2, 0,
362
363
364
    "Defines the avaliability volume for neighbour occupancy lookups."
    " 0: unconstrained")

365
  ("inferredDirectCodingMode",
366
    params.encoder.gps.inferred_direct_coding_mode_enabled_flag, true,
367
    "Permits early termination of the geometry octree for isolated points")
368

369
370
371
372
  ("adjacentChildContextualization",
    params.encoder.gps.adjacent_child_contextualization_enabled_flag, true,
    "Occupancy contextualization using neighbouring adjacent children")

373
374
375
376
  ("intra_pred_max_node_size_log2",
    params.encoder.gps.intra_pred_max_node_size_log2, 0,
    "octree nodesizes eligible for occupancy intra prediction")

377
378
379
380
  ("ctxOccupancyReductionFactor",
     params.encoder.gps.geom_occupancy_ctx_reduction_factor, 3,
     "Adjusts the number of contexts used in occupancy coding")

381
382
383
384
  ("trisoup_node_size_log2",
    params.encoder.gps.trisoup_node_size_log2, 0,
    "Size of nodes for surface triangulation.\n"
    "  0: disabled\n")
385

386
387
  (po::Section("Attributes"))

388
389
390
  // attribute processing
  //   NB: Attribute options are special in the way they are applied (see above)
  ("attribute",
391
392
393
    attribute_setter,
    "Encode the given attribute (NB, must appear after the"
    "following attribute parameters)")
394

395
396
397
398
  ("bitdepth",
    params_attr.desc.attr_bitdepth, 8,
    "Attribute bitdepth")

399
  ("transformType",
400
    params_attr.aps.attr_encoding, AttributeEncoding::kPredictingTransform,
401
    "Coding method to use for attribute:\n"
402
    "  0: Hierarchical neighbourhood prediction\n"
403
    "  1: Region Adaptive Hierarchical Transform (RAHT)\n"
404
    "  2: Hierarichical neighbourhood prediction as lifting transform")
405
406

  ("rahtDepth",
407
    params_attr.aps.raht_depth, 21,
408
409
    "Number of bits for morton representation of an RAHT co-ordinate"
    "component")
410

411
412
413
414
  ("rahtPredictionEnabled",
    params_attr.aps.raht_prediction_enabled_flag, true,
    "Controls the use of transform-domain prediction")

415
  ("numberOfNearestNeighborsInPrediction",
416
    params_attr.aps.num_pred_nearest_neighbours, 3,
417
    "Attribute's maximum number of nearest neighbors to be used for prediction")
418

419
420
421
422
423
424
  ("adaptivePredictionThreshold",
    params_attr.aps.adaptive_prediction_threshold, -1,
    "Neighbouring attribute value difference that enables choice of "
    "single|multi predictors. Applies to transformType=2 only.\n"
    "  -1: auto = 2**(bitdepth-2)")

425
426
427
428
  ("attributeSearchRange",
    params_attr.aps.search_range, 128,
    "Range for nearest neighbor search")

429
430
431
432
433
434
  ("lodDecimation",
    params_attr.aps.lod_decimation_enabled_flag, false,
    "Controls LoD generation method:\n"
    " 0: distance based subsampling\n"
    " 1: decimation by 1:3")

435
436
437
438
439
  ("max_num_direct_predictors",
    params_attr.aps.max_num_direct_predictors, 3,
    "Maximum number of nearest neighbour candidates used in direct"
    "attribute prediction")

440
  ("levelOfDetailCount",
441
    params_attr.aps.num_detail_levels, 1,
442
    "Attribute's number of levels of detail")
443

444
445
  ("dist2",
    params_attr.aps.dist2, {},
446
447
    "Attribute's list of squared distances, or initial value for automatic"
    "derivation")
448

449
450
451
452
  ("intraLodPredictionEnabled",
    params_attr.aps.intra_lod_prediction_enabled_flag, false,
    "Permits referring to points in same LoD")

453
454
455
456
457
458
459
  ("qp",
    params_attr.aps.init_qp, 4,
    "Attribute's luma quantisation parameter")

  ("qpChromaOffset",
    params_attr.aps.aps_chroma_qp_offset, 0,
    "Attribute's chroma quantisation parameter offset (relative to luma)")
460
461
462
463

  ("aps_slice_qp_deltas_present_flag",
    params_attr.aps.aps_slice_qp_deltas_present_flag, false,
    "Enable signalling of per-slice QP values")
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520

  // This section is just dedicated to attribute recolouring (encoder only).
  // parameters are common to all attributes.
  (po::Section("Recolouring"))

  ("recolourSearchRange",
    params.encoder.recolour.searchRange, 8,
    "")

  ("recolourNumNeighboursFwd",
    params.encoder.recolour.numNeighboursFwd, 8,
    "")

  ("recolourNumNeighboursBwd",
    params.encoder.recolour.numNeighboursBwd, 1,
    "")

  ("recolourUseDistWeightedAvgFwd",
    params.encoder.recolour.useDistWeightedAvgFwd, true,
    "")

  ("recolourUseDistWeightedAvgBwd",
    params.encoder.recolour.useDistWeightedAvgBwd, true,
    "")

  ("recolourSkipAvgIfIdenticalSourcePointPresentFwd",
    params.encoder.recolour.skipAvgIfIdenticalSourcePointPresentFwd, true,
    "")

  ("recolourSkipAvgIfIdenticalSourcePointPresentBwd",
    params.encoder.recolour.skipAvgIfIdenticalSourcePointPresentBwd, false,
    "")

  ("recolourDistOffsetFwd",
    params.encoder.recolour.distOffsetFwd, 4.,
    "")

  ("recolourDistOffsetBwd",
    params.encoder.recolour.distOffsetBwd, 4.,
    "")

  ("recolourMaxGeometryDist2Fwd",
    params.encoder.recolour.maxGeometryDist2Fwd, 1000.,
    "")

  ("recolourMaxGeometryDist2Bwd",
    params.encoder.recolour.maxGeometryDist2Bwd, 1000.,
    "")

  ("recolourMaxAttributeDist2Fwd",
    params.encoder.recolour.maxAttributeDist2Fwd, 1000.,
    "")

  ("recolourMaxAttributeDist2Bwd",
    params.encoder.recolour.maxAttributeDist2Bwd, 1000.,
    "")

521
  ;
522
  /* clang-format on */
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537

  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;
  }

538
539
  // Certain coding modes are not available when trisoup is enabled.
  // Disable them, and warn if set (they may be set as defaults).
540
  if (params.encoder.gps.trisoup_node_size_log2 > 0) {
541
542
543
544
545
546
547
548
549
550
    if (!params.encoder.gps.geom_unique_points_flag)
      err.warn() << "TriSoup geometry does not preserve duplicated points\n";

    if (params.encoder.gps.inferred_direct_coding_mode_enabled_flag)
      err.warn() << "TriSoup geometry is incompatable with IDCM\n";

    params.encoder.gps.geom_unique_points_flag = true;
    params.encoder.gps.inferred_direct_coding_mode_enabled_flag = false;
  }

551
552
553
554
555
556
557
  // support disabling attribute coding (simplifies configuration)
  if (params.disableAttributeCoding) {
    params.encoder.attributeIdxMap.clear();
    params.encoder.sps.attributeSets.clear();
    params.encoder.aps.clear();
  }

558
  // fixup any per-attribute settings
559
  for (const auto& it : params.encoder.attributeIdxMap) {
560
    auto& attr_sps = params.encoder.sps.attributeSets[it.second];
561
562
    auto& attr_aps = params.encoder.aps[it.second];

563
564
    // Avoid wasting bits signalling chroma quant step size for reflectance
    if (it.first == "reflectance") {
565
      attr_aps.aps_chroma_qp_offset = 0;
566
567
    }

568
569
570
571
572
    bool isLifting =
      attr_aps.attr_encoding == AttributeEncoding::kPredictingTransform
      || attr_aps.attr_encoding == AttributeEncoding::kLiftingTransform;

    // derive the dist2 values based on an initial value
573
574
    if (isLifting) {
      if (attr_aps.dist2.size() > attr_aps.num_detail_levels) {
575
        attr_aps.dist2.resize(attr_aps.num_detail_levels);
576
577
578
579
580
581
582
583
584
585
586
      } else if (
        attr_aps.dist2.size() < attr_aps.num_detail_levels
        && !attr_aps.dist2.empty()) {
        if (attr_aps.dist2.size() < attr_aps.num_detail_levels) {
          attr_aps.dist2.resize(attr_aps.num_detail_levels);
          const double distRatio = 4.0;
          uint64_t d2 = attr_aps.dist2[0];
          for (int i = 0; i < attr_aps.num_detail_levels; ++i) {
            attr_aps.dist2[i] = d2;
            d2 = uint64_t(std::round(distRatio * d2));
          }
587
588
589
        }
      }
    }
590
591
592
593
594
595
596
597
598
599
600
    // In order to simplify specification of dist2 values, which are
    // depending on the scale of the coded point cloud, the following
    // adjust the dist2 values according to PQS.  The user need only
    // specify the unquantised PQS value.
    if (params.positionQuantizationScaleAdjustsDist2) {
      double pqs = params.encoder.sps.seq_source_geom_scale_factor;
      double pqs2 = pqs * pqs;
      for (auto& dist2 : attr_aps.dist2)
        dist2 = int64_t(std::round(pqs2 * dist2));
    }

601
602
603
604
605
606
607
608
    // Set default threshold based on bitdepth
    if (attr_aps.adaptive_prediction_threshold == -1) {
      attr_aps.adaptive_prediction_threshold = 1
        << (attr_sps.attr_bitdepth - 2);
    }

    if (attr_aps.attr_encoding == AttributeEncoding::kLiftingTransform) {
      attr_aps.adaptive_prediction_threshold = 0;
609
      attr_aps.intra_lod_prediction_enabled_flag = false;
610
611
612
    }

    // For RAHT, ensure that the unused lod count = 0 (prevents mishaps)
613
    if (attr_aps.attr_encoding == AttributeEncoding::kRAHTransform) {
614
      attr_aps.num_detail_levels = 0;
615
      attr_aps.adaptive_prediction_threshold = 0;
616
617
618
    }
  }

619
  // sanity checks
620
621
622
623
624
625

  if (params.encoder.gps.intra_pred_max_node_size_log2)
    if (!params.encoder.gps.neighbour_avail_boundary_log2)
      err.error() << "Geometry intra prediction requires finite"
                     "neighbour_avail_boundary_log2\n";

626
627
628
629
630
631
632
633
  for (const auto& it : params.encoder.attributeIdxMap) {
    const auto& attr_sps = params.encoder.sps.attributeSets[it.second];
    const auto& attr_aps = params.encoder.aps[it.second];

    bool isLifting =
      attr_aps.attr_encoding == AttributeEncoding::kPredictingTransform
      || attr_aps.attr_encoding == AttributeEncoding::kLiftingTransform;

634
635
636
637
638
639
640
641
642
643
644
    if (it.first == "color") {
      // todo(??): permit relaxing of the following constraint
      if (attr_sps.attr_bitdepth > 8)
        err.error() << it.first << ".bitdepth must be less than 9\n";
    }

    if (it.first == "reflectance") {
      if (attr_sps.attr_bitdepth > 16)
        err.error() << it.first << ".bitdepth must be less than 17\n";
    }

645
    if (isLifting) {
646
      int lod = attr_aps.num_detail_levels;
647
      if (lod > 255 || lod < 0) {
648
        err.error() << it.first
649
                    << ".levelOfDetailCount must be in the range [0,255]\n";
650
      }
651
652
      if (attr_aps.dist2.size() != lod) {
        err.error() << it.first << ".dist2 does not have " << lod
653
                    << " entries\n";
654
      }
655

656
657
658
659
660
      if (attr_aps.adaptive_prediction_threshold < 0) {
        err.error() << it.first
                    << ".adaptivePredictionThreshold must be positive\n";
      }

661
      if (
662
        attr_aps.num_pred_nearest_neighbours
663
        > kAttributePredictionMaxNeighbourCount) {
664
665
        err.error() << it.first
                    << ".numberOfNearestNeighborsInPrediction must be <= "
666
                    << kAttributePredictionMaxNeighbourCount << "\n";
667
      }
668
    }
669
670
671
672
673
674
675
676

    if (attr_aps.init_qp < 4)
      err.error() << it.first << ".qp must be greater than 3\n";

    if (attr_aps.init_qp + attr_aps.aps_chroma_qp_offset < 4) {
      err.error() << it.first << ".qpChromaOffset must be greater than "
                  << attr_aps.init_qp - 5 << "\n";
    }
Khaled Mammou's avatar
TMC3v0  
Khaled Mammou committed
677
678
  }

679
680
  // check required arguments are specified

681
  if (!params.isDecoder && params.uncompressedDataPath.empty())
682
683
    err.error() << "uncompressedDataPath not set\n";

684
  if (params.isDecoder && params.reconstructedDataPath.empty())
685
686
687
688
689
690
691
692
693
694
    err.error() << "reconstructedDataPath not set\n";

  if (params.compressedStreamPath.empty())
    err.error() << "compressedStreamPath 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;

695
696
  // Dump the complete derived configuration
  cout << "+ Effective configuration parameters\n";
697

698
  po::dumpCfg(cout, opts, "General", 4);
699
  if (params.isDecoder) {
700
    po::dumpCfg(cout, opts, "Decoder", 4);
701
  } else {
702
703
    po::dumpCfg(cout, opts, "Encoder", 4);
    po::dumpCfg(cout, opts, "Geometry", 4);
704
    po::dumpCfg(cout, opts, "Recolouring", 4);
705

706
    for (const auto& it : params.encoder.attributeIdxMap) {
707
      // NB: when dumping the config, opts references params_attr
708
709
      params_attr.desc = params.encoder.sps.attributeSets[it.second];
      params_attr.aps = params.encoder.aps[it.second];
710
      params_attr.encoder = params.encoder.attr[it.second];
711
712
713
      cout << "    " << it.first << "\n";
      po::dumpCfg(cout, opts, "Attributes", 8);
    }
Khaled Mammou's avatar
TMC3v0  
Khaled Mammou committed
714
715
  }

716
717
  cout << endl;

Khaled Mammou's avatar
TMC3v0  
Khaled Mammou committed
718
719
  return true;
}
720

721
int
722
Compress(Parameters& params, Stopwatch& clock)
723
{
Khaled Mammou's avatar
TMC3v0  
Khaled Mammou committed
724
  PCCPointSet3 pointCloud;
725
726
727
  if (
    !pointCloud.read(params.uncompressedDataPath)
    || pointCloud.getPointCount() == 0) {
Khaled Mammou's avatar
TMC3v0  
Khaled Mammou committed
728
729
730
731
    cout << "Error: can't open input file!" << endl;
    return -1;
  }

732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
  // Sanitise the input point cloud
  // todo(df): remove the following with generic handling of properties
  bool codeColour = params.encoder.attributeIdxMap.count("color");
  if (!codeColour)
    pointCloud.removeColors();
  assert(codeColour == pointCloud.hasColors());

  bool codeReflectance = params.encoder.attributeIdxMap.count("reflectance");
  if (!codeReflectance)
    pointCloud.removeReflectances();
  assert(codeReflectance == pointCloud.hasReflectances());

  ofstream fout(params.compressedStreamPath, ios::binary);
  if (!fout.is_open()) {
    return -1;
  }

749
750
  clock.start();

Khaled Mammou's avatar
TMC3v0  
Khaled Mammou committed
751
752
753
  if (params.colorTransform == COLOR_TRANSFORM_RGB_TO_YCBCR) {
    pointCloud.convertRGBToYUV();
  }
754
755
756
757
758
759
760
761
762

  if (params.reflectanceScale > 1 && pointCloud.hasReflectances()) {
    const auto pointCount = pointCloud.getPointCount();
    for (size_t i = 0; i < pointCount; ++i) {
      int val = pointCloud.getReflectance(i) / params.reflectanceScale;
      pointCloud.setReflectance(i, val);
    }
  }

Khaled Mammou's avatar
TMC3v0  
Khaled Mammou committed
763
764
  PCCTMC3Encoder3 encoder;

765
766
  // The reconstructed point cloud
  std::unique_ptr<PCCPointSet3> reconPointCloud;
Khaled Mammou's avatar
TMC3v0  
Khaled Mammou committed
767
  if (!params.reconstructedDataPath.empty()) {
768
    reconPointCloud.reset(new PCCPointSet3);
Khaled Mammou's avatar
TMC3v0  
Khaled Mammou committed
769
770
  }

771
  int ret = encoder.compress(
772
773
    pointCloud, &params.encoder,
    [&](const PayloadBuffer& buf) { writeTlv(buf, fout); },
774
    reconPointCloud.get());
775
  if (ret) {
Khaled Mammou's avatar
TMC3v0  
Khaled Mammou committed
776
777
778
    cout << "Error: can't compress point cloud!" << endl;
    return -1;
  }
779

780
  std::cout << "Total bitstream size " << fout.tellp() << " B" << std::endl;
Khaled Mammou's avatar
TMC3v0  
Khaled Mammou committed
781
782
  fout.close();

783
784
  clock.stop();

Khaled Mammou's avatar
TMC3v0  
Khaled Mammou committed
785
786
  if (!params.reconstructedDataPath.empty()) {
    if (params.colorTransform == COLOR_TRANSFORM_RGB_TO_YCBCR) {
787
788
789
790
791
792
793
794
795
      reconPointCloud->convertYUVToRGB();
    }

    if (params.reflectanceScale > 1 && reconPointCloud->hasReflectances()) {
      const auto pointCount = reconPointCloud->getPointCount();
      for (size_t i = 0; i < pointCount; ++i) {
        int val = reconPointCloud->getReflectance(i) * params.reflectanceScale;
        reconPointCloud->setReflectance(i, val);
      }
Khaled Mammou's avatar
TMC3v0  
Khaled Mammou committed
796
    }
797

798
799
    reconPointCloud->write(
      params.reconstructedDataPath, !params.outputBinaryPly);
Khaled Mammou's avatar
TMC3v0  
Khaled Mammou committed
800
801
802
803
  }

  return 0;
}
804
int
805
Decompress(Parameters& params, Stopwatch& clock)
806
{
Khaled Mammou's avatar
TMC3v0  
Khaled Mammou committed
807
808
809
810
811
  ifstream fin(params.compressedStreamPath, ios::binary);
  if (!fin.is_open()) {
    return -1;
  }

812
813
  clock.start();

814
  PayloadBuffer buf;
Khaled Mammou's avatar
TMC3v0  
Khaled Mammou committed
815
  PCCTMC3Decoder3 decoder;
816

817
818
819
  while (true) {
    PayloadBuffer* buf_ptr = &buf;
    readTlv(fin, &buf);
Khaled Mammou's avatar
TMC3v0  
Khaled Mammou committed
820

821
822
823
    // at end of file (or other error), flush decoder
    if (!fin)
      buf_ptr = nullptr;
Khaled Mammou's avatar
TMC3v0  
Khaled Mammou committed
824

825
826
827
    int ret = decoder.decompress(
      params.decoder, buf_ptr, [&](const PCCPointSet3& decodedPointCloud) {
        PCCPointSet3 pointCloud(decodedPointCloud);
828

829
830
831
832
        if (params.colorTransform == COLOR_TRANSFORM_RGB_TO_YCBCR) {
          pointCloud.convertYUVToRGB();
        }

833
834
835
836
837
838
839
840
        if (params.reflectanceScale > 1 && pointCloud.hasReflectances()) {
          const auto pointCount = pointCloud.getPointCount();
          for (size_t i = 0; i < pointCount; ++i) {
            int val = pointCloud.getReflectance(i) * params.reflectanceScale;
            pointCloud.setReflectance(i, val);
          }
        }

841
842
        // Dump the decoded colour using the pre inverse scaled geometry
        if (!params.preInvScalePath.empty()) {
843
          pointCloud.write(params.preInvScalePath, !params.outputBinaryPly);
844
845
        }

846
        decoder.inverseQuantization(pointCloud);
847
848
849

        clock.stop();

850
851
        if (!pointCloud.write(
              params.reconstructedDataPath, !params.outputBinaryPly)) {
852
853
854
855
856
857
858
859
860
861
862
863
864
          cout << "Error: can't open output file!" << endl;
        }

        clock.start();
      });

    if (ret) {
      cout << "Error: can't decompress point cloud!" << endl;
      return -1;
    }

    if (!buf_ptr)
      break;
Khaled Mammou's avatar
TMC3v0  
Khaled Mammou committed
865
  }
866

867
868
869
870
871
872
  fin.clear();
  fin.seekg(0, ios_base::end);
  std::cout << "Total bitstream size " << fin.tellg() << " B" << std::endl;

  clock.stop();

Khaled Mammou's avatar
TMC3v0  
Khaled Mammou committed
873
874
  return 0;
}