Add rough prototype of specifications and license info for the library/tools.

git-svn-id: http://svn.sukimashita.com/repos/hldemo/trunk@3 e98d5eb1-5f28-0410-b569-d5a1ad2e6e54

2 files changed, 638 insertions, 0 deletions

diff --git a/COPYING b/COPYING
new file mode 100644
index 0000000..d511905
--- /dev/null
+++ b/COPYING
@@ -0,0 +1,339 @@
+		    GNU GENERAL PUBLIC LICENSE
+		       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+			    Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+		    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+			    NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+		     END OF TERMS AND CONDITIONS
+
+	    How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License along
+    with this program; if not, write to the Free Software Foundation, Inc.,
+    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  <signature of Ty Coon>, 1 April 1989
+  Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.
diff --git a/doc/hl1-demofile-spec.txt b/doc/hl1-demofile-spec.txt
index e69de29..930b20b 100644
--- a/doc/hl1-demofile-spec.txt
+++ b/doc/hl1-demofile-spec.txt
@@ -0,0 +1,299 @@
+Half-Life 1 Demofile Specifications
+--------------------------------------------------------------------------------
+
+The Half-Life Demofile format has it's roots in the Quake 1 Demo format and is
+basically just an extension to it. Thus it contains only basic descriptors which
+rapidly points into raw recorded network data.
+
+It requires a lot of game engine related logic to be used for parsing such a 
+file in a non-game client application. This explains the lack of any
+documentation or examples in the SDK as it would require to heavily open up
+game engine sources.
+
+
+General Fileformat Data Hiarchy:
+
+DemoFile {
+	DemoHeader
+
+	DemoSegment {
+		DemoMacroBlock {
+			DemoMacroHeader
+			DemoMacroData {
+			
+			}
+		}
+		...
+	}
+	...
+	
+	DemoDirectoryEntry
+	...
+}
+
+
+Demofile Header
+--------------------------------------------------------------------------------
+The header starting at the beginning of the file contains the magic and further
+global game related information.
+
+DemoHeader->directory_offset points to a table of DemoDirectoryEntry structs
+prefixed by a count and suffixed by a file offset to the end of table.
+
+The location of the entries is usually somewhere at the end of the demo file,
+which is often a cause for "corrupt" demofiles if the data inbetween got
+altered/wrongly written by the game itself (raw network stream insanity or
+crash) thus resulting in a wrong offset.
+
+This can be fixed by parsing the end of the file for directory entries and
+fixing the proper offset value which allows playback in the game again.
+
+Known network_version -> Half-Life version mappings:

+
+	40 = '1.0.1.6'

+	42 = '1.1.0.1'

+	43 = '1.1.0.4/6'

+	45 = '1.1.0.8'

+	46 = '1.1.1.x'

+	47 = '1.1.1.x'

+
+struct DemoHeader
+{
+	char[8]		magic;
+	uint32 		demo_version;
+	uint32		network_version;
+	char[260]	map_name;
+	char[260]	game_dll;
+	uint32		map_crc;
+	uint32		directory_offset {
+		uint32			dir_count;	// 1 to 1024
+		DemoDirectoryEntry*	entries;
+		uint32			dir_end;
+	}
+}
+
+
+Demofile Directory Entries
+--------------------------------------------------------------------------------
+
+A directory entry is used to define a series of data segments of the recording
+which contain the game data. Usually this is used to split data of the 
+"Loading..." part and the actual game recording part.
+
+DemoDirectoryEntry->offset points to the start of a data segment within the 
+demofile.
+
+struct DemoDirectoryEntry
+{
+	uint32		number;
+	char[64]	title;
+	uint32		flags;
+	int32		play;
+	float32		time;
+	uint32		frames;
+	uint32		offset;		// points to a DemoSegment
+	uint32		length;		// length of the DemoSegment at offset
+}
+
+
+Demofile Data Segments
+--------------------------------------------------------------------------------
+
+Each segment is of variable size and contains a sequence of numbered macro
+blocks. We use it here purely as a virtual container.
+
+struct DemoSegment
+{
+	DemoMacro*	macros;
+}
+
+
+Demofile Macro Blocks
+--------------------------------------------------------------------------------
+
+Each macro block is "stamped" with time and frame information from the
+recording and is followed by the individual macro type data which has to be 
+parsed individually. This relates to the game engine's status information at
+a specific time.
+
+The game uses 10 macro types:
+
+	0 = 'Game Data'

