Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/membraneframework/membrane_precompiled_dependency_provider
https://github.com/membraneframework/membrane_precompiled_dependency_provider
Last synced: 2 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/membraneframework/membrane_precompiled_dependency_provider
- Owner: membraneframework
- License: apache-2.0
- Created: 2023-12-11T16:20:42.000Z (11 months ago)
- Default Branch: master
- Last Pushed: 2023-12-12T15:44:04.000Z (11 months ago)
- Last Synced: 2023-12-18T18:53:04.703Z (11 months ago)
- Language: Elixir
- Size: 22.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Membrane Precompiled Dependency Provider
[](https://hex.pm/packages/membrane_precompiled_dependency_provider)
[](https://hexdocs.pm/membrane_precompiled_dependency_provider/)
[](https://circleci.com/gh/membraneframework/membrane_precompiled_dependency_provider)
Package providing URLs for precompiled dependencies used by Membrane plugins.
## Installation
The package can be installed by adding `membrane_precompiled_dependency_provider` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:membrane_precompiled_dependency_provider, "~> 0.1.2"}
]
end
```
## Usage
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).
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_.
The simplest example of `natives/0` function in `bundlex.exs`, where we have an `:example` native that has an `:example_dep` Generic dependency:
```elixir
defp natives() do
[
example: [
interface: :nif,
sources: ["example.c"],
os_deps: [
example_dep:
[{
:precompiled,
Membrane.PrecompiledDependencyProvider.get_dependency_url(:example_dep)
}]
],
preprocessor: Unifex
]
]
```
## Adding new dependencies
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.
To add any dependency start by adding it's name as one of possible values of `precompiled_dependencies()` type:
```elixir
@type precompiled_dependency() :: ... | :example_dep
```
When the dependency is _Generic_ (is present on `membraneframework-precompiled`) that is all you need to do.
#### Adding Non-generic dependencies
When the precompiled builds of a dependency are already hosted somewhere else they can be added as a _Non-generic_ dependency.
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:
```elixir
defp get_non_generic_dep_url(:example_non_generic_dep, target) do
...
end
```
For an example see implementation for `:ffmpeg`.
## Copyright and License
Copyright 2023, [Software Mansion](https://swmansion.com/?utm_source=git&utm_medium=readme&utm_campaign=membrane)
[](https://swmansion.com/?utm_source=git&utm_medium=readme&utm_campaign=membrane)
Licensed under the [Apache License, Version 2.0](LICENSE)