src/Tizen.Multimedia.Vision/MediaVision/FaceTrackingModel.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 System.IO;
  19 using InteropModel = Interop.MediaVision.FaceTrackingModel;
  20
  21 namespace Tizen.Multimedia.Vision
  22 {
  23     /// <summary>
  24     /// Represents the face tracking model.
  25     /// </summary>
  26     /// <since_tizen> 3 </since_tizen>
  27     public class FaceTrackingModel : IDisposable
  28     {
  29         private IntPtr _handle = IntPtr.Zero;
  30         private bool _disposed = false;
  31
  32         /// <summary>
  33         /// Initializes a new instance of the <see cref="FaceTrackingModel"/> class.
  34         /// </summary>
  35         /// <exception cref="NotSupportedException">The feature is not supported.</exception>
  36         /// <since_tizen> 3 </since_tizen>
  37         public FaceTrackingModel()
  38         {
  39             InteropModel.Create(out _handle).Validate("Failed to create FaceTrackingModel.");
  40         }
  41
  42         /// <summary>
  43         /// Initializes a new instance of the <see cref="FaceTrackingModel"/> class with the specified path.
  44         /// </summary>
  45         /// <remarks>
  46         /// Models saved by <see cref="Save(string)"/> can be loaded.
  47         /// </remarks>
  48         /// <param name="modelPath">Path to the model to load.</param>
  49         /// <exception cref="ArgumentNullException"><paramref name="modelPath"/> is null.</exception>
  50         /// <exception cref="FileNotFoundException"><paramref name="modelPath"/> is invalid.</exception>
  51         /// <exception cref="NotSupportedException">
  52         ///     The feature is not supported.\n
  53         ///     -or-\n
  54         ///     <paramref name="modelPath"/> is not supported format.
  55         /// </exception>
  56         /// <exception cref="UnauthorizedAccessException">No permission to access the specified file.</exception>
  57         /// <seealso cref="Save(string)"/>
  58         /// <since_tizen> 3 </since_tizen>
  59         public FaceTrackingModel(string modelPath)
  60         {
  61             if (modelPath == null)
  62             {
  63                 throw new ArgumentNullException(nameof(modelPath));
  64             }
  65             InteropModel.Load(modelPath, out _handle).Validate("Failed to load FaceTrackingModel from file.");
  66         }
  67
  68         ~FaceTrackingModel()
  69         {
  70             Dispose(false);
  71         }
  72
  73         private MediaVisionError InvokePrepare(MediaVisionSource source, Quadrangle region)
  74         {
  75             if (region != null)
  76             {
  77                 var quad = region.ToMarshalable();
  78                 return InteropModel.Prepare(Handle, IntPtr.Zero, source.Handle, ref quad);
  79             }
  80
  81             return InteropModel.Prepare(Handle, IntPtr.Zero, source.Handle, IntPtr.Zero);
  82         }
  83
  84         /// <summary>
  85         /// Initializes the tracking model by the location of the face to be tracked.
  86         ///
  87         /// It is usually called once after the tracking model is created, and each time before tracking
  88         /// is started for the new sequence of sources, which is not the direct continuation of
  89         /// the sequence for which tracking has been performed before. But, it is allowed to call it
  90         /// between tracking sessions to allow Media Vision start to track more accurately.
  91         /// </summary>
  92         /// <remarks>
  93         /// <paramref name="region"/> needs to be the position of the face to be tracked when called first time for the tracking model.
  94         /// <paramref name="region"/> is fitted to the valid region of <paramref name="source"/> if <paramref name="region"/> has invalid points.
  95         /// </remarks>
  96         /// <param name="source">The source where face location is specified.
  97         ///     Usually it is the first frame of the video or the first image in the continuous
  98         ///     image sequence planned to be used for tracking.</param>
  99         /// <param name="region">The region determining position of the face to be tracked on the source.
 100         ///     If null, then tracking model will try to find previously tracked face by itself.</param>
 101         /// <exception cref="ArgumentNullException"><paramref name="source"/> is null.</exception>
 102         /// <exception cref="ObjectDisposedException">
 103         ///     The <see cref="FaceTrackingModel"/> has already been disposed of.\n
 104         ///     -or-\n
 105         ///     <paramref name="source"/> has already bean disposed of.
 106         /// </exception>
 107         /// <since_tizen> 3 </since_tizen>
 108         public void Prepare(MediaVisionSource source, Quadrangle region)
 109         {
 110             if (source == null)
 111             {
 112                 throw new ArgumentNullException(nameof(source));
 113             }
 114
 115             InvokePrepare(source, region).Validate("Failed to prepare tracking model.");
 116         }
 117
 118         /// <summary>
 119         /// Saves the tracking model to the file.
 120         /// </summary>
 121         /// <param name="path">Path to the file to save the model.</param>
 122         /// <exception cref="ArgumentNullException"><paramref name="path"/> is null.</exception>
 123         /// <exception cref="UnauthorizedAccessException">No permission to write to the specified path.</exception>
 124         /// <exception cref="ObjectDisposedException">The <see cref="FaceRecognitionModel"/> has already been disposed of.</exception>
 125         /// <exception cref="DirectoryNotFoundException">The directory for <paramref name="path"/> does not exist.</exception>
 126         /// <since_tizen> 3 </since_tizen>
 127         public void Save(string path)
 128         {
 129             if (path == null)
 130             {
 131                 throw new ArgumentNullException(nameof(path));
 132             }
 133
 134             var ret = InteropModel.Save(path, Handle);
 135
 136             if (ret == MediaVisionError.InvalidPath)
 137             {
 138                 throw new DirectoryNotFoundException($"The directory for the path({path}) does not exist.");
 139             }
 140
 141             ret.Validate("Failed to save tracking model to file");
 142         }
 143
 144         /// <summary>
 145         /// Releases all the resources used by the <see cref="FaceTrackingModel"/> object.
 146         /// </summary>
 147         public void Dispose()
 148         {
 149             Dispose(true);
 150             GC.SuppressFinalize(this);
 151         }
 152
 153         /// <summary>
 154         /// Releases the resources used by the <see cref="FaceTrackingModel"/> object.
 155         /// </summary>
 156         /// <param name="disposing">
 157         /// true to release both managed and unmanaged resources; otherwise false to release only unmanaged resources.
 158         /// </param>
 159         protected virtual void Dispose(bool disposing)
 160         {
 161             if (_disposed)
 162             {
 163                 return;
 164             }
 165
 166             InteropModel.Destroy(_handle);
 167             _disposed = true;
 168         }
 169
 170         internal IntPtr Handle
 171         {
 172             get
 173             {
 174                 if (_disposed)
 175                 {
 176                     throw new ObjectDisposedException(nameof(FaceTrackingModel));
 177                 }
 178                 return _handle;
 179             }
 180         }
 181     }
 182 }