<?php
/**
 * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
 * @author     Robin Gareus <robin@gareus.org>
 */

if(!defined('DOKU_INC')) die();
class helper_plugin_ladspa extends DokuWiki_Plugin {

  /**
   * Constructor
   */
  function helper_plugin_ladspa() {
    ;
  }

  /**
   * return some info
   */
  function getInfo(){
    return array(
      'author' => 'Robin Gareus',
      'email'  => 'robin@gareus.org',
      'date'   => '2008-12-29',
      'name'   => 'ladspa',
      'desc'   => 'ladspa info (helper)',
      'url'    => 'http://mir.dnsalias.com/wiki/dokuladspa',
    );
  }

  function getMethods(){
    $result = array();
    // TODO 
    return $result;
  }

//// functions calling 'ladspa-sdk' tools via shell to gather information /////

  /** call `listplugins` to query LADSPA .so lib filenames.
   * @return array of filenames
   */
/*private */function get_so() {
    $rv=array();
    $lp=`listplugins | grep -e ".so:\$"`;
    foreach (split(':',$lp) as $so) {
      $fn=trim($so);
      if(!empty($fn)) $rv[]=array('fn' => $fn);
    }
    return $rv;
  }

  /** call `analyseplugin` to get info from LADSPA .so lib.
   *
   * @param $so string the filename of the .so library
   * @return array of plugins
   */
/*private */function get_ap($so) {
    $lp=`analyseplugin "$so"`;
    return $this->parse_ap($lp, $so);
  }

/*private */function get_all() {
    $plugins=array();
    $sos=get_so();
    usort($sos , 'cmp_fn');
    foreach ($sos as &$so) {
      $p=get_ap($so['fn']);
      $so['contains']=count($p);
      $plugins = array_merge($plugins,$p);  # XXX this, alas, re-orders numberic keys.
    }
    // save $so and $plugins
    //
    //$f =fopen($datafn, "w");
    //if ($f) {fwrite($f, serialize(array('sos'=>$sos, 'plugins' => $plugins))); fclose($f);}
    return $plugins;
  }

//// parser for `analyseplugin` output ////

