dsm_client.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright © 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
 * Copyright © 2013 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_CLIENT_H
#define _DSM_CLIENT_H


#include "fs_types.h"
#include "dsm_types.h"


/*---Constant and macro definitions for public use-----------------------------*/

/*
 * Defines for 'loadflags' parameter in DSMCC_ClientLoadObject function
 */
#define LOAD_FLAGS_DEFAULT                      0x0000007F

/* LOAD_FLAGS_CACHE_PRIORITY_MASK is mask bits that specify cache priority
 * With these bits set to zero, the object is loaded from the stream.
 */
#define LOAD_FLAGS_CACHE_PRIORITY_MASK          0x000000FF
#define LOAD_FLAGS_REQUEST_FROM_STREAM          0x00000000

/* When LOAD_FLAGS_REQUEST_FILE_ONLY_BIT is set, the load request will only
 * succeed for objects with OBJECT_TYPE_FILE
 */
#define LOAD_FLAGS_REQUEST_FILE_ONLY_BIT        0x00000100

/* When LOAD_FLAGS_REQUEST_EXISTANCE_BIT is set, content data is NOT provided
 * and only E_FsStatus value is relevant on the return
 */
#define LOAD_FLAGS_REQUEST_EXISTANCE_BIT        0x00000400

/* For stream object type (with events), and LOAD_FLAGS_REQUEST_STREAM_OBJ_XML_BIT set,
 * but without LOAD_FLAGS_REQUEST_EVENT_LIST_BIT being set,
 * the content data is XML format as defined by 'TS 102 809' v1.2.1, section 8.2
 */
#define LOAD_FLAGS_REQUEST_STREAM_OBJ_XML_BIT   0x00002000

/* For stream object type, and LOAD_FLAGS_REQUEST_DEFERRED_SERVICE_BIT set,
 * the content data is S_DvbLocator of the deferred service for that stream
 * Note: ignored if LOAD_FLAGS_REQUEST_EVENT_LIST_BIT is set and stream has events
 */
#define LOAD_FLAGS_REQUEST_DEFERRED_SERVICE_BIT 0x00004000

/* For stream object type (with events), and LOAD_FLAGS_REQUEST_EVENT_LIST_BIT set,
 * the content data is a comma separated list of events on that stream
 */
#define LOAD_FLAGS_REQUEST_EVENT_LIST_BIT       0x00008000

/* LOAD_FLAGS_REQUEST_DIR_FILE_LIST_BIT is depreciated, as this is the default.
 * For a directory object type, the content data is given as a comma separated list
 * of names for each entry in the directory.
 * Note: LOAD_FLAGS_REQUEST_DIRECTORY_LIST_BIT modifies this behaviour
 * and LOAD_FLAGS_REQUEST_SERVICE_CONTEXT_BIT overrides it.
 */
#define LOAD_FLAGS_REQUEST_DIR_FILE_LIST_BIT    0x00000000

/* For a directory object type, LOAD_FLAGS_REQUEST_DIRECTORY_LIST_BIT specifies that
 * each entry in the directory list should start with a byte that gives its type/kind,
 * followed by the name and then a separating comma or null or last entry.
 * For the type/kind byte see values in E_DsmObjectType.
 * The size of this content data is does not include the terminating null byte.
 * Note: ignored if LOAD_FLAGS_REQUEST_SERVICE_CONTEXT_BIT is set!
 */
#define LOAD_FLAGS_REQUEST_DIRECTORY_LIST_BIT   0x00040000

/* For a directory object type, and LOAD_FLAGS_REQUEST_SERVICE_CONTEXT_BIT set,
 * the content data points to service context data for service ID
 * Service ID value must be given in content 'user_data' field.
 */
#define LOAD_FLAGS_REQUEST_SERVICE_CONTEXT_BIT  0x00080000

/*---Enumerations for public use-----------------------------------------------*/

typedef enum
{
   OBJECT_TYPE_UNKNOWN = 0x30,   /* ascii '0' */
   OBJECT_TYPE_FILE,
   OBJECT_TYPE_DIRECTORY,
   OBJECT_TYPE_ROOT_DIR,
   OBJECT_TYPE_STREAM,
   OBJECT_TYPE_STREAM_WITH_EVENTS
} E_DsmObjectType;


/*---Global type defs for public use-------------------------------------------*/

typedef F_FS_CALLBACK F_DSM_CBLOAD;

typedef void (*F_DSM_EVENT)( void *userData, U8BIT *name,
                             U32BIT dataLen, U8BIT *dataPtr );

typedef void (*F_DSM_TYPE)( void *userData, E_DsmObjectType type );

/*---Global Function prototypes for public use---------------------------------*/


E_FsStatus DSMCC_ClientLoadObject( H_DsmControl dsmctrl,
   U8BIT *path, U32BIT flags,
   F_DSM_CBLOAD cb_func, S_CONTENT *pContent );

E_FsStatus DSMCC_ClientObjectType( H_DsmControl dsmctrl, U8BIT *path,
   F_DSM_TYPE cbfunc, void *userData, E_DsmObjectType *pType );

void DSMCC_ClientPreloadHint( H_DsmControl dsmctrl, U8BIT *path );

E_FsStatus DSMCC_ClientEventSubscribeName( H_DsmControl dsmctrl,
   FS_HANDLE streamObject, U8BIT *eventName,
   F_DSM_EVENT cb_func, void *userData,
   H_DsmEvent *pEventHandle );

E_FsStatus DSMCC_ClientEventSubscribeId( H_DsmControl dsmctrl,
   U16BIT associationTag, U16BIT eventId,
   F_DSM_EVENT cb_func, void *userData,
   H_DsmEvent *pEventHandle );

void DSMCC_ClientEventUnsubscribe(H_DsmControl dsmctrl, H_DsmEvent event);

BOOLEAN DSMCC_ClientLoadFileGroups( H_DsmControl dsmctrl, H_ObjCarousel hOC,
   U16BIT *total, S_CarouselInfoFileGroup **pGroups );

void DSMCC_ClientUnloadFileGroups( H_DsmControl dsmctrl, H_ObjCarousel hOC,
   S_CarouselInfoFileGroup *groups );




#endif /* _VGR_DSMCLIENT_H */