initial commit

Project.toml

@@ -1,10 +1,14 @@
 name = "PortMidi"
 uuid = "42b16160-194f-40b3-8419-7a13c10fa643"
 authors = ["SteffenPL <steffen.plunder@web.de> and contributors"]
-version = "1.0.0-DEV"
+version = "0.1.0"
+
+[deps]
+PortMidi_jll = "6b227df9-c220-5195-838c-e1464939a66f"
 
 [compat]
 julia = "1.6"
+PortMidi_jll = "2.0.4"
 
 [extras]
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"

README.md

@@ -1,5 +1,61 @@
-# PortMidi
+# PortMidi.jl
 
+<!---
 [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://SteffenPL.github.io/PortMidi.jl/stable/)
 [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://SteffenPL.github.io/PortMidi.jl/dev/)
 [![Build Status](https://github.com/SteffenPL/PortMidi.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/SteffenPL/PortMidi.jl/actions/workflows/CI.yml?query=branch%3Amain)
+--->
+
+A Julia wrapper for the [PortMidi](https://github.com/PortMidi/portmidi). 
+See the [C documentation](https://portmidi.github.io/portmidi_docs/) for a list of functions. 
+
+_This wrapper is work in progress. As this is just a hobby for me, I am also happy to hand over the repository in more suitable hands._
+
+## Example
+
+See the `examples` folder for a test case. 
+
+```julia
+using PortMidi 
+
+Pm_Initialize()
+
+# 0. Get info about devices
+for i in 0:Pm_CountDevices()-1
+    info = unsafe_load(Pm_GetDeviceInfo(i))
+    println(i, ": ", info.output > 0 ? "[Output ] " : "[Input] ", unsafe_string(info.name), " (", unsafe_string(info.interf), ")")
+end
+
+# 1. Select device
+id = 0  # change this number if needed
+print("Use: ", unsafe_string(unsafe_load(Pm_GetDeviceInfo(id)).name))
+
+# 2. Open device 
+stream = Ref{Ptr{PortMidi.PortMidiStream}}(C_NULL)
+Pm_OpenOutput(stream, id, C_NULL, 0, C_NULL, C_NULL, 0)
+# don't forget to call later: Pm_Close(stream[])
+
+# 3. Send MIDI messages 
+Note_ON = 0x90
+Note_OFF = 0x80
+C4 = 60
+
+function play_note(stream, note, velocity, duration)
+    Pm_WriteShort(stream[], 0, Pm_Message(Note_ON, note, velocity))
+    sleep(duration)
+    Pm_WriteShort(stream[], 0, Pm_Message(Note_OFF, note, velocity))
+end
+
+# make a random tune...
+for i in 1:12
+    @async play_note(stream, C4 + rand([-5,-2,0,2,5]), rand(80:120), 0.4 + 0.05*rand())
+    sleep(0.5 + 0.05*rand())
+end
+
+# 4. Close device
+Pm_Close(stream[])
+```
+
+On Windows, one could use the program [loopMIDI](https://www.tobias-erichsen.de/software/loopmidi.html) to create a virtual MIDI device 
+and in combination with some virtual instruments (e.g. DAWs, VCV Rack, ...) one can also then listen to the notes in realtime. But this
+is only one out of many possible ways to use the `PortMidi` library.

examples/play_notes.jl

@@ -0,0 +1,38 @@
+using PortMidi 
+
+Pm_Initialize()
+
+# 0. Get info about devices
+for i in 0:Pm_CountDevices()-1
+    info = unsafe_load(Pm_GetDeviceInfo(i))
+    println(i, ": ", info.output > 0 ? "[Output ] " : "[Input] ", unsafe_string(info.name), " (", unsafe_string(info.interf), ")")
+end
+
+# 1. Select device
+id = 11
+print("Use: ", unsafe_string(unsafe_load(Pm_GetDeviceInfo(id)).name))
+
+# 2. Open device 
+stream = Ref{Ptr{PortMidi.PortMidiStream}}(C_NULL)
+Pm_OpenOutput(stream, id, C_NULL, 0, C_NULL, C_NULL, 0)
+# don't forget to call later: Pm_Close(stream[])
+
+# 3. Send MIDI messages 
+Note_ON = 0x90
+Note_OFF = 0x80
+C4 = 60
+
+function play_note(stream, note, velocity, duration)
+    Pm_WriteShort(stream[], 0, Pm_Message(Note_ON, note, velocity))
+    sleep(duration)
+    Pm_WriteShort(stream[], 0, Pm_Message(Note_OFF, note, velocity))
+end
+
+# make a random tune...
+for i in 1:12
+    @async play_note(stream, C4 + rand([-5,-2,0,2,5]), rand(80:120), 0.4 + 0.05*rand())
+    sleep(0.5 + 0.05*rand())
+end
+
+# 4. Close device
+Pm_Close(stream[])

gen/Manifest.toml

@@ -0,0 +1,178 @@
+# This file is machine-generated - editing it directly is not advised
+
+julia_version = "1.9.1"
+manifest_format = "2.0"
+project_hash = "40f0b0cca44e6451975797e90b2d06a0b8d8569a"
+
+[[deps.ArgTools]]
+uuid = "0dad84c5-d112-42e6-8d28-ef12dabb789f"
+version = "1.1.1"
+
+[[deps.Artifacts]]
+uuid = "56f22d72-fd6d-98f1-02f0-08ddc0907c33"
+
+[[deps.Base64]]
+uuid = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"
+
+[[deps.CEnum]]
+git-tree-sha1 = "389ad5c84de1ae7cf0e28e381131c98ea87d54fc"
+uuid = "fa961155-64e5-5f13-b03f-caf6b980ea82"
+version = "0.5.0"
+
+[[deps.Clang]]
+deps = ["CEnum", "Clang_jll", "Downloads", "Pkg", "TOML"]
+git-tree-sha1 = "846054622cb22aa63b5d51b5d84ec04b42d4d587"
+uuid = "40e3b903-d033-50b4-a0cc-940c62c95e31"
+version = "0.17.8"
+
+[[deps.Clang_jll]]
+deps = ["Artifacts", "JLLWrappers", "Libdl", "Pkg", "TOML", "Zlib_jll", "libLLVM_jll"]
+git-tree-sha1 = "124bb00d4ceace456054f17c7cb01e5c8195c609"
+uuid = "0ee61d77-7f21-5576-8119-9fcc46b10100"
+version = "14.0.6+4"
+
+[[deps.Dates]]
+deps = ["Printf"]
+uuid = "ade2ca70-3891-5945-98fb-dc099432e06a"
+
+[[deps.Downloads]]
+deps = ["ArgTools", "FileWatching", "LibCURL", "NetworkOptions"]
+uuid = "f43a241f-c20a-4ad4-852c-f6b1247861c6"
+version = "1.6.0"
+
+[[deps.FileWatching]]
+uuid = "7b1f6079-737a-58dc-b8bc-7a2ca5c1b5ee"
+
+[[deps.InteractiveUtils]]
+deps = ["Markdown"]
+uuid = "b77e0a4c-d291-57a0-90e8-8db25a27a240"
+
+[[deps.JLLWrappers]]
+deps = ["Artifacts", "Preferences"]
+git-tree-sha1 = "7e5d6779a1e09a36db2a7b6cff50942a0a7d0fca"
+uuid = "692b3bcd-3c85-4b1f-b108-f13ce0eb3210"
+version = "1.5.0"
+
+[[deps.LibCURL]]
+deps = ["LibCURL_jll", "MozillaCACerts_jll"]
+uuid = "b27032c2-a3e7-50c8-80cd-2d36dbcbfd21"
+version = "0.6.3"
+
+[[deps.LibCURL_jll]]
+deps = ["Artifacts", "LibSSH2_jll", "Libdl", "MbedTLS_jll", "Zlib_jll", "nghttp2_jll"]
+uuid = "deac9b47-8bc7-5906-a0fe-35ac56dc84c0"
+version = "7.84.0+0"
+
+[[deps.LibGit2]]
+deps = ["Base64", "NetworkOptions", "Printf", "SHA"]
+uuid = "76f85450-5226-5b5a-8eaa-529ad045b433"
+
+[[deps.LibSSH2_jll]]
+deps = ["Artifacts", "Libdl", "MbedTLS_jll"]
+uuid = "29816b5a-b9ab-546f-933c-edad1886dfa8"
+version = "1.10.2+0"
+
+[[deps.Libdl]]
+uuid = "8f399da3-3557-5675-b5ff-fb832c97cbdb"
+
+[[deps.Logging]]
+uuid = "56ddb016-857b-54e1-b83d-db4d58db5568"
+
+[[deps.Markdown]]
+deps = ["Base64"]
+uuid = "d6f4376e-aef5-505a-96c1-9c027394607a"
+
+[[deps.MbedTLS_jll]]
+deps = ["Artifacts", "Libdl"]
+uuid = "c8ffd9c3-330d-5841-b78e-0817d7145fa1"
+version = "2.28.2+0"
+
+[[deps.MozillaCACerts_jll]]
+uuid = "14a3606d-f60d-562e-9121-12d972cd8159"
+version = "2022.10.11"
+
+[[deps.NetworkOptions]]
+uuid = "ca575930-c2e3-43a9-ace4-1e988b2c1908"
+version = "1.2.0"
+
+[[deps.Pkg]]
+deps = ["Artifacts", "Dates", "Downloads", "FileWatching", "LibGit2", "Libdl", "Logging", "Markdown", "Printf", "REPL", "Random", "SHA", "Serialization", "TOML", "Tar", "UUIDs", "p7zip_jll"]
+uuid = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
+version = "1.9.0"
+
+[[deps.PortMidi_jll]]
+deps = ["Artifacts", "JLLWrappers", "Libdl", "alsa_jll"]
+git-tree-sha1 = "865436b433a7ed35ca02b5ef12a00ce29c75364b"
+uuid = "6b227df9-c220-5195-838c-e1464939a66f"
+version = "2.0.4+0"
+
+[[deps.Preferences]]
+deps = ["TOML"]
+git-tree-sha1 = "00805cd429dcb4870060ff49ef443486c262e38e"
+uuid = "21216c6a-2e73-6563-6e65-726566657250"
+version = "1.4.1"
+
+[[deps.Printf]]
+deps = ["Unicode"]
+uuid = "de0858da-6303-5e67-8744-51eddeeeb8d7"
+
+[[deps.REPL]]
+deps = ["InteractiveUtils", "Markdown", "Sockets", "Unicode"]
+uuid = "3fa0cd96-eef1-5676-8a61-b3b8758bbffb"
+
+[[deps.Random]]
+deps = ["SHA", "Serialization"]
+uuid = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
+
+[[deps.SHA]]
+uuid = "ea8e919c-243c-51af-8825-aaa63cd721ce"
+version = "0.7.0"
+
+[[deps.Serialization]]
+uuid = "9e88b42a-f829-5b0c-bbe9-9e923198166b"
+
+[[deps.Sockets]]
+uuid = "6462fe0b-24de-5631-8697-dd941f90decc"
+
+[[deps.TOML]]
+deps = ["Dates"]
+uuid = "fa267f1f-6049-4f14-aa54-33bafae1ed76"
+version = "1.0.3"
+
+[[deps.Tar]]
+deps = ["ArgTools", "SHA"]
+uuid = "a4e569a6-e804-4fa4-b0f3-eef7a1d5b13e"
+version = "1.10.0"
+
+[[deps.UUIDs]]
+deps = ["Random", "SHA"]
+uuid = "cf7118a7-6976-5b1a-9a39-7adc72f591a4"
+
+[[deps.Unicode]]
+uuid = "4ec0a83e-493e-50e2-b9ac-8f72acf5a8f5"
+
+[[deps.Zlib_jll]]
+deps = ["Libdl"]
+uuid = "83775a58-1f1d-513f-b197-d71354ab007a"
+version = "1.2.13+0"
+
+[[deps.alsa_jll]]
+deps = ["Artifacts", "JLLWrappers", "Libdl", "Pkg"]
+git-tree-sha1 = "69859a01e7735ce5b49b1328827f6e3f4cdd7d19"
+uuid = "45378030-f8ea-5b20-a7c7-1a9d95efb90e"
+version = "1.2.5+0"
+
+[[deps.libLLVM_jll]]
+deps = ["Artifacts", "Libdl"]
+uuid = "8f36deef-c2a5-5394-99ed-8e07531fb29a"
+version = "14.0.6+3"
+
+[[deps.nghttp2_jll]]
+deps = ["Artifacts", "Libdl"]
+uuid = "8e850ede-7688-5339-a07c-302acd2aaf8d"
+version = "1.48.0+0"
+
+[[deps.p7zip_jll]]
+deps = ["Artifacts", "Libdl"]
+uuid = "3f19e933-33d8-53b3-aaab-bd5110c3b7a0"
+version = "17.4.0+0"

gen/Project.toml

@@ -0,0 +1,3 @@
+[deps]
+Clang = "40e3b903-d033-50b4-a0cc-940c62c95e31"
+PortMidi_jll = "6b227df9-c220-5195-838c-e1464939a66f"

gen/epilogue.jl

@@ -0,0 +1,6 @@
+Pm_Message(status, data1, data2) = ((((data2) << 16) & 0xFF0000) | (((data1) << 8) & 0xFF00) | ((status) & 0xFF))
+Pm_MessageStatus(msg) = ((msg) & 0xFF)
+Pm_MessageData1(msg) = (((msg) >> 8) & 0xFF)
+Pm_MessageData2(msg) = (((msg) >> 16) & 0xFF)
+
+export Pm_Message, Pm_MessageStatus, Pm_MessageData1, Pm_MessageData2

gen/generate.jl

@@ -0,0 +1,14 @@
+using Clang.Generators
+using PortMidi_jll
+
+cd(@__DIR__)
+include_dir = normpath(PortMidi_jll.artifact_dir, "include")
+
+options = load_options(joinpath(@__DIR__, "generator.toml"))
+args = get_default_args()
+push!(args, "-I$include_dir")
+
+headers = detect_headers(include_dir, args)
+ctx = create_context(headers, args, options)
+
+build!(ctx)

gen/generator.toml

@@ -0,0 +1,15 @@
+[general]
+library_name = "libportmidi"
+output_file_path = "../src/PortMidi.jl"
+module_name = "PortMidi"
+jll_pkg_name = "PortMidi_jll"
+
+# use_julia_native_enum_type = true
+
+# prologue_file_path = "prologue.jl"
+# epilogue_file_path = "epilogue.jl"
+
+# export_symbol_prefixes = ["Pm"]
+# output_ignorelist = ["TRUE", "FALSE"]
+
+ignore_pure_definition = false

gen/prologue.jl

@@ -0,0 +1,2 @@
+to_c_type(::Type{<:AbstractString}) = Cstring # or Ptr{Cchar}
+to_c_type(t::Type{<:Union{AbstractArray,Ref}}) = Ptr{eltype(t)}