mmal_parameters_common.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_PARAMETERS_COMMON_H
#define MMAL_PARAMETERS_COMMON_H

#define MMAL_PARAMETER_GROUP_COMMON            (0<<16)

#define MMAL_PARAMETER_GROUP_CAMERA            (1<<16)

#define MMAL_PARAMETER_GROUP_VIDEO             (2<<16)

#define MMAL_PARAMETER_GROUP_AUDIO             (3<<16)

#define MMAL_PARAMETER_GROUP_CLOCK             (4<<16)

#define MMAL_PARAMETER_GROUP_MIRACAST       (5<<16)


enum {
   MMAL_PARAMETER_UNUSED                  
         = MMAL_PARAMETER_GROUP_COMMON,
   MMAL_PARAMETER_SUPPORTED_ENCODINGS,    
   MMAL_PARAMETER_URI,                    
   MMAL_PARAMETER_CHANGE_EVENT_REQUEST,   
   MMAL_PARAMETER_ZERO_COPY,              
   MMAL_PARAMETER_BUFFER_REQUIREMENTS,    
   MMAL_PARAMETER_STATISTICS,             
   MMAL_PARAMETER_CORE_STATISTICS,        
   MMAL_PARAMETER_MEM_USAGE,              
   MMAL_PARAMETER_BUFFER_FLAG_FILTER,     
   MMAL_PARAMETER_SEEK,                   
   MMAL_PARAMETER_POWERMON_ENABLE,        
   MMAL_PARAMETER_LOGGING,                
   MMAL_PARAMETER_SYSTEM_TIME,            
   MMAL_PARAMETER_NO_IMAGE_PADDING,       
   MMAL_PARAMETER_LOCKSTEP_ENABLE         
};

typedef struct MMAL_PARAMETER_HEADER_T
{
   uint32_t id;      
   uint32_t size;    
} MMAL_PARAMETER_HEADER_T;

typedef struct MMAL_PARAMETER_CHANGE_EVENT_REQUEST_T
{
   MMAL_PARAMETER_HEADER_T hdr;

   uint32_t change_id;  
   MMAL_BOOL_T enable;  
} MMAL_PARAMETER_CHANGE_EVENT_REQUEST_T;

typedef struct MMAL_PARAMETER_BUFFER_REQUIREMENTS_T
{
   MMAL_PARAMETER_HEADER_T hdr;

   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; 
} MMAL_PARAMETER_BUFFER_REQUIREMENTS_T;

typedef struct MMAL_PARAMETER_SEEK_T
{
   MMAL_PARAMETER_HEADER_T hdr;

   int64_t offset;  
   uint32_t flags;  
#define MMAL_PARAM_SEEK_FLAG_PRECISE 0x1 
#define MMAL_PARAM_SEEK_FLAG_FORWARD 0x2 
} MMAL_PARAMETER_SEEK_T;

typedef struct MMAL_PARAMETER_STATISTICS_T
{
   MMAL_PARAMETER_HEADER_T hdr;

   uint32_t buffer_count;           
   uint32_t frame_count;            
   uint32_t frames_skipped;         
   uint32_t frames_discarded;       
   uint32_t eos_seen;               
   uint32_t maximum_frame_bytes;    
   int64_t  total_bytes;            
   uint32_t corrupt_macroblocks;    
} MMAL_PARAMETER_STATISTICS_T;

typedef enum
{
   MMAL_CORE_STATS_RX,
   MMAL_CORE_STATS_TX,
   MMAL_CORE_STATS_MAX = 0x7fffffff /* Force 32 bit size for this enum */
} MMAL_CORE_STATS_DIR;

typedef struct MMAL_PARAMETER_CORE_STATISTICS_T
{
   MMAL_PARAMETER_HEADER_T hdr;
   MMAL_CORE_STATS_DIR dir;
   MMAL_BOOL_T reset;               
   MMAL_CORE_STATISTICS_T stats;    
} MMAL_PARAMETER_CORE_STATISTICS_T;

typedef struct MMAL_PARAMETER_MEM_USAGE_T
{
   MMAL_PARAMETER_HEADER_T hdr;
   uint32_t pool_mem_alloc_size;
} MMAL_PARAMETER_MEM_USAGE_T;

typedef struct MMAL_PARAMETER_LOGGING_T
{
   MMAL_PARAMETER_HEADER_T hdr;
   uint32_t set;     
   uint32_t clear;   
} MMAL_PARAMETER_LOGGING_T;

#endif /* MMAL_PARAMETERS_COMMON_H */