motioncells: rework property descriptions

This commit is contained in:
Reynaldo H. Verdejo Pinochet 2015-12-27 21:11:18 -08:00
parent c788678059
commit 8f3392ba44

View file

@ -204,52 +204,55 @@ gst_motion_cells_class_init (GstMotioncellsClass * klass)
g_object_class_install_property (gobject_class, PROP_GRID_X,
g_param_spec_int ("gridx", "Number of Horizontal Grids",
"You can give number of horizontal grid cells.", GRID_MIN, GRID_MAX,
"Number of horizontal grid cells.", GRID_MIN, GRID_MAX,
GRID_DEF,
(GParamFlags) (G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)));
g_object_class_install_property (gobject_class, PROP_GRID_Y,
g_param_spec_int ("gridy", "Number of Vertical Grids",
"You can give number of vertical grid cells.", GRID_MIN, GRID_MAX,
"Number of vertical grid cells.", GRID_MIN, GRID_MAX,
GRID_DEF,
(GParamFlags) (G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)));
g_object_class_install_property (gobject_class, PROP_SENSITIVITY,
g_param_spec_double ("sensitivity", "Motion Sensitivity",
"You can tunning the element motion sensitivity.", SENSITIVITY_MIN,
"Motion detection sensitivity.", SENSITIVITY_MIN,
SENSITIVITY_MAX, SENSITIVITY_DEFAULT,
(GParamFlags) (G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)));
g_object_class_install_property (gobject_class, PROP_THRESHOLD,
g_param_spec_double ("threshold", "Lower bound of motion cells number",
"Threshold value for motion, when motion cells number greater sum cells * threshold, we show motion.",
"Threshold value for motion. Filter detects motion when at least "
"this fraction of the cells have moved",
THRESHOLD_MIN, THRESHOLD_MAX, THRESHOLD_DEFAULT,
(GParamFlags) (G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)));
g_object_class_install_property (gobject_class, PROP_GAP,
g_param_spec_int ("gap",
"Gap is time in second, elapsed time from last motion timestamp. ",
"If elapsed time minus form last motion timestamp is greater or equal than gap then we post motion finished bus message. ",
g_param_spec_int ("gap", "Motion-finished Threshold",
"Interval in seconds after which motion is considered finished "
"and a motion finished bus message is posted.",
GAP_MIN, GAP_MAX, GAP_DEF,
(GParamFlags) (G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)));
g_object_class_install_property (gobject_class, PROP_POSTNOMOTION,
g_param_spec_int ("postnomotion", "POSTNOMOTION",
"If non 0 post a no_motion event is posted on the bus if no motion is detected for N seconds",
g_param_spec_int ("postnomotion", "No-motion Threshold",
"If non 0, post a no_motion event on the bus if no motion is "
"detected for the given number of seconds",
POST_NO_MOTION_MIN, POST_NO_MOTION_MAX, POST_NO_MOTION_DEF,
(GParamFlags) (G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)));
g_object_class_install_property (gobject_class, PROP_MINIMUNMOTIONFRAMES,
g_param_spec_int ("minimummotionframes", "MINIMUN MOTION FRAMES",
"Define the minimum number of motion frames that trigger a motion event",
g_param_spec_int ("minimummotionframes", "Minimum Motion Frames",
"Minimum number of motion frames triggering a motion event",
MINIMUM_MOTION_FRAMES_MIN, MINIMUM_MOTION_FRAMES_MAX,
MINIMUM_MOTION_FRAMES_DEF,
(GParamFlags) (G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)));
g_object_class_install_property (gobject_class, PROP_DISPLAY,
g_param_spec_boolean ("display", "Display",
"Motion Cells visible or not on Current Frame", FALSE,
"Toggle display of motion cells on current frame", FALSE,
(GParamFlags) (G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)));
g_object_class_install_property (gobject_class, PROP_POSTALLMOTION,
g_param_spec_boolean ("postallmotion", "Post All Motion",
"Element post bus msg for every motion frame or just motion start and motion stop",
"Post bus messages for every motion frame or just motion start and "
"motion stop",
FALSE, (GParamFlags) (G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)));
g_object_class_install_property (gobject_class, PROP_USEALPHA,
g_param_spec_boolean ("usealpha", "Use alpha",
"Use or not alpha blending on frames with motion cells", TRUE,
"Toggle usage of alpha blending on frames with motion cells", TRUE,
(GParamFlags) (G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)));
#if 0
/* FIXME: should not be a long property, make it either gint or gint64
@ -269,31 +272,33 @@ gst_motion_cells_class_init (GstMotioncellsClass * klass)
(GParamFlags) (G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)));
g_object_class_install_property (gobject_class, PROP_MOTIONMASKCOORD,
g_param_spec_string ("motionmaskcoords", "Motion Mask with Coordinates",
"The upper left x, y and lower right x, y coordinates separated with \":\", "
"describe a region. Regions separated with \",\"", NULL,
"Describe a region with its upper left and lower right x, y "
"coordinates separated with \":\". Pass multiple regions as a "
"comma-separated list", NULL,
(GParamFlags) (G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)));
g_object_class_install_property (gobject_class, PROP_MOTIONMASKCELLSPOS,
g_param_spec_string ("motionmaskcellspos",
"Motion Mask with Cells Position",
"The line and column idx separated with \":\" what cells want we mask-out, "
"describe a cell. Cells separated with \",\"", NULL,
"Describe a cell with its line and column idx separated with \":\". "
"Pass multiple cells as a comma-separated list", NULL,
(GParamFlags) (G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)));
g_object_class_install_property (gobject_class, PROP_CELLSCOLOR,
g_param_spec_string ("cellscolor", "Color of Motion Cells",
"The color of motion cells separated with \",\"", "255,255,0",
"Color for motion cells in R,G,B format. Max per channel is 255",
"255,255,0",
(GParamFlags) (G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)));
g_object_class_install_property (gobject_class, PROP_MOTIONCELLSIDX,
g_param_spec_string ("motioncellsidx", "Motion Cells Of Interest(MOCI)",
"The line and column idx separated with \":\", "
"describe a cell. Cells separated with \",\"", NULL,
"Describe a cell with its line and column idx separated with \":\". "
"Pass multiple cells as a comma-separated list", NULL,
(GParamFlags) (G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)));
g_object_class_install_property (gobject_class, PROP_CALCULATEMOTION,
g_param_spec_boolean ("calculatemotion", "Calculate Motion",
"If needs calculate motion on frame you need this property setting true otherwise false",
"Toggles motion calculation. If FALSE, this filter does nothing",
TRUE, (GParamFlags) (G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)));
g_object_class_install_property (gobject_class, PROP_MOTIONCELLTHICKNESS,
g_param_spec_int ("motioncellthickness", "Motion Cell Thickness",
"Motion Cell Border Thickness, if it's -1 then motion cell will be fill",
"Motion Cell Border Thickness. Set to -1 to fill motion cell",
THICKNESS_MIN, THICKNESS_MAX, THICKNESS_DEF,
(GParamFlags) (G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)));