Build GStreamer in Windows CI

Author: Sean-Der

.github/build_windows.bat

@@ -2,5 +2,5 @@ call "C:\Program Files (x86)\Microsoft Visual Studio\2017\BuildTools\VC\Auxiliar
 mkdir build
 cd build
 cmd.exe /c cmake -G "NMake Makefiles" ..
-cmake -G "NMake Makefiles" -DBUILD_TEST=TRUE ..
+cmake -G "NMake Makefiles" -DBUILD_TEST=TRUE -DBUILD_GSTREAMER_PLUGIN=TRUE ..
 nmake

.travis.yml

@@ -107,7 +107,8 @@ matrix:
     - name: "Windows MSVC"
       os: windows
       script:
-        - choco install nasm strawberryperl
+        - choco install nasm strawberryperl gstreamer
+        - choco install gstreamer-devel --version=1.16.2 # gstreamer-devel has not been approved yet. Version number must be explicit to install
         - unset CC CC_FOR_BUILD CXX CXX_FOR_BUILD # We want to use MSVC
         - export "PATH=/c/Strawberry/perl/site/bin:/c/Strawberry/perl/bin:/c/Strawberry/c/bin:/c/Program Files/NASM:`pwd`/open-source/local/lib:`pwd`/open-source/local/bin:$PATH"
         - .github/build_windows.bat

CMakeLists.txt

@@ -127,6 +127,10 @@ link_directories(${LOG4CPLUS_LIBRARY_DIRS})
 find_library(Jsmn REQUIRED)
 set(OPEN_SRC_INCLUDE_DIRS ${OPEN_SRC_INCLUDE_DIRS} ${JSMN_INCLUDE_DIRS})
 
+if (WIN32)
+       set(PKG_CONFIG_EXECUTABLE "C:\\gstreamer\\1.0\\x86_64\\bin\\pkg-config.exe")
+endif()
+
 ############# Enable Sanitizers ############
 if("${CMAKE_C_COMPILER_ID}" MATCHES "GNU|Clang")
   set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fPIC")
@@ -176,7 +180,6 @@ include_directories(${KINESIS_VIDEO_PRODUCER_CPP_SRC}/src/JNI/include)
 include_directories(${KINESIS_VIDEO_PRODUCER_C_SRC}/src/include)
 
 if (WIN32)
-  SET(JSMN_LIBRARY "../../open-source/local/lib/jsmn")
   SET(Log4cplus "log4cplus::log4cplus")
 endif()
 

README.md

@@ -34,7 +34,7 @@ To download run the following command:
 `git clone --recursive https://github.com/awslabs/amazon-kinesis-video-streams-producer-sdk-cpp.git`
 
 Note: If you miss running git clone with --recursive, run `git submodule update --init` in the amazon-kinesis-video-streams-producer-sdk-cpp/open-source directory
