WsbMediaDownload.h

Go to the documentation of this file.

/*****************************************************************
|
|   Wasabi - Media Download interface
|
|   $Id: WsbMediaDownload.h 13313 2017-09-08 02:29:47Z ehodzic $
|   Original author: Edin Hodzic ([email protected])
|
|   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) 2017 by Intertrust. All rights reserved. 
|
****************************************************************/
#ifndef _WSB_MEDIA_DOWNLOAD_H_
#define _WSB_MEDIA_DOWNLOAD_H_

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

/*----------------------------------------------------------------------
|   constants
+---------------------------------------------------------------------*/
#define WSB_MD_MAX_TRACKS 3

/*----------------------------------------------------------------------
|   types
+---------------------------------------------------------------------*/
typedef struct WSB_MediaDownload WSB_MediaDownload;

typedef enum {
    WSB_MDS_PAUSED = 1,

    WSB_MDS_RUNNING

} WSB_MediaDownload_State;

typedef struct {
    WSB_UInt32 max_bandwidth_bps; /* bits per second */
    WSB_UInt32 max_connections;
} WSB_MediaDownload_Constraints;

typedef struct {
    WSB_MediaDownload_State state;
    WSB_MediaDownload_Constraints constraints;
    WSB_UInt32 content_count;
    const char** path;
} WSB_MediaDownload_Status;

typedef enum {
    WSB_MDST_DASH = 1,
    WSB_MDST_SINGLE_FILE
} WSB_MediaDownload_SourceType;

typedef struct WSB_MediaDownload_Content {
    WSB_MediaDownload_SourceType type;
    const char* url;

    union {
        struct {
            const char* media_file_name;
            const char* subtitles_file_name;
            WSB_UInt32 track_count;
            const char* track[WSB_MD_MAX_TRACKS];
        } dash;

        struct {
            const char* media_file_name;
        } single_file;
    } u;

} WSB_MediaDownload_Content;

typedef enum {
    WSB_MDCS_PENDING     = 1,
    WSB_MDCS_IN_PROGRESS = 2,
    WSB_MDCS_FAILING     = 3,
    WSB_MDCS_CANCELED    = 4,
    WSB_MDCS_COMPLETED   = 5
} WSB_MediaDownload_ContentState;

typedef struct {
    WSB_MediaDownload_ContentState content_state;
    WSB_MediaDownload_Content content;
    const char* path;
    WSB_UInt32 downloaded_percentage;
} WSB_MediaDownload_ContentStatus;

typedef struct {

    void (*State)(void* client_context, WSB_MediaDownload_State state);

    void (*Progress)(void* client_context,
                     const WSB_MediaDownload_ContentStatus* content_status);
                     
} WSB_MediaDownload_Listener;

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

WSB_EXPORT WSB_Result
WSB_MediaDownload_Get(WSB_MediaDownload** download);

WSB_EXPORT WSB_Result
WSB_MediaDownload_Release(WSB_MediaDownload* download);

WSB_EXPORT WSB_Result
WSB_MediaDownload_SetListener(WSB_MediaDownload* download,
                              void* client_context,
                              const WSB_MediaDownload_Listener* listener);

WSB_EXPORT WSB_Result
WSB_MediaDownload_RemoveListener(WSB_MediaDownload* download);

WSB_EXPORT WSB_Result
WSB_MediaDownload_Pause(WSB_MediaDownload* download);

WSB_EXPORT WSB_Result
WSB_MediaDownload_Resume(WSB_MediaDownload* download);

WSB_EXPORT WSB_Result
WSB_MediaDownload_SetConstraints(WSB_MediaDownload* download,
                                 const WSB_MediaDownload_Constraints* constraints);

WSB_EXPORT WSB_Result
WSB_MediaDownload_QueryStatus(WSB_MediaDownload* download,
                              WSB_MediaDownload_Status** status);

WSB_EXPORT WSB_Result
WSB_MediaDownload_ReleaseStatus(WSB_MediaDownload* download,
                                WSB_MediaDownload_Status* status);

WSB_EXPORT WSB_Result
WSB_MediaDownload_AddContent(WSB_MediaDownload* download,
                             const char* path,
                             const WSB_MediaDownload_Content* content);

WSB_EXPORT WSB_Result
WSB_MediaDownload_CancelContent(WSB_MediaDownload* download,
                                const char* path);

WSB_EXPORT WSB_Result
WSB_MediaDownload_QueryContentStatus(WSB_MediaDownload* download,
                                     const char* path,
                                     WSB_MediaDownload_ContentStatus** content_status);

WSB_EXPORT WSB_Result
WSB_MediaDownload_ReleaseContentStatus(WSB_MediaDownload* download,
                                       WSB_MediaDownload_ContentStatus* content_status);

#ifdef __cplusplus
}
#endif

#endif // _WSB_MEDIA_DOWNLOAD_H_