edflib.h

Go to the documentation of this file.

/*
*****************************************************************************
*
* Copyright (c) 2009 - 2024 Teunis van Beelen
* All rights reserved.
*
* Email: teuniz@protonmail.com
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*     * Redistributions of source code must retain the above copyright
*       notice, this list of conditions and the following disclaimer.
*     * Redistributions in binary form must reproduce the above copyright
*       notice, this list of conditions and the following disclaimer in the
*       documentation and/or other materials provided with the distribution.
*     * Neither the name of the copyright holder nor the names of its
*       contributors may be used to endorse or promote products derived from
*       this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ''AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
*****************************************************************************
*/
 
/* compile with options "-D_LARGEFILE64_SOURCE -D_LARGEFILE_SOURCE" */
 
 
#ifndef EDFLIB_INCLUDED
#define EDFLIB_INCLUDED
 
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <time.h>
 
 
/*
 * If both EDFLIB_SO_DLL and EDFLIB_BUILD are defined: compile only EDFlib as a shared library (so, dll).
 * When compiling on unix-like systems, add the -fvisibility=hidden to hide all symbols by
 * default so that this macro can reveal them.
 *
 * If only EDFLIB_SO_DLL is defined: link with EDFlib as an external library (so, dll).
 * EDFlib must be installed on your system (as an .so or .dll) when running your program.
 *
 * If both EDFLIB_SO_DLL and EDFLIB_BUILD are not defined: EDFlib will not be used as a shared library,
 * it will be an integral part of your program instead.
 *
 */
 
/*
#define EDFLIB_SO_DLL
#define EDFLIB_BUILD
*/
 
#if defined(EDFLIB_SO_DLL)
#  if defined(EDFLIB_BUILD)
#    if defined(_WIN32)
#      define EDFLIB_API __declspec(dllexport)
#    elif defined(__ELF__)
#      define EDFLIB_API __attribute__ ((visibility ("default")))
#    else
#      define EDFLIB_API
#    endif
#  else
#    if defined(_WIN32)
#      define EDFLIB_API __declspec(dllimport)
#    else
#      define EDFLIB_API
#    endif
#  endif
#else
#  define EDFLIB_API
#endif
 
 
 
#define EDFLIB_TIME_DIMENSION     (10000000LL)
#define EDFLIB_MAXSIGNALS                (640)
#define EDFLIB_MAX_ANNOTATION_LEN        (512)
 
#define EDFSEEK_SET  (0)
#define EDFSEEK_CUR  (1)
#define EDFSEEK_END  (2)
 
#define EDF_ANNOT_IDX_POS_END     (0)
#define EDF_ANNOT_IDX_POS_MIDDLE  (1)
#define EDF_ANNOT_IDX_POS_START   (2)
 
/* the following defines are used in the member "filetype" of the edf_hdr_struct
   and as return value for the function edfopen_file_readonly() */
#define EDFLIB_FILETYPE_EDF                  (0)
#define EDFLIB_FILETYPE_EDFPLUS              (1)
#define EDFLIB_FILETYPE_BDF                  (2)
#define EDFLIB_FILETYPE_BDFPLUS              (3)
#define EDFLIB_MALLOC_ERROR                 (-1)
#define EDFLIB_NO_SUCH_FILE_OR_DIRECTORY    (-2)
 
/* when this error occurs, try to open the file with EDFbrowser (https://www.teuniz.net/edfbrowser/),
   it will give you full details about the cause of the error. It can also fix most errors. */
#define EDFLIB_FILE_CONTAINS_FORMAT_ERRORS  (-3)
 
#define EDFLIB_MAXFILES_REACHED             (-4)
#define EDFLIB_FILE_READ_ERROR              (-5)
#define EDFLIB_FILE_ALREADY_OPENED          (-6)
#define EDFLIB_FILETYPE_ERROR               (-7)
#define EDFLIB_FILE_WRITE_ERROR             (-8)
#define EDFLIB_NUMBER_OF_SIGNALS_INVALID    (-9)
#define EDFLIB_FILE_IS_DISCONTINUOUS       (-10)
#define EDFLIB_INVALID_READ_ANNOTS_VALUE   (-11)
#define EDFLIB_ARCH_ERROR                  (-12)
 
/* values for annotations */
#define EDFLIB_DO_NOT_READ_ANNOTATIONS  (0)
#define EDFLIB_READ_ANNOTATIONS         (1)
#define EDFLIB_READ_ALL_ANNOTATIONS     (2)
 
