videolan
/
vlc
mirror of https://gitea.goldendeliverer.com/videolan/vlc.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
109462 Commits
7 Branches
132 Tags
718 MiB
Tree: 259d873b41
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '259d873b41'
${ noResults }
vlc/Cargo.toml

19 lines
403 B
Raw Normal View History

rust: add Cargo workspace for abstractions > A workspace is a collection of one or more packages https://doc.rust-lang.org/cargo/reference/workspaces.html#workspaces Rust abstractions of VLC Core will live in src/rust/, while the Rust modules will live in the respective directories in modules/.
3 years ago
[workspace]
rust: add binary helper crate for generating raw bindings This binary crate, called vlcrs-sys-generator, uses the bindgen[1] crate to automatically generate raw (extern "C"...) bindings, which are then used by safe abstractions. The goal is for this program to be used to generate raw bindings that are which will be used by safe abstractions, each safely wrapping a part of the VLC core API, generally a header will be a crate. This is done so that the so that the dependency chain of the Rust modules closely follows that of the C modules, in particular a demux module should not need to be rebuild if it doesn't depend on vout. Since writing and maintaining raw bindings is tedious and error-prone, the raw bindings (extern "C"...) are generated using a Clang front-end, bindgen, written in Rust. Updating the bindings should be as simple as running `cargo run -p vlcrs-sys-generator'. [1]: https://rust-lang.github.io/rust-bindgen/
3 years ago
members = [
Cargo.toml: list crate explicitely Otherwise, stale files in any src/rust/vlcrs-*/ folder makes the folder alive without manifest or with a non-complete manifest and everything breaks...
1 year ago
"src/rust/vlcrs-core",
"src/rust/vlcrs-macros",
"src/rust/vlcrs-messages",
"src/rust/vlcrs-utils",
logger: add telegraf tracer The tracer is designed to send the metrics towards a telegraf server using this kind of configuration: [[inputs.socket_listener]] service_address = "tcp://localhost:8094" The telegraf server can then forward the metrics towards an influxdb server for monitoring or directly to grafana live server[^1] for introspection. The influxdb database can also be used to query the metrics after they've been indexed. The application using the tracer can use the VLC_TELEGRAF_ENDPOINT environment variable (eg. VLC_TELEGRAF_ENDPOINT=tcp://127.0.0.1:8094) to set where the tracer will output the traces to. A bunch of notes and improvement left for later: - Unsafe code is still used for accessing the fields data since an union is used and union access is unsafe. It could probably be wrapped from the binding implementation. - There is no way to specify the address using the configuration since vlc_variable is not bound to the Rust bindings and no unsafe extern "C" code is done from the plugin. - The tracer currently panic as the telegraf server dies because it doesn't handle reconnection. Proper reconnection logic with maybe size-limited temporary storing might be a proper workaround for that. - The tracer doesn't use the timestamp provided by VLC right now, proper time conversion is required for it to work. - There's no proper tags for the metrics being sent, which is an issue given that tags are providing indexing on the data. The tags should be generated from the string values of the tracer. Maybe an additional "Role" should be added in the trace entry for that purpose. [^1]: https://grafana.com/blog/2021/08/16/streaming-real-time-telegraf-metrics-using-grafana-live/
1 year ago
"modules/logger/telegraf-rs/"
rust: add binary helper crate for generating raw bindings This binary crate, called vlcrs-sys-generator, uses the bindgen[1] crate to automatically generate raw (extern "C"...) bindings, which are then used by safe abstractions. The goal is for this program to be used to generate raw bindings that are which will be used by safe abstractions, each safely wrapping a part of the VLC core API, generally a header will be a crate. This is done so that the so that the dependency chain of the Rust modules closely follows that of the C modules, in particular a demux module should not need to be rebuild if it doesn't depend on vout. Since writing and maintaining raw bindings is tedious and error-prone, the raw bindings (extern "C"...) are generated using a Clang front-end, bindgen, written in Rust. Updating the bindings should be as simple as running `cargo run -p vlcrs-sys-generator'. [1]: https://rust-lang.github.io/rust-bindgen/
3 years ago
]
src: Cargo.toml: fix warnings on workspace Since we'll be using edition = "2021", and we have a virtual workspace[^1], we need to specify the manifest resolver[^2]. Otherwise, cargo emits the following warning: warning: virtual workspace defaulting to `resolver = "1"` despite one or more workspace members being on edition 2021 which implies `resolver = "2"` note: to keep the current resolver, specify `workspace.resolver = "1"` in the workspace root's manifest note: to use the edition 2021 resolver, specify `workspace.resolver = "2"` in the workspace root's manifest note: for more details see https://doc.rust-lang.org/cargo/reference/resolver.html#resolver-versions See release note[^3] for details on how this resolver changes the way features are selected for packages inside the workspace. [^1]: https://doc.rust-lang.org/cargo/reference/workspaces.html#virtual-workspace [^2]: https://doc.rust-lang.org/edition-guide/rust-2021/default-cargo-resolver.html [^3]: https://blog.rust-lang.org/2021/03/25/Rust-1.51.0.html#cargos-new-feature-resolver
2 years ago
resolver = "2"
Cargo.toml: exclude contrib from workspace This fixes e.g., `make .rav1e`: "Error: CliError { error: Some(current package believes it's in a workspace when it's not" when building..." See: https://github.com/rust-lang/cargo/issues/5418 Co-authored-by: Alexandre Janniaux <ajanni@videolabs.io>
10 months ago
exclude = ["contrib"]
src: Cargo.toml: expose common workspace keys Expose the version and license keys to every members of the workspace. The rationale is that every core crates merged into `src/rust/` will be versioned under the same revision as the core.
2 years ago
[workspace.package]
version = "4.0.0"
license = "LGPL-2.1-or-later"
rust: Cargo.toml: expose core and macros in workspace The crates will be used by rust plugins, but we want to provide the version from the workspace instead of specifying the path each time relatively to the plugin crate manifest.
1 year ago
[workspace.dependencies]
logger: add telegraf tracer The tracer is designed to send the metrics towards a telegraf server using this kind of configuration: [[inputs.socket_listener]] service_address = "tcp://localhost:8094" The telegraf server can then forward the metrics towards an influxdb server for monitoring or directly to grafana live server[^1] for introspection. The influxdb database can also be used to query the metrics after they've been indexed. The application using the tracer can use the VLC_TELEGRAF_ENDPOINT environment variable (eg. VLC_TELEGRAF_ENDPOINT=tcp://127.0.0.1:8094) to set where the tracer will output the traces to. A bunch of notes and improvement left for later: - Unsafe code is still used for accessing the fields data since an union is used and union access is unsafe. It could probably be wrapped from the binding implementation. - There is no way to specify the address using the configuration since vlc_variable is not bound to the Rust bindings and no unsafe extern "C" code is done from the plugin. - The tracer currently panic as the telegraf server dies because it doesn't handle reconnection. Proper reconnection logic with maybe size-limited temporary storing might be a proper workaround for that. - The tracer doesn't use the timestamp provided by VLC right now, proper time conversion is required for it to work. - There's no proper tags for the metrics being sent, which is an issue given that tags are providing indexing on the data. The tags should be generated from the string values of the tracer. Maybe an additional "Role" should be added in the trace entry for that purpose. [^1]: https://grafana.com/blog/2021/08/16/streaming-real-time-telegraf-metrics-using-grafana-live/
1 year ago
vlcrs-core = { path = "src/rust/vlcrs-core" }
vlcrs-macros = { path = "src/rust/vlcrs-macros" }