+	1 = 'Game Data'

+	2 = 'N/A'				// unused, skip

+	3 = 'Client Command'			// string

+	4 = 'N/A'				// string

+	5 = 'Last in segment'

+	6 = 'N/A'

+	7 = 'N/A'--------------------------------------------------------------------------------

+	8 = 'Play Sound'

+	9 = 'N/A'				// delta data
+
+struct DemoMacroHeader
+{
+	uint32		file_offset;
+	uint8		type;
+	float32		time;
+	uiint32		frame;
+	...
+}
+
+Demofile Macro Types
+--------------------------------------------------------------------------------
+
+Each macro type has it's own structure closely related to the game engine and
+it's parsing differs among the demo's network version.
+
+# 0 and 1 / Game Data:
+
+struct DemoMacro_GameData
+{
+	if(network_version = 42)
+	{
+	uint8[560]	extinfo;
+	}
+	else
+	if(network_version >= 45)
+	{
+	uint8[220]	extinfo;
+	uint16		recorded_resolution_width;
+	uint16		recorded_resolution_height;		
+	uint16		recorded_resolution_depth;
+	uint8[238]	extinfo;		
+	}
+	
+	int32		chunklength;	// size of following DemoServerMessage
+	...
+}
+
+A server message follows the game data information and is parsed dynamically.
+
+struct DemoServerMessage
+{
+	uint8		id;
+	...
+}
+
+List of Server Message IDs:
+
+{0}     'bad',

+{1}     'nop',

+{2}     'disconnect',

+{3}     'event',

+{4}     'version',

+{5}     'setview',

+{6}     'sound',

+{7}     'time',

+{8}     'print',

+{9}     'stufftext',

+{10}    'setangle',

+{11}    'serverinfo',

+{12}    'lightstyle',

+{13}    'updateuserinfo',

+{14}    'deltadescription',

+{15}    '',

+{16}    'stopsound',

+{17}    '',

+{18}    '',

+{19}    '',

+{20}    '',

+{21}    '',

+{22}    '',

+{23}    'temp_entity',

+{24}    'setpause',

+{25}    '',

+{26}    '',

+{27}    '',

+{28}    '',

+{29}    'spawnstaticsound',

+{30}    'intermission',

+{31}    '',

+{32}    'cdtrack',

+{33}    '',

+{34}    '',

+{35}    'weaponanim',

+{36}    '',

+{37}    'roomtype',

+{38}    'addangle',

+{39}    'newusermsg',

+{40}    '',

+{41}    '',

+{42}    '',

+{43}    '',

+{44}    '',

+{45}    'classinfo',

+{46}    '',

+{47}    '',

+{48}    '',

+{49}    '',

+{50}    'hltv',

+{51}    'director',

+{52}    '',

+{53}    '',

+{54}    'sendextrainfo',

+{55}    '',

+{56}    '',

+{57}    '',

+{58}    '',

+{59}    '',

+{60}    '',

+{61}    '',

+{62}    '',

+{63}    '',

+{64}    '',

+{65}    '',

+{66}    '',

+{67}    '',

+{68}    '',

+{69}    '',

+{70}    '',

+{71}    '',

+{72}    '',

+{73}    '',

+{74}    '',

+{75}    '',

+{76}    '',

+{77}    '',

+{78}    '',

+{79}    '',

+{80}    '',

+{81}    '',

+{82}    '',

+{83}    '',

+{84}    '',

+{85}    '',

+{86}    '',

+{87}    '',

+{88}    '',

+{89}    '',

+{90}    '',

+{91}    '',

+{92}    '',

+{93}    '',

+{94}    '',

+{95}    '',

+{96}    '',

+{97}    '',

+{98}    '',

+{99}    '',

+{100}   ''
+
+# 2 / Unknown
+
+This is an unused macro type in Half-Life and should never be encountered.
+
+# 3 / Client Command
+
+A null-terminated string corresponding to a client command such as "+weapon".
+
+# 4 / Unknown
+
+A null-terminated string.
+
+# 5 / Last in segment
+
+This macro type marks the end of this segment for verification and switch to the
+next one.
+
+# 6 / Unknown
+