ShiAction.h

Go to the documentation of this file.

/*****************************************************************
|
|   Sushi - Action
|
|   $Id: ShiAction.h 7984 2015-03-01 07:11:46Z hwa $
|   Original author:  Gilles Boccon-Gibod
|
|   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 _SHI_ACTION_H_
#define _SHI_ACTION_H_

/*----------------------------------------------------------------------
|   includes
+---------------------------------------------------------------------*/
#include "ShiResults.h"
#include "ShiTypes.h"
#include "ShiList.h"
#include "ShiAttributes.h"
#include "ShiLicenseInfo.h"

/*----------------------------------------------------------------------
|   constants
+---------------------------------------------------------------------*/
#define SHI_ACTION_CALLBACK_IS_MANDATORY    0x00000001
#define SHI_ACTION_CALLBACK_IS_RESET        0x00010000

#define SHI_ACTION_OBLIGATION_IS_MANDATORY  0x00000001

#define SHI_ACTION_RESULT_MUST_ACCEPT       0x00000001
#define SHI_ACTION_RESULT_HAS_OBLIGATIONS   0x00000002
#define SHI_ACTION_RESULT_HAS_CALLBACKS     0x00000004

#define SHI_ACTION_PLAY "Play"

#define SHI_ACTION_EXPORT "Export"

/*
 * Predefined export modes.
 */
#define SHI_ACTION_EXPORT_MODE_DONT_KNOW  "DontKnow"
#define SHI_ACTION_EXPORT_MODE_RENDER     "Render"
#define SHI_ACTION_EXPORT_MODE_COPY       "Copy"
#define SHI_ACTION_EXPORT_MODE_MOVE       "Move"

/*
 * Predefined export target systems ID used when exporting to
 * audio CD (also known as CD Burning).
 */
#define SHI_ACTION_EXPORT_SYSTEM_AUDIO_CD "CleartextPcmAudio"

#define SHI_DATA_POINTER_TYPE_ID_CALLBACK   1
#define SHI_DATA_POINTER_TYPE_ID_OBLIGATION 2

/*----------------------------------------------------------------------
|   types
+---------------------------------------------------------------------*/
typedef struct {
    const char* target_system; 
    const char* export_mode;   
} SHI_ActionExportParameters;

typedef enum {
    SHI_ACTION_OBLIGATION_TYPE_PLAYBACK_METERING,

    SHI_ACTION_OBLIGATION_TYPE_MEDIA_ZONES,

    SHI_ACTION_OBLIGATION_TYPE_GENERIC
} SHI_ActionObligationType;

typedef struct {
    SHI_ActionObligationType type;

    SHI_Flags                flags;

    const void*              parameters;
} SHI_ActionObligation;

typedef enum {
    SHI_MEDIA_ZONE_TYPE_NOSKIP   = 0,
    SHI_MEDIA_ZONE_TYPE_MAGNETIC = 1,
    SHI_MEDIA_ZONE_TYPE_STICKY   = 2
} SHI_MediaZoneType;

#define SHI_MEDIA_ZONE_FLAG_METER          1
#define SHI_MEDIA_ZONE_FLAG_INCLUDE_SPLICE 2

typedef struct {
    SHI_UInt32        id;

    SHI_MediaZoneType type;

    SHI_Flags         flags; 
} SHI_MediaZoneInfo;

typedef struct {
    SHI_Cardinal       zone_count;
    SHI_MediaZoneInfo* zones;
} SHI_ActionMediaZonesObligation;

typedef struct {
    SHI_Attribute* attribute;
} SHI_ActionGenericObligation;

typedef enum {
    SHI_ACTION_METERING_START,
    
    SHI_ACTION_METERING_STOP,
    
    SHI_ACTION_METERING_ZONE_COMPLETED
} SHI_ActionMeteringEventType;

typedef struct {
    const char* metering_tag;
} SHI_ActionOnZoneCompletedMeteringParameters;

