mmal_port.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_PORT_H
#define MMAL_PORT_H

#ifdef __cplusplus
extern "C" {
#endif

/* @{ */

#include "mmal_types.h"
#include "mmal_format.h"
#include "mmal_buffer.h"
#include "mmal_parameters.h"

typedef enum
{
   MMAL_PORT_TYPE_UNKNOWN = 0,          
   MMAL_PORT_TYPE_CONTROL,              
   MMAL_PORT_TYPE_INPUT,                
   MMAL_PORT_TYPE_OUTPUT,               
   MMAL_PORT_TYPE_CLOCK,                
   MMAL_PORT_TYPE_INVALID = 0xffffffff  
} MMAL_PORT_TYPE_T;

/* @{ */
#define MMAL_PORT_CAPABILITY_PASSTHROUGH                       0x01

#define MMAL_PORT_CAPABILITY_ALLOCATION                        0x02

#define MMAL_PORT_CAPABILITY_SUPPORTS_EVENT_FORMAT_CHANGE      0x04
/* @} */

typedef struct MMAL_PORT_T
{
   struct MMAL_PORT_PRIVATE_T *priv; 
   const char *name;                 
   MMAL_PORT_TYPE_T type;            
   uint16_t index;                   
   uint16_t index_all;               
   uint32_t is_enabled;              
   MMAL_ES_FORMAT_T *format;         
   uint32_t buffer_num_min;          
   uint32_t buffer_size_min;         
   uint32_t buffer_alignment_min;    
   uint32_t buffer_num_recommended;  
   uint32_t buffer_size_recommended; 
   uint32_t buffer_num;              
   uint32_t buffer_size;             
   struct MMAL_COMPONENT_T *component;    
   struct MMAL_PORT_USERDATA_T *userdata; 
   uint32_t capabilities;            
} MMAL_PORT_T;

MMAL_STATUS_T mmal_port_format_commit(MMAL_PORT_T *port);

typedef void (*MMAL_PORT_BH_CB_T)(MMAL_PORT_T *port, MMAL_BUFFER_HEADER_T *buffer);

MMAL_STATUS_T mmal_port_enable(MMAL_PORT_T *port, MMAL_PORT_BH_CB_T cb);

MMAL_STATUS_T mmal_port_disable(MMAL_PORT_T *port);

MMAL_STATUS_T mmal_port_flush(MMAL_PORT_T *port);

MMAL_STATUS_T mmal_port_parameter_set(MMAL_PORT_T *port,
   const MMAL_PARAMETER_HEADER_T *param);

MMAL_STATUS_T mmal_port_parameter_get(MMAL_PORT_T *port,
   MMAL_PARAMETER_HEADER_T *param);

MMAL_STATUS_T mmal_port_send_buffer(MMAL_PORT_T *port,
   MMAL_BUFFER_HEADER_T *buffer);

MMAL_STATUS_T mmal_port_connect(MMAL_PORT_T *port, MMAL_PORT_T *other_port);

MMAL_STATUS_T mmal_port_disconnect(MMAL_PORT_T *port);

uint8_t *mmal_port_payload_alloc(MMAL_PORT_T *port, uint32_t payload_size);

void mmal_port_payload_free(MMAL_PORT_T *port, uint8_t *payload);

MMAL_STATUS_T mmal_port_event_get(MMAL_PORT_T *port, MMAL_BUFFER_HEADER_T **buffer, uint32_t event);

/* @} */

#ifdef __cplusplus
}
#endif

#endif /* MMAL_PORT_H */