nrsc5.h

Go to the documentation of this file.

#ifndef NRSC5_H_
#define NRSC5_H_
 
#include <stdint.h>
#include <stdlib.h>
#include <stdio.h>
#include <time.h>
 
/*
 * Definitions.
 */
#define NRSC5_SCAN_BEGIN  87.9e6
#define NRSC5_SCAN_END   107.9e6
#define NRSC5_SCAN_SKIP    0.2e6
 
#define NRSC5_MIME_PRIMARY_IMAGE    0xBE4B7536 
#define NRSC5_MIME_STATION_LOGO     0xD9C72536 
#define NRSC5_MIME_NAVTEQ           0x2D42AC3E
#define NRSC5_MIME_HERE_TPEG        0x82F03DFC
#define NRSC5_MIME_HERE_IMAGE       0xB7F03DFC
#define NRSC5_MIME_HD_TMC           0xEECB55B6
#define NRSC5_MIME_HDC              0x4DC66C5A 
#define NRSC5_MIME_TEXT             0xBB492AAC 
#define NRSC5_MIME_JPEG             0x1E653E9C 
#define NRSC5_MIME_PNG              0x4F328CA0 
#define NRSC5_MIME_TTN_TPEG_1       0xB39EBEB2
#define NRSC5_MIME_TTN_TPEG_2       0x4EB03469
#define NRSC5_MIME_TTN_TPEG_3       0x52103469
#define NRSC5_MIME_TTN_STM_TRAFFIC  0xFF8422D7
#define NRSC5_MIME_TTN_STM_WEATHER  0xEF042E96
#define NRSC5_MIME_UNKNOWN_00000000 0x00000000
#define NRSC5_MIME_UNKNOWN_1C7D0E29 0x1C7D0E29
#define NRSC5_MIME_UNKNOWN_B81FFAA8 0xB81FFAA8
#define NRSC5_MIME_UNKNOWN_FFFFFFFF 0xFFFFFFFF
 
#define NRSC5_AUDIO_FRAME_SAMPLES  2048        
#define NRSC5_SAMPLE_RATE_CU8      1488375     
#define NRSC5_SAMPLE_RATE_CS16_FM  744187.5    
#define NRSC5_SAMPLE_RATE_CS16_AM  46511.71875 
#define NRSC5_SAMPLE_RATE_AUDIO    44100       
#define NRSC5_DEVICE_VERSION_LENGTH 4          
#ifdef NRSC5_EXPORTS
#ifdef __MINGW32__
#define NRSC5_API __declspec(dllexport)
#else
#define NRSC5_API
#endif
#else
#define NRSC5_API
#endif
 
enum
{
    NRSC5_MODE_FM,
    NRSC5_MODE_AM
};
 
/*
 * Data types.
 */
enum
{
    NRSC5_SIG_COMPONENT_AUDIO,
    NRSC5_SIG_COMPONENT_DATA
};
 
enum
{
    NRSC5_AAS_TYPE_STREAM = 0,
    NRSC5_AAS_TYPE_PACKET = 1,
    NRSC5_AAS_TYPE_LOT = 3
};
 
struct nrsc5_sig_component_t
{
    struct nrsc5_sig_component_t *next;  
    uint8_t type; 
    uint8_t id;   
    union
    {
        struct {
            uint16_t port;  
            uint16_t service_data_type;
            uint8_t type;   
            uint32_t mime;  
        } data;
        struct {
            uint8_t port;   
            uint8_t type;   
            uint32_t mime;  
        } audio;
    };
};
typedef struct nrsc5_sig_component_t nrsc5_sig_component_t;
 
enum
{
    NRSC5_SIG_SERVICE_AUDIO,
    NRSC5_SIG_SERVICE_DATA
};
 
struct nrsc5_sig_service_t
{
    struct nrsc5_sig_service_t *next; 
    uint8_t type;      
    uint16_t number;   
    const char *name;  
    nrsc5_sig_component_t *components; 
    nrsc5_sig_component_t *audio_component; 
};
typedef struct nrsc5_sig_service_t nrsc5_sig_service_t;
 
