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 config = gst_buffer_pool_get_config (bpool);
746 if (!gst_buffer_pool_config_get_params (config, &caps, &size, &min_buffers,
750 min_latency = MAX (GST_V4L2_MIN_BUFFERS, obj->min_buffers);
756 /* This workaround a unfixable bug in libv4l2 when RW is emulated on top
757 * of MMAP. In this case, the first read initialize the queues, but the
758 * poll before that will always fail. Doing an empty read, forces the
759 * queue to be initialized now. We only do this if we have a streaming
761 if (obj->device_caps & V4L2_CAP_STREAMING)
762 obj->read (obj->video_fd, NULL, 0);
765 case GST_V4L2_IO_DMABUF:
766 case GST_V4L2_IO_MMAP:
770 can_allocate = GST_V4L2_ALLOCATOR_CAN_ALLOCATE (pool->vallocator, MMAP);
772 /* first, lets request buffers, and see how many we can get: */
773 GST_DEBUG_OBJECT (pool, "requesting %d MMAP buffers", min_buffers);
775 count = gst_v4l2_allocator_start (pool->vallocator, min_buffers,
778 if (count < GST_V4L2_MIN_BUFFERS) {
783 /* V4L2 buffer pool are often very limited in the amount of buffers it
784 * can offer. The copy_threshold will workaround this limitation by
785 * falling back to copy if the pipeline needed more buffers. This also
786 * prevent having to do REQBUFS(N)/REQBUFS(0) everytime configure is
788 if (count != min_buffers || pool->enable_copy_threshold) {
789 GST_WARNING_OBJECT (pool,
790 "Uncertain or not enough buffers, enabling copy threshold");
792 copy_threshold = min_latency;
797 case GST_V4L2_IO_USERPTR:
802 GST_V4L2_ALLOCATOR_CAN_ALLOCATE (pool->vallocator, USERPTR);
804 GST_DEBUG_OBJECT (pool, "requesting %d USERPTR buffers", min_buffers);
806 count = gst_v4l2_allocator_start (pool->vallocator, min_buffers,
807 V4L2_MEMORY_USERPTR);
809 /* There is no rational to not get what we asked */
810 if (count < min_buffers) {
818 case GST_V4L2_IO_DMABUF_IMPORT:
822 can_allocate = GST_V4L2_ALLOCATOR_CAN_ALLOCATE (pool->vallocator, DMABUF);
824 GST_DEBUG_OBJECT (pool, "requesting %d DMABUF buffers", min_buffers);
826 count = gst_v4l2_allocator_start (pool->vallocator, min_buffers,
829 /* There is no rational to not get what we asked */
830 if (count < min_buffers) {
841 g_assert_not_reached ();
846 max_latency = max_buffers;
848 max_latency = min_buffers;
851 pool->copy_threshold = copy_threshold;
852 pool->max_latency = max_latency;
853 pool->min_latency = min_latency;
854 pool->num_queued = 0;
856 if (max_buffers != 0 && max_buffers < min_buffers)
857 max_buffers = min_buffers;
859 gst_buffer_pool_config_set_params (config, caps, size, min_buffers,
861 pclass->set_config (bpool, config);
862 gst_structure_free (config);
864 if (pool->other_pool)
865 if (!gst_buffer_pool_set_active (pool->other_pool, TRUE))
866 goto other_pool_failed;
868 /* now, allocate the buffers: */
869 if (!pclass->start (bpool))
872 if (!V4L2_TYPE_IS_OUTPUT (obj->type)) {
873 pool->group_released_handler =
874 g_signal_connect_swapped (pool->vallocator, "group-released",
875 G_CALLBACK (gst_v4l2_buffer_pool_resurect_buffer), pool);
876 ret = gst_v4l2_buffer_pool_streamon (pool);
884 GST_ERROR_OBJECT (pool, "invalid config %" GST_PTR_FORMAT, config);
885 gst_structure_free (config);
890 GST_ERROR_OBJECT (pool,
891 "we received %d buffer from device '%s', we want at least %d",
892 min_buffers, obj->videodev, GST_V4L2_MIN_BUFFERS);
893 gst_structure_free (config);
898 GST_ERROR_OBJECT (pool, "allocate failed");
903 GST_ERROR_OBJECT (pool, "failed to active the other pool %"
904 GST_PTR_FORMAT, pool->other_pool);
910 gst_v4l2_buffer_pool_stop (GstBufferPool * bpool)
912 GstV4l2BufferPool *pool = GST_V4L2_BUFFER_POOL (bpool);
915 GST_DEBUG_OBJECT (pool, "stopping pool");
917 if (pool->group_released_handler > 0) {
918 g_signal_handler_disconnect (pool->vallocator,
919 pool->group_released_handler);
920 pool->group_released_handler = 0;
923 if (pool->other_pool) {
924 gst_buffer_pool_set_active (pool->other_pool, FALSE);
925 gst_object_unref (pool->other_pool);
926 pool->other_pool = NULL;
929 gst_v4l2_buffer_pool_streamoff (pool);
931 ret = GST_BUFFER_POOL_CLASS (parent_class)->stop (bpool);
933 if (ret && pool->vallocator) {
936 vret = gst_v4l2_allocator_stop (pool->vallocator);
938 if (vret == GST_V4L2_BUSY)
939 GST_WARNING_OBJECT (pool, "some buffers are still outstanding");
941 ret = (vret == GST_V4L2_OK);
948 gst_v4l2_buffer_pool_flush_start (GstBufferPool * bpool)
950 GstV4l2BufferPool *pool = GST_V4L2_BUFFER_POOL (bpool);
952 GST_DEBUG_OBJECT (pool, "start flushing");
954 gst_poll_set_flushing (pool->poll, TRUE);
956 GST_OBJECT_LOCK (pool);
958 g_cond_broadcast (&pool->empty_cond);
959 GST_OBJECT_UNLOCK (pool);
961 if (pool->other_pool)
962 gst_buffer_pool_set_flushing (pool->other_pool, TRUE);
966 gst_v4l2_buffer_pool_flush_stop (GstBufferPool * bpool)
968 GstV4l2BufferPool *pool = GST_V4L2_BUFFER_POOL (bpool);
970 GST_DEBUG_OBJECT (pool, "stop flushing");
972 if (pool->other_pool)
973 gst_buffer_pool_set_flushing (pool->other_pool, FALSE);
975 gst_poll_set_flushing (pool->poll, FALSE);
979 gst_v4l2_buffer_pool_poll (GstV4l2BufferPool * pool)
983 /* In RW mode there is no queue, hence no need to wait while the queue is
985 if (pool->obj->mode != GST_V4L2_IO_RW) {
986 GST_OBJECT_LOCK (pool);
988 g_cond_wait (&pool->empty_cond, GST_OBJECT_GET_LOCK (pool));
989 GST_OBJECT_UNLOCK (pool);
992 if (!pool->can_poll_device)
995 GST_LOG_OBJECT (pool, "polling device");
998 ret = gst_poll_wait (pool->poll, GST_CLOCK_TIME_NONE);
999 if (G_UNLIKELY (ret < 0)) {
1007 GST_WARNING_OBJECT (pool,
1008 "v4l2 device doesn't support polling. Disabling"
1009 " using libv4l2 in this case may cause deadlocks");
1010 pool->can_poll_device = FALSE;
1017 if (gst_poll_fd_has_error (pool->poll, &pool->pollfd))
1026 GST_DEBUG_OBJECT (pool, "stop called");
1027 return GST_FLOW_FLUSHING;
1031 GST_ELEMENT_ERROR (pool->obj->element, RESOURCE, READ, (NULL),
1032 ("poll error %d: %s (%d)", ret, g_strerror (errno), errno));
1033 return GST_FLOW_ERROR;
1037 static GstFlowReturn
1038 gst_v4l2_buffer_pool_qbuf (GstV4l2BufferPool * pool, GstBuffer * buf)
1040 GstV4l2MemoryGroup *group = NULL;
1041 const GstV4l2Object *obj = pool->obj;
1042 GstClockTime timestamp;
1045 if (!gst_v4l2_is_buffer_valid (buf, &group)) {
1046 GST_ERROR_OBJECT (pool, "invalid buffer %p", buf);
1047 return GST_FLOW_ERROR;
1050 index = group->buffer.index;
1052 if (pool->buffers[index] != NULL)
1053 goto already_queued;
1055 GST_LOG_OBJECT (pool, "queuing buffer %i", index);
1057 if (V4L2_TYPE_IS_OUTPUT (obj->type)) {
1058 enum v4l2_field field;
1060 /* Except when field is set to alternate, buffer field is the same as
1061 * the one defined in format */
1062 if (V4L2_TYPE_IS_MULTIPLANAR (obj->type))
1063 field = obj->format.fmt.pix_mp.field;
1065 field = obj->format.fmt.pix.field;
1067 /* NB: At this moment, we can't have alternate mode because it not handled
1069 if (field == V4L2_FIELD_ALTERNATE) {
1070 if (GST_BUFFER_FLAG_IS_SET (buf, GST_VIDEO_FRAME_FLAG_TFF))
1071 field = V4L2_FIELD_TOP;
1073 field = V4L2_FIELD_BOTTOM;
1076 group->buffer.field = field;
1079 if (GST_BUFFER_TIMESTAMP_IS_VALID (buf)) {
1080 timestamp = GST_BUFFER_TIMESTAMP (buf);
1081 GST_TIME_TO_TIMEVAL (timestamp, group->buffer.timestamp);
1084 GST_OBJECT_LOCK (pool);
1085 g_atomic_int_inc (&pool->num_queued);
1086 pool->buffers[index] = buf;
1088 if (!gst_v4l2_allocator_qbuf (pool->vallocator, group))
1091 pool->empty = FALSE;
1092 g_cond_signal (&pool->empty_cond);
1093 GST_OBJECT_UNLOCK (pool);
1099 GST_ERROR_OBJECT (pool, "the buffer %i was already queued", index);
1100 return GST_FLOW_ERROR;
1104 GST_ERROR_OBJECT (pool, "could not queue a buffer %i", index);
1105 /* Mark broken buffer to the allocator */
1106 GST_BUFFER_FLAG_SET (buf, GST_BUFFER_FLAG_TAG_MEMORY);
1107 g_atomic_int_add (&pool->num_queued, -1);
1108 pool->buffers[index] = NULL;
1109 GST_OBJECT_UNLOCK (pool);
1110 return GST_FLOW_ERROR;
1114 static GstFlowReturn
1115 gst_v4l2_buffer_pool_dqbuf (GstV4l2BufferPool * pool, GstBuffer ** buffer)
1119 GstV4l2Object *obj = pool->obj;
1120 GstClockTime timestamp;
1121 GstV4l2MemoryGroup *group;
1122 GstVideoMeta *vmeta;
1126 if ((res = gst_v4l2_buffer_pool_poll (pool)) != GST_FLOW_OK)
1129 GST_LOG_OBJECT (pool, "dequeueing a buffer");
1131 res = gst_v4l2_allocator_dqbuf (pool->vallocator, &group);
1132 if (res == GST_FLOW_EOS)
1134 if (res != GST_FLOW_OK)
1137 /* get our GstBuffer with that index from the pool, if the buffer was
1138 * outstanding we have a serious problem.
1140 outbuf = pool->buffers[group->buffer.index];
1144 /* mark the buffer outstanding */
1145 pool->buffers[group->buffer.index] = NULL;
1146 if (g_atomic_int_dec_and_test (&pool->num_queued)) {
1147 GST_OBJECT_LOCK (pool);
1149 GST_OBJECT_UNLOCK (pool);
1152 timestamp = GST_TIMEVAL_TO_TIME (group->buffer.timestamp);
1155 vmeta = gst_buffer_get_video_meta (outbuf);
1156 for (i = 0; i < group->n_mem; i++) {
1157 GST_LOG_OBJECT (pool,
1158 "dequeued buffer %p seq:%d (ix=%d), mem %p used %d, plane=%d, flags %08x, ts %"
1159 GST_TIME_FORMAT ", pool-queued=%d, buffer=%p", outbuf,
1160 group->buffer.sequence, group->buffer.index, group->mem[i],
1161 group->planes[i].bytesused, i, group->buffer.flags,
1162 GST_TIME_ARGS (timestamp), pool->num_queued, outbuf);
1165 vmeta->offset[i] = size;
1166 size += gst_memory_get_sizes (group->mem[i], NULL, NULL);
1170 /* Ignore timestamp and field for OUTPUT device */
1171 if (V4L2_TYPE_IS_OUTPUT (obj->type))
1174 /* Check for driver bug in reporting feild */
1175 if (group->buffer.field == V4L2_FIELD_ANY) {
1176 /* Only warn once to avoid the spamming */
1177 #ifndef GST_DISABLE_GST_DEBUG
1178 if (!pool->has_warned_on_buggy_field) {
1179 pool->has_warned_on_buggy_field = TRUE;
1180 GST_WARNING_OBJECT (pool,
1181 "Driver should never set v4l2_buffer.field to ANY");
1185 /* Use the value from the format (works for UVC bug) */
1186 group->buffer.field = obj->format.fmt.pix.field;
1188 /* If driver also has buggy S_FMT, assume progressive */
1189 if (group->buffer.field == V4L2_FIELD_ANY) {
1190 #ifndef GST_DISABLE_GST_DEBUG
1191 if (!pool->has_warned_on_buggy_field) {
1192 pool->has_warned_on_buggy_field = TRUE;
1193 GST_WARNING_OBJECT (pool,
1194 "Driver should never set v4l2_format.pix.field to ANY");
1198 group->buffer.field = V4L2_FIELD_NONE;
1202 /* set top/bottom field first if v4l2_buffer has the information */
1203 switch (group->buffer.field) {
1204 case V4L2_FIELD_NONE:
1205 GST_BUFFER_FLAG_UNSET (outbuf, GST_VIDEO_BUFFER_FLAG_INTERLACED);
1206 GST_BUFFER_FLAG_UNSET (outbuf, GST_VIDEO_BUFFER_FLAG_TFF);
1208 case V4L2_FIELD_INTERLACED_TB:
1209 GST_BUFFER_FLAG_SET (outbuf, GST_VIDEO_BUFFER_FLAG_INTERLACED);
1210 GST_BUFFER_FLAG_SET (outbuf, GST_VIDEO_BUFFER_FLAG_TFF);
1212 case V4L2_FIELD_INTERLACED_BT:
1213 GST_BUFFER_FLAG_SET (outbuf, GST_VIDEO_BUFFER_FLAG_INTERLACED);
1214 GST_BUFFER_FLAG_UNSET (outbuf, GST_VIDEO_BUFFER_FLAG_TFF);
1216 case V4L2_FIELD_INTERLACED:
1217 GST_BUFFER_FLAG_SET (outbuf, GST_VIDEO_BUFFER_FLAG_INTERLACED);
1218 if (obj->tv_norm == V4L2_STD_NTSC_M ||
1219 obj->tv_norm == V4L2_STD_NTSC_M_JP ||
1220 obj->tv_norm == V4L2_STD_NTSC_M_KR) {
1221 GST_BUFFER_FLAG_UNSET (outbuf, GST_VIDEO_BUFFER_FLAG_TFF);
1223 GST_BUFFER_FLAG_SET (outbuf, GST_VIDEO_BUFFER_FLAG_TFF);
1227 GST_BUFFER_FLAG_UNSET (outbuf, GST_VIDEO_BUFFER_FLAG_INTERLACED);
1228 GST_BUFFER_FLAG_UNSET (outbuf, GST_VIDEO_BUFFER_FLAG_TFF);
1229 GST_FIXME_OBJECT (pool,
1230 "Unhandled enum v4l2_field %d - treating as progressive",
1231 group->buffer.field);
1235 if (GST_VIDEO_INFO_FORMAT (&obj->info) == GST_VIDEO_FORMAT_ENCODED) {
1236 if ((group->buffer.flags & V4L2_BUF_FLAG_KEYFRAME) ||
1237 GST_V4L2_PIXELFORMAT (obj) == V4L2_PIX_FMT_MJPEG ||
1238 GST_V4L2_PIXELFORMAT (obj) == V4L2_PIX_FMT_JPEG ||
1239 GST_V4L2_PIXELFORMAT (obj) == V4L2_PIX_FMT_PJPG)
1240 GST_BUFFER_FLAG_UNSET (outbuf, GST_BUFFER_FLAG_DELTA_UNIT);
1242 GST_BUFFER_FLAG_SET (outbuf, GST_BUFFER_FLAG_DELTA_UNIT);
1245 if (group->buffer.flags & V4L2_BUF_FLAG_ERROR)
1246 GST_BUFFER_FLAG_SET (outbuf, GST_BUFFER_FLAG_CORRUPTED);
1248 GST_BUFFER_TIMESTAMP (outbuf) = timestamp;
1249 GST_BUFFER_OFFSET (outbuf) = group->buffer.sequence;
1250 GST_BUFFER_OFFSET_END (outbuf) = group->buffer.sequence + 1;
1260 GST_DEBUG_OBJECT (pool, "poll error %s", gst_flow_get_name (res));
1265 return GST_FLOW_EOS;
1269 return GST_FLOW_ERROR;
1273 GST_ERROR_OBJECT (pool, "No free buffer found in the pool at index %d.",
1274 group->buffer.index);
1275 return GST_FLOW_ERROR;
1279 static GstFlowReturn
1280 gst_v4l2_buffer_pool_acquire_buffer (GstBufferPool * bpool, GstBuffer ** buffer,
1281 GstBufferPoolAcquireParams * params)
1284 GstV4l2BufferPool *pool = GST_V4L2_BUFFER_POOL (bpool);
1285 GstBufferPoolClass *pclass = GST_BUFFER_POOL_CLASS (parent_class);
1286 GstV4l2Object *obj = pool->obj;
1288 GST_DEBUG_OBJECT (pool, "acquire");
1290 /* If this is being called to resurect a lost buffer */
1291 if (params && params->flags & GST_V4L2_BUFFER_POOL_ACQUIRE_FLAG_RESURRECT) {
1292 ret = pclass->acquire_buffer (bpool, buffer, params);
1296 switch (obj->type) {
1297 case V4L2_BUF_TYPE_VIDEO_CAPTURE:
1298 case V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE:
1299 /* capture, This function should return a buffer with new captured data */
1300 switch (obj->mode) {
1301 case GST_V4L2_IO_RW:
1303 /* take empty buffer from the pool */
1304 ret = pclass->acquire_buffer (bpool, buffer, params);
1307 case GST_V4L2_IO_DMABUF:
1308 case GST_V4L2_IO_MMAP:
1309 case GST_V4L2_IO_USERPTR:
1310 case GST_V4L2_IO_DMABUF_IMPORT:
1312 /* just dequeue a buffer, we basically use the queue of v4l2 as the
1313 * storage for our buffers. This function does poll first so we can
1314 * interrupt it fine. */
1315 ret = gst_v4l2_buffer_pool_dqbuf (pool, buffer);
1319 ret = GST_FLOW_ERROR;
1320 g_assert_not_reached ();
1326 case V4L2_BUF_TYPE_VIDEO_OUTPUT:
1327 case V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE:
1328 /* playback, This function should return an empty buffer */
1329 switch (obj->mode) {
1330 case GST_V4L2_IO_RW:
1331 /* get an empty buffer */
1332 ret = pclass->acquire_buffer (bpool, buffer, params);
1335 case GST_V4L2_IO_MMAP:
1336 case GST_V4L2_IO_DMABUF:
1337 case GST_V4L2_IO_USERPTR:
1338 case GST_V4L2_IO_DMABUF_IMPORT:
1339 /* get a free unqueued buffer */
1340 ret = pclass->acquire_buffer (bpool, buffer, params);
1344 ret = GST_FLOW_ERROR;
1345 g_assert_not_reached ();
1351 ret = GST_FLOW_ERROR;
1352 g_assert_not_reached ();
1360 gst_v4l2_buffer_pool_release_buffer (GstBufferPool * bpool, GstBuffer * buffer)
1362 GstV4l2BufferPool *pool = GST_V4L2_BUFFER_POOL (bpool);
1363 GstBufferPoolClass *pclass = GST_BUFFER_POOL_CLASS (parent_class);
1364 GstV4l2Object *obj = pool->obj;
1366 GST_DEBUG_OBJECT (pool, "release buffer %p", buffer);
1368 switch (obj->type) {
1369 case V4L2_BUF_TYPE_VIDEO_CAPTURE:
1370 case V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE:
1371 /* capture, put the buffer back in the queue so that we can refill it
1373 switch (obj->mode) {
1374 case GST_V4L2_IO_RW:
1375 /* release back in the pool */
1376 pclass->release_buffer (bpool, buffer);
1379 case GST_V4L2_IO_DMABUF:
1380 case GST_V4L2_IO_MMAP:
1381 case GST_V4L2_IO_USERPTR:
1382 case GST_V4L2_IO_DMABUF_IMPORT:
1384 GstV4l2MemoryGroup *group;
1385 if (gst_v4l2_is_buffer_valid (buffer, &group)) {
1386 gst_v4l2_allocator_reset_group (pool->vallocator, group);
1387 /* queue back in the device */
1388 if (pool->other_pool)
1389 gst_v4l2_buffer_pool_prepare_buffer (pool, buffer, NULL);
1390 if (gst_v4l2_buffer_pool_qbuf (pool, buffer) != GST_FLOW_OK)
1391 pclass->release_buffer (bpool, buffer);
1393 /* Simply release invalide/modified buffer, the allocator will
1394 * give it back later */
1395 GST_BUFFER_FLAG_SET (buffer, GST_BUFFER_FLAG_TAG_MEMORY);
1396 pclass->release_buffer (bpool, buffer);
1401 g_assert_not_reached ();
1406 case V4L2_BUF_TYPE_VIDEO_OUTPUT:
1407 case V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE:
1408 switch (obj->mode) {
1409 case GST_V4L2_IO_RW:
1410 /* release back in the pool */
1411 pclass->release_buffer (bpool, buffer);
1414 case GST_V4L2_IO_MMAP:
1415 case GST_V4L2_IO_DMABUF:
1416 case GST_V4L2_IO_USERPTR:
1417 case GST_V4L2_IO_DMABUF_IMPORT:
1419 GstV4l2MemoryGroup *group;
1422 if (!gst_v4l2_is_buffer_valid (buffer, &group)) {
1423 /* Simply release invalide/modified buffer, the allocator will
1424 * give it back later */
1425 GST_BUFFER_FLAG_SET (buffer, GST_BUFFER_FLAG_TAG_MEMORY);
1426 pclass->release_buffer (bpool, buffer);
1430 index = group->buffer.index;
1432 if (pool->buffers[index] == NULL) {
1433 GST_LOG_OBJECT (pool, "buffer %u not queued, putting on free list",
1436 /* Remove qdata, this will unmap any map data in userptr */
1437 gst_mini_object_set_qdata (GST_MINI_OBJECT (buffer),
1438 GST_V4L2_IMPORT_QUARK, NULL, NULL);
1440 /* reset to default size */
1441 gst_v4l2_allocator_reset_group (pool->vallocator, group);
1443 /* playback, put the buffer back in the queue to refill later. */
1444 pclass->release_buffer (bpool, buffer);
1446 /* the buffer is queued in the device but maybe not played yet. We just
1447 * leave it there and not make it available for future calls to acquire
1448 * for now. The buffer will be dequeued and reused later. */
1449 GST_LOG_OBJECT (pool, "buffer %u is queued", index);
1455 g_assert_not_reached ();
1461 g_assert_not_reached ();
1467 gst_v4l2_buffer_pool_dispose (GObject * object)
1469 GstV4l2BufferPool *pool = GST_V4L2_BUFFER_POOL (object);
1471 if (pool->vallocator)
1472 gst_object_unref (pool->vallocator);
1473 pool->vallocator = NULL;
1475 if (pool->allocator)
1476 gst_object_unref (pool->allocator);
1477 pool->allocator = NULL;
1479 if (pool->other_pool)
1480 gst_object_unref (pool->other_pool);
1481 pool->other_pool = NULL;
1483 G_OBJECT_CLASS (parent_class)->dispose (object);
1487 gst_v4l2_buffer_pool_finalize (GObject * object)
1489 GstV4l2BufferPool *pool = GST_V4L2_BUFFER_POOL (object);
1491 if (pool->video_fd >= 0)
1492 pool->obj->close (pool->video_fd);
1494 gst_poll_free (pool->poll);
1496 /* This can't be done in dispose method because we must not set pointer
1497 * to NULL as it is part of the v4l2object and dispose could be called
1499 gst_object_unref (pool->obj->element);
1501 g_cond_clear (&pool->empty_cond);
1503 /* FIXME have we done enough here ? */
1505 G_OBJECT_CLASS (parent_class)->finalize (object);
1509 gst_v4l2_buffer_pool_init (GstV4l2BufferPool * pool)
1511 pool->poll = gst_poll_new (TRUE);
1512 pool->can_poll_device = TRUE;
1513 g_cond_init (&pool->empty_cond);
1518 gst_v4l2_buffer_pool_class_init (GstV4l2BufferPoolClass * klass)
1520 GObjectClass *object_class = G_OBJECT_CLASS (klass);
1521 GstBufferPoolClass *bufferpool_class = GST_BUFFER_POOL_CLASS (klass);
1523 object_class->dispose = gst_v4l2_buffer_pool_dispose;
1524 object_class->finalize = gst_v4l2_buffer_pool_finalize;
1526 bufferpool_class->start = gst_v4l2_buffer_pool_start;
1527 bufferpool_class->stop = gst_v4l2_buffer_pool_stop;
1528 bufferpool_class->set_config = gst_v4l2_buffer_pool_set_config;
1529 bufferpool_class->alloc_buffer = gst_v4l2_buffer_pool_alloc_buffer;
1530 bufferpool_class->acquire_buffer = gst_v4l2_buffer_pool_acquire_buffer;
1531 bufferpool_class->release_buffer = gst_v4l2_buffer_pool_release_buffer;
1532 bufferpool_class->flush_start = gst_v4l2_buffer_pool_flush_start;
1533 bufferpool_class->flush_stop = gst_v4l2_buffer_pool_flush_stop;
1535 GST_DEBUG_CATEGORY_INIT (v4l2bufferpool_debug, "v4l2bufferpool", 0,
1536 "V4L2 Buffer Pool");
1537 GST_DEBUG_CATEGORY_GET (CAT_PERFORMANCE, "GST_PERFORMANCE");
1541 * gst_v4l2_buffer_pool_new:
1542 * @obj: the v4l2 object owning the pool
1544 * Construct a new buffer pool.
1546 * Returns: the new pool, use gst_object_unref() to free resources
1549 gst_v4l2_buffer_pool_new (GstV4l2Object * obj, GstCaps * caps)
1551 GstV4l2BufferPool *pool;
1552 GstStructure *config;
1553 gchar *name, *parent_name;
1556 fd = obj->dup (obj->video_fd);
1560 /* setting a significant unique name */
1561 parent_name = gst_object_get_name (GST_OBJECT (obj->element));
1562 name = g_strconcat (parent_name, ":", "pool:",
1563 V4L2_TYPE_IS_OUTPUT (obj->type) ? "sink" : "src", NULL);
1564 g_free (parent_name);
1566 pool = (GstV4l2BufferPool *) g_object_new (GST_TYPE_V4L2_BUFFER_POOL,
1567 "name", name, NULL);
1568 g_object_ref_sink (pool);
1571 gst_poll_fd_init (&pool->pollfd);
1572 pool->pollfd.fd = fd;
1573 gst_poll_add_fd (pool->poll, &pool->pollfd);
1574 if (V4L2_TYPE_IS_OUTPUT (obj->type))
1575 gst_poll_fd_ctl_write (pool->poll, &pool->pollfd, TRUE);
1577 gst_poll_fd_ctl_read (pool->poll, &pool->pollfd, TRUE);
1579 pool->video_fd = fd;
1581 pool->can_poll_device = TRUE;
1583 pool->vallocator = gst_v4l2_allocator_new (GST_OBJECT (pool), obj);
1584 if (pool->vallocator == NULL)
1585 goto allocator_failed;
1587 gst_object_ref (obj->element);
1589 config = gst_buffer_pool_get_config (GST_BUFFER_POOL_CAST (pool));
1590 gst_buffer_pool_config_set_params (config, caps, obj->info.size, 0, 0);
1591 /* This will simply set a default config, but will not configure the pool
1592 * because min and max are not valid */
1593 gst_buffer_pool_set_config (GST_BUFFER_POOL_CAST (pool), config);
1595 return GST_BUFFER_POOL (pool);
1600 GST_ERROR ("failed to dup fd %d (%s)", errno, g_strerror (errno));
1605 GST_ERROR_OBJECT (pool, "Failed to create V4L2 allocator");
1606 gst_object_unref (pool);
1611 static GstFlowReturn
1612 gst_v4l2_do_read (GstV4l2BufferPool * pool, GstBuffer * buf)
1615 GstV4l2Object *obj = pool->obj;
1620 toread = obj->info.size;
1622 GST_LOG_OBJECT (pool, "reading %d bytes into buffer %p", toread, buf);
1624 gst_buffer_map (buf, &map, GST_MAP_WRITE);
1627 if ((res = gst_v4l2_buffer_pool_poll (pool)) != GST_FLOW_OK)
1630 amount = obj->read (obj->video_fd, map.data, toread);
1632 if (amount == toread) {
1634 } else if (amount == -1) {
1635 if (errno == EAGAIN || errno == EINTR) {
1640 /* short reads can happen if a signal interrupts the read */
1645 GST_LOG_OBJECT (pool, "read %d bytes", amount);
1646 gst_buffer_unmap (buf, &map);
1647 gst_buffer_resize (buf, 0, amount);
1654 GST_DEBUG ("poll error %s", gst_flow_get_name (res));
1659 GST_ELEMENT_ERROR (obj->element, RESOURCE, READ,
1660 (_("Error reading %d bytes from device '%s'."),
1661 toread, obj->videodev), GST_ERROR_SYSTEM);
1662 res = GST_FLOW_ERROR;
1667 gst_buffer_unmap (buf, &map);
1668 gst_buffer_resize (buf, 0, 0);
1674 * gst_v4l2_buffer_pool_process:
1675 * @bpool: a #GstBufferPool
1676 * @buf: a #GstBuffer, maybe be replaced
1678 * Process @buf in @bpool. For capture devices, this functions fills @buf with
1679 * data from the device. For output devices, this functions send the contents of
1680 * @buf to the device for playback.
1682 * Returns: %GST_FLOW_OK on success.
1685 gst_v4l2_buffer_pool_process (GstV4l2BufferPool * pool, GstBuffer ** buf)
1687 GstFlowReturn ret = GST_FLOW_OK;
1688 GstBufferPool *bpool = GST_BUFFER_POOL_CAST (pool);
1689 GstV4l2Object *obj = pool->obj;
1691 GST_DEBUG_OBJECT (pool, "process buffer %p", buf);
1693 if (GST_BUFFER_POOL_IS_FLUSHING (pool))
1694 return GST_FLOW_FLUSHING;
1696 switch (obj->type) {
1697 case V4L2_BUF_TYPE_VIDEO_CAPTURE:
1698 case V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE:
1700 switch (obj->mode) {
1701 case GST_V4L2_IO_RW:
1702 /* capture into the buffer */
1703 ret = gst_v4l2_do_read (pool, *buf);
1706 case GST_V4L2_IO_MMAP:
1707 case GST_V4L2_IO_DMABUF:
1711 if ((*buf)->pool == bpool) {
1713 gsize size = gst_buffer_get_size (*buf);
1716 if (GST_BUFFER_FLAG_IS_SET (*buf, GST_BUFFER_FLAG_CORRUPTED))
1717 goto buffer_corrupted;
1722 num_queued = g_atomic_int_get (&pool->num_queued);
1723 GST_TRACE_OBJECT (pool, "Only %i buffer left in the capture queue.",
1726 /* If we have no more buffer, and can allocate it time to do so */
1727 if (num_queued == 0) {
1728 if (GST_V4L2_ALLOCATOR_CAN_ALLOCATE (pool->vallocator, MMAP)) {
1729 ret = gst_v4l2_buffer_pool_resurect_buffer (pool);
1730 if (ret == GST_FLOW_OK)
1735 /* start copying buffers when we are running low on buffers */
1736 if (num_queued < pool->copy_threshold) {
1739 if (GST_V4L2_ALLOCATOR_CAN_ALLOCATE (pool->vallocator, MMAP)) {
1740 ret = gst_v4l2_buffer_pool_resurect_buffer (pool);
1741 if (ret == GST_FLOW_OK)
1745 /* copy the buffer */
1746 copy = gst_buffer_copy_region (*buf,
1747 GST_BUFFER_COPY_ALL | GST_BUFFER_COPY_DEEP, 0, -1);
1748 GST_LOG_OBJECT (pool, "copy buffer %p->%p", *buf, copy);
1750 /* and requeue so that we can continue capturing */
1751 gst_buffer_unref (*buf);
1756 /* nothing, data was inside the buffer when we did _acquire() */
1760 /* buffer not from our pool, grab a frame and copy it into the target */
1761 if ((ret = gst_v4l2_buffer_pool_dqbuf (pool, &tmp)) != GST_FLOW_OK)
1764 /* An empty buffer on capture indicates the end of stream */
1765 if (gst_buffer_get_size (tmp) == 0) {
1766 gboolean corrupted = GST_BUFFER_FLAG_IS_SET (tmp,
1767 GST_BUFFER_FLAG_CORRUPTED);
1769 gst_v4l2_buffer_pool_release_buffer (bpool, tmp);
1772 goto buffer_corrupted;
1777 ret = gst_v4l2_buffer_pool_copy_buffer (pool, *buf, tmp);
1779 /* an queue the buffer again after the copy */
1780 gst_v4l2_buffer_pool_release_buffer (bpool, tmp);
1782 if (ret != GST_FLOW_OK)
1787 case GST_V4L2_IO_USERPTR:
1789 struct UserPtrData *data;
1792 /* Replace our buffer with downstream allocated buffer */
1793 data = gst_mini_object_steal_qdata (GST_MINI_OBJECT (*buf),
1794 GST_V4L2_IMPORT_QUARK);
1795 tmp = gst_buffer_ref (data->buffer);
1796 _unmap_userptr_frame (data);
1798 /* Now tmp is writable, copy the flags and timestamp */
1799 gst_buffer_copy_into (tmp, *buf,
1800 GST_BUFFER_COPY_FLAGS | GST_BUFFER_COPY_TIMESTAMPS, 0, -1);
1802 gst_buffer_replace (buf, tmp);
1803 gst_buffer_unref (tmp);
1807 case GST_V4L2_IO_DMABUF_IMPORT:
1811 /* Replace our buffer with downstream allocated buffer */
1812 tmp = gst_mini_object_steal_qdata (GST_MINI_OBJECT (*buf),
1813 GST_V4L2_IMPORT_QUARK);
1815 gst_buffer_copy_into (tmp, *buf,
1816 GST_BUFFER_COPY_FLAGS | GST_BUFFER_COPY_TIMESTAMPS, 0, -1);
1818 gst_buffer_replace (buf, tmp);
1819 gst_buffer_unref (tmp);
1824 g_assert_not_reached ();
1829 case V4L2_BUF_TYPE_VIDEO_OUTPUT:
1830 case V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE:
1832 switch (obj->mode) {
1833 case GST_V4L2_IO_RW:
1834 /* FIXME, do write() */
1835 GST_WARNING_OBJECT (pool, "implement write()");
1838 case GST_V4L2_IO_USERPTR:
1839 case GST_V4L2_IO_DMABUF_IMPORT:
1840 case GST_V4L2_IO_DMABUF:
1841 case GST_V4L2_IO_MMAP:
1843 GstBuffer *to_queue = NULL;
1844 GstV4l2MemoryGroup *group;
1847 if ((*buf)->pool != bpool)
1850 if (!gst_v4l2_is_buffer_valid (*buf, &group))
1853 index = group->buffer.index;
1855 GST_LOG_OBJECT (pool, "processing buffer %i from our pool", index);
1857 if (pool->buffers[index] != NULL) {
1858 GST_LOG_OBJECT (pool, "buffer %i already queued, copying", index);
1862 /* we can queue directly */
1863 to_queue = gst_buffer_ref (*buf);
1866 if (to_queue == NULL) {
1867 GstBufferPoolAcquireParams params = { 0 };
1869 GST_LOG_OBJECT (pool, "alloc buffer from our pool");
1871 /* this can return EOS if all buffers are outstanding which would
1872 * be strange because we would expect the upstream element to have
1873 * allocated them and returned to us.. */
1874 params.flags = GST_BUFFER_POOL_ACQUIRE_FLAG_DONTWAIT;
1875 ret = gst_buffer_pool_acquire_buffer (bpool, &to_queue, ¶ms);
1876 if (ret != GST_FLOW_OK)
1877 goto acquire_failed;
1879 ret = gst_v4l2_buffer_pool_prepare_buffer (pool, to_queue, *buf);
1880 if (ret != GST_FLOW_OK) {
1881 gst_buffer_unref (to_queue);
1882 goto prepare_failed;
1886 if ((ret = gst_v4l2_buffer_pool_qbuf (pool, to_queue)) != GST_FLOW_OK)
1889 /* if we are not streaming yet (this is the first buffer, start
1891 if (!gst_v4l2_buffer_pool_streamon (pool)) {
1892 /* don't check return value because qbuf would have failed */
1893 gst_v4l2_is_buffer_valid (to_queue, &group);
1895 /* qbuf has stored to_queue buffer but we are not in
1896 * streaming state, so the flush logic won't be performed.
1897 * To avoid leaks, flush the allocator and restore the queued
1898 * buffer as non-queued */
1899 gst_v4l2_allocator_flush (pool->vallocator);
1901 pool->buffers[group->buffer.index] = NULL;
1903 gst_mini_object_set_qdata (GST_MINI_OBJECT (to_queue),
1904 GST_V4L2_IMPORT_QUARK, NULL, NULL);
1905 gst_buffer_unref (to_queue);
1906 g_atomic_int_add (&pool->num_queued, -1);
1910 /* Remove our ref, we will still hold this buffer in acquire as needed,
1911 * otherwise the pool will think it is outstanding and will refuse to stop. */
1912 gst_buffer_unref (to_queue);
1914 if (g_atomic_int_get (&pool->num_queued) >= pool->min_latency) {
1916 /* all buffers are queued, try to dequeue one and release it back
1917 * into the pool so that _acquire can get to it again. */
1918 ret = gst_v4l2_buffer_pool_dqbuf (pool, &out);
1919 if (ret == GST_FLOW_OK && out->pool == NULL)
1920 /* release the rendered buffer back into the pool. This wakes up any
1921 * thread waiting for a buffer in _acquire(). */
1922 gst_v4l2_buffer_pool_release_buffer (bpool, out);
1927 g_assert_not_reached ();
1932 g_assert_not_reached ();
1941 GST_ERROR_OBJECT (pool, "failed to copy buffer");
1946 GST_WARNING_OBJECT (pool, "Dropping corrupted buffer without payload");
1947 gst_buffer_unref (*buf);
1949 return GST_V4L2_FLOW_CORRUPTED_BUFFER;
1953 GST_DEBUG_OBJECT (pool, "end of stream reached");
1954 gst_buffer_unref (*buf);
1956 return GST_V4L2_FLOW_LAST_BUFFER;
1960 if (ret == GST_FLOW_FLUSHING)
1961 GST_DEBUG_OBJECT (pool, "flushing");
1963 GST_WARNING_OBJECT (pool, "failed to acquire a buffer: %s",
1964 gst_flow_get_name (ret));
1969 GST_ERROR_OBJECT (pool, "failed to prepare data");
1974 GST_ERROR_OBJECT (pool, "failed to queue buffer");
1979 GST_ERROR_OBJECT (pool, "failed to start streaming");
1980 return GST_FLOW_ERROR;
1985 gst_v4l2_buffer_pool_set_other_pool (GstV4l2BufferPool * pool,
1986 GstBufferPool * other_pool)
1988 g_return_if_fail (!gst_buffer_pool_is_active (GST_BUFFER_POOL (pool)));
1990 if (pool->other_pool)
1991 gst_object_unref (pool->other_pool);
1992 pool->other_pool = gst_object_ref (other_pool);
1996 gst_v4l2_buffer_pool_copy_at_threshold (GstV4l2BufferPool * pool, gboolean copy)
1998 GST_OBJECT_LOCK (pool);
1999 pool->enable_copy_threshold = copy;
2000 GST_OBJECT_UNLOCK (pool);
2004 gst_v4l2_buffer_pool_flush (GstBufferPool * bpool)
2006 GstV4l2BufferPool *pool = GST_V4L2_BUFFER_POOL (bpool);
2007 gboolean ret = TRUE;
2009 gst_v4l2_buffer_pool_streamoff (pool);
2011 if (!V4L2_TYPE_IS_OUTPUT (pool->obj->type))
2012 ret = gst_v4l2_buffer_pool_streamon (pool);