-You will also need to install `pkg-config` and `CMake` and a build enviroment. If you are build the GStreamer plugin you will also need to install it locally.
+You will also need to install `pkg-config` and `CMake` and a build enviroment. If you are building the GStreamer plugin you will also need GStreamer and GStreamer (Development Libraries).
 
 Refer to the [FAQ](#FAQ) for platform specific instructions.
 
@@ -43,6 +43,8 @@ Create a build directory in the newly checked out repository, and execute CMake
 
 `mkdir -p amazon-kinesis-video-streams-producer-sdk-cpp/build; cd amazon-kinesis-video-streams-producer-sdk-cpp/build; cmake .. `
 
+If you are building on Windows you need to generate `NMake Makefiles`, you should run `cmake .. -G "NMake Makefiles"`
+
 GStreamer and JNI is NOT built by default, if you wish to build both you MUST execute `cmake .. -DBUILD_GSTREAMER_PLUGIN=ON -DBUILD_JNI=TRUE`
 
 By default we download all the libraries from GitHub and build them locally, so should require nothing to be installed ahead of time.
@@ -74,16 +76,28 @@ To build the library run make in the build directory you executed CMake.
 make
 ```
 
+On Windows you should run `nmake` instead of `make`
+
 In your build directory you will now have shared objects for all the targets you have selected
 
 ## Run
 ### GStreamer Plugin (kvssink)
 
 #### Loading Element
-The GStreamer plugin will be in your `build` directory, to load this plugin it will need to be in your `GST_PLUGIN_PATH`. Do this you can run
+The GStreamer plugin is located in your `build` directory.
+
+To load this plugin set the following environment variables. This should be run from the root of the repo, NOT the `build` directory.
 
 ```
 export GST_PLUGIN_PATH=`pwd`/build
+export LD_LIBRARY_PATH=`pwd`/open-source/local/lib
+```
+
+The equivalent for Windows is
+
+```
+set GST_PLUGIN_PATH=%CD%\build
+set PATH=%PATH%;%CD%\open-source\local\bin;%CD%\open-source\local\lib
 ```
 
 Now if you execute `gst-inspect-1.0 kvssink` you should get information on the plugin like
@@ -107,7 +121,7 @@ Plugin Details:
   Origin URL               http://gstreamer.net
 ```
 
-If the build failed, or `GST_PLUGIN_PATH` is not proprely set you will get output like
+If the build failed, or `GST_PLUGIN_PATH` is not properly set you will get output like
 
 ```text
 No such element or plugin 'kvssink'

docs/macos.md

@@ -8,18 +8,6 @@ $ export AWS_SECRET_ACCESS_KEY=YourSecretAccessKey
 ```
 optionally, set `AWS_SESSION_TOKEN` if integrating with temporary token and `AWS_DEFAULT_REGION` for the region other than `us-west-2`
 
-----
-##### Setting the environment variables for library path
-* Export the **LD_LIBRARY_PATH**=`<full path to your sdk cpp directory`>/open-source/local/lib. For example, if you have downloaded the CPP SDK in `/opt/awssdk` directory then you can set
-the LD_LIBRARY_PATH as below:
-```
-export LD_LIBRARY_PATH=/opt/awssdk/amazon-kinesis-video-streams-producer-sdk-cpp/open-source/local/lib:$LD_LIBRARY_PATH
-```
-* Set the path for the producer **SDK GStreamer plugin** so that GStreamer can locate it.
-```
-$ export GST_PLUGIN_PATH=<YourSdkFolderPath>/build:$GST_PLUGIN_PATH
-```
-
 ###### Discovering available devices.
 Run the `gst-device-monitor-1.0` command to identify available media devices in your system. An example output as follows:
 ```
@@ -203,16 +191,7 @@ The addFileLoggerPlatformCallbacksProvider API takes five parameters.
 #### Troubleshooting:
 
 ##### Library not found error when running the sample application
-If any error similar to the following shows that the library path is not properly set:
-```
- liblog4cplus-1.2.so.5: cannot open shared object file: No such file or directory
-```
-To resolve this issue, export the LD_LIBRARY_PATH=`<full path to your sdk cpp directory`>/open-source/local/lib. If you have downloaded the CPP SDK in `/opt/awssdk` directory then you can set
-	the LD_LIBRARY_PATH as below:
-
-```
-export LD_LIBRARY_PATH=/opt/awssdk/amazon-kinesis-video-streams-producer-sdk-cpp/open-source/local/lib:$LD_LIBRARY_PATH
-```
+Make sure you have set `GST_PLUGIN_PATH` and `LD_LIBRARY_PATH` in the `Loading Element` section of the main README.md
 
 #####  Build fails with "crypto/include/internal/cryptlib.h:13:11: fatal error: 'stdlib.h`"
 run `export MACOSX_DEPLOYMENT_TARGET=10.14`
@@ -229,7 +208,6 @@ The projects depend on the following open source components. Running `CMake` wil
 * automake 1.15.1 (GNU License)
 * flex 2.5.35 Apple(flex-31)
 * libtool (Apple Inc. version cctools-898)
-* jsoncpp - [License](https://github.com/open-source-parsers/jsoncpp/blob/master/LICENSE)
 
 ###### Unit test dependencies
 * [googletest](https://github.com/google/googletest)

docs/windows.md

@@ -1,3 +1,8 @@
+#### Installing GStreamer
+Install GStreamer and GStreamer development from https://gstreamer.freedesktop.org/download/
+
+Make sure when install that you do a full install, the standard install is missing important elements like `x264enc`
+
 ##### Discovering available devices:
 
 Run the command `gst-device-monitor-1.0` to discover available devices. A sample output of the command looks like following:

tst/CMakeLists.txt

@@ -22,7 +22,7 @@ target_link_libraries(${PROJECT_NAME}
             ${GTEST_LIBNAME})
 add_test(${PROJECT_NAME} ${PROJECT_NAME})
 
-if(BUILD_GSTREAMER_PLUGIN)
+if(BUILD_GSTREAMER_PLUGIN AND NOT WIN32)
   pkg_check_modules(GST_CHECK REQUIRED gstreamer-check-1.0)
 
   file(GLOB GST_PLUGIN_TEST_SOURCES gstreamer/*.cpp)