src/Tizen.Multimedia.Vision/MediaVision/MovementDetector.cs

   1 /*
   2  * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the License);
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an AS IS BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 using System;
  18 using static Interop.MediaVision.Surveillance;
  19
  20 namespace Tizen.Multimedia
  21 {
  22     /// <summary>
  23     /// Provides the ability to detect movement on image sources.
  24     /// </summary>
  25     /// <seealso cref="MovementDetectionConfiguration"/>
  26     /// <since_tizen> 3</since_tizen>
  27     public class MovementDetector : SurveillanceEngine
  28     {
  29         private const string KeyNumberOfRegions = "NUMBER_OF_MOVEMENT_REGIONS";
  30         private const string KeyRegions = "MOVEMENT_REGIONS";
  31
  32         private const string MovementDetectedEventType = "MV_SURVEILLANCE_EVENT_MOVEMENT_DETECTED";
  33
  34         /// <summary>
  35         /// Initializes a new instance of the <see cref="MovementDetector"/> class.
  36         /// </summary>
  37         /// <exception cref="NotSupportedException">The feature is not supported.</exception>
  38         /// <since_tizen> 3</since_tizen>
  39         public MovementDetector() : base(MovementDetectedEventType)
  40         {
  41         }
  42
  43         /// <summary>
  44         /// Occurs when the movement detected.
  45         /// </summary>
  46         /// <remarks>The event handler will be executed on an internal thread.</remarks>
  47         /// <since_tizen> 3</since_tizen>
  48         public event EventHandler<MovementDetectedEventArgs> Detected;
  49
  50         internal override void OnEventDetected(IntPtr trigger, IntPtr source, int streamId,
  51             IntPtr result, IntPtr _)
  52         {
  53             try
  54             {
  55                 Detected?.Invoke(this, CreateMovementDetectedEventArgs(result));
  56             }
  57             catch (Exception e)
  58             {
  59                 MultimediaLog.Error(MediaVisionLog.Tag, "Failed to invoke Recognized event.", e);
  60             }
  61         }
  62
  63         private static Rectangle[] RetrieveAreas(IntPtr result)
  64         {
  65             int count = 0;
  66             GetResultValue(result, KeyNumberOfRegions, out count).Validate("Failed to get result count");
  67
  68             if (count == 0)
  69             {
  70                 return new Rectangle[0];
  71             }
  72
  73             var rects = new global::Interop.MediaVision.Rectangle[count];
  74
  75             GetResultValue(result, KeyRegions, rects).Validate("Failed to get regions");
  76
  77             return global::Interop.ToApiStruct(rects);
  78         }
  79
  80         private static MovementDetectedEventArgs CreateMovementDetectedEventArgs(IntPtr result)
  81         {
  82             return new MovementDetectedEventArgs(RetrieveAreas(result));
  83         }
  84
  85
  86         /// <summary>
  87         /// Adds <see cref="SurveillanceSource"/>.
  88         /// </summary>
  89         /// <param name="source">The source used for recognition.</param>
  90         /// <exception cref="ArgumentNullException"><paramref name="source"/> is null.</exception>
  91         /// <exception cref="ObjectDisposedException">The <see cref="MovementDetector"/> has already been disposed of.</exception>
  92         /// <see cref="SurveillanceSource.Push(MediaVisionSource)"/>
  93         /// <since_tizen> 3</since_tizen>
  94         public void AddSource(SurveillanceSource source)
  95         {
  96             AddSource(source, null);
  97         }
  98
  99         /// <summary>
 100         /// Adds <see cref="SurveillanceSource"/> with the provided <see cref="MovementDetectionConfiguration"/>.
 101         /// </summary>
 102         /// <param name="source">The source used for recognition.</param>
 103         /// <param name="config">The config for the <paramref name="source"/>. This value can be null.</param>
 104         /// <exception cref="ArgumentNullException"><paramref name="source"/> is null.</exception>
 105         /// <exception cref="ObjectDisposedException">
 106         ///     The <see cref="MovementDetector"/> has already been disposed of.\n
 107         ///     -or-\n
 108         ///     <paramref name="config"/> has already been disposed of.
 109         /// </exception>
 110         /// <see cref="SurveillanceSource.Push(MediaVisionSource)"/>
 111         /// <since_tizen> 3</since_tizen>
 112         public void AddSource(SurveillanceSource source, MovementDetectionConfiguration config)
 113         {
 114             InvokeAddSource(source, config);
 115         }
 116
 117     }
 118 }