include/dsm_types.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright © 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
 * Copyright © 2014 Ocean Blue Software Ltd
 *
 * 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
 *******************************************************************************/
#ifndef _DSM_TYPES_H
#define _DSM_TYPES_H

#include "dvblocator.h"

#define INVALID_CAROUSEL_ID      0xFFFFFFFF
#define UNKNOWN_CAROUSEL_ID      0xFFFFFFFE

/* Enum used to specify type of behaviour in unload type operation.
 * The unload operation (normally on carousel) can cause any pending
 * object load requests to either:
 *   1. forced to abort, or
 *   2. kept pending until a new carousel is loaded.
 *  This enum is used in relevant API functions.
 */
typedef enum
{
   RST_MODE_FORCE,
   RST_MODE_PENDING,
} E_DsmRstMode;

/* Enum used to report Object Carousel load status */
typedef enum {
    /*0*/ OC_LOAD_UNINITIATED = 0,
    /*1*/ OC_LOAD_IN_PROGRESS,
    /*2*/ OC_LOAD_BOOTED,
    /*3*/ OC_LOAD_COMPLETED,
    /*4*/ OC_LOAD_ABORTED_TIMEOUT,
    /*5*/ OC_LOAD_ABORTED_PATH_ERROR,
    /*6*/ OC_LOAD_ABORTED_ERROR,
    /*7*/ OC_LOAD_ABORTED_UNLOAD,
    /*8*/ OC_LOAD_FILE_GROUP_CHANGE
} E_OCLoadStatus;

/* Carousel SRG User Info for File Groups - available once carousel is loaded
 * - used by Australia/South Africa MHEG profile */
typedef struct {
    U16BIT     owner_id;
    U16BIT     group_id;
    U8BIT      group_priority;
    U8BIT      use_flags;
    U8BIT      receiver_profile;
    U8BIT      group_version;
    U8BIT*     location;
} S_CarouselInfoFileGroup;

typedef U32BIT H_DsmEvent;

typedef struct s_ObjCarousel *H_ObjCarousel;

typedef struct s_DsmControl *H_DsmControl;


#endif /*_DSM_TYPES_H*/