From 24da1ba3dcb0d63c28fa48f99677dd76eb31151a Mon Sep 17 00:00:00 2001 From: Ishank gulati Date: Thu, 17 Dec 2015 10:16:10 +0530 Subject: [PATCH 1/3] added videoio docs and tutorials --- .../highgui/table_of_content_highgui.markdown | 18 ----------------- doc/tutorials/tutorials.markdown | 4 ++++ .../images/video-input-psnr-ssim.png | Bin .../images/video-write.png | Bin .../videoio/table_of_content_videoio.markdown | 19 ++++++++++++++++++ .../images/outputVideoInput.png | Bin .../video_input_psnr_ssim.markdown | 8 ++++---- .../images/resultOutputWideoWrite.png | Bin .../images/videoCompressSelect.png | Bin .../video-write/images/videoFileStructure.png | Bin .../video-write/video_write.markdown | 6 +++--- .../video-input-psnr-ssim.cpp | 0 .../video-input-psnr-ssim/video/Megamind.avi | Bin .../video/Megamind_bugy.avi | Bin .../video-write/video-write.cpp | 0 15 files changed, 30 insertions(+), 25 deletions(-) rename doc/tutorials/{highgui => videoio}/images/video-input-psnr-ssim.png (100%) rename doc/tutorials/{highgui => videoio}/images/video-write.png (100%) create mode 100644 doc/tutorials/videoio/table_of_content_videoio.markdown rename doc/tutorials/{highgui => videoio}/video-input-psnr-ssim/images/outputVideoInput.png (100%) rename doc/tutorials/{highgui => videoio}/video-input-psnr-ssim/video_input_psnr_ssim.markdown (97%) rename doc/tutorials/{highgui => videoio}/video-write/images/resultOutputWideoWrite.png (100%) rename doc/tutorials/{highgui => videoio}/video-write/images/videoCompressSelect.png (100%) rename doc/tutorials/{highgui => videoio}/video-write/images/videoFileStructure.png (100%) rename doc/tutorials/{highgui => videoio}/video-write/video_write.markdown (97%) rename samples/cpp/tutorial_code/{HighGUI => videoio}/video-input-psnr-ssim/video-input-psnr-ssim.cpp (100%) rename samples/cpp/tutorial_code/{HighGUI => videoio}/video-input-psnr-ssim/video/Megamind.avi (100%) rename samples/cpp/tutorial_code/{HighGUI => videoio}/video-input-psnr-ssim/video/Megamind_bugy.avi (100%) rename samples/cpp/tutorial_code/{HighGUI => videoio}/video-write/video-write.cpp (100%) diff --git a/doc/tutorials/highgui/table_of_content_highgui.markdown b/doc/tutorials/highgui/table_of_content_highgui.markdown index 3ff0e0322..8f8b28f42 100644 --- a/doc/tutorials/highgui/table_of_content_highgui.markdown +++ b/doc/tutorials/highgui/table_of_content_highgui.markdown @@ -12,24 +12,6 @@ use the built-in graphical user interface of the library. We will learn how to add a Trackbar to our applications -- @subpage tutorial_video_input_psnr_ssim - - *Compatibility:* \> OpenCV 2.0 - - *Author:* Bernát Gábor - - You will learn how to read video streams, and how to calculate similarity values such as PSNR - or SSIM. - -- @subpage tutorial_video_write - - *Compatibility:* \> OpenCV 2.0 - - *Author:* Bernát Gábor - - Whenever you work with video feeds you may eventually want to save your image processing - result in a form of a new video file. Here's how to do it. - - @subpage tutorial_raster_io_gdal *Compatibility:* \> OpenCV 2.0 diff --git a/doc/tutorials/tutorials.markdown b/doc/tutorials/tutorials.markdown index 552420c3c..035c69a29 100644 --- a/doc/tutorials/tutorials.markdown +++ b/doc/tutorials/tutorials.markdown @@ -71,6 +71,10 @@ As always, we would be happy to hear your comments and receive your contribution Run OpenCV and your vision apps on an iDevice +- @subpage tutorial_table_of_content_videoio + + These tutorials show how to read and write videos using videio module. + - @subpage tutorial_table_of_content_viz These tutorials show how to use Viz module effectively. diff --git a/doc/tutorials/highgui/images/video-input-psnr-ssim.png b/doc/tutorials/videoio/images/video-input-psnr-ssim.png similarity index 100% rename from doc/tutorials/highgui/images/video-input-psnr-ssim.png rename to doc/tutorials/videoio/images/video-input-psnr-ssim.png diff --git a/doc/tutorials/highgui/images/video-write.png b/doc/tutorials/videoio/images/video-write.png similarity index 100% rename from doc/tutorials/highgui/images/video-write.png rename to doc/tutorials/videoio/images/video-write.png diff --git a/doc/tutorials/videoio/table_of_content_videoio.markdown b/doc/tutorials/videoio/table_of_content_videoio.markdown new file mode 100644 index 000000000..b1b669ded --- /dev/null +++ b/doc/tutorials/videoio/table_of_content_videoio.markdown @@ -0,0 +1,19 @@ +Video Input and Output (videoio module) {#tutorial_table_of_content_videoio} +========================================= + +This section contains tutorials about how to read/save your video files. + +- @subpage tutorial_video_input_psnr_ssim + + *Compatibility:* \> OpenCV 2.0 + + *Author:* Bernát Gábor + + You will learn how to read video streams, and how to calculate similarity values such as PSNR + or SSIM. + +- @subpage tutorial_video_write + + *Compatibility:* \> OpenCV 2.0 + + *Author:* Bernát Gábor \ No newline at end of file diff --git a/doc/tutorials/highgui/video-input-psnr-ssim/images/outputVideoInput.png b/doc/tutorials/videoio/video-input-psnr-ssim/images/outputVideoInput.png similarity index 100% rename from doc/tutorials/highgui/video-input-psnr-ssim/images/outputVideoInput.png rename to doc/tutorials/videoio/video-input-psnr-ssim/images/outputVideoInput.png diff --git a/doc/tutorials/highgui/video-input-psnr-ssim/video_input_psnr_ssim.markdown b/doc/tutorials/videoio/video-input-psnr-ssim/video_input_psnr_ssim.markdown similarity index 97% rename from doc/tutorials/highgui/video-input-psnr-ssim/video_input_psnr_ssim.markdown rename to doc/tutorials/videoio/video-input-psnr-ssim/video_input_psnr_ssim.markdown index 1e61a8775..ef82b6723 100644 --- a/doc/tutorials/highgui/video-input-psnr-ssim/video_input_psnr_ssim.markdown +++ b/doc/tutorials/videoio/video-input-psnr-ssim/video_input_psnr_ssim.markdown @@ -20,12 +20,12 @@ As a test case where to show off these using OpenCV I've created a small program video files and performs a similarity check between them. This is something you could use to check just how well a new video compressing algorithms works. Let there be a reference (original) video like [this small Megamind clip -](https://github.com/Itseez/opencv/tree/master/samples/cpp/tutorial_code/HighGUI/video-input-psnr-ssim/video/Megamind.avi) and [a compressed -version of it ](https://github.com/Itseez/opencv/tree/master/samples/cpp/tutorial_code/HighGUI/video-input-psnr-ssim/video/Megamind_bugy.avi). +](https://github.com/Itseez/opencv/tree/master/samples/cpp/tutorial_code/videoio/video-input-psnr-ssim/video/Megamind.avi) and [a compressed +version of it ](https://github.com/Itseez/opencv/tree/master/samples/cpp/tutorial_code/videoio/video-input-psnr-ssim/video/Megamind_bugy.avi). You may also find the source code and these video file in the -`samples/cpp/tutorial_code/HighGUI/video-input-psnr-ssim/` folder of the OpenCV source library. +`samples/cpp/tutorial_code/videoio/video-input-psnr-ssim/` folder of the OpenCV source library. -@include cpp/tutorial_code/HighGUI/video-input-psnr-ssim/video-input-psnr-ssim.cpp +@include cpp/tutorial_code/videoio/video-input-psnr-ssim/video-input-psnr-ssim.cpp How to read a video stream (online-camera or offline-file)? ----------------------------------------------------------- diff --git a/doc/tutorials/highgui/video-write/images/resultOutputWideoWrite.png b/doc/tutorials/videoio/video-write/images/resultOutputWideoWrite.png similarity index 100% rename from doc/tutorials/highgui/video-write/images/resultOutputWideoWrite.png rename to doc/tutorials/videoio/video-write/images/resultOutputWideoWrite.png diff --git a/doc/tutorials/highgui/video-write/images/videoCompressSelect.png b/doc/tutorials/videoio/video-write/images/videoCompressSelect.png similarity index 100% rename from doc/tutorials/highgui/video-write/images/videoCompressSelect.png rename to doc/tutorials/videoio/video-write/images/videoCompressSelect.png diff --git a/doc/tutorials/highgui/video-write/images/videoFileStructure.png b/doc/tutorials/videoio/video-write/images/videoFileStructure.png similarity index 100% rename from doc/tutorials/highgui/video-write/images/videoFileStructure.png rename to doc/tutorials/videoio/video-write/images/videoFileStructure.png diff --git a/doc/tutorials/highgui/video-write/video_write.markdown b/doc/tutorials/videoio/video-write/video_write.markdown similarity index 97% rename from doc/tutorials/highgui/video-write/video_write.markdown rename to doc/tutorials/videoio/video-write/video_write.markdown index d10f6d051..399ac7a1e 100644 --- a/doc/tutorials/highgui/video-write/video_write.markdown +++ b/doc/tutorials/videoio/video-write/video_write.markdown @@ -30,10 +30,10 @@ The source code --------------- You may also find the source code and these video file in the -`samples/cpp/tutorial_code/highgui/video-write/` folder of the OpenCV source library or [download it -from here ](https://github.com/Itseez/opencv/tree/master/samples/cpp/tutorial_code/HighGUI/video-write/video-write.cpp). +`samples/cpp/tutorial_code/videoio/video-write/` folder of the OpenCV source library or [download it +from here ](https://github.com/Itseez/opencv/tree/master/samples/cpp/tutorial_code/videoio/video-write/video-write.cpp). -@include cpp/tutorial_code/HighGUI/video-write/video-write.cpp +@include cpp/tutorial_code/videoio/video-write/video-write.cpp The structure of a video ------------------------ diff --git a/samples/cpp/tutorial_code/HighGUI/video-input-psnr-ssim/video-input-psnr-ssim.cpp b/samples/cpp/tutorial_code/videoio/video-input-psnr-ssim/video-input-psnr-ssim.cpp similarity index 100% rename from samples/cpp/tutorial_code/HighGUI/video-input-psnr-ssim/video-input-psnr-ssim.cpp rename to samples/cpp/tutorial_code/videoio/video-input-psnr-ssim/video-input-psnr-ssim.cpp diff --git a/samples/cpp/tutorial_code/HighGUI/video-input-psnr-ssim/video/Megamind.avi b/samples/cpp/tutorial_code/videoio/video-input-psnr-ssim/video/Megamind.avi similarity index 100% rename from samples/cpp/tutorial_code/HighGUI/video-input-psnr-ssim/video/Megamind.avi rename to samples/cpp/tutorial_code/videoio/video-input-psnr-ssim/video/Megamind.avi diff --git a/samples/cpp/tutorial_code/HighGUI/video-input-psnr-ssim/video/Megamind_bugy.avi b/samples/cpp/tutorial_code/videoio/video-input-psnr-ssim/video/Megamind_bugy.avi similarity index 100% rename from samples/cpp/tutorial_code/HighGUI/video-input-psnr-ssim/video/Megamind_bugy.avi rename to samples/cpp/tutorial_code/videoio/video-input-psnr-ssim/video/Megamind_bugy.avi diff --git a/samples/cpp/tutorial_code/HighGUI/video-write/video-write.cpp b/samples/cpp/tutorial_code/videoio/video-write/video-write.cpp similarity index 100% rename from samples/cpp/tutorial_code/HighGUI/video-write/video-write.cpp rename to samples/cpp/tutorial_code/videoio/video-write/video-write.cpp From 359acc0d338b2f858064ae098fd7cf4b63d3455c Mon Sep 17 00:00:00 2001 From: Maksim Shabunin Date: Fri, 12 Feb 2016 13:35:46 +0300 Subject: [PATCH 2/3] Tutorials: moved imgcodecs and videoio tutorials to separate pages --- .../highgui/table_of_content_highgui.markdown | 15 +-------------- .../{highgui => imgcodecs}/images/gdal-io.jpg | Bin .../raster-gdal/images/gdal_flood-zone.jpg | Bin .../raster-gdal/images/gdal_heat-map.jpg | Bin .../raster-gdal/images/gdal_output.jpg | Bin .../raster-gdal/raster_io_gdal.markdown | 2 +- .../imgcodecs/table_of_content_highgui.markdown | 12 ++++++++++++ doc/tutorials/tutorials.markdown | 15 +++++++++------ .../{highgui => videoio}/intelperc.markdown | 0 .../{highgui => videoio}/kinect_openni.markdown | 0 .../videoio/table_of_content_videoio.markdown | 6 +++++- .../GDAL_IO/gdal-image.cpp | 0 12 files changed, 28 insertions(+), 22 deletions(-) rename doc/tutorials/{highgui => imgcodecs}/images/gdal-io.jpg (100%) rename doc/tutorials/{highgui => imgcodecs}/raster-gdal/images/gdal_flood-zone.jpg (100%) rename doc/tutorials/{highgui => imgcodecs}/raster-gdal/images/gdal_heat-map.jpg (100%) rename doc/tutorials/{highgui => imgcodecs}/raster-gdal/images/gdal_output.jpg (100%) rename doc/tutorials/{highgui => imgcodecs}/raster-gdal/raster_io_gdal.markdown (98%) create mode 100644 doc/tutorials/imgcodecs/table_of_content_highgui.markdown rename doc/tutorials/{highgui => videoio}/intelperc.markdown (100%) rename doc/tutorials/{highgui => videoio}/kinect_openni.markdown (100%) rename samples/cpp/tutorial_code/{HighGUI => imgcodecs}/GDAL_IO/gdal-image.cpp (100%) diff --git a/doc/tutorials/highgui/table_of_content_highgui.markdown b/doc/tutorials/highgui/table_of_content_highgui.markdown index 8f8b28f42..a8f1d4e34 100644 --- a/doc/tutorials/highgui/table_of_content_highgui.markdown +++ b/doc/tutorials/highgui/table_of_content_highgui.markdown @@ -1,8 +1,7 @@ High Level GUI and Media (highgui module) {#tutorial_table_of_content_highgui} ========================================= -This section contains valuable tutorials about how to read/save your image/video files and how to -use the built-in graphical user interface of the library. +This section contains tutorials about how to use the built-in graphical user interface of the library. - @subpage tutorial_trackbar @@ -11,15 +10,3 @@ use the built-in graphical user interface of the library. *Author:* Ana Huamán We will learn how to add a Trackbar to our applications - -- @subpage tutorial_raster_io_gdal - - *Compatibility:* \> OpenCV 2.0 - - *Author:* Marvin Smith - - Read common GIS Raster and DEM files to display and manipulate geographic data. - -- @subpage tutorial_kinect_openni - -- @subpage tutorial_intelperc diff --git a/doc/tutorials/highgui/images/gdal-io.jpg b/doc/tutorials/imgcodecs/images/gdal-io.jpg similarity index 100% rename from doc/tutorials/highgui/images/gdal-io.jpg rename to doc/tutorials/imgcodecs/images/gdal-io.jpg diff --git a/doc/tutorials/highgui/raster-gdal/images/gdal_flood-zone.jpg b/doc/tutorials/imgcodecs/raster-gdal/images/gdal_flood-zone.jpg similarity index 100% rename from doc/tutorials/highgui/raster-gdal/images/gdal_flood-zone.jpg rename to doc/tutorials/imgcodecs/raster-gdal/images/gdal_flood-zone.jpg diff --git a/doc/tutorials/highgui/raster-gdal/images/gdal_heat-map.jpg b/doc/tutorials/imgcodecs/raster-gdal/images/gdal_heat-map.jpg similarity index 100% rename from doc/tutorials/highgui/raster-gdal/images/gdal_heat-map.jpg rename to doc/tutorials/imgcodecs/raster-gdal/images/gdal_heat-map.jpg diff --git a/doc/tutorials/highgui/raster-gdal/images/gdal_output.jpg b/doc/tutorials/imgcodecs/raster-gdal/images/gdal_output.jpg similarity index 100% rename from doc/tutorials/highgui/raster-gdal/images/gdal_output.jpg rename to doc/tutorials/imgcodecs/raster-gdal/images/gdal_output.jpg diff --git a/doc/tutorials/highgui/raster-gdal/raster_io_gdal.markdown b/doc/tutorials/imgcodecs/raster-gdal/raster_io_gdal.markdown similarity index 98% rename from doc/tutorials/highgui/raster-gdal/raster_io_gdal.markdown rename to doc/tutorials/imgcodecs/raster-gdal/raster_io_gdal.markdown index 95137be2d..a511d8088 100644 --- a/doc/tutorials/highgui/raster-gdal/raster_io_gdal.markdown +++ b/doc/tutorials/imgcodecs/raster-gdal/raster_io_gdal.markdown @@ -28,7 +28,7 @@ of the bay rise 10, 50, and 100 meters. Code ---- -@include cpp/tutorial_code/HighGUI/GDAL_IO/gdal-image.cpp +@include cpp/tutorial_code/imgcodecs/GDAL_IO/gdal-image.cpp How to Read Raster Data using GDAL ---------------------------------- diff --git a/doc/tutorials/imgcodecs/table_of_content_highgui.markdown b/doc/tutorials/imgcodecs/table_of_content_highgui.markdown new file mode 100644 index 000000000..e78e8276f --- /dev/null +++ b/doc/tutorials/imgcodecs/table_of_content_highgui.markdown @@ -0,0 +1,12 @@ +Image Input and Output (imgcodecs module) {#tutorial_table_of_content_imgcodecs} +========================================= + +This section contains tutorials about how to read/save your image files. + +- @subpage tutorial_raster_io_gdal + + *Compatibility:* \> OpenCV 2.0 + + *Author:* Marvin Smith + + Read common GIS Raster and DEM files to display and manipulate geographic data. diff --git a/doc/tutorials/tutorials.markdown b/doc/tutorials/tutorials.markdown index 035c69a29..931921777 100644 --- a/doc/tutorials/tutorials.markdown +++ b/doc/tutorials/tutorials.markdown @@ -25,10 +25,17 @@ As always, we would be happy to hear your comments and receive your contribution - @subpage tutorial_table_of_content_highgui - This section - contains valuable tutorials about how to read/save your image/video files and how to use the + This section contains valuable tutorials about how to use the built-in graphical user interface of the library. +- @subpage tutorial_table_of_content_imgcodecs + + These tutorials show how to read and write images using imgcodecs module. + +- @subpage tutorial_table_of_content_videoio + + These tutorials show how to read and write videos using videio module. + - @subpage tutorial_table_of_content_calib3d Although we got @@ -71,10 +78,6 @@ As always, we would be happy to hear your comments and receive your contribution Run OpenCV and your vision apps on an iDevice -- @subpage tutorial_table_of_content_videoio - - These tutorials show how to read and write videos using videio module. - - @subpage tutorial_table_of_content_viz These tutorials show how to use Viz module effectively. diff --git a/doc/tutorials/highgui/intelperc.markdown b/doc/tutorials/videoio/intelperc.markdown similarity index 100% rename from doc/tutorials/highgui/intelperc.markdown rename to doc/tutorials/videoio/intelperc.markdown diff --git a/doc/tutorials/highgui/kinect_openni.markdown b/doc/tutorials/videoio/kinect_openni.markdown similarity index 100% rename from doc/tutorials/highgui/kinect_openni.markdown rename to doc/tutorials/videoio/kinect_openni.markdown diff --git a/doc/tutorials/videoio/table_of_content_videoio.markdown b/doc/tutorials/videoio/table_of_content_videoio.markdown index b1b669ded..4f6276511 100644 --- a/doc/tutorials/videoio/table_of_content_videoio.markdown +++ b/doc/tutorials/videoio/table_of_content_videoio.markdown @@ -16,4 +16,8 @@ This section contains tutorials about how to read/save your video files. *Compatibility:* \> OpenCV 2.0 - *Author:* Bernát Gábor \ No newline at end of file + *Author:* Bernát Gábor + +- @subpage tutorial_kinect_openni + +- @subpage tutorial_intelperc diff --git a/samples/cpp/tutorial_code/HighGUI/GDAL_IO/gdal-image.cpp b/samples/cpp/tutorial_code/imgcodecs/GDAL_IO/gdal-image.cpp similarity index 100% rename from samples/cpp/tutorial_code/HighGUI/GDAL_IO/gdal-image.cpp rename to samples/cpp/tutorial_code/imgcodecs/GDAL_IO/gdal-image.cpp From 6c0c0466c6677091d2ba2bba9dcd1618e2132e8d Mon Sep 17 00:00:00 2001 From: Maksim Shabunin Date: Fri, 12 Feb 2016 13:42:44 +0300 Subject: [PATCH 3/3] Tutorials: moved Megamind.avi files to samples/data folder --- .../video_input_psnr_ssim.markdown | 6 +++--- .../video => data}/Megamind.avi | Bin .../video => data}/Megamind_bugy.avi | Bin 3 files changed, 3 insertions(+), 3 deletions(-) rename samples/{cpp/tutorial_code/videoio/video-input-psnr-ssim/video => data}/Megamind.avi (100%) rename samples/{cpp/tutorial_code/videoio/video-input-psnr-ssim/video => data}/Megamind_bugy.avi (100%) diff --git a/doc/tutorials/videoio/video-input-psnr-ssim/video_input_psnr_ssim.markdown b/doc/tutorials/videoio/video-input-psnr-ssim/video_input_psnr_ssim.markdown index ef82b6723..9dbff286c 100644 --- a/doc/tutorials/videoio/video-input-psnr-ssim/video_input_psnr_ssim.markdown +++ b/doc/tutorials/videoio/video-input-psnr-ssim/video_input_psnr_ssim.markdown @@ -20,10 +20,10 @@ As a test case where to show off these using OpenCV I've created a small program video files and performs a similarity check between them. This is something you could use to check just how well a new video compressing algorithms works. Let there be a reference (original) video like [this small Megamind clip -](https://github.com/Itseez/opencv/tree/master/samples/cpp/tutorial_code/videoio/video-input-psnr-ssim/video/Megamind.avi) and [a compressed -version of it ](https://github.com/Itseez/opencv/tree/master/samples/cpp/tutorial_code/videoio/video-input-psnr-ssim/video/Megamind_bugy.avi). +](https://github.com/Itseez/opencv/tree/master/samples/data/Megamind.avi) and [a compressed +version of it ](https://github.com/Itseez/opencv/tree/master/samples/data/Megamind_bugy.avi). You may also find the source code and these video file in the -`samples/cpp/tutorial_code/videoio/video-input-psnr-ssim/` folder of the OpenCV source library. +`samples/data` folder of the OpenCV source library. @include cpp/tutorial_code/videoio/video-input-psnr-ssim/video-input-psnr-ssim.cpp diff --git a/samples/cpp/tutorial_code/videoio/video-input-psnr-ssim/video/Megamind.avi b/samples/data/Megamind.avi similarity index 100% rename from samples/cpp/tutorial_code/videoio/video-input-psnr-ssim/video/Megamind.avi rename to samples/data/Megamind.avi diff --git a/samples/cpp/tutorial_code/videoio/video-input-psnr-ssim/video/Megamind_bugy.avi b/samples/data/Megamind_bugy.avi similarity index 100% rename from samples/cpp/tutorial_code/videoio/video-input-psnr-ssim/video/Megamind_bugy.avi rename to samples/data/Megamind_bugy.avi