src/lib/file_group.h

   1 /*
   2     Copyright (C) 2013-2021 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   6     DCP-o-matic is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     DCP-o-matic is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21
  22 /** @file  src/lib/file_group.h
  23  *  @brief FileGroup class.
  24  */
  25
  26
  27 #ifndef DCPOMATIC_FILE_GROUP_H
  28 #define DCPOMATIC_FILE_GROUP_H
  29
  30
  31 #include <dcp/file.h>
  32 #include <boost/filesystem.hpp>
  33 #include <boost/optional.hpp>
  34 #include <vector>
  35
  36
  37 /** @class FileGroup
  38  *  @brief A class to make a list of files behave like they were concatenated.
  39  */
  40 class FileGroup
  41 {
  42 public:
  43         FileGroup ();
  44         explicit FileGroup (boost::filesystem::path);
  45         explicit FileGroup (std::vector<boost::filesystem::path> const &);
  46
  47         FileGroup (FileGroup const&) = delete;
  48         FileGroup& operator= (FileGroup const&) = delete;
  49
  50         void set_paths (std::vector<boost::filesystem::path> const &);
  51
  52         struct Result {
  53                 Result(int bytes_read_, bool eof_)
  54                         : bytes_read(bytes_read_)
  55                         , eof(eof_)
  56                 {}
  57
  58                 int bytes_read = 0;
  59                 bool eof = false;
  60         };
  61
  62         int64_t seek (int64_t, int) const;
  63         Result read (uint8_t*, int) const;
  64         int64_t length () const;
  65
  66 private:
  67         void ensure_open_path (size_t) const;
  68
  69         std::vector<boost::filesystem::path> _paths;
  70         /** Index of path that we are currently reading from */
  71         mutable size_t _current_path = 0;
  72         mutable boost::optional<dcp::File> _current_file;
  73         mutable size_t _current_size = 0;
  74         mutable int64_t _position = 0;
  75 };
  76
  77
  78 #endif