// 
// Copyright (c) Microsoft. All rights reserved.
// Licensed under the MIT license.
// 
// Microsoft Cognitive Services: http://www.microsoft.com/cognitive
// 
// Microsoft Cognitive Services Github:
// https://github.com/Microsoft/Cognitive
// 
// Copyright (c) Microsoft Corporation
// All rights reserved.
// 
// MIT License:
// Permission is hereby granted, free of charge, to any person obtaining
// a copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to
// permit persons to whom the Software is furnished to do so, subject to
// the following conditions:
// 
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED ""AS IS"", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
// 

using System;
using OpenCvSharp;

namespace VideoFrameAnalyzer
{
    /// <summary> Metadata for a VideoFrame. </summary>
    public struct VideoFrameMetadata
    {
        public DateTime Timestamp;
        public int Index;
    }

    /// <summary> A video frame produced by the <see cref="FrameGrabber{AnalysisResultType}"/>.
    ///     This class encapsulates the image, any metadata, and also allows the user to attach
    ///     some arbitrary data to each frame as it flows through the pipeline. </summary>
    public class VideoFrame
    {
        /// <summary> Constructor. </summary>
        /// <param name="image">    The image captured by the camera. </param>
        /// <param name="metadata"> The metadata. </param>
        public VideoFrame(Mat image, VideoFrameMetadata metadata)
        {
            Image = image;
            Metadata = metadata;
        }

        /// <summary> Gets the image for the frame. </summary>
        /// <value> The image. </value>
        public Mat Image { get; }

        /// <summary> Gets the frame's metadata. </summary>
        /// <value> The metadata. </value>
        public VideoFrameMetadata Metadata { get; }

        /// <summary> Gets or sets the frame's "user data". </summary>
        /// <value> Any additional data that the user would like to attach to a video frame. </value>
        public object UserData { get; set; } = null;
    }
}