Skip to content

Commit 33ba267

Browse files
NoarkhhNoarkhh
authored
Merge pull request #1 from membraneframework-labs/add-basic-functionality
Add basic functionality
2 parents 64aedf7 + cf0c0a3 commit 33ba267

File tree

8 files changed

+460
-43
lines changed

8 files changed

+460
-43
lines changed

‎.circleci/config.yml‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
version: 2.1
2+
orbs:
3+
elixir: membraneframework/elixir@1
4+
5+
workflows:
6+
build:
7+
jobs:
8+
- elixir/build_test:
9+
filters: &filters
10+
tags:
11+
only: /v.*/
12+
- elixir/test:
13+
filters:
14+
<<: *filters
15+
- elixir/lint:
16+
filters:
17+
<<: *filters
18+
- elixir/hex_publish:
19+
requires:
20+
- elixir/build_test
21+
- elixir/test
22+
- elixir/lint
23+
context:
24+
- Deployment
25+
filters:
26+
branches:
27+
ignore: /.*/
28+
tags:
29+
only: /v.*/

‎LICENSE‎

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright 2023 Software Mansion
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎README.md‎

Lines changed: 64 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
1-
# MembranePrecompiledDependencyProvider
1+
# Membrane Precompiled Dependency Provider
22

3-
**TODO: Add description**
3+
[![Hex.pm](https://img.shields.io/hexpm/v/membrane_precompiled_dependency_provider.svg)](https://hex.pm/packages/membrane_precompiled_dependency_provider)
4+
[![API Docs](https://img.shields.io/badge/api-docs-yellow.svg?style=flat)](https://hexdocs.pm/membrane_precompiled_dependency_provider/)
5+
[![CircleCI](https://circleci.com/gh/membraneframework/membrane_precompiled_dependency_provider.svg?style=svg)](https://circleci.com/gh/membraneframework/membrane_precompiled_dependency_provider)
6+
7+
Package providing URLs for precompiled dependencies used by Membrane plugins.
48

59
## Installation
610

7-
If [available in Hex](https://hex.pm/docs/publish), the package can be installed
8-
by adding `membrane_precompiled_dependency_provider` to your list of dependencies in `mix.exs`:
11+
The package can be installed by adding `membrane_precompiled_dependency_provider` to your list of dependencies in `mix.exs`:
912

1013
```elixir
1114
def deps do
@@ -15,7 +18,61 @@ def deps do
1518
end
1619
```
1720

18-
Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
19-
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
20-
be found at <https://hexdocs.pm/membrane_precompiled_dependency_provider>.
21+
## Usage
22+
23+
In most cases the package is intended to provide an URL to be used in your project's `bundlex.exs`. This text will assume familiarity with Bundlex and it's mechanism of managing precompiled dependencies, so if you're not acquainted with it you can read about it [here](https://hexdocs.pm/bundlex/readme.html).
24+
25+
Dependencies that are fully located in a correctly structured repository in `membraneframework-precompiled` github organization (details [here](https://github.com/membraneframework-precompiled)) will be referred to as _Generic_. Otherwise they will be referred to as _Non-generic_.
26+
27+
The simplest example of `natives/0` function in `bundlex.exs`, where we have an `:example` native that has an `:example_dep` Generic dependency:
28+
29+
```elixir
30+
defp natives() do
31+
[
32+
example: [
33+
interface: :nif,
34+
sources: ["example.c"],
35+
os_deps: [
36+
example_dep:
37+
[{
38+
:precompiled,
39+
Membrane.PrecompiledDependencyProvider.get_dependency_url(:example_dep)
40+
}]
41+
],
42+
preprocessor: Unifex
43+
]
44+
]
45+
```
46+
47+
## Adding new dependencies
48+
49+
Pool of dependencies offered by this package can be expanded with new ones, _Generic_ and _Non-generic_, by modifying `lib/membrane_precompiled_dependency_provider.ex` appropriately.
50+
51+
To add any dependency start by adding it's name as one of possible values of `precompiled_dependencies()` type:
52+
```elixir
53+
@type precompiled_dependency() :: ... | :example_dep
54+
```
55+
56+
When the dependency is _Generic_ (is present on `membraneframework-precompiled`) that is all you need to do.
57+
58+
#### Adding Non-generic dependencies
59+
60+
When the precompiled builds of a dependency are already hosted somewhere else they can be added as a _Non-generic_ dependency.
61+
62+
To achieve this create a clause of `get_non_generic_dep_url/2` that pattern-matches on your dependency's name and returns an URL appropriate for the passed target:
63+
64+
```elixir
65+
defp get_non_generic_dep_url(:example_non_generic_dep, target) do
66+
...
67+
end
68+
```
69+
70+
For an example see implementation for `:ffmpeg`.
71+
72+
## Copyright and License
73+
74+
Copyright 2023, [Software Mansion](https://swmansion.com/?utm_source=git&utm_medium=readme&utm_campaign=membrane)
75+
76+
[![Software Mansion](https://logo.swmansion.com/logo?color=white&variant=desktop&width=200&tag=membrane-github)](https://swmansion.com/?utm_source=git&utm_medium=readme&utm_campaign=membrane)
2177

78+
Licensed under the [Apache License, Version 2.0](LICENSE)

‎lib/membrane_precompiled_dependency_provider.ex‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
defmodule Membrane.PrecompiledDependencyProvider do
2+
@moduledoc """
3+
Module providing URLs for precompiled dependencies used by Membrane plugins.
4+
5+
Dependencies that are fully located in the repositories of `membraneframework-precompiled` will
6+
be referred to as Generic. Otherwise they will be referred to as Non-generic.
7+
"""
8+
@membrane_precompiled_org_url "https://github.com/membraneframework-precompiled"
9+
10+
@type precompiled_dependency() ::
11+
:ffmpeg | :portaudio | :"fdk-aac" | :srtp | :opus | :sdl2 | :portaudio | :mad | :lame
12+
13+
@doc """
14+
Get URL of a precompiled build of given dependency for appropriate target.
15+
"""
16+
@spec get_dependency_url(dependency :: precompiled_dependency()) ::
17+
String.t() | nil
18+
def get_dependency_url(dependency) do
19+
get_dep_url(dependency, Bundlex.get_target())
20+
end
21+
22+
@spec get_generic_dep_url_prefix(dep :: precompiled_dependency()) :: String.t()
23+
defp get_generic_dep_url_prefix(dep) do
24+
"#{@membrane_precompiled_org_url}/precompiled_#{dep}/releases/latest/download/#{dep}"
25+
end
26+
27+
@spec get_dep_url(dep :: precompiled_dependency(), target :: Bundlex.target()) ::
28+
String.t() | nil
29+
defp get_dep_url(:ffmpeg, target) do
30+
url_prefix = get_generic_dep_url_prefix(:ffmpeg)
31+
32+
case target do
33+
%{abi: "musl"} ->
34+
nil
35+
36+
%{architecture: "aarch64", os: "linux"} ->
37+
"https://github.com/BtbN/FFmpeg-Builds/releases/download/latest/ffmpeg-n6.0-latest-linuxarm64-gpl-shared-6.0.tar.xz"
38+
39+
%{os: "linux"} ->
40+
"https://github.com/BtbN/FFmpeg-Builds/releases/download/latest/ffmpeg-n6.0-latest-linux64-gpl-shared-6.0.tar.xz"
41+
42+
%{architecture: "x86_64", os: "darwin" <> _rest_of_os_name} ->
43+
"#{url_prefix}_macos_intel.tar.gz"
44+
45+
%{architecture: "aarch64", os: "darwin" <> _rest_of_os_name} ->
46+
"#{url_prefix}_macos_arm.tar.gz"
47+
48+
_other ->
49+
nil
50+
end
51+
end
52+
53+
# ---------------------------------
54+
# NEW NON-GENERIC DEPENDENCIES HERE
55+
56+
# ---------------------------------
57+
58+
defp get_dep_url(generic_dep, target) do
59+
url_prefix = get_generic_dep_url_prefix(generic_dep)
60+
61+
case target do
62+
%{abi: "musl"} ->
63+
nil
64+
65+
%{os: "linux"} ->
66+
"#{url_prefix}_linux.tar.gz"
67+
68+
%{architecture: "x86_64", os: "darwin" <> _rest_of_os_name} ->
69+
"#{url_prefix}_macos_intel.tar.gz"
70+
71+
%{architecture: "aarch64", os: "darwin" <> _rest_of_os_name} ->
72+
"#{url_prefix}_macos_arm.tar.gz"
73+
74+
_other ->
75+
nil
76+
end
77+
end
78+
end

0 commit comments

Comments
 (0)