Skip to content

Commit ae287ba

Browse files
committed
Merge pull request #197 from cchampet/add_USAGE
Add USAGE.md
2 parents 9f75cb9 + 16b3377 commit ae287ba

File tree

2 files changed

+63
-29
lines changed

2 files changed

+63
-29
lines changed

README.md

Lines changed: 1 addition & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -21,35 +21,7 @@ See [**COPYING.md**](COPYING.md)
2121
See [**INSTALL.md**](INSTALL.md)
2222

2323
#### How to use
24-
Check out applications contained in the project to see examples of how to use the library in C++, Java or Python.
25-
26-
To encode, avTranscoder manipulates profiles.
27-
A profile is a text file which discribes, with a set of key-value, what we want as output for the format, the video, or the audio.
28-
You can create your own profiles and export a variable called ```AVPROFILES``` to indicate the path to them.
29-
30-
The minimum format profile is:
31-
```
32-
avProfileName=profileName
33-
avProfileLongName=profileLongName
34-
avProfileType=avProfileTypeFormat
35-
format=formatName
36-
```
37-
38-
The minimum video profile is:
39-
```
40-
avProfileName=profileName
41-
avProfileLongName=profileLongName
42-
avProfileType=avProfileTypeVideo
43-
codec=codecName
44-
```
45-
46-
The minimum audio profile is:
47-
```
48-
avProfileName=profileName
49-
avProfileLongName=profileLongName
50-
avProfileType=avProfileTypeAudio
51-
codec=codecName
52-
```
24+
See [**USAGE.md**](USAGE.md)
5325

5426
#### Tests
5527

USAGE.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# How to use avTranscoder
2+
3+
Check out applications contained in the project to see examples of how to use the library in C++, Java or Python.
4+
5+
#### In C++
6+
Set environment:
7+
```
8+
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/path/to/ffmpeg/lib:/path/to/avtranscoder/lib
9+
export PATH=$PATH:/path/to/avtranscoder/bin
10+
```
11+
12+
#### In Java
13+
Add argument to the JVM:
14+
```
15+
-Djava.library.path=/path/to/avtranscoder/lib/java
16+
```
17+
Set environment:
18+
```
19+
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/path/to/ffmpeg/lib
20+
```
21+
22+
#### In Python
23+
Set environment:
24+
```
25+
export PYTHONPATH=$PYTHONPATH:/path/to/avtranscoder/lib/python<version>/site-packages/
26+
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/path/to/ffmpeg/lib
27+
```
28+
29+
#### Use profiles
30+
To wrap/unwrap/encode/decode, avTranscoder manipulates profiles.
31+
A profile is a set of key-value given as parameters to the InputFile(unwrap), the OutputFile(wrap), the Video/AudioDecoder(decode) or the Video/AudioEncoder(encode).
32+
There are two ways to manipulate profiles:
33+
* create profiles inside your code, by instanciate ```Map``` structures.
34+
* create profiles outside your code, by create text files.
35+
To indicate the path to the text files, export environment variable:
36+
```
37+
export AVPROFILES=/path/to/profiles
38+
```
39+
40+
The minimum format profile (wrap/unwrap) is:
41+
```
42+
avProfileName=profileName
43+
avProfileLongName=profileLongName
44+
avProfileType=avProfileTypeFormat
45+
format=formatName
46+
```
47+
48+
The minimum video profile (encode/decode) is:
49+
```
50+
avProfileName=profileName
51+
avProfileLongName=profileLongName
52+
avProfileType=avProfileTypeVideo
53+
codec=codecName
54+
```
55+
56+
The minimum audio profile (encode/decode) is:
57+
```
58+
avProfileName=profileName
59+
avProfileLongName=profileLongName
60+
avProfileType=avProfileTypeAudio
61+
codec=codecName
62+
```

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy