d4dfc65de731a087e3c55b7c5a05491b4e00a68c
[media-ctl.git] / src / mediactl.h
1 /*
2  * Media controller interface library
3  *
4  * Copyright (C) 2010-2011 Ideas on board SPRL
5  *
6  * Contact: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU Lesser General Public License as published
10  * by the Free Software Foundation; either version 2.1 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public License
19  * along with this program. If not, see <http://www.gnu.org/licenses/>.
20  */
21
22 #ifndef __MEDIA_H__
23 #define __MEDIA_H__
24
25 #include <linux/media.h>
26
27 struct media_link {
28         struct media_pad *source;
29         struct media_pad *sink;
30         struct media_link *twin;
31         __u32 flags;
32         __u32 padding[3];
33 };
34
35 struct media_pad {
36         struct media_entity *entity;
37         __u32 index;
38         __u32 flags;
39         __u32 padding[3];
40 };
41
42 struct media_entity {
43         struct media_device *media;
44         struct media_entity_desc info;
45         struct media_pad *pads;
46         struct media_link *links;
47         unsigned int max_links;
48         unsigned int num_links;
49
50         char devname[32];
51         int fd;
52         __u32 padding[6];
53 };
54
55 struct media_device {
56         int fd;
57         struct media_entity *entities;
58         unsigned int entities_count;
59         void (*debug_handler)(void *, ...);
60         void *debug_priv;
61         __u32 padding[6];
62 };
63
64 #define media_dbg(media, ...) \
65         (media)->debug_handler((media)->debug_priv, __VA_ARGS__)
66
67 /**
68  * @brief Set a handler for debug messages.
69  * @param media - device instance.
70  * @param debug_handler - debug message handler
71  * @param debug_priv - first argument to debug message handler
72  *
73  * Set a handler for debug messages that will be called whenever
74  * debugging information is to be printed. The handler expects an
75  * fprintf-like function.
76  */
77 void media_debug_set_handler(
78         struct media_device *media, void (*debug_handler)(void *, ...),
79         void *debug_priv);
80
81 /**
82  * @brief Open a media device with debugging enabled.
83  * @param name - name (including path) of the device node.
84  * @param debug_handler - debug message handler
85  * @param debug_priv - first argument to debug message handler
86  *
87  * Open the media device referenced by @a name and enumerate entities, pads and
88  * links.
89  *
90  * Calling media_open_debug() instead of media_open() is equivalent to
91  * media_open() and media_debug_set_handler() except that debugging is
92  * also enabled during media_open().
93  *
94  * @return A pointer to a newly allocated media_device structure instance on
95  * success and NULL on failure. The returned pointer must be freed with
96  * media_close when the device isn't needed anymore.
97  */
98 struct media_device *media_open_debug(
99         const char *name, void (*debug_handler)(void *, ...),
100         void *debug_priv);
101
102 /**
103  * @brief Open a media device.
104  * @param name - name (including path) of the device node.
105  *
106  * Open the media device referenced by @a name and enumerate entities, pads and
107  * links.
108  *
109  * @return A pointer to a newly allocated media_device structure instance on
110  * success and NULL on failure. The returned pointer must be freed with
111  * media_close when the device isn't needed anymore.
112  */
113 struct media_device *media_open(const char *name);
114
115 /**
116  * @brief Close a media device.
117  * @param media - device instance.
118  *
119  * Close the @a media device instance and free allocated resources. Access to the
120  * device instance is forbidden after this function returns.
121  */
122 void media_close(struct media_device *media);
123
124 /**
125  * @brief Locate the pad at the other end of a link.
126  * @param pad - sink pad at one end of the link.
127  *
128  * Locate the source pad connected to @a pad through an enabled link. As only one
129  * link connected to a sink pad can be enabled at a time, the connected source
130  * pad is guaranteed to be unique.
131  *
132  * @return A pointer to the connected source pad, or NULL if all links connected
133  * to @a pad are disabled. Return NULL also if @a pad is not a sink pad.
134  */
135 struct media_pad *media_entity_remote_source(struct media_pad *pad);
136
137 /**
138  * @brief Get the type of an entity.
139  * @param entity - the entity.
140  *
141  * @return The type of @a entity.
142  */
143 static inline unsigned int media_entity_type(struct media_entity *entity)
144 {
145         return entity->info.type & MEDIA_ENT_TYPE_MASK;
146 }
147
148 /**
149  * @brief Find an entity by its name.
150  * @param media - media device.
151  * @param name - entity name.
152  * @param length - size of @a name.
153  *
154  * Search for an entity with a name equal to @a name.
155  *
156  * @return A pointer to the entity if found, or NULL otherwise.
157  */
158 struct media_entity *media_get_entity_by_name(struct media_device *media,
159         const char *name, size_t length);
160
161 /**
162  * @brief Find an entity by its ID.
163  * @param media - media device.
164  * @param id - entity ID.
165  *
166  * Search for an entity with an ID equal to @a id.
167  *
168  * @return A pointer to the entity if found, or NULL otherwise.
169  */
170 struct media_entity *media_get_entity_by_id(struct media_device *media,
171         __u32 id);
172
173 /**
174  * @brief Configure a link.
175  * @param media - media device.
176  * @param source - source pad at the link origin.
177  * @param sink - sink pad at the link target.
178  * @param flags - configuration flags.
179  *
180  * Locate the link between @a source and @a sink, and configure it by applying
181  * the new @a flags.
182  *
183  * Only the MEDIA_LINK_FLAG_ENABLED flag is writable.
184  *
185  * @return 0 on success, -1 on failure:
186  *         -ENOENT: link not found
187  *         - other error codes returned by MEDIA_IOC_SETUP_LINK
188  */
189 int media_setup_link(struct media_device *media,
190         struct media_pad *source, struct media_pad *sink,
191         __u32 flags);
192
193 /**
194  * @brief Reset all links to the disabled state.
195  * @param media - media device.
196  *
197  * Disable all links in the media device. This function is usually used after
198  * opening a media device to reset all links to a known state.
199  *
200  * @return 0 on success, or a negative error code on failure.
201  */
202 int media_reset_links(struct media_device *media);
203
204 /**
205  * @brief Parse string to a pad on the media device.
206  * @param media - media device.
207  * @param p - input string
208  * @param endp - pointer to string where parsing ended
209  *
210  * Parse NULL terminated string describing a pad and return its struct
211  * media_pad instance.
212  *
213  * @return Pointer to struct media_pad on success, NULL on failure.
214  */
215 struct media_pad *media_parse_pad(struct media_device *media,
216                                   const char *p, char **endp);
217
218 /**
219  * @brief Parse string to a link on the media device.
220  * @param media - media device.
221  * @param p - input string
222  * @param endp - pointer to p where parsing ended
223  *
224  * Parse NULL terminated string p describing a link and return its struct
225  * media_link instance.
226  *
227  * @return Pointer to struct media_link on success, NULL on failure.
228  */
229 struct media_link *media_parse_link(struct media_device *media,
230                                     const char *p, char **endp);
231
232 /**
233  * @brief Parse string to a link on the media device and set it up.
234  * @param media - media device.
235  * @param p - input string
236  *
237  * Parse NULL terminated string p describing a link and its configuration
238  * and configure the link.
239  *
240  * @return 0 on success, or a negative error code on failure.
241  */
242 int media_parse_setup_link(struct media_device *media,
243                            const char *p, char **endp);
244
245 /**
246  * @brief Parse string to link(s) on the media device and set it up.
247  * @param media - media device.
248  * @param p - input string
249  *
250  * Parse NULL terminated string p describing link(s) separated by
251  * commas (,) and configure the link(s).
252  *
253  * @return 0 on success, or a negative error code on failure.
254  */
255 int media_parse_setup_links(struct media_device *media, const char *p);
256
257 #endif