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