enum
{
    NRSC5_EVENT_LOST_DEVICE,
    NRSC5_EVENT_IQ,
    NRSC5_EVENT_SYNC,
    NRSC5_EVENT_LOST_SYNC,
    NRSC5_EVENT_MER,
    NRSC5_EVENT_BER,
    NRSC5_EVENT_HDC,
    NRSC5_EVENT_AUDIO,
    NRSC5_EVENT_ID3,
    NRSC5_EVENT_SIG,
    NRSC5_EVENT_LOT,
    NRSC5_EVENT_SIS,
    NRSC5_EVENT_STREAM,
    NRSC5_EVENT_PACKET,
    NRSC5_EVENT_AUDIO_SERVICE,
    NRSC5_EVENT_STATION_ID,
    NRSC5_EVENT_STATION_NAME,
    NRSC5_EVENT_STATION_SLOGAN,
    NRSC5_EVENT_STATION_MESSAGE,
    NRSC5_EVENT_STATION_LOCATION,
    NRSC5_EVENT_AUDIO_SERVICE_DESCRIPTOR,
    NRSC5_EVENT_DATA_SERVICE_DESCRIPTOR,
    NRSC5_EVENT_EMERGENCY_ALERT,
    NRSC5_EVENT_HERE_IMAGE,
    NRSC5_EVENT_LOT_HEADER,
    NRSC5_EVENT_LOT_FRAGMENT,
    NRSC5_EVENT_AGC,
    NRSC5_EVENT_EXCITER_INFO,
    NRSC5_EVENT_IMPORTER_INFO,
    NRSC5_EVENT_LEAP_SECOND_OFFSET,
    NRSC5_EVENT_LOCAL_TIME,
};
 
enum
{
    NRSC5_ACCESS_PUBLIC,
    NRSC5_ACCESS_RESTRICTED
};
 
enum
{
    NRSC5_PROGRAM_TYPE_UNDEFINED = 0,
    NRSC5_PROGRAM_TYPE_NEWS = 1,
    NRSC5_PROGRAM_TYPE_INFORMATION = 2,
    NRSC5_PROGRAM_TYPE_SPORTS = 3,
    NRSC5_PROGRAM_TYPE_TALK = 4,
    NRSC5_PROGRAM_TYPE_ROCK = 5,
    NRSC5_PROGRAM_TYPE_CLASSIC_ROCK = 6,
    NRSC5_PROGRAM_TYPE_ADULT_HITS = 7,
    NRSC5_PROGRAM_TYPE_SOFT_ROCK = 8,
    NRSC5_PROGRAM_TYPE_TOP_40 = 9,
    NRSC5_PROGRAM_TYPE_COUNTRY = 10,
    NRSC5_PROGRAM_TYPE_OLDIES = 11,
    NRSC5_PROGRAM_TYPE_SOFT = 12,
    NRSC5_PROGRAM_TYPE_NOSTALGIA = 13,
    NRSC5_PROGRAM_TYPE_JAZZ = 14,
    NRSC5_PROGRAM_TYPE_CLASSICAL = 15,
    NRSC5_PROGRAM_TYPE_RHYTHM_AND_BLUES = 16,
    NRSC5_PROGRAM_TYPE_SOFT_RHYTHM_AND_BLUES = 17,
    NRSC5_PROGRAM_TYPE_FOREIGN_LANGUAGE = 18,
    NRSC5_PROGRAM_TYPE_RELIGIOUS_MUSIC = 19,
    NRSC5_PROGRAM_TYPE_RELIGIOUS_TALK = 20,
    NRSC5_PROGRAM_TYPE_PERSONALITY = 21,
    NRSC5_PROGRAM_TYPE_PUBLIC = 22,
    NRSC5_PROGRAM_TYPE_COLLEGE = 23,
    NRSC5_PROGRAM_TYPE_SPANISH_TALK = 24,
    NRSC5_PROGRAM_TYPE_SPANISH_MUSIC = 25,
    NRSC5_PROGRAM_TYPE_HIP_HOP = 26,
    NRSC5_PROGRAM_TYPE_WEATHER = 29,
    NRSC5_PROGRAM_TYPE_EMERGENCY_TEST = 30,
    NRSC5_PROGRAM_TYPE_EMERGENCY = 31,
    NRSC5_PROGRAM_TYPE_TRAFFIC = 65,
    NRSC5_PROGRAM_TYPE_SPECIAL_READING_SERVICES = 76
};
 
