Ts2Tables.h

Go to the documentation of this file.

/*****************************************************************
|
|   MPEG2 Transport Stream - Tables
|
|   $Id: Ts2Tables.h 354 2018-06-28 00:42:39Z pgirish $
|   Original author:  Julien Boeuf
|
|   This software is provided to you pursuant to your agreement 
|   with Intertrust Technologies Corporation ("Intertrust"). 
|   This software may be used only in accordance with the terms 
|   of the agreement.
|      
|   Copyright (c) 2005-2014 by Intertrust. All rights reserved. 
|
****************************************************************/

#ifndef _TS2_TABLES_H_
#define _TS2_TABLES_H_

/*----------------------------------------------------------------------
|   includes
+---------------------------------------------------------------------*/
#include "Atomix.h"
#include "Ts2Packet.h"
#include "Ts2Utils.h"

/*----------------------------------------------------------------------
|   constants
+---------------------------------------------------------------------*/
#define TS2_PAT_PID     0
#define TS2_CAT_PID     1

#define TS2_PAT_TABLE_ID 0x00
#define TS2_CAT_TABLE_ID 0x01
#define TS2_PMT_TABLE_ID 0x02

#define TS2_SECTION_CRC_SIZE            4
#define TS2_SECTION_LONG_HEADER_SIZE    8
#define TS2_SECTION_SHORT_HEADER_SIZE   3

/*----------------------------------------------------------------------
|   types
+---------------------------------------------------------------------*/
typedef struct TS2_Table TS2_Table;
typedef struct {
    ATX_UInt8   table_id;
    ATX_UInt8   section_syntax_indicator;
    ATX_UInt8   private_indicator; /* constant in all tables other than Private tables */
    ATX_UInt16  section_length;
    ATX_UInt32  specific; /* data specific to the table type */
    ATX_UInt8   section_number;
    ATX_UInt8   last_section_number;
} TS2_SectionHeader;

typedef struct {
    TS2_SectionHeader header;
    ATX_Byte*         payload; /* to be used in ParseSection */
    ATX_Byte*         buffer;  /* contains the whole section (with header and crc) */
    ATX_Size          bytes_read;
} TS2_Section;

typedef enum {
    TS2_CRC_NONE = 0,
    TS2_CRC_OK,
    TS2_CRC_FAILED
} TS2_Crc_Status;

struct TS2_Table {
    /* public */
    ATX_Boolean    is_complete;
    TS2_Crc_Status crc_status;
    ATX_Result   (*UpdateSectionBuffer)(TS2_Table* self); /* only support 1 section for now */
    
    /* internal */
    ATX_Result (*CheckTableId)(ATX_UInt8 table_id);
    ATX_Result (*ParseSection)(TS2_Table* self);
    void       (*Destruct)(TS2_Table* self);
    TS2_Section section;    
};

typedef struct {
    ATX_UInt16 program_number;
    ATX_UInt16 pid;
} TS2_PAT_Entry;

typedef struct {
    TS2_Table base;
    ATX_List* programs_to_pids;
} TS2_PAT;

typedef struct {
    TS2_Table   base;
    ATX_UInt16  pcr_pid;
    ATX_UInt16  program_info_length;
    ATX_List*   program_info_descs; /* List of TS2_Descriptor */
    ATX_List*   elementary_streams; /* List of TS2_ElementaryStream */
} TS2_PMT;

typedef struct {
    TS2_Table base;
    ATX_List* descriptors;
} TS2_CAT;

typedef struct {
    TS2_Table base;
} TS2_PrivateTable;    

#ifdef __cplusplus
extern "C" {
#endif

/*----------------------------------------------------------------------
|   TS2_Section methods
+---------------------------------------------------------------------*/
ATX_Size 
TS2_Section_GetPayloadSize(TS2_Section* section);
    
ATX_Result
TS2_SectionHeader_Serialize(TS2_SectionHeader* header,
                            ATX_Byte*          buffer);

/*----------------------------------------------------------------------
|   TS2_Table methods
+---------------------------------------------------------------------*/
ATX_Result 
TS2_Table_AddData(TS2_Table*      self,
                  const ATX_Byte* data,
                  ATX_Size        data_size,
                  ATX_Boolean     payload_unit_start);

TS2_EXPORT ATX_Result
TS2_Table_AddPacket(TS2_Table*        self,
                    const TS2_Packet* packet);
    
ATX_Result 
TS2_Table_SerializeToPackets(TS2_Table*       self,
                             ATX_UInt16       pid,
                             ATX_DataBuffer*  packets,
                             ATX_UInt32*      continuity_counter);
                                        
ATX_Result 
TS2_Table_UpdateSectionBuffer(TS2_Table* self);

ATX_Boolean
TS2_Table_IsEqual(TS2_Table* self,
                  TS2_Table* other);

TS2_EXPORT void 
TS2_Table_Destruct(TS2_Table* self);

/*----------------------------------------------------------------------
|   TS2_PAT methods
+---------------------------------------------------------------------*/
TS2_EXPORT ATX_Result 
TS2_PAT_Construct(TS2_PAT* self);

TS2_EXPORT ATX_Result
TS2_PAT_GetFirstPMTPid(const TS2_PAT* self,
                       ATX_UInt16*    pmt_pid);

TS2_EXPORT ATX_Result
TS2_PAT_GetPMTPid(const TS2_PAT* self,
                  ATX_UInt16     program_num,
                  ATX_UInt16*    pmt_pid);

/*----------------------------------------------------------------------
|   TS2_PMT methods
+---------------------------------------------------------------------*/
TS2_EXPORT ATX_Result 
TS2_PMT_Construct(TS2_PMT* self);

ATX_Result 
TS2_PMT_RemoveCADescriptors(TS2_PMT* self);

/*----------------------------------------------------------------------
|   TS2_CAT methods
+---------------------------------------------------------------------*/
TS2_EXPORT ATX_Result 
TS2_CAT_Construct(TS2_CAT* self);

/*----------------------------------------------------------------------
|   helpers
+---------------------------------------------------------------------*/
#define TS2_SectionHeader_GetSize(h)    \
    (h)->section_syntax_indicator?      \
    TS2_SECTION_LONG_HEADER_SIZE:       \
    TS2_SECTION_SHORT_HEADER_SIZE
    
#ifdef __cplusplus
}
#endif

#endif /* _TS2_TABLES_H_ */