Ptex
PtexWriter.h
Go to the documentation of this file.
1 #ifndef PtexWriter_h
2 #define PtexWriter_h
3 
4 /*
5 PTEX SOFTWARE
6 Copyright 2009 Disney Enterprises, Inc. All rights reserved
7 
8 Redistribution and use in source and binary forms, with or without
9 modification, are permitted provided that the following conditions are
10 met:
11 
12  * Redistributions of source code must retain the above copyright
13  notice, this list of conditions and the following disclaimer.
14 
15  * Redistributions in binary form must reproduce the above copyright
16  notice, this list of conditions and the following disclaimer in
17  the documentation and/or other materials provided with the
18  distribution.
19 
20  * The names "Disney", "Walt Disney Pictures", "Walt Disney Animation
21  Studios" or the names of its contributors may NOT be used to
22  endorse or promote products derived from this software without
23  specific prior written permission from Walt Disney Pictures.
24 
25 Disclaimer: THIS SOFTWARE IS PROVIDED BY WALT DISNEY PICTURES AND
26 CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
27 BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS
28 FOR A PARTICULAR PURPOSE, NONINFRINGEMENT AND TITLE ARE DISCLAIMED.
29 IN NO EVENT SHALL WALT DISNEY PICTURES, THE COPYRIGHT HOLDER OR
30 CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31 EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32 PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33 PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND BASED ON ANY
34 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
35 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
36 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
37 */
38 
39 #include "PtexPlatform.h"
40 #include <zlib.h>
41 #include <map>
42 #include <vector>
43 #include <stdio.h>
44 #include "Ptexture.h"
45 #include "PtexIO.h"
46 #include "PtexReader.h"
47 
48 
49 class PtexWriterBase : public PtexWriter, public PtexIO {
50 public:
51  virtual void setBorderModes(Ptex::BorderMode uBorderMode, Ptex::BorderMode vBorderMode)
52  {
53  _extheader.ubordermode = uBorderMode;
54  _extheader.vbordermode = vBorderMode;
55  }
56  virtual void writeMeta(const char* key, const char* value);
57  virtual void writeMeta(const char* key, const int8_t* value, int count);
58  virtual void writeMeta(const char* key, const int16_t* value, int count);
59  virtual void writeMeta(const char* key, const int32_t* value, int count);
60  virtual void writeMeta(const char* key, const float* value, int count);
61  virtual void writeMeta(const char* key, const double* value, int count);
62  virtual void writeMeta(PtexMetaData* data);
63  virtual bool close(Ptex::String& error);
64  virtual void release();
65 
66  bool ok(Ptex::String& error) {
67  if (!_ok) getError(error);
68  return _ok;
69  }
70  void getError(Ptex::String& error) {
71  error = (_error + "\nPtex file: " + _path).c_str();
72  }
73 
74 protected:
75  struct MetaEntry {
76  std::string key;
78  std::vector<uint8_t> data;
79  MetaEntry() : datatype(MetaDataType(0)), data() {}
80  };
81 
82  virtual void finish() = 0;
83  PtexWriterBase(const char* path,
85  int nchannels, int alphachan, int nfaces,
86  bool compress);
87  virtual ~PtexWriterBase();
88 
89  int writeBlank(FILE* fp, int size);
90  int writeBlock(FILE* fp, const void* data, int size);
91  int writeZipBlock(FILE* fp, const void* data, int size, bool finish=true);
92  int readBlock(FILE* fp, void* data, int size);
93  int copyBlock(FILE* dst, FILE* src, FilePos pos, int size);
94  Res calcTileRes(Res faceres);
95  virtual void addMetaData(const char* key, MetaDataType t, const void* value, int size);
96  void writeConstFaceBlock(FILE* fp, const void* data, FaceDataHeader& fdh);
97  void writeFaceBlock(FILE* fp, const void* data, int stride, Res res,
98  FaceDataHeader& fdh);
99  void writeFaceData(FILE* fp, const void* data, int stride, Res res,
100  FaceDataHeader& fdh);
101  void writeReduction(FILE* fp, const void* data, int stride, Res res);
102  int writeMetaDataBlock(FILE* fp, MetaEntry& val);
103  void setError(const std::string& error) { _error = error; _ok = false; }
104  bool storeFaceInfo(int faceid, FaceInfo& dest, const FaceInfo& src, int flags=0);
105 
106  bool _ok; // true if no error has occurred
107  std::string _error; // the error text (if any)
108  std::string _path; // file path
109  std::string _tilepath; // temp tile file path ("<path>.tiles.tmp")
110  FILE* _tilefp; // temp tile file handle
111  Header _header; // the file header
112  ExtHeader _extheader; // extended header
113  int _pixelSize; // size of a pixel in bytes
114  std::vector<MetaEntry> _metadata; // meta data waiting to be written
115  std::map<std::string,int> _metamap; // for preventing duplicate keys
116  z_stream_s _zstream; // libzip compression stream
117 
119 };
120 
121 
123 public:
124  PtexMainWriter(const char* path, PtexTexture* tex,
126  int nchannels, int alphachan, int nfaces, bool genmipmaps);
127 
128  virtual bool close(Ptex::String& error);
129  virtual bool writeFace(int faceid, const FaceInfo& f, const void* data, int stride);
130  virtual bool writeConstantFace(int faceid, const FaceInfo& f, const void* data);
131 
132 protected:
133  virtual ~PtexMainWriter();
134  virtual void addMetaData(const char* key, MetaDataType t, const void* value, int size)
135  {
136  PtexWriterBase::addMetaData(key, t, value, size);
137  _hasNewData = true;
138  }
139 
140 private:
141  virtual void finish();
142  void generateReductions();
144  void storeConstValue(int faceid, const void* data, int stride, Res res);
145  void writeMetaData(FILE* fp);
146 
147  std::string _newpath; // path to ".new" file
148  std::string _tmppath; // temp file path ("<path>.tmp")
149  FILE* _tmpfp; // temp file handle
150  bool _hasNewData; // true if data has been written
151  bool _genmipmaps; // true if mipmaps should be generated
152  std::vector<FaceInfo> _faceinfo; // info about each face
153  std::vector<uint8_t> _constdata; // constant data for each face
154  std::vector<uint32_t> _rfaceids; // faceid reordering for reduction levels
155  std::vector<uint32_t> _faceids_r; // faceid indexed by rfaceid
156 
157  static const int MinReductionLog2 =2; // log2(minimum reduction size) - can tune
158  struct LevelRec {
159  // note: level 0 is ordered by faceid
160  // levels 1+ are reduction levels (half res in both u and v) and
161  // are ordered by rfaceid[faceid]. Also, faces with a minimum
162  // dimension (the smaller of u or v) smaller than MinReductionLog2
163  // are omitted from subsequent levels.
164  std::vector<FilePos> pos; // position of data blocks within _tmp file
165  std::vector<FaceDataHeader> fdh; // face data headers
166  };
167  std::vector<LevelRec> _levels; // info about each level
168  std::vector<FilePos> _rpos; // reduction file positions
169 
170  PtexReader* _reader; // reader for accessing existing data in file
171 };
172 
173 
175  public:
176  PtexIncrWriter(const char* path, FILE* fp,
178  int nchannels, int alphachan, int nfaces);
179 
180  virtual bool close(Ptex::String& error);
181  virtual bool writeFace(int faceid, const FaceInfo& f, const void* data, int stride);
182  virtual bool writeConstantFace(int faceid, const FaceInfo& f, const void* data);
183 
184  protected:
185  void writeMetaDataEdit();
186  virtual void finish();
187  virtual ~PtexIncrWriter();
188 
189  private:
190  FILE* _fp; // the file being edited
191 };
192 
193 #endif
std::string _tilepath
Definition: PtexWriter.h:109
Interface for writing data to a ptex file.
Definition: Ptexture.h:737
void getError(Ptex::String &error)
Definition: PtexWriter.h:70
bool storeFaceInfo(int faceid, FaceInfo &dest, const FaceInfo &src, int flags=0)
Definition: PtexWriter.cpp:331
virtual ~PtexWriterBase()
Definition: PtexWriter.cpp:312
virtual bool close(Ptex::String &error)
Close the file.
virtual void release()
Release resources held by this pointer (pointer becomes invalid).
Definition: PtexWriter.cpp:303
void writeReduction(FILE *fp, const void *data, int stride, Res res)
Definition: PtexWriter.cpp:692
ExtHeader _extheader
Definition: PtexWriter.h:112
Memory-managed string.
Definition: Ptexture.h:303
std::vector< FaceDataHeader > fdh
Definition: PtexWriter.h:165
PtexUtils::ReduceFn * _reduceFn
Definition: PtexWriter.h:118
void writeFaceData(FILE *fp, const void *data, int stride, Res res, FaceDataHeader &fdh)
Definition: PtexWriter.cpp:631
DataType
Type of data stored in texture file.
Definition: Ptexture.h:83
Meta data accessor.
Definition: Ptexture.h:337
virtual void finish()
void writeMetaData(FILE *fp)
bool ok(Ptex::String &error)
Definition: PtexWriter.h:66
std::vector< uint32_t > _rfaceids
Definition: PtexWriter.h:154
BorderMode ubordermode
Definition: PtexIO.h:63
virtual void setBorderModes(Ptex::BorderMode uBorderMode, Ptex::BorderMode vBorderMode)
Set border modes.
Definition: PtexWriter.h:51
virtual bool writeConstantFace(int faceid, const FaceInfo &f, const void *data)
Write constant texture data for a face.
Definition: PtexWriter.cpp:862
void storeConstValue(int faceid, const void *data, int stride, Res res)
Definition: PtexWriter.cpp:877
Pixel resolution of a given texture.
Definition: Ptexture.h:274
std::string _path
Definition: PtexWriter.h:108
std::vector< FaceInfo > _faceinfo
Definition: PtexWriter.h:152
Platform-specific classes, functions, and includes.
std::string _newpath
Definition: PtexWriter.h:147
void generateReductions()
virtual bool close(Ptex::String &error)
Close the file.
Definition: PtexWriter.cpp:779
MetaDataType
Type of meta data entry.
Definition: Ptexture.h:107
static const int MinReductionLog2
Definition: PtexWriter.h:157
int writeMetaDataBlock(FILE *fp, MetaEntry &val)
Definition: PtexWriter.cpp:709
virtual void finish()
Definition: PtexWriter.cpp:889
off_t FilePos
Definition: PtexPlatform.h:85
z_stream_s _zstream
Definition: PtexWriter.h:116
PtexReader * _reader
Definition: PtexWriter.h:170
BorderMode
How to handle mesh border when filtering.
Definition: Ptexture.h:91
void setError(const std::string &error)
Definition: PtexWriter.h:103
int writeZipBlock(FILE *fp, const void *data, int size, bool finish=true)
Definition: PtexWriter.cpp:512
virtual bool writeConstantFace(int faceid, const FaceInfo &f, const void *data)
Write constant texture data for a face.
FILE * _tilefp
Definition: PtexWriter.h:110
Information about a face, as stored in the Ptex file header.
Definition: Ptexture.h:350
int copyBlock(FILE *dst, FILE *src, FilePos pos, int size)
Definition: PtexWriter.cpp:553
void ReduceFn(const void *src, int sstride, int ures, int vres, void *dst, int dstride, DataType dt, int nchannels)
Definition: PtexUtils.h:132
Definition: PtexIO.h:41
PtexMainWriter(const char *path, PtexTexture *tex, Ptex::MeshType mt, Ptex::DataType dt, int nchannels, int alphachan, int nfaces, bool genmipmaps)
Definition: PtexWriter.cpp:725
int writeBlock(FILE *fp, const void *data, int size)
Definition: PtexWriter.cpp:501
virtual ~PtexMainWriter()
Definition: PtexWriter.cpp:773
int readBlock(FILE *fp, void *data, int size)
Definition: PtexWriter.cpp:543
virtual void addMetaData(const char *key, MetaDataType t, const void *value, int size)
Definition: PtexWriter.cpp:455
std::string _error
Definition: PtexWriter.h:107
virtual bool close(Ptex::String &error)
Close the file.
Definition: PtexWriter.cpp:318
MeshType
Type of base mesh for which the textures are defined.
Definition: Ptexture.h:77
MetaDataType
Type of meta data entry.
Definition: Ptexture.h:220
void writeMetaDataEdit()
PtexWriterBase(const char *path, Ptex::MeshType mt, Ptex::DataType dt, int nchannels, int alphachan, int nfaces, bool compress)
Definition: PtexWriter.cpp:262
BorderMode vbordermode
Definition: PtexIO.h:64
std::vector< FilePos > _rpos
Definition: PtexWriter.h:168
std::vector< FilePos > pos
Definition: PtexWriter.h:164
virtual bool writeFace(int faceid, const FaceInfo &f, const void *data, int stride)
Write texture data for a face.
Definition: PtexWriter.cpp:805
std::vector< LevelRec > _levels
Definition: PtexWriter.h:167
void flagConstantNeighorhoods()
Definition: PtexWriter.cpp:995
virtual ~PtexIncrWriter()
Res calcTileRes(Res faceres)
Definition: PtexWriter.cpp:572
Interface for reading data from a ptex file.
Definition: Ptexture.h:439
Header _header
Definition: PtexWriter.h:111
std::vector< uint32_t > _faceids_r
Definition: PtexWriter.h:155
int writeBlank(FILE *fp, int size)
Definition: PtexWriter.cpp:489
virtual void finish()=0
Information about a face, as stored in the Ptex file header.
Definition: Ptexture.h:237
std::vector< MetaEntry > _metadata
Definition: PtexWriter.h:114
virtual void writeMeta(const char *key, const char *value)
Write a string as meta data.
Definition: PtexWriter.cpp:363
PtexIncrWriter(const char *path, FILE *fp, Ptex::MeshType mt, Ptex::DataType dt, int nchannels, int alphachan, int nfaces)
std::map< std::string, int > _metamap
Definition: PtexWriter.h:115
void writeConstFaceBlock(FILE *fp, const void *data, FaceDataHeader &fdh)
Definition: PtexWriter.cpp:594
virtual bool writeFace(int faceid, const FaceInfo &f, const void *data, int stride)
Write texture data for a face.
std::string _tmppath
Definition: PtexWriter.h:148
void writeFaceBlock(FILE *fp, const void *data, int stride, Res res, FaceDataHeader &fdh)
Definition: PtexWriter.cpp:604
std::vector< uint8_t > data
Definition: PtexWriter.h:78
Public API classes for reading, writing, caching, and filtering Ptex files.
virtual void addMetaData(const char *key, MetaDataType t, const void *value, int size)
Definition: PtexWriter.h:134
std::vector< uint8_t > _constdata
Definition: PtexWriter.h:153