markdown/deploying/windows.md

   1 # Windows deployment
   2
   3 This page explains how to deploy GStreamer along your
   4 application. There are different mechanisms, which have been reviewed
   5 in [](deploying/index.md). The details for some of the
   6 mechanisms are given here, and more options might be added to this
   7 documentation in the future.
   8
   9 ## Shared GStreamer
  10
  11 This is the easiest way to deploy GStreamer, although most of the time
  12 it installs unnecessary files which grow the size of the installer and
  13 the target drive free space requirements. Since GStreamer might be shared
  14 among all applications that use it, though, the extra space requirements
  15 are somewhat blurred.
  16
  17 Simply pack GStreamer  **runtime**  installer ([the same one you
  18 installed in your development machine](installing/on-windows.md))
  19 inside your installer (or download it from your installer) and execute
  20 it silently using `msiexec`. `msiexec` is the tool that wraps most of
  21 the Windows Installer functionality and offers a number of options to
  22 suit your needs. You can review these options by
  23 executing `msiexec` without parameters. For example using 1.8.1:
  24
  25 ```
  26 msiexec /i gstreamer-1.0-x86-1.8.1.msi
  27 ```
  28
  29 This will bring up the installation dialog as if the user had
  30 double-clicked on the `msi` file. Usually, you will want to let the user
  31 choose where they want to install GStreamer. An environment variable will
  32 let your application locate it later on.
  33
  34 ## Private deployment of GStreamer
  35
  36 You can use the same method as the shared GStreamer, but instruct its
  37 installer to deploy to your application’s folder (or a
  38 subfolder). Again, use the `msiexec` parameters that suit you best. For
  39 example:
  40
  41 ```
  42 msiexec /passive INSTALLDIR=C:\Desired\Folder /i gstreamer-1.0-x86-1.8.1.msi
  43 ```
  44
  45 This will install GStreamer to `C:\Desired\Folder`  showing a progress
  46 dialog, but not requiring user intervention.
  47
  48 ## Deploy only necessary files, by manually picking them
  49
  50 On the other side of the spectrum, if you want to reduce the space
  51 requirements (and installer size) to the maximum, you can manually
  52 choose which GStreamer libraries to deploy. Unfortunately, you are on
  53 your own on this road, besides using the [Dependency
  54 Walker](http://www.dependencywalker.com/) tool to discover inter-DLL
  55 dependencies.
  56
  57 Bear in mind that GStreamer is modular in nature. Plug-ins are loaded
  58 depending on the media that is being played, so, if you do not know in
  59 advance what files you are going to play, you do not know which DLLs you
  60 need to deploy.
  61
  62 ## Deploy only necessary packages, using provided Merge Modules
  63
  64 If you are building your installer using one of the Professional
  65 editions of [Visual
  66 Studio](http://www.microsoft.com/visualstudio/en-us/products/2010-editions/professional/overview)
  67 or [WiX](http://wix.sf.net) you can take advantage of pre-packaged
  68 [Merge
  69 Modules](http://msdn.microsoft.com/en-us/library/windows/desktop/aa369820\(v=vs.85\).aspx).
  70 GStreamer is divided in packages, which roughly take care of
  71 different tasks. There is the core package, the playback package, the
  72 networking package, etc. Each package contains the necessary libraries
  73 and files to accomplish its task.
  74
  75 The Merge Modules are pieces that can be put together to build a larger
  76 Windows Installer. In this case, you just need to create a deployment
  77 project for your application with Visual Studio and then add the Merge
  78 Modules for the GStreamer packages your application needs.
  79
  80 This will produce a smaller installer than deploying the complete
  81 GStreamer, without the added burden of having to manually pick each
  82 library. You just need to know which packages your application requires.
  83
  84 | Package name | Dependencies | Licenses | Description |
  85 |--------------|--------------|----------|-------------|
  86 | base-system-1.0  | |JPEG, FreeType, BSD-like, LGPL, LGPL-2+, LGPL-2.1, LibPNG and MIT | Base system dependencies |
  87 | gstreamer-1.0-capture | gstreamer-1.0-core, gstreamer-1.0-encoding | LGPL and LGPL-2+ | GStreamer plugins for capture |
  88 | gstreamer-1.0-codecs | base-crypto, gstreamer-1.0-core | BSD, Jasper-2.0, BSD-like, LGPL, LGPL-2, LGPL-2+, LGPL-2.1 and LGPL-2.1+ | GStreamer codecs |
  89 | gstreamer-1.0-codecs-gpl | gstreamer-1.0-core | BSD-like, LGPL, LGPL-2+ and LGPL-2.1+ | GStreamer codecs under the GPL license and/or with patents issues |
  90 | gstreamer-1.0-core | base-system-1.0 | LGPL and LGPL-2+ | GStreamer core |
  91 | gstreamer-1.0-dvd | gstreamer-1.0-core | GPL-2+, LGPL and LGPL-2+ | GStreamer DVD support |
  92 | gstreamer-1.0-effects | gstreamer-1.0-core | LGPL and LGPL-2+ | GStreamer effects and instrumentation plugins |
  93 | gstreamer-1.0-net | base-crypto, gstreamer-1.0-core | GPL-3, LGPL, LGPL-2+, LGPL-2.1+ and LGPL-3+ | GStreamer plugins for network protocols |
  94 | gstreamer-1.0-playback | gstreamer-1.0-core | LGPL and LGPL-2+ | GStreamer plugins for playback |
  95 | gstreamer-1.0-system | gstreamer-1.0-core | LGPL, LGPL-2+ and LGPL-2.1+ | GStreamer system plugins |
  96 | gstreamer-1.0-visualizers | gstreamer-1.0-core | LGPL and LGPL-2+ | GStreamer visualization plugins |
  97 | gstreamer-1.0-encoding | gstreamer-1.0-core, gstreamer-1.0-playback | LGPL and LGPL2+ | GStreamer plugins for encoding |
  98 | gstreamer-1.0-editing | gstreamer-1.0-core, gstreamer-1.0-devtools | LGPL and LGPL2+ | GStreamer libraries and plugins for non linear editing |
  99 | gstreamer-1.0-devtools | gstreamer-1.0-core | LGPL and LGPL2+ | GStreamer developers tools |
 100 | gstreamer-1.0-libav | gstreamer-1.0-core | LGPL and LGPL2+ | GStreamer plugins wrapping ffmpeg |
 101 | gstreamer-1.0-net-restricted | base-crypto, gstreamer-1.0-core | LGPL and LGPL2+ | GStreamer plugins for network protocols with potential patent issues in some countries |
 102 | gstreamer-1.0-codecs-restricted | gstreamer-1.0-core | LGPL and LGPL2+ | GStreamer restricted codecs with potential patent issues in some countries |
 103 | base-crypto | base-system-1.0 | LGPL and LGPL2+ | Cryptographic libraries |
 104
 105
 106 If you include a merge module in your deployment project, remember to
 107 include also its dependencies. Otherwise, the project will build
 108 correctly and install flawlessly, but, when executing your application,
 109 it will miss files.