/* the following defines are possible errors returned by the first sample write action */
#define EDFLIB_NO_SIGNALS                  (-20)
#define EDFLIB_TOO_MANY_SIGNALS            (-21)
#define EDFLIB_NO_SAMPLES_IN_RECORD        (-22)
#define EDFLIB_DIGMIN_IS_DIGMAX            (-23)
#define EDFLIB_DIGMAX_LOWER_THAN_DIGMIN    (-24)
#define EDFLIB_PHYSMIN_IS_PHYSMAX          (-25)
#define EDFLIB_DATARECORD_SIZE_TOO_BIG     (-26)
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct edf_param_struct
{
  char   label[17];              
  long long smp_in_file;         
  double phys_max;               
  double phys_min;               
  int    dig_max;                
  int    dig_min;                
  int    smp_in_datarecord;      
  char   physdimension[9];       
  char   prefilter[81];          
  char   transducer[81];         
} edflib_param_t;
 
typedef struct edf_annotation_struct
{
        long long onset;                                
        long long duration_l;                           
        char duration[20];                              
        char annotation[EDFLIB_MAX_ANNOTATION_LEN + 1]; 
} edflib_annotation_t;
 
typedef struct edf_hdr_struct
{
  int       handle;               
  int       filetype;             
  int       edfsignals;           
  long long file_duration;        
  int       startdate_day;        
  int       startdate_month;      
  int       startdate_year;       
  long long starttime_subsecond;  
  int       starttime_second;     
  int       starttime_minute;     
  int       starttime_hour;       
  char      patient[81];          
  char      recording[81];        
  char      patientcode[81];      
  char      sex[16];              
#if defined(__GNUC__)
  char      gender[16] __attribute__ ((deprecated ("use sex")));      
#else
  char      gender[16];  
#endif
  char      birthdate[16];             
  int       birthdate_day;             
  int       birthdate_month;           
  int       birthdate_year;            
  char      patient_name[81];          
  char      patient_additional[81];    
  char      admincode[81];             
  char      technician[81];            
  char      equipment[81];             
  char      recording_additional[81];  
  long long datarecord_duration;       
  long long datarecords_in_file;       
  long long annotations_in_file;       
  edflib_param_t signalparam[EDFLIB_MAXSIGNALS];  
} edflib_hdr_t;
 
/*****************  the following functions are used to read files **************************/
 
EDFLIB_API int edfopen_file_readonly(const char *path, edflib_hdr_t *edfhdr, int read_annotations);
 
EDFLIB_API int edfread_physical_samples(int handle, int edfsignal, int n, double *buf);
 
EDFLIB_API int edfread_digital_samples(int handle, int edfsignal, int n, int *buf);
 
EDFLIB_API long long edfseek(int handle, int edfsignal, long long offset, int whence);
 
EDFLIB_API long long edftell(int handle, int edfsignal);
 
EDFLIB_API int edfrewind(int handle, int edfsignal);
 
EDFLIB_API int edf_get_annotation(int handle, int n, edflib_annotation_t *annot);
 
/*****************  the following functions are used in read and write mode **************************/
 
EDFLIB_API int edfclose_file(int handle);
 
EDFLIB_API int edflib_version(void);
 
EDFLIB_API int edflib_is_file_used(const char *path);
 
EDFLIB_API int edflib_get_number_of_open_files(void);
 
EDFLIB_API int edflib_get_handle(int file_number);
 
/*****************  the following functions are used to write files **************************/
 
EDFLIB_API int edfopen_file_writeonly(const char *path, int filetype, int number_of_signals);
 
EDFLIB_API int edfopen_file_writeonly_with_params(const char *path, int filetype, int number_of_signals, int samplefrequency, double phys_max_min, const char *phys_dim);
 
EDFLIB_API int edf_set_samplefrequency(int handle, int edfsignal, int samplefrequency);
 
EDFLIB_API int edf_set_physical_maximum(int handle, int edfsignal, double phys_max);
 
EDFLIB_API int edf_set_physical_minimum(int handle, int edfsignal, double phys_min);
 
EDFLIB_API int edf_set_digital_maximum(int handle, int edfsignal, int dig_max);
 
EDFLIB_API int edf_set_digital_minimum(int handle, int edfsignal, int dig_min);
 
EDFLIB_API int edf_set_label(int handle, int edfsignal, const char *label);
 
EDFLIB_API int edf_set_prefilter(int handle, int edfsignal, const char *prefilter);
 
EDFLIB_API int edf_set_transducer(int handle, int edfsignal, const char *transducer);
 
EDFLIB_API int edf_set_physical_dimension(int handle, int edfsignal, const char *phys_dim);
 
