rstdoc: update ShowCRC32 parameters (#479)

Author: pinterf

distrib/Readme/readme_history.txt

@@ -9,6 +9,15 @@ For online documentation check https://avisynthplus.readthedocs.io/en/latest/
 Actual:
 https://avisynthplus.readthedocs.io/en/latest/avisynthdoc/changelist376.html
 
+20260508 3.7.5.r45XX (pre 3.7.6)
+--------------------------------
+- ShowCRC32: new "channels" (select planes), "mode" (0=combined, 1=per-plane), and
+  "showmode" (0=display, 1=display+frameprop, 2=frameprop only) parameters;
+  frame property "ShowCRC32" is an int64 array of unsigned 32-bit CRC values;
+  planar RGB(A) planes always in R,G,B,A order; packed formats with default parameters
+  hash the raw buffer unchanged (backward-compatible).
+- rstdoc: document Invert's chroma inversion behavior
+
 20260506 3.7.5.r4589 (pre 3.7.6)
 --------------------------------
 TL;DR (since r4565):

distrib/docs/english/source/avisynthdoc/changelist376.rst

@@ -125,6 +125,20 @@ Additions, changes
   overlay Y; pass 2 processes luma at full resolution.  The ``"placement"`` parameter is respected for
   correct 4:2:0 / 4:2:2 mask downsampling.
   See :doc:`Layer <./corefilters/layer>`.
+- ``ShowCRC32``: add ``channels``, ``mode``, and ``showmode`` parameters.
+
+  * ``channels`` — selects which planes to checksum using their initial letters (Y, U, V, A for YUV;
+    R, G, B, A for RGB), defaulting to all planes.  Unrecognised letters are silently ignored.
+  * ``mode`` — ``0`` (default): one combined CRC32 over all selected planes; ``1``: separate CRC32
+    per plane displayed as ``"Y:XXXXXXXX U:XXXXXXXX ..."``.
+  * ``showmode`` — ``0`` (default): display text only; ``1``: display text and store result as frame
+    property ``"ShowCRC32"`` (``int64`` array — one element for ``mode=0``, one per active plane for
+    ``mode=1``); ``2``: store frame property only, no text drawn.  Values are unsigned 32-bit integers
+    stored as ``int64``.
+  * For packed formats (YUY2, RGB24/32/48/64) with default parameters the raw interleaved buffer
+    is hashed directly, preserving backward compatibility.
+  * Planar RGB(A): planes are always processed in R, G, B, A logical order.
+  See :doc:`showframes <./corefilters/showframes>`.
 - "Layer": add ``"top_left"`` option for the ``"placement"`` parameter — HEVC/AV1 left+top co-sited
   chroma (point-sample, fastest).  Affects ``"mul"``, ``"add"``, ``"subtract"``, ``"lighten"``,
   ``"darken"``, and ``"mulovr"`` modes with 4:2:0 / 4:2:2 sources.
@@ -361,6 +375,7 @@ Documentation
 - Add :doc:`SetFilterProp / SetFilterPropPassthrough <./corefilters/setfilterprop>`
 - Add ``ShowCRC32`` documentation to :doc:`showframes <./corefilters/showframes>`
   (filter exists since 3.7.0; rst page was not updated at the time).
+  Document new ``channels`` and ``mode`` parameters added in 3.7.6.
 - Update :doc:`Layer <./corefilters/layer>` with ``"mulovr"`` mode, ``"top_left"`` placement
   option, and related chroma-placement refactoring notes.
 - Update :doc:`Overlay <./corefilters/overlay>` with ``"placement"`` parameter for ``"blend"`` mode.

distrib/docs/english/source/avisynthdoc/corefilters/showframes.rst

@@ -7,7 +7,7 @@ Set of filters to overlay frame numbers, timecodes, and debug information onto a
 * `ShowFrameNumber`_ displays the frame number on each frame.
 * `ShowSMPTE`_ displays SMPTE timecodes.
 * `ShowTime`_ displays time for the current frame.
-* `ShowCRC32`_ computes and displays the CRC32 checksum of the default plane (debug filter).
+* `ShowCRC32`_ computes and displays the CRC32 checksum of selected planes (debug filter).
 
 See the `Examples`_ section for visuals.
 
@@ -398,10 +398,19 @@ See the :ref:`ShowTime examples <ShowTime-examples>` section.
 ShowCRC32
 ---------
 
-A debug filter that computes the CRC32 checksum of the **default plane** of each frame
-and overlays the result as an 8-character uppercase hexadecimal string (e.g. ``"AB12CD34"``).
-Only the default plane is checksummed: luma (Y) for YUV clips, the green plane for planar RGB,
-or the interleaved data for packed formats such as YUY2.
+A debug filter that computes the CRC32 checksum of selected planes of each frame and overlays
+the result as an uppercase hexadecimal string.
+
+By default (no ``channels`` or ``mode`` given) the result is a single 8-character value
+(e.g. ``"AB12CD34"``).  With the ``channels`` and ``mode`` parameters the filter can cover
+any combination of planes and either combine them into one CRC or show them side by side.
+
+For **packed formats** (YUY2, RGB24/32/48/64) with default parameters the interleaved
+buffer is hashed directly, matching the original pre-3.7.6 behaviour.  When ``channels``
+or ``mode`` is specified the clip is internally converted to a planar equivalent first.
+
+For **planar RGB(A)** clips planes are always processed in R, G, B, A logical order,
+regardless of the physical plane storage order.
 
 The text placement and scrolling behaviour are identical to `ShowFrameNumber`_.
 
@@ -411,7 +420,8 @@ The text placement and scrolling behaviour are identical to `ShowFrameNumber`_.
 
     ShowCRC32 (clip, bool "scroll", int "offset", float "x", float "y", string "font", float "size",
                int "text_color", int "halo_color", float "font_width", float "font_angle",
-               bool "bold", bool "italic", bool "noaa")
+               bool "bold", bool "italic", bool "noaa", string "channels", int "mode",
+               int "showmode")
 
 .. describe:: clip
 
