Re: [RFCv2 PATCH 08/10] DocBook: document new v4l motion detection event.

[Hans Verkuil <hverkuil@xs4all.nl>]

On 08/21/2013 11:41 PM, Laurent Pinchart wrote:
> Hi Hans,
> 
> Thank you for the patch.
> 
> On Monday 12 August 2013 12:58:31 Hans Verkuil wrote:
>> From: Hans Verkuil <hans.verkuil@cisco.com>
>>
>> Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com>
>> ---
>>  Documentation/DocBook/media/v4l/vidioc-dqevent.xml | 40 +++++++++++++++++++
>>  .../DocBook/media/v4l/vidioc-subscribe-event.xml   |  9 +++++
>>  2 files changed, 49 insertions(+)
>>
>> diff --git a/Documentation/DocBook/media/v4l/vidioc-dqevent.xml
>> b/Documentation/DocBook/media/v4l/vidioc-dqevent.xml index 89891ad..23ee1e3
>> 100644
>> --- a/Documentation/DocBook/media/v4l/vidioc-dqevent.xml
>> +++ b/Documentation/DocBook/media/v4l/vidioc-dqevent.xml
>> @@ -94,6 +94,12 @@
>>  	  </row>
>>  	  <row>
>>  	    <entry></entry>
>> +	    <entry>&v4l2-event-motion-det;</entry>
>> +            <entry><structfield>motion_det</structfield></entry>
>> +	    <entry>Event data for event V4L2_EVENT_MOTION_DET.</entry>
>> +	  </row>
>> +	  <row>
>> +	    <entry></entry>
>>  	    <entry>__u8</entry>
>>              <entry><structfield>data</structfield>[64]</entry>
>>  	    <entry>Event data. Defined by the event type. The union
>> @@ -242,6 +248,40 @@
>>        </tgroup>
>>      </table>
>>
>> +    <table frame="none" pgwide="1" id="v4l2-event-motion-det">
>> +      <title>struct <structname>v4l2_event_motion_det</structname></title>
>> +      <tgroup cols="3">
>> +	&cs-str;
>> +	<tbody valign="top">
>> +	  <row>
>> +	    <entry>__u32</entry>
>> +	    <entry><structfield>flags</structfield></entry>
>> +	    <entry>
>> +	      Currently only one flag is available: if
>> <constant>V4L2_EVENT_MD_FL_HAVE_FRAME_SEQ</constant> +	      is set, then
>> the <structfield>frame_sequence</structfield> field is valid, +	     
>> otherwise that field should be ignored.
>> +	    </entry>
>> +	  </row>
>> +	  <row>
>> +	    <entry>__u32</entry>
>> +	    <entry><structfield>frame_sequence</structfield></entry>
>> +	    <entry>
>> +	      The sequence number of the frame being received. Only valid if the
>> +	      <constant>V4L2_EVENT_MD_FL_HAVE_FRAME_SEQ</constant> flag was set.
>> +	    </entry>
>> +	  </row>
>> +	  <row>
>> +	    <entry>__u32</entry>
>> +	    <entry><structfield>region_mask</structfield></entry>
>> +	    <entry>
>> +	      The bitmask of the regions that reported motion. There is at least
>> one
>> +	      region. If this field is 0, then no motion was detected at all.
>> +	    </entry>
>> +	  </row>
>> +	</tbody>
>> +      </tgroup>
>> +    </table>
>> +
>>      <table pgwide="1" frame="none" id="changes-flags">
>>        <title>Changes</title>
>>        <tgroup cols="3">
>> diff --git a/Documentation/DocBook/media/v4l/vidioc-subscribe-event.xml
>> b/Documentation/DocBook/media/v4l/vidioc-subscribe-event.xml index
>> 5c70b61..d9c3e66 100644
>> --- a/Documentation/DocBook/media/v4l/vidioc-subscribe-event.xml
>> +++ b/Documentation/DocBook/media/v4l/vidioc-subscribe-event.xml
>> @@ -155,6 +155,15 @@
>>  	    </entry>
>>  	  </row>
>>  	  <row>
>> +	    <entry><constant>V4L2_EVENT_MOTION_DET</constant></entry>
>> +	    <entry>5</entry>
>> +	    <entry>
>> +	      <para>Triggered whenever the motion detection state changes, i.e.
>> +	      whether motion is detected or not.
> 
> Isn't the event also triggered when region_mask changes from a non-zero value 
> to a different non-zero value ? The second part of the sentence seems to imply 
> that the even is only triggered when motion starts being detected or stops 
> being detected.

Good point. How about this:

"Triggered whenever the motion detection state for one or more of the regions
changes."

Regards,

	Hans