EDFLIB_API int edf_set_startdatetime(int handle, int startdate_year, int startdate_month, int startdate_day,
                                     int starttime_hour, int starttime_minute, int starttime_second);
 
EDFLIB_API int edf_set_patientname(int handle, const char *patientname);
 
EDFLIB_API int edf_set_patientcode(int handle, const char *patientcode);
 
EDFLIB_API int edf_set_sex(int handle, int sex);
 
#if defined(__GNUC__)
EDFLIB_API int edf_set_gender(int handle, int sex) __attribute__ ((deprecated ("use edf_set_sex()")));
#else
EDFLIB_API int edf_set_gender(int handle, int sex);
#endif
/* DEPRECATED!! USE edf_set_sex()
 * Sets the sex. 1 is male, 0 is female.
 * Returns 0 on success, otherwise -1
 * This function is optional and can be called only after opening a file in writemode
 * and before the first sample write action
 */
 
EDFLIB_API int edf_set_birthdate(int handle, int birthdate_year, int birthdate_month, int birthdate_day);
 
EDFLIB_API int edf_set_patient_additional(int handle, const char *patient_additional);
 
EDFLIB_API int edf_set_admincode(int handle, const char *admincode);
 
EDFLIB_API int edf_set_technician(int handle, const char *technician);
 
EDFLIB_API int edf_set_equipment(int handle, const char *equipment);
 
EDFLIB_API int edf_set_recording_additional(int handle, const char *recording_additional);
 
EDFLIB_API int edfwrite_physical_samples(int handle, double *buf);
 
EDFLIB_API int edf_blockwrite_physical_samples(int handle, double *buf);
 
EDFLIB_API int edfwrite_digital_short_samples(int handle, short *buf);
 
EDFLIB_API int edfwrite_digital_samples(int handle, int *buf);
 
EDFLIB_API int edf_blockwrite_digital_3byte_samples(int handle, void *buf);
 
EDFLIB_API int edf_blockwrite_digital_short_samples(int handle, short *buf);
 
EDFLIB_API int edf_blockwrite_digital_samples(int handle, int *buf);
 
EDFLIB_API int edfwrite_annotation_utf8_hr(int handle, long long onset, long long duration, const char *description);
 
#if defined(__GNUC__)
EDFLIB_API int edfwrite_annotation_utf8(int handle, long long onset, long long duration, const char *description) __attribute__ ((deprecated ("use edfwrite_annotation_utf8_hr()")));
#else
EDFLIB_API int edfwrite_annotation_utf8(int handle, long long onset, long long duration, const char *description);
#endif
/* DEPRECATED!! USE edfwrite_annotation_utf8_hr()
 * writes an annotation/event to the file
 * onset is relative to the start of the file
 * onset and duration are in units of 100 microseconds!     resolution is 0.0001 second!
 * for example: 34.071 seconds must be written as 340710
 * if duration is unknown or not applicable: set a negative number (-1)
 * description is a null-terminated UTF8-string containing the text that describes the event
 * This function is optional and can be called only after opening a file in writemode
 * and before closing the file
 */
 
EDFLIB_API int edfwrite_annotation_latin1_hr(int handle, long long onset, long long duration, const char *description);
 
#if defined(__GNUC__)
EDFLIB_API int edfwrite_annotation_latin1(int handle, long long onset, long long duration, const char *description) __attribute__ ((deprecated ("use edfwrite_annotation_latin1_hr()")));
#else
EDFLIB_API int edfwrite_annotation_latin1(int handle, long long onset, long long duration, const char *description);
#endif
/* DEPRECATED!! USE edfwrite_annotation_latin1_hr()
 * writes an annotation/event to the file
 * onset is relative to the start of the file
 * onset and duration are in units of 100 microseconds!     resolution is 0.0001 second!
 * for example: 34.071 seconds must be written as 340710
 * if duration is unknown or not applicable: set a negative number (-1)
 * description is a null-terminated Latin1-string containing the text that describes the event
 * This function is optional and can be called only after opening a file in writemode
 * and before closing the file
 */
 
EDFLIB_API int edf_set_datarecord_duration(int handle, int duration);
 
EDFLIB_API int edf_set_micro_datarecord_duration(int handle, int duration);
 
EDFLIB_API int edf_set_number_of_annotation_signals(int handle, int annot_signals);
 
EDFLIB_API int edf_set_subsecond_starttime(int handle, int subsecond);
 
EDFLIB_API int edf_set_annot_chan_idx_pos(int handle, int pos);
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif