mmal_buffer.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_BUFFER_H
#define MMAL_BUFFER_H

#ifdef __cplusplus
extern "C" {
#endif

/* @{ */

typedef struct {
   uint32_t planes;     
   uint32_t offset[4];  
   uint32_t pitch[4];   
   uint32_t flags;      
   /* TBD stereoscopic support */
} MMAL_BUFFER_HEADER_VIDEO_SPECIFIC_T;

typedef union
{
   MMAL_BUFFER_HEADER_VIDEO_SPECIFIC_T video;

} MMAL_BUFFER_HEADER_TYPE_SPECIFIC_T;

typedef struct MMAL_BUFFER_HEADER_T
{
   struct MMAL_BUFFER_HEADER_T *next; 
   struct MMAL_BUFFER_HEADER_PRIVATE_T *priv; 
   uint32_t cmd;              
   uint8_t  *data;            
   uint32_t alloc_size;       
   uint32_t length;           
   uint32_t offset;           
   uint32_t flags;            
   int64_t  pts;              
   int64_t  dts;              
   MMAL_BUFFER_HEADER_TYPE_SPECIFIC_T *type;

   void *user_data;           
} MMAL_BUFFER_HEADER_T;

/* @{ */
#define MMAL_BUFFER_HEADER_FLAG_EOS                    (1<<0)

#define MMAL_BUFFER_HEADER_FLAG_FRAME_START            (1<<1)

#define MMAL_BUFFER_HEADER_FLAG_FRAME_END              (1<<2)

#define MMAL_BUFFER_HEADER_FLAG_FRAME                  (MMAL_BUFFER_HEADER_FLAG_FRAME_START|MMAL_BUFFER_HEADER_FLAG_FRAME_END)

#define MMAL_BUFFER_HEADER_FLAG_KEYFRAME               (1<<3)

#define MMAL_BUFFER_HEADER_FLAG_DISCONTINUITY          (1<<4)

#define MMAL_BUFFER_HEADER_FLAG_CONFIG                 (1<<5)

#define MMAL_BUFFER_HEADER_FLAG_ENCRYPTED              (1<<6)

#define MMAL_BUFFER_HEADER_FLAG_CODECSIDEINFO          (1<<7)

#define MMAL_BUFFER_HEADER_FLAGS_SNAPSHOT              (1<<8)

#define MMAL_BUFFER_HEADER_FLAG_CORRUPTED              (1<<9)

#define MMAL_BUFFER_HEADER_FLAG_TRANSMISSION_FAILED    (1<<10)

#define MMAL_BUFFER_HEADER_FLAG_DECODEONLY             (1<<11)

#define MMAL_BUFFER_HEADER_FLAG_NAL_END                (1<<12)

#define MMAL_BUFFER_HEADER_FLAG_USER0                  (1<<28)
#define MMAL_BUFFER_HEADER_FLAG_USER1                  (1<<29)
#define MMAL_BUFFER_HEADER_FLAG_USER2                  (1<<30)
#define MMAL_BUFFER_HEADER_FLAG_USER3                  (1<<31)
/* @} */

#define MMAL_BUFFER_HEADER_FLAG_FORMAT_SPECIFIC_START_BIT 16
#define MMAL_BUFFER_HEADER_FLAG_FORMAT_SPECIFIC_START (1<<MMAL_BUFFER_HEADER_FLAG_FORMAT_SPECIFIC_START_BIT)
/* @{ */
#define MMAL_BUFFER_HEADER_VIDEO_FLAG_INTERLACED       (MMAL_BUFFER_HEADER_FLAG_FORMAT_SPECIFIC_START<<0)

#define MMAL_BUFFER_HEADER_VIDEO_FLAG_TOP_FIELD_FIRST  (MMAL_BUFFER_HEADER_FLAG_FORMAT_SPECIFIC_START<<1)

#define MMAL_BUFFER_HEADER_VIDEO_FLAG_DISPLAY_EXTERNAL (MMAL_BUFFER_HEADER_FLAG_FORMAT_SPECIFIC_START<<3)

#define MMAL_BUFFER_HEADER_VIDEO_FLAG_PROTECTED        (MMAL_BUFFER_HEADER_FLAG_FORMAT_SPECIFIC_START<<4)

#define MMAL_BUFFER_HEADER_VIDEO_FLAG_COLUMN_LOG2_SHIFT (MMAL_BUFFER_HEADER_FLAG_FORMAT_SPECIFIC_START_BIT+8)
#define MMAL_BUFFER_HEADER_VIDEO_FLAG_COLUMN_LOG2_MASK (0xF<<MMAL_BUFFER_HEADER_VIDEO_FLAG_COLUMN_LOG2_SHIFT)
/* @} */

void mmal_buffer_header_acquire(MMAL_BUFFER_HEADER_T *header);

void mmal_buffer_header_reset(MMAL_BUFFER_HEADER_T *header);

void mmal_buffer_header_release(MMAL_BUFFER_HEADER_T *header);

void mmal_buffer_header_release_continue(MMAL_BUFFER_HEADER_T *header);

typedef MMAL_BOOL_T (*MMAL_BH_PRE_RELEASE_CB_T)(MMAL_BUFFER_HEADER_T *header, void *userdata);

void mmal_buffer_header_pre_release_cb_set(MMAL_BUFFER_HEADER_T *header, MMAL_BH_PRE_RELEASE_CB_T cb, void *userdata);

MMAL_STATUS_T mmal_buffer_header_replicate(MMAL_BUFFER_HEADER_T *dest, MMAL_BUFFER_HEADER_T *src);

MMAL_STATUS_T mmal_buffer_header_mem_lock(MMAL_BUFFER_HEADER_T *header);

void mmal_buffer_header_mem_unlock(MMAL_BUFFER_HEADER_T *header);

/* @} */

#ifdef __cplusplus
}
#endif

#endif /* MMAL_BUFFER_H */