remove rtsp sample as it has been merged into sample app.

update release note for v1.7.1. Update doc.
stability fix.

Author: chehefen

README.md

@@ -44,9 +44,14 @@ This library is licensed under the Amazon Software License.
 
 ----
 ### Release notes
+
+#### Release 1.7.1 (6th Feb 2019)
+* Removed kinesis_video_gstreamer_sample_rtsp_app as the kinesis_video_gstreamer_sample_app has become multi-purposed for webcams, rtsp and video files.
+* stability fixes.
+
 #### Release 1.7.0 (14th Dec 2018)
 * Added support for uploading files(offline mode) to Kinesis Video Stream
-* Stability fixes
+* Additional fixes
 
 #### Release 1.6.0 (3rd Dec 2018)
 * JNI namespace change

docker_native_scripts/README.md

@@ -25,12 +25,12 @@ Download the `Dockerfile` and `start_rtsp_in_docker.sh` into a folder.  Once the
   rtspdockertest      latest              54f0d65f69b2        Less than a second ago   2.82GB
 
 ```
-#### Start the Docker container 
+#### Start the Docker container
 ---
 
 *  Start the Kinesis Video Streams Docker container using the following command:
 ```
-   $ docker run -it <IMAGE_ID> <AWS_ACCESS_KEY_ID> <AWS_SECRET_ACCESS_KEY> <RTSP_URL> <STREAM_NAME>
+   $ docker run -it <IMAGE_ID> <AWS_ACCESS_KEY_ID> <AWS_SECRET_ACCESS_KEY> <STREAM_NAME> <RTSP_URL>
 ```
 
 

docker_native_scripts/start_rtsp_in_docker.sh

@@ -1,9 +1,9 @@
 #!/bin/bash
 # Demo GStreamer Sample Application for RTSP Streaming to Kinesis Video Streams
-# To be run inside the Docker container 
+# To be run inside the Docker container
 
 cd /opt/amazon-kinesis-video-streams-producer-sdk-cpp/kinesis-video-native-build/
 
 # Start the demo rtsp application to send video streams
 export LD_LIBRARY_PATH=/opt/amazon-kinesis-video-streams-producer-sdk-cpp/kinesis-video-native-build/downloads/local/lib:$LD_LIBRARY_PATH
-AWS_ACCESS_KEY_ID=$1 AWS_SECRET_ACCESS_KEY=$2 ./kinesis_video_gstreamer_sample_rtsp_app $3 $4
+AWS_ACCESS_KEY_ID=$1 AWS_SECRET_ACCESS_KEY=$2 ./kinesis_video_gstreamer_sample_app $3 $4

docker_native_scripts/windows/start_rtsp_in_docker.bat

@@ -1,5 +1,5 @@
 REM Demo GStreamer Sample Application for RTSP Streaming to Kinesis Video Streams
-REM To be run inside the Docker container 
+REM To be run inside the Docker container
 
 cd /opt/amazon-kinesis-video-streams-producer-sdk-cpp/kinesis-video-native-build/Release
 
@@ -9,4 +9,4 @@ set AWS_ACCESS_KEY_ID=%1
 set AWS_SECRET_ACCESS_KEY=%2
 
 REM %3 is RTSP_URL and %4 for STREAM_NAME
-kinesis_video_gstreamer_sample_rtsp_app.exe %3 %4
+kinesis_video_gstreamer_sample_app.exe %3 %4

docker_native_scripts/windows/windows-docker-readme.md

@@ -28,5 +28,5 @@ Use the **IMAGE_ID** from the output (e.g `02181afc49f9`):
 #### 3. Start the Docker container to run RTSP video streaming
 Run the Docker container to send video to Kinesis Video Streams using the following command:
 ```
-  > docker run -it <IMAGE_ID> <AWS_ACCESS_KEY_ID> <AWS_SECRET_ACCESS_KEY> <RTSP_URL> <YOUR_STREAM_NAME>
+  > docker run -it <IMAGE_ID> <AWS_ACCESS_KEY_ID> <AWS_SECRET_ACCESS_KEY> <YOUR_STREAM_NAME> <RTSP_URL>
 ```

install-instructions-linux.md

@@ -205,7 +205,8 @@ $ gst-launch-1.0 rtspsrc location=rtsp://YourCameraRtspUrl short-header=TRUE ! r
 ```
 
 **Note:** If you are using IoT credentials then you can pass them as parameters to the gst-launch-1.0 command
-``` gst-launch-1.0 rtspsrc location=rtsp://YourCameraRtspUrl short-header=TRUE ! rtph264depay ! video/x-h264, format=avc,alignment=au !
+```
+$ gst-launch-1.0 rtspsrc location=rtsp://YourCameraRtspUrl short-header=TRUE ! rtph264depay ! video/x-h264, format=avc,alignment=au !
  kvssink stream-name="iot-stream" iot-certificate="iot-certificate,endpoint=endpoint,cert-path=/path/to/certificate,key-path=/path/to/private/key,ca-path=/path/to/ca-cert,role-aliases=role-aliases"
 ```
 
@@ -222,11 +223,9 @@ $ gst-launch-1.0 v4l2src do-timestamp=TRUE device=/dev/video0 ! h264parse ! vide
 ###### Running the `gst-launch-1.0` command to start streaming from camera source in **Raspberry-PI**.
 
 ```
