sys/v4l2/gstv4l2src.c

   1 /* GStreamer
   2  *
   3  * Copyright (C) 2001-2002 Ronald Bultje <rbultje@ronald.bitfreak.net>
   4  *               2006 Edgard Lima <edgard.lima@gmail.com>
   5  *
   6  * gstv4l2src.c: Video4Linux2 source element
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Library General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Library General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Library General Public
  19  * License along with this library; if not, write to the
  20  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  21  * Boston, MA 02110-1301, USA.
  22  */
  23
  24 /**
  25  * SECTION:element-v4l2src
  26  *
  27  * v4l2src can be used to capture video from v4l2 devices, like webcams and tv
  28  * cards.
  29  *
  30  * <refsect2>
  31  * <title>Example launch lines</title>
  32  * |[
  33  * gst-launch-1.0 v4l2src ! xvimagesink
  34  * ]| This pipeline shows the video captured from /dev/video0 tv card and for
  35  * webcams.
  36  * |[
  37  * gst-launch-1.0 v4l2src ! jpegdec ! xvimagesink
  38  * ]| This pipeline shows the video captured from a webcam that delivers jpeg
  39  * images.
  40  * </refsect2>
  41  *
  42  * Since 1.14, the use of libv4l2 has been disabled due to major bugs in the
  43  * emulation layer. To enable usage of this library, set the environment
  44  * variable GST_V4L2_USE_LIBV4L2=1.
  45  */
  46
  47 #ifdef HAVE_CONFIG_H
  48 #include <config.h>
  49 #endif
  50
  51 #include <string.h>
  52 #include <sys/time.h>
  53 #include <unistd.h>
  54
  55 #include <gst/video/gstvideometa.h>
  56 #include <gst/video/gstvideopool.h>
  57
  58 #include "gstv4l2src.h"
  59
  60 #include "gstv4l2colorbalance.h"
  61 #include "gstv4l2tuner.h"
  62 #include "gstv4l2vidorient.h"
  63
  64 #include "gst/gst-i18n-plugin.h"
  65
  66 GST_DEBUG_CATEGORY (v4l2src_debug);
  67 #define GST_CAT_DEFAULT v4l2src_debug
  68
  69 #define DEFAULT_PROP_DEVICE   "/dev/video0"
  70
  71 enum
  72 {
  73   PROP_0,
  74   V4L2_STD_OBJECT_PROPS,
  75   PROP_LAST
  76 };
  77
  78 /* signals and args */
  79 enum
  80 {
  81   SIGNAL_PRE_SET_FORMAT,
  82   LAST_SIGNAL
  83 };
  84
  85 static guint gst_v4l2_signals[LAST_SIGNAL] = { 0 };
  86
  87 GST_IMPLEMENT_V4L2_COLOR_BALANCE_METHODS (GstV4l2Src, gst_v4l2src);
  88 GST_IMPLEMENT_V4L2_TUNER_METHODS (GstV4l2Src, gst_v4l2src);
  89 GST_IMPLEMENT_V4L2_VIDORIENT_METHODS (GstV4l2Src, gst_v4l2src);
  90
  91 static void gst_v4l2src_uri_handler_init (gpointer g_iface,
  92     gpointer iface_data);
  93
  94 #define gst_v4l2src_parent_class parent_class
  95 G_DEFINE_TYPE_WITH_CODE (GstV4l2Src, gst_v4l2src, GST_TYPE_PUSH_SRC,
  96     G_IMPLEMENT_INTERFACE (GST_TYPE_URI_HANDLER, gst_v4l2src_uri_handler_init);
  97     G_IMPLEMENT_INTERFACE (GST_TYPE_TUNER, gst_v4l2src_tuner_interface_init);
  98     G_IMPLEMENT_INTERFACE (GST_TYPE_COLOR_BALANCE,
  99         gst_v4l2src_color_balance_interface_init);
 100     G_IMPLEMENT_INTERFACE (GST_TYPE_VIDEO_ORIENTATION,
 101         gst_v4l2src_video_orientation_interface_init));
 102
 103 static void gst_v4l2src_finalize (GstV4l2Src * v4l2src);
 104
 105 /* element methods */
 106 static GstStateChangeReturn gst_v4l2src_change_state (GstElement * element,
 107     GstStateChange transition);
 108
 109 /* basesrc methods */
 110 static gboolean gst_v4l2src_start (GstBaseSrc * src);
 111 static gboolean gst_v4l2src_unlock (GstBaseSrc * src);
 112 static gboolean gst_v4l2src_unlock_stop (GstBaseSrc * src);
 113 static gboolean gst_v4l2src_stop (GstBaseSrc * src);
 114 static GstCaps *gst_v4l2src_get_caps (GstBaseSrc * src, GstCaps * filter);
 115 static gboolean gst_v4l2src_query (GstBaseSrc * bsrc, GstQuery * query);
 116 static gboolean gst_v4l2src_decide_allocation (GstBaseSrc * src,
 117     GstQuery * query);
 118 static GstFlowReturn gst_v4l2src_create (GstPushSrc * src, GstBuffer ** out);
 119 static GstCaps *gst_v4l2src_fixate (GstBaseSrc * basesrc, GstCaps * caps,
 120     GstStructure * pref_s);
 121 static gboolean gst_v4l2src_negotiate (GstBaseSrc * basesrc);
 122
 123 static void gst_v4l2src_set_property (GObject * object, guint prop_id,
 124     const GValue * value, GParamSpec * pspec);
 125 static void gst_v4l2src_get_property (GObject * object, guint prop_id,
 126     GValue * value, GParamSpec * pspec);
 127
 128 static void
 129 gst_v4l2src_class_init (GstV4l2SrcClass * klass)
 130 {
 131   GObjectClass *gobject_class;
 132   GstElementClass *element_class;
 133   GstBaseSrcClass *basesrc_class;
 134   GstPushSrcClass *pushsrc_class;
 135
 136   gobject_class = G_OBJECT_CLASS (klass);
 137   element_class = GST_ELEMENT_CLASS (klass);
 138   basesrc_class = GST_BASE_SRC_CLASS (klass);
 139   pushsrc_class = GST_PUSH_SRC_CLASS (klass);
 140
 141   gobject_class->finalize = (GObjectFinalizeFunc) gst_v4l2src_finalize;
 142   gobject_class->set_property = gst_v4l2src_set_property;
 143   gobject_class->get_property = gst_v4l2src_get_property;
 144
 145   element_class->change_state = gst_v4l2src_change_state;
 146
 147   gst_v4l2_object_install_properties_helper (gobject_class,
 148       DEFAULT_PROP_DEVICE);
 149
 150   /**
 151    * GstV4l2Src::prepare-format:
 152    * @v4l2src: the v4l2src instance
 153    * @fd: the file descriptor of the current device
 154    * @caps: the caps of the format being set
 155    *
 156    * This signal gets emitted before calling the v4l2 VIDIOC_S_FMT ioctl
 157    * (set format). This allows for any custom configuration of the device to
 158    * happen prior to the format being set.
 159    * This is mostly useful for UVC H264 encoding cameras which need the H264
 160    * Probe & Commit to happen prior to the normal Probe & Commit.
 161    */
 162   gst_v4l2_signals[SIGNAL_PRE_SET_FORMAT] = g_signal_new ("prepare-format",
 163       G_TYPE_FROM_CLASS (klass),
 164       G_SIGNAL_RUN_LAST,
 165       0, NULL, NULL, NULL, G_TYPE_NONE, 2, G_TYPE_INT, GST_TYPE_CAPS);
 166
 167   gst_element_class_set_static_metadata (element_class,
 168       "Video (video4linux2) Source", "Source/Video",
 169       "Reads frames from a Video4Linux2 device",
 170       "Edgard Lima <edgard.lima@gmail.com>, "
 171       "Stefan Kost <ensonic@users.sf.net>");
 172
 173   gst_element_class_add_pad_template
 174       (element_class,
 175       gst_pad_template_new ("src", GST_PAD_SRC, GST_PAD_ALWAYS,
 176           gst_v4l2_object_get_all_caps ()));
 177
 178   basesrc_class->get_caps = GST_DEBUG_FUNCPTR (gst_v4l2src_get_caps);
 179   basesrc_class->start = GST_DEBUG_FUNCPTR (gst_v4l2src_start);
 180   basesrc_class->unlock = GST_DEBUG_FUNCPTR (gst_v4l2src_unlock);
 181   basesrc_class->unlock_stop = GST_DEBUG_FUNCPTR (gst_v4l2src_unlock_stop);
 182   basesrc_class->stop = GST_DEBUG_FUNCPTR (gst_v4l2src_stop);
 183   basesrc_class->query = GST_DEBUG_FUNCPTR (gst_v4l2src_query);
 184   basesrc_class->negotiate = GST_DEBUG_FUNCPTR (gst_v4l2src_negotiate);
 185   basesrc_class->decide_allocation =
 186       GST_DEBUG_FUNCPTR (gst_v4l2src_decide_allocation);
 187
 188   pushsrc_class->create = GST_DEBUG_FUNCPTR (gst_v4l2src_create);
 189
 190   klass->v4l2_class_devices = NULL;
 191
 192   GST_DEBUG_CATEGORY_INIT (v4l2src_debug, "v4l2src", 0, "V4L2 source element");
 193 }
 194
 195 static void
 196 gst_v4l2src_init (GstV4l2Src * v4l2src)
 197 {
 198   /* fixme: give an update_fps_function */
 199   v4l2src->v4l2object = gst_v4l2_object_new (GST_ELEMENT (v4l2src),
 200       GST_OBJECT (GST_BASE_SRC_PAD (v4l2src)), V4L2_BUF_TYPE_VIDEO_CAPTURE,
 201       DEFAULT_PROP_DEVICE, gst_v4l2_get_input, gst_v4l2_set_input, NULL);
 202
 203   /* Avoid the slow probes */
 204   v4l2src->v4l2object->skip_try_fmt_probes = TRUE;
 205
 206   gst_base_src_set_format (GST_BASE_SRC (v4l2src), GST_FORMAT_TIME);
 207   gst_base_src_set_live (GST_BASE_SRC (v4l2src), TRUE);
 208 }
 209
 210
 211 static void
 212 gst_v4l2src_finalize (GstV4l2Src * v4l2src)
 213 {
 214   gst_v4l2_object_destroy (v4l2src->v4l2object);
 215
 216   G_OBJECT_CLASS (parent_class)->finalize ((GObject *) (v4l2src));
 217 }
 218
 219
 220 static void
 221 gst_v4l2src_set_property (GObject * object,
 222     guint prop_id, const GValue * value, GParamSpec * pspec)
 223 {
 224   GstV4l2Src *v4l2src = GST_V4L2SRC (object);
 225
 226   if (!gst_v4l2_object_set_property_helper (v4l2src->v4l2object,
 227           prop_id, value, pspec)) {
 228     switch (prop_id) {
 229       default:
 230         G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 231         break;
 232     }
 233   }
 234 }
 235
 236 static void
 237 gst_v4l2src_get_property (GObject * object,
 238     guint prop_id, GValue * value, GParamSpec * pspec)
 239 {
 240   GstV4l2Src *v4l2src = GST_V4L2SRC (object);
 241
 242   if (!gst_v4l2_object_get_property_helper (v4l2src->v4l2object,
 243           prop_id, value, pspec)) {
 244     switch (prop_id) {
 245       default:
 246         G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 247         break;
 248     }
 249   }
 250 }
 251
 252 struct PreferedCapsInfo
 253 {
 254   gint width;
 255   gint height;
 256   gint fps_n;
 257   gint fps_d;
 258 };
 259
 260 static gboolean
 261 gst_vl42_src_fixate_fields (GQuark field_id, GValue * value, gpointer user_data)
 262 {
 263   GstStructure *s = user_data;
 264
 265   if (field_id == g_quark_from_string ("interlace-mode"))
 266     return TRUE;
 267
 268   if (field_id == g_quark_from_string ("colorimetry"))
 269     return TRUE;
 270
 271   gst_structure_fixate_field (s, g_quark_to_string (field_id));
 272
 273   return TRUE;
 274 }
 275
 276 static void
 277 gst_v4l2_src_fixate_struct_with_preference (GstStructure * s,
 278     struct PreferedCapsInfo *pref)
 279 {
 280   if (gst_structure_has_field (s, "width"))
 281     gst_structure_fixate_field_nearest_int (s, "width", pref->width);
 282
 283   if (gst_structure_has_field (s, "height"))
 284     gst_structure_fixate_field_nearest_int (s, "height", pref->height);
 285
 286   if (gst_structure_has_field (s, "framerate"))
 287     gst_structure_fixate_field_nearest_fraction (s, "framerate", pref->fps_n,
 288         pref->fps_d);
 289
 290   /* Finally, fixate everything else except the interlace-mode and colorimetry
 291    * which still need further negotiation as it wasn't probed */
 292   gst_structure_map_in_place (s, gst_vl42_src_fixate_fields, s);
 293 }
 294
 295 static void
 296 gst_v4l2_src_parse_fixed_struct (GstStructure * s,
 297     gint * width, gint * height, gint * fps_n, gint * fps_d)
 298 {
 299   if (gst_structure_has_field (s, "width") && width)
 300     gst_structure_get_int (s, "width", width);
 301
 302   if (gst_structure_has_field (s, "height") && height)
 303     gst_structure_get_int (s, "height", height);
 304
 305   if (gst_structure_has_field (s, "framerate") && fps_n && fps_d)
 306     gst_structure_get_fraction (s, "framerate", fps_n, fps_d);
 307 }
 308
 309 /* TODO Consider framerate */
 310 static gint
 311 gst_v4l2src_fixed_caps_compare (GstStructure * a, GstStructure * b,
 312     struct PreferedCapsInfo *pref)
 313 {
 314   gint aw = G_MAXINT, ah = G_MAXINT, ad = G_MAXINT;
 315   gint bw = G_MAXINT, bh = G_MAXINT, bd = G_MAXINT;
 316   gint ret;
 317
 318   gst_v4l2_src_parse_fixed_struct (a, &aw, &ah, NULL, NULL);
 319   gst_v4l2_src_parse_fixed_struct (b, &bw, &bh, NULL, NULL);
 320
 321   /* When both are smaller then pref, just append to the end */
 322   if ((bw < pref->width || bh < pref->height)
 323       && (aw < pref->width || ah < pref->height)) {
 324     ret = 1;
 325     goto done;
 326   }
 327
 328   /* If a is smaller then pref and not b, then a goes after b */
 329   if (aw < pref->width || ah < pref->height) {
 330     ret = 1;
 331     goto done;
 332   }
 333
 334   /* If b is smaller then pref and not a, then a goes before b */
 335   if (bw < pref->width || bh < pref->height) {
 336     ret = -1;
 337     goto done;
 338   }
 339
 340   /* Both are larger or equal to the preference, prefer the smallest */
 341   ad = MAX (1, aw - pref->width) * MAX (1, ah - pref->height);
 342   bd = MAX (1, bw - pref->width) * MAX (1, bh - pref->height);
 343
 344   /* Adjust slightly in case width/height matched the preference */
 345   if (aw == pref->width)
 346     ad -= 1;
 347
 348   if (ah == pref->height)
 349     ad -= 1;
 350
 351   if (bw == pref->width)
 352     bd -= 1;
 353
 354   if (bh == pref->height)
 355     bd -= 1;
 356
 357   /* If the choices are equivalent, maintain the order */
 358   if (ad == bd)
 359     ret = 1;
 360   else
 361     ret = ad - bd;
 362
 363 done:
 364   GST_TRACE ("Placing %ix%i (%s) %s %ix%i (%s)", aw, ah,
 365       gst_structure_get_string (a, "format"), ret > 0 ? "after" : "before", bw,
 366       bh, gst_structure_get_string (b, "format"));
 367   return ret;
 368 }
 369
 370 static gboolean
 371 gst_v4l2src_set_format (GstV4l2Src * v4l2src, GstCaps * caps,
 372     GstV4l2Error * error)
 373 {
 374   GstV4l2Object *obj;
 375
 376   obj = v4l2src->v4l2object;
 377
 378   /* make sure we stop capturing and dealloc buffers */
 379   if (!gst_v4l2_object_stop (obj))
 380     return FALSE;
 381
 382   g_signal_emit (v4l2src, gst_v4l2_signals[SIGNAL_PRE_SET_FORMAT], 0,
 383       v4l2src->v4l2object->video_fd, caps);
 384
 385   return gst_v4l2_object_set_format (obj, caps, error);
 386 }
 387
 388 static GstCaps *
 389 gst_v4l2src_fixate (GstBaseSrc * basesrc, GstCaps * caps, GstStructure * pref_s)
 390 {
 391   /* Let's prefer a good resolutiion as of today's standard. */
 392   struct PreferedCapsInfo pref = {
 393     3840, 2160, 120, 1
 394   };
 395   GstV4l2Src *v4l2src = GST_V4L2SRC (basesrc);
 396   GstV4l2Object *obj = v4l2src->v4l2object;
 397   GList *caps_list = NULL;
 398   GstStructure *s;
 399   gint i = G_MAXINT;
 400   GstV4l2Error error = GST_V4L2_ERROR_INIT;
 401   GstCaps *fcaps = NULL;
 402
 403   GST_DEBUG_OBJECT (basesrc, "fixating caps %" GST_PTR_FORMAT, caps);
 404
 405   caps = gst_caps_make_writable (caps);
 406
 407   /* We consider the first structure from peercaps to be a preference. This is
 408    * useful for matching a reported native display, or simply to avoid
 409    * transformation to happen downstream. */
 410   if (pref_s) {
 411     pref_s = gst_structure_copy (pref_s);
 412     gst_v4l2_src_fixate_struct_with_preference (pref_s, &pref);
 413     gst_v4l2_src_parse_fixed_struct (pref_s, &pref.width, &pref.height,
 414         &pref.fps_n, &pref.fps_d);
 415     gst_structure_free (pref_s);
 416   }
 417
 418   GST_DEBUG_OBJECT (basesrc, "Prefered size %ix%i", pref.width, pref.height);
 419
 420   /* Sort the structures to get the caps that is nearest to our preferences,
 421    * first */
 422   while ((s = gst_caps_steal_structure (caps, 0))) {
 423     gst_v4l2_src_fixate_struct_with_preference (s, &pref);
 424     caps_list = g_list_insert_sorted_with_data (caps_list, s,
 425         (GCompareDataFunc) gst_v4l2src_fixed_caps_compare, &pref);
 426   }
 427
 428   while (caps_list) {
 429     s = caps_list->data;
 430     caps_list = g_list_delete_link (caps_list, caps_list);
 431     gst_caps_append_structure (caps, s);
 432   }
 433
 434   GST_DEBUG_OBJECT (basesrc, "sorted and normalized caps %" GST_PTR_FORMAT,
 435       caps);
 436
 437   /* Each structure in the caps has been fixated, except for the
 438    * interlace-mode and colorimetry. Now normalize the caps so we can
 439    * enumerate the possibilities */
 440   caps = gst_caps_normalize (caps);
 441
 442   for (i = 0; i < gst_caps_get_size (caps); ++i) {
 443     gst_v4l2_clear_error (&error);
 444     if (fcaps)
 445       gst_caps_unref (fcaps);
 446
 447     fcaps = gst_caps_copy_nth (caps, i);
 448
 449     /* try hard to avoid TRY_FMT since some UVC camera just crash when this
 450      * is called at run-time. */
 451     if (gst_v4l2_object_caps_is_subset (obj, fcaps)) {
 452       gst_caps_unref (fcaps);
 453       fcaps = gst_v4l2_object_get_current_caps (obj);
 454       break;
 455     }
 456
 457     /* Just check if the format is acceptable, once we know
 458      * no buffers should be outstanding we try S_FMT.
 459      *
 460      * Basesrc will do an allocation query that
 461      * should indirectly reclaim buffers, after that we can
 462      * set the format and then configure our pool */
 463     if (gst_v4l2_object_try_format (obj, fcaps, &error)) {
 464       /* make sure the caps changed before doing anything */
 465       if (gst_v4l2_object_caps_equal (obj, fcaps))
 466         break;
 467
 468       v4l2src->renegotiation_adjust = v4l2src->offset + 1;
 469       v4l2src->pending_set_fmt = TRUE;
 470       break;
 471     }
 472
 473     /* Only EIVAL make sense, report any other errors, this way we don't keep
 474      * probing if the device got disconnected, or if it's firmware stopped
 475      * responding */
 476     if (error.error->code != GST_RESOURCE_ERROR_SETTINGS) {
 477       i = G_MAXINT;
 478       break;
 479     }
 480   }
 481
 482   if (i >= gst_caps_get_size (caps)) {
 483     gst_v4l2_error (v4l2src, &error);
 484     if (fcaps)
 485       gst_caps_unref (fcaps);
 486     gst_caps_unref (caps);
 487     return NULL;
 488   }
 489
 490   gst_caps_unref (caps);
 491
 492   GST_DEBUG_OBJECT (basesrc, "fixated caps %" GST_PTR_FORMAT, fcaps);
 493
 494   return fcaps;
 495 }
 496
 497 static gboolean
 498 gst_v4l2src_negotiate (GstBaseSrc * basesrc)
 499 {
 500   GstCaps *thiscaps;
 501   GstCaps *caps = NULL;
 502   GstCaps *peercaps = NULL;
 503   gboolean result = FALSE;
 504
 505   /* first see what is possible on our source pad */
 506   thiscaps = gst_pad_query_caps (GST_BASE_SRC_PAD (basesrc), NULL);
 507   GST_DEBUG_OBJECT (basesrc, "caps of src: %" GST_PTR_FORMAT, thiscaps);
 508
 509   /* nothing or anything is allowed, we're done */
 510   if (thiscaps == NULL || gst_caps_is_any (thiscaps))
 511     goto no_nego_needed;
 512
 513   /* get the peer caps without a filter as we'll filter ourselves later on */
 514   peercaps = gst_pad_peer_query_caps (GST_BASE_SRC_PAD (basesrc), NULL);
 515   GST_DEBUG_OBJECT (basesrc, "caps of peer: %" GST_PTR_FORMAT, peercaps);
 516   if (peercaps && !gst_caps_is_any (peercaps)) {
 517     /* Prefer the first caps we are compatible with that the peer proposed */
 518     caps = gst_caps_intersect_full (peercaps, thiscaps,
 519         GST_CAPS_INTERSECT_FIRST);
 520
 521     GST_DEBUG_OBJECT (basesrc, "intersect: %" GST_PTR_FORMAT, caps);
 522
 523     gst_caps_unref (thiscaps);
 524   } else {
 525     /* no peer or peer have ANY caps, work with our own caps then */
 526     caps = thiscaps;
 527   }
 528
 529   if (caps) {
 530     /* now fixate */
 531     if (!gst_caps_is_empty (caps)) {
 532       GstStructure *pref = NULL;
 533
 534       if (peercaps && !gst_caps_is_any (peercaps))
 535         pref = gst_caps_get_structure (peercaps, 0);
 536
 537       caps = gst_v4l2src_fixate (basesrc, caps, pref);
 538
 539       /* Fixating may fail as we now set the selected format */
 540       if (!caps) {
 541         result = FALSE;
 542         goto done;
 543       }
 544
 545       GST_DEBUG_OBJECT (basesrc, "fixated to: %" GST_PTR_FORMAT, caps);
 546
 547       if (gst_caps_is_any (caps)) {
 548         /* hmm, still anything, so element can do anything and
 549          * nego is not needed */
 550         result = TRUE;
 551       } else if (gst_caps_is_fixed (caps)) {
 552         /* yay, fixed caps, use those then */
 553         result = gst_base_src_set_caps (basesrc, caps);
 554       }
 555     }
 556     gst_caps_unref (caps);
 557   }
 558
 559 done:
 560   if (peercaps)
 561     gst_caps_unref (peercaps);
 562
 563   return result;
 564
 565 no_nego_needed:
 566   {
 567     GST_DEBUG_OBJECT (basesrc, "no negotiation needed");
 568     if (thiscaps)
 569       gst_caps_unref (thiscaps);
 570     return TRUE;
 571   }
 572 }
 573
 574 static GstCaps *
 575 gst_v4l2src_get_caps (GstBaseSrc * src, GstCaps * filter)
 576 {
 577   GstV4l2Src *v4l2src;
 578   GstV4l2Object *obj;
 579
 580   v4l2src = GST_V4L2SRC (src);
 581   obj = v4l2src->v4l2object;
 582
 583   if (!GST_V4L2_IS_OPEN (obj)) {
 584     return gst_pad_get_pad_template_caps (GST_BASE_SRC_PAD (v4l2src));
 585   }
 586
 587   return gst_v4l2_object_get_caps (obj, filter);
 588 }
 589
 590 static gboolean
 591 gst_v4l2src_decide_allocation (GstBaseSrc * bsrc, GstQuery * query)
 592 {
 593   GstV4l2Src *src = GST_V4L2SRC (bsrc);
 594   gboolean ret = TRUE;
 595
 596   if (src->pending_set_fmt) {
 597     GstCaps *caps = gst_pad_get_current_caps (GST_BASE_SRC_PAD (bsrc));
 598     GstV4l2Error error = GST_V4L2_ERROR_INIT;
 599
 600     caps = gst_caps_make_writable (caps);
 601     if (!(ret = gst_v4l2src_set_format (src, caps, &error)))
 602       gst_v4l2_error (src, &error);
 603
 604     gst_caps_unref (caps);
 605     src->pending_set_fmt = FALSE;
 606   } else if (gst_buffer_pool_is_active (src->v4l2object->pool)) {
 607     /* Trick basesrc into not deactivating the active pool. Renegotiating here
 608      * would otherwise turn off and on the camera. */
 609     GstAllocator *allocator;
 610     GstAllocationParams params;
 611     GstBufferPool *pool;
 612
 613     gst_base_src_get_allocator (bsrc, &allocator, &params);
 614     pool = gst_base_src_get_buffer_pool (bsrc);
 615
 616     if (gst_query_get_n_allocation_params (query))
 617       gst_query_set_nth_allocation_param (query, 0, allocator, &params);
 618     else
 619       gst_query_add_allocation_param (query, allocator, &params);
 620
 621     if (gst_query_get_n_allocation_pools (query))
 622       gst_query_set_nth_allocation_pool (query, 0, pool,
 623           src->v4l2object->info.size, 1, 0);
 624     else
 625       gst_query_add_allocation_pool (query, pool, src->v4l2object->info.size, 1,
 626           0);
 627
 628     if (pool)
 629       gst_object_unref (pool);
 630     if (allocator)
 631       gst_object_unref (allocator);
 632
 633     return GST_BASE_SRC_CLASS (parent_class)->decide_allocation (bsrc, query);
 634   }
 635
 636   if (ret) {
 637     ret = gst_v4l2_object_decide_allocation (src->v4l2object, query);
 638     if (ret)
 639       ret = GST_BASE_SRC_CLASS (parent_class)->decide_allocation (bsrc, query);
 640   }
 641
 642   if (ret) {
 643     if (!gst_buffer_pool_set_active (src->v4l2object->pool, TRUE))
 644       goto activate_failed;
 645   }
 646
 647   return ret;
 648
 649 activate_failed:
 650   {
 651     GST_ELEMENT_ERROR (src, RESOURCE, SETTINGS,
 652         (_("Failed to allocate required memory.")),
 653         ("Buffer pool activation failed"));
 654     return FALSE;
 655   }
 656 }
 657
 658 static gboolean
 659 gst_v4l2src_query (GstBaseSrc * bsrc, GstQuery * query)
 660 {
 661   GstV4l2Src *src;
 662   GstV4l2Object *obj;
 663   gboolean res = FALSE;
 664
 665   src = GST_V4L2SRC (bsrc);
 666   obj = src->v4l2object;
 667
 668   switch (GST_QUERY_TYPE (query)) {
 669     case GST_QUERY_LATENCY:{
 670       GstClockTime min_latency, max_latency;
 671       guint32 fps_n, fps_d;
 672       guint num_buffers = 0;
 673
 674       /* device must be open */
 675       if (!GST_V4L2_IS_OPEN (obj)) {
 676         GST_WARNING_OBJECT (src,
 677             "Can't give latency since device isn't open !");
 678         goto done;
 679       }
 680
 681       fps_n = GST_V4L2_FPS_N (obj);
 682       fps_d = GST_V4L2_FPS_D (obj);
 683
 684       /* we must have a framerate */
 685       if (fps_n <= 0 || fps_d <= 0) {
 686         GST_WARNING_OBJECT (src,
 687             "Can't give latency since framerate isn't fixated !");
 688         goto done;
 689       }
 690
 691       /* min latency is the time to capture one frame */
 692       min_latency = gst_util_uint64_scale_int (GST_SECOND, fps_d, fps_n);
 693
 694       /* max latency is total duration of the frame buffer */
 695       if (obj->pool != NULL)
 696         num_buffers = GST_V4L2_BUFFER_POOL_CAST (obj->pool)->max_latency;
 697
 698       if (num_buffers == 0)
 699         max_latency = -1;
 700       else
 701         max_latency = num_buffers * min_latency;
 702
 703       GST_DEBUG_OBJECT (bsrc,
 704           "report latency min %" GST_TIME_FORMAT " max %" GST_TIME_FORMAT,
 705           GST_TIME_ARGS (min_latency), GST_TIME_ARGS (max_latency));
 706
 707       /* we are always live, the min latency is 1 frame and the max latency is
 708        * the complete buffer of frames. */
 709       gst_query_set_latency (query, TRUE, min_latency, max_latency);
 710
 711       res = TRUE;
 712       break;
 713     }
 714     default:
 715       res = GST_BASE_SRC_CLASS (parent_class)->query (bsrc, query);
 716       break;
 717   }
 718
 719 done:
 720
 721   return res;
 722 }
 723
 724 /* start and stop are not symmetric -- start will open the device, but not start
 725  * capture. it's setcaps that will start capture, which is called via basesrc's
 726  * negotiate method. stop will both stop capture and close the device.
 727  */
 728 static gboolean
 729 gst_v4l2src_start (GstBaseSrc * src)
 730 {
 731   GstV4l2Src *v4l2src = GST_V4L2SRC (src);
 732
 733   v4l2src->offset = 0;
 734   v4l2src->renegotiation_adjust = 0;
 735
 736   /* activate settings for first frame */
 737   v4l2src->ctrl_time = 0;
 738   gst_object_sync_values (GST_OBJECT (src), v4l2src->ctrl_time);
 739
 740   v4l2src->has_bad_timestamp = FALSE;
 741   v4l2src->last_timestamp = 0;
 742
 743   return TRUE;
 744 }
 745
 746 static gboolean
 747 gst_v4l2src_unlock (GstBaseSrc * src)
 748 {
 749   GstV4l2Src *v4l2src = GST_V4L2SRC (src);
 750   return gst_v4l2_object_unlock (v4l2src->v4l2object);
 751 }
 752
 753 static gboolean
 754 gst_v4l2src_unlock_stop (GstBaseSrc * src)
 755 {
 756   GstV4l2Src *v4l2src = GST_V4L2SRC (src);
 757
 758   v4l2src->last_timestamp = 0;
 759
 760   return gst_v4l2_object_unlock_stop (v4l2src->v4l2object);
 761 }
 762
 763 static gboolean
 764 gst_v4l2src_stop (GstBaseSrc * src)
 765 {
 766   GstV4l2Src *v4l2src = GST_V4L2SRC (src);
 767   GstV4l2Object *obj = v4l2src->v4l2object;
 768
 769   if (GST_V4L2_IS_ACTIVE (obj)) {
 770     if (!gst_v4l2_object_stop (obj))
 771       return FALSE;
 772   }
 773
 774   v4l2src->pending_set_fmt = FALSE;
 775
 776   return TRUE;
 777 }
 778
 779 static GstStateChangeReturn
 780 gst_v4l2src_change_state (GstElement * element, GstStateChange transition)
 781 {
 782   GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
 783   GstV4l2Src *v4l2src = GST_V4L2SRC (element);
 784   GstV4l2Object *obj = v4l2src->v4l2object;
 785
 786   switch (transition) {
 787     case GST_STATE_CHANGE_NULL_TO_READY:
 788       /* open the device */
 789       if (!gst_v4l2_object_open (obj))
 790         return GST_STATE_CHANGE_FAILURE;
 791       break;
 792     default:
 793       break;
 794   }
 795
 796   ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
 797
 798   switch (transition) {
 799     case GST_STATE_CHANGE_READY_TO_NULL:
 800       /* close the device */
 801       if (!gst_v4l2_object_close (obj))
 802         return GST_STATE_CHANGE_FAILURE;
 803
 804       break;
 805     default:
 806       break;
 807   }
 808
 809   return ret;
 810 }
 811
 812 static GstFlowReturn
 813 gst_v4l2src_create (GstPushSrc * src, GstBuffer ** buf)
 814 {
 815   GstV4l2Src *v4l2src = GST_V4L2SRC (src);
 816   GstV4l2Object *obj = v4l2src->v4l2object;
 817   GstV4l2BufferPool *pool = GST_V4L2_BUFFER_POOL_CAST (obj->pool);
 818   GstFlowReturn ret;
 819   GstClock *clock;
 820   GstClockTime abs_time, base_time, timestamp, duration;
 821   GstClockTime delay;
 822   GstMessage *qos_msg;
 823
 824   do {
 825     ret = GST_BASE_SRC_CLASS (parent_class)->alloc (GST_BASE_SRC (src), 0,
 826         obj->info.size, buf);
 827
 828     if (G_UNLIKELY (ret != GST_FLOW_OK))
 829       goto alloc_failed;
 830
 831     ret = gst_v4l2_buffer_pool_process (pool, buf);
 832
 833   } while (ret == GST_V4L2_FLOW_CORRUPTED_BUFFER);
 834
 835   if (G_UNLIKELY (ret != GST_FLOW_OK))
 836     goto error;
 837
 838   timestamp = GST_BUFFER_TIMESTAMP (*buf);
 839   duration = obj->duration;
 840
 841   /* timestamps, LOCK to get clock and base time. */
 842   /* FIXME: element clock and base_time is rarely changing */
 843   GST_OBJECT_LOCK (v4l2src);
 844   if ((clock = GST_ELEMENT_CLOCK (v4l2src))) {
 845     /* we have a clock, get base time and ref clock */
 846     base_time = GST_ELEMENT (v4l2src)->base_time;
 847     gst_object_ref (clock);
 848   } else {
 849     /* no clock, can't set timestamps */
 850     base_time = GST_CLOCK_TIME_NONE;
 851   }
 852   GST_OBJECT_UNLOCK (v4l2src);
 853
 854   /* sample pipeline clock */
 855   if (clock) {
 856     abs_time = gst_clock_get_time (clock);
 857     gst_object_unref (clock);
 858   } else {
 859     abs_time = GST_CLOCK_TIME_NONE;
 860   }
 861
 862 retry:
 863   if (!v4l2src->has_bad_timestamp && timestamp != GST_CLOCK_TIME_NONE) {
 864     struct timespec now;
 865     GstClockTime gstnow;
 866
 867     /* v4l2 specs say to use the system time although many drivers switched to
 868      * the more desirable monotonic time. We first try to use the monotonic time
 869      * and see how that goes */
 870     clock_gettime (CLOCK_MONOTONIC, &now);
 871     gstnow = GST_TIMESPEC_TO_TIME (now);
 872
 873     if (timestamp > gstnow || (gstnow - timestamp) > (10 * GST_SECOND)) {
 874       GTimeVal now;
 875
 876       /* very large diff, fall back to system time */
 877       g_get_current_time (&now);
 878       gstnow = GST_TIMEVAL_TO_TIME (now);
 879     }
 880
 881     /* Detect buggy drivers here, and stop using their timestamp. Failing any
 882      * of these condition would imply a very buggy driver:
 883      *   - Timestamp in the future
 884      *   - Timestamp is going backward compare to last seen timestamp
 885      *   - Timestamp is jumping forward for less then a frame duration
 886      *   - Delay is bigger then the actual timestamp
 887      * */
 888     if (timestamp > gstnow) {
 889       GST_WARNING_OBJECT (v4l2src,
 890           "Timestamp in the future detected, ignoring driver timestamps");
 891       v4l2src->has_bad_timestamp = TRUE;
 892       goto retry;
 893     }
 894
 895     if (v4l2src->last_timestamp > timestamp) {
 896       GST_WARNING_OBJECT (v4l2src,
 897           "Timestamp going backward, ignoring driver timestamps");
 898       v4l2src->has_bad_timestamp = TRUE;
 899       goto retry;
 900     }
 901
 902     delay = gstnow - timestamp;
 903
 904     if (delay > timestamp) {
 905       GST_WARNING_OBJECT (v4l2src,
 906           "Timestamp does not correlate with any clock, ignoring driver timestamps");
 907       v4l2src->has_bad_timestamp = TRUE;
 908       goto retry;
 909     }
 910
 911     /* Save last timestamp for sanity checks */
 912     v4l2src->last_timestamp = timestamp;
 913
 914     GST_DEBUG_OBJECT (v4l2src, "ts: %" GST_TIME_FORMAT " now %" GST_TIME_FORMAT
 915         " delay %" GST_TIME_FORMAT, GST_TIME_ARGS (timestamp),
 916         GST_TIME_ARGS (gstnow), GST_TIME_ARGS (delay));
 917   } else {
 918     /* we assume 1 frame latency otherwise */
 919     if (GST_CLOCK_TIME_IS_VALID (duration))
 920       delay = duration;
 921     else
 922       delay = 0;
 923   }
 924
 925   /* set buffer metadata */
 926
 927   if (G_LIKELY (abs_time != GST_CLOCK_TIME_NONE)) {
 928     /* the time now is the time of the clock minus the base time */
 929     timestamp = abs_time - base_time;
 930
 931     /* adjust for delay in the device */
 932     if (timestamp > delay)
 933       timestamp -= delay;
 934     else
 935       timestamp = 0;
 936   } else {
 937     timestamp = GST_CLOCK_TIME_NONE;
 938   }
 939
 940   /* activate settings for next frame */
 941   if (GST_CLOCK_TIME_IS_VALID (duration)) {
 942     v4l2src->ctrl_time += duration;
 943   } else {
 944     /* this is not very good (as it should be the next timestamp),
 945      * still good enough for linear fades (as long as it is not -1)
 946      */
 947     v4l2src->ctrl_time = timestamp;
 948   }
 949   gst_object_sync_values (GST_OBJECT (src), v4l2src->ctrl_time);
 950
 951   GST_INFO_OBJECT (src, "sync to %" GST_TIME_FORMAT " out ts %" GST_TIME_FORMAT,
 952       GST_TIME_ARGS (v4l2src->ctrl_time), GST_TIME_ARGS (timestamp));
 953
 954   /* use generated offset values only if there are not already valid ones
 955    * set by the v4l2 device */
 956   if (!GST_BUFFER_OFFSET_IS_VALID (*buf)
 957       || !GST_BUFFER_OFFSET_END_IS_VALID (*buf)) {
 958     GST_BUFFER_OFFSET (*buf) = v4l2src->offset++;
 959     GST_BUFFER_OFFSET_END (*buf) = v4l2src->offset;
 960   } else {
 961     /* adjust raw v4l2 device sequence, will restart at null in case of renegotiation
 962      * (streamoff/streamon) */
 963     GST_BUFFER_OFFSET (*buf) += v4l2src->renegotiation_adjust;
 964     GST_BUFFER_OFFSET_END (*buf) += v4l2src->renegotiation_adjust;
 965     /* check for frame loss with given (from v4l2 device) buffer offset */
 966     if ((v4l2src->offset != 0)
 967         && (GST_BUFFER_OFFSET (*buf) != (v4l2src->offset + 1))) {
 968       guint64 lost_frame_count = GST_BUFFER_OFFSET (*buf) - v4l2src->offset - 1;
 969       GST_WARNING_OBJECT (v4l2src,
 970           "lost frames detected: count = %" G_GUINT64_FORMAT " - ts: %"
 971           GST_TIME_FORMAT, lost_frame_count, GST_TIME_ARGS (timestamp));
 972
 973       qos_msg = gst_message_new_qos (GST_OBJECT_CAST (v4l2src), TRUE,
 974           GST_CLOCK_TIME_NONE, GST_CLOCK_TIME_NONE, timestamp,
 975           GST_CLOCK_TIME_IS_VALID (duration) ? lost_frame_count *
 976           duration : GST_CLOCK_TIME_NONE);
 977       gst_element_post_message (GST_ELEMENT_CAST (v4l2src), qos_msg);
 978
 979     }
 980     v4l2src->offset = GST_BUFFER_OFFSET (*buf);
 981   }
 982
 983   GST_BUFFER_TIMESTAMP (*buf) = timestamp;
 984   GST_BUFFER_DURATION (*buf) = duration;
 985
 986   return ret;
 987
 988   /* ERROR */
 989 alloc_failed:
 990   {
 991     if (ret != GST_FLOW_FLUSHING)
 992       GST_ELEMENT_ERROR (src, RESOURCE, NO_SPACE_LEFT,
 993           ("Failed to allocate a buffer"), (NULL));
 994     return ret;
 995   }
 996 error:
 997   {
 998     gst_buffer_replace (buf, NULL);
 999     if (ret == GST_V4L2_FLOW_LAST_BUFFER) {
1000       GST_ELEMENT_ERROR (src, RESOURCE, FAILED,
1001           ("Driver returned a buffer with no payload, this most likely "
1002               "indicate a bug in the driver."), (NULL));
1003       ret = GST_FLOW_ERROR;
1004     } else {
1005       GST_DEBUG_OBJECT (src, "error processing buffer %d (%s)", ret,
1006           gst_flow_get_name (ret));
1007     }
1008     return ret;
1009   }
1010 }
1011
1012
1013 /* GstURIHandler interface */
1014 static GstURIType
1015 gst_v4l2src_uri_get_type (GType type)
1016 {
1017   return GST_URI_SRC;
1018 }
1019
1020 static const gchar *const *
1021 gst_v4l2src_uri_get_protocols (GType type)
1022 {
1023   static const gchar *protocols[] = { "v4l2", NULL };
1024
1025   return protocols;
1026 }
1027
1028 static gchar *
1029 gst_v4l2src_uri_get_uri (GstURIHandler * handler)
1030 {
1031   GstV4l2Src *v4l2src = GST_V4L2SRC (handler);
1032
1033   if (v4l2src->v4l2object->videodev != NULL) {
1034     return g_strdup_printf ("v4l2://%s", v4l2src->v4l2object->videodev);
1035   }
1036
1037   return g_strdup ("v4l2://");
1038 }
1039
1040 static gboolean
1041 gst_v4l2src_uri_set_uri (GstURIHandler * handler, const gchar * uri,
1042     GError ** error)
1043 {
1044   GstV4l2Src *v4l2src = GST_V4L2SRC (handler);
1045   const gchar *device = DEFAULT_PROP_DEVICE;
1046
1047   if (strcmp (uri, "v4l2://") != 0) {
1048     device = uri + 7;
1049   }
1050   g_object_set (v4l2src, "device", device, NULL);
1051
1052   return TRUE;
1053 }
1054
1055
1056 static void
1057 gst_v4l2src_uri_handler_init (gpointer g_iface, gpointer iface_data)
1058 {
1059   GstURIHandlerInterface *iface = (GstURIHandlerInterface *) g_iface;
1060
1061   iface->get_type = gst_v4l2src_uri_get_type;
1062   iface->get_protocols = gst_v4l2src_uri_get_protocols;
1063   iface->get_uri = gst_v4l2src_uri_get_uri;
1064   iface->set_uri = gst_v4l2src_uri_set_uri;
1065 }