build-12683127/doc/spa/monitor/device.h

Go to the documentation of this file.

/* Simple Plugin API
 *
 * Copyright © 2018 Wim Taymans
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice (including the next
 * paragraph) shall be included in all copies or substantial portions of the
 * Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 */
 
#ifndef SPA_DEVICE_H
#define SPA_DEVICE_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <spa/utils/defs.h>
#include <spa/utils/hook.h>
#include <spa/utils/dict.h>
#include <spa/pod/event.h>
 
#define SPA_TYPE_INTERFACE_Device       SPA_TYPE_INFO_INTERFACE_BASE "Device"
 
#define SPA_VERSION_DEVICE              0
struct spa_device { struct spa_interface iface; };
 
struct spa_device_info {
#define SPA_VERSION_DEVICE_INFO 0
        uint32_t version;
 
#define SPA_DEVICE_CHANGE_MASK_FLAGS            (1u<<0)
#define SPA_DEVICE_CHANGE_MASK_PROPS            (1u<<1)
#define SPA_DEVICE_CHANGE_MASK_PARAMS           (1u<<2)
        uint64_t change_mask;
        uint64_t flags;
        const struct spa_dict *props;           
        struct spa_param_info *params;          
        uint32_t n_params;                      
};
 
#define SPA_DEVICE_INFO_INIT()  (struct spa_device_info){ SPA_VERSION_DEVICE_INFO, }
 
struct spa_device_object_info {
#define SPA_VERSION_DEVICE_OBJECT_INFO 0
        uint32_t version;
 
        const char *type;                       
        const char *factory_name;               
#define SPA_DEVICE_OBJECT_CHANGE_MASK_FLAGS     (1u<<0)
#define SPA_DEVICE_OBJECT_CHANGE_MASK_PROPS     (1u<<1)
        uint64_t change_mask;
        uint64_t flags;
        const struct spa_dict *props;           
};
 
#define SPA_DEVICE_OBJECT_INFO_INIT()   (struct spa_device_object_info){ SPA_VERSION_DEVICE_OBJECT_INFO, }
 
#define SPA_RESULT_TYPE_DEVICE_PARAMS   1
struct spa_result_device_params {
        uint32_t id;
        uint32_t index;
        uint32_t next;
        struct spa_pod *param;
};
 
#define SPA_DEVICE_EVENT_INFO           0
#define SPA_DEVICE_EVENT_RESULT         1
#define SPA_DEVICE_EVENT_EVENT          2
#define SPA_DEVICE_EVENT_OBJECT_INFO    3
#define SPA_DEVICE_EVENT_NUM            4
 
struct spa_device_events {
#define SPA_VERSION_DEVICE_EVENTS       0
        uint32_t version;
 
        void (*info) (void *data, const struct spa_device_info *info);
 
        void (*result) (void *data, int seq, int res, uint32_t type, const void *result);
 
        void (*event) (void *data, const struct spa_event *event);
 
        void (*object_info) (void *data, uint32_t id,
                const struct spa_device_object_info *info);
};
 
#define SPA_DEVICE_METHOD_ADD_LISTENER  0
#define SPA_DEVICE_METHOD_SYNC          1
#define SPA_DEVICE_METHOD_ENUM_PARAMS   2
#define SPA_DEVICE_METHOD_SET_PARAM     3
#define SPA_DEVICE_METHOD_NUM           4
 
struct spa_device_methods {
        /* the version of the methods. This can be used to expand this
         * structure in the future */
#define SPA_VERSION_DEVICE_METHODS      0
        uint32_t version;
 
        int (*add_listener) (void *object,
                        struct spa_hook *listener,
                        const struct spa_device_events *events,
                        void *data);
        int (*sync) (void *object, int seq);
 
        int (*enum_params) (void *object, int seq,
                            uint32_t id, uint32_t index, uint32_t max,
                            const struct spa_pod *filter);
 
        int (*set_param) (void *object,
                          uint32_t id, uint32_t flags,
                          const struct spa_pod *param);
};
 
#define spa_device_method(o,method,version,...)                         \
({                                                                      \
        int _res = -ENOTSUP;                                            \
        struct spa_device *_o = o;                                      \
        spa_interface_call_res(&_o->iface,                              \
                        struct spa_device_methods, _res,                \
                        method, version, ##__VA_ARGS__);                \
        _res;                                                           \
})
 
#define spa_device_add_listener(d,...)  spa_device_method(d, add_listener, 0, __VA_ARGS__)
#define spa_device_sync(d,...)          spa_device_method(d, sync, 0, __VA_ARGS__)
#define spa_device_enum_params(d,...)   spa_device_method(d, enum_params, 0, __VA_ARGS__)
#define spa_device_set_param(d,...)     spa_device_method(d, set_param, 0, __VA_ARGS__)
 
#define SPA_KEY_DEVICE_ENUM_API         "device.enum.api"       
#define SPA_KEY_DEVICE_API              "device.api"            
#define SPA_KEY_DEVICE_NAME             "device.name"           
#define SPA_KEY_DEVICE_ALIAS            "device.alias"          
#define SPA_KEY_DEVICE_NICK             "device.nick"           
#define SPA_KEY_DEVICE_DESCRIPTION      "device.description"    
#define SPA_KEY_DEVICE_ICON             "device.icon"           
#define SPA_KEY_DEVICE_ICON_NAME        "device.icon-name"      
#define SPA_KEY_DEVICE_PLUGGED_USEC     "device.plugged.usec"   
#define SPA_KEY_DEVICE_BUS_ID           "device.bus-id"         
#define SPA_KEY_DEVICE_BUS_PATH         "device.bus-path"       
#define SPA_KEY_DEVICE_BUS              "device.bus"            
#define SPA_KEY_DEVICE_SUBSYSTEM        "device.subsystem"      
#define SPA_KEY_DEVICE_SYSFS_PATH       "device.sysfs.path"     
#define SPA_KEY_DEVICE_VENDOR_ID        "device.vendor.id"      
#define SPA_KEY_DEVICE_VENDOR_NAME      "device.vendor.name"    
#define SPA_KEY_DEVICE_PRODUCT_ID       "device.product.id"     
#define SPA_KEY_DEVICE_PRODUCT_NAME     "device.product.name"   
#define SPA_KEY_DEVICE_SERIAL           "device.serial"         
#define SPA_KEY_DEVICE_CLASS            "device.class"          
#define SPA_KEY_DEVICE_CAPABILITIES     "device.capabilities"   
#define SPA_KEY_DEVICE_FORM_FACTOR      "device.form-factor"    
#define SPA_KEY_DEVICE_PROFILE          "device.profile "       
#define SPA_KEY_DEVICE_PROFILE_SET      "device.profile-set"    
#define SPA_KEY_DEVICE_STRING           "device.string"         
#ifdef __cplusplus
}  /* extern "C" */
#endif
 
#endif /* SPA_DEVICE_H */