Skip to content

Commit 2422678

Browse files
committed
Update IMF README
1 parent 9ed6845 commit 2422678

File tree

1 file changed

+31
-3
lines changed

1 file changed

+31
-3
lines changed

README-IMF.md

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,38 @@
11
# FFMPEG IMF
22

3-
## Debug build
3+
# IMF for FFMPEG
44

5-
`./configure --enable-libxml2 --enable-debug --enable-static --disable-optimizations --prefix=$PWD/dist`
5+
## Introduction
66

7-
## Install clang-format-12 on ubuntu
7+
This project adds support for [IMF Compositions](https://ieeexplore.ieee.org/document/9097478) as an input format to [FFMPEG](https://ffmpeg.org).
8+
9+
## Usage
10+
11+
`./ffmpeg -i <path of CPL> -assetmaps <path of ASSETMAP1>,<path of ASSETMAP2>,...`
12+
13+
If `-assetmaps` is not specified, FFMPEG looks for a file called `ASSETMAP.xml` in the same directory as the CPL.
14+
15+
## Build
16+
17+
### Release
18+
19+
`./configure --enable-libxml2`
20+
21+
### Debug
22+
23+
`./configure --enable-libxml2 --enable-debug --disable-optimizations --prefix=$PWD/dist`
24+
25+
## Unit tests
26+
27+
`./imf-unit-tests.sh`
28+
29+
## Code style
30+
31+
`./imf-check-style.sh`
32+
33+
## Dependencies
34+
35+
### clang-format-12
836

937
```sh
1038
wget -O - https://apt.llvm.org/llvm-snapshot.gpg.key | sudo apt-key add -

0 commit comments

Comments
 (0)