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     if (GST_V4L2_IS_ACTIVE (obj)) {
 450       /* try hard to avoid TRY_FMT since some UVC camera just crash when this
 451        * is called at run-time. */
 452       if (gst_v4l2_object_caps_is_subset (obj, fcaps)) {
 453         gst_caps_unref (fcaps);
 454         fcaps = gst_v4l2_object_get_current_caps (obj);
 455         break;
 456       }
 457
 458       /* Just check if the format is acceptable, once we know
 459        * no buffers should be outstanding we try S_FMT.
 460        *
 461        * Basesrc will do an allocation query that
 462        * should indirectly reclaim buffers, after that we can
 463        * set the format and then configure our pool */
 464       if (gst_v4l2_object_try_format (obj, fcaps, &error)) {
 465         /* make sure the caps changed before doing anything */
 466         if (gst_v4l2_object_caps_equal (obj, fcaps))
 467           break;
 468
 469         v4l2src->renegotiation_adjust = v4l2src->offset + 1;
 470         v4l2src->pending_set_fmt = TRUE;
 471         break;
 472       }
 473     } else {
 474       if (gst_v4l2src_set_format (v4l2src, fcaps, &error))
 475         break;
 476     }
 477
 478     /* Only EIVAL make sense, report any other errors, this way we don't keep
 479      * probing if the device got disconnected, or if it's firmware stopped
 480      * responding */
 481     if (error.error->code != GST_RESOURCE_ERROR_SETTINGS) {
 482       i = G_MAXINT;
 483       break;
 484     }
 485   }
 486
 487   if (i >= gst_caps_get_size (caps)) {
 488     gst_v4l2_error (v4l2src, &error);
 489     if (fcaps)
 490       gst_caps_unref (fcaps);
 491     gst_caps_unref (caps);
 492     return NULL;
 493   }
 494
 495   gst_caps_unref (caps);
 496
 497   GST_DEBUG_OBJECT (basesrc, "fixated caps %" GST_PTR_FORMAT, fcaps);
 498
 499   return fcaps;
 500 }
 501
 502 static gboolean
 503 gst_v4l2src_negotiate (GstBaseSrc * basesrc)
 504 {
 505   GstCaps *thiscaps;
 506   GstCaps *caps = NULL;
 507   GstCaps *peercaps = NULL;
 508   gboolean result = FALSE;
 509
 510   /* first see what is possible on our source pad */
 511   thiscaps = gst_pad_query_caps (GST_BASE_SRC_PAD (basesrc), NULL);
 512   GST_DEBUG_OBJECT (basesrc, "caps of src: %" GST_PTR_FORMAT, thiscaps);
 513
 514   /* nothing or anything is allowed, we're done */
 515   if (thiscaps == NULL || gst_caps_is_any (thiscaps))
 516     goto no_nego_needed;
 517
 518   /* get the peer caps without a filter as we'll filter ourselves later on */
 519   peercaps = gst_pad_peer_query_caps (GST_BASE_SRC_PAD (basesrc), NULL);
 520   GST_DEBUG_OBJECT (basesrc, "caps of peer: %" GST_PTR_FORMAT, peercaps);
 521   if (peercaps && !gst_caps_is_any (peercaps)) {
 522     /* Prefer the first caps we are compatible with that the peer proposed */
 523     caps = gst_caps_intersect_full (peercaps, thiscaps,
 524         GST_CAPS_INTERSECT_FIRST);
 525
 526     GST_DEBUG_OBJECT (basesrc, "intersect: %" GST_PTR_FORMAT, caps);
 527
 528     gst_caps_unref (thiscaps);
 529   } else {
 530     /* no peer or peer have ANY caps, work with our own caps then */
 531     caps = thiscaps;
 532   }
 533
 534   if (caps) {
 535     /* now fixate */
 536     if (!gst_caps_is_empty (caps)) {
 537       GstStructure *pref = NULL;
 538
 539       if (peercaps && !gst_caps_is_any (peercaps))
 540         pref = gst_caps_get_structure (peercaps, 0);
 541
 542       caps = gst_v4l2src_fixate (basesrc, caps, pref);
 543
 544       /* Fixating may fail as we now set the selected format */
 545       if (!caps) {
 546         result = FALSE;
 547         goto done;
 548       }
 549
 550       GST_DEBUG_OBJECT (basesrc, "fixated to: %" GST_PTR_FORMAT, caps);
 551
 552       if (gst_caps_is_any (caps)) {
 553         /* hmm, still anything, so element can do anything and
 554          * nego is not needed */
 555         result = TRUE;
 556       } else if (gst_caps_is_fixed (caps)) {
 557         /* yay, fixed caps, use those then */
 558         result = gst_base_src_set_caps (basesrc, caps);
 559       }
 560     }
 561     gst_caps_unref (caps);
 562   }
 563
 564 done:
 565   if (peercaps)
 566     gst_caps_unref (peercaps);
 567
 568   return result;
 569
 570 no_nego_needed:
 571   {
 572     GST_DEBUG_OBJECT (basesrc, "no negotiation needed");
 573     if (thiscaps)
 574       gst_caps_unref (thiscaps);
 575     return TRUE;
 576   }
 577 }
 578
 579 static GstCaps *
 580 gst_v4l2src_get_caps (GstBaseSrc * src, GstCaps * filter)
 581 {
 582   GstV4l2Src *v4l2src;
 583   GstV4l2Object *obj;
 584
 585   v4l2src = GST_V4L2SRC (src);
 586   obj = v4l2src->v4l2object;
 587
 588   if (!GST_V4L2_IS_OPEN (obj)) {
 589     return gst_pad_get_pad_template_caps (GST_BASE_SRC_PAD (v4l2src));
 590   }
 591
 592   return gst_v4l2_object_get_caps (obj, filter);
 593 }
 594
 595 static gboolean
 596 gst_v4l2src_decide_allocation (GstBaseSrc * bsrc, GstQuery * query)
 597 {
 598   GstV4l2Src *src = GST_V4L2SRC (bsrc);
 599   gboolean ret = TRUE;
 600
 601   if (src->pending_set_fmt) {
 602     GstCaps *caps = gst_pad_get_current_caps (GST_BASE_SRC_PAD (bsrc));
 603     GstV4l2Error error = GST_V4L2_ERROR_INIT;
 604
 605     caps = gst_caps_make_writable (caps);
 606     if (!(ret = gst_v4l2src_set_format (src, caps, &error)))
 607       gst_v4l2_error (src, &error);
 608
 609     gst_caps_unref (caps);
 610     src->pending_set_fmt = FALSE;
 611   } else if (gst_buffer_pool_is_active (src->v4l2object->pool)) {
 612     /* Trick basesrc into not deactivating the active pool. Renegotiating here
 613      * would otherwise turn off and on the camera. */
 614     GstAllocator *allocator;
 615     GstAllocationParams params;
 616     GstBufferPool *pool;
 617
 618     gst_base_src_get_allocator (bsrc, &allocator, &params);
 619     pool = gst_base_src_get_buffer_pool (bsrc);
 620
 621     if (gst_query_get_n_allocation_params (query))
 622       gst_query_set_nth_allocation_param (query, 0, allocator, &params);
 623     else
 624       gst_query_add_allocation_param (query, allocator, &params);
 625
 626     if (gst_query_get_n_allocation_pools (query))
 627       gst_query_set_nth_allocation_pool (query, 0, pool,
 628           src->v4l2object->info.size, 1, 0);
 629     else
 630       gst_query_add_allocation_pool (query, pool, src->v4l2object->info.size, 1,
 631           0);
 632
 633     if (pool)
 634       gst_object_unref (pool);
 635     if (allocator)
 636       gst_object_unref (allocator);
 637
 638     return GST_BASE_SRC_CLASS (parent_class)->decide_allocation (bsrc, query);
 639   }
 640
 641   if (ret) {
 642     ret = gst_v4l2_object_decide_allocation (src->v4l2object, query);
 643     if (ret)
 644       ret = GST_BASE_SRC_CLASS (parent_class)->decide_allocation (bsrc, query);
 645   }
 646
 647   if (ret) {
 648     if (!gst_buffer_pool_set_active (src->v4l2object->pool, TRUE))
 649       goto activate_failed;
 650   }
 651
 652   return ret;
 653
 654 activate_failed:
 655   {
 656     GST_ELEMENT_ERROR (src, RESOURCE, SETTINGS,
 657         (_("Failed to allocate required memory.")),
 658         ("Buffer pool activation failed"));
 659     return FALSE;
 660   }
 661 }
 662
 663 static gboolean
 664 gst_v4l2src_query (GstBaseSrc * bsrc, GstQuery * query)
 665 {
 666   GstV4l2Src *src;
 667   GstV4l2Object *obj;
 668   gboolean res = FALSE;
 669
 670   src = GST_V4L2SRC (bsrc);
 671   obj = src->v4l2object;
 672
 673   switch (GST_QUERY_TYPE (query)) {
 674     case GST_QUERY_LATENCY:{
 675       GstClockTime min_latency, max_latency;
 676       guint32 fps_n, fps_d;
 677       guint num_buffers = 0;
 678
 679       /* device must be open */
 680       if (!GST_V4L2_IS_OPEN (obj)) {
 681         GST_WARNING_OBJECT (src,
 682             "Can't give latency since device isn't open !");
 683         goto done;
 684       }
 685
 686       fps_n = GST_V4L2_FPS_N (obj);
 687       fps_d = GST_V4L2_FPS_D (obj);
 688
 689       /* we must have a framerate */
 690       if (fps_n <= 0 || fps_d <= 0) {
 691         GST_WARNING_OBJECT (src,
 692             "Can't give latency since framerate isn't fixated !");
 693         goto done;
 694       }
 695
 696       /* min latency is the time to capture one frame */
 697       min_latency = gst_util_uint64_scale_int (GST_SECOND, fps_d, fps_n);
 698
 699       /* max latency is total duration of the frame buffer */
 700       if (obj->pool != NULL)
 701         num_buffers = GST_V4L2_BUFFER_POOL_CAST (obj->pool)->max_latency;
 702
 703       if (num_buffers == 0)
 704         max_latency = -1;
 705       else
 706         max_latency = num_buffers * min_latency;
 707
 708       GST_DEBUG_OBJECT (bsrc,
 709           "report latency min %" GST_TIME_FORMAT " max %" GST_TIME_FORMAT,
 710           GST_TIME_ARGS (min_latency), GST_TIME_ARGS (max_latency));
 711
 712       /* we are always live, the min latency is 1 frame and the max latency is
 713        * the complete buffer of frames. */
 714       gst_query_set_latency (query, TRUE, min_latency, max_latency);
 715
 716       res = TRUE;
 717       break;
 718     }
 719     default:
 720       res = GST_BASE_SRC_CLASS (parent_class)->query (bsrc, query);
 721       break;
 722   }
 723
 724 done:
 725
 726   return res;
 727 }
 728
 729 /* start and stop are not symmetric -- start will open the device, but not start
 730  * capture. it's setcaps that will start capture, which is called via basesrc's
 731  * negotiate method. stop will both stop capture and close the device.
 732  */
 733 static gboolean
 734 gst_v4l2src_start (GstBaseSrc * src)
 735 {
 736   GstV4l2Src *v4l2src = GST_V4L2SRC (src);
 737
 738   v4l2src->offset = 0;
 739   v4l2src->renegotiation_adjust = 0;
 740
 741   /* activate settings for first frame */
 742   v4l2src->ctrl_time = 0;
 743   gst_object_sync_values (GST_OBJECT (src), v4l2src->ctrl_time);
 744
 745   v4l2src->has_bad_timestamp = FALSE;
 746   v4l2src->last_timestamp = 0;
 747
 748   return TRUE;
 749 }
 750
 751 static gboolean
 752 gst_v4l2src_unlock (GstBaseSrc * src)
 753 {
 754   GstV4l2Src *v4l2src = GST_V4L2SRC (src);
 755   return gst_v4l2_object_unlock (v4l2src->v4l2object);
 756 }
 757
 758 static gboolean
 759 gst_v4l2src_unlock_stop (GstBaseSrc * src)
 760 {
 761   GstV4l2Src *v4l2src = GST_V4L2SRC (src);
 762
 763   v4l2src->last_timestamp = 0;
 764
 765   return gst_v4l2_object_unlock_stop (v4l2src->v4l2object);
 766 }
 767
 768 static gboolean
 769 gst_v4l2src_stop (GstBaseSrc * src)
 770 {
 771   GstV4l2Src *v4l2src = GST_V4L2SRC (src);
 772   GstV4l2Object *obj = v4l2src->v4l2object;
 773
 774   if (GST_V4L2_IS_ACTIVE (obj)) {
 775     if (!gst_v4l2_object_stop (obj))
 776       return FALSE;
 777   }
 778
 779   v4l2src->pending_set_fmt = FALSE;
 780
 781   return TRUE;
 782 }
 783
 784 static GstStateChangeReturn
 785 gst_v4l2src_change_state (GstElement * element, GstStateChange transition)
 786 {
 787   GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
 788   GstV4l2Src *v4l2src = GST_V4L2SRC (element);
 789   GstV4l2Object *obj = v4l2src->v4l2object;
 790
 791   switch (transition) {
 792     case GST_STATE_CHANGE_NULL_TO_READY:
 793       /* open the device */
 794       if (!gst_v4l2_object_open (obj))
 795         return GST_STATE_CHANGE_FAILURE;
 796       break;
 797     default:
 798       break;
 799   }
 800
 801   ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
 802
 803   switch (transition) {
 804     case GST_STATE_CHANGE_READY_TO_NULL:
 805       /* close the device */
 806       if (!gst_v4l2_object_close (obj))
 807         return GST_STATE_CHANGE_FAILURE;
 808
 809       break;
 810     default:
 811       break;
 812   }
 813
 814   return ret;
 815 }
 816
 817 static GstFlowReturn
 818 gst_v4l2src_create (GstPushSrc * src, GstBuffer ** buf)
 819 {
 820   GstV4l2Src *v4l2src = GST_V4L2SRC (src);
 821   GstV4l2Object *obj = v4l2src->v4l2object;
 822   GstV4l2BufferPool *pool = GST_V4L2_BUFFER_POOL_CAST (obj->pool);
 823   GstFlowReturn ret;
 824   GstClock *clock;
 825   GstClockTime abs_time, base_time, timestamp, duration;
 826   GstClockTime delay;
 827   GstMessage *qos_msg;
 828
 829   do {
 830     ret = GST_BASE_SRC_CLASS (parent_class)->alloc (GST_BASE_SRC (src), 0,
 831         obj->info.size, buf);
 832
 833     if (G_UNLIKELY (ret != GST_FLOW_OK))
 834       goto alloc_failed;
 835
 836     ret = gst_v4l2_buffer_pool_process (pool, buf);
 837
 838   } while (ret == GST_V4L2_FLOW_CORRUPTED_BUFFER);
 839
 840   if (G_UNLIKELY (ret != GST_FLOW_OK))
 841     goto error;
 842
 843   timestamp = GST_BUFFER_TIMESTAMP (*buf);
 844   duration = obj->duration;
 845
 846   /* timestamps, LOCK to get clock and base time. */
 847   /* FIXME: element clock and base_time is rarely changing */
 848   GST_OBJECT_LOCK (v4l2src);
 849   if ((clock = GST_ELEMENT_CLOCK (v4l2src))) {
 850     /* we have a clock, get base time and ref clock */
 851     base_time = GST_ELEMENT (v4l2src)->base_time;
 852     gst_object_ref (clock);
 853   } else {
 854     /* no clock, can't set timestamps */
 855     base_time = GST_CLOCK_TIME_NONE;
 856   }
 857   GST_OBJECT_UNLOCK (v4l2src);
 858
 859   /* sample pipeline clock */
 860   if (clock) {
 861     abs_time = gst_clock_get_time (clock);
 862     gst_object_unref (clock);
 863   } else {
 864     abs_time = GST_CLOCK_TIME_NONE;
 865   }
 866
 867 retry:
 868   if (!v4l2src->has_bad_timestamp && timestamp != GST_CLOCK_TIME_NONE) {
 869     struct timespec now;
 870     GstClockTime gstnow;
 871
 872     /* v4l2 specs say to use the system time although many drivers switched to
 873      * the more desirable monotonic time. We first try to use the monotonic time
 874      * and see how that goes */
 875     clock_gettime (CLOCK_MONOTONIC, &now);
 876     gstnow = GST_TIMESPEC_TO_TIME (now);
 877
 878     if (timestamp > gstnow || (gstnow - timestamp) > (10 * GST_SECOND)) {
 879       GTimeVal now;
 880
 881       /* very large diff, fall back to system time */
 882       g_get_current_time (&now);
 883       gstnow = GST_TIMEVAL_TO_TIME (now);
 884     }
 885
 886     /* Detect buggy drivers here, and stop using their timestamp. Failing any
 887      * of these condition would imply a very buggy driver:
 888      *   - Timestamp in the future
 889      *   - Timestamp is going backward compare to last seen timestamp
 890      *   - Timestamp is jumping forward for less then a frame duration
 891      *   - Delay is bigger then the actual timestamp
 892      * */
 893     if (timestamp > gstnow) {
 894       GST_WARNING_OBJECT (v4l2src,
 895           "Timestamp in the future detected, ignoring driver timestamps");
 896       v4l2src->has_bad_timestamp = TRUE;
 897       goto retry;
 898     }
 899
 900     if (v4l2src->last_timestamp > timestamp) {
 901       GST_WARNING_OBJECT (v4l2src,
 902           "Timestamp going backward, ignoring driver timestamps");
 903       v4l2src->has_bad_timestamp = TRUE;
 904       goto retry;
 905     }
 906
 907     delay = gstnow - timestamp;
 908
 909     if (delay > timestamp) {
 910       GST_WARNING_OBJECT (v4l2src,
 911           "Timestamp does not correlate with any clock, ignoring driver timestamps");
 912       v4l2src->has_bad_timestamp = TRUE;
 913       goto retry;
 914     }
 915
 916     /* Save last timestamp for sanity checks */
 917     v4l2src->last_timestamp = timestamp;
 918
 919     GST_DEBUG_OBJECT (v4l2src, "ts: %" GST_TIME_FORMAT " now %" GST_TIME_FORMAT
 920         " delay %" GST_TIME_FORMAT, GST_TIME_ARGS (timestamp),
 921         GST_TIME_ARGS (gstnow), GST_TIME_ARGS (delay));
 922   } else {
 923     /* we assume 1 frame latency otherwise */
 924     if (GST_CLOCK_TIME_IS_VALID (duration))
 925       delay = duration;
 926     else
 927       delay = 0;
 928   }
 929
 930   /* set buffer metadata */
 931
 932   if (G_LIKELY (abs_time != GST_CLOCK_TIME_NONE)) {
 933     /* the time now is the time of the clock minus the base time */
 934     timestamp = abs_time - base_time;
 935
 936     /* adjust for delay in the device */
 937     if (timestamp > delay)
 938       timestamp -= delay;
 939     else
 940       timestamp = 0;
 941   } else {
 942     timestamp = GST_CLOCK_TIME_NONE;
 943   }
 944
 945   /* activate settings for next frame */
 946   if (GST_CLOCK_TIME_IS_VALID (duration)) {
 947     v4l2src->ctrl_time += duration;
 948   } else {
 949     /* this is not very good (as it should be the next timestamp),
 950      * still good enough for linear fades (as long as it is not -1)
 951      */
 952     v4l2src->ctrl_time = timestamp;
 953   }
 954   gst_object_sync_values (GST_OBJECT (src), v4l2src->ctrl_time);
 955
 956   GST_INFO_OBJECT (src, "sync to %" GST_TIME_FORMAT " out ts %" GST_TIME_FORMAT,
 957       GST_TIME_ARGS (v4l2src->ctrl_time), GST_TIME_ARGS (timestamp));
 958
 959   /* use generated offset values only if there are not already valid ones
 960    * set by the v4l2 device */
 961   if (!GST_BUFFER_OFFSET_IS_VALID (*buf)
 962       || !GST_BUFFER_OFFSET_END_IS_VALID (*buf)) {
 963     GST_BUFFER_OFFSET (*buf) = v4l2src->offset++;
 964     GST_BUFFER_OFFSET_END (*buf) = v4l2src->offset;
 965   } else {
 966     /* adjust raw v4l2 device sequence, will restart at null in case of renegotiation
 967      * (streamoff/streamon) */
 968     GST_BUFFER_OFFSET (*buf) += v4l2src->renegotiation_adjust;
 969     GST_BUFFER_OFFSET_END (*buf) += v4l2src->renegotiation_adjust;
 970     /* check for frame loss with given (from v4l2 device) buffer offset */
 971     if ((v4l2src->offset != 0)
 972         && (GST_BUFFER_OFFSET (*buf) != (v4l2src->offset + 1))) {
 973       guint64 lost_frame_count = GST_BUFFER_OFFSET (*buf) - v4l2src->offset - 1;
 974       GST_WARNING_OBJECT (v4l2src,
 975           "lost frames detected: count = %" G_GUINT64_FORMAT " - ts: %"
 976           GST_TIME_FORMAT, lost_frame_count, GST_TIME_ARGS (timestamp));
 977
 978       qos_msg = gst_message_new_qos (GST_OBJECT_CAST (v4l2src), TRUE,
 979           GST_CLOCK_TIME_NONE, GST_CLOCK_TIME_NONE, timestamp,
 980           GST_CLOCK_TIME_IS_VALID (duration) ? lost_frame_count *
 981           duration : GST_CLOCK_TIME_NONE);
 982       gst_element_post_message (GST_ELEMENT_CAST (v4l2src), qos_msg);
 983
 984     }
 985     v4l2src->offset = GST_BUFFER_OFFSET (*buf);
 986   }
 987
 988   GST_BUFFER_TIMESTAMP (*buf) = timestamp;
 989   GST_BUFFER_DURATION (*buf) = duration;
 990
 991   return ret;
 992
 993   /* ERROR */
 994 alloc_failed:
 995   {
 996     if (ret != GST_FLOW_FLUSHING)
 997       GST_ELEMENT_ERROR (src, RESOURCE, NO_SPACE_LEFT,
 998           ("Failed to allocate a buffer"), (NULL));
 999     return ret;
1000   }
1001 error:
1002   {
1003     gst_buffer_replace (buf, NULL);
1004     if (ret == GST_V4L2_FLOW_LAST_BUFFER) {
1005       GST_ELEMENT_ERROR (src, RESOURCE, FAILED,
1006           ("Driver returned a buffer with no payload, this most likely "
1007               "indicate a bug in the driver."), (NULL));
1008       ret = GST_FLOW_ERROR;
1009     } else {
1010       GST_DEBUG_OBJECT (src, "error processing buffer %d (%s)", ret,
1011           gst_flow_get_name (ret));
1012     }
1013     return ret;
1014   }
1015 }
1016
1017
1018 /* GstURIHandler interface */
1019 static GstURIType
1020 gst_v4l2src_uri_get_type (GType type)
1021 {
1022   return GST_URI_SRC;
1023 }
1024
1025 static const gchar *const *
1026 gst_v4l2src_uri_get_protocols (GType type)
1027 {
1028   static const gchar *protocols[] = { "v4l2", NULL };
1029
1030   return protocols;
1031 }
1032
1033 static gchar *
1034 gst_v4l2src_uri_get_uri (GstURIHandler * handler)
1035 {
1036   GstV4l2Src *v4l2src = GST_V4L2SRC (handler);
1037
1038   if (v4l2src->v4l2object->videodev != NULL) {
1039     return g_strdup_printf ("v4l2://%s", v4l2src->v4l2object->videodev);
1040   }
1041
1042   return g_strdup ("v4l2://");
1043 }
1044
1045 static gboolean
1046 gst_v4l2src_uri_set_uri (GstURIHandler * handler, const gchar * uri,
1047     GError ** error)
1048 {
1049   GstV4l2Src *v4l2src = GST_V4L2SRC (handler);
1050   const gchar *device = DEFAULT_PROP_DEVICE;
1051
1052   if (strcmp (uri, "v4l2://") != 0) {
1053     device = uri + 7;
1054   }
1055   g_object_set (v4l2src, "device", device, NULL);
1056
1057   return TRUE;
1058 }
1059
1060
1061 static void
1062 gst_v4l2src_uri_handler_init (gpointer g_iface, gpointer iface_data)
1063 {
1064   GstURIHandlerInterface *iface = (GstURIHandlerInterface *) g_iface;
1065
1066   iface->get_type = gst_v4l2src_uri_get_type;
1067   iface->get_protocols = gst_v4l2src_uri_get_protocols;
1068   iface->get_uri = gst_v4l2src_uri_get_uri;
1069   iface->set_uri = gst_v4l2src_uri_set_uri;
1070 }