Store and preserve the ply format in the Ply header (#22)

Author: c42f

src/io.jl

@@ -4,8 +4,6 @@
 #--------------------------------------------------
 # Header IO
 
-@enum Format Format_ascii Format_binary_little Format_binary_big
-
 function ply_type(type_name)
     if     type_name == "char"   || type_name == "int8";    return Int8
     elseif type_name == "short"  || type_name == "int16";   return Int16
@@ -141,9 +139,10 @@ function write_header_field(stream::IO, comment::PlyComment)
     println(stream, prefix, comment.comment)
 end
 
-function write_header(ply, stream::IO, ascii)
+function write_header(ply, stream::IO, format=ply.format)
     println(stream, "ply")
-    if ascii
+    _check_native_endian(format)
+    if format == Format_ascii
         println(stream, "format ascii 1.0")
     else
         endianness = _host_is_little_endian ? "little" : "big"
@@ -309,6 +308,13 @@ function write_binary_values(stream::IO, elen, props::ArrayProperty{T}...) where
     end
 end
 
+function _check_native_endian(format)
+    if _host_is_little_endian && format == Format_binary_big
+        error("Reading big endian ply on little endian host is not implemented")
+    elseif !_host_is_little_endian && format == Format_binary_little
+        error("Reading little endian ply on big endian host is not implemented")
+    end
+end
 
 #-------------------------------------------------------------------------------
 # High level IO for complete files
@@ -321,13 +327,7 @@ be a file name or an open stream.
 """
 function load_ply(io::IO)
     elements, format, comments = read_header(io)
-    if format != Format_ascii
-        if _host_is_little_endian && format != Format_binary_little
-            error("Reading big endian ply on little endian host is not implemented")
-        elseif !_host_is_little_endian && format != Format_binary_big
-            error("Reading little endian ply on big endian host is not implemented")
-        end
-    end
+    _check_native_endian(format)
     for element in elements
         for prop in element.properties
             resize!(prop, length(element))
@@ -338,11 +338,11 @@ function load_ply(io::IO)
                     read_ascii_value!(io, prop, i)
                 end
             end
-        else # format == Format_binary_little
+        else
             read_binary_values!(io, length(element), element.properties...)
         end
     end
-    Ply(elements, comments)
+    Ply(format, elements, comments)
 end
 
 function load_ply(file_name::AbstractString)
@@ -359,10 +359,14 @@ Save data from `Ply` data structure into `file` which may be a filename or an
 open stream.  The file will be native endian binary, unless the keyword
 argument `ascii` is set to `true`.
 """
-function save_ply(ply, stream::IO; ascii::Bool=false)
-    write_header(ply, stream, ascii)
+function save_ply(ply, stream::IO; ascii=nothing)
+    format = ascii === nothing       ? ply.format           :
+             ascii                   ? Format_ascii         :
+             _host_is_little_endian  ? Format_binary_little :
+                                       Format_binary_big
+    write_header(ply, stream, format)
     for element in ply
-        if ascii
+        if format == Format_ascii
             for i=1:length(element)
                 for (j,property) in enumerate(element.properties)
                     if j != 1

src/types.jl

@@ -187,6 +187,8 @@ end
 
 
 #--------------------------------------------------
+@enum Format Format_ascii Format_binary_little Format_binary_big
+
 """
     Ply()
 
@@ -196,15 +198,19 @@ contents of the header.  Ply elements and comments can be added using
 interface, and looked up by indexing with a string.
 """
 mutable struct Ply
+    format::Format
     elements::Vector{PlyElement}
     comments::Vector{PlyComment}
 end
 
-Ply() = Ply(Vector{PlyElement}(), Vector{String}())
+Ply(format=Format_ascii) = Ply(format, Vector{PlyElement}(), Vector{String}())
+
+# For compat
+Ply(elements::Vector{PlyElement}, comments::Vector{PlyComment}) = Ply(Format_ascii, elements, comments)
 
 function Base.show(io::IO, ply::Ply)
     buf = IOBuffer()
-    write_header(ply, buf, true)
+    write_header(ply, buf)
     headerstr = String(take!(buf))
     headerstr = replace(strip(headerstr), "\n"=>"\n ")
     print(io, "$Ply with header:\n $headerstr")

test/runtests.jl

@@ -130,6 +130,11 @@ end
         @test newply.comments == [PlyComment("A comment",false,1),
                                   PlyComment("Blah blah",false,1),
                                   PlyComment("x=10",true,1)]
+        @test (newply.format == PlyIO.Format_ascii) == test_ascii
+
+        save_ply(newply, "roundtrip_test_tmp_2.ply")
+        newply_2 = load_ply("roundtrip_test_tmp_2.ply")
+        @test (newply_2.format == PlyIO.Format_ascii) == test_ascii
     end
 
     @testset "proptype=$proptype" for proptype in [Int8, Int16, Int32, Int64,