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_resurrect_buffer (GstV4l2BufferPool * pool)
616 GstBufferPoolAcquireParams params = { 0 };
617 GstBuffer *buffer = NULL;
620 GST_DEBUG_OBJECT (pool, "A buffer was lost, reallocating it");
622 /* block recursive calls to this function */
623 g_signal_handler_block (pool->vallocator, pool->group_released_handler);
626 (GstBufferPoolAcquireFlags) GST_V4L2_BUFFER_POOL_ACQUIRE_FLAG_RESURRECT |
627 GST_BUFFER_POOL_ACQUIRE_FLAG_DONTWAIT;
629 gst_buffer_pool_acquire_buffer (GST_BUFFER_POOL (pool), &buffer, ¶ms);
631 if (ret == GST_FLOW_OK)
632 gst_buffer_unref (buffer);
634 g_signal_handler_unblock (pool->vallocator, pool->group_released_handler);
640 gst_v4l2_buffer_pool_streamon (GstV4l2BufferPool * pool)
642 GstV4l2Object *obj = pool->obj;
648 case GST_V4L2_IO_MMAP:
649 case GST_V4L2_IO_USERPTR:
650 case GST_V4L2_IO_DMABUF:
651 case GST_V4L2_IO_DMABUF_IMPORT:
652 if (!V4L2_TYPE_IS_OUTPUT (pool->obj->type)) {
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, resurrect them, then releasing will queue
657 while (gst_v4l2_buffer_pool_resurrect_buffer (pool) == GST_FLOW_OK)
661 if (obj->ioctl (pool->video_fd, VIDIOC_STREAMON, &obj->type) < 0)
662 goto streamon_failed;
664 pool->streaming = TRUE;
666 GST_DEBUG_OBJECT (pool, "Started streaming");
676 GST_ERROR_OBJECT (pool, "error with STREAMON %d (%s)", errno,
682 /* Call with streamlock held, or when streaming threads are down */
684 gst_v4l2_buffer_pool_streamoff (GstV4l2BufferPool * pool)
686 GstBufferPoolClass *pclass = GST_BUFFER_POOL_CLASS (parent_class);
687 GstV4l2Object *obj = pool->obj;
690 if (!pool->streaming)
694 case GST_V4L2_IO_MMAP:
695 case GST_V4L2_IO_USERPTR:
696 case GST_V4L2_IO_DMABUF:
697 case GST_V4L2_IO_DMABUF_IMPORT:
699 if (obj->ioctl (pool->video_fd, VIDIOC_STREAMOFF, &obj->type) < 0)
700 GST_WARNING_OBJECT (pool, "STREAMOFF failed with errno %d (%s)",
701 errno, g_strerror (errno));
703 pool->streaming = FALSE;
705 GST_DEBUG_OBJECT (pool, "Stopped streaming");
707 if (pool->vallocator)
708 gst_v4l2_allocator_flush (pool->vallocator);
714 for (i = 0; i < VIDEO_MAX_FRAME; i++) {
715 if (pool->buffers[i]) {
716 GstBuffer *buffer = pool->buffers[i];
717 GstBufferPool *bpool = GST_BUFFER_POOL (pool);
719 pool->buffers[i] = NULL;
721 if (V4L2_TYPE_IS_OUTPUT (pool->obj->type))
722 gst_v4l2_buffer_pool_release_buffer (bpool, buffer);
723 else /* Don't re-enqueue capture buffer on stop */
724 pclass->release_buffer (bpool, buffer);
726 g_atomic_int_add (&pool->num_queued, -1);
732 gst_v4l2_buffer_pool_start (GstBufferPool * bpool)
734 GstV4l2BufferPool *pool = GST_V4L2_BUFFER_POOL (bpool);
735 GstBufferPoolClass *pclass = GST_BUFFER_POOL_CLASS (parent_class);
736 GstV4l2Object *obj = pool->obj;
737 GstStructure *config;
739 guint size, min_buffers, max_buffers;
740 guint max_latency, min_latency, copy_threshold = 0;
741 gboolean can_allocate = FALSE, ret = TRUE;
743 GST_DEBUG_OBJECT (pool, "activating pool");
745 if (pool->other_pool) {
748 if (!gst_buffer_pool_set_active (pool->other_pool, TRUE))
749 goto other_pool_failed;
751 if (gst_buffer_pool_acquire_buffer (pool->other_pool, &buffer, NULL) !=
753 goto other_pool_failed;
755 if (!gst_v4l2_object_try_import (obj, buffer)) {
756 gst_buffer_unref (buffer);
759 gst_buffer_unref (buffer);
762 config = gst_buffer_pool_get_config (bpool);
763 if (!gst_buffer_pool_config_get_params (config, &caps, &size, &min_buffers,
767 min_latency = MAX (GST_V4L2_MIN_BUFFERS, obj->min_buffers);
773 /* This workaround a unfixable bug in libv4l2 when RW is emulated on top
774 * of MMAP. In this case, the first read initialize the queues, but the
775 * poll before that will always fail. Doing an empty read, forces the
776 * queue to be initialized now. We only do this if we have a streaming
778 if (obj->device_caps & V4L2_CAP_STREAMING)
779 obj->read (obj->video_fd, NULL, 0);
782 case GST_V4L2_IO_DMABUF:
783 case GST_V4L2_IO_MMAP:
787 can_allocate = GST_V4L2_ALLOCATOR_CAN_ALLOCATE (pool->vallocator, MMAP);
789 /* first, lets request buffers, and see how many we can get: */
790 GST_DEBUG_OBJECT (pool, "requesting %d MMAP buffers", min_buffers);
792 count = gst_v4l2_allocator_start (pool->vallocator, min_buffers,
795 if (count < GST_V4L2_MIN_BUFFERS) {
800 /* V4L2 buffer pool are often very limited in the amount of buffers it
801 * can offer. The copy_threshold will workaround this limitation by
802 * falling back to copy if the pipeline needed more buffers. This also
803 * prevent having to do REQBUFS(N)/REQBUFS(0) everytime configure is
805 if (count != min_buffers || pool->enable_copy_threshold) {
806 GST_WARNING_OBJECT (pool,
807 "Uncertain or not enough buffers, enabling copy threshold");
809 copy_threshold = min_latency;
814 case GST_V4L2_IO_USERPTR:
819 GST_V4L2_ALLOCATOR_CAN_ALLOCATE (pool->vallocator, USERPTR);
821 GST_DEBUG_OBJECT (pool, "requesting %d USERPTR buffers", min_buffers);
823 count = gst_v4l2_allocator_start (pool->vallocator, min_buffers,
824 V4L2_MEMORY_USERPTR);
826 /* There is no rational to not get what we asked */
827 if (count < min_buffers) {
835 case GST_V4L2_IO_DMABUF_IMPORT:
839 can_allocate = GST_V4L2_ALLOCATOR_CAN_ALLOCATE (pool->vallocator, DMABUF);
841 GST_DEBUG_OBJECT (pool, "requesting %d DMABUF buffers", min_buffers);
843 count = gst_v4l2_allocator_start (pool->vallocator, min_buffers,
846 /* There is no rational to not get what we asked */
847 if (count < min_buffers) {
858 g_assert_not_reached ();
863 max_latency = max_buffers;
865 max_latency = min_buffers;
868 pool->copy_threshold = copy_threshold;
869 pool->max_latency = max_latency;
870 pool->min_latency = min_latency;
871 pool->num_queued = 0;
873 if (max_buffers != 0 && max_buffers < min_buffers)
874 max_buffers = min_buffers;
876 gst_buffer_pool_config_set_params (config, caps, size, min_buffers,
878 pclass->set_config (bpool, config);
879 gst_structure_free (config);
881 /* now, allocate the buffers: */
882 if (!pclass->start (bpool))
885 if (!V4L2_TYPE_IS_OUTPUT (obj->type)) {
886 if (g_atomic_int_get (&pool->num_queued) < min_buffers)
889 pool->group_released_handler =
890 g_signal_connect_swapped (pool->vallocator, "group-released",
891 G_CALLBACK (gst_v4l2_buffer_pool_resurrect_buffer), pool);
892 ret = gst_v4l2_buffer_pool_streamon (pool);
900 GST_ERROR_OBJECT (pool, "invalid config %" GST_PTR_FORMAT, config);
901 gst_structure_free (config);
906 GST_ERROR_OBJECT (pool,
907 "we received %d buffer from device '%s', we want at least %d",
908 min_buffers, obj->videodev, GST_V4L2_MIN_BUFFERS);
909 gst_structure_free (config);
914 GST_ERROR_OBJECT (pool, "allocate failed");
919 GST_ERROR_OBJECT (pool, "failed to activate the other pool %"
920 GST_PTR_FORMAT, pool->other_pool);
925 GST_ERROR_OBJECT (pool, "failed to queue buffers into the capture queue");
930 GST_ERROR_OBJECT (pool, "cannot import buffers from downstream pool");
936 gst_v4l2_buffer_pool_stop (GstBufferPool * bpool)
938 GstV4l2BufferPool *pool = GST_V4L2_BUFFER_POOL (bpool);
944 GST_DEBUG_OBJECT (pool, "stopping pool");
946 if (pool->group_released_handler > 0) {
947 g_signal_handler_disconnect (pool->vallocator,
948 pool->group_released_handler);
949 pool->group_released_handler = 0;
952 if (pool->other_pool) {
953 gst_buffer_pool_set_active (pool->other_pool, FALSE);
954 gst_object_unref (pool->other_pool);
955 pool->other_pool = NULL;
958 gst_v4l2_buffer_pool_streamoff (pool);
960 ret = GST_BUFFER_POOL_CLASS (parent_class)->stop (bpool);
962 if (ret && pool->vallocator) {
965 vret = gst_v4l2_allocator_stop (pool->vallocator);
967 if (vret == GST_V4L2_BUSY)
968 GST_WARNING_OBJECT (pool, "some buffers are still outstanding");
970 ret = (vret == GST_V4L2_OK);
977 gst_v4l2_buffer_pool_orphan (GstBufferPool ** bpool)
979 GstV4l2BufferPool *pool = GST_V4L2_BUFFER_POOL (*bpool);
982 if (!GST_V4L2_ALLOCATOR_CAN_ORPHAN_BUFS (pool->vallocator))
985 if (g_getenv ("GST_V4L2_FORCE_DRAIN"))
988 GST_DEBUG_OBJECT (pool, "orphaning pool");
990 gst_buffer_pool_set_active (*bpool, FALSE);
992 * If the buffer pool has outstanding buffers, it will not be stopped
993 * by the base class when set inactive. Stop it manually and mark it
996 ret = gst_v4l2_buffer_pool_stop (*bpool);
998 gst_v4l2_allocator_orphan (pool->vallocator);
1000 pool->orphaned = TRUE;
1001 gst_object_unref (*bpool);
1007 gst_v4l2_buffer_pool_flush_start (GstBufferPool * bpool)
1009 GstV4l2BufferPool *pool = GST_V4L2_BUFFER_POOL (bpool);
1011 GST_DEBUG_OBJECT (pool, "start flushing");
1013 gst_poll_set_flushing (pool->poll, TRUE);
1015 GST_OBJECT_LOCK (pool);
1016 pool->empty = FALSE;
1017 g_cond_broadcast (&pool->empty_cond);
1018 GST_OBJECT_UNLOCK (pool);
1020 if (pool->other_pool)
1021 gst_buffer_pool_set_flushing (pool->other_pool, TRUE);
1025 gst_v4l2_buffer_pool_flush_stop (GstBufferPool * bpool)
1027 GstV4l2BufferPool *pool = GST_V4L2_BUFFER_POOL (bpool);
1029 GST_DEBUG_OBJECT (pool, "stop flushing");
1031 if (pool->other_pool)
1032 gst_buffer_pool_set_flushing (pool->other_pool, FALSE);
1034 gst_poll_set_flushing (pool->poll, FALSE);
1037 static GstFlowReturn
1038 gst_v4l2_buffer_pool_poll (GstV4l2BufferPool * pool, gboolean wait)
1041 GstClockTime timeout;
1044 timeout = GST_CLOCK_TIME_NONE;
1048 /* In RW mode there is no queue, hence no need to wait while the queue is
1050 if (pool->obj->mode != GST_V4L2_IO_RW) {
1051 GST_OBJECT_LOCK (pool);
1053 if (!wait && pool->empty) {
1054 GST_OBJECT_UNLOCK (pool);
1059 g_cond_wait (&pool->empty_cond, GST_OBJECT_GET_LOCK (pool));
1061 GST_OBJECT_UNLOCK (pool);
1064 if (!pool->can_poll_device) {
1071 GST_LOG_OBJECT (pool, "polling device");
1074 ret = gst_poll_wait (pool->poll, timeout);
1075 if (G_UNLIKELY (ret < 0)) {
1083 GST_WARNING_OBJECT (pool,
1084 "v4l2 device doesn't support polling. Disabling"
1085 " using libv4l2 in this case may cause deadlocks");
1086 pool->can_poll_device = FALSE;
1093 if (gst_poll_fd_has_error (pool->poll, &pool->pollfd))
1105 GST_DEBUG_OBJECT (pool, "stop called");
1106 return GST_FLOW_FLUSHING;
1110 GST_ELEMENT_ERROR (pool->obj->element, RESOURCE, READ, (NULL),
1111 ("poll error %d: %s (%d)", ret, g_strerror (errno), errno));
1112 return GST_FLOW_ERROR;
1115 return GST_FLOW_CUSTOM_SUCCESS;
1118 static GstFlowReturn
1119 gst_v4l2_buffer_pool_qbuf (GstV4l2BufferPool * pool, GstBuffer * buf,
1120 GstV4l2MemoryGroup * group)
1122 const GstV4l2Object *obj = pool->obj;
1123 GstClockTime timestamp;
1126 index = group->buffer.index;
1128 if (pool->buffers[index] != NULL)
1129 goto already_queued;
1131 GST_LOG_OBJECT (pool, "queuing buffer %i", index);
1133 if (V4L2_TYPE_IS_OUTPUT (obj->type)) {
1134 enum v4l2_field field;
1136 /* Except when field is set to alternate, buffer field is the same as
1137 * the one defined in format */
1138 if (V4L2_TYPE_IS_MULTIPLANAR (obj->type))
1139 field = obj->format.fmt.pix_mp.field;
1141 field = obj->format.fmt.pix.field;
1143 /* NB: At this moment, we can't have alternate mode because it not handled
1145 if (field == V4L2_FIELD_ALTERNATE) {
1146 if (GST_BUFFER_FLAG_IS_SET (buf, GST_VIDEO_FRAME_FLAG_TFF))
1147 field = V4L2_FIELD_TOP;
1149 field = V4L2_FIELD_BOTTOM;
1152 group->buffer.field = field;
1155 if (GST_BUFFER_TIMESTAMP_IS_VALID (buf)) {
1156 timestamp = GST_BUFFER_TIMESTAMP (buf);
1157 GST_TIME_TO_TIMEVAL (timestamp, group->buffer.timestamp);
1160 GST_OBJECT_LOCK (pool);
1161 g_atomic_int_inc (&pool->num_queued);
1162 pool->buffers[index] = buf;
1164 if (!gst_v4l2_allocator_qbuf (pool->vallocator, group))
1167 pool->empty = FALSE;
1168 g_cond_signal (&pool->empty_cond);
1169 GST_OBJECT_UNLOCK (pool);
1175 GST_ERROR_OBJECT (pool, "the buffer %i was already queued", index);
1176 return GST_FLOW_ERROR;
1180 GST_ERROR_OBJECT (pool, "could not queue a buffer %i", index);
1181 /* Mark broken buffer to the allocator */
1182 GST_BUFFER_FLAG_SET (buf, GST_BUFFER_FLAG_TAG_MEMORY);
1183 g_atomic_int_add (&pool->num_queued, -1);
1184 pool->buffers[index] = NULL;
1185 GST_OBJECT_UNLOCK (pool);
1186 return GST_FLOW_ERROR;
1190 static GstFlowReturn
1191 gst_v4l2_buffer_pool_dqbuf (GstV4l2BufferPool * pool, GstBuffer ** buffer,
1195 GstBuffer *outbuf = NULL;
1196 GstV4l2Object *obj = pool->obj;
1197 GstClockTime timestamp;
1198 GstV4l2MemoryGroup *group;
1199 GstVideoMeta *vmeta;
1203 if ((res = gst_v4l2_buffer_pool_poll (pool, wait)) < GST_FLOW_OK)
1206 if (res == GST_FLOW_CUSTOM_SUCCESS) {
1207 GST_LOG_OBJECT (pool, "nothing to dequeue");
1211 GST_LOG_OBJECT (pool, "dequeueing a buffer");
1213 res = gst_v4l2_allocator_dqbuf (pool->vallocator, &group);
1214 if (res == GST_FLOW_EOS)
1216 if (res != GST_FLOW_OK)
1219 /* get our GstBuffer with that index from the pool, if the buffer was
1220 * outstanding we have a serious problem.
1222 outbuf = pool->buffers[group->buffer.index];
1226 /* mark the buffer outstanding */
1227 pool->buffers[group->buffer.index] = NULL;
1228 if (g_atomic_int_dec_and_test (&pool->num_queued)) {
1229 GST_OBJECT_LOCK (pool);
1231 GST_OBJECT_UNLOCK (pool);
1234 timestamp = GST_TIMEVAL_TO_TIME (group->buffer.timestamp);
1237 vmeta = gst_buffer_get_video_meta (outbuf);
1238 for (i = 0; i < group->n_mem; i++) {
1239 GST_LOG_OBJECT (pool,
1240 "dequeued buffer %p seq:%d (ix=%d), mem %p used %d, plane=%d, flags %08x, ts %"
1241 GST_TIME_FORMAT ", pool-queued=%d, buffer=%p", outbuf,
1242 group->buffer.sequence, group->buffer.index, group->mem[i],
1243 group->planes[i].bytesused, i, group->buffer.flags,
1244 GST_TIME_ARGS (timestamp), pool->num_queued, outbuf);
1247 vmeta->offset[i] = size;
1248 size += gst_memory_get_sizes (group->mem[i], NULL, NULL);
1252 /* Ignore timestamp and field for OUTPUT device */
1253 if (V4L2_TYPE_IS_OUTPUT (obj->type))
1256 /* Check for driver bug in reporting feild */
1257 if (group->buffer.field == V4L2_FIELD_ANY) {
1258 /* Only warn once to avoid the spamming */
1259 #ifndef GST_DISABLE_GST_DEBUG
1260 if (!pool->has_warned_on_buggy_field) {
1261 pool->has_warned_on_buggy_field = TRUE;
1262 GST_WARNING_OBJECT (pool,
1263 "Driver should never set v4l2_buffer.field to ANY");
1267 /* Use the value from the format (works for UVC bug) */
1268 group->buffer.field = obj->format.fmt.pix.field;
1270 /* If driver also has buggy S_FMT, assume progressive */
1271 if (group->buffer.field == V4L2_FIELD_ANY) {
1272 #ifndef GST_DISABLE_GST_DEBUG
1273 if (!pool->has_warned_on_buggy_field) {
1274 pool->has_warned_on_buggy_field = TRUE;
1275 GST_WARNING_OBJECT (pool,
1276 "Driver should never set v4l2_format.pix.field to ANY");
1280 group->buffer.field = V4L2_FIELD_NONE;
1284 /* set top/bottom field first if v4l2_buffer has the information */
1285 switch (group->buffer.field) {
1286 case V4L2_FIELD_NONE:
1287 GST_BUFFER_FLAG_UNSET (outbuf, GST_VIDEO_BUFFER_FLAG_INTERLACED);
1288 GST_BUFFER_FLAG_UNSET (outbuf, GST_VIDEO_BUFFER_FLAG_TFF);
1290 case V4L2_FIELD_INTERLACED_TB:
1291 GST_BUFFER_FLAG_SET (outbuf, GST_VIDEO_BUFFER_FLAG_INTERLACED);
1292 GST_BUFFER_FLAG_SET (outbuf, GST_VIDEO_BUFFER_FLAG_TFF);
1294 case V4L2_FIELD_INTERLACED_BT:
1295 GST_BUFFER_FLAG_SET (outbuf, GST_VIDEO_BUFFER_FLAG_INTERLACED);
1296 GST_BUFFER_FLAG_UNSET (outbuf, GST_VIDEO_BUFFER_FLAG_TFF);
1298 case V4L2_FIELD_INTERLACED:
1299 GST_BUFFER_FLAG_SET (outbuf, GST_VIDEO_BUFFER_FLAG_INTERLACED);
1300 if (obj->tv_norm == V4L2_STD_NTSC_M ||
1301 obj->tv_norm == V4L2_STD_NTSC_M_JP ||
1302 obj->tv_norm == V4L2_STD_NTSC_M_KR) {
1303 GST_BUFFER_FLAG_UNSET (outbuf, GST_VIDEO_BUFFER_FLAG_TFF);
1305 GST_BUFFER_FLAG_SET (outbuf, GST_VIDEO_BUFFER_FLAG_TFF);
1309 GST_BUFFER_FLAG_UNSET (outbuf, GST_VIDEO_BUFFER_FLAG_INTERLACED);
1310 GST_BUFFER_FLAG_UNSET (outbuf, GST_VIDEO_BUFFER_FLAG_TFF);
1311 GST_FIXME_OBJECT (pool,
1312 "Unhandled enum v4l2_field %d - treating as progressive",
1313 group->buffer.field);
1317 if (GST_VIDEO_INFO_FORMAT (&obj->info) == GST_VIDEO_FORMAT_ENCODED) {
1318 if ((group->buffer.flags & V4L2_BUF_FLAG_KEYFRAME) ||
1319 GST_V4L2_PIXELFORMAT (obj) == V4L2_PIX_FMT_MJPEG ||
1320 GST_V4L2_PIXELFORMAT (obj) == V4L2_PIX_FMT_JPEG ||
1321 GST_V4L2_PIXELFORMAT (obj) == V4L2_PIX_FMT_PJPG)
1322 GST_BUFFER_FLAG_UNSET (outbuf, GST_BUFFER_FLAG_DELTA_UNIT);
1324 GST_BUFFER_FLAG_SET (outbuf, GST_BUFFER_FLAG_DELTA_UNIT);
1327 if (group->buffer.flags & V4L2_BUF_FLAG_ERROR)
1328 GST_BUFFER_FLAG_SET (outbuf, GST_BUFFER_FLAG_CORRUPTED);
1330 GST_BUFFER_TIMESTAMP (outbuf) = timestamp;
1331 GST_BUFFER_OFFSET (outbuf) = group->buffer.sequence;
1332 GST_BUFFER_OFFSET_END (outbuf) = group->buffer.sequence + 1;
1342 GST_DEBUG_OBJECT (pool, "poll error %s", gst_flow_get_name (res));
1347 return GST_FLOW_EOS;
1351 return GST_FLOW_ERROR;
1355 GST_ERROR_OBJECT (pool, "No free buffer found in the pool at index %d.",
1356 group->buffer.index);
1357 return GST_FLOW_ERROR;
1361 static GstFlowReturn
1362 gst_v4l2_buffer_pool_acquire_buffer (GstBufferPool * bpool, GstBuffer ** buffer,
1363 GstBufferPoolAcquireParams * params)
1366 GstV4l2BufferPool *pool = GST_V4L2_BUFFER_POOL (bpool);
1367 GstBufferPoolClass *pclass = GST_BUFFER_POOL_CLASS (parent_class);
1368 GstV4l2Object *obj = pool->obj;
1370 GST_DEBUG_OBJECT (pool, "acquire");
1372 /* If this is being called to resurrect a lost buffer */
1373 if (params && params->flags & GST_V4L2_BUFFER_POOL_ACQUIRE_FLAG_RESURRECT) {
1374 ret = pclass->acquire_buffer (bpool, buffer, params);
1378 switch (obj->type) {
1379 case V4L2_BUF_TYPE_VIDEO_CAPTURE:
1380 case V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE:
1381 /* capture, This function should return a buffer with new captured data */
1382 switch (obj->mode) {
1383 case GST_V4L2_IO_RW:
1385 /* take empty buffer from the pool */
1386 ret = pclass->acquire_buffer (bpool, buffer, params);
1389 case GST_V4L2_IO_DMABUF:
1390 case GST_V4L2_IO_MMAP:
1391 case GST_V4L2_IO_USERPTR:
1392 case GST_V4L2_IO_DMABUF_IMPORT:
1394 /* just dequeue a buffer, we basically use the queue of v4l2 as the
1395 * storage for our buffers. This function does poll first so we can
1396 * interrupt it fine. */
1397 ret = gst_v4l2_buffer_pool_dqbuf (pool, buffer, TRUE);
1401 ret = GST_FLOW_ERROR;
1402 g_assert_not_reached ();
1408 case V4L2_BUF_TYPE_VIDEO_OUTPUT:
1409 case V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE:
1410 /* playback, This function should return an empty buffer */
1411 switch (obj->mode) {
1412 case GST_V4L2_IO_RW:
1413 /* get an empty buffer */
1414 ret = pclass->acquire_buffer (bpool, buffer, params);
1417 case GST_V4L2_IO_MMAP:
1418 case GST_V4L2_IO_DMABUF:
1419 case GST_V4L2_IO_USERPTR:
1420 case GST_V4L2_IO_DMABUF_IMPORT:
1421 /* get a free unqueued buffer */
1422 ret = pclass->acquire_buffer (bpool, buffer, params);
1426 ret = GST_FLOW_ERROR;
1427 g_assert_not_reached ();
1433 ret = GST_FLOW_ERROR;
1434 g_assert_not_reached ();
1442 gst_v4l2_buffer_pool_release_buffer (GstBufferPool * bpool, GstBuffer * buffer)
1444 GstV4l2BufferPool *pool = GST_V4L2_BUFFER_POOL (bpool);
1445 GstBufferPoolClass *pclass = GST_BUFFER_POOL_CLASS (parent_class);
1446 GstV4l2Object *obj = pool->obj;
1448 GST_DEBUG_OBJECT (pool, "release buffer %p", buffer);
1450 switch (obj->type) {
1451 case V4L2_BUF_TYPE_VIDEO_CAPTURE:
1452 case V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE:
1453 /* capture, put the buffer back in the queue so that we can refill it
1455 switch (obj->mode) {
1456 case GST_V4L2_IO_RW:
1457 /* release back in the pool */
1458 pclass->release_buffer (bpool, buffer);
1461 case GST_V4L2_IO_DMABUF:
1462 case GST_V4L2_IO_MMAP:
1463 case GST_V4L2_IO_USERPTR:
1464 case GST_V4L2_IO_DMABUF_IMPORT:
1466 GstV4l2MemoryGroup *group;
1467 if (gst_v4l2_is_buffer_valid (buffer, &group)) {
1468 GstFlowReturn ret = GST_FLOW_OK;
1470 gst_v4l2_allocator_reset_group (pool->vallocator, group);
1471 /* queue back in the device */
1472 if (pool->other_pool)
1473 ret = gst_v4l2_buffer_pool_prepare_buffer (pool, buffer, NULL);
1474 if (ret != GST_FLOW_OK ||
1475 gst_v4l2_buffer_pool_qbuf (pool, buffer, group) != GST_FLOW_OK)
1476 pclass->release_buffer (bpool, buffer);
1478 /* Simply release invalide/modified buffer, the allocator will
1479 * give it back later */
1480 GST_BUFFER_FLAG_SET (buffer, GST_BUFFER_FLAG_TAG_MEMORY);
1481 pclass->release_buffer (bpool, buffer);
1486 g_assert_not_reached ();
1491 case V4L2_BUF_TYPE_VIDEO_OUTPUT:
1492 case V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE:
1493 switch (obj->mode) {
1494 case GST_V4L2_IO_RW:
1495 /* release back in the pool */
1496 pclass->release_buffer (bpool, buffer);
1499 case GST_V4L2_IO_MMAP:
1500 case GST_V4L2_IO_DMABUF:
1501 case GST_V4L2_IO_USERPTR:
1502 case GST_V4L2_IO_DMABUF_IMPORT:
1504 GstV4l2MemoryGroup *group;
1507 if (!gst_v4l2_is_buffer_valid (buffer, &group)) {
1508 /* Simply release invalide/modified buffer, the allocator will
1509 * give it back later */
1510 GST_BUFFER_FLAG_SET (buffer, GST_BUFFER_FLAG_TAG_MEMORY);
1511 pclass->release_buffer (bpool, buffer);
1515 index = group->buffer.index;
1517 if (pool->buffers[index] == NULL) {
1518 GST_LOG_OBJECT (pool, "buffer %u not queued, putting on free list",
1521 /* Remove qdata, this will unmap any map data in userptr */
1522 gst_mini_object_set_qdata (GST_MINI_OBJECT (buffer),
1523 GST_V4L2_IMPORT_QUARK, NULL, NULL);
1525 /* reset to default size */
1526 gst_v4l2_allocator_reset_group (pool->vallocator, group);
1528 /* playback, put the buffer back in the queue to refill later. */
1529 pclass->release_buffer (bpool, buffer);
1531 /* the buffer is queued in the device but maybe not played yet. We just
1532 * leave it there and not make it available for future calls to acquire
1533 * for now. The buffer will be dequeued and reused later. */
1534 GST_LOG_OBJECT (pool, "buffer %u is queued", index);
1540 g_assert_not_reached ();
1546 g_assert_not_reached ();
1552 gst_v4l2_buffer_pool_dispose (GObject * object)
1554 GstV4l2BufferPool *pool = GST_V4L2_BUFFER_POOL (object);
1556 if (pool->vallocator)
1557 gst_object_unref (pool->vallocator);
1558 pool->vallocator = NULL;
1560 if (pool->allocator)
1561 gst_object_unref (pool->allocator);
1562 pool->allocator = NULL;
1564 if (pool->other_pool)
1565 gst_object_unref (pool->other_pool);
1566 pool->other_pool = NULL;
1568 G_OBJECT_CLASS (parent_class)->dispose (object);
1572 gst_v4l2_buffer_pool_finalize (GObject * object)
1574 GstV4l2BufferPool *pool = GST_V4L2_BUFFER_POOL (object);
1576 if (pool->video_fd >= 0)
1577 pool->obj->close (pool->video_fd);
1579 gst_poll_free (pool->poll);
1581 /* This can't be done in dispose method because we must not set pointer
1582 * to NULL as it is part of the v4l2object and dispose could be called
1584 gst_object_unref (pool->obj->element);
1586 g_cond_clear (&pool->empty_cond);
1588 /* FIXME have we done enough here ? */
1590 G_OBJECT_CLASS (parent_class)->finalize (object);
1594 gst_v4l2_buffer_pool_init (GstV4l2BufferPool * pool)
1596 pool->poll = gst_poll_new (TRUE);
1597 pool->can_poll_device = TRUE;
1598 g_cond_init (&pool->empty_cond);
1600 pool->orphaned = FALSE;
1604 gst_v4l2_buffer_pool_class_init (GstV4l2BufferPoolClass * klass)
1606 GObjectClass *object_class = G_OBJECT_CLASS (klass);
1607 GstBufferPoolClass *bufferpool_class = GST_BUFFER_POOL_CLASS (klass);
1609 object_class->dispose = gst_v4l2_buffer_pool_dispose;
1610 object_class->finalize = gst_v4l2_buffer_pool_finalize;
1612 bufferpool_class->start = gst_v4l2_buffer_pool_start;
1613 bufferpool_class->stop = gst_v4l2_buffer_pool_stop;
1614 bufferpool_class->set_config = gst_v4l2_buffer_pool_set_config;
1615 bufferpool_class->alloc_buffer = gst_v4l2_buffer_pool_alloc_buffer;
1616 bufferpool_class->acquire_buffer = gst_v4l2_buffer_pool_acquire_buffer;
1617 bufferpool_class->release_buffer = gst_v4l2_buffer_pool_release_buffer;
1618 bufferpool_class->flush_start = gst_v4l2_buffer_pool_flush_start;
1619 bufferpool_class->flush_stop = gst_v4l2_buffer_pool_flush_stop;
1621 GST_DEBUG_CATEGORY_INIT (v4l2bufferpool_debug, "v4l2bufferpool", 0,
1622 "V4L2 Buffer Pool");
1623 GST_DEBUG_CATEGORY_GET (CAT_PERFORMANCE, "GST_PERFORMANCE");
1627 * gst_v4l2_buffer_pool_new:
1628 * @obj: the v4l2 object owning the pool
1630 * Construct a new buffer pool.
1632 * Returns: the new pool, use gst_object_unref() to free resources
1635 gst_v4l2_buffer_pool_new (GstV4l2Object * obj, GstCaps * caps)
1637 GstV4l2BufferPool *pool;
1638 GstStructure *config;
1639 gchar *name, *parent_name;
1642 fd = obj->dup (obj->video_fd);
1646 /* setting a significant unique name */
1647 parent_name = gst_object_get_name (GST_OBJECT (obj->element));
1648 name = g_strconcat (parent_name, ":", "pool:",
1649 V4L2_TYPE_IS_OUTPUT (obj->type) ? "sink" : "src", NULL);
1650 g_free (parent_name);
1652 pool = (GstV4l2BufferPool *) g_object_new (GST_TYPE_V4L2_BUFFER_POOL,
1653 "name", name, NULL);
1654 g_object_ref_sink (pool);
1657 gst_poll_fd_init (&pool->pollfd);
1658 pool->pollfd.fd = fd;
1659 gst_poll_add_fd (pool->poll, &pool->pollfd);
1660 if (V4L2_TYPE_IS_OUTPUT (obj->type))
1661 gst_poll_fd_ctl_write (pool->poll, &pool->pollfd, TRUE);
1663 gst_poll_fd_ctl_read (pool->poll, &pool->pollfd, TRUE);
1665 pool->video_fd = fd;
1667 pool->can_poll_device = TRUE;
1669 pool->vallocator = gst_v4l2_allocator_new (GST_OBJECT (pool), obj);
1670 if (pool->vallocator == NULL)
1671 goto allocator_failed;
1673 gst_object_ref (obj->element);
1675 config = gst_buffer_pool_get_config (GST_BUFFER_POOL_CAST (pool));
1676 gst_buffer_pool_config_set_params (config, caps, obj->info.size, 0, 0);
1677 /* This will simply set a default config, but will not configure the pool
1678 * because min and max are not valid */
1679 gst_buffer_pool_set_config (GST_BUFFER_POOL_CAST (pool), config);
1681 return GST_BUFFER_POOL (pool);
1686 GST_ERROR ("failed to dup fd %d (%s)", errno, g_strerror (errno));
1691 GST_ERROR_OBJECT (pool, "Failed to create V4L2 allocator");
1692 gst_object_unref (pool);
1697 static GstFlowReturn
1698 gst_v4l2_do_read (GstV4l2BufferPool * pool, GstBuffer * buf)
1701 GstV4l2Object *obj = pool->obj;
1706 toread = obj->info.size;
1708 GST_LOG_OBJECT (pool, "reading %d bytes into buffer %p", toread, buf);
1710 gst_buffer_map (buf, &map, GST_MAP_WRITE);
1713 if ((res = gst_v4l2_buffer_pool_poll (pool, TRUE)) != GST_FLOW_OK)
1716 amount = obj->read (obj->video_fd, map.data, toread);
1718 if (amount == toread) {
1720 } else if (amount == -1) {
1721 if (errno == EAGAIN || errno == EINTR) {
1726 /* short reads can happen if a signal interrupts the read */
1731 GST_LOG_OBJECT (pool, "read %d bytes", amount);
1732 gst_buffer_unmap (buf, &map);
1733 gst_buffer_resize (buf, 0, amount);
1740 GST_DEBUG ("poll error %s", gst_flow_get_name (res));
1745 GST_ELEMENT_ERROR (obj->element, RESOURCE, READ,
1746 (_("Error reading %d bytes from device '%s'."),
1747 toread, obj->videodev), GST_ERROR_SYSTEM);
1748 res = GST_FLOW_ERROR;
1753 gst_buffer_unmap (buf, &map);
1754 gst_buffer_resize (buf, 0, 0);
1760 * gst_v4l2_buffer_pool_process:
1761 * @bpool: a #GstBufferPool
1762 * @buf: a #GstBuffer, maybe be replaced
1764 * Process @buf in @bpool. For capture devices, this functions fills @buf with
1765 * data from the device. For output devices, this functions send the contents of
1766 * @buf to the device for playback.
1768 * Returns: %GST_FLOW_OK on success.
1771 gst_v4l2_buffer_pool_process (GstV4l2BufferPool * pool, GstBuffer ** buf)
1773 GstFlowReturn ret = GST_FLOW_OK;
1774 GstBufferPool *bpool = GST_BUFFER_POOL_CAST (pool);
1775 GstV4l2Object *obj = pool->obj;
1777 GST_DEBUG_OBJECT (pool, "process buffer %p", buf);
1779 if (GST_BUFFER_POOL_IS_FLUSHING (pool))
1780 return GST_FLOW_FLUSHING;
1782 switch (obj->type) {
1783 case V4L2_BUF_TYPE_VIDEO_CAPTURE:
1784 case V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE:
1786 switch (obj->mode) {
1787 case GST_V4L2_IO_RW:
1788 /* capture into the buffer */
1789 ret = gst_v4l2_do_read (pool, *buf);
1792 case GST_V4L2_IO_MMAP:
1793 case GST_V4L2_IO_DMABUF:
1797 if ((*buf)->pool == bpool) {
1799 gsize size = gst_buffer_get_size (*buf);
1801 /* Legacy M2M devices return empty buffer when drained */
1802 if (size == 0 && GST_V4L2_IS_M2M (obj->device_caps))
1805 if (GST_VIDEO_INFO_FORMAT (&pool->caps_info) !=
1806 GST_VIDEO_FORMAT_ENCODED && size < pool->size)
1807 goto buffer_truncated;
1809 num_queued = g_atomic_int_get (&pool->num_queued);
1810 GST_TRACE_OBJECT (pool, "Only %i buffer left in the capture queue.",
1813 /* If we have no more buffer, and can allocate it time to do so */
1814 if (num_queued == 0) {
1815 if (GST_V4L2_ALLOCATOR_CAN_ALLOCATE (pool->vallocator, MMAP)) {
1816 ret = gst_v4l2_buffer_pool_resurrect_buffer (pool);
1817 if (ret == GST_FLOW_OK)
1822 /* start copying buffers when we are running low on buffers */
1823 if (num_queued < pool->copy_threshold) {
1826 if (GST_V4L2_ALLOCATOR_CAN_ALLOCATE (pool->vallocator, MMAP)) {
1827 ret = gst_v4l2_buffer_pool_resurrect_buffer (pool);
1828 if (ret == GST_FLOW_OK)
1832 /* copy the buffer */
1833 copy = gst_buffer_copy_region (*buf,
1834 GST_BUFFER_COPY_ALL | GST_BUFFER_COPY_DEEP, 0, -1);
1835 GST_LOG_OBJECT (pool, "copy buffer %p->%p", *buf, copy);
1837 /* and requeue so that we can continue capturing */
1838 gst_buffer_unref (*buf);
1843 /* nothing, data was inside the buffer when we did _acquire() */
1847 /* buffer not from our pool, grab a frame and copy it into the target */
1848 if ((ret = gst_v4l2_buffer_pool_dqbuf (pool, &tmp, TRUE))
1852 /* An empty buffer on capture indicates the end of stream */
1853 if (gst_buffer_get_size (tmp) == 0) {
1854 gst_v4l2_buffer_pool_release_buffer (bpool, tmp);
1856 /* Legacy M2M devices return empty buffer when drained */
1857 if (GST_V4L2_IS_M2M (obj->device_caps))
1861 ret = gst_v4l2_buffer_pool_copy_buffer (pool, *buf, tmp);
1863 /* an queue the buffer again after the copy */
1864 gst_v4l2_buffer_pool_release_buffer (bpool, tmp);
1866 if (ret != GST_FLOW_OK)
1871 case GST_V4L2_IO_USERPTR:
1873 struct UserPtrData *data;
1876 /* Replace our buffer with downstream allocated buffer */
1877 data = gst_mini_object_steal_qdata (GST_MINI_OBJECT (*buf),
1878 GST_V4L2_IMPORT_QUARK);
1879 tmp = gst_buffer_ref (data->buffer);
1880 _unmap_userptr_frame (data);
1882 /* Now tmp is writable, copy the flags and timestamp */
1883 gst_buffer_copy_into (tmp, *buf,
1884 GST_BUFFER_COPY_FLAGS | GST_BUFFER_COPY_TIMESTAMPS, 0, -1);
1886 gst_buffer_replace (buf, tmp);
1887 gst_buffer_unref (tmp);
1891 case GST_V4L2_IO_DMABUF_IMPORT:
1895 /* Replace our buffer with downstream allocated buffer */
1896 tmp = gst_mini_object_steal_qdata (GST_MINI_OBJECT (*buf),
1897 GST_V4L2_IMPORT_QUARK);
1899 gst_buffer_copy_into (tmp, *buf,
1900 GST_BUFFER_COPY_FLAGS | GST_BUFFER_COPY_TIMESTAMPS, 0, -1);
1902 gst_buffer_replace (buf, tmp);
1903 gst_buffer_unref (tmp);
1908 g_assert_not_reached ();
1913 case V4L2_BUF_TYPE_VIDEO_OUTPUT:
1914 case V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE:
1916 switch (obj->mode) {
1917 case GST_V4L2_IO_RW:
1918 /* FIXME, do write() */
1919 GST_WARNING_OBJECT (pool, "implement write()");
1922 case GST_V4L2_IO_USERPTR:
1923 case GST_V4L2_IO_DMABUF_IMPORT:
1924 case GST_V4L2_IO_DMABUF:
1925 case GST_V4L2_IO_MMAP:
1927 GstBuffer *to_queue = NULL;
1929 GstV4l2MemoryGroup *group;
1932 if ((*buf)->pool != bpool)
1935 if (!gst_v4l2_is_buffer_valid (*buf, &group))
1938 index = group->buffer.index;
1940 GST_LOG_OBJECT (pool, "processing buffer %i from our pool", index);
1942 if (pool->buffers[index] != NULL) {
1943 GST_LOG_OBJECT (pool, "buffer %i already queued, copying", index);
1947 /* we can queue directly */
1948 to_queue = gst_buffer_ref (*buf);
1951 if (to_queue == NULL) {
1952 GstBufferPoolAcquireParams params = { 0 };
1954 GST_LOG_OBJECT (pool, "alloc buffer from our pool");
1956 /* this can return EOS if all buffers are outstanding which would
1957 * be strange because we would expect the upstream element to have
1958 * allocated them and returned to us.. */
1959 params.flags = GST_BUFFER_POOL_ACQUIRE_FLAG_DONTWAIT;
1960 ret = gst_buffer_pool_acquire_buffer (bpool, &to_queue, ¶ms);
1961 if (ret != GST_FLOW_OK)
1962 goto acquire_failed;
1964 ret = gst_v4l2_buffer_pool_prepare_buffer (pool, to_queue, *buf);
1965 if (ret != GST_FLOW_OK) {
1966 gst_buffer_unref (to_queue);
1967 goto prepare_failed;
1970 /* retreive the group */
1971 gst_v4l2_is_buffer_valid (to_queue, &group);
1974 if ((ret = gst_v4l2_buffer_pool_qbuf (pool, to_queue, group))
1978 /* if we are not streaming yet (this is the first buffer, start
1980 if (!gst_v4l2_buffer_pool_streamon (pool)) {
1981 /* don't check return value because qbuf would have failed */
1982 gst_v4l2_is_buffer_valid (to_queue, &group);
1984 /* qbuf has stored to_queue buffer but we are not in
1985 * streaming state, so the flush logic won't be performed.
1986 * To avoid leaks, flush the allocator and restore the queued
1987 * buffer as non-queued */
1988 gst_v4l2_allocator_flush (pool->vallocator);
1990 pool->buffers[group->buffer.index] = NULL;
1992 gst_mini_object_set_qdata (GST_MINI_OBJECT (to_queue),
1993 GST_V4L2_IMPORT_QUARK, NULL, NULL);
1994 gst_buffer_unref (to_queue);
1995 g_atomic_int_add (&pool->num_queued, -1);
1999 /* Remove our ref, we will still hold this buffer in acquire as needed,
2000 * otherwise the pool will think it is outstanding and will refuse to stop. */
2001 gst_buffer_unref (to_queue);
2003 /* release as many buffer as possible */
2004 while (gst_v4l2_buffer_pool_dqbuf (pool, &buffer, FALSE) ==
2006 if (buffer->pool == NULL)
2007 gst_v4l2_buffer_pool_release_buffer (bpool, buffer);
2010 if (g_atomic_int_get (&pool->num_queued) >= pool->min_latency) {
2011 /* all buffers are queued, try to dequeue one and release it back
2012 * into the pool so that _acquire can get to it again. */
2013 ret = gst_v4l2_buffer_pool_dqbuf (pool, &buffer, TRUE);
2014 if (ret == GST_FLOW_OK && buffer->pool == NULL)
2015 /* release the rendered buffer back into the pool. This wakes up any
2016 * thread waiting for a buffer in _acquire(). */
2017 gst_v4l2_buffer_pool_release_buffer (bpool, buffer);
2022 g_assert_not_reached ();
2027 g_assert_not_reached ();
2036 GST_ERROR_OBJECT (pool, "failed to copy buffer");
2041 GST_WARNING_OBJECT (pool,
2042 "Dropping truncated buffer, this is likely a driver bug.");
2043 gst_buffer_unref (*buf);
2045 return GST_V4L2_FLOW_CORRUPTED_BUFFER;
2049 GST_DEBUG_OBJECT (pool, "end of stream reached");
2050 gst_buffer_unref (*buf);
2052 return GST_V4L2_FLOW_LAST_BUFFER;
2056 if (ret == GST_FLOW_FLUSHING)
2057 GST_DEBUG_OBJECT (pool, "flushing");
2059 GST_WARNING_OBJECT (pool, "failed to acquire a buffer: %s",
2060 gst_flow_get_name (ret));
2065 GST_ERROR_OBJECT (pool, "failed to prepare data");
2070 GST_ERROR_OBJECT (pool, "failed to queue buffer");
2075 GST_ERROR_OBJECT (pool, "failed to start streaming");
2076 return GST_FLOW_ERROR;
2081 gst_v4l2_buffer_pool_set_other_pool (GstV4l2BufferPool * pool,
2082 GstBufferPool * other_pool)
2084 g_return_if_fail (!gst_buffer_pool_is_active (GST_BUFFER_POOL (pool)));
2086 if (pool->other_pool)
2087 gst_object_unref (pool->other_pool);
2088 pool->other_pool = gst_object_ref (other_pool);
2092 gst_v4l2_buffer_pool_copy_at_threshold (GstV4l2BufferPool * pool, gboolean copy)
2094 GST_OBJECT_LOCK (pool);
2095 pool->enable_copy_threshold = copy;
2096 GST_OBJECT_UNLOCK (pool);
2100 gst_v4l2_buffer_pool_flush (GstBufferPool * bpool)
2102 GstV4l2BufferPool *pool = GST_V4L2_BUFFER_POOL (bpool);
2103 gboolean ret = TRUE;
2105 gst_v4l2_buffer_pool_streamoff (pool);
2107 if (!V4L2_TYPE_IS_OUTPUT (pool->obj->type))
2108 ret = gst_v4l2_buffer_pool_streamon (pool);