miniply.h

Go to the documentation of this file.

/*
MIT License
 
Copyright (c) 2019 Vilya Harvey
 
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished TODO(lf)so, subject to the following conditions:
 
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/
 
#ifndef MINIPLY_H
#define MINIPLY_H
 
#include <cstdarg>
#include <cstdint>
#include <cstdio>
#include <string>
#include <vector>
 
 
namespace miniply {
 
//
// Constants
//
 
static constexpr uint32_t kInvalidIndex = 0xFFFFFFFFu;
 
// Standard PLY element names
extern const char* kPLYVertexElement;  // "vertex"
extern const char* kPLYFaceElement;    // "face"
 
//
// PLY Parsing types
//
 
enum class PLYFileType {
    ASCII,
    Binary,
    BinaryBigEndian,
};
 
enum class PLYPropertyType {
    Char,
    UChar,
    Short,
    UShort,
    Int,
    UInt,
    Float,
    Double,
 
    None,  
};
 
struct PLYProperty {
    std::string name;
    PLYPropertyType type = PLYPropertyType::None;  
    PLYPropertyType countType =
        PLYPropertyType::None;  
    uint32_t offset = 0;        
    uint32_t stride = 0;
 
    std::vector<uint8_t> listData;
    std::vector<uint32_t> rowCount;  // Entry `i` is the number of items (*not* the number of bytes) in row `i`.
};
 
struct PLYElement {
    std::string name;  
    std::vector<PLYProperty> properties;
    uint32_t count = 0;      
    bool fixedSize = true;   
    uint32_t rowStride = 0;  
 
    void calculate_offsets();
 
    uint32_t find_property(const char* propName) const;
 
    bool find_properties(uint32_t propIdxs[], uint32_t numIdxs, ...) const;
 
    bool find_properties_va(uint32_t propIdxs[], uint32_t numIdxs, va_list names) const;
 
    bool convert_list_to_fixed_size(uint32_t listPropIdx, uint32_t listSize, uint32_t newPropIdxs[]);
};
 
class PLYReader {
   public:
    PLYReader(const char* filename);
    ~PLYReader();
 
    bool valid() const;
    bool has_element() const;
    const PLYElement* element() const;
    bool load_element();
    void next_element();
 
    PLYFileType file_type() const;
    int version_major() const;
    int version_minor() const;
    uint32_t num_elements() const;
    uint32_t find_element(const char* name) const;
    PLYElement* get_element(uint32_t idx);
 
    bool element_is(const char* name) const;
 
    uint32_t num_rows() const;
 
    uint32_t find_property(const char* name) const;
 
    bool find_properties(uint32_t propIdxs[], uint32_t numIdxs, ...) const;
 
    bool extract_properties(const uint32_t propIdxs[], uint32_t numProps, PLYPropertyType destType, void* dest) const;
 
    bool extract_properties_with_stride(const uint32_t propIdxs[], uint32_t numProps, PLYPropertyType destType, void* dest,
                                        uint32_t destStride) const;
 
    const uint32_t* get_list_counts(uint32_t propIdx) const;
 
    uint32_t sum_of_list_counts(uint32_t propIdx) const;
 
    const uint8_t* get_list_data(uint32_t propIdx) const;
    bool extract_list_property(uint32_t propIdx, PLYPropertyType destType, void* dest) const;
 
    uint32_t num_triangles(uint32_t propIdx) const;
    bool requires_triangulation(uint32_t propIdx) const;
    bool extract_triangles(uint32_t propIdx, const float pos[], uint32_t numVerts, PLYPropertyType destType, void* dest) const;
 
    bool find_pos(uint32_t propIdxs[3]) const;
    bool find_normal(uint32_t propIdxs[3]) const;
    bool find_texcoord(uint32_t propIdxs[2]) const;
    bool find_color(uint32_t propIdxs[3]) const;
    bool find_indices(uint32_t propIdxs[1]) const;
 
   private:
    bool refill_buffer();
    bool rewind_to_safe_char();
    bool accept();
    bool advance();
    bool next_line();
    bool match(const char* str);
    bool which(const char* values[], uint32_t* index);
    bool which_property_type(PLYPropertyType* type);
    bool keyword(const char* kw);
    bool identifier(char* dest, size_t destLen);
 
    template <class T>  // T must be a type compatible with uint32_t.
    bool typed_which(const char* values[], T* index) {
        return which(values, reinterpret_cast<uint32_t*>(index));
    }
 
    bool int_literal(int* value);
    bool float_literal(float* value);
    bool double_literal(double* value);
 
    bool parse_elements();
    bool parse_element();
    bool parse_property(std::vector<PLYProperty>& properties);
 
    bool load_fixed_size_element(PLYElement& elem);
    bool load_variable_size_element(PLYElement& elem);
 
    bool load_ascii_scalar_property(PLYProperty& prop, size_t& destIndex);
    bool load_ascii_list_property(PLYProperty& prop);
    bool load_binary_scalar_property(PLYProperty& prop, size_t& destIndex);
    bool load_binary_list_property(PLYProperty& prop);
    bool load_binary_scalar_property_big_endian(PLYProperty& prop, size_t& destIndex);
    bool load_binary_list_property_big_endian(PLYProperty& prop);
 
    bool ascii_value(PLYPropertyType propType, uint8_t value[8]);
 
   private:
    FILE* m_f = nullptr;
    char* m_buf = nullptr;
    const char* m_bufEnd = nullptr;
    const char* m_pos = nullptr;
    const char* m_end = nullptr;
    bool m_inDataSection = false;
    bool m_atEOF = false;
    int64_t m_bufOffset = 0;
 
    bool m_valid = false;
 
    PLYFileType m_fileType = PLYFileType::ASCII;  
    int m_majorVersion = 0;
    int m_minorVersion = 0;
    std::vector<PLYElement> m_elements;  
 
    size_t m_currentElement = 0;
    bool m_elementLoaded = false;
    std::vector<uint8_t> m_elementData;
 
    char* m_tmpBuf = nullptr;
};
 
uint32_t triangulate_polygon(uint32_t n, const float pos[], uint32_t numVerts, const int indices[], int dst[]);
 
}  // namespace miniply
 
#endif  // MINIPLY_H