Swift bindings #716

ScottThomasMiller · 2024-04-21T09:13:11Z

CI for Swift bindings.

…tests

Andrey1994

Thanks a lot @ScottThomasMiller great job!

I wrote some comments, but overall its really good. It seems like theis some copypaste and duplicates, need to cleanup it first. And probably some files which should not be in the repo were added.

I will help you with docs update and will update the website with info about new language supported

run_unix.yml

src/board_controller/ant_neuro/build.cmake

swift_package/BrainFlow/Sources/BoardDescription.swift

swift_package/BrainFlow/Sources/BoardShim.swift

swift_package/BrainFlow/Tests/BrainFlowTests/BoardShimTests.swift

swift_package/BrainFlow/Tests/BrainFlowTests/BrainFlowCITests.swift

.../BrainFlowCI/BrainFlowCI.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist

...inFlowCI/BrainFlowCI.xcodeproj/project.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings

.../BrainFlowCI/BrainFlowCI.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved

ScottThomasMiller · 2024-05-03T19:39:25Z

Cleanup is complete. Build and CI are good. Should I open a new PR?

Andrey1994 · 2024-05-03T21:17:17Z

no, lets keep in this one, just push your changes to the same brach

ScottThomasMiller · 2024-05-03T22:34:14Z

All changes pushed. All checks passed. The PR is ready for your review.

Andrey1994

maybe this branch is not properly updated, but there are still a lot of unresolved comments

src/board_controller/build.cmake

src/board_controller/gtec/build.cmake

src/board_controller/muse/muse_bglib/build.cmake

src/board_controller/neuromd/brainbit_bglib/build.cmake

src/data_handler/build.cmake

src/ml/build.cmake

src/ml/onnx/build.cmake

src/utils/bluetooth/build.cmake

swift_package/BrainFlow/Sources/BrainFlow/dummy.swift

swift_package/BrainFlow/Tests/BrainFlowTests/BrainFlowTests.swift

Andrey1994 · 2024-05-11T23:55:11Z

Also need to rename examples from main.swift, here is a full list:

        deleted:    ../swift_package/examples/tests/band_power/main.swift
        deleted:    ../swift_package/examples/tests/band_power_all/main.swift
        deleted:    ../swift_package/examples/tests/denoising/main.swift
        deleted:    ../swift_package/examples/tests/downsampling/main.swift
        deleted:    ../swift_package/examples/tests/ica/main.swift
        deleted:    ../swift_package/examples/tests/read_write_file/main.swift
        deleted:    ../swift_package/examples/tests/signal_filtering/main.swift
        deleted:    ../swift_package/examples/tests/transforms/main.swift

Andrey1994 · 2024-05-12T00:25:19Z

I also merged master branch to this one and added docs about swift, would be good if you take a look and maybe add details how to build it using xcode. File is docs/BuildBrainFlow.rst

ScottThomasMiller · 2024-05-12T01:40:44Z

Due to a strange issue with Xcode, the example test files must be named main.swift, unless the test file contains ArgumentParser, in which case it must be named the same as the top-level struct (for example, eeg_metrics.) I can try to find a workaround. Maybe I can just add ArgumentParser to all of the tests, even the ones that don't actually need it?

I figured it out. I used the @main decorator instead of the main.swift filename.

ScottThomasMiller · 2024-05-12T11:09:39Z

I added instructions to docs/BuildBrainFlow.rst.

ScottThomasMiller · 2024-05-12T14:59:37Z

I made all of the updates except I have not yet changed the main.swift filenames. The build is failing at the following line:

  builtin-copy -exclude .DS_Store -exclude CVS -exclude .svn -exclude .git -exclude .hg -resolve-src-symlinks -rename /Users/runner/Library/Developer/Xcode/DerivedData/BrainFlowCI-hfqdqfivnwvgoqhhucaczbqmqols/Build/Intermediates.noindex/ArchiveIntermediates/band_power/IntermediateBuildFilesPath/BrainFlowCI.build/Release/band_power.build/Objects-normal/arm64/band_power.swiftdoc /Users/runner/Library/Developer/Xcode/DerivedData/BrainFlowCI-hfqdqfivnwvgoqhhucaczbqmqols/Build/Intermediates.noindex/ArchiveIntermediates/band_power/BuildProductsPath/Release/band_power.swiftmodule/arm64-apple-macos.swiftdoc

Error: Process completed with exit code 65.

Andrey1994 · 2024-05-12T16:52:08Z

I think you are missing hidden conversations, there are more comments if you expand them

Andrey1994 · 2024-05-12T16:53:00Z

for example - https://github.com/brainflow-dev/brainflow/pull/716/files/a2c526a09dd43e391bd59be5fa4af2407091acf7#r1575460864 if you scroll messages in this PR and expand hidden conversations you will see this

ScottThomasMiller · 2024-05-12T17:18:14Z

Indeed I did! I am working on the missed comments now.

ScottThomasMiller · 2024-05-14T21:38:07Z

The build is clean except for this error:

