X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Flib%2Ffile_group.cc;h=548e13fef5cd538d357d541077b3d58fa256ea93;hb=3828baf56467224f5d44049bf1e7a7ed11f43a05;hp=9d042554c5b8c0649385456895d0358d813a7b0c;hpb=ae9b0b509787d244366eb8f69bdf9d563b6c6bb6;p=dcpomatic.git

diff --git a/src/lib/file_group.cc b/src/lib/file_group.cc
index 9d042554c..548e13fef 100644
--- a/src/lib/file_group.cc
+++ b/src/lib/file_group.cc
@@ -1,31 +1,38 @@
 /*
-    Copyright (C) 2013 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2013-2014 Carl Hetherington <cth@carlh.net>
 
-    This program is free software; you can redistribute it and/or modify
+    This file is part of DCP-o-matic.
+
+    DCP-o-matic is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     the Free Software Foundation; either version 2 of the License, or
     (at your option) any later version.
 
-    This program is distributed in the hope that it will be useful,
+    DCP-o-matic is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+    along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
 
 */
 
+/** @file  src/lib/file_group.cc
+ *  @brief FileGroup class.
+ */
+
 #include <cstdio>
 #include <sndfile.h>
 #include "file_group.h"
 #include "exceptions.h"
 #include "cross.h"
+#include <iostream>
 
 using std::vector;
 using std::cout;
 
+/** Construct a FileGroup with no files */
 FileGroup::FileGroup ()
 	: _current_path (0)
 	, _current_file (0)
@@ -33,14 +40,17 @@ FileGroup::FileGroup ()
 
 }
 
+/** Construct a FileGroup with a single file */
 FileGroup::FileGroup (boost::filesystem::path p)
 	: _current_path (0)
 	, _current_file (0)
 {
 	_paths.push_back (p);
+	ensure_open_path (0);
 	seek (0, SEEK_SET);
 }
 
+/** Construct a FileGroup with multiple files */
 FileGroup::FileGroup (vector<boost::filesystem::path> const & p)
 	: _paths (p)
 	, _current_path (0)
@@ -50,6 +60,7 @@ FileGroup::FileGroup (vector<boost::filesystem::path> const & p)
 	seek (0, SEEK_SET);
 }
 
+/** Destroy a FileGroup, closing any open file */
 FileGroup::~FileGroup ()
 {
 	if (_current_file) {
@@ -73,7 +84,7 @@ FileGroup::ensure_open_path (size_t p) const
 		/* Already open */
 		return;
 	}
-	
+
 	if (_current_file) {
 		fclose (_current_file);
 	}
@@ -102,9 +113,9 @@ FileGroup::seek (int64_t pos, int whence) const
 		}
 #ifdef DCPOMATIC_WINDOWS
 		full_pos += _ftelli64 (_current_file);
-#else		
+#else
 		full_pos += ftell (_current_file);
-#endif		
+#endif
 		full_pos += pos;
 		break;
 	case SEEK_END:
@@ -142,7 +153,7 @@ int
 FileGroup::read (uint8_t* buffer, int amount) const
 {
 	int read = 0;
-	while (1) {
+	while (true) {
 		int const this_time = fread (buffer + read, 1, amount - read, _current_file);
 		read += this_time;
 		if (read == amount) {
@@ -160,6 +171,7 @@ FileGroup::read (uint8_t* buffer, int amount) const
 	return read;
 }
 
+/** @return Combined length of all the files */
 int64_t
 FileGroup::length () const
 {