#include <RecordParams.h>

Collaboration diagram for Kwave::RecordParams:

Public Member Functions
	RecordParams ()

virtual	~RecordParams ()

virtual int	fromList (const QStringList &list)

virtual QStringList	toList () const

Public Attributes
Kwave::record_method_t	method

bool	pre_record_enabled

unsigned int	pre_record_time

bool	record_time_limited

unsigned int	record_time

bool	start_time_enabled

QDateTime	start_time

bool	record_trigger_enabled

unsigned int	record_trigger

bool	amplification_enabled

int	amplification

bool	agc_enabled

unsigned int	agc_decay

bool	fade_in_enabled

unsigned int	fade_in_time

bool	fade_out_enabled

unsigned int	fade_out_time

QString	device_name

unsigned int	tracks

double	sample_rate

Kwave::Compression::Type	compression

unsigned int	bits_per_sample

Kwave::SampleFormat::Format	sample_format

unsigned int	buffer_count

unsigned int	buffer_size

Detailed Description

Definition at line 54 of file RecordParams.h.

Constructor & Destructor Documentation

◆ RecordParams()

Kwave::RecordParams::RecordParams ( )

Constructor, initializes everything with defaults

Definition at line 26 of file RecordParams.cpp.

    :method(Kwave::RECORD_NONE),
     pre_record_enabled(false),     pre_record_time(20),
     record_time_limited(false),    record_time(5*60),
     start_time_enabled(false),     start_time(QDateTime::currentDateTime()),
     record_trigger_enabled(false), record_trigger(30),
     amplification_enabled(false),  amplification(+3),
     agc_enabled(false),            agc_decay(50),
     fade_in_enabled(false),        fade_in_time(5),
     fade_out_enabled(false),       fade_out_time(5),
     device_name(_("plug:dsnoop")),
     tracks(2),
     sample_rate(44100.0),
     compression(Kwave::Compression::NONE),
     bits_per_sample(16),
     sample_format(Kwave::SampleFormat::Unknown),
     buffer_count(32),
     buffer_size(13) /* (1 << 13) == 8192 bytes */
 {
 }

◆ ~RecordParams()

Kwave::RecordParams::~RecordParams ( )

virtual

Destructor

Definition at line 48 of file RecordParams.cpp.

49 {

50 }

Member Function Documentation

◆ fromList()

int Kwave::RecordParams::fromList ( const QStringList & list )

virtual

Parse from a QStringList

Parameters

list	the QStringList to parse

Returns: zero or -EINVAL if failed

Definition at line 58 of file RecordParams.cpp.

References bits_per_sample, buffer_count, buffer_size, compression, device_name, Kwave::SampleFormat::fromInt(), Kwave::Compression::fromInt(), GET, method, pre_record_enabled, pre_record_time, Kwave::RECORD_INVALID, record_time, record_time_limited, record_trigger, record_trigger_enabled, sample_format, sample_rate, start_time, start_time_enabled, Kwave::toInt(), and tracks.