@@ -493,6 +503,41 @@ The text placement and scrolling behaviour are identical to `ShowFrameNumber`_.
 
     Default: false
 
+.. describe:: channels
+
+    | Selects which planes to include in the checksum, using their initial letters.
+    | For YUV(A) clips: Y, U, V, A.  For RGB(A) clips: R, G, B, A.
+    | Letters are not case-sensitive and may appear in any order; unrecognised
+      letters are silently ignored.
+    | For planar RGB(A) planes are always processed in R, G, B, A order regardless
+      of the order given here.
+
+    Default: all planes of the current color space (same set as ``Invert``).
+
+.. describe:: mode
+
+    | Controls how checksums from multiple planes are combined.
+    | ``0`` — compute a single CRC32 over all selected planes concatenated in order;
+      the result is one 8-character hex value (e.g. ``"AB12CD34"``).
+    | ``1`` — compute a separate CRC32 per selected plane; the result shows each
+      plane label followed by its value (e.g. ``"Y:AB12CD34 U:12345678 V:ABCDEF01"``).
+
+    Default: 0
+
+.. describe:: showmode
+
+    | Controls whether the CRC result is overlaid as text, stored as a frame property,
+      or both.
+    | ``0`` — display only (default; original behaviour).
+    | ``1`` — display the text *and* store the CRC value(s) as an integer array frame
+      property named ``ShowCRC32``.  For ``mode=0`` the array has one element; for
+      ``mode=1`` it has one element per active plane, in display order.
+    | ``2`` — store the frame property only; no text is drawn on the output.
+    | Values are unsigned 32-bit integers stored as ``int64`` (the native array element
+      type for AviSynth frame properties).
+
+    Default: 0
+
 
 Examples
 --------
@@ -586,12 +631,49 @@ Examples
             LSMASHSource("sintel-2048-surround.mp4")
             ShowTime()
 
+.. _ShowCRC32-examples:
+
+.. rubric:: `ShowCRC32`_
+
+* Default behaviour on a packed RGB32 clip — the whole interleaved frame buffer is
+  hashed and a single 8-character hex value is overlaid::
+
+    ColorBars(pixel_type="RGB32").ShowCRC32()
+
+* Equivalent explicit call — ``mode=0`` combines all RGBA planes into one CRC.
+  For packed RGB32 with explicit parameters the clip is first converted to planar
+  RGBA internally, so all four planes are covered::
+
+    ColorBars(pixel_type="RGB32").ShowCRC32(mode=0, channels="RGBA")
+
+* Per-plane mode — display a separate CRC for each of the R, G, B planes side by
+  side (e.g. ``"R:AB12CD34 G:12345678 B:ABCDEF01"``)::
+
+    ColorBars(pixel_type="RGB32").ShowCRC32(mode=1, channels="RGB")
+
+* Store CRC values as a frame property without drawing anything on screen, then
+  display the property with ``propShow``.  ``channels="RGBA"`` is specified, but
+  ``RGBP8`` has no alpha plane — the ``A`` letter is silently ignored, so the
+  property array will have three elements (R, G, B) rather than four.  No error
+  is raised::
+
+    ColorBars(pixel_type="RGBP8")
+    ShowCRC32(mode=1, channels="RGBA", showmode=2)
+    propShow(props="ShowCRC32", align=1)
+
 Changelog
 ---------
 
 +-----------------+-----------------------------------------------------------------------------+
 | Version         | Changes                                                                     |
 +=================+=============================================================================+
+| AviSynth+ 3.7.6 || ``ShowCRC32``: add ``channels``, ``mode``, and ``showmode`` parameters.    |
+|                 || ``channels``: select planes individually.                                  |
+|                 || ``mode``: combined (0) or per-plane (1) CRC output.                        |
+|                 || ``showmode``: display only (0), display + frame property (1), property     |
+|                 |  only (2). Frame property name: ``ShowCRC32`` (int64 array).                |
+|                 || Planar RGB(A): planes always processed in R, G, B, A order.                |
++-----------------+-----------------------------------------------------------------------------+
 | AviSynth+ 3.7.3 | Add ``bold``, ``italic`` and ``noaa``                                       |
 +-----------------+-----------------------------------------------------------------------------+
 | AviSynth+ 3.7.0 | Added ``ShowCRC32``.                                                        |
@@ -606,7 +688,7 @@ Changelog
 | AviSynth 2.5.6  | Added ``offset`` and other options.                                         |
 +-----------------+-----------------------------------------------------------------------------+
 
-$Date: 2026/05/08 11:02:00 $
+$Date: 2026/05/08 11:57:00 $
 
 .. _Interlaced Fieldbased:
     http://avisynth.nl/index.php/Interlaced_fieldbased