[Performous-commit] Tapio Vierros : Document file format support.

[Tapio V. <aa...@us...>]

Module: editor
Branch: master
Commit: 94becf34f8c646ea5558876b098cf146c8b06714

Author: Tapio Vierros <tap...@gm...>
Date:   Mon Jan 24 19:00:07 2011 +0200

Document file format support.

---

 docs/FileFormats.txt |   35 +++++++++++++++++++++++++++++++++++
 1 files changed, 35 insertions(+), 0 deletions(-)

diff --git a/docs/FileFormats.txt b/docs/FileFormats.txt
new file mode 100644
index 0000000..d9f8a3d
--- /dev/null
+++ b/docs/FileFormats.txt
@@ -0,0 +1,35 @@
+Editor file format support
+==========================
+
+This document describes to what extent various file formats are supported by the editor.
+
+
+Own project files
+-----------------
+Native save/load format. Preserves operation history (undo buffer). Currently only saves notes, not metadata.
+
+
+SingStar XML
+------------
+Import and export. Round-trip is not perfect: All XML elements except MELODY, TRACK, SENTENCE and NOTE are ignored as are all attributes of SENTENCE-element. Exporter writes some useful comments.
+
+
+UltraStar TXT
+-------------
+Import only, export planned.
+
+
+Frets on Fire MIDI/INI
+----------------------
+No support, but both import and export are planned.
+
+
+Plain text lyrics
+-----------------
+Raw lyrics without any timing data can be read from a file or copied from clipboard. A note is created for each word and a line break indicates sentence end.
+
+
+Music files
+-----------
+The pitch analysis can be performed to any file that FFmpeg can decode. Playback and metadata reading support depends on Phonon media library back-end.
+