Referenced by Kwave::RecordDialog::RecordDialog().

 {
     bool ok;
     int index = 0;
 
     // check number of elements
     if (list.count() != 17) return -EINVAL;
 
     // recording method
     unsigned int method_index;
     GET(method_index, toUInt);
     method = (method_index < Kwave::RECORD_INVALID) ?
                 static_cast<Kwave::record_method_t>(method_index) :
                 Kwave::RECORD_INVALID;
 
     // pre-record
     GET(pre_record_enabled, toUInt);
     GET(pre_record_time, toUInt);
 
     // record time
     GET(record_time_limited, toUInt);
     GET(record_time, toUInt);
 
     // record start time
     GET(start_time_enabled, toUInt);
     start_time = QDateTime::fromString(list[index++], Qt::ISODate);
 
     // auto-adjust to same hour as last time but not in past
     if (start_time.date() < QDate::currentDate())
         start_time.setDate(QDate::currentDate());
     if (start_time < QDateTime::currentDateTime())
         start_time = start_time.addDays(1);
     // set seconds to zero
     QTime t = start_time.time();
     t.setHMS(t.hour(), t.minute(), 0, 0);
     start_time.setTime(t);
 
     // record trigger
     GET(record_trigger_enabled, toUInt);
     GET(record_trigger, toUInt);
 
 //     // amplification
 //     GET(amplification_enabled, toUInt);
 //     GET(amplification, toInt);
 //
 //     // AGC
 //     GET(agc_enabled, toUInt);
 //     GET(agc_decay, toUInt);
 //
 //     // fade in
 //     GET(fade_in_enabled, toUInt);
 //     GET(fade_in_time, toUInt);
 //
 //     // fade out
 //     GET(fade_out_enabled, toUInt);
 //     GET(fade_out_time, toUInt);
 
     // device name
     device_name = list[index++];
 
     // tracks, sample rate, compression, sample format, bits per sample
     GET(tracks, toUInt);
     GET(sample_rate, toDouble);
     int ct;
     GET(ct, toInt);
     compression = Kwave::Compression::fromInt(ct);
     GET(bits_per_sample, toUInt);
 
     int sf;
     GET(sf, toInt);
     Kwave::SampleFormat(sample_format).fromInt(sf);
 
     // buffer count and power of buffer size
     GET(buffer_count, toUInt);
     GET(buffer_size, toUInt);
 
     return 0;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ toList()

QStringList Kwave::RecordParams::toList ( ) const

virtual

Parse into a QStringList

Definition at line 140 of file RecordParams.cpp.

References bits_per_sample, buffer_count, buffer_size, compression, device_name, method, pre_record_enabled, pre_record_time, PUT, record_time, record_time_limited, record_trigger, record_trigger_enabled, sample_format, sample_rate, start_time, start_time_enabled, Kwave::toInt(), and tracks.

 {
     QStringList list;
     QString param;
 
     // record method
     PUT(static_cast<unsigned int>(method));
 
     // pre-record
     PUT(pre_record_enabled);
     PUT(pre_record_time);
 
     // record time
     PUT(record_time_limited);
     PUT(record_time);
 
     // start time
     PUT(start_time_enabled);
     list += start_time.toString(Qt::ISODate);
 
     // record trigger
     PUT(record_trigger_enabled);
     PUT(record_trigger);
 
 //     // amplification
 //     PUT(amplification_enabled);
 //     PUT(amplification);
 //
 //     // AGC
 //     PUT(agc_enabled);
 //     PUT(agc_decay);
 //
 //     // fade in
 //     PUT(fade_in_enabled);
 //     PUT(fade_in_time);
 //
 //     // fade out
 //     PUT(fade_out_enabled);
 //     PUT(fade_out_time);
 
     // device name
     list += device_name;
 
     // tracks, sample rate, compression, sample format, bits per sample
     PUT(tracks);
     PUT(sample_rate);
     PUT(compression);
     PUT(bits_per_sample);
     PUT(Kwave::SampleFormat(sample_format).toInt());
 
     // buffer count and power of buffer size
     PUT(buffer_count);
     PUT(buffer_size);
 
     return list;
 }

Here is the call graph for this function:

Member Data Documentation

◆ agc_decay

unsigned int Kwave::RecordParams::agc_decay

agc: decay in milliseconds

Definition at line 93 of file RecordParams.h.

◆ agc_enabled

bool Kwave::RecordParams::agc_enabled

agc: feature enabled

Definition at line 92 of file RecordParams.h.

◆ amplification

int Kwave::RecordParams::amplification

amplification: value in decibel

Definition at line 90 of file RecordParams.h.

◆ amplification_enabled

bool Kwave::RecordParams::amplification_enabled

amplification: feature enabled

Definition at line 89 of file RecordParams.h.

◆ bits_per_sample

unsigned int Kwave::RecordParams::bits_per_sample

resolution in bits per sample

Definition at line 105 of file RecordParams.h.

Referenced by Kwave::RecordDialog::bitsPerSampleChanged(), Kwave::RecordPlugin::changeCompression(), fromList(), Kwave::RecordDialog::setBitsPerSample(), Kwave::RecordPlugin::startRecording(), and toList().

◆ buffer_count

unsigned int Kwave::RecordParams::buffer_count

number of buffers

Definition at line 108 of file RecordParams.h.

Referenced by fromList(), Kwave::RecordDialog::RecordDialog(), Kwave::RecordPlugin::setupRecordThread(), Kwave::RecordDialog::sourceBufferCountChanged(), toList(), and Kwave::RecordPlugin::updateBufferProgressBar().

◆ buffer_size

unsigned int Kwave::RecordParams::buffer_size

power of the record buffer size

Definition at line 109 of file RecordParams.h.

Referenced by fromList(), Kwave::RecordDialog::RecordDialog(), Kwave::RecordPlugin::setupRecordThread(), Kwave::RecordDialog::sourceBufferSizeChanged(), and toList().

◆ compression

Kwave::Compression::Type Kwave::RecordParams::compression

compression type

Definition at line 104 of file RecordParams.h.

Referenced by Kwave::RecordPlugin::changeSampleRate(), Kwave::RecordDialog::compressionChanged(), fromList(), Kwave::RecordDialog::setCompression(), Kwave::RecordPlugin::setupRecordThread(), Kwave::RecordPlugin::startRecording(), and toList().

◆ device_name

QString Kwave::RecordParams::device_name

name of the input device

Definition at line 101 of file RecordParams.h.

Referenced by fromList(), Kwave::RecordDialog::selectRecordDevice(), Kwave::RecordDialog::setDevice(), Kwave::RecordDialog::setState(), Kwave::RecordDialog::setSupportedDevices(), toList(), and Kwave::RecordDialog::updateListSelection().

◆ fade_in_enabled

bool Kwave::RecordParams::fade_in_enabled

fade in: feature enabled

Definition at line 95 of file RecordParams.h.

◆ fade_in_time

unsigned int Kwave::RecordParams::fade_in_time

fade in: time in milliseconds

Definition at line 96 of file RecordParams.h.

◆ fade_out_enabled

bool Kwave::RecordParams::fade_out_enabled

fade out: feature enabled

Definition at line 98 of file RecordParams.h.

◆ fade_out_time

unsigned int Kwave::RecordParams::fade_out_time

fade out: time in milliseconds

Definition at line 99 of file RecordParams.h.

◆ method

Kwave::record_method_t Kwave::RecordParams::method

Definition at line 75 of file RecordParams.h.

Referenced by fromList(), Kwave::RecordDialog::methodSelected(), Kwave::RecordDialog::setMethod(), and toList().

◆ pre_record_enabled

bool Kwave::RecordParams::pre_record_enabled

method/class for recording pre-record: feature enabled

Definition at line 77 of file RecordParams.h.

Referenced by fromList(), Kwave::RecordDialog::preRecordingChecked(), Kwave::RecordPlugin::setupRecordThread(), and toList().

◆ pre_record_time

unsigned int Kwave::RecordParams::pre_record_time

pre-record: time in seconds

Definition at line 78 of file RecordParams.h.

Referenced by fromList(), Kwave::RecordDialog::preRecordingTimeChanged(), Kwave::RecordPlugin::setupRecordThread(), and toList().

◆ record_time

unsigned int Kwave::RecordParams::record_time

record time: limit in seconds

Definition at line 81 of file RecordParams.h.

Referenced by fromList(), Kwave::RecordPlugin::processBuffer(), Kwave::RecordDialog::recordTimeChanged(), toList(), and Kwave::RecordDialog::updateRecordButton().

◆ record_time_limited

bool Kwave::RecordParams::record_time_limited

record time: limited

Definition at line 80 of file RecordParams.h.

Referenced by fromList(), Kwave::RecordPlugin::processBuffer(), Kwave::RecordDialog::recordTimeChecked(), toList(), and Kwave::RecordDialog::updateRecordButton().

◆ record_trigger

unsigned int Kwave::RecordParams::record_trigger

record trigger level in percent

Definition at line 87 of file RecordParams.h.

Referenced by Kwave::RecordPlugin::checkTrigger(), fromList(), toList(), and Kwave::RecordDialog::triggerChanged().

◆ record_trigger_enabled

bool Kwave::RecordParams::record_trigger_enabled

record trigger: feature enabled

Definition at line 86 of file RecordParams.h.

Referenced by Kwave::RecordPlugin::checkTrigger(), fromList(), Kwave::RecordPlugin::processBuffer(), Kwave::RecordDialog::startTimeChecked(), toList(), and Kwave::RecordDialog::triggerChecked().

◆ sample_format

Kwave::SampleFormat::Format Kwave::RecordParams::sample_format

sample format

Definition at line 106 of file RecordParams.h.

Referenced by Kwave::RecordPlugin::changeBitsPerSample(), fromList(), Kwave::RecordPlugin::paramsValid(), Kwave::RecordDialog::sampleFormatChanged(), Kwave::RecordDialog::setSampleFormat(), Kwave::RecordPlugin::setupRecordThread(), Kwave::RecordPlugin::startRecording(), and toList().

◆ sample_rate

double Kwave::RecordParams::sample_rate

sample rate in samples/second

Definition at line 103 of file RecordParams.h.

Referenced by Kwave::RecordPlugin::changeTracks(), Kwave::RecordPlugin::checkTrigger(), fromList(), Kwave::RecordPlugin::processBuffer(), Kwave::RecordDialog::sampleRateChanged(), Kwave::RecordDialog::setSampleRate(), Kwave::RecordPlugin::setupRecordThread(), Kwave::RecordPlugin::startRecording(), toList(), Kwave::RecordDialog::updateBufferState(), Kwave::RecordDialog::updateEffects(), and Kwave::RecordDialog::updateRecordButton().

◆ start_time

QDateTime Kwave::RecordParams::start_time

start time: date & time

Definition at line 84 of file RecordParams.h.

Referenced by Kwave::RecordPlugin::checkTrigger(), fromList(), Kwave::RecordDialog::RecordDialog(), Kwave::RecordDialog::startTimeChanged(), toList(), and Kwave::RecordDialog::updateBufferState().

◆ start_time_enabled

bool Kwave::RecordParams::start_time_enabled

start time: feature enabled

Definition at line 83 of file RecordParams.h.

Referenced by Kwave::RecordPlugin::checkTrigger(), fromList(), Kwave::RecordPlugin::processBuffer(), Kwave::RecordDialog::RecordDialog(), Kwave::RecordDialog::startTimeChecked(), toList(), Kwave::RecordDialog::triggerChecked(), and Kwave::RecordDialog::updateBufferState().

◆ tracks

unsigned int Kwave::RecordParams::tracks

number of tracks

Definition at line 102 of file RecordParams.h.

Referenced by Kwave::RecordPlugin::flushPrerecordingQueue(), fromList(), Kwave::RecordPlugin::paramsValid(), Kwave::RecordPlugin::processBuffer(), Kwave::RecordPlugin::recordStopped(), Kwave::RecordPlugin::setDevice(), Kwave::RecordDialog::setTracks(), Kwave::RecordPlugin::setupRecordThread(), Kwave::RecordPlugin::startRecording(), toList(), Kwave::RecordDialog::tracksChanged(), and Kwave::RecordDialog::updateEffects().

The documentation for this class was generated from the following files:

plugins/record/RecordParams.h
plugins/record/RecordParams.cpp

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ RecordParams()

◆ ~RecordParams()

Member Function Documentation

◆ fromList()

◆ toList()

Member Data Documentation

◆ agc_decay

◆ agc_enabled

◆ amplification

◆ amplification_enabled

◆ bits_per_sample

◆ buffer_count

◆ buffer_size

◆ compression

◆ device_name

◆ fade_in_enabled

◆ fade_in_time

◆ fade_out_enabled

◆ fade_out_time

◆ method

◆ pre_record_enabled

◆ pre_record_time

◆ record_time

◆ record_time_limited

◆ record_trigger

◆ record_trigger_enabled

◆ sample_format

◆ sample_rate

◆ start_time

◆ start_time_enabled

◆ tracks