OpenCV  4.5.5-dev
Open Source Computer Vision
Namespaces | Classes | Typedefs | Functions
cv::gapi::wip Namespace Reference

This namespace contains experimental G-API functionality, functions or structures in this namespace are subjects to change or removal in the future releases. This namespace also contains functions which API is not stabilized yet. More...

Namespaces

 draw
 
 gst
 
 onevpl
 

Classes

struct  Data
 This aggregate type represents all types which G-API can handle (via variant). More...
 
class  GAsyncCanceled
 
class  GAsyncContext
 A class to group async requests to cancel them in a single shot. More...
 
class  GCaptureSource
 OpenCV's VideoCapture-based streaming source. More...
 
class  IStreamSource
 Abstract streaming pipeline source. More...
 

Typedefs

using GStreamerPipeline = gst::GStreamerPipeline
 
using GStreamerSource = gst::GStreamerSource
 
using GVPLSource = onevpl::GSource
 

Functions

void async (GCompiled &gcmpld, std::function< void(std::exception_ptr)> &&callback, GRunArgs &&ins, GRunArgsP &&outs)
 
void async (GCompiled &gcmpld, std::function< void(std::exception_ptr)> &&callback, GRunArgs &&ins, GRunArgsP &&outs, GAsyncContext &ctx)
 
std::future< void > async (GCompiled &gcmpld, GRunArgs &&ins, GRunArgsP &&outs)
 
std::future< void > async (GCompiled &gcmpld, GRunArgs &&ins, GRunArgsP &&outs, GAsyncContext &ctx)
 
void async_apply (GComputation &gcomp, std::function< void(std::exception_ptr)> &&callback, GRunArgs &&ins, GRunArgsP &&outs, GCompileArgs &&args={})
 
void async_apply (GComputation &gcomp, std::function< void(std::exception_ptr)> &&callback, GRunArgs &&ins, GRunArgsP &&outs, GCompileArgs &&args, GAsyncContext &ctx)
 
std::future< void > async_apply (GComputation &gcomp, GRunArgs &&ins, GRunArgsP &&outs, GCompileArgs &&args={})
 
std::future< void > async_apply (GComputation &gcomp, GRunArgs &&ins, GRunArgsP &&outs, GCompileArgs &&args, GAsyncContext &ctx)
 
cv::Ptr< IStreamSourceget_streaming_source (cv::Ptr< GStreamerPipeline > &pipeline, const std::string &appsinkName, const GStreamerSource::OutputType outputType=GStreamerSource::OutputType::MAT)
 
cv::Ptr< IStreamSourcemake_capture_src (const std::string &path)
 
cv::Ptr< IStreamSourcemake_gst_src (const std::string &pipeline, const GStreamerSource::OutputType outputType=GStreamerSource::OutputType::MAT)
 
template<class... Args>
cv::Ptr< IStreamSourcemake_onevpl_src (Args &&... args)
 
template<class T , class... Args>
IStreamSource::Ptr make_src (Args &&... args)
 

Detailed Description

This namespace contains experimental G-API functionality, functions or structures in this namespace are subjects to change or removal in the future releases. This namespace also contains functions which API is not stabilized yet.

Typedef Documentation

◆ GStreamerPipeline

◆ GStreamerSource

◆ GVPLSource

Function Documentation

◆ async() [1/4]

void cv::gapi::wip::async ( GCompiled gcmpld,
std::function< void(std::exception_ptr)> &&  callback,
GRunArgs &&  ins,
GRunArgsP &&  outs 
)

These functions asynchronously (i.e. probably on a separate thread of execution) call GCompiled::operator() member function of their first argument with copies of rest of arguments (except callback) passed in. The difference between the function is the way to get the completion notification (via callback or a waiting on std::future object) If exception is occurred during execution of apply it is transferred to the callback (via function parameter) or passed to future (and will be thrown on call to std::future::get)

N.B. : Input arguments are copied on call to async function (actually on call to cv::gin) and thus do not have to outlive the actual completion of asynchronous activity. While output arguments are "captured" by reference(pointer) and therefore must outlive the asynchronous activity (i.e. live at least until callback is called or future is unblocked)

Parameters
gcmpldCompiled computation (graph) to start asynchronously
callbackCallback to be called when execution of gcmpld is done
insInput parameters for gcmpld
outsOutput parameters for gcmpld

◆ async() [2/4]