Deploy Cpp libs / CppUnix (Debug, macos-11.0)
Cancelled

I'm not sure what that's from. My swift_package CI looks good; no errors. I think the only thing remaining are the comments for the docs. I will work on that next.

Andrey1994

Most important remaining fixes are: create a package and do not copypaste files in users apps, and fix code style, there are more details in comments

Andrey1994 · 2024-05-19T18:48:27Z

docs/BuildBrainFlow.rst

+
+You can build the Swift bindings for BrainFlow using Xcode. Before that you need to compile C/C++ code :ref:`compilation-label` and ensure that native libraries are properly placed. Keep in mind that currently it supports only MacOS.
+
+To compile your Swift app with the BrainFlow bindings, first copy all of the .swift files from swift_package/BrainFlow/Sources/BrainFlowBindings into your Xcode project:


copypasting files is not good, I actually thought that its smth like package. e.g. https://www.swiftyplace.com/blog/modular-code-with-swift-package-manager
Can also publish it on github packages later on. BrainFlowCI should use it as a package also

Creating the package is an important feature, but it is also a challenge and will take a while. I've tried several times over the years but failed each time. I will most likely have to open a help ticket with Apple Developer Support. I cannot promise a delivery date for this feature.

https://developer.apple.com/documentation/xcode/creating-a-standalone-swift-package-with-xcode here is a good guide how to create it, I believe the 1st step should be to separate BrainFlowCI and BrainFlowBinding to different projects, create a package like described in the article and after that try to use this package in CI apps

Andrey1994 · 2024-05-19T18:50:25Z

swift_package/BrainFlowCI/BrainFlowBindings/BoardDescription.swift

