meta.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_META_H
#define SPA_META_H

#ifdef __cplusplus
extern "C" {
#endif

#include <spa/utils/defs.h>
#include <spa/pod/pod.h>

enum spa_meta_type {
        SPA_META_Invalid,
        SPA_META_Header,        
        SPA_META_VideoCrop,     
        SPA_META_VideoDamage,   
        SPA_META_Bitmap,        
        SPA_META_Cursor,        
        SPA_META_Control,       
        SPA_META_Busy,          
        _SPA_META_LAST,         
};

struct spa_meta {
        uint32_t type;          
        uint32_t size;          
        void *data;             
};

static inline void *spa_meta_first(const struct spa_meta *m) {
        return m->data;
}
#define spa_meta_first spa_meta_first
static inline void *spa_meta_end(const struct spa_meta *m) {
        return SPA_PTROFF(m->data,m->size,void);
}
#define spa_meta_end spa_meta_end
#define spa_meta_check(p,m)     (SPA_PTROFF(p,sizeof(*(p)),void) <= spa_meta_end(m))

struct spa_meta_header {
#define SPA_META_HEADER_FLAG_DISCONT    (1 << 0)        
#define SPA_META_HEADER_FLAG_CORRUPTED  (1 << 1)        
#define SPA_META_HEADER_FLAG_MARKER     (1 << 2)        
#define SPA_META_HEADER_FLAG_HEADER     (1 << 3)        
#define SPA_META_HEADER_FLAG_GAP        (1 << 4)        
#define SPA_META_HEADER_FLAG_DELTA_UNIT (1 << 5)        
        uint32_t flags;                         
        uint32_t offset;                        
        int64_t pts;                            
        int64_t dts_offset;                     
        uint64_t seq;                           
};

struct spa_meta_region {
        struct spa_region region;
};

static inline bool spa_meta_region_is_valid(const struct spa_meta_region *m) {
        return m->region.size.width != 0 && m->region.size.height != 0;
}
#define spa_meta_region_is_valid spa_meta_region_is_valid

#define spa_meta_for_each(pos,meta)                                     \
        for ((pos) = (__typeof(pos))spa_meta_first(meta);                       \
            spa_meta_check(pos, meta);                                  \
            (pos)++)

#define spa_meta_bitmap_is_valid(m)     ((m)->format != 0)

struct spa_meta_bitmap {
        uint32_t format;                
        struct spa_rectangle size;      
        int32_t stride;                 
        uint32_t offset;                
};

#define spa_meta_cursor_is_valid(m)     ((m)->id != 0)

struct spa_meta_cursor {
        uint32_t id;                    
        uint32_t flags;                 
        struct spa_point position;      
        struct spa_point hotspot;       
        uint32_t bitmap_offset;         
};

struct spa_meta_control {
        struct spa_pod_sequence sequence;
};

struct spa_meta_busy {
        uint32_t flags;
        uint32_t count;                 
};

#ifdef __cplusplus
}  /* extern "C" */
#endif

#endif /* SPA_META_H */