rusty_link 0.4.9

Rust bindings for Ableton Link through the official C Wrapper (abl_link)
Documentation
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
/* Copyright 2021, Ableton AG, Berlin. All rights reserved.
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 *  If you would like to incorporate Link into a proprietary software application,
 *  please contact <link-devs@ableton.com>.
 */

#include <abl_link.h>
#include <ableton/LinkAudio.hpp>

#include <algorithm>
#include <cstdlib>
#include <cstring>
#include <string>

namespace
{
struct abl_link_audio_channel_id toChannelId(const ableton::link_audio::Id &id)
{
  struct abl_link_audio_channel_id out{};
  std::copy(id.begin(), id.end(), out.bytes);
  return out;
}

struct abl_link_audio_peer_id toPeerId(const ableton::link_audio::Id &id)
{
  struct abl_link_audio_peer_id out{};
  std::copy(id.begin(), id.end(), out.bytes);
  return out;
}

struct abl_link_audio_session_id toSessionId(const ableton::link_audio::Id &id)
{
  struct abl_link_audio_session_id out{};
  std::copy(id.begin(), id.end(), out.bytes);
  return out;
}

ableton::link_audio::Id toCppChannelId(const struct abl_link_audio_channel_id &id)
{
  ableton::link_audio::Id out{};
  std::copy(id.bytes, id.bytes + sizeof(id.bytes), out.begin());
  return out;
}

ableton::link_audio::Id toCppSessionId(const struct abl_link_audio_session_id &id)
{
  ableton::link_audio::Id out{};
  std::copy(id.bytes, id.bytes + sizeof(id.bytes), out.begin());
  return out;
}

char *copyCString(const std::string &value)
{
  auto *buffer = static_cast<char *>(std::malloc(value.size() + 1));
  if (buffer)
  {
    std::memcpy(buffer, value.c_str(), value.size() + 1);
  }
  return buffer;
}

size_t copyStringToBuffer(const std::string &src, char *buffer, size_t buffer_size)
{
  if (buffer && buffer_size > 0)
  {
    const auto toCopy = std::min(buffer_size - 1, src.size());
    std::memcpy(buffer, src.c_str(), toCopy);
    buffer[toCopy] = '\0';
  }
  return src.size();
}
} // namespace

