ccl_platform_if.h

//
// Copyright (c) 2014 Conviva. All rights reserved.
// CCL - Conviva Client Library
//
 
 
 
#ifndef CCLPLATFORMIF_H
#define CCLPLATFORMIF_H
 
#include <stdint.h>
 
#define CCL_MAX_PLATFORM_METADATA_LENGTH 128
 
typedef enum {
 
    CCL_DEVICE_TYPE_UNKNOWN = 0, // default when memset to 0.
 
    CCL_DEVICE_TYPE_DESKTOP,
 
    CCL_DEVICE_TYPE_CONSOLE,
 
    CCL_DEVICE_TYPE_SETTOP,
 
    CCL_DEVICE_TYPE_MOBILE,
 
    CCL_DEVICE_TYPE_TABLET,
 
    CCL_DEVICE_TYPE_SMARTTV,
 
    CCL_DEVICE_TYPE_VEHICLE,
 
    CCL_DEVICE_TYPE_OTHER
 
} ccl_device_type_t;
 
typedef enum {
    CCL_DEVICE_CATEGORY_INVALID = 0, // default when memset to 0.
    //The device is a Android Device like Samsung Galaxy or Amazon Fire TV or Android TV or Android Tablet.
    CCL_DEVICE_CATEGORY_AND,
    //The device is a Apple device like iPhone or Apple TV.
    CCL_DEVICE_CATEGORY_APL,
    //The device is a Google Chromecast STB or Android TV with built-in Chromecast.
    CCL_DEVICE_CATEGORY_CHR,
    //The device is a desktop computer(including notebook)
    CCL_DEVICE_CATEGORY_DSKAPP,
    //The device is a simulated device video session for testing.
    CCL_DEVICE_CATEGORY_SIMULATOR,
    //The device is a Phone or other device based on KaiOS OS, like Lyf Jio F30C.
    CCL_DEVICE_CATEGORY_KAIOS,
    //The device is a LG smart TV including NetCast and webOS.
    CCL_DEVICE_CATEGORY_LGTV,
    //It mostly covers various Set-Top Boxes and Smart TVs that provide custom Linux-based SDKs
    CCL_DEVICE_CATEGORY_LNX,
    //The device is a Nintendo games console including Wii and Switch.
    CCL_DEVICE_CATEGORY_NINTENDO,
    //The device is a PlayStation games console including PS3 and PS4.
    CCL_DEVICE_CATEGORY_PS,
    //The device is a Roku device.
    CCL_DEVICE_CATEGORY_RK,
    //The device is a Samsung Smart TV including Orsay and Tizen.
    CCL_DEVICE_CATEGORY_SAMSUNGTV,
    //Vidaa - based devices. This is the operating system developed by Hisense.
    CCL_DEVICE_CATEGORY_VIDAA,
    //Category for native app integrations on Vizio TVs based on a SmartCast platform (2016).
    CCL_DEVICE_CATEGORY_VIZIOTV,
    //The device can any device with in-browser HTML5-based players. 
    CCL_DEVICE_CATEGORY_WEB,
    //The device is a Windows OS - based handheld device, like Windows Phone or Windows Tablet.
    CCL_DEVICE_CATEGORY_WIN,
    //The device is a Xbox games console including Xbox 360 and Xbox One.
    CCL_DEVICE_CATEGORY_XB
} ccl_device_category_t;
 
typedef enum {
    CCL_HASH_SHA1
} ccl_hash_algo_t;
 
typedef struct ccl_platform_metadata {
    char device_brand[CCL_MAX_PLATFORM_METADATA_LENGTH];
 
    char device_manufacturer[CCL_MAX_PLATFORM_METADATA_LENGTH];
 
    char device_model[CCL_MAX_PLATFORM_METADATA_LENGTH];
 
    ccl_device_category_t device_category;
 
    ccl_device_type_t device_type;
 
    char device_version[CCL_MAX_PLATFORM_METADATA_LENGTH];
 
    char framework_name[CCL_MAX_PLATFORM_METADATA_LENGTH];
 
    char framework_version[CCL_MAX_PLATFORM_METADATA_LENGTH];
 
    char operating_system_name[CCL_MAX_PLATFORM_METADATA_LENGTH];
 
    char operating_system_version[CCL_MAX_PLATFORM_METADATA_LENGTH];
 
    int screen_height;
 
    int screen_width;
 
    double screen_scale_factor;
 
} ccl_platform_metadata_t;
 
typedef void (*ccl_timer_callback) (void *timer_data);
 
typedef void (*ccl_http_callback) (int status, void *http_data, const char *response, unsigned int response_length);
 
typedef void (*ccl_load_callback) (int status, const char *data, unsigned int length);
 
typedef void (*ccl_save_callback) (int status, const char *error, unsigned int length);
 
typedef void (*ccl_http_get_callback) (int status, const char *response, unsigned int response_length);
 
typedef struct {
 
    int (*generate_hash) (const ccl_hash_algo_t hash_algo_type, const unsigned char *input_msg,
                          const int input_msg_len, unsigned char *output_msg,
                          const int output_msg_max_len);
} ccl_crypto_t;
 
typedef enum {
    CCL_UNKNOWN_COMPRESSION = 0, // default when memset to 0.
    CCL_GZIP_COMPRESSION,
} ccl_compression_type_t;
 
typedef struct {
    char *url;
    char *content_type;
    void *data;
    int data_len;
    char **header_keys;
    char **header_values;
    int header_count;
    int timeout_secs;
    ccl_http_callback cbk_func;
} ccl_http_request_t;
 
typedef struct {
 
    void (*save_data) (const char *data, unsigned int length, ccl_save_callback func);
 
    void (*load_data) (ccl_load_callback func);
 
 
    void (*http_post_request) (const char *url, const char *content_type,
                               const char *request, unsigned int request_length,
                               unsigned int timeout,
                               ccl_http_callback func, void *http_data);
 
    void (*console_log) (const char *message);
 
    uint64_t (*epoch_time_ms) (void);
 
    void (*get_platform_metadata) (ccl_platform_metadata_t *platform_metadata);
 
    void * (*create_timer) (ccl_timer_callback func, void *timer_data,
                            unsigned int initial_time, unsigned int interval);
 
    void (*destroy_timer) (void *timer_handle);
 
    int (*rand) (void);
 
    void * (*mutex_init) (void);
 
    void (*mutex_lock) (void *lock);
 
    void (*mutex_unlock) (void *lock);
 
    void (*mutex_destroy) (void *lock);
 
    void * (*rwlock_init) (void);
 
    void (*rwlock_rdlock) (void *rwlock);
 
    void (*rwlock_wrlock) (void *rwlock);
 
    void (*rwlock_unlock) (void *rwlock);
 
    void (*rwlock_destroy) (void *rwlock);
    
    void * (*mem_alloc) (size_t mem_size);
 
    void (*mem_free) (void *memory);
 
 
    int (*base64_encode) (const unsigned char *input_msg,
                const int input_msg_len, unsigned char *output_msg, const int output_msg_max_len);
 
    ccl_crypto_t crypto_funcs;
 
 
    char *(*generate_uuid)(void);
 
    void (*http_get_request) (const char *url, ccl_http_get_callback func);
 
 
    char* (*get_encoded_data) (const char *input, int len, ccl_compression_type_t type, int *output_len);
 
    void (*http_post_with_headers) (ccl_http_request_t *req);
 
} ccl_platform_t;
 
#endif /* CCLPLATFORMIF_H */