Files
opencv/modules/ptcloud/src/io_ply.cpp
T
Alexander Smorkalov fc3803c67b Merge pull request #29224 from asmorkalov:as/ptcloud2
Dedicated pointcloud module #29224

OpenCV contrib: https://github.com/opencv/opencv_contrib/pull/4134

### Pull Request Readiness Checklist

See details at https://github.com/opencv/opencv/wiki/How_to_contribute#making-a-good-pull-request

- [x] I agree to contribute to the project under Apache 2 License.
- [x] To the best of my knowledge, the proposed patch is not based on a code under GPL or another license that is incompatible with OpenCV
- [ ] The PR is proposed to the proper branch
- [ ] There is a reference to the original bug report and related work
- [ ] There is accuracy test, performance test and test data in opencv_extra repository, if applicable
      Patch to opencv_extra has the same branch name.
- [ ] The feature is well documented and sample code can be built with the project CMake
2026-06-04 12:19:02 +03:00

683 lines
21 KiB
C++

// This file is part of OpenCV project.
// It is subject to the license terms in the LICENSE file found in the top-level directory
// of this distribution and at http://opencv.org/license.html.
#include "precomp.hpp"
#include "io_ply.hpp"
#include "utils.hpp"
#include <opencv2/core/utils/logger.hpp>
#include <fstream>
#include <string>
#include <iomanip>
#include <cstddef>
namespace cv {
static const std::set<std::string> colorKeys = { "red", "diffuse_red", "green", "diffuse_green", "blue", "diffuse_blue" };
void PlyDecoder::readData(std::vector<Point3f>& points, std::vector<Point3f>& normals, std::vector<Point3f>& rgb,
std::vector<Point3f>& texCoords, int& nTexCoords,
std::vector<std::vector<int32_t>>& indices, int /*flags*/)
{
points.clear();
normals.clear();
rgb.clear();
texCoords.clear();
indices.clear();
nTexCoords = 0;
std::ifstream file(m_filename, std::ios::binary);
if (parseHeader(file, nTexCoords))
{
parseBody(file, points, normals, rgb, texCoords, indices);
}
}
bool PlyDecoder::parseHeader(std::ifstream &file, int& nTexCoords)
{
std::string s;
std::getline(file, s);
if (trimSpaces(s) != "ply")
{
CV_LOG_ERROR(NULL, "Provided file is not in PLY format");
return false;
}
std::getline(file, s);
auto splitArr = split(s, ' ');
// "\r" symbols are not trimmed by default
for (auto& e : splitArr)
{
e = trimSpaces(e);
}
if (splitArr[0] != "format")
{
CV_LOG_ERROR(NULL, "Provided file doesn't have format");
return false;
}
if (splitArr[1] == "ascii")
{
m_inputDataFormat = DataFormat::ASCII;
}
else if (splitArr[1] == "binary_little_endian")
{
m_inputDataFormat = DataFormat::BinaryLittleEndian;
}
else if (splitArr[1] == "binary_big_endian")
{
m_inputDataFormat = DataFormat::BinaryBigEndian;
}
else
{
CV_LOG_ERROR(NULL, "Provided PLY file format is not supported");
return false;
}
const std::map<std::string, int> dataTypes =
{
{ "char", CV_8S }, { "int8", CV_8S },
{ "uchar", CV_8U }, { "uint8", CV_8U },
{ "short", CV_16S }, { "int16", CV_16S },
{ "ushort", CV_16U }, { "uint16", CV_16U },
{ "int", CV_32S }, { "int32", CV_32S },
{ "uint", CV_32U }, { "uint32", CV_32U },
{ "float", CV_32F }, { "float32", CV_32F },
{ "double", CV_64F }, { "float64", CV_64F },
};
enum ReadElement
{
READ_OTHER = 0,
READ_VERTEX = 1,
READ_FACE = 2
};
ReadElement elemRead = READ_OTHER;
m_vertexDescription = ElementDescription();
m_faceDescription = ElementDescription();
while (std::getline(file, s))
{
if (startsWith(s, "element"))
{
std::vector<std::string> splitArrElem = split(s, ' ');
// "\r" symbols are not trimmed by default
for (auto& e : splitArrElem)
{
e = trimSpaces(e);
}
std::string elemName = splitArrElem.at(1);
if (elemName == "vertex")
{
elemRead = READ_VERTEX;
if(splitArrElem.size() != 3)
{
CV_LOG_ERROR(NULL, "Vertex element description has " << splitArrElem.size()
<< " words instead of 3");
return false;
}
std::istringstream iss(splitArrElem[2]);
iss >> m_vertexDescription.amount;
}
else if (elemName == "face")
{
elemRead = READ_FACE;
if(splitArrElem.size() != 3)
{
CV_LOG_ERROR(NULL, "Face element description has " << splitArrElem.size()
<< " words instead of 3");
return false;
}
std::istringstream iss(splitArrElem[2]);
iss >> m_faceDescription.amount;
}
else
{
elemRead = READ_OTHER;
}
continue;
}
if (startsWith(s, "property"))
{
Property property;
std::string elName = (elemRead == READ_VERTEX) ? "Vertex" : "Face";
std::vector<std::string> splitArrElem = split(s, ' ');
// "\r" symbols are not trimmed by default
for (auto& e : splitArrElem)
{
e = trimSpaces(e);
}
if (splitArrElem.size() < 3)
{
CV_LOG_ERROR(NULL, elName << " property has " << splitArrElem.size()
<< " words instead of at least 3");
return false;
}
std::string propType = splitArrElem[1];
if (propType == "list")
{
property.isList = true;
if (splitArrElem.size() < 5)
{
CV_LOG_ERROR(NULL, elName << " property has " << splitArrElem.size()
<< " words instead of at least 5");
return false;
}
std::string amtTypeString = splitArrElem[2];
if (dataTypes.count(amtTypeString) == 0)
{
CV_LOG_ERROR(NULL, "Property type " << amtTypeString
<< " is not supported");
return false;
}
else
{
property.counterType = dataTypes.at(amtTypeString);
}
std::string idxTypeString = splitArrElem[3];
if (dataTypes.count(idxTypeString) == 0)
{
CV_LOG_ERROR(NULL, "Property type " << idxTypeString
<< " is not supported");
return false;
}
else
{
property.valType = dataTypes.at(idxTypeString);
}
property.name = splitArrElem[4];
}
else
{
property.isList = false;
if (dataTypes.count(propType) == 0)
{
CV_LOG_ERROR(NULL, "Property type " << propType
<< " is not supported");
return false;
}
else
{
property.valType = dataTypes.at(propType);
}
property.name = splitArrElem[2];
}
if (elemRead == READ_VERTEX)
{
m_vertexDescription.properties.push_back(property);
}
else if (elemRead == READ_FACE)
{
m_faceDescription.properties.push_back(property);
}
continue;
}
if (startsWith(s, "end_header"))
break;
}
static const std::set<std::string> texCoordKeys = { "texture_u", "s", "texture_v", "t", "texture_w" };
bool good = true;
m_vertexCount = m_vertexDescription.amount;
std::map<std::string, int> amtProps;
for (const auto& p : m_vertexDescription.properties)
{
bool known = false;
if (p.name == "x" || p.name == "y" || p.name == "z")
{
known = true;
if (p.valType != CV_32F)
{
CV_LOG_ERROR(NULL, "Vertex property " << p.name
<< " should be float");
good = false;
}
}
if (p.name == "nx" || p.name == "ny" || p.name == "nz")
{
known = true;
if (p.valType != CV_32F)
{
CV_LOG_ERROR(NULL, "Vertex property " << p.name
<< " should be float");
good = false;
}
m_hasNormal = true;
}
if (colorKeys.count(p.name) > 0)
{
known = true;
if (p.valType != CV_8U)
{
CV_LOG_ERROR(NULL, "Vertex property " << p.name
<< " should be uchar");
good = false;
}
m_hasColour = true;
}
if (texCoordKeys.count(p.name) > 0)
{
known = true;
if (p.valType != CV_32F)
{
CV_LOG_ERROR(NULL, "Vertex property " << p.name
<< " should be float");
good = false;
}
m_hasTexCoord = true;
}
if (p.isList)
{
CV_LOG_ERROR(NULL, "List properties for vertices are not supported");
good = false;
}
if (known)
{
amtProps[p.name]++;
}
}
// check if we have no duplicates
for (const auto& a : amtProps)
{
if (a.second > 1)
{
CV_LOG_ERROR(NULL, "Vertex property " << a.first << " is duplicated");
good = false;
}
}
const std::array<std::string, 3> vertKeys = {"x", "y", "z"};
for (const std::string& c : vertKeys)
{
if (amtProps.count(c) == 0)
{
CV_LOG_ERROR(NULL, "Vertex property " << c << " is not presented in the file");
good = false;
}
}
// check for synonyms
std::vector<std::pair<size_t, size_t>> propCounts;
std::vector<std::pair<std::string, std::string>> synonyms = {
{"red", "diffuse_red"},
{"green", "diffuse_green"},
{"blue", "diffuse_blue"},
{"texture_u", "s"},
{"texture_v", "t"},
};
for (const auto& p : synonyms)
{
std::string a, b;
a = p.first; b = p.second;
size_t ca = amtProps.count(a), cb = amtProps.count(b);
propCounts.push_back({ca, cb});
if (ca + cb > 1)
{
CV_LOG_ERROR(NULL, "Vertex property " << a << " should not go with its synonym " << b);
good = false;
}
}
// check for color conventions
bool shortColorConv = propCounts[0].first || propCounts[1].first || propCounts[2].first;
bool diffuseColorConv = propCounts[0].second || propCounts[1].second || propCounts[2].second;
if (shortColorConv && diffuseColorConv)
{
CV_LOG_ERROR(NULL, "Vertex color properties should not be diffuse and not diffuse at the same time");
good = false;
}
// check for texture conventions
bool shortTexConv = propCounts[3].second || propCounts[4].second;
bool longTexConv = propCounts[3].first || propCounts[4].first;
if (shortTexConv && longTexConv)
{
CV_LOG_ERROR(NULL, "Vertex texture coordinates properties should not be in a short and in a long form at the same time");
good = false;
}
nTexCoords = 0;
for (const auto& k : texCoordKeys)
{
nTexCoords += (int)(amtProps.count(k));
}
m_faceCount = m_faceDescription.amount;
int amtLists = 0;
for (const auto& p : m_faceDescription.properties)
{
if (p.isList)
{
amtLists++;
if (!(p.counterType == CV_8U && (p.valType == CV_32S || p.valType == CV_32U)))
{
CV_LOG_ERROR(NULL, "List property " << p.name
<< " should have type uint8 for counter and uint32 for values");
good = false;
}
if (!(p.name == "vertex_index" || p.name == "vertex_indices"))
{
CV_LOG_ERROR(NULL, "List property should be vertex_index or vertex_indices, "
<< p.name << " is not supported");
good = false;
}
}
}
if (amtLists > 1)
{
CV_LOG_ERROR(NULL, "Only 1 list property is supported per face");
good = false;
}
return good;
}
template <typename T>
T readNext(std::ifstream &file, DataFormat format)
{
T val;
if (format == DataFormat::ASCII)
{
file >> val;
return val;
}
file.read((char *)&val, sizeof(T));
#ifdef WORDS_BIGENDIAN
if (!(format == DataFormat::BinaryBigEndian) )
{
swapEndian<T>(val);
}
#else
if (format == DataFormat::BinaryBigEndian)
{
swapEndian<T>(val);
}
#endif
return val;
}
template <>
uchar readNext<uchar>(std::ifstream &file, DataFormat format)
{
if (format == DataFormat::ASCII)
{
int val;
file >> val;
return (uchar)val;
}
uchar val;
file.read((char *)&val, sizeof(uchar));
// 1 byte does not have to be endian-swapped
return val;
}
void PlyDecoder::parseBody(std::ifstream &file,
std::vector<Point3f>& points, std::vector<Point3f>& normals,
std::vector<Point3f>& rgb, std::vector<Point3f>& texCoords,
std::vector<std::vector<int32_t>> &indices)
{
points.reserve(m_vertexCount);
if (m_hasColour)
{
rgb.reserve(m_vertexCount);
}
if (m_hasNormal)
{
normals.reserve(m_vertexCount);
}
struct VertexFields
{
float vx, vy, vz;
float nx, ny, nz;
float u, v, w;
float r, g, b;
};
union VertexData
{
std::array<uchar, sizeof(VertexFields)> bytes;
VertexFields vf;
};
// to avoid string matching at file loading
std::vector<size_t> vertexOffsets(m_vertexDescription.properties.size(), (size_t)(-1));
for (size_t j = 0; j < m_vertexDescription.properties.size(); j++)
{
const auto& p = m_vertexDescription.properties[j];
size_t offset = (size_t)(-1);
if (p.name == "x")
offset = offsetof(VertexFields, vx);
if (p.name == "y")
offset = offsetof(VertexFields, vy);
if (p.name == "z")
offset = offsetof(VertexFields, vz);
if (p.name == "nx")
offset = offsetof(VertexFields, nx);
if (p.name == "ny")
offset = offsetof(VertexFields, ny);
if (p.name == "nz")
offset = offsetof(VertexFields, nz);
if (p.name == "texture_u" || p.name == "s")
offset = offsetof(VertexFields, u);
if (p.name == "texture_v" || p.name == "t")
offset = offsetof(VertexFields, v);
if (p.name == "texture_w")
offset = offsetof(VertexFields, w);
if (p.name == "red" || p.name == "diffuse_red")
offset = offsetof(VertexFields, r);
if (p.name == "green" || p.name == "diffuse_green")
offset = offsetof(VertexFields, g);
if (p.name == "blue" || p.name == "diffuse_blue")
offset = offsetof(VertexFields, b);
vertexOffsets[j] = offset;
}
for (size_t i = 0; i < m_vertexCount; i++)
{
VertexData vertexData{ };
for (size_t j = 0; j < m_vertexDescription.properties.size(); j++)
{
const auto& p = m_vertexDescription.properties[j];
uint ival = 0; float fval = 0;
// here signedness is not important
switch (p.valType)
{
case CV_8U: case CV_8S:
ival = readNext<uchar>(file, m_inputDataFormat);
break;
case CV_16U: case CV_16S:
ival = readNext<ushort>(file, m_inputDataFormat);
break;
case CV_32S: case CV_32U:
ival = readNext<uint>(file, m_inputDataFormat);
break;
case CV_32F:
fval = readNext<float>(file, m_inputDataFormat);
break;
case CV_64F:
fval = (float)readNext<double>(file, m_inputDataFormat);
break;
default:
break;
}
size_t offset = vertexOffsets[j];
if (offset != (size_t)(-1))
{
if (colorKeys.count(p.name) > 0 && p.valType == CV_8U)
{
fval = ival / 255.f;
}
*(float*)(vertexData.bytes.data() + offset) = fval;
}
}
points.push_back({ vertexData.vf.vx, vertexData.vf.vy, vertexData.vf.vz });
if (m_hasColour)
{
rgb.push_back({ vertexData.vf.r, vertexData.vf.g, vertexData.vf.b });
}
if (m_hasNormal)
{
normals.push_back({ vertexData.vf.nx, vertexData.vf.ny, vertexData.vf.nz });
}
if (m_hasTexCoord)
{
texCoords.push_back({ vertexData.vf.u, vertexData.vf.v, vertexData.vf.w });
}
}
indices.reserve(m_faceCount);
for (size_t i = 0; i < m_faceCount; i++)
{
for (const auto& p : m_faceDescription.properties)
{
if (p.isList)
{
size_t nVerts = readNext<uchar>(file, m_inputDataFormat);
if (nVerts < 3)
{
CV_LOG_ERROR(NULL, "Face should have at least 3 vertices but has " << nVerts);
return;
}
// PLY can have faces with >3 vertices in TRIANGLE_FAN format
// in this case we load them as separate triangles
int vert1 = readNext<int>(file, m_inputDataFormat);
int vert2 = readNext<int>(file, m_inputDataFormat);
for (size_t j = 2; j < nVerts; j++)
{
int vert3 = readNext<int>(file, m_inputDataFormat);
indices.push_back({vert1, vert2, vert3});
vert2 = vert3;
}
}
else
{
// read and discard
switch (p.valType)
{
case CV_8U: case CV_8S:
readNext<uchar>(file, m_inputDataFormat);
break;
case CV_16U: case CV_16S:
readNext<ushort>(file, m_inputDataFormat);
break;
case CV_32S: case CV_32U:
readNext<uint>(file, m_inputDataFormat);
break;
case CV_32F:
readNext<float>(file, m_inputDataFormat);
break;
case CV_64F:
readNext<double>(file, m_inputDataFormat);
break;
default:
break;
}
}
}
}
}
void PlyEncoder::writeData(const std::vector<Point3f>& points, const std::vector<Point3f>& normals, const std::vector<Point3f>& rgb,
const std::vector<Point3f>& texCoords, int nTexCoords,
const std::vector<std::vector<int32_t>>& indices)
{
std::ofstream file(m_filename, std::ios::binary);
if (!file)
{
CV_LOG_ERROR(NULL, "Impossible to open the file: " << m_filename);
return;
}
bool hasNormals = !normals.empty(), hasColor = !rgb.empty();
if (texCoords.empty() && nTexCoords > 0)
{
CV_LOG_ERROR(NULL, "No texture coordinates provided while having nTexCoord > 0");
return;
}
file << "ply" << std::endl;
file << "format ascii 1.0" << std::endl;
file << "comment created by OpenCV" << std::endl;
file << "element vertex " << points.size() << std::endl;
file << "property float x" << std::endl;
file << "property float y" << std::endl;
file << "property float z" << std::endl;
if(hasColor)
{
file << "property uchar red" << std::endl;
file << "property uchar green" << std::endl;
file << "property uchar blue" << std::endl;
}
if (hasNormals)
{
file << "property float nx" << std::endl;
file << "property float ny" << std::endl;
file << "property float nz" << std::endl;
}
if (nTexCoords > 0)
{
file << "property float texture_u" << std::endl;
}
if (nTexCoords > 1)
{
file << "property float texture_v" << std::endl;
}
if (nTexCoords > 2)
{
file << "property float texture_w" << std::endl;
}
if (!indices.empty())
{
file << "element face " << indices.size() << std::endl;
file << "property list uchar int vertex_indices" << std::endl;
}
file << "end_header" << std::endl;
for (size_t i = 0; i < points.size(); i++)
{
file << std::setprecision(9) << points[i].x << " " << points[i].y << " " << points[i].z;
if (hasColor)
{
file << " " << static_cast<int>(rgb[i].x * 255.f) << " " << static_cast<int>(rgb[i].y * 255.f) << " " << static_cast<int>(rgb[i].z * 255.f);
}
if (hasNormals)
{
file << " " << std::setprecision(9) << normals[i].x << " " << normals[i].y << " " << normals[i].z;
}
if (nTexCoords > 0)
{
file << " " << std::setprecision(9) << texCoords[i].x;
}
if (nTexCoords > 1)
{
file << " " << std::setprecision(9) << texCoords[i].y;
}
if (nTexCoords > 2)
{
file << " " << std::setprecision(9) << texCoords[i].z;
}
file << std::endl;
}
for (const auto& faceIndices : indices)
{
file << faceIndices.size();
for (const auto& index : faceIndices)
{
file << " " << index;
}
file << std::endl;
}
file.close();
}
} /* namespace cv */