summaryrefslogtreecommitdiff
path: root/README.webvi
blob: 62a328d0de2a30d237f2388a8237a6010dcf3045 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
webvi - command line web video downloader

Copyright 2009-2012 Antti Ajanki <antti.ajanki@iki.fi>

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or (at
your option) any later version. See the file COPYING for more
information.

Description
-----------

Webvi is a tool for downloading and playing videos from popular video
sharing websites such as YouTube. See README for the full list of
supported sites.

Installation
------------

Install the following packages including development files for the
libraries:

cmake
pkg-config
quvi
libcurl
libxml2
glib-2.0
libtidy

To compile and install the command line client (without VDR plugin;
see main README if you have VDR installed) run

mkdir objs
cd objs
cmake ..
make

By default the program is installed under /usr/local. You can specify
a different installation location by

make PREFIX=/usr

Running
-------

webvi --templatedir=/usr/local/share/webvi/templates

The parameter --templatedir can be left out if the default PREFIX was
used in make install-library.

Command line parameters
-----------------------

-h, --help                  show this help message and exit
-t DIR, --templatepath=DIR  read video site templates from DIR
--vfat                      generate Windows compatible filenames
-u URL, --url=URL           Download video from URL and exit
-v, --verbose               debug output

Usage
-----

The content of video sharing websites is presented as series of menus.
The menus consists of two kinds of links. Navigation links, which are
be identified by [brackets], are used to navigate the site.
Non-bracketed links are media streams that can be downloaded or
played.

Following commands are recognized:

help       Show help
select x   Select a link whose index is x
download x Download a media stream. x is menu index or video page URL.
stream x   Play a media stream. x is menu index or video page URL.
back       Go backward in history
forward    Go forward in history
display    Redisplay the current menu
menu       Go back to the main menu
quit       Quit the program

x is an index of menu item or an address of a video page (download and
stream commands). A plain number without a command follows a link
(like "select") or downloads a stream (like "download") if the item is
not a navigation link.

The command line option --url runs a single download mode that
downloads a video from the the given URL and exits. URL must point to
a video page on one of the supported sites (see README).

Config file
-----------

Config files /etc/webvi.conf and ~/.webvi configure the behavior of
the program. An example configuration file debian/webvi.conf is
included in the sources.

The config files are in ini format. The following items are recognized
in section [webvi]:

streamplayer1, ..., streamplayer9

streamplayer1 to streamplayer9 are alternative media players to be
used for streaming. The substring %s will be replaced by the stream
URL. The players are tried one by one starting from streamplayer1
until one of them succeeds playing the stream. If no players are
defined in config files then vlc, totem, mplayer, and xine are tried
(in that order).

templatepath

Path to video site templates.

vfat

Generate Windows compatible filenames. Allowed values: true, false.

verbose

Write debug output to stdin. Allowed values: true, false.

Quality of the downloaded and streamed videos can be selected in video
site specific sections. Currently only YouTube module (section should
be called [www.youtube.com]) supports multiple qualities. The
following options are recognized:

download-min-quality, download-max-quality

Minimum and maximum allowed quality when saving the video to disc. The
default is to download the best available version of the video.

stream-min-quality, stream-max-quality

Minimum and maximum allowed quality when playing the video. The
default is to download the best available version of the video.

For Youtube, the available quality scores are:

  50: standard quality (320x240, i.e. what you get in the web browser)
  60: 480x360 MP4
  65: 480p WebM
  70: 720p MP4
  75: 720p WebM
  80: 1080p MP4