~james2432/hyberia/Readouid

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
touei README
============

1) Authors and thanks
----------------

* Mathieu Charron  (LP: elwillow)
* Jamie Nadeau     (LP: james2432)
* Martin Samson    (LP: pyrolian)

contribution from:

* No one yet.

Thanks to:

The MPlayer project for their outstanding player
Matroska for their great container that don't suck.
Gentoo et Funtoo for their Distro.

2) Licensing
------------

Eiffel Forum License, version 2

1. Permission is hereby granted to use, copy, modify and/or
   distribute this package, provided that:
      * copyright notices are retained unchanged,
      * any distribution of this package, whether modified or not,
        includes this license text.
2. Permission is hereby also granted to distribute binary programs
   which depend on this package. If the binary program depends on a
   modified version of this package, you are encouraged to publicly
   release the modified version of this package.

THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT WARRANTY. ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHORS BE LIABLE TO ANY PARTY FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THIS PACKAGE.

3) Requirements
---------------

* Python 2.6
* C compiler (like gcc)
* mkvtoolnix
* MPlayer with demuxer for you video files
* Custom xorg configuration (optional)
* Your video file with specific filename
* Enough of disk space for the video muxing

@TODO: Missing how to configure xorg and initrc
@TODO: add source for software


4) Installation
---------------

** filename pattern **

First you need to rename your file according to a specific pattern:
* The first 4 characters are the time the video will be played in
  24 military hours format (4h00 PM = 1600).
  You time need to comply to a _modulus 5_. 1604 is not valid.

* A dot "."

* The name of the video. it will be used for the subtitling of the
  introduction video. It NEEDS to be unique.
  NO SPACE. Use underscore, they will be replace by space. Also, don't
  worry about the case, it will be `Title` for the intro video.

* The ".mkv" string for extension.

If you want to play "Higurashi no Naku Koro ni" at 3h45 PM the filename
will be:

- 1545.Higurashi_no_Naku_Koro_ni.mkv

** File structure **

The file structure is simple, inside the folder in the LOCATION config
entry you will need one folder for each day. If Sunday is the 3rd (of any
month) simple create a folder name "04" and put your files (named accordinly)
in that folder.
If the location does not exist, the script will die.
The script will also create the folder structure in the TMP-LOCATION.
If you are not sure what is the structure delete the TMP-LOCATION folder
and it will be recreated.

Since the default is in the /tmp you should worry to much, it is wipe
at each reboot. Just make sure there is enough space for the intro video.


5) Configuration
----------------

Please see the touei.conf.sample for the configuration instruction.

The default location is /etc/touei.conf. You can set a different path
in the touei_run file (located in /usr/local/bin) but it will break the
daemon.

6) Reference
-----------

Subtitle: http://www.matroska.org/technical/specs/subtitles/ssa.html
Video Container: http://www.matroska.org/node/46


# EOF