ogl_beamformer_lib_base.h (8768B)
1 /* See LICENSE for license details. */ 2 #ifndef BEAMFORMER_LIB_EXPORT 3 #if defined(_WIN32) 4 #define BEAMFORMER_LIB_EXPORT __declspec(dllexport) 5 #else 6 #define BEAMFORMER_LIB_EXPORT 7 #endif 8 #endif 9 10 #define BEAMFORMER_LIB_ERRORS \ 11 X(None, 0, "None") \ 12 X(VersionMismatch, 1, "host-library version mismatch") \ 13 X(InvalidAccess, 2, "library in invalid state") \ 14 X(ParameterBlockOverflow, 3, "parameter block count overflow") \ 15 X(ParameterBlockUnallocated, 4, "push to unallocated parameter block") \ 16 X(ComputeStageOverflow, 5, "compute stage overflow") \ 17 X(InvalidComputeStage, 6, "invalid compute shader stage") \ 18 X(InvalidStartShader, 7, "starting shader not Decode or Demodulate") \ 19 X(InvalidDemodulationDataKind, 8, "data kind for demodulation not Int16 or Float") \ 20 X(InvalidImagePlane, 9, "invalid image plane") \ 21 X(BufferOverflow, 10, "passed buffer size exceeds available space") \ 22 X(DataSizeMismatch, 11, "data size doesn't match the size specified in parameters") \ 23 X(WorkQueueFull, 12, "work queue full") \ 24 X(ExportSpaceOverflow, 13, "not enough space for data export") \ 25 X(SharedMemory, 14, "failed to open shared memory region") \ 26 X(SyncVariable, 15, "failed to acquire lock within timeout period") \ 27 X(InvalidFilterKind, 16, "invalid filter kind") \ 28 X(InvalidSimpleParameters, 17, "invalid simple parameters struct") 29 30 #define X(type, num, string) BeamformerLibErrorKind_##type = num, 31 typedef enum {BEAMFORMER_LIB_ERRORS} BeamformerLibErrorKind; 32 #undef X 33 34 BEAMFORMER_LIB_EXPORT uint32_t beamformer_get_api_version(void); 35 36 BEAMFORMER_LIB_EXPORT BeamformerLibErrorKind beamformer_get_last_error(void); 37 BEAMFORMER_LIB_EXPORT const char *beamformer_get_last_error_string(void); 38 BEAMFORMER_LIB_EXPORT const char *beamformer_error_string(BeamformerLibErrorKind kind); 39 40 /////////////////////////// 41 // NOTE: Simple API 42 /* Usage: 43 * - fill out a BeamformerSimpleParameters 44 * - filters need to be created with beamformer_create_filter, and the slot 45 * needs to be assigned in compute_stage_parameters 46 * - (Optional) allocate a buffer with enough space for all Float32 or Float32Complex output points 47 * - pass the data and parameters to beamformer_beamform_data() 48 * - pass 0 for out_data if you do not need the beamformed data returned 49 * - if the function was unsuccessful you can check the error with beamformer_get_last_error() 50 * or beamformer_get_last_error_string() 51 */ 52 BEAMFORMER_LIB_EXPORT uint32_t beamformer_beamform_data(BeamformerSimpleParameters *bp, void *data, 53 uint32_t data_size, void *out_data, 54 int32_t timeout_ms); 55 56 /* NOTE: sets timeout for all functions which may timeout but don't 57 * take a timeout argument. The majority of such functions will not 58 * timeout in the normal case and so passing a timeout parameter around 59 * every where is cumbersome. 60 * 61 * timeout_ms: milliseconds (Default: 0) 62 * 63 * IMPORTANT: timeout of -1 will block forever */ 64 BEAMFORMER_LIB_EXPORT void beamformer_set_global_timeout(uint32_t timeout_ms); 65 66 /////////////////////////// 67 // NOTE: Advanced API 68 69 /* NOTE: downloads the last 32 frames worth of compute timings into output */ 70 BEAMFORMER_LIB_EXPORT uint32_t beamformer_compute_timings(BeamformerComputeStatsTable *output, 71 int32_t timeout_ms); 72 73 /* NOTE: pushes data and tries to immediately starts a compute */ 74 BEAMFORMER_LIB_EXPORT uint32_t beamformer_push_data_with_compute(void *data, uint32_t size, 75 uint32_t image_plane_tag, 76 uint32_t parameter_slot); 77 78 /////////////////////////// 79 // Parameter Configuration 80 BEAMFORMER_LIB_EXPORT uint32_t beamformer_reserve_parameter_blocks(uint32_t count); 81 BEAMFORMER_LIB_EXPORT uint32_t beamformer_set_pipeline_stage_parameters(uint32_t stage_index, 82 int32_t parameter); 83 BEAMFORMER_LIB_EXPORT uint32_t beamformer_push_pipeline(int32_t *shaders, uint32_t shader_count, 84 BeamformerDataKind data_kind); 85 86 BEAMFORMER_LIB_EXPORT uint32_t beamformer_set_pipeline_stage_parameters_at(uint32_t stage_index, 87 int32_t parameter, 88 uint32_t parameter_slot); 89 BEAMFORMER_LIB_EXPORT uint32_t beamformer_push_pipeline_at(int32_t *shaders, uint32_t shader_count, 90 BeamformerDataKind data_kind, 91 uint32_t parameter_slot); 92 93 BEAMFORMER_LIB_EXPORT uint32_t beamformer_push_simple_parameters(BeamformerSimpleParameters *bp); 94 BEAMFORMER_LIB_EXPORT uint32_t beamformer_push_simple_parameters_at(BeamformerSimpleParameters *bp, 95 uint32_t parameter_slot); 96 97 BEAMFORMER_LIB_EXPORT uint32_t beamformer_push_parameters(BeamformerParameters *); 98 BEAMFORMER_LIB_EXPORT uint32_t beamformer_push_parameters_ui(BeamformerUIParameters *); 99 BEAMFORMER_LIB_EXPORT uint32_t beamformer_push_parameters_head(BeamformerParametersHead *); 100 101 BEAMFORMER_LIB_EXPORT uint32_t beamformer_push_parameters_at(BeamformerParameters *, 102 uint32_t parameter_slot); 103 104 BEAMFORMER_LIB_EXPORT uint32_t beamformer_push_channel_mapping(int16_t *mapping, uint32_t count); 105 BEAMFORMER_LIB_EXPORT uint32_t beamformer_push_channel_mapping_at(int16_t *mapping, uint32_t count, 106 uint32_t parameter_slot); 107 108 BEAMFORMER_LIB_EXPORT uint32_t beamformer_push_sparse_elements(int16_t *elements, uint32_t count); 109 BEAMFORMER_LIB_EXPORT uint32_t beamformer_push_sparse_elements_at(int16_t *elements, uint32_t count, 110 uint32_t parameter_slot); 111 112 BEAMFORMER_LIB_EXPORT uint32_t beamformer_push_focal_vectors(float *vectors, uint32_t count); 113 BEAMFORMER_LIB_EXPORT uint32_t beamformer_push_focal_vectors_at(float *vectors, uint32_t count, 114 uint32_t parameter_slot); 115 116 BEAMFORMER_LIB_EXPORT uint32_t beamformer_push_transmit_receive_orientations(uint8_t *values, 117 uint32_t count); 118 BEAMFORMER_LIB_EXPORT uint32_t beamformer_push_transmit_receive_orientations_at(uint8_t *values, 119 uint32_t count, 120 uint32_t parameter_slot); 121 122 //////////////////// 123 // Filter Creation 124 125 /* Kaiser Low-Pass Parameter Selection 126 * see: "Discrete Time Signal Processing" (Oppenheim) 127 * δ: fractional passband ripple 128 * ω_p: highest angular frequency of passband 129 * ω_s: lowest angular frequency of stopband 130 * ω_c: cutoff angular frequency. midpoint of ω_s and ω_p 131 * M: length of filter 132 * 133 * Define: A = -20log10(δ) 134 * β: 135 * β = 0.1102(A - 8.7) if 50 < A 136 * β = 0.5842 * pow(A - 21, 0.4) + 0.07886(A − 21) if 21 <= A <= 50 137 * β = 0 if A < 21 138 * M: 139 * M = (A - 8) / (2.285 (ω_s - ω_p)) 140 */ 141 142 BEAMFORMER_LIB_EXPORT uint32_t beamformer_create_filter(BeamformerFilterKind kind, 143 void *filter_parameters, uint32_t filter_size, 144 float sampling_frequency, uint32_t complex, 145 uint8_t filter_slot, uint8_t parameter_block); 146 147 ////////////////////////// 148 // Live Imaging Controls 149 BEAMFORMER_LIB_EXPORT int32_t beamformer_live_parameters_get_dirty_flag(void); 150 BEAMFORMER_LIB_EXPORT uint32_t beamformer_set_live_parameters(BeamformerLiveImagingParameters *); 151 BEAMFORMER_LIB_EXPORT BeamformerLiveImagingParameters *beamformer_get_live_parameters(void);