getModuleInfo_include_src.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright © 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
 * Copyright © 2004 Ocean Blue Software Ltd
 * Copyright © 2001 Koninklijke Philips Electronics N.V
 *
 * This file is part of a DTVKit Software Component
 * You are permitted to copy, modify or distribute this file subject to the terms
 * of the DTVKit 1.0 Licence which can be found in licence.txt or at www.dtvkit.org
 * 
 * THIS CODE AND INFORMATION ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
 * EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
 * 
 * If you or your organisation is not a member of DTVKit then you have access
 * to this source code outside of the terms of the licence agreement
 * and you are expected to delete this and any associated files immediately.
 * Further information on DTVKit, membership and terms can be found at www.dtvkit.org
 *******************************************************************************/
/*
-- getpModuleInfo_source - Common Code
--
-- Get module info from module info descriptor in DII message (compatible with
-- contiguous or managed/MemSeq memory)
--
-- Uses/assumes the following vars:
--      valid, mpModuleInfoDescStart, *pModuleInfo
--
-- mpModuleInfoDescStart references ('points' to) first byte of module info
-- descriptor, valid (BOOLEAN) indicates whether module info was valid
--
-- mpModuleInfoDescStart    = const pUInt8/MemSeqRef,
-- pModuleInfo              = pModuleInfo_t
-- valid                    = BOOLEAN
--
-- NB. Only DVB (UK Profile 1) spec. currently implemented
*/

