README.md

# OpenIMF 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"

## Building

Bash scripts can be use to build OpenIMF project: 
- build.sh: build solutions.  
- clear.sh: clear solututions.
 
### OSX
- mkdir build
- cd build
- cmake .. -G Xcode 
- open the generated xcode project and build it

### Linux
- mkdir build
- cd build
- cmake .. 
- make

### Windows
- md build
- cd build
- cmake .. -G "Visual Studio 15 2017 Win64"
- open the generated visual studio solution and build it

### Android
- open the android Studio
- import the project from porting/Android/PccDecoder

### External dependencies

| Software | License | Repo Link
|---|---|---|
| arcore-android-sdk-1.14.0 | Apache License 2.0 | https://developers.google.com/ar/develop
| ffmpeg-4.2.2-win64-dev-lgpl | LGPL v2.1 | https://github.com/FFmpeg/FFmpeg
| glew-2.1.0 | Khronos Group | https://github.com/nigels-com/glew
| glfw | Zlib | https://github.com/glfw/glfw
| glm | MIT | https://github.com/g-truc/glm
| stb | MIT | https://github.com/nothings/stb

### Running

The decoder requires an ISO/IEC 23090-5 comliant bitstream
Example bistreams can be located in the data folder 

### Scripts

The helper tool to copy the immersive media streams to the test application folder on the android device

### Contributing
Please read the doc/getting-started/contribute.md for details on our code of conduct, and the process for submitting pull requests to us.