  /** parse output from `analyseplugin`
   *
   * @param $lp string (requires trailing empty line)
   * @return array of plugins
   */
  function parse_ap($lp, $so="??") {
    $analysepluginmap = array (
      "Plugin Name: "                => 'Name',
      "Plugin Label: "               => 'Label',
      "Plugin Unique ID: "           => 'UniqueID',
      "Maker: "                      => 'Maker',
      "Copyright: "                  => 'Copyright',
      "Must Run Real-Time: "         => 'PropertyRealTime',
      "Has activate() Function: "    => 'customTypeActivate',
      "Has deativate() Function: "   => 'customTypeDeactivate', ## typo in `analyseplugin`
      "Has deactivate() Function: "  => 'customTypeDeactivate',
      "Has run_adding() Function: "  => 'customTypeRunAdding',
      "Environment: "                => 'customEnvironment',
      "ERROR: "                      => '',  # TODO
      "Ports:"                       => 'Ports',
      "This plugin cannot use in-place processing. It will not work with all hosts."
                                     => 'PropertyInplace',
    );

  # Notes from ladspa.h
  #define LADSPA_PROPERTY_REALTIME        0x1
  #define LADSPA_PROPERTY_INPLACE_BROKEN  0x2
  #define LADSPA_PROPERTY_HARD_RT_CAPABLE 0x4
  #define LADSPA_IS_REALTIME(x)        ((x) & LADSPA_PROPERTY_REALTIME)
  #define LADSPA_IS_INPLACE_BROKEN(x)  ((x) & LADSPA_PROPERTY_INPLACE_BROKEN)
  #define LADSPA_IS_HARD_RT_CAPABLE(x) ((x) & LADSPA_PROPERTY_HARD_RT_CAPABLE)

    $rv=array();
    $p=false;
    $state=0; 

    foreach (split("\n", $lp) as $l) {
      $l=trim($l);
      if (empty($l)) {  // new plugin
        if (is_array($p) && !empty($p['UniqueID'])) { 
          $this->process_plugin($p); 
          $p['so']=$so; 
          $rv[$p['UniqueID']]=$p; 
        }
        $p=array();
        $state=0; 
        continue;
      }

      if ($state==1) { // 'Ports'
        $p['Ports'][]=$this->parse_port($l); 
        continue;
      }

      // now check for patterns in analysepluginmap

      $key=false;
      $pattern='';
      foreach ($analysepluginmap as $pt=> $k) {
        if (strncmp($l,$pt,strlen($pt))==0) {
          $key=$k;
          $pattern=$pt;
          break;
        }
      }

      // TODO parser "Errors"

      if (!empty($key)) {
       $v=substr($l, strlen($pattern));
       switch ($key) {
         case 'Ports':  
           $state=1; 
           $p['Ports'][]=$this->parse_port($v); 
           break;
         case 'customTypeDeactivate':
           $p['Capabilities']|=trim($v)=='Yes'?2:0;
           break;
         case 'customTypeActivate':
           $p['Capabilities']|=trim($v)=='Yes'?1:0;
           break;
         case 'customTypeRunAdding':
           $p['Capabilities']|=trim($v)=='Yes'?4:0;
           break;
         case 'PropertyRealTime':
           $p['Properties']|=trim($v)=='Yes'?1:0;
           break;
         case 'PropertyInplace':
           $p['Properties']|=2;
           break;
         case 'customEnvironment':
           $p['Properties']|=trim($v)=='Normal'?0:4;
           break;
         default:  
           $p[$k] = trim($v," \t\n\r\0\0x0B\""); 
           break;
        }
      }  /* end found/parse pattern */
    } /* end foreach line */
    return $rv;
  }

/** parse a "Port" line from `analyseplugin`.
 * @param $line string - line alike:
 * <pre>"Band 3 Freq [Hz]" input, control, 200 to 1000, default 400</pre>
 * @returns array 
 */
/*private */function parse_port($line) {
    if (!preg_match('/"([^"]*)" ([^,]*), (.*)$/', $line, $m)) {
      echo "invalid port data\n";
      return array();
    }
    $param=$m[3];
    $s=split(',', $param);
    $p = array(
          'name' => $m[1],
          'io' => $m[2],
          'type' => $s[0],
      );

# "Sections" input, control, 1 to 30, integer
# "Release Time (s)" input, control, 0 to ..., default 0 
# "Bandwidth (Hz)" input, control, 0.0001*srate to 0.45*srate, default 0.0067082*srate, logarithmic

# "Filter" input, control, toggled, default 0


    if ($s[0]=='control') {
      if (trim($s[1])=='toggled') { 
        $p['min']   = 0;
        $p['max']   = 1;
        $p['toggled']  = true;
        $p['default']  = floatval(str_replace("default ",'',trim($s[2]))); // skip "default "
        return($p);
      }

      $mm=split(' ', trim($s[1]));  // "<min> to <max>"
      $p['min']     = floatval($mm[0]);
      if (strpos($mm[0],'srate')!==false)
        $p['min'] *= 48000.0;
      if (strpos($mm[0],'...')!==false)
        $p['min']  = -110000000; // XXX

      $p['max']    = floatval($mm[2]);
      if (strpos($mm[2],'srate')!==false)
        $p['max'] *= 48000.0;
      if (strpos($mm[2],'...')!==false)
        $p['max']  = 110000000; // XXX

      $p['default']  = floatval(str_replace("default ",'',trim($s[2]))); // skip "default "
      if (strpos($s[2],'srate')!=false)
        $p['default'] = floatval(48000.0*$p['default']);

      if (strpos($param,'integer')!=false) {
        $p['integer'] = true;
      }
      if (strpos($param,'logarithmic')!=false) {
        $p['logscale'] = true;
      }
      if ($p['default'] < $p['min']) $p['default']= $p['min'];
      if ($p['default'] > $p['max']) $p['default']= $p['max'];
    }
    return $p;
  }

