# Copyright 2017 SrMouraSilva
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from pluginsmanager.model.system.system_input import SystemInput
from pluginsmanager.model.system.system_output import SystemOutput
[docs]class ProtocolParser:
"""
Prepare the objects to `mod-host`_ string command
.. _mod-host: https://github.com/moddevices/mod-host
"""
@staticmethod
[docs] def add(effect):
"""
``add <lv2_uri> <instance_number>``
add a LV2 plugin encapsulated as a jack client
e.g.::
add http://lv2plug.in/plugins/eg-amp 0
instance_number must be any value between 0 ~ 9999, inclusively
:param Lv2Effect effect: Effect will be added
"""
plugin = effect.plugin
return "add {} {}".format(plugin['uri'], effect.instance)
@staticmethod
[docs] def remove(effect):
"""
``remove <instance_number>``
remove a LV2 plugin instance (and also the jack client)
e.g.::
remove 0
:param Lv2Effect effect: Effect will be removed
"""
return 'remove {}'.format(effect.instance)
@staticmethod
@staticmethod
[docs] def connect_on_output(effect_output, index_out=1):
"""
Connect 'plugin' on system output indexed in 'index_out'
.. deprecated:: future
It will be removed
"""
return ProtocolParser._connect_message(
ProtocolParser._get_out_name_of(effect_output),
'system:playback_{}'.format(index_out)
)
@staticmethod
[docs] def connect(connection):
"""
``connect <origin_port> <destination_port>``
connect two plugin audio ports
e.g.::
connect system:capture_1 plugin_0:in
:param pluginsmanager.model.connection.Connection connection: Connection with a valid
:class:`Output` and :class:`Input`
"""
return ProtocolParser._connect_message(
ProtocolParser._get_out_name_of(connection.output),
ProtocolParser._get_in_name_of(connection.input)
)
@staticmethod
def _connect_message(origin_port, destination_port):
return 'connect {} {}'.format(origin_port, destination_port)
@staticmethod
def _get_out_name_of(effect_output):
effect = effect_output.effect
if isinstance(effect_output, SystemOutput):
return '{}:{}'.format(effect, effect_output)
return 'effect_{}:{}'.format(effect.instance, effect_output.symbol)
@staticmethod
def _get_in_name_of(effect_input):
effect = effect_input.effect
if isinstance(effect_input, SystemInput):
return '{}:{}'.format(effect, effect_input)
return 'effect_{}:{}'.format(effect.instance, effect_input.symbol)
@staticmethod
[docs] def disconnect(connection):
"""
``disconnect <origin_port> <destination_port>``
disconnect two plugin audio ports
e.g.::
disconnect system:capture_1 plugin_0:in
:param pluginsmanager.model.connection.Connection connection: Connection with a valid
:class:`Output` and :class:`Input`
"""
return 'disconnect {} {}'.format(
ProtocolParser._get_out_name_of(connection.output),
ProtocolParser._get_in_name_of(connection.input)
)
@staticmethod
[docs] def preset_load():
"""
``preset_load <instance_number> <preset_uri>``
load a preset state to given plugin instance
e.g.::
preset_load 0 "http://drobilla.net/plugins/mda/presets#JX10-moogcury-lite"
.. note::
Not implemented yet
"""
return None
@staticmethod
[docs] def preset_save():
"""
``preset_save <instance_number> <preset_name> <dir> <file_name>``
save a preset state from given plugin instance
e.g.::
preset_save 0 "My Preset" /home/user/.lv2/my-presets.lv2 mypreset.ttl
.. note::
Not implemented yet
"""
return None
@staticmethod
[docs] def preset_show():
"""
``preset_show <instance_number> <preset_uri>``
show the preset information of requested instance / URI
e.g.::
preset_show 0 http://drobilla.net/plugins/mda/presets#EPiano-bright
.. note::
Not implemented yet
"""
return None
@staticmethod
[docs] def param_set(param):
"""
``param_set <instance_number> <param_symbol> <param_value>``
set a value to given control
e.g.::
param_set 0 gain 2.50
:param Lv2Param param: Parameter that will be updated your value
"""
instance = param.effect.instance
return 'param_set {} {} {}'.format(instance, param.symbol, param.value)
@staticmethod
[docs] def param_get(param):
"""
``param_get <instance_number> <param_symbol>``
get the value of the request control
e.g.::
param_get 0 gain
:param Lv2Param param: Parameter that will be get your current value
"""
instance = param.effect.instance
return 'param_get {} {}'.format(instance, param.symbol)
@staticmethod
[docs] def param_monitor():
"""
``param_monitor <instance_number> <param_symbol> <cond_op> <value>``
do monitoring a plugin instance control port according given condition
e.g.::
param_monitor 0 gain > 2.50
.. note::
Not implemented yet
"""
return None
@staticmethod
[docs] def monitor():
"""
``monitor <addr> <port> <status>``
open a socket port to monitoring parameters
e.g.::
monitor localhost 12345 1
* if ``status = 1`` start monitoring
* if ``status = 0`` stop monitoring
.. note::
Not implemented yet
"""
return None
@staticmethod
[docs] def midi_learn(self, plugin, param):
"""
``midi_learn <instance_number> <param_symbol>``
This command maps starts MIDI learn for a parameter
e.g.::
midi_learn 0 gain
.. note::
Not implemented yet
"""
pass
@staticmethod
[docs] def midi_map(plugin, param, midi_chanel, midi_cc):
"""
``midi_map <instance_number> <param_symbol> <midi_channel> <midi_cc>``
This command maps a MIDI controller to a parameter
e.g.::
midi_map 0 gain 0 7
.. note::
Not implemented yet
"""
pass
@staticmethod
[docs] def midi_unmap(plugin, param):
"""
``midi_unmap <instance_number> <param_symbol>``
This command unmaps the MIDI controller from a parameter
e.g.::
unmap 0 gain
.. note::
Not implemented yet
"""
pass
@staticmethod
[docs] def bypass(effect):
"""
``bypass <instance_number> <bypass_value>``
toggle plugin processing
e.g.::
bypass 0 1
* if ``bypass_value = 1`` bypass plugin
* if ``bypass_value = 0`` process plugin
:param Lv2Effect effect: Effect that will be active the bypass
or disable the bypass
"""
return 'bypass {} {}'.format(
effect.instance,
1 if effect.active else 0
)
@staticmethod
[docs] def load(filename):
"""
``load <file_name>``
load a history command file
dummy way to save/load workspace state
e.g.::
load my_setup
.. note::
Not implemented yet
"""
return 'load {}'.format(filename)
@staticmethod
[docs] def save(filename):
"""
``save <file_name>``
saves the history of typed commands
dummy way to save/load workspace state
e.g.::
save my_setup
.. note::
Not implemented yet
"""
return 'save '.format(filename)
@staticmethod
[docs] def help():
"""
``help``
show a help message
"""
return 'help'
@staticmethod
[docs] def quit():
"""
``quit``
bye!
"""
return 'quit'