Files
zoneminder/tests/zm_zone.cpp
Isaac Connor c0016fa00b feat: store zone coordinates as percentages for resolution independence
Convert zone coordinates from absolute pixel values to percentages
(0.00-100.00) so zones automatically adapt when monitor resolution
changes. This eliminates the need to manually reconfigure zones after
resolution adjustments.

Changes:
- Add DB migration (zm_update-1.37.81.sql) to convert existing pixel
  coords to percentages, recalculate area, and update Units default
- Add Zone::ParsePercentagePolygon() in C++ to parse percentage coords
  and convert to pixels at runtime using monitor dimensions
- Backwards compat: C++ Zone::Load() checks Units column and uses old
  pixel parser for legacy 'Pixels' zones
- Update PHP coordsToPoints/mapCoords/getPolyArea for float coords,
  replace scanline area algorithm with shoelace formula
- Update JS zone editor to work in percentage coordinate space with
  SVG viewBox "0 0 100 100" and non-scaling-stroke for consistent
  line thickness
- Position zone SVG overlay inside imageFeed container via JS to align
  with image only (not status bar)
- Support array of zone IDs in Monitor::getStreamHTML zones option
- Update monitor resize handler: percentage coords don't need rescaling,
  only threshold pixel counts are adjusted
- Add 8 Catch2 unit tests for ParsePercentagePolygon

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-02-23 18:19:20 -05:00

223 lines
7.7 KiB
C++

