-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathbarelymusician.h
1986 lines (1773 loc) · 65.7 KB
/
barelymusician.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#ifndef BARELYMUSICIAN_BARELYMUSICIAN_H_
#define BARELYMUSICIAN_BARELYMUSICIAN_H_
// NOLINTBEGIN
#include <stdbool.h>
#include <stdint.h>
#if defined(_WIN32) || defined(__CYGWIN__)
#ifdef BARELYMUSICIAN_EXPORTS
#ifdef __GNUC__
#define BARELY_EXPORT __attribute__((dllexport))
#else // __GNUC__
#define BARELY_EXPORT __declspec(dllexport)
#endif // __GNUC__
#else // BARELYMUSICIAN_EXPORTS
#ifdef __GNUC__
#define BARELY_EXPORT __attribute__((dllimport))
#else // __GNUC__
#define BARELY_EXPORT __declspec(dllimport)
#endif // __GNUC__
#endif // BARELYMUSICIAN_EXPORTS
#else // defined(_WIN32) || defined(__CYGWIN__)
#if __GNUC__ >= 4
#define BARELY_EXPORT __attribute__((visibility("default")))
#else // __GNUC__ >= 4
#define BARELY_EXPORT
#endif // __GNUC__ >= 4
#endif // defined(_WIN32) || defined(__CYGWIN__)
/// ====================
/// barelymusician C API
/// ====================
///
/// barelymusician is a real-time music engine for interactive systems. It is
/// used to generate and perform musical sounds from scratch in a sample
/// accurate way.
///
/// @note To use barelymusician in a C++ project, see the C++ API below.
///
/// -------------
/// Example usage
/// -------------
///
/// - Musician:
///
/// @code{.cpp}
/// #include "barelymusician/barelymusician.h"
///
/// // Create.
/// BarelyMusicianHandle handle;
/// BarelyMusician_Create(&handle);
///
/// // Set the tempo.
/// BarelyMusician_SetTempo(handle, /*tempo=*/124.0);
///
/// // Update the timestamp.
/// //
/// // Timestamp updates must happen prior to processing of instruments for
/// // the respective timestamps. Otherwise, those process calls will be
/// // *late* to receive any relevant state changes. Therefore, this should
/// // typically be called from a main thread update callback with an
/// // additional "lookahead" in order to compensate for the potential thread
/// // synchronization issues in real-time audio applications.
/// double timestamp = 1.0;
/// BarelyMusician_Update(handle, timestamp);
///
/// // Destroy.
/// BarelyMusician_Destroy(handle);
/// @endcode
///
/// - Instrument:
///
/// @code{.cpp}
/// #include "barelymusician/instruments/synth_instrument.h"
///
/// // Create.
/// BarelyId instrument_id = BarelyId_kInvalid;
/// BarelyInstrument_Create(handle, BarelySynthInstrument_GetDefinition(),
/// /*frame_rate=*/48000, &instrument_id);
///
/// // Set a note on.
/// //
/// // Pitch values are normalized, where each `1.0` shifts one octave, and
/// // `0.0` represents the middle A (A4) for a typical instrument definition.
/// // However, this is not a strict rule, since both `pitch` and `intensity`
/// // values can be interpreted in any desired way by a custom instrument.
/// BarelyInstrument_SetNoteOn(handle, instrument_id, /*pitch=*/-1.0,
/// /*intensity=*/0.25);
///
/// // Check if the note is on.
/// bool is_note_on = false;
/// BarelyInstrument_IsNoteOn(handle, instrument_id, /*pitch=*/-1.0,
/// &is_note_on);
///
/// // Set a control value.
/// BarelyInstrument_SetControl(handle, instrument_id,
/// BarelySynthControl_kGain,
/// /*value=*/0.5, /*slope_per_beat=*/0.0);
///
/// // Process.
/// //
/// // Instruments expect raw PCM audio buffer to be processed with a
/// // synchronous call. Therefore, this should typically be called from an
/// // audio thread process callback in real-time audio applications.
/// double output_samples[2 * 1024];
/// int output_channel_count = 2;
/// int output_frame_count = 1024;
/// double timestamp = 0.0;
/// BarelyInstrument_Process(handle, instrument_id, output_samples,
/// output_channel_count, output_frame_count,
/// timestamp);
///
/// // Destroy.
/// BarelyInstrument_Destroy(handle, instrument_id);
/// @endcode
///
/// - Performer:
///
/// @code{.cpp}
/// // Create.
/// BarelyId performer_id = BarelyId_kInvalid;
/// BarelyPerformer_Create(handle, &performer_id);
///
/// // Create a task.
/// BarelyTaskDefinition definition; // populate this.
/// BarelyId task_id = BarelyId_kInvalid;
/// BarelyPerformer_CreateTask(handle, performer_id, definition,
/// /*is_one_off=*/false, /*position=*/0.0,
/// /*process_order=*/0, /*user_data=*/nullptr,
/// &task_id);
///
/// // Set looping on.
/// BarelyPerformer_SetLooping(handle, performer_id, /*is_looping=*/true);
///
/// // Start.
/// BarelyPerformer_Start(handle, performer_id);
///
/// // Check if started playing.
/// bool is_playing = false;
/// BarelyPerformer_IsPlaying(handle, performer_id, &is_playing);
///
/// // Destroy the task.
/// BarelyPerformer_DestroyTask(handle, performer_id, task_id);
///
/// // Destroy.
/// BarelyPerformer_Destroy(handle, performer_id);
/// @endcode
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
/// Musician handle.
typedef struct BarelyMusician* BarelyMusicianHandle;
/// Identifier alias.
typedef int64_t BarelyId;
/// Identifier values.
enum BarelyId_Values {
/// Invalid identifier.
BarelyId_kInvalid = 0,
};
/// Status enum alias.
typedef int32_t BarelyStatus;
/// Status enum values.
enum BarelyStatus_Values {
/// Success.
BarelyStatus_kOk = 0,
/// Invalid argument error.
BarelyStatus_kInvalidArgument = 1,
/// Not found error.
BarelyStatus_kNotFound = 2,
/// Unimplemented error.
BarelyStatus_kUnimplemented = 3,
/// Internal error.
BarelyStatus_kInternal = 4,
};
/// Instrument control event callback signature.
///
/// @param index Control index.
/// @param value Control value.
/// @param user_data Pointer to user data.
typedef void (*BarelyInstrument_ControlEventCallback)(int32_t index,
double value,
void* user_data);
/// Instrument note control event callback signature.
///
/// @param pitch Note pitch.
/// @param index Note control index.
/// @param value Note control value.
/// @param user_data Pointer to user data.
typedef void (*BarelyInstrument_NoteControlEventCallback)(double pitch,
int32_t index,
double value,
void* user_data);
/// Instrument note off event callback signature.
///
/// @param pitch Note pitch.
/// @param user_data Pointer to user data.
typedef void (*BarelyInstrument_NoteOffEventCallback)(double pitch,
void* user_data);
/// Instrument note on event callback signature.
///
/// @param pitch Note pitch.
/// @param intensity Note intensity.
/// @param user_data Pointer to user data.
typedef void (*BarelyInstrument_NoteOnEventCallback)(double pitch,
double intensity,
void* user_data);
/// Instrument definition create callback signature.
///
/// @param state Pointer to instrument state.
/// @param frame_rate Frame rate in hertz.
typedef void (*BarelyInstrumentDefinition_CreateCallback)(void** state,
int32_t frame_rate);
/// Instrument definition destroy callback signature.
///
/// @param state Pointer to instrument state.
typedef void (*BarelyInstrumentDefinition_DestroyCallback)(void** state);
/// Instrument definition process callback signature.
///
/// @param state Pointer to instrument state.
/// @param output_samples Array of output samples.
/// @param output_channel_count Number of output channels.
/// @param output_frame_count Number of output frames.
typedef void (*BarelyInstrumentDefinition_ProcessCallback)(
void** state, double* output_samples, int32_t output_channel_count,
int32_t output_frame_count);
/// Instrument definition set control callback signature.
///
/// @param state Pointer to instrument state.
/// @param index Control index.
/// @param value Control value.
/// @param slope_per_frame Control slope in value change per frame.
typedef void (*BarelyInstrumentDefinition_SetControlCallback)(
void** state, int32_t index, double value, double slope_per_frame);
/// Instrument definition set data callback signature.
///
/// @param state Pointer to instrument state.
/// @param data Pointer to immutable data.
/// @param size Data size in bytes.
typedef void (*BarelyInstrumentDefinition_SetDataCallback)(void** state,
const void* data,
int32_t size);
/// Instrument definition set note control callback signature.
///
/// @param state Pointer to instrument state.
/// @param pitch Note pitch.
/// @param index Note control index.
/// @param value Note control value.
/// @param slope_per_frame Note control slope in value change per frame.
typedef void (*BarelyInstrumentDefinition_SetNoteControlCallback)(
void** state, double pitch, int32_t index, double value,
double slope_per_frame);
/// Instrument definition set note off callback signature.
///
/// @param state Pointer to instrument state.
/// @param pitch Note pitch.
typedef void (*BarelyInstrumentDefinition_SetNoteOffCallback)(void** state,
double pitch);
/// Instrument definition set note on callback signature.
///
/// @param state Pointer to instrument state.
/// @param pitch Note pitch.
/// @param intensity Note intensity.
typedef void (*BarelyInstrumentDefinition_SetNoteOnCallback)(void** state,
double pitch,
double intensity);
/// Task definition create callback signature.
///
/// @param state Pointer to task state.
/// @param user_data Pointer to user data.
typedef void (*BarelyTaskDefinition_CreateCallback)(void** state,
void* user_data);
/// Task definition destroy callback signature.
///
/// @param state Pointer to task state.
typedef void (*BarelyTaskDefinition_DestroyCallback)(void** state);
/// Task definition process callback signature.
///
/// @param state Pointer to task state.
typedef void (*BarelyTaskDefinition_ProcessCallback)(void** state);
/// Control definition.
typedef struct BarelyControlDefinition {
/// Default value.
double default_value;
/// Minimum value.
double min_value;
/// Maximum value.
double max_value;
} BarelyControlDefinition;
/// Instrument definition.
typedef struct BarelyInstrumentDefinition {
/// Create callback.
BarelyInstrumentDefinition_CreateCallback create_callback;
/// Destroy callback.
BarelyInstrumentDefinition_DestroyCallback destroy_callback;
/// Process callback.
BarelyInstrumentDefinition_ProcessCallback process_callback;
/// Set control callback.
BarelyInstrumentDefinition_SetControlCallback set_control_callback;
/// Set data callback.
BarelyInstrumentDefinition_SetDataCallback set_data_callback;
/// Set note control callback.
BarelyInstrumentDefinition_SetNoteControlCallback set_note_control_callback;
/// Set note off callback.
BarelyInstrumentDefinition_SetNoteOffCallback set_note_off_callback;
/// Set note on callback.
BarelyInstrumentDefinition_SetNoteOnCallback set_note_on_callback;
/// Array of control definitions.
const BarelyControlDefinition* control_definitions;
/// Number of control definitions.
int32_t control_definition_count;
/// Array of note control definitions.
const BarelyControlDefinition* note_control_definitions;
/// Number of note control definitions.
int32_t note_control_definition_count;
} BarelyInstrumentDefinition;
/// Task definition.
typedef struct BarelyTaskDefinition {
/// Create callback.
BarelyTaskDefinition_CreateCallback create_callback;
/// Destroy callback.
BarelyTaskDefinition_DestroyCallback destroy_callback;
/// Process callback.
BarelyTaskDefinition_ProcessCallback process_callback;
} BarelyTaskDefinition;
/// Creates a new instrument.
///
/// @param handle Musician handle.
/// @param definition Instrument definition.
/// @param frame_rate Frame rate in hertz.
/// @param out_instrument_id Output instrument identifier.
/// @return Status.
BARELY_EXPORT BarelyStatus BarelyInstrument_Create(
BarelyMusicianHandle handle, BarelyInstrumentDefinition definition,
int32_t frame_rate, BarelyId* out_instrument_id);
/// Destroys an instrument.
///
/// @param handle Musician handle.
/// @param instrument_id Instrument identifier.
/// @return Status.
BARELY_EXPORT BarelyStatus BarelyInstrument_Destroy(BarelyMusicianHandle handle,
BarelyId instrument_id);
/// Gets an instrument control value.
///
/// @param handle Musician handle.
/// @param instrument_id Instrument identifier.
/// @param index Control index.
/// @param out_value Output control value.
/// @return Status.
BARELY_EXPORT BarelyStatus
BarelyInstrument_GetControl(BarelyMusicianHandle handle, BarelyId instrument_id,
int32_t index, double* out_value);
/// Gets an instrument note control value.
///
/// @param handle Musician handle.
/// @param instrument_id Instrument identifier.
/// @param pitch Note pitch.
/// @param index Note control index.
/// @param out_value Output note control value.
/// @return Status.
BARELY_EXPORT BarelyStatus BarelyInstrument_GetNoteControl(
BarelyMusicianHandle handle, BarelyId instrument_id, double pitch,
int32_t index, double* out_value);
/// Gets whether an instrument note is on or not.
///
/// @param handle Musician handle.
/// @param instrument_id Instrument identifier.
/// @param pitch Note pitch.
/// @param out_is_note_on Output true if on, false otherwise.
/// @return Status.
BARELY_EXPORT BarelyStatus
BarelyInstrument_IsNoteOn(BarelyMusicianHandle handle, BarelyId instrument_id,
double pitch, bool* out_is_note_on);
/// Processes instrument output samples at timestamp.
///
/// @param handle Musician handle.
/// @param instrument_id Instrument identifier.
/// @param output_samples Array of interleaved output samples.
/// @param output_channel_count Number of output channels.
/// @param output_frame_count Number of output frames.
/// @param timestamp Timestamp in seconds.
/// @return Status.
BARELY_EXPORT BarelyStatus BarelyInstrument_Process(
BarelyMusicianHandle handle, BarelyId instrument_id, double* output_samples,
int32_t output_channel_count, int32_t output_frame_count, double timestamp);
/// Resets all instrument control values.
///
/// @param handle Musician handle.
/// @param instrument_id Instrument identifier.
/// @return Status.
BARELY_EXPORT BarelyStatus BarelyInstrument_ResetAllControls(
BarelyMusicianHandle handle, BarelyId instrument_id);
/// Resets all instrument note control values.
///
/// @param handle Musician handle.
/// @param instrument_id Instrument identifier.
/// @param pitch Note pitch.
/// @return Status.
BARELY_EXPORT BarelyStatus BarelyInstrument_ResetAllNoteControls(
BarelyMusicianHandle handle, BarelyId instrument_id, double pitch);
/// Resets an instrument control value.
///
/// @param handle Musician handle.
/// @param instrument_id Instrument identifier.
/// @param index Control index.
/// @return Status.
BARELY_EXPORT BarelyStatus BarelyInstrument_ResetControl(
BarelyMusicianHandle handle, BarelyId instrument_id, int32_t index);
/// Resets an instrument note control value.
///
/// @param handle Musician handle.
/// @param instrument_id Instrument identifier.
/// @param pitch Note pitch.
/// @param index Note control index.
/// @return Status.
BARELY_EXPORT BarelyStatus BarelyInstrument_ResetNoteControl(
BarelyMusicianHandle handle, BarelyId instrument_id, double pitch,
int32_t index);
/// Sets all instrument notes off.
///
/// @param handle Musician handle.
/// @param instrument_id Instrument identifier.
/// @return Status.
BARELY_EXPORT BarelyStatus BarelyInstrument_SetAllNotesOff(
BarelyMusicianHandle handle, BarelyId instrument_id);
/// Sets an instrument control value.
///
/// @param handle Musician handle.
/// @param instrument_id Instrument identifier.
/// @param index Control index.
/// @param value Control value.
/// @param slope_per_beat Control slope in value change per beat.
/// @return Status.
BARELY_EXPORT BarelyStatus
BarelyInstrument_SetControl(BarelyMusicianHandle handle, BarelyId instrument_id,
int32_t index, double value, double slope_per_beat);
/// Sets the control event callback of an instrument.
///
/// @param handle Musician handle.
/// @param instrument_id Instrument identifier.
/// @param callback Control event callback.
/// @param user_data Pointer to user data.
/// @return Status.
BARELY_EXPORT BarelyStatus BarelyInstrument_SetControlEventCallback(
BarelyMusicianHandle handle, BarelyId instrument_id,
BarelyInstrument_ControlEventCallback callback, void* user_data);
/// Sets instrument data.
///
/// @param handle Musician handle.
/// @param instrument_id Instrument identifier.
/// @param data Pointer to immutable data.
/// @param size Data size in bytes.
/// @return Status.
BARELY_EXPORT BarelyStatus BarelyInstrument_SetData(BarelyMusicianHandle handle,
BarelyId instrument_id,
const void* data,
int32_t size);
/// Sets an instrument note control value.
///
/// @param handle Musician handle.
/// @param instrument_id Instrument identifier.
/// @param pitch Note pitch.
/// @param index Note control index.
/// @param value Note control value.
/// @param slope_per_beat Note control slope in value change per beat.
/// @return Status.
BARELY_EXPORT BarelyStatus BarelyInstrument_SetNoteControl(
BarelyMusicianHandle handle, BarelyId instrument_id, double pitch,
int32_t index, double value, double slope_per_beat);
/// Sets the note control event callback of an instrument.
///
/// @param handle Musician handle.
/// @param instrument_id Instrument identifier.
/// @param callback Note control event callback.
/// @param user_data Pointer to user data.
/// @return Status.
BARELY_EXPORT BarelyStatus BarelyInstrument_SetNoteControlEventCallback(
BarelyMusicianHandle handle, BarelyId instrument_id,
BarelyInstrument_NoteControlEventCallback callback, void* user_data);
/// Sets an instrument note off.
///
/// @param handle Musician handle.
/// @param instrument_id Instrument identifier.
/// @param pitch Note pitch.
/// @return Status.
BARELY_EXPORT BarelyStatus BarelyInstrument_SetNoteOff(
BarelyMusicianHandle handle, BarelyId instrument_id, double pitch);
/// Sets the note off event callback of an instrument.
///
/// @param handle Musician handle.
/// @param instrument_id Instrument identifier.
/// @param callback Note off event callback.
/// @param user_data Pointer to user data.
/// @return Status.
BARELY_EXPORT BarelyStatus BarelyInstrument_SetNoteOffEventCallback(
BarelyMusicianHandle handle, BarelyId instrument_id,
BarelyInstrument_NoteOffEventCallback callback, void* user_data);
/// Sets an instrument note on.
///
/// @param handle Musician handle.
/// @param instrument_id Instrument identifier.
/// @param pitch Note pitch.
/// @param intensity Note intensity.
/// @return Status.
BARELY_EXPORT BarelyStatus
BarelyInstrument_SetNoteOn(BarelyMusicianHandle handle, BarelyId instrument_id,
double pitch, double intensity);
/// Sets the note on event callback of an instrument.
///
/// @param handle Musician handle.
/// @param instrument_id Instrument identifier.
/// @param callback Note on event callback.
/// @param user_data Pointer to user data.
/// @return Status.
BARELY_EXPORT BarelyStatus BarelyInstrument_SetNoteOnEventCallback(
BarelyMusicianHandle handle, BarelyId instrument_id,
BarelyInstrument_NoteOnEventCallback callback, void* user_data);
/// Creates a new musician.
///
/// @param out_handle Output musician handle.
/// @return Status.
BARELY_EXPORT BarelyStatus
BarelyMusician_Create(BarelyMusicianHandle* out_handle);
/// Destroys a musician.
///
/// @param handle Musician handle.
/// @return Status.
BARELY_EXPORT BarelyStatus BarelyMusician_Destroy(BarelyMusicianHandle handle);
/// Gets the tempo of a musician.
///
/// @param handle Musician handle.
/// @param out_tempo Output tempo in beats per minute.
/// @return Status.
BARELY_EXPORT BarelyStatus BarelyMusician_GetTempo(BarelyMusicianHandle handle,
double* out_tempo);
/// Gets the timestamp of a musician.
///
/// @param handle Musician handle.
/// @param out_timestamp Output timestamp in seconds.
/// @return Status.
BARELY_EXPORT BarelyStatus
BarelyMusician_GetTimestamp(BarelyMusicianHandle handle, double* out_timestamp);
/// Sets the tempo of a musician.
///
/// @param handle Musician handle.
/// @param tempo Tempo in beats per minute.
/// @return Status.
BARELY_EXPORT BarelyStatus BarelyMusician_SetTempo(BarelyMusicianHandle handle,
double tempo);
/// Updates a musician at timestamp.
///
/// @param handle Musician handle.
/// @param timestamp Timestamp in seconds.
/// @return Status.
BARELY_EXPORT BarelyStatus BarelyMusician_Update(BarelyMusicianHandle handle,
double timestamp);
/// Creates a new performer.
///
/// @param handle Musician handle.
/// @param out_performer_id Output performer identifier.
/// @return Status.
BARELY_EXPORT BarelyStatus BarelyPerformer_Create(BarelyMusicianHandle handle,
BarelyId* out_performer_id);
/// Creates a new performer task.
///
/// @param handle Musician handle.
/// @param performer_id Performer identifier.
/// @param definition Task definition.
/// @param is_one_off True if one-off task, false otherwise.
/// @param position Task position in beats.
/// @param process_order Task process order.
/// @param user_data Pointer to user data.
/// @param out_task_id Output task identifier.
/// @return Status.
BARELY_EXPORT BarelyStatus BarelyPerformer_CreateTask(
BarelyMusicianHandle handle, BarelyId performer_id,
BarelyTaskDefinition definition, bool is_one_off, double position,
int32_t process_order, void* user_data, BarelyId* out_task_id);
/// Destroys a performer.
///
/// @param handle Musician handle.
/// @param performer_id Performer identifier.
/// @return Status.
BARELY_EXPORT BarelyStatus BarelyPerformer_Destroy(BarelyMusicianHandle handle,
BarelyId performer_id);
/// Destroys a performer task.
///
/// @param handle Musician handle.
/// @param performer_id Performer identifier.
/// @param task_id Task identifier.
/// @return Status.
BARELY_EXPORT BarelyStatus BarelyPerformer_DestroyTask(
BarelyMusicianHandle handle, BarelyId performer_id, BarelyId task_id);
/// Gets the loop begin position of a performer.
///
/// @param handle Musician handle.
/// @param performer_id Performer identifier.
/// @param out_loop_begin_position Output loop begin position in beats.
/// @return Status.
BARELY_EXPORT BarelyStatus BarelyPerformer_GetLoopBeginPosition(
BarelyMusicianHandle handle, BarelyId performer_id,
double* out_loop_begin_position);
/// Gets the loop length of a performer.
///
/// @param handle Musician handle.
/// @param performer_id Performer identifier.
/// @param out_loop_length Output loop length.
/// @return Status.
BARELY_EXPORT BarelyStatus
BarelyPerformer_GetLoopLength(BarelyMusicianHandle handle,
BarelyId performer_id, double* out_loop_length);
/// Gets the position of a performer.
///
/// @param handle Musician handle.
/// @param performer_id Performer identifier.
/// @param out_position Output position in beats.
/// @return Status.
BARELY_EXPORT BarelyStatus BarelyPerformer_GetPosition(
BarelyMusicianHandle handle, BarelyId performer_id, double* out_position);
/// Gets the position of a performer task.
///
/// @param handle Musician handle.
/// @param performer_id Performer identifier.
/// @param task_id Task identifier.
/// @param out_position Output position in beats.
/// @return Status.
BARELY_EXPORT BarelyStatus BarelyPerformer_GetTaskPosition(
BarelyMusicianHandle handle, BarelyId performer_id, BarelyId task_id,
double* out_position);
/// Gets the process order of a performer task.
///
/// @param handle Musician handle.
/// @param performer_id Performer identifier.
/// @param task_id Task identifier.
/// @param out_process_order Output process order.
/// @return Status.
BARELY_EXPORT BarelyStatus BarelyPerformer_GetTaskProcessOrder(
BarelyMusicianHandle handle, BarelyId performer_id, BarelyId task_id,
int32_t* out_process_order);
/// Gets whether a performer is looping or not.
///
/// @param handle Musician handle.
/// @param performer_id Performer identifier.
/// @param out_is_looping Output true if looping, false otherwise.
/// @return Status.
BARELY_EXPORT BarelyStatus BarelyPerformer_IsLooping(
BarelyMusicianHandle handle, BarelyId performer_id, bool* out_is_looping);
/// Gets whether a performer is playing or not.
///
/// @param handle Musician handle.
/// @param performer_id Performer identifier.
/// @param out_is_playing Output true if playing, false otherwise.
/// @return Status.
BARELY_EXPORT BarelyStatus BarelyPerformer_IsPlaying(
BarelyMusicianHandle handle, BarelyId performer_id, bool* out_is_playing);
/// Sets the loop begin position of a performer.
///
/// @param handle Musician handle.
/// @param performer_id Performer identifier.
/// @param loop_begin_position Loop begin position in beats.
/// @return Status.
BARELY_EXPORT BarelyStatus BarelyPerformer_SetLoopBeginPosition(
BarelyMusicianHandle handle, BarelyId performer_id,
double loop_begin_position);
/// Sets the loop length of a performer.
///
/// @param handle Musician handle.
/// @param performer_id Performer identifier.
/// @param loop_length Loop length in beats.
/// @return Status.
BARELY_EXPORT BarelyStatus BarelyPerformer_SetLoopLength(
BarelyMusicianHandle handle, BarelyId performer_id, double loop_length);
/// Sets whether a performer is looping or not.
///
/// @param handle Musician handle.
/// @param performer_id Performer identifier.
/// @param is_looping True if looping, false otherwise.
/// @return Status.
BARELY_EXPORT BarelyStatus BarelyPerformer_SetLooping(
BarelyMusicianHandle handle, BarelyId performer_id, bool is_looping);
/// Sets the position of a performer.
///
/// @param handle Musician handle.
/// @param performer_id Performer identifier.
/// @param position Position in beats.
/// @return Status.
BARELY_EXPORT BarelyStatus BarelyPerformer_SetPosition(
BarelyMusicianHandle handle, BarelyId performer_id, double position);
/// Sets the position of a performer task.
///
/// @param handle Musician handle.
/// @param performer_id Performer identifier.
/// @param task_id Task identifier.
/// @param position Position in beats.
/// @return Status.
BARELY_EXPORT BarelyStatus BarelyPerformer_SetTaskPosition(
BarelyMusicianHandle handle, BarelyId performer_id, BarelyId task_id,
double position);
/// Sets the process order of a performer task.
///
/// @param handle Musician handle.
/// @param performer_id Performer identifier.
/// @param task_id Task identifier.
/// @param process_order Process order.
/// @return Status.
BARELY_EXPORT BarelyStatus BarelyPerformer_SetTaskProcessOrder(
BarelyMusicianHandle handle, BarelyId performer_id, BarelyId task_id,
int32_t process_order);
/// Starts a performer.
///
/// @param handle Musician handle.
/// @param performer_id Performer identifier.
/// @return Status.
BARELY_EXPORT BarelyStatus BarelyPerformer_Start(BarelyMusicianHandle handle,
BarelyId performer_id);
/// Stops a performer.
///
/// @param handle Musician handle.
/// @param performer_id Performer identifier.
/// @return Status.
BARELY_EXPORT BarelyStatus BarelyPerformer_Stop(BarelyMusicianHandle handle,
BarelyId performer_id);
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
// NOLINTEND
#ifdef __cplusplus
#include <cassert>
#include <compare>
#include <functional>
#include <limits>
#include <memory>
#include <span>
#include <string>
#include <type_traits>
#include <utility>
#include <variant>
/// ======================
/// barelymusician C++ API
/// ======================
///
/// barelymusician is a real-time music engine for interactive systems. It is
/// used to generate and perform musical sounds from scratch in a sample
/// accurate way.
///
/// -------------
/// Example usage
/// -------------
///
/// - Musician:
///
/// @code{.cpp}
/// #include "barelymusician/barelymusician.h"
///
/// // Create.
/// barely::Musician musician;
///
/// // Set the tempo.
/// musician.SetTempo(/*tempo=*/124.0);
///
/// // Update the timestamp.
/// //
/// // Timestamp updates must happen prior to processing of instruments for
/// // the respective timestamps. Otherwise, those process calls will be
/// // *late* to receive any relevant state changes. Therefore, this should
/// // typically be called from a main thread update callback with an
/// // additional "lookahead" in order to compensate for the potential thread
/// // synchronization issues in real-time audio applications.
/// double timestamp = 1.0;
/// musician.Update(timestamp);
/// @endcode
///
/// - Instrument:
///
/// @code{.cpp}
/// #include "barelymusician/instruments/synth_instrument.h"
///
/// // Create.
/// auto instrument =
/// musician.CreateInstrument(barely::SynthInstrument::GetDefinition(),
/// /*frame_rate=*/48000);
///
/// // Set a note on.
/// //
/// // Pitch values are normalized, where each `1.0` shifts one octave, and
/// // `0.0` represents the middle A (A4) for a typical instrument definition.
/// // However, this is not a strict rule, since both `pitch` and `intensity`
/// // values can be interpreted in any desired way by a custom instrument.
/// instrument.SetNoteOn(/*pitch=*/-1.0, /*intensity=*/0.25);
///
/// // Check if the note is on.
/// const bool is_note_on = instrument.IsNoteOn(/*pitch=*/-1.0);
///
/// // Set a control value.
/// instrument.SetControl(barely::SynthControl::kGain, /*value=*/0.5,
/// /*slope_per_beat=*/0.0);
///
/// // Process.
/// //
/// // Instruments expect raw PCM audio buffer to be processed with a
/// // synchronous call. Therefore, this should typically be called from an
/// // audio thread process callback in real-time audio applications.
/// const int output_channel_count = 2;
/// const int output_frame_count = 1024;
/// std::vector<double> output_samples(
/// output_channel_count * output_frame_count, 0.0);
/// double timestamp = 0.0;
/// instrument.Process(output_samples.data(), output_channel_count,
/// output_frame_count, timestamp);
/// @endcode
///
/// - Performer:
///
/// @code{.cpp}
/// // Create.
/// auto performer = musician.CreatePerformer();
///
/// // Create a task.
/// auto task = performer.CreateTask([]() {}, // populate this.
/// /*is_one_off=*/false, /*position=*/0.0,
/// /*process_order=*/0);
///
/// // Set looping on.
/// performer.SetLooping(/*is_looping=*/true);
///
/// // Start.
/// performer.Start();
///
/// // Check if started playing.
/// const bool is_playing = performer.IsPlaying();
///
/// // Destroy the task.
/// performer.DestroyTask(task);
/// @endcode
namespace barely {
/// Status.
class Status {
public:
/// Enum values.
enum Enum : BarelyStatus {
/// Success.
kOk = BarelyStatus_kOk,
/// Invalid argument error.
kInvalidArgument = BarelyStatus_kInvalidArgument,
/// Not found error.
kNotFound = BarelyStatus_kNotFound,
/// Unimplemented error.
kUnimplemented = BarelyStatus_kUnimplemented,
/// Internal error.
kRaw = BarelyStatus_kInternal,
};
/// Returns a new `Status` with `Status::kOk`.
///
/// @return Status.
static Status Ok() noexcept { return Status(Status::kOk); }
/// Returns a new `Status` with `Status::kInvalidArgument`.
///
/// @return Status.
static Status InvalidArgument() noexcept { return Status::kInvalidArgument; }
/// Returns a new `Status` with `Status::kNotFound`.
///
/// @return Status.
static Status NotFound() noexcept { return Status::kNotFound; }
/// Returns a new `Status` with `Status::kUnimplemented`.
///
/// @return Status.
static Status Unimplemented() noexcept { return Status::kUnimplemented; }
/// Returns a new `Status` with `Status::kRaw`.
///
/// @return Status.
static Status Raw() noexcept { return Status::kRaw; }
/// Constructs a new `Status`.
///
/// @param status Status enum.
// NOLINTNEXTLINE(google-explicit-constructor)
Status(Enum status) noexcept : status_(status) {}
/// Constructs a new `Status` from a raw type.
///
/// @param status Raw status enum.
// NOLINTNEXTLINE(google-explicit-constructor)
Status(BarelyStatus status) noexcept : status_(static_cast<Enum>(status)) {}
/// Returns the enum value.
///
/// @return Enum value.
// NOLINTNEXTLINE(google-explicit-constructor)
operator Enum() const noexcept { return status_; }
/// Enum comparators.
auto operator<=>(Enum status) const noexcept { return status_ <=> status; }
/// Returns whether the status is okay or not.
///
/// @return True if okay, false otherwise.
[[nodiscard]] bool IsOk() const noexcept { return status_ == kOk; }
/// Returns the status string.
///
/// @return Status string.
[[nodiscard]] std::string ToString() const noexcept {
switch (status_) {
case kOk:
return "Ok";
case kInvalidArgument:
return "Invalid argument error";