OpenShot Audio Library | OpenShotAudio  0.3.0
juce_FileOutputStream.h
1 /*
2  ==============================================================================
3 
4  This file is part of the JUCE library.
5  Copyright (c) 2017 - ROLI Ltd.
6 
7  JUCE is an open source library subject to commercial or open-source
8  licensing.
9 
10  The code included in this file is provided under the terms of the ISC license
11  http://www.isc.org/downloads/software-support-policy/isc-license. Permission
12  To use, copy, modify, and/or distribute this software for any purpose with or
13  without fee is hereby granted provided that the above copyright notice and
14  this permission notice appear in all copies.
15 
16  JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
17  EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
18  DISCLAIMED.
19 
20  ==============================================================================
21 */
22 
23 namespace juce
24 {
25 
26 //==============================================================================
34 class JUCE_API FileOutputStream : public OutputStream
35 {
36 public:
37  //==============================================================================
66  FileOutputStream (const File& fileToWriteTo,
67  size_t bufferSizeToUse = 16384);
68 
70  ~FileOutputStream() override;
71 
72  //==============================================================================
75  const File& getFile() const { return file; }
76 
81  const Result& getStatus() const noexcept { return status; }
82 
86  bool failedToOpen() const noexcept { return status.failed(); }
87 
91  bool openedOk() const noexcept { return status.wasOk(); }
92 
97  Result truncate();
98 
99  //==============================================================================
100  void flush() override;
101  int64 getPosition() override;
102  bool setPosition (int64) override;
103  bool write (const void*, size_t) override;
104  bool writeRepeatedByte (uint8 byte, size_t numTimesToRepeat) override;
105 
106 
107 private:
108  //==============================================================================
109  File file;
110  void* fileHandle = nullptr;
111  Result status { Result::ok() };
112  int64 currentPosition = 0;
113  size_t bufferSize, bytesInBuffer = 0;
114  HeapBlock<char> buffer;
115 
116  void openHandle();
117  void closeHandle();
118  void flushInternal();
119  bool flushBuffer();
120  int64 setPositionInternal (int64);
121  ssize_t writeInternal (const void*, size_t);
122 
123  JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (FileOutputStream)
124 };
125 
126 } // namespace juce
static Result ok() noexcept
Definition: juce_Result.h:61
const Result & getStatus() const noexcept
bool openedOk() const noexcept
const File & getFile() const
bool failedToOpen() const noexcept