3 * Copyright (C) 2001-2002 Ronald Bultje <rbultje@ronald.bitfreak.net>
4 * 2006 Edgard Lima <edgard.lima@gmail.com>
5 * 2009 Texas Instruments, Inc - http://www.ti.com/
7 * gstv4l2bufferpool.c V4L2 buffer pool class
9 * This library is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Library General Public
11 * License as published by the Free Software Foundation; either
12 * version 2 of the License, or (at your option) any later version.
14 * This library is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Library General Public License for more details.
19 * You should have received a copy of the GNU Library General Public
20 * License along with this library; if not, write to the
21 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
22 * Boston, MA 02110-1301, USA.
30 # define _GNU_SOURCE /* O_CLOEXEC */
38 #include "gst/video/video.h"
39 #include "gst/video/gstvideometa.h"
40 #include "gst/video/gstvideopool.h"
41 #include "gst/allocators/gstdmabuf.h"
43 #include <gstv4l2bufferpool.h>
45 #include "gstv4l2object.h"
46 #include "gst/gst-i18n-plugin.h"
47 #include <gst/glib-compat-private.h>
49 GST_DEBUG_CATEGORY_STATIC (v4l2bufferpool_debug);
50 GST_DEBUG_CATEGORY_STATIC (CAT_PERFORMANCE);
51 #define GST_CAT_DEFAULT v4l2bufferpool_debug
53 #define GST_V4L2_IMPORT_QUARK gst_v4l2_buffer_pool_import_quark ()
59 #define gst_v4l2_buffer_pool_parent_class parent_class
60 G_DEFINE_TYPE (GstV4l2BufferPool, gst_v4l2_buffer_pool, GST_TYPE_BUFFER_POOL);
62 enum _GstV4l2BufferPoolAcquireFlags
64 GST_V4L2_BUFFER_POOL_ACQUIRE_FLAG_RESURRECT =
65 GST_BUFFER_POOL_ACQUIRE_FLAG_LAST,
66 GST_V4L2_BUFFER_POOL_ACQUIRE_FLAG_LAST
69 static void gst_v4l2_buffer_pool_release_buffer (GstBufferPool * bpool,
73 gst_v4l2_is_buffer_valid (GstBuffer * buffer, GstV4l2MemoryGroup ** out_group)
75 GstMemory *mem = gst_buffer_peek_memory (buffer, 0);
76 gboolean valid = FALSE;
78 if (GST_BUFFER_FLAG_IS_SET (buffer, GST_BUFFER_FLAG_TAG_MEMORY))
81 if (gst_is_dmabuf_memory (mem))
82 mem = gst_mini_object_get_qdata (GST_MINI_OBJECT (mem),
83 GST_V4L2_MEMORY_QUARK);
85 if (mem && gst_is_v4l2_memory (mem)) {
86 GstV4l2Memory *vmem = (GstV4l2Memory *) mem;
87 GstV4l2MemoryGroup *group = vmem->group;
90 if (group->n_mem != gst_buffer_n_memory (buffer))
93 for (i = 0; i < group->n_mem; i++) {
94 if (group->mem[i] != gst_buffer_peek_memory (buffer, i))
97 if (!gst_memory_is_writable (group->mem[i]))
111 gst_v4l2_buffer_pool_copy_buffer (GstV4l2BufferPool * pool, GstBuffer * dest,
114 const GstVideoFormatInfo *finfo = pool->caps_info.finfo;
116 GST_LOG_OBJECT (pool, "copying buffer");
118 if (finfo && (finfo->format != GST_VIDEO_FORMAT_UNKNOWN &&
119 finfo->format != GST_VIDEO_FORMAT_ENCODED)) {
120 GstVideoFrame src_frame, dest_frame;
122 GST_DEBUG_OBJECT (pool, "copy video frame");
124 /* we have raw video, use videoframe copy to get strides right */
125 if (!gst_video_frame_map (&src_frame, &pool->caps_info, src, GST_MAP_READ))
128 if (!gst_video_frame_map (&dest_frame, &pool->caps_info, dest,
130 gst_video_frame_unmap (&src_frame);
134 gst_video_frame_copy (&dest_frame, &src_frame);
136 gst_video_frame_unmap (&src_frame);
137 gst_video_frame_unmap (&dest_frame);
141 GST_DEBUG_OBJECT (pool, "copy raw bytes");
143 if (!gst_buffer_map (src, &map, GST_MAP_READ))
146 gst_buffer_fill (dest, 0, map.data, gst_buffer_get_size (src));
148 gst_buffer_unmap (src, &map);
149 gst_buffer_resize (dest, 0, gst_buffer_get_size (src));
152 gst_buffer_copy_into (dest, src,
153 GST_BUFFER_COPY_FLAGS | GST_BUFFER_COPY_TIMESTAMPS, 0, -1);
155 GST_CAT_LOG_OBJECT (CAT_PERFORMANCE, pool, "slow copy into buffer %p", dest);
161 GST_ERROR_OBJECT (pool, "could not map buffer");
162 return GST_FLOW_ERROR;
175 gst_v4l2_buffer_pool_import_quark (void)
177 static GQuark quark = 0;
180 quark = g_quark_from_string ("GstV4l2BufferPoolUsePtrData");
186 _unmap_userptr_frame (struct UserPtrData *data)
189 gst_video_frame_unmap (&data->frame);
191 gst_buffer_unmap (data->buffer, &data->map);
194 gst_buffer_unref (data->buffer);
196 g_slice_free (struct UserPtrData, data);
200 gst_v4l2_buffer_pool_import_userptr (GstV4l2BufferPool * pool,
201 GstBuffer * dest, GstBuffer * src)
203 GstFlowReturn ret = GST_FLOW_OK;
204 GstV4l2MemoryGroup *group = NULL;
206 const GstVideoFormatInfo *finfo = pool->caps_info.finfo;
207 struct UserPtrData *data = NULL;
209 GST_LOG_OBJECT (pool, "importing userptr");
212 if (!gst_v4l2_is_buffer_valid (dest, &group))
215 if (V4L2_TYPE_IS_OUTPUT (pool->obj->type))
216 flags = GST_MAP_READ;
218 flags = GST_MAP_WRITE;
220 data = g_slice_new0 (struct UserPtrData);
222 if (finfo && (finfo->format != GST_VIDEO_FORMAT_UNKNOWN &&
223 finfo->format != GST_VIDEO_FORMAT_ENCODED)) {
224 gsize size[GST_VIDEO_MAX_PLANES] = { 0, };
227 data->is_frame = TRUE;
229 if (!gst_video_frame_map (&data->frame, &pool->caps_info, src, flags))
232 for (i = 0; i < GST_VIDEO_FORMAT_INFO_N_PLANES (finfo); i++) {
233 if (GST_VIDEO_FORMAT_INFO_IS_TILED (finfo)) {
234 gint tinfo = GST_VIDEO_FRAME_PLANE_STRIDE (&data->frame, i);
238 pstride = GST_VIDEO_TILE_X_TILES (tinfo) <<
239 GST_VIDEO_FORMAT_INFO_TILE_WS (finfo);
241 pheight = GST_VIDEO_TILE_Y_TILES (tinfo) <<
242 GST_VIDEO_FORMAT_INFO_TILE_HS (finfo);
244 size[i] = pstride * pheight;
246 size[i] = GST_VIDEO_FRAME_PLANE_STRIDE (&data->frame, i) *
247 GST_VIDEO_FRAME_COMP_HEIGHT (&data->frame, i);
251 /* In the single planar API, planes must be contiguous in memory and
252 * therefore they must have expected size. ie: no padding.
253 * To check these conditions, we check that plane 'i' start address
254 * + plane 'i' size equals to plane 'i+1' start address */
255 if (!V4L2_TYPE_IS_MULTIPLANAR (pool->obj->type)) {
256 for (i = 0; i < (GST_VIDEO_FORMAT_INFO_N_PLANES (finfo) - 1); i++) {
257 const struct v4l2_pix_format *pix_fmt = &pool->obj->format.fmt.pix;
259 gint estride = gst_v4l2_object_extrapolate_stride (finfo, i,
260 pix_fmt->bytesperline);
261 guint eheight = GST_VIDEO_FORMAT_INFO_SCALE_HEIGHT (finfo, i,
264 tmp = ((guint8 *) data->frame.data[i]) + estride * eheight;
265 if (tmp != data->frame.data[i + 1])
266 goto non_contiguous_mem;
270 if (!gst_v4l2_allocator_import_userptr (pool->vallocator, group,
271 data->frame.info.size, finfo->n_planes, data->frame.data, size))
277 data->is_frame = FALSE;
279 if (!gst_buffer_map (src, &data->map, flags))
282 ptr[0] = data->map.data;
283 size[0] = data->map.size;
285 if (!gst_v4l2_allocator_import_userptr (pool->vallocator, group,
286 data->map.size, 1, ptr, size))
290 data->buffer = gst_buffer_ref (src);
292 gst_mini_object_set_qdata (GST_MINI_OBJECT (dest), GST_V4L2_IMPORT_QUARK,
293 data, (GDestroyNotify) _unmap_userptr_frame);
295 gst_buffer_copy_into (dest, src,
296 GST_BUFFER_COPY_FLAGS | GST_BUFFER_COPY_TIMESTAMPS, 0, -1);
302 GST_ERROR_OBJECT (pool, "destination buffer invalid or not from our pool");
303 return GST_FLOW_ERROR;
307 GST_ERROR_OBJECT (pool, "could not map buffer");
308 g_slice_free (struct UserPtrData, data);
309 return GST_FLOW_ERROR;
313 GST_ERROR_OBJECT (pool, "memory is not contiguous or plane size mismatch");
314 _unmap_userptr_frame (data);
315 return GST_FLOW_ERROR;
319 GST_ERROR_OBJECT (pool, "failed to import data");
320 _unmap_userptr_frame (data);
321 return GST_FLOW_ERROR;
326 gst_v4l2_buffer_pool_import_dmabuf (GstV4l2BufferPool * pool,
327 GstBuffer * dest, GstBuffer * src)
329 GstV4l2MemoryGroup *group = NULL;
330 GstMemory *dma_mem[GST_VIDEO_MAX_PLANES] = { 0 };
331 guint n_mem = gst_buffer_n_memory (src);
334 GST_LOG_OBJECT (pool, "importing dmabuf");
336 if (!gst_v4l2_is_buffer_valid (dest, &group))
339 if (n_mem > GST_VIDEO_MAX_PLANES)
342 for (i = 0; i < n_mem; i++)
343 dma_mem[i] = gst_buffer_peek_memory (src, i);
345 if (!gst_v4l2_allocator_import_dmabuf (pool->vallocator, group, n_mem,
349 gst_mini_object_set_qdata (GST_MINI_OBJECT (dest), GST_V4L2_IMPORT_QUARK,
350 gst_buffer_ref (src), (GDestroyNotify) gst_buffer_unref);
352 gst_buffer_copy_into (dest, src,
353 GST_BUFFER_COPY_FLAGS | GST_BUFFER_COPY_TIMESTAMPS, 0, -1);
359 GST_ERROR_OBJECT (pool, "destination buffer invalid or not from our pool");
360 return GST_FLOW_ERROR;
364 GST_ERROR_OBJECT (pool, "could not map buffer");
365 return GST_FLOW_ERROR;
369 GST_ERROR_OBJECT (pool, "failed to import dmabuf");
370 return GST_FLOW_ERROR;
375 gst_v4l2_buffer_pool_prepare_buffer (GstV4l2BufferPool * pool,
376 GstBuffer * dest, GstBuffer * src)
378 GstFlowReturn ret = GST_FLOW_OK;
379 gboolean own_src = FALSE;
382 if (pool->other_pool == NULL) {
383 GST_ERROR_OBJECT (pool, "can't prepare buffer, source buffer missing");
384 return GST_FLOW_ERROR;
387 ret = gst_buffer_pool_acquire_buffer (pool->other_pool, &src, NULL);
388 if (ret != GST_FLOW_OK) {
389 GST_ERROR_OBJECT (pool, "failed to acquire buffer from downstream pool");
396 switch (pool->obj->mode) {
397 case GST_V4L2_IO_MMAP:
398 case GST_V4L2_IO_DMABUF:
399 ret = gst_v4l2_buffer_pool_copy_buffer (pool, dest, src);
401 case GST_V4L2_IO_USERPTR:
402 ret = gst_v4l2_buffer_pool_import_userptr (pool, dest, src);
404 case GST_V4L2_IO_DMABUF_IMPORT:
405 ret = gst_v4l2_buffer_pool_import_dmabuf (pool, dest, src);
412 gst_buffer_unref (src);
419 gst_v4l2_buffer_pool_alloc_buffer (GstBufferPool * bpool, GstBuffer ** buffer,
420 GstBufferPoolAcquireParams * params)
422 GstV4l2BufferPool *pool = GST_V4L2_BUFFER_POOL (bpool);
423 GstV4l2MemoryGroup *group = NULL;
424 GstBuffer *newbuf = NULL;
434 gst_buffer_new_allocate (pool->allocator, pool->size, &pool->params);
436 case GST_V4L2_IO_MMAP:
437 group = gst_v4l2_allocator_alloc_mmap (pool->vallocator);
439 case GST_V4L2_IO_DMABUF:
440 group = gst_v4l2_allocator_alloc_dmabuf (pool->vallocator,
443 case GST_V4L2_IO_USERPTR:
444 group = gst_v4l2_allocator_alloc_userptr (pool->vallocator);
446 case GST_V4L2_IO_DMABUF_IMPORT:
447 group = gst_v4l2_allocator_alloc_dmabufin (pool->vallocator);
451 g_assert_not_reached ();
457 newbuf = gst_buffer_new ();
459 for (i = 0; i < group->n_mem; i++)
460 gst_buffer_append_memory (newbuf, group->mem[i]);
461 } else if (newbuf == NULL) {
462 goto allocation_failed;
465 /* add metadata to raw video buffers */
466 if (pool->add_videometa)
467 gst_buffer_add_video_meta_full (newbuf, GST_VIDEO_FRAME_FLAG_NONE,
468 GST_VIDEO_INFO_FORMAT (info), GST_VIDEO_INFO_WIDTH (info),
469 GST_VIDEO_INFO_HEIGHT (info), GST_VIDEO_INFO_N_PLANES (info),
470 info->offset, info->stride);
479 GST_ERROR_OBJECT (pool, "failed to allocate buffer");
480 return GST_FLOW_ERROR;
485 gst_v4l2_buffer_pool_set_config (GstBufferPool * bpool, GstStructure * config)
487 GstV4l2BufferPool *pool = GST_V4L2_BUFFER_POOL (bpool);
488 GstV4l2Object *obj = pool->obj;
490 guint size, min_buffers, max_buffers;
491 GstAllocator *allocator;
492 GstAllocationParams params;
493 gboolean can_allocate = FALSE;
494 gboolean updated = FALSE;
497 pool->add_videometa =
498 gst_buffer_pool_config_has_option (config,
499 GST_BUFFER_POOL_OPTION_VIDEO_META);
501 /* parse the config and keep around */
502 if (!gst_buffer_pool_config_get_params (config, &caps, &size, &min_buffers,
506 if (!gst_buffer_pool_config_get_allocator (config, &allocator, ¶ms))
509 GST_DEBUG_OBJECT (pool, "config %" GST_PTR_FORMAT, config);
512 gst_object_unref (pool->allocator);
513 pool->allocator = NULL;
516 case GST_V4L2_IO_DMABUF:
517 pool->allocator = gst_dmabuf_allocator_new ();
518 can_allocate = GST_V4L2_ALLOCATOR_CAN_ALLOCATE (pool->vallocator, MMAP);
520 case GST_V4L2_IO_MMAP:
521 can_allocate = GST_V4L2_ALLOCATOR_CAN_ALLOCATE (pool->vallocator, MMAP);
523 case GST_V4L2_IO_USERPTR:
525 GST_V4L2_ALLOCATOR_CAN_ALLOCATE (pool->vallocator, USERPTR);
527 case GST_V4L2_IO_DMABUF_IMPORT:
528 can_allocate = GST_V4L2_ALLOCATOR_CAN_ALLOCATE (pool->vallocator, DMABUF);
532 pool->allocator = g_object_ref (allocator);
533 pool->params = params;
534 /* No need to change the configuration */
538 g_assert_not_reached ();
542 /* libv4l2 conversion code does not handle CREATE_BUFS, and may lead to
543 * instability and crash, disable it for now */
544 if (can_allocate && obj->fmtdesc->flags & V4L2_FMT_FLAG_EMULATED) {
545 GST_WARNING_OBJECT (pool,
546 "libv4l2 converter detected, disabling CREATE_BUFS");
547 can_allocate = FALSE;
548 GST_OBJECT_FLAG_UNSET (pool->vallocator,
549 GST_V4L2_ALLOCATOR_FLAG_MMAP_CREATE_BUFS
550 | GST_V4L2_ALLOCATOR_FLAG_USERPTR_CREATE_BUFS
551 | GST_V4L2_ALLOCATOR_FLAG_DMABUF_CREATE_BUFS);
554 if (min_buffers < GST_V4L2_MIN_BUFFERS (obj)) {
556 min_buffers = GST_V4L2_MIN_BUFFERS (obj);
557 GST_INFO_OBJECT (pool, "increasing minimum buffers to %u", min_buffers);
560 /* respect driver requirements */
561 if (min_buffers < obj->min_buffers) {
563 min_buffers = obj->min_buffers;
564 GST_INFO_OBJECT (pool, "increasing minimum buffers to %u", min_buffers);
567 if (max_buffers > VIDEO_MAX_FRAME || max_buffers == 0) {
569 max_buffers = VIDEO_MAX_FRAME;
570 GST_INFO_OBJECT (pool, "reducing maximum buffers to %u", max_buffers);
573 if (min_buffers > max_buffers) {
575 min_buffers = max_buffers;
576 GST_INFO_OBJECT (pool, "reducing minimum buffers to %u", min_buffers);
577 } else if (min_buffers != max_buffers) {
580 max_buffers = min_buffers;
581 GST_INFO_OBJECT (pool, "can't allocate, setting maximum to minimum");
585 if (!pool->add_videometa && obj->need_video_meta) {
586 GST_INFO_OBJECT (pool, "adding needed video meta");
588 gst_buffer_pool_config_add_option (config,
589 GST_BUFFER_POOL_OPTION_VIDEO_META);
592 /* Always update the config to ensure the configured size matches */
593 gst_buffer_pool_config_set_params (config, caps, obj->info.size, min_buffers,
596 /* keep a GstVideoInfo with defaults for the when we need to copy */
597 gst_video_info_from_caps (&pool->caps_info, caps);
600 ret = GST_BUFFER_POOL_CLASS (parent_class)->set_config (bpool, config);
602 /* If anything was changed documentation recommend to return FALSE */
603 return !updated && ret;
608 GST_ERROR_OBJECT (pool, "invalid config %" GST_PTR_FORMAT, config);
614 gst_v4l2_buffer_pool_resurrect_buffer (GstV4l2BufferPool * pool)
616 GstBufferPoolAcquireParams params = { 0 };
617 GstBuffer *buffer = NULL;
620 GST_DEBUG_OBJECT (pool, "A buffer was lost, reallocating it");
622 /* block recursive calls to this function */
623 g_signal_handler_block (pool->vallocator, pool->group_released_handler);
626 (GstBufferPoolAcquireFlags) GST_V4L2_BUFFER_POOL_ACQUIRE_FLAG_RESURRECT |
627 GST_BUFFER_POOL_ACQUIRE_FLAG_DONTWAIT;
629 gst_buffer_pool_acquire_buffer (GST_BUFFER_POOL (pool), &buffer, ¶ms);
631 if (ret == GST_FLOW_OK)
632 gst_buffer_unref (buffer);
634 g_signal_handler_unblock (pool->vallocator, pool->group_released_handler);
640 gst_v4l2_buffer_pool_streamon (GstV4l2BufferPool * pool)
642 GstV4l2Object *obj = pool->obj;
648 case GST_V4L2_IO_MMAP:
649 case GST_V4L2_IO_USERPTR:
650 case GST_V4L2_IO_DMABUF:
651 case GST_V4L2_IO_DMABUF_IMPORT:
652 if (!V4L2_TYPE_IS_OUTPUT (pool->obj->type)) {
656 num_queued = g_atomic_int_get (&pool->num_queued);
657 if (num_queued < pool->num_allocated)
658 n = pool->num_allocated - num_queued;
660 /* For captures, we need to enqueue buffers before we start streaming,
661 * so the driver don't underflow immediately. As we have put then back
662 * into the base class queue, resurrect them, then releasing will queue
664 for (i = 0; i < n; i++)
665 gst_v4l2_buffer_pool_resurrect_buffer (pool);
668 if (obj->ioctl (pool->video_fd, VIDIOC_STREAMON, &obj->type) < 0)
669 goto streamon_failed;
671 pool->streaming = TRUE;
673 GST_DEBUG_OBJECT (pool, "Started streaming");
683 GST_ERROR_OBJECT (pool, "error with STREAMON %d (%s)", errno,
689 /* Call with streamlock held, or when streaming threads are down */
691 gst_v4l2_buffer_pool_streamoff (GstV4l2BufferPool * pool)
693 GstBufferPoolClass *pclass = GST_BUFFER_POOL_CLASS (parent_class);
694 GstV4l2Object *obj = pool->obj;
697 if (!pool->streaming)
701 case GST_V4L2_IO_MMAP:
702 case GST_V4L2_IO_USERPTR:
703 case GST_V4L2_IO_DMABUF:
704 case GST_V4L2_IO_DMABUF_IMPORT:
706 if (obj->ioctl (pool->video_fd, VIDIOC_STREAMOFF, &obj->type) < 0)
707 GST_WARNING_OBJECT (pool, "STREAMOFF failed with errno %d (%s)",
708 errno, g_strerror (errno));
710 pool->streaming = FALSE;
712 GST_DEBUG_OBJECT (pool, "Stopped streaming");
714 if (pool->vallocator)
715 gst_v4l2_allocator_flush (pool->vallocator);
721 for (i = 0; i < VIDEO_MAX_FRAME; i++) {
722 if (pool->buffers[i]) {
723 GstBuffer *buffer = pool->buffers[i];
724 GstBufferPool *bpool = GST_BUFFER_POOL (pool);
726 pool->buffers[i] = NULL;
728 if (V4L2_TYPE_IS_OUTPUT (pool->obj->type))
729 gst_v4l2_buffer_pool_release_buffer (bpool, buffer);
730 else /* Don't re-enqueue capture buffer on stop */
731 pclass->release_buffer (bpool, buffer);
733 g_atomic_int_add (&pool->num_queued, -1);
739 gst_v4l2_buffer_pool_start (GstBufferPool * bpool)
741 GstV4l2BufferPool *pool = GST_V4L2_BUFFER_POOL (bpool);
742 GstBufferPoolClass *pclass = GST_BUFFER_POOL_CLASS (parent_class);
743 GstV4l2Object *obj = pool->obj;
744 GstStructure *config;
746 guint size, min_buffers, max_buffers;
747 guint max_latency, min_latency, copy_threshold = 0;
748 gboolean can_allocate = FALSE, ret = TRUE;
750 GST_DEBUG_OBJECT (pool, "activating pool");
752 if (pool->other_pool) {
755 if (!gst_buffer_pool_set_active (pool->other_pool, TRUE))
756 goto other_pool_failed;
758 if (gst_buffer_pool_acquire_buffer (pool->other_pool, &buffer, NULL) !=
760 goto other_pool_failed;
762 if (!gst_v4l2_object_try_import (obj, buffer)) {
763 gst_buffer_unref (buffer);
766 gst_buffer_unref (buffer);
769 config = gst_buffer_pool_get_config (bpool);
770 if (!gst_buffer_pool_config_get_params (config, &caps, &size, &min_buffers,
774 min_latency = MAX (GST_V4L2_MIN_BUFFERS (obj), obj->min_buffers);
780 /* This workaround a unfixable bug in libv4l2 when RW is emulated on top
781 * of MMAP. In this case, the first read initialize the queues, but the
782 * poll before that will always fail. Doing an empty read, forces the
783 * queue to be initialized now. We only do this if we have a streaming
785 if (obj->device_caps & V4L2_CAP_STREAMING)
786 obj->read (obj->video_fd, NULL, 0);
789 case GST_V4L2_IO_DMABUF:
790 case GST_V4L2_IO_MMAP:
794 can_allocate = GST_V4L2_ALLOCATOR_CAN_ALLOCATE (pool->vallocator, MMAP);
796 /* first, lets request buffers, and see how many we can get: */
797 GST_DEBUG_OBJECT (pool, "requesting %d MMAP buffers", min_buffers);
799 count = gst_v4l2_allocator_start (pool->vallocator, min_buffers,
801 pool->num_allocated = count;
803 if (count < GST_V4L2_MIN_BUFFERS (obj)) {
808 /* V4L2 buffer pool are often very limited in the amount of buffers it
809 * can offer. The copy_threshold will workaround this limitation by
810 * falling back to copy if the pipeline needed more buffers. This also
811 * prevent having to do REQBUFS(N)/REQBUFS(0) every time configure is
813 if (count != min_buffers || pool->enable_copy_threshold) {
814 GST_WARNING_OBJECT (pool,
815 "Uncertain or not enough buffers, enabling copy threshold");
817 copy_threshold = min_latency;
822 case GST_V4L2_IO_USERPTR:
827 GST_V4L2_ALLOCATOR_CAN_ALLOCATE (pool->vallocator, USERPTR);
829 GST_DEBUG_OBJECT (pool, "requesting %d USERPTR buffers", min_buffers);
831 count = gst_v4l2_allocator_start (pool->vallocator, min_buffers,
832 V4L2_MEMORY_USERPTR);
833 pool->num_allocated = count;
835 /* There is no rational to not get what we asked */
836 if (count < min_buffers) {
844 case GST_V4L2_IO_DMABUF_IMPORT:
848 can_allocate = GST_V4L2_ALLOCATOR_CAN_ALLOCATE (pool->vallocator, DMABUF);
850 GST_DEBUG_OBJECT (pool, "requesting %d DMABUF buffers", min_buffers);
852 count = gst_v4l2_allocator_start (pool->vallocator, min_buffers,
854 pool->num_allocated = count;
856 /* There is no rational to not get what we asked */
857 if (count < min_buffers) {
868 g_assert_not_reached ();
873 max_latency = max_buffers;
875 max_latency = min_buffers;
878 pool->copy_threshold = copy_threshold;
879 pool->max_latency = max_latency;
880 pool->min_latency = min_latency;
881 pool->num_queued = 0;
883 if (max_buffers != 0 && max_buffers < min_buffers)
884 max_buffers = min_buffers;
886 gst_buffer_pool_config_set_params (config, caps, size, min_buffers,
888 pclass->set_config (bpool, config);
889 gst_structure_free (config);
891 /* now, allocate the buffers: */
892 if (!pclass->start (bpool))
895 if (!V4L2_TYPE_IS_OUTPUT (obj->type)) {
896 if (g_atomic_int_get (&pool->num_queued) < pool->num_allocated)
899 pool->group_released_handler =
900 g_signal_connect_swapped (pool->vallocator, "group-released",
901 G_CALLBACK (gst_v4l2_buffer_pool_resurrect_buffer), pool);
902 ret = gst_v4l2_buffer_pool_streamon (pool);
910 GST_ERROR_OBJECT (pool, "invalid config %" GST_PTR_FORMAT, config);
911 gst_structure_free (config);
916 GST_ERROR_OBJECT (pool,
917 "we received %d buffer from device '%s', we want at least %d",
918 min_buffers, obj->videodev, GST_V4L2_MIN_BUFFERS (obj));
919 gst_structure_free (config);
924 GST_ERROR_OBJECT (pool, "allocate failed");
929 GST_ERROR_OBJECT (pool, "failed to activate the other pool %"
930 GST_PTR_FORMAT, pool->other_pool);
935 GST_ERROR_OBJECT (pool, "failed to queue buffers into the capture queue");
940 GST_ERROR_OBJECT (pool, "cannot import buffers from downstream pool");
946 gst_v4l2_buffer_pool_vallocator_stop (GstV4l2BufferPool * pool)
950 if (!pool->vallocator)
953 vret = gst_v4l2_allocator_stop (pool->vallocator);
955 if (vret == GST_V4L2_BUSY)
956 GST_WARNING_OBJECT (pool, "some buffers are still outstanding");
958 return (vret == GST_V4L2_OK);
962 gst_v4l2_buffer_pool_stop (GstBufferPool * bpool)
964 GstV4l2BufferPool *pool = GST_V4L2_BUFFER_POOL (bpool);
967 GST_DEBUG_OBJECT (pool, "stopping pool");
969 if (pool->group_released_handler > 0) {
970 g_signal_handler_disconnect (pool->vallocator,
971 pool->group_released_handler);
972 pool->group_released_handler = 0;
975 if (pool->other_pool) {
976 gst_buffer_pool_set_active (pool->other_pool, FALSE);
977 gst_object_unref (pool->other_pool);
978 pool->other_pool = NULL;
982 gst_v4l2_buffer_pool_streamoff (pool);
984 ret = GST_BUFFER_POOL_CLASS (parent_class)->stop (bpool);
987 ret = gst_v4l2_buffer_pool_vallocator_stop (pool);
993 gst_v4l2_buffer_pool_orphan (GstBufferPool ** bpool)
995 GstV4l2BufferPool *pool = GST_V4L2_BUFFER_POOL (*bpool);
998 g_return_val_if_fail (pool->orphaned == FALSE, FALSE);
1000 if (!GST_V4L2_ALLOCATOR_CAN_ORPHAN_BUFS (pool->vallocator))
1003 if (g_getenv ("GST_V4L2_FORCE_DRAIN"))
1006 GST_DEBUG_OBJECT (pool, "orphaning pool");
1007 gst_buffer_pool_set_active (*bpool, FALSE);
1009 /* We lock to prevent racing with a return buffer in QBuf, and has a
1010 * workaround of not being able to use the pool hidden activation lock. */
1011 GST_OBJECT_LOCK (pool);
1013 gst_v4l2_buffer_pool_streamoff (pool);
1014 ret = gst_v4l2_allocator_orphan (pool->vallocator);
1016 pool->orphaned = TRUE;
1018 GST_OBJECT_UNLOCK (pool);
1021 gst_object_unref (*bpool);
1029 gst_v4l2_buffer_pool_flush_start (GstBufferPool * bpool)
1031 GstV4l2BufferPool *pool = GST_V4L2_BUFFER_POOL (bpool);
1033 GST_DEBUG_OBJECT (pool, "start flushing");
1035 gst_poll_set_flushing (pool->poll, TRUE);
1037 GST_OBJECT_LOCK (pool);
1038 pool->empty = FALSE;
1039 g_cond_broadcast (&pool->empty_cond);
1040 GST_OBJECT_UNLOCK (pool);
1042 if (pool->other_pool && gst_buffer_pool_is_active (pool->other_pool))
1043 gst_buffer_pool_set_flushing (pool->other_pool, TRUE);
1047 gst_v4l2_buffer_pool_flush_stop (GstBufferPool * bpool)
1049 GstV4l2BufferPool *pool = GST_V4L2_BUFFER_POOL (bpool);
1051 GST_DEBUG_OBJECT (pool, "stop flushing");
1053 if (pool->other_pool && gst_buffer_pool_is_active (pool->other_pool))
1054 gst_buffer_pool_set_flushing (pool->other_pool, FALSE);
1056 gst_poll_set_flushing (pool->poll, FALSE);
1059 static GstFlowReturn
1060 gst_v4l2_buffer_pool_poll (GstV4l2BufferPool * pool, gboolean wait)
1063 GstClockTime timeout;
1066 timeout = GST_CLOCK_TIME_NONE;
1070 /* In RW mode there is no queue, hence no need to wait while the queue is
1072 if (pool->obj->mode != GST_V4L2_IO_RW) {
1073 GST_OBJECT_LOCK (pool);
1075 if (!wait && pool->empty) {
1076 GST_OBJECT_UNLOCK (pool);
1081 g_cond_wait (&pool->empty_cond, GST_OBJECT_GET_LOCK (pool));
1083 GST_OBJECT_UNLOCK (pool);
1086 if (!pool->can_poll_device) {
1093 GST_LOG_OBJECT (pool, "polling device");
1096 ret = gst_poll_wait (pool->poll, timeout);
1097 if (G_UNLIKELY (ret < 0)) {
1105 GST_WARNING_OBJECT (pool,
1106 "v4l2 device doesn't support polling. Disabling"
1107 " using libv4l2 in this case may cause deadlocks");
1108 pool->can_poll_device = FALSE;
1115 if (gst_poll_fd_has_error (pool->poll, &pool->pollfd))
1118 /* PRI is used to signal that events are available */
1119 if (gst_poll_fd_has_pri (pool->poll, &pool->pollfd)) {
1120 struct v4l2_event event = { 0, };
1122 if (!gst_v4l2_dequeue_event (pool->obj, &event))
1123 goto dqevent_failed;
1125 if (event.type != V4L2_EVENT_SOURCE_CHANGE) {
1126 GST_INFO_OBJECT (pool, "Received unhandled event, ignoring.");
1130 if ((event.u.src_change.changes & V4L2_EVENT_SRC_CH_RESOLUTION) == 0) {
1131 GST_DEBUG_OBJECT (pool,
1132 "Received non-resolution source-change, ignoring.");
1136 return GST_V4L2_FLOW_RESOLUTION_CHANGE;
1148 GST_DEBUG_OBJECT (pool, "stop called");
1149 return GST_FLOW_FLUSHING;
1153 GST_ELEMENT_ERROR (pool->obj->element, RESOURCE, READ, (NULL),
1154 ("poll error %d: %s (%d)", ret, g_strerror (errno), errno));
1155 return GST_FLOW_ERROR;
1159 return GST_V4L2_FLOW_LAST_BUFFER;
1163 GST_ELEMENT_ERROR (pool->obj->element, RESOURCE, READ, (NULL),
1164 ("dqevent error: %s (%d)", g_strerror (errno), errno));
1165 return GST_FLOW_ERROR;
1169 static GstFlowReturn
1170 gst_v4l2_buffer_pool_qbuf (GstV4l2BufferPool * pool, GstBuffer * buf,
1171 GstV4l2MemoryGroup * group, guint32 * frame_number)
1173 const GstV4l2Object *obj = pool->obj;
1176 index = group->buffer.index;
1178 if (pool->buffers[index] != NULL)
1179 goto already_queued;
1181 GST_LOG_OBJECT (pool, "queuing buffer %i", index);
1183 if (V4L2_TYPE_IS_OUTPUT (obj->type)) {
1184 enum v4l2_field field;
1186 /* Buffer field is the same as the one defined in format */
1187 if (V4L2_TYPE_IS_MULTIPLANAR (obj->type))
1188 field = obj->format.fmt.pix_mp.field;
1190 field = obj->format.fmt.pix.field;
1192 group->buffer.field = field;
1196 group->buffer.timestamp.tv_sec = *frame_number;
1197 group->buffer.timestamp.tv_usec = 0;
1199 if (GST_BUFFER_TIMESTAMP_IS_VALID (buf)) {
1200 GstClockTime timestamp = GST_BUFFER_TIMESTAMP (buf);
1201 GST_TIME_TO_TIMEVAL (timestamp, group->buffer.timestamp);
1203 group->buffer.timestamp.tv_sec = -1;
1204 group->buffer.timestamp.tv_usec = -1;
1208 GST_OBJECT_LOCK (pool);
1210 /* If the pool was orphaned, don't try to queue any returned buffers.
1211 * This is done with the objet lock in order to synchronize with
1216 g_atomic_int_inc (&pool->num_queued);
1217 pool->buffers[index] = buf;
1219 if (!gst_v4l2_allocator_qbuf (pool->vallocator, group))
1222 pool->empty = FALSE;
1223 g_cond_signal (&pool->empty_cond);
1224 GST_OBJECT_UNLOCK (pool);
1230 GST_ERROR_OBJECT (pool, "the buffer %i was already queued", index);
1231 return GST_FLOW_ERROR;
1235 GST_DEBUG_OBJECT (pool, "pool was orphaned, not queuing back buffer.");
1236 GST_BUFFER_FLAG_SET (buf, GST_BUFFER_FLAG_TAG_MEMORY);
1237 GST_OBJECT_UNLOCK (pool);
1238 return GST_FLOW_FLUSHING;
1242 GST_ERROR_OBJECT (pool, "could not queue a buffer %i", index);
1243 /* Mark broken buffer to the allocator */
1244 GST_BUFFER_FLAG_SET (buf, GST_BUFFER_FLAG_TAG_MEMORY);
1245 g_atomic_int_add (&pool->num_queued, -1);
1246 pool->buffers[index] = NULL;
1247 GST_OBJECT_UNLOCK (pool);
1248 return GST_FLOW_ERROR;
1252 static GstFlowReturn
1253 gst_v4l2_buffer_pool_dqbuf (GstV4l2BufferPool * pool, GstBuffer ** buffer,
1257 GstBuffer *outbuf = NULL;
1258 GstV4l2Object *obj = pool->obj;
1259 GstClockTime timestamp;
1260 GstV4l2MemoryGroup *group;
1261 GstVideoMeta *vmeta;
1265 if ((res = gst_v4l2_buffer_pool_poll (pool, wait)) < GST_FLOW_OK)
1268 if (res == GST_V4L2_FLOW_LAST_BUFFER) {
1269 GST_LOG_OBJECT (pool, "nothing to dequeue");
1273 if (res == GST_V4L2_FLOW_RESOLUTION_CHANGE) {
1274 GST_INFO_OBJECT (pool, "Resolution change detected.");
1278 GST_LOG_OBJECT (pool, "dequeueing a buffer");
1280 res = gst_v4l2_allocator_dqbuf (pool->vallocator, &group);
1281 if (res == GST_FLOW_EOS)
1283 if (res != GST_FLOW_OK)
1286 /* get our GstBuffer with that index from the pool, if the buffer was
1287 * outstanding we have a serious problem.
1289 outbuf = pool->buffers[group->buffer.index];
1293 /* mark the buffer outstanding */
1294 pool->buffers[group->buffer.index] = NULL;
1295 if (g_atomic_int_dec_and_test (&pool->num_queued)) {
1296 GST_OBJECT_LOCK (pool);
1298 GST_OBJECT_UNLOCK (pool);
1301 timestamp = GST_TIMEVAL_TO_TIME (group->buffer.timestamp);
1304 vmeta = gst_buffer_get_video_meta (outbuf);
1305 for (i = 0; i < group->n_mem; i++) {
1306 GST_LOG_OBJECT (pool,
1307 "dequeued buffer %p seq:%d (ix=%d), mem %p used %d, plane=%d, flags %08x, ts %"
1308 GST_TIME_FORMAT ", pool-queued=%d, buffer=%p", outbuf,
1309 group->buffer.sequence, group->buffer.index, group->mem[i],
1310 group->planes[i].bytesused, i, group->buffer.flags,
1311 GST_TIME_ARGS (timestamp), pool->num_queued, outbuf);
1314 vmeta->offset[i] = size;
1315 size += gst_memory_get_sizes (group->mem[i], NULL, NULL);
1319 /* Ignore timestamp and field for OUTPUT device */
1320 if (V4L2_TYPE_IS_OUTPUT (obj->type))
1323 /* Check for driver bug in reporting feild */
1324 if (group->buffer.field == V4L2_FIELD_ANY) {
1325 /* Only warn once to avoid the spamming */
1326 #ifndef GST_DISABLE_GST_DEBUG
1327 if (!pool->has_warned_on_buggy_field) {
1328 pool->has_warned_on_buggy_field = TRUE;
1329 GST_WARNING_OBJECT (pool,
1330 "Driver should never set v4l2_buffer.field to ANY");
1334 /* Use the value from the format (works for UVC bug) */
1335 group->buffer.field = obj->format.fmt.pix.field;
1337 /* If driver also has buggy S_FMT, assume progressive */
1338 if (group->buffer.field == V4L2_FIELD_ANY) {
1339 #ifndef GST_DISABLE_GST_DEBUG
1340 if (!pool->has_warned_on_buggy_field) {
1341 pool->has_warned_on_buggy_field = TRUE;
1342 GST_WARNING_OBJECT (pool,
1343 "Driver should never set v4l2_format.pix.field to ANY");
1347 group->buffer.field = V4L2_FIELD_NONE;
1351 /* set top/bottom field first if v4l2_buffer has the information */
1352 switch (group->buffer.field) {
1353 case V4L2_FIELD_NONE:
1354 GST_BUFFER_FLAG_UNSET (outbuf, GST_VIDEO_BUFFER_FLAG_INTERLACED);
1355 GST_BUFFER_FLAG_UNSET (outbuf, GST_VIDEO_BUFFER_FLAG_TFF);
1357 case V4L2_FIELD_TOP:
1358 GST_BUFFER_FLAG_SET (outbuf, GST_VIDEO_BUFFER_FLAG_INTERLACED);
1359 GST_BUFFER_FLAG_SET (outbuf, GST_VIDEO_BUFFER_FLAG_TOP_FIELD);
1361 case V4L2_FIELD_BOTTOM:
1362 GST_BUFFER_FLAG_SET (outbuf, GST_VIDEO_BUFFER_FLAG_INTERLACED);
1363 GST_BUFFER_FLAG_SET (outbuf, GST_VIDEO_BUFFER_FLAG_BOTTOM_FIELD);
1365 case V4L2_FIELD_INTERLACED_TB:
1366 GST_BUFFER_FLAG_SET (outbuf, GST_VIDEO_BUFFER_FLAG_INTERLACED);
1367 GST_BUFFER_FLAG_SET (outbuf, GST_VIDEO_BUFFER_FLAG_TFF);
1369 case V4L2_FIELD_INTERLACED_BT:
1370 GST_BUFFER_FLAG_SET (outbuf, GST_VIDEO_BUFFER_FLAG_INTERLACED);
1371 GST_BUFFER_FLAG_UNSET (outbuf, GST_VIDEO_BUFFER_FLAG_TFF);
1373 case V4L2_FIELD_INTERLACED:
1374 GST_BUFFER_FLAG_SET (outbuf, GST_VIDEO_BUFFER_FLAG_INTERLACED);
1375 if (obj->tv_norm == V4L2_STD_NTSC_M ||
1376 obj->tv_norm == V4L2_STD_NTSC_M_JP ||
1377 obj->tv_norm == V4L2_STD_NTSC_M_KR) {
1378 GST_BUFFER_FLAG_UNSET (outbuf, GST_VIDEO_BUFFER_FLAG_TFF);
1380 GST_BUFFER_FLAG_SET (outbuf, GST_VIDEO_BUFFER_FLAG_TFF);
1384 GST_BUFFER_FLAG_UNSET (outbuf, GST_VIDEO_BUFFER_FLAG_INTERLACED);
1385 GST_BUFFER_FLAG_UNSET (outbuf, GST_VIDEO_BUFFER_FLAG_TFF);
1386 GST_FIXME_OBJECT (pool,
1387 "Unhandled enum v4l2_field %d - treating as progressive",
1388 group->buffer.field);
1392 if (GST_VIDEO_INFO_FORMAT (&obj->info) == GST_VIDEO_FORMAT_ENCODED) {
1393 if ((group->buffer.flags & V4L2_BUF_FLAG_KEYFRAME) ||
1394 GST_V4L2_PIXELFORMAT (obj) == V4L2_PIX_FMT_MJPEG ||
1395 GST_V4L2_PIXELFORMAT (obj) == V4L2_PIX_FMT_JPEG ||
1396 GST_V4L2_PIXELFORMAT (obj) == V4L2_PIX_FMT_PJPG)
1397 GST_BUFFER_FLAG_UNSET (outbuf, GST_BUFFER_FLAG_DELTA_UNIT);
1399 GST_BUFFER_FLAG_SET (outbuf, GST_BUFFER_FLAG_DELTA_UNIT);
1402 if (group->buffer.flags & V4L2_BUF_FLAG_ERROR)
1403 GST_BUFFER_FLAG_SET (outbuf, GST_BUFFER_FLAG_CORRUPTED);
1405 GST_BUFFER_TIMESTAMP (outbuf) = timestamp;
1406 GST_BUFFER_OFFSET (outbuf) = group->buffer.sequence;
1407 GST_BUFFER_OFFSET_END (outbuf) = group->buffer.sequence + 1;
1417 GST_DEBUG_OBJECT (pool, "poll error %s", gst_flow_get_name (res));
1422 return GST_FLOW_EOS;
1426 return GST_FLOW_ERROR;
1430 GST_ERROR_OBJECT (pool, "No free buffer found in the pool at index %d.",
1431 group->buffer.index);
1432 return GST_FLOW_ERROR;
1436 static GstFlowReturn
1437 gst_v4l2_buffer_pool_acquire_buffer (GstBufferPool * bpool, GstBuffer ** buffer,
1438 GstBufferPoolAcquireParams * params)
1441 GstV4l2BufferPool *pool = GST_V4L2_BUFFER_POOL (bpool);
1442 GstBufferPoolClass *pclass = GST_BUFFER_POOL_CLASS (parent_class);
1443 GstV4l2Object *obj = pool->obj;
1445 GST_DEBUG_OBJECT (pool, "acquire");
1447 /* If this is being called to resurrect a lost buffer */
1448 if (params && params->flags & GST_V4L2_BUFFER_POOL_ACQUIRE_FLAG_RESURRECT) {
1449 ret = pclass->acquire_buffer (bpool, buffer, params);
1453 switch (obj->type) {
1454 case V4L2_BUF_TYPE_VIDEO_CAPTURE:
1455 case V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE:
1456 /* capture, This function should return a buffer with new captured data */
1457 switch (obj->mode) {
1458 case GST_V4L2_IO_RW:
1460 /* take empty buffer from the pool */
1461 ret = pclass->acquire_buffer (bpool, buffer, params);
1464 case GST_V4L2_IO_DMABUF:
1465 case GST_V4L2_IO_MMAP:
1466 case GST_V4L2_IO_USERPTR:
1467 case GST_V4L2_IO_DMABUF_IMPORT:
1469 /* just dequeue a buffer, we basically use the queue of v4l2 as the
1470 * storage for our buffers. This function does poll first so we can
1471 * interrupt it fine. */
1472 ret = gst_v4l2_buffer_pool_dqbuf (pool, buffer, TRUE);
1476 ret = GST_FLOW_ERROR;
1477 g_assert_not_reached ();
1483 case V4L2_BUF_TYPE_VIDEO_OUTPUT:
1484 case V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE:
1485 /* playback, This function should return an empty buffer */
1486 switch (obj->mode) {
1487 case GST_V4L2_IO_RW:
1488 /* get an empty buffer */
1489 ret = pclass->acquire_buffer (bpool, buffer, params);
1492 case GST_V4L2_IO_MMAP:
1493 case GST_V4L2_IO_DMABUF:
1494 case GST_V4L2_IO_USERPTR:
1495 case GST_V4L2_IO_DMABUF_IMPORT:
1496 /* get a free unqueued buffer */
1497 ret = pclass->acquire_buffer (bpool, buffer, params);
1501 ret = GST_FLOW_ERROR;
1502 g_assert_not_reached ();
1508 ret = GST_FLOW_ERROR;
1509 g_assert_not_reached ();
1517 gst_v4l2_buffer_pool_release_buffer (GstBufferPool * bpool, GstBuffer * buffer)
1519 GstV4l2BufferPool *pool = GST_V4L2_BUFFER_POOL (bpool);
1520 GstBufferPoolClass *pclass = GST_BUFFER_POOL_CLASS (parent_class);
1521 GstV4l2Object *obj = pool->obj;
1523 GST_DEBUG_OBJECT (pool, "release buffer %p", buffer);
1525 switch (obj->type) {
1526 case V4L2_BUF_TYPE_VIDEO_CAPTURE:
1527 case V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE:
1528 /* capture, put the buffer back in the queue so that we can refill it
1530 switch (obj->mode) {
1531 case GST_V4L2_IO_RW:
1532 /* release back in the pool */
1533 pclass->release_buffer (bpool, buffer);
1536 case GST_V4L2_IO_DMABUF:
1537 case GST_V4L2_IO_MMAP:
1538 case GST_V4L2_IO_USERPTR:
1539 case GST_V4L2_IO_DMABUF_IMPORT:
1541 GstV4l2MemoryGroup *group;
1542 if (gst_v4l2_is_buffer_valid (buffer, &group)) {
1543 GstFlowReturn ret = GST_FLOW_OK;
1545 gst_v4l2_allocator_reset_group (pool->vallocator, group);
1546 /* queue back in the device */
1547 if (pool->other_pool)
1548 ret = gst_v4l2_buffer_pool_prepare_buffer (pool, buffer, NULL);
1549 if (ret != GST_FLOW_OK ||
1550 gst_v4l2_buffer_pool_qbuf (pool, buffer, group,
1551 NULL) != GST_FLOW_OK)
1552 pclass->release_buffer (bpool, buffer);
1554 /* Simply release invalid/modified buffer, the allocator will
1555 * give it back later */
1556 GST_BUFFER_FLAG_SET (buffer, GST_BUFFER_FLAG_TAG_MEMORY);
1557 pclass->release_buffer (bpool, buffer);
1562 g_assert_not_reached ();
1567 case V4L2_BUF_TYPE_VIDEO_OUTPUT:
1568 case V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE:
1569 switch (obj->mode) {
1570 case GST_V4L2_IO_RW:
1571 /* release back in the pool */
1572 pclass->release_buffer (bpool, buffer);
1575 case GST_V4L2_IO_MMAP:
1576 case GST_V4L2_IO_DMABUF:
1577 case GST_V4L2_IO_USERPTR:
1578 case GST_V4L2_IO_DMABUF_IMPORT:
1580 GstV4l2MemoryGroup *group;
1583 if (!gst_v4l2_is_buffer_valid (buffer, &group)) {
1584 /* Simply release invalid/modified buffer, the allocator will
1585 * give it back later */
1586 GST_BUFFER_FLAG_SET (buffer, GST_BUFFER_FLAG_TAG_MEMORY);
1587 pclass->release_buffer (bpool, buffer);
1591 index = group->buffer.index;
1593 if (pool->buffers[index] == NULL) {
1594 GST_LOG_OBJECT (pool, "buffer %u not queued, putting on free list",
1597 /* Remove qdata, this will unmap any map data in userptr */
1598 gst_mini_object_set_qdata (GST_MINI_OBJECT (buffer),
1599 GST_V4L2_IMPORT_QUARK, NULL, NULL);
1601 /* reset to default size */
1602 gst_v4l2_allocator_reset_group (pool->vallocator, group);
1604 /* playback, put the buffer back in the queue to refill later. */
1605 pclass->release_buffer (bpool, buffer);
1607 /* the buffer is queued in the device but maybe not played yet. We just
1608 * leave it there and not make it available for future calls to acquire
1609 * for now. The buffer will be dequeued and reused later. */
1610 GST_LOG_OBJECT (pool, "buffer %u is queued", index);
1616 g_assert_not_reached ();
1622 g_assert_not_reached ();
1628 gst_v4l2_buffer_pool_dispose (GObject * object)
1630 GstV4l2BufferPool *pool = GST_V4L2_BUFFER_POOL (object);
1632 if (pool->vallocator)
1633 gst_object_unref (pool->vallocator);
1634 pool->vallocator = NULL;
1636 if (pool->allocator)
1637 gst_object_unref (pool->allocator);
1638 pool->allocator = NULL;
1640 if (pool->other_pool)
1641 gst_object_unref (pool->other_pool);
1642 pool->other_pool = NULL;
1644 G_OBJECT_CLASS (parent_class)->dispose (object);
1648 gst_v4l2_buffer_pool_finalize (GObject * object)
1650 GstV4l2BufferPool *pool = GST_V4L2_BUFFER_POOL (object);
1652 if (pool->video_fd >= 0)
1653 pool->obj->close (pool->video_fd);
1655 gst_poll_free (pool->poll);
1657 /* This can't be done in dispose method because we must not set pointer
1658 * to NULL as it is part of the v4l2object and dispose could be called
1660 gst_object_unref (pool->obj->element);
1662 g_cond_clear (&pool->empty_cond);
1664 /* FIXME have we done enough here ? */
1666 G_OBJECT_CLASS (parent_class)->finalize (object);
1670 gst_v4l2_buffer_pool_init (GstV4l2BufferPool * pool)
1672 pool->poll = gst_poll_new (TRUE);
1673 pool->can_poll_device = TRUE;
1674 g_cond_init (&pool->empty_cond);
1676 pool->orphaned = FALSE;
1680 gst_v4l2_buffer_pool_class_init (GstV4l2BufferPoolClass * klass)
1682 GObjectClass *object_class = G_OBJECT_CLASS (klass);
1683 GstBufferPoolClass *bufferpool_class = GST_BUFFER_POOL_CLASS (klass);
1685 object_class->dispose = gst_v4l2_buffer_pool_dispose;
1686 object_class->finalize = gst_v4l2_buffer_pool_finalize;
1688 bufferpool_class->start = gst_v4l2_buffer_pool_start;
1689 bufferpool_class->stop = gst_v4l2_buffer_pool_stop;
1690 bufferpool_class->set_config = gst_v4l2_buffer_pool_set_config;
1691 bufferpool_class->alloc_buffer = gst_v4l2_buffer_pool_alloc_buffer;
1692 bufferpool_class->acquire_buffer = gst_v4l2_buffer_pool_acquire_buffer;
1693 bufferpool_class->release_buffer = gst_v4l2_buffer_pool_release_buffer;
1694 bufferpool_class->flush_start = gst_v4l2_buffer_pool_flush_start;
1695 bufferpool_class->flush_stop = gst_v4l2_buffer_pool_flush_stop;
1697 GST_DEBUG_CATEGORY_INIT (v4l2bufferpool_debug, "v4l2bufferpool", 0,
1698 "V4L2 Buffer Pool");
1699 GST_DEBUG_CATEGORY_GET (CAT_PERFORMANCE, "GST_PERFORMANCE");
1703 * gst_v4l2_buffer_pool_new:
1704 * @obj: the v4l2 object owning the pool
1706 * Construct a new buffer pool.
1708 * Returns: the new pool, use gst_object_unref() to free resources
1711 gst_v4l2_buffer_pool_new (GstV4l2Object * obj, GstCaps * caps)
1713 GstV4l2BufferPool *pool;
1714 GstStructure *config;
1715 gchar *name, *parent_name;
1718 fd = obj->dup (obj->video_fd);
1722 /* setting a significant unique name */
1723 parent_name = gst_object_get_name (GST_OBJECT (obj->element));
1724 name = g_strdup_printf ("%s:pool%u:%s",
1725 parent_name, obj->pool_seq++,
1726 V4L2_TYPE_IS_OUTPUT (obj->type) ? "sink" : "src");
1727 g_free (parent_name);
1729 pool = (GstV4l2BufferPool *) g_object_new (GST_TYPE_V4L2_BUFFER_POOL,
1730 "name", name, NULL);
1731 g_object_ref_sink (pool);
1734 gst_poll_fd_init (&pool->pollfd);
1735 pool->pollfd.fd = fd;
1736 gst_poll_add_fd (pool->poll, &pool->pollfd);
1737 if (V4L2_TYPE_IS_OUTPUT (obj->type))
1738 gst_poll_fd_ctl_write (pool->poll, &pool->pollfd, TRUE);
1740 gst_poll_fd_ctl_read (pool->poll, &pool->pollfd, TRUE);
1742 pool->video_fd = fd;
1744 pool->can_poll_device = TRUE;
1746 pool->vallocator = gst_v4l2_allocator_new (GST_OBJECT (pool), obj);
1747 if (pool->vallocator == NULL)
1748 goto allocator_failed;
1750 gst_object_ref (obj->element);
1752 config = gst_buffer_pool_get_config (GST_BUFFER_POOL_CAST (pool));
1753 gst_buffer_pool_config_set_params (config, caps, obj->info.size, 0, 0);
1754 /* This will simply set a default config, but will not configure the pool
1755 * because min and max are not valid */
1756 gst_buffer_pool_set_config (GST_BUFFER_POOL_CAST (pool), config);
1758 return GST_BUFFER_POOL (pool);
1763 GST_ERROR ("failed to dup fd %d (%s)", errno, g_strerror (errno));
1768 GST_ERROR_OBJECT (pool, "Failed to create V4L2 allocator");
1769 gst_object_unref (pool);
1774 static GstFlowReturn
1775 gst_v4l2_do_read (GstV4l2BufferPool * pool, GstBuffer * buf)
1778 GstV4l2Object *obj = pool->obj;
1783 toread = obj->info.size;
1785 GST_LOG_OBJECT (pool, "reading %d bytes into buffer %p", toread, buf);
1787 gst_buffer_map (buf, &map, GST_MAP_WRITE);
1790 if ((res = gst_v4l2_buffer_pool_poll (pool, TRUE)) != GST_FLOW_OK)
1793 amount = obj->read (obj->video_fd, map.data, toread);
1795 if (amount == toread) {
1797 } else if (amount == -1) {
1798 if (errno == EAGAIN || errno == EINTR) {
1803 /* short reads can happen if a signal interrupts the read */
1808 GST_LOG_OBJECT (pool, "read %d bytes", amount);
1809 gst_buffer_unmap (buf, &map);
1810 gst_buffer_resize (buf, 0, amount);
1817 GST_DEBUG ("poll error %s", gst_flow_get_name (res));
1822 GST_ELEMENT_ERROR (obj->element, RESOURCE, READ,
1823 (_("Error reading %d bytes from device '%s'."),
1824 toread, obj->videodev), GST_ERROR_SYSTEM);
1825 res = GST_FLOW_ERROR;
1830 gst_buffer_unmap (buf, &map);
1831 gst_buffer_resize (buf, 0, 0);
1837 * gst_v4l2_buffer_pool_process:
1838 * @bpool: a #GstBufferPool
1839 * @buf: a #GstBuffer, maybe be replaced
1840 * @frame_number: 32 bit frame number or %NULL
1842 * Process @buf in @bpool. For capture devices, this functions fills @buf with
1843 * data from the device. For output devices, this functions send the contents of
1844 * @buf to the device for playback.
1846 * If non-%NULL and an output device, @frame_number is stored inside the timestamp for output devices and read
1847 * back from the timestamp for capture devices.
1849 * Returns: %GST_FLOW_OK on success.
1852 gst_v4l2_buffer_pool_process (GstV4l2BufferPool * pool, GstBuffer ** buf,
1853 guint32 * frame_number)
1855 GstFlowReturn ret = GST_FLOW_OK;
1856 GstBufferPool *bpool = GST_BUFFER_POOL_CAST (pool);
1857 GstV4l2Object *obj = pool->obj;
1859 GST_DEBUG_OBJECT (pool, "process buffer %p", buf);
1861 if (GST_BUFFER_POOL_IS_FLUSHING (pool))
1862 return GST_FLOW_FLUSHING;
1864 switch (obj->type) {
1865 case V4L2_BUF_TYPE_VIDEO_CAPTURE:
1866 case V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE:
1868 switch (obj->mode) {
1869 case GST_V4L2_IO_RW:
1870 /* capture into the buffer */
1871 ret = gst_v4l2_do_read (pool, *buf);
1874 case GST_V4L2_IO_MMAP:
1875 case GST_V4L2_IO_DMABUF:
1879 if ((*buf)->pool == bpool) {
1881 gsize size = gst_buffer_get_size (*buf);
1883 /* Legacy M2M devices return empty buffer when drained */
1884 if (size == 0 && GST_V4L2_IS_M2M (obj->device_caps))
1887 if (GST_VIDEO_INFO_FORMAT (&pool->caps_info) !=
1888 GST_VIDEO_FORMAT_ENCODED && size < pool->size)
1889 goto buffer_truncated;
1891 num_queued = g_atomic_int_get (&pool->num_queued);
1892 GST_TRACE_OBJECT (pool, "Only %i buffer left in the capture queue.",
1895 /* If we have no more buffer, and can allocate it time to do so */
1896 if (num_queued == 0) {
1897 if (GST_V4L2_ALLOCATOR_CAN_ALLOCATE (pool->vallocator, MMAP)) {
1898 ret = gst_v4l2_buffer_pool_resurrect_buffer (pool);
1899 if (ret == GST_FLOW_OK)
1904 /* start copying buffers when we are running low on buffers */
1905 if (num_queued < pool->copy_threshold) {
1908 if (GST_V4L2_ALLOCATOR_CAN_ALLOCATE (pool->vallocator, MMAP)) {
1909 ret = gst_v4l2_buffer_pool_resurrect_buffer (pool);
1910 if (ret == GST_FLOW_OK)
1914 /* copy the buffer */
1915 copy = gst_buffer_copy_region (*buf,
1916 GST_BUFFER_COPY_ALL | GST_BUFFER_COPY_DEEP, 0, -1);
1917 GST_LOG_OBJECT (pool, "copy buffer %p->%p", *buf, copy);
1919 /* and requeue so that we can continue capturing */
1920 gst_buffer_unref (*buf);
1925 /* nothing, data was inside the buffer when we did _acquire() */
1929 /* buffer not from our pool, grab a frame and copy it into the target */
1930 if ((ret = gst_v4l2_buffer_pool_dqbuf (pool, &tmp, TRUE))
1934 /* An empty buffer on capture indicates the end of stream */
1935 if (gst_buffer_get_size (tmp) == 0) {
1936 gst_v4l2_buffer_pool_release_buffer (bpool, tmp);
1938 /* Legacy M2M devices return empty buffer when drained */
1939 if (GST_V4L2_IS_M2M (obj->device_caps))
1943 ret = gst_v4l2_buffer_pool_copy_buffer (pool, *buf, tmp);
1945 /* an queue the buffer again after the copy */
1946 gst_v4l2_buffer_pool_release_buffer (bpool, tmp);
1948 if (ret != GST_FLOW_OK)
1953 case GST_V4L2_IO_USERPTR:
1955 struct UserPtrData *data;
1958 /* Replace our buffer with downstream allocated buffer */
1959 data = gst_mini_object_steal_qdata (GST_MINI_OBJECT (*buf),
1960 GST_V4L2_IMPORT_QUARK);
1961 tmp = gst_buffer_ref (data->buffer);
1962 _unmap_userptr_frame (data);
1964 /* Now tmp is writable, copy the flags and timestamp */
1965 gst_buffer_copy_into (tmp, *buf,
1966 GST_BUFFER_COPY_FLAGS | GST_BUFFER_COPY_TIMESTAMPS, 0, -1);
1968 gst_buffer_replace (buf, tmp);
1969 gst_buffer_unref (tmp);
1973 case GST_V4L2_IO_DMABUF_IMPORT:
1977 /* Replace our buffer with downstream allocated buffer */
1978 tmp = gst_mini_object_steal_qdata (GST_MINI_OBJECT (*buf),
1979 GST_V4L2_IMPORT_QUARK);
1981 gst_buffer_copy_into (tmp, *buf,
1982 GST_BUFFER_COPY_FLAGS | GST_BUFFER_COPY_TIMESTAMPS, 0, -1);
1984 gst_buffer_replace (buf, tmp);
1985 gst_buffer_unref (tmp);
1990 g_assert_not_reached ();
1995 case V4L2_BUF_TYPE_VIDEO_OUTPUT:
1996 case V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE:
1998 switch (obj->mode) {
1999 case GST_V4L2_IO_RW:
2000 /* FIXME, do write() */
2001 GST_WARNING_OBJECT (pool, "implement write()");
2004 case GST_V4L2_IO_USERPTR:
2005 case GST_V4L2_IO_DMABUF_IMPORT:
2006 case GST_V4L2_IO_DMABUF:
2007 case GST_V4L2_IO_MMAP:
2009 GstBuffer *to_queue = NULL;
2011 GstV4l2MemoryGroup *group;
2014 if ((*buf)->pool != bpool)
2017 if (!gst_v4l2_is_buffer_valid (*buf, &group))
2020 index = group->buffer.index;
2022 GST_LOG_OBJECT (pool, "processing buffer %i from our pool", index);
2024 if (pool->buffers[index] != NULL) {
2025 GST_LOG_OBJECT (pool, "buffer %i already queued, copying", index);
2029 /* we can queue directly */
2030 to_queue = gst_buffer_ref (*buf);
2033 if (to_queue == NULL) {
2034 GstBufferPoolAcquireParams params = { 0 };
2036 GST_LOG_OBJECT (pool, "alloc buffer from our pool");
2038 /* this can return EOS if all buffers are outstanding which would
2039 * be strange because we would expect the upstream element to have
2040 * allocated them and returned to us.. */
2041 params.flags = GST_BUFFER_POOL_ACQUIRE_FLAG_DONTWAIT;
2042 ret = gst_buffer_pool_acquire_buffer (bpool, &to_queue, ¶ms);
2043 if (ret != GST_FLOW_OK)
2044 goto acquire_failed;
2046 ret = gst_v4l2_buffer_pool_prepare_buffer (pool, to_queue, *buf);
2047 if (ret != GST_FLOW_OK) {
2048 gst_buffer_unref (to_queue);
2049 goto prepare_failed;
2052 /* retrieve the group */
2053 gst_v4l2_is_buffer_valid (to_queue, &group);
2057 gst_v4l2_buffer_pool_qbuf (pool, to_queue, group,
2062 /* if we are not streaming yet (this is the first buffer, start
2064 if (!gst_v4l2_buffer_pool_streamon (pool)) {
2065 /* don't check return value because qbuf would have failed */
2066 gst_v4l2_is_buffer_valid (to_queue, &group);
2068 /* qbuf has stored to_queue buffer but we are not in
2069 * streaming state, so the flush logic won't be performed.
2070 * To avoid leaks, flush the allocator and restore the queued
2071 * buffer as non-queued */
2072 gst_v4l2_allocator_flush (pool->vallocator);
2074 pool->buffers[group->buffer.index] = NULL;
2076 gst_mini_object_set_qdata (GST_MINI_OBJECT (to_queue),
2077 GST_V4L2_IMPORT_QUARK, NULL, NULL);
2078 gst_buffer_unref (to_queue);
2079 g_atomic_int_add (&pool->num_queued, -1);
2083 /* Remove our ref, we will still hold this buffer in acquire as needed,
2084 * otherwise the pool will think it is outstanding and will refuse to stop. */
2085 gst_buffer_unref (to_queue);
2087 /* release as many buffer as possible */
2088 while (gst_v4l2_buffer_pool_dqbuf (pool, &buffer, FALSE) ==
2090 if (buffer->pool == NULL)
2091 gst_v4l2_buffer_pool_release_buffer (bpool, buffer);
2094 if (g_atomic_int_get (&pool->num_queued) >= pool->min_latency) {
2095 /* all buffers are queued, try to dequeue one and release it back
2096 * into the pool so that _acquire can get to it again. */
2097 ret = gst_v4l2_buffer_pool_dqbuf (pool, &buffer, TRUE);
2098 if (ret == GST_FLOW_OK && buffer->pool == NULL)
2099 /* release the rendered buffer back into the pool. This wakes up any
2100 * thread waiting for a buffer in _acquire(). */
2101 gst_v4l2_buffer_pool_release_buffer (bpool, buffer);
2106 g_assert_not_reached ();
2111 g_assert_not_reached ();
2120 GST_ERROR_OBJECT (pool, "failed to copy buffer");
2125 GST_WARNING_OBJECT (pool,
2126 "Dropping truncated buffer, this is likely a driver bug.");
2127 gst_buffer_unref (*buf);
2129 return GST_V4L2_FLOW_CORRUPTED_BUFFER;
2133 GST_DEBUG_OBJECT (pool, "end of stream reached");
2134 gst_buffer_unref (*buf);
2136 return GST_V4L2_FLOW_LAST_BUFFER;
2140 if (ret == GST_FLOW_FLUSHING)
2141 GST_DEBUG_OBJECT (pool, "flushing");
2143 GST_WARNING_OBJECT (pool, "failed to acquire a buffer: %s",
2144 gst_flow_get_name (ret));
2149 GST_ERROR_OBJECT (pool, "failed to prepare data");
2154 GST_ERROR_OBJECT (pool, "failed to queue buffer");
2159 GST_ERROR_OBJECT (pool, "failed to start streaming");
2160 return GST_FLOW_ERROR;
2165 gst_v4l2_buffer_pool_set_other_pool (GstV4l2BufferPool * pool,
2166 GstBufferPool * other_pool)
2168 g_return_if_fail (!gst_buffer_pool_is_active (GST_BUFFER_POOL (pool)));
2170 if (pool->other_pool)
2171 gst_object_unref (pool->other_pool);
2172 pool->other_pool = gst_object_ref (other_pool);
2176 gst_v4l2_buffer_pool_copy_at_threshold (GstV4l2BufferPool * pool, gboolean copy)
2178 GST_OBJECT_LOCK (pool);
2179 pool->enable_copy_threshold = copy;
2180 GST_OBJECT_UNLOCK (pool);
2184 gst_v4l2_buffer_pool_flush (GstBufferPool * bpool)
2186 GstV4l2BufferPool *pool = GST_V4L2_BUFFER_POOL (bpool);
2187 gboolean ret = TRUE;
2189 gst_v4l2_buffer_pool_streamoff (pool);
2191 if (!V4L2_TYPE_IS_OUTPUT (pool->obj->type))
2192 ret = gst_v4l2_buffer_pool_streamon (pool);
2198 * gst_v4l2_buffer_pool_enable_resolution_change:
2199 * @pool: a #GstBufferPool
2201 * When this is called, the pool will subscribe to the
2202 * %V4L2_EVENT_SOURCE_CHANGE. Upon receiving this event, it will notify
2203 * the element acquiring buffer with the special flow return
2204 * %GST_V4L2_FLOW_RESOLUTION_CHANGE.
2207 gst_v4l2_buffer_pool_enable_resolution_change (GstV4l2BufferPool * pool)
2209 guint32 input_id = 0;
2211 g_return_if_fail (!gst_buffer_pool_is_active (GST_BUFFER_POOL (pool)));
2213 /* Make sure we subscribe for the current input */
2214 gst_v4l2_get_input (pool->obj, &input_id);
2216 if (gst_v4l2_subscribe_event (pool->obj, V4L2_EVENT_SOURCE_CHANGE, input_id))
2217 gst_poll_fd_ctl_pri (pool->poll, &pool->pollfd, TRUE);