Core (Tests): Add LV::Video::validate() and LV::Video::has_same_content() for testing videos.

Author: kaixiong

libvisual/CMakeLists.txt

@@ -224,6 +224,8 @@ ENDIF()
 # Tests
 OPTION(ENABLE_TESTS "Build tests" no)
 IF(ENABLE_TESTS)
+  ADD_COMPILE_DEFINITIONS(LV_ENABLE_TESTS)
+
   ENABLE_TESTING()
   ADD_SUBDIRECTORY(tests)
 ENDIF()

libvisual/libvisual/lv_video.cpp

@@ -36,6 +36,7 @@
 #include "private/lv_video_transform.hpp"
 #include "private/lv_video_bmp.hpp"
 #include "private/lv_video_png.hpp"
+#include <cstring>
 #include <fstream>
 
 namespace LV {
@@ -292,6 +293,110 @@ namespace LV {
       return true;
   }
 
+  #ifdef LV_ENABLE_TESTS
+  bool Video::validate() const
+  {
+      // Validate dimensions.
+
+      if (m_impl->width <= 0) {
+          visual_log (VISUAL_LOG_ERROR, "Video has a zero or negative width (%d).", m_impl->width);
+          return false;
+      }
+
+      if (m_impl->height <= 0) {
+          visual_log (VISUAL_LOG_ERROR, "Video has a zero of negative height (%d).", m_impl->height);
+          return false;
+      }
+
+      if (m_impl->pitch <= 0) {
+          visual_log (VISUAL_LOG_ERROR, "Video has a zero of negative pitch (%d).", m_impl->pitch);
+          return false;
+      }
+
+      // Validate extents.
+
+      if (m_impl->width != m_impl->extents.width) {
+          visual_log (VISUAL_LOG_ERROR, "Width (%d) and width of extents (%d) do not agree.",
+                      m_impl->width, m_impl->extents.width);
+          return false;
+      }
+
+      if (m_impl->height != m_impl->extents.height) {
+          visual_log (VISUAL_LOG_ERROR, "Height (%d) and height of extents (%d) do not agree.",
+                      m_impl->height, m_impl->extents.height);
+          return false;
+      }
+
+      // Validate parent-child relations.
+
+      if (m_impl->parent) {
+          auto parent_impl = m_impl->parent->m_impl.get ();
+          if (!parent_impl->extents.contains (m_impl->extents)) {
+              visual_log (VISUAL_LOG_ERROR, "Sub-video is not fully contained by parent.");
+              return false;
+          }
+      }
+
+      if (m_impl->depth != VISUAL_VIDEO_DEPTH_GL) {
+          // Validate depth and bytes per pixel consisteency.
+
+          if (m_impl->bpp != visual_video_depth_bpp (m_impl->depth) / 8) {
+              visual_log (VISUAL_LOG_ERROR, "Depth (%s) is not consistent with BPP (%d).",
+                          visual_video_depth_name (m_impl->depth), m_impl->bpp);
+              return false;
+          }
+
+          // Validate pixel row table
+
+          auto pixel_row_ptr = static_cast<uint8_t const*> (get_pixels ());
+
+          for (int y = 0; y < m_impl->height; y++) {
+              if (m_impl->pixel_rows[y] != pixel_row_ptr) {
+                  visual_log (VISUAL_LOG_ERROR, "Pixel row pointer table is wrong at y=%d.", y);
+                  return false;
+              }
+
+              pixel_row_ptr += m_impl->pitch;
+          }
+      }
+
+      return true;
+  }
+  #endif // defined(LV_ENABLE_TESTS)
+
+  bool Video::has_same_content (VideoConstPtr const& video) const
+  {
+      // Comparison of GL LV::Video is not supported.
+      if (m_impl->depth == VISUAL_VIDEO_DEPTH_GL || video->m_impl->depth == VISUAL_VIDEO_DEPTH_GL) {
+          return false;
+      }
+
+      // Videos must have the same dimensions and pixel format.
+
+      if (m_impl->width != video->m_impl->width)
+          return false;
+
+      if (m_impl->height != video->m_impl->height)
+          return false;
+
+      if (m_impl->depth != video->m_impl->depth)
+          return false;
+
+      // Videos must have the same colours at every pixel.
+
+      // Determine the block size in bytes in each row to compare. This must exclude padding. It must also exclude
+      // pixels outside of a subvideo's extents.
+      std::size_t const content_bytes_per_row = m_impl->width * m_impl->bpp;
+
+      for (int y = 0; y < m_impl->height; y++) {
+          if (std::memcmp (m_impl->pixel_rows[y], video->m_impl->pixel_rows[y], content_bytes_per_row)) {
+              return false;
+          }
+      }
+
+      return true;
+  }
+
   void Video::set_palette (Palette const& palette)
   {
       m_impl->palette = palette;

libvisual/libvisual/lv_video.h

@@ -294,6 +294,26 @@ namespace LV {
        */
       bool compare_attrs_ignore_pitch (VideoConstPtr const& src) const;
 
+#ifdef LV_ENABLE_TESTS
+      /**
+       * Validates the state of this Video.
+       *
+       * @remark For debugging and testing purposes.
+       *
+       * @return true if video has consistent state, false otherwise.
+       */
+      bool validate() const;
+#endif // defined(LV_ENABLE_TESTS)
+
+      /**
+       * Checks if this Video has the same (pixel) content as another Video.
+       *
+       * @param src Video to compare against
+       *
+       * @return true if both videos have the same content, false otherwise
+       */
+      bool has_same_content (VideoConstPtr const& video) const;
+
       /**
        * Returns the size of the pixel buffer
        *

libvisual/tests/video_test/CMakeLists.txt

@@ -1,3 +1,7 @@
+LV_BUILD_TEST(video_check_test
+  SOURCES video_check_test.cpp
+)
+
 IF(HAVE_SDL)
   LV_BUILD_TEST(video_scale_test
     SOURCES   video_scale_test.cpp

libvisual/tests/video_test/video_check_test.cpp

@@ -0,0 +1,14 @@
+#include "test.h"
+#include <libvisual/libvisual.h>
+
+int main (int argc, char* argv[])
+{
+    LV::System::init (argc, argv);
+
+    auto video = LV::Video::create(640, 480, VISUAL_VIDEO_DEPTH_16BIT);
+
+    LV_TEST_ASSERT (video->validate ());
+    LV_TEST_ASSERT (video->has_same_content (video));
+
+    LV::System::destroy ();
+}