/*
 *  video.rs
 *  purecv
 *
 *  This file is part of purecv - WebARKit.
 *
 *  purecv is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Lesser General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  purecv is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public License
 *  along with purecv.  If not, see <http://www.gnu.org/licenses/>.
 *
 *  As a special exception, the copyright holders of this library give you
 *  permission to link this library with independent modules to produce an
 *  executable, regardless of the license terms of these independent modules, and to
 *  copy and distribute the resulting executable under terms of your choice,
 *  provided that you also meet, for each linked independent module, the terms and
 *  conditions of the license of that module. An independent module is a module
 *  which is neither derived from nor based on this library. If you modify this
 *  library, you may extend this exception to your version of the library, but you
 *  are not obligated to do so. If you do not wish to do so, delete this exception
 *  statement from your version.
 *
 *  Copyright 2026 WebARKit.
 *
 *  Author(s): Walter Perdan @kalwalt https://github.com/kalwalt
 *
 */

//! Video analysis module — optical flow and motion estimation.
//!
//! This module provides functions for tracking feature points across video
//! frames using the pyramidal Lucas-Kanade (LK) optical flow algorithm,
//! mirroring the OpenCV `video` module API.
//!
//! # Main functions
//!
//! - [`optical_flow::build_optical_flow_pyramid`] — construct a Gaussian image
//!   pyramid (with optional spatial derivatives) suitable for LK tracking.
//! - [`optical_flow::calc_optical_flow_pyramid_lk`] — track feature points
//!   from one frame to the next using the pyramidal Lucas-Kanade method.

pub mod optical_flow;

#[cfg(feature = "simd")]
pub(crate) mod simd;

#[cfg(test)]
mod tests;

pub use optical_flow::{
    build_optical_flow_pyramid, calc_optical_flow_pyramid_lk, OpticalFlowPyramid,
    OPTFLOW_LK_GET_MIN_EIGENVALS, OPTFLOW_USE_INITIAL_FLOW,
};
