1
0
mirror of https://github.com/opencv/opencv.git synced 2026-07-31 00:03:03 +04:00

videoio(doc): add 'videoio_hwaccel' group, fix typos

This commit is contained in:
Alexander Alekhin
2021-03-07 04:19:26 +00:00
parent be24659c03
commit 4287961aed
5 changed files with 55 additions and 9 deletions
@@ -3,7 +3,7 @@ Video I/O with OpenCV Overview {#videoio_overview}
### See also:
- @ref videoio "Video I/O Code Reference"
- Tutorials: @ref tutorial_table_of_content_videoio
- Tutorials: @ref tutorial_table_of_content_app
General Information
===================
@@ -15,7 +15,7 @@ I/O APIs used as backend.
![Video I/O with OpenCV](pics/videoio_overview.svg)
Some backends such as (DSHOW) Direct Show, Microsoft Media Foundation (MSMF),
Some backends such as Direct Show (DSHOW), Microsoft Media Foundation (MSMF),
Video 4 Linux (V4L), etc... are interfaces to the video I/O library provided by the operating system.
Some others backends like OpenNI2 for Kinect, Intel Perceptual Computing SDK, GStreamer,
@@ -90,7 +90,7 @@ The FFmpeg library
OpenCV can use the FFmpeg library (http://ffmpeg.org/) as backend to record, convert and stream audio and video.
FFmpeg is a complete, cross-reference solution. If you enable FFmpeg while configuring OpenCV than
CMake will download and install the binaries in `OPENCV_SOURCE_CODE/3rdparty/ffmpeg/`. To use
FFmpeg at runtime, you must deploy the FFMepg binaries with your application.
FFmpeg at runtime, you must deploy the FFmpeg binaries with your application.
@note FFmpeg is licensed under the GNU Lesser General Public License (LGPL) version 2.1 or later.
See `OPENCV_SOURCE_CODE/3rdparty/ffmpeg/readme.txt` and http://ffmpeg.org/legal.html for details and
+16 -4
View File
@@ -52,10 +52,11 @@
### See also:
- @ref videoio_overview
- Tutorials: @ref tutorial_table_of_content_videoio
- Tutorials: @ref tutorial_table_of_content_app
@{
@defgroup videoio_flags_base Flags for video I/O
@defgroup videoio_flags_others Additional flags for video I/O API backends
@defgroup videoio_hwaccel Hardware-accelerated video decoding and encoding
@defgroup videoio_c C API for video I/O
@defgroup videoio_ios iOS glue for video I/O
@defgroup videoio_winrt WinRT glue for video I/O
@@ -211,6 +212,10 @@ enum VideoWriterProperties {
//! @addtogroup videoio_flags_others
//! @{
/** @name Hardware acceleration support
@{
*/
/** @brief Video Acceleration type
*
* Used as value in #CAP_PROP_HW_ACCELERATION and #VIDEOWRITER_PROP_HW_ACCELERATION
@@ -231,6 +236,8 @@ enum VideoAccelerationType
VIDEO_ACCELERATION_MFX = 4, //!< libmfx (Intel MediaSDK/oneVPL)
};
//! @} Hardware acceleration support
/** @name IEEE 1394 drivers
@{
*/
@@ -521,8 +528,9 @@ enum { CAP_PROP_XI_DOWNSAMPLING = 400, //!< Chan
//! @} XIMEA
/** @name XIMEA Camera API
* @{
/** @name ARAVIS Camera API
@{
*/
//! Properties of cameras available through ARAVIS backend
@@ -532,7 +540,6 @@ enum { CAP_PROP_ARAVIS_AUTOTRIGGER = 600 //!< Autom
//! @} ARAVIS
/** @name AVFoundation framework for iOS
OS X Lion will have the same API
@{
*/
@@ -544,6 +551,9 @@ enum { CAP_PROP_IOS_DEVICE_FOCUS = 9001,
CAP_PROP_IOS_DEVICE_TORCH = 9005
};
//! @} AVFoundation framework for iOS
/** @name Smartek Giganetix GigEVisionSDK
@{
*/
@@ -1089,8 +1099,10 @@ protected:
Size frameSize, bool isColor = true);
};
//! @cond IGNORED
template<> struct DefaultDeleter<CvCapture>{ CV_EXPORTS void operator ()(CvCapture* obj) const; };
template<> struct DefaultDeleter<CvVideoWriter>{ CV_EXPORTS void operator ()(CvVideoWriter* obj) const; };
//! @endcond IGNORED
//! @} videoio
@@ -0,0 +1,34 @@
// This file is part of OpenCV project.
// It is subject to the license terms in the LICENSE file found in the top-level directory
// of this distribution and at http://opencv.org/license.html.
//
// This file should not be used with compiler (documentation only)
//
namespace cv {
/** @addtogroup videoio_hwaccel
This section contains information about API to control Hardware-accelerated video decoding and encoding.
@note Check [Wiki page](https://github.com/opencv/opencv/wiki/Video-IO-hardware-acceleration)
for description of supported hardware / software configurations and available benchmarks
cv::VideoCapture properties:
- #CAP_PROP_HW_ACCELERATION (as #VideoAccelerationType)
- #CAP_PROP_HW_DEVICE
cv::VideoWriter properties:
- #VIDEOWRITER_PROP_HW_ACCELERATION (as #VideoAccelerationType)
- #VIDEOWRITER_PROP_HW_DEVICE
Properties are supported by these backends:
- #CAP_FFMPEG
- #CAP_GSTREAMER
- #CAP_MSMF (Windows)
@{
*/
/** @} */
} // namespace