mirror of
https://github.com/dolphin-emu/dolphin.git
synced 2024-09-21 20:01:40 +02:00
09f3f9b41a
The class NonCopyable is, like the name says, supposed to disallow
copying. But should it allow moving?
For a long time, NonCopyable used to not allow moving. (It declared
a deleted copy constructor and assigment operator without declaring
a move constructor and assignment operator, making the compiler
implicitly delete the move constructor and assignment operator.)
That's fine if the classes that inherit from NonCopyable don't need
to be movable or if writing the move constructor and assignment
operator by hand is fine, but that's not the case for all classes,
as I discovered when I was working on the DirectoryBlob PR.
Because of that, I decided to make NonCopyable movable in c7602cc,
allowing me to use NonCopyable in DirectoryBlob.h. That was however
an unfortunate decision, because some of the classes that inherit
from NonCopyable have incorrect behavior when moved by default-
generated move constructors and assignment operators, and do not
explicitly delete the move constructors and assignment operators,
relying on NonCopyable being non-movable.
So what can we do about this? There are four solutions that I can
think of:
1. Make NonCopyable non-movable and tell DirectoryBlob to suck it.
2. Keep allowing moving NonCopyable, and expect that classes that
don't support moving will delete the move constructor and
assignment operator manually. Not only is this inconsistent
(having classes disallow copying one way and disallow moving
another way), but deleting the move constructor and assignment
operator manually is too easy to forget compared to how tricky
the resulting problems are.
3. Have one "MovableNonCopyable" and one "NonMovableNonCopyable".
It works, but it feels rather silly...
4. Don't have a NonCopyable class at all. Considering that deleting
the copy constructor and assignment operator only takes two lines
of code, I don't see much of a reason to keep NonCopyable. I
suppose that there was more of a point in having NonCopyable back
in the pre-C++11 days, when it wasn't possible to use "= delete".
I decided to go with the fourth one (like the commit title says).
The implementation of the commit is fairly straight-forward, though
I would like to point out that I skipped adding "= delete" lines
for classes whose only reason for being uncopyable is that they
contain uncopyable classes like File::IOFile and std::unique_ptr,
because the compiler makes such classes uncopyable automatically.
52 lines
1.7 KiB
C++
52 lines
1.7 KiB
C++
// Copyright 2008 Dolphin Emulator Project
|
|
// Licensed under GPLv2+
|
|
// Refer to the license.txt file included.
|
|
|
|
// ---------------------------------------------------------------------------------
|
|
// Class: WaveFileWriter
|
|
// Description: Simple utility class to make it easy to write long 16-bit stereo
|
|
// audio streams to disk.
|
|
// Use Start() to start recording to a file, and AddStereoSamples to add wave data.
|
|
// The float variant will convert from -1.0-1.0 range and clamp.
|
|
// Alternatively, AddSamplesBE for big endian wave data.
|
|
// If Stop is not called when it destructs, the destructor will call Stop().
|
|
// ---------------------------------------------------------------------------------
|
|
|
|
#pragma once
|
|
|
|
#include <array>
|
|
#include <string>
|
|
|
|
#include "Common/CommonTypes.h"
|
|
#include "Common/File.h"
|
|
|
|
class WaveFileWriter
|
|
{
|
|
public:
|
|
WaveFileWriter();
|
|
~WaveFileWriter();
|
|
|
|
WaveFileWriter(const WaveFileWriter&) = delete;
|
|
WaveFileWriter& operator=(const WaveFileWriter&) = delete;
|
|
WaveFileWriter(WaveFileWriter&&) = delete;
|
|
WaveFileWriter& operator=(WaveFileWriter&&) = delete;
|
|
|
|
bool Start(const std::string& filename, unsigned int HLESampleRate);
|
|
void Stop();
|
|
|
|
void SetSkipSilence(bool skip) { skip_silence = skip; }
|
|
void AddStereoSamplesBE(const short* sample_data, u32 count, int sample_rate); // big endian
|
|
u32 GetAudioSize() const { return audio_size; }
|
|
private:
|
|
static constexpr size_t BUFFER_SIZE = 32 * 1024;
|
|
|
|
File::IOFile file;
|
|
bool skip_silence = false;
|
|
u32 audio_size = 0;
|
|
std::array<short, BUFFER_SIZE> conv_buffer{};
|
|
void Write(u32 value);
|
|
void Write4(const char* ptr);
|
|
std::string basename;
|
|
int current_sample_rate;
|
|
int file_index = 0;
|
|
};
|