Port r13909 from the mainline.

[xiph/unicode.git] / oggdsf / README

Information for builds after 0.71 \r
=================================\r
\r
This project now uses VS2005. VS2003/2002/6.0 will *not*\r
 be able to open or build this project.\r
\r
This also means it uses V8.0 of the run time libraries.\r
Depending if i have suppressed the warnings, you may\r
see lots of compiler warnings about things in the C\r
library being deprecated. As of V8.0 most of the standard\r
C library is marked deprecated and it is recommended to\r
use new and semantically different functions from the new\r
secure CRT. Since there are so many of these occurences,\r
and some of the code needs to be portable, these warnings\r
are mostly suppressed/ignored.\r
\r
In order to fix unicode problems on modern systems without\r
 dropping support for 9X/ME machines, a custom built\r
 C runtime needs to be used. These are in the repository\r
 in the bin directory. You need to overwrite some of your\r
 Visual Studio files to build the version that can run\r
 on the old versions. At this stage i haven't checked\r
 whether it is now unbuildable without doing this (i don't\r
 think it will be, just you will get a binary that only\r
 works on NT/2K/XP systems)\r
\r
(More info to come on this)  \r
\r
You need to set up several things in your build environment\r
 in order to build this project. It depends on several\r
 Microsoft SDK's. Without these you cannot build this\r
 project.\r
\r
The directshow SDK is now part of the core platforms SDK.\r
 You will need this as well as the DirectX SDK.\r
\r
There are no longer hardcoded paths into the directx sdk,\r
 all the projects now use the environment variables that\r
 are created by installing the SDK's.\r
\r
The main solution is in \sln\oggdsf_all\r
\r
Some projects in the solution may not build. You should\r
 build the distribution project called oggcodecs, to\r
 ensure you are build all and only the projects that are\r
 part of the core distribution. VS Express, may or may not\r
 properly handle distribution project.\r
\r
If you are using the distribution project from the IDE\r
 it is important that before you\r
 install using that installer, that you uninstall any\r
 version of the official distribution. Similarly, if\r
 you are going to install the official distribution\r
 after you have used this feature, you need to unistall\r
 the official distribution.\r
 They use two different installer technologies, and each\r
  will install over the other without the other one\r
  knowing.\r
\r
In order to build you need the following\r
 * Visual Studio 2005 - I develop and test with the professional\r
    edition. This is the recommended way to build.\r
\r
    It should/may also be possible to build with the\r
    free Express edition. To build the directshow filters\r
    core package, you'll need VC++ 2005 Express. Other\r
    projects not part of the core distribution are in C#\r
    so if you want to be able to open every project in the\r
    solution you will also need this. I have not tested\r
    using the express edition yet. If you try and it works\r
    let me know, or tell me anything special you had to do.\r
\r
    You can download express edition for free from\r
    http://msdn.microsoft.com/vstudio/express/visualc/default.aspx\r
\r
    \r
 * Windows Server 2003 SP1 Platform SDK - Yes, even if you\r
    are using XP or whatever operating system.\r
\r
    You can download it from (~400MB, getting the disk image is easiest)\r
    http://www.microsoft.com/downloads/details.aspx?FamilyId=A55B6B43-E24F-4EA3-A93E-40C0EC4F68E5&displaylang=en\r
\r
   You will need to update the build paths in VS2005, whether\r
    you use express or the full version. The following link explains\r
    how to do that (see step 3). If using express, you will need\r
    to follow all the steps on this link.\r
\r
   http://msdn.microsoft.com/vstudio/express/visualc/usingpsdk/\r
\r
   See step 3. \r
\r
   eg. in the Executable files list *at the top* of the list\r
    ad $(MSSdk)\Bin and in the include list $(MSSdk)\include\r
   They must be at the top (or at least above the other\r
    references to the built in platform sdk), \r
    otherwise the compiler will\r
    still use the old version it came with.\r
\r
   In the installer there is one item not checked at the top\r
    This option adds the MSSdk environment variable. It\r
    warns this could affect other programs that use older\r
    versions of the platform sdk. It caused no problem for\r
    me, but if you have development projects depending \r
    on this variable and/or older versions of the platform\r
    SDK, you'll have to work out what works for you. That\r
    warning is pretty big and bold.\r
\r
   If you don't take this option, you'll need to hardcode in\r
    the path you installed the platform sdk to as it does\r
    suggest in step 3 of the link above, however this still\r
    changes VS's global settings could also cause problems.\r
\r
   Alternatively, if you don't take this option, and later \r
    realise that this issue will not affect you, you can\r
    add the MSSdk user and system variable yourself if you\r
    choose.\r
\r
   Hardcoding the path will force VS to always use this\r
    version, and you'll have to update it if a new one\r
    comes out. Using the environment variable will cause\r
    it to always use the latest version (really whatever version\r
    the variable points to). Each option has it's ups and\r
    downs, depending on what other development work you do.\r
\r
   Also note: That big bold warning says you can register with\r
    visual studio by using a link in the start menu. This\r
    *does not* work for VS2005. The platform SDK was released\r
    before VS2005, it's probably updating the build paths\r
    in vs2003. This is the reason you have to manaully update\r
    the paths in options. It's likely when a new platform\r
    SDK is released it will work properly for VS2005.\r
   \r
\r
   You mileage mary vary if you have the express edition.\r
\r
 * DirectX SDK February 2006 (or probably later will work too)\r
\r
    You can download it from (~350MB, validation required)\r
    http://www.microsoft.com/downloads/details.aspx?FamilyID=EDB98FFA-A59C-4C23-9B92-BA304F188314&displaylang=en\r
