icecast_client.h

Go to the documentation of this file.

 
#ifndef _ICECAST_CLIENT_H
#define _ICECAST_CLIENT_H
 
//Dependencies
#include "core/net.h"
#include "core/socket.h"
 
//Icecast client support
#ifndef ICECAST_CLIENT_SUPPORT
   #define ICECAST_CLIENT_SUPPORT DISABLED
#elif (ICECAST_CLIENT_SUPPORT != ENABLED && ICECAST_CLIENT_SUPPORT != DISABLED)
   #error ICECAST_CLIENT_SUPPORT parameter is not valid
#endif
 
//Stack size required to run the Icecast client
#ifndef ICECAST_CLIENT_STACK_SIZE
   #define ICECAST_CLIENT_STACK_SIZE 650
#elif (ICECAST_CLIENT_STACK_SIZE < 1)
   #error ICECAST_CLIENT_STACK_SIZE parameter is not valid
#endif
 
//Priority at which the Icecast client should run
#ifndef ICECAST_CLIENT_PRIORITY
   #define ICECAST_CLIENT_PRIORITY OS_TASK_PRIORITY_NORMAL
#endif
 
//Maximum time the Icecast client will wait before closing the connection
#ifndef ICECAST_CLIENT_TIMEOUT
   #define ICECAST_CLIENT_TIMEOUT 10000
#elif (ICECAST_CLIENT_TIMEOUT < 1000)
   #error ICECAST_CLIENT_TIMEOUT parameter is not valid
#endif
 
//Recovery delay
#ifndef ICECAST_RECOVERY_DELAY
   #define ICECAST_RECOVERY_DELAY 5000
#elif (ICECAST_RECOVERY_DELAY < 1000)
   #error ICECAST_RECOVERY_DELAY parameter is not valid
#endif
 
//Maximum length of the server name
#ifndef ICECAST_SERVER_NAME_MAX_LEN
   #define ICECAST_SERVER_NAME_MAX_LEN 48
#elif (ICECAST_SERVER_NAME_MAX_LEN < 1)
   #error ICECAST_SERVER_NAME_MAX_LEN parameter is not valid
#endif
 
//Maxmimum length of the requested resource
#ifndef ICECAST_RESOURCE_MAX_LEN
   #define ICECAST_RESOURCE_MAX_LEN 32
#elif (ICECAST_RESOURCE_MAX_LEN < 1)
   #error ICECAST_RESOURCE_MAX_LEN parameter is not valid
#endif
 
//Maximum size of metadata blocks
#ifndef ICECAST_CLIENT_METADATA_MAX_SIZE
   #define ICECAST_CLIENT_METADATA_MAX_SIZE 512
#elif (ICECAST_CLIENT_METADATA_MAX_SIZE < 128)
   #error ICECAST_CLIENT_METADATA_MAX_SIZE parameter is not valid
#endif
 
//C++ guard
#ifdef __cplusplus
extern "C" {
#endif
 
 
typedef struct
{
   NetInterface *interface;                        
   char_t serverName[ICECAST_SERVER_NAME_MAX_LEN]; 
   uint16_t serverPort;                            
   char_t resource[ICECAST_RESOURCE_MAX_LEN];      
   size_t bufferSize;                              
} IcecastClientSettings;
 
 
typedef struct
{
   IcecastClientSettings settings;                    
   OsMutex mutex;                                     
   OsEvent writeEvent;                                
   OsEvent readEvent;                                 
   OsTaskId taskId;                                   
#if (OS_STATIC_TASK_SUPPORT == ENABLED)
   OsTaskTcb taskTcb;                                 
   OsStackType taskStack[ICECAST_CLIENT_STACK_SIZE];  
#endif
   Socket *socket;                                    
   size_t blockSize;                                  
   uint8_t *streamBuffer;                             
   size_t bufferSize;                                 
   size_t bufferLength;                               
   size_t writeIndex;                                 
   size_t readIndex;                                  
   size_t totalLength;                                
   char_t buffer[ICECAST_CLIENT_METADATA_MAX_SIZE];   
   char_t metadata[ICECAST_CLIENT_METADATA_MAX_SIZE]; 
   size_t metadataLength;                             
} IcecastClientContext;
 
 
//Icecast related functions
void icecastClientGetDefaultSettings(IcecastClientSettings *settings);
 
error_t icecastClientInit(IcecastClientContext *context,
   const IcecastClientSettings *settings);
 
error_t icecastClientStart(IcecastClientContext *context);
 
error_t icecastClientReadStream(IcecastClientContext *context,
   uint8_t *data, size_t size, size_t *length, systime_t timeout);
 
error_t icecastClientReadMetadata(IcecastClientContext *context,
   char_t *metadata, size_t size, size_t *length);
 
void icecastClientTask(void *param);
 
error_t icecastClientConnect(IcecastClientContext *context);
error_t icecastClientProcessMetadata(IcecastClientContext *context);
 
//C++ guard
#ifdef __cplusplus
}
#endif
 
#endif