From: Víctor Manuel Jáquez Leal <vjaquez@igalia.com>
Date: Thu, 12 Nov 2020 12:33:26 +0000 (+0100)
Subject: va: comments to explain code
X-Git-Tag: 1.19.3~507^2~1093
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=5876f232eefc4c9f3c3d20918b9ff3808b79af98;p=platform%2Fupstream%2Fgstreamer.git

va: comments to explain code

There are a couple part where code seems, at least to me, a bit oscure or
confusing. So let's better add an explanation.

Part-of: <https://gitlab.freedesktop.org/gstreamer/gst-plugins-bad/-/merge_requests/1802>
---

diff --git a/sys/va/gstvabasedec.c b/sys/va/gstvabasedec.c
index 87aa8f5..b33e854 100644
--- a/sys/va/gstvabasedec.c
+++ b/sys/va/gstvabasedec.c
@@ -334,6 +334,8 @@ gst_va_base_dec_decide_allocation (GstVideoDecoder * decoder, GstQuery * query)
   gst_object_unref (allocator);
   gst_object_unref (pool);
 
+  /* There's no need to chain decoder's method since all what is
+   * needed is done. */
   return TRUE;
 
 wrong_caps:
diff --git a/sys/va/gstvapool.c b/sys/va/gstvapool.c
index 18ea591..9c7a768 100644
--- a/sys/va/gstvapool.c
+++ b/sys/va/gstvapool.c
@@ -145,7 +145,14 @@ gst_va_pool_set_config (GstBufferPool * pool, GstStructure * config)
   vpool->caps_info = caps_info;
   vpool->alloc_info = alloc_info;
 
-  /* May adjust the stride alignment based on the real HW alignment */
+  /* May adjust the stride alignment based on the real HW alignment:
+   *
+   * Counts the number of consecutive bits from lower significant
+   * bit. This number is then converted to the notion of alignment in
+   * GStreamer and passed as as constraint in GstVideoAlignment. The
+   * side effect is that the updated GstVideoInfo is now guarantied to
+   * endup with the same stride (ndufresne).
+   */
   if (vpool->need_alignment) {
     for (i = 0; i < GST_VIDEO_INFO_N_PLANES (&alloc_info); i++) {
       gint nth_bit;