From eedb6fa3c48b8844ec773a28e803c90c78a8344c Mon Sep 17 00:00:00 2001
From: Kevin Hughes <kevin@kevin-M3920.(none)>
Date: Wed, 17 Apr 2013 13:20:32 -0400
Subject: [PATCH] removed separate example for reading image sequences and
 modified starter_video.cpp to better explain the functionality of
 VideoCapture. I also added a bit more explanation in the documentation of the
 VideoCapture interface

---
 .../reading_and_writing_images_and_video.rst  |  8 +-
 samples/cpp/starter_video.cpp                 | 76 ++++++++++---------
 2 files changed, 43 insertions(+), 41 deletions(-)

diff --git a/modules/highgui/doc/reading_and_writing_images_and_video.rst b/modules/highgui/doc/reading_and_writing_images_and_video.rst
index 914856dc3..622440a7c 100644
--- a/modules/highgui/doc/reading_and_writing_images_and_video.rst
+++ b/modules/highgui/doc/reading_and_writing_images_and_video.rst
@@ -197,8 +197,8 @@ VideoCapture
 ------------
 .. ocv:class:: VideoCapture
 
-Class for video capturing from video files or cameras.
-The class provides C++ API for capturing video from cameras or for reading video files. Here is how the class can be used: ::
+Class for video capturing from video files, image sequences or cameras.
+The class provides C++ API for capturing video from cameras or for reading video files and image sequences. Here is how the class can be used: ::
 
     #include "opencv2/opencv.hpp"
 
@@ -249,7 +249,7 @@ VideoCapture constructors.
 .. ocv:cfunction:: CvCapture* cvCaptureFromFile( const char* filename )
 .. ocv:pyoldfunction:: cv.CaptureFromFile(filename) -> CvCapture
 
-    :param filename: name of the opened video file
+    :param filename: name of the opened video file (eg. video.avi) or image sequence (eg. img%02d.jpg)
 
     :param device: id of the opened video capturing device (i.e. a camera index). If there is a single camera connected, just pass 0.
 
@@ -266,7 +266,7 @@ Open video file or a capturing device for video capturing
 .. ocv:pyfunction:: cv2.VideoCapture.open(filename) -> retval
 .. ocv:pyfunction:: cv2.VideoCapture.open(device) -> retval
 
-    :param filename: name of the opened video file
+    :param filename: name of the opened video file (eg. video.avi) or image sequence (eg. img%02d.jpg)
 
     :param device: id of the opened video capturing device (i.e. a camera index).
 
diff --git a/samples/cpp/starter_video.cpp b/samples/cpp/starter_video.cpp
index 5bceb552c..6a34c84d2 100644
--- a/samples/cpp/starter_video.cpp
+++ b/samples/cpp/starter_video.cpp
@@ -4,47 +4,51 @@
 *  Created on: Nov 23, 2010
 *      Author: Ethan Rublee
 *
-* A starter sample for using opencv, get a video stream and display the images
+*  Modified on: April 17, 2013
+*      Author: Kevin Hughes
+*
+* A starter sample for using OpenCV VideoCapture with capture devices, video files or image sequences
 * easy as CV_PI right?
 */
-#include "opencv2/highgui/highgui.hpp"
+
+#include <opencv2/highgui/highgui.hpp>
+
 #include <iostream>
-#include <vector>
 #include <stdio.h>
 
 using namespace cv;
 using namespace std;
 
+void help(char** av) {
+    cout << "The program captures frames from a video file, image sequence (01.jpg, 02.jpg ... 10.jpg) or camera connected to your computer." << endl
+         << "Usage:\n" << av[0] << " <video file, image sequence or device number>" << endl
+         << "q,Q,esc -- quit" << endl
+         << "space   -- save frame" << endl << endl
+         << "\tTo capture from a camera pass the device number. To find the device number, try ls /dev/video*" << endl
+         << "\texample: " << av[0] << " 0" << endl
+         << "\tYou may also pass a video file instead of a device number" << endl
+         << "\texample: " << av[0] << " video.avi" << endl
+         << "\tYou can also pass the path to an image sequence and OpenCV will treat the sequence just like a video." << endl
+         << "\texample: " << av[0] << " right%%02d.jpg" << endl;
+}
 
-
-//hide the local functions in an anon namespace
-namespace {
-    void help(char** av) {
-        cout << "\nThis program justs gets you started reading images from video\n"
-            "Usage:\n./" << av[0] << " <video device number>\n"
-            << "q,Q,esc -- quit\n"
-            << "space   -- save frame\n\n"
-            << "\tThis is a starter sample, to get you up and going in a copy pasta fashion\n"
-            << "\tThe program captures frames from a camera connected to your computer.\n"
-            << "\tTo find the video device number, try ls /dev/video* \n"
-            << "\tYou may also pass a video file, like my_vide.avi instead of a device number"
-            << endl;
-    }
-
-    int process(VideoCapture& capture) {
-        int n = 0;
-        char filename[200];
-        string window_name = "video | q or esc to quit";
-        cout << "press space to save a picture. q or esc to quit" << endl;
-        namedWindow(window_name, WINDOW_KEEPRATIO); //resizable window;
-        Mat frame;
-        for (;;) {
-            capture >> frame;
-            if (frame.empty())
-                break;
-            imshow(window_name, frame);
-            char key = (char)waitKey(5); //delay N millis, usually long enough to display and capture input
-            switch (key) {
+int process(VideoCapture& capture) {
+    int n = 0;
+    char filename[200];
+    string window_name = "video | q or esc to quit";
+    cout << "press space to save a picture. q or esc to quit" << endl;
+    namedWindow(window_name, CV_WINDOW_KEEPRATIO); //resizable window;
+    Mat frame;
+    
+    for (;;) {
+        capture >> frame;
+        if (frame.empty())
+            break;
+        
+        imshow(window_name, frame);
+        char key = (char)waitKey(30); //delay N millis, usually long enough to display and capture input
+        
+        switch (key) {
         case 'q':
         case 'Q':
         case 27: //escape key
@@ -56,11 +60,9 @@ namespace {
             break;
         default:
             break;
-            }
         }
-        return 0;
     }
-
+    return 0;
 }
 
 int main(int ac, char** av) {
@@ -70,11 +72,11 @@ int main(int ac, char** av) {
         return 1;
     }
     std::string arg = av[1];
-    VideoCapture capture(arg); //try to open string, this will attempt to open it as a video file
+    VideoCapture capture(arg); //try to open string, this will attempt to open it as a video file or image sequence
     if (!capture.isOpened()) //if this fails, try to open as a video camera, through the use of an integer param
         capture.open(atoi(arg.c_str()));
     if (!capture.isOpened()) {
-        cerr << "Failed to open a video device or video file!\n" << endl;
+        cerr << "Failed to open the video device, video file or image sequence!\n" << endl;
         help(av);
         return 1;
     }