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)
746 if (!gst_buffer_pool_set_active (pool->other_pool, TRUE))
747 goto other_pool_failed;
749 config = gst_buffer_pool_get_config (bpool);
750 if (!gst_buffer_pool_config_get_params (config, &caps, &size, &min_buffers,
754 min_latency = MAX (GST_V4L2_MIN_BUFFERS, obj->min_buffers);
760 /* This workaround a unfixable bug in libv4l2 when RW is emulated on top
761 * of MMAP. In this case, the first read initialize the queues, but the
762 * poll before that will always fail. Doing an empty read, forces the
763 * queue to be initialized now. We only do this if we have a streaming
765 if (obj->device_caps & V4L2_CAP_STREAMING)
766 obj->read (obj->video_fd, NULL, 0);
769 case GST_V4L2_IO_DMABUF:
770 case GST_V4L2_IO_MMAP:
774 can_allocate = GST_V4L2_ALLOCATOR_CAN_ALLOCATE (pool->vallocator, MMAP);
776 /* first, lets request buffers, and see how many we can get: */
777 GST_DEBUG_OBJECT (pool, "requesting %d MMAP buffers", min_buffers);
779 count = gst_v4l2_allocator_start (pool->vallocator, min_buffers,
782 if (count < GST_V4L2_MIN_BUFFERS) {
787 /* V4L2 buffer pool are often very limited in the amount of buffers it
788 * can offer. The copy_threshold will workaround this limitation by
789 * falling back to copy if the pipeline needed more buffers. This also
790 * prevent having to do REQBUFS(N)/REQBUFS(0) everytime configure is
792 if (count != min_buffers || pool->enable_copy_threshold) {
793 GST_WARNING_OBJECT (pool,
794 "Uncertain or not enough buffers, enabling copy threshold");
796 copy_threshold = min_latency;
801 case GST_V4L2_IO_USERPTR:
806 GST_V4L2_ALLOCATOR_CAN_ALLOCATE (pool->vallocator, USERPTR);
808 GST_DEBUG_OBJECT (pool, "requesting %d USERPTR buffers", min_buffers);
810 count = gst_v4l2_allocator_start (pool->vallocator, min_buffers,
811 V4L2_MEMORY_USERPTR);
813 /* There is no rational to not get what we asked */
814 if (count < min_buffers) {
822 case GST_V4L2_IO_DMABUF_IMPORT:
826 can_allocate = GST_V4L2_ALLOCATOR_CAN_ALLOCATE (pool->vallocator, DMABUF);
828 GST_DEBUG_OBJECT (pool, "requesting %d DMABUF buffers", min_buffers);
830 count = gst_v4l2_allocator_start (pool->vallocator, min_buffers,
833 /* There is no rational to not get what we asked */
834 if (count < min_buffers) {
845 g_assert_not_reached ();
850 max_latency = max_buffers;
852 max_latency = min_buffers;
855 pool->copy_threshold = copy_threshold;
856 pool->max_latency = max_latency;
857 pool->min_latency = min_latency;
858 pool->num_queued = 0;
860 if (max_buffers != 0 && max_buffers < min_buffers)
861 max_buffers = min_buffers;
863 gst_buffer_pool_config_set_params (config, caps, size, min_buffers,
865 pclass->set_config (bpool, config);
866 gst_structure_free (config);
868 /* now, allocate the buffers: */
869 if (!pclass->start (bpool))
872 if (!V4L2_TYPE_IS_OUTPUT (obj->type)) {
873 if (g_atomic_int_get (&pool->num_queued) < min_buffers)
876 pool->group_released_handler =
877 g_signal_connect_swapped (pool->vallocator, "group-released",
878 G_CALLBACK (gst_v4l2_buffer_pool_resurect_buffer), pool);
879 ret = gst_v4l2_buffer_pool_streamon (pool);
887 GST_ERROR_OBJECT (pool, "invalid config %" GST_PTR_FORMAT, config);
888 gst_structure_free (config);
893 GST_ERROR_OBJECT (pool,
894 "we received %d buffer from device '%s', we want at least %d",
895 min_buffers, obj->videodev, GST_V4L2_MIN_BUFFERS);
896 gst_structure_free (config);
901 GST_ERROR_OBJECT (pool, "allocate failed");
906 GST_ERROR_OBJECT (pool, "failed to active the other pool %"
907 GST_PTR_FORMAT, pool->other_pool);
912 GST_ERROR_OBJECT (pool, "failed to queue buffers into the capture queue");
918 gst_v4l2_buffer_pool_stop (GstBufferPool * bpool)
920 GstV4l2BufferPool *pool = GST_V4L2_BUFFER_POOL (bpool);
923 GST_DEBUG_OBJECT (pool, "stopping pool");
925 if (pool->group_released_handler > 0) {
926 g_signal_handler_disconnect (pool->vallocator,
927 pool->group_released_handler);
928 pool->group_released_handler = 0;
931 if (pool->other_pool) {
932 gst_buffer_pool_set_active (pool->other_pool, FALSE);
933 gst_object_unref (pool->other_pool);
934 pool->other_pool = NULL;
937 gst_v4l2_buffer_pool_streamoff (pool);
939 ret = GST_BUFFER_POOL_CLASS (parent_class)->stop (bpool);
941 if (ret && pool->vallocator) {
944 vret = gst_v4l2_allocator_stop (pool->vallocator);
946 if (vret == GST_V4L2_BUSY)
947 GST_WARNING_OBJECT (pool, "some buffers are still outstanding");
949 ret = (vret == GST_V4L2_OK);
956 gst_v4l2_buffer_pool_flush_start (GstBufferPool * bpool)
958 GstV4l2BufferPool *pool = GST_V4L2_BUFFER_POOL (bpool);
960 GST_DEBUG_OBJECT (pool, "start flushing");
962 gst_poll_set_flushing (pool->poll, TRUE);
964 GST_OBJECT_LOCK (pool);
966 g_cond_broadcast (&pool->empty_cond);
967 GST_OBJECT_UNLOCK (pool);
969 if (pool->other_pool)
970 gst_buffer_pool_set_flushing (pool->other_pool, TRUE);
974 gst_v4l2_buffer_pool_flush_stop (GstBufferPool * bpool)
976 GstV4l2BufferPool *pool = GST_V4L2_BUFFER_POOL (bpool);
978 GST_DEBUG_OBJECT (pool, "stop flushing");
980 if (pool->other_pool)
981 gst_buffer_pool_set_flushing (pool->other_pool, FALSE);
983 gst_poll_set_flushing (pool->poll, FALSE);
987 gst_v4l2_buffer_pool_poll (GstV4l2BufferPool * pool, gboolean wait)
990 GstClockTime timeout;
993 timeout = GST_CLOCK_TIME_NONE;
997 /* In RW mode there is no queue, hence no need to wait while the queue is
999 if (pool->obj->mode != GST_V4L2_IO_RW) {
1000 GST_OBJECT_LOCK (pool);
1002 if (!wait && pool->empty) {
1003 GST_OBJECT_UNLOCK (pool);
1008 g_cond_wait (&pool->empty_cond, GST_OBJECT_GET_LOCK (pool));
1010 GST_OBJECT_UNLOCK (pool);
1013 if (!pool->can_poll_device) {
1020 GST_LOG_OBJECT (pool, "polling device");
1023 ret = gst_poll_wait (pool->poll, timeout);
1024 if (G_UNLIKELY (ret < 0)) {
1032 GST_WARNING_OBJECT (pool,
1033 "v4l2 device doesn't support polling. Disabling"
1034 " using libv4l2 in this case may cause deadlocks");
1035 pool->can_poll_device = FALSE;
1042 if (gst_poll_fd_has_error (pool->poll, &pool->pollfd))
1054 GST_DEBUG_OBJECT (pool, "stop called");
1055 return GST_FLOW_FLUSHING;
1059 GST_ELEMENT_ERROR (pool->obj->element, RESOURCE, READ, (NULL),
1060 ("poll error %d: %s (%d)", ret, g_strerror (errno), errno));
1061 return GST_FLOW_ERROR;
1064 return GST_FLOW_CUSTOM_SUCCESS;
1067 static GstFlowReturn
1068 gst_v4l2_buffer_pool_qbuf (GstV4l2BufferPool * pool, GstBuffer * buf,
1069 GstV4l2MemoryGroup * group)
1071 const GstV4l2Object *obj = pool->obj;
1072 GstClockTime timestamp;
1075 index = group->buffer.index;
1077 if (pool->buffers[index] != NULL)
1078 goto already_queued;
1080 GST_LOG_OBJECT (pool, "queuing buffer %i", index);
1082 if (V4L2_TYPE_IS_OUTPUT (obj->type)) {
1083 enum v4l2_field field;
1085 /* Except when field is set to alternate, buffer field is the same as
1086 * the one defined in format */
1087 if (V4L2_TYPE_IS_MULTIPLANAR (obj->type))
1088 field = obj->format.fmt.pix_mp.field;
1090 field = obj->format.fmt.pix.field;
1092 /* NB: At this moment, we can't have alternate mode because it not handled
1094 if (field == V4L2_FIELD_ALTERNATE) {
1095 if (GST_BUFFER_FLAG_IS_SET (buf, GST_VIDEO_FRAME_FLAG_TFF))
1096 field = V4L2_FIELD_TOP;
1098 field = V4L2_FIELD_BOTTOM;
1101 group->buffer.field = field;
1104 if (GST_BUFFER_TIMESTAMP_IS_VALID (buf)) {
1105 timestamp = GST_BUFFER_TIMESTAMP (buf);
1106 GST_TIME_TO_TIMEVAL (timestamp, group->buffer.timestamp);
1109 GST_OBJECT_LOCK (pool);
1110 g_atomic_int_inc (&pool->num_queued);
1111 pool->buffers[index] = buf;
1113 if (!gst_v4l2_allocator_qbuf (pool->vallocator, group))
1116 pool->empty = FALSE;
1117 g_cond_signal (&pool->empty_cond);
1118 GST_OBJECT_UNLOCK (pool);
1124 GST_ERROR_OBJECT (pool, "the buffer %i was already queued", index);
1125 return GST_FLOW_ERROR;
1129 GST_ERROR_OBJECT (pool, "could not queue a buffer %i", index);
1130 /* Mark broken buffer to the allocator */
1131 GST_BUFFER_FLAG_SET (buf, GST_BUFFER_FLAG_TAG_MEMORY);
1132 g_atomic_int_add (&pool->num_queued, -1);
1133 pool->buffers[index] = NULL;
1134 GST_OBJECT_UNLOCK (pool);
1135 return GST_FLOW_ERROR;
1139 static GstFlowReturn
1140 gst_v4l2_buffer_pool_dqbuf (GstV4l2BufferPool * pool, GstBuffer ** buffer,
1144 GstBuffer *outbuf = NULL;
1145 GstV4l2Object *obj = pool->obj;
1146 GstClockTime timestamp;
1147 GstV4l2MemoryGroup *group;
1148 GstVideoMeta *vmeta;
1152 if ((res = gst_v4l2_buffer_pool_poll (pool, wait)) < GST_FLOW_OK)
1155 if (res == GST_FLOW_CUSTOM_SUCCESS) {
1156 GST_LOG_OBJECT (pool, "nothing to dequeue");
1160 GST_LOG_OBJECT (pool, "dequeueing a buffer");
1162 res = gst_v4l2_allocator_dqbuf (pool->vallocator, &group);
1163 if (res == GST_FLOW_EOS)
1165 if (res != GST_FLOW_OK)
1168 /* get our GstBuffer with that index from the pool, if the buffer was
1169 * outstanding we have a serious problem.
1171 outbuf = pool->buffers[group->buffer.index];
1175 /* mark the buffer outstanding */
1176 pool->buffers[group->buffer.index] = NULL;
1177 if (g_atomic_int_dec_and_test (&pool->num_queued)) {
1178 GST_OBJECT_LOCK (pool);
1180 GST_OBJECT_UNLOCK (pool);
1183 timestamp = GST_TIMEVAL_TO_TIME (group->buffer.timestamp);
1186 vmeta = gst_buffer_get_video_meta (outbuf);
1187 for (i = 0; i < group->n_mem; i++) {
1188 GST_LOG_OBJECT (pool,
1189 "dequeued buffer %p seq:%d (ix=%d), mem %p used %d, plane=%d, flags %08x, ts %"
1190 GST_TIME_FORMAT ", pool-queued=%d, buffer=%p", outbuf,
1191 group->buffer.sequence, group->buffer.index, group->mem[i],
1192 group->planes[i].bytesused, i, group->buffer.flags,
1193 GST_TIME_ARGS (timestamp), pool->num_queued, outbuf);
1196 vmeta->offset[i] = size;
1197 size += gst_memory_get_sizes (group->mem[i], NULL, NULL);
1201 /* Ignore timestamp and field for OUTPUT device */
1202 if (V4L2_TYPE_IS_OUTPUT (obj->type))
1205 /* Check for driver bug in reporting feild */
1206 if (group->buffer.field == V4L2_FIELD_ANY) {
1207 /* Only warn once to avoid the spamming */
1208 #ifndef GST_DISABLE_GST_DEBUG
1209 if (!pool->has_warned_on_buggy_field) {
1210 pool->has_warned_on_buggy_field = TRUE;
1211 GST_WARNING_OBJECT (pool,
1212 "Driver should never set v4l2_buffer.field to ANY");
1216 /* Use the value from the format (works for UVC bug) */
1217 group->buffer.field = obj->format.fmt.pix.field;
1219 /* If driver also has buggy S_FMT, assume progressive */
1220 if (group->buffer.field == V4L2_FIELD_ANY) {
1221 #ifndef GST_DISABLE_GST_DEBUG
1222 if (!pool->has_warned_on_buggy_field) {
1223 pool->has_warned_on_buggy_field = TRUE;
1224 GST_WARNING_OBJECT (pool,
1225 "Driver should never set v4l2_format.pix.field to ANY");
1229 group->buffer.field = V4L2_FIELD_NONE;
1233 /* set top/bottom field first if v4l2_buffer has the information */
1234 switch (group->buffer.field) {
1235 case V4L2_FIELD_NONE:
1236 GST_BUFFER_FLAG_UNSET (outbuf, GST_VIDEO_BUFFER_FLAG_INTERLACED);
1237 GST_BUFFER_FLAG_UNSET (outbuf, GST_VIDEO_BUFFER_FLAG_TFF);
1239 case V4L2_FIELD_INTERLACED_TB:
1240 GST_BUFFER_FLAG_SET (outbuf, GST_VIDEO_BUFFER_FLAG_INTERLACED);
1241 GST_BUFFER_FLAG_SET (outbuf, GST_VIDEO_BUFFER_FLAG_TFF);
1243 case V4L2_FIELD_INTERLACED_BT:
1244 GST_BUFFER_FLAG_SET (outbuf, GST_VIDEO_BUFFER_FLAG_INTERLACED);
1245 GST_BUFFER_FLAG_UNSET (outbuf, GST_VIDEO_BUFFER_FLAG_TFF);
1247 case V4L2_FIELD_INTERLACED:
1248 GST_BUFFER_FLAG_SET (outbuf, GST_VIDEO_BUFFER_FLAG_INTERLACED);
1249 if (obj->tv_norm == V4L2_STD_NTSC_M ||
1250 obj->tv_norm == V4L2_STD_NTSC_M_JP ||
1251 obj->tv_norm == V4L2_STD_NTSC_M_KR) {
1252 GST_BUFFER_FLAG_UNSET (outbuf, GST_VIDEO_BUFFER_FLAG_TFF);
1254 GST_BUFFER_FLAG_SET (outbuf, GST_VIDEO_BUFFER_FLAG_TFF);
1258 GST_BUFFER_FLAG_UNSET (outbuf, GST_VIDEO_BUFFER_FLAG_INTERLACED);
1259 GST_BUFFER_FLAG_UNSET (outbuf, GST_VIDEO_BUFFER_FLAG_TFF);
1260 GST_FIXME_OBJECT (pool,
1261 "Unhandled enum v4l2_field %d - treating as progressive",
1262 group->buffer.field);
1266 if (GST_VIDEO_INFO_FORMAT (&obj->info) == GST_VIDEO_FORMAT_ENCODED) {
1267 if ((group->buffer.flags & V4L2_BUF_FLAG_KEYFRAME) ||
1268 GST_V4L2_PIXELFORMAT (obj) == V4L2_PIX_FMT_MJPEG ||
1269 GST_V4L2_PIXELFORMAT (obj) == V4L2_PIX_FMT_JPEG ||
1270 GST_V4L2_PIXELFORMAT (obj) == V4L2_PIX_FMT_PJPG)
1271 GST_BUFFER_FLAG_UNSET (outbuf, GST_BUFFER_FLAG_DELTA_UNIT);
1273 GST_BUFFER_FLAG_SET (outbuf, GST_BUFFER_FLAG_DELTA_UNIT);
1276 if (group->buffer.flags & V4L2_BUF_FLAG_ERROR)
1277 GST_BUFFER_FLAG_SET (outbuf, GST_BUFFER_FLAG_CORRUPTED);
1279 GST_BUFFER_TIMESTAMP (outbuf) = timestamp;
1280 GST_BUFFER_OFFSET (outbuf) = group->buffer.sequence;
1281 GST_BUFFER_OFFSET_END (outbuf) = group->buffer.sequence + 1;
1291 GST_DEBUG_OBJECT (pool, "poll error %s", gst_flow_get_name (res));
1296 return GST_FLOW_EOS;
1300 return GST_FLOW_ERROR;
1304 GST_ERROR_OBJECT (pool, "No free buffer found in the pool at index %d.",
1305 group->buffer.index);
1306 return GST_FLOW_ERROR;
1310 static GstFlowReturn
1311 gst_v4l2_buffer_pool_acquire_buffer (GstBufferPool * bpool, GstBuffer ** buffer,
1312 GstBufferPoolAcquireParams * params)
1315 GstV4l2BufferPool *pool = GST_V4L2_BUFFER_POOL (bpool);
1316 GstBufferPoolClass *pclass = GST_BUFFER_POOL_CLASS (parent_class);
1317 GstV4l2Object *obj = pool->obj;
1319 GST_DEBUG_OBJECT (pool, "acquire");
1321 /* If this is being called to resurect a lost buffer */
1322 if (params && params->flags & GST_V4L2_BUFFER_POOL_ACQUIRE_FLAG_RESURRECT) {
1323 ret = pclass->acquire_buffer (bpool, buffer, params);
1327 switch (obj->type) {
1328 case V4L2_BUF_TYPE_VIDEO_CAPTURE:
1329 case V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE:
1330 /* capture, This function should return a buffer with new captured data */
1331 switch (obj->mode) {
1332 case GST_V4L2_IO_RW:
1334 /* take empty buffer from the pool */
1335 ret = pclass->acquire_buffer (bpool, buffer, params);
1338 case GST_V4L2_IO_DMABUF:
1339 case GST_V4L2_IO_MMAP:
1340 case GST_V4L2_IO_USERPTR:
1341 case GST_V4L2_IO_DMABUF_IMPORT:
1343 /* just dequeue a buffer, we basically use the queue of v4l2 as the
1344 * storage for our buffers. This function does poll first so we can
1345 * interrupt it fine. */
1346 ret = gst_v4l2_buffer_pool_dqbuf (pool, buffer, TRUE);
1350 ret = GST_FLOW_ERROR;
1351 g_assert_not_reached ();
1357 case V4L2_BUF_TYPE_VIDEO_OUTPUT:
1358 case V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE:
1359 /* playback, This function should return an empty buffer */
1360 switch (obj->mode) {
1361 case GST_V4L2_IO_RW:
1362 /* get an empty buffer */
1363 ret = pclass->acquire_buffer (bpool, buffer, params);
1366 case GST_V4L2_IO_MMAP:
1367 case GST_V4L2_IO_DMABUF:
1368 case GST_V4L2_IO_USERPTR:
1369 case GST_V4L2_IO_DMABUF_IMPORT:
1370 /* get a free unqueued buffer */
1371 ret = pclass->acquire_buffer (bpool, buffer, params);
1375 ret = GST_FLOW_ERROR;
1376 g_assert_not_reached ();
1382 ret = GST_FLOW_ERROR;
1383 g_assert_not_reached ();
1391 gst_v4l2_buffer_pool_release_buffer (GstBufferPool * bpool, GstBuffer * buffer)
1393 GstV4l2BufferPool *pool = GST_V4L2_BUFFER_POOL (bpool);
1394 GstBufferPoolClass *pclass = GST_BUFFER_POOL_CLASS (parent_class);
1395 GstV4l2Object *obj = pool->obj;
1397 GST_DEBUG_OBJECT (pool, "release buffer %p", buffer);
1399 switch (obj->type) {
1400 case V4L2_BUF_TYPE_VIDEO_CAPTURE:
1401 case V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE:
1402 /* capture, put the buffer back in the queue so that we can refill it
1404 switch (obj->mode) {
1405 case GST_V4L2_IO_RW:
1406 /* release back in the pool */
1407 pclass->release_buffer (bpool, buffer);
1410 case GST_V4L2_IO_DMABUF:
1411 case GST_V4L2_IO_MMAP:
1412 case GST_V4L2_IO_USERPTR:
1413 case GST_V4L2_IO_DMABUF_IMPORT:
1415 GstV4l2MemoryGroup *group;
1416 if (gst_v4l2_is_buffer_valid (buffer, &group)) {
1417 gst_v4l2_allocator_reset_group (pool->vallocator, group);
1418 /* queue back in the device */
1419 if (pool->other_pool)
1420 gst_v4l2_buffer_pool_prepare_buffer (pool, buffer, NULL);
1421 if (gst_v4l2_buffer_pool_qbuf (pool, buffer, group) != GST_FLOW_OK)
1422 pclass->release_buffer (bpool, buffer);
1424 /* Simply release invalide/modified buffer, the allocator will
1425 * give it back later */
1426 GST_BUFFER_FLAG_SET (buffer, GST_BUFFER_FLAG_TAG_MEMORY);
1427 pclass->release_buffer (bpool, buffer);
1432 g_assert_not_reached ();
1437 case V4L2_BUF_TYPE_VIDEO_OUTPUT:
1438 case V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE:
1439 switch (obj->mode) {
1440 case GST_V4L2_IO_RW:
1441 /* release back in the pool */
1442 pclass->release_buffer (bpool, buffer);
1445 case GST_V4L2_IO_MMAP:
1446 case GST_V4L2_IO_DMABUF:
1447 case GST_V4L2_IO_USERPTR:
1448 case GST_V4L2_IO_DMABUF_IMPORT:
1450 GstV4l2MemoryGroup *group;
1453 if (!gst_v4l2_is_buffer_valid (buffer, &group)) {
1454 /* Simply release invalide/modified buffer, the allocator will
1455 * give it back later */
1456 GST_BUFFER_FLAG_SET (buffer, GST_BUFFER_FLAG_TAG_MEMORY);
1457 pclass->release_buffer (bpool, buffer);
1461 index = group->buffer.index;
1463 if (pool->buffers[index] == NULL) {
1464 GST_LOG_OBJECT (pool, "buffer %u not queued, putting on free list",
1467 /* Remove qdata, this will unmap any map data in userptr */
1468 gst_mini_object_set_qdata (GST_MINI_OBJECT (buffer),
1469 GST_V4L2_IMPORT_QUARK, NULL, NULL);
1471 /* reset to default size */
1472 gst_v4l2_allocator_reset_group (pool->vallocator, group);
1474 /* playback, put the buffer back in the queue to refill later. */
1475 pclass->release_buffer (bpool, buffer);
1477 /* the buffer is queued in the device but maybe not played yet. We just
1478 * leave it there and not make it available for future calls to acquire
1479 * for now. The buffer will be dequeued and reused later. */
1480 GST_LOG_OBJECT (pool, "buffer %u is queued", index);
1486 g_assert_not_reached ();
1492 g_assert_not_reached ();
1498 gst_v4l2_buffer_pool_dispose (GObject * object)
1500 GstV4l2BufferPool *pool = GST_V4L2_BUFFER_POOL (object);
1502 if (pool->vallocator)
1503 gst_object_unref (pool->vallocator);
1504 pool->vallocator = NULL;
1506 if (pool->allocator)
1507 gst_object_unref (pool->allocator);
1508 pool->allocator = NULL;
1510 if (pool->other_pool)
1511 gst_object_unref (pool->other_pool);
1512 pool->other_pool = NULL;
1514 G_OBJECT_CLASS (parent_class)->dispose (object);
1518 gst_v4l2_buffer_pool_finalize (GObject * object)
1520 GstV4l2BufferPool *pool = GST_V4L2_BUFFER_POOL (object);
1522 if (pool->video_fd >= 0)
1523 pool->obj->close (pool->video_fd);
1525 gst_poll_free (pool->poll);
1527 /* This can't be done in dispose method because we must not set pointer
1528 * to NULL as it is part of the v4l2object and dispose could be called
1530 gst_object_unref (pool->obj->element);
1532 g_cond_clear (&pool->empty_cond);
1534 /* FIXME have we done enough here ? */
1536 G_OBJECT_CLASS (parent_class)->finalize (object);
1540 gst_v4l2_buffer_pool_init (GstV4l2BufferPool * pool)
1542 pool->poll = gst_poll_new (TRUE);
1543 pool->can_poll_device = TRUE;
1544 g_cond_init (&pool->empty_cond);
1549 gst_v4l2_buffer_pool_class_init (GstV4l2BufferPoolClass * klass)
1551 GObjectClass *object_class = G_OBJECT_CLASS (klass);
1552 GstBufferPoolClass *bufferpool_class = GST_BUFFER_POOL_CLASS (klass);
1554 object_class->dispose = gst_v4l2_buffer_pool_dispose;
1555 object_class->finalize = gst_v4l2_buffer_pool_finalize;
1557 bufferpool_class->start = gst_v4l2_buffer_pool_start;
1558 bufferpool_class->stop = gst_v4l2_buffer_pool_stop;
1559 bufferpool_class->set_config = gst_v4l2_buffer_pool_set_config;
1560 bufferpool_class->alloc_buffer = gst_v4l2_buffer_pool_alloc_buffer;
1561 bufferpool_class->acquire_buffer = gst_v4l2_buffer_pool_acquire_buffer;
1562 bufferpool_class->release_buffer = gst_v4l2_buffer_pool_release_buffer;
1563 bufferpool_class->flush_start = gst_v4l2_buffer_pool_flush_start;
1564 bufferpool_class->flush_stop = gst_v4l2_buffer_pool_flush_stop;
1566 GST_DEBUG_CATEGORY_INIT (v4l2bufferpool_debug, "v4l2bufferpool", 0,
1567 "V4L2 Buffer Pool");
1568 GST_DEBUG_CATEGORY_GET (CAT_PERFORMANCE, "GST_PERFORMANCE");
1572 * gst_v4l2_buffer_pool_new:
1573 * @obj: the v4l2 object owning the pool
1575 * Construct a new buffer pool.
1577 * Returns: the new pool, use gst_object_unref() to free resources
1580 gst_v4l2_buffer_pool_new (GstV4l2Object * obj, GstCaps * caps)
1582 GstV4l2BufferPool *pool;
1583 GstStructure *config;
1584 gchar *name, *parent_name;
1587 fd = obj->dup (obj->video_fd);
1591 /* setting a significant unique name */
1592 parent_name = gst_object_get_name (GST_OBJECT (obj->element));
1593 name = g_strconcat (parent_name, ":", "pool:",
1594 V4L2_TYPE_IS_OUTPUT (obj->type) ? "sink" : "src", NULL);
1595 g_free (parent_name);
1597 pool = (GstV4l2BufferPool *) g_object_new (GST_TYPE_V4L2_BUFFER_POOL,
1598 "name", name, NULL);
1599 g_object_ref_sink (pool);
1602 gst_poll_fd_init (&pool->pollfd);
1603 pool->pollfd.fd = fd;
1604 gst_poll_add_fd (pool->poll, &pool->pollfd);
1605 if (V4L2_TYPE_IS_OUTPUT (obj->type))
1606 gst_poll_fd_ctl_write (pool->poll, &pool->pollfd, TRUE);
1608 gst_poll_fd_ctl_read (pool->poll, &pool->pollfd, TRUE);
1610 pool->video_fd = fd;
1612 pool->can_poll_device = TRUE;
1614 pool->vallocator = gst_v4l2_allocator_new (GST_OBJECT (pool), obj);
1615 if (pool->vallocator == NULL)
1616 goto allocator_failed;
1618 gst_object_ref (obj->element);
1620 config = gst_buffer_pool_get_config (GST_BUFFER_POOL_CAST (pool));
1621 gst_buffer_pool_config_set_params (config, caps, obj->info.size, 0, 0);
1622 /* This will simply set a default config, but will not configure the pool
1623 * because min and max are not valid */
1624 gst_buffer_pool_set_config (GST_BUFFER_POOL_CAST (pool), config);
1626 return GST_BUFFER_POOL (pool);
1631 GST_ERROR ("failed to dup fd %d (%s)", errno, g_strerror (errno));
1636 GST_ERROR_OBJECT (pool, "Failed to create V4L2 allocator");
1637 gst_object_unref (pool);
1642 static GstFlowReturn
1643 gst_v4l2_do_read (GstV4l2BufferPool * pool, GstBuffer * buf)
1646 GstV4l2Object *obj = pool->obj;
1651 toread = obj->info.size;
1653 GST_LOG_OBJECT (pool, "reading %d bytes into buffer %p", toread, buf);
1655 gst_buffer_map (buf, &map, GST_MAP_WRITE);
1658 if ((res = gst_v4l2_buffer_pool_poll (pool, TRUE)) != GST_FLOW_OK)
1661 amount = obj->read (obj->video_fd, map.data, toread);
1663 if (amount == toread) {
1665 } else if (amount == -1) {
1666 if (errno == EAGAIN || errno == EINTR) {
1671 /* short reads can happen if a signal interrupts the read */
1676 GST_LOG_OBJECT (pool, "read %d bytes", amount);
1677 gst_buffer_unmap (buf, &map);
1678 gst_buffer_resize (buf, 0, amount);
1685 GST_DEBUG ("poll error %s", gst_flow_get_name (res));
1690 GST_ELEMENT_ERROR (obj->element, RESOURCE, READ,
1691 (_("Error reading %d bytes from device '%s'."),
1692 toread, obj->videodev), GST_ERROR_SYSTEM);
1693 res = GST_FLOW_ERROR;
1698 gst_buffer_unmap (buf, &map);
1699 gst_buffer_resize (buf, 0, 0);
1705 * gst_v4l2_buffer_pool_process:
1706 * @bpool: a #GstBufferPool
1707 * @buf: a #GstBuffer, maybe be replaced
1709 * Process @buf in @bpool. For capture devices, this functions fills @buf with
1710 * data from the device. For output devices, this functions send the contents of
1711 * @buf to the device for playback.
1713 * Returns: %GST_FLOW_OK on success.
1716 gst_v4l2_buffer_pool_process (GstV4l2BufferPool * pool, GstBuffer ** buf)
1718 GstFlowReturn ret = GST_FLOW_OK;
1719 GstBufferPool *bpool = GST_BUFFER_POOL_CAST (pool);
1720 GstV4l2Object *obj = pool->obj;
1722 GST_DEBUG_OBJECT (pool, "process buffer %p", buf);
1724 if (GST_BUFFER_POOL_IS_FLUSHING (pool))
1725 return GST_FLOW_FLUSHING;
1727 switch (obj->type) {
1728 case V4L2_BUF_TYPE_VIDEO_CAPTURE:
1729 case V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE:
1731 switch (obj->mode) {
1732 case GST_V4L2_IO_RW:
1733 /* capture into the buffer */
1734 ret = gst_v4l2_do_read (pool, *buf);
1737 case GST_V4L2_IO_MMAP:
1738 case GST_V4L2_IO_DMABUF:
1742 if ((*buf)->pool == bpool) {
1744 gsize size = gst_buffer_get_size (*buf);
1746 /* Legacy M2M devices return empty buffer when drained */
1747 if (size == 0 && GST_V4L2_IS_M2M (obj->device_caps))
1750 if (GST_VIDEO_INFO_FORMAT (&pool->caps_info) !=
1751 GST_VIDEO_FORMAT_ENCODED && size < pool->size)
1752 goto buffer_truncated;
1754 num_queued = g_atomic_int_get (&pool->num_queued);
1755 GST_TRACE_OBJECT (pool, "Only %i buffer left in the capture queue.",
1758 /* If we have no more buffer, and can allocate it time to do so */
1759 if (num_queued == 0) {
1760 if (GST_V4L2_ALLOCATOR_CAN_ALLOCATE (pool->vallocator, MMAP)) {
1761 ret = gst_v4l2_buffer_pool_resurect_buffer (pool);
1762 if (ret == GST_FLOW_OK)
1767 /* start copying buffers when we are running low on buffers */
1768 if (num_queued < pool->copy_threshold) {
1771 if (GST_V4L2_ALLOCATOR_CAN_ALLOCATE (pool->vallocator, MMAP)) {
1772 ret = gst_v4l2_buffer_pool_resurect_buffer (pool);
1773 if (ret == GST_FLOW_OK)
1777 /* copy the buffer */
1778 copy = gst_buffer_copy_region (*buf,
1779 GST_BUFFER_COPY_ALL | GST_BUFFER_COPY_DEEP, 0, -1);
1780 GST_LOG_OBJECT (pool, "copy buffer %p->%p", *buf, copy);
1782 /* and requeue so that we can continue capturing */
1783 gst_buffer_unref (*buf);
1788 /* nothing, data was inside the buffer when we did _acquire() */
1792 /* buffer not from our pool, grab a frame and copy it into the target */
1793 if ((ret = gst_v4l2_buffer_pool_dqbuf (pool, &tmp, TRUE))
1797 /* An empty buffer on capture indicates the end of stream */
1798 if (gst_buffer_get_size (tmp) == 0) {
1799 gst_v4l2_buffer_pool_release_buffer (bpool, tmp);
1801 /* Legacy M2M devices return empty buffer when drained */
1802 if (GST_V4L2_IS_M2M (obj->device_caps))
1806 ret = gst_v4l2_buffer_pool_copy_buffer (pool, *buf, tmp);
1808 /* an queue the buffer again after the copy */
1809 gst_v4l2_buffer_pool_release_buffer (bpool, tmp);
1811 if (ret != GST_FLOW_OK)
1816 case GST_V4L2_IO_USERPTR:
1818 struct UserPtrData *data;
1821 /* Replace our buffer with downstream allocated buffer */
1822 data = gst_mini_object_steal_qdata (GST_MINI_OBJECT (*buf),
1823 GST_V4L2_IMPORT_QUARK);
1824 tmp = gst_buffer_ref (data->buffer);
1825 _unmap_userptr_frame (data);
1827 /* Now tmp is writable, copy the flags and timestamp */
1828 gst_buffer_copy_into (tmp, *buf,
1829 GST_BUFFER_COPY_FLAGS | GST_BUFFER_COPY_TIMESTAMPS, 0, -1);
1831 gst_buffer_replace (buf, tmp);
1832 gst_buffer_unref (tmp);
1836 case GST_V4L2_IO_DMABUF_IMPORT:
1840 /* Replace our buffer with downstream allocated buffer */
1841 tmp = gst_mini_object_steal_qdata (GST_MINI_OBJECT (*buf),
1842 GST_V4L2_IMPORT_QUARK);
1844 gst_buffer_copy_into (tmp, *buf,
1845 GST_BUFFER_COPY_FLAGS | GST_BUFFER_COPY_TIMESTAMPS, 0, -1);
1847 gst_buffer_replace (buf, tmp);
1848 gst_buffer_unref (tmp);
1853 g_assert_not_reached ();
1858 case V4L2_BUF_TYPE_VIDEO_OUTPUT:
1859 case V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE:
1861 switch (obj->mode) {
1862 case GST_V4L2_IO_RW:
1863 /* FIXME, do write() */
1864 GST_WARNING_OBJECT (pool, "implement write()");
1867 case GST_V4L2_IO_USERPTR:
1868 case GST_V4L2_IO_DMABUF_IMPORT:
1869 case GST_V4L2_IO_DMABUF:
1870 case GST_V4L2_IO_MMAP:
1872 GstBuffer *to_queue = NULL;
1874 GstV4l2MemoryGroup *group;
1877 if ((*buf)->pool != bpool)
1880 if (!gst_v4l2_is_buffer_valid (*buf, &group))
1883 index = group->buffer.index;
1885 GST_LOG_OBJECT (pool, "processing buffer %i from our pool", index);
1887 if (pool->buffers[index] != NULL) {
1888 GST_LOG_OBJECT (pool, "buffer %i already queued, copying", index);
1892 /* we can queue directly */
1893 to_queue = gst_buffer_ref (*buf);
1896 if (to_queue == NULL) {
1897 GstBufferPoolAcquireParams params = { 0 };
1899 GST_LOG_OBJECT (pool, "alloc buffer from our pool");
1901 /* this can return EOS if all buffers are outstanding which would
1902 * be strange because we would expect the upstream element to have
1903 * allocated them and returned to us.. */
1904 params.flags = GST_BUFFER_POOL_ACQUIRE_FLAG_DONTWAIT;
1905 ret = gst_buffer_pool_acquire_buffer (bpool, &to_queue, ¶ms);
1906 if (ret != GST_FLOW_OK)
1907 goto acquire_failed;
1909 ret = gst_v4l2_buffer_pool_prepare_buffer (pool, to_queue, *buf);
1910 if (ret != GST_FLOW_OK) {
1911 gst_buffer_unref (to_queue);
1912 goto prepare_failed;
1915 /* retreive the group */
1916 gst_v4l2_is_buffer_valid (to_queue, &group);
1919 if ((ret = gst_v4l2_buffer_pool_qbuf (pool, to_queue, group))
1923 /* if we are not streaming yet (this is the first buffer, start
1925 if (!gst_v4l2_buffer_pool_streamon (pool)) {
1926 /* don't check return value because qbuf would have failed */
1927 gst_v4l2_is_buffer_valid (to_queue, &group);
1929 /* qbuf has stored to_queue buffer but we are not in
1930 * streaming state, so the flush logic won't be performed.
1931 * To avoid leaks, flush the allocator and restore the queued
1932 * buffer as non-queued */
1933 gst_v4l2_allocator_flush (pool->vallocator);
1935 pool->buffers[group->buffer.index] = NULL;
1937 gst_mini_object_set_qdata (GST_MINI_OBJECT (to_queue),
1938 GST_V4L2_IMPORT_QUARK, NULL, NULL);
1939 gst_buffer_unref (to_queue);
1940 g_atomic_int_add (&pool->num_queued, -1);
1944 /* Remove our ref, we will still hold this buffer in acquire as needed,
1945 * otherwise the pool will think it is outstanding and will refuse to stop. */
1946 gst_buffer_unref (to_queue);
1948 /* release as many buffer as possible */
1949 while (gst_v4l2_buffer_pool_dqbuf (pool, &buffer, FALSE) ==
1951 if (buffer->pool == NULL)
1952 gst_v4l2_buffer_pool_release_buffer (bpool, buffer);
1955 if (g_atomic_int_get (&pool->num_queued) >= pool->min_latency) {
1956 /* all buffers are queued, try to dequeue one and release it back
1957 * into the pool so that _acquire can get to it again. */
1958 ret = gst_v4l2_buffer_pool_dqbuf (pool, &buffer, TRUE);
1959 if (ret == GST_FLOW_OK && buffer->pool == NULL)
1960 /* release the rendered buffer back into the pool. This wakes up any
1961 * thread waiting for a buffer in _acquire(). */
1962 gst_v4l2_buffer_pool_release_buffer (bpool, buffer);
1967 g_assert_not_reached ();
1972 g_assert_not_reached ();
1981 GST_ERROR_OBJECT (pool, "failed to copy buffer");
1986 GST_WARNING_OBJECT (pool,
1987 "Dropping truncated buffer, this is likely a driver bug.");
1988 gst_buffer_unref (*buf);
1990 return GST_V4L2_FLOW_CORRUPTED_BUFFER;
1994 GST_DEBUG_OBJECT (pool, "end of stream reached");
1995 gst_buffer_unref (*buf);
1997 return GST_V4L2_FLOW_LAST_BUFFER;
2001 if (ret == GST_FLOW_FLUSHING)
2002 GST_DEBUG_OBJECT (pool, "flushing");
2004 GST_WARNING_OBJECT (pool, "failed to acquire a buffer: %s",
2005 gst_flow_get_name (ret));
2010 GST_ERROR_OBJECT (pool, "failed to prepare data");
2015 GST_ERROR_OBJECT (pool, "failed to queue buffer");
2020 GST_ERROR_OBJECT (pool, "failed to start streaming");
2021 return GST_FLOW_ERROR;
2026 gst_v4l2_buffer_pool_set_other_pool (GstV4l2BufferPool * pool,
2027 GstBufferPool * other_pool)
2029 g_return_if_fail (!gst_buffer_pool_is_active (GST_BUFFER_POOL (pool)));
2031 if (pool->other_pool)
2032 gst_object_unref (pool->other_pool);
2033 pool->other_pool = gst_object_ref (other_pool);
2037 gst_v4l2_buffer_pool_copy_at_threshold (GstV4l2BufferPool * pool, gboolean copy)
2039 GST_OBJECT_LOCK (pool);
2040 pool->enable_copy_threshold = copy;
2041 GST_OBJECT_UNLOCK (pool);
2045 gst_v4l2_buffer_pool_flush (GstBufferPool * bpool)
2047 GstV4l2BufferPool *pool = GST_V4L2_BUFFER_POOL (bpool);
2048 gboolean ret = TRUE;
2050 gst_v4l2_buffer_pool_streamoff (pool);
2052 if (!V4L2_TYPE_IS_OUTPUT (pool->obj->type))
2053 ret = gst_v4l2_buffer_pool_streamon (pool);