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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
|
# 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).
## Building on macOS/arm64
Build `osx-environment` in `$HOME`
```
bash platform/osx/copy_resources.sh
source platform/osx/set_paths.sh
./waf configure --target-macos-arm64
```
## Disk writer logging
As we have no `film' folder to log to during disk writes, the logs end up:
### macOS
* Disk writer backend: `/var/log/dcpomatic_disk_writer_{out,err}.log`
* Disk writer frontend: `/Users/$USER/Library/Preferences/com.dcpomatic/2/2.16/disk.log`
### Windows
* Disk writer backend: `c:\Users\$USER\AppData\Local\dcpomatic\2.16.0\disk_writer.log`
* Disk writer frontend: `c:\Users\$USER\AppData\Local\dcpomatic\2.16.0\disk.log`
### Linux
* Disk writer backend: `/home/$USER/.config/dcpomatic/2.16.0/disk_writer.log`
* Disk writer frontend: `/home/$USER/.config/dcpomatic/2.16.0/disk.log`
## Branches
The `test/data` submodule has the following branches:
* `v2.16.x` - branch for use with v2.16.x versions
* `v2.18.x` - branch for use with v2.18.x versions
## 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
```K 2048```
seeks half-way through the DCP.
* `E`
Stops playback and closes the player.
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`.
- ./waf pot
- cp build/src/lib/libdcpomatic.pot src/lib/po/$LANG.po
- cp build/src/wx/libdcpomatic-wx.pot src/wx/po/$LANG.po
- cp build/src/tools/dcpomatic.pot src/tools/po/$LANG.po
- sed -i "s/CHARSET/UTF-8/" src/{lib,wx,tools}/po/$LANG.po
- Commit / push
- Add credit to `src/wx/about_dialog.cc` and database.
- Add to `i18n.php` on website and `update-i18n-stats` script, then run `update-i18n-stats` script.
## Taking screenshots for the manual
The manual PDF looks nice if vector screenshots are used. These can be taken as follows:
- Build `gtk-vector-screenshot.git` (using meson/ninja)
- Copy `libgtk-vector-screenshot.so` to `/usr/local/lib/gtk-3.0/modules/`
- Run DCP-o-matic using `run/dcpomatic --screenshot`
- Start `take-vector-screenshot`, click "Take screenshot" then click on the DCP-o-matic window.
- Find a PDF in `/tmp/dcpomatic2.pdf`
- Copy this to `doc/manual/raw-screenshots`
## Adding a new variant
Files to edit:
- `cscript`
- `wscript`
- `src/lib/variant.cc`
- `src/tools/wscript`
- `platform/osx/make_dmg.sh`
- `platform/windows/wscript`
- `platform/osx/wscript`
## Cucumber
To run the cucumber tests you will need to build cucumber-cpp:
git clone https://github.com/cucumber/cucumber-cpp.git
cd cucumber-cpp
cmake .
make
sudo make install
It may give warnings about not finding Qt but you can ignore them
(Qt is not required).
You then need three processes:
`run/cucumber_server`
Runs dcpomatic_cucumber (built from step_defintions/dcpomatic.cc):
a means to ask a running DCP-o-matic to do something.
`dcpomatic2 --cucumber`
A DCP-o-matic instance that is listening for dcpomatic_cucumber to send something.
`cucumber .`
The ruby program that performs the steps in the tests.
|
