sis.h

Go to the documentation of this file.

/*****************************************************************************
 * sis.h
 * Copyright (c) 2010-2011 VideoLAN
 * $Id$
 *
 * Authors: 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_SIS_H_
#define _DVBPSI_SIS_H_

#ifdef __cplusplus
extern "C" {
#endif

/*****************************************************************************
 * dvbpsi_sis_t
 *****************************************************************************/
typedef struct dvbpsi_sis_s
{
  /* section */
  uint8_t                   i_protocol_version;     
  /* encryption */
  bool                      b_encrypted_packet;     
  uint8_t                   i_encryption_algorithm; 
  uint64_t                  i_pts_adjustment;       
  uint8_t                   cw_index;               
  /* splice command */
  uint16_t                  i_splice_command_length;
  uint8_t                   i_splice_command_type;  
  /* Splice Command:
   * splice_command_type     splice_info_section
   *    0x00                    splice_null()
   *    0x01                    reserved
   *    0x02                    reserved
   *    0x03                    reserved
   *    0x04                    splice_schedule()
   *    0x05                    splice_insert()
   *    0x06                    time_signal()
   *    0x07                    bandwidth_reservation()
   *    0x08 - 0xff             reserved
   */
  void                      *p_splice_command;      
  /* descriptors */
  uint16_t                  i_descriptors_length;   
  dvbpsi_descriptor_t       *p_first_descriptor;     
  /* FIXME: alignment stuffing */
  uint32_t i_ecrc; 
} dvbpsi_sis_t;

/*****************************************************************************
 * Splice Commands
 *****************************************************************************/
typedef struct dvbpsi_sis_cmd_splice_null_s
{
    /* nothing */
} dvbpsi_sis_cmd_splice_null_t;

typedef struct dvbpsi_sis_break_duration_s
{
    bool        b_auto_return;  
    uint64_t    i_duration;     
} dvbpsi_sis_break_duration_t;

typedef struct dvbpsi_sis_component_utc_splice_time_s dvbpsi_sis_component_utc_splice_time_s;
struct dvbpsi_sis_component_utc_splice_time_s
{
    uint8_t     component_tag;      
    uint32_t    i_utc_splice_time;  
    dvbpsi_sis_component_utc_splice_time_s *p_next; 
};

typedef struct dvbpsi_sis_splice_event_s dvbpsi_sis_splice_event_t;
struct dvbpsi_sis_splice_event_s
{
    uint32_t        i_splice_event_id;               
    bool            b_splice_event_cancel_indicator; 
    /* if (!b_splice_event_cancel_indicator) */
    bool            b_out_of_network_indicator; 
    bool            b_program_splice_flag;      
    bool            b_duration_flag;            
    /*      if (b_program_splice_flag) */
    uint32_t        i_utc_splice_time;          
    /*      if (!b_program_splice_flag) */
    uint8_t         i_component_count;          
    dvbpsi_sis_component_utc_splice_time_s  *p_data;
    /*      if (b_duration_flag) */
    dvbpsi_sis_break_duration_t *p_break_duration;     
    /* */

    uint16_t        i_unique_program_id; 
    uint8_t         i_avail_num;         
    uint8_t         i_avails_expected;   
    /* end */

    dvbpsi_sis_splice_event_t *p_next;   
};

typedef struct dvbpsi_sis_cmd_splice_schedule_s
{
    uint8_t                     i_splice_count; 
    dvbpsi_sis_splice_event_t  *p_splice_event; 
} dvbpsi_sis_cmd_splice_schedule_t;

typedef struct dvbpsi_sis_splice_time_s dvbpsi_sis_splice_time_t;
struct dvbpsi_sis_splice_time_s
{
    bool        b_time_specified_flag; 
    /* if (b_time_specified_flag) */
    uint64_t    i_pts_time;        
    /* else reserved */
    /* end */

    dvbpsi_sis_splice_time_t *p_next; 
};

