mmal_component_wrapper.h

Go to the documentation of this file.

/*
Copyright (c) 2012, Broadcom Europe Ltd
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
    * Redistributions of source code must retain the above copyright
      notice, this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above copyright
      notice, this list of conditions and the following disclaimer in the
      documentation and/or other materials provided with the distribution.
    * Neither the name of the copyright holder nor the
      names of its contributors may be used to endorse or promote products
      derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

#ifndef MMAL_WRAPPER_H
#define MMAL_WRAPPER_H

#ifdef __cplusplus
extern "C" {
#endif

typedef struct MMAL_WRAPPER_T MMAL_WRAPPER_T;

typedef void (*MMAL_WRAPPER_CALLBACK_T)(MMAL_WRAPPER_T *wrapper);

struct MMAL_WRAPPER_T {

   void *user_data;           
   MMAL_WRAPPER_CALLBACK_T callback; 
   MMAL_COMPONENT_T *component;
   MMAL_STATUS_T status;

   MMAL_PORT_T *control;        
   uint32_t    input_num;       
   MMAL_PORT_T **input;         
   MMAL_POOL_T **input_pool;    
   uint32_t    output_num;      
   MMAL_PORT_T **output;        
   MMAL_POOL_T **output_pool;   
   MMAL_QUEUE_T **output_queue; 
   /* Used for debug / statistics */
   int64_t time_setup;          
   int64_t time_enable;         
   int64_t time_disable;        
};

MMAL_STATUS_T mmal_wrapper_create(MMAL_WRAPPER_T **wrapper, const char *name);

/* @{ */
#define MMAL_WRAPPER_FLAG_WAIT 1

#define MMAL_WRAPPER_FLAG_PAYLOAD_ALLOCATE 2

#define MMAL_WRAPPER_FLAG_PAYLOAD_USE_SHARED_MEMORY 4
/* @} */

MMAL_STATUS_T mmal_wrapper_port_enable(MMAL_PORT_T *port, uint32_t flags);

MMAL_STATUS_T mmal_wrapper_port_disable(MMAL_PORT_T *port);

MMAL_STATUS_T mmal_wrapper_buffer_get_empty(MMAL_PORT_T *port, MMAL_BUFFER_HEADER_T **buffer, uint32_t flags);

MMAL_STATUS_T mmal_wrapper_buffer_get_full(MMAL_PORT_T *port, MMAL_BUFFER_HEADER_T **buffer, uint32_t flags);

MMAL_STATUS_T mmal_wrapper_cancel(MMAL_WRAPPER_T *wrapper);

MMAL_STATUS_T mmal_wrapper_destroy(MMAL_WRAPPER_T *wrapper);

#ifdef __cplusplus
}
#endif

#endif /* MMAL_WRAPPER_H */