Rework argument types

Argument types of setters and ctors now mostly follow these rules:
 - moveable types are passed by value
 - non-moveable types are passed by const ref

Code that receives moveable types by value now passes it to nested
methods using std::move(). These changes together allowed to make
most setters zero-copy for moveable types, in case if user uses
rvalue or std::move(). If the user uses copy ctor, it is usually
the only copy made.

This is a breaking change: signature of some protected methods
that can be overridden by user were changed.

Author: gavv

include/aspl/Compat.hpp

@@ -10,7 +10,7 @@
 
 namespace aspl {
 
-// Backward compatibility macOS before 12.0
+// Backward compatibility with macOS before 12.0
 #if !defined(MAC_OS_VERSION_12_0) || MAC_OS_X_VERSION_MAX_ALLOWED < MAC_OS_VERSION_12_0
 enum
 {

include/aspl/Context.hpp

@@ -37,10 +37,11 @@ struct Context
     //! Create context.
     //! If dispatcher or tracer is not specified, default one is created.
     //! Default tracer sends output to syslog.
-    explicit Context(const std::shared_ptr<aspl::Tracer>& tracer = {},
-        const std::shared_ptr<aspl::Dispatcher>& dispatcher = {})
-        : Dispatcher(dispatcher ? dispatcher : std::make_shared<aspl::Dispatcher>())
-        , Tracer(tracer ? tracer : std::make_shared<aspl::Tracer>())
+    explicit Context(std::shared_ptr<aspl::Tracer> tracer = {},
+        std::shared_ptr<aspl::Dispatcher> dispatcher = {})
+        : Dispatcher(
+              dispatcher ? std::move(dispatcher) : std::make_shared<aspl::Dispatcher>())
+        , Tracer(tracer ? std::move(tracer) : std::make_shared<aspl::Tracer>())
     {
     }
 };

include/aspl/Device.hpp

@@ -167,7 +167,7 @@ class Device : public Object
 {
 public:
     //! Construct device.
-    explicit Device(const std::shared_ptr<const Context>& context,
+    explicit Device(std::shared_ptr<const Context> context,
         const DeviceParameters& params = {});
 
     //! @name Getters and setters
@@ -619,7 +619,7 @@ class Device : public Object
 
     //! Add stream to device.
     //! Same as AddStreamAsync(Direction), but allows to construct stream manually.
-    void AddStreamAsync(const std::shared_ptr<Stream>& stream);
+    void AddStreamAsync(std::shared_ptr<Stream> stream);
 
     //! Remove stream from device.
     //! @remarks
@@ -630,7 +630,7 @@ class Device : public Object
     //!  owned objects asynchronously (when HAL allows it). Hence, GetStreamCount()
     //!  and GetStreamByIndex() are updated immediately, but GetOwnedObjectIDs(),
     //!  GetStreamIDs(), etc. are updated some time later.
-    void RemoveStreamAsync(const std::shared_ptr<Stream>& stream);
+    void RemoveStreamAsync(std::shared_ptr<Stream> stream);
 
     //! @}
 
@@ -672,7 +672,7 @@ class Device : public Object
     //! Add volume control to device.
     //! Same as AddVolumeControlAsync(Direction), but allows to construct control
     //! manually.
-    void AddVolumeControlAsync(const std::shared_ptr<VolumeControl>& control);
+    void AddVolumeControlAsync(std::shared_ptr<VolumeControl> control);
 
     //! Remove volume control from device.
     //! @remarks
@@ -683,7 +683,7 @@ class Device : public Object
     //!  owned objects asynchronously (when HAL allows it). Hence, GetVolumeControlCount()
     //!  and GetVolumeControlByIndex() are updated immediately, but GetOwnedObjectIDs(),
     //!  GetControlIDs(), etc. are updated some time later.
-    void RemoveVolumeControlAsync(const std::shared_ptr<VolumeControl>& control);
+    void RemoveVolumeControlAsync(std::shared_ptr<VolumeControl> control);
 
     //! @}
 
@@ -723,7 +723,7 @@ class Device : public Object
 
     //! Add mute control to device.
     //! Same as AddMuteControlAsync(Direction), but allows to construct control manually.
-    void AddMuteControlAsync(const std::shared_ptr<MuteControl>& control);
+    void AddMuteControlAsync(std::shared_ptr<MuteControl> control);
 
     //! Remove mute control from device.
     //! @remarks
@@ -734,7 +734,7 @@ class Device : public Object
     //!  owned objects asynchronously (when HAL allows it). Hence, GetMuteControlCount()
     //!  and GetMuteControlByIndex() are updated immediately, but GetOwnedObjectIDs(),
     //!  GetControlIDs(), etc. are updated some time later.
-    void RemoveMuteControlAsync(const std::shared_ptr<MuteControl>& control);
+    void RemoveMuteControlAsync(std::shared_ptr<MuteControl> control);
 
     //! @}
 
@@ -744,7 +744,7 @@ class Device : public Object
     //! Set handler for control requests.
     //! This is optional. You may provide a custom handler if you want to do
     //! custom processing or want to inject custom client implementation.
-    void SetControlHandler(const std::shared_ptr<ControlRequestHandler>& handler);
+    void SetControlHandler(std::shared_ptr<ControlRequestHandler> handler);
 
     //! Called before new client start I/O with the device.
     //! Updates client map and invokes OnAddClient().
@@ -790,7 +790,7 @@ class Device : public Object
     //! You need to provide your own implementation if you want your device
     //! to actually do something useful. Default implementation is suitable for
     //! a null / black hole device.
-    void SetIOHandler(const std::shared_ptr<IORequestHandler>& handler);
+    void SetIOHandler(std::shared_ptr<IORequestHandler> handler);
 
     //! Get the current zero time stamp for the device.
     //! In default implementation, the zero time stamp and host time are increased
@@ -874,7 +874,7 @@ class Device : public Object
     //!  If invoked from PerformConfigurationChange(), assumes that we're already
     //!  at the point where it's safe to change configuration and executes the
     //!  function immediately.
-    void RequestConfigurationChange(const std::function<void()>& func = {});
+    void RequestConfigurationChange(std::function<void()> func = {});
 
     //! Called by the Host to allow the device to perform a configuration change
     //! that had been previously requested via a call to the Host method,
@@ -982,8 +982,7 @@ class Device : public Object
     //! Invoked by SetAvailableSampleRatesAsync() to actually change the list.
     //! Default implementation just updates the list returned by
     //! GetAvailableSampleRates().
-    virtual OSStatus SetAvailableSampleRatesImpl(
-        const std::vector<AudioValueRange>& rates);
+    virtual OSStatus SetAvailableSampleRatesImpl(std::vector<AudioValueRange> rates);
 
     //! Set channels for stereo.
     //! Invoked by SetPreferredChannelsForStereoAsync() to actually change the value.
@@ -1003,14 +1002,13 @@ class Device : public Object
     //! By default, it also affects values returned by GetPreferredChannelCount() and
     //! GetPreferredChannelLayout().
     virtual OSStatus SetPreferredChannelsImpl(
-        const std::vector<AudioChannelDescription>& channels);
+        std::vector<AudioChannelDescription> channels);
 
     //! Invoked by SetPreferredChannelLayoutAsync() to actually change the value.
     //! Default implementation changes the value returned by GetPreferredChannelLayout().
     //! By default, it also affects values returned by GetPreferredChannelCount() and
     //! GetPreferredChannels().
-    virtual OSStatus SetPreferredChannelLayoutImpl(
-        const std::vector<UInt8>& channelLayout);
+    virtual OSStatus SetPreferredChannelLayoutImpl(std::vector<UInt8> channelLayout);
 
     //! Start or stop device identification.
     //! This can be requested by UI, but probably makes little sense to virtual devices.

include/aspl/Dispatcher.hpp

@@ -41,8 +41,7 @@ class Dispatcher
 public:
     //! Construct dispatcher.
     //! Use tracer if you want to debug dispatcher itself, it is quite verbose.
-    Dispatcher(const std::shared_ptr<Tracer> tracer = {},
-        AudioObjectID hintMaximumID = 1000);
+    Dispatcher(std::shared_ptr<Tracer> tracer = {}, AudioObjectID hintMaximumID = 1000);
 
     Dispatcher(const Dispatcher&) = delete;
     Dispatcher& operator=(const Dispatcher&) = delete;

include/aspl/Driver.hpp

@@ -55,8 +55,8 @@ class Driver
 public:
     //! Construct driver.
     //! If context or plugin are not set, they are created automatically.
-    explicit Driver(const std::shared_ptr<Context>& context = {},
-        const std::shared_ptr<Plugin>& plugin = {});
+    explicit Driver(std::shared_ptr<Context> context = {},
+        std::shared_ptr<Plugin> plugin = {});
 
     Driver(const Driver&) = delete;
     Driver& operator=(const Driver&) = delete;

include/aspl/MuteControl.hpp

@@ -39,7 +39,7 @@ class MuteControl : public Object
 {
 public:
     //! Construct stream.
-    explicit MuteControl(const std::shared_ptr<const Context>& context,
+    explicit MuteControl(std::shared_ptr<const Context> context,
         const MuteControlParameters& params = {});
 
     //! @name Getters and setters

include/aspl/Object.hpp

@@ -58,7 +58,7 @@ class Object : public std::enable_shared_from_this<Object>
     //! Class name is used for logging. It should be the name of the derived class.
     //! If objectID is @c kAudioObjectUnknown (zero), allocates new object ID.
     //! Otherwise uses given object ID.
-    explicit Object(const std::shared_ptr<const Context>& context,
+    explicit Object(std::shared_ptr<const Context> context,
         const char* className = "Object",
         AudioObjectID objectID = kAudioObjectUnknown);
 
@@ -121,7 +121,7 @@ class Object : public std::enable_shared_from_this<Object>
 
     //! Add object to the list of owned objects.
     //! Also invokes SetOwner() on the added object.
-    void AddOwnedObject(const std::shared_ptr<Object>& object,
+    void AddOwnedObject(std::shared_ptr<Object> object,
         AudioObjectPropertyScope scope = kAudioObjectPropertyScopeGlobal);
 
     //! Remove object to the list of owned objects.
@@ -144,8 +144,7 @@ class Object : public std::enable_shared_from_this<Object>
 
     //! Notify HAL that some properties were changed.
     //! This is automatically called by all setters.
-    void NotifyPropertiesChanged(
-        const std::vector<AudioObjectPropertySelector>& selectors,
+    void NotifyPropertiesChanged(std::vector<AudioObjectPropertySelector> selectors,
         AudioObjectPropertyScope scope = kAudioObjectPropertyScopeGlobal,
         AudioObjectPropertyElement element = kAudioObjectPropertyElementMain) const;
 

include/aspl/Plugin.hpp

@@ -49,7 +49,7 @@ class Plugin : public Object
 {
 public:
     //! Construct plugin.
-    explicit Plugin(const std::shared_ptr<const Context>& context,
+    explicit Plugin(std::shared_ptr<const Context> context,
         const PluginParameters& params = {});
 
     //! @name Getters and setters
@@ -103,11 +103,11 @@ class Plugin : public Object
 
     //! Add device to the plugin.
     //! Adds device to the owned object list.
-    void AddDevice(const std::shared_ptr<Device>& device);
+    void AddDevice(std::shared_ptr<Device> device);
 
     //! Remove device from the plugin.
     //! Removes device from the owned object list.
-    void RemoveDevice(const std::shared_ptr<Device>& device);
+    void RemoveDevice(std::shared_ptr<Device> device);
 
     //! @}
 

include/aspl/Stream.hpp

@@ -77,8 +77,8 @@ class Stream : public Object
 {
 public:
     //! Construct stream.
-    explicit Stream(const std::shared_ptr<const Context>& context,
-        const std::shared_ptr<Device>& device,
+    explicit Stream(std::shared_ptr<const Context> context,
+        std::shared_ptr<Device> device,
         const StreamParameters& params = {});
 
     //! @name Getters and setters
@@ -242,11 +242,11 @@ class Stream : public Object
 
     //! Attach volume control to the stream.
     //! ApplyProcessing() will use control to apply volume settings to the stream.
-    void AttachVolumeControl(const std::shared_ptr<VolumeControl>& control);
+    void AttachVolumeControl(std::shared_ptr<VolumeControl> control);
 
     //! Attach mute control to the stream.
     //! ApplyProcessing() will use control to apply mute settings to the stream.
-    void AttachMuteControl(const std::shared_ptr<MuteControl>& control);
+    void AttachMuteControl(std::shared_ptr<MuteControl> control);
 
     //! Apply processing to the stream's data.
     //! The provided buffer contains exactly @p frameCount * @p channelCount samples.
@@ -266,7 +266,7 @@ class Stream : public Object
 
     //! Request HAL to perform configuration update.
     //! Similar to Device::RequestConfigurationChange().
-    void RequestConfigurationChange(const std::function<void()>& func = {});
+    void RequestConfigurationChange(std::function<void()> func = {});
 
     //! @}
 
@@ -353,7 +353,7 @@ class Stream : public Object
     //! Default implementation just changes the list returned by
     //! GetAvailablePhysicalFormats().
     virtual OSStatus SetAvailablePhysicalFormatsImpl(
-        const std::vector<AudioStreamRangedDescription>& formats);
+        std::vector<AudioStreamRangedDescription> formats);
 
     //! Set current virtual format of the stream.
     //! Invoked by SetVirtualFormatAsync() to actually change the format.
@@ -369,7 +369,7 @@ class Stream : public Object
     //! Default implementation just changes the list returned by
     //! GetAvailableVirtualFormats().
     virtual OSStatus SetAvailableVirtualFormatsImpl(
-        const std::vector<AudioStreamRangedDescription>& formats);
+        std::vector<AudioStreamRangedDescription> formats);
 
     //! @}
 

include/aspl/VolumeControl.hpp

@@ -65,7 +65,7 @@ class VolumeControl : public Object
 {
 public:
     //! Construct stream.
-    explicit VolumeControl(const std::shared_ptr<const Context>& context,
+    explicit VolumeControl(std::shared_ptr<const Context> context,
         const VolumeControlParameters& params = {});
 
     //! @name Getters and setters