← Back to branch summary

~ubuntu-branches/ubuntu/karmic/tovid/karmic

« back to all changes in this revision

Viewing changes to docs/src/en/tovid-stats.t2t

  • Committer: Bazaar Package Importer
  • Author(s): Matvey Kozhev
  • Date: 2008-01-24 22:04:40 UTC
  • Revision ID: james.westby@ubuntu.com-20080124220440-x7cheljduf1rdgnq
Tags: upstream-0.31
Import upstream version 0.31

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/src/en/tovid-stats.t2t
 
1
tovid-stats manual
 
2
 
 
3
 
 
4
==Name==
 
5
 
 
6
tovid-stats: Display summarized statistics of tovid encodings
 
7
 
 
8
 
 
9
==Description==
 
10
 
 
11
tovid-stats reads encoding statistics from **~/.tovid/stats.tovid**
 
12
and can display filtered, averaged, correlated or summarized information
 
13
about all the videos you've encoded with **tovid**. It can also display
 
14
a 2D graphical scatterplot of data from any two statistic fields.
 
15
 
 
16
 
 
17
==Usage==
 
18
 
 
19
**tovid-stats** //COMMANDS//
 
20
 
 
21
Where //COMMANDS// is a list of data-filtering commands that operate on
 
22
specific //FIELD// names (see below for //FIELD// names). Available //COMMANDS//:
 
23
 
 
24
: **-count** //FIELD//
 
25
    Count total occurrences of unique values in the given field.
 
26
: **-average** //FIELD_1// {by //FIELD_2//}.
 
27
    Print average values from //FIELD_1// (must be a numerical field). If the
 
28
    **by** clause is included, group averages by distinct values in //FIELD_2//.
 
29
: **-list** //FIELD_1// by //FIELD_2//
 
30
    List all values of //FIELD_1//, grouped by distinct values in //FIELD_2//.
 
31
: **-plot** //FIELD_1// by //FIELD_2//
 
32
    Like **-list**, but display a graphical scatterplot of the results.
 
33
    //FIELD_1// must be a numerical field.
 
34
: **-match** //FIELD// //VALUE//
 
35
    Only display records where //FIELD// has the given //VALUE//. This option may
 
36
    be used to filter the results of subsequent commands.
 
37
: **-show** '//FIELD// [//FIELD//]...'
 
38
    Display the given fields for all records.
 
39
 
 
40
 
 
41
==Fields==
 
42
 
 
43
The **~/.tovid/stats.tovid** file has accumulated a lot of fields containing data
 
44
originally intended only for developers. Some fields aren't very useful, or are
 
45
cryptically named, but here's the complete list anyway:
 
46
 
 
47
- tovid_version
 
48
- final_name
 
49
- length
 
50
- format
 
51
- tvsys
 
52
- final_size
 
53
- tgt_bitrate
 
54
- avg_bitrate
 
55
- peak_bitrate
 
56
- gop_minsize
 
57
- gop_maxsize
 
58
- encoding_time
 
59
- cpu_model
 
60
- cpu_speed
 
61
- in_vcodec
 
62
- in_acodec
 
63
- encoding_mode
 
64
- in_md5
 
65
- in_width
 
66
- in_height
 
67
- quant
 
68
- kbpm
 
69
- enc_time_ratio
 
70
- backend
 
71
 
 
72
 
 
73
==Examples==
 
74
 
 
75
See how many times you've used each version of tovid:
 
76
 
 
77
```
 
78
tovid-stats -count tovid_version
 
79
```
 
80
 
 
81
To see a scatterplot of bitrates needed by each format:
 
82
 
 
83
```
 
84
tovid-stats -plot avg_bitrate by format
 
85
```
 
86
 
 
87
To filter results, use the -match option. For example, to show the filename
 
88
and output size of all SVCD-format encodings, do:
 
89
 
 
90
```
 
91
tovid-stats -match format svcd -show 'final_name final_size'
 
92
```
 
93
 
 
94
Use multiple -match options to filter further, i.e.:
 
95
 
 
96
```
 
97
tovid-stats -match format dvd -match tvsys pal [-show etc.]
 
98
```
 
99
 
 
100
 
 
101
==See also==
 
102
 
 
103
**idvid**(1), **makedvd**(1), **makemenu**(1), **makeslides**(1),
 
104
**makevcd**(1), **makexml**(1), **postproc**(1), **tovid**(1), **todisc**(1)
 
105
 
 
106
 
 
107
==Contact==
 
108
 
 
109
For further assistance, contact information, forum and IRC links,
 
110
please refer to the [tovid homepage http://tovid.org/].