-$ gst-launch-1.0 v4l2src do-timestamp=TRUE device=/dev/video0 ! videoconvert ! video/x-raw,format=I420,width=640,height=480,framerate=30/1 ! omxh264enc control-rate=1 target-bitrate=5120000 periodicity-idr=45 inline-header=FALSE ! h264parse ! video/x-h264,stream-format=avc,alignment=au,width=640,height=480,framerate=30/1 ! kvssink stream-name=YourStreamName frame-timestamp=dts-only access-key=YourAccessKey secret-key=YourSecretKey
+$ gst-launch-1.0 v4l2src do-timestamp=TRUE device=/dev/video0 ! videoconvert ! video/x-raw,format=I420,width=640,height=480,framerate=30/1 ! omxh264enc control-rate=1 target-bitrate=5120000 periodicity-idr=45 inline-header=FALSE ! h264parse ! video/x-h264,stream-format=avc,alignment=au,width=640,height=480,framerate=30/1 ! kvssink stream-name=YourStreamName access-key=YourAccessKey secret-key=YourSecretKey
 ```
 
-**Note:**  Raspberry PI camera module requires `frame-timestamp=dts-only` . If USB camera is used for streaming then this property is optional.
-
 ##### 4. Run the demo application from Docker
 
 Refer the **README.md** file in the  *docker_native_scripts* folder for running the build and RTSP demo application within Docker container.

install-instructions-macos.md

@@ -105,7 +105,9 @@ $ gst-launch-1.0 rtspsrc location=rtsp://YourCameraRtspUrl short-header=TRUE ! r
 ```
 
 **Note:** If you are using IoT credentials then you can pass them as parameters to the gst-launch-1.0 command
-``` gst-launch-1.0 rtspsrc location=rtsp://YourCameraRtspUrl short-header=TRUE ! rtph264depay ! video/x-h264, format=avc,alignment=au !
+
+```
+$ gst-launch-1.0 rtspsrc location=rtsp://YourCameraRtspUrl short-header=TRUE ! rtph264depay ! video/x-h264, format=avc,alignment=au !
  kvssink stream-name="iot-stream" iot-certificate="iot-certificate,endpoint=endpoint,cert-path=/path/to/certificate,key-path=/path/to/private/key,ca-path=/path/to/ca-cert,role-aliases=role-aliases"
 ```
 
@@ -119,16 +121,23 @@ $ gst-launch-1.0 autovideosrc ! videoconvert ! video/x-raw,format=I420,width=640
 The demo application `kinesis_video_gstreamer_sample_app` in the `kinesis-video-native-build` directory uses GStreamer pipeline to get video data from the camera. Launch it with a stream name and it will start streaming from the camera. The user can also supply a streaming resolution (width and height) through command line arguments.
 
 ```
-Usage: AWS_ACCESS_KEY_ID=YourAccessKeyId AWS_SECRET_ACCESS_KEY=YourSecretAccessKey ./kinesis_video_gstreamer_sample_app -w <width> -h <height> -f <framerate> -b <bitrateInKBPS> <my_stream_name>
+Usage: AWS_ACCESS_KEY_ID=YourAccessKeyId AWS_SECRET_ACCESS_KEY=YourSecretAccessKey ./kinesis_video_gstreamer_sample_app <my_stream_name> -w <width> -h <height> -f <framerate> -b <bitrateInKBPS>
 ```
 * **A.** If **resolution is provided** then the sample will try to check if the camera supports that resolution. If it does detect that the camera can support the resolution supplied in command line, then streaming starts; else, it will fail with an error message `Resolution not supported`.
 * **B.** If **no resolution is specified**, the demo will try to use these three resolutions **640x480, 1280x720 and 1920x1080** and will **start streaming** once the camera supported resolution is detected.
 
 ##### Running the GStreamer RTSP demo application
-The GStreamer RTSP demo app will be built in `kinesis_video_gstreamer_sample_rtsp_app` in the `kinesis-video-native-build` directory. Launch it with a stream name and `rtsp_url`  and it will start streaming.
+`kinesis_video_gstreamer_sample_app` also supports taking a rtsp url. In the `kinesis-video-native-build` directory. Launch it with a stream name and `rtsp_url`  and it will start streaming.
+
+```
+AWS_ACCESS_KEY_ID=YourAccessKeyId AWS_SECRET_ACCESS_KEY=YourSecretAccessKey ./kinesis_video_gstreamer_sample_app <my-rtsp-stream> <my_rtsp_url>
+```
+
+##### Uploading a video file
+`kinesis_video_gstreamer_sample_app` also supports uploading a video that is either mkv, mpegts, or mp4. The file content has to be h264 encoded. In the `kinesis-video-native-build` directory. Launch it with a stream name and a path to the file and it will start streaming.
 
 ```
-AWS_ACCESS_KEY_ID=YourAccessKeyId AWS_SECRET_ACCESS_KEY=YourSecretAccessKey ./kinesis_video_gstreamer_sample_rtsp_app <my_rtsp_url> my-rtsp-stream
+AWS_ACCESS_KEY_ID=YourAccessKeyId AWS_SECRET_ACCESS_KEY=YourSecretAccessKey ./kinesis_video_gstreamer_sample_app <my-stream> </path/to/file>
 ```
 
 ##### Using Docker to run the demo application

install-instructions-windows-msvc.md

@@ -93,4 +93,4 @@ set GST_PLUGIN_SYSTEM_PATH=C:\Users\<myuser>\Downloads\amazon-kinesis-video-stre
       * Run the demo
           * **Example**:
             * Run the sample demo application for sending **webcam video** by executing ` kinesis_video_gstreamer_sample_app.exe my-test-stream `  or
-              * Run the sample **RTSP demo** application for sending **IP camera video** by executing  `kinesis_video_gstreamer_sample_rtsp_app.exe <rtsp_url> my-test-rtsp-stream`
+            * Run the sample application for sending **IP camera video** by executing  `kinesis_video_gstreamer_sample_app.exe my-test-rtsp-stream <rtsp_url>`