initial work towards enabling video files (mp4, avi) in DICe

Author: dicengine

src/base/DICe.h

@@ -148,6 +148,8 @@ const char* const gauss_filter_images = "gauss_filter_images";
 /// String parameter name
 const char* const time_average_cine_ref_frame = "time_average_cine_ref_frame";
 /// String parameter name
+const char* const time_average_video_ref_frame = "time_average_video_ref_frame";
+/// String parameter name
 const char* const gauss_filter_mask_size = "gauss_filter_mask_size";
 /// String parameter name
 const char* const correlation_routine = "correlation_routine";
@@ -684,6 +686,7 @@ enum Image_File_Type{
   NETCDF,
   CINE,
   BMP,
+  VIDEO,
   MAX_IMAGE_FILE_TYPE,
   NO_SUCH_IMAGE_FILE_TYPE
 };
@@ -1249,6 +1252,11 @@ const Correlation_Parameter time_average_cine_ref_frame_param(time_average_cine_
   false,
   "Select the number of frames over which to time average the reference frame of a cine file");
 /// Correlation parameter and properties
+const Correlation_Parameter time_average_video_ref_frame_param(time_average_video_ref_frame,
+  SIZE_PARAM,
+  false,
+  "Select the number of frames over which to time average the reference frame of a video file");
+/// Correlation parameter and properties
 const Correlation_Parameter compute_def_gradients_param(compute_def_gradients,
   BOOL_PARAM,
   false,
@@ -1283,7 +1291,7 @@ const Correlation_Parameter remove_outlier_pixels_param(remove_outlier_pixels,
 // TODO don't forget to update this when adding a new one
 /// The total number of valid correlation parameters
 /// Vector of valid parameter names
-const int_t num_valid_correlation_params = 90;
+const int_t num_valid_correlation_params = 91;
 /// Vector oIf valid parameter names
 const Correlation_Parameter valid_correlation_params[num_valid_correlation_params] = {
   correlation_routine_param,
@@ -1365,6 +1373,7 @@ const Correlation_Parameter valid_correlation_params[num_valid_correlation_param
   convert_cine_to_8_bit_param,
   remove_outlier_pixels_param,
   time_average_cine_ref_frame_param,
+  time_average_video_ref_frame_param,
   global_regularization_alpha_param,
   global_stabilization_tau_param,
   global_formulation_param,

src/base/DICe_Image.cpp

@@ -1244,7 +1244,7 @@ template <typename S>
 bool
 Image_<S>::is_video_frame()const{
   Image_File_Type type = utils::image_file_type(file_name_.c_str());
-  if(type==CINE||type==NETCDF)
+  if(type==CINE||type==NETCDF||type==VIDEO)
     return true;
   else
     return false;

src/base/DICe_Image.h

@@ -405,7 +405,7 @@ Image_ {
     return has_gradients_;
   }
 
-  /// returns true if the image is a frame from a video sequence cine or netcdf file
+  /// returns true if the image is a frame from a video sequence file
   bool is_video_frame()const;
 
   /// returns true if the image was created from a file not array

src/core/DICe_Parser.cpp

@@ -127,25 +127,39 @@ const char* const stereo_left_suffix = "stereo_left_suffix";
 /// Input parameter
 const char* const stereo_right_suffix = "stereo_right_suffix";
 /// Input parameter
-const char* const stereo_cine_file = "stereo_cine_file";
-/// Input parameter
 const char* const stereo_reference_image = "stereo_reference_image";
 /// Input parameter
 const char* const stereo_deformed_images = "stereo_deformed_images";
 /// Input parameter
 const char* const netcdf_file = "netcdf_file";
 /// Input parameter
-const char* const cine_file = "cine_file";
+const char* const stereo_video_file = "stereo_video_file";
+/// Input parameter
+const char* const video_file = "video_file";
+/// Input parameter
+const char* const video_ref_index = "video_ref_index";
+/// Input parameter
+const char* const video_start_index = "video_start_index";
+/// Input parameter
+const char* const video_preview_index = "video_preview_index";
+/// Input parameter
+const char* const video_end_index = "video_end_index";
+/// Input parameter
+const char* const video_skip_index = "video_skip_index";
+/// Input parameter
+const char* const stereo_cine_file = "stereo_cine_file"; // legacy option
+/// Input parameter
+const char* const cine_file = "cine_file"; // legacy option
 /// Input parameter
-const char* const cine_ref_index = "cine_ref_index";
+const char* const cine_ref_index = "cine_ref_index"; // legacy option
 /// Input parameter
-const char* const cine_start_index = "cine_start_index";
+const char* const cine_start_index = "cine_start_index"; // legacy option
 /// Input parameter
-const char* const cine_preview_index = "cine_preview_index";
+const char* const cine_preview_index = "cine_preview_index"; // legacy option
 /// Input parameter
-const char* const cine_end_index = "cine_end_index";
+const char* const cine_end_index = "cine_end_index";  // legacy option
 /// Input parameter
-const char* const cine_skip_index = "cine_skip_index";
+const char* const cine_skip_index = "cine_skip_index"; // legacy option
 /// Input parameter (multiple deformed images not allowed)
 const char* const deformed_images = "deformed_images";
 // For image sequences

src/core/DICe_Parser.h

@@ -218,12 +218,12 @@ Schema::set_def_image(const std::string & defName){
   const int_t num_buffer_frames = !has_extents_ || has_motion_window ? CINE_BUFFER_NUM_FRAMES : 1; // the extents update after each frame so can only put one frame in the buffer
   if((frame_id_-first_frame_id_)%num_buffer_frames==0){
     if(DICe::utils::image_file_type(defName.c_str())==CINE){
-      std::string undecorated_cine_file = DICe::utils::cine_file_name(defName.c_str());
+      std::string undecorated_cine_file = DICe::utils::video_file_name(defName.c_str());
       // test if this is a cross-correlation (if so, don't use a buffer since only one frame is needed)
       // if it is a cross-correlation setting the def image, the ref and def images will come from different files
       // hence the check below on the cine file name
       assert(ref_img_!=Teuchos::null);
-      std::string undecorated_ref_cine_file = DICe::utils::cine_file_name(ref_img_->file_name().c_str());
+      std::string undecorated_ref_cine_file = DICe::utils::video_file_name(ref_img_->file_name().c_str());
       if(undecorated_cine_file==undecorated_ref_cine_file){ // assumes ref image has already been set
         // check if the window params are already set and just the frame needs to be updated
         const hypercine::HyperCine::Bit_Depth_Conversion_Type conversion_type = convert_cine_to_8_bit_ ? hypercine::HyperCine::TO_8_BIT :