summaryrefslogtreecommitdiff
path: root/README
blob: d06bd8a672859dade0f6d9987b52108512fc91fa (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
146
147
148
This is a "plugin" for the Video Disk Recorder (VDR).

Originaly written by:           Kai Tobias Burwieck <kai-at-burwieck.net>
                                "Interpohl" <interpohl-at-vdr-portal.de>
                                Onno Kreuzinger <o.kreuzinger-at-kreuzinger.biz>
                                Andreas Brachold <vdr04-at-deltab.de>

Former project's homepage:      http://www.burwieck.net/vdr (dead?)
                                http://vdr-image.kreuzinger.biz>

Maintainer:                     Andreas Brachold <vdr04-at-deltab.de>

Project homepage:               http://deltab.de/vdr/image.html

Some files are from the mp3/MPlayer Plugin.	Thanks to Stefan Hülswitt


Required:
-----------
- fullfeatured dvb card
- vdr 1.2.6+, series vdr 1.3.0 work too
- to compile plugin depends package libavcodec1-dev (tested with ffmpeg-0.4.8)
- to run your will need package netpbm and libavcodec1*
- netpbm 10.0+ (check for "anytopnm", if  it does not exist upgrade/install netpbm)
- not necessary but useful utils/file (file) for better imagetyp detection, used by anytopnm

*) it's use libavcodec.so, also static linking possible with compile #> make plugin FFMPEG_STATIC=1

Important Note:
if tools are installed by source absolutely also for it provide that the 
programs (anytopnm pnmscale pnmfile pnmcut pnmflip) are inside the search-path, 
otherwise adapt the variable "PATH"  within the file imageplugin.sh.

Install:
------------
Install the plugin part as usual (see vdr docs if you not know already).

Compile  depends package libavcodec1-dev, libavcodec1 or also know ffmpeg.
later for run your will only need libavcodec1(libavcodec.so) and netpbm.
("apt-get install libavcodec1-dev libavcodec1 netpbm" on Debian)

In the ./examples directory you can find a sample file for
imagesources.conf, change this file if needed and place it in
the plugins folder in your config folder (the video folder by default).

The syntax is :
<path>;<name in vdr menu>;<0/1>;<pattern to filter file display>

examples:
/media/cdrom;CDROM;1;*.jpg *.jpeg *.png *.tif* *.bmp
/archive/photos/holiday;Holiday pictures;0;DSC10*.jpg

0/1 is for media that need to be mounted (uses the same mount.sh
as mplayer/mp3 plugin).


The file ./scripts/imageplugin.sh could go to /usr/bin, or any other folder in your path.
You can also use the plugin options (vdr -help after installing the plugin) to specify
the path's to the files, if you don't want to those files in you system.
[ e.g.: ./vdr '-Pimage -C /path/imageplugin.sh -m /path/mount.sh' ...]
The install.sh in the examples folder will try a automatic install, give it a try if it fails else.

Manual:
------------
Start the plugin, than select a file (or folder) and press OK.


At all modi
   OK          toggle OSD informations
   Play/Pause  begin/halt slide
   Stop/Blue   stop plugin
   Red         open menu with imagecommands
 
While watching pictures
   Back        stop plugin
 
   Left        previous picture
   Right       next picture
   Down        jump three pictures back
   Up          jump three pictures forward

   7           jump five pictures back
   9           jump five pictures forward
 
   0           view original image
   1           Rotate 90 Grad counter clockwise
   3           Rotate 90 Grad clockwise direction
 
   4 	       slide show - decrease the time (seconds) each picture shows
   6 	       slide show - increase the time (seconds) each picture shows
   5           Zoom inside image
   8           Zoom outside image and call Jumpmenu
 
'Zoom menu'
   Back        Zoom outside image 
 
   Left        scroll zoomedframe inside picture to left
   Right       scroll zoomedframe inside picture to right
   Down        scroll zoomedframe inside picture to left
   Up          scroll zoomedframe inside picture to up
 
   0           view original image
   5           Zoom inside image
   8           Zoom outside image 
  
'Jump menu' (3x3 preview):
   Back        view original image
  
   Left        previous picture group (go 9 pictures back)
   Right       next picture group (go to the next 9 pictures)
  
   0           view original image
   1 ... 9     pick the corresponding image

(thx for the english readme/keymapping description to Kai Steinbach)

image commands
------------
The file imagecmds.conf can be used to define commands that can be applied to the 
currently viewed image. The syntax is exactly the same as described for the 
file commands.conf, see "man 5 vdr". If only one instruction is indicated, 
the filename of the image will be appended to the command string, 
separated by a blank and enclosed in single quotes.

Format> Menutext ?: command %s
?  - Confirmation request (optionally)
%s - placeholder for filename (optionally)

See for a sample at examples/imagecmds.conf .


Diagnosis of the scripts and installation
-----------------------------------------
If the script does not work like it should, start the Script to test from the console.

imageplugin.sh [infile] [outfile] [WIDTH] [HEIGHT] [ZOOMFACTOR] [LEFTPOS] [TOPPOS] {FLIPCMD}
e.g. imageplugin.sh myimage.png outfile.pnm 720 576 0 0 0 original

and please examine the produced syslog messages at /var/log/message or messages on console

if that does not help repeats the procedure with > export DEBUG=yes;

export DEBUG=yes;imageplugin.sh myimage.png outfile.pnm 720 576 0 0 0 original

and examine the expenditure on the screendump

*) if script work for your, it's could reduce the message on syslog, 
if your change on imageplugin.sh inside from VERBOSE=yes to VERBOSE=no