WsbMediaFile.h

Go to the documentation of this file.

/*****************************************************************
|
|   Wasabi - Media File API
|
|   $Id: WsbMediaFile.h 13807 2018-02-09 10:12:46Z nbanda $
|   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_FILE_H_
#define _WSB_MEDIA_FILE_H_

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

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

typedef struct WSB_TrackInfo WSB_TrackInfo;

typedef struct WSB_AudioMediaInfo {
    WSB_UInt32  channel_count;
    WSB_UInt32  sample_rate;
    WSB_UInt32  sample_size;
    const char* language;
} WSB_AudioMediaInfo;

typedef enum {
    WSB_HDR_TYPE_UNKNOWN      = 0,
    WSB_HDR_TYPE_HDR10        = 1,
    WSB_HDR_TYPE_DOLBY_VISION = 2
} WSB_HdrType;

typedef struct {
    WSB_UInt32 reserved;
} WSB_Hdr10Info;

typedef struct {
    WSB_Int32 profile_id;
    WSB_Int32 level_id;
} WSB_DolbyVisionProfileLevelInfo;

typedef struct {
    WSB_Int32                              pl_info_count;
    const WSB_DolbyVisionProfileLevelInfo* pl_infos;
} WSB_DolbyVisionInfo;

typedef struct {
    WSB_HdrType             type;
    union {
        WSB_Hdr10Info       hdr10;
        WSB_DolbyVisionInfo dolby_vision;
    } info;
} WSB_HdrInfo;

typedef struct WSB_VideoMediaInfo {
    WSB_UInt32  width;
    WSB_UInt32  height;
    WSB_UInt32  depth;
    WSB_HdrInfo hdr_info;
} WSB_VideoMediaInfo;

typedef enum {
    WSB_MEDIA_TYPE_UNKNOWN  = 0,
    WSB_MEDIA_TYPE_AUDIO    = 1,
    WSB_MEDIA_TYPE_VIDEO    = 2,
    WSB_MEDIA_TYPE_SUBTITLE = 3
} WSB_MediaType;

typedef enum {
    WSB_MEDIA_FORMAT_UNKNOWN   = 0,
    WSB_MEDIA_FORMAT_AAC       = 1,
    WSB_MEDIA_FORMAT_AVC       = 2,
    WSB_MEDIA_FORMAT_MPEG4_VID = 4,
    WSB_MEDIA_FORMAT_HEVC      = 5,
    WSB_MEDIA_FORMAT_AC3       = 6,
    WSB_MEDIA_FORMAT_VTT       = 7,
    WSB_MEDIA_FORMAT_TTML      = 8
} WSB_MediaFormat;

typedef enum {
    WSB_STREAM_ENCRYPTION_METHOD_UNKNOWN       = 0,
    WSB_STREAM_ENCRYPTION_METHOD_NULL          = 1,
    WSB_STREAM_ENCRYPTION_METHOD_AES_128_CBC   = 2,
    WSB_STREAM_ENCRYPTION_METHOD_AES_128_CTR   = 3,
    WSB_STREAM_ENCRYPTION_METHOD_DVB_CSA       = 4
} WSB_StreamEncryptionMethod;

typedef struct WSB_MediaInfo {
    WSB_MediaType              type;
    WSB_MediaFormat            format;
    WSB_UInt32                 duration; 
    WSB_UInt32                 bitrate;  
    WSB_StreamEncryptionMethod encryption_method;
    const char*                track_name; 
    union {
        WSB_AudioMediaInfo audio;
        WSB_VideoMediaInfo video;
    } specific;
} WSB_MediaInfo;

typedef struct WSB_FileProgress {
    WSB_Flags     flags;
    WSB_LargeSize available;    
    WSB_LargeSize total_size;   
} WSB_FileProgress;

typedef enum {
    WSB_PROTECTION_TYPE_UNKNOWN    = 0,
    WSB_PROTECTION_TYPE_CLEAR_TEXT = 1,
    WSB_PROTECTION_TYPE_DCF        = 2,
    WSB_PROTECTION_TYPE_PDCF       = 3,
    WSB_PROTECTION_TYPE_PIFF       = 4,
    WSB_PROTECTION_TYPE_BBTS       = 5,
    WSB_PROTECTION_TYPE_CENC       = 6,/* Common Encryption cenc scheme */
    WSB_PROTECTION_TYPE_HLS_AES    = 7,/* HLS Encryption defined in IETF draft */
    WSB_PROTECTION_TYPE_CBCS       = 8 /* Common Encryption cbcs scheme */
} WSB_MediaFileProtectionType;

