Ts2Descriptors.h

Go to the documentation of this file.

/*****************************************************************
|
|   MPEG2 Transport Stream - Descriptors
|
|   $Id: Ts2Descriptors.h 310 2016-06-07 23:26:47Z hwa $
|   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) 2010-2014 by Intertrust. All rights reserved. 
|
****************************************************************/

#ifndef _TS2_DESCRIPTORS_H_
#define _TS2_DESCRIPTORS_H_

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

/*----------------------------------------------------------------------
|   constants
+---------------------------------------------------------------------*/
#define TS2_DESCRIPTOR_HEADER_SIZE           2

#define TS2_VIDEO_STREAM_DESCRIPTOR_TAG      2
#define TS2_AUDIO_STREAM_DESCRIPTOR_TAG      3
#define TS2_REGISTRATION_DESCRIPTOR_TAG      5
#define TS2_CA_DESCRIPTOR_TAG                9
#define TS2_DOVI_VIDEO_STREAM_DESCRIPTOR_TAG 176 /* 0xB0 */

#define TS2_DOVI_FORMAT_IDENTIFIER           0x444F5649

#define TS2_DOVI_FLAG_RPU_PRESENT            0x04
#define TS2_DOVI_FLAG_EL_PRESENT             0x02
#define TS2_DOVI_FLAG_BL_PRESENT             0x01

#define TS2_DOVI_RPU_PRESENT(flag) ((flag & TS2_DOVI_FLAG_RPU_PRESENT) > 0)
#define TS2_DOVI_EL_PRESENT(flag)  ((flag & TS2_DOVI_FLAG_EL_PRESENT) > 0)
#define TS2_DOVI_BL_PRESENT(flag)  ((flag & TS2_DOVI_FLAG_BL_PRESENT) > 0)

/*----------------------------------------------------------------------
|   types
+---------------------------------------------------------------------*/
typedef struct TS2_Descriptor TS2_Descriptor; /* forward declaration */

struct TS2_Descriptor {
    /* public */
    ATX_UInt8   tag;
    ATX_UInt8   length; /* length of the fields */
    ATX_Boolean is_generic;
    
    /* internal */
    void       (*Destroy)(TS2_Descriptor* self);
    ATX_Result (*SerializeFields)(TS2_Descriptor* self,
                                  ATX_Byte*       buffer);
};

typedef struct {
    TS2_Descriptor base;
    ATX_UInt8      flags;
} TS2_AudioStreamDescriptor;

typedef struct {
    TS2_Descriptor base;
    ATX_UInt8      flags;
    /* following are optional, see flags */
    ATX_UInt8      profile_and_level_indication;
    ATX_UInt8      optional_info;
} TS2_VideoStreamDescriptor;

typedef struct {
    TS2_Descriptor base;
    ATX_UInt16     system_id;    /* CA_system_ID 16 bit */
    ATX_UInt16     pid;          /* CA_PID 13 bit */
    ATX_Byte*      private_data; /* size is TS2_CADescriptor_GetPrivateDataSize */
} TS2_CADescriptor;

typedef struct {
    TS2_Descriptor base;
    ATX_UInt32     format_identifier;              /* format id 32 bit */
    ATX_Byte*      additional_identification_info;
} TS2_RegistrationDescriptor;

typedef struct {
    TS2_Descriptor base;
    ATX_Byte       version_major;  /* version major 8 bit */
    ATX_Byte       version_minor;  /* version minor 8 bit */
    ATX_Byte       profile;        /* profile 7 bit */
    ATX_Byte       level;          /* level 6 bit */
    ATX_UInt8      flags;
    ATX_UInt16     dependency_pid; /* if (!bl_present_flag) */
} TS2_DoviVideoStreamDescriptor;

typedef struct {
    TS2_Descriptor base;
    ATX_Byte*      data; /* size is TS2_GenericDescriptor_GetDataSize */
} TS2_GenericDescriptor;
    

typedef enum {
    AS_GENERIC = -1,
    PMT_DESCRIPTOR,
    CAT_DESCRIPTOR,
    PMT_ES_DESCRIPTOR,
    CA_DESC_PRIVATE_DESCRIPTOR,
    KSM_ACCESS_CRITERIA_DESCRIPTOR
} TS2_DescriptorType;

/*----------------------------------------------------------------------
|   functions
+---------------------------------------------------------------------*/
#ifdef __cplusplus
extern "C" {
#endif

ATX_Result 
TS2_Descriptor_Parse(const ATX_Byte*    data,
                     ATX_Size*          data_size, /* in/out */
                     TS2_DescriptorType desc_type, /* what is the descriptor type / context for parsing */
                     ATX_Boolean        as_generic, /* whether to short-circuit regular parsing and force parsing as generic descriptor */
                     TS2_Descriptor**   desc);
    
ATX_Result
TS2_Descriptor_Serialize(TS2_Descriptor* self,
                         ATX_Byte*       buffer);
    
ATX_Size
TS2_DescriptorList_GetSize(ATX_List* descs);
    
ATX_Result
TS2_DescriptorList_Serialize(ATX_List* descs, ATX_Byte* buffer);

void
TS2_DescriptorList_Destroy(ATX_List* descs);
    
ATX_Result
TS2_CADescriptor_Create(ATX_UInt16         system_id,
                        ATX_UInt16         pid,
                        const ATX_Byte*    private_data,
                        ATX_Size           private_data_size,
                        TS2_CADescriptor** ca_desc);

#ifdef __cplusplus
}
#endif

/*----------------------------------------------------------------------
|   helpers
+---------------------------------------------------------------------*/
#define TS2_Descriptor_Destroy(self) (self)->Destroy(self)

#define TS2_Descriptor_GetSize(self) ((self)->length + 2)

#define TS2_CADescriptor_GetPrivateDataSize(self) \
    (ATX_Size)((self->base.length - 4))

#define TS2_RegistrationDescriptor_GetAdditionalInfoSize(self) \
    (ATX_Size)((self->base.length - 4))

#define TS2_VideoStreamDescriptor_Mpeg1OnlyFlag(vdesc) ((vdesc)->flags & 0x04)

#endif /* _TS2_DESCRIPTORS_H_ */