Doc fixes.
[libdcp.git] / src / util.h
1 /*
2     Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
3
4     This program is free software; you can redistribute it and/or modify
5     it under the terms of the GNU General Public License as published by
6     the Free Software Foundation; either version 2 of the License, or
7     (at your option) any later version.
8
9     This program is distributed in the hope that it will be useful,
10     but WITHOUT ANY WARRANTY; without even the implied warranty of
11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12     GNU General Public License for more details.
13
14     You should have received a copy of the GNU General Public License
15     along with this program; if not, write to the Free Software
16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17
18 */
19
20 #include <string>
21 #include <sigc++/sigc++.h>
22
23 namespace libdcp {
24
25 /** Create a UUID.
26  *  @return UUID.
27  */
28 extern std::string make_uuid ();
29
30 /** Create a digest for a file.
31  *  @param filename File name.
32  *  @param progress If non-0, a signal which will be emitted periodically to update
33  *  progress; the parameter will start at 0.5 and proceed to 1.
34  *  @return Digest.
35  */
36 extern std::string make_digest (std::string filename, sigc::signal1<void, float>* progress);
37
38 }