/*----------------------------------------------------------------------
|   constants
+---------------------------------------------------------------------*/
#define WSB_CONTENT_TYPE_VIDEO_MP4      "video/mp4"
#define WSB_CONTENT_TYPE_VIDEO_M4V      "video/m4v"
#define WSB_CONTENT_TYPE_AUDIO_MP4      "audio/mp4"
#define WSB_CONTENT_TYPE_VIDEO_MPEG2TS  "video/MP2T"
#define WSB_CONTENT_TYPE_DASH           "application/dash+xml"
#define WSB_CONTENT_TYPE_HLS            "application/vnd.apple.mpegurl"
#define WSB_CONTENT_TYPE_DCF            "application/vnd.oma.drm.dcf"
#define WSB_CONTENT_TYPE_DECE           "video/vnd.dece.mp4"
#define WSB_CONTENT_TYPE_SUBTITLE_VTT   "text/vtt"
#define WSB_CONTENT_TYPE_SUBTITLE_MP4   "application/mp4"
#define WSB_CONTENT_TYPE_SUBTITLE_TTML  "application/ttml+xml"

#define WSB_MEDIA_FILE_METADATA_FILTER_MINIMAL_SET  1
#define WSB_MEDIA_FILE_METADATA_FILTER_BASIC_SET    2
#define WSB_MEDIA_FILE_METADATA_FILTER_EXTENDED_SET 4
#define WSB_MEDIA_FILE_METADATA_FILTER_LICENSE      8
#define WSB_MEDIA_FILE_METADATA_FILTER_ALL          0xFFFFFFFF

#define WSB_MEDIA_FILE_FLAG_PROGRESS_CAN_START      1

#define WSB_FILE_METADATA_NAME              "Name"              /* string */
#define WSB_FILE_METADATA_ARTIST            "Artist"            /* string */
#define WSB_FILE_METADATA_ALBUM_ARTIST      "AlbumArtist"       /* string */
#define WSB_FILE_METADATA_COMPOSER          "Composer"          /* string */
#define WSB_FILE_METADATA_WRITER            "Writer"            /* string */
#define WSB_FILE_METADATA_ALBUM             "Album"             /* string */
#define WSB_FILE_METADATA_GENRE_CODE        "GenreCode"         /* integer */
#define WSB_FILE_METADATA_GENRE_NAME        "GenreName"         /* string */
#define WSB_FILE_METADATA_GROUPING          "Grouping"          /* string */
#define WSB_FILE_METADATA_DATE              "Date"              /* string */
#define WSB_FILE_METADATA_ENCODING_TOOL     "Tool",             /* string */
#define WSB_FILE_METADATA_COMMENT           "Comment"           /* string */
#define WSB_FILE_METADATA_LYRICS            "Lyrics"            /* string */
#define WSB_FILE_METADATA_COPYRIGHT         "Copyright"         /* string */
#define WSB_FILE_METADATA_TRACK_NUMBER      "Track"             /* integer */
#define WSB_FILE_METADATA_DISC_NUMBER       "Disc"              /* integer */
#define WSB_FILE_METADATA_COVER_ART         "Cover"             /* byte array */
#define WSB_FILE_METADATA_DESCRIPTION       "Description"       /* string */
#define WSB_FILE_METADATA_RATING            "Rating"            /* integer */
#define WSB_FILE_METADATA_TEMPO             "Tempo"             /* integer */
#define WSB_FILE_METADATA_COMPILATION       "Compilation"       /* boolean */
#define WSB_FILE_METADATA_IS_GAPLESS        "IsGapless"         /* boolean */
#define WSB_FILE_METADATA_TITLE             "Title"             /* string */
#define WSB_FILE_METADATA_STORE_FRONT       "StoreFrontId"      /* integer */
#define WSB_FILE_METADATA_FILE_KIND         "FileKind"          /* integer */
#define WSB_FILE_METADATA_SHOW_NAME         "ShowName"          /* string */
#define WSB_FILE_METADATA_SHOW_SEASON       "ShowSeason"        /* integer */
#define WSB_FILE_METADATA_SHOW_EPISODE_NUM  "ShowEpisodeNumber" /* integer */
#define WSB_FILE_METADATA_SHOW_EPISONE_NAME "ShowEpisodeName"   /* string */
#define WSB_FILE_METADATA_TV_NETWORK_NAME   "TVNetworkName"     /* string */
#define WSB_FILE_METADATA_IS_PODCAST        "IsPodcast"         /* boolean */
#define WSB_FILE_METADATA_PODCAST_URL       "PodcastUrl"        /* string */
#define WSB_FILE_METADATA_PODCAST_GUID      "PodcastGuid"       /* byte array */
#define WSB_FILE_METADATA_PODCAST_CATEGORY  "PodcastCategory"   /* string */
#define WSB_FILE_METADATA_KEYWORDS          "Keywords"          /* string */
#define WSB_FILE_METADATA_PURCHASE_DATE     "PurchaseDate"      /* string */
#define WSB_FILE_METADATA_ICON_URI          "IconUri"           /* string */
#define WSB_FILE_METADATA_INFO_URL          "Info URL"          /* string */
#define WSB_FILE_METADATA_COVER_ART_URI     "CoverUri"          /* string */
#define WSB_FILE_METADATA_LYRICS_URI        "LyricsUri"         /* string */
#define WSB_FILE_METADATA_DURATION          "Duration"          /* integer */
#define WSB_FILE_METADATA_PERFORMER         "Performer"         /* string */
#define WSB_FILE_METADATA_AUTHOR            "Author"            /* string */

#define WSB_SLAS_ATTRIBUTE_NAME "SilentLicenseAcquisitionUrls"  
#define WSB_RI_ATTRIBUTE_NAME   "RightsIssuerUrls"  

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

WSB_EXPORT const char*
WSB_TrackInfo_GetContentId(WSB_TrackInfo* track_info);

WSB_EXPORT WSB_UInt32
WSB_TrackInfo_GetTrackId(WSB_TrackInfo* track_info);

WSB_EXPORT WSB_Result
WSB_TrackInfo_GetMediaInfo(WSB_TrackInfo* track_info,
                           WSB_MediaInfo* media_info);

WSB_EXPORT WSB_Result
WSB_TrackInfo_GetContentProtection(WSB_TrackInfo*  track_info,
                                   SHI_Attribute** content_protection);

WSB_EXPORT void
WSB_TrackInfo_Release(WSB_TrackInfo* track_info);

WSB_EXPORT WSB_Result 
WSB_MediaFile_Open(const char* name, const char* mime_type, WSB_MediaFile** file);

WSB_EXPORT WSB_Result
WSB_MediaFile_GetProtectionType(WSB_MediaFile*               file,
                                WSB_MediaFileProtectionType* type);

WSB_EXPORT WSB_Result 
WSB_MediaFile_GetMetadata(WSB_MediaFile*  file, 
                          SHI_Attribute** metadata);
                          
WSB_EXPORT WSB_Result
WSB_MediaFile_GetProgress(WSB_MediaFile*    file,
                          WSB_FileProgress* progress);
                          
WSB_EXPORT WSB_Result 
WSB_MediaFile_SetLicense(WSB_MediaFile* file, 
                         const void*    license_data, 
                         WSB_Size       license_data_size);
                         
WSB_EXPORT const char*
WSB_MediaFile_GetContentId(WSB_MediaFile* file);

WSB_EXPORT const char*
WSB_MediaFile_GetContentType(WSB_MediaFile* file);

WSB_EXPORT WSB_Result
WSB_MediaFile_GetMediaInfo(WSB_MediaFile* file,
                           WSB_MediaInfo* media_info);

WSB_EXPORT WSB_Cardinal
WSB_MediaFile_GetTrackCount(WSB_MediaFile* file);

WSB_EXPORT WSB_Result
WSB_MediaFile_GetTrackInfo(WSB_MediaFile*  file,
                           WSB_Ordinal     index,
                           WSB_TrackInfo** track_info);

WSB_EXPORT WSB_Result
WSB_MediaFile_GetLicense(WSB_MediaFile* file,
                         SHI_Data**     license);

WSB_EXPORT WSB_Result
WSB_MediaFile_GetRightsIssuerUrls(WSB_MediaFile*  file,
                                  SHI_Attribute** ri_urls); /* mapping contentid -> ri_urls */

WSB_EXPORT WSB_Result
WSB_MediaFile_GetSilentLicenseAcquisitionUrls(WSB_MediaFile*  file,
                                              SHI_Attribute** slas); /* mapping contentid -> sla */

WSB_EXPORT const char*
WSB_MediaFile_GetName(WSB_MediaFile* file);

WSB_EXPORT WSB_Result
WSB_MediaFile_WaitUntilReady(WSB_MediaFile* file,
                             WSB_UInt32     file_ready_timeout_ms);
WSB_EXPORT WSB_Result 
WSB_MediaFile_Close(WSB_MediaFile* file);

#if defined(__cplusplus)
}
#endif

#endif /* _WSB_MEDIA_FILE_H_ */