introspect.h

Go to the documentation of this file.

/* PipeWire
 *
 * Copyright © 2019 Collabora Ltd.
 *   @author George Kiagiadakis <george.kiagiadakis@collabora.com>
 *
 * 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 PIPEWIRE_EXT_SESSION_MANAGER_INTROSPECT_H
#define PIPEWIRE_EXT_SESSION_MANAGER_INTROSPECT_H
 
#include <spa/utils/defs.h>
#include <spa/utils/dict.h>
#include <spa/param/param.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
enum pw_endpoint_link_state {
        PW_ENDPOINT_LINK_STATE_ERROR = -1,
        PW_ENDPOINT_LINK_STATE_PREPARING,
        PW_ENDPOINT_LINK_STATE_INACTIVE,
        PW_ENDPOINT_LINK_STATE_ACTIVE,
};
 
struct pw_session_info {
#define PW_VERSION_SESSION_INFO                 0
        uint32_t version;                       
        uint32_t id;                            
#define PW_SESSION_CHANGE_MASK_PROPS            (1 << 0)
#define PW_SESSION_CHANGE_MASK_PARAMS           (1 << 1)
#define PW_SESSION_CHANGE_MASK_ALL              ((1 << 2)-1)
        uint64_t change_mask;                   
        struct spa_dict *props;                 
        struct spa_param_info *params;          
        uint32_t n_params;                      
};
 
struct pw_endpoint_info {
#define PW_VERSION_ENDPOINT_INFO                0
        uint32_t version;                       
        uint32_t id;                            
        char *name;                             
        char *media_class;                      
        enum pw_direction direction;            
#define PW_ENDPOINT_FLAG_PROVIDES_SESSION       (1 << 0)
        uint32_t flags;                         
#define PW_ENDPOINT_CHANGE_MASK_STREAMS         (1 << 0)
#define PW_ENDPOINT_CHANGE_MASK_SESSION         (1 << 1)
#define PW_ENDPOINT_CHANGE_MASK_PROPS           (1 << 2)
#define PW_ENDPOINT_CHANGE_MASK_PARAMS          (1 << 3)
#define PW_ENDPOINT_CHANGE_MASK_ALL             ((1 << 4)-1)
        uint64_t change_mask;                   
        uint32_t n_streams;                     
        uint32_t session_id;                    
        struct spa_dict *props;                 
        struct spa_param_info *params;          
        uint32_t n_params;                      
};
 
struct pw_endpoint_stream_info {
#define PW_VERSION_ENDPOINT_STREAM_INFO         0
        uint32_t version;                       
        uint32_t id;                            
        uint32_t endpoint_id;                   
        char *name;                             
#define PW_ENDPOINT_STREAM_CHANGE_MASK_LINK_PARAMS      (1 << 0)
#define PW_ENDPOINT_STREAM_CHANGE_MASK_PROPS            (1 << 1)
#define PW_ENDPOINT_STREAM_CHANGE_MASK_PARAMS           (1 << 2)
#define PW_ENDPOINT_STREAM_CHANGE_MASK_ALL              ((1 << 3)-1)
        uint64_t change_mask;                   
        struct spa_pod *link_params;            
        struct spa_dict *props;                 
        struct spa_param_info *params;          
        uint32_t n_params;                      
};
 
struct pw_endpoint_link_info {
#define PW_VERSION_ENDPOINT_LINK_INFO           0
        uint32_t version;                       
        uint32_t id;                            
        uint32_t session_id;                    
        uint32_t output_endpoint_id;            
        uint32_t output_stream_id;              
        uint32_t input_endpoint_id;             
        uint32_t input_stream_id;               
#define PW_ENDPOINT_LINK_CHANGE_MASK_STATE      (1 << 0)
#define PW_ENDPOINT_LINK_CHANGE_MASK_PROPS      (1 << 1)
#define PW_ENDPOINT_LINK_CHANGE_MASK_PARAMS     (1 << 2)
#define PW_ENDPOINT_LINK_CHANGE_MASK_ALL        ((1 << 3)-1)
        uint64_t change_mask;                   
        enum pw_endpoint_link_state state;      
        char *error;                            
        struct spa_dict *props;                 
        struct spa_param_info *params;          
        uint32_t n_params;                      
};
 
#ifdef __cplusplus
}  /* extern "C" */
#endif
 
#endif /* PIPEWIRE_EXT_SESSION_MANAGER_INTROSPECT_H */