00001 // $Id: rifffile.h 1282 2006-06-09 09:46:49Z alex $ 00002 /* @@tag:xara-cn@@ DO NOT MODIFY THIS LINE 00003 ================================XARAHEADERSTART=========================== 00004 00005 Xara LX, a vector drawing and manipulation program. 00006 Copyright (C) 1993-2006 Xara Group Ltd. 00007 Copyright on certain contributions may be held in joint with their 00008 respective authors. See AUTHORS file for details. 00009 00010 LICENSE TO USE AND MODIFY SOFTWARE 00011 ---------------------------------- 00012 00013 This file is part of Xara LX. 00014 00015 Xara LX is free software; you can redistribute it and/or modify it 00016 under the terms of the GNU General Public License version 2 as published 00017 by the Free Software Foundation. 00018 00019 Xara LX and its component source files are distributed in the hope 00020 that it will be useful, but WITHOUT ANY WARRANTY; without even the 00021 implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 00022 See the GNU General Public License for more details. 00023 00024 You should have received a copy of the GNU General Public License along 00025 with Xara LX (see the file GPL in the root directory of the 00026 distribution); if not, write to the Free Software Foundation, Inc., 51 00027 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA 00028 00029 00030 ADDITIONAL RIGHTS 00031 ----------------- 00032 00033 Conditional upon your continuing compliance with the GNU General Public 00034 License described above, Xara Group Ltd grants to you certain additional 00035 rights. 00036 00037 The additional rights are to use, modify, and distribute the software 00038 together with the wxWidgets library, the wxXtra library, and the "CDraw" 00039 library and any other such library that any version of Xara LX relased 00040 by Xara Group Ltd requires in order to compile and execute, including 00041 the static linking of that library to XaraLX. In the case of the 00042 "CDraw" library, you may satisfy obligation under the GNU General Public 00043 License to provide source code by providing a binary copy of the library 00044 concerned and a copy of the license accompanying it. 00045 00046 Nothing in this section restricts any of the rights you have under 00047 the GNU General Public License. 00048 00049 00050 SCOPE OF LICENSE 00051 ---------------- 00052 00053 This license applies to this program (XaraLX) and its constituent source 00054 files only, and does not necessarily apply to other Xara products which may 00055 in part share the same code base, and are subject to their own licensing 00056 terms. 00057 00058 This license does not apply to files in the wxXtra directory, which 00059 are built into a separate library, and are subject to the wxWindows 00060 license contained within that directory in the file "WXXTRA-LICENSE". 00061 00062 This license does not apply to the binary libraries (if any) within 00063 the "libs" directory, which are subject to a separate license contained 00064 within that directory in the file "LIBS-LICENSE". 00065 00066 00067 ARRANGEMENTS FOR CONTRIBUTION OF MODIFICATIONS 00068 ---------------------------------------------- 00069 00070 Subject to the terms of the GNU Public License (see above), you are 00071 free to do whatever you like with your modifications. However, you may 00072 (at your option) wish contribute them to Xara's source tree. You can 00073 find details of how to do this at: 00074 http://www.xaraxtreme.org/developers/ 00075 00076 Prior to contributing your modifications, you will need to complete our 00077 contributor agreement. This can be found at: 00078 http://www.xaraxtreme.org/developers/contribute/ 00079 00080 Please note that Xara will not accept modifications which modify any of 00081 the text between the start and end of this header (marked 00082 XARAHEADERSTART and XARAHEADEREND). 00083 00084 00085 MARKS 00086 ----- 00087 00088 Xara, Xara LX, Xara X, Xara X/Xtreme, Xara Xtreme, the Xtreme and Xara 00089 designs are registered or unregistered trademarks, design-marks, and/or 00090 service marks of Xara Group Ltd. All rights in these marks are reserved. 00091 00092 00093 Xara Group Ltd, Gaddesden Place, Hemel Hempstead, HP2 6EX, UK. 00094 http://www.xara.com/ 00095 00096 =================================XARAHEADEREND============================ 00097 */ 00098 // Handling RIFF files (used by CDR importer) 00099 00100 #ifndef INC_RIFFFILE 00101 #define INC_RIFFFILE 00102 00103 #include "riffform.h" 00104 //#include "list.h" - in camtypes.h [AUTOMATICALLY REMOVED] 00105 //#include "ccfile.h" - in camtypes.h [AUTOMATICALLY REMOVED] 00106 00107 typedef enum { 00108 RIFFOBJECTTYPE_NONE, // initial condition 00109 RIFFOBJECTTYPE_CHUNK, 00110 RIFFOBJECTTYPE_LISTSTART, 00111 RIFFOBJECTTYPE_LISTEND, 00112 RIFFOBJECTTYPE_FILEEND 00113 } RIFFObjectType; 00114 00115 // a class for storeing level information 00116 class RIFFFileLevel : public ListItem 00117 { 00118 friend class RIFFFile; 00119 00120 protected: 00121 INT32 Start; // the offset in the file at which this object starts 00122 INT32 End; // where it ends 00123 FOURCC Type; // and the type of this list 00124 }; 00125 00126 /******************************************************************************************** 00127 00128 > class RIFFFile : public CC_CLASS_MEMDUMP 00129 00130 Author: Ben_Summers (Xara Group Ltd) <camelotdev@xara.com> 00131 Created: 21 03 95 00132 Purpose: Nice class for reading RIFF files, takes a CCFile in the Init() routine 00133 to get it's data from. 00134 This doesn't view a RIFF file quite how they're actually stored on the disc. 00135 It's viewed as a series of Objects. These objects can be 00136 Chunks 00137 Start of lists 00138 End of lists 00139 End of file 00140 An object inside a list has a higher level than the list and chunks just 00141 before the list. 00142 You ask for the next object with NextObject(). This reads in the details 00143 about the next object in the file, which you can then read with the Get 00144 functions. 00145 You can get at the data with GetChunkData - this will error if the last 00146 object is not a chunk. This function reads the data into a block you give it. 00147 Alternatively, use AquireChunkData which will read it into a block maintained 00148 by this class. 00149 Data is not read unless it has to be. 00150 RepeatCurrent() will repeat the current object, giving one level of rewind. 00151 Useful for reading files with naff structures. 00152 SkipToListEnd() will skip to the end of the list of the level given. 00153 00154 It's recommended that you have a quite shufty at the documentation in the 00155 MSDN about RIFF files. 00156 00157 ********************************************************************************************/ 00158 00159 class RIFFFile : public CC_CLASS_MEMDUMP 00160 { 00161 CC_DECLARE_MEMDUMP(RIFFFile); 00162 00163 public: 00164 RIFFFile(); 00165 ~RIFFFile(); 00166 00167 FOURCC Init(CCLexFile *File, BOOL NoHeader = FALSE); 00168 BOOL NextObject(void); 00169 BOOL GetChunkData(ADDR Block, INT32 Size); 00170 BOOL GetChunkData(ADDR Block, INT32 Size, INT32 Offset); 00171 BOOL AquireChunkData(void); 00172 BOOL SkipToListEnd(UINT32 Level); 00173 BOOL RepeatCurrent(void); 00174 BOOL GetListContents(ADDR *Block, INT32 *Size); 00175 BOOL AquireListContents(INT32 *ListSize); 00176 00177 // checks to see if a start of a file is a RIFF file. Returns the form type if it's 00178 // a valid RIFF header, or 0 if not 00179 static FOURCC CheckRIFFHeader(ADDR Header, DWORD FileSize); 00180 00181 static BOOL FindChunkWithinListContents(ADDR ListContents, INT32 ListSize, FOURCC Type, INT32 Entry, ADDR *Chunk, INT32 *ChunkSize); 00182 00183 RIFFObjectType GetObjType(void) {return ObjType;} 00184 FOURCC GetObjChunkType(void) {return ObjChunkType;} 00185 INT32 GetObjSize(void) {return ObjSize;} 00186 UINT32 GetObjLevel(void) {return ObjLevel;} 00187 ADDR GetAquiredData(void) {return AquiredData;} 00188 00189 INT32 ProgressLimit(void) {return Size;} // the last value progress will return 00190 INT32 ProgressNow(void) {return Location;} // the current position for the progress bar 00191 00192 private: 00193 CCLexFile *File; // the file the RIFF file comes from 00194 00195 RIFFObjectType ObjType; // object type of current object 00196 FOURCC ObjChunkType; // type of current chunk (or type of list) 00197 INT32 ObjSize; // size in bytes of current chunk 00198 UINT32 ObjLevel; // level of object 00199 INT32 ObjLocation; // location of start of the current object 00200 00201 UINT32 CurrentLevel; // level we're currently at 00202 00203 INT32 Location; // current location within the file 00204 INT32 Size; // size of the file 00205 00206 BOOL GotData; // Have we already got the data for this object? 00207 // this is set even if it's only partially got 00208 00209 INT32 AlignedObjectSize; // the size of this object aligned to the actual 00210 // size it takes up in the file 00211 00212 List Levels; // list of information about the levels we're on 00213 // the tail tells us about the current level... 00214 // items are deleted and created as we process the file 00215 00216 BOOL RepeatObject; // repeat the current object on the next NextObject() 00217 BOOL Error; // had an error 00218 00219 BYTE *AquiredData; // pointer to aquired data 00220 INT32 AquiredDataSize; // size of aquired data block 00221 00222 private: 00223 BOOL EnsureAquiredSizeIsAtLeast(INT32 Size); 00224 }; 00225 00226 #endif // INC_RIFFFILE 00227