chrome/browser/media_galleries/win/snapshot_file_details.h

   1 // Copyright 2013 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef CHROME_BROWSER_MEDIA_GALLERIES_WIN_SNAPSHOT_FILE_DETAILS_H_
   6 #define CHROME_BROWSER_MEDIA_GALLERIES_WIN_SNAPSHOT_FILE_DETAILS_H_
   7
   8 #include "base/files/file.h"
   9 #include "base/files/file_path.h"
  10 #include "base/win/scoped_comptr.h"
  11 #include "chrome/browser/media_galleries/fileapi/mtp_device_async_delegate.h"
  12
  13 // Structure used to represent snapshot file request params.
  14 struct SnapshotRequestInfo {
  15   SnapshotRequestInfo(
  16       const base::FilePath& device_file_path,
  17       const base::FilePath& snapshot_file_path,
  18       const MTPDeviceAsyncDelegate::CreateSnapshotFileSuccessCallback&
  19           success_callback,
  20       const MTPDeviceAsyncDelegate::ErrorCallback& error_callback);
  21   ~SnapshotRequestInfo();
  22
  23   // Device file path.
  24   base::FilePath device_file_path;
  25
  26   // Local platform path of the snapshot file.
  27   base::FilePath snapshot_file_path;
  28
  29   // A callback to be called when CreateSnapshotFile() succeeds.
  30   MTPDeviceAsyncDelegate::CreateSnapshotFileSuccessCallback
  31       success_callback;
  32
  33   // A callback to be called when CreateSnapshotFile() fails.
  34   MTPDeviceAsyncDelegate::ErrorCallback error_callback;
  35 };
  36
  37 // Provides the details for the the creation of snapshot file.
  38 class SnapshotFileDetails {
  39  public:
  40   explicit SnapshotFileDetails(const SnapshotRequestInfo& request_info);
  41   ~SnapshotFileDetails();
  42
  43   void set_file_info(const base::File::Info& file_info);
  44   void set_device_file_stream(IStream* file_stream);
  45   void set_optimal_transfer_size(DWORD optimal_transfer_size);
  46
  47   SnapshotRequestInfo request_info() const {
  48     return request_info_;
  49   }
  50
  51   base::File::Info file_info() const {
  52     return file_info_;
  53   }
  54
  55   IStream* device_file_stream() const {
  56     return file_stream_.get();
  57   }
  58
  59   DWORD optimal_transfer_size() const {
  60     return optimal_transfer_size_;
  61   }
  62
  63   // Returns true if the data contents of the device file is written to the
  64   // snapshot file.
  65   bool IsSnapshotFileWriteComplete() const;
  66
  67   // Adds |bytes_written| to |bytes_written_|.
  68   // |bytes_written| specifies the total number of bytes transferred during
  69   // the last write operation.
  70   // If |bytes_written| is valid, returns true and adds |bytes_written| to
  71   // |bytes_written_|.
  72   // If |bytes_written| is invalid, returns false and does not add
  73   // |bytes_written| to |bytes_written_|.
  74   bool AddBytesWritten(DWORD bytes_written);
  75
  76  private:
  77   // Snapshot file request params.
  78   SnapshotRequestInfo request_info_;
  79
  80   // Metadata of the created snapshot file.
  81   base::File::Info file_info_;
  82
  83   // Used to read the device file contents.
  84   base::win::ScopedComPtr<IStream> file_stream_;
  85
  86   // The number of bytes of data to read from the |file_stream| object
  87   // during each IStream::Read() operation.
  88   DWORD optimal_transfer_size_;
  89
  90   // Total number of bytes written into the snapshot file.
  91   DWORD bytes_written_;
  92 };
  93
  94 #endif  // CHROME_BROWSER_MEDIA_GALLERIES_WIN_SNAPSHOT_FILE_DETAILS_H_