  /** post-process data gathered from `analyseplugin` before using/saving it.
   *  this function basically counts the available ports by type.
   */
/*private */function process_plugin(&$plugin) {
    $portcounters=array('audio_in' => 0, 'audio_out' => 0, 'control_in' => 0, 'control_out' => 0);
    $controlports=array();
    foreach ($plugin['Ports'] as $p) {
      if        ($p['io'] == 'input') {
        if        ($p['type'] == 'control') {
          $portcounters['control_in']++;
          $controlports[]=$p;
        } else if ($p['type'] == 'audio') {
          $portcounters['audio_in']++;
        }
      } else if ($p['io'] == 'output') {
        if        ($p['type'] == 'control') {
          $portcounters['control_out']++;
          $controlports[]=$p;
        } else if ($p['type'] == 'audio') {
          $portcounters['audio_out']++;
        }
      }
    }
   $plugin['controlports'] = $controlports;
   $plugin['portcounters'] = $portcounters;
  }


//// sort plugins helpers ////

function cmp_fn($a, $b) {
 return strcmp(basename($a['fn']), basename($b['fn']));
}

function cmp_chnin($a, $b) {
 $va=$a['portcounters']['audio_in'];
 $vb=$b['portcounters']['audio_in'];
 if ($va==$vb) return 0;
 return ($va > $vb);
}

function cmp_chnout($a, $b) {
 $va=$a['portcounters']['audio_out'];
 $vb=$b['portcounters']['audio_out'];
 if ($va==$vb) return 0;
 return ($va > $vb);
}

function cmp_label($a, $b) {
 $va=$a['Label'];
 $vb=$b['Label'];
 return strcmp($va, $vb);
}

function cmp_control($a, $b) {
 $va=count($a['controlports']);
 $vb=count($b['controlports']);
 if ($va==$vb) return 0;
 return ($va > $vb);
}

//// output functions ////

/*private */function _ht($txt) { 
    # TODO: obfuscate email addresses here ?!  /@([^ ])\./ 
    # TODO: no duplicate &copy;  s/^(C)//  
    return htmlentities($txt);
  }

/*private */function _st($t, $max=16) {
    $txt='???';
    if (!empty($t) && strlen($t)<=$max) {$txt=$t;}
    else if (!empty($t)) { $txt=substr($t,0,$max).'..';}
    return $this->_ht($txt);
  }

/*private */function fmt_val ($v) {
    if (abs($v)>=110000000) { return (($v<0?'&minus;':'').'&infin;');}
    if (abs($v)>=1000000) { return (intval($v/100000)/10.0).'M';}
    else if (abs($v)>=1000) { return (intval($v/100)/10.0).'K';}
    else if (abs($v)>=10) { return (intval($v*10.0)/10.0);}
    else { return (intval($v*100.0)/100.0);}
  }

/*private */function render_flags($plugin) {
    $rv='';
    if ($plugin['Properties']&0x1) $rv.='  <span class="led" title="must run in realtime">[RT]</span>';
    if ($plugin['Properties']&0x2) $rv.='  <span class="led" title="WARNING: no in-place processing.">[<del>IP</del>]</span>';
    if ($plugin['Properties']&0x4) $rv.='  <span class="led" title="may run in realtime">[rt]</span>';
   #if ($plugin['Properties']&0x4) $rv.='  <span class="led" title="may run in realtime">[<blink>rt</blink>]</span>';
    if ($plugin['Capabilities']&0x1) $rv.='  <span class="led" title="provides activate()">[A]</span>';
    if ($plugin['Capabilities']&0x2) $rv.='  <span class="led" title="provides deactivate()">[D]</span>';
    if ($plugin['Capabilities']&0x4) $rv.='  <span class="led" title="provides run_adding()">[R]</span>';
    return ($rv);
  }

