docs: Update docs for installing on windows

This page has been only sporadically updated for a decade, and it is
unlikely to be updated properly anytime soon. Update the top half, and
add a note about the tutorial section being out of date.

The trigger for this was a question on the mailing list about Windows
11 support, since it's not listed in the supported platforms list.

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/5239>
This commit is contained in:
Nirbheek Chauhan 2023-08-24 20:03:27 +05:30 committed by GStreamer Marge Bot
parent 6fa405c1e2
commit 46a4b07fe5

View file

@ -6,55 +6,33 @@
* Windows 8 * Windows 8
* Windows 8.1 * Windows 8.1
* Windows 10 * Windows 10
* Windows 11 and newer
## Prerequisites ## Prerequisites
To develop applications using GStreamer for Windows we recommend using To develop applications using GStreamer for Windows we recommend using Windows
[Windows 7](http://windows.microsoft.com/en-us/windows7/products/home) 10 or newer with Microsoft Visual Studio 2019 or newer. Older versions of each
or later. Windows Vista may also work but it is not supported. may also work, but they are not recommended.
GStreamer package includes C headers (`.h`) and library files (`.lib`) GStreamer package includes C headers (`.h`) and library files (`.lib`) valid
valid for any version of [Microsoft Visual for any version of [Microsoft Visual Studio](http://www.microsoft.com/visualstudio).
Studio](http://www.microsoft.com/visualstudio). For convenience, For convenience, property pages (`.props`) are also included which extremely
property pages (`.props`) are also included which extremely simplify simplify creating new projects.
creating new projects. These property pages, though, only work with
[Microsoft Visual
Studio 2010](http://www.microsoft.com/visualstudio/en-us/products/2010-editions)
and newer (including the free [Visual C++ Express
edition](http://www.microsoft.com/visualstudio/en-us/products/2010-editions/visual-cpp-express)).
The recommended system is
[Windows 7](http://windows.microsoft.com/en-us/windows7/products/home) or newer
with [Microsoft Visual
Studio 2010](http://www.microsoft.com/visualstudio/en-us/products/2010-editions)
or newer. Take a look at its [system
requirements](http://www.microsoft.com/visualstudio/en-us/products/2010-editions/visual-cpp-express)).
Installing GStreamer for 32-bit platforms requires approximately 286MB of
free disk space for the runtime and 207MB for the development files (as of some older version).
Installing GStreamer for 64-bits platforms requires up to approximately 350MB of
free disk space for the runtime and 400MB for the development files (as of version 1.15.1).
## Download and install GStreamer binaries ## Download and install GStreamer binaries
There are 3 sets of files in GStreamer binaries: There are 3 sets of files in GStreamer binaries:
- The runtime files are needed to run GStreamer applications. You - The runtime files are needed to run GStreamer applications. You probably want
probably want to distribute these files with your application (or to distribute these files with your application (or the installer below).
the installer below). - The development files are **additional** files you need at build-time to
- The development files are **additional** files you need to create create GStreamer applications.
GStreamer applications. - The [Merge Modules](http://msdn.microsoft.com/en-us/library/windows/desktop/aa369820%28v=vs.85%29.aspx)
- The [Merge files are **additional** files you can use to deploy GStreamer binaries
Modules](http://msdn.microsoft.com/en-us/library/windows/desktop/aa369820%28v=vs.85%29.aspx) alongside your application (see [Windows deployment](deploying/windows.md)).
files are **additional** files you can use to deploy GStreamer binaries
alongside your application (see [Windows
deployment](deploying/windows.md)).
Get both **the Runtime and Development** installers appropriate for Get both **the Runtime and Development** installers appropriate for
your architecture from here: your architecture from the [GStreamer download page](https://gstreamer.freedesktop.org/download/).
[GStreamer download page](https://gstreamer.freedesktop.org/download/)
If in doubt, download the 64-bit MSVC packages: If in doubt, download the 64-bit MSVC packages:
- Runtime installer: e.g. `gstreamer-1.0-msvc-x86_64-{VERSION}.msi` - Runtime installer: e.g. `gstreamer-1.0-msvc-x86_64-{VERSION}.msi`
@ -83,10 +61,10 @@ At runtime, GStreamer will look for its plugins in the following folders:
- `%HOMEDRIVE%%HOMEFOLDER%/.gstreamer-1.0/plugins` - `%HOMEDRIVE%%HOMEFOLDER%/.gstreamer-1.0/plugins`
- `C:\gstreamer\1.0\x86\lib\gstreamer-1.0` - `C:\gstreamer\1.0\x86\lib\gstreamer-1.0`
- `<location of libgstreamer-1.0-0.dll>\..\lib\gstreamer-1.0` - `<location of gstreamer-1.0-0.dll>\..\lib\gstreamer-1.0`
- `%GST_PLUGIN_PATH%` - `%GST_PLUGIN_PATH%`
So, typically, if your application can find `libgstreamer-1.0-0.dll`, So, typically, if your application can find `gstreamer-1.0-0.dll`,
it will find the GStreamer plugins, as long as the installation folder it will find the GStreamer plugins, as long as the installation folder
structure is unmodified. If you do change this structure in your structure is unmodified. If you do change this structure in your
application, then you can use the `GST_PLUGIN_PATH` environment application, then you can use the `GST_PLUGIN_PATH` environment
@ -99,6 +77,8 @@ environment variable to point where the plugins are located.
## Configure your development environment ## Configure your development environment
**NOTE: these instructions are out of date, exercise caution while following them**
### Building the tutorials ### Building the tutorials
The tutorials code, along with project files and a solution file for The tutorials code, along with project files and a solution file for