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) {
556 min_buffers = GST_V4L2_MIN_BUFFERS;
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 recommand to return FALSE */
603 return !updated && ret;
608 GST_ERROR_OBJECT (pool, "invalid config %" GST_PTR_FORMAT, config);
614 gst_v4l2_buffer_pool_resurect_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)) {
653 /* For captures, we need to enqueue buffers before we start streaming,
654 * so the driver don't underflow immediatly. As we have put then back
655 * into the base class queue, resurect them, then releasing will queue
657 while (gst_v4l2_buffer_pool_resurect_buffer (pool) == GST_FLOW_OK)
661 if (obj->ioctl (pool->video_fd, VIDIOC_STREAMON, &obj->type) < 0)
662 goto streamon_failed;
664 pool->streaming = TRUE;
666 GST_DEBUG_OBJECT (pool, "Started streaming");
676 GST_ERROR_OBJECT (pool, "error with STREAMON %d (%s)", errno,
682 /* Call with streamlock held, or when streaming threads are down */
684 gst_v4l2_buffer_pool_streamoff (GstV4l2BufferPool * pool)
686 GstBufferPoolClass *pclass = GST_BUFFER_POOL_CLASS (parent_class);
687 GstV4l2Object *obj = pool->obj;
690 if (!pool->streaming)
694 case GST_V4L2_IO_MMAP:
695 case GST_V4L2_IO_USERPTR:
696 case GST_V4L2_IO_DMABUF:
697 case GST_V4L2_IO_DMABUF_IMPORT:
699 if (obj->ioctl (pool->video_fd, VIDIOC_STREAMOFF, &obj->type) < 0)
700 GST_WARNING_OBJECT (pool, "STREAMOFF failed with errno %d (%s)",
701 errno, g_strerror (errno));
703 pool->streaming = FALSE;
705 GST_DEBUG_OBJECT (pool, "Stopped streaming");
707 if (pool->vallocator)
708 gst_v4l2_allocator_flush (pool->vallocator);
714 for (i = 0; i < VIDEO_MAX_FRAME; i++) {
715 if (pool->buffers[i]) {
716 GstBuffer *buffer = pool->buffers[i];
717 GstBufferPool *bpool = GST_BUFFER_POOL (pool);
719 pool->buffers[i] = NULL;
721 if (V4L2_TYPE_IS_OUTPUT (pool->obj->type))
722 gst_v4l2_buffer_pool_release_buffer (bpool, buffer);
723 else /* Don't re-enqueue capture buffer on stop */
724 pclass->release_buffer (bpool, buffer);
726 g_atomic_int_add (&pool->num_queued, -1);
732 gst_v4l2_buffer_pool_start (GstBufferPool * bpool)
734 GstV4l2BufferPool *pool = GST_V4L2_BUFFER_POOL (bpool);
735 GstBufferPoolClass *pclass = GST_BUFFER_POOL_CLASS (parent_class);
736 GstV4l2Object *obj = pool->obj;
737 GstStructure *config;
739 guint size, min_buffers, max_buffers;
740 guint max_latency, min_latency, copy_threshold = 0;
741 gboolean can_allocate = FALSE, ret = TRUE;
743 GST_DEBUG_OBJECT (pool, "activating pool");
745 if (pool->other_pool) {
748 if (!gst_buffer_pool_set_active (pool->other_pool, TRUE))
749 goto other_pool_failed;
751 if (gst_buffer_pool_acquire_buffer (pool->other_pool, &buffer, NULL) !=
753 goto other_pool_failed;
755 if (!gst_v4l2_object_try_import (obj, buffer)) {
756 gst_buffer_unref (buffer);
759 gst_buffer_unref (buffer);
762 config = gst_buffer_pool_get_config (bpool);
763 if (!gst_buffer_pool_config_get_params (config, &caps, &size, &min_buffers,
767 min_latency = MAX (GST_V4L2_MIN_BUFFERS, obj->min_buffers);
773 /* This workaround a unfixable bug in libv4l2 when RW is emulated on top
774 * of MMAP. In this case, the first read initialize the queues, but the
775 * poll before that will always fail. Doing an empty read, forces the
776 * queue to be initialized now. We only do this if we have a streaming
778 if (obj->device_caps & V4L2_CAP_STREAMING)
779 obj->read (obj->video_fd, NULL, 0);
782 case GST_V4L2_IO_DMABUF:
783 case GST_V4L2_IO_MMAP:
787 can_allocate = GST_V4L2_ALLOCATOR_CAN_ALLOCATE (pool->vallocator, MMAP);
789 /* first, lets request buffers, and see how many we can get: */
790 GST_DEBUG_OBJECT (pool, "requesting %d MMAP buffers", min_buffers);
792 count = gst_v4l2_allocator_start (pool->vallocator, min_buffers,
795 if (count < GST_V4L2_MIN_BUFFERS) {
800 /* V4L2 buffer pool are often very limited in the amount of buffers it
801 * can offer. The copy_threshold will workaround this limitation by
802 * falling back to copy if the pipeline needed more buffers. This also
803 * prevent having to do REQBUFS(N)/REQBUFS(0) everytime configure is
805 if (count != min_buffers || pool->enable_copy_threshold) {
806 GST_WARNING_OBJECT (pool,
807 "Uncertain or not enough buffers, enabling copy threshold");
809 copy_threshold = min_latency;
814 case GST_V4L2_IO_USERPTR:
819 GST_V4L2_ALLOCATOR_CAN_ALLOCATE (pool->vallocator, USERPTR);
821 GST_DEBUG_OBJECT (pool, "requesting %d USERPTR buffers", min_buffers);
823 count = gst_v4l2_allocator_start (pool->vallocator, min_buffers,
824 V4L2_MEMORY_USERPTR);
826 /* There is no rational to not get what we asked */
827 if (count < min_buffers) {
835 case GST_V4L2_IO_DMABUF_IMPORT:
839 can_allocate = GST_V4L2_ALLOCATOR_CAN_ALLOCATE (pool->vallocator, DMABUF);
841 GST_DEBUG_OBJECT (pool, "requesting %d DMABUF buffers", min_buffers);
843 count = gst_v4l2_allocator_start (pool->vallocator, min_buffers,
846 /* There is no rational to not get what we asked */
847 if (count < min_buffers) {
858 g_assert_not_reached ();
863 max_latency = max_buffers;
865 max_latency = min_buffers;
868 pool->copy_threshold = copy_threshold;
869 pool->max_latency = max_latency;
870 pool->min_latency = min_latency;
871 pool->num_queued = 0;
873 if (max_buffers != 0 && max_buffers < min_buffers)
874 max_buffers = min_buffers;
876 gst_buffer_pool_config_set_params (config, caps, size, min_buffers,
878 pclass->set_config (bpool, config);
879 gst_structure_free (config);
881 /* now, allocate the buffers: */
882 if (!pclass->start (bpool))
885 if (!V4L2_TYPE_IS_OUTPUT (obj->type)) {
886 if (g_atomic_int_get (&pool->num_queued) < min_buffers)
889 pool->group_released_handler =
890 g_signal_connect_swapped (pool->vallocator, "group-released",
891 G_CALLBACK (gst_v4l2_buffer_pool_resurect_buffer), pool);
892 ret = gst_v4l2_buffer_pool_streamon (pool);
900 GST_ERROR_OBJECT (pool, "invalid config %" GST_PTR_FORMAT, config);
901 gst_structure_free (config);
906 GST_ERROR_OBJECT (pool,
907 "we received %d buffer from device '%s', we want at least %d",
908 min_buffers, obj->videodev, GST_V4L2_MIN_BUFFERS);
909 gst_structure_free (config);
914 GST_ERROR_OBJECT (pool, "allocate failed");
919 GST_ERROR_OBJECT (pool, "failed to activate the other pool %"
920 GST_PTR_FORMAT, pool->other_pool);
925 GST_ERROR_OBJECT (pool, "failed to queue buffers into the capture queue");
930 GST_ERROR_OBJECT (pool, "cannot import buffers from downstream pool");
936 gst_v4l2_buffer_pool_stop (GstBufferPool * bpool)
938 GstV4l2BufferPool *pool = GST_V4L2_BUFFER_POOL (bpool);
941 GST_DEBUG_OBJECT (pool, "stopping pool");
943 if (pool->group_released_handler > 0) {
944 g_signal_handler_disconnect (pool->vallocator,
945 pool->group_released_handler);
946 pool->group_released_handler = 0;
949 if (pool->other_pool) {
950 gst_buffer_pool_set_active (pool->other_pool, FALSE);
951 gst_object_unref (pool->other_pool);
952 pool->other_pool = NULL;
955 gst_v4l2_buffer_pool_streamoff (pool);
957 ret = GST_BUFFER_POOL_CLASS (parent_class)->stop (bpool);
959 if (ret && pool->vallocator) {
962 vret = gst_v4l2_allocator_stop (pool->vallocator);
964 if (vret == GST_V4L2_BUSY)
965 GST_WARNING_OBJECT (pool, "some buffers are still outstanding");
967 ret = (vret == GST_V4L2_OK);
974 gst_v4l2_buffer_pool_flush_start (GstBufferPool * bpool)
976 GstV4l2BufferPool *pool = GST_V4L2_BUFFER_POOL (bpool);
978 GST_DEBUG_OBJECT (pool, "start flushing");
980 gst_poll_set_flushing (pool->poll, TRUE);
982 GST_OBJECT_LOCK (pool);
984 g_cond_broadcast (&pool->empty_cond);
985 GST_OBJECT_UNLOCK (pool);
987 if (pool->other_pool)
988 gst_buffer_pool_set_flushing (pool->other_pool, TRUE);
992 gst_v4l2_buffer_pool_flush_stop (GstBufferPool * bpool)
994 GstV4l2BufferPool *pool = GST_V4L2_BUFFER_POOL (bpool);
996 GST_DEBUG_OBJECT (pool, "stop flushing");
998 if (pool->other_pool)
999 gst_buffer_pool_set_flushing (pool->other_pool, FALSE);
1001 gst_poll_set_flushing (pool->poll, FALSE);
1004 static GstFlowReturn
1005 gst_v4l2_buffer_pool_poll (GstV4l2BufferPool * pool, gboolean wait)
1008 GstClockTime timeout;
1011 timeout = GST_CLOCK_TIME_NONE;
1015 /* In RW mode there is no queue, hence no need to wait while the queue is
1017 if (pool->obj->mode != GST_V4L2_IO_RW) {
1018 GST_OBJECT_LOCK (pool);
1020 if (!wait && pool->empty) {
1021 GST_OBJECT_UNLOCK (pool);
1026 g_cond_wait (&pool->empty_cond, GST_OBJECT_GET_LOCK (pool));
1028 GST_OBJECT_UNLOCK (pool);
1031 if (!pool->can_poll_device) {
1038 GST_LOG_OBJECT (pool, "polling device");
1041 ret = gst_poll_wait (pool->poll, timeout);
1042 if (G_UNLIKELY (ret < 0)) {
1050 GST_WARNING_OBJECT (pool,
1051 "v4l2 device doesn't support polling. Disabling"
1052 " using libv4l2 in this case may cause deadlocks");
1053 pool->can_poll_device = FALSE;
1060 if (gst_poll_fd_has_error (pool->poll, &pool->pollfd))
1072 GST_DEBUG_OBJECT (pool, "stop called");
1073 return GST_FLOW_FLUSHING;
1077 GST_ELEMENT_ERROR (pool->obj->element, RESOURCE, READ, (NULL),
1078 ("poll error %d: %s (%d)", ret, g_strerror (errno), errno));
1079 return GST_FLOW_ERROR;
1082 return GST_FLOW_CUSTOM_SUCCESS;
1085 static GstFlowReturn
1086 gst_v4l2_buffer_pool_qbuf (GstV4l2BufferPool * pool, GstBuffer * buf,
1087 GstV4l2MemoryGroup * group)
1089 const GstV4l2Object *obj = pool->obj;
1090 GstClockTime timestamp;
1093 index = group->buffer.index;
1095 if (pool->buffers[index] != NULL)
1096 goto already_queued;
1098 GST_LOG_OBJECT (pool, "queuing buffer %i", index);
1100 if (V4L2_TYPE_IS_OUTPUT (obj->type)) {
1101 enum v4l2_field field;
1103 /* Except when field is set to alternate, buffer field is the same as
1104 * the one defined in format */
1105 if (V4L2_TYPE_IS_MULTIPLANAR (obj->type))
1106 field = obj->format.fmt.pix_mp.field;
1108 field = obj->format.fmt.pix.field;
1110 /* NB: At this moment, we can't have alternate mode because it not handled
1112 if (field == V4L2_FIELD_ALTERNATE) {
1113 if (GST_BUFFER_FLAG_IS_SET (buf, GST_VIDEO_FRAME_FLAG_TFF))
1114 field = V4L2_FIELD_TOP;
1116 field = V4L2_FIELD_BOTTOM;
1119 group->buffer.field = field;
1122 if (GST_BUFFER_TIMESTAMP_IS_VALID (buf)) {
1123 timestamp = GST_BUFFER_TIMESTAMP (buf);
1124 GST_TIME_TO_TIMEVAL (timestamp, group->buffer.timestamp);
1127 GST_OBJECT_LOCK (pool);
1128 g_atomic_int_inc (&pool->num_queued);
1129 pool->buffers[index] = buf;
1131 if (!gst_v4l2_allocator_qbuf (pool->vallocator, group))
1134 pool->empty = FALSE;
1135 g_cond_signal (&pool->empty_cond);
1136 GST_OBJECT_UNLOCK (pool);
1142 GST_ERROR_OBJECT (pool, "the buffer %i was already queued", index);
1143 return GST_FLOW_ERROR;
1147 GST_ERROR_OBJECT (pool, "could not queue a buffer %i", index);
1148 /* Mark broken buffer to the allocator */
1149 GST_BUFFER_FLAG_SET (buf, GST_BUFFER_FLAG_TAG_MEMORY);
1150 g_atomic_int_add (&pool->num_queued, -1);
1151 pool->buffers[index] = NULL;
1152 GST_OBJECT_UNLOCK (pool);
1153 return GST_FLOW_ERROR;
1157 static GstFlowReturn
1158 gst_v4l2_buffer_pool_dqbuf (GstV4l2BufferPool * pool, GstBuffer ** buffer,
1162 GstBuffer *outbuf = NULL;
1163 GstV4l2Object *obj = pool->obj;
1164 GstClockTime timestamp;
1165 GstV4l2MemoryGroup *group;
1166 GstVideoMeta *vmeta;
1170 if ((res = gst_v4l2_buffer_pool_poll (pool, wait)) < GST_FLOW_OK)
1173 if (res == GST_FLOW_CUSTOM_SUCCESS) {
1174 GST_LOG_OBJECT (pool, "nothing to dequeue");
1178 GST_LOG_OBJECT (pool, "dequeueing a buffer");
1180 res = gst_v4l2_allocator_dqbuf (pool->vallocator, &group);
1181 if (res == GST_FLOW_EOS)
1183 if (res != GST_FLOW_OK)
1186 /* get our GstBuffer with that index from the pool, if the buffer was
1187 * outstanding we have a serious problem.
1189 outbuf = pool->buffers[group->buffer.index];
1193 /* mark the buffer outstanding */
1194 pool->buffers[group->buffer.index] = NULL;
1195 if (g_atomic_int_dec_and_test (&pool->num_queued)) {
1196 GST_OBJECT_LOCK (pool);
1198 GST_OBJECT_UNLOCK (pool);
1201 timestamp = GST_TIMEVAL_TO_TIME (group->buffer.timestamp);
1204 vmeta = gst_buffer_get_video_meta (outbuf);
1205 for (i = 0; i < group->n_mem; i++) {
1206 GST_LOG_OBJECT (pool,
1207 "dequeued buffer %p seq:%d (ix=%d), mem %p used %d, plane=%d, flags %08x, ts %"
1208 GST_TIME_FORMAT ", pool-queued=%d, buffer=%p", outbuf,
1209 group->buffer.sequence, group->buffer.index, group->mem[i],
1210 group->planes[i].bytesused, i, group->buffer.flags,
1211 GST_TIME_ARGS (timestamp), pool->num_queued, outbuf);
1214 vmeta->offset[i] = size;
1215 size += gst_memory_get_sizes (group->mem[i], NULL, NULL);
1219 /* Ignore timestamp and field for OUTPUT device */
1220 if (V4L2_TYPE_IS_OUTPUT (obj->type))
1223 /* Check for driver bug in reporting feild */
1224 if (group->buffer.field == V4L2_FIELD_ANY) {
1225 /* Only warn once to avoid the spamming */
1226 #ifndef GST_DISABLE_GST_DEBUG
1227 if (!pool->has_warned_on_buggy_field) {
1228 pool->has_warned_on_buggy_field = TRUE;
1229 GST_WARNING_OBJECT (pool,
1230 "Driver should never set v4l2_buffer.field to ANY");
1234 /* Use the value from the format (works for UVC bug) */
1235 group->buffer.field = obj->format.fmt.pix.field;
1237 /* If driver also has buggy S_FMT, assume progressive */
1238 if (group->buffer.field == V4L2_FIELD_ANY) {
1239 #ifndef GST_DISABLE_GST_DEBUG
1240 if (!pool->has_warned_on_buggy_field) {
1241 pool->has_warned_on_buggy_field = TRUE;
1242 GST_WARNING_OBJECT (pool,
1243 "Driver should never set v4l2_format.pix.field to ANY");
1247 group->buffer.field = V4L2_FIELD_NONE;
1251 /* set top/bottom field first if v4l2_buffer has the information */
1252 switch (group->buffer.field) {
1253 case V4L2_FIELD_NONE:
1254 GST_BUFFER_FLAG_UNSET (outbuf, GST_VIDEO_BUFFER_FLAG_INTERLACED);
1255 GST_BUFFER_FLAG_UNSET (outbuf, GST_VIDEO_BUFFER_FLAG_TFF);
1257 case V4L2_FIELD_INTERLACED_TB:
1258 GST_BUFFER_FLAG_SET (outbuf, GST_VIDEO_BUFFER_FLAG_INTERLACED);
1259 GST_BUFFER_FLAG_SET (outbuf, GST_VIDEO_BUFFER_FLAG_TFF);
1261 case V4L2_FIELD_INTERLACED_BT:
1262 GST_BUFFER_FLAG_SET (outbuf, GST_VIDEO_BUFFER_FLAG_INTERLACED);
1263 GST_BUFFER_FLAG_UNSET (outbuf, GST_VIDEO_BUFFER_FLAG_TFF);
1265 case V4L2_FIELD_INTERLACED:
1266 GST_BUFFER_FLAG_SET (outbuf, GST_VIDEO_BUFFER_FLAG_INTERLACED);
1267 if (obj->tv_norm == V4L2_STD_NTSC_M ||
1268 obj->tv_norm == V4L2_STD_NTSC_M_JP ||
1269 obj->tv_norm == V4L2_STD_NTSC_M_KR) {
1270 GST_BUFFER_FLAG_UNSET (outbuf, GST_VIDEO_BUFFER_FLAG_TFF);
1272 GST_BUFFER_FLAG_SET (outbuf, GST_VIDEO_BUFFER_FLAG_TFF);
1276 GST_BUFFER_FLAG_UNSET (outbuf, GST_VIDEO_BUFFER_FLAG_INTERLACED);
1277 GST_BUFFER_FLAG_UNSET (outbuf, GST_VIDEO_BUFFER_FLAG_TFF);
1278 GST_FIXME_OBJECT (pool,
1279 "Unhandled enum v4l2_field %d - treating as progressive",
1280 group->buffer.field);
1284 if (GST_VIDEO_INFO_FORMAT (&obj->info) == GST_VIDEO_FORMAT_ENCODED) {
1285 if ((group->buffer.flags & V4L2_BUF_FLAG_KEYFRAME) ||
1286 GST_V4L2_PIXELFORMAT (obj) == V4L2_PIX_FMT_MJPEG ||
1287 GST_V4L2_PIXELFORMAT (obj) == V4L2_PIX_FMT_JPEG ||
1288 GST_V4L2_PIXELFORMAT (obj) == V4L2_PIX_FMT_PJPG)
1289 GST_BUFFER_FLAG_UNSET (outbuf, GST_BUFFER_FLAG_DELTA_UNIT);
1291 GST_BUFFER_FLAG_SET (outbuf, GST_BUFFER_FLAG_DELTA_UNIT);
1294 if (group->buffer.flags & V4L2_BUF_FLAG_ERROR)
1295 GST_BUFFER_FLAG_SET (outbuf, GST_BUFFER_FLAG_CORRUPTED);
1297 GST_BUFFER_TIMESTAMP (outbuf) = timestamp;
1298 GST_BUFFER_OFFSET (outbuf) = group->buffer.sequence;
1299 GST_BUFFER_OFFSET_END (outbuf) = group->buffer.sequence + 1;
1309 GST_DEBUG_OBJECT (pool, "poll error %s", gst_flow_get_name (res));
1314 return GST_FLOW_EOS;
1318 return GST_FLOW_ERROR;
1322 GST_ERROR_OBJECT (pool, "No free buffer found in the pool at index %d.",
1323 group->buffer.index);
1324 return GST_FLOW_ERROR;
1328 static GstFlowReturn
1329 gst_v4l2_buffer_pool_acquire_buffer (GstBufferPool * bpool, GstBuffer ** buffer,
1330 GstBufferPoolAcquireParams * params)
1333 GstV4l2BufferPool *pool = GST_V4L2_BUFFER_POOL (bpool);
1334 GstBufferPoolClass *pclass = GST_BUFFER_POOL_CLASS (parent_class);
1335 GstV4l2Object *obj = pool->obj;
1337 GST_DEBUG_OBJECT (pool, "acquire");
1339 /* If this is being called to resurect a lost buffer */
1340 if (params && params->flags & GST_V4L2_BUFFER_POOL_ACQUIRE_FLAG_RESURRECT) {
1341 ret = pclass->acquire_buffer (bpool, buffer, params);
1345 switch (obj->type) {
1346 case V4L2_BUF_TYPE_VIDEO_CAPTURE:
1347 case V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE:
1348 /* capture, This function should return a buffer with new captured data */
1349 switch (obj->mode) {
1350 case GST_V4L2_IO_RW:
1352 /* take empty buffer from the pool */
1353 ret = pclass->acquire_buffer (bpool, buffer, params);
1356 case GST_V4L2_IO_DMABUF:
1357 case GST_V4L2_IO_MMAP:
1358 case GST_V4L2_IO_USERPTR:
1359 case GST_V4L2_IO_DMABUF_IMPORT:
1361 /* just dequeue a buffer, we basically use the queue of v4l2 as the
1362 * storage for our buffers. This function does poll first so we can
1363 * interrupt it fine. */
1364 ret = gst_v4l2_buffer_pool_dqbuf (pool, buffer, TRUE);
1368 ret = GST_FLOW_ERROR;
1369 g_assert_not_reached ();
1375 case V4L2_BUF_TYPE_VIDEO_OUTPUT:
1376 case V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE:
1377 /* playback, This function should return an empty buffer */
1378 switch (obj->mode) {
1379 case GST_V4L2_IO_RW:
1380 /* get an empty buffer */
1381 ret = pclass->acquire_buffer (bpool, buffer, params);
1384 case GST_V4L2_IO_MMAP:
1385 case GST_V4L2_IO_DMABUF:
1386 case GST_V4L2_IO_USERPTR:
1387 case GST_V4L2_IO_DMABUF_IMPORT:
1388 /* get a free unqueued buffer */
1389 ret = pclass->acquire_buffer (bpool, buffer, params);
1393 ret = GST_FLOW_ERROR;
1394 g_assert_not_reached ();
1400 ret = GST_FLOW_ERROR;
1401 g_assert_not_reached ();
1409 gst_v4l2_buffer_pool_release_buffer (GstBufferPool * bpool, GstBuffer * buffer)
1411 GstV4l2BufferPool *pool = GST_V4L2_BUFFER_POOL (bpool);
1412 GstBufferPoolClass *pclass = GST_BUFFER_POOL_CLASS (parent_class);
1413 GstV4l2Object *obj = pool->obj;
1415 GST_DEBUG_OBJECT (pool, "release buffer %p", buffer);
1417 switch (obj->type) {
1418 case V4L2_BUF_TYPE_VIDEO_CAPTURE:
1419 case V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE:
1420 /* capture, put the buffer back in the queue so that we can refill it
1422 switch (obj->mode) {
1423 case GST_V4L2_IO_RW:
1424 /* release back in the pool */
1425 pclass->release_buffer (bpool, buffer);
1428 case GST_V4L2_IO_DMABUF:
1429 case GST_V4L2_IO_MMAP:
1430 case GST_V4L2_IO_USERPTR:
1431 case GST_V4L2_IO_DMABUF_IMPORT:
1433 GstV4l2MemoryGroup *group;
1434 if (gst_v4l2_is_buffer_valid (buffer, &group)) {
1435 GstFlowReturn ret = GST_FLOW_OK;
1437 gst_v4l2_allocator_reset_group (pool->vallocator, group);
1438 /* queue back in the device */
1439 if (pool->other_pool)
1440 ret = gst_v4l2_buffer_pool_prepare_buffer (pool, buffer, NULL);
1441 if (ret != GST_FLOW_OK ||
1442 gst_v4l2_buffer_pool_qbuf (pool, buffer, group) != GST_FLOW_OK)
1443 pclass->release_buffer (bpool, buffer);
1445 /* Simply release invalide/modified buffer, the allocator will
1446 * give it back later */
1447 GST_BUFFER_FLAG_SET (buffer, GST_BUFFER_FLAG_TAG_MEMORY);
1448 pclass->release_buffer (bpool, buffer);
1453 g_assert_not_reached ();
1458 case V4L2_BUF_TYPE_VIDEO_OUTPUT:
1459 case V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE:
1460 switch (obj->mode) {
1461 case GST_V4L2_IO_RW:
1462 /* release back in the pool */
1463 pclass->release_buffer (bpool, buffer);
1466 case GST_V4L2_IO_MMAP:
1467 case GST_V4L2_IO_DMABUF:
1468 case GST_V4L2_IO_USERPTR:
1469 case GST_V4L2_IO_DMABUF_IMPORT:
1471 GstV4l2MemoryGroup *group;
1474 if (!gst_v4l2_is_buffer_valid (buffer, &group)) {
1475 /* Simply release invalide/modified buffer, the allocator will
1476 * give it back later */
1477 GST_BUFFER_FLAG_SET (buffer, GST_BUFFER_FLAG_TAG_MEMORY);
1478 pclass->release_buffer (bpool, buffer);
1482 index = group->buffer.index;
1484 if (pool->buffers[index] == NULL) {
1485 GST_LOG_OBJECT (pool, "buffer %u not queued, putting on free list",
1488 /* Remove qdata, this will unmap any map data in userptr */
1489 gst_mini_object_set_qdata (GST_MINI_OBJECT (buffer),
1490 GST_V4L2_IMPORT_QUARK, NULL, NULL);
1492 /* reset to default size */
1493 gst_v4l2_allocator_reset_group (pool->vallocator, group);
1495 /* playback, put the buffer back in the queue to refill later. */
1496 pclass->release_buffer (bpool, buffer);
1498 /* the buffer is queued in the device but maybe not played yet. We just
1499 * leave it there and not make it available for future calls to acquire
1500 * for now. The buffer will be dequeued and reused later. */
1501 GST_LOG_OBJECT (pool, "buffer %u is queued", index);
1507 g_assert_not_reached ();
1513 g_assert_not_reached ();
1519 gst_v4l2_buffer_pool_dispose (GObject * object)
1521 GstV4l2BufferPool *pool = GST_V4L2_BUFFER_POOL (object);
1523 if (pool->vallocator)
1524 gst_object_unref (pool->vallocator);
1525 pool->vallocator = NULL;
1527 if (pool->allocator)
1528 gst_object_unref (pool->allocator);
1529 pool->allocator = NULL;
1531 if (pool->other_pool)
1532 gst_object_unref (pool->other_pool);
1533 pool->other_pool = NULL;
1535 G_OBJECT_CLASS (parent_class)->dispose (object);
1539 gst_v4l2_buffer_pool_finalize (GObject * object)
1541 GstV4l2BufferPool *pool = GST_V4L2_BUFFER_POOL (object);
1543 if (pool->video_fd >= 0)
1544 pool->obj->close (pool->video_fd);
1546 gst_poll_free (pool->poll);
1548 /* This can't be done in dispose method because we must not set pointer
1549 * to NULL as it is part of the v4l2object and dispose could be called
1551 gst_object_unref (pool->obj->element);
1553 g_cond_clear (&pool->empty_cond);
1555 /* FIXME have we done enough here ? */
1557 G_OBJECT_CLASS (parent_class)->finalize (object);
1561 gst_v4l2_buffer_pool_init (GstV4l2BufferPool * pool)
1563 pool->poll = gst_poll_new (TRUE);
1564 pool->can_poll_device = TRUE;
1565 g_cond_init (&pool->empty_cond);
1570 gst_v4l2_buffer_pool_class_init (GstV4l2BufferPoolClass * klass)
1572 GObjectClass *object_class = G_OBJECT_CLASS (klass);
1573 GstBufferPoolClass *bufferpool_class = GST_BUFFER_POOL_CLASS (klass);
1575 object_class->dispose = gst_v4l2_buffer_pool_dispose;
1576 object_class->finalize = gst_v4l2_buffer_pool_finalize;
1578 bufferpool_class->start = gst_v4l2_buffer_pool_start;
1579 bufferpool_class->stop = gst_v4l2_buffer_pool_stop;
1580 bufferpool_class->set_config = gst_v4l2_buffer_pool_set_config;
1581 bufferpool_class->alloc_buffer = gst_v4l2_buffer_pool_alloc_buffer;
1582 bufferpool_class->acquire_buffer = gst_v4l2_buffer_pool_acquire_buffer;
1583 bufferpool_class->release_buffer = gst_v4l2_buffer_pool_release_buffer;
1584 bufferpool_class->flush_start = gst_v4l2_buffer_pool_flush_start;
1585 bufferpool_class->flush_stop = gst_v4l2_buffer_pool_flush_stop;
1587 GST_DEBUG_CATEGORY_INIT (v4l2bufferpool_debug, "v4l2bufferpool", 0,
1588 "V4L2 Buffer Pool");
1589 GST_DEBUG_CATEGORY_GET (CAT_PERFORMANCE, "GST_PERFORMANCE");
1593 * gst_v4l2_buffer_pool_new:
1594 * @obj: the v4l2 object owning the pool
1596 * Construct a new buffer pool.
1598 * Returns: the new pool, use gst_object_unref() to free resources
1601 gst_v4l2_buffer_pool_new (GstV4l2Object * obj, GstCaps * caps)
1603 GstV4l2BufferPool *pool;
1604 GstStructure *config;
1605 gchar *name, *parent_name;
1608 fd = obj->dup (obj->video_fd);
1612 /* setting a significant unique name */
1613 parent_name = gst_object_get_name (GST_OBJECT (obj->element));
1614 name = g_strconcat (parent_name, ":", "pool:",
1615 V4L2_TYPE_IS_OUTPUT (obj->type) ? "sink" : "src", NULL);
1616 g_free (parent_name);
1618 pool = (GstV4l2BufferPool *) g_object_new (GST_TYPE_V4L2_BUFFER_POOL,
1619 "name", name, NULL);
1620 g_object_ref_sink (pool);
1623 gst_poll_fd_init (&pool->pollfd);
1624 pool->pollfd.fd = fd;
1625 gst_poll_add_fd (pool->poll, &pool->pollfd);
1626 if (V4L2_TYPE_IS_OUTPUT (obj->type))
1627 gst_poll_fd_ctl_write (pool->poll, &pool->pollfd, TRUE);
1629 gst_poll_fd_ctl_read (pool->poll, &pool->pollfd, TRUE);
1631 pool->video_fd = fd;
1633 pool->can_poll_device = TRUE;
1635 pool->vallocator = gst_v4l2_allocator_new (GST_OBJECT (pool), obj);
1636 if (pool->vallocator == NULL)
1637 goto allocator_failed;
1639 gst_object_ref (obj->element);
1641 config = gst_buffer_pool_get_config (GST_BUFFER_POOL_CAST (pool));
1642 gst_buffer_pool_config_set_params (config, caps, obj->info.size, 0, 0);
1643 /* This will simply set a default config, but will not configure the pool
1644 * because min and max are not valid */
1645 gst_buffer_pool_set_config (GST_BUFFER_POOL_CAST (pool), config);
1647 return GST_BUFFER_POOL (pool);
1652 GST_ERROR ("failed to dup fd %d (%s)", errno, g_strerror (errno));
1657 GST_ERROR_OBJECT (pool, "Failed to create V4L2 allocator");
1658 gst_object_unref (pool);
1663 static GstFlowReturn
1664 gst_v4l2_do_read (GstV4l2BufferPool * pool, GstBuffer * buf)
1667 GstV4l2Object *obj = pool->obj;
1672 toread = obj->info.size;
1674 GST_LOG_OBJECT (pool, "reading %d bytes into buffer %p", toread, buf);
1676 gst_buffer_map (buf, &map, GST_MAP_WRITE);
1679 if ((res = gst_v4l2_buffer_pool_poll (pool, TRUE)) != GST_FLOW_OK)
1682 amount = obj->read (obj->video_fd, map.data, toread);
1684 if (amount == toread) {
1686 } else if (amount == -1) {
1687 if (errno == EAGAIN || errno == EINTR) {
1692 /* short reads can happen if a signal interrupts the read */
1697 GST_LOG_OBJECT (pool, "read %d bytes", amount);
1698 gst_buffer_unmap (buf, &map);
1699 gst_buffer_resize (buf, 0, amount);
1706 GST_DEBUG ("poll error %s", gst_flow_get_name (res));
1711 GST_ELEMENT_ERROR (obj->element, RESOURCE, READ,
1712 (_("Error reading %d bytes from device '%s'."),
1713 toread, obj->videodev), GST_ERROR_SYSTEM);
1714 res = GST_FLOW_ERROR;
1719 gst_buffer_unmap (buf, &map);
1720 gst_buffer_resize (buf, 0, 0);
1726 * gst_v4l2_buffer_pool_process:
1727 * @bpool: a #GstBufferPool
1728 * @buf: a #GstBuffer, maybe be replaced
1730 * Process @buf in @bpool. For capture devices, this functions fills @buf with
1731 * data from the device. For output devices, this functions send the contents of
1732 * @buf to the device for playback.
1734 * Returns: %GST_FLOW_OK on success.
1737 gst_v4l2_buffer_pool_process (GstV4l2BufferPool * pool, GstBuffer ** buf)
1739 GstFlowReturn ret = GST_FLOW_OK;
1740 GstBufferPool *bpool = GST_BUFFER_POOL_CAST (pool);
1741 GstV4l2Object *obj = pool->obj;
1743 GST_DEBUG_OBJECT (pool, "process buffer %p", buf);
1745 if (GST_BUFFER_POOL_IS_FLUSHING (pool))
1746 return GST_FLOW_FLUSHING;
1748 switch (obj->type) {
1749 case V4L2_BUF_TYPE_VIDEO_CAPTURE:
1750 case V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE:
1752 switch (obj->mode) {
1753 case GST_V4L2_IO_RW:
1754 /* capture into the buffer */
1755 ret = gst_v4l2_do_read (pool, *buf);
1758 case GST_V4L2_IO_MMAP:
1759 case GST_V4L2_IO_DMABUF:
1763 if ((*buf)->pool == bpool) {
1765 gsize size = gst_buffer_get_size (*buf);
1767 /* Legacy M2M devices return empty buffer when drained */
1768 if (size == 0 && GST_V4L2_IS_M2M (obj->device_caps))
1771 if (GST_VIDEO_INFO_FORMAT (&pool->caps_info) !=
1772 GST_VIDEO_FORMAT_ENCODED && size < pool->size)
1773 goto buffer_truncated;
1775 num_queued = g_atomic_int_get (&pool->num_queued);
1776 GST_TRACE_OBJECT (pool, "Only %i buffer left in the capture queue.",
1779 /* If we have no more buffer, and can allocate it time to do so */
1780 if (num_queued == 0) {
1781 if (GST_V4L2_ALLOCATOR_CAN_ALLOCATE (pool->vallocator, MMAP)) {
1782 ret = gst_v4l2_buffer_pool_resurect_buffer (pool);
1783 if (ret == GST_FLOW_OK)
1788 /* start copying buffers when we are running low on buffers */
1789 if (num_queued < pool->copy_threshold) {
1792 if (GST_V4L2_ALLOCATOR_CAN_ALLOCATE (pool->vallocator, MMAP)) {
1793 ret = gst_v4l2_buffer_pool_resurect_buffer (pool);
1794 if (ret == GST_FLOW_OK)
1798 /* copy the buffer */
1799 copy = gst_buffer_copy_region (*buf,
1800 GST_BUFFER_COPY_ALL | GST_BUFFER_COPY_DEEP, 0, -1);
1801 GST_LOG_OBJECT (pool, "copy buffer %p->%p", *buf, copy);
1803 /* and requeue so that we can continue capturing */
1804 gst_buffer_unref (*buf);
1809 /* nothing, data was inside the buffer when we did _acquire() */
1813 /* buffer not from our pool, grab a frame and copy it into the target */
1814 if ((ret = gst_v4l2_buffer_pool_dqbuf (pool, &tmp, TRUE))
1818 /* An empty buffer on capture indicates the end of stream */
1819 if (gst_buffer_get_size (tmp) == 0) {
1820 gst_v4l2_buffer_pool_release_buffer (bpool, tmp);
1822 /* Legacy M2M devices return empty buffer when drained */
1823 if (GST_V4L2_IS_M2M (obj->device_caps))
1827 ret = gst_v4l2_buffer_pool_copy_buffer (pool, *buf, tmp);
1829 /* an queue the buffer again after the copy */
1830 gst_v4l2_buffer_pool_release_buffer (bpool, tmp);
1832 if (ret != GST_FLOW_OK)
1837 case GST_V4L2_IO_USERPTR:
1839 struct UserPtrData *data;
1842 /* Replace our buffer with downstream allocated buffer */
1843 data = gst_mini_object_steal_qdata (GST_MINI_OBJECT (*buf),
1844 GST_V4L2_IMPORT_QUARK);
1845 tmp = gst_buffer_ref (data->buffer);
1846 _unmap_userptr_frame (data);
1848 /* Now tmp is writable, copy the flags and timestamp */
1849 gst_buffer_copy_into (tmp, *buf,
1850 GST_BUFFER_COPY_FLAGS | GST_BUFFER_COPY_TIMESTAMPS, 0, -1);
1852 gst_buffer_replace (buf, tmp);
1853 gst_buffer_unref (tmp);
1857 case GST_V4L2_IO_DMABUF_IMPORT:
1861 /* Replace our buffer with downstream allocated buffer */
1862 tmp = gst_mini_object_steal_qdata (GST_MINI_OBJECT (*buf),
1863 GST_V4L2_IMPORT_QUARK);
1865 gst_buffer_copy_into (tmp, *buf,
1866 GST_BUFFER_COPY_FLAGS | GST_BUFFER_COPY_TIMESTAMPS, 0, -1);
1868 gst_buffer_replace (buf, tmp);
1869 gst_buffer_unref (tmp);
1874 g_assert_not_reached ();
1879 case V4L2_BUF_TYPE_VIDEO_OUTPUT:
1880 case V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE:
1882 switch (obj->mode) {
1883 case GST_V4L2_IO_RW:
1884 /* FIXME, do write() */
1885 GST_WARNING_OBJECT (pool, "implement write()");
1888 case GST_V4L2_IO_USERPTR:
1889 case GST_V4L2_IO_DMABUF_IMPORT:
1890 case GST_V4L2_IO_DMABUF:
1891 case GST_V4L2_IO_MMAP:
1893 GstBuffer *to_queue = NULL;
1895 GstV4l2MemoryGroup *group;
1898 if ((*buf)->pool != bpool)
1901 if (!gst_v4l2_is_buffer_valid (*buf, &group))
1904 index = group->buffer.index;
1906 GST_LOG_OBJECT (pool, "processing buffer %i from our pool", index);
1908 if (pool->buffers[index] != NULL) {
1909 GST_LOG_OBJECT (pool, "buffer %i already queued, copying", index);
1913 /* we can queue directly */
1914 to_queue = gst_buffer_ref (*buf);
1917 if (to_queue == NULL) {
1918 GstBufferPoolAcquireParams params = { 0 };
1920 GST_LOG_OBJECT (pool, "alloc buffer from our pool");
1922 /* this can return EOS if all buffers are outstanding which would
1923 * be strange because we would expect the upstream element to have
1924 * allocated them and returned to us.. */
1925 params.flags = GST_BUFFER_POOL_ACQUIRE_FLAG_DONTWAIT;
1926 ret = gst_buffer_pool_acquire_buffer (bpool, &to_queue, ¶ms);
1927 if (ret != GST_FLOW_OK)
1928 goto acquire_failed;
1930 ret = gst_v4l2_buffer_pool_prepare_buffer (pool, to_queue, *buf);
1931 if (ret != GST_FLOW_OK) {
1932 gst_buffer_unref (to_queue);
1933 goto prepare_failed;
1936 /* retreive the group */
1937 gst_v4l2_is_buffer_valid (to_queue, &group);
1940 if ((ret = gst_v4l2_buffer_pool_qbuf (pool, to_queue, group))
1944 /* if we are not streaming yet (this is the first buffer, start
1946 if (!gst_v4l2_buffer_pool_streamon (pool)) {
1947 /* don't check return value because qbuf would have failed */
1948 gst_v4l2_is_buffer_valid (to_queue, &group);
1950 /* qbuf has stored to_queue buffer but we are not in
1951 * streaming state, so the flush logic won't be performed.
1952 * To avoid leaks, flush the allocator and restore the queued
1953 * buffer as non-queued */
1954 gst_v4l2_allocator_flush (pool->vallocator);
1956 pool->buffers[group->buffer.index] = NULL;
1958 gst_mini_object_set_qdata (GST_MINI_OBJECT (to_queue),
1959 GST_V4L2_IMPORT_QUARK, NULL, NULL);
1960 gst_buffer_unref (to_queue);
1961 g_atomic_int_add (&pool->num_queued, -1);
1965 /* Remove our ref, we will still hold this buffer in acquire as needed,
1966 * otherwise the pool will think it is outstanding and will refuse to stop. */
1967 gst_buffer_unref (to_queue);
1969 /* release as many buffer as possible */
1970 while (gst_v4l2_buffer_pool_dqbuf (pool, &buffer, FALSE) ==
1972 if (buffer->pool == NULL)
1973 gst_v4l2_buffer_pool_release_buffer (bpool, buffer);
1976 if (g_atomic_int_get (&pool->num_queued) >= pool->min_latency) {
1977 /* all buffers are queued, try to dequeue one and release it back
1978 * into the pool so that _acquire can get to it again. */
1979 ret = gst_v4l2_buffer_pool_dqbuf (pool, &buffer, TRUE);
1980 if (ret == GST_FLOW_OK && buffer->pool == NULL)
1981 /* release the rendered buffer back into the pool. This wakes up any
1982 * thread waiting for a buffer in _acquire(). */
1983 gst_v4l2_buffer_pool_release_buffer (bpool, buffer);
1988 g_assert_not_reached ();
1993 g_assert_not_reached ();
2002 GST_ERROR_OBJECT (pool, "failed to copy buffer");
2007 GST_WARNING_OBJECT (pool,
2008 "Dropping truncated buffer, this is likely a driver bug.");
2009 gst_buffer_unref (*buf);
2011 return GST_V4L2_FLOW_CORRUPTED_BUFFER;
2015 GST_DEBUG_OBJECT (pool, "end of stream reached");
2016 gst_buffer_unref (*buf);
2018 return GST_V4L2_FLOW_LAST_BUFFER;
2022 if (ret == GST_FLOW_FLUSHING)
2023 GST_DEBUG_OBJECT (pool, "flushing");
2025 GST_WARNING_OBJECT (pool, "failed to acquire a buffer: %s",
2026 gst_flow_get_name (ret));
2031 GST_ERROR_OBJECT (pool, "failed to prepare data");
2036 GST_ERROR_OBJECT (pool, "failed to queue buffer");
2041 GST_ERROR_OBJECT (pool, "failed to start streaming");
2042 return GST_FLOW_ERROR;
2047 gst_v4l2_buffer_pool_set_other_pool (GstV4l2BufferPool * pool,
2048 GstBufferPool * other_pool)
2050 g_return_if_fail (!gst_buffer_pool_is_active (GST_BUFFER_POOL (pool)));
2052 if (pool->other_pool)
2053 gst_object_unref (pool->other_pool);
2054 pool->other_pool = gst_object_ref (other_pool);
2058 gst_v4l2_buffer_pool_copy_at_threshold (GstV4l2BufferPool * pool, gboolean copy)
2060 GST_OBJECT_LOCK (pool);
2061 pool->enable_copy_threshold = copy;
2062 GST_OBJECT_UNLOCK (pool);
2066 gst_v4l2_buffer_pool_flush (GstBufferPool * bpool)
2068 GstV4l2BufferPool *pool = GST_V4L2_BUFFER_POOL (bpool);
2069 gboolean ret = TRUE;
2071 gst_v4l2_buffer_pool_streamoff (pool);
2073 if (!V4L2_TYPE_IS_OUTPUT (pool->obj->type))
2074 ret = gst_v4l2_buffer_pool_streamon (pool);