  function render_legend() {
    $rv='';
    $rv.='<div class="legend">';
    $rv.='<div>'; // first line
    $rv.='<span class="linear">linear</span>';
    $rv.='&nbsp;|&nbsp;';
    $rv.='<span class="logscale">logscale</span>';
    $rv.='&nbsp;|&nbsp;';
    $rv.='<span class="integer">integer</span> Controlls';
    $rv.='</div><div>'; // 2nd line
    $rv.='<span class="output">Ouput</span> Ports';
    $rv.='&nbsp;||&nbsp;';
    $rv.='<span class="param">Parameter</span>';
    $rv.='&nbsp;|&nbsp;';
    $rv.='<span class="led param">Value</span>';
    $rv.='</div><div>'; // 2nd line
    #$rv.='Use mouse-over to view the full titles<br/> or long parameters indictated by "..".';
    $rv.='use mouse-over to reveal ".." contd. titles.';
    $rv.='</div></div>';
    return ($rv);
  }

  function render_list($plugins) {
    $rv='';
    $rv.="<ul>\n";
    foreach ($plugins as $plugin) {
      $rv.="<li>\n";
      $rv.="";
      $rv.=' <span class="label" title="'.$this->_ht($plugin['Label']).'"><a href="#pl'.$plugin['UniqueID'].'">'.$this->_st($plugin['Label'],48).'</a></span>';
      $rv.=' <span class="param label"><a href="?id=ladspa/'.intval($plugin['UniqueID']).'" title="'.$plugin['UniqueID'].'">('.$this->_st($plugin['UniqueID']).')</a></span>';
      $rv.=' &nbsp; <span class="title" title="'.$this->_ht($plugin['Name']).'">'.$this->_st($plugin['Name'],48).'</span>'."\n";
      $rv.=' &nbsp; audio:&nbsp;<span class="led">'.$plugin['portcounters']['audio_in'].'/'.$plugin['portcounters']['audio_out'].'</span>';
      $rv.=' &nbsp; ctrl:&nbsp;<span class="led">'.$plugin['portcounters']['control_in'].'/'.$plugin['portcounters']['control_out'].'</span>';
      $rv.=' &nbsp; ';
      $rv.=$this->render_flags($plugin);
      $rv.="</li>\n";
    }
    $rv.="</ul>\n";
    return ($rv);
  }