{
    MemPtr  mpModuleInfoDesc;
    U8BIT   tapsCount;
    U8BIT   userInfoLength;
    MemPos  currPos, endPos;
    U8BIT   descriptorTag;
    U8BIT   descriptorLength;
    U8BIT   ui8  = 0;
    U16BIT  ui16 = 0;
    ui8 += 0;   /* -- stop compiler warnings when no checking */

    dsmAssert(( mpModuleInfoDescStart != NULL ));
    dsmAssert(( pModuleInfo != NULL ));


    /* -- Open MemPtr for accessing module descriptor info */
    MEMPTR_OPEN( mpModuleInfoDescStart, mpModuleInfoDesc );

    /* -- Read moduleId */
    READ_UINT16( mpModuleInfoDesc, pModuleInfo->moduleId );

    /* -- Read moduleSize */
    /* -- L0 check because 0 length modules are not useful */
    READ_UINT32_L0CHK( mpModuleInfoDesc, pModuleInfo->moduleSize,
        pModuleInfo->moduleSize != 0,
        dsmDP2(("DATA ERROR: Module size = %u\n", pModuleInfo->moduleSize)),
        goto _return_False );

#ifndef NDEBUG
    /* Initialise debug monitor flag */
    pModuleInfo->blkRcvd = 0;
#endif

    /* -- Read moduleVersion */
    READ_UINT8( mpModuleInfoDesc, pModuleInfo->version );

    /* -- Skip pModuleInfoLength */
    SET_POS_REL( mpModuleInfoDesc, 1 );

    /* -- mpModuleInfoDesc -> BIOP::pModuleInfo */

    /* -- Read moduleTimeOut */
    READ_UINT32( mpModuleInfoDesc, pModuleInfo->profileInfo.moduleTimeout );

    /* -- Read blockTimeOut */
    READ_UINT32( mpModuleInfoDesc, pModuleInfo->profileInfo.blockTimeout );

    /* -- Read minBlockTime */
    READ_UINT32( mpModuleInfoDesc, pModuleInfo->profileInfo.minBlockTime );

    /* -- Read/check tapsCount >= 1 (DVB) */
    /* -- L1 check because this should be correct */
    READ_UINT8_L1CHK( mpModuleInfoDesc, tapsCount, tapsCount >= 1,
        dsmDP2(("DATA ERROR: Module info tapsCount (< 1) = %u\n", ui8)),
        goto _return_False );


    /* -- mpModuleInfoDesc -> start of first BIOP::Tap */

    /* -- Read info from first Tap */
    /* -- Read tapId - TODO: Not required ? */
    READ_UINT16( mpModuleInfoDesc, pModuleInfo->profileInfo.tap.id );

    /* -- tapUse = BIOP_OBJECT_USE (in BIOP::pModuleInfoMessage - DVB/UK DTT) */
    /* -- L0 check because this must be correct */
    READ_UINT16_L0CHK( mpModuleInfoDesc, ui16, ui16 == BIOP_OBJECT_USE,
        dsmDP2(("DATA ERROR: Module info 1st tapUse (!= BIOP_OBJECT_USE) = %u\n", ui16)),
        goto _return_False );

    /* -- Read associationTag */
    READ_UINT16( mpModuleInfoDesc, pModuleInfo->profileInfo.tap.associationTag );

    /* -- selectorLength = 0 (DVB/UK DTT) */
    ADV_UINT8_L2CHK( mpModuleInfoDesc, ui8, ui8 == 0x00,
        dsmDP2(("DATA ERROR: Module info tap selectorLength (!= 0) = %u\n", ui8)),
        goto _return_False );

    /* -- Skip any remaining Taps */
    while (--tapsCount > 0) {

        /* -- Skip tapId, tapUse, associationTag */
        SET_POS_REL( mpModuleInfoDesc, 6 );

        /* -- Read selectorLength */
        READ_UINT8( mpModuleInfoDesc, ui8 );

        /* -- Skip selector field */
        SET_POS_REL( mpModuleInfoDesc, (S32BIT)ui8 );
    }


    /* -- mpModuleInfoDesc -> userInfoLength */

    /* -- Read userInfoLength */
    READ_UINT8( mpModuleInfoDesc, userInfoLength );

    /* -- Initialise module compression info */
    pModuleInfo->profileInfo.compressed   = FALSE;
    pModuleInfo->profileInfo.originalSize = pModuleInfo->moduleSize;

    if (userInfoLength > 0) {

        /* -- Search module descriptor loop for compressed module descriptor */

        /* -- Determine end position of search data */
        GET_POS( mpModuleInfoDesc, currPos );
        endPos = currPos + userInfoLength;

        while (currPos < endPos) {

            /* -- mpModuleInfoDesc -> current module descriptor */

            /* -- Read descriptorTag */
            READ_UINT8( mpModuleInfoDesc, descriptorTag );

            /* -- Read descriptorLength */
            READ_UINT8( mpModuleInfoDesc, descriptorLength );

            switch (descriptorTag )
            {
                case DESCRIPTOR_COMP_MODULE_TAG:
                /* -- compressionMethod LSNibble == 0x8 (DVB/RFC1950)*/
                /* -- L1 check because this should be correct (subsequently
                   -- zlib inflate should also check compression method of
                   -- module data/stream before attempting to decompress) */
                ADV_UINT8_L1CHK( mpModuleInfoDesc, ui8, (ui8 & 0x0f) == 0x08,
                    dsmDP2(("DATA ERROR: Module info compressionMethod (!= 0x08) = %u\n", ui8)),
                    goto _return_False );

                /* -- Indicate module is compressed */
                pModuleInfo->profileInfo.compressed = TRUE;

                /* -- Read originalSize */
                READ_UINT32( mpModuleInfoDesc,
                                    pModuleInfo->profileInfo.originalSize );

                /* -- Found the required info so quit the loop */
                break;

                case DESCRIPTOR_MHP_CACHING_PRIORITY:
                /* TS 101 812, section B.2.2.4.2 Caching priority descriptor */
                READ_UINT32( mpModuleInfoDesc, pModuleInfo->priority );
                READ_UINT32( mpModuleInfoDesc, pModuleInfo->transparency );
                break;

                default:
                dsmDP2(("INFO: Module - Unknown descriptor tag: %x\n", descriptorTag));
                /* -- Skip this module descriptor */
                SET_POS_REL( mpModuleInfoDesc, (S32BIT)descriptorLength );
            }

            /* -- Find next (potential) descriptor start position */
            GET_POS( mpModuleInfoDesc, currPos );
        }
    }

    /* -- If we get here, assume we have recovered the required data */
    valid = TRUE;
    goto _return;

    /* -- NB. Final position of mpModuleInfoDesc ptr is irrelevant */

_return_False:
    valid = FALSE;

_return:
    MEMPTR_CLOSE( mpModuleInfoDesc );
    DEBUG_CHK( valid == TRUE,
        dsmDP1(("ERROR: getpModuleInfo failure (invalid)\n")) );
}


/*----------------------------------------------------------------------------*/