WsbMediaPlayback.h

Go to the documentation of this file.

/*****************************************************************
|
|   Wasabi - Media Playback API
|
|   $Id: WsbMediaPlayback.h 12185 2015-12-07 06:21:28Z 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) 2008-2014 by Intertrust. All rights reserved. 
|
****************************************************************/
#ifndef _WSB_MEDIA_PLAYBACK_H_
#define _WSB_MEDIA_PLAYBACK_H_

/*----------------------------------------------------------------------
|   includes
+---------------------------------------------------------------------*/
#include "WsbTypes.h"
#include "ShiData.h"

/*----------------------------------------------------------------------
|   prototypes
+---------------------------------------------------------------------*/
typedef struct WSB_Player WSB_Player;

#if defined(__cplusplus)
extern "C" {
#endif

/*----------------------------------------------------------------------
|   constants
+---------------------------------------------------------------------*/
#define WSB_PLAYER_STREAM_INFO_MASK_ALL             0x1FFF

#define WSB_PLAYER_STREAM_INFO_MASK_TYPE            0x0001
#define WSB_PLAYER_STREAM_INFO_MASK_ID              0x0002
#define WSB_PLAYER_STREAM_INFO_MASK_NOMINAL_BITRATE 0x0004
#define WSB_PLAYER_STREAM_INFO_MASK_AVERAGE_BITRATE 0x0008
#define WSB_PLAYER_STREAM_INFO_MASK_INSTANT_BITRATE 0x0010
#define WSB_PLAYER_STREAM_INFO_MASK_SIZE            0x0020
#define WSB_PLAYER_STREAM_INFO_MASK_DURATION        0x0040
#define WSB_PLAYER_STREAM_INFO_MASK_SAMPLE_RATE     0x0080
#define WSB_PLAYER_STREAM_INFO_MASK_CHANNEL_COUNT   0x0100
#define WSB_PLAYER_STREAM_INFO_MASK_WIDTH           0x0200
#define WSB_PLAYER_STREAM_INFO_MASK_HEIGHT          0x0400
#define WSB_PLAYER_STREAM_INFO_MASK_FLAGS           0x0800
#define WSB_PLAYER_STREAM_INFO_MASK_DATA_TYPE       0x1000

#define WSB_PLAYER_INPUT_FLAG_AUDIO_TRACK           0x0001
#define WSB_PLAYER_INPUT_FLAG_VIDEO_TRACK           0x0002
#define WSB_PLAYER_INPUT_FLAG_TRACK_BY_INDEX        0x0004

#define WSB_PLAYER_STREAM_INFO_FLAG_VBR             0x01

#define WSB_PLAYER_STREAM_INFO_FLAG_CONTINUOUS      0x02

typedef enum {
    WSB_PLAYER_MSG_MODEL_NATIVE,
    WSB_PLAYER_MSG_MODEL_RAW
} WSB_Player_MsgThreadModel;

typedef enum {
    WSB_PLAYER_EVENT_TYPE_ACK,
    WSB_PLAYER_EVENT_TYPE_NACK,
    WSB_PLAYER_EVENT_TYPE_PONG_NOTIFICATION,
    WSB_PLAYER_EVENT_TYPE_DECODER_STATE_NOTIFICATION,
    WSB_PLAYER_EVENT_TYPE_VOLUME_NOTIFICATION,
    WSB_PLAYER_EVENT_TYPE_STREAM_TIMECODE_NOTIFICATION,
    WSB_PLAYER_EVENT_TYPE_STREAM_POSITION_NOTIFICATION,
    WSB_PLAYER_EVENT_TYPE_STREAM_INFO_NOTIFICATION,
    WSB_PLAYER_EVENT_TYPE_DRM_STATE_NOTIFICATION,
    WSB_PLAYER_EVENT_TYPE_PROPERTY_NOTIFICATION,
    WSB_PLAYER_EVENT_TYPE_DECODER_EVENT_NOTIFICATION,
    WSB_PLAYER_EVENT_TYPE_BUFFERING,
    WSB_PLAYER_EVENT_TYPE_GOTO_URL_NOTIFICATION
} WSB_Player_EventType;

typedef enum {
    WSB_PLAYER_COMMAND_ID_SET_INPUT,
    WSB_PLAYER_COMMAND_ID_SET_INPUT_EX,
    WSB_PLAYER_COMMAND_ID_SET_VIDEO_OUTPUT,
    WSB_PLAYER_COMMAND_ID_SET_AUDIO_OUTPUT,
    WSB_PLAYER_COMMAND_ID_SET_VOLUME,
    WSB_PLAYER_COMMAND_ID_PLAY,
    WSB_PLAYER_COMMAND_ID_PAUSE,
    WSB_PLAYER_COMMAND_ID_STOP,
    WSB_PLAYER_COMMAND_ID_PING,
    WSB_PLAYER_COMMAND_ID_SEEK_TO_TIME,
    WSB_PLAYER_COMMAND_ID_SEEK_TO_POSITION,
    WSB_PLAYER_COMMAND_ID_REGISTER_MODULE,
    WSB_PLAYER_COMMAND_ID_ADD_NODE,
    WSB_PLAYER_COMMAND_ID_SET_PROPERTY
} WSB_Player_CommandId;

typedef enum {
    WSB_PLAYER_DECODER_STATE_STOPPED,
    WSB_PLAYER_DECODER_STATE_PLAYING,
    WSB_PLAYER_DECODER_STATE_PAUSED,
    WSB_PLAYER_DECODER_STATE_EOS
} WSB_Player_DecoderState;

typedef enum {
    WSB_PLAYER_DECODER_EVENT_TYPE_DECODING_ERROR,
    WSB_PLAYER_DECODER_EVENT_TYPE_INIT_ERROR
} WSB_Player_DecoderEventType;

typedef enum {
    WSB_PLAYER_DRM_STATE_INACTIVE,
    WSB_PLAYER_DRM_STATE_GETTING_LICENSE,
    WSB_PLAYER_DRM_STATE_REGISTERING
} WSB_Player_DRMState;

typedef enum {
    WSB_PLAYER_PROPERTY_SCOPE_CORE,
    WSB_PLAYER_PROPERTY_SCOPE_STREAM,
    WSB_PLAYER_PROPERTY_SCOPE_MODULE
} WSB_Player_PropertyScope;

/*----------------------------------------------------------------------
|   types
+---------------------------------------------------------------------*/

typedef struct {
    WSB_Player_EventType type;
} WSB_Player_Event;

typedef struct {
    WSB_Player_Event     base;
    WSB_Player_CommandId command;
} WSB_Player_AckEvent;

typedef struct {
    WSB_Player_Event     base;
    WSB_Player_CommandId command;
    WSB_Result           result;
} WSB_Player_NackEvent;

typedef struct {
    WSB_Player_Event base;
    const void*      cookie;
} WSB_Player_PongNotificationEvent;

typedef struct {
    WSB_Player_Event        base;
    WSB_Player_DecoderState state;
} WSB_Player_DecoderStateNotificationEvent;

typedef struct {
    WSB_Result  result_code;
    const char* message;
} WSB_Player_DecodingErrorDetails;

typedef struct {
    WSB_Player_Event            base;
    WSB_Player_DecoderEventType type;
    union {
        WSB_Player_DecodingErrorDetails decoding_error;
    } details;
} WSB_Player_DecoderEventNotificationEvent;

typedef struct {
    WSB_Player_Event base;
    float            volume;
} WSB_Player_VolumeNotificationEvent;

typedef struct {
    WSB_Player_Event base;
    WSB_TimeCode     timecode;
} WSB_Player_StreamTimeCodeNotificationEvent;

typedef struct {
    WSB_Player_Event   base;
    WSB_StreamPosition position;
} WSB_Player_StreamPositionNotificationEvent;

typedef struct {
    WSB_Player_Event base;
    WSB_Mask         update_mask;
    WSB_StreamInfo   info;
} WSB_Player_StreamInfoNotificationEvent;

typedef struct {
    WSB_Player_Event    base;
    WSB_Player_DRMState state;
} WSB_Player_DRMStateNotificationEvent;

typedef struct {
    WSB_Player_Event    base;
    WSB_Size            available;
    WSB_Size            needed;
} WSB_Player_BufferingNotificationEvent;

typedef struct {
    WSB_Player_Event    base;
    const char*         goto_url;
} WSB_Player_GotoUrlNotificationEvent;

typedef struct {
    WSB_Player_Event         base;
    WSB_Player_PropertyScope scope;
    const char*              source;
    const char*              name;
    SHI_DataType             type;  
    SHI_DataValue            value; 
} WSB_Player_PropertyNotificationEvent;

typedef struct {
    void* instance;
    void  (*handler)(void* instance, const WSB_Player_Event* event);
} WSB_Player_EventListener;

/*----------------------------------------------------------------------
|   functions
+---------------------------------------------------------------------*/

WSB_EXPORT WSB_Result 
WSB_Player_Create(WSB_Player_EventListener  listener,
                  WSB_Player_MsgThreadModel msg_model,
                  WSB_Player**              playback);

WSB_EXPORT WSB_Result 
WSB_Player_PumpMessage(WSB_Player* playback, WSB_Int32 timeout);

WSB_EXPORT WSB_Result 
WSB_Player_SetInput(WSB_Player* playback, const char* name, const char* mime_type);

WSB_EXPORT WSB_Result 
WSB_Player_SetInputEx(WSB_Player* playback,
                      const char* name,
                      const char* mime_type,
                      WSB_Int32   flags,
                      const void* license_data,
                      WSB_Size    license_data_size,
                      WSB_Int32   audio_track,
                      WSB_Int32   video_track);

WSB_EXPORT WSB_Result 
WSB_Player_SetVideoOutput(WSB_Player* playback, const char* output_name);


WSB_EXPORT WSB_Result 
WSB_Player_SetAudioOutput(WSB_Player* playback, const char* output_name);

WSB_EXPORT WSB_Result 
WSB_Player_SetVolume(WSB_Player* playback, float volume);

#define WSB_PROPERTY_NAME_PLAYER_EXTRA_CONTENT_ACCESS_HTTP_HEADERS \
    "Wasabi.Player.ExtraContentAccessHttpHeaders"

WSB_EXPORT WSB_Result 
WSB_Player_SetProperty(WSB_Player*              playback,
                       WSB_Player_PropertyScope scope,
                       const char*              target,
                       const char*              name,
                       SHI_DataType             type,
                       const SHI_DataValue*     value); 

WSB_EXPORT WSB_Result 
WSB_Player_Play(WSB_Player* playback);

WSB_EXPORT WSB_Result 
WSB_Player_Pause(WSB_Player* playback);

WSB_EXPORT WSB_Result 
WSB_Player_Stop(WSB_Player* playback);

WSB_EXPORT WSB_Result 
WSB_Player_SetFullscreen(WSB_Player* playback, WSB_Boolean fullscreen);

WSB_EXPORT WSB_Result 
WSB_Player_Seek(WSB_Player* playback, WSB_Int32 offset, WSB_Int32 range);

WSB_EXPORT WSB_Result 
WSB_Player_Destroy(WSB_Player* playback);

#if defined(__cplusplus)
}
#endif

#endif /* _WSB_MEDIA_PLAYBACK_H_ */