  function render_ladspa($plugin) {
    $rv='';
    // prepare data
    $portcounters=$plugin['portcounters'];
    $controlports=$plugin['controlports'];
    // format it
    $rv.='<a name="pl'.$plugin['UniqueID'].'"></a>';
    $rv.='<div class="wrappper" id="ladspa_'.$plugin['UniqueID'].'">';
    $rv.='<div class="bar">';
    $rv.=' <span class="label" title="'.$this->_ht($plugin['Label']).'">'.$this->_st($plugin['Label']).'</span>';
    $rv.=' <span class="title" title="'.$this->_ht($plugin['Name']).'">'.$this->_st($plugin['Name']).'</span>'."\n";
    $rv.='</div>';
    $rv.='<div class="bar small">';
    $rv.=' <span class="label"><a href="?id=ladspa/'.intval($plugin['UniqueID']).'" title="'.$plugin['UniqueID'].'">('.$this->_st($plugin['UniqueID']).')</a></span>';
    $rv.=' <span title="by '.$this->_ht($plugin['Maker']).'"><em>by</em>'.$this->_st($plugin['Maker']).'</span>';
    $rv.=' <span title="'.$this->_ht($plugin['Copyright']).'">&copy;'.$this->_st($plugin['Copyright']).'</span>'."\n";
    $rv.='</div>';
    $rv.='<div class="pluginbody">'; // pluginbody
    $rv.=' <div class="box" style="float:left;"><div>audio</div><div>in:<span class="led">'.$portcounters['audio_in'].'</span></div></div>';
    $rv.=' <div class="box" style="float:right; text-align:right;">audio<br/>out:<span class="led">'.$portcounters['audio_out'].'</span></div>';
    $rv.=' <div class="mainbox">';

    $rv.='  <div>'; // ctrl top-line
    $rv.='   <span>ctrl in:</span><span class="led">'.$portcounters['control_in'].'</span>';
    $rv.='   <span>&nbsp;/&nbsp;out:</span><span class="led">'.$portcounters['control_out'].'</span>';
    $rv.='  </div>';
    $rv.='  <div>'; // ctrl 2nd line
    $rv.=$this->render_flags($plugin);
    $rv.='  </div>';

    $tot=count($controlports); 
    $i=0; $halfway=ceil($tot/2.0);
    if ($tot>1)
      $rv.=' <div class="col" style="left:0px;">';
    else
      $rv.=' <div class="col" style="left:51px;">';
    foreach ($controlports as $c) {
      $rv.=' <div class="port" id="port_'.$plugin['UniqueID'].'_'.$i.'">'."\n";
      if ($c['io'] == 'input') 
        $rv.=' <div><span class="param" title="'.$this->_ht($c['name']).'">'.$this->_st($c['name']).'</span>'."</div>\n";
      else
        $rv.=' <div><span class="param output" title="'.$this->_ht($c['name']).'">'.$this->_st($c['name']).'</span>'."</div>\n";
      if ($c['logscale']==true) { // log
        if ($c['min']==0) {
          $w=log($c['max']);
          if ($w<=0) $w=0; else $w= 100.0 * log($c['default']) / $w;
        } else if ($c['max']==0) {
          $w=-1*log($c['min']);
          if ($w<=0) $w=0; else $w= 100.0 * (log($c['default'])+log($c['min'])) / $w; ## verify
        } else  {
          $w=log($c['max'])-log($c['min']);
          if ($w<=0) $w=0; else $w= 100.0 * (log($c['default'])-log($c['min'])) / $w;
        }
      } else {  // linear
        $w=$c['max']-$c['min'];
        if ($w<=0) $w=0; else $w= 100.0 * ($c['default']-$c['min']) / $w;
      }
      $rv.='  <div id="sb_'.$plugin['UniqueID'].'_'.$i.'" class="diabg';
      if ($c['integer']) 
        $rv.=' integer';
      else if ($c['logscale']) 
        $rv.=' logscale';
      if ($c['io'] == 'input') 
        $rv.='" onmousedown="ladsw(this,event);">';
      else 
        $rv.=' output">'."\n";
      $rv.='   <div class="dia" id="sl_'.$plugin['UniqueID'].'_'.$i.'" style="width:'.floor($w).'px;">&nbsp;</div>'."\n";
      $rv.='   <div class="diatxt">';
      $rv.='    <span class="value left">'.$this->fmt_val($c['min']).'&nbsp;&le;</span>'."\n";
      $rv.='    <span class="value center" id="pv_'.$plugin['UniqueID'].'_'.$i.'">('.$this->fmt_val($c['default']).')</span>'."\n";
      $rv.='    <span class="value right">&le;&nbsp;'.$this->fmt_val($c['max']).'</span>'."\n";
      $rv.='   </div>'."\n";
      $rv.='  </div>'."\n";
      $rv.=' </div>'."\n";
      $i++;
      if ($tot>1 && $i==$halfway) {
       $rv.=' </div><div class="col" style="left:110px;">';
      }
    }
    $rv.=' </div>'."\n"; // col
    if (1) {
    $rv.='   <script type="text/javascript">/* <![CDATA[ */'."\n";
    $rv.='   plugins['.$plugin['UniqueID'].']={\'portcount\':'.$plugin['portcounters']['control_in'].'}'."\n";
    $i=0;
    foreach ($controlports as $c) {
      $rv.='   plugins['.$plugin['UniqueID'].']['.$i.']={\'min\':'.$c['min'].',\'val\':'.$c['default'].',\'max\':'.$c['max'].',\'log\':'.($c['logscale']?1:0).',\'int\':'.($c['integer']?1:0).'};'."\n";
      $i++;
    }
    $rv.='   /* ]]> */</script>'."\n";
    }
    $rv.=' <div class="diaspace" style="height:'.(($halfway+0)*3).'em;">&nbsp;</div>';
    $rv.=' </div>'."\n"; //mainbox
    $rv.='</div>'; // pluginbody
    $rv.='</div>'; // wrapper
    return $rv;
  }

}
//Setup VIM: ex: et sw=2 ts=2 enc=utf-8 :