typedef struct dvbpsi_sis_component_splice_time_s dvbpsi_sis_component_splice_time_t;
struct dvbpsi_sis_component_splice_time_s
{
    uint8_t     i_component_tag;    
    /* if (splice_immediate_flag) */
    dvbpsi_sis_splice_time_t *p_splice_time; 
    /* */

    dvbpsi_sis_component_splice_time_t *p_next; 
};

typedef struct dvbpsi_sis_cmd_splice_insert_s
{
    uint32_t        i_splice_event_id;               
    bool            b_splice_event_cancel_indicator; 
    /* if (!b_splice_event_cancel_indicator) */
    bool            b_out_of_network_indicator; 
    bool            b_program_splice_flag;      
    bool            b_duration_flag;            
    bool            b_splice_immediate_flag;    
    /*      if (b_program_splice_flag) && (!b_splice_immediate_flag) */
    dvbpsi_sis_splice_time_t *p_splice_time;           
    /*      if (!b_program_splice_flag) */
    uint8_t         i_component_count;           
    dvbpsi_sis_component_splice_time_t  *p_data; 
    /*      if (b_duration_flag) */
    dvbpsi_sis_break_duration_t *p_break_duration; 
    /* */
    uint16_t        i_unique_program_id;      
    uint8_t         i_avail_num;              
    uint8_t         i_avails_expected;        
    /* end */
} dvbpsi_sis_cmd_splice_insert_t;

typedef struct dvbpsi_sis_cmd_time_signal_s
{
    dvbpsi_sis_splice_time_t *p_splice_time;       
} dvbpsi_sis_cmd_time_signal_t;

typedef struct dvbpsi_sis_cmd_bandwidth_reservation_s
{
    /* nothing */
} dvbpsi_sis_cmd_bandwidth_reservation_t;

/*****************************************************************************
 * dvbpsi_sis_callback
 *****************************************************************************/
typedef void (* dvbpsi_sis_callback)(void* p_cb_data, dvbpsi_sis_t* p_new_sis);

/*****************************************************************************
 * dvbpsi_AttachSIS
 *****************************************************************************/
bool dvbpsi_AttachSIS(dvbpsi_t* p_dvbpsi, uint8_t i_table_id, uint16_t i_extension,
                      dvbpsi_sis_callback pf_callback, void* p_cb_data);

/*****************************************************************************
 * dvbpsi_DetachSIS
 *****************************************************************************/
void dvbpsi_DetachSIS(dvbpsi_t *p_dvbpsi, uint8_t i_table_id, uint16_t i_extension);

/*****************************************************************************
 * dvbpsi_InitSIS/dvbpsi_NewSIS
 *****************************************************************************/
void dvbpsi_InitSIS(dvbpsi_sis_t *p_sis, uint8_t i_protocol_version);

dvbpsi_sis_t* dvbpsi_NewSIS(uint8_t i_protocol_version);

/*****************************************************************************
 * dvbpsi_EmptySIS/dvbpsi_DeleteSIS
 *****************************************************************************/
void dvbpsi_EmptySIS(dvbpsi_sis_t *p_sis);

void dvbpsi_DeleteSIS(dvbpsi_sis_t *p_sis);

/*****************************************************************************
 * dvbpsi_SISAddDescriptor
 *****************************************************************************/
dvbpsi_descriptor_t *dvbpsi_SISAddDescriptor(dvbpsi_sis_t *p_sis,
                                             uint8_t i_tag, uint8_t i_length,
                                             uint8_t *p_data);

/*****************************************************************************
 * dvbpsi_GenSISSections
 *****************************************************************************
 * Generate SIS sections based on the dvbpsi_sis_t structure.
 *****************************************************************************/
dvbpsi_psi_section_t *dvbpsi_GenSISSections(dvbpsi_t *p_dvbpsi, dvbpsi_sis_t * p_sis);

#ifdef __cplusplus
};
#endif

#else
#error "Multiple inclusions of sis.h"
#endif