dvbpsi.h

Go to the documentation of this file.

/*****************************************************************************
 * dvbpsi.h
 * Copyright (C) 2001-2012 VideoLAN
 * $Id$
 *
 * Authors: Arnaud de Bossoreille de Ribou <bozo@via.ecp.fr>
 *          Jean-Paul Saman <jpsaman@videolan.org>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 *****************************************************************************/
 
#ifndef _DVBPSI_DVBPSI_H_
#define _DVBPSI_DVBPSI_H_
 
#define DVBPSI_VERSION      2.0.0              
#define DVBPSI_VERSION_INT  ((2<<16)+(0<<8)+0) 
#ifdef __cplusplus
extern "C" {
#endif
 
/*****************************************************************************
 * Helper for GCC version checks borrowed from VLC.
 *****************************************************************************/
#ifdef __GNUC__
# define DVBPSI_GCC_VERSION(maj,min) \
    ((__GNUC__ > (maj)) || (__GNUC__ == (maj) && __GNUC_MINOR__ >= (min)))
#else
# define DVBPSI_GCC_VERSION(maj,min) (0)
#endif
 
/*****************************************************************************
 * dvbpsi_t
 *****************************************************************************/
typedef struct dvbpsi_s dvbpsi_t;
 
enum dvbpsi_msg_level
{
    DVBPSI_MSG_NONE  = -1, 
    DVBPSI_MSG_ERROR =  0, 
    DVBPSI_MSG_WARN  =  1, 
    DVBPSI_MSG_DEBUG =  2, 
};
typedef enum dvbpsi_msg_level dvbpsi_msg_level_t;
 
/*****************************************************************************
 * dvbpsi_message_cb
 *****************************************************************************/
typedef void (* dvbpsi_message_cb)(dvbpsi_t *handle,
                                   const dvbpsi_msg_level_t level,
                                   const char* msg);
 
/*****************************************************************************
 * dvbpsi_decoder_t
 *****************************************************************************/
typedef struct dvbpsi_decoder_s dvbpsi_decoder_t;
 
/* Clever cast borrowed from VLC */
#if DVBPSI_GCC_VERSION(4,0)
# ifndef __cplusplus
#  define DVBPSI_DECODER( x ) \
    __builtin_choose_expr( \
        __builtin_offsetof(__typeof__(*(x)), i_magic), \
        (void)0, \
        (dvbpsi_decoder_t *)(x))
# else
#  define DVBPSI_DECODER( x ) \
    ((dvbpsi_decoder_t *)(x) \
      + 0 * __builtin_offsetof(__typeof__(*(x)), i_magic))
# endif
#else
# define DVBPSI_DECODER(x) ((dvbpsi_decoder_t *)(x))
#endif
 
/*****************************************************************************
 * dvbpsi_t
 *****************************************************************************/
struct dvbpsi_s
{
    dvbpsi_decoder_t             *p_decoder;          
    /* Messages callback */
    dvbpsi_message_cb             pf_message;           
    enum dvbpsi_msg_level         i_msg_level;          
    /* private data pointer for use by caller, not by libdvbpsi itself ! */
    void                         *p_sys;                
};
 
/*****************************************************************************
 * dvbpsi_new
 *****************************************************************************/
dvbpsi_t *dvbpsi_new(dvbpsi_message_cb callback, enum dvbpsi_msg_level level);
 
/*****************************************************************************
 * dvbpsi_delete
 *****************************************************************************/
void dvbpsi_delete(dvbpsi_t *p_dvbpsi);
 
/*****************************************************************************
 * dvbpsi_packet_push
 *****************************************************************************/
bool dvbpsi_packet_push(dvbpsi_t *p_dvbpsi, const uint8_t* p_data);
 
/*****************************************************************************
 * dvbpsi_psi_section_t
 *****************************************************************************/
 
typedef struct dvbpsi_psi_section_s dvbpsi_psi_section_t;
 
/*****************************************************************************
 * dvbpsi_callback_gather_t
 *****************************************************************************/
typedef void (* dvbpsi_callback_gather_t)(dvbpsi_t *p_dvbpsi,  
                            dvbpsi_psi_section_t* p_section);  
/*****************************************************************************
 * dvbpsi_callback_new_t
 *****************************************************************************/
typedef void (*dvbpsi_callback_new_t)(dvbpsi_t *p_dvbpsi,  
                                    uint8_t i_table_id,  
                                    uint16_t i_extension,
                                    void *p_data);       
/*****************************************************************************
 * dvbpsi_callback_del_t
 *****************************************************************************/
typedef void (*dvbpsi_callback_del_t)(dvbpsi_t *p_dvbpsi,   
                                    uint8_t i_table_id,   
                                    uint16_t i_extension);
/*****************************************************************************
 * DVBPSI_DECODER_COMMON
 *****************************************************************************/
#define DVBPSI_DECODER_COMMON                                                     \
                                                                               \
                                                                           \
    uint8_t  i_magic[3];                              \
    bool     b_complete_header;                 \
    bool     b_discontinuity;                           \
    bool     b_current_valid;                      \
    uint8_t  i_continuity_counter;                      \
    uint8_t  prevpacket[188];                         \
    uint8_t  i_last_section_number;           \
    dvbpsi_psi_section_t *p_current_section;               \
    dvbpsi_psi_section_t *p_sections;        \
    dvbpsi_callback_gather_t pf_gather;             \
    int      i_section_max_size;    \
    int      i_need;                                          \
    /* since version 2.0.0  */                                                    \
    uint16_t i_table_id;                                      \
    uint16_t i_extension;                                  \
    /* Subtables creation and deletion Callbacks */                               \
    dvbpsi_callback_new_t pf_new;                        \
    dvbpsi_callback_del_t pf_del;                            \
    void     *p_priv;                                 \
    /* pointer to next decoder in list */                                         \
    dvbpsi_decoder_t *p_next;      
/*****************************************************************************
 * struct dvbpsi_decoder_s
 *****************************************************************************/
struct dvbpsi_decoder_s
{
    DVBPSI_DECODER_COMMON
};
 
/*****************************************************************************
 * dvbpsi_decoder_new
 *****************************************************************************/
void *dvbpsi_decoder_new(dvbpsi_callback_gather_t pf_gather,
                         const int i_section_max_size,
                         const bool b_discontinuity,
                         const size_t psi_size);
 
/*****************************************************************************
 * dvbpsi_decoder_delete
 *****************************************************************************/
void dvbpsi_decoder_delete(dvbpsi_decoder_t *p_decoder);
 
/*****************************************************************************
 * dvbpsi_decoder_reset
 *****************************************************************************/
void dvbpsi_decoder_reset(dvbpsi_decoder_t* p_decoder, const bool b_force);
 
/*****************************************************************************
 * dvbpsi_decoder_psi_sections_completed
 *****************************************************************************/
bool dvbpsi_decoder_psi_sections_completed(dvbpsi_decoder_t* p_decoder);
 
/*****************************************************************************
 * dvbpsi_decoder_psi_section_add
 *****************************************************************************/
bool dvbpsi_decoder_psi_section_add(dvbpsi_decoder_t *p_decoder, dvbpsi_psi_section_t *p_section);
 
/*****************************************************************************
 * dvbpsi_decoder_present
 *****************************************************************************/
__attribute__((deprecated,unused))
bool dvbpsi_decoder_present(dvbpsi_t *p_dvbpsi);
 
#ifdef __cplusplus
};
#endif
 
#else
#error "Multiple inclusions of dvbpsi.h"
#endif