Add comments.

Author: shincurry

animeloop-cli.xcodeproj/project.pbxproj

@@ -219,7 +219,7 @@
 		88537E911E4C501900385BCB /* Project object */ = {
 			isa = PBXProject;
 			attributes = {
-				LastUpgradeCheck = 0820;
+				LastUpgradeCheck = 0900;
 				ORGANIZATIONNAME = ShinCurry;
 				TargetAttributes = {
 					88537E981E4C501900385BCB = {
@@ -272,15 +272,21 @@
 				CLANG_CXX_LIBRARY = "libc++";
 				CLANG_ENABLE_MODULES = YES;
 				CLANG_ENABLE_OBJC_ARC = YES;
+				CLANG_WARN_BLOCK_CAPTURE_AUTORELEASING = YES;
 				CLANG_WARN_BOOL_CONVERSION = YES;
+				CLANG_WARN_COMMA = YES;
 				CLANG_WARN_CONSTANT_CONVERSION = YES;
 				CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR;
 				CLANG_WARN_DOCUMENTATION_COMMENTS = YES;
 				CLANG_WARN_EMPTY_BODY = YES;
 				CLANG_WARN_ENUM_CONVERSION = YES;
 				CLANG_WARN_INFINITE_RECURSION = YES;
 				CLANG_WARN_INT_CONVERSION = YES;
+				CLANG_WARN_NON_LITERAL_NULL_CONVERSION = YES;
+				CLANG_WARN_OBJC_LITERAL_CONVERSION = YES;
 				CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR;
+				CLANG_WARN_RANGE_LOOP_ANALYSIS = YES;
+				CLANG_WARN_STRICT_PROTOTYPES = YES;
 				CLANG_WARN_SUSPICIOUS_MOVE = YES;
 				CLANG_WARN_UNREACHABLE_CODE = YES;
 				CLANG_WARN__DUPLICATE_METHOD_MATCH = YES;
@@ -319,15 +325,21 @@
 				CLANG_CXX_LIBRARY = "libc++";
 				CLANG_ENABLE_MODULES = YES;
 				CLANG_ENABLE_OBJC_ARC = YES;
+				CLANG_WARN_BLOCK_CAPTURE_AUTORELEASING = YES;
 				CLANG_WARN_BOOL_CONVERSION = YES;
+				CLANG_WARN_COMMA = YES;
 				CLANG_WARN_CONSTANT_CONVERSION = YES;
 				CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR;
 				CLANG_WARN_DOCUMENTATION_COMMENTS = YES;
 				CLANG_WARN_EMPTY_BODY = YES;
 				CLANG_WARN_ENUM_CONVERSION = YES;
 				CLANG_WARN_INFINITE_RECURSION = YES;
 				CLANG_WARN_INT_CONVERSION = YES;
+				CLANG_WARN_NON_LITERAL_NULL_CONVERSION = YES;
+				CLANG_WARN_OBJC_LITERAL_CONVERSION = YES;
 				CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR;
+				CLANG_WARN_RANGE_LOOP_ANALYSIS = YES;
+				CLANG_WARN_STRICT_PROTOTYPES = YES;
 				CLANG_WARN_SUSPICIOUS_MOVE = YES;
 				CLANG_WARN_UNREACHABLE_CODE = YES;
 				CLANG_WARN__DUPLICATE_METHOD_MATCH = YES;

animeloop-cli/filter.cpp

@@ -18,7 +18,13 @@ using namespace std;
 using namespace cv;
 
 
-// filter 0 找出所有起始帧和结束帧相同的片段，并去重
+/**
+ filter 0 
+ Find all loop fragments that the begin frame is same as end one, then remove the repetition.
+
+ @param loop LoopVideo instance
+ @param durations reference of durations value
+ */
 void al::filter_0(const LoopVideo * loop, LoopDurations &durations) {
     LoopDurations _durations;
     int min_duration_frame = loop->kMinduration * loop->info.fps;
@@ -69,8 +75,15 @@ void al::filter_0(const LoopVideo * loop, LoopDurations &durations) {
     durations = _durations;    
 }
 
-// filter 1 筛选相近片段相似度高的片段
-// MAGIC NUMBER ===> if (distance_begin >= 25 && distance_end >= 25) {
+/**
+ filter 1
+ find the loop fragments that is same as nearby one, then remove it.
+ 
+ MAGIC NUMBER ===> if (distance_begin >= 25 && distance_end >= 25) {
+
+ @param loop LoopVideo instance
+ @param durations reference of durations value
+ */
 void al::filter_1(const al::LoopVideo * loop, LoopDurations &durations) {
     LoopDurations _durations;
     auto hashs = loop->phash_strings;
@@ -91,8 +104,15 @@ void al::filter_1(const al::LoopVideo * loop, LoopDurations &durations) {
     durations = _durations;
 }
 
-// filter 2 筛选临近帧像素变化小的片段
-// MAGIC NUMBER ===> if (variance > 1.0) {
+/**
+ filter 2
+ find the loop fragments with a small frame pixels change.
+ 
+ MAGIC NUMBER ===> if (variance > 1.0) {
+ 
+ @param loop LoopVideo instance
+ @param durations reference of durations value
+ */
 void al::filter_2(const al::LoopVideo * loop, al::LoopDurations &durations) {
     LoopDurations _durations;
     auto hashs = loop->phash_strings;
@@ -116,7 +136,13 @@ void al::filter_2(const al::LoopVideo * loop, al::LoopDurations &durations) {
     durations = _durations;
 }
 
-// filter 3 筛选起始或者结束帧为黑色或白色的片段
+/**
+ filter 3
+ find the loop fragments that the color of begin/end frame is most black or white, then remove it.
+ 
+ @param loop LoopVideo instance
+ @param durations reference of durations value
+ */
 void al::filter_3(const al::LoopVideo * loop, al::LoopDurations &durations) {
     LoopDurations _durations;
 

animeloop-cli/loop_video.cpp

@@ -48,8 +48,8 @@ al::LoopVideo::LoopVideo(std::string series, std::string episode, std::string in
         create_directories(this->caches_path);
     }
 
-    this->face_cascade_filename = "./lbpcascade_animeface.xml";
-    face_cascade.load(this->face_cascade_filename.string());
+//    this->face_cascade_filename = "./lbpcascade_animeface.xml";
+//    face_cascade.load(this->face_cascade_filename.string());
 }
 
 void al::LoopVideo::init() {
@@ -86,7 +86,6 @@ void al::LoopVideo::print(LoopDurations durations) {
     }
 }
 
-
 void al::LoopVideo::generate(const LoopDurations durations) {
     VideoInfo info = get_info(this->input_path.string());
 

animeloop-cli/loop_video.hpp

@@ -33,7 +33,7 @@ namespace al {
         boost::filesystem::path phash_filename;
         boost::filesystem::path resized_video_filename;
         std::string output_type = "mp4";
-        boost::filesystem::path face_cascade_filename;
+//        boost::filesystem::path face_cascade_filename;
 
         // Effect the final results.
         double kMinduration = 0.6;
@@ -50,13 +50,39 @@ namespace al {
         LoopDurations filtered_durations;
         FrameVector frames;
 
+        /**
+         Class LoopVideo constructor.
+         
+         @param series series title
+         @param episode episode title
+         @param input input file path
+         @param output output file path
+         */
         LoopVideo(std::string series, std::string episode, std::string input, std::string output);
-        cv::CascadeClassifier face_cascade;
+//        cv::CascadeClassifier face_cascade;
 
+        /**
+         Initial resized video file, pHash and dHash file for cache.
+         */
         void init();
+        
+        /**
+         Animeloop algorithm filter workflow.
+         */
         void filter();
+        
+        /**
+         Print durations data.
+         
+         @param durations durations data
+         */
         void print(LoopDurations durations);
 
+        /**
+         Generate loop video files from durations data.
+         
+         @param durations durations data
+         */
         void generate(const al::LoopDurations filtered_durations);
 
     private:

animeloop-cli/utils.hpp

@@ -20,6 +20,13 @@ namespace al {
     VideoInfo get_info(std::string filename);
     VideoInfo get_info(cv::VideoCapture &capture);
 
+    /**
+     Resize a video and write into a new file.
+
+     @param file intput path of origin video file
+     @param output output path of resized video file
+     @param size resizing size
+     */
     void resize_video(std::string file, std::string output, cv::Size size);
 
     bool get_frames(std::string file, FrameVector &frames);
@@ -29,7 +36,21 @@ namespace al {
     double get_variance(std::vector<int> distances);
     double get_mean(cv::Mat image);
 
+    
+    /**
+     Convert seconds value to a time string.
+
+     @param seconds seconds value
+     @return Time string
+     */
     std::string time_string(double seconds);
+    
+    /**
+     Generate the MD5 checksum of a file.
+
+     @param filename file path
+     @return md5 string value
+     */
     std::string md5_of_file(std::string filename);
 }