New version of mcut, documentation update
[enigma2-plugins.git] / moviecut / Readme-MovieCut.txt
1 MovieCut-1.3
2 ------------
3 2009-12-04
4 Anders Holst (aho@sics.se)
5
6
7 This module makes it possible to execute the cuts specified by the
8 Cutlist editor on DM7025, i.e. the specified sections are actually
9 removed from the file, saving disk space and simplifying if the movie
10 is to be e.g. burned to a DVD. When installed it will be accessible
11 from the file list menu (i.e. selecting a file in the file list and
12 pressing the menu button) under the name "Execute cuts...". First use
13 the Cutlist editor to set the appropriate cut marks. Then select 
14 "Execute cuts..." and it will give some options for usage.
15
16 The real work is done by the program "mcut". It was inspired and
17 guided by the similar package "moviecutter" bu Georges. However, you
18 need not wait over the night but it can run in the background as you
19 keep watching on your dreambox, and a typical movie takes about 15-20
20 minutes to process. The program "mcut" can also be called directly
21 from a shell. With no arguments it will give a brief description of
22 the options.
23
24
25 News since version 1.2
26
27 * The same mcut program can now cut movies on both DM7025 and
28   DM800/DM8000, and both normal and HD movies. There may still be some
29   flickering at the cut points, especially on DM800/DM8000, but rather
30   limited.
31
32 (* There is a driver change on DM7025 that makes movies cut with the
33    old mcut program (1.2 and earlier) to show much more flickering at
34    the cut points than before. Therefore you should change to he new
35    version, 1.3, even if you have only a DM7025 and thus no HD movies.)
36
37 * The mcut program now cuts the new .sc files too (making precise fast
38   forward and rewind possible), and copies the .eit as well (making
39   the info button work on cut movies).
40
41 * Some code cleanup.
42
43
44 News since version 1.1
45
46 * Nothing really is supposed to have changed functionally. However,
47   the plugin is updated to the skin changes of 2008-04-14, and the
48   location changes of 2008-06-28, and it uses eConsoleAppContainer
49   instead of spawnv/waitpid to launch "mcut".
50
51
52 News since version 1.0
53
54 * Cutting is still in the background, but now a notification will pop
55   up either when cutting is successfully finished, or with a suitable
56   error message if cutting fails.
57
58 * The cutting can now be done quite exact: If all cut marks are placed
59   at GOP boundaries (singlestep GOPs by pausing and pressing either
60   "rewind" or with the appropriate settings "pause"), then the
61   retained part will start with the same frame you were at when you
62   placed the IN cut, and it will stop just a few frames before
63   (typically 3 frames before - I can't easily get rid of this) the one
64   where you placed the OUT cut. Note however that due to a bug in
65   enigma2 (still there 2008-02-28) the CutListEditor will set the mark
66   at the right place, but when revisiting the mark you will end up one
67   GOP later. Trust the original mark position, not where it seems to
68   be when jumping to it.
69
70 * There are no flickering between cuts any more! There is a small (3
71   frames long) pause before the next cut starts, but all flickering
72   and squares seem to be gone. I believe this is as good as it can get
73   without remuxing.
74
75
76 Caveats
77
78 * Since some time in the spring 2008 there seems to be a change/bug in
79   enigma2 that makes the elapsed time calculation somewhat offset
80   compared to earlier. This appears such that cut marks placed with
81   earlier versions appears to have drifted when watched in the new
82   version of enigma2. MovieCut is still callibrated to the earlier
83   calculation, and may thus also place the cuts somewhat offset from
84   the intended places. Always cut to a new file and check the result
85   to be on the safe side!
86
87 * The manual specification of cuts in the "advanced cut parameter"
88   dialogue is as awkward as before to specify with the remote control:
89   "0" is mapped to ".","0", and ":" since this was most
90   straightforward to implement using existing python code. Also note
91   that the cuts are given in pairs of *included* sections, not
92   *excluded* as in the cutlist editor (i.e. there is first an IN time,
93   followed by OUT, and so on).
94
95 * Although the flickering between cuts may be gone when looking at the
96   movie on the dreambox, there is no guarantee that they are gone when
97   trying to convert it to mpeg for burning to DVD or similar. It is
98   not even guaranteed that they can be easily converted at all - at
99   least one program is reported to fail to continue after the first
100   cut.
101
102
103 Disclaimer
104
105 I have really tried to be careful and make it reasonably "safe": It
106 checks for errors during the process and will abort in a controlled
107 way if it happens; If "-r"="replace" is specified, it will not remove
108 any files until the whole cutting is successfully done; if "-r" is not
109 given it will not overwrite any existing file with the same name as the
110 destination; if no cuts are specified nothing will be done; etc.
111
112 However, all use will be on your own risk. I will not take
113 responsibility for any damage or loss of movies or other files due to
114 either bugs in the program or uncareful use. 
115