\r
    You will also need to add to your include paths in\r
     Visual Studio the path to the DX include files.\r
    This DX SDK creates the environment variable DXSDK_DIR\r
\r
    So you need to add to the include list (as you did above)\r
    $(DXSDK_DIR)include\r
\r
 * WMP 10 SDK - Need after 0.72 release.\r
\r
   You can download from here\r
   http://msdn.microsoft.com/windowsmedia/downloads/default.aspx\r
\r
   You need to add the include path to visual studio. In\r
   tools->options->projects and solutions->vC++ dirs\r
 \r
\r
   Add the WMP include path to the include list (drop down at top)\r
   default install path will be c:\WMSDK\WMPSDK10\include\r
\r
 * NASM 0.98.38/0.98.39 - This is required for flac. Best to\r
    install it to it's default at C:\NASM. Where "best to"\r
    means if you don't want to be screwing around.\r
\r
   You can download from here\r
   http://sourceforge.net/projects/nasm\r
\r
 * Windows Mobile 5.0 Developer Resource Kit (~900MB)\r
    http://www.microsoft.com/downloads/details.aspx?familyid=3BAA5B7D-04C1-4EC2-83DC-61B21EC5FE57&displaylang=en\r
\r
   The express edition can not do mobile development.\r
   I have no idea whether it will let you open the project\r
    and ignore the mobile configurations or whether\r
    it will just refuse to let you. I'm not sure if\r
    the professional edition will even let you open the\r
    projects which have wm5 configs (most of them)\r
    without installing this.\r
\r
 * Doxygen with DOT if you want to create the doc files\r
   - Most recently used graphviz (DOT) V2.8 from\r
     http://www.graphviz.org/Download_windows.php\r
   - And doxygen version 1.4.7 from\r
     http://www.stack.nl/~dimitri/doxygen/download.html#latestsrc\r
\r
 * NSIS (currently using 2.17) to build the installers\r
\r
\r
\r
You need all these things if you want to build this project.\r
 If you already do directx/multimedia development you may already\r
 have some or all of these sdk's. You only need them once to setup\r
 your build environment.\r
\r
It may seem excessive that you need to download 2 gigabytes of stuff\r
 just to build. This project uses technologies from several sdk's, \r
 and there is no way around that. Once you set up these things, the\r
 project is very easy to build, with the professional edition and\r
 above that is, possibly the standard edition. \r
\r
The baseclasses library is no longer used from the platform\r
 SDK (but you still need it). There is a modified version\r
 of the baseclasses libraries that is part of this source.\r
 The version in the platform SDK won't build in VS2005 as it\r
 is, the modifed version that is part of this source has\r
 fixes so that it builds correctly with the new compiler.\r
\r
This project now uses V8 of the runtime libraries. As of\r
 version 8, there are changes to the way the operating system\r
 handles these libraries. The first release to use this is/will be\r
 0.72.xxxx\r
\r
The release distributions are built using NSIS. There is\r
 an MSI installer project in the solution, this is only\r
 for developer convenience. It is often not fully up to\r
 date, and/or correct. It should *never* be used as a means\r
 of distribution.\r
   \r
\r
==========================================================\r
The below information is left for reference, where the \r
 information above conflicts with this, the information\r
 above should take precedence. Much of the information \r
 below is no longer relevant.\r
==========================================================\r
Updated after 0.62 release.\r
==========================\r
\r
These are probably not very build friendly at the moment.\r
I will make them a bit more user friendly in the future.\r
\r
\r
In order to build these...\r
\r
\r
You need visual studio 2003. There are no VC6 files or VS2002 files.\r
 In theory you should be able to create VC2002 files... and in fact\r
 out of date VC2002 files are generally found with .vcproj.bak \r
 extensions. However some of the libraries will not build in VS2002,\r
 there is a bug in the 2002 compilers imlpementation of mixed mode\r
 dlls, which stops some of the .NET bridging libraries linking.\r
\r
You need NASM for FLAC to build. (lifes easier if it's at C:\NASM)\r
 you'll have to play around with that yourself... it's a real pain !\r
 Also the vcproj files have hidden settings that don't show up\r
 in visual studio... you'll have to figure it out (ie edit the vcproj)\r
 I suggest once you get it to build, leave it built... don't clean\r
 that project. The clean script it has for some reason tries to\r
 delete some necessary header files. Don't ask me why !\r
 Also ignore visual studio hassling you about sourcesafe for flac.\r
\r
I've been using NASM 0.98.38 which you can find here\r
 http://sourceforge.net/projects/nasm You want the win32 binaries.\r
\r
If you do accidentally clean FLAC, you will get a message when you\r
 try to build that says "ordinals.h" not found. You need to\r
 go to the libFLAC directory and find the file called ordinals.h.bak\r
 and *copy* it to the same directory without the .in extension.\r
 Don't just rename it... you want to keep that file for next time\r
 this happens !\r
\r
You need DirectX 9 SDK installed (lifes easier if it's at C:\DXSDK)\r
 Otherwise all projects prefixed with dsf you'll need to change the\r
 absolute references to that path. I'll try to do something to make\r
 this easier in future.\r
 \r
If the baseclasses project shows up as not found, you need to find\r
 it in the DXSDK directory tree, and load it from there.\r
 By default it tries to build against Multithreaded static runtimes\r
 You *must* change these to Multi Threaded DLL or Multi Threaded \r
 debug DLL. Otherwise all sorts of chaos will occur. This project\r
 is not part of the package. It is part of the DirectX SDK.\r
\r
If you try to build the installer project, you need to change the paths\r
 of the AUTHORS, COPYRIGHTS etc files... i can't make it accept a\r
 relative path.\r
\r
Probably other stuff i can't think of. These aren't really ready for\r
 easy use yet.\r
\r