+    var temperature_channels: [Int32] = [Int32]()
+
+    // decode the input JSON into self:
+    init(_ descriptionJSON: String?) throws {


if you've added a special method fromJSON, why do we still have regulat constructor from json string?

Not sure. I will take a look at removing the constructor.

Andrey1994 · 2024-05-19T18:50:51Z

swift_package/BrainFlowCI/BrainFlowBindings/BoardShim.swift

+    let bfParams: BrainFlowInputParams
+    private let jsonBrainFlowInputParams: [CChar]
+
+    /*


remove commented out code block

I think this one is already resolved. I do not see the commented code block in my local repo.

https://github.com/ScottThomasMiller/brainflow/blob/swift-bindings/swift_package/BrainFlowCI/BrainFlowBindings/BoardShim.swift#L16 its here

Andrey1994 · 2024-05-19T18:52:09Z

swift_package/BrainFlowCI/BrainFlowBindings/BoardShim.swift

+    init (_ boardId: BoardIds, _ params: BrainFlowInputParams) throws {
+        self.boardId = boardId
+        self.bfParams = params
+        self.masterBoardId = try BoardShim.getMasterBoardID(boardId: boardId, params: params)


this method is called getBoardID in all other bindings

I have both getBoardID and getMasterBoardID. I can make getMasterBoardID a private func, so that it is not available outside the bindings. Will that work?

getBoardId should return master board id for streaming and playback and normal board id for everything else. Having both is confusing

But if its used only inside binding its probably ok

Andrey1994 · 2024-05-19T18:54:12Z

swift_package/BrainFlowCI/BrainFlowBindings/BoardShim.swift

+    static func eegNames (_ boardId: BoardIds, _ preset: BrainFlowPresets = .DEFAULT_PRESET) throws -> [String] {
+        var stringLen: Int32 = 0
+        var bytes = [CChar](repeating: 0, count: 4096)
+        let errorCode = get_eeg_names (boardId.rawValue, preset.rawValue, &bytes, &stringLen)


not consistent code style, in some lines there are spaces before ( in some lines not, I am ok with both options in swift binding as long as its uniform. You can take one of the tools from this thread and apply it - https://forums.swift.org/t/swift-source-code-formatting-tool-like-clang-format-for-objective-c/416

Do you mean the space between get_eeg_names and '('? I prefer no space. I can remove the spaces if you prefer.

yes, and its in plenty of places if you take a look carefully. Removing this manually is not good since you will waste more time doing it and more likely will miss smth. For C++ we use clang-format tool which formats code automatically, would be good to run formatter on the entire binding and force consistent code style this way

like in the method below there is getBoardDescr (_ and get_board_descr ( and no space in other lines in the same method

Andrey1994 · 2024-05-19T18:56:51Z

swift_package/BrainFlowCI/BrainFlowBindings/BoardShim.swift

+    }
+
+    /// If the board is streaming or playback, then return the board ID itself. Otherwise return the master board ID.
+    static func getMasterBoardID(boardId: BoardIds, params: BrainFlowInputParams) throws -> BoardIds {


make this method private or rename to getBoardId and make it non static(other bindings have getBoardId method)

ScottThomasMiller added 30 commits April 17, 2024 20:38

Swift Bindings with updated cmake files and standalone executable CI …

e2d0f24

…tests

trying to fix build error from SPM

00ab3b3

removed Package.resolved and xcode clean commands

d376386

removed BrainFlowCITests.swift from all targets

6f751b3

removed all references to BrainFlowTests

b81e571

set exact version of swift-argument-parser

ec5faa5

set exact version of swift-argument-parser to 1.2.0

c9e699b

using destination OS X

1f25c6a

platform=macOS, arch=x86_64

0e47557

removed space from destination parameter

26bd97e

removed code signing

19960d4

added Frameworks directory and updated gitignore

d94cce8

added cp commands for the Frameworks subdirectory

6bdb626

added arm64 and updated simpleble make file

f255cf2

removed arm64 destination

cd2921a

using xcodebuild install

ab3ed47

embed without signing and copy-on-install

dfbade1

pared-down yml for expedited troubleshooting

4e646ad

added troubleshooting ls and otool commands

41371de

added troubleshooting ls and otool commands take II

25002c3

unchecked copy on install

e29e21a

troubleshooting image not found error

7c1a543

added runpath search paths

192b959

changed embedding location to executables

a3d1137

commented out ls commands

950fe6f

add ls install

b350a25

disabled library validation

9caaefb

disable library validation for all

56884af

re-added build commands

7b46896

reverted run unix to confirm all other CI is OK

3f05e05

ScottThomasMiller added 2 commits April 20, 2024 21:02

really reverted it this time

fbaaa7c

known good Swift CI

a2c526a

Andrey1994 reviewed Apr 22, 2024

View reviewed changes

cleanup for initial PR

9982ba8

Andrey1994 reviewed May 9, 2024

View reviewed changes

swift_package/BrainFlow/Tests/BrainFlowTests/BrainFlowTests.swift Outdated Show resolved Hide resolved

Andrey1994 mentioned this pull request May 9, 2024

Create new release #718

Closed

Merge branch 'master' into swift-bindings

322c29c

finished cleanup

ba868be

ScottThomasMiller added 2 commits May 12, 2024 22:49

PR cleanup third pass

42ceaf4

fixed linker error

8d8050f

Andrey1994 requested changes May 19, 2024

View reviewed changes

Andrey1994 closed this Nov 17, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Swift bindings #716

Swift bindings #716

ScottThomasMiller commented Apr 21, 2024

Andrey1994 left a comment

ScottThomasMiller commented May 3, 2024

Andrey1994 commented May 3, 2024 •

edited

Loading

ScottThomasMiller commented May 3, 2024

Andrey1994 left a comment

Andrey1994 commented May 11, 2024

Andrey1994 commented May 12, 2024

ScottThomasMiller commented May 12, 2024 •

edited

Loading

ScottThomasMiller commented May 12, 2024

ScottThomasMiller commented May 12, 2024

Andrey1994 commented May 12, 2024

Andrey1994 commented May 12, 2024

ScottThomasMiller commented May 12, 2024

ScottThomasMiller commented May 14, 2024

Andrey1994 left a comment

Andrey1994 May 19, 2024

ScottThomasMiller May 27, 2024

Andrey1994 May 27, 2024

Andrey1994 May 19, 2024

ScottThomasMiller May 27, 2024

Andrey1994 May 19, 2024

ScottThomasMiller May 27, 2024

Andrey1994 May 27, 2024

Andrey1994 May 19, 2024

ScottThomasMiller May 27, 2024

Andrey1994 May 27, 2024

Andrey1994 May 27, 2024

Andrey1994 May 19, 2024

ScottThomasMiller May 27, 2024

Andrey1994 May 27, 2024

Andrey1994 May 27, 2024

Andrey1994 May 19, 2024

ScottThomasMiller May 27, 2024


		You can build the Swift bindings for BrainFlow using Xcode. Before that you need to compile C/C++ code :ref:`compilation-label` and ensure that native libraries are properly placed. Keep in mind that currently it supports only MacOS.

		To compile your Swift app with the BrainFlow bindings, first copy all of the .swift files from swift_package/BrainFlow/Sources/BrainFlowBindings into your Xcode project:

Swift bindings #716

Swift bindings #716

Conversation

ScottThomasMiller commented Apr 21, 2024

Andrey1994 left a comment

Choose a reason for hiding this comment

ScottThomasMiller commented May 3, 2024

Andrey1994 commented May 3, 2024 • edited Loading

ScottThomasMiller commented May 3, 2024

Andrey1994 left a comment

Choose a reason for hiding this comment

Andrey1994 commented May 11, 2024

Andrey1994 commented May 12, 2024

ScottThomasMiller commented May 12, 2024 • edited Loading

ScottThomasMiller commented May 12, 2024

ScottThomasMiller commented May 12, 2024

Andrey1994 commented May 12, 2024

Andrey1994 commented May 12, 2024

ScottThomasMiller commented May 12, 2024

ScottThomasMiller commented May 14, 2024

Andrey1994 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Andrey1994 commented May 3, 2024 •

edited

Loading

ScottThomasMiller commented May 12, 2024 •

edited

Loading