enum
{
    NRSC5_BLEND_DISABLE,
    NRSC5_BLEND_SELECT,
    NRSC5_BLEND_ENABLE
};
 
enum
{
    NRSC5_LOCATION_FORMAT_SAME,
    NRSC5_LOCATION_FORMAT_FIPS,
    NRSC5_LOCATION_FORMAT_ZIP
};
 
enum
{
    NRSC5_ALERT_CATEGORY_NON_SPECIFIC = 1,
    NRSC5_ALERT_CATEGORY_GEOPHYSICAL = 2,
    NRSC5_ALERT_CATEGORY_WEATHER = 3,
    NRSC5_ALERT_CATEGORY_SAFETY = 4,
    NRSC5_ALERT_CATEGORY_SECURITY = 5,
    NRSC5_ALERT_CATEGORY_RESCUE = 6,
    NRSC5_ALERT_CATEGORY_FIRE = 7,
    NRSC5_ALERT_CATEGORY_HEALTH = 8,
    NRSC5_ALERT_CATEGORY_ENVIRONMENTAL = 9,
    NRSC5_ALERT_CATEGORY_TRANSPORTATION = 10,
    NRSC5_ALERT_CATEGORY_UTILITIES = 11,
    NRSC5_ALERT_CATEGORY_HAZMAT = 12,
    NRSC5_ALERT_CATEGORY_TEST = 30
};
 
enum
{
    NRSC5_HERE_IMAGE_TRAFFIC = 8,
    NRSC5_HERE_IMAGE_WEATHER = 13
};
 
struct nrsc5_sis_asd_t
{
    struct nrsc5_sis_asd_t *next; 
    unsigned int program;     
    unsigned int access;      
    unsigned int type;        
    unsigned int sound_exp;   
};
typedef struct nrsc5_sis_asd_t nrsc5_sis_asd_t;
 
enum
{
    NRSC5_SERVICE_DATA_TYPE_NON_SPECIFIC = 0,
    NRSC5_SERVICE_DATA_TYPE_NEWS = 1,
    NRSC5_SERVICE_DATA_TYPE_SPORTS = 3,
    NRSC5_SERVICE_DATA_TYPE_WEATHER = 29,
    NRSC5_SERVICE_DATA_TYPE_EMERGENCY = 31,
    NRSC5_SERVICE_DATA_TYPE_TRAFFIC = 65,
    NRSC5_SERVICE_DATA_TYPE_IMAGE_MAPS = 66,
    NRSC5_SERVICE_DATA_TYPE_TEXT = 80,
    NRSC5_SERVICE_DATA_TYPE_ADVERTISING = 256,
    NRSC5_SERVICE_DATA_TYPE_FINANCIAL = 257,
    NRSC5_SERVICE_DATA_TYPE_STOCK_TICKER = 258,
    NRSC5_SERVICE_DATA_TYPE_NAVIGATION = 259,
    NRSC5_SERVICE_DATA_TYPE_ELECTRONIC_PROGRAM_GUIDE = 260,
    NRSC5_SERVICE_DATA_TYPE_AUDIO = 261,
    NRSC5_SERVICE_DATA_TYPE_PRIVATE_DATA_NETWORK = 262,
    NRSC5_SERVICE_DATA_TYPE_SERVICE_MAINTENANCE = 263,
    NRSC5_SERVICE_DATA_TYPE_HD_RADIO_SYSTEM_SERVICES = 264,
    NRSC5_SERVICE_DATA_TYPE_AUDIO_RELATED_DATA = 265,
    NRSC5_SERVICE_DATA_TYPE_RESERVED_FOR_SPECIAL_TESTS = 511
};
 