void cv::gapi::wip::async ( GCompiled gcmpld,
std::function< void(std::exception_ptr)> &&  callback,
GRunArgs &&  ins,
GRunArgsP &&  outs,
GAsyncContext ctx 
)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters
gcmpldCompiled computation (graph) to run asynchronously
callbackCallback to be called when execution of gcmpld is done
insInput parameters for gcmpld
outsOutput parameters for gcmpld
ctxContext this request belongs to
See also
async GAsyncContext

◆ async() [3/4]

std::future<void> cv::gapi::wip::async ( GCompiled gcmpld,
GRunArgs &&  ins,
GRunArgsP &&  outs 
)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters
gcmpldCompiled computation (graph) to run asynchronously
insInput parameters for gcmpld
outsOutput parameters for gcmpld
Returns
std::future<void> object to wait for completion of async operation
See also
async

◆ async() [4/4]

std::future<void> cv::gapi::wip::async ( GCompiled gcmpld,
GRunArgs &&  ins,
GRunArgsP &&  outs,
GAsyncContext ctx 
)
Parameters
gcmpldCompiled computation (graph) to run asynchronously
insInput parameters for gcmpld
outsOutput parameters for gcmpld
ctxContext this request belongs to
Returns
std::future<void> object to wait for completion of async operation
See also
async GAsyncContext

◆ async_apply() [1/4]

void cv::gapi::wip::async_apply ( GComputation gcomp,
std::function< void(std::exception_ptr)> &&  callback,
GRunArgs &&  ins,
GRunArgsP &&  outs,
GCompileArgs &&  args = {} 
)

In contrast to async() functions, these do call GComputation::apply() member function of the GComputation passed in.

Parameters
gcompComputation (graph) to run asynchronously
callbackCallback to be called when execution of gcomp is done
insInput parameters for gcomp
outsOutput parameters for gcomp
argsCompile arguments to pass to GComputation::apply()
See also
async

◆ async_apply() [2/4]

void cv::gapi::wip::async_apply ( GComputation gcomp,
std::function< void(std::exception_ptr)> &&  callback,
GRunArgs &&  ins,
GRunArgsP &&  outs,
GCompileArgs &&  args,
GAsyncContext ctx 
)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters
gcompComputation (graph) to run asynchronously
callbackCallback to be called when execution of gcomp is done
insInput parameters for gcomp
outsOutput parameters for gcomp
argsCompile arguments to pass to GComputation::apply()
ctxContext this request belongs to
See also
async_apply async GAsyncContext

◆ async_apply() [3/4]

std::future<void> cv::gapi::wip::async_apply ( GComputation gcomp,
GRunArgs &&  ins,
GRunArgsP &&  outs,
GCompileArgs &&  args = {} 
)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters
gcompComputation (graph) to run asynchronously
insInput parameters for gcomp
outsOutput parameters for gcomp
argsCompile arguments to pass to GComputation::apply()
Returns
std::future<void> object to wait for completion of async operation
See also
async_apply async

◆ async_apply() [4/4]

std::future<void> cv::gapi::wip::async_apply ( GComputation gcomp,
GRunArgs &&  ins,
GRunArgsP &&  outs,
GCompileArgs &&  args,
GAsyncContext ctx 
)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters
gcompComputation (graph) to run asynchronously
insInput parameters for gcomp
outsOutput parameters for gcomp
argsCompile arguments to pass to GComputation::apply()
ctxContext this request belongs to
Returns
std::future<void> object to wait for completion of async operation
See also
async_apply async GAsyncContext

◆ get_streaming_source()

cv::Ptr<IStreamSource> cv::gapi::wip::get_streaming_source ( cv::Ptr< GStreamerPipeline > &  pipeline,
const std::string &  appsinkName,
const GStreamerSource::OutputType  outputType = GStreamerSource::OutputType::MAT 
)
inline
Python:
cv.gapi.wip.get_streaming_source(pipeline, appsinkName[, outputType]) -> retval

◆ make_capture_src()

cv::Ptr<IStreamSource> cv::gapi::wip::make_capture_src ( const std::string &  path)
inline
Python:
cv.gapi.wip.make_capture_src(path) -> retval

◆ make_gst_src()

cv::Ptr<IStreamSource> cv::gapi::wip::make_gst_src ( const std::string &  pipeline,
const GStreamerSource::OutputType  outputType = GStreamerSource::OutputType::MAT 
)
inline
Python:
cv.gapi.wip.make_gst_src(pipeline[, outputType]) -> retval

◆ make_onevpl_src()

template<class... Args>
cv::Ptr<IStreamSource> cv::gapi::wip::make_onevpl_src ( Args &&...  args)
inline

◆ make_src()

template<class T , class... Args>
IStreamSource::Ptr cv::gapi::wip::make_src ( Args &&...  args)
inline