/*
* This file is part of the ZoneMinder Project. See AUTHORS file for Copyright information
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the
* Free Software Foundation; either version 2 of the License, or (at your
* option) any later version.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
* more details.
*
* You should have received a copy of the GNU General Public License along
* with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#include "zm_catch2.h"
#include "zm_zone.h"
TEST_CASE("Zone::ParsePercentagePolygon: full-frame zone at 1920x1080", "[Zone]") {
Polygon polygon;
bool result = Zone::ParsePercentagePolygon(
"0.00,0.00 100.00,0.00 100.00,100.00 0.00,100.00",
1920, 1080, polygon);
REQUIRE(result == true);
REQUIRE(polygon.GetVertices().size() == 4);
REQUIRE(polygon.GetVertices()[0] == Vector2(0, 0));
REQUIRE(polygon.GetVertices()[1] == Vector2(1920, 0));
REQUIRE(polygon.GetVertices()[2] == Vector2(1920, 1080));
REQUIRE(polygon.GetVertices()[3] == Vector2(0, 1080));
}
TEST_CASE("Zone::ParsePercentagePolygon: center 50% zone", "[Zone]") {
Polygon polygon;
bool result = Zone::ParsePercentagePolygon(
"25.00,25.00 75.00,25.00 75.00,75.00 25.00,75.00",
1920, 1080, polygon);
REQUIRE(result == true);
REQUIRE(polygon.GetVertices().size() == 4);
REQUIRE(polygon.GetVertices()[0] == Vector2(480, 270));
REQUIRE(polygon.GetVertices()[1] == Vector2(1440, 270));
REQUIRE(polygon.GetVertices()[2] == Vector2(1440, 810));
REQUIRE(polygon.GetVertices()[3] == Vector2(480, 810));
}
TEST_CASE("Zone::ParsePercentagePolygon: fractional percentages", "[Zone]") {
Polygon polygon;
bool result = Zone::ParsePercentagePolygon(
"50.25,75.50 60.00,75.50 60.00,85.00 50.25,85.00",
1920, 1080, polygon);
REQUIRE(result == true);
REQUIRE(polygon.GetVertices().size() == 4);
// 50.25% of 1920 = 964.8 -> 965
REQUIRE(polygon.GetVertices()[0].x_ == 965);
// 75.50% of 1080 = 815.4 -> 815
REQUIRE(polygon.GetVertices()[0].y_ == 815);
}
TEST_CASE("Zone::ParsePercentagePolygon: different resolution", "[Zone]") {
Polygon polygon;
bool result = Zone::ParsePercentagePolygon(
"0.00,0.00 100.00,0.00 100.00,100.00 0.00,100.00",
640, 480, polygon);
REQUIRE(result == true);
REQUIRE(polygon.GetVertices()[1] == Vector2(640, 0));
REQUIRE(polygon.GetVertices()[2] == Vector2(640, 480));
}
TEST_CASE("Zone::ParsePercentagePolygon: clamping beyond 100%", "[Zone]") {
Polygon polygon;
bool result = Zone::ParsePercentagePolygon(
"0.00,0.00 110.00,0.00 100.00,100.00 0.00,100.00",
1920, 1080, polygon);
REQUIRE(result == true);
// 110% should be clamped to monitor width
REQUIRE(polygon.GetVertices()[1].x_ == 1920);
}
TEST_CASE("Zone::ParsePercentagePolygon: triangle", "[Zone]") {
Polygon polygon;
bool result = Zone::ParsePercentagePolygon(
"50.00,10.00 90.00,90.00 10.00,90.00",
1000, 1000, polygon);
REQUIRE(result == true);
REQUIRE(polygon.GetVertices().size() == 3);
REQUIRE(polygon.GetVertices()[0] == Vector2(500, 100));
REQUIRE(polygon.GetVertices()[1] == Vector2(900, 900));
REQUIRE(polygon.GetVertices()[2] == Vector2(100, 900));
}
TEST_CASE("Zone::ParsePercentagePolygon: too few points", "[Zone]") {
Polygon polygon;
bool result = Zone::ParsePercentagePolygon(
"0.00,0.00 100.00,0.00",
1920, 1080, polygon);
REQUIRE(result == false);
}
TEST_CASE("Zone::ParsePercentagePolygon: integer coords still work", "[Zone]") {
// strtod handles integers fine
Polygon polygon;
bool result = Zone::ParsePercentagePolygon(
"0,0 100,0 100,100 0,100",
1920, 1080, polygon);
REQUIRE(result == true);
REQUIRE(polygon.GetVertices()[0] == Vector2(0, 0));
REQUIRE(polygon.GetVertices()[1] == Vector2(1920, 0));
REQUIRE(polygon.GetVertices()[2] == Vector2(1920, 1080));
REQUIRE(polygon.GetVertices()[3] == Vector2(0, 1080));
}
TEST_CASE("Zone::ParsePolygonString: basic pixel parsing", "[Zone]") {
Polygon polygon;
SECTION("parses a simple rectangle") {
bool ok = Zone::ParsePolygonString("0,0 639,0 639,479 0,479", polygon);
REQUIRE(ok);
auto const &verts = polygon.GetVertices();
REQUIRE(verts.size() == 4);
REQUIRE(verts[0] == Vector2(0, 0));
REQUIRE(verts[1] == Vector2(639, 0));
REQUIRE(verts[2] == Vector2(639, 479));
REQUIRE(verts[3] == Vector2(0, 479));
}
SECTION("parses a triangle") {
bool ok = Zone::ParsePolygonString("100,100 200,100 150,200", polygon);
REQUIRE(ok);
auto const &verts = polygon.GetVertices();
REQUIRE(verts.size() == 3);
REQUIRE(verts[0] == Vector2(100, 100));
REQUIRE(verts[1] == Vector2(200, 100));
REQUIRE(verts[2] == Vector2(150, 200));
}
SECTION("rejects string with fewer than 3 vertices") {
// Two vertices — not enough for a polygon, but ParsePolygonString
// returns true if any vertices were parsed (vertices.empty() check)
bool ok = Zone::ParsePolygonString("10,20 30,40", polygon);
REQUIRE(ok);
// The polygon won't be properly formed but parsing itself doesn't fail
}
}
TEST_CASE("Zone::ParsePercentagePolygon: percentage to pixel conversion", "[Zone]") {
Polygon polygon;
unsigned int width = 1920;
unsigned int height = 1080;
SECTION("full-frame 0-100% rectangle") {
bool ok = Zone::ParsePercentagePolygon("0,0 100,0 100,100 0,100", width, height, polygon);
REQUIRE(ok);
auto const &verts = polygon.GetVertices();
REQUIRE(verts.size() == 4);
REQUIRE(verts[0] == Vector2(0, 0));
REQUIRE(verts[1] == Vector2(1920, 0));
REQUIRE(verts[2] == Vector2(1920, 1080));
REQUIRE(verts[3] == Vector2(0, 1080));
}
SECTION("50% rectangle converts to half-resolution pixels") {
bool ok = Zone::ParsePercentagePolygon("0,0 50,0 50,50 0,50", width, height, polygon);
REQUIRE(ok);
auto const &verts = polygon.GetVertices();
REQUIRE(verts.size() == 4);
REQUIRE(verts[0] == Vector2(0, 0));
REQUIRE(verts[1] == Vector2(960, 0));
REQUIRE(verts[2] == Vector2(960, 540));
REQUIRE(verts[3] == Vector2(0, 540));
}
SECTION("values are clamped to monitor bounds") {
// 100% should clamp to exact monitor dimensions
bool ok = Zone::ParsePercentagePolygon("0,0 100,0 100,100 0,100", width, height, polygon);
REQUIRE(ok);
auto const &verts = polygon.GetVertices();
for (auto const &v : verts) {
REQUIRE(v.x_ >= 0);
REQUIRE(v.x_ <= static_cast<int>(width));
REQUIRE(v.y_ >= 0);
REQUIRE(v.y_ <= static_cast<int>(height));
}
}
}
TEST_CASE("Zone: pixel values through ParsePercentagePolygon produce wrong results", "[Zone]") {
// This test demonstrates the bug: when pixel coordinates (>100) are fed
// through ParsePercentagePolygon, they get treated as percentages and
// scaled wildly, then clamped to monitor bounds.
Polygon polygon;
unsigned int width = 1920;
unsigned int height = 1080;
// These are pixel coordinates for a 640x480 region
bool ok = Zone::ParsePercentagePolygon("0,0 639,0 639,479 0,479", width, height, polygon);
REQUIRE(ok);
auto const &verts = polygon.GetVertices();
REQUIRE(verts.size() == 4);
// 639% of 1920 = 12268.8 -> clamped to 1920
// 479% of 1080 = 5173.2 -> clamped to 1080
// All non-zero coords get clamped to monitor bounds — the zone is
// degenerate (covers the full monitor instead of a sub-region)
REQUIRE(verts[1] == Vector2(static_cast<int>(width), 0));
REQUIRE(verts[2] == Vector2(static_cast<int>(width), static_cast<int>(height)));
}