buffer/buffer.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_BUFFER_H
#define SPA_BUFFER_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <spa/utils/defs.h>
#include <spa/buffer/meta.h>
 
enum spa_data_type {
        SPA_DATA_Invalid,
        SPA_DATA_MemPtr,                
        SPA_DATA_MemFd,                 
        SPA_DATA_DmaBuf,                
        SPA_DATA_MemId,                 
        _SPA_DATA_LAST,                 
};
 
struct spa_chunk {
        uint32_t offset;                
        uint32_t size;                  
        int32_t stride;                 
#define SPA_CHUNK_FLAG_NONE             0
#define SPA_CHUNK_FLAG_CORRUPTED        (1u<<0) 
        int32_t flags;                  
};
 
struct spa_data {
        uint32_t type;                  
#define SPA_DATA_FLAG_NONE       0
#define SPA_DATA_FLAG_READABLE  (1u<<0) 
#define SPA_DATA_FLAG_WRITABLE  (1u<<1) 
#define SPA_DATA_FLAG_DYNAMIC   (1u<<2) 
#define SPA_DATA_FLAG_READWRITE (SPA_DATA_FLAG_READABLE|SPA_DATA_FLAG_WRITABLE)
        uint32_t flags;                 
        int64_t fd;                     
        uint32_t mapoffset;             
        uint32_t maxsize;               
        void *data;                     
        struct spa_chunk *chunk;        
};
 
struct spa_buffer {
        uint32_t n_metas;               
        uint32_t n_datas;               
        struct spa_meta *metas;         
        struct spa_data *datas;         
};
 
/* static */ inline struct spa_meta *spa_buffer_find_meta(const struct spa_buffer *b, uint32_t type)
{
        uint32_t i;
 
        for (i = 0; i < b->n_metas; i++)
                if (b->metas[i].type == type)
                        return &b->metas[i];
 
        return NULL;
}
 
/* static */ inline void *spa_buffer_find_meta_data(const struct spa_buffer *b, uint32_t type, size_t size)
{
        struct spa_meta *m;
        if ((m = spa_buffer_find_meta(b, type)) && m->size >= size)
                return m->data;
        return NULL;
}
 
#ifdef __cplusplus
}  /* extern "C" */
#endif
 
#endif /* SPA_BUFFER_H */