2 * Copyright (C) <1999> Erik Walthinsen <omega@cse.ogi.edu>
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Library General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Library General Public License for more details.
14 * You should have received a copy of the GNU Library General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
24 #include <gst/base/gstbasetransform.h>
25 #include <gst/video/video.h>
29 #define GST_TYPE_VIDEO_BOX \
30 (gst_video_box_get_type())
31 #define GST_VIDEO_BOX(obj) \
32 (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_VIDEO_BOX,GstVideoBox))
33 #define GST_VIDEO_BOX_CLASS(klass) \
34 (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_VIDEO_BOX,GstVideoBoxClass))
35 #define GST_IS_VIDEO_BOX(obj) \
36 (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_VIDEO_BOX))
37 #define GST_IS_VIDEO_BOX_CLASS(obj) \
38 (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_VIDEO_BOX))
40 typedef struct _GstVideoBox GstVideoBox;
41 typedef struct _GstVideoBoxClass GstVideoBoxClass;
53 GstBaseTransform element;
56 gint in_width, in_height;
57 gint out_width, out_height;
59 gint box_left, box_right, box_top, box_bottom;
61 gint border_left, border_right, border_top, border_bottom;
62 gint crop_left, crop_right, crop_top, crop_bottom;
68 GstVideoBoxFill fill_type;
71 struct _GstVideoBoxClass
73 GstBaseTransformClass parent_class;
76 /* elementfactory information */
77 static GstElementDetails gst_video_box_details =
78 GST_ELEMENT_DETAILS ("video box filter",
79 "Filter/Effect/Video",
80 "Resizes a video by adding borders or cropping",
81 "Wim Taymans <wim@fluendo.com>");
84 #define DEFAULT_LEFT 0
85 #define DEFAULT_RIGHT 0
87 #define DEFAULT_BOTTOM 0
88 #define DEFAULT_FILL_TYPE VIDEO_BOX_FILL_BLACK
89 #define DEFAULT_ALPHA 1.0
90 #define DEFAULT_BORDER_ALPHA 1.0
105 static GstStaticPadTemplate gst_video_box_src_template =
106 GST_STATIC_PAD_TEMPLATE ("src",
109 GST_STATIC_CAPS (GST_VIDEO_CAPS_YUV ("{ I420, AYUV }"))
112 static GstStaticPadTemplate gst_video_box_sink_template =
113 GST_STATIC_PAD_TEMPLATE ("sink",
116 GST_STATIC_CAPS (GST_VIDEO_CAPS_YUV ("I420"))
120 GST_BOILERPLATE (GstVideoBox, gst_video_box, GstBaseTransform,
121 GST_TYPE_BASE_TRANSFORM);
123 static void gst_video_box_set_property (GObject * object, guint prop_id,
124 const GValue * value, GParamSpec * pspec);
125 static void gst_video_box_get_property (GObject * object, guint prop_id,
126 GValue * value, GParamSpec * pspec);
128 static GstCaps *gst_video_box_transform_caps (GstBaseTransform * trans,
129 GstPad * pad, GstCaps * from);
130 static gboolean gst_video_box_set_caps (GstBaseTransform * trans,
131 GstCaps * in, GstCaps * out);
132 static GstFlowReturn gst_video_box_transform (GstBaseTransform * trans,
133 GstBuffer * in, GstBuffer ** out);
136 #define GST_TYPE_VIDEO_BOX_FILL (gst_video_box_fill_get_type())
138 gst_video_box_fill_get_type (void)
140 static GType video_box_fill_type = 0;
141 static GEnumValue video_box_fill[] = {
142 {VIDEO_BOX_FILL_BLACK, "0", "Black"},
143 {VIDEO_BOX_FILL_GREEN, "1", "Colorkey green"},
144 {VIDEO_BOX_FILL_BLUE, "2", "Colorkey blue"},
148 if (!video_box_fill_type) {
149 video_box_fill_type =
150 g_enum_register_static ("GstVideoBoxFill", video_box_fill);
152 return video_box_fill_type;
157 gst_video_box_base_init (gpointer g_class)
159 GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
161 gst_element_class_set_details (element_class, &gst_video_box_details);
163 gst_element_class_add_pad_template (element_class,
164 gst_static_pad_template_get (&gst_video_box_sink_template));
165 gst_element_class_add_pad_template (element_class,
166 gst_static_pad_template_get (&gst_video_box_src_template));
170 gst_video_box_class_init (GstVideoBoxClass * klass)
172 GObjectClass *gobject_class;
173 GstBaseTransformClass *trans_class;
175 gobject_class = (GObjectClass *) klass;
176 trans_class = (GstBaseTransformClass *) klass;
178 gobject_class->set_property = gst_video_box_set_property;
179 gobject_class->get_property = gst_video_box_get_property;
181 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_FILL_TYPE,
182 g_param_spec_enum ("fill", "Fill", "How to fill the borders",
183 GST_TYPE_VIDEO_BOX_FILL, DEFAULT_FILL_TYPE,
184 (GParamFlags) G_PARAM_READWRITE));
185 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_LEFT,
186 g_param_spec_int ("left", "Left",
187 "Pixels to box at left (<0 = add a border)", G_MININT, G_MAXINT,
188 DEFAULT_LEFT, G_PARAM_READWRITE));
189 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_RIGHT,
190 g_param_spec_int ("right", "Right",
191 "Pixels to box at right (<0 = add a border)", G_MININT, G_MAXINT,
192 DEFAULT_RIGHT, G_PARAM_READWRITE));
193 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_TOP,
194 g_param_spec_int ("top", "Top",
195 "Pixels to box at top (<0 = add a border)", G_MININT, G_MAXINT,
196 DEFAULT_TOP, G_PARAM_READWRITE));
197 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_BOTTOM,
198 g_param_spec_int ("bottom", "Bottom",
199 "Pixels to box at bottom (<0 = add a border)", G_MININT, G_MAXINT,
200 DEFAULT_BOTTOM, G_PARAM_READWRITE));
201 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_ALPHA,
202 g_param_spec_double ("alpha", "Alpha", "Alpha value picture", 0.0, 1.0,
203 DEFAULT_ALPHA, G_PARAM_READWRITE));
204 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_BORDER_ALPHA,
205 g_param_spec_double ("border_alpha", "Border Alpha",
206 "Alpha value of the border", 0.0, 1.0, DEFAULT_BORDER_ALPHA,
209 trans_class->transform_caps = gst_video_box_transform_caps;
210 trans_class->set_caps = gst_video_box_set_caps;
211 trans_class->transform = gst_video_box_transform;
215 gst_video_box_init (GstVideoBox * video_box)
217 video_box->box_right = DEFAULT_RIGHT;
218 video_box->box_left = DEFAULT_LEFT;
219 video_box->box_top = DEFAULT_TOP;
220 video_box->box_bottom = DEFAULT_BOTTOM;
221 video_box->fill_type = DEFAULT_FILL_TYPE;
222 video_box->alpha = DEFAULT_ALPHA;
223 video_box->border_alpha = DEFAULT_BORDER_ALPHA;
226 /* do we need this function? */
228 gst_video_box_set_property (GObject * object, guint prop_id,
229 const GValue * value, GParamSpec * pspec)
231 GstVideoBox *video_box = GST_VIDEO_BOX (object);
235 video_box->box_left = g_value_get_int (value);
236 if (video_box->box_left < 0) {
237 video_box->border_left = -video_box->box_left;
238 video_box->crop_left = 0;
240 video_box->border_left = 0;
241 video_box->crop_left = video_box->box_left;
245 video_box->box_right = g_value_get_int (value);
246 if (video_box->box_right < 0) {
247 video_box->border_right = -video_box->box_right;
248 video_box->crop_right = 0;
250 video_box->border_right = 0;
251 video_box->crop_right = video_box->box_right;
255 video_box->box_top = g_value_get_int (value);
256 if (video_box->box_top < 0) {
257 video_box->border_top = -video_box->box_top;
258 video_box->crop_top = 0;
260 video_box->border_top = 0;
261 video_box->crop_top = video_box->box_top;
265 video_box->box_bottom = g_value_get_int (value);
266 if (video_box->box_bottom < 0) {
267 video_box->border_bottom = -video_box->box_bottom;
268 video_box->crop_bottom = 0;
270 video_box->border_bottom = 0;
271 video_box->crop_bottom = video_box->box_bottom;
275 video_box->fill_type = g_value_get_enum (value);
278 video_box->alpha = g_value_get_double (value);
280 case PROP_BORDER_ALPHA:
281 video_box->border_alpha = g_value_get_double (value);
284 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
289 gst_video_box_get_property (GObject * object, guint prop_id, GValue * value,
292 GstVideoBox *video_box = GST_VIDEO_BOX (object);
296 g_value_set_int (value, video_box->box_left);
299 g_value_set_int (value, video_box->box_right);
302 g_value_set_int (value, video_box->box_top);
305 g_value_set_int (value, video_box->box_bottom);
308 g_value_set_enum (value, video_box->fill_type);
311 g_value_set_double (value, video_box->alpha);
313 case PROP_BORDER_ALPHA:
314 g_value_set_double (value, video_box->border_alpha);
317 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
323 gst_video_box_transform_caps (GstBaseTransform * trans, GstPad * pad,
326 GstVideoBox *video_box;
328 GstStructure *structure;
329 gint direction, i, tmp;
331 video_box = GST_VIDEO_BOX (trans);
332 to = gst_caps_copy (from);
333 direction = (pad == trans->sinkpad) ? 1 : -1;
335 for (i = 0; i < gst_caps_get_size (to); i++) {
336 structure = gst_caps_get_structure (to, i);
337 if (gst_structure_get_int (structure, "width", &tmp))
338 gst_structure_set (structure, "width", G_TYPE_INT,
339 tmp + direction * (video_box->box_left + video_box->box_right), NULL);
340 if (gst_structure_get_int (structure, "height", &tmp))
341 gst_structure_set (structure, "height", G_TYPE_INT,
342 tmp + direction * (video_box->box_top + video_box->box_bottom), NULL);
349 gst_video_box_set_caps (GstBaseTransform * trans, GstCaps * in, GstCaps * out)
351 GstVideoBox *video_box;
352 GstStructure *structure;
355 video_box = GST_VIDEO_BOX (trans);
357 structure = gst_caps_get_structure (in, 0);
358 ret = gst_structure_get_int (structure, "width", &video_box->in_width);
359 ret &= gst_structure_get_int (structure, "height", &video_box->in_height);
361 structure = gst_caps_get_structure (out, 0);
362 ret &= gst_structure_get_int (structure, "width", &video_box->out_width);
363 ret &= gst_structure_get_int (structure, "height", &video_box->out_height);
368 #define ROUND_UP_2(x) (((x)+1)&~1)
369 #define ROUND_UP_4(x) (((x)+3)&~3)
370 #define ROUND_UP_8(x) (((x)+7)&~7)
372 /* see gst-plugins/gst/games/gstvideoimage.c, paint_setup_I420() */
373 #define GST_VIDEO_I420_Y_ROWSTRIDE(width) (ROUND_UP_4(width))
374 #define GST_VIDEO_I420_U_ROWSTRIDE(width) (ROUND_UP_8(width)/2)
375 #define GST_VIDEO_I420_V_ROWSTRIDE(width) ((ROUND_UP_8(GST_VIDEO_I420_Y_ROWSTRIDE(width)))/2)
377 #define GST_VIDEO_I420_Y_OFFSET(w,h) (0)
378 #define GST_VIDEO_I420_U_OFFSET(w,h) (GST_VIDEO_I420_Y_OFFSET(w,h)+(GST_VIDEO_I420_Y_ROWSTRIDE(w)*ROUND_UP_2(h)))
379 #define GST_VIDEO_I420_V_OFFSET(w,h) (GST_VIDEO_I420_U_OFFSET(w,h)+(GST_VIDEO_I420_U_ROWSTRIDE(w)*ROUND_UP_2(h)/2))
381 #define GST_VIDEO_I420_SIZE(w,h) (GST_VIDEO_I420_V_OFFSET(w,h)+(GST_VIDEO_I420_V_ROWSTRIDE(w)*ROUND_UP_2(h)/2))
383 static int yuv_colors_Y[] = { 16, 150, 29 };
384 static int yuv_colors_U[] = { 128, 46, 255 };
385 static int yuv_colors_V[] = { 128, 21, 107 };
388 gst_video_box_copy_plane_i420 (GstVideoBox * video_box, guint8 * src,
389 guint8 * dest, gint br, gint bl, gint bt, gint bb, gint src_crop_width,
390 gint src_crop_height, gint src_stride, gint dest_width, gint dest_stride,
396 for (j = 0; j < bt; j++) {
397 memset (dest, fill_color, dest_width);
401 /* copy and add left and right border */
402 for (j = 0; j < src_crop_height; j++) {
403 memset (dest, fill_color, bl);
404 memcpy (dest + bl, src, src_crop_width);
405 memset (dest + bl + src_crop_width, fill_color, br);
411 for (j = 0; j < bb; j++) {
412 memset (dest, fill_color, dest_width);
418 gst_video_box_i420 (GstVideoBox * video_box, guint8 * src, guint8 * dest)
420 guint8 *srcY, *srcU, *srcV;
421 guint8 *destY, *destU, *destV;
422 gint crop_width, crop_height;
423 gint out_width, out_height;
424 gint src_width, src_height;
425 gint src_stride, dest_stride;
428 br = video_box->border_right;
429 bl = video_box->border_left;
430 bt = video_box->border_top;
431 bb = video_box->border_bottom;
433 out_width = video_box->out_width;
434 out_height = video_box->out_height;
436 src_width = video_box->in_width;
437 src_height = video_box->in_height;
439 crop_width = src_width - (video_box->crop_left + video_box->crop_right);
440 crop_height = src_height - (video_box->crop_top + video_box->crop_bottom);
443 src_stride = GST_VIDEO_I420_Y_ROWSTRIDE (src_width);
444 dest_stride = GST_VIDEO_I420_Y_ROWSTRIDE (out_width);
446 destY = dest + GST_VIDEO_I420_Y_OFFSET (out_width, out_height);
448 srcY = src + GST_VIDEO_I420_Y_OFFSET (src_width, src_height);
449 srcY += src_stride * video_box->crop_top + video_box->crop_left;
451 gst_video_box_copy_plane_i420 (video_box, srcY, destY, br, bl, bt, bb,
452 crop_width, crop_height, src_stride, out_width, dest_stride,
453 yuv_colors_Y[video_box->fill_type]);
456 src_stride = GST_VIDEO_I420_U_ROWSTRIDE (src_width);
457 dest_stride = GST_VIDEO_I420_U_ROWSTRIDE (out_width);
459 destU = dest + GST_VIDEO_I420_U_OFFSET (out_width, out_height);
461 srcU = src + GST_VIDEO_I420_U_OFFSET (src_width, src_height);
462 srcU += src_stride * (video_box->crop_top / 2) + (video_box->crop_left / 2);
464 gst_video_box_copy_plane_i420 (video_box, srcU, destU, br / 2, bl / 2, bt / 2,
465 bb / 2, crop_width / 2, crop_height / 2, src_stride, out_width / 2,
466 dest_stride, yuv_colors_U[video_box->fill_type]);
469 src_stride = GST_VIDEO_I420_V_ROWSTRIDE (src_width);
470 dest_stride = GST_VIDEO_I420_V_ROWSTRIDE (out_width);
472 destV = dest + GST_VIDEO_I420_V_OFFSET (out_width, out_height);
474 srcV = src + GST_VIDEO_I420_V_OFFSET (src_width, src_height);
475 srcV += src_stride * (video_box->crop_top / 2) + (video_box->crop_left / 2);
477 gst_video_box_copy_plane_i420 (video_box, srcV, destV, br / 2, bl / 2, bt / 2,
478 bb / 2, crop_width / 2, crop_height / 2, src_stride, out_width / 2,
479 dest_stride, yuv_colors_V[video_box->fill_type]);
482 /* Note the source image is always I420, we
483 * are converting to AYUV on the fly here */
486 gst_video_box_ayuv (GstVideoBox * video_box, guint8 * src, guint8 * dest)
488 guint8 *srcY, *srcU, *srcV;
489 gint crop_width, crop_width2, crop_height;
490 gint out_width, out_height;
491 gint src_stride, src_stride2;
493 gint colorY, colorU, colorV;
495 guint8 b_alpha = (guint8) (video_box->border_alpha * 255);
496 guint8 i_alpha = (guint8) (video_box->alpha * 255);
497 guint32 *destp = (guint32 *) dest;
500 br = video_box->border_right;
501 bl = video_box->border_left;
502 bt = video_box->border_top;
503 bb = video_box->border_bottom;
505 out_width = video_box->out_width;
506 out_height = video_box->out_height;
508 src_stride = GST_VIDEO_I420_Y_ROWSTRIDE (video_box->in_width);
509 src_stride2 = src_stride / 2;
512 video_box->in_width - (video_box->crop_left + video_box->crop_right);
513 crop_width2 = crop_width / 2;
515 video_box->in_height - (video_box->crop_top + video_box->crop_bottom);
518 src + GST_VIDEO_I420_Y_OFFSET (video_box->in_width, video_box->in_height);
519 srcY += src_stride * video_box->crop_top + video_box->crop_left;
521 src + GST_VIDEO_I420_U_OFFSET (video_box->in_width, video_box->in_height);
522 srcU += src_stride2 * (video_box->crop_top / 2) + (video_box->crop_left / 2);
524 src + GST_VIDEO_I420_V_OFFSET (video_box->in_width, video_box->in_height);
525 srcV += src_stride2 * (video_box->crop_top / 2) + (video_box->crop_left / 2);
527 colorY = yuv_colors_Y[video_box->fill_type];
528 colorU = yuv_colors_U[video_box->fill_type];
529 colorV = yuv_colors_V[video_box->fill_type];
532 GUINT32_FROM_BE ((b_alpha << 24) | (colorY << 16) | (colorU << 8) |
536 for (i = 0; i < bt; i++) {
537 for (j = 0; j < out_width; j++) {
541 for (i = 0; i < crop_height; i++) {
543 for (j = 0; j < bl; j++) {
546 dest = (guint8 *) destp;
548 for (j = 0; j < crop_width2; j++) {
562 srcU += src_stride2 - crop_width2;
563 srcV += src_stride2 - crop_width2;
565 srcY += src_stride - crop_width;
567 destp = (guint32 *) dest;
569 for (j = 0; j < br; j++) {
574 for (i = 0; i < bb; i++) {
575 for (j = 0; j < out_width; j++) {
582 gst_video_box_transform (GstBaseTransform * trans, GstBuffer * in,
585 GstVideoBox *video_box;
588 video_box = GST_VIDEO_BOX (trans);
590 if (video_box->use_alpha) {
591 ret = gst_pad_alloc_buffer (trans->srcpad,
592 GST_BUFFER_OFFSET_NONE,
593 video_box->out_height * video_box->out_height * 4,
594 GST_PAD_CAPS (trans->srcpad), out);
595 if (ret != GST_FLOW_OK)
598 gst_video_box_ayuv (video_box,
599 GST_BUFFER_DATA (in), GST_BUFFER_DATA (*out));
601 ret = gst_pad_alloc_buffer (trans->srcpad,
602 GST_BUFFER_OFFSET_NONE,
603 GST_VIDEO_I420_SIZE (video_box->out_width, video_box->out_height),
604 GST_PAD_CAPS (trans->srcpad), out);
605 if (ret != GST_FLOW_OK)
608 gst_video_box_i420 (video_box,
609 GST_BUFFER_DATA (in), GST_BUFFER_DATA (*out));
612 gst_buffer_stamp (*out, in);
615 gst_buffer_unref (in);
620 plugin_init (GstPlugin * plugin)
622 return gst_element_register (plugin, "videobox", GST_RANK_NONE,
626 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
629 "resizes a video by adding borders or cropping",
630 plugin_init, VERSION, GST_LICENSE, GST_PACKAGE, GST_ORIGIN)