typedef enum {
    SHI_ACTION_CALLBACK_TYPE_ON_TIME,

    SHI_ACTION_CALLBACK_TYPE_ON_TIME_ELAPSED,

    SHI_ACTION_CALLBACK_TYPE_ON_PLAY,

    SHI_ACTION_CALLBACK_TYPE_ON_STOP,

    SHI_ACTION_CALLBACK_TYPE_ON_SEEK,

    SHI_ACTION_CALLBACK_TYPE_ON_TIMECODE,

    SHI_ACTION_CALLBACK_TYPE_ON_ZONE_COMPLETED
} SHI_ActionCallbackType;

typedef struct {
    SHI_UInt32             handle;

    SHI_Flags              flags;

    SHI_ActionCallbackType type;

    const void*            parameters;
} SHI_ActionCallback;

typedef struct {
    SHI_DateTime time;
} SHI_ActionOnTimeCallbackParameters;

typedef struct {
    SHI_UInt32 seconds; 
} SHI_ActionOnTimeElapsedCallbackParameters;

typedef struct {
    SHI_UInt32 timecode;
} SHI_ActionOnTimecodeCallbackParameters;

typedef struct {
    SHI_UInt32 zone_id;
} SHI_ActionOnZoneCompletedCallbackParameters;

typedef struct {
    SHI_UInt32 offset;
    SHI_UInt32 range;
} SHI_ActionOnSeekCallbackArguments;

typedef struct {
    SHI_Boolean is_granted;   
    SHI_Boolean is_permanent; 
    SHI_Flags   flags;        
} SHI_ActionResultInfo;

/*----------------------------------------------------------------------
|   interfaces
+---------------------------------------------------------------------*/
#if defined(__cplusplus)
extern "C" {
#endif

typedef struct SHI_ActionResult SHI_ActionResult;

SHI_PUBLIC_API
void*
SHI_ActionResult_GetInterface(SHI_ActionResult* self, SHI_InterfaceId iface_id);

SHI_PUBLIC_API
SHI_Result
SHI_ActionResult_Release(SHI_ActionResult* self);

SHI_PUBLIC_API
SHI_Result
SHI_ActionResult_GetObligations(SHI_ActionResult* self, SHI_List** obligations);

SHI_PUBLIC_API
SHI_Result 
SHI_ActionResult_GetCallbacks(SHI_ActionResult* self, SHI_List** callbacks);

SHI_PUBLIC_API
SHI_Result 
SHI_ActionResult_GetInfo(SHI_ActionResult* self, SHI_ActionResultInfo* info);

SHI_PUBLIC_API
SHI_Result 
SHI_ActionResult_GetDetails(SHI_ActionResult* self, SHI_Attribute** details);

SHI_PUBLIC_API
SHI_Result
SHI_ActionResult_Accept(SHI_ActionResult* self);

SHI_PUBLIC_API
SHI_Boolean
SHI_ActionResult_IsFromMs3(SHI_ActionResult* self);

typedef struct SHI_Action SHI_Action;

SHI_PUBLIC_API
void*
SHI_Action_GetInterface(SHI_Action* self, SHI_InterfaceId iface_id);

SHI_PUBLIC_API
SHI_Result
SHI_Action_Destroy(SHI_Action* self);

SHI_PUBLIC_API
SHI_Result 
SHI_Action_Describe(SHI_Action* self, SHI_LicenseInfo** description);

SHI_PUBLIC_API
SHI_Result
SHI_Action_Check(SHI_Action* self, SHI_ActionResult** result);

SHI_PUBLIC_API
SHI_Result
SHI_Action_Perform(SHI_Action* self, SHI_ActionResult** result);

SHI_PUBLIC_API
SHI_Result 
SHI_Action_Callback(SHI_Action*        self, 
                    SHI_UInt32         callback_handle,
                    const void*        arguments,
                    SHI_ActionResult** result);

SHI_PUBLIC_API
SHI_Result 
SHI_Action_LogMeteringEvent(SHI_Action*                 self,
                            SHI_ActionMeteringEventType type,
                            const void*                 parameters);

#if defined(__cplusplus)
}
#endif

#endif /* _SHI_ACTION_H_ */