mmal_format.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_FORMAT_H
#define MMAL_FORMAT_H

#ifdef __cplusplus
extern "C" {
#endif

/* @{ */

#include "mmal_types.h"
#include "mmal_encodings.h"

typedef enum {
   MMAL_ES_TYPE_UNKNOWN,     
   MMAL_ES_TYPE_CONTROL,     
   MMAL_ES_TYPE_AUDIO,       
   MMAL_ES_TYPE_VIDEO,       
   MMAL_ES_TYPE_SUBPICTURE   
} MMAL_ES_TYPE_T;

typedef struct
{
   uint32_t        width;        
   uint32_t        height;       
   MMAL_RECT_T     crop;         
   MMAL_RATIONAL_T frame_rate;   
   MMAL_RATIONAL_T par;          
   MMAL_FOURCC_T   color_space;  
} MMAL_VIDEO_FORMAT_T;

typedef struct MMAL_AUDIO_FORMAT_T
{
   uint32_t channels;           
   uint32_t sample_rate;        
   uint32_t bits_per_sample;    
   uint32_t block_align;        
} MMAL_AUDIO_FORMAT_T;

typedef struct
{
   uint32_t x_offset;        
   uint32_t y_offset;        
} MMAL_SUBPICTURE_FORMAT_T;

typedef union
{
   MMAL_AUDIO_FORMAT_T      audio;      
   MMAL_VIDEO_FORMAT_T      video;      
   MMAL_SUBPICTURE_FORMAT_T subpicture; 
} MMAL_ES_SPECIFIC_FORMAT_T;

/* @{ */
#define MMAL_ES_FORMAT_FLAG_FRAMED       0x1 
/* @} */

/* @{ */
#define MMAL_ENCODING_UNKNOWN            0
/* @} */

/* @{ */
#define MMAL_ENCODING_VARIANT_DEFAULT    0
/* @} */

typedef struct MMAL_ES_FORMAT_T
{
   MMAL_ES_TYPE_T type;           
   MMAL_FOURCC_T encoding;        
   MMAL_FOURCC_T encoding_variant;
   MMAL_ES_SPECIFIC_FORMAT_T *es; 
   uint32_t bitrate;              
   uint32_t flags;                
   uint32_t extradata_size;       
   uint8_t  *extradata;           
} MMAL_ES_FORMAT_T;

MMAL_ES_FORMAT_T *mmal_format_alloc(void);

void mmal_format_free(MMAL_ES_FORMAT_T *format);

MMAL_STATUS_T mmal_format_extradata_alloc(MMAL_ES_FORMAT_T *format, unsigned int size);

void mmal_format_copy(MMAL_ES_FORMAT_T *format_dest, MMAL_ES_FORMAT_T *format_src);

MMAL_STATUS_T mmal_format_full_copy(MMAL_ES_FORMAT_T *format_dest, MMAL_ES_FORMAT_T *format_src);

/* @{ */
#define MMAL_ES_FORMAT_COMPARE_FLAG_TYPE              0x01 
#define MMAL_ES_FORMAT_COMPARE_FLAG_ENCODING          0x02 
#define MMAL_ES_FORMAT_COMPARE_FLAG_BITRATE           0x04 
#define MMAL_ES_FORMAT_COMPARE_FLAG_FLAGS             0x08 
#define MMAL_ES_FORMAT_COMPARE_FLAG_EXTRADATA         0x10 
#define MMAL_ES_FORMAT_COMPARE_FLAG_VIDEO_RESOLUTION   0x0100 
#define MMAL_ES_FORMAT_COMPARE_FLAG_VIDEO_CROPPING     0x0200 
#define MMAL_ES_FORMAT_COMPARE_FLAG_VIDEO_FRAME_RATE   0x0400 
#define MMAL_ES_FORMAT_COMPARE_FLAG_VIDEO_ASPECT_RATIO 0x0800 
#define MMAL_ES_FORMAT_COMPARE_FLAG_VIDEO_COLOR_SPACE  0x1000 
#define MMAL_ES_FORMAT_COMPARE_FLAG_ES_OTHER  0x10000000 
/* @} */

uint32_t mmal_format_compare(MMAL_ES_FORMAT_T *format_1, MMAL_ES_FORMAT_T *format_2);

/* @} */

#ifdef __cplusplus
}
#endif

#endif /* MMAL_FORMAT_H */