summaryrefslogtreecommitdiff
path: root/src/util.cc
diff options
context:
space:
mode:
authorCarl Hetherington <cth@carlh.net>2013-01-13 12:55:21 +0000
committerCarl Hetherington <cth@carlh.net>2013-01-13 12:55:21 +0000
commite5432f1ef35ec5a68a0a3c2d10f76f7582e8852c (patch)
tree0353ed20d7bacd91598e1e2b367dad9bf313d9e6 /src/util.cc
parent67dc9215dc549b2402f1c8bbd744c172da248c7a (diff)
Comment tweaks.
Diffstat (limited to 'src/util.cc')
-rw-r--r--src/util.cc15
1 files changed, 15 insertions, 0 deletions
diff --git a/src/util.cc b/src/util.cc
index 2b3a6c8d..78ef7676 100644
--- a/src/util.cc
+++ b/src/util.cc
@@ -43,6 +43,9 @@ using std::max;
using boost::shared_ptr;
using namespace libdcp;
+/** Create a UUID.
+ * @return UUID.
+ */
string
libdcp::make_uuid ()
{
@@ -53,6 +56,13 @@ libdcp::make_uuid ()
return string (buffer);
}
+
+/** Create a digest for a file.
+ * @param filename File name.
+ * @param progress If non-0, a signal which will be emitted periodically to update
+ * progress; the parameter will start at 0.5 and proceed to 1.
+ * @return Digest.
+ */
string
libdcp::make_digest (string filename, boost::signals2::signal<void (float)>* progress)
{
@@ -94,6 +104,11 @@ libdcp::make_digest (string filename, boost::signals2::signal<void (float)>* pro
return Kumu::base64encode (byte_buffer, 20, digest, 64);
}
+/** Convert a content kind to a string which is representative,
+ * but not necessarily human-readable.
+ * @param kind ContentKind.
+ * @return string.
+ */
string
libdcp::content_kind_to_string (ContentKind kind)
{