struct nrsc5_sis_dsd_t
{
    struct nrsc5_sis_dsd_t *next; 
    unsigned int access;  
    unsigned int type;    
    uint32_t mime_type;   
};
typedef struct nrsc5_sis_dsd_t nrsc5_sis_dsd_t;
 
struct nrsc5_id3_comment_t {
    struct nrsc5_id3_comment_t *next; 
    char *lang; 
    char *short_content_desc; 
    char *full_text; 
};
typedef struct nrsc5_id3_comment_t nrsc5_id3_comment_t;
 
enum
{
    NRSC5_PKT_FLAGS_NONE = 0,
    NRSC5_PKT_FLAGS_CRC_ERROR = 1 << 0, 
};
 
struct nrsc5_event_t
{
    unsigned int event;
    union
    {
        struct {
            const void *data;
            size_t count;
        } iq;
        struct {
            float freq_offset; 
            int psmi;          
            int pli;           
            int hppi;          
            int aabi;          
            int rdbi;          
        } sync;
        struct {
            float cber;
        } ber;
        struct {
            float lower;
            float upper;
        } mer;
        struct {
            unsigned int program;
            const uint8_t *data;
            size_t count;
            unsigned int flags; 
        } hdc;
        struct {
            unsigned int program;
            const int16_t *data;
            size_t count;
        } audio;
        struct {
            unsigned int program;
            const char *title;
            const char *artist;
            const char *album;
            const char *genre;
            struct {
                const char *owner;
                const char *id;
            } ufid;
            struct {
                uint32_t mime;
                int param;
                int lot;
            } xhdr;
            nrsc5_id3_comment_t *comments;
        } id3;
        struct {
            uint16_t port;  
            uint16_t seq;
            unsigned int size;
            uint32_t mime;  
            const uint8_t *data;
            nrsc5_sig_service_t *service;
            nrsc5_sig_component_t *component;
        } stream;
        struct {
            uint16_t port;  
            uint16_t seq;
            unsigned int size;
            uint32_t mime;  
            const uint8_t *data;
            nrsc5_sig_service_t *service;
            nrsc5_sig_component_t *component;
        } packet;
        struct {
            uint16_t port;                    
            unsigned int lot;                 
            unsigned int size;                
            uint32_t mime;                    
            const char *name;                 
            const uint8_t *data;              
            struct tm *expiry_utc;            
            nrsc5_sig_service_t *service;     
            nrsc5_sig_component_t *component; 
        } lot;
        struct {
            unsigned int lot;                 
            unsigned int seq;                 
            unsigned int repeat;              
            unsigned int size;                
            unsigned int bytes_so_far;        
            int is_duplicate;                 
            const uint8_t *data;              
            nrsc5_sig_service_t *service;     
            nrsc5_sig_component_t *component; 
        } lot_fragment;
        struct {
            unsigned int program;       
            unsigned int access;        
            unsigned int type;          
            unsigned int codec_mode;    
            unsigned int blend_control; 
            int digital_audio_gain;     
            unsigned int common_delay;  
            unsigned int latency;       
        } audio_service;
        struct {
            nrsc5_sig_service_t *services;
        } sig;
        struct {
            const char *country_code;
            int fcc_facility_id;
            const char *name;
            const char *slogan;
            const char *message;
            const char *alert;
            float latitude;
            float longitude;
            int altitude;
            nrsc5_sis_asd_t *audio_services;
            nrsc5_sis_dsd_t *data_services;
            const uint8_t *alert_cnt;
            int alert_cnt_length;
            int alert_category1;
            int alert_category2;
            int alert_location_format;
            int alert_num_locations;
            const int *alert_locations;
        } sis;
        struct {
            const char *country_code;
            int fcc_facility_id;
        } station_id;
        struct {
            const char *name;
        } station_name;
        struct {
            const char *slogan;
        } station_slogan;
        struct {
            const char *message;
        } station_message;
        struct {
            float latitude;
            float longitude;
            int altitude;
        } station_location;
        struct {
            unsigned int program;     
            unsigned int access;      
            unsigned int type;        
            unsigned int sound_exp;   
        } asd;
        struct {
            unsigned int access;  
            unsigned int type;    
            uint32_t mime_type;   
        } dsd;
        struct {
            const char *message;
            const uint8_t *control_data;
            int control_data_length;
            int category1;
            int category2;
            int location_format;
            int num_locations;
            const int *locations;
        } emergency_alert;
        struct {
            int image_type;      
            int seq;             
            int n1;              
            int n2;              
            struct tm *time_utc; 
            float latitude1;     
            float longitude1;    
            float latitude2;     
            float longitude2;    
            const char *name;    
            unsigned int size;   
            const uint8_t *data; 
        } here_image;
        struct {
            float gain_db;       
            float peak_dbfs;     
            int is_final;        
        } agc;
        struct {
            const char* manufacturer_id;                           
            int core_version[NRSC5_DEVICE_VERSION_LENGTH];         
            int core_status;                                       
            int manufacturer_version[NRSC5_DEVICE_VERSION_LENGTH]; 
            int manufacturer_status;                               
            int importer_connected;                                
        } exciter_info;
        struct {
            const char* manufacturer_id;                           
            int core_version[NRSC5_DEVICE_VERSION_LENGTH];         
            int core_status;                                       
            int manufacturer_version[NRSC5_DEVICE_VERSION_LENGTH]; 
            int manufacturer_status;                               
        } importer_info;
        struct {
            int pending_offset;           
            int current_offset;           
            unsigned int pending_alfn;    
        } leap_second_offset;
        struct {
            int utc_offset;    
            int dst_regional;  
            int dst_local;     
            int dst_schedule;  
        } local_time;
    };
};
typedef struct nrsc5_event_t nrsc5_event_t;
 
