← Back to branch summary

~ubuntu-branches/ubuntu/intrepid/transcode/intrepid-proposed

« back to all changes in this revision

Viewing changes to docs/ibp_support.txt

  • Committer: Bazaar Package Importer
  • Author(s): Daniel T Chen
  • Date: 2005-10-10 19:12:47 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20051010191247-uq4j6t947df71v7m
Tags: 2:1.0.1-0.0ubuntu1
* New upstream release.
* debian/:
  + Remove 03_rescale.c and 04_average.c dpatches, applied upstream.
  + Force amd64 to link against the correct _pic libs, fixing FTBFS.
  + Disable mjpegtools support on ppc until post-Breezy (FTBFS).

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/ibp_support.txt
 
1
IBP support for transcode
 
2
 
 
3
This is the web page about IBP and related tools
 
4
http://loci.cs.utk.edu/
 
5
 
 
6
Binary utilities can user lors URI for input and/or output file.
 
7
 
 
8
If we want to access file in the IBP depot then URI in form 
 
9
 
 
10
lors://host:port/local_path/file?bs=number&duration=number&copies=number&threads=number&timeout=number&servers=number&size=number
 
11
 
 
12
is used. User can also use the short form URI 
 
13
 
 
14
lors:///local_path/file 
 
15
 
 
16
When we want to read an IBP file, the local_path/file specifies local file 
 
17
where is stored exNode with XML specification. When writing an IBP file the
 
18
local_path/file specifies local file where to store exNode with XML
 
19
specification of IBP depots used. 
 
20
 
 
21
The paremeters in the full form of URI mean as follows:
 
22
 
 
23
host     specification of L-Bone server location
 
24
port     specification of L-Bone server port (default 6767)
 
25
bs       specification of block-size for transfer in megabytes (default 10)
 
26
duration specification of allocation duration in seconds (default 3600s)
 
27
copies   specification of number of copies (default 1)
 
28
threads  specification of number of threads (concurrent TCP streams) (default 1)
 
29
timeout  specification of timeout in seconds (default 100)
 
30
servers  specification of number of unique IBP depots (default 1)
 
31
size     specification of assumed file size in bytes (default 10MB)
 
32
 
 
33
There are environment variables that can be used instead of URI parameters for 
 
34
the LoRS layer.
 
35
 
 
36
LBONE_SERVER   specifies L-Bone server location
 
37
LBONE_PORT     specifies L-Bone server port (default 6767)
 
38
LORS_BLOCKSIZE specifies block-size for transfer in megabytes (default 10)
 
39
LORS_DURATION  specifies duration of allocation in seconds (default 3600s)
 
40
LORS_COPIES    specifies number of copies (default 1)
 
41
LORS_THREADS   specifies number of threads (concurrent TCP streams) (default 1)
 
42
LORS_TIMEOUT   specifies timeout in seconds (default 100)
 
43
LORS_SERVERS   specifies number of unique IBP depots (default 1)
 
44
LORS_SIZE      specifies assumed file size in bytes (default 10MB)
 
45
 
 
46
At least LBONE_SERVER or host must be set.
 
47
 
 
48
Transcode program can be used in almost traditional way. If we want to store
 
49
the file to the IBP depot then URI in form lors:///local_path/file is used
 
50
instead of local file name. The environment variables should be set unless user
 
51
specifies URI in its full form. The same form of URI can be used for loading
 
52
the file from the IBP depot. Transcode can read and write ordinary local files
 
53
as well. The prefix lors:// is required for accessing IBP, otherwise local file
 
54
is used.
 
55
 
 
56
For example:
 
57
 
 
58
LBONE_SERVER=our.ibp.host; 
 
59
transcode -i lors:///video.dv.xnd -P1 -N 0x1 -y raw -o lors:///temp1-remux.avi.xnd -E 44100,16,2 -J resample
 
60
 
 
61
Transcode will use source file identified by serialized description of IBP
 
62
exNode stored in video.dv.xnd file on local disc in the current directory. The
 
63
L-Bone server location is taken from environment variable (referring to
 
64
our.ibp.host) and resulting serialized exNode XML description will be
 
65
stored in the current directory as temp1-remux.avi.xnd