summaryrefslogtreecommitdiff
path: root/stream.h
diff options
context:
space:
mode:
authorLaurent Pinchart <laurent.pinchart@ideasonboard.com>2018-06-09 14:29:41 +0300
committerLaurent Pinchart <laurent.pinchart@ideasonboard.com>2018-06-12 21:19:58 +0300
commit2bb0cfbf8137e02cc32aae3b36f85ef7300e8936 (patch)
tree42899dbeb32459722d27606bd79848a25a8c5e16 /stream.h
parentdf21a9349a256fd2bea1f8701af198b312682d39 (diff)
Split UVC gadget into a library and test application
Split the project into a UVC gadget library and a test application. To avoid rolling out a custom build system, switch to CMake. Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Diffstat (limited to 'stream.h')
-rw-r--r--stream.h113
1 files changed, 0 insertions, 113 deletions
diff --git a/stream.h b/stream.h
deleted file mode 100644
index 13779d3..0000000
--- a/stream.h
+++ /dev/null
@@ -1,113 +0,0 @@
-/*
- * UVC stream handling
- *
- * Copyright (C) 2010 Ideas on board SPRL <laurent.pinchart@ideasonboard.com>
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License along
- * with this program; if not, write to the Free Software Foundation, Inc.,
- */
-
-#ifndef __STREAM_H__
-#define __STREAM_H__
-
-struct events;
-struct uvc_function_config;
-struct uvc_stream;
-struct v4l2_pix_format;
-struct video_source;
-
-/*
- * uvc_stream_new - Create a new UVC stream
- * @uvc_device: Filename of UVC device node
- *
- * Create a new UVC stream to handle the UVC function corresponding to the video
- * device node @uvc_device.
- *
- * Streams allocated with this function can be deleted with uvc_stream_delete().
- *
- * On success, returns a pointer to newly allocated and populated struct uvc_stream.
- * On failure, returns NULL.
- */
-struct uvc_stream *uvc_stream_new(const char *uvc_device);
-
-/*
- * uvc_stream_init_uvc - Initialize a UVC stream
- * @stream: the UVC stream
- * @fc: UVC function configuration
- *
- * Before it can be used, a UVC stream has to be initialized by calling this
- * function with a UVC function configuration @fc. The function configuration
- * contains all the parameters of the UVC function that will be handled by the
- * UVC stream. It can be parsed from the UVC function ConfigFS directory using
- * configfs_parse_uvc_function().
- *
- * uvc_stream_init_uvc() also registers UVC event notifiers for the stream. The
- * caller must have called the uvc_stream_set_event_handler() function first,
- * and ensure that the event handler is immediately usable. If the event loop is
- * already running, all initialization steps required to handle events must be
- * fully performed before calling this function.
- */
-void uvc_stream_init_uvc(struct uvc_stream *stream,
- struct uvc_function_config *fc);
-
-/*
- * uvc_stream_set_event_handler - Set an event handler for a stream
- * @stream: the UVC stream
- * @events: the event handler
- *
- * This function sets the event handler that the stream can use to be notified
- * of file descriptor events.
- */
-void uvc_stream_set_event_handler(struct uvc_stream *stream,
- struct events *events);
-
-void uvc_stream_set_video_source(struct uvc_stream *stream,
- struct video_source *src);
-
-/*
- * uvc_stream_delete - Delete a UVC stream
- * @stream: the UVC stream
- *
- * This functions deletes the @stream created with uvc_stream_new(). Upon return
- * the stream object may be freed, the @stream pointer thus becomes invalid and
- * the stream must not be touched anymore.
- *
- * Every stream allocated with uvc_stream_new() must be deleted when not needed
- * anymore.
- */
-void uvc_stream_delete(struct uvc_stream *stream);
-
-/*
- * uvc_stream_set_format - Set the active video format for the stream
- * @stream: the UVC stream
- * @format: the video stream format
- *
- * This function is called from the UVC protocol handler to configure the video
- * format for the @stream. It must not be called directly by applications.
- *
- * Returns 0 on success, or a negative error code on failure.
- */
-int uvc_stream_set_format(struct uvc_stream *stream,
- const struct v4l2_pix_format *format);
-
-/*
- * uvc_stream_enable - Turn on/off video streaming for the UVC stream
- * @stream: the UVC stream
- * @enable: 0 to stop the stream, 1 to start it
- *
- * This function is called from the UVC protocol handler to start video transfer
- * for the @stream. It must not be called directly by applications.
- */
-void uvc_stream_enable(struct uvc_stream *stream, int enable);
-
-#endif /* __STREAM_H__ */