extern "C"
{
  struct abl_link abl_link_create(double bpm)
  {
    return {reinterpret_cast<void *>(new ableton::LinkAudio(bpm, std::string{}))};
  }

  void abl_link_destroy(struct abl_link link)
  {
    delete reinterpret_cast<ableton::LinkAudio *>(link.impl);
  }

  bool abl_link_is_enabled(struct abl_link link)
  {
    return reinterpret_cast<ableton::LinkAudio *>(link.impl)->isEnabled();
  }

  void abl_link_enable(struct abl_link link, bool enabled)
  {
    reinterpret_cast<ableton::LinkAudio *>(link.impl)->enable(enabled);
  }

  bool abl_link_is_start_stop_sync_enabled(struct abl_link link)
  {
    return reinterpret_cast<ableton::LinkAudio *>(link.impl)->isStartStopSyncEnabled();
  }

  void abl_link_enable_start_stop_sync(struct abl_link link, bool enabled)
  {
    reinterpret_cast<ableton::LinkAudio *>(link.impl)->enableStartStopSync(enabled);
  }

  uint64_t abl_link_num_peers(struct abl_link link)
  {
    return reinterpret_cast<ableton::LinkAudio *>(link.impl)->numPeers();
  }

  void abl_link_set_num_peers_callback(struct abl_link link,
    void (*callback)(uint64_t num_peers, void *context),
    void *context)
  {
    reinterpret_cast<ableton::LinkAudio *>(link.impl)->setNumPeersCallback(
      [callback, context](std::size_t numPeers)
      { (*callback)(static_cast<uint64_t>(numPeers), context); });
  }

  void abl_link_set_tempo_callback(
    struct abl_link link, void (*callback)(double tempo, void *context), void *context)
  {
    reinterpret_cast<ableton::LinkAudio *>(link.impl)->setTempoCallback(
      [callback, context](double tempo) { (*callback)(tempo, context); });
  }

  void abl_link_set_start_stop_callback(
    struct abl_link link, void (*callback)(bool isPlaying, void *context), void *context)
  {
    reinterpret_cast<ableton::LinkAudio *>(link.impl)->setStartStopCallback(
      [callback, context](bool isPlaying) { (*callback)(isPlaying, context); });
  }

  int64_t abl_link_clock_micros(struct abl_link link)
  {
    return reinterpret_cast<ableton::LinkAudio *>(link.impl)->clock().micros().count();
  }

  abl_link_session_state abl_link_create_session_state(void)
  {
    return abl_link_session_state{reinterpret_cast<void *>(
      new ableton::Link::SessionState{ableton::link::ApiState{}, {}})};
  }

  void abl_link_destroy_session_state(abl_link_session_state session_state)
  {
    delete reinterpret_cast<ableton::Link::SessionState *>(session_state.impl);
  }

  void abl_link_capture_app_session_state(
    struct abl_link link, abl_link_session_state session_state)
  {
    *reinterpret_cast<ableton::Link::SessionState *>(session_state.impl) =
      reinterpret_cast<ableton::LinkAudio *>(link.impl)->captureAppSessionState();
  }

  void abl_link_commit_app_session_state(
    struct abl_link link, abl_link_session_state session_state)
  {
    reinterpret_cast<ableton::LinkAudio *>(link.impl)->commitAppSessionState(
      *reinterpret_cast<ableton::Link::SessionState *>(session_state.impl));
  }

  void abl_link_capture_audio_session_state(
    struct abl_link link, abl_link_session_state session_state)
  {
    *reinterpret_cast<ableton::Link::SessionState *>(session_state.impl) =
      reinterpret_cast<ableton::LinkAudio *>(link.impl)->captureAudioSessionState();
  }

  void abl_link_commit_audio_session_state(
    struct abl_link link, abl_link_session_state session_state)
  {
    reinterpret_cast<ableton::LinkAudio *>(link.impl)->commitAudioSessionState(
      *reinterpret_cast<ableton::Link::SessionState *>(session_state.impl));
  }

  double abl_link_tempo(abl_link_session_state session_state)
  {
    return reinterpret_cast<ableton::Link::SessionState *>(session_state.impl)->tempo();
  }

  void abl_link_set_tempo(
    abl_link_session_state session_state, double bpm, int64_t at_time)
  {
    reinterpret_cast<ableton::Link::SessionState *>(session_state.impl)
      ->setTempo(bpm, std::chrono::microseconds{at_time});
  }

  double abl_link_beat_at_time(
    abl_link_session_state session_state, int64_t time, double quantum)
  {
    auto micros = std::chrono::microseconds{time};
    return reinterpret_cast<ableton::Link::SessionState *>(session_state.impl)
      ->beatAtTime(micros, quantum);
  }

  double abl_link_phase_at_time(
    abl_link_session_state session_state, int64_t time, double quantum)
  {
    return reinterpret_cast<ableton::Link::SessionState *>(session_state.impl)
      ->phaseAtTime(std::chrono::microseconds{time}, quantum);
  }

  int64_t abl_link_time_at_beat(
    abl_link_session_state session_state, double beat, double quantum)
  {
    return reinterpret_cast<ableton::Link::SessionState *>(session_state.impl)
      ->timeAtBeat(beat, quantum)
      .count();
  }

  void abl_link_request_beat_at_time(
    abl_link_session_state session_state, double beat, int64_t time, double quantum)
  {
    reinterpret_cast<ableton::Link::SessionState *>(session_state.impl)
      ->requestBeatAtTime(beat, std::chrono::microseconds{time}, quantum);
  }

  void abl_link_force_beat_at_time(
    abl_link_session_state session_state, double beat, int64_t time, double quantum)
  {
    reinterpret_cast<ableton::Link::SessionState *>(session_state.impl)
      ->forceBeatAtTime(beat, std::chrono::microseconds{time}, quantum);
  }

  void abl_link_set_is_playing(
    abl_link_session_state session_state, bool is_playing, int64_t time)
  {
    reinterpret_cast<ableton::Link::SessionState *>(session_state.impl)
      ->setIsPlaying(is_playing, std::chrono::microseconds(time));
  }

  bool abl_link_is_playing(abl_link_session_state session_state)
  {
    return reinterpret_cast<ableton::Link::SessionState *>(session_state.impl)
      ->isPlaying();
  }

  int64_t abl_link_time_for_is_playing(abl_link_session_state session_state)
  {
    return static_cast<int64_t>(
      reinterpret_cast<ableton::Link::SessionState *>(session_state.impl)
        ->timeForIsPlaying()
        .count());
  }

  void abl_link_request_beat_at_start_playing_time(
    abl_link_session_state session_state, double beat, double quantum)
  {
    reinterpret_cast<ableton::Link::SessionState *>(session_state.impl)
      ->requestBeatAtStartPlayingTime(beat, quantum);
  }

  void abl_link_set_is_playing_and_request_beat_at_time(
    abl_link_session_state session_state,
    bool is_playing,
    int64_t time,
    double beat,
    double quantum)
  {
    reinterpret_cast<ableton::Link::SessionState *>(session_state.impl)
      ->setIsPlayingAndRequestBeatAtTime(
        is_playing, std::chrono::microseconds{time}, beat, quantum);
  }

  bool abl_link_audio_is_link_audio_enabled(struct abl_link link)
  {
    return reinterpret_cast<ableton::LinkAudio *>(link.impl)->isLinkAudioEnabled();
  }

  void abl_link_audio_enable_link_audio(struct abl_link link, bool enabled)
  {
    reinterpret_cast<ableton::LinkAudio *>(link.impl)->enableLinkAudio(enabled);
  }

  size_t abl_link_audio_peer_name(struct abl_link link, char *buffer, size_t buffer_size)
  {
    return copyStringToBuffer(
      reinterpret_cast<ableton::LinkAudio *>(link.impl)->peerName(), buffer, buffer_size);
  }

  void abl_link_audio_set_peer_name(struct abl_link link, const char *name)
  {
    reinterpret_cast<ableton::LinkAudio *>(link.impl)->setPeerName(name);
  }

  struct abl_link_audio_channel_list abl_link_audio_get_channels(struct abl_link link)
  {
    struct abl_link_audio_channel_list result{};
    const auto channels = reinterpret_cast<ableton::LinkAudio *>(link.impl)->channels();
    result.count = channels.size();
    if (result.count == 0)
    {
      return result;
    }

    result.channels = static_cast<struct abl_link_audio_channel *>(
      std::calloc(result.count, sizeof(struct abl_link_audio_channel)));
    if (!result.channels)
    {
      result.count = 0;
      return result;
    }

    for (size_t i = 0; i < result.count; ++i)
    {
      const auto &channel = channels[i];
      result.channels[i].id = toChannelId(channel.id);
      result.channels[i].peer_id = toPeerId(channel.peerId);
      result.channels[i].name = copyCString(channel.name);
      result.channels[i].peer_name = copyCString(channel.peerName);
    }

    return result;
  }

  void abl_link_audio_free_channel_list(struct abl_link_audio_channel_list list)
  {
    if (!list.channels)
    {
      return;
    }
    for (size_t i = 0; i < list.count; ++i)
    {
      std::free(const_cast<char *>(list.channels[i].name));
      std::free(const_cast<char *>(list.channels[i].peer_name));
    }
    std::free(list.channels);
  }

  void abl_link_audio_set_channels_changed_callback(
    struct abl_link link, void (*callback)(void *context), void *context)
  {
    reinterpret_cast<ableton::LinkAudio *>(link.impl)->setChannelsChangedCallback(
      [callback, context]()
      {
        if (callback)
        {
          (*callback)(context);
        }
      });
  }

  struct abl_link_audio_sink abl_link_audio_sink_create(
    struct abl_link link, const char *name, size_t max_num_samples)
  {
    return {reinterpret_cast<void *>(new ableton::LinkAudioSink(
      *reinterpret_cast<ableton::LinkAudio *>(link.impl), name, max_num_samples))};
  }

  void abl_link_audio_sink_destroy(struct abl_link_audio_sink sink)
  {
    delete reinterpret_cast<ableton::LinkAudioSink *>(sink.impl);
  }

  size_t abl_link_audio_sink_name(
    struct abl_link_audio_sink sink, char *buffer, size_t buffer_size)
  {
    return copyStringToBuffer(
      reinterpret_cast<ableton::LinkAudioSink *>(sink.impl)->name(), buffer, buffer_size);
  }

  void abl_link_audio_sink_set_name(struct abl_link_audio_sink sink, const char *name)
  {
    reinterpret_cast<ableton::LinkAudioSink *>(sink.impl)->setName(name);
  }

  void abl_link_audio_sink_request_max_num_samples(
    struct abl_link_audio_sink sink, size_t num_samples)
  {
    reinterpret_cast<ableton::LinkAudioSink *>(sink.impl)->requestMaxNumSamples(
      num_samples);
  }

  size_t abl_link_audio_sink_max_num_samples(struct abl_link_audio_sink sink)
  {
    return reinterpret_cast<ableton::LinkAudioSink *>(sink.impl)->maxNumSamples();
  }

  struct abl_link_audio_sink_buffer_handle abl_link_audio_sink_retain_buffer(
    struct abl_link_audio_sink sink)
  {
    struct abl_link_audio_sink_buffer_handle result{};
    auto *cppSink = reinterpret_cast<ableton::LinkAudioSink *>(sink.impl);
    auto *cppHandle = new ableton::LinkAudioSink::BufferHandle(*cppSink);
    result.impl = cppHandle;
    result.samples = cppHandle->samples;
    result.max_num_samples = cppHandle->maxNumSamples;
    return result;
  }

  bool abl_link_audio_sink_buffer_is_valid(
    const struct abl_link_audio_sink_buffer_handle *handle)
  {
    if (!handle || !handle->impl)
    {
      return false;
    }
    const auto *cppHandle =
      reinterpret_cast<const ableton::LinkAudioSink::BufferHandle *>(handle->impl);
    return static_cast<bool>(*cppHandle);
  }

  bool abl_link_audio_sink_buffer_commit(struct abl_link_audio_sink_buffer_handle *handle,
    abl_link_session_state session_state,
    double beats_at_buffer_begin,
    double quantum,
    size_t num_frames,
    size_t num_channels,
    uint32_t sample_rate)
  {
    if (!handle || !handle->impl)
    {
      return false;
    }
    auto *cppHandle =
      reinterpret_cast<ableton::LinkAudioSink::BufferHandle *>(handle->impl);
    const auto *state =
      reinterpret_cast<ableton::Link::SessionState *>(session_state.impl);
    const auto result = cppHandle->commit(
      *state, beats_at_buffer_begin, quantum, num_frames, num_channels, sample_rate);
    delete cppHandle;
    handle->impl = nullptr;
    handle->samples = nullptr;
    handle->max_num_samples = 0;
    return result;
  }

  void abl_link_audio_sink_buffer_release(
    struct abl_link_audio_sink_buffer_handle *handle)
  {
    if (!handle || !handle->impl)
    {
      return;
    }
    delete reinterpret_cast<ableton::LinkAudioSink::BufferHandle *>(handle->impl);
    handle->impl = nullptr;
    handle->samples = nullptr;
    handle->max_num_samples = 0;
  }

  bool abl_link_audio_source_buffer_info_begin_beats(
    const struct abl_link_audio_source_buffer_info *info,
    abl_link_session_state session_state,
    double quantum,
    double *out_beats)
  {
    if (!info || !out_beats || !session_state.impl)
    {
      return false;
    }
    if (info->sample_rate == 0)
    {
      return false;
    }
    auto cppInfo = ableton::LinkAudioSource::BufferHandle::Info{};
    cppInfo.numChannels = info->num_channels;
    cppInfo.numFrames = info->num_frames;
    cppInfo.sampleRate = info->sample_rate;
    cppInfo.count = info->count;
    cppInfo.sessionBeatTime = info->session_beat_time;
    cppInfo.tempo = info->tempo;
    cppInfo.sessionId = toCppSessionId(info->session_id);

    const auto *state =
      reinterpret_cast<const ableton::Link::SessionState *>(session_state.impl);
    const auto beats = cppInfo.beginBeats(*state, quantum);
    if (!beats)
    {
      return false;
    }
    *out_beats = *beats;
    return true;
  }

  bool abl_link_audio_source_buffer_info_end_beats(
    const struct abl_link_audio_source_buffer_info *info,
    abl_link_session_state session_state,
    double quantum,
    double *out_beats)
  {
    if (!info || !out_beats || !session_state.impl)
    {
      return false;
    }
    if (info->sample_rate == 0)
    {
      return false;
    }
    auto cppInfo = ableton::LinkAudioSource::BufferHandle::Info{};
    cppInfo.numChannels = info->num_channels;
    cppInfo.numFrames = info->num_frames;
    cppInfo.sampleRate = info->sample_rate;
    cppInfo.count = info->count;
    cppInfo.sessionBeatTime = info->session_beat_time;
    cppInfo.tempo = info->tempo;
    cppInfo.sessionId = toCppSessionId(info->session_id);

    const auto *state =
      reinterpret_cast<const ableton::Link::SessionState *>(session_state.impl);
    const auto beats = cppInfo.endBeats(*state, quantum);
    if (!beats)
    {
      return false;
    }
    *out_beats = *beats;
    return true;
  }

  struct abl_link_audio_source abl_link_audio_source_create(struct abl_link link,
    struct abl_link_audio_channel_id channel_id,
    void (*callback)(const struct abl_link_audio_source_buffer *buffer, void *context),
    void *context)
  {
    auto *cppLink = reinterpret_cast<ableton::LinkAudio *>(link.impl);
    const auto id = toCppChannelId(channel_id);
    return {reinterpret_cast<void *>(new ableton::LinkAudioSource(*cppLink, id,
      [callback, context](ableton::LinkAudioSource::BufferHandle handle)
      {
        if (!callback)
        {
          return;
        }
        struct abl_link_audio_source_buffer buffer{};
        buffer.samples = handle.samples;
        buffer.info.num_channels = handle.info.numChannels;
        buffer.info.num_frames = handle.info.numFrames;
        buffer.info.sample_rate = handle.info.sampleRate;
        buffer.info.count = handle.info.count;
        buffer.info.session_beat_time = handle.info.sessionBeatTime;
        buffer.info.tempo = handle.info.tempo;
        buffer.info.session_id = toSessionId(handle.info.sessionId);
        callback(&buffer, context);
      }))};
  }

  void abl_link_audio_source_destroy(struct abl_link_audio_source source)
  {
    delete reinterpret_cast<ableton::LinkAudioSource *>(source.impl);
  }

  struct abl_link_audio_channel_id abl_link_audio_source_id(
    struct abl_link_audio_source source)
  {
    if (!source.impl)
    {
      struct abl_link_audio_channel_id empty{};
      return empty;
    }
    return toChannelId(reinterpret_cast<ableton::LinkAudioSource *>(source.impl)->id());
  }
}