README

   1 playumidi - play standard midi-file format 0/1 for FreeBSD USB-MIDI device
   2   Version 0.8.0
   3
   4
   5 [Introduction]--------------------------------------------------------------
   6
   7  "playumidi" is the "SIMPLE" MIDI file player for USB MIDI device on FreeBSD.
   8  This software is able to direct control for FreeBSD-umidi device(/dev/umidi*.*)
   9  in the "uaudio" driver.
  10  Therefore, You don't need to use the "/dev/sequencer" device or the other
  11  software when listening the MIDI-file music.
  12  And, Support for auto-judge MIDI-file XG/GS/GM mode & auto add the
  13  Tone-Generator ReSet code when the ReSet code isn't exist in a MIDI-file.
  14
  15
  16 [Requirement]---------------------------------------------------------------
  17
  18  "playumid" is able to running following environment.
  19   * OS: FreeBSD
  20   * Available /dev/umidi*.* driver Only(integrated uaudio driver)
  21       (But Can't use /dev/sequencer (old midi driver))
  22   *  USB-MIDI Device (Support by FreeBSD uaudio driver)
  23   *  MIDI Tone generator or Compatible Device
  24       (e.g. YAMAMA MU1000/2000/128/etc... or Roland SC-88xx)
  25   * Depends on libpthread
  26       (Usually, libpthread is FreeBSD-default library.
  27        So, You don't neet to install this library.)
  28   * Depends on libiconv
  29       (However, only if you want to play MIDI files with embedded languages
  30        other than English)
  31
  32  Reference Environment:
  33   * FreeBSD 9.1-RELEASE
  34   * uaudio driver
  35       (patched by
  36         http://lists.freebsd.org/pipermail/freebsd-usb/2012-December/011702.html
  37           "Thank you!! for public this patch!")
  38   * YAMAHA MU1000 Tone Generator (Integrated USB)
  39
  40
  41 [Install]-------------------------------------------------------------------
  42
  43  Please read INSTALL text.
  44
  45
  46 [Usage]---------------------------------------------------------------------
  47
  48  playumidi is command-line software.
  49
  50  SYNOPSIS:
  51     "playumidi [option] file"
  52
  53  OPTIONS:
  54     -d device_name
  55       * Set the USB MIDI device name (Device Number & Port Number is auto-search)
  56           (If you want to use the "/dev/umidi0.0" device, you set "-d umidi".
  57            Don't set the Device Number & Port Number("0.0") )
  58       * playumidi use the midi device that the device directory is
  59         "/dev/<device_name>DeviceNumber.Number".
  60       * DEFAULT: "umidi"
  61
  62     -0 device_fullname
  63       * playumidi use the indicate device as the port-0 midi device.
  64       * Can't use the "-d"option same time.
  65            (When use both "-d" option and "-0/1/2/3"option,
  66             playumidi terminate process)
  67       * DEFAULT: "umidiX.0" (X is serarched by playumidi from 0 to 15.)
  68
  69     -1 device_fullname
  70       * playumidi use the indicate device as the port-1 midi device.
  71       * Can't use the "-d"option same time.
  72            (When use both "-d" option and "-0/1/2/3"option,
  73             playumidi terminate process)
  74       * DEFAULT: "umidiX.1" (X is serarched by playumidi from 0 to 15.)
  75
  76     -2 device_fullname
  77       * playumidi use the indicate device as the port-2 midi device.
  78       * Can't use the "-d"option same time.
  79            (When use both "-d" option and "-0/1/2/3"option,
  80             playumidi terminate process)
  81       * DEFAULT: "umidiX.2" (X is serarched by playumidi from 0 to 15.)
  82
  83     -3 device_fullname
  84       * playumidi use the indicate device as the port-3 midi device.
  85       * Can't use the "-d"option same time.
  86            (When use both "-d" option and "-0/1/2/3"option,
  87             playumidi terminate process)
  88       * DEFAULT: "umidiX.3" (X is serarched by playumidi from 0 to 15.)
  89
  90     -r
  91       * Disable Auto-Insert XG/GS/GM Reset code.
  92
  93     -q
  94       * Quiet Mode : Don't output the Meta-Event Text to the terminal stdout."
  95
  96     -v
  97       * Verbose Mode : Output the playumidi running status.(DEBUG mode)"
  98     -h
  99       * Output Command-Line Help Message (Usage)
 100
 101
 102  The following Playing-Operation are available
 103
 104     "Ctrl + C" Key
 105       * Stop playing music & Terminate playumidi.
 106
 107
 108 [CAUTION!!]-----------------------------------------------------------------
 109
 110  playumidi directly opens, writes midi-event data, and closes
 111  the /dev/<usb-midi device>.
 112  So, it is necessary to grant the R/W privileges(666) to /dev/<usb-midi device>
 113  before use playumidi.
 114  But, the FreeBSD umidi-driver (integraed by uaudio driver) is not granted
 115  permission only of the root-user R/W and others user/group read-only
 116  (permission 644) at the default.
 117
 118  Therefore, there is a need to grant permissions to R/W prior to use.
 119  I will show some examples below.
 120
 121   * (Example 1) set permissions every use time
 122         Do the following command as the root user.
 123         (Of course, can use sudo command also.)
 124            "chmod -R 755 /dev/umidi*"
 125
 126   * (Example 2) Set permanently R/W permission for usb-midi device. (FreeBSD 8/9 only)
 127         Do the following operation as the root user.
 128         (Of course, can use sudo command also.)
 129
 130       1. Append to /etc/devfs.rules the following two lines.
 131          (Making /etc/devfs.rules when there is not existing this file.)
 132             ------------------------------------------
 133             [devfsrules_common=7]
 134             add path 'umidi*' mode 0666 group wheel
 135             ------------------------------------------
 136
 137       2.  Append to /etc/rc.conf the following three lines.
 138             ------------------------------------------
 139             devd_enable="YES"
 140             devfs_enable="YES"
 141             devfs_system_ruleset="devfsrules_common"
 142             ------------------------------------------
 143
 144       3.  Reboot FreeBSD (shutdown -r now)
 145
 146
 147 [AUTHORS]----------------------------------------------------------------
 148
 149  Koine Yuusuke (koinec@users.sourceforge.jp)
 150
 151
 152 [LICENSE]----------------------------------------------------------------
 153
 154  playumidi presented by the "FreeBSD License".
 155
 156  Please read LICENSE text file.
 157
 158
 159 END of README ***********************************************************