typedef void (*nrsc5_callback_t)(const nrsc5_event_t *evt, void *opaque);
 
typedef struct nrsc5_t nrsc5_t;
 
 
/* ============================================================================
 * Public functions. All functions return void or an error code (0 == success).
 */
 
NRSC5_API void nrsc5_get_version(const char **version);
 
NRSC5_API void nrsc5_service_data_type_name(unsigned int type, const char **name);
 
NRSC5_API void nrsc5_program_type_name(unsigned int type, const char **name);
 
 NRSC5_API void nrsc5_alert_category_name(unsigned int category, const char **name);
 
NRSC5_API int nrsc5_open(nrsc5_t **st, int device_index);
 
NRSC5_API int nrsc5_open_file(nrsc5_t **st, FILE *fp);
 
NRSC5_API int nrsc5_open_pipe(nrsc5_t **st);
 
NRSC5_API int nrsc5_open_rtltcp(nrsc5_t **st, int socket);
 
NRSC5_API void nrsc5_close(nrsc5_t *st);
 
NRSC5_API void nrsc5_start(nrsc5_t *st);
 
NRSC5_API void nrsc5_stop(nrsc5_t *st);
 
NRSC5_API int nrsc5_set_mode(nrsc5_t *st, int mode);
 
NRSC5_API int nrsc5_set_bias_tee(nrsc5_t *st, int on);
 
NRSC5_API int nrsc5_set_direct_sampling(nrsc5_t *st, int on);
 
NRSC5_API int nrsc5_set_freq_correction(nrsc5_t *st, int ppm_error);
 
NRSC5_API void nrsc5_get_frequency(nrsc5_t *st, float *freq);
 
NRSC5_API int nrsc5_set_frequency(nrsc5_t *st, float freq);
 
NRSC5_API void nrsc5_get_gain(nrsc5_t *st, float *gain);
 
NRSC5_API int nrsc5_set_gain(nrsc5_t *st, float gain);
 
NRSC5_API void nrsc5_set_auto_gain(nrsc5_t *st, int enabled);
 
NRSC5_API void nrsc5_set_callback(nrsc5_t *st, nrsc5_callback_t callback, void *opaque);
 
NRSC5_API int nrsc5_pipe_samples_cu8(nrsc5_t *st, const uint8_t *samples, unsigned int length);
 
NRSC5_API int nrsc5_pipe_samples_cs16(nrsc5_t *st, const int16_t *samples, unsigned int length);
 
#endif /* NRSC5_H_ */