summaryrefslogtreecommitdiff
path: root/examples
diff options
context:
space:
mode:
authorCarl Hetherington <cth@carlh.net>2012-08-22 19:14:33 +0100
committerCarl Hetherington <cth@carlh.net>2012-08-22 19:14:33 +0100
commit5d9c51436fe44785dec918af133c9f2e09d5d8d0 (patch)
treeb4a3991d09e04ee98294e41e9d8adf83081fb6a1 /examples
parent737c1fa7c4822365c0d548c7a8a3d3f3e8cc32a5 (diff)
Use make_dcp example in documentation.
Diffstat (limited to 'examples')
-rw-r--r--examples/make_dcp.cc21
1 files changed, 18 insertions, 3 deletions
diff --git a/examples/make_dcp.cc b/examples/make_dcp.cc
index 41026cc2..5b764393 100644
--- a/examples/make_dcp.cc
+++ b/examples/make_dcp.cc
@@ -17,13 +17,20 @@
*/
-/* This example file shows how to make a DCP from some JPEG2000 and WAV files
- using libdcp.
-*/
+/** @file examples/make_dcp.cc
+ * @brief Shows how to make a DCP from some JPEG2000 and WAV files.
+ */
#include <vector>
#include <string>
#include <sigc++/sigc++.h>
+
+/* If you are using an installed libdcp, these #includes would need to be changed to
+#include <libdcp/dcp.h>
+#include <libdcp/picture_asset.h>
+... etc. ...
+*/
+
#include "dcp.h"
#include "picture_asset.h"
#include "sound_asset.h"
@@ -67,6 +74,14 @@ main ()
/* Now we will create a `sound asset', which is made up of a WAV file for each channel of audio. Here we're using
stereo, so we add two WAV files to a vector.
+
+ We could add more files here to use more channels; the file order is:
+ Left
+ Right
+ Centre
+ LFE (sub)
+ Left surround
+ Right surround
*/
std::vector<std::string> sound_files;
sound_files.push_back ("examples/sine_440_-12dB.wav");