Add a title clip to the timeline
[vidi-player.git] / vidi-timeline.py
1 #!/usr/bin/env python3
2 #
3 # vidi-timeline - generate GStreamer Editing Services timelines from midi
4 #
5 # Copyright (C) 2016  Antonio Ospite <ao2@ao2.it>
6 #
7 # This program is free software: you can redistribute it and/or modify
8 # it under the terms of the GNU General Public License as published by
9 # the Free Software Foundation, either version 3 of the License, or
10 # (at your option) any later version.
11 #
12 # This program is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 # GNU General Public License for more details.
16 #
17 # You should have received a copy of the GNU General Public License
18 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
19
20 import os
21 import sys
22 import mido
23 import vidi
24
25 # TODO: turn these into command line options
26 ADD_REST_BACKGROUND = True
27 ADD_TITLE = True
28 TITLE_TEXT = None
29 TITLE_DURATION = 5
30 TITLE_CREDITS = "Created with vidi-timeline\nhttps://git.ao2.it/vidi-player.git"
31
32
33 def timeline_from_midi(midi_file, video_font_path):
34     timeline = vidi.Timeline()
35
36     if ADD_TITLE:
37         title = TITLE_TEXT
38         if not title:
39             title = os.path.splitext(os.path.basename(midi_file.filename))[0]
40             title += "\n\n"
41             title += TITLE_CREDITS
42
43         timeline.add_title_clip(title, 0, TITLE_DURATION)
44
45         elapsed_time = start_time = TITLE_DURATION
46     else:
47         elapsed_time = start_time = 0
48
49     for msg in midi_file:
50         elapsed_time += msg.time
51         if vidi.is_note_on(msg) and msg.channel == 0:
52             start_time = elapsed_time
53         elif vidi.is_note_off(msg) and msg.channel == 0:
54             note = vidi.MidiNote(msg.note)
55             duration = elapsed_time - start_time
56             print("Note name: %3s start_time: %f duration: %f" %
57                   (note.name, start_time, duration))
58
59             video_sample_path = "%s/sample_%s.webm" % (video_font_path, note.name)
60
61             timeline.add_clip(video_sample_path, start_time, duration)
62
63     if ADD_REST_BACKGROUND:
64         rest_sample_path = "%s/sample_rest.png" % video_font_path
65         timeline.add_layer_clip(rest_sample_path, 0, elapsed_time)
66
67     return timeline
68
69
70 def usage():
71     print("usage: %s <midi_file> <videofont_directory> [<destination_file>]"
72           % os.path.basename(sys.argv[0]))
73
74
75 def main():
76     if len(sys.argv) > 1 and sys.argv[1] in ["-h", "--help"]:
77         usage()
78         return 0
79
80     if len(sys.argv) < 3:
81         usage()
82         return 1
83
84     if not os.path.isdir(sys.argv[2]):
85         sys.stderr.write("The second argument must be the path of the videofont directory\n")
86         usage()
87         return 1
88
89     if len(sys.argv) > 3 and os.path.exists(sys.argv[3]):
90         sys.stderr.write("File '%s' exists, exiting!\n" % sys.argv[3])
91         return 1
92
93     midi_file = mido.MidiFile(sys.argv[1])
94
95     overlapping_notes = vidi.check_overlapping_notes(midi_file)
96     if overlapping_notes:
97         sys.stderr.write("Sorry, supporting only midi file with no overlapping notes on channel 0\n")
98         return 1
99
100     video_font_path = os.path.realpath(sys.argv[2])
101
102     timeline = timeline_from_midi(midi_file, video_font_path)
103
104     if len(sys.argv) > 3:
105         timeline.save(sys.argv[3])
106     else:
107         try:
108             timeline.play()
109         except KeyboardInterrupt:
110             timeline.stop()
111             return 1
112
113
114 if __name__ == "__main__":
115     sys.exit(main())