Rename DEVELOPMENT -> DEVELOP.md and add some stuff about player stress testing.
authorCarl Hetherington <cth@carlh.net>
Sun, 15 Mar 2020 21:26:19 +0000 (22:26 +0100)
committerCarl Hetherington <cth@carlh.net>
Sun, 15 Mar 2020 21:26:19 +0000 (22:26 +0100)
DEVELOP.md [new file with mode: 0644]
DEVELOPMENT [deleted file]

diff --git a/DEVELOP.md b/DEVELOP.md
new file mode 100644 (file)
index 0000000..6896900
--- /dev/null
@@ -0,0 +1,56 @@
+# DCP-o-matic development notes
+
+This file collects a few notes relevant to DCP-o-matic developers.  There is also some information
+[on the web site](https://dcpomatic.com/development).
+
+
+## Player stress testing
+
+If you configure DCP-o-matic with `--enable-player-stress-test` you can make a script which
+will run and manipulate the player in predictable ways.  The script is a series of commands
+read line-by-line, and each line can be one of:
+
+* `O <path>`
+
+Open a DCP, for example
+
+```O /home/carl/DCP/MyTestDCP```
+
+* `P`
+
+Start playing the currently-loaded DCP.
+
+* `W <time-in-milliseconds>`
+
+Wait for approximately the given time before carrying on, for example
+
+```W 14000```
+
+to wait for 14 seconds.
+
+* `S`
+
+Stop any current playback.
+
+* `K <position>`
+
+Seek to some point in the current DCP, where 0 is the start and 4095 is the end; for example
+
+```S 2048```
+
+seeks half-way through the DCP.
+
+The script can be run using something like
+
+```dcpomatic2_player -s stress```
+
+to load a script file called `stress` and start executing it.
+
+
+Adding a new language
+
+- Edit src/wx/config_dialog.cc to add the language to languages.
+- Add to platform/windows/wscript, platform/osx/make_dmg.sh, cscript.
+- Add credit to src/wx/about_dialog.cc and database.
+- Add to i18n.php on website and update-i18n-stats script.
+
diff --git a/DEVELOPMENT b/DEVELOPMENT
deleted file mode 100644 (file)
index 1bced04..0000000
+++ /dev/null
@@ -1,7 +0,0 @@
-Adding a new language
-
-- Edit src/wx/config_dialog.cc to add the language to languages.
-- Add to platform/windows/wscript, platform/osx/make_dmg.sh, cscript.
-- Add credit to src/wx/about_dialog.cc and database.
-- Add to i18n.php on website and update-i18n-stats script.
-