AudioPlayerWrapper_ParamsParser.cpp

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2023-2023 Istituto Italiano di Tecnologia (IIT)
 * SPDX-License-Identifier: LGPL-2.1-or-later
 */
 
 
// Generated by yarpDeviceParamParserGenerator (2.0)
// This is an automatically generated file. Please do not edit it.
// It will be re-generated if the cmake flag ALLOW_DEVICE_PARAM_PARSER_GERNERATION is ON.
 
// Generated on: Thu May 22 11:32:40 2025
 
 
#include "AudioPlayerWrapper_ParamsParser.h"
#include <yarp/os/LogStream.h>
#include <yarp/os/Value.h>
 
namespace {
    YARP_LOG_COMPONENT(AudioPlayerWrapperParamsCOMPONENT, "yarp.device.AudioPlayerWrapper")
}
 
 
AudioPlayerWrapper_ParamsParser::AudioPlayerWrapper_ParamsParser()
{
}
 
 
std::vector<std::string> AudioPlayerWrapper_ParamsParser::getListOfParams() const
{
    std::vector<std::string> params;
    params.push_back("name");
    params.push_back("period");
    params.push_back("debug");
    params.push_back("playback_network_buffer_size");
    params.push_back("start");
    return params;
}
 
 
bool AudioPlayerWrapper_ParamsParser::getParamValue(const std::string& paramName, std::string& paramValue) const
{
    if (paramName =="name")
    {
        paramValue = m_name;
        return true;
    }
    if (paramName =="period")
    {
        paramValue = std::to_string(m_period);
        return true;
    }
    if (paramName =="debug")
    {
        if (m_debug==true) paramValue = "true";
        else paramValue = "false";
        return true;
    }
    if (paramName =="playback_network_buffer_size")
    {
        paramValue = std::to_string(m_playback_network_buffer_size);
        return true;
    }
    if (paramName =="start")
    {
        if (m_start==true) paramValue = "true";
        else paramValue = "false";
        return true;
    }
 
    yError() <<"parameter '" << paramName << "' was not found";
    return false;
 
}
 
 
std::string AudioPlayerWrapper_ParamsParser::getConfiguration() const
{
    //This is a sub-optimal solution.
    //Ideally getConfiguration() should return all parameters but it is currently
    //returning only user provided parameters (excluding default values)
    //This behaviour will be fixed in the near future.
    std::string s_cfg = m_provided_configuration;
    return s_cfg;
}
 
bool      AudioPlayerWrapper_ParamsParser::parseParams(const yarp::os::Searchable & config)
{
    //Check for --help option
    if (config.check("help"))
    {
        yCInfo(AudioPlayerWrapperParamsCOMPONENT) << getDocumentationOfDeviceParams();
    }
 
    m_provided_configuration = config.toString();
    yarp::os::Property prop_check(m_provided_configuration.c_str());
    //Parser of parameter name
    {
        if (config.check("name"))
        {
            m_name = config.find("name").asString();
            yCInfo(AudioPlayerWrapperParamsCOMPONENT) << "Parameter 'name' using value:" << m_name;
        }
        else
        {
            yCInfo(AudioPlayerWrapperParamsCOMPONENT) << "Parameter 'name' using DEFAULT value:" << m_name;
        }
        prop_check.unput("name");
    }
 
    //Parser of parameter period
    {
        if (config.check("period"))
        {
            m_period = config.find("period").asFloat32();
            yCInfo(AudioPlayerWrapperParamsCOMPONENT) << "Parameter 'period' using value:" << m_period;
        }
        else
        {
            yCInfo(AudioPlayerWrapperParamsCOMPONENT) << "Parameter 'period' using DEFAULT value:" << m_period;
        }
        prop_check.unput("period");
    }
 
    //Parser of parameter debug
    {
        if (config.check("debug"))
        {
            m_debug = config.find("debug").asBool();
            yCInfo(AudioPlayerWrapperParamsCOMPONENT) << "Parameter 'debug' using value:" << m_debug;
        }
        else
        {
            yCInfo(AudioPlayerWrapperParamsCOMPONENT) << "Parameter 'debug' using DEFAULT value:" << m_debug;
        }
        prop_check.unput("debug");
    }
 
    //Parser of parameter playback_network_buffer_size
    {
        if (config.check("playback_network_buffer_size"))
        {
            m_playback_network_buffer_size = config.find("playback_network_buffer_size").asFloat64();
            yCInfo(AudioPlayerWrapperParamsCOMPONENT) << "Parameter 'playback_network_buffer_size' using value:" << m_playback_network_buffer_size;
        }
        else
        {
            yCInfo(AudioPlayerWrapperParamsCOMPONENT) << "Parameter 'playback_network_buffer_size' using DEFAULT value:" << m_playback_network_buffer_size;
        }
        prop_check.unput("playback_network_buffer_size");
    }
 
    //Parser of parameter start
    {
        if (config.check("start"))
        {
            m_start = config.find("start").asBool();
            yCInfo(AudioPlayerWrapperParamsCOMPONENT) << "Parameter 'start' using value:" << m_start;
        }
        else
        {
            yCInfo(AudioPlayerWrapperParamsCOMPONENT) << "Parameter 'start' using DEFAULT value:" << m_start;
        }
        prop_check.unput("start");
    }
 
    /*
    //This code check if the user set some parameter which are not check by the parser
    //If the parser is set in strict mode, this will generate an error
    if (prop_check.size() > 0)
    {
        bool extra_params_found = false;
        for (auto it=prop_check.begin(); it!=prop_check.end(); it++)
        {
            if (m_parser_is_strict)
            {
                yCError(AudioPlayerWrapperParamsCOMPONENT) << "User asking for parameter: "<<it->name <<" which is unknown to this parser!";
                extra_params_found = true;
            }
            else
            {
                yCWarning(AudioPlayerWrapperParamsCOMPONENT) << "User asking for parameter: "<< it->name <<" which is unknown to this parser!";
            }
        }
 
       if (m_parser_is_strict && extra_params_found)
       {
           return false;
       }
    }
    */
    return true;
}
 
 
std::string      AudioPlayerWrapper_ParamsParser::getDocumentationOfDeviceParams() const
{
    std::string doc;
    doc = doc + std::string("\n=============================================\n");
    doc = doc + std::string("This is the help for device: AudioPlayerWrapper\n");
    doc = doc + std::string("\n");
    doc = doc + std::string("This is the list of the parameters accepted by the device:\n");
    doc = doc + std::string("'name': prefix of the ports opened by the device\n");
    doc = doc + std::string("'period': period of the internal thread, in s\n");
    doc = doc + std::string("'debug': developers use only\n");
    doc = doc + std::string("'playback_network_buffer_size': size of the audio buffer in seconds, increasing this value to robustify the real-time audio stream (it will increase latency too)\n");
    doc = doc + std::string("'start': automatically activates the playback when the device is started\n");
    doc = doc + std::string("\n");
    doc = doc + std::string("Here are some examples of invocation command with yarpdev, with all params:\n");
    doc = doc + " yarpdev --device AudioPlayerWrapper --name /audioPlayerWrapper --period 0.02 --debug false --playback_network_buffer_size 5.0 --start false\n";
    doc = doc + std::string("Using only mandatory params:\n");
    doc = doc + " yarpdev --device AudioPlayerWrapper\n";
    doc = doc + std::string("=============================================\n\n");    return doc;
}