-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathHACKING.html
319 lines (287 loc) · 12.8 KB
/
HACKING.html
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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
<!DOCTYPE html>
<html lang="en">
<head>
<base href=".">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Hacking on Pitivi</title>
<link rel="stylesheet" href="assets/css/dark-frontend.css" type="text/css" title="dark">
<link rel="alternate stylesheet" href="assets/css/light-frontend.css" type="text/css" title="light">
<link rel="stylesheet" href="assets/css/bootstrap-toc.min.css" type="text/css">
<link rel="stylesheet" href="assets/css/jquery.mCustomScrollbar.min.css">
<link rel="stylesheet" href="assets/js/search/enable_search.css" type="text/css">
<link rel="stylesheet" href="assets/css/prism-tomorrow.css" type="text/css" title="dark">
<link rel="alternate stylesheet" href="assets/css/prism.css" type="text/css" title="light">
<script src="assets/js/mustache.min.js"></script>
<script src="assets/js/jquery.js"></script>
<script src="assets/js/bootstrap.js"></script>
<script src="assets/js/scrollspy.js"></script>
<script src="assets/js/typeahead.jquery.min.js"></script>
<script src="assets/js/search.js"></script>
<script src="assets/js/compare-versions.js"></script>
<script src="assets/js/jquery.mCustomScrollbar.concat.min.js"></script>
<script src="assets/js/bootstrap-toc.min.js"></script>
<script src="assets/js/jquery.touchSwipe.min.js"></script>
<script src="assets/js/anchor.min.js"></script>
<script src="assets/js/tag_filtering.js"></script>
<script src="assets/js/language_switching.js"></script>
<script src="assets/js/styleswitcher.js"></script>
<script src="assets/js/lines_around_headings.js"></script>
<script src="assets/js/prism-core.js"></script>
<script src="assets/js/prism-autoloader.js"></script>
<script src="assets/js/prism_autoloader_path_override.js"></script>
<script src="assets/js/trie.js"></script>
<link rel="shortcut icon" href="assets/images/favicon.png">
</head>
<body class="no-script
">
<script>
$('body').removeClass('no-script');
</script>
<nav class="navbar navbar-fixed-top navbar-default" id="topnav">
<div class="container-fluid">
<div class="navbar-right">
<a id="toc-toggle">
<span class="glyphicon glyphicon-menu-right"></span>
<span class="glyphicon glyphicon-menu-left"></span>
</a>
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar-wrapper" aria-expanded="false">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<span title="light mode switch" class="glyphicon glyphicon-sunglasses pull-right" id="lightmode-icon"></span>
<form class="navbar-form pull-right" id="navbar-search-form">
<div class="form-group has-feedback">
<input type="text" class="form-control input-sm" name="search" id="sidenav-lookup-field" placeholder="search" disabled>
<span class="glyphicon glyphicon-search form-control-feedback" id="search-mgn-glass"></span>
</div>
</form>
</div>
<div class="navbar-header">
<a id="sidenav-toggle">
<span class="glyphicon glyphicon-menu-right"></span>
<span class="glyphicon glyphicon-menu-left"></span>
</a>
<a id="home-link" href="index.html" class="hotdoc-navbar-brand">
<img src="assets/images/pitivi.svg" alt="Home">
</a>
</div>
<div class="navbar-collapse collapse" id="navbar-wrapper">
<ul class="nav navbar-nav" id="menu">
</ul>
<div class="hidden-xs hidden-sm navbar-text navbar-center">
<p><b>The Pitivi Developer Documentation</b></p>
</div>
</div>
</div>
</nav>
<main>
<div data-extension="core" data-hotdoc-in-toplevel="True" data-hotdoc-project="Pitivi" data-hotdoc-ref="HACKING.html" class="page_container" id="page-wrapper">
<script src="assets/js/utils.js"></script>
<div class="panel panel-collapse oc-collapsed" id="sidenav" data-hotdoc-role="navigation">
<script src="assets/js/full-width.js"></script>
<div id="sitenav-wrapper">
<iframe src="hotdoc-sitemap.html" id="sitenav-frame"></iframe>
</div>
</div>
<div id="body">
<div id="main">
<div id="page-description" data-hotdoc-role="main">
<h1 id="hacking-on-pitivi">Hacking on Pitivi</h1>
<p>To develop Pitivi on Linux you need to set up a development environment,
as described below. For <a href="crossplatform.html">other platforms</a>, get in
touch with us.</p>
<p>By setting up a development environment, you create a
<a href="https://flatpak.org">flatpak</a> sandbox containing all the Pitivi
dependencies. The sandbox is then used to run Pitivi and the unittests,
without messing your system.</p>
<p>Start by installing <strong>both</strong> <a href="http://flatpak.org/getting.html">flatpak</a>
and <code>flatpak-builder</code> on your system.</p>
<p>Create a development environment folder and get the <a href="http://gitlab.gnome.org/GNOME/pitivi">Pitivi source
code</a> into it:</p>
<pre><code>$ mkdir pitivi-dev
$ cd pitivi-dev
$ git clone https://gitlab.gnome.org/GNOME/pitivi.git
</code></pre>
<p>Whenever you want to hack on Pitivi, start a new terminal and enter the
development environment:</p>
<pre><code>$ cd pitivi-dev/pitivi && source bin/pitivi-env
-> Setting up the prefix for the sandbox...
Using Pitivi prefix in /.../pitivi-dev/pitivi-prefix
[prefix being built, if not already...]
Running in sandbox: echo Prefix ready
Prefix ready
</code></pre>
<p>When creating the sandbox from scratch it can take up to a few hours,
depending on your internet connection speed and the CPU. Note the prompt
changes:</p>
<pre><code>(ptv-flatpak) $
</code></pre>
<p>By entering the development environment, you get:</p>
<ul>
<li>a <a href="http://docs.flatpak.org/en/latest/working-with-the-sandbox.html">Flatpak sandbox</a>
with dependencies and some development tools, in <code>pitivi-dev/pitivi-prefix</code>
</li>
<li>the <a href="http://mesonbuild.com/Quick-guide.html">Meson build directory</a>,
in <code>pitivi-dev/pitivi/mesonbuild</code>
</li>
<li>some aliases for the build tools, such as <code>ninja</code>, so they are executed in the sandbox.</li>
</ul>
<p>Now that you are in the development environment, try running the
<a href="Testing.html">unittests</a>:</p>
<pre><code>(ptv-flatpak) $ ptvtests
Running in sandbox: gst-validate-launcher .../pitivi/tests/ptv_testsuite.py
</code></pre>
<p>Hack away, and check the effect of your changes by simply running:</p>
<pre><code>(ptv-flatpak) $ pitivi
</code></pre>
<h2 id="updating-the-development-environment">Updating the development environment</h2>
<p>To update the dependencies installed in the sandbox, run:</p>
<pre><code>(ptv-flatpak) $ ptvenv --update
</code></pre>
<p>That will actually recreate the sandbox prefix, updating all
dependencies from their git repos and tarballs as defined in the
<a href="https://gitlab.gnome.org/GNOME/pitivi/blob/master/build/flatpak/org.pitivi.Pitivi.json">flatpak
manifest</a>.</p>
<h3 id="how-we-use-the-sandbox">How we use the sandbox</h3>
<p>The sandbox we set up has access to the host file system. This allows
running the Python modules in <code>pitivi-dev/pitivi/pitivi/...</code> on top of
the GNOME + Pitivi dependencies system installed in the sandbox.
Without this trick, you'd have to build and install every time when you
change a <code>.py</code> file, to be able to test how it works, which would be
annoying because it takes a non-negligible amount of time.</p>
<p>We don't actually run Pitivi 100% uninstalled. Besides the <code>.py</code> files
there are other parts which need to be built when changed or even
installed before using them:</p>
<ul>
<li>
<p>Select parts of Pitivi are written in C, such as the audio envelope
renderer for the audio clips. Build them with <code>ninja -C mesonbuild/</code> or
with our very own alias <code>build</code>, which is the same thing. No need to
install them.</p>
</li>
<li>
<p>Similarly, <code>bin/pitivi.py.in</code> and <code>pitivi/configure.py.in</code> also need
to be built with <code>build</code>, to regenerate the corresponding <code>.py</code> files.</p>
</li>
<li>
<p>The translations need to be built and installed, which can be done
with <code>binstall</code>. See "Switching locales" below.</p>
</li>
</ul>
<h2 id="hacking-on-pitivi-dependencies-meson">Hacking on Pitivi dependencies (Meson)</h2>
<p>If you have to work on say, <a href="https://gstreamer.freedesktop.org/modules/gst-editing-services.html">GStreamer Editing
Services</a>
which is built using the Meson build system, first clone it into your
<code>pitivi-dev</code> folder:</p>
<pre><code>(ptv-flatpak) $ cd pitivi-dev
(ptv-flatpak) $ git clone [email protected]:gstreamer/gst-editing-services.git
</code></pre>
<p>Prepare its build directory using the <code>setup</code> alias which runs <code>meson</code>. This has
to be done only once:</p>
<pre><code>(ptv-flatpak) $ cd pitivi-dev/gst-editing-services
(ptv-flatpak) $ setup
Using Pitivi prefix in /.../pitivi-dev/pitivi-prefix
Running in sandbox: meson mesonbuild/ --prefix=/app --libdir=lib
</code></pre>
<p>Build and install it in the sandbox:</p>
<pre><code>(ptv-flatpak) $ cd pitivi-dev/gst-editing-services
(ptv-flatpak) $ ninja -C mesonbuild/ install
Using Pitivi prefix in /.../pitivi-dev/pitivi-prefix
Running in sandbox: ninja -C mesonbuild/ install
</code></pre>
<p>In the <code>(ptv-flatpak)</code> development environment <code>meson</code> and <code>ninja</code> are aliases
which run meson and ninja in the flatpak sandbox.</p>
<p>NOTE: When updating the environment with <code>ptvenv --update</code>, it will use your
local dependencies repositories it finds in the <code>pitivi-dev</code> folder, instead of
the default remote repositories. This means you have to update them yourself.
Also beware that it only takes into account committed changes.</p>
<h2 id="hacking-on-pitivi-dependencies-autotools-make-etc">Hacking on Pitivi dependencies (Autotools, Make, etc)</h2>
<p>If the project you are working on is built with other tools, make sure
they are run in the sandbox by using <code>ptvenv</code>. For example:</p>
<pre><code>(ptv-flatpak) $ cd pitivi-dev/frei0r-plugins-1.4
(ptv-flatpak) $ ptvenv ./autogen.sh
Running in sandbox: ./autogen.sh
(ptv-flatpak) $ ptvenv ./configure
Running in sandbox: ./configure
(ptv-flatpak) $ ptvenv make
Running in sandbox: make
</code></pre>
<h2 id="profiling-pitivi">Profiling Pitivi</h2>
<p>To profile a Pitivi run, simply set the <code>PITIVI_PROFILING</code> environment
variable to 1, like so:</p>
<pre><code>(ptv-flatpak) $ PITIVI_PROFILING=1 pitivi
</code></pre>
<p>A file named <code>pitivi-runstats</code> will be created in the current directory, a handy tool to examine it is <code>gprof2dot.py</code>, install it with:</p>
<pre><code>$ pip install gprof2dot
</code></pre>
<p>Then run:</p>
<pre><code>$ gprof2dot -f pstats pitivi-runstats | dot -Tsvg -o profile.svg
</code></pre>
<p>You can then inspect the call tree profile with your preferred image viewer:</p>
<pre><code>$ xdg-open profile.svg
</code></pre>
<h2 id="switching-locales">Switching locales</h2>
<p>To see how Pitivi looks in a different locale, use:</p>
<pre><code>(ptv-flatpak) $ LANG=fr_FR.UTF-8 pitivi
</code></pre>
<p>Pay attention the translations in the sandbox are not automatically
updated when you <code>git pull</code>. You can update them by updating your
sandbox (<code>ptvenv --update</code>) or by reinstalling Pitivi in the sandbox:</p>
<pre><code>(ptv-flatpak) $ binstall
[...]
Installing /.../pitivi-dev/pitivi/mesonbuild/po/de.gmo to /app/share/locale/de/LC_MESSAGES/pitivi.mo
[...]
</code></pre>
</div>
<div id="subpages">
<p><b>Subpages:</b></p>
<div class="thumb-subpages">
</div>
<p>
<a href="Development_workflow.html">Development Workflow</a>
– How we do it
</p>
<p>
<a href="Git.html">Using Git in Pitivi</a>
– Specifics of using Git in Pitivi
</p>
<p>
<a href="Coding_style_guide.html">Coding Style Guide</a>
– Writing code that looks consistent
</p>
<p>
<a href="Command_line_tools.html">Command line tools</a>
– A list of tools useful when developing Pitivi
</p>
<p>
<a href="Inspecting_UI.html">Hacking the UI</a>
– How to enable and use the GTK Inspector
</p>
<p>
<a href="Debugging.html">Debugging</a>
</p>
</div>
</div>
<div id="search_results">
<p>The results of the search are</p>
</div>
<div id="footer">
</div>
</div>
<div id="toc-column">
<div class="edit-button">
<a href="https://gitlab.gnome.org/GNOME/pitivi/edit/master/docs/HACKING.md" data-hotdoc-role="edit-button">Edit on GitLab</a>
</div>
<div id="toc-wrapper">
<nav id="toc"></nav>
</div>
</div>
</div>
</main>
<script src="assets/js/navbar_offset_scroller.js"></script>
</body>
</html>