Skip to content
GitLab
Commit 660414fc authored by Vlad Zakharchenko's avatar Vlad Zakharchenko
Browse files

Updated name to OpenV3C

parent 99b4c868
Hide whitespace changes
Inline Side-by-side
CMakeLists.txt
View file @ 660414fc
cmake_minimum_required (VERSION 3.6)
project (OpenIMF)
project (OpenV3C)
IF( WIN32 OR MSVC )
set (CMAKE_CXX_FLAGS "${CMAKE_C_FLAGS} -std=c++14 -DMSVC /openmp -DGIT_COMMIT_HASH=\\\"proto\\\"") # -DBITSTREAM_TRACE
......
CONTRIBUTING.md
View file @ 660414fc
# Welcome
Welcome to OpenIMF!
Welcome to OpenV3C!
- [Before you get started](#before-you-get-started)
- [Code of Conduct](#code-of-conduct)
......@@ -24,7 +24,7 @@ Please make sure to read and observe our [Code of Conduct](http://mpegx.int-evry
## Community Expectations
OpenIMF is a community project driven by its community which strives to promote a healthy, friendly and productive environment.
OpenV3C is a community project driven by its community which strives to promote a healthy, friendly and productive environment.
The goal of the community is to develop a platform for delivery of the immersive media over the network. To build a platform at such scale requires the support of a community with similar aspirations.
- See [Community Membership](./community-membership.md) for a list of various community roles. With gradual contributions, one can move up in the chain.
......@@ -33,14 +33,14 @@ The goal of the community is to develop a platform for delivery of the immersive
# Getting started
- Fork the repository on GitLab
- Read the [developer guide](../setup/develop_OpenIMF.md) for build instructions.
- Read the [developer guide](./README.md) for build instructions.
# Your First Contribution
We will help you to contribute in different areas like filing issues, developing features, fixing critical bugs and getting your work reviewed and merged.
If you have questions about the development process, feel free to jump into our [Slack Channel](https://join.slack.com/t/OpenIMF) or join our [mailing list](https://groups.google.com/forum/#!forum/OpenIMF).
If you have questions about the development process, feel free to jump into our [mailing list](https://groups.google.com/forum/#!forum/OpenIMF).
## Find something to work on
......@@ -50,7 +50,7 @@ Here is how you get started.
### Find a good first topic
There is currently only one [repository](http://mpegx.int-evry.fr/software/MPEG-Public/PCC/V-PCC_decoder) within the OpenIMF organization.
There is currently only one [repository](http://mpegx.int-evry.fr/software/MPEG-Public/PCC/V-PCC_decoder) within the OpenV3C organization.
We can help new contributors who wish to work on such issues.
Another good way to contribute is to find a documentation improvement, such as a missing/broken link. Please see [Contributing](#contributing) below for the workflow.
......@@ -63,9 +63,9 @@ then the robot will assign the issue to you and your name will present at `Assig
### File an Issue
While we encourage everyone to contribute code, it is also appreciated when someone reports an issue.
Issues should be filed under the OpenIMF repository.
Issues should be filed under the OpenV3C repository.
*Example:* a OpenIMF issue should be opened to [OpenIMF](http://mpegx.int-evry.fr/software/MPEG-Public/PCC/V-PCC_decoder/issues).
*Example:* a OpenV3C issue should be opened to [OpenV3C](http://mpegx.int-evry.fr/software/MPEG-Public/PCC/V-PCC_decoder/issues).
Please follow the prompted submission guidelines while opening an issue.
......@@ -79,13 +79,13 @@ This is a rough outline of what a contributor's workflow looks like:
- Make commits of logical units.
- Make sure commit messages are in the proper format (see below).
- Push changes in a topic branch to a personal fork of the repository.
- Submit a pull request to [OpenIMF](http://mpegx.int-evry.fr/software/MPEG-Public/PCC/V-PCC_decoder).
- Submit a pull request to [OpenV3C](http://mpegx.int-evry.fr/software/MPEG-Public/PCC/V-PCC_decoder).
- The PR must receive an approval from two maintainers.
## Creating Pull Requests
Pull requests are often called simply "PR".
OpenIMF generally follows the standard [gitlab pull request](https://docs.gitlab.com/ee/topics/gitlab_flow.html) process.
OpenV3C generally follows the standard [gitlab pull request](https://docs.gitlab.com/ee/topics/gitlab_flow.html) process.
In addition to the above process, a bot will begin applying structured labels to your PR.
......@@ -135,4 +135,4 @@ There are multiple types of tests.
The location of the test code varies with type, as do the specifics of the environment needed to successfully run the test:
* Unit: These confirm that a particular function behaves as intended. Unit test source code can be found adjacent to the corresponding source code within a given package. These are easily run locally by any developer.
* Integration: These tests cover interactions of package components or interactions between OpenIMF components and OpenIMF core.
\ No newline at end of file
* Integration: These tests cover interactions of package components or interactions between OpenV3C components and OpenV3C core.
\ No newline at end of file
README.md
View file @ 660414fc
# OpenIMF v1.0
# OpenV3C v1.0
The project Open Immersive Media Framework is a cross platform reference decoder and reconstruction implementation of the ISO/IEC 23090-5 compression standard: MPEG-I part 5 "Video-based Point Cloud Compression"
The project Open V3C, the Immersive Media Framework is a cross platform reference decoder and reconstruction implementation of the ISO/IEC 23090-5 compression standard: MPEG-I part 5 "Video-based Point Cloud Compression"
## Building
Bash scripts can be use to build OpenIMF project:
Bash scripts can be use to build OpenV3C project:
- build.sh: build solutions.
- clear.sh: clear solututions.
......
doc/design/openimf_core.md
View file @ 660414fc
# OpenIMF Core
# OpenV3C Core
The core of the OpenIMF allows corss platform implementation of
The core of the OpenV3C allows corss platform implementation of
the main functionality for the immersive media decoding and
reconstruction.
......@@ -18,16 +18,16 @@ standard on a mobile devices, leveraging the mobile device
hardware including graphics processing unit (GPU) and
hardware video decoder to accelerate performance.
OpenIMF is a solution for real-time decoding and rendering of the
OpenV3C is a solution for real-time decoding and rendering of the
V-PCC content, leveraging the device hardware including GPU and
video decoder to accelerate performance.
OpenIMF supports AR experiences including the presentation of
OpenV3C supports AR experiences including the presentation of
v-pcc-decoded content super-imposed on the external environment
as seen through the camera.
The following diagram illustrates the __architecture__ of the OpenIMF.
The following diagram illustrates the __architecture__ of the OpenV3C.
![OpenIMF architecture](./figures/architecture.png)
![OpenV3C architecture](./figures/architecture.png)
Volumetric media such as dynamic point clouds enables
viewer to freely navigate in an augmented scene with a 6
......@@ -43,7 +43,7 @@ transformation from 2d projections to 3d volume
## V-PCC bitstream
The input bistream to the OpenIMF must comply to the ISO/IEC 23090-5.
The input bistream to the OpenV3C must comply to the ISO/IEC 23090-5.
Currenlt supported version of bitstreams shall be generated using the
TMC2v8.0 reference software.
......@@ -58,7 +58,7 @@ the heterogeneous processing systems it transferring large amounts
of data, such as decoded images over the but from GPU to CPU memory
The following diagram illustrates the __decoder__ __pipeline__
of the OpenIMF.
of the OpenV3C.
![core](./figures/decoder_pipeline.png)
......
doc/getting-started/community_membership.md
View file @ 660414fc
# OpenIMF Community Membership
# OpenV3C Community Membership
**Note :** This document keeps changing based on the status and feedback of OpenIMF Community.
**Note :** This document keeps changing based on the status and feedback of OpenV3C Community.
This document gives a brief overview of the OpenIMF community roles with the requirements and responsibilities associated with them.
This document gives a brief overview of the OpenV3C community roles with the requirements and responsibilities associated with them.
| Role | Requirements | Responsibilities | Privileges |
| -----| ---------------- | ------------ | -------|
| [Member](#member) | Sponsor from 2 approvers, active in community, contributed to OpenIMF | Welcome and guide new contributors | OpenIMF GitLab organization Member |
| [Member](#member) | Sponsor from 2 approvers, active in community, contributed to OpenV3C | Welcome and guide new contributors | OpenV3C GitLab organization Member |
| [Approver](#approver) | Sponsor from 2 maintainers, has good experience and knowledge of domain, actively contributed to code and review | Review and approve contributions from community members | Write access to specific packagies in relevant repository |
| [Maintainer](#maintainer) | Sponsor from 2 owners, shown good technical judgement in feature design/development and PR review | Participate in release planning and feature development/maintenance | Top level write access to relevant repository. Name entry in Maintainers file of the repository |
| [Owner](#owner) | Sponsor from 3 owners, helps drive the overall OpenIMF project | Drive the overall technical roadmap of the project and set priorities of activities in release planning | OpenImf GitLab organization Admin access |
| [Owner](#owner) | Sponsor from 3 owners, helps drive the overall OpenV3C project | Drive the overall technical roadmap of the project and set priorities of activities in release planning | OpenV3C GitLab organization Admin access |
**Note :** It is mandatory for all OpenIMF community members to follow OpenIMF [Code of Conduct].
**Note :** It is mandatory for all OpenV3C community members to follow OpenV3C [Code of Conduct].
## Member
......@@ -28,17 +28,17 @@ reviewing issues/PRs or participate in community discussions on slack/mailing li
- Authoring PRs
- Reviewing issues/PRs authored by other community members
- Participating in community discussions on slack/mailing list
- Participate in OpenIMF community meetings
- Participate in OpenV3C community meetings
### Responsibilities and privileges
- Member of the OpenIMF GitLab organization
- Member of the OpenV3C GitLab organization
- Can be assigned to issues and PRs and community members can also request their review
- Participate in assigned issues and PRs
- Welcome new contributors
- Guide new contributors to relevant docs/files
- Help/Motivate new members in contributing to OpenIMF
- Help/Motivate new members in contributing to OpenV3C
## Approver
......@@ -61,7 +61,7 @@ They have actively participated in the issue/PR reviews and have identified rele
- Acknowledge and work on review requests from community members
- May approve code contributions for acceptance related to relevant expertise
- Have 'write access' to specific packages inside a repo, enforced via bot
- Continue to contribute and guide other community members to contribute in OpenIMF project
- Continue to contribute and guide other community members to contribute in OpenV3C project
## Maintainer
......@@ -80,7 +80,7 @@ Has overall knowledge of the project and features in the project.
- Participate in release planning
- Maintain project code quality
- Ensure API compatibility with forward/backward versions based on feature graduation criteria
- Analyze and propose new features/enhancements in OpenIMF project
- Analyze and propose new features/enhancements in OpenV3C project
- Demonstrate sound technical judgement
- Mentor contributors and approvers
- Have top level write access to relevant repository (able click Merge PR button when manual check-in is necessary)
......@@ -90,7 +90,7 @@ Has overall knowledge of the project and features in the project.
## Owner
Owners are maintainers who have helped drive the overall project direction.
Has deep understanding of OpenIMF and related domain and facilitates major agreement in release planning
Has deep understanding of OpenV3C and related domain and facilitates major agreement in release planning
### Requirements
......@@ -112,8 +112,8 @@ Has deep understanding of OpenIMF and related domain and facilitates major agree
- Participate & Drive design/development of multiple features
**Note :** These roles are applicable only for OpenIMF GitLab organization and repositories. Currently OpenIMF doesn't have a formal process for review and acceptance into these roles. We will come-up with a process soon.
**Note :** These roles are applicable only for OpenV3C GitLab organization and repositories. Currently OpenV3C doesn't have a formal process for review and acceptance into these roles. We will come-up with a process soon.
[Code of Conduct]: https://GitLab.com/OpenIMF/CODE_OF_CONDUCT.md
[Code of Conduct]: ../../CODE_OF_CONDUCT.md
doc/getting-started/contribute.md
View file @ 660414fc
# Welcome
Welcome to OpenIMF!
Welcome to OpenV3C!
- [Before you get started](#before-you-get-started)
- [Code of Conduct](#code-of-conduct)
......@@ -24,7 +24,7 @@ Please make sure to read and observe our [Code of Conduct](http://mpegx.int-evry
## Community Expectations
OpenIMF is a community project driven by its community which strives to promote a healthy, friendly and productive environment.
OpenV3C is a community project driven by its community which strives to promote a healthy, friendly and productive environment.
The goal of the community is to develop a platform for delivery of the immersive media over the network. To build a platform at such scale requires the support of a community with similar aspirations.
- See [Community Membership](./community_membership.md) for a list of various community roles. With gradual contributions, one can move up in the chain.
......@@ -33,14 +33,14 @@ The goal of the community is to develop a platform for delivery of the immersive
# Getting started
- Fork the repository on GitLab
- Read the [developer guide](../setup/develop_OpenIMF.md) for build instructions.
- Read the [developer guide](../setup/develop_OpenV3C.md) for build instructions.
# Your First Contribution
We will help you to contribute in different areas like filing issues, developing features, fixing critical bugs and getting your work reviewed and merged.
If you have questions about the development process, feel free to jump into our [Slack Channel](https://join.slack.com/t/OpenIMF) or join our [mailing list](https://groups.google.com/forum/#!forum/OpenIMF).
If you have questions about the development process, feel free to jump into our [Slack Channel](https://join.slack.com/t/OpenV3C) or join our [mailing list](https://groups.google.com/forum/#!forum/OpenV3C).
## Find something to work on
......@@ -50,7 +50,7 @@ Here is how you get started.
### Find a good first topic
There is currently only one [repository](http://mpegx.int-evry.fr/software/MPEG-Public/PCC/V-PCC_decoder) within the OpenIMF organization.
There is currently only one [repository](http://mpegx.int-evry.fr/software/MPEG-Public/PCC/V-PCC_decoder) within the OpenV3C organization.
We can help new contributors who wish to work on such issues.
Another good way to contribute is to find a documentation improvement, such as a missing/broken link. Please see [Contributing](#contributing) below for the workflow.
......@@ -63,9 +63,9 @@ then the robot will assign the issue to you and your name will present at `Assig
### File an Issue
While we encourage everyone to contribute code, it is also appreciated when someone reports an issue.
Issues should be filed under the OpenIMF repository.
Issues should be filed under the OpenV3C repository.
*Example:* a OpenIMF issue should be opened to [OpenIMF](http://mpegx.int-evry.fr/software/MPEG-Public/PCC/V-PCC_decoder/issues).
*Example:* a OpenV3C issue should be opened to [OpenV3C](http://mpegx.int-evry.fr/software/MPEG-Public/PCC/V-PCC_decoder/issues).
Please follow the prompted submission guidelines while opening an issue.
......@@ -79,13 +79,13 @@ This is a rough outline of what a contributor's workflow looks like:
- Make commits of logical units.
- Make sure commit messages are in the proper format (see below).
- Push changes in a topic branch to a personal fork of the repository.
- Submit a pull request to [OpenIMF](http://mpegx.int-evry.fr/software/MPEG-Public/PCC/V-PCC_decoder).
- Submit a pull request to [OpenV3C](http://mpegx.int-evry.fr/software/MPEG-Public/PCC/V-PCC_decoder).
- The PR must receive an approval from two maintainers.
## Creating Pull Requests
Pull requests are often called simply "PR".
OpenIMF generally follows the standard [gitlab pull request](https://docs.gitlab.com/ee/topics/gitlab_flow.html) process.
OpenV3C generally follows the standard [gitlab pull request](https://docs.gitlab.com/ee/topics/gitlab_flow.html) process.
In addition to the above process, a bot will begin applying structured labels to your PR.
......@@ -135,4 +135,4 @@ There are multiple types of tests.
The location of the test code varies with type, as do the specifics of the environment needed to successfully run the test:
* Unit: These confirm that a particular function behaves as intended. Unit test source code can be found adjacent to the corresponding source code within a given package. These are easily run locally by any developer.
* Integration: These tests cover interactions of package components or interactions between OpenIMF components and OpenIMF core.
\ No newline at end of file
* Integration: These tests cover interactions of package components or interactions between OpenV3C components and OpenV3C core.
\ No newline at end of file
doc/getting-started/feature-lifecycle.md
View file @ 660414fc
......@@ -77,5 +77,5 @@ The API version names will be like v1, v2, etc.
- Code is thoroughly tested and is reported to be very stable.
- Project will support this feature for at least next 4 minor releases and notice of at least 4 minor releases will be given before stopping support.
- Feature Owner should commit to ensure backward/forward compatibility in the later versions.
- Consensus from OpenIMF Maintainers as well as Feature/API Owners who use/interact with the Feature/API.
- Consensus from OpenV3C Maintainers as well as Feature/API Owners who use/interact with the Feature/API.
doc/getting-started/getting-started.md
View file @ 660414fc
# Welcome to OpenIMF
# Welcome to OpenV3C
OpenIMF is an open source platform for immersive media decoding, rendering and delivery over the network.
OpenV3C is an open source platform for immersive media decoding, rendering and delivery over the network.
# Why OpenIMF?
# Why OpenV3C?
Learn about OpenIMF and the OpenIMF Mission here
Learn about OpenV3C and the OpenV3C Mission here
##First Steps
To get the most out of OpenIMF, start by reviewing a few introductory topics:
- Quick Start: Install OpenIMF
- Start developing OpenIMF
- Contributing: Contribute to OpenIMF
To get the most out of OpenV3C, start by reviewing a few introductory topics:
- Quick Start: Install OpenV3C
- Start developing OpenV3C
- Contributing: Contribute to OpenV3C
- Troubleshooting: Troubleshoot commonly occurring issues.
- GitHub issues are here
doc/getting-started/reporting_bugs.md
View file @ 660414fc
# Reporting bugs
If any part of the OpenIMF project has bugs or documentation mistakes, please let us know by opening an issue. We treat bugs and mistakes very seriously and believe no issue is too small. Before creating a bug report, please check that an issue reporting the same problem does not already exist.
If any part of the OpenV3C project has bugs or documentation mistakes, please let us know by opening an issue. We treat bugs and mistakes very seriously and believe no issue is too small. Before creating a bug report, please check that an issue reporting the same problem does not already exist.
To make the bug report accurate and easy to understand, please try to create bug reports that are:
......
doc/getting-started/roadmap.md
View file @ 660414fc
# Roadmap
This document defines a high level roadmap for OpenIMF development.
This document defines a high level roadmap for OpenV3C development.
The [milestones defined in GitLab](http://mpegx.int-evry.fr/software/MPEG-Public/PCC/V-PCC_decoder/milestones) represent the most up-to-date plans.
OpenIMF 1.0 is our current stable branch. The roadmap below outlines new features that will be added to OpenIMF.
OpenV3C 1.0 is our current stable branch. The roadmap below outlines new features that will be added to OpenV3C.
## 2020 Q2 Roadmap
- Support for TMC2v9.0 compliant bitstreams.
- Support for SEI messages.
- Enhance performance and reliability of OpenIMF.
- Enhance performance and reliability of OpenV3C.
- Improve contributor experience by defining project governance policies, release process, membership rules etc.
- Improve the performance of point cloud reconstruction.
- Improve OpenIMP installation experience
......
doc/getting-started/support.md
View file @ 660414fc
......@@ -4,10 +4,6 @@ If you need support, start with the [troubleshooting guide](../troubleshooting/t
## Community
**Slack channel:**
We use Slack for public discussions. To chat with us or the rest of the community, join us in the [OpenIMF Slack](https://openimf.slack.com) team channel #general. To sign up, use our Slack inviter link [here](https://join.slack.com/t/openimf/shared_invite/TBU).
**Mailing List**
Please sign up on our [mailing list](https://groups.google.com/forum/#!forum/openimf)
\ No newline at end of file
external-dependency.md
View file @ 660414fc
## OpenIMF External Build Dependencies
## OpenV3C External Build Dependencies
| Software | License | Repo Link
|---|---|---|
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment