xiph-qt/README

   1 XiphQT
   2 ======
   3
   4 XiphQT, the Xiph QuickTime Components, is a collection of QuickTime
   5 and Mac OS X 'plug-ins' providing support for the Xiph.Org Foundation's
   6 (http://xiph.org/) multimedia compression formats.
   7
   8
   9 Building
  10 ========
  11
  12 The XiphQT source code is accompanied by a set of Xcode project files,
  13 and can be built easily using Xcode GUI or 'xcodebuild' command line
  14 tool. To build from sources source codes of a number of additional
  15 libraries need to be placed in the ./external-libs folder (see below).
  16
  17 The latest version of XiphQT makes use of the following libraries:
  18 ogg, vorbis, flac, speex, theora and theora-exp. Their source code can
  19 be found on http://xiph.org/ .
  20
  21 To build using Xcode's xcodebuild command-line tool type with the
  22 ./build-macosx as the current working directory:
  23
  24     > xcodebuild -target XiphQT -configuration Release
  25
  26 That should produce statically linked XiphQT.component bundle in the
  27 ./build-macosx/build/Release directory.
  28
  29 To only build decoder and importer components use type:
  30
  31     > xcodebuild -target 'XiphQT (decoders)' -configuration Release
  32
  33
  34 Installing
  35 ==========
  36
  37 The binary component bundle needs to be installed in
  38 ~/Library/Components (or /Library/Components for system-wide
  39 installation). Create the folder if it doesn't exist.
  40
  41
  42 Source code organisation
  43 ========================
  44
  45 ./AppleSDK
  46         contains selected files from the CoreAudio SDK; these files are the
  47         base of the AudioCodec API
  48
  49 ./CAFLAC
  50         FLAC AudioCodec files
  51
  52 ./CASpeex
  53         Speex AudioCodec files
  54
  55 ./CAVorbis
  56         Vorbis AudioCodec files
  57
  58 ./OggImport
  59         Ogg QuickTime MovieImporter component files
  60
  61 ./OggExport
  62         Ogg QuickTime Movie Data Export component files
  63
  64 ./Theora
  65         Theora QuickTime ImageCodec component files
  66
  67 ./common, ./utils and ./resources
  68         Functions, definition and resources shared between several components
  69
  70 ./external-libs
  71         Source code of the external libraries should be placed here in
  72         the corresponding subfolders: ogg, speex, theora, vorbis, flac
  73         (using SVN repository all libraries except flac can be pulled
  74         automatically)
  75
  76 ./build-macosx
  77         Xcode project files, for building for Mac OS X
  78
  79 ./build-win32
  80         Win32 build files
  81
  82
  83 Copying
  84 =======
  85
  86     XiphQT is free software; you can redistribute it and/or
  87     modify it under the terms of the GNU Lesser General Public
  88     License as published by the Free Software Foundation; either
  89     version 2.1 of the License, or (at your option) any later version.
  90
  91     XiphQT is distributed in the hope that it will be useful,
  92     but WITHOUT ANY WARRANTY; without even the implied warranty of
  93     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See file COPYING
  94     for the details.
  95
  96
  97     ---
  98     The part of the CoreAudio SDK, included under the ./AppleSDK directory,
  99     is redistributed according to the terms specified in the files. See
 100     the file headers for more details.
 101
 102
 103     ---
 104     Part of the OggImport component source code written by Steve Nicolai
 105     is distributed under the terms of BSD-style License. See file
 106     COPYING.qtcomponents in the OggImport directory for the details.
 107
 108
 109
 110 More Information
 111 ================
 112
 113 More information can be found on the project webpages at:
 114 http://xiph.org/quicktime/