2014-05-22 17:46:02 +00:00
/* Generic video compositor plugin
* Copyright ( C ) 2008 Wim Taymans < wim @ fluendo . com >
* Copyright ( C ) 2010 Sebastian Dröge < sebastian . droege @ collabora . co . uk >
*
* This library is free software ; you can redistribute it and / or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation ; either
* version 2 of the License , or ( at your option ) any later version .
*
* This library 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
* Library General Public License for more details .
*
* You should have received a copy of the GNU Library General Public
* License along with this library ; if not , write to the
* Free Software Foundation , Inc . , 51 Franklin St , Fifth Floor ,
* Boston , MA 02110 - 1301 , USA .
*/
2017-07-06 18:26:21 +00:00
2014-05-22 17:46:02 +00:00
# ifndef __GST_COMPOSITOR_H__
# define __GST_COMPOSITOR_H__
# include <gst/gst.h>
# include <gst/video/video.h>
# include <gst/video/gstvideoaggregator.h>
2021-04-02 05:43:02 +00:00
# include <gst/base/base.h>
2014-05-22 17:46:02 +00:00
# include "blend.h"
G_BEGIN_DECLS
# define GST_TYPE_COMPOSITOR (gst_compositor_get_type())
2020-03-12 06:39:09 +00:00
G_DECLARE_FINAL_TYPE ( GstCompositor , gst_compositor , GST , COMPOSITOR ,
GstVideoAggregator )
2014-05-22 17:46:02 +00:00
2018-10-27 11:37:07 +00:00
# define GST_TYPE_COMPOSITOR_PAD (gst_compositor_pad_get_type())
2020-03-12 06:39:09 +00:00
G_DECLARE_FINAL_TYPE ( GstCompositorPad , gst_compositor_pad , GST , COMPOSITOR_PAD ,
2021-04-02 05:43:02 +00:00
GstVideoAggregatorParallelConvertPad )
2018-10-27 11:37:07 +00:00
2014-05-22 17:46:02 +00:00
/**
2018-10-27 15:44:27 +00:00
* GstCompositorBackground :
2014-05-22 17:46:02 +00:00
* @ COMPOSITOR_BACKGROUND_CHECKER : checker pattern background
* @ COMPOSITOR_BACKGROUND_BLACK : solid color black background
* @ COMPOSITOR_BACKGROUND_WHITE : solid color white background
* @ COMPOSITOR_BACKGROUND_TRANSPARENT : background is left transparent and layers are composited using " A OVER B " composition rules . This is only applicable to AYUV and ARGB ( and variants ) as it preserves the alpha channel and allows for further mixing .
*
* The different backgrounds compositor can blend over .
*/
typedef enum
{
COMPOSITOR_BACKGROUND_CHECKER ,
COMPOSITOR_BACKGROUND_BLACK ,
COMPOSITOR_BACKGROUND_WHITE ,
COMPOSITOR_BACKGROUND_TRANSPARENT ,
2017-07-06 18:26:21 +00:00
} GstCompositorBackground ;
2014-05-22 17:46:02 +00:00
2018-10-27 15:44:27 +00:00
/**
* GstCompositorOperator :
* @ COMPOSITOR_OPERATOR_SOURCE : Copy the source over the destination ,
* without the destination pixels .
* @ COMPOSITOR_OPERATOR_OVER : Blend the source over the destination .
* @ COMPOSITOR_OPERATOR_ADD : Similar to over but add the source and
* destination alpha . Requires output with alpha
* channel .
*
* The different blending operators that can be used by compositor .
*
* See https : //www.cairographics.org/operators/ for some explanation and
* visualizations .
*
*/
typedef enum
{
COMPOSITOR_OPERATOR_SOURCE ,
COMPOSITOR_OPERATOR_OVER ,
COMPOSITOR_OPERATOR_ADD ,
} GstCompositorOperator ;
2021-05-19 07:22:46 +00:00
/**
* GstCompositorSizingPolicy :
* @ COMPOSITOR_SIZING_POLICY_NONE : Scaling image without padding
* @ COMPOSITOR_SIZING_POLICY_KEEP_ASPECT_RATIO : Scaling image to fit destination
* resolution with preserving aspect ratio . Resulting image will be centered
* in the configured destination rectangle and it might have padding area
* if aspect ratio of destination rectangle is different from that of
* input image .
*
* Since : 1.20
*/
typedef enum
{
COMPOSITOR_SIZING_POLICY_NONE ,
COMPOSITOR_SIZING_POLICY_KEEP_ASPECT_RATIO ,
} GstCompositorSizingPolicy ;
2020-07-15 05:46:56 +00:00
/* copied from video-converter.c */
typedef void ( * GstParallelizedTaskFunc ) ( gpointer user_data ) ;
typedef struct _GstParallelizedTaskRunner GstParallelizedTaskRunner ;
struct _GstParallelizedTaskRunner
{
2021-04-02 05:43:02 +00:00
GstTaskPool * pool ;
gboolean own_pool ;
2020-07-15 05:46:56 +00:00
guint n_threads ;
2021-04-02 05:43:02 +00:00
GstQueueArray * tasks ;
2020-07-15 05:46:56 +00:00
GstParallelizedTaskFunc func ;
gpointer * task_data ;
GMutex lock ;
2021-04-02 05:43:02 +00:00
gint n_todo ;
gboolean async_tasks ;
2020-07-15 05:46:56 +00:00
} ;
2014-05-22 17:46:02 +00:00
/**
* GstCompositor :
*
* The opaque # GstCompositor structure .
*/
struct _GstCompositor
{
GstVideoAggregator videoaggregator ;
GstCompositorBackground background ;
2020-11-07 01:59:09 +00:00
/* Property to allow overriding the default behaviour of
* pad . width = = 0 or pad . height = = 0 : by default it means the input
* image should be left unscaled in that dimension , but it may be desirable
* to have it simply mean the image should not be composited into the output
* image , for example when animating the property .
*/
gboolean zero_size_is_unscaled ;
2021-08-03 15:51:24 +00:00
/* Max num of allowed for blending/rendering threads */
guint max_threads ;
2019-05-26 13:23:25 +00:00
/* The 'blend' compositing function does not preserve the alpha value of the
* background , while ' overlay ' does ; i . e . , COMPOSITOR_OPERATOR_ADD is the
* same as COMPOSITOR_OPERATOR_OVER when using the ' blend ' BlendFunction . */
2014-05-22 17:46:02 +00:00
BlendFunction blend , overlay ;
FillCheckerFunction fill_checker ;
FillColorFunction fill_color ;
2020-07-15 05:46:56 +00:00
2021-11-19 12:46:43 +00:00
/* pre-calculated white/black level values, YUV or RGB order depending on
* selected output format */
gint white_color [ GST_VIDEO_MAX_COMPONENTS ] ;
gint black_color [ GST_VIDEO_MAX_COMPONENTS ] ;
2020-07-15 05:46:56 +00:00
GstParallelizedTaskRunner * blend_runner ;
2014-05-22 17:46:02 +00:00
} ;
2018-10-27 11:37:07 +00:00
/**
* GstCompositorPad :
*
* The opaque # GstCompositorPad structure .
*/
struct _GstCompositorPad
{
2021-04-02 05:43:02 +00:00
GstVideoAggregatorParallelConvertPad parent ;
2018-10-27 11:37:07 +00:00
/* properties */
gint xpos , ypos ;
gint width , height ;
gdouble alpha ;
2021-05-19 07:22:46 +00:00
GstCompositorSizingPolicy sizing_policy ;
2018-10-27 11:37:07 +00:00
2018-10-27 15:44:27 +00:00
GstCompositorOperator op ;
2021-05-19 07:22:46 +00:00
/* offset values for xpos and ypos used when sizing-policy is equal to
* keep - aspect - ratio */
gint x_offset ;
gint y_offset ;
2018-10-27 11:37:07 +00:00
} ;
2021-02-11 08:58:59 +00:00
GST_ELEMENT_REGISTER_DECLARE ( compositor ) ;
2014-05-22 17:46:02 +00:00
G_END_DECLS
# endif /* __GST_COMPOSITOR_H__ */