Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jordijoangimenez authored Apr 28, 2024
1 parent 96cc20f commit ac5bae4
Showing 1 changed file with 11 additions and 13 deletions.
24 changes: 11 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,26 @@
# rt-xr-maf-native
<h1 align="center">Media Access Function (MAF) API</h1>
<p align="center">
<img src="https://img.shields.io/badge/Status-Under_Development-yellow" alt="Under Development">
<img src="https://img.shields.io/github/v/tag/5G-MAG/rt-xr-maf-native?label=version" alt="Version">
<img src="https://img.shields.io/badge/License-5G--MAG%20Public%20License%20(v1.0)-blue" alt="License">
</p>

## Introduction
This repository provides implementation of the Media Access Functions API (MAF) defined in [ISO/IEC 23090-14](https://www.iso.org/obp/ui/#iso:std:iso-iec:23090:-14:ed-1:v1:en). The Media Access Functions API allows media playback and access in the context of 3D Scene Description encoding.

This repository provides implementation of the Media Access Functions API (MAF) defined in ISO/IEC 23090-14.
The project is a dependency of [`rt-xr-unity-player`](https://github.com/5G-MAG/rt-xr-unity-player), providing the build artifacts for [`rt-xr-maf-plugin`](https://github.com/5G-MAG/rt-xr-maf-plugin).

The Media Access Functions API allows media playback and access in the context of 3D Scene Description encoding as specified through [ISO/IEC 23090-14](https://www.iso.org/obp/ui/#iso:std:iso-iec:23090:-14:ed-1:v1:en).
Additional information can be found at: https://5g-mag.github.io/Getting-Started/pages/xr-media-integration-in-5g/

### About the implementation
The implementation is organized through *subprojects*:
- **subprojects/maf**: the core library implementing the MAF API, along with a media pipeline factory.
- **subprojects/maf_csharp**: SWIG C# bindings.
- **subprojects/avpipeline**: a media pipeline which uses libav for audio/video decoding.

The project is a dependency of [`rt-xr-unity-player`](https://github.com/5G-MAG/rt-xr-unity-player), providing the build artifacts for [`rt-xr-maf-plugin`](https://github.com/5G-MAG/rt-xr-maf-plugin).


### Supported platforms

The project currently supports win64.
Contributions to support additional platforms are welcome.

Contributions to support additional platforms are welcome.

## Building

Expand Down Expand Up @@ -50,9 +52,6 @@ If you intend to develop a new media pipeline, take a look at the `subprojects/a
- When the XR player executes, it calls `MAF::MediaPipelineFactory::loadPluginsDir()` which looks up the given directory for dynamic libraries implementing the plugin interface `IMediaPipelineFactoryPlugin`.
- A call to `MediaPipelineFactory::createMediaPipeline()` iterates registered plugins until a MediaPipeline is successfully created - if any - and can returned to the application.


## Contributing

### Gitflow

This project follows the [Gitflow workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow).
Expand All @@ -61,7 +60,6 @@ The `development` branch of this project serves as an integration branch for new

Consequently, please make sure to switch to the `development` branch before starting the implementation of a new feature.


### pre_commit hook

Contributors are encouraged to use the provided *pre_commit* hook which builds and tests before each commit.
Expand Down

0 